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)readAttributeInteractionModelVersion:(ResponseHandler)completionHandler;
103 - (void)readAttributeVendorName:(ResponseHandler)completionHandler;
104 - (void)readAttributeVendorID:(ResponseHandler)completionHandler;
105 - (void)readAttributeProductName:(ResponseHandler)completionHandler;
106 - (void)readAttributeProductID:(ResponseHandler)completionHandler;
107 - (void)readAttributeUserLabel:(ResponseHandler)completionHandler;
108 - (void)writeAttributeUserLabel:(NSString *)value completionHandler:(ResponseHandler)completionHandler;
109 - (void)readAttributeLocation:(ResponseHandler)completionHandler;
110 - (void)writeAttributeLocation:(NSString *)value completionHandler:(ResponseHandler)completionHandler;
111 - (void)readAttributeHardwareVersion:(ResponseHandler)completionHandler;
112 - (void)readAttributeHardwareVersionString:(ResponseHandler)completionHandler;
113 - (void)readAttributeSoftwareVersion:(ResponseHandler)completionHandler;
114 - (void)readAttributeSoftwareVersionString:(ResponseHandler)completionHandler;
115 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
120 * Cluster Color Control
123 @interface CHIPColorControl : CHIPCluster
125 - (void)moveColor:(int16_t)rateX
127 optionsMask:(uint8_t)optionsMask
128 optionsOverride:(uint8_t)optionsOverride
129 completionHandler:(ResponseHandler)completionHandler;
130 - (void)moveColorTemperature:(uint8_t)moveMode
132 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
133 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
134 optionsMask:(uint8_t)optionsMask
135 optionsOverride:(uint8_t)optionsOverride
136 completionHandler:(ResponseHandler)completionHandler;
137 - (void)moveHue:(uint8_t)moveMode
139 optionsMask:(uint8_t)optionsMask
140 optionsOverride:(uint8_t)optionsOverride
141 completionHandler:(ResponseHandler)completionHandler;
142 - (void)moveSaturation:(uint8_t)moveMode
144 optionsMask:(uint8_t)optionsMask
145 optionsOverride:(uint8_t)optionsOverride
146 completionHandler:(ResponseHandler)completionHandler;
147 - (void)moveToColor:(uint16_t)colorX
148 colorY:(uint16_t)colorY
149 transitionTime:(uint16_t)transitionTime
150 optionsMask:(uint8_t)optionsMask
151 optionsOverride:(uint8_t)optionsOverride
152 completionHandler:(ResponseHandler)completionHandler;
153 - (void)moveToColorTemperature:(uint16_t)colorTemperature
154 transitionTime:(uint16_t)transitionTime
155 optionsMask:(uint8_t)optionsMask
156 optionsOverride:(uint8_t)optionsOverride
157 completionHandler:(ResponseHandler)completionHandler;
158 - (void)moveToHue:(uint8_t)hue
159 direction:(uint8_t)direction
160 transitionTime:(uint16_t)transitionTime
161 optionsMask:(uint8_t)optionsMask
162 optionsOverride:(uint8_t)optionsOverride
163 completionHandler:(ResponseHandler)completionHandler;
164 - (void)moveToHueAndSaturation:(uint8_t)hue
165 saturation:(uint8_t)saturation
166 transitionTime:(uint16_t)transitionTime
167 optionsMask:(uint8_t)optionsMask
168 optionsOverride:(uint8_t)optionsOverride
169 completionHandler:(ResponseHandler)completionHandler;
170 - (void)moveToSaturation:(uint8_t)saturation
171 transitionTime:(uint16_t)transitionTime
172 optionsMask:(uint8_t)optionsMask
173 optionsOverride:(uint8_t)optionsOverride
174 completionHandler:(ResponseHandler)completionHandler;
175 - (void)stepColor:(int16_t)stepX
177 transitionTime:(uint16_t)transitionTime
178 optionsMask:(uint8_t)optionsMask
179 optionsOverride:(uint8_t)optionsOverride
180 completionHandler:(ResponseHandler)completionHandler;
181 - (void)stepColorTemperature:(uint8_t)stepMode
182 stepSize:(uint16_t)stepSize
183 transitionTime:(uint16_t)transitionTime
184 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
185 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
186 optionsMask:(uint8_t)optionsMask
187 optionsOverride:(uint8_t)optionsOverride
188 completionHandler:(ResponseHandler)completionHandler;
189 - (void)stepHue:(uint8_t)stepMode
190 stepSize:(uint8_t)stepSize
191 transitionTime:(uint8_t)transitionTime
192 optionsMask:(uint8_t)optionsMask
193 optionsOverride:(uint8_t)optionsOverride
194 completionHandler:(ResponseHandler)completionHandler;
195 - (void)stepSaturation:(uint8_t)stepMode
196 stepSize:(uint8_t)stepSize
197 transitionTime:(uint8_t)transitionTime
198 optionsMask:(uint8_t)optionsMask
199 optionsOverride:(uint8_t)optionsOverride
200 completionHandler:(ResponseHandler)completionHandler;
201 - (void)stopMoveStep:(uint8_t)optionsMask
202 optionsOverride:(uint8_t)optionsOverride
203 completionHandler:(ResponseHandler)completionHandler;
205 - (void)readAttributeCurrentHue:(ResponseHandler)completionHandler;
206 - (void)configureAttributeCurrentHue:(uint16_t)minInterval
207 maxInterval:(uint16_t)maxInterval
208 change:(uint8_t)change
209 completionHandler:(ResponseHandler)completionHandler;
210 - (void)reportAttributeCurrentHue:(ResponseHandler)reportHandler;
211 - (void)readAttributeCurrentSaturation:(ResponseHandler)completionHandler;
212 - (void)configureAttributeCurrentSaturation:(uint16_t)minInterval
213 maxInterval:(uint16_t)maxInterval
214 change:(uint8_t)change
215 completionHandler:(ResponseHandler)completionHandler;
216 - (void)reportAttributeCurrentSaturation:(ResponseHandler)reportHandler;
217 - (void)readAttributeRemainingTime:(ResponseHandler)completionHandler;
218 - (void)readAttributeCurrentX:(ResponseHandler)completionHandler;
219 - (void)configureAttributeCurrentX:(uint16_t)minInterval
220 maxInterval:(uint16_t)maxInterval
221 change:(uint16_t)change
222 completionHandler:(ResponseHandler)completionHandler;
223 - (void)reportAttributeCurrentX:(ResponseHandler)reportHandler;
224 - (void)readAttributeCurrentY:(ResponseHandler)completionHandler;
225 - (void)configureAttributeCurrentY:(uint16_t)minInterval
226 maxInterval:(uint16_t)maxInterval
227 change:(uint16_t)change
228 completionHandler:(ResponseHandler)completionHandler;
229 - (void)reportAttributeCurrentY:(ResponseHandler)reportHandler;
230 - (void)readAttributeDriftCompensation:(ResponseHandler)completionHandler;
231 - (void)readAttributeCompensationText:(ResponseHandler)completionHandler;
232 - (void)readAttributeColorTemperature:(ResponseHandler)completionHandler;
233 - (void)configureAttributeColorTemperature:(uint16_t)minInterval
234 maxInterval:(uint16_t)maxInterval
235 change:(uint16_t)change
236 completionHandler:(ResponseHandler)completionHandler;
237 - (void)reportAttributeColorTemperature:(ResponseHandler)reportHandler;
238 - (void)readAttributeColorMode:(ResponseHandler)completionHandler;
239 - (void)readAttributeColorControlOptions:(ResponseHandler)completionHandler;
240 - (void)writeAttributeColorControlOptions:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
241 - (void)readAttributeNumberOfPrimaries:(ResponseHandler)completionHandler;
242 - (void)readAttributePrimary1X:(ResponseHandler)completionHandler;
243 - (void)readAttributePrimary1Y:(ResponseHandler)completionHandler;
244 - (void)readAttributePrimary1Intensity:(ResponseHandler)completionHandler;
245 - (void)readAttributePrimary2X:(ResponseHandler)completionHandler;
246 - (void)readAttributePrimary2Y:(ResponseHandler)completionHandler;
247 - (void)readAttributePrimary2Intensity:(ResponseHandler)completionHandler;
248 - (void)readAttributePrimary3X:(ResponseHandler)completionHandler;
249 - (void)readAttributePrimary3Y:(ResponseHandler)completionHandler;
250 - (void)readAttributePrimary3Intensity:(ResponseHandler)completionHandler;
251 - (void)readAttributePrimary4X:(ResponseHandler)completionHandler;
252 - (void)readAttributePrimary4Y:(ResponseHandler)completionHandler;
253 - (void)readAttributePrimary4Intensity:(ResponseHandler)completionHandler;
254 - (void)readAttributePrimary5X:(ResponseHandler)completionHandler;
255 - (void)readAttributePrimary5Y:(ResponseHandler)completionHandler;
256 - (void)readAttributePrimary5Intensity:(ResponseHandler)completionHandler;
257 - (void)readAttributePrimary6X:(ResponseHandler)completionHandler;
258 - (void)readAttributePrimary6Y:(ResponseHandler)completionHandler;
259 - (void)readAttributePrimary6Intensity:(ResponseHandler)completionHandler;
260 - (void)readAttributeWhitePointX:(ResponseHandler)completionHandler;
261 - (void)writeAttributeWhitePointX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
262 - (void)readAttributeWhitePointY:(ResponseHandler)completionHandler;
263 - (void)writeAttributeWhitePointY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
264 - (void)readAttributeColorPointRX:(ResponseHandler)completionHandler;
265 - (void)writeAttributeColorPointRX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
266 - (void)readAttributeColorPointRY:(ResponseHandler)completionHandler;
267 - (void)writeAttributeColorPointRY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
268 - (void)readAttributeColorPointRIntensity:(ResponseHandler)completionHandler;
269 - (void)writeAttributeColorPointRIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
270 - (void)readAttributeColorPointGX:(ResponseHandler)completionHandler;
271 - (void)writeAttributeColorPointGX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
272 - (void)readAttributeColorPointGY:(ResponseHandler)completionHandler;
273 - (void)writeAttributeColorPointGY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
274 - (void)readAttributeColorPointGIntensity:(ResponseHandler)completionHandler;
275 - (void)writeAttributeColorPointGIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
276 - (void)readAttributeColorPointBX:(ResponseHandler)completionHandler;
277 - (void)writeAttributeColorPointBX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
278 - (void)readAttributeColorPointBY:(ResponseHandler)completionHandler;
279 - (void)writeAttributeColorPointBY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
280 - (void)readAttributeColorPointBIntensity:(ResponseHandler)completionHandler;
281 - (void)writeAttributeColorPointBIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
282 - (void)readAttributeEnhancedCurrentHue:(ResponseHandler)completionHandler;
283 - (void)readAttributeEnhancedColorMode:(ResponseHandler)completionHandler;
284 - (void)readAttributeColorLoopActive:(ResponseHandler)completionHandler;
285 - (void)readAttributeColorLoopDirection:(ResponseHandler)completionHandler;
286 - (void)readAttributeColorLoopTime:(ResponseHandler)completionHandler;
287 - (void)readAttributeColorCapabilities:(ResponseHandler)completionHandler;
288 - (void)readAttributeColorTempPhysicalMin:(ResponseHandler)completionHandler;
289 - (void)readAttributeColorTempPhysicalMax:(ResponseHandler)completionHandler;
290 - (void)readAttributeCoupleColorTempToLevelMinMireds:(ResponseHandler)completionHandler;
291 - (void)readAttributeStartUpColorTemperatureMireds:(ResponseHandler)completionHandler;
292 - (void)writeAttributeStartUpColorTemperatureMireds:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
293 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
298 * Cluster Color Control
301 @interface CHIPColorControl : CHIPCluster
303 - (void)moveColor:(int16_t)rateX
305 optionsMask:(uint8_t)optionsMask
306 optionsOverride:(uint8_t)optionsOverride
307 completionHandler:(ResponseHandler)completionHandler;
308 - (void)moveColorTemperature:(uint8_t)moveMode
310 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
311 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
312 optionsMask:(uint8_t)optionsMask
313 optionsOverride:(uint8_t)optionsOverride
314 completionHandler:(ResponseHandler)completionHandler;
315 - (void)moveHue:(uint8_t)moveMode
317 optionsMask:(uint8_t)optionsMask
318 optionsOverride:(uint8_t)optionsOverride
319 completionHandler:(ResponseHandler)completionHandler;
320 - (void)moveSaturation:(uint8_t)moveMode
322 optionsMask:(uint8_t)optionsMask
323 optionsOverride:(uint8_t)optionsOverride
324 completionHandler:(ResponseHandler)completionHandler;
325 - (void)moveToColor:(uint16_t)colorX
326 colorY:(uint16_t)colorY
327 transitionTime:(uint16_t)transitionTime
328 optionsMask:(uint8_t)optionsMask
329 optionsOverride:(uint8_t)optionsOverride
330 completionHandler:(ResponseHandler)completionHandler;
331 - (void)moveToColorTemperature:(uint16_t)colorTemperature
332 transitionTime:(uint16_t)transitionTime
333 optionsMask:(uint8_t)optionsMask
334 optionsOverride:(uint8_t)optionsOverride
335 completionHandler:(ResponseHandler)completionHandler;
336 - (void)moveToHue:(uint8_t)hue
337 direction:(uint8_t)direction
338 transitionTime:(uint16_t)transitionTime
339 optionsMask:(uint8_t)optionsMask
340 optionsOverride:(uint8_t)optionsOverride
341 completionHandler:(ResponseHandler)completionHandler;
342 - (void)moveToHueAndSaturation:(uint8_t)hue
343 saturation:(uint8_t)saturation
344 transitionTime:(uint16_t)transitionTime
345 optionsMask:(uint8_t)optionsMask
346 optionsOverride:(uint8_t)optionsOverride
347 completionHandler:(ResponseHandler)completionHandler;
348 - (void)moveToSaturation:(uint8_t)saturation
349 transitionTime:(uint16_t)transitionTime
350 optionsMask:(uint8_t)optionsMask
351 optionsOverride:(uint8_t)optionsOverride
352 completionHandler:(ResponseHandler)completionHandler;
353 - (void)stepColor:(int16_t)stepX
355 transitionTime:(uint16_t)transitionTime
356 optionsMask:(uint8_t)optionsMask
357 optionsOverride:(uint8_t)optionsOverride
358 completionHandler:(ResponseHandler)completionHandler;
359 - (void)stepColorTemperature:(uint8_t)stepMode
360 stepSize:(uint16_t)stepSize
361 transitionTime:(uint16_t)transitionTime
362 colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
363 colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
364 optionsMask:(uint8_t)optionsMask
365 optionsOverride:(uint8_t)optionsOverride
366 completionHandler:(ResponseHandler)completionHandler;
367 - (void)stepHue:(uint8_t)stepMode
368 stepSize:(uint8_t)stepSize
369 transitionTime:(uint8_t)transitionTime
370 optionsMask:(uint8_t)optionsMask
371 optionsOverride:(uint8_t)optionsOverride
372 completionHandler:(ResponseHandler)completionHandler;
373 - (void)stepSaturation:(uint8_t)stepMode
374 stepSize:(uint8_t)stepSize
375 transitionTime:(uint8_t)transitionTime
376 optionsMask:(uint8_t)optionsMask
377 optionsOverride:(uint8_t)optionsOverride
378 completionHandler:(ResponseHandler)completionHandler;
379 - (void)stopMoveStep:(uint8_t)optionsMask
380 optionsOverride:(uint8_t)optionsOverride
381 completionHandler:(ResponseHandler)completionHandler;
383 - (void)readAttributeCurrentHue:(ResponseHandler)completionHandler;
384 - (void)configureAttributeCurrentHue:(uint16_t)minInterval
385 maxInterval:(uint16_t)maxInterval
386 change:(uint8_t)change
387 completionHandler:(ResponseHandler)completionHandler;
388 - (void)reportAttributeCurrentHue:(ResponseHandler)reportHandler;
389 - (void)readAttributeCurrentSaturation:(ResponseHandler)completionHandler;
390 - (void)configureAttributeCurrentSaturation:(uint16_t)minInterval
391 maxInterval:(uint16_t)maxInterval
392 change:(uint8_t)change
393 completionHandler:(ResponseHandler)completionHandler;
394 - (void)reportAttributeCurrentSaturation:(ResponseHandler)reportHandler;
395 - (void)readAttributeRemainingTime:(ResponseHandler)completionHandler;
396 - (void)readAttributeCurrentX:(ResponseHandler)completionHandler;
397 - (void)configureAttributeCurrentX:(uint16_t)minInterval
398 maxInterval:(uint16_t)maxInterval
399 change:(uint16_t)change
400 completionHandler:(ResponseHandler)completionHandler;
401 - (void)reportAttributeCurrentX:(ResponseHandler)reportHandler;
402 - (void)readAttributeCurrentY:(ResponseHandler)completionHandler;
403 - (void)configureAttributeCurrentY:(uint16_t)minInterval
404 maxInterval:(uint16_t)maxInterval
405 change:(uint16_t)change
406 completionHandler:(ResponseHandler)completionHandler;
407 - (void)reportAttributeCurrentY:(ResponseHandler)reportHandler;
408 - (void)readAttributeDriftCompensation:(ResponseHandler)completionHandler;
409 - (void)readAttributeCompensationText:(ResponseHandler)completionHandler;
410 - (void)readAttributeColorTemperature:(ResponseHandler)completionHandler;
411 - (void)configureAttributeColorTemperature:(uint16_t)minInterval
412 maxInterval:(uint16_t)maxInterval
413 change:(uint16_t)change
414 completionHandler:(ResponseHandler)completionHandler;
415 - (void)reportAttributeColorTemperature:(ResponseHandler)reportHandler;
416 - (void)readAttributeColorMode:(ResponseHandler)completionHandler;
417 - (void)readAttributeColorControlOptions:(ResponseHandler)completionHandler;
418 - (void)writeAttributeColorControlOptions:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
419 - (void)readAttributeNumberOfPrimaries:(ResponseHandler)completionHandler;
420 - (void)readAttributePrimary1X:(ResponseHandler)completionHandler;
421 - (void)readAttributePrimary1Y:(ResponseHandler)completionHandler;
422 - (void)readAttributePrimary1Intensity:(ResponseHandler)completionHandler;
423 - (void)readAttributePrimary2X:(ResponseHandler)completionHandler;
424 - (void)readAttributePrimary2Y:(ResponseHandler)completionHandler;
425 - (void)readAttributePrimary2Intensity:(ResponseHandler)completionHandler;
426 - (void)readAttributePrimary3X:(ResponseHandler)completionHandler;
427 - (void)readAttributePrimary3Y:(ResponseHandler)completionHandler;
428 - (void)readAttributePrimary3Intensity:(ResponseHandler)completionHandler;
429 - (void)readAttributePrimary4X:(ResponseHandler)completionHandler;
430 - (void)readAttributePrimary4Y:(ResponseHandler)completionHandler;
431 - (void)readAttributePrimary4Intensity:(ResponseHandler)completionHandler;
432 - (void)readAttributePrimary5X:(ResponseHandler)completionHandler;
433 - (void)readAttributePrimary5Y:(ResponseHandler)completionHandler;
434 - (void)readAttributePrimary5Intensity:(ResponseHandler)completionHandler;
435 - (void)readAttributePrimary6X:(ResponseHandler)completionHandler;
436 - (void)readAttributePrimary6Y:(ResponseHandler)completionHandler;
437 - (void)readAttributePrimary6Intensity:(ResponseHandler)completionHandler;
438 - (void)readAttributeWhitePointX:(ResponseHandler)completionHandler;
439 - (void)writeAttributeWhitePointX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
440 - (void)readAttributeWhitePointY:(ResponseHandler)completionHandler;
441 - (void)writeAttributeWhitePointY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
442 - (void)readAttributeColorPointRX:(ResponseHandler)completionHandler;
443 - (void)writeAttributeColorPointRX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
444 - (void)readAttributeColorPointRY:(ResponseHandler)completionHandler;
445 - (void)writeAttributeColorPointRY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
446 - (void)readAttributeColorPointRIntensity:(ResponseHandler)completionHandler;
447 - (void)writeAttributeColorPointRIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
448 - (void)readAttributeColorPointGX:(ResponseHandler)completionHandler;
449 - (void)writeAttributeColorPointGX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
450 - (void)readAttributeColorPointGY:(ResponseHandler)completionHandler;
451 - (void)writeAttributeColorPointGY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
452 - (void)readAttributeColorPointGIntensity:(ResponseHandler)completionHandler;
453 - (void)writeAttributeColorPointGIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
454 - (void)readAttributeColorPointBX:(ResponseHandler)completionHandler;
455 - (void)writeAttributeColorPointBX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
456 - (void)readAttributeColorPointBY:(ResponseHandler)completionHandler;
457 - (void)writeAttributeColorPointBY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
458 - (void)readAttributeColorPointBIntensity:(ResponseHandler)completionHandler;
459 - (void)writeAttributeColorPointBIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
460 - (void)readAttributeEnhancedCurrentHue:(ResponseHandler)completionHandler;
461 - (void)readAttributeEnhancedColorMode:(ResponseHandler)completionHandler;
462 - (void)readAttributeColorLoopActive:(ResponseHandler)completionHandler;
463 - (void)readAttributeColorLoopDirection:(ResponseHandler)completionHandler;
464 - (void)readAttributeColorLoopTime:(ResponseHandler)completionHandler;
465 - (void)readAttributeColorCapabilities:(ResponseHandler)completionHandler;
466 - (void)readAttributeColorTempPhysicalMin:(ResponseHandler)completionHandler;
467 - (void)readAttributeColorTempPhysicalMax:(ResponseHandler)completionHandler;
468 - (void)readAttributeCoupleColorTempToLevelMinMireds:(ResponseHandler)completionHandler;
469 - (void)readAttributeStartUpColorTemperatureMireds:(ResponseHandler)completionHandler;
470 - (void)writeAttributeStartUpColorTemperatureMireds:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
471 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
476 * Cluster Content Launch
479 @interface CHIPContentLaunch : CHIPCluster
481 - (void)launchContent:(ResponseHandler)completionHandler;
482 - (void)launchURL:(ResponseHandler)completionHandler;
484 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
492 @interface CHIPDoorLock : CHIPCluster
494 - (void)clearAllPins:(ResponseHandler)completionHandler;
495 - (void)clearAllRfids:(ResponseHandler)completionHandler;
496 - (void)clearHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
497 - (void)clearPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
498 - (void)clearRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
499 - (void)clearWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
500 - (void)clearYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
501 - (void)getHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
502 - (void)getLogRecord:(uint16_t)logIndex completionHandler:(ResponseHandler)completionHandler;
503 - (void)getPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
504 - (void)getRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
505 - (void)getUserType:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
506 - (void)getWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
507 - (void)getYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
508 - (void)lockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
509 - (void)setHolidaySchedule:(uint8_t)scheduleId
510 localStartTime:(uint32_t)localStartTime
511 localEndTime:(uint32_t)localEndTime
512 operatingModeDuringHoliday:(uint8_t)operatingModeDuringHoliday
513 completionHandler:(ResponseHandler)completionHandler;
514 - (void)setPin:(uint16_t)userId
515 userStatus:(uint8_t)userStatus
516 userType:(uint8_t)userType
518 completionHandler:(ResponseHandler)completionHandler;
519 - (void)setRfid:(uint16_t)userId
520 userStatus:(uint8_t)userStatus
521 userType:(uint8_t)userType
523 completionHandler:(ResponseHandler)completionHandler;
524 - (void)setUserType:(uint16_t)userId userType:(uint8_t)userType completionHandler:(ResponseHandler)completionHandler;
525 - (void)setWeekdaySchedule:(uint8_t)scheduleId
526 userId:(uint16_t)userId
527 daysMask:(uint8_t)daysMask
528 startHour:(uint8_t)startHour
529 startMinute:(uint8_t)startMinute
530 endHour:(uint8_t)endHour
531 endMinute:(uint8_t)endMinute
532 completionHandler:(ResponseHandler)completionHandler;
533 - (void)setYeardaySchedule:(uint8_t)scheduleId
534 userId:(uint16_t)userId
535 localStartTime:(uint32_t)localStartTime
536 localEndTime:(uint32_t)localEndTime
537 completionHandler:(ResponseHandler)completionHandler;
538 - (void)unlockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
539 - (void)unlockWithTimeout:(uint16_t)timeoutInSeconds pin:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
541 - (void)readAttributeLockState:(ResponseHandler)completionHandler;
542 - (void)configureAttributeLockState:(uint16_t)minInterval
543 maxInterval:(uint16_t)maxInterval
544 completionHandler:(ResponseHandler)completionHandler;
545 - (void)reportAttributeLockState:(ResponseHandler)reportHandler;
546 - (void)readAttributeLockType:(ResponseHandler)completionHandler;
547 - (void)readAttributeActuatorEnabled:(ResponseHandler)completionHandler;
548 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
556 @interface CHIPDoorLock : CHIPCluster
558 - (void)clearAllPins:(ResponseHandler)completionHandler;
559 - (void)clearAllRfids:(ResponseHandler)completionHandler;
560 - (void)clearHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
561 - (void)clearPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
562 - (void)clearRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
563 - (void)clearWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
564 - (void)clearYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
565 - (void)getHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
566 - (void)getLogRecord:(uint16_t)logIndex completionHandler:(ResponseHandler)completionHandler;
567 - (void)getPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
568 - (void)getRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
569 - (void)getUserType:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
570 - (void)getWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
571 - (void)getYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
572 - (void)lockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
573 - (void)setHolidaySchedule:(uint8_t)scheduleId
574 localStartTime:(uint32_t)localStartTime
575 localEndTime:(uint32_t)localEndTime
576 operatingModeDuringHoliday:(uint8_t)operatingModeDuringHoliday
577 completionHandler:(ResponseHandler)completionHandler;
578 - (void)setPin:(uint16_t)userId
579 userStatus:(uint8_t)userStatus
580 userType:(uint8_t)userType
582 completionHandler:(ResponseHandler)completionHandler;
583 - (void)setRfid:(uint16_t)userId
584 userStatus:(uint8_t)userStatus
585 userType:(uint8_t)userType
587 completionHandler:(ResponseHandler)completionHandler;
588 - (void)setUserType:(uint16_t)userId userType:(uint8_t)userType completionHandler:(ResponseHandler)completionHandler;
589 - (void)setWeekdaySchedule:(uint8_t)scheduleId
590 userId:(uint16_t)userId
591 daysMask:(uint8_t)daysMask
592 startHour:(uint8_t)startHour
593 startMinute:(uint8_t)startMinute
594 endHour:(uint8_t)endHour
595 endMinute:(uint8_t)endMinute
596 completionHandler:(ResponseHandler)completionHandler;
597 - (void)setYeardaySchedule:(uint8_t)scheduleId
598 userId:(uint16_t)userId
599 localStartTime:(uint32_t)localStartTime
600 localEndTime:(uint32_t)localEndTime
601 completionHandler:(ResponseHandler)completionHandler;
602 - (void)unlockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
603 - (void)unlockWithTimeout:(uint16_t)timeoutInSeconds pin:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
605 - (void)readAttributeLockState:(ResponseHandler)completionHandler;
606 - (void)configureAttributeLockState:(uint16_t)minInterval
607 maxInterval:(uint16_t)maxInterval
608 completionHandler:(ResponseHandler)completionHandler;
609 - (void)reportAttributeLockState:(ResponseHandler)reportHandler;
610 - (void)readAttributeLockType:(ResponseHandler)completionHandler;
611 - (void)readAttributeActuatorEnabled:(ResponseHandler)completionHandler;
612 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
620 @interface CHIPGroups : CHIPCluster
622 - (void)addGroup:(uint16_t)groupId groupName:(NSString *)groupName completionHandler:(ResponseHandler)completionHandler;
623 - (void)addGroupIfIdentifying:(uint16_t)groupId
624 groupName:(NSString *)groupName
625 completionHandler:(ResponseHandler)completionHandler;
626 - (void)getGroupMembership:(uint8_t)groupCount groupList:(uint16_t)groupList completionHandler:(ResponseHandler)completionHandler;
627 - (void)removeAllGroups:(ResponseHandler)completionHandler;
628 - (void)removeGroup:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
629 - (void)viewGroup:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
631 - (void)readAttributeNameSupport:(ResponseHandler)completionHandler;
632 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
640 @interface CHIPIasZone : CHIPCluster
642 - (void)readAttributeZoneState:(ResponseHandler)completionHandler;
643 - (void)readAttributeZoneType:(ResponseHandler)completionHandler;
644 - (void)readAttributeZoneStatus:(ResponseHandler)completionHandler;
645 - (void)readAttributeIasCieAddress:(ResponseHandler)completionHandler;
646 - (void)writeAttributeIasCieAddress:(uint64_t)value completionHandler:(ResponseHandler)completionHandler;
647 - (void)readAttributeZoneId:(ResponseHandler)completionHandler;
648 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
656 @interface CHIPIdentify : CHIPCluster
658 - (void)identify:(uint16_t)identifyTime completionHandler:(ResponseHandler)completionHandler;
659 - (void)identifyQuery:(ResponseHandler)completionHandler;
661 - (void)readAttributeIdentifyTime:(ResponseHandler)completionHandler;
662 - (void)writeAttributeIdentifyTime:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
663 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
668 * Cluster Level Control
671 @interface CHIPLevelControl : CHIPCluster
673 - (void)move:(uint8_t)moveMode
675 optionMask:(uint8_t)optionMask
676 optionOverride:(uint8_t)optionOverride
677 completionHandler:(ResponseHandler)completionHandler;
678 - (void)moveToLevel:(uint8_t)level
679 transitionTime:(uint16_t)transitionTime
680 optionMask:(uint8_t)optionMask
681 optionOverride:(uint8_t)optionOverride
682 completionHandler:(ResponseHandler)completionHandler;
683 - (void)moveToLevelWithOnOff:(uint8_t)level
684 transitionTime:(uint16_t)transitionTime
685 completionHandler:(ResponseHandler)completionHandler;
686 - (void)moveWithOnOff:(uint8_t)moveMode rate:(uint8_t)rate completionHandler:(ResponseHandler)completionHandler;
687 - (void)step:(uint8_t)stepMode
688 stepSize:(uint8_t)stepSize
689 transitionTime:(uint16_t)transitionTime
690 optionMask:(uint8_t)optionMask
691 optionOverride:(uint8_t)optionOverride
692 completionHandler:(ResponseHandler)completionHandler;
693 - (void)stepWithOnOff:(uint8_t)stepMode
694 stepSize:(uint8_t)stepSize
695 transitionTime:(uint16_t)transitionTime
696 completionHandler:(ResponseHandler)completionHandler;
697 - (void)stop:(uint8_t)optionMask optionOverride:(uint8_t)optionOverride completionHandler:(ResponseHandler)completionHandler;
698 - (void)stopWithOnOff:(ResponseHandler)completionHandler;
700 - (void)readAttributeCurrentLevel:(ResponseHandler)completionHandler;
701 - (void)configureAttributeCurrentLevel:(uint16_t)minInterval
702 maxInterval:(uint16_t)maxInterval
703 change:(uint8_t)change
704 completionHandler:(ResponseHandler)completionHandler;
705 - (void)reportAttributeCurrentLevel:(ResponseHandler)reportHandler;
706 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
714 @interface CHIPLowPower : CHIPCluster
716 - (void)sleep:(ResponseHandler)completionHandler;
718 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
723 * Cluster Media Playback
726 @interface CHIPMediaPlayback : CHIPCluster
728 - (void)fastForwardRequest:(ResponseHandler)completionHandler;
729 - (void)nextRequest:(ResponseHandler)completionHandler;
730 - (void)pauseRequest:(ResponseHandler)completionHandler;
731 - (void)playRequest:(ResponseHandler)completionHandler;
732 - (void)previousRequest:(ResponseHandler)completionHandler;
733 - (void)rewindRequest:(ResponseHandler)completionHandler;
734 - (void)skipBackwardRequest:(ResponseHandler)completionHandler;
735 - (void)skipForwardRequest:(ResponseHandler)completionHandler;
736 - (void)startOverRequest:(ResponseHandler)completionHandler;
737 - (void)stopRequest:(ResponseHandler)completionHandler;
739 - (void)readAttributeCurrentState:(ResponseHandler)completionHandler;
740 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
748 @interface CHIPOnOff : CHIPCluster
750 - (void)off:(ResponseHandler)completionHandler;
751 - (void)on:(ResponseHandler)completionHandler;
752 - (void)toggle:(ResponseHandler)completionHandler;
754 - (void)readAttributeOnOff:(ResponseHandler)completionHandler;
755 - (void)configureAttributeOnOff:(uint16_t)minInterval
756 maxInterval:(uint16_t)maxInterval
757 completionHandler:(ResponseHandler)completionHandler;
758 - (void)reportAttributeOnOff:(ResponseHandler)reportHandler;
759 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
767 @interface CHIPScenes : CHIPCluster
769 - (void)addScene:(uint16_t)groupId
770 sceneId:(uint8_t)sceneId
771 transitionTime:(uint16_t)transitionTime
772 sceneName:(NSString *)sceneName
773 clusterId:(uint16_t)clusterId
774 length:(uint8_t)length
776 completionHandler:(ResponseHandler)completionHandler;
777 - (void)getSceneMembership:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
778 - (void)recallScene:(uint16_t)groupId
779 sceneId:(uint8_t)sceneId
780 transitionTime:(uint16_t)transitionTime
781 completionHandler:(ResponseHandler)completionHandler;
782 - (void)removeAllScenes:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
783 - (void)removeScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
784 - (void)storeScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
785 - (void)viewScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
787 - (void)readAttributeSceneCount:(ResponseHandler)completionHandler;
788 - (void)readAttributeCurrentScene:(ResponseHandler)completionHandler;
789 - (void)readAttributeCurrentGroup:(ResponseHandler)completionHandler;
790 - (void)readAttributeSceneValid:(ResponseHandler)completionHandler;
791 - (void)readAttributeNameSupport:(ResponseHandler)completionHandler;
792 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
797 * Cluster Temperature Measurement
800 @interface CHIPTemperatureMeasurement : CHIPCluster
802 - (void)readAttributeMeasuredValue:(ResponseHandler)completionHandler;
803 - (void)configureAttributeMeasuredValue:(uint16_t)minInterval
804 maxInterval:(uint16_t)maxInterval
805 change:(int16_t)change
806 completionHandler:(ResponseHandler)completionHandler;
807 - (void)reportAttributeMeasuredValue:(ResponseHandler)reportHandler;
808 - (void)readAttributeMinMeasuredValue:(ResponseHandler)completionHandler;
809 - (void)readAttributeMaxMeasuredValue:(ResponseHandler)completionHandler;
810 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
814 NS_ASSUME_NONNULL_END
816 #endif /* CHIP_CLUSTERS_H */