Skip to content

Commit 5e2a180

Browse files
committed
feat(docs( Zigbee docs update
1 parent 263aab5 commit 5e2a180

23 files changed

+239
-302
lines changed

docs/en/zigbee/ep_binary.rst

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,11 @@ About
66
-----
77

88
The ``ZigbeeBinary`` class provides an endpoint for binary input/output sensors in Zigbee networks. This endpoint implements the Zigbee Home Automation (HA) standard for binary sensors, supporting various application types for HVAC, security, and general binary sensing.
9+
Binary Input (BI) is meant to be used for sensors that provide a binary signal, such as door/window sensors, motion detectors, etc. to be sent to the network.
910

10-
**Features:**
11-
* Binary input sensor support
12-
* Configurable application types (HVAC, Security, etc.)
13-
* Custom description support
14-
* Automatic reporting capabilities
15-
* Integration with common endpoint features (binding, OTA, etc.)
16-
* Zigbee HA standard compliance
17-
18-
**Use Cases:**
19-
* Door/window sensors
20-
* Motion detectors
21-
* Smoke alarms
22-
* HVAC status monitoring
23-
* Security system sensors
24-
* Any on/off sensor application
11+
.. note::
12+
13+
Binary Output (BO) is not supported yet.
2514

2615
API Reference
2716
-------------
@@ -138,8 +127,8 @@ Manually reports the current binary input value.
138127
139128
This function will return ``true`` if successful, ``false`` otherwise.
140129

141-
Usage Example
142-
-------------
130+
Example
131+
-------
143132

144133
Binary Input Implementation
145134
****************************

docs/en/zigbee/ep_carbon_dioxide_sensor.rst

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,6 @@ About
77

88
The ``ZigbeeCarbonDioxideSensor`` class provides a CO2 sensor endpoint for Zigbee networks. This endpoint implements the Zigbee Home Automation (HA) standard for carbon dioxide measurement devices.
99

10-
**Features:**
11-
* CO2 concentration measurement in ppm
12-
* Configurable measurement range
13-
* Tolerance and reporting configuration
14-
* Automatic reporting capabilities
15-
* Integration with common endpoint features (binding, OTA, etc.)
16-
* Zigbee HA standard compliance
17-
18-
**Use Cases:**
19-
* Indoor air quality monitoring
20-
* Smart home ventilation control
21-
* HVAC system air quality control
22-
* Industrial air quality monitoring
23-
* Health and safety monitoring
24-
* Environmental monitoring systems
25-
2610
API Reference
2711
-------------
2812

@@ -109,8 +93,8 @@ Manually reports the current CO2 concentration value.
10993
11094
This function will return ``true`` if successful, ``false`` otherwise.
11195

112-
Usage Example
113-
-------------
96+
Example
97+
-------
11498

11599
CO2 Sensor Implementation
116100
*************************

docs/en/zigbee/ep_color_dimmable_light.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ Restores the light to its last known state.
213213
214214
void restoreLight();
215215
216-
Usage Example
217-
-------------
216+
Example
217+
-------
218218

219219
Color Dimmable Light Implementation
220220
***********************************

docs/en/zigbee/ep_color_dimmer_switch.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,8 @@ Turns on lights by recalling a scene.
212212
213213
void lightOnWithSceneRecall();
214214
215-
Usage Example
216-
-------------
215+
Example
216+
-------
217217

218218
Color Dimmer Switch Implementation
219219
**********************************

docs/en/zigbee/ep_contact_switch.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ Manually reports the current contact state.
7878
7979
This function will return ``true`` if successful, ``false`` otherwise.
8080

81-
Usage Example
82-
-------------
81+
Example
82+
-------
8383

8484
Contact Switch Implementation
8585
*****************************

docs/en/zigbee/ep_dimmable_light.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ Sets a callback function to be called when the light state or level changes.
128128
* ``bool state`` - New light state (true = on, false = off)
129129
* ``uint8_t level`` - New brightness level (0-100)
130130

131-
Usage Example
132-
-------------
131+
Example
132+
-------
133133

134134
Dimmable Light Implementation
135135
*****************************

docs/en/zigbee/ep_door_window_handle.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,5 +121,7 @@ Manually reports the current handle position.
121121
122122
This function will return ``true`` if successful, ``false`` otherwise.
123123

124-
Usage Example
125-
-------------
124+
Example
125+
-------
126+
127+
*To be added*

docs/en/zigbee/ep_electrical_measurement.rst

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ Adds a DC measurement type to the endpoint.
5252

5353
.. code-block:: arduino
5454
55-
bool addDCMeasurement(uint16_t measurement_type);
55+
bool addDCMeasurement(ZIGBEE_DC_MEASUREMENT_TYPE measurement_type);
5656
57-
* ``measurement_type`` - DC measurement type constant
57+
* ``measurement_type`` - DC measurement type constant (ZIGBEE_DC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_DC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_DC_MEASUREMENT_TYPE_POWER)
5858

5959
This function will return ``true`` if successful, ``false`` otherwise.
6060

@@ -65,9 +65,9 @@ Sets the DC measurement value for a specific measurement type.
6565

6666
.. code-block:: arduino
6767
68-
bool setDCMeasurement(uint16_t measurement_type, int32_t value);
68+
bool setDCMeasurement(ZIGBEE_DC_MEASUREMENT_TYPE measurement_type, int16_t value);
6969
70-
* ``measurement_type`` - DC measurement type constant
70+
* ``measurement_type`` - DC measurement type constant (ZIGBEE_DC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_DC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_DC_MEASUREMENT_TYPE_POWER)
7171
* ``value`` - Measurement value
7272

7373
This function will return ``true`` if successful, ``false`` otherwise.
@@ -79,9 +79,9 @@ Sets the minimum and maximum values for a DC measurement type.
7979

8080
.. code-block:: arduino
8181
82-
bool setDCMinMaxValue(uint16_t measurement_type, int32_t min, int32_t max);
82+
bool setDCMinMaxValue(ZIGBEE_DC_MEASUREMENT_TYPE measurement_type, int16_t min, int16_t max);
8383
84-
* ``measurement_type`` - DC measurement type constant
84+
* ``measurement_type`` - DC measurement type constant (ZIGBEE_DC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_DC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_DC_MEASUREMENT_TYPE_POWER)
8585
* ``min`` - Minimum value
8686
* ``max`` - Maximum value
8787

@@ -94,9 +94,9 @@ Sets the multiplier and divisor for scaling DC measurements.
9494

9595
.. code-block:: arduino
9696
97-
bool setDCMultiplierDivisor(uint16_t measurement_type, uint16_t multiplier, uint16_t divisor);
97+
bool setDCMultiplierDivisor(ZIGBEE_DC_MEASUREMENT_TYPE measurement_type, uint16_t multiplier, uint16_t divisor);
9898
99-
* ``measurement_type`` - DC measurement type constant
99+
* ``measurement_type`` - DC measurement type constant (ZIGBEE_DC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_DC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_DC_MEASUREMENT_TYPE_POWER)
100100
* ``multiplier`` - Multiplier value
101101
* ``divisor`` - Divisor value
102102

@@ -109,9 +109,9 @@ Sets the reporting configuration for DC measurements.
109109

110110
.. code-block:: arduino
111111
112-
bool setDCReporting(uint16_t measurement_type, uint16_t min_interval, uint16_t max_interval, int32_t delta);
112+
bool setDCReporting(ZIGBEE_DC_MEASUREMENT_TYPE measurement_type, uint16_t min_interval, uint16_t max_interval, int16_t delta);
113113
114-
* ``measurement_type`` - DC measurement type constant
114+
* ``measurement_type`` - DC measurement type constant (ZIGBEE_DC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_DC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_DC_MEASUREMENT_TYPE_POWER)
115115
* ``min_interval`` - Minimum reporting interval in seconds
116116
* ``max_interval`` - Maximum reporting interval in seconds
117117
* ``delta`` - Minimum change required to trigger a report
@@ -125,9 +125,9 @@ Manually reports a DC measurement value.
125125

126126
.. code-block:: arduino
127127
128-
bool reportDC(uint16_t measurement_type);
128+
bool reportDC(ZIGBEE_DC_MEASUREMENT_TYPE measurement_type);
129129
130-
* ``measurement_type`` - DC measurement type constant
130+
* ``measurement_type`` - DC measurement type constant (ZIGBEE_DC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_DC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_DC_MEASUREMENT_TYPE_POWER)
131131

132132
This function will return ``true`` if successful, ``false`` otherwise.
133133

@@ -141,10 +141,10 @@ Adds an AC measurement type for a specific phase.
141141

142142
.. code-block:: arduino
143143
144-
bool addACMeasurement(uint16_t measurement_type, uint8_t phase);
144+
bool addACMeasurement(ZIGBEE_AC_MEASUREMENT_TYPE measurement_type, ZIGBEE_AC_PHASE_TYPE phase_type);
145145
146-
* ``measurement_type`` - AC measurement type constant
147-
* ``phase`` - Phase number (1-3)
146+
* ``measurement_type`` - AC measurement type constant (ZIGBEE_AC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_AC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_AC_MEASUREMENT_TYPE_POWER, ZIGBEE_AC_MEASUREMENT_TYPE_POWER_FACTOR, ZIGBEE_AC_MEASUREMENT_TYPE_FREQUENCY)
147+
* ``phase_type`` - Phase type constant (ZIGBEE_AC_PHASE_TYPE_NON_SPECIFIC, ZIGBEE_AC_PHASE_TYPE_A, ZIGBEE_AC_PHASE_TYPE_B, ZIGBEE_AC_PHASE_TYPE_C)
148148

149149
This function will return ``true`` if successful, ``false`` otherwise.
150150

@@ -155,10 +155,10 @@ Sets the AC measurement value for a specific measurement type and phase.
155155

156156
.. code-block:: arduino
157157
158-
bool setACMeasurement(uint16_t measurement_type, uint8_t phase, int32_t value);
158+
bool setACMeasurement(ZIGBEE_AC_MEASUREMENT_TYPE measurement_type, ZIGBEE_AC_PHASE_TYPE phase_type, int32_t value);
159159
160-
* ``measurement_type`` - AC measurement type constant
161-
* ``phase`` - Phase number (1-3)
160+
* ``measurement_type`` - AC measurement type constant (ZIGBEE_AC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_AC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_AC_MEASUREMENT_TYPE_POWER, ZIGBEE_AC_MEASUREMENT_TYPE_POWER_FACTOR, ZIGBEE_AC_MEASUREMENT_TYPE_FREQUENCY)
161+
* ``phase_type`` - Phase type constant (ZIGBEE_AC_PHASE_TYPE_NON_SPECIFIC, ZIGBEE_AC_PHASE_TYPE_A, ZIGBEE_AC_PHASE_TYPE_B, ZIGBEE_AC_PHASE_TYPE_C)
162162
* ``value`` - Measurement value
163163

164164
This function will return ``true`` if successful, ``false`` otherwise.
@@ -170,10 +170,10 @@ Sets the minimum and maximum values for an AC measurement type and phase.
170170

171171
.. code-block:: arduino
172172
173-
bool setACMinMaxValue(uint16_t measurement_type, uint8_t phase, int32_t min, int32_t max);
173+
bool setACMinMaxValue(ZIGBEE_AC_MEASUREMENT_TYPE measurement_type, ZIGBEE_AC_PHASE_TYPE phase_type, int32_t min, int32_t max);
174174
175-
* ``measurement_type`` - AC measurement type constant
176-
* ``phase`` - Phase number (1-3)
175+
* ``measurement_type`` - AC measurement type constant (ZIGBEE_AC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_AC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_AC_MEASUREMENT_TYPE_POWER, ZIGBEE_AC_MEASUREMENT_TYPE_POWER_FACTOR, ZIGBEE_AC_MEASUREMENT_TYPE_FREQUENCY)
176+
* ``phase_type`` - Phase type constant (ZIGBEE_AC_PHASE_TYPE_NON_SPECIFIC, ZIGBEE_AC_PHASE_TYPE_A, ZIGBEE_AC_PHASE_TYPE_B, ZIGBEE_AC_PHASE_TYPE_C)
177177
* ``min`` - Minimum value
178178
* ``max`` - Maximum value
179179

@@ -186,10 +186,9 @@ Sets the multiplier and divisor for scaling AC measurements.
186186

187187
.. code-block:: arduino
188188
189-
bool setACMultiplierDivisor(uint16_t measurement_type, uint8_t phase, uint16_t multiplier, uint16_t divisor);
189+
bool setACMultiplierDivisor(ZIGBEE_AC_MEASUREMENT_TYPE measurement_type, uint16_t multiplier, uint16_t divisor);
190190
191-
* ``measurement_type`` - AC measurement type constant
192-
* ``phase`` - Phase number (1-3)
191+
* ``measurement_type`` - AC measurement type constant (ZIGBEE_AC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_AC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_AC_MEASUREMENT_TYPE_POWER, ZIGBEE_AC_MEASUREMENT_TYPE_POWER_FACTOR, ZIGBEE_AC_MEASUREMENT_TYPE_FREQUENCY)
193192
* ``multiplier`` - Multiplier value
194193
* ``divisor`` - Divisor value
195194

@@ -202,10 +201,10 @@ Sets the power factor for a specific phase.
202201

203202
.. code-block:: arduino
204203
205-
bool setACPowerFactor(uint8_t phase, int16_t power_factor);
204+
bool setACPowerFactor(ZIGBEE_AC_PHASE_TYPE phase_type, int8_t power_factor);
206205
207-
* ``phase`` - Phase number (1-3)
208-
* ``power_factor`` - Power factor value
206+
* ``phase_type`` - Phase type constant (ZIGBEE_AC_PHASE_TYPE_NON_SPECIFIC, ZIGBEE_AC_PHASE_TYPE_A, ZIGBEE_AC_PHASE_TYPE_B, ZIGBEE_AC_PHASE_TYPE_C)
207+
* ``power_factor`` - Power factor value (-100 to 100)
209208

210209
This function will return ``true`` if successful, ``false`` otherwise.
211210

@@ -216,10 +215,10 @@ Sets the reporting configuration for AC measurements.
216215

217216
.. code-block:: arduino
218217
219-
bool setACReporting(uint16_t measurement_type, uint8_t phase, uint16_t min_interval, uint16_t max_interval, int32_t delta);
218+
bool setACReporting(ZIGBEE_AC_MEASUREMENT_TYPE measurement_type, ZIGBEE_AC_PHASE_TYPE phase_type, uint16_t min_interval, uint16_t max_interval, int32_t delta);
220219
221-
* ``measurement_type`` - AC measurement type constant
222-
* ``phase`` - Phase number (1-3)
220+
* ``measurement_type`` - AC measurement type constant (ZIGBEE_AC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_AC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_AC_MEASUREMENT_TYPE_POWER, ZIGBEE_AC_MEASUREMENT_TYPE_POWER_FACTOR, ZIGBEE_AC_MEASUREMENT_TYPE_FREQUENCY)
221+
* ``phase_type`` - Phase type constant (ZIGBEE_AC_PHASE_TYPE_NON_SPECIFIC, ZIGBEE_AC_PHASE_TYPE_A, ZIGBEE_AC_PHASE_TYPE_B, ZIGBEE_AC_PHASE_TYPE_C)
223222
* ``min_interval`` - Minimum reporting interval in seconds
224223
* ``max_interval`` - Maximum reporting interval in seconds
225224
* ``delta`` - Minimum change required to trigger a report
@@ -233,15 +232,15 @@ Manually reports an AC measurement value.
233232

234233
.. code-block:: arduino
235234
236-
bool reportAC(uint16_t measurement_type, uint8_t phase);
235+
bool reportAC(ZIGBEE_AC_MEASUREMENT_TYPE measurement_type, ZIGBEE_AC_PHASE_TYPE phase_type);
237236
238-
* ``measurement_type`` - AC measurement type constant
239-
* ``phase`` - Phase number (1-3)
237+
* ``measurement_type`` - AC measurement type constant (ZIGBEE_AC_MEASUREMENT_TYPE_VOLTAGE, ZIGBEE_AC_MEASUREMENT_TYPE_CURRENT, ZIGBEE_AC_MEASUREMENT_TYPE_POWER, ZIGBEE_AC_MEASUREMENT_TYPE_POWER_FACTOR, ZIGBEE_AC_MEASUREMENT_TYPE_FREQUENCY)
238+
* ``phase_type`` - Phase type constant (ZIGBEE_AC_PHASE_TYPE_NON_SPECIFIC, ZIGBEE_AC_PHASE_TYPE_A, ZIGBEE_AC_PHASE_TYPE_B, ZIGBEE_AC_PHASE_TYPE_C)
240239

241240
This function will return ``true`` if successful, ``false`` otherwise.
242241

243-
Usage Example
244-
-------------
242+
Example
243+
-------
245244

246245
DC Electrical Measurement
247246
*************************

docs/en/zigbee/ep_flow_sensor.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ Manually reports the current flow rate value.
109109
110110
This function will return ``true`` if successful, ``false`` otherwise.
111111

112-
Usage Example
113-
-------------
112+
Example
113+
-------
114114

115115
Flow + PressureSensor Implementation
116116
************************************

docs/en/zigbee/ep_gateway.rst

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,7 @@ About
66
-----
77

88
The ``ZigbeeGateway`` class provides a gateway endpoint for Zigbee networks. This endpoint implements the Zigbee Home Automation (HA) standard for network coordination and gateway functionality.
9-
10-
**Features:**
11-
* Network coordination
12-
* Device management
13-
* Gateway functionality
14-
* Integration with common endpoint features (binding, OTA, etc.)
15-
* Zigbee HA standard compliance
16-
17-
**Use Cases:**
18-
* Zigbee coordinators
19-
* Smart home hubs
20-
* Network gateways
21-
* Bridge devices to other protocols (WiFi, Ethernet, etc.)
9+
Gateway is a device that can be used to bridge Zigbee network to other networks (e.g. WiFi, Ethernet, etc.).
2210

2311
API Reference
2412
-------------
@@ -37,8 +25,8 @@ Creates a new Zigbee gateway endpoint.
3725
3826
* ``endpoint`` - Endpoint number (1-254)
3927

40-
Usage Example
41-
-------------
28+
Example
29+
-------
4230

4331
Gateway Implementation
4432
**********************

docs/en/zigbee/ep_illuminance_sensor.rst

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,6 @@ The ``ZigbeeIlluminanceSensor`` class provides an endpoint for illuminance senso
1212
* Configurable measurement range
1313
* Tolerance and reporting configuration
1414
* Automatic reporting capabilities
15-
* Integration with common endpoint features (binding, OTA, etc.)
16-
* Zigbee HA standard compliance
17-
18-
**Use Cases:**
19-
* Ambient light monitoring
20-
* Smart lighting control
21-
* Daylight harvesting systems
22-
* Security lighting systems
23-
* Energy management systems
24-
* Smart home automation
2515

2616
API Reference
2717
-------------
@@ -109,11 +99,11 @@ Manually reports the current illuminance value.
10999
110100
This function will return ``true`` if successful, ``false`` otherwise.
111101

112-
Usage Example
113-
-------------
102+
Example
103+
-------
114104

115105
Illuminance Sensor Implementation
116-
*********************************
106+
********************************
117107

118108
.. literalinclude:: ../../../libraries/Zigbee/examples/Zigbee_Illuminance_Sensor/Zigbee_Illuminance_Sensor.ino
119109
:language: arduino

0 commit comments

Comments
 (0)