Merge pull request letscontrolit#4854 from tonhuisman/feature/P103-ad…

…d-ezo-hum-sensor [P103] Add support for EZO-HUM sensor
Micha-he · Dec 9, 2024 · 30e4197 · 30e4197
2 parents 919a166 + 5e5516e
commit 30e4197
Show file tree

Hide file tree

Showing 17 changed files with 597 additions and 239 deletions.
diff --git a/docs/source/Plugin/P103.rst b/docs/source/Plugin/P103.rst
@@ -27,13 +27,134 @@ Datasheet: |P103_datasheet|
 Description
 -----------
 
+Several Atlas Scientific EZO sensors are supported by this plugin. Only I2C communication is supported, some sensors use that by default, and most other sensors can be re-configured from RS232 to I2C communication.
 
+Currently there is support for:
 
+* **pH**: Potential of Hydrogen (Acidity)
 
-.. Events
-.. ~~~~~~
+* **ORP**: Oxidation Reduction Potential
+
+* **EC**: Electrical Conductivity
+
+* **DO**: Dissolved Oxigen
+
+* **HUM**: Humidity (Can also provide Temperature and Dewpoint measurements)
+
+Device configuration
+--------------------
+
+.. image:: P103_DeviceConfiguration.png
+
+* **Name**: A unique name should be entered here.
+
+* **Enabled**: The device can be disabled or enabled. When not enabled the device should not use any resources.
+
+I2C options
+^^^^^^^^^^^
+
+The available settings here depend on the build used. At least the **Force Slow I2C speed** option is available, but selections for the I2C Multiplexer can also be shown. For details see the :ref:`Hardware_page`
+
+When loading the Device configuration page, the plugin will try to detect the type of sensor connected based on the selected I2C addresses. If no sensor is found, the message in red will be shown.
+
+If no sensor is connected, the configuration can still be shown by selecting the **Setup without sensor** checkbox, choosing the I2C address for the intended sensor, and submitting the page.
+
+Device settings
+^^^^^^^^^^^^^^^
+
+Board
+^^^^^
+
+This section shows relevant information, obtained from the sensor if actually connected.
+
+* **Status LED**: The status led on the sensor can be enabled or disabled, using this checkbox.
+
+For each board there are different device parameters available, but when using the device simulation, no actual device information is available, so no data is shown.
+
+Board pH
+^^^^^^^^
+
+.. image:: P103_Device_pH.png
+
+pH Calibration
+^^^^^^^^^^^^^^
+
+For the pH sensor, some calibration may be needed. The simulated device doesn't have any calibration data set.
+
+.. image:: P103_Device_pH_Calibration.png
+
+For compensation of temperature, either a fixed temperature or a value from a connected temperature sensor can be selected. For this connected temperature sensor, the ``[<Taskname>#<valuename>]`` notation can be used. This will will be evaluated when the value is needed.
+
+Board ORP
+^^^^^^^^^
+
+.. image:: P103_Device_ORP.png
+
+ORP Calibration
+^^^^^^^^^^^^^^^
+
+For the ORP sensor, some calibration may be needed. The simulated device doesn't have any calibration data set.
+
+.. image:: P103_Device_ORP_Calibration.png
+
+For compensation of temperature, either a fixed temperature or a value from a connected temperature sensor can be selected. For this connected temperature sensor, the ``[<Taskname>#<valuename>]`` notation can be used. This will will be evaluated when the value is needed.
+
+Board EC
+^^^^^^^^
+
+.. image:: P103_Device_EC.png
+
+EC Calibration
+^^^^^^^^^^^^^^
+
+For the EC sensor, some calibration may be needed. The simulated device doesn't have any calibration data set.
+
+.. image:: P103_Device_EC_Calibration.png
+
+For compensation of temperature, either a fixed temperature or a value from a connected temperature sensor can be selected. For this connected temperature sensor, the ``[<Taskname>#<valuename>]`` notation can be used. This will will be evaluated when the value is needed.
+
+Board DO
+^^^^^^^^
+
+.. image:: P103_Device_DO.png
+
+DO Calibration
+^^^^^^^^^^^^^^
+
+For the DO sensor, some calibration may be needed. The simulated device doesn't have any calibration data set.
+
+.. image:: P103_Device_DO_Calibration.png
+
+Board HUM
+^^^^^^^^^
+
+.. image:: P103_Device_HUM.png
+
+HUM Calibration
+^^^^^^^^^^^^^^^
+
+For the HUM sensor, no calibration can be adjusted, but options to enable the Temperature and/or Dew-point measurements are available.
+
+.. image:: P103_Device_HUM_Options.png
+
+To make the Temperature and Dew-point available for use, extra values are available:
+
+.. image:: P103_Device_HUM_Values.png
+
+Data Acquisition
+^^^^^^^^^^^^^^^^
+
+This group of settings, **Single event with all values**, **Send to Controller** and **Interval** settings are standard available configuration items. Send to Controller is only visible when one or more Controllers are configured.
+
+* **Interval** By default, Interval will be set to 60 sec. The data will be collected and optionally sent to any configured controllers using this interval.
+
+Values
+^^^^^^
+
+For all sensors, the **SensorData** and **Voltage** values are available. For the **HUM** Humidity sensor, also **Temperature** and **Dew-point** values are available, but have to be enabled in options to return a sensible value.
+
+In selected builds, per Value **Stats** options are available, that when enabled, will gather the measured data and present most recent data in a graph, as described here: :ref:`Task Value Statistics:  <Task Value Statistics>`
 
-.. .. include:: P103_events.repl
 
 
 
@@ -43,4 +164,6 @@ Change log
 .. versionchanged:: 2.0
   ...
 
+  |added| 2023-10-17 Add HUM sensor
+
   |added| 2020-04-25
diff --git a/docs/source/Plugin/P103_DeviceConfiguration.png b/docs/source/Plugin/P103_DeviceConfiguration.png
diff --git a/docs/source/Plugin/P103_Device_DO.png b/docs/source/Plugin/P103_Device_DO.png
diff --git a/docs/source/Plugin/P103_Device_DO_Calibration.png b/docs/source/Plugin/P103_Device_DO_Calibration.png
diff --git a/docs/source/Plugin/P103_Device_EC.png b/docs/source/Plugin/P103_Device_EC.png
diff --git a/docs/source/Plugin/P103_Device_EC_Calibration.png b/docs/source/Plugin/P103_Device_EC_Calibration.png
diff --git a/docs/source/Plugin/P103_Device_HUM.png b/docs/source/Plugin/P103_Device_HUM.png
diff --git a/docs/source/Plugin/P103_Device_HUM_Options.png b/docs/source/Plugin/P103_Device_HUM_Options.png
diff --git a/docs/source/Plugin/P103_Device_HUM_Values.png b/docs/source/Plugin/P103_Device_HUM_Values.png
diff --git a/docs/source/Plugin/P103_Device_ORP.png b/docs/source/Plugin/P103_Device_ORP.png
diff --git a/docs/source/Plugin/P103_Device_ORP_Calibration.png b/docs/source/Plugin/P103_Device_ORP_Calibration.png
diff --git a/docs/source/Plugin/P103_Device_pH.png b/docs/source/Plugin/P103_Device_pH.png
diff --git a/docs/source/Plugin/P103_Device_pH_Calibration.png b/docs/source/Plugin/P103_Device_pH_Calibration.png
diff --git a/docs/source/Plugin/_plugin_substitutions_p10x.repl b/docs/source/Plugin/_plugin_substitutions_p10x.repl
@@ -37,16 +37,16 @@
 .. |P102_compileinfo| replace:: `.`
 .. |P102_usedlibraries| replace::  https://github.com/olehs/PZEM004T
 
-.. |P103_name| replace:: :cyan:`Atlas Scientific EZO pH`
+.. |P103_name| replace:: :cyan:`Atlas Scientific EZO pH ORP EC DO HUM`
 .. |P103_type| replace:: :cyan:`Environment`
-.. |P103_typename| replace:: :cyan:`Environment - Atlas Scientific EZO pH`
+.. |P103_typename| replace:: :cyan:`Environment - Atlas Scientific EZO pH ORP EC DO HUM`
 .. |P103_porttype| replace:: `.`
 .. |P103_status| replace:: :yellow:`CLIMATE`
-.. |P103_github| replace:: P103_Atlas_EZO_pH.ino 
-.. _P103_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P103_Atlas_EZO_pH.ino 
+.. |P103_github| replace:: P103_Atlas_EZO_pH_ORP_EC_DO.ino 
+.. _P103_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P103_Atlas_EZO_pH_ORP_EC_DO.ino 
 .. |P103_usedby| replace:: `.`
 .. |P103_shortinfo| replace:: `.`
-.. |P103_maintainer| replace:: TD-er
+.. |P103_maintainer| replace:: `TD-er tonhuisman`
 .. |P103_compileinfo| replace:: `.`
 .. |P103_usedlibraries| replace::  `.`
 .. |P103_datasheet| replace::  https://atlas-scientific.com/files/pH_EZO_Datasheet.pdf