Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[P103] Add support for EZO-HUM sensor #4854

Merged
merged 27 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
37800d4
[P103] Add support for EZO-HUM sensor
tonhuisman Oct 20, 2023
e10e8dd
[P103] Fix some issues, add logging for analysis
tonhuisman Oct 22, 2023
9c3e769
[P103] Fix more issues, add/apply settings for EZO-HUM
tonhuisman Oct 22, 2023
9ab6047
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Oct 23, 2023
48f8b8d
[P103] Handle EZO-HUM firmware issue of unexpected 'Dew' in output
tonhuisman Oct 23, 2023
feba189
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Nov 14, 2023
79557e2
Merge branch 'mega' into feature/P103-add-ezo-hum-sensor
tonhuisman Dec 12, 2023
732f93a
Merge branch 'feature/P103-add-ezo-hum-sensor' of https://github.com/…
tonhuisman Jan 20, 2024
94ed3d0
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Feb 1, 2024
b5e48a6
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Feb 1, 2024
1562664
[P103] Fix to apply new `UserVar` usage
tonhuisman Feb 1, 2024
ada38c2
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Feb 2, 2024
dbbb9a1
Merge branch 'mega' into feature/P103-add-ezo-hum-sensor
tonhuisman Mar 7, 2024
517b5e9
Merge branch 'feature/P103-add-ezo-hum-sensor' of https://github.com/…
tonhuisman Mar 8, 2024
4683de1
Merge branch 'mega' into feature/P103-add-ezo-hum-sensor
TD-er May 29, 2024
2a0cd89
Merge branch 'feature/P103-add-ezo-hum-sensor' of https://github.com/…
tonhuisman Jul 3, 2024
b418df5
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Jul 3, 2024
76d8d6f
Merge branch 'mega' into feature/P103-add-ezo-hum-sensor
TD-er Jul 3, 2024
b267c36
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Sep 27, 2024
dcb9e92
Merge branch 'mega' into feature/P103-add-ezo-hum-sensor
TD-er Oct 2, 2024
0bae3dd
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Oct 3, 2024
9a10620
Merge branch 'mega' of https://github.com/letscontrolit/ESPEasy into …
tonhuisman Oct 17, 2024
0852557
[P103] Javascript fixes, code improvements
tonhuisman Oct 19, 2024
ce60f43
[Build] Fix: Use package with Solo1 'autodetect' (Solo1 specific pack…
tonhuisman Oct 19, 2024
1e0145d
Merge branch 'mega' into feature/P103-add-ezo-hum-sensor
tonhuisman Nov 15, 2024
568dddf
[P103] Add documentation
tonhuisman Nov 16, 2024
5e5516e
[P103] Fix cast issue
tonhuisman Nov 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 126 additions & 3 deletions docs/source/Plugin/P103.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand All @@ -43,4 +164,6 @@ Change log
.. versionchanged:: 2.0
...

|added| 2023-10-17 Add HUM sensor

|added| 2020-04-25
Binary file added docs/source/Plugin/P103_DeviceConfiguration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_DO.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_DO_Calibration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_EC.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_EC_Calibration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_HUM.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_HUM_Options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_HUM_Values.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_ORP.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_pH.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P103_Device_pH_Calibration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/source/Plugin/_plugin_substitutions_p10x.repl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading