Version 2.0.5

Added sensor measurement frequency in switch hardware configuration.

include/zh_config.h

@@ -14,7 +14,7 @@
 #define ZH_OFFLINE false
 
 #define ZH_NOT_USED 0xFF
-//***********************************************************************************//
+
 #define ZH_DEVICE_TYPE                             \
     DF(ZHDT_NONE, "")                              \
     DF(ZHDT_GATEWAY, "gateway")                    \
@@ -29,15 +29,24 @@
     DF(ZHDT_BINARY_SENSOR, "espnow_sensor")        \
     DF(ZHDT_MAX, "")
 
-typedef enum zh_device_type_t
+typedef enum // Enumeration of device types supported by the ESP-NOW gateway.
 {
 #define DF(_value, _name) _value,
     ZH_DEVICE_TYPE
 #undef DF
 } zh_device_type_t;
 
+/**
+ * @brief Get char description from the enumeration zh_device_type_t value.
+ *
+ * @note Used for identificate device type in MQTT topics (example - "homeassistant/espnow_switch/70-03-9F-44-BE-F7").
+ *
+ * @param[in] value Enumeration value of zh_device_type_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_device_type_value_name(zh_device_type_t value);
-//***********************************************************************************//
+
 #define ZH_PAYLOAD_TYPE                 \
     DF(ZHPT_NONE, "")                   \
     DF(ZHPT_ATTRIBUTES, "attributes")   \
@@ -60,17 +69,27 @@ char *zh_get_device_type_value_name(zh_device_type_t value);
     DF(ZHPT_RGB, "rgb")                 \
     DF(ZHPT_EFFECT, "effect")           \
     DF(ZHPT_HARDWARE, "hardware")       \
+    DF(ZHPT_ERROR, "")                  \
     DF(ZHPT_MAX, "")
 
-typedef enum zh_payload_type_t
+typedef enum // Enumeration of payload types supported by the ESP-NOW gateway.
 {
 #define DF(_value, _name) _value,
     ZH_PAYLOAD_TYPE
 #undef DF
 } zh_payload_type_t;
 
+/**
+ * @brief Get char description from the enumeration zh_payload_type_t value.
+ *
+ * @note Used for identificate payload type in MQTT topics (example - "homeassistant/espnow_switch/70-03-9F-44-BE-F7/attributes").
+ *
+ * @param[in] value Enumeration value of zh_payload_type_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_payload_type_value_name(zh_payload_type_t value);
-//***********************************************************************************//
+
 #define HA_COMPONENT_TYPE                               \
     DF(HACT_NONE, "")                                   \
     DF(HACT_ALARM_CONTROL_PANEL, "alarm_control_panel") \
@@ -95,15 +114,24 @@ char *zh_get_payload_type_value_name(zh_payload_type_t value);
     DF(HACT_VACUUM, "vacuum")                           \
     DF(HACT_MAX, "")
 
-typedef enum ha_component_type_t
+typedef enum // Enumeration of device types supported by the Home Assistant. For details see https://www.home-assistant.io/integrations/mqtt.
 {
 #define DF(_value, _name) _value,
     HA_COMPONENT_TYPE
 #undef DF
 } ha_component_type_t;
 
+/**
+ * @brief Get char description from the enumeration ha_component_type_t value.
+ *
+ * @note Used to prepare a configuration message for Home Assistant MQTT discovery.
+ *
+ * @param[in] value Enumeration value of ha_component_type_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_component_type_value_name(ha_component_type_t value);
-//***********************************************************************************//
+
 #define HA_BINARY_SENSOR_DEVICE_CLASS               \
     DF(HABSDC_NONE, "")                             \
     DF(HABSDC_BATTERY, "battery")                   \
@@ -136,15 +164,24 @@ char *zh_get_component_type_value_name(ha_component_type_t value);
     DF(HABSDC_WINDOW, "window")                     \
     DF(HABSDC_MAX, "")
 
-typedef enum ha_binary_sensor_device_class_t
+typedef enum // Enumeration of binary sensor types supported by the Home Assistant. For details see https://www.home-assistant.io/integrations/binary_sensor/#device-class.
 {
 #define DF(_value, _name) _value,
     HA_BINARY_SENSOR_DEVICE_CLASS
 #undef DF
 } ha_binary_sensor_device_class_t;
 
+/**
+ * @brief Get char description from the enumeration ha_binary_sensor_device_class_t value.
+ *
+ * @note Used to prepare a configuration message for Home Assistant MQTT discovery.
+ *
+ * @param[in] value Enumeration value of ha_binary_sensor_device_class_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_binary_sensor_device_class_value_name(ha_binary_sensor_device_class_t value);
-//***********************************************************************************//
+
 #define HA_COVER_DEVICE_CLASS    \
     DF(HACDC_NONE, "")           \
     DF(HACDC_AWNING, "awning")   \
@@ -159,83 +196,121 @@ char *zh_get_binary_sensor_device_class_value_name(ha_binary_sensor_device_class
     DF(HACDC_WINDOW, "window")   \
     DF(HACDC_MAX, "")
 
-typedef enum ha_cover_device_class_t
+typedef enum // Enumeration of cover types supported by the Home Assistant. For details see https://www.home-assistant.io/integrations/cover.
 {
 #define DF(_value, _name) _value,
     HA_COVER_DEVICE_CLASS
 #undef DF
 } ha_cover_device_class_t;
 
+/**
+ * @brief Get char description from the enumeration ha_cover_device_class_t value.
+ *
+ * @note Used to prepare a configuration message for Home Assistant MQTT discovery.
+ *
+ * @param[in] value Enumeration value of ha_cover_device_class_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_cover_device_class_value_name(ha_cover_device_class_t value);
-//***********************************************************************************//
+
-#define HA_SENSOR_DEVICE_CLASS                                         \
+#define HA_SENSOR_DEVICE_CLASS                                                                                                                                                                           \
-    DF(HASDC_NONE, "")                                                 \
+    DF(HASDC_NONE, "")                                                                                                                                                                                   \
-    DF(HASDC_APPARENT_POWER, "apparent_power")                         \
+    DF(HASDC_APPARENT_POWER, "apparent_power")                                     /* Apparent power in VA */                                                                                            \
-    DF(HASDC_AQI, "aqi")                                               \
+    DF(HASDC_AQI, "aqi")                                                           /* Air quality index (unitless) */                                                                                    \
-    DF(HASDC_BATTERY, "battery")                                       \
+    DF(HASDC_BATTERY, "battery")                                                   /* Percentage of battery that is left in % */                                                                         \
-    DF(HASDC_CARBON_DIOXIDE, "carbon_dioxide")                         \
+    DF(HASDC_CARBON_DIOXIDE, "carbon_dioxide")                                     /* Carbon dioxide in CO2 (Smoke) in ppm */                                                                            \
-    DF(HASDC_CARBON_MONOXIDE, "carbon_monoxide")                       \
+    DF(HASDC_CARBON_MONOXIDE, "carbon_monoxide")                                   /* Carbon monoxide in CO (Gas CNG/LPG) in ppm */                                                                      \
-    DF(HASDC_CURRENT, "current")                                       \
+    DF(HASDC_CURRENT, "current")                                                   /* Current in A, mA */                                                                                                \
-    DF(HASDC_DATE, "date")                                             \
+    DF(HASDC_DATE, "date")                                                         /* Date string (ISO 8601) */                                                                                          \
-    DF(HASDC_DISTANCE, "distance")                                     \
+    DF(HASDC_DISTANCE, "distance")                                                 /* Generic distance in km, m, cm, mm, mi, yd, or in */                                                                \
-    DF(HASDC_DURATION, "duration")                                     \
+    DF(HASDC_DURATION, "duration")                                                 /* Duration in d, h, min, or s */                                                                                     \
-    DF(HASDC_ENERGY, "energy")                                         \
+    DF(HASDC_ENERGY, "energy")                                                     /* Energy in Wh, kWh, MWh, MJ, or GJ */                                                                               \
-    DF(HASDC_FREQUENCY, "frequency")                                   \
+    DF(HASDC_FREQUENCY, "frequency")                                               /* Frequency in Hz, kHz, MHz, or GHz */                                                                               \
-    DF(HASDC_GAS, "gas")                                               \
+    DF(HASDC_GAS, "gas")                                                           /* Gasvolume in m³, ft³ or CCF */                                                                                   \
-    DF(HASDC_HUMIDITY, "humidity")                                     \
+    DF(HASDC_HUMIDITY, "humidity")                                                 /* Percentage of humidity in the air in % */                                                                          \
-    DF(HASDC_ILLUMINANCE, "illuminance")                               \
+    DF(HASDC_ILLUMINANCE, "illuminance")                                           /* The current light level in lx */                                                                                   \
-    DF(HASDC_MOISTURE, "moisture")                                     \
+    DF(HASDC_MOISTURE, "moisture")                                                 /* Percentage of water in a substance in % */                                                                         \
-    DF(HASDC_MONETARY, "monetar")                                      \
+    DF(HASDC_MONETARY, "monetary")                                                 /* The monetary value (ISO 4217) */                                                                                   \
-    DF(HASDC_NITROGEN_DIOXIDE, "nitrogen_dioxide")                     \
+    DF(HASDC_NITROGEN_DIOXIDE, "nitrogen_dioxide")                                 /* Concentration of nitrogen dioxide in µg/m³ */                                                                    \
-    DF(HASDC_NITROGEN_MONOXIDE, "nitrogen_monoxide")                   \
+    DF(HASDC_NITROGEN_MONOXIDE, "nitrogen_monoxide")                               /* Concentration of nitrogen monoxide in µg/m³ */                                                                   \
-    DF(HASDC_NITROUS_OXIDE, "nitrous_oxide")                           \
+    DF(HASDC_NITROUS_OXIDE, "nitrous_oxide")                                       /* Concentration of nitrous oxide in µg/m³ */                                                                       \
-    DF(HASDC_OZONE, "ozone")                                           \
+    DF(HASDC_OZONE, "ozone")                                                       /* Concentration of ozone in µg/m³ */                                                                               \
-    DF(HASDC_PM1, "pm1")                                               \
+    DF(HASDC_PM1, "pm1")                                                           /* Concentration of particulate matter less than 1 micrometer in µg/m³ */                                           \
-    DF(HASDC_PM10, "pm10")                                             \
+    DF(HASDC_PM10, "pm10")                                                         /* Concentration of particulate matter less than 10 micrometers in µg/m³ */                                         \
-    DF(HASDC_PM25, "pm25")                                             \
+    DF(HASDC_PM25, "pm25")                                                         /* Concentration of particulate matter less than 2.5 micrometers in µg/m³ */                                        \
-    DF(HASDC_POWER_FACTOR, "power_factor")                             \
+    DF(HASDC_POWER_FACTOR, "power_factor")                                         /* Power factor (unitless), unit may be None or % */                                                                  \
-    DF(HASDC_POWER, "power")                                           \
+    DF(HASDC_POWER, "power")                                                       /* Power in W or kW */                                                                                                \
-    DF(HASDC_PRECIPITATION, "precipitation")                           \
+    DF(HASDC_PRECIPITATION, "precipitation")                                       /* Accumulated precipitation in cm, in or mm */                                                                       \
-    DF(HASDC_PRECIPITATION_INTENSITY, "precipitation_intensity")       \
+    DF(HASDC_PRECIPITATION_INTENSITY, "precipitation_intensity")                   /* Precipitation intensity in in/d, in/h, mm/d or mm/h */                                                             \
-    DF(HASDC_PRESSURE, "pressure")                                     \
+    DF(HASDC_PRESSURE, "pressure")                                                 /* Pressure in Pa, kPa, hPa, bar, cbar, mbar, mmHg, inHg or psi */                                                    \
-    DF(HASDC_REACTIVE_POWER, "reactive_power")                         \
+    DF(HASDC_REACTIVE_POWER, "reactive_power")                                     /* Reactive power in var */                                                                                           \
-    DF(HASDC_SIGNAL_STRENGTH, "signal_strength")                       \
+    DF(HASDC_SIGNAL_STRENGTH, "signal_strength")                                   /* Signal strength in dB or dBm */                                                                                    \
-    DF(HASDC_SPEED, "speed")                                           \
+    DF(HASDC_SPEED, "speed")                                                       /* Generic speed in ft/s, in/d, in/h, km/h, kn, m/s, mph or mm/d */                                                   \
-    DF(HASDC_SULPHUR_DIOXIDE, "sulphur_dioxide")                       \
+    DF(HASDC_SULPHUR_DIOXIDE, "sulphur_dioxide")                                   /* Concentration of sulphur dioxide in µg/m³ */                                                                     \
-    DF(HASDC_TEMPERATURE, "temperature")                               \
+    DF(HASDC_TEMPERATURE, "temperature")                                           /* Temperature in °C, °F or K */                                                                                    \
-    DF(HASDC_TIMESTAMP, "timestamp")                                   \
+    DF(HASDC_TIMESTAMP, "timestamp")                                               /* Datetime object or timestamp string (ISO 8601) */                                                                  \
-    DF(HASDC_VOLATILE_ORGANIC_COMPOUNDS, "volatile_organic_compounds") \
+    DF(HASDC_VOLATILE_ORGANIC_COMPOUNDS, "volatile_organic_compounds")             /* Concentration of volatile organic compounds in µg/m³ */                                                          \
-    DF(HASDC_VOLTAGE, "voltage")                                       \
+    DF(HASDC_VOLTAGE, "voltage")                                                   /* Voltage in V, mV */                                                                                                \
-    DF(HASDC_VOLUME, "volume")                                         \
+    DF(HASDC_VOLUME, "volume")                                                     /* Generic volume in L, mL, gal, fl. oz., m³, ft³, or CCF */                                                        \
-    DF(HASDC_WATER, "water")                                           \
+    DF(HASDC_WATER, "water")                                                       /* Water consumption in L, gal, m³, ft³, or CCF */                                                                  \
-    DF(HASDC_WEIGHT, "weight")                                         \
+    DF(HASDC_WEIGHT, "weight")                                                     /* Generic mass in kg, g, mg, µg, oz, lb, or st */                                                                   \
-    DF(HASDC_WIND_SPEED, "wind_speed")                                 \
+    DF(HASDC_WIND_SPEED, "wind_speed")                                             /* Wind speed in Beaufort, ft/s, km/h, kn, m/s, or mph */                                                             \
+    DF(HASDC_ATMOSPHERIC_PRESSURE, "atmospheric_pressure")                         /* Atmospheric pressure in cbar, bar, hPa, mmHg, inHg, kPa, mbar, Pa or psi */                                        \
+    DF(HASDC_DATA_RATE, "data_rate")                                               /* Data rate in bit/s, kbit/s, Mbit/s, Gbit/s, B/s, kB/s, MB/s, GB/s, KiB/s, MiB/s or GiB/s */                        \
+    DF(HASDC_DATA_SIZE, "data_size")                                               /* Data size in bit, kbit, Mbit, Gbit, B, kB, MB, GB, TB, PB, EB, ZB, YB, KiB, MiB, GiB, TiB, PiB, EiB, ZiB or YiB */ \
+    DF(HASDC_ENERGY_STORAGE, "energy_storage")                                     /* Stored energy in Wh, kWh, MWh, MJ, or GJ */                                                                        \
+    DF(HASDC_ENUM, "enum")                                                         /* Has a limited set of (non-numeric) states */                                                                       \
+    DF(HASDC_IRRADIANCE, "irradiance")                                             /* Irradiance in W/m² or BTU/(h⋅ft²) */                                                                           \
+    DF(HASDC_PH, "ph")                                                             /* Potential hydrogen (pH) value of a water solution */                                                               \
+    DF(HASDC_SOUND_PRESSURE, "sound_pressure")                                     /* Sound pressure in dB or dBA */                                                                                     \
+    DF(HASDC_VOLATILE_ORGANIC_COMPOUNDS_PARTS, "volatile_organic_compounds_parts") /* Ratio of volatile organic compounds in ppm or ppb */                                                               \
+    DF(HASDC_VOLUME_FLOW_RATE, "volume_flow_rate")                                 /* Volume flow rate in m³/h, ft³/min, L/min, gal/min */                                                             \
+    DF(HASDC_VOLUME_STORAGE, "volume_storage")                                     /* Generic stored volume in L, mL, gal, fl. oz., m³, ft³, or CCF */                                                 \
     DF(HASDC_MAX, "")
 
-typedef enum ha_sensor_device_class_t
+typedef enum // Enumeration of sensor types supported by the Home Assistant. For details see https://www.home-assistant.io/integrations/sensor.
 {
 #define DF(_value, _name) _value,
     HA_SENSOR_DEVICE_CLASS
 #undef DF
 } ha_sensor_device_class_t;
 
+/**
+ * @brief Get char description from the enumeration ha_sensor_device_class_t value.
+ *
+ * @note Used to prepare a configuration message for Home Assistant MQTT discovery.
+ *
+ * @param[in] value Enumeration value of ha_sensor_device_class_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_sensor_device_class_value_name(ha_sensor_device_class_t value);
-//***********************************************************************************//
+
 #define HA_SWITCH_DEVICE_CLASS  \
     DF(HASWDC_NONE, "")         \
     DF(HASWDC_OUTLET, "outlet") \
     DF(HASWDC_SWITCH, "switch") \
     DF(HASWDC_MAX, "")
 
-typedef enum ha_switch_device_class_t
+typedef enum // Enumeration of switch types supported by the Home Assistant. For details see https://www.home-assistant.io/integrations/switch.
 {
 #define DF(_value, _name) _value,
     HA_SWITCH_DEVICE_CLASS
 #undef DF
 } ha_switch_device_class_t;
 
+/**
+ * @brief Get char description from the enumeration ha_switch_device_class_t value.
+ *
+ * @note Used to prepare a configuration message for Home Assistant MQTT discovery.
+ *
+ * @param[in] value Enumeration value of ha_switch_device_class_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_switch_device_class_value_name(ha_switch_device_class_t value);
-//***********************************************************************************//
+
 #define HA_ON_OFF_TYPE             \
     DF(HAONOFT_NONE, "")           \
     DF(HAONOFT_ON, "ON")           \
@@ -252,15 +327,24 @@ char *zh_get_switch_device_class_value_name(ha_switch_device_class_t value);
     DF(HAONOFT_LEAKAGE, "LEAKAGE") \
     DF(HAONOFT_MAX, "")
 
-typedef enum ha_on_off_type_t
+typedef enum // Enumeration of payload_on / payload_off types supported by gateway.
 {
 #define DF(_value, _name) _value,
     HA_ON_OFF_TYPE
 #undef DF
 } ha_on_off_type_t;
 
+/**
+ * @brief Get char description from the enumeration ha_on_off_type_t value.
+ *
+ * @note Used to prepare a configuration message for Home Assistant MQTT discovery.
+ *
+ * @param[in] value Enumeration value of ha_on_off_type_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_on_off_type_value_name(ha_on_off_type_t value);
-//***********************************************************************************//
+
 #define HA_CHIP_TYPE              \
     DF(HACHT_NONE, "")            \
     DF(HACHT_ESP32, "ESP32")      \
@@ -272,264 +356,276 @@ char *zh_get_on_off_type_value_name(ha_on_off_type_t value);
     DF(HACHT_ESP32C6, "ESP32-C6") \
     DF(HACHT_MAX, "")
 
-typedef enum ha_chip_type_t
+typedef enum // Enumeration of ESP module types supported by gateway.
 {
 #define DF(_value, _name) _value,
     HA_CHIP_TYPE
 #undef DF
 } ha_chip_type_t;
 
+/**
+ * @brief Get char description from the enumeration ha_chip_type_t value.
+ *
+ * @note Used to prepare a attribytes message by ESP-NOW gateway.
+ *
+ * @param[in] value Enumeration value of ha_chip_type_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_chip_type_value_name(ha_chip_type_t value);
-//***********************************************************************************//
+
 #define HA_LED_EFFECT_TYPE \
     DF(HALET_NONE, "")     \
     DF(HALET_MAX, "")
 
-typedef enum ha_led_effect_type_t
+typedef enum // Enumeration of light effect supported by gateway.
 {
 #define DF(_value, _name) _value,
     HA_LED_EFFECT_TYPE
 #undef DF
 } ha_led_effect_type_t;
-//***********************************************************************************//
+
-#define HA_LED_TYPE         \
+#define HA_LED_TYPE                                                       \
-    DF(HALT_NONE, "")       \
+    DF(HALT_NONE, "")                                                     \
-    DF(HALT_W, "W")         \
+    DF(HALT_W, "Cold white or Warm white or one another color")           \
-    DF(HALT_WW, "WW")       \
+    DF(HALT_WW, "Cold white + Warm white")                                \
-    DF(HALT_RGB, "RGB")     \
+    DF(HALT_RGB, "Red + Green + Blue colors")                             \
-    DF(HALT_RGBW, "RGBW")   \
+    DF(HALT_RGBW, "Red + Green + Blue + Cold white or Warm white colors") \
-    DF(HALT_RGBWW, "RGBWW") \
+    DF(HALT_RGBWW, "Red + Green + Blue + Cold white + Warm white colors") \
     DF(HALT_MAX, "")
 
-typedef enum ha_led_type_t
+typedef enum // Enumeration of led types supported by gateway.
 {
 #define DF(_value, _name) _value,
     HA_LED_TYPE
 #undef DF
 } ha_led_type_t;
 
-char *zh_get_led_type_value_name(ha_led_type_t value);
+#define HA_SENSOR_TYPE                                      \
-//***********************************************************************************//
+    DF(HAST_NONE, "")                                       \
-#define HA_SENSOR_TYPE          \
+    DF(HAST_DS18B20, "DS18B20")                             \
-    DF(HAST_NONE, "")           \
+    DF(HAST_AHT, "AHT") /* AHT10/AHT20/AHT21/AHT25/AHT30 */ \
-    DF(HAST_DS18B20, "DS18B20") \
+    DF(HAST_SHT, "SHT") /* SHT2X/3X/4X */                   \
-    DF(HAST_DHT11, "DHT11")     \
+    DF(HAST_GATEWAY, "")                                    \
-    DF(HAST_DHT22, "DHT22")     \
+    DF(HAST_WINDOW, "")                                     \
-    DF(HAST_GATEWAY, "GATEWAY") \
+    DF(HAST_DOOR, "")                                       \
-    DF(HAST_WINDOW, "WINDOW")   \
+    DF(HAST_LEAKAGE, "")                                    \
-    DF(HAST_DOOR, "DOOR")       \
+    DF(HAST_DHT, "DHT") /* DHT11/DHT22/AM2302/AM2320 */     \
-    DF(HAST_LEAKAGE, "LEAKAGE") \
+    DF(HAST_BH1750, "BH1750")                               \
+    DF(HAST_BMP280, "BMP280") /* BMP180/BMP280 */           \
+    DF(HAST_BME280, "BME280")                               \
+    DF(HAST_BME680, "BME680")                               \
+    DF(HAST_HTU, "HTU") /* HTU20/HTU21/HTU30/HTU31 */       \
+    DF(HAST_HDC1080, "HDC1080")                             \
     DF(HAST_MAX, "")
 
-typedef enum ha_sensor_type_t
+typedef enum // Enumeration of sensor / binary sensor supported by gateway.
 {
 #define DF(_value, _name) _value,
     HA_SENSOR_TYPE
 #undef DF
 } ha_sensor_type_t;
 
+/**
+ * @brief Get char description from the enumeration ha_sensor_type_t value.
+ *
+ * @note Used to prepare at attributes messages and status messages by ESP-NOW gateway.
+ *
+ * @param[in] value Enumeration value of ha_sensor_type_t.
+ *
+ * @return Pointer to char value
+ */
 char *zh_get_sensor_type_value_name(ha_sensor_type_t value);
-//***********************************************************************************//
-typedef struct zh_sensor_config_message_t
-{
-    uint8_t unique_id;
-    ha_sensor_device_class_t sensor_device_class;
-    char unit_of_measurement[5];
-    uint8_t suggested_display_precision;
-    uint16_t expire_after;
-    bool enabled_by_default;
-    bool force_update;
-    uint8_t qos;
-    bool retain;
-} __attribute__((packed)) zh_sensor_config_message_t;
 
-typedef struct zh_sensor_hardware_config_message_t
+typedef struct // Structure for data exchange between ESP-NOW devices.
 {
-    ha_sensor_type_t sensor_type;
+    zh_device_type_t device_type;   // Type of ESP-NOW message sender (gateway, switch, led, etc…).
-    uint8_t sensor_pin_1;
+    zh_payload_type_t payload_type; // Type of payload for indicating to the recipient of the message into which required structure the received data should be converted (if required).
-    uint8_t sensor_pin_2;
+    union                           // Main union for data exchange between ESP-NOW devices. @attention Usually not used in this view. According to the device_type data and payload_type data, the ESP-NOW device should convert the payload_data to the required secondary structure/union (excluding the case of having to send an empty message).
-    uint8_t power_pin;
+    {
-    uint16_t measurement_frequency;
+        struct // Secondary structure of attributes message.
-    bool battery_power;
+        {
-} __attribute__((packed)) zh_sensor_hardware_config_message_t;
+            ha_chip_type_t chip_type;     // Used ESP module type.
+            ha_sensor_type_t sensor_type; // Used sensor/binary sensor type (if present).
+            char flash_size[5];           // SoC flash memory.
+            uint8_t cpu_frequency;        // SoC frequency.
+            uint32_t heap_size;           // Current HEAP memory size.
+            uint32_t min_heap_size;       // Minimum HEAP memory size.
+            uint8_t reset_reason;         // Last reset reason.
+            char app_name[32];            // Firmware application name.
+            char app_version[32];         // Firmware application version.
+            uint32_t uptime;              // Uptime work (in seconds).
+        } attributes_message;
+        struct // Secondary structure of keep alive message.
+        {
+            bool online_status;        // Current status of ESP-NOW device operation. @note Online (true) / Offline (false).
+            uint8_t message_frequency; // Frequency of transmission of the keep alive message by ESP-NOW device. @note Used by the ESP-NOW gateway to set the offline status of a ESP-NOW node when the message sending time is exceeded.
+        } keep_alive_message;
+        union // Secondary union of structures of any configuration messages. @attention Not used in this view. Should be converted to the required tertiary structure.
+        {
+            struct // Tertiary structure of zh_espnow_binary_sensor node configuration message. @note Used for publish at MQTT zh_espnow_binary_sensor node configuration message.
+            {
+                uint8_t unique_id;                                          // An ID that uniquely identifies this binary sensor device. @note The ID will look like this - "MAC-X" (for example 64-B7-08-31-00-A8-1). @attention If two binary sensors have the same unique ID, Home Assistant will raise an exception.
+                ha_binary_sensor_device_class_t binary_sensor_device_class; // Binary sensor type supported by the Home Assistant. @note Used to prepare a correct configuration message for Home Assistant MQTT discovery. For details see https://www.home-assistant.io/integrations/binary_sensor.
+                ha_on_off_type_t payload_on;                                // The payload that represents ON state.
+                ha_on_off_type_t payload_off;                               // The payload that represents OFF state.
+                uint16_t expire_after;                                      // If set, it defines the number of seconds after the sensors state expires, if its not updated. After expiry, the sensors state becomes unavailable.
+                uint16_t off_delay;                                         // For sensors that only send on state updates (like PIRs), this variable sets a delay in seconds after which the sensors state will be updated back to off.
+                bool enabled_by_default;                                    // Flag which defines if the entity should be enabled when first added.
+                bool force_update;                                          // Sends update events (which results in update of state objects last_changed) even if the sensors state hasnt changed. Useful if you want to have meaningful value graphs in history or want to create an automation that triggers on every incoming state message (not only when the sensors new state is different to the current one).
+                uint8_t qos;                                                // The maximum QoS level to be used when receiving and publishing messages.
+                bool retain;                                                // If the published message should have the retain flag on or not.
+            } binary_sensor_config_message;
+            struct // Tertiary structure of zh_espnow_sensor node configuration message. @note Used publish at MQTT zh_espnow_sensor node configuration message.
+            {
+                uint8_t unique_id;                            // An ID that uniquely identifies this sensor device. @note The ID will look like this - "MAC-X" (for example 64-B7-08-31-00-A8-1). @attention If two sensors have the same unique ID, Home Assistant will raise an exception.
+                ha_sensor_device_class_t sensor_device_class; // Sensor type supported by the Home Assistant. @note Used to prepare a correct configuration message for Home Assistant MQTT discovery. For details see https://www.home-assistant.io/integrations/sensor.
+                char unit_of_measurement[5];                  // Defines the units of measurement of the sensor, if any.
+                uint8_t suggested_display_precision;          // The number of decimals which should be used in the sensors state after rounding.
+                uint16_t expire_after;                        // If set, it defines the number of seconds after the sensors state expires, if its not updated. After expiry, the sensors state becomes unavailable.
+                bool enabled_by_default;                      // Flag which defines if the entity should be enabled when first added.
+                bool force_update;                            // Sends update events (which results in update of state objects last_changed) even if the sensors state hasnt changed. Useful if you want to have meaningful value graphs in history or want to create an automation that triggers on every incoming state message (not only when the sensors new state is different to the current one).
+                uint8_t qos;                                  // The maximum QoS level to be used when receiving and publishing messages.
+                bool retain;                                  // If the published message should have the retain flag on or not.
+            } sensor_config_message;
+            struct // Tertiary structure of zh_espnow_sensor node hardware configuration message. @note Used for change hardware configuration / publish at MQTT zh_espnow_sensor node hardware configuration message.
+            {
+                ha_sensor_type_t sensor_type;   // Sensor type. @note Used in zh_espnow_sensor firmware only.
+                uint8_t sensor_pin_1;           // Sensor GPIO number 1. @note Main pin for 1-wire sensors, SDA pin for I2C sensors.
+                uint8_t sensor_pin_2;           // Sensor GPIO number 2. @note SCL pin for I2C sensors.
+                uint8_t power_pin;              // Power GPIO number (if used sensor power control).
+                uint16_t measurement_frequency; // Measurement frequency (sleep time on battery powering).
+                bool battery_power;             // Battery powered. @note Battery powering (true) / external powering (false).
+            } sensor_hardware_config_message;
+            struct // Tertiary structure of zh_espnow_led node configuration message. @note Used for publish at MQTT zh_espnow_led node configuration message.
+            {
+                uint8_t unique_id;            // An ID that uniquely identifies this light device. @note The ID will look like this - "MAC-X" (for example 64-B7-08-31-00-A8-1). @attention If two lights have the same unique ID, Home Assistant will raise an exception.
+                ha_led_type_t led_type;       // Led type. @note Used to identify the led type by ESP-NOW gateway and prepare a correct configuration message for Home Assistant MQTT discovery.
+                ha_on_off_type_t payload_on;  // The payload that represents ON state.
+                ha_on_off_type_t payload_off; // The payload that represents OFF state.
+                bool enabled_by_default;      // Flag which defines if the entity should be enabled when first added.
+                bool optimistic;              // Flag that defines if led works in optimistic mode.
+                uint8_t qos;                  // The maximum QoS level to be used when receiving and publishing messages.
+                bool retain;                  // If the published message should have the retain flag on or not.
+            } led_config_message;
+            struct // Tertiary structure of zh_espnow_led node hardware configuration message. @note Used for change hardware configuration / publish at MQTT zh_espnow_led node hardware configuration message.
+            {
+                ha_led_type_t led_type;   // Led type.
+                uint8_t first_white_pin;  // First white GPIO number.
+                uint8_t second_white_pin; // Second white GPIO number (if present).
+                uint8_t red_pin;          // Red GPIO number (if present).
+                uint8_t green_pin;        // Green GPIO number (if present).
+                uint8_t blue_pin;         // Blue GPIO number (if present).
+            } led_hardware_config_message;
+            struct // Tertiary structure of zh_espnow_switch node configuration message. @note Used for publish at MQTT zh_espnow_switch node configuration message.
+            {
+                uint8_t unique_id;                     // An ID that uniquely identifies this switch device. @note The ID will look like this - "MAC-X" (for example 64-B7-08-31-00-A8-1). @attention If two switches have the same unique ID, Home Assistant will raise an exception.
+                ha_switch_device_class_t device_class; // Switch type supported by the Home Assistant. @note Used to prepare a correct configuration message for Home Assistant MQTT discovery. For details see https://www.home-assistant.io/integrations/switch
+                ha_on_off_type_t payload_on;           // The payload that represents ON state.
+                ha_on_off_type_t payload_off;          // The payload that represents OFF state.
+                bool enabled_by_default;               // Flag which defines if the entity should be enabled when first added.
+                bool optimistic;                       // Flag that defines if switch works in optimistic mode.
+                uint8_t qos;                           // The maximum QoS level to be used when receiving and publishing messages.
+                bool retain;                           // If the published message should have the retain flag on or not.
+            } switch_config_message;
+            struct // Tertiary structure of zh_espnow_switch node hardware configuration message. @note Used for change hardware configuration / publish at MQTT zh_espnow_switch node hardware configuration message.
+            {
+                uint8_t relay_pin;              // Relay GPIO number.
+                bool relay_on_level;            // Relay ON level. @note HIGH (true) / LOW (false).
+                uint8_t led_pin;                // Led GPIO number (if present).
+                bool led_on_level;              // Led ON level (if present). @note HIGH (true) / LOW (false).
+                uint8_t int_button_pin;         // Internal button GPIO number (if present).
+                bool int_button_on_level;       // Internal button trigger level (if present). @note HIGH (true) / LOW (false).
+                uint8_t ext_button_pin;         // External button GPIO number (if present).
+                bool ext_button_on_level;       // External button trigger level (if present). @note HIGH (true) / LOW (false).
+                uint8_t sensor_pin;             // Sensor GPIO number (if present).
+                ha_sensor_type_t sensor_type;   // Sensor type (if present). @note Used to identify the sensor type by ESP-NOW gateway and send the appropriate sensor status messages to MQTT.
+                uint16_t measurement_frequency; // Sensor measurement frequency (if present).
+            } switch_hardware_config_message;
+        } config_message;
+        union // Secondary union of structures of any status messages. @attention Not used in this view. Should be converted to the required tertiary structure.
+        {
+            struct // Tertiary structure of zh_espnow_binary_sensor node status message.
+            {
+                ha_sensor_type_t sensor_type; // Binary sensor type. @note Used to identify the binary sensor type by ESP-NOW gateway and send the appropriate binary sensor status messages to MQTT.
+                ha_on_off_type_t connect;     // Event that caused the sensor to be triggered (if present). @note Example - CONNECT @attention Must be same with set on binary_sensor_config_message structure.
+                ha_on_off_type_t open;        // Event that caused the sensor to be triggered (if present). @note Example - OPEN / CLOSE @attention Must be same with set on binary_sensor_config_message structure.
+                ha_on_off_type_t battery;     // Event that caused the sensor to be triggered (if present). @note Example - HIGH / LOW @attention Must be same with set on binary_sensor_config_message structure.
+                ha_on_off_type_t leakage;     // Event that caused the sensor to be triggered (if present). @note Example - DRY / LEAKAGE @attention Must be same with set on binary_sensor_config_message structure.
+                ha_on_off_type_t reserved_1;  // Reserved for future development.
+                ha_on_off_type_t reserved_2;  // Reserved for future development.
+                ha_on_off_type_t reserved_3;  // Reserved for future development.
+                ha_on_off_type_t reserved_4;  // Reserved for future development.
+                ha_on_off_type_t reserved_5;  // Reserved for future development.
+                ha_on_off_type_t reserved_6;  // Reserved for future development.
+                ha_on_off_type_t reserved_7;  // Reserved for future development.
+                ha_on_off_type_t reserved_8;  // Reserved for future development.
+                ha_on_off_type_t reserved_9;  // Reserved for future development.
+                ha_on_off_type_t reserved_10; // Reserved for future development.
+                ha_on_off_type_t reserved_11; // Reserved for future development.
+                ha_on_off_type_t reserved_12; // Reserved for future development.
+                ha_on_off_type_t reserved_13; // Reserved for future development.
+                ha_on_off_type_t reserved_14; // Reserved for future development.
+                ha_on_off_type_t reserved_15; // Reserved for future development.
+            } binary_sensor_status_message;
+            struct // Tertiary structure of zh_espnow_sensor node status message.
+            {
+                ha_sensor_type_t sensor_type; // Sensor type. @note Used to identify the sensor type by ESP-NOW gateway and send the appropriate sensor status messages to MQTT.
+                float temperature;            // Temperature value (if present).
+                float humidity;               // Humidity value (if present).
+                float atmospheric_pressure;   // Atmospheric pressure value (if present).
+                float aqi;                    // Air quality index (if present).
+                float voltage;                // Voltage value (if present).
+                float illuminance;            // Light level (if present).
+                float uv_index;               // UV index (if present).
+                float reserved_3;             // Reserved for future development.
+                float reserved_4;             // Reserved for future development.
+                float reserved_5;             // Reserved for future development.
+                float reserved_6;             // Reserved for future development.
+                float reserved_7;             // Reserved for future development.
+                float reserved_8;             // Reserved for future development.
+                float reserved_9;             // Reserved for future development.
+                float reserved_10;            // Reserved for future development.
+                float reserved_11;            // Reserved for future development.
+                float reserved_12;            // Reserved for future development.
+                float reserved_13;            // Reserved for future development.
+                float reserved_14;            // Reserved for future development.
+                float reserved_15;            // Reserved for future development.
+            } sensor_status_message;
+            struct // Tertiary structure of zh_espnow_led node status message.
+            {
+                ha_on_off_type_t status;     // Status of the zh_espnow_led. @note Example - ON / OFF. @attention Must be same with set on led_config_message structure.
+                uint8_t brightness;          // Brightness value.
+                uint16_t temperature;        // White color temperature value (if present).
+                uint8_t red;                 // Red color value (if present).
+                uint8_t green;               // Green color value (if present).
+                uint8_t blue;                // Blue color value (if present).
+                ha_led_effect_type_t effect; // Reserved for future development.
+            } led_status_message;
+            struct // Tertiary structure of zh_espnow_switch node status message.
+            {
+                ha_on_off_type_t status; // Status of the zh_espnow_switch. @note Example - ON / OFF. @attention Must be same with set on switch_config_message structure.
+            } switch_status_message;
+            struct // Tertiary structure of ESP-NOW node error message.
+            {
+                char message[150]; // Error message.
+            } error_message;
 
-typedef struct zh_binary_sensor_config_message_t
+        } status_message;
-{
+        union // Secondary union of structures of any OTA update messages. @attention Not used in this view. Should be converted to the required tertiary structure.
-    uint8_t unique_id;
+        {
-    ha_binary_sensor_device_class_t binary_sensor_device_class;
+            struct // Tertiary structure for transfer from ESP-NOW node to ESP-NOW gateway system information for OTA update initialization.
-    ha_on_off_type_t payload_on;
+            {
-    ha_on_off_type_t payload_off;
+                char app_name[32];    // Firmware application name.
-    uint16_t expire_after;
+                char app_version[32]; // Firmware application version.
-    uint16_t off_delay;
+            } espnow_ota_data;
-    bool enabled_by_default;
+            struct // Tertiary structure for transfer from ESP-NOW gateway to ESP-NOW node OTA update data.
-    bool force_update;
+            {
-    uint8_t qos;
+                uint16_t part;     // System counter for the number of new firmware sent parts.
-    bool retain;
+                uint8_t data_len;  // Size of sent data @note Except for the last part, the data is transmitted in 200 bytes part size.
-} __attribute__((packed)) zh_binary_sensor_config_message_t;
+                uint8_t data[200]; // Sent data.
+            } espnow_ota_message;
+        } ota_message;
+    } payload_data;
 
-typedef struct zh_led_config_message_t
-{
-    uint8_t unique_id;
-    ha_led_type_t led_type;
-    ha_on_off_type_t payload_on;
-    ha_on_off_type_t payload_off;
-    bool enabled_by_default;
-    bool optimistic;
-    uint8_t qos;
-    bool retain;
-} __attribute__((packed)) zh_led_config_message_t;
-
-typedef struct zh_led_hardware_config_message_t
-{
-    ha_led_type_t led_type;
-    uint8_t first_white_pin;
-    uint8_t second_white_pin;
-    uint8_t red_pin;
-    uint8_t green_pin;
-    uint8_t blue_pin;
-} __attribute__((packed)) zh_led_hardware_config_message_t;
-
-typedef struct zh_switch_config_message_t
-{
-    uint8_t unique_id;
-    ha_switch_device_class_t device_class;
-    ha_on_off_type_t payload_on;
-    ha_on_off_type_t payload_off;
-    bool enabled_by_default;
-    bool optimistic;
-    uint8_t qos;
-    bool retain;
-} __attribute__((packed)) zh_switch_config_message_t;
-
-typedef struct zh_switch_hardware_config_message_t
-{
-    uint8_t relay_pin;
-    bool relay_on_level;
-    uint8_t led_pin;
-    bool led_on_level;
-    uint8_t int_button_pin;
-    bool int_button_on_level;
-    uint8_t ext_button_pin;
-    bool ext_button_on_level;
-    uint8_t sensor_pin;
-    ha_sensor_type_t sensor_type;
-} __attribute__((packed)) zh_switch_hardware_config_message_t;
-//***********************************************************************************//
-typedef struct zh_sensor_status_message_t
-{
-    ha_sensor_type_t sensor_type;
-    float temperature;
-    float humidity;
-    float pressure;
-    float quality;
-    float voltage;
-    float reserved_1; // Reserved for future development.
-    float reserved_2; // Reserved for future development.
-    float reserved_3; // Reserved for future development.
-    float reserved_4; // Reserved for future development.
-    float reserved_5; // Reserved for future development.
-} __attribute__((packed)) zh_sensor_status_message_t;
-
-typedef struct zh_binary_sensor_status_message_t
-{
-    ha_sensor_type_t sensor_type;
-    ha_on_off_type_t connect;
-    ha_on_off_type_t open;
-    ha_on_off_type_t battery;
-    ha_on_off_type_t leakage;
-    ha_on_off_type_t reserved_1; // Reserved for future development.
-    ha_on_off_type_t reserved_2; // Reserved for future development.
-    ha_on_off_type_t reserved_3; // Reserved for future development.
-    ha_on_off_type_t reserved_4; // Reserved for future development.
-    ha_on_off_type_t reserved_5; // Reserved for future development.
-} __attribute__((packed)) zh_binary_sensor_status_message_t;
-
-typedef struct zh_led_status_message_t
-{
-    ha_on_off_type_t status;
-    uint8_t brightness;
-    uint16_t temperature;
-    uint8_t red;
-    uint8_t green;
-    uint8_t blue;
-    ha_led_effect_type_t effect; // Reserved for future development.
-} __attribute__((packed)) zh_led_status_message_t;
-
-typedef struct zh_switch_status_message_t
-{
-    ha_on_off_type_t status;
-} __attribute__((packed)) zh_switch_status_message_t;
-//***********************************************************************************//
-typedef struct zh_attributes_message_t
-{
-    ha_chip_type_t chip_type;
-    ha_sensor_type_t sensor_type;
-    char flash_size[5];
-    uint8_t cpu_frequency;
-    uint32_t heap_size;
-    uint32_t min_heap_size;
-    uint8_t reset_reason;
-    char app_name[32];
-    char app_version[32];
-    uint32_t uptime;
-} __attribute__((packed)) zh_attributes_message_t;
-
-typedef struct zh_keep_alive_message_t
-{
-    bool online_status;
-    uint8_t message_frequency;
-} __attribute__((packed)) zh_keep_alive_message_t;
-
-typedef union zh_config_message_t
-{
-    zh_binary_sensor_config_message_t binary_sensor_config_message;
-    zh_sensor_config_message_t sensor_config_message;
-    zh_sensor_hardware_config_message_t sensor_hardware_config_message;
-    zh_led_config_message_t led_config_message;
-    zh_led_hardware_config_message_t led_hardware_config_message;
-    zh_switch_config_message_t switch_config_message;
-    zh_switch_hardware_config_message_t switch_hardware_config_message;
-} __attribute__((packed)) zh_config_message_t;
-
-typedef union zh_status_message_t
-{
-    zh_binary_sensor_status_message_t binary_sensor_status_message;
-    zh_sensor_status_message_t sensor_status_message;
-    zh_led_status_message_t led_status_message;
-    zh_switch_status_message_t switch_status_message;
-} __attribute__((packed)) zh_status_message_t;
-
-typedef struct zh_espnow_ota_message_t
-{
-    ha_chip_type_t chip_type;
-    char app_name[32];
-    char app_version[32];
-    uint16_t part;
-    uint8_t data_len;
-    uint8_t data[128];
-} __attribute__((packed)) zh_espnow_ota_message_t;
-
-typedef struct zh_espnow_ota_data_t
-{
-    ha_chip_type_t chip_type;
-    zh_device_type_t device_type;
-    char app_name[32];
-    char app_version[32];
-    uint8_t mac_addr[6];
-} __attribute__((packed)) zh_espnow_ota_data_t;
-
-typedef union zh_payload_data_t
-{
-    zh_attributes_message_t attributes_message;
-    zh_keep_alive_message_t keep_alive_message;
-    zh_config_message_t config_message;
-    zh_status_message_t status_message;
-    zh_espnow_ota_message_t espnow_ota_message;
-} __attribute__((packed)) zh_payload_data_t;
-
-typedef struct zh_espnow_data_t
-{
-    zh_device_type_t device_type;
-    zh_payload_type_t payload_type;
-    zh_payload_data_t payload_data;
 } __attribute__((packed)) zh_espnow_data_t;

version.txt

@@ -1 +1 @@
-1.0.0
+2.0.5

zh_config.c

@@ -144,22 +144,6 @@ char *zh_get_chip_type_value_name(ha_chip_type_t value)
     return "";
 }
 
-char *zh_get_led_type_value_name(ha_led_type_t value)
-{
-    switch (value)
-    {
-#define DF(_value, _name) \
-    case _value:          \
-        return _name;
-        HA_LED_TYPE
-#undef DF
-        break;
-    default:
-        break;
-    }
-    return "";
-}
-
 char *zh_get_sensor_type_value_name(ha_sensor_type_t value)
 {
     switch (value)