Updated one comment

This commit is contained in:
2024-05-29 14:14:14 +03:00
parent cb30d73628
commit 3d18e539da

View File

@ -54,7 +54,7 @@
typedef struct // Structure of data exchange between tasks, functions and event handlers. typedef struct // Structure of data exchange between tasks, functions and event handlers.
{ {
struct struct // Storage structure of sensor hardware configuration data.
{ {
ha_sensor_type_t sensor_type; // Sensor types. ha_sensor_type_t sensor_type; // Sensor types.
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_1; // Sensor GPIO number 1. @note Main pin for 1-wire sensors, SDA pin for I2C sensors.
@ -62,7 +62,7 @@ typedef struct // Structure of data exchange between tasks, functions and event
uint8_t power_pin; // Power GPIO number (if used sensor power control). uint8_t power_pin; // Power GPIO number (if used sensor power control).
uint16_t measurement_frequency; // Measurement frequency (sleep time on battery powering). uint16_t measurement_frequency; // Measurement frequency (sleep time on battery powering).
bool battery_power; // Battery powered. @note Battery powering (true) / external powering (false). bool battery_power; // Battery powered. @note Battery powering (true) / external powering (false).
} hardware_config; // Storage structure of sensor hardware configuration data. } hardware_config;
volatile bool gateway_is_available; // Gateway availability status flag. @note Used to control the tasks when the gateway connection is established / lost. Used only when external powered. volatile bool gateway_is_available; // Gateway availability status flag. @note Used to control the tasks when the gateway connection is established / lost. Used only when external powered.
uint8_t gateway_mac[6]; // Gateway MAC address. @note Used only when external powered. uint8_t gateway_mac[6]; // Gateway MAC address. @note Used only when external powered.
uint8_t sent_message_quantity; // System counter for the number of sended messages. @note Used only when powered by battery. uint8_t sent_message_quantity; // System counter for the number of sended messages. @note Used only when powered by battery.