c369dca062
* feat(docs): Add Zigbee library documentation * fix: Remove helper scripts * fix: Proper class naming for better readability * fix(docs): Fix typos Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * ci(pre-commit): Apply automatic fixes * fix(docs): Precommit fixes * fix(docs): Precommit fixes --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
95 lines
1.9 KiB
ReStructuredText
95 lines
1.9 KiB
ReStructuredText
###################
|
|
ZigbeeContactSwitch
|
|
###################
|
|
|
|
About
|
|
-----
|
|
|
|
The ``ZigbeeContactSwitch`` class provides a contact switch endpoint for Zigbee networks. This endpoint implements the Zigbee Home Automation (HA) standard for door/window contact sensors and other binary contact devices.
|
|
|
|
**Features:**
|
|
* Contact state detection (open/closed)
|
|
* Configurable application types
|
|
* Automatic reporting capabilities
|
|
* Integration with common endpoint features (binding, OTA, etc.)
|
|
* Zigbee HA standard compliance
|
|
|
|
**Use Cases:**
|
|
* Door and window sensors
|
|
* Security system contacts
|
|
* Cabinet and drawer sensors
|
|
* Industrial contact monitoring
|
|
* Smart home security applications
|
|
|
|
API Reference
|
|
-------------
|
|
|
|
Constructor
|
|
***********
|
|
|
|
ZigbeeContactSwitch
|
|
^^^^^^^^^^^^^^^^^^^
|
|
|
|
Creates a new Zigbee contact switch endpoint.
|
|
|
|
.. code-block:: arduino
|
|
|
|
ZigbeeContactSwitch(uint8_t endpoint);
|
|
|
|
* ``endpoint`` - Endpoint number (1-254)
|
|
|
|
API Methods
|
|
***********
|
|
|
|
setClosed
|
|
^^^^^^^^^
|
|
|
|
Sets the contact switch to closed state.
|
|
|
|
.. code-block:: arduino
|
|
|
|
bool setClosed();
|
|
|
|
This function will return ``true`` if successful, ``false`` otherwise.
|
|
|
|
setOpen
|
|
^^^^^^^
|
|
|
|
Sets the contact switch to open state.
|
|
|
|
.. code-block:: arduino
|
|
|
|
bool setOpen();
|
|
|
|
This function will return ``true`` if successful, ``false`` otherwise.
|
|
|
|
setIASClientEndpoint
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Sets the IAS Client endpoint number (default is 1).
|
|
|
|
.. code-block:: arduino
|
|
|
|
void setIASClientEndpoint(uint8_t ep_number);
|
|
|
|
* ``ep_number`` - IAS Client endpoint number
|
|
|
|
report
|
|
^^^^^^
|
|
|
|
Manually reports the current contact state.
|
|
|
|
.. code-block:: arduino
|
|
|
|
bool report();
|
|
|
|
This function will return ``true`` if successful, ``false`` otherwise.
|
|
|
|
Example
|
|
-------
|
|
|
|
Contact Switch Implementation
|
|
*****************************
|
|
|
|
.. literalinclude:: ../../../libraries/Zigbee/examples/Zigbee_Contact_Switch/Zigbee_Contact_Switch.ino
|
|
:language: arduino
|