Skip to content

Commit c38a689

Browse files
committed
docs(zigbee): Add docs for new methods
1 parent 8910320 commit c38a689

File tree

3 files changed

+111
-12
lines changed

3 files changed

+111
-12
lines changed

docs/en/zigbee/ep_contact_switch.rst

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,17 @@ Sets the contact switch to open state.
6363
6464
This function will return ``true`` if successful, ``false`` otherwise.
6565

66+
report
67+
^^^^^^
68+
69+
Manually reports the current contact state.
70+
71+
.. code-block:: arduino
72+
73+
bool report();
74+
75+
This function will return ``true`` if successful, ``false`` otherwise.
76+
6677
setIASClientEndpoint
6778
^^^^^^^^^^^^^^^^^^^^
6879

@@ -74,16 +85,38 @@ Sets the IAS Client endpoint number (default is 1).
7485
7586
* ``ep_number`` - IAS Client endpoint number
7687

77-
report
78-
^^^^^^
88+
requestIASZoneEnroll
89+
^^^^^^^^^^^^^^^^^^^^
7990

80-
Manually reports the current contact state.
91+
Requests a new IAS Zone enrollment. Can be called to enroll a new device or to re-enroll an already enrolled device.
8192

8293
.. code-block:: arduino
8394
84-
bool report();
95+
bool requestIASZoneEnroll();
8596
86-
This function will return ``true`` if successful, ``false`` otherwise.
97+
This function will return ``true`` if the enrollment request was sent successfully, ``false`` otherwise. The actual enrollment status should be checked using the ``enrolled()`` method after waiting for the enrollment response.
98+
99+
restoreIASZoneEnroll
100+
^^^^^^^^^^^^^^^^^^^^
101+
102+
Restores IAS Zone enrollment from stored attributes. This method should be called after rebooting an already enrolled device. It restores the enrollment information from flash memory, which is faster for sleepy devices compared to requesting a new enrollment.
103+
104+
.. code-block:: arduino
105+
106+
bool restoreIASZoneEnroll();
107+
108+
This function will return ``true`` if the enrollment was successfully restored, ``false`` otherwise. The enrollment information (zone ID and IAS CIE address) must be available in the device's stored attributes for this to succeed.
109+
110+
enrolled
111+
^^^^^^^^
112+
113+
Checks if the device is currently enrolled in the IAS Zone.
114+
115+
.. code-block:: arduino
116+
117+
bool enrolled();
118+
119+
This function returns ``true`` if the device is enrolled, ``false`` otherwise. Use this method to check the enrollment status after calling ``requestIASZoneEnroll()`` or ``restoreIASZoneEnroll()``.
87120

88121
Example
89122
-------

docs/en/zigbee/ep_door_window_handle.rst

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,17 @@ Sets the door/window handle to tilted position.
6767
6868
This function will return ``true`` if successful, ``false`` otherwise.
6969

70+
report
71+
^^^^^^
72+
73+
Manually reports the current handle position.
74+
75+
.. code-block:: arduino
76+
77+
bool report();
78+
79+
This function will return ``true`` if successful, ``false`` otherwise.
80+
7081
setIASClientEndpoint
7182
^^^^^^^^^^^^^^^^^^^^
7283

@@ -78,16 +89,38 @@ Sets the IAS Client endpoint number (default is 1).
7889
7990
* ``ep_number`` - IAS Client endpoint number
8091

81-
report
82-
^^^^^^
92+
requestIASZoneEnroll
93+
^^^^^^^^^^^^^^^^^^^^
8394

84-
Manually reports the current handle position.
95+
Requests a new IAS Zone enrollment. Can be called to enroll a new device or to re-enroll an already enrolled device.
8596

8697
.. code-block:: arduino
8798
88-
bool report();
99+
bool requestIASZoneEnroll();
89100
90-
This function will return ``true`` if successful, ``false`` otherwise.
101+
This function will return ``true`` if the enrollment request was sent successfully, ``false`` otherwise. The actual enrollment status should be checked using the ``enrolled()`` method after waiting for the enrollment response.
102+
103+
restoreIASZoneEnroll
104+
^^^^^^^^^^^^^^^^^^^^
105+
106+
Restores IAS Zone enrollment from stored attributes. This method should be called after rebooting an already enrolled device. It restores the enrollment information from flash memory, which is faster for sleepy devices compared to requesting a new enrollment.
107+
108+
.. code-block:: arduino
109+
110+
bool restoreIASZoneEnroll();
111+
112+
This function will return ``true`` if the enrollment was successfully restored, ``false`` otherwise. The enrollment information (zone ID and IAS CIE address) must be available in the device's stored attributes for this to succeed.
113+
114+
enrolled
115+
^^^^^^^^
116+
117+
Checks if the device is currently enrolled in the IAS Zone.
118+
119+
.. code-block:: arduino
120+
121+
bool enrolled();
122+
123+
This function returns ``true`` if the device is enrolled, ``false`` otherwise. Use this method to check the enrollment status after calling ``requestIASZoneEnroll()``.
91124

92125
Example
93126
-------

docs/en/zigbee/ep_vibration_sensor.rst

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,42 @@ Manually reports the current vibration state.
7373

7474
.. code-block:: arduino
7575
76-
void report();
76+
bool report();
7777
78-
This function does not return a value.
78+
This function will return ``true`` if successful, ``false`` otherwise.
79+
80+
requestIASZoneEnroll
81+
^^^^^^^^^^^^^^^^^^^^
82+
83+
Requests a new IAS Zone enrollment. Can be called to enroll a new device or to re-enroll an already enrolled device.
84+
85+
.. code-block:: arduino
86+
87+
bool requestIASZoneEnroll();
88+
89+
This function will return ``true`` if the enrollment request was sent successfully, ``false`` otherwise. The actual enrollment status should be checked using the ``enrolled()`` method after waiting for the enrollment response.
90+
91+
restoreIASZoneEnroll
92+
^^^^^^^^^^^^^^^^^^^^
93+
94+
Restores IAS Zone enrollment from stored attributes. This method should be called after rebooting an already enrolled device. It restores the enrollment information from flash memory, which is faster for sleepy devices compared to requesting a new enrollment.
95+
96+
.. code-block:: arduino
97+
98+
bool restoreIASZoneEnroll();
99+
100+
This function will return ``true`` if the enrollment was successfully restored, ``false`` otherwise. The enrollment information (zone ID and IAS CIE address) must be available in the device's stored attributes for this to succeed.
101+
102+
enrolled
103+
^^^^^^^^
104+
105+
Checks if the device is currently enrolled in the IAS Zone.
106+
107+
.. code-block:: arduino
108+
109+
bool enrolled();
110+
111+
This function returns ``true`` if the device is enrolled, ``false`` otherwise. Use this method to check the enrollment status after calling ``requestIASZoneEnroll()`` or ``restoreIASZoneEnroll()``.
79112

80113
Example
81114
-------

0 commit comments

Comments
 (0)