@@ -25,7 +25,6 @@ Creates a new Zigbee analog endpoint.
25
25
26
26
ZigbeeAnalog(uint8_t endpoint);
27
27
28
- **Parameters: **
29
28
* ``endpoint `` - Endpoint number (1-254)
30
29
31
30
Cluster Management
@@ -40,7 +39,7 @@ Adds analog input cluster to the endpoint.
40
39
41
40
bool addAnalogInput();
42
41
43
- ** Returns: ** ``true `` if successful, ``false `` otherwise
42
+ This function will return ``true `` if successful, ``false `` otherwise.
44
43
45
44
addAnalogOutput
46
45
^^^^^^^^^^^^^^^
@@ -51,7 +50,7 @@ Adds analog output cluster to the endpoint.
51
50
52
51
bool addAnalogOutput();
53
52
54
- ** Returns: ** ``true `` if successful, ``false `` otherwise
53
+ This function will return ``true `` if successful, ``false `` otherwise.
55
54
56
55
Analog Input API
57
56
----------------
@@ -68,10 +67,9 @@ Sets the application type for the analog input.
68
67
69
68
bool setAnalogInputApplication(uint32_t application_type);
70
69
71
- **Parameters: **
72
70
* ``application_type `` - Application type constant (see esp_zigbee_zcl_analog_input.h for values)
73
71
74
- ** Returns: ** ``true `` if successful, ``false `` otherwise
72
+ This function will return ``true `` if successful, ``false `` otherwise.
75
73
76
74
setAnalogInputDescription
77
75
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -82,10 +80,9 @@ Sets a custom description for the analog input.
82
80
83
81
bool setAnalogInputDescription(const char *description);
84
82
85
- **Parameters: **
86
83
* ``description `` - Description string
87
84
88
- ** Returns: ** ``true `` if successful, ``false `` otherwise
85
+ This function will return ``true `` if successful, ``false `` otherwise.
89
86
90
87
setAnalogInputResolution
91
88
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -96,10 +93,9 @@ Sets the resolution for the analog input.
96
93
97
94
bool setAnalogInputResolution(float resolution);
98
95
99
- **Parameters: **
100
96
* ``resolution `` - Resolution value
101
97
102
- ** Returns: ** ``true `` if successful, ``false `` otherwise
98
+ This function will return ``true `` if successful, ``false `` otherwise.
103
99
104
100
setAnalogInputMinMax
105
101
^^^^^^^^^^^^^^^^^^^^
@@ -110,11 +106,10 @@ Sets the minimum and maximum values for the analog input.
110
106
111
107
bool setAnalogInputMinMax(float min, float max);
112
108
113
- **Parameters: **
114
109
* ``min `` - Minimum value
115
110
* ``max `` - Maximum value
116
111
117
- ** Returns: ** ``true `` if successful, ``false `` otherwise
112
+ This function will return ``true `` if successful, ``false `` otherwise.
118
113
119
114
Value Control
120
115
*************
@@ -128,10 +123,9 @@ Sets the analog input value.
128
123
129
124
bool setAnalogInput(float analog);
130
125
131
- **Parameters: **
132
126
* ``analog `` - Analog input value
133
127
134
- ** Returns: ** ``true `` if successful, ``false `` otherwise
128
+ This function will return ``true `` if successful, ``false `` otherwise.
135
129
136
130
Reporting Methods
137
131
*****************
@@ -145,12 +139,11 @@ Sets the reporting configuration for analog input.
145
139
146
140
bool setAnalogInputReporting(uint16_t min_interval, uint16_t max_interval, float delta);
147
141
148
- **Parameters: **
149
142
* ``min_interval `` - Minimum reporting interval in seconds
150
143
* ``max_interval `` - Maximum reporting interval in seconds
151
144
* ``delta `` - Minimum change in value to trigger a report
152
145
153
- ** Returns: ** ``true `` if successful, ``false `` otherwise
146
+ This function will return ``true `` if successful, ``false `` otherwise.
154
147
155
148
reportAnalogInput
156
149
^^^^^^^^^^^^^^^^^
@@ -161,7 +154,7 @@ Manually reports the current analog input value.
161
154
162
155
bool reportAnalogInput();
163
156
164
- ** Returns: ** ``true `` if successful, ``false `` otherwise
157
+ This function will return ``true `` if successful, ``false `` otherwise.
165
158
166
159
Analog Output API
167
160
-----------------
@@ -178,10 +171,9 @@ Sets the application type for the analog output.
178
171
179
172
bool setAnalogOutputApplication(uint32_t application_type);
180
173
181
- **Parameters: **
182
174
* ``application_type `` - Application type constant (see esp_zigbee_zcl_analog_output.h for values)
183
175
184
- ** Returns: ** ``true `` if successful, ``false `` otherwise
176
+ This function will return ``true `` if successful, ``false `` otherwise.
185
177
186
178
setAnalogOutputDescription
187
179
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -192,10 +184,9 @@ Sets a custom description for the analog output.
192
184
193
185
bool setAnalogOutputDescription(const char *description);
194
186
195
- **Parameters: **
196
187
* ``description `` - Description string
197
188
198
- ** Returns: ** ``true `` if successful, ``false `` otherwise
189
+ This function will return ``true `` if successful, ``false `` otherwise.
199
190
200
191
setAnalogOutputResolution
201
192
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -206,10 +197,9 @@ Sets the resolution for the analog output.
206
197
207
198
bool setAnalogOutputResolution(float resolution);
208
199
209
- **Parameters: **
210
200
* ``resolution `` - Resolution value
211
201
212
- ** Returns: ** ``true `` if successful, ``false `` otherwise
202
+ This function will return ``true `` if successful, ``false `` otherwise.
213
203
214
204
setAnalogOutputMinMax
215
205
^^^^^^^^^^^^^^^^^^^^^
@@ -220,11 +210,10 @@ Sets the minimum and maximum values for the analog output.
220
210
221
211
bool setAnalogOutputMinMax(float min, float max);
222
212
223
- **Parameters: **
224
213
* ``min `` - Minimum value
225
214
* ``max `` - Maximum value
226
215
227
- ** Returns: ** ``true `` if successful, ``false `` otherwise
216
+ This function will return ``true `` if successful, ``false `` otherwise.
228
217
229
218
Value Control
230
219
*************
@@ -238,10 +227,9 @@ Sets the analog output value.
238
227
239
228
bool setAnalogOutput(float analog);
240
229
241
- **Parameters: **
242
230
* ``analog `` - Analog output value
243
231
244
- ** Returns: ** ``true `` if successful, ``false `` otherwise
232
+ This function will return ``true `` if successful, ``false `` otherwise.
245
233
246
234
getAnalogOutput
247
235
^^^^^^^^^^^^^^^
@@ -252,7 +240,7 @@ Gets the current analog output value.
252
240
253
241
float getAnalogOutput();
254
242
255
- ** Returns: ** Current analog output value
243
+ This function will return current analog output value.
256
244
257
245
Reporting Methods
258
246
*****************
@@ -266,7 +254,7 @@ Manually reports the current analog output value.
266
254
267
255
bool reportAnalogOutput();
268
256
269
- ** Returns: ** ``true `` if successful, ``false `` otherwise
257
+ This function will return ``true `` if successful, ``false `` otherwise.
270
258
271
259
Event Handling
272
260
**************
@@ -280,7 +268,6 @@ Sets a callback function to be called when the analog output value changes.
280
268
281
269
void onAnalogOutputChange(void (*callback)(float analog));
282
270
283
- **Parameters: **
284
271
* ``callback `` - Function to call when analog output changes
285
272
286
273
Example
0 commit comments