Apply Upstream code (2021-03-15)
[platform/upstream/connectedhomeip.git] / src / darwin / Framework / CHIP / gen / CHIPClustersObjc.h
1 /*
2  *
3  *    Copyright (c) 2021 Project CHIP Authors
4  *
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
8  *
9  *        http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 // THIS FILE IS GENERATED BY ZAP
19
20 #ifndef CHIP_CLUSTERS_H
21 #define CHIP_CLUSTERS_H
22
23 #import <Foundation/Foundation.h>
24
25 @class CHIPDevice;
26
27 typedef void (^ResponseHandler)(NSError * _Nullable error, NSDictionary * _Nullable values);
28
29 NS_ASSUME_NONNULL_BEGIN
30
31 /**
32  * CHIPCluster
33  *    This is the base class for clusters.
34  */
35 @interface CHIPCluster : NSObject
36
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;
42
43 @end
44
45 /**
46  * Cluster Application Basic
47  *
48  */
49 @interface CHIPApplicationBasic : CHIPCluster
50
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;
59
60 @end
61
62 /**
63  * Cluster Barrier Control
64  *
65  */
66 @interface CHIPBarrierControl : CHIPCluster
67
68 - (void)barrierControlGoToPercent:(uint8_t)percentOpen completionHandler:(ResponseHandler)completionHandler;
69 - (void)barrierControlStop:(ResponseHandler)completionHandler;
70
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;
76
77 @end
78
79 /**
80  * Cluster Basic
81  *
82  */
83 @interface CHIPBasic : CHIPCluster
84
85 - (void)mfgSpecificPing:(ResponseHandler)completionHandler;
86
87 - (void)readAttributeInteractionModelVersion:(ResponseHandler)completionHandler;
88 - (void)readAttributeVendorName:(ResponseHandler)completionHandler;
89 - (void)readAttributeVendorID:(ResponseHandler)completionHandler;
90 - (void)readAttributeProductName:(ResponseHandler)completionHandler;
91 - (void)readAttributeProductID:(ResponseHandler)completionHandler;
92 - (void)readAttributeUserLabel:(ResponseHandler)completionHandler;
93 - (void)writeAttributeUserLabel:(NSString *)value completionHandler:(ResponseHandler)completionHandler;
94 - (void)readAttributeLocation:(ResponseHandler)completionHandler;
95 - (void)writeAttributeLocation:(NSString *)value completionHandler:(ResponseHandler)completionHandler;
96 - (void)readAttributeHardwareVersion:(ResponseHandler)completionHandler;
97 - (void)readAttributeHardwareVersionString:(ResponseHandler)completionHandler;
98 - (void)readAttributeSoftwareVersion:(ResponseHandler)completionHandler;
99 - (void)readAttributeSoftwareVersionString:(ResponseHandler)completionHandler;
100 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
101
102 @end
103
104 /**
105  * Cluster Binding
106  *
107  */
108 @interface CHIPBinding : CHIPCluster
109
110 - (void)bind:(uint64_t)nodeId
111               groupId:(uint16_t)groupId
112            endpointId:(uint8_t)endpointId
113             clusterId:(uint16_t)clusterId
114     completionHandler:(ResponseHandler)completionHandler;
115 - (void)unbind:(uint64_t)nodeId
116               groupId:(uint16_t)groupId
117            endpointId:(uint8_t)endpointId
118             clusterId:(uint16_t)clusterId
119     completionHandler:(ResponseHandler)completionHandler;
120
121 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
122
123 @end
124
125 /**
126  * Cluster Color Control
127  *
128  */
129 @interface CHIPColorControl : CHIPCluster
130
131 - (void)moveColor:(int16_t)rateX
132                 rateY:(int16_t)rateY
133           optionsMask:(uint8_t)optionsMask
134       optionsOverride:(uint8_t)optionsOverride
135     completionHandler:(ResponseHandler)completionHandler;
136 - (void)moveColorTemperature:(uint8_t)moveMode
137                         rate:(uint16_t)rate
138      colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
139      colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
140                  optionsMask:(uint8_t)optionsMask
141              optionsOverride:(uint8_t)optionsOverride
142            completionHandler:(ResponseHandler)completionHandler;
143 - (void)moveHue:(uint8_t)moveMode
144                  rate:(uint8_t)rate
145           optionsMask:(uint8_t)optionsMask
146       optionsOverride:(uint8_t)optionsOverride
147     completionHandler:(ResponseHandler)completionHandler;
148 - (void)moveSaturation:(uint8_t)moveMode
149                   rate:(uint8_t)rate
150            optionsMask:(uint8_t)optionsMask
151        optionsOverride:(uint8_t)optionsOverride
152      completionHandler:(ResponseHandler)completionHandler;
153 - (void)moveToColor:(uint16_t)colorX
154                colorY:(uint16_t)colorY
155        transitionTime:(uint16_t)transitionTime
156           optionsMask:(uint8_t)optionsMask
157       optionsOverride:(uint8_t)optionsOverride
158     completionHandler:(ResponseHandler)completionHandler;
159 - (void)moveToColorTemperature:(uint16_t)colorTemperature
160                 transitionTime:(uint16_t)transitionTime
161                    optionsMask:(uint8_t)optionsMask
162                optionsOverride:(uint8_t)optionsOverride
163              completionHandler:(ResponseHandler)completionHandler;
164 - (void)moveToHue:(uint8_t)hue
165             direction:(uint8_t)direction
166        transitionTime:(uint16_t)transitionTime
167           optionsMask:(uint8_t)optionsMask
168       optionsOverride:(uint8_t)optionsOverride
169     completionHandler:(ResponseHandler)completionHandler;
170 - (void)moveToHueAndSaturation:(uint8_t)hue
171                     saturation:(uint8_t)saturation
172                 transitionTime:(uint16_t)transitionTime
173                    optionsMask:(uint8_t)optionsMask
174                optionsOverride:(uint8_t)optionsOverride
175              completionHandler:(ResponseHandler)completionHandler;
176 - (void)moveToSaturation:(uint8_t)saturation
177           transitionTime:(uint16_t)transitionTime
178              optionsMask:(uint8_t)optionsMask
179          optionsOverride:(uint8_t)optionsOverride
180        completionHandler:(ResponseHandler)completionHandler;
181 - (void)stepColor:(int16_t)stepX
182                 stepY:(int16_t)stepY
183        transitionTime:(uint16_t)transitionTime
184           optionsMask:(uint8_t)optionsMask
185       optionsOverride:(uint8_t)optionsOverride
186     completionHandler:(ResponseHandler)completionHandler;
187 - (void)stepColorTemperature:(uint8_t)stepMode
188                     stepSize:(uint16_t)stepSize
189               transitionTime:(uint16_t)transitionTime
190      colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
191      colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
192                  optionsMask:(uint8_t)optionsMask
193              optionsOverride:(uint8_t)optionsOverride
194            completionHandler:(ResponseHandler)completionHandler;
195 - (void)stepHue:(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)stepSaturation:(uint8_t)stepMode
202               stepSize:(uint8_t)stepSize
203         transitionTime:(uint8_t)transitionTime
204            optionsMask:(uint8_t)optionsMask
205        optionsOverride:(uint8_t)optionsOverride
206      completionHandler:(ResponseHandler)completionHandler;
207 - (void)stopMoveStep:(uint8_t)optionsMask
208       optionsOverride:(uint8_t)optionsOverride
209     completionHandler:(ResponseHandler)completionHandler;
210
211 - (void)readAttributeCurrentHue:(ResponseHandler)completionHandler;
212 - (void)configureAttributeCurrentHue:(uint16_t)minInterval
213                          maxInterval:(uint16_t)maxInterval
214                               change:(uint8_t)change
215                    completionHandler:(ResponseHandler)completionHandler;
216 - (void)reportAttributeCurrentHue:(ResponseHandler)reportHandler;
217 - (void)readAttributeCurrentSaturation:(ResponseHandler)completionHandler;
218 - (void)configureAttributeCurrentSaturation:(uint16_t)minInterval
219                                 maxInterval:(uint16_t)maxInterval
220                                      change:(uint8_t)change
221                           completionHandler:(ResponseHandler)completionHandler;
222 - (void)reportAttributeCurrentSaturation:(ResponseHandler)reportHandler;
223 - (void)readAttributeRemainingTime:(ResponseHandler)completionHandler;
224 - (void)readAttributeCurrentX:(ResponseHandler)completionHandler;
225 - (void)configureAttributeCurrentX:(uint16_t)minInterval
226                        maxInterval:(uint16_t)maxInterval
227                             change:(uint16_t)change
228                  completionHandler:(ResponseHandler)completionHandler;
229 - (void)reportAttributeCurrentX:(ResponseHandler)reportHandler;
230 - (void)readAttributeCurrentY:(ResponseHandler)completionHandler;
231 - (void)configureAttributeCurrentY:(uint16_t)minInterval
232                        maxInterval:(uint16_t)maxInterval
233                             change:(uint16_t)change
234                  completionHandler:(ResponseHandler)completionHandler;
235 - (void)reportAttributeCurrentY:(ResponseHandler)reportHandler;
236 - (void)readAttributeDriftCompensation:(ResponseHandler)completionHandler;
237 - (void)readAttributeCompensationText:(ResponseHandler)completionHandler;
238 - (void)readAttributeColorTemperature:(ResponseHandler)completionHandler;
239 - (void)configureAttributeColorTemperature:(uint16_t)minInterval
240                                maxInterval:(uint16_t)maxInterval
241                                     change:(uint16_t)change
242                          completionHandler:(ResponseHandler)completionHandler;
243 - (void)reportAttributeColorTemperature:(ResponseHandler)reportHandler;
244 - (void)readAttributeColorMode:(ResponseHandler)completionHandler;
245 - (void)readAttributeColorControlOptions:(ResponseHandler)completionHandler;
246 - (void)writeAttributeColorControlOptions:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
247 - (void)readAttributeNumberOfPrimaries:(ResponseHandler)completionHandler;
248 - (void)readAttributePrimary1X:(ResponseHandler)completionHandler;
249 - (void)readAttributePrimary1Y:(ResponseHandler)completionHandler;
250 - (void)readAttributePrimary1Intensity:(ResponseHandler)completionHandler;
251 - (void)readAttributePrimary2X:(ResponseHandler)completionHandler;
252 - (void)readAttributePrimary2Y:(ResponseHandler)completionHandler;
253 - (void)readAttributePrimary2Intensity:(ResponseHandler)completionHandler;
254 - (void)readAttributePrimary3X:(ResponseHandler)completionHandler;
255 - (void)readAttributePrimary3Y:(ResponseHandler)completionHandler;
256 - (void)readAttributePrimary3Intensity:(ResponseHandler)completionHandler;
257 - (void)readAttributePrimary4X:(ResponseHandler)completionHandler;
258 - (void)readAttributePrimary4Y:(ResponseHandler)completionHandler;
259 - (void)readAttributePrimary4Intensity:(ResponseHandler)completionHandler;
260 - (void)readAttributePrimary5X:(ResponseHandler)completionHandler;
261 - (void)readAttributePrimary5Y:(ResponseHandler)completionHandler;
262 - (void)readAttributePrimary5Intensity:(ResponseHandler)completionHandler;
263 - (void)readAttributePrimary6X:(ResponseHandler)completionHandler;
264 - (void)readAttributePrimary6Y:(ResponseHandler)completionHandler;
265 - (void)readAttributePrimary6Intensity:(ResponseHandler)completionHandler;
266 - (void)readAttributeWhitePointX:(ResponseHandler)completionHandler;
267 - (void)writeAttributeWhitePointX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
268 - (void)readAttributeWhitePointY:(ResponseHandler)completionHandler;
269 - (void)writeAttributeWhitePointY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
270 - (void)readAttributeColorPointRX:(ResponseHandler)completionHandler;
271 - (void)writeAttributeColorPointRX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
272 - (void)readAttributeColorPointRY:(ResponseHandler)completionHandler;
273 - (void)writeAttributeColorPointRY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
274 - (void)readAttributeColorPointRIntensity:(ResponseHandler)completionHandler;
275 - (void)writeAttributeColorPointRIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
276 - (void)readAttributeColorPointGX:(ResponseHandler)completionHandler;
277 - (void)writeAttributeColorPointGX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
278 - (void)readAttributeColorPointGY:(ResponseHandler)completionHandler;
279 - (void)writeAttributeColorPointGY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
280 - (void)readAttributeColorPointGIntensity:(ResponseHandler)completionHandler;
281 - (void)writeAttributeColorPointGIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
282 - (void)readAttributeColorPointBX:(ResponseHandler)completionHandler;
283 - (void)writeAttributeColorPointBX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
284 - (void)readAttributeColorPointBY:(ResponseHandler)completionHandler;
285 - (void)writeAttributeColorPointBY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
286 - (void)readAttributeColorPointBIntensity:(ResponseHandler)completionHandler;
287 - (void)writeAttributeColorPointBIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
288 - (void)readAttributeEnhancedCurrentHue:(ResponseHandler)completionHandler;
289 - (void)readAttributeEnhancedColorMode:(ResponseHandler)completionHandler;
290 - (void)readAttributeColorLoopActive:(ResponseHandler)completionHandler;
291 - (void)readAttributeColorLoopDirection:(ResponseHandler)completionHandler;
292 - (void)readAttributeColorLoopTime:(ResponseHandler)completionHandler;
293 - (void)readAttributeColorCapabilities:(ResponseHandler)completionHandler;
294 - (void)readAttributeColorTempPhysicalMin:(ResponseHandler)completionHandler;
295 - (void)readAttributeColorTempPhysicalMax:(ResponseHandler)completionHandler;
296 - (void)readAttributeCoupleColorTempToLevelMinMireds:(ResponseHandler)completionHandler;
297 - (void)readAttributeStartUpColorTemperatureMireds:(ResponseHandler)completionHandler;
298 - (void)writeAttributeStartUpColorTemperatureMireds:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
299 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
300
301 @end
302
303 /**
304  * Cluster Content Launch
305  *
306  */
307 @interface CHIPContentLaunch : CHIPCluster
308
309 - (void)launchContent:(ResponseHandler)completionHandler;
310 - (void)launchURL:(ResponseHandler)completionHandler;
311
312 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
313
314 @end
315
316 /**
317  * Cluster Door Lock
318  *
319  */
320 @interface CHIPDoorLock : CHIPCluster
321
322 - (void)clearAllPins:(ResponseHandler)completionHandler;
323 - (void)clearAllRfids:(ResponseHandler)completionHandler;
324 - (void)clearHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
325 - (void)clearPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
326 - (void)clearRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
327 - (void)clearWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
328 - (void)clearYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
329 - (void)getHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
330 - (void)getLogRecord:(uint16_t)logIndex completionHandler:(ResponseHandler)completionHandler;
331 - (void)getPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
332 - (void)getRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
333 - (void)getUserType:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
334 - (void)getWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
335 - (void)getYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
336 - (void)lockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
337 - (void)setHolidaySchedule:(uint8_t)scheduleId
338                 localStartTime:(uint32_t)localStartTime
339                   localEndTime:(uint32_t)localEndTime
340     operatingModeDuringHoliday:(uint8_t)operatingModeDuringHoliday
341              completionHandler:(ResponseHandler)completionHandler;
342 - (void)setPin:(uint16_t)userId
343            userStatus:(uint8_t)userStatus
344              userType:(uint8_t)userType
345                   pin:(NSString *)pin
346     completionHandler:(ResponseHandler)completionHandler;
347 - (void)setRfid:(uint16_t)userId
348            userStatus:(uint8_t)userStatus
349              userType:(uint8_t)userType
350                    id:(NSString *)id
351     completionHandler:(ResponseHandler)completionHandler;
352 - (void)setUserType:(uint16_t)userId userType:(uint8_t)userType completionHandler:(ResponseHandler)completionHandler;
353 - (void)setWeekdaySchedule:(uint8_t)scheduleId
354                     userId:(uint16_t)userId
355                   daysMask:(uint8_t)daysMask
356                  startHour:(uint8_t)startHour
357                startMinute:(uint8_t)startMinute
358                    endHour:(uint8_t)endHour
359                  endMinute:(uint8_t)endMinute
360          completionHandler:(ResponseHandler)completionHandler;
361 - (void)setYeardaySchedule:(uint8_t)scheduleId
362                     userId:(uint16_t)userId
363             localStartTime:(uint32_t)localStartTime
364               localEndTime:(uint32_t)localEndTime
365          completionHandler:(ResponseHandler)completionHandler;
366 - (void)unlockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
367 - (void)unlockWithTimeout:(uint16_t)timeoutInSeconds pin:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
368
369 - (void)readAttributeLockState:(ResponseHandler)completionHandler;
370 - (void)configureAttributeLockState:(uint16_t)minInterval
371                         maxInterval:(uint16_t)maxInterval
372                   completionHandler:(ResponseHandler)completionHandler;
373 - (void)reportAttributeLockState:(ResponseHandler)reportHandler;
374 - (void)readAttributeLockType:(ResponseHandler)completionHandler;
375 - (void)readAttributeActuatorEnabled:(ResponseHandler)completionHandler;
376 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
377
378 @end
379
380 /**
381  * Cluster General Commissioning
382  *
383  */
384 @interface CHIPGeneralCommissioning : CHIPCluster
385
386 - (void)armFailSafe:(uint16_t)expiryLengthSeconds
387            breadcrumb:(uint64_t)breadcrumb
388             timeoutMs:(uint32_t)timeoutMs
389     completionHandler:(ResponseHandler)completionHandler;
390 - (void)commissioningComplete:(ResponseHandler)completionHandler;
391 - (void)setFabric:(NSData *)fabricId
392          fabricSecret:(NSData *)fabricSecret
393            breadcrumb:(uint64_t)breadcrumb
394             timeoutMs:(uint32_t)timeoutMs
395     completionHandler:(ResponseHandler)completionHandler;
396
397 - (void)readAttributeFabricId:(ResponseHandler)completionHandler;
398 - (void)readAttributeBreadcrumb:(ResponseHandler)completionHandler;
399 - (void)writeAttributeBreadcrumb:(uint64_t)value completionHandler:(ResponseHandler)completionHandler;
400 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
401
402 @end
403
404 /**
405  * Cluster Groups
406  *
407  */
408 @interface CHIPGroups : CHIPCluster
409
410 - (void)addGroup:(uint16_t)groupId groupName:(NSString *)groupName completionHandler:(ResponseHandler)completionHandler;
411 - (void)addGroupIfIdentifying:(uint16_t)groupId
412                     groupName:(NSString *)groupName
413             completionHandler:(ResponseHandler)completionHandler;
414 - (void)getGroupMembership:(uint8_t)groupCount groupList:(uint16_t)groupList completionHandler:(ResponseHandler)completionHandler;
415 - (void)removeAllGroups:(ResponseHandler)completionHandler;
416 - (void)removeGroup:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
417 - (void)viewGroup:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
418
419 - (void)readAttributeNameSupport:(ResponseHandler)completionHandler;
420 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
421
422 @end
423
424 /**
425  * Cluster Identify
426  *
427  */
428 @interface CHIPIdentify : CHIPCluster
429
430 - (void)identify:(uint16_t)identifyTime completionHandler:(ResponseHandler)completionHandler;
431 - (void)identifyQuery:(ResponseHandler)completionHandler;
432
433 - (void)readAttributeIdentifyTime:(ResponseHandler)completionHandler;
434 - (void)writeAttributeIdentifyTime:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
435 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
436
437 @end
438
439 /**
440  * Cluster Level Control
441  *
442  */
443 @interface CHIPLevelControl : CHIPCluster
444
445 - (void)move:(uint8_t)moveMode
446                  rate:(uint8_t)rate
447            optionMask:(uint8_t)optionMask
448        optionOverride:(uint8_t)optionOverride
449     completionHandler:(ResponseHandler)completionHandler;
450 - (void)moveToLevel:(uint8_t)level
451        transitionTime:(uint16_t)transitionTime
452            optionMask:(uint8_t)optionMask
453        optionOverride:(uint8_t)optionOverride
454     completionHandler:(ResponseHandler)completionHandler;
455 - (void)moveToLevelWithOnOff:(uint8_t)level
456               transitionTime:(uint16_t)transitionTime
457            completionHandler:(ResponseHandler)completionHandler;
458 - (void)moveWithOnOff:(uint8_t)moveMode rate:(uint8_t)rate completionHandler:(ResponseHandler)completionHandler;
459 - (void)step:(uint8_t)stepMode
460              stepSize:(uint8_t)stepSize
461        transitionTime:(uint16_t)transitionTime
462            optionMask:(uint8_t)optionMask
463        optionOverride:(uint8_t)optionOverride
464     completionHandler:(ResponseHandler)completionHandler;
465 - (void)stepWithOnOff:(uint8_t)stepMode
466              stepSize:(uint8_t)stepSize
467        transitionTime:(uint16_t)transitionTime
468     completionHandler:(ResponseHandler)completionHandler;
469 - (void)stop:(uint8_t)optionMask optionOverride:(uint8_t)optionOverride completionHandler:(ResponseHandler)completionHandler;
470 - (void)stopWithOnOff:(ResponseHandler)completionHandler;
471
472 - (void)readAttributeCurrentLevel:(ResponseHandler)completionHandler;
473 - (void)configureAttributeCurrentLevel:(uint16_t)minInterval
474                            maxInterval:(uint16_t)maxInterval
475                                 change:(uint8_t)change
476                      completionHandler:(ResponseHandler)completionHandler;
477 - (void)reportAttributeCurrentLevel:(ResponseHandler)reportHandler;
478 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
479
480 @end
481
482 /**
483  * Cluster Low Power
484  *
485  */
486 @interface CHIPLowPower : CHIPCluster
487
488 - (void)sleep:(ResponseHandler)completionHandler;
489
490 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
491
492 @end
493
494 /**
495  * Cluster Media Playback
496  *
497  */
498 @interface CHIPMediaPlayback : CHIPCluster
499
500 - (void)fastForwardRequest:(ResponseHandler)completionHandler;
501 - (void)nextRequest:(ResponseHandler)completionHandler;
502 - (void)pauseRequest:(ResponseHandler)completionHandler;
503 - (void)playRequest:(ResponseHandler)completionHandler;
504 - (void)previousRequest:(ResponseHandler)completionHandler;
505 - (void)rewindRequest:(ResponseHandler)completionHandler;
506 - (void)skipBackwardRequest:(ResponseHandler)completionHandler;
507 - (void)skipForwardRequest:(ResponseHandler)completionHandler;
508 - (void)startOverRequest:(ResponseHandler)completionHandler;
509 - (void)stopRequest:(ResponseHandler)completionHandler;
510
511 - (void)readAttributeCurrentState:(ResponseHandler)completionHandler;
512 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
513
514 @end
515
516 /**
517  * Cluster On/off
518  *
519  */
520 @interface CHIPOnOff : CHIPCluster
521
522 - (void)off:(ResponseHandler)completionHandler;
523 - (void)on:(ResponseHandler)completionHandler;
524 - (void)toggle:(ResponseHandler)completionHandler;
525
526 - (void)readAttributeOnOff:(ResponseHandler)completionHandler;
527 - (void)configureAttributeOnOff:(uint16_t)minInterval
528                     maxInterval:(uint16_t)maxInterval
529               completionHandler:(ResponseHandler)completionHandler;
530 - (void)reportAttributeOnOff:(ResponseHandler)reportHandler;
531 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
532
533 @end
534
535 /**
536  * Cluster Scenes
537  *
538  */
539 @interface CHIPScenes : CHIPCluster
540
541 - (void)addScene:(uint16_t)groupId
542               sceneId:(uint8_t)sceneId
543        transitionTime:(uint16_t)transitionTime
544             sceneName:(NSString *)sceneName
545             clusterId:(uint16_t)clusterId
546                length:(uint8_t)length
547                 value:(uint8_t)value
548     completionHandler:(ResponseHandler)completionHandler;
549 - (void)getSceneMembership:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
550 - (void)recallScene:(uint16_t)groupId
551               sceneId:(uint8_t)sceneId
552        transitionTime:(uint16_t)transitionTime
553     completionHandler:(ResponseHandler)completionHandler;
554 - (void)removeAllScenes:(uint16_t)groupId completionHandler:(ResponseHandler)completionHandler;
555 - (void)removeScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
556 - (void)storeScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
557 - (void)viewScene:(uint16_t)groupId sceneId:(uint8_t)sceneId completionHandler:(ResponseHandler)completionHandler;
558
559 - (void)readAttributeSceneCount:(ResponseHandler)completionHandler;
560 - (void)readAttributeCurrentScene:(ResponseHandler)completionHandler;
561 - (void)readAttributeCurrentGroup:(ResponseHandler)completionHandler;
562 - (void)readAttributeSceneValid:(ResponseHandler)completionHandler;
563 - (void)readAttributeNameSupport:(ResponseHandler)completionHandler;
564 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
565
566 @end
567
568 /**
569  * Cluster Temperature Measurement
570  *
571  */
572 @interface CHIPTemperatureMeasurement : CHIPCluster
573
574 - (void)readAttributeMeasuredValue:(ResponseHandler)completionHandler;
575 - (void)configureAttributeMeasuredValue:(uint16_t)minInterval
576                             maxInterval:(uint16_t)maxInterval
577                                  change:(int16_t)change
578                       completionHandler:(ResponseHandler)completionHandler;
579 - (void)reportAttributeMeasuredValue:(ResponseHandler)reportHandler;
580 - (void)readAttributeMinMeasuredValue:(ResponseHandler)completionHandler;
581 - (void)readAttributeMaxMeasuredValue:(ResponseHandler)completionHandler;
582 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
583
584 @end
585
586 NS_ASSUME_NONNULL_END
587
588 #endif /* CHIP_CLUSTERS_H */