Environment - SHT4x

SHT4x Temperature and Humidity sensors

Plugin details

Type: Environment

Name: SHT4x

Status ESP32: COLLECTION F CLIMATE

Status ESP8266: COLLECTION F CLIMATE

GitHub: P153_SHT4x.ino

Maintainer: tonhuisman

Used libraries: .

Description

The Sensirion SHT4x range (SHT40, SHT41, SHT43 and SHT45) Temperature and Humidity sensors offer accuracy depending on the model used. The SHT43 is an industrial grade high accuracy sensor, the other models have increasing accuracy from low to high type number.

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: The sensor supports a single address, but that address depends on the actual type suffix, printed on the sensor chip (and usually included in the documentation for the device/board).

Address	Type	Remark
0x44	SHT4x-Axxx	Default, most used.
0x45	SHT4x-Bxxx
0x46	SHT4x-Cxxx

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

• Temperature offset: An offset from the current temperature can be applied in 0.01°C steps. The offset can be set here.

• Startup Configuration: To enable conditioning of the sensor, a Startup Configuration can be selected that enables an internal heater for a limited amount of measurements. Here that statup setting can be selected. The sensors don’t allow the heater to be used combined with Low or Medium resolution measurements.

Low resolution: Execute only low resolution measurements.

Medium resolution: Execute only medium resolution measurements.

High resolution: Execute only high resolution measurements. (Default)

High res., Heater 200 mWatt for 1 sec.: Heat the sensor for 1 second with 200 milliwatt power, then execute a high resolution measurement.

High res., Heater 200 mWatt for 0.1 sec.: Heat the sensor for 100 milliseconds with 200 milliwatt power, then execute a high resolution measurement.

High res., Heater 110 mWatt for 1 sec.: Heat the sensor for 1 second with 110 milliwatt power, then execute a high resolution measurement.

High res., Heater 110 mWatt for 0.1 sec.: Heat the sensor for 100 milliseconds with 110 milliwatt power, then execute a high resolution measurement.

High res., Heater 20 mWatt for 1 sec.: Heat the sensor for 1 second with 20 milliwatt power, then execute a high resolution measurement.

High res., Heater 20 mWatt for 0.1 sec.: Heat the sensor for 100 milliseconds with 20 milliwatt power, then execute a high resolution measurement.

Warning

The maximum duty-cycle using the heater is 10%, so when using a 1 second heating period, an Interval setting > 10 seconds must be used, to protect the sensor.

Activating the heater helps to remove possible condensation from the sensor.

• Use Normal Configuration after: After using the Startup configuration for some time, the Normal Configuration will be used. This is configured in Interval cycles, in range 1..10.

• Normal Configuration: After the Startup Configuration has been applied for some time, or if the Startup Configuration is the same as the Normal Configuration, the Normal Configuration measurement mode will be applied.

Low resolution: Execute only low resolution measurements.

Medium resolution: Execute only medium resolution measurements.

High resolution: Execute only high resolution measurements. (Default)

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 60 sec. The data will be collected and optionally sent to any configured controllers using this interval. If the Interval is set lower or equal than the required 10 * Heater time, the plugin will not start!

Values

The plugin provides the Temperature and Humidity values. A formula can be set to recalculate. The number of decimals can be set as desired, and defaults to 2.

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:

Commands available

Command Syntax	Extra information
sht4x,startup	Re-start with the Startup Configuration, like a plugin re-start, using the same Interval runs, only accepted if Startup and Normal configuration are different, and Interval runs > 0. This helps to remove condensation from the sensor from Rules, f.e. once a day.

Get Config Values

Get Config Values retrieves values or settings from the sensor or plugin, and can be used in Rules, Display plugins, Formula’s etc. The square brackets are part of the variable. Replace <taskname> by the Name of the task.

Config value	Information
[<taskname>#Serialnumber]	Returns the serial number of the sensor.

Change log

Changed in version 2.0: …

added 2023-05-06 Initial release version.