alexey.zholtikov/zh_config
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 7 Wiki Activity

Compare commits

base: alexey.zholtikov:v2.0.1
Branches Tags
alexey.zholtikov:main
alexey.zholtikov:v2.0.5
alexey.zholtikov:v2.0.4
alexey.zholtikov:v2.0.3
alexey.zholtikov:v2.0.2
alexey.zholtikov:v2.0.1
alexey.zholtikov:v2.0.0
alexey.zholtikov:v1.0.0
...
compare: alexey.zholtikov:main
Branches Tags
alexey.zholtikov:main
alexey.zholtikov:v2.0.5
alexey.zholtikov:v2.0.4
alexey.zholtikov:v2.0.3
alexey.zholtikov:v2.0.2
alexey.zholtikov:v2.0.1
alexey.zholtikov:v2.0.0
alexey.zholtikov:v1.0.0

7 Commits
v2.0.1 ... main

Author SHA1 Message Date
Alexey Zholtikov
73e8a70f4f Version 2.0.5 
Added sensor measurement frequency in switch hardware configuration.
 2024-07-19 15:10:38 +03:00
Alexey Zholtikov
db717bf6ee Version 2.0.4 
Added support for error messages.
 2024-07-16 09:05:55 +03:00
Alexey Zholtikov
49a4564b99 Minor changes 2024-07-05 11:38:51 +03:00
Alexey Zholtikov
4b9ccf882d Version 2.0.3 
Updated supported sensors.
 2024-07-03 07:11:37 +03:00
Alexey Zholtikov
c568d84e56 Version 2.0.2 
Updated ha_sensor_device_class_t enumeration.
Updated binary_sensor_status_message structure.
Updated sensor_status_message structure.
 2024-06-24 18:06:25 +03:00
Alexey Zholtikov
befd1cd3bb Recovered erroneously deleted data 2024-06-23 22:08:45 +03:00
Alexey Zholtikov
7a42949720 Removed unused data 2024-06-23 21:36:34 +03:00
2 changed files with 115 additions and 75 deletions
Show Stats Expand all files Collapse all files

188
include/zh_config.h
View File

@ -69,6 +69,7 @@ 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 // Enumeration of payload types supported by the ESP-NOW gateway.
@ -213,48 +214,59 @@ typedef enum // Enumeration of cover types supported by the Home Assistant. For
*/
char *zh_get_cover_device_class_value_name(ha_cover_device_class_t value);
#define HA_SENSOR_DEVICE_CLASS \
DF(HASDC_NONE, "") \
DF(HASDC_APPARENT_POWER, "apparent_power") \
DF(HASDC_AQI, "aqi") \
DF(HASDC_BATTERY, "battery") \
DF(HASDC_CARBON_DIOXIDE, "carbon_dioxide") \
DF(HASDC_CARBON_MONOXIDE, "carbon_monoxide") \
DF(HASDC_CURRENT, "current") \
DF(HASDC_DATE, "date") \
DF(HASDC_DISTANCE, "distance") \
DF(HASDC_DURATION, "duration") \
DF(HASDC_ENERGY, "energy") \
DF(HASDC_FREQUENCY, "frequency") \
DF(HASDC_GAS, "gas") \
DF(HASDC_HUMIDITY, "humidity") \
DF(HASDC_ILLUMINANCE, "illuminance") \
DF(HASDC_MOISTURE, "moisture") \
DF(HASDC_MONETARY, "monetar") \
DF(HASDC_NITROGEN_DIOXIDE, "nitrogen_dioxide") \
DF(HASDC_NITROGEN_MONOXIDE, "nitrogen_monoxide") \
DF(HASDC_NITROUS_OXIDE, "nitrous_oxide") \
DF(HASDC_OZONE, "ozone") \
DF(HASDC_PM1, "pm1") \
DF(HASDC_PM10, "pm10") \
DF(HASDC_PM25, "pm25") \
DF(HASDC_POWER_FACTOR, "power_factor") \
DF(HASDC_POWER, "power") \
DF(HASDC_PRECIPITATION, "precipitation") \
DF(HASDC_PRECIPITATION_INTENSITY, "precipitation_intensity") \
DF(HASDC_PRESSURE, "pressure") \
DF(HASDC_REACTIVE_POWER, "reactive_power") \
DF(HASDC_SIGNAL_STRENGTH, "signal_strength") \
DF(HASDC_SPEED, "speed") \
DF(HASDC_SULPHUR_DIOXIDE, "sulphur_dioxide") \
DF(HASDC_TEMPERATURE, "temperature") \
DF(HASDC_TIMESTAMP, "timestamp") \
DF(HASDC_VOLATILE_ORGANIC_COMPOUNDS, "volatile_organic_compounds") \
DF(HASDC_VOLTAGE, "voltage") \
DF(HASDC_VOLUME, "volume") \
DF(HASDC_WATER, "water") \
DF(HASDC_WEIGHT, "weight") \
DF(HASDC_WIND_SPEED, "wind_speed") \
#define HA_SENSOR_DEVICE_CLASS \
DF(HASDC_NONE, "") \
DF(HASDC_APPARENT_POWER, "apparent_power") /* Apparent power in VA */ \
DF(HASDC_AQI, "aqi") /* Air quality index (unitless) */ \
DF(HASDC_BATTERY, "battery") /* Percentage of battery that is left in % */ \
DF(HASDC_CARBON_DIOXIDE, "carbon_dioxide") /* Carbon dioxide in CO2 (Smoke) in ppm */ \
DF(HASDC_CARBON_MONOXIDE, "carbon_monoxide") /* Carbon monoxide in CO (Gas CNG/LPG) in ppm */ \
DF(HASDC_CURRENT, "current") /* Current in A, mA */ \
DF(HASDC_DATE, "date") /* Date string (ISO 8601) */ \
DF(HASDC_DISTANCE, "distance") /* Generic distance in km, m, cm, mm, mi, yd, or in */ \
DF(HASDC_DURATION, "duration") /* Duration in d, h, min, or s */ \
DF(HASDC_ENERGY, "energy") /* Energy in Wh, kWh, MWh, MJ, or GJ */ \
DF(HASDC_FREQUENCY, "frequency") /* Frequency in Hz, kHz, MHz, or GHz */ \
DF(HASDC_GAS, "gas") /* Gasvolume in m³, ft³ or CCF */ \
DF(HASDC_HUMIDITY, "humidity") /* Percentage of humidity in the air in % */ \
DF(HASDC_ILLUMINANCE, "illuminance") /* The current light level in lx */ \
DF(HASDC_MOISTURE, "moisture") /* Percentage of water in a substance in % */ \
DF(HASDC_MONETARY, "monetary") /* The monetary value (ISO 4217) */ \
DF(HASDC_NITROGEN_DIOXIDE, "nitrogen_dioxide") /* Concentration of nitrogen dioxide in µg/m³ */ \
DF(HASDC_NITROGEN_MONOXIDE, "nitrogen_monoxide") /* Concentration of nitrogen monoxide in µg/m³ */ \
DF(HASDC_NITROUS_OXIDE, "nitrous_oxide") /* Concentration of nitrous oxide in µg/m³ */ \
DF(HASDC_OZONE, "ozone") /* Concentration of ozone in µg/m³ */ \
DF(HASDC_PM1, "pm1") /* Concentration of particulate matter less than 1 micrometer in µg/m³ */ \
DF(HASDC_PM10, "pm10") /* Concentration of particulate matter less than 10 micrometers in µg/m³ */ \
DF(HASDC_PM25, "pm25") /* Concentration of particulate matter less than 2.5 micrometers in µg/m³ */ \
DF(HASDC_POWER_FACTOR, "power_factor") /* Power factor (unitless), unit may be None or % */ \
DF(HASDC_POWER, "power") /* Power in W or kW */ \
DF(HASDC_PRECIPITATION, "precipitation") /* Accumulated precipitation in cm, in or mm */ \
DF(HASDC_PRECIPITATION_INTENSITY, "precipitation_intensity") /* Precipitation intensity in in/d, in/h, mm/d or mm/h */ \
DF(HASDC_PRESSURE, "pressure") /* Pressure in Pa, kPa, hPa, bar, cbar, mbar, mmHg, inHg or psi */ \
DF(HASDC_REACTIVE_POWER, "reactive_power") /* Reactive power in var */ \
DF(HASDC_SIGNAL_STRENGTH, "signal_strength") /* Signal strength in dB or dBm */ \
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") /* Concentration of sulphur dioxide in µg/m³ */ \
DF(HASDC_TEMPERATURE, "temperature") /* Temperature in °C, °F or K */ \
DF(HASDC_TIMESTAMP, "timestamp") /* Datetime object or timestamp string (ISO 8601) */ \
DF(HASDC_VOLATILE_ORGANIC_COMPOUNDS, "volatile_organic_compounds") /* Concentration of volatile organic compounds in µg/m³ */ \
DF(HASDC_VOLTAGE, "voltage") /* Voltage in V, mV */ \
DF(HASDC_VOLUME, "volume") /* Generic volume in L, mL, gal, fl. oz., m³, ft³, or CCF */ \
DF(HASDC_WATER, "water") /* Water consumption in L, gal, m³, ft³, or CCF */ \
DF(HASDC_WEIGHT, "weight") /* Generic mass in kg, g, mg, µg, oz, lb, or st */ \
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 // Enumeration of sensor types supported by the Home Assistant. For details see https://www.home-assistant.io/integrations/sensor.
@ -389,20 +401,22 @@ typedef enum // Enumeration of led types supported by gateway.
#undef DF
} ha_led_type_t;
#define HA_SENSOR_TYPE \
DF(HAST_NONE, "") \
DF(HAST_DS18B20, "DS18B20") \
DF(HAST_DHT11, "DHT11") /* Deprecated. Will be removed soon. */ \
DF(HAST_DHT22, "DHT22") /* Deprecated. Will be removed soon. */ \
DF(HAST_GATEWAY, "") \
DF(HAST_WINDOW, "") \
DF(HAST_DOOR, "") \
DF(HAST_LEAKAGE, "") \
DF(HAST_DHT, "DHT") /* DHT11/DHT22/AM2302/AM2320 */ \
DF(HAST_BH1750, "BH1750") \
DF(HAST_BMP280, "BMP280") /* BMP180/BMP280 */ \
DF(HAST_BME280, "BME280") \
DF(HAST_BME680, "BME680") \
#define HA_SENSOR_TYPE \
DF(HAST_NONE, "") \
DF(HAST_DS18B20, "DS18B20") \
DF(HAST_AHT, "AHT") /* AHT10/AHT20/AHT21/AHT25/AHT30 */ \
DF(HAST_SHT, "SHT") /* SHT2X/3X/4X */ \
DF(HAST_GATEWAY, "") \
DF(HAST_WINDOW, "") \
DF(HAST_DOOR, "") \
DF(HAST_LEAKAGE, "") \
DF(HAST_DHT, "DHT") /* DHT11/DHT22/AM2302/AM2320 */ \
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 // Enumeration of sensor / binary sensor supported by gateway.
@ -476,7 +490,7 @@ typedef struct // Structure for data exchange between ESP-NOW devices.
} 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 types. @note Used in zh_espnow_sensor firmware only.
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).
@ -496,7 +510,7 @@ typedef struct // Structure for data exchange between ESP-NOW devices.
} 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 types. @note Used in zh_espnow_led firmware only.
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).
@ -516,23 +530,24 @@ typedef struct // Structure for data exchange between ESP-NOW devices.
} 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 types (if present). @note Used to identify the sensor type by ESP-NOW gateway and send the appropriate sensor status messages to MQTT.
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 types. @note Used to identify the binary sensor type by ESP-NOW gateway and send the appropriate binary sensor status messages to MQTT.
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.
@ -542,20 +557,40 @@ typedef struct // Structure for data exchange between ESP-NOW devices.
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 types. @note Used to identify the sensor type by ESP-NOW gateway and send the appropriate sensor status messages to MQTT.
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 pressure; // Pressure value (if present).
float quality; // Quality 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 reserved_1; // Reserved for future development.
float reserved_2; // Reserved for future development.
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.
{
@ -571,6 +606,11 @@ typedef struct // Structure for data exchange between ESP-NOW devices.
{
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;
} 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.
{

2
version.txt
View File

@ -1 +1 @@
2.0.1
2.0.5