docs(zigbee): Update Thermostat APIs

Author: P-R-O-C-H-Y

docs/en/zigbee/ep_thermostat.rst

@@ -5,13 +5,14 @@ ZigbeeThermostat
 About
 -----
 
-The ``ZigbeeThermostat`` class provides a thermostat endpoint for Zigbee networks that receives temperature data from temperature sensors. This endpoint implements the Zigbee Home Automation (HA) standard for thermostats that can bind to temperature sensors and receive temperature readings.
+The ``ZigbeeThermostat`` class provides a thermostat endpoint for Zigbee networks.
+This endpoint implements the Zigbee Home Automation (HA) standard for thermostats that can bind to temperature and humidity sensors and receive temperature and humidity readings.
 
 **Features:**
 * Automatic discovery and binding to temperature sensors
-* Temperature data reception from bound sensors
-* Configurable temperature reporting intervals
-* Sensor settings retrieval (min/max temperature, tolerance)
+* Temperature and humidity data reception from bound sensors
+* Configurable temperature and humidity reporting intervals
+* Sensor settings retrieval (min/max/tolerance for temperature and humidity)
 * Multiple addressing modes (group, specific endpoint, IEEE address)
 
 API Reference
@@ -60,20 +61,60 @@ Sets a callback function for receiving temperature data with source information.
 * ``src_endpoint`` - Source endpoint that sent the temperature data
 * ``src_address`` - Source address information
 
-onConfigReceive
-^^^^^^^^^^^^^^^
+onTempConfigReceive
+^^^^^^^^^^^^^^^^^^^
 
 Sets a callback function for receiving sensor configuration data.
 
 .. code-block:: arduino
 
-    void onConfigReceive(void (*callback)(float min_temp, float max_temp, float tolerance));
+    void onTempConfigReceive(void (*callback)(float min_temp, float max_temp, float tolerance));
 
 * ``callback`` - Function to call when sensor configuration is received
 * ``min_temp`` - Minimum temperature supported by the sensor
 * ``max_temp`` - Maximum temperature supported by the sensor
 * ``tolerance`` - Temperature tolerance of the sensor
 
+onHumidityReceive
+^^^^^^^^^^^^^^^^^
+
+Sets a callback function for receiving humidity data.
+
+.. code-block:: arduino
+
+    void onHumidityReceive(void (*callback)(float humidity));
+    
+* ``callback`` - Function to call when humidity data is received
+* ``humidity`` - Humidity value in percentage
+
+onHumidityReceiveWithSource
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets a callback function for receiving humidity data with source information.
+
+.. code-block:: arduino
+
+    void onHumidityReceiveWithSource(void (*callback)(float humidity, uint8_t src_endpoint, esp_zb_zcl_addr_t src_address));
+
+* ``callback`` - Function to call when humidity data is received
+* ``humidity`` - Humidity value in percentage
+* ``src_endpoint`` - Source endpoint that sent the humidity data
+* ``src_address`` - Source address information
+
+onHumidityConfigReceive
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets a callback function for receiving humidity sensor configuration data.
+
+.. code-block:: arduino
+
+    void onHumidityConfigReceive(void (*callback)(float min_humidity, float max_humidity, float tolerance));
+
+* ``callback`` - Function to call when humidity sensor configuration is received
+* ``min_humidity`` - Minimum humidity supported by the sensor
+* ``max_humidity`` - Maximum humidity supported by the sensor
+* ``tolerance`` - Humidity tolerance of the sensor
+
 Temperature Data Retrieval
 **************************
 
@@ -98,7 +139,7 @@ Requests temperature data from a specific group.
 * ``group_addr`` - Group address to send the request to
 
 getTemperature (Endpoint + Short Address)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Requests temperature data from a specific endpoint using short address.
 
@@ -110,7 +151,7 @@ Requests temperature data from a specific endpoint using short address.
 * ``short_addr`` - Short address of the target device
 
 getTemperature (Endpoint + IEEE Address)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Requests temperature data from a specific endpoint using IEEE address.
 
@@ -121,49 +162,143 @@ Requests temperature data from a specific endpoint using IEEE address.
 * ``endpoint`` - Target endpoint number
 * ``ieee_addr`` - IEEE address of the target device
 
-Sensor Settings Retrieval
-*************************
+Humidity Data Retrieval
+***********************
 
-getSensorSettings
-^^^^^^^^^^^^^^^^^
+getHumidity
+^^^^^^^^^^^
+
+Requests humidity data from all bound sensors.
+
+.. code-block:: arduino
+
+    void getHumidity();
+
+getHumidity (Group)
+^^^^^^^^^^^^^^^^^^^
+
+Requests humidity data from a specific group.
+
+.. code-block:: arduino
+
+    void getHumidity(uint16_t group_addr);
+
+* ``group_addr`` - Group address to send the request to
+
+getHumidity (Endpoint + Short Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Requests humidity data from a specific endpoint using short address.
+
+.. code-block:: arduino
+
+    void getHumidity(uint8_t endpoint, uint16_t short_addr);
+
+* ``endpoint`` - Target endpoint number
+* ``short_addr`` - Short address of the target device
+
+getHumidity (Endpoint + IEEE Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Requests humidity data from a specific endpoint using IEEE address.
+
+.. code-block:: arduino
+
+    void getHumidity(uint8_t endpoint, esp_zb_ieee_addr_t ieee_addr);
+
+* ``endpoint`` - Target endpoint number
+* ``ieee_addr`` - IEEE address of the target device
+
+Temperature Settings Retrieval
+******************************
+
+getTemperatureSettings
+^^^^^^^^^^^^^^^^^^^^^^
+
+Requests temperature sensor settings from all bound sensors.
+
+.. code-block:: arduino
+
+    void getTemperatureSettings();
+
+getTemperatureSettings (Group)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Requests temperature sensor settings from a specific group.
 
-Requests sensor settings from all bound sensors.
+.. code-block:: arduino
+
+    void getTemperatureSettings(uint16_t group_addr);
+
+* ``group_addr`` - Group address to send the request to
+
+getTemperatureSettings (Endpoint + Short Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Requests temperature sensor settings from a specific endpoint using short address.
 
 .. code-block:: arduino
 
-    void getSensorSettings();
+    void getTemperatureSettings(uint8_t endpoint, uint16_t short_addr);
+
+* ``endpoint`` - Target endpoint number
+* ``short_addr`` - Short address of the target device
+
+getTemperatureSettings (Endpoint + IEEE Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Requests temperature sensor settings from a specific endpoint using IEEE address.
+
+.. code-block:: arduino
+
+    void getTemperatureSettings(uint8_t endpoint, esp_zb_ieee_addr_t ieee_addr);
+
+* ``endpoint`` - Target endpoint number
+* ``ieee_addr`` - IEEE address of the target device
+
+Humidity Settings Retrieval
+***************************
+
+getHumiditySettings
+^^^^^^^^^^^^^^^^^^^
 
-getSensorSettings (Group)
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Requests humidity sensor settings from all bound sensors.
 
-Requests sensor settings from a specific group.
+.. code-block:: arduino
+    
+    void getHumiditySettings();
+
+getHumiditySettings (Group)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Requests humidity sensor settings from a specific group.
 
 .. code-block:: arduino
 
-    void getSensorSettings(uint16_t group_addr);
+    void getHumiditySettings(uint16_t group_addr);
 
 * ``group_addr`` - Group address to send the request to
 
-getSensorSettings (Endpoint + Short Address)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+getHumiditySettings (Endpoint + Short Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Requests sensor settings from a specific endpoint using short address.
+Requests humidity sensor settings from a specific endpoint using short address.
 
 .. code-block:: arduino
 
-    void getSensorSettings(uint8_t endpoint, uint16_t short_addr);
+    void getHumiditySettings(uint8_t endpoint, uint16_t short_addr);
 
 * ``endpoint`` - Target endpoint number
 * ``short_addr`` - Short address of the target device
 
-getSensorSettings (Endpoint + IEEE Address)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+getHumiditySettings (Endpoint + IEEE Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Requests sensor settings from a specific endpoint using IEEE address.
+Requests humidity sensor settings from a specific endpoint using IEEE address.
 
 .. code-block:: arduino
 
-    void getSensorSettings(uint8_t endpoint, esp_zb_ieee_addr_t ieee_addr);
+    void getHumiditySettings(uint8_t endpoint, esp_zb_ieee_addr_t ieee_addr);
 
 * ``endpoint`` - Target endpoint number
 * ``ieee_addr`` - IEEE address of the target device
@@ -228,6 +363,66 @@ Configures temperature reporting for a specific endpoint using IEEE address.
 * ``max_interval`` - Maximum reporting interval in seconds
 * ``delta`` - Minimum change in temperature to trigger a report
 
+Humidity Reporting Configuration
+********************************
+
+setHumidityReporting
+^^^^^^^^^^^^^^^^^^^^
+
+Configures humidity reporting for all bound sensors.
+
+.. code-block:: arduino
+
+    void setHumidityReporting(uint16_t min_interval, uint16_t max_interval, float delta);
+
+* ``min_interval`` - Minimum reporting interval in seconds
+* ``max_interval`` - Maximum reporting interval in seconds
+* ``delta`` - Minimum change in humidity to trigger a report
+
+setHumidityReporting (Group)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Configures humidity reporting for a specific group.
+
+.. code-block:: arduino
+
+    void setHumidityReporting(uint16_t group_addr, uint16_t min_interval, uint16_t max_interval, float delta);
+
+* ``group_addr`` - Group address to configure
+* ``min_interval`` - Minimum reporting interval in seconds
+* ``max_interval`` - Maximum reporting interval in seconds
+* ``delta`` - Minimum change in humidity to trigger a report
+
+setHumidityReporting (Endpoint + Short Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Configures humidity reporting for a specific endpoint using short address.
+
+.. code-block:: arduino
+
+    void setHumidityReporting(uint8_t endpoint, uint16_t short_addr, uint16_t min_interval, uint16_t max_interval, float delta);
+
+* ``endpoint`` - Target endpoint number
+* ``short_addr`` - Short address of the target device
+* ``min_interval`` - Minimum reporting interval in seconds
+* ``max_interval`` - Maximum reporting interval in seconds
+* ``delta`` - Minimum change in humidity to trigger a report
+
+setHumidityReporting (Endpoint + IEEE Address)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Configures humidity reporting for a specific endpoint using IEEE address.
+
+.. code-block:: arduino
+
+    void setHumidityReporting(uint8_t endpoint, esp_zb_ieee_addr_t ieee_addr, uint16_t min_interval, uint16_t max_interval, float delta);
+
+* ``endpoint`` - Target endpoint number
+* ``ieee_addr`` - IEEE address of the target device
+* ``min_interval`` - Minimum reporting interval in seconds
+* ``max_interval`` - Maximum reporting interval in seconds
+* ``delta`` - Minimum change in humidity to trigger a report
+
 Example
 -------