3 * Copyright (c) 2021 Project CHIP Authors
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 // THIS FILE IS GENERATED BY ZAP
20 #ifndef CHIP_CLUSTERS_H
21 #define CHIP_CLUSTERS_H
23 #import <Foundation/Foundation.h>
27 typedef void (^ResponseHandler)(NSError * _Nullable error, NSDictionary * _Nullable values);
29 NS_ASSUME_NONNULL_BEGIN
33 * This is the base class for clusters.
35 @interface CHIPCluster : NSObject
37 - (nullable instancetype)initWithDevice:(CHIPDevice *)device
38 endpoint:(uint8_t)endpoint
39 queue:(dispatch_queue_t)queue NS_DESIGNATED_INITIALIZER;
40 - (instancetype)init NS_UNAVAILABLE;
41 + (instancetype)new NS_UNAVAILABLE;
46 * Cluster Application Basic
49 @interface CHIPApplicationBasic : CHIPCluster
51 - (void)readAttributeVendorName:(ResponseHandler)completionHandler;
52 - (void)readAttributeVendorId:(ResponseHandler)completionHandler;
53 - (void)readAttributeApplicationName:(ResponseHandler)completionHandler;
54 - (void)readAttributeProductId:(ResponseHandler)completionHandler;
55 - (void)readAttributeApplicationId:(ResponseHandler)completionHandler;
56 - (void)readAttributeCatalogVendorId:(ResponseHandler)completionHandler;
57 - (void)readAttributeApplicationSatus:(ResponseHandler)completionHandler;
58 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
63 * Cluster Barrier Control
66 @interface CHIPBarrierControl : CHIPCluster
68 - (void)barrierControlGoToPercent:(uint8_t)percentOpen completionHandler:(ResponseHandler)completionHandler;
69 - (void)barrierControlStop:(ResponseHandler)completionHandler;
71 - (void)readAttributeBarrierMovingState:(ResponseHandler)completionHandler;
72 - (void)readAttributeBarrierSafetyStatus:(ResponseHandler)completionHandler;
73 - (void)readAttributeBarrierCapabilities:(ResponseHandler)completionHandler;
74 - (void)readAttributeBarrierPosition:(ResponseHandler)completionHandler;
75 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
80 * Cluster Barrier Control
83 @interface CHIPBarrierControl : CHIPCluster
85 - (void)barrierControlGoToPercent:(uint8_t)percentOpen completionHandler:(ResponseHandler)completionHandler;
86 - (void)barrierControlStop:(ResponseHandler)completionHandler;
88 - (void)readAttributeBarrierMovingState:(ResponseHandler)completionHandler;
89 - (void)readAttributeBarrierSafetyStatus:(ResponseHandler)completionHandler;
90 - (void)readAttributeBarrierCapabilities:(ResponseHandler)completionHandler;
91 - (void)readAttributeBarrierPosition:(ResponseHandler)completionHandler;
92 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
100 @interface CHIPBasic : CHIPCluster
102 - (void)resetToFactoryDefaults:(ResponseHandler)completionHandler;
104 - (void)readAttributeZclVersion:(ResponseHandler)completionHandler;
105 - (void)readAttributePowerSource:(ResponseHandler)completionHandler;
106 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
111 * Cluster Color Control
114 @interface CHIPColorControl : CHIPCluster
116 - (void)moveColor:(int16_t)rateX
118 optionsMask:(uint8_t)optionsMask
119 optionsOverride:(uint8_t)optionsOverride
120 completionHandler:(ResponseHandler)completionHandler;
121 - (void)moveColorTemperature:(uint8_t)moveMode
123 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
124 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
125 optionsMask:(uint8_t)optionsMask
126 optionsOverride:(uint8_t)optionsOverride
127 completionHandler:(ResponseHandler)completionHandler;
128 - (void)moveHue:(uint8_t)moveMode
130 optionsMask:(uint8_t)optionsMask
131 optionsOverride:(uint8_t)optionsOverride
132 completionHandler:(ResponseHandler)completionHandler;
133 - (void)moveSaturation:(uint8_t)moveMode
135 optionsMask:(uint8_t)optionsMask
136 optionsOverride:(uint8_t)optionsOverride
137 completionHandler:(ResponseHandler)completionHandler;
138 - (void)moveToColor:(uint16_t)colorX
139 colorY:(uint16_t)colorY
140 transitionTime:(uint16_t)transitionTime
141 optionsMask:(uint8_t)optionsMask
142 optionsOverride:(uint8_t)optionsOverride
143 completionHandler:(ResponseHandler)completionHandler;
144 - (void)moveToColorTemperature:(uint16_t)colorTemperature
145 transitionTime:(uint16_t)transitionTime
146 optionsMask:(uint8_t)optionsMask
147 optionsOverride:(uint8_t)optionsOverride
148 completionHandler:(ResponseHandler)completionHandler;
149 - (void)moveToHue:(uint8_t)hue
150 direction:(uint8_t)direction
151 transitionTime:(uint16_t)transitionTime
152 optionsMask:(uint8_t)optionsMask
153 optionsOverride:(uint8_t)optionsOverride
154 completionHandler:(ResponseHandler)completionHandler;
155 - (void)moveToHueAndSaturation:(uint8_t)hue
156 saturation:(uint8_t)saturation
157 transitionTime:(uint16_t)transitionTime
158 optionsMask:(uint8_t)optionsMask
159 optionsOverride:(uint8_t)optionsOverride
160 completionHandler:(ResponseHandler)completionHandler;
161 - (void)moveToSaturation:(uint8_t)saturation
162 transitionTime:(uint16_t)transitionTime
163 optionsMask:(uint8_t)optionsMask
164 optionsOverride:(uint8_t)optionsOverride
165 completionHandler:(ResponseHandler)completionHandler;
166 - (void)stepColor:(int16_t)stepX
168 transitionTime:(uint16_t)transitionTime
169 optionsMask:(uint8_t)optionsMask
170 optionsOverride:(uint8_t)optionsOverride
171 completionHandler:(ResponseHandler)completionHandler;
172 - (void)stepColorTemperature:(uint8_t)stepMode
173 stepSize:(uint16_t)stepSize
174 transitionTime:(uint16_t)transitionTime
175 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
176 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
177 optionsMask:(uint8_t)optionsMask
178 optionsOverride:(uint8_t)optionsOverride
179 completionHandler:(ResponseHandler)completionHandler;
180 - (void)stepHue:(uint8_t)stepMode
181 stepSize:(uint8_t)stepSize
182 transitionTime:(uint8_t)transitionTime
183 optionsMask:(uint8_t)optionsMask
184 optionsOverride:(uint8_t)optionsOverride
185 completionHandler:(ResponseHandler)completionHandler;
186 - (void)stepSaturation:(uint8_t)stepMode
187 stepSize:(uint8_t)stepSize
188 transitionTime:(uint8_t)transitionTime
189 optionsMask:(uint8_t)optionsMask
190 optionsOverride:(uint8_t)optionsOverride
191 completionHandler:(ResponseHandler)completionHandler;
192 - (void)stopMoveStep:(uint8_t)optionsMask
193 optionsOverride:(uint8_t)optionsOverride
194 completionHandler:(ResponseHandler)completionHandler;
196 - (void)readAttributeCurrentHue:(ResponseHandler)completionHandler;
197 - (void)configureAttributeCurrentHue:(uint16_t)minInterval
198 maxInterval:(uint16_t)maxInterval
199 change:(uint8_t)change
200 completionHandler:(ResponseHandler)completionHandler;
201 - (void)reportAttributeCurrentHue:(ResponseHandler)reportHandler;
202 - (void)readAttributeCurrentSaturation:(ResponseHandler)completionHandler;
203 - (void)configureAttributeCurrentSaturation:(uint16_t)minInterval
204 maxInterval:(uint16_t)maxInterval
205 change:(uint8_t)change
206 completionHandler:(ResponseHandler)completionHandler;
207 - (void)reportAttributeCurrentSaturation:(ResponseHandler)reportHandler;
208 - (void)readAttributeRemainingTime:(ResponseHandler)completionHandler;
209 - (void)readAttributeCurrentX:(ResponseHandler)completionHandler;
210 - (void)configureAttributeCurrentX:(uint16_t)minInterval
211 maxInterval:(uint16_t)maxInterval
212 change:(uint16_t)change
213 completionHandler:(ResponseHandler)completionHandler;
214 - (void)reportAttributeCurrentX:(ResponseHandler)reportHandler;
215 - (void)readAttributeCurrentY:(ResponseHandler)completionHandler;
216 - (void)configureAttributeCurrentY:(uint16_t)minInterval
217 maxInterval:(uint16_t)maxInterval
218 change:(uint16_t)change
219 completionHandler:(ResponseHandler)completionHandler;
220 - (void)reportAttributeCurrentY:(ResponseHandler)reportHandler;
221 - (void)readAttributeDriftCompensation:(ResponseHandler)completionHandler;
222 - (void)readAttributeCompensationText:(ResponseHandler)completionHandler;
223 - (void)readAttributeColorTemperature:(ResponseHandler)completionHandler;
224 - (void)configureAttributeColorTemperature:(uint16_t)minInterval
225 maxInterval:(uint16_t)maxInterval
226 change:(uint16_t)change
227 completionHandler:(ResponseHandler)completionHandler;
228 - (void)reportAttributeColorTemperature:(ResponseHandler)reportHandler;
229 - (void)readAttributeColorMode:(ResponseHandler)completionHandler;
230 - (void)readAttributeColorControlOptions:(ResponseHandler)completionHandler;
231 - (void)writeAttributeColorControlOptions:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
232 - (void)readAttributeNumberOfPrimaries:(ResponseHandler)completionHandler;
233 - (void)readAttributePrimary1X:(ResponseHandler)completionHandler;
234 - (void)readAttributePrimary1Y:(ResponseHandler)completionHandler;
235 - (void)readAttributePrimary1Intensity:(ResponseHandler)completionHandler;
236 - (void)readAttributePrimary2X:(ResponseHandler)completionHandler;
237 - (void)readAttributePrimary2Y:(ResponseHandler)completionHandler;
238 - (void)readAttributePrimary2Intensity:(ResponseHandler)completionHandler;
239 - (void)readAttributePrimary3X:(ResponseHandler)completionHandler;
240 - (void)readAttributePrimary3Y:(ResponseHandler)completionHandler;
241 - (void)readAttributePrimary3Intensity:(ResponseHandler)completionHandler;
242 - (void)readAttributePrimary4X:(ResponseHandler)completionHandler;
243 - (void)readAttributePrimary4Y:(ResponseHandler)completionHandler;
244 - (void)readAttributePrimary4Intensity:(ResponseHandler)completionHandler;
245 - (void)readAttributePrimary5X:(ResponseHandler)completionHandler;
246 - (void)readAttributePrimary5Y:(ResponseHandler)completionHandler;
247 - (void)readAttributePrimary5Intensity:(ResponseHandler)completionHandler;
248 - (void)readAttributePrimary6X:(ResponseHandler)completionHandler;
249 - (void)readAttributePrimary6Y:(ResponseHandler)completionHandler;
250 - (void)readAttributePrimary6Intensity:(ResponseHandler)completionHandler;
251 - (void)readAttributeWhitePointX:(ResponseHandler)completionHandler;
252 - (void)writeAttributeWhitePointX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
253 - (void)readAttributeWhitePointY:(ResponseHandler)completionHandler;
254 - (void)writeAttributeWhitePointY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
255 - (void)readAttributeColorPointRX:(ResponseHandler)completionHandler;
256 - (void)writeAttributeColorPointRX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
257 - (void)readAttributeColorPointRY:(ResponseHandler)completionHandler;
258 - (void)writeAttributeColorPointRY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
259 - (void)readAttributeColorPointRIntensity:(ResponseHandler)completionHandler;
260 - (void)writeAttributeColorPointRIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
261 - (void)readAttributeColorPointGX:(ResponseHandler)completionHandler;
262 - (void)writeAttributeColorPointGX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
263 - (void)readAttributeColorPointGY:(ResponseHandler)completionHandler;
264 - (void)writeAttributeColorPointGY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
265 - (void)readAttributeColorPointGIntensity:(ResponseHandler)completionHandler;
266 - (void)writeAttributeColorPointGIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
267 - (void)readAttributeColorPointBX:(ResponseHandler)completionHandler;
268 - (void)writeAttributeColorPointBX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
269 - (void)readAttributeColorPointBY:(ResponseHandler)completionHandler;
270 - (void)writeAttributeColorPointBY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
271 - (void)readAttributeColorPointBIntensity:(ResponseHandler)completionHandler;
272 - (void)writeAttributeColorPointBIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
273 - (void)readAttributeEnhancedCurrentHue:(ResponseHandler)completionHandler;
274 - (void)readAttributeEnhancedColorMode:(ResponseHandler)completionHandler;
275 - (void)readAttributeColorLoopActive:(ResponseHandler)completionHandler;
276 - (void)readAttributeColorLoopDirection:(ResponseHandler)completionHandler;
277 - (void)readAttributeColorLoopTime:(ResponseHandler)completionHandler;
278 - (void)readAttributeColorCapabilities:(ResponseHandler)completionHandler;
279 - (void)readAttributeColorTempPhysicalMin:(ResponseHandler)completionHandler;
280 - (void)readAttributeColorTempPhysicalMax:(ResponseHandler)completionHandler;
281 - (void)readAttributeCoupleColorTempToLevelMinMireds:(ResponseHandler)completionHandler;
282 - (void)readAttributeStartUpColorTemperatureMireds:(ResponseHandler)completionHandler;
283 - (void)writeAttributeStartUpColorTemperatureMireds:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
284 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
289 * Cluster Color Control
292 @interface CHIPColorControl : CHIPCluster
294 - (void)moveColor:(int16_t)rateX
296 optionsMask:(uint8_t)optionsMask
297 optionsOverride:(uint8_t)optionsOverride
298 completionHandler:(ResponseHandler)completionHandler;
299 - (void)moveColorTemperature:(uint8_t)moveMode
301 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
302 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
303 optionsMask:(uint8_t)optionsMask
304 optionsOverride:(uint8_t)optionsOverride
305 completionHandler:(ResponseHandler)completionHandler;
306 - (void)moveHue:(uint8_t)moveMode
308 optionsMask:(uint8_t)optionsMask
309 optionsOverride:(uint8_t)optionsOverride
310 completionHandler:(ResponseHandler)completionHandler;
311 - (void)moveSaturation:(uint8_t)moveMode
313 optionsMask:(uint8_t)optionsMask
314 optionsOverride:(uint8_t)optionsOverride
315 completionHandler:(ResponseHandler)completionHandler;
316 - (void)moveToColor:(uint16_t)colorX
317 colorY:(uint16_t)colorY
318 transitionTime:(uint16_t)transitionTime
319 optionsMask:(uint8_t)optionsMask
320 optionsOverride:(uint8_t)optionsOverride
321 completionHandler:(ResponseHandler)completionHandler;
322 - (void)moveToColorTemperature:(uint16_t)colorTemperature
323 transitionTime:(uint16_t)transitionTime
324 optionsMask:(uint8_t)optionsMask
325 optionsOverride:(uint8_t)optionsOverride
326 completionHandler:(ResponseHandler)completionHandler;
327 - (void)moveToHue:(uint8_t)hue
328 direction:(uint8_t)direction
329 transitionTime:(uint16_t)transitionTime
330 optionsMask:(uint8_t)optionsMask
331 optionsOverride:(uint8_t)optionsOverride
332 completionHandler:(ResponseHandler)completionHandler;
333 - (void)moveToHueAndSaturation:(uint8_t)hue
334 saturation:(uint8_t)saturation
335 transitionTime:(uint16_t)transitionTime
336 optionsMask:(uint8_t)optionsMask
337 optionsOverride:(uint8_t)optionsOverride
338 completionHandler:(ResponseHandler)completionHandler;
339 - (void)moveToSaturation:(uint8_t)saturation
340 transitionTime:(uint16_t)transitionTime
341 optionsMask:(uint8_t)optionsMask
342 optionsOverride:(uint8_t)optionsOverride
343 completionHandler:(ResponseHandler)completionHandler;
344 - (void)stepColor:(int16_t)stepX
346 transitionTime:(uint16_t)transitionTime
347 optionsMask:(uint8_t)optionsMask
348 optionsOverride:(uint8_t)optionsOverride
349 completionHandler:(ResponseHandler)completionHandler;
350 - (void)stepColorTemperature:(uint8_t)stepMode
351 stepSize:(uint16_t)stepSize
352 transitionTime:(uint16_t)transitionTime
353 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
354 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
355 optionsMask:(uint8_t)optionsMask
356 optionsOverride:(uint8_t)optionsOverride
357 completionHandler:(ResponseHandler)completionHandler;
358 - (void)stepHue:(uint8_t)stepMode
359 stepSize:(uint8_t)stepSize
360 transitionTime:(uint8_t)transitionTime
361 optionsMask:(uint8_t)optionsMask
362 optionsOverride:(uint8_t)optionsOverride
363 completionHandler:(ResponseHandler)completionHandler;
364 - (void)stepSaturation:(uint8_t)stepMode
365 stepSize:(uint8_t)stepSize
366 transitionTime:(uint8_t)transitionTime
367 optionsMask:(uint8_t)optionsMask
368 optionsOverride:(uint8_t)optionsOverride
369 completionHandler:(ResponseHandler)completionHandler;
370 - (void)stopMoveStep:(uint8_t)optionsMask
371 optionsOverride:(uint8_t)optionsOverride
372 completionHandler:(ResponseHandler)completionHandler;
374 - (void)readAttributeCurrentHue:(ResponseHandler)completionHandler;
375 - (void)configureAttributeCurrentHue:(uint16_t)minInterval
376 maxInterval:(uint16_t)maxInterval
377 change:(uint8_t)change
378 completionHandler:(ResponseHandler)completionHandler;
379 - (void)reportAttributeCurrentHue:(ResponseHandler)reportHandler;
380 - (void)readAttributeCurrentSaturation:(ResponseHandler)completionHandler;
381 - (void)configureAttributeCurrentSaturation:(uint16_t)minInterval
382 maxInterval:(uint16_t)maxInterval
383 change:(uint8_t)change
384 completionHandler:(ResponseHandler)completionHandler;
385 - (void)reportAttributeCurrentSaturation:(ResponseHandler)reportHandler;
386 - (void)readAttributeRemainingTime:(ResponseHandler)completionHandler;
387 - (void)readAttributeCurrentX:(ResponseHandler)completionHandler;
388 - (void)configureAttributeCurrentX:(uint16_t)minInterval
389 maxInterval:(uint16_t)maxInterval
390 change:(uint16_t)change
391 completionHandler:(ResponseHandler)completionHandler;
392 - (void)reportAttributeCurrentX:(ResponseHandler)reportHandler;
393 - (void)readAttributeCurrentY:(ResponseHandler)completionHandler;
394 - (void)configureAttributeCurrentY:(uint16_t)minInterval
395 maxInterval:(uint16_t)maxInterval
396 change:(uint16_t)change
397 completionHandler:(ResponseHandler)completionHandler;
398 - (void)reportAttributeCurrentY:(ResponseHandler)reportHandler;
399 - (void)readAttributeDriftCompensation:(ResponseHandler)completionHandler;
400 - (void)readAttributeCompensationText:(ResponseHandler)completionHandler;
401 - (void)readAttributeColorTemperature:(ResponseHandler)completionHandler;
402 - (void)configureAttributeColorTemperature:(uint16_t)minInterval
403 maxInterval:(uint16_t)maxInterval
404 change:(uint16_t)change
405 completionHandler:(ResponseHandler)completionHandler;
406 - (void)reportAttributeColorTemperature:(ResponseHandler)reportHandler;
407 - (void)readAttributeColorMode:(ResponseHandler)completionHandler;
408 - (void)readAttributeColorControlOptions:(ResponseHandler)completionHandler;
409 - (void)writeAttributeColorControlOptions:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
410 - (void)readAttributeNumberOfPrimaries:(ResponseHandler)completionHandler;
411 - (void)readAttributePrimary1X:(ResponseHandler)completionHandler;
412 - (void)readAttributePrimary1Y:(ResponseHandler)completionHandler;
413 - (void)readAttributePrimary1Intensity:(ResponseHandler)completionHandler;
414 - (void)readAttributePrimary2X:(ResponseHandler)completionHandler;
415 - (void)readAttributePrimary2Y:(ResponseHandler)completionHandler;
416 - (void)readAttributePrimary2Intensity:(ResponseHandler)completionHandler;
417 - (void)readAttributePrimary3X:(ResponseHandler)completionHandler;
418 - (void)readAttributePrimary3Y:(ResponseHandler)completionHandler;
419 - (void)readAttributePrimary3Intensity:(ResponseHandler)completionHandler;
420 - (void)readAttributePrimary4X:(ResponseHandler)completionHandler;
421 - (void)readAttributePrimary4Y:(ResponseHandler)completionHandler;
422 - (void)readAttributePrimary4Intensity:(ResponseHandler)completionHandler;
423 - (void)readAttributePrimary5X:(ResponseHandler)completionHandler;
424 - (void)readAttributePrimary5Y:(ResponseHandler)completionHandler;
425 - (void)readAttributePrimary5Intensity:(ResponseHandler)completionHandler;
426 - (void)readAttributePrimary6X:(ResponseHandler)completionHandler;
427 - (void)readAttributePrimary6Y:(ResponseHandler)completionHandler;
428 - (void)readAttributePrimary6Intensity:(ResponseHandler)completionHandler;
429 - (void)readAttributeWhitePointX:(ResponseHandler)completionHandler;
430 - (void)writeAttributeWhitePointX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
431 - (void)readAttributeWhitePointY:(ResponseHandler)completionHandler;
432 - (void)writeAttributeWhitePointY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
433 - (void)readAttributeColorPointRX:(ResponseHandler)completionHandler;
434 - (void)writeAttributeColorPointRX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
435 - (void)readAttributeColorPointRY:(ResponseHandler)completionHandler;
436 - (void)writeAttributeColorPointRY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
437 - (void)readAttributeColorPointRIntensity:(ResponseHandler)completionHandler;
438 - (void)writeAttributeColorPointRIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
439 - (void)readAttributeColorPointGX:(ResponseHandler)completionHandler;
440 - (void)writeAttributeColorPointGX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
441 - (void)readAttributeColorPointGY:(ResponseHandler)completionHandler;
442 - (void)writeAttributeColorPointGY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
443 - (void)readAttributeColorPointGIntensity:(ResponseHandler)completionHandler;
444 - (void)writeAttributeColorPointGIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
445 - (void)readAttributeColorPointBX:(ResponseHandler)completionHandler;
446 - (void)writeAttributeColorPointBX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
447 - (void)readAttributeColorPointBY:(ResponseHandler)completionHandler;
448 - (void)writeAttributeColorPointBY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
449 - (void)readAttributeColorPointBIntensity:(ResponseHandler)completionHandler;
450 - (void)writeAttributeColorPointBIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
451 - (void)readAttributeEnhancedCurrentHue:(ResponseHandler)completionHandler;
452 - (void)readAttributeEnhancedColorMode:(ResponseHandler)completionHandler;
453 - (void)readAttributeColorLoopActive:(ResponseHandler)completionHandler;
454 - (void)readAttributeColorLoopDirection:(ResponseHandler)completionHandler;
455 - (void)readAttributeColorLoopTime:(ResponseHandler)completionHandler;
456 - (void)readAttributeColorCapabilities:(ResponseHandler)completionHandler;
457 - (void)readAttributeColorTempPhysicalMin:(ResponseHandler)completionHandler;
458 - (void)readAttributeColorTempPhysicalMax:(ResponseHandler)completionHandler;
459 - (void)readAttributeCoupleColorTempToLevelMinMireds:(ResponseHandler)completionHandler;
460 - (void)readAttributeStartUpColorTemperatureMireds:(ResponseHandler)completionHandler;
461 - (void)writeAttributeStartUpColorTemperatureMireds:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
462 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
467 * Cluster Content Launch
470 @interface CHIPContentLaunch : CHIPCluster
472 - (void)launchContent:(ResponseHandler)completionHandler;
473 - (void)launchURL:(ResponseHandler)completionHandler;
475 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
483 @interface CHIPDoorLock : CHIPCluster
485 - (void)clearAllPins:(ResponseHandler)completionHandler;
486 - (void)clearAllRfids:(ResponseHandler)completionHandler;
487 - (void)clearHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
488 - (void)clearPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
489 - (void)clearRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
490 - (void)clearWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
491 - (void)clearYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
492 - (void)getHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
493 - (void)getLogRecord:(uint16_t)logIndex completionHandler:(ResponseHandler)completionHandler;
494 - (void)getPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
495 - (void)getRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
496 - (void)getUserType:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
497 - (void)getWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
498 - (void)getYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
499 - (void)lockDoor:(char *)pin completionHandler:(ResponseHandler)completionHandler;
500 - (void)setHolidaySchedule:(uint8_t)scheduleId
501 localStartTime:(uint32_t)localStartTime
502 localEndTime:(uint32_t)localEndTime
503 operatingModeDuringHoliday:(uint8_t)operatingModeDuringHoliday
504 completionHandler:(ResponseHandler)completionHandler;
505 - (void)setPin:(uint16_t)userId
506 userStatus:(uint8_t)userStatus
507 userType:(uint8_t)userType
509 completionHandler:(ResponseHandler)completionHandler;
510 - (void)setRfid:(uint16_t)userId
511 userStatus:(uint8_t)userStatus
512 userType:(uint8_t)userType
514 completionHandler:(ResponseHandler)completionHandler;
515 - (void)setUserType:(uint16_t)userId userType:(uint8_t)userType completionHandler:(ResponseHandler)completionHandler;
516 - (void)setWeekdaySchedule:(uint8_t)scheduleId
517 userId:(uint16_t)userId
518 daysMask:(uint8_t)daysMask
519 startHour:(uint8_t)startHour
520 startMinute:(uint8_t)startMinute
521 endHour:(uint8_t)endHour
522 endMinute:(uint8_t)endMinute
523 completionHandler:(ResponseHandler)completionHandler;
524 - (void)setYeardaySchedule:(uint8_t)scheduleId
525 userId:(uint16_t)userId
526 localStartTime:(uint32_t)localStartTime
527 localEndTime:(uint32_t)localEndTime
528 completionHandler:(ResponseHandler)completionHandler;
529 - (void)unlockDoor:(char *)pin completionHandler:(ResponseHandler)completionHandler;
530 - (void)unlockWithTimeout:(uint16_t)timeoutInSeconds pin:(char *)pin completionHandler:(ResponseHandler)completionHandler;
532 - (void)readAttributeLockState:(ResponseHandler)completionHandler;
533 - (void)configureAttributeLockState:(uint16_t)minInterval
534 maxInterval:(uint16_t)maxInterval
535 completionHandler:(ResponseHandler)completionHandler;
536 - (void)reportAttributeLockState:(ResponseHandler)reportHandler;
537 - (void)readAttributeLockType:(ResponseHandler)completionHandler;
538 - (void)readAttributeActuatorEnabled:(ResponseHandler)completionHandler;
539 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
547 @interface CHIPDoorLock : CHIPCluster
549 - (void)clearAllPins:(ResponseHandler)completionHandler;
550 - (void)clearAllRfids:(ResponseHandler)completionHandler;
551 - (void)clearHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
552 - (void)clearPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
553 - (void)clearRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
554 - (void)clearWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
555 - (void)clearYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
556 - (void)getHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
557 - (void)getLogRecord:(uint16_t)logIndex completionHandler:(ResponseHandler)completionHandler;
558 - (void)getPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
559 - (void)getRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
560 - (void)getUserType:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
561 - (void)getWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
562 - (void)getYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
563 - (void)lockDoor:(char *)pin completionHandler:(ResponseHandler)completionHandler;
564 - (void)setHolidaySchedule:(uint8_t)scheduleId
565 localStartTime:(uint32_t)localStartTime
566 localEndTime:(uint32_t)localEndTime
567 operatingModeDuringHoliday:(uint8_t)operatingModeDuringHoliday
568 completionHandler:(ResponseHandler)completionHandler;
569 - (void)setPin:(uint16_t)userId
570 userStatus:(uint8_t)userStatus
571 userType:(uint8_t)userType
573 completionHandler:(ResponseHandler)completionHandler;
574 - (void)setRfid:(uint16_t)userId
575 userStatus:(uint8_t)userStatus
576 userType:(uint8_t)userType
578 completionHandler:(ResponseHandler)completionHandler;
579 - (void)setUserType:(uint16_t)userId userType:(uint8_t)userType completionHandler:(ResponseHandler)completionHandler;
580 - (void)setWeekdaySchedule:(uint8_t)scheduleId
581 userId:(uint16_t)userId
582 daysMask:(uint8_t)daysMask
583 startHour:(uint8_t)startHour
584 startMinute:(uint8_t)startMinute
585 endHour:(uint8_t)endHour
586 endMinute:(uint8_t)endMinute
587 completionHandler:(ResponseHandler)completionHandler;
588 - (void)setYeardaySchedule:(uint8_t)scheduleId
589 userId:(uint16_t)userId
590 localStartTime:(uint32_t)localStartTime
591 localEndTime:(uint32_t)localEndTime
592 completionHandler:(ResponseHandler)completionHandler;
593 - (void)unlockDoor:(char *)pin completionHandler:(ResponseHandler)completionHandler;
594 - (void)unlockWithTimeout:(uint16_t)timeoutInSeconds pin:(char *)pin completionHandler:(ResponseHandler)completionHandler;
596 - (void)readAttributeLockState:(ResponseHandler)completionHandler;
597 - (void)configureAttributeLockState:(uint16_t)minInterval
598 maxInterval:(uint16_t)maxInterval
599 completionHandler:(ResponseHandler)completionHandler;
600 - (void)reportAttributeLockState:(ResponseHandler)reportHandler;
601 - (void)readAttributeLockType:(ResponseHandler)completionHandler;
602 - (void)readAttributeActuatorEnabled:(ResponseHandler)completionHandler;
603 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
611 @interface CHIPGroups : CHIPCluster
613 - (void)addGroup:(uint16_t)groupId groupName:(char *)groupName completionHandler:(ResponseHandler)completionHandler;
614 - (void)addGroupIfIdentifying:(uint16_t)groupId groupName:(char *)groupName completionHandler:(ResponseHandler)completionHandler;
615 - (void)getGroupMembership:(uint8_t)groupCount groupList:(uint16_t)groupList completionHandler:(ResponseHandler)completionHandler;
616 - (void)removeAllGroups:(ResponseHandler)completionHandler;
617 - (void)removeGroup:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
618 - (void)viewGroup:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
620 - (void)readAttributeNameSupport:(ResponseHandler)completionHandler;
621 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
629 @interface CHIPIasZone : CHIPCluster
631 - (void)readAttributeZoneState:(ResponseHandler)completionHandler;
632 - (void)readAttributeZoneType:(ResponseHandler)completionHandler;
633 - (void)readAttributeZoneStatus:(ResponseHandler)completionHandler;
634 - (void)readAttributeIasCieAddress:(ResponseHandler)completionHandler;
635 - (void)writeAttributeIasCieAddress:(uint64_t)value completionHandler:(ResponseHandler)completionHandler;
636 - (void)readAttributeZoneId:(ResponseHandler)completionHandler;
637 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
645 @interface CHIPIdentify : CHIPCluster
647 - (void)identify:(uint16_t)identifyTime completionHandler:(ResponseHandler)completionHandler;
648 - (void)identifyQuery:(ResponseHandler)completionHandler;
650 - (void)readAttributeIdentifyTime:(ResponseHandler)completionHandler;
651 - (void)writeAttributeIdentifyTime:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
652 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
657 * Cluster Level Control
660 @interface CHIPLevelControl : CHIPCluster
662 - (void)move:(uint8_t)moveMode
664 optionMask:(uint8_t)optionMask
665 optionOverride:(uint8_t)optionOverride
666 completionHandler:(ResponseHandler)completionHandler;
667 - (void)moveToLevel:(uint8_t)level
668 transitionTime:(uint16_t)transitionTime
669 optionMask:(uint8_t)optionMask
670 optionOverride:(uint8_t)optionOverride
671 completionHandler:(ResponseHandler)completionHandler;
672 - (void)moveToLevelWithOnOff:(uint8_t)level
673 transitionTime:(uint16_t)transitionTime
674 completionHandler:(ResponseHandler)completionHandler;
675 - (void)moveWithOnOff:(uint8_t)moveMode rate:(uint8_t)rate completionHandler:(ResponseHandler)completionHandler;
676 - (void)step:(uint8_t)stepMode
677 stepSize:(uint8_t)stepSize
678 transitionTime:(uint16_t)transitionTime
679 optionMask:(uint8_t)optionMask
680 optionOverride:(uint8_t)optionOverride
681 completionHandler:(ResponseHandler)completionHandler;
682 - (void)stepWithOnOff:(uint8_t)stepMode
683 stepSize:(uint8_t)stepSize
684 transitionTime:(uint16_t)transitionTime
685 completionHandler:(ResponseHandler)completionHandler;
686 - (void)stop:(uint8_t)optionMask optionOverride:(uint8_t)optionOverride completionHandler:(ResponseHandler)completionHandler;
687 - (void)stopWithOnOff:(ResponseHandler)completionHandler;
689 - (void)readAttributeCurrentLevel:(ResponseHandler)completionHandler;
690 - (void)configureAttributeCurrentLevel:(uint16_t)minInterval
691 maxInterval:(uint16_t)maxInterval
692 change:(uint8_t)change
693 completionHandler:(ResponseHandler)completionHandler;
694 - (void)reportAttributeCurrentLevel:(ResponseHandler)reportHandler;
695 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
703 @interface CHIPLowPower : CHIPCluster
705 - (void)sleep:(ResponseHandler)completionHandler;
707 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
712 * Cluster Media Playback
715 @interface CHIPMediaPlayback : CHIPCluster
717 - (void)fastForwardRequest:(ResponseHandler)completionHandler;
718 - (void)nextRequest:(ResponseHandler)completionHandler;
719 - (void)pauseRequest:(ResponseHandler)completionHandler;
720 - (void)playRequest:(ResponseHandler)completionHandler;
721 - (void)previousRequest:(ResponseHandler)completionHandler;
722 - (void)rewindRequest:(ResponseHandler)completionHandler;
723 - (void)skipBackwardRequest:(ResponseHandler)completionHandler;
724 - (void)skipForwardRequest:(ResponseHandler)completionHandler;
725 - (void)startOverRequest:(ResponseHandler)completionHandler;
726 - (void)stopRequest:(ResponseHandler)completionHandler;
728 - (void)readAttributeCurrentState:(ResponseHandler)completionHandler;
729 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
737 @interface CHIPOnOff : CHIPCluster
739 - (void)off:(ResponseHandler)completionHandler;
740 - (void)on:(ResponseHandler)completionHandler;
741 - (void)toggle:(ResponseHandler)completionHandler;
743 - (void)readAttributeOnOff:(ResponseHandler)completionHandler;
744 - (void)configureAttributeOnOff:(uint16_t)minInterval
745 maxInterval:(uint16_t)maxInterval
746 completionHandler:(ResponseHandler)completionHandler;
747 - (void)reportAttributeOnOff:(ResponseHandler)reportHandler;
748 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
756 @interface CHIPScenes : CHIPCluster
758 - (void)addScene:(uint16_t)groupId
759 sceneId:(uint8_t)sceneId
760 transitionTime:(uint16_t)transitionTime
761 sceneName:(char *)sceneName
762 clusterId:(uint16_t)clusterId
763 length:(uint8_t)length
765 completionHandler:(ResponseHandler)completionHandler;
766 - (void)getSceneMembership:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
767 - (void)recallScene:(uint16_t)groupId
768 sceneId:(uint8_t)sceneId
769 transitionTime:(uint16_t)transitionTime
770 completionHandler:(ResponseHandler)completionHandler;
771 - (void)removeAllScenes:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
772 - (void)removeScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
773 - (void)storeScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
774 - (void)viewScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
776 - (void)readAttributeSceneCount:(ResponseHandler)completionHandler;
777 - (void)readAttributeCurrentScene:(ResponseHandler)completionHandler;
778 - (void)readAttributeCurrentGroup:(ResponseHandler)completionHandler;
779 - (void)readAttributeSceneValid:(ResponseHandler)completionHandler;
780 - (void)readAttributeNameSupport:(ResponseHandler)completionHandler;
781 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
786 * Cluster Temperature Measurement
789 @interface CHIPTemperatureMeasurement : CHIPCluster
791 - (void)readAttributeMeasuredValue:(ResponseHandler)completionHandler;
792 - (void)configureAttributeMeasuredValue:(uint16_t)minInterval
793 maxInterval:(uint16_t)maxInterval
794 change:(int16_t)change
795 completionHandler:(ResponseHandler)completionHandler;
796 - (void)reportAttributeMeasuredValue:(ResponseHandler)reportHandler;
797 - (void)readAttributeMinMeasuredValue:(ResponseHandler)completionHandler;
798 - (void)readAttributeMaxMeasuredValue:(ResponseHandler)completionHandler;
799 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
803 NS_ASSUME_NONNULL_END
805 #endif /* CHIP_CLUSTERS_H */