You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/zigbee/ep_contact_switch.rst
+38-5Lines changed: 38 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,6 +63,17 @@ Sets the contact switch to open state.
63
63
64
64
This function will return ``true`` if successful, ``false`` otherwise.
65
65
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
+
66
77
setIASClientEndpoint
67
78
^^^^^^^^^^^^^^^^^^^^
68
79
@@ -74,16 +85,38 @@ Sets the IAS Client endpoint number (default is 1).
74
85
75
86
* ``ep_number`` - IAS Client endpoint number
76
87
77
-
report
78
-
^^^^^^
88
+
requestIASZoneEnroll
89
+
^^^^^^^^^^^^^^^^^^^^
79
90
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.
81
92
82
93
.. code-block:: arduino
83
94
84
-
bool report();
95
+
bool requestIASZoneEnroll();
85
96
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()``.
Copy file name to clipboardExpand all lines: docs/en/zigbee/ep_door_window_handle.rst
+38-5Lines changed: 38 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,17 @@ Sets the door/window handle to tilted position.
67
67
68
68
This function will return ``true`` if successful, ``false`` otherwise.
69
69
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
+
70
81
setIASClientEndpoint
71
82
^^^^^^^^^^^^^^^^^^^^
72
83
@@ -78,16 +89,38 @@ Sets the IAS Client endpoint number (default is 1).
78
89
79
90
* ``ep_number`` - IAS Client endpoint number
80
91
81
-
report
82
-
^^^^^^
92
+
requestIASZoneEnroll
93
+
^^^^^^^^^^^^^^^^^^^^
83
94
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.
85
96
86
97
.. code-block:: arduino
87
98
88
-
bool report();
99
+
bool requestIASZoneEnroll();
89
100
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()``.
Copy file name to clipboardExpand all lines: docs/en/zigbee/ep_vibration_sensor.rst
+35-2Lines changed: 35 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,9 +73,42 @@ Manually reports the current vibration state.
73
73
74
74
.. code-block:: arduino
75
75
76
-
void report();
76
+
bool report();
77
77
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()``.
0 commit comments