Input - I2C Liquid level sensor

Seeed Studio I2C Liquid level sensor

Plugin details

Type: Input

Name: I2C Liquid level sensor

Status ESP32: COLLECTION G

Status ESP8266: COLLECTION G

GitHub: P170_Waterlevel.ino

Maintainer: tonhuisman

Used libraries: .

Description

The Seeed Studio I2C Liquid level sensor can measure a liquid level in the range of 0..10cm, in a resolution of 5mm. It uses a capacitive sensor method.

(Image (c) Seeed Studio)

Configuration

• Name: Required by ESPEasy, must be unique among the list of available devices/tasks.

• Enabled: The device can be disabled or enabled. When not enabled the device should not use any resources.

I2C options

• I2C Address: Is not available in the configuration, but the device has a fixed address, or actually 2 fixed adjacent addresses, 0x77 and 0x78, as there are to separate but similar microcontrollers on the board, each delivering a part of the measurement range.

The available I2C 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 I2C Bus page

Device Settings

• Sensitivity: This determines the signal level measured for each sensor-pad to be submerged in the liquid. Depending on the type of liquid to be measured, this may need adjusting.

Events

• Trigger on Low level: When set above 0 (in steps of 5 mm, rounded down on save), an event will be generated when the liquid level goes below this level. The generated event is <taskname>#LowLevel=<level>.

• Trigger on High level: When set above 0 (in steps of 5 mm, rounded down on save), an event will be generated when the liquid level rises above this level. The generated event is <taskname>#HighLevel=<level>.

When a Trigger is set to 0 it will be disabled. Rules have to be enabled to be able to process the events.

• Trigger only once: When enabled, only a single event will be generated for a High or Low level trigger, until that state is reset and again passes the trigger level.

• Log signal level: When enabled will log at Info level the received data from the sensor after reading. Can be used to find a suitable Sensitivity setting when the default doesn’t work as expected. Should best be disabled during normal operation.

Data Acquisition

This group of settings are standard available configuration items.

• Single event with all values: When this setting is enabled, all available values will be sent in a single event <TaskName>#All, with all values in order as arguments to the event.

• Show derived values: When checked, the Devices overview page, and the /json endpoint (used for updating the Devices overview page) will include any Derived values as defined. See the TaskValueSetDerived and TaskValueSetPresentation commands.

• Event & Log derived values: When checked, the Derived values will be generated as Events, to be handled in Rules, and sent to logging devices like the Syslog server and/or SD-card logging.

(The derived values options are only available if String variables feature is included in the build.)

• Send to Controller: Select the Controller(s) to send the Values to, either on a TaskRun command applied to the task, or on an Interval time action.

Send to Controller is only visible when one or more Controllers are configured.

Depending on the controller capabilities, some configuration settings may be shown:

All configured Controllers are shown here, including the enabled or disabled state (multiple Controllers can be enabled, only a single MQTT Controller can be enabled at one time!).

For each controller the user can select wether the data should be sent on each Interval (or explicit TaskRun).

For the Domoticz controllers the value index (IDX) has to be configured.

For some controllers, like Home Assistant/openHAB, there are extra options available.

• Group: This represents the group id to combine all values from multiple tasks into a single grouped-device during MQTT AutoDiscovery. Groups, by design, can span multiple ESPEasy devices, if desired, as long as the Task/Valuename combinations are unique. If a group should only combine Tasks from a single ESPEasy unit, the group id should be unique across multiple ESPEasy units. The group description, default Group <n>, can be adjusted in Home Assistant. If the Group value matches the current Unit nr, the Unit name, %sysname%, is used instead of Group <nr>.

• Retained: For MQTT Controllers, this setting can be enabled to send the values for the current task with the Retain flag set. The Publish Retain flag in the Controller settings will override this by sending all task values with Retain flag enabled.

• Send derived: This checkbox determines if any configured Derived values should also be sent to the controller (and included in the AutoDiscovery if that’s available and enabled).

• Resend MQTT Discovery: When checked, will start a resend of the MQTT Discovery process for this task after a random delay, when Submit is clicked, so any changed settings will be updated in the MQTT broker. This setting is only available if the controller is enabled, the Auto Discovery feature is available and enabled for the controller. This setting is not stored.

Other controllers, like f.e. FHEM HTTP, do not support additional settings besides the checkbox to enable sending the data.

• Interval By default, Interval will be set to 0 sec. The data will be collected and optionally sent to any configured controllers using this interval. When an output value is changed, the data will be sent to any configured controller, and an event will also be generated when the Rules are enabled (Tools/Advanced).

Values

The plugin provides the Level (mm) and Steps (range 0..20) values. A formula can be set to recalculate the displayed, and sent, value.

In selected builds, per Value is a Stats checkbox available, that when checked, gathers the data and presents recent data in a graph, as described here: Task Value Statistics:

Events

Event	Extra information
<taskname>#LowLevel=<level> <level>: Current level value.	This event is generated if the level goes below the set Trigger on Low level value (5..100 mm), and is repeated every Interval seconds (or 1 sec. if Interval is 0). When Trigger only once is set, only a single event will be generated, until the measured level rises above the configured level and goes below that again.
<taskname>#HighLevel=<level> <level>: Current level value.	This event is generated if the level rises above the set Trigger on High level value (5..100 mm), and is repeated every Interval seconds (or 1 sec. if Interval is 0). When Trigger only once is set, only a single event will be generated, until the measured level goes below the configured level and rises above that again.

Change log

Changed in version 2.0: …

added 2024-05-21 Initial release version.