From 3683380a7f7b5ffab747796a4d7650bad8c868a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Proch=C3=A1zka?= <90197375+P-R-O-C-H-Y@users.noreply.github.com> Date: Tue, 22 Jul 2025 15:46:40 +0200 Subject: [PATCH] feat(docs): Updaze Zigbee docs with latest changes --- docs/en/zigbee/ep_fan_control.rst | 133 ++++++++++++++++++++++++++++++ docs/en/zigbee/zigbee_core.rst | 13 +++ docs/en/zigbee/zigbee_ep.rst | 13 +++ 3 files changed, 159 insertions(+) create mode 100644 docs/en/zigbee/ep_fan_control.rst diff --git a/docs/en/zigbee/ep_fan_control.rst b/docs/en/zigbee/ep_fan_control.rst new file mode 100644 index 00000000000..1cfff0820df --- /dev/null +++ b/docs/en/zigbee/ep_fan_control.rst @@ -0,0 +1,133 @@ +################ +ZigbeeFanControl +################ + +About +----- + +The ``ZigbeeFanControl`` class provides a Zigbee endpoint for controlling fan devices in a Home Automation (HA) network. This endpoint implements the Fan Control cluster and allows for controlling fan modes and sequences. + +**Features:** +* Fan mode control (OFF, LOW, MEDIUM, HIGH, ON, AUTO, SMART) +* Fan mode sequence configuration +* State change callbacks +* Zigbee HA standard compliance + +**Use Cases:** +* Smart ceiling fans +* HVAC system fans +* Exhaust fans +* Any device requiring fan speed control + +API Reference +------------- + +Constructor +*********** + +ZigbeeFanControl +^^^^^^^^^^^^^^^^ + +Creates a new Zigbee fan control endpoint. + +.. code-block:: arduino + + ZigbeeFanControl(uint8_t endpoint); + +* ``endpoint`` - Endpoint number (1-254) + +Fan Mode Enums +************** + +ZigbeeFanMode +^^^^^^^^^^^^^ + +Available fan modes for controlling the fan speed and operation. + +.. code-block:: arduino + + enum ZigbeeFanMode { + FAN_MODE_OFF, // Fan is off + FAN_MODE_LOW, // Low speed + FAN_MODE_MEDIUM, // Medium speed + FAN_MODE_HIGH, // High speed + FAN_MODE_ON, // Fan is on (full speed) + FAN_MODE_AUTO, // Automatic mode + FAN_MODE_SMART, // Smart mode + }; + +ZigbeeFanModeSequence +^^^^^^^^^^^^^^^^^^^^^ + +Available fan mode sequences that define which modes are available for the fan. + +.. code-block:: arduino + + enum ZigbeeFanModeSequence { + FAN_MODE_SEQUENCE_LOW_MED_HIGH, // Low -> Medium -> High + FAN_MODE_SEQUENCE_LOW_HIGH, // Low -> High + FAN_MODE_SEQUENCE_LOW_MED_HIGH_AUTO, // Low -> Medium -> High -> Auto + FAN_MODE_SEQUENCE_LOW_HIGH_AUTO, // Low -> High -> Auto + FAN_MODE_SEQUENCE_ON_AUTO, // On -> Auto + }; + +API Methods +*********** + +setFanModeSequence +^^^^^^^^^^^^^^^^^^ + +Sets the fan mode sequence and initializes the fan control. + +.. code-block:: arduino + + bool setFanModeSequence(ZigbeeFanModeSequence sequence); + +* ``sequence`` - The fan mode sequence to set + +This function will return ``true`` if successful, ``false`` otherwise. + +getFanMode +^^^^^^^^^^ + +Gets the current fan mode. + +.. code-block:: arduino + + ZigbeeFanMode getFanMode(); + +This function will return current fan mode. + +getFanModeSequence +^^^^^^^^^^^^^^^^^^ + +Gets the current fan mode sequence. + +.. code-block:: arduino + + ZigbeeFanModeSequence getFanModeSequence(); + +This function will return current fan mode sequence. + +Event Handling +************** + +onFanModeChange +^^^^^^^^^^^^^^^ + +Sets a callback function to be called when the fan mode changes. + +.. code-block:: arduino + + void onFanModeChange(void (*callback)(ZigbeeFanMode mode)); + +* ``callback`` - Function to call when fan mode changes + +Example +------- + +Fan Control Implementation +************************** + +.. literalinclude:: ../../../libraries/Zigbee/examples/Zigbee_Fan_Control/Zigbee_Fan_Control.ino + :language: arduino diff --git a/docs/en/zigbee/zigbee_core.rst b/docs/en/zigbee/zigbee_core.rst index ee8f7234210..89cf88ecca1 100644 --- a/docs/en/zigbee/zigbee_core.rst +++ b/docs/en/zigbee/zigbee_core.rst @@ -345,6 +345,19 @@ Performs a factory reset, clearing all network settings. * ``restart`` - ``true`` to restart after reset (default: ``true``) +onGlobalDefaultResponse +^^^^^^^^^^^^^^^^^^^^^^^ + +Sets a global callback for default response messages. + +.. code-block:: arduino + + void onGlobalDefaultResponse(void (*callback)(zb_cmd_type_t resp_to_cmd, esp_zb_zcl_status_t status, uint8_t endpoint, uint16_t cluster)); + +* ``callback`` - Function pointer to the callback function + +This callback will be called for all endpoints when a default response is received. + Utility Functions ***************** diff --git a/docs/en/zigbee/zigbee_ep.rst b/docs/en/zigbee/zigbee_ep.rst index ce13d60bbaf..10c0c9fd084 100644 --- a/docs/en/zigbee/zigbee_ep.rst +++ b/docs/en/zigbee/zigbee_ep.rst @@ -345,6 +345,19 @@ Sets a callback function for identify events. * ``callback`` - Function to call when identify event occurs * ``time`` - Identify time in seconds +onDefaultResponse +^^^^^^^^^^^^^^^^^ + +Sets a callback for default response messages for this endpoint. + +.. code-block:: arduino + + void onDefaultResponse(void (*callback)(zb_cmd_type_t resp_to_cmd, esp_zb_zcl_status_t status)); + +* ``callback`` - Function pointer to the callback function + +This callback will be called when a default response is received for this specific endpoint. + Supported Endpoints -------------------