examples/tv-app/tv-common/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 Barrier Control
  47  *
  48  */
  49 @interface CHIPBarrierControl : CHIPCluster
  50
  51 - (void)barrierControlGoToPercent:(uint8_t)percentOpen completionHandler:(ResponseHandler)completionHandler;
  52 - (void)barrierControlStop:(ResponseHandler)completionHandler;
  53
  54 - (void)readAttributeBarrierMovingState:(ResponseHandler)completionHandler;
  55 - (void)readAttributeBarrierSafetyStatus:(ResponseHandler)completionHandler;
  56 - (void)readAttributeBarrierCapabilities:(ResponseHandler)completionHandler;
  57 - (void)readAttributeBarrierPosition:(ResponseHandler)completionHandler;
  58 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
  59
  60 @end
  61
  62 /**
  63  * Cluster Color Control
  64  *
  65  */
  66 @interface CHIPColorControl : CHIPCluster
  67
  68 - (void)moveColor:(int16_t)rateX
  69                 rateY:(int16_t)rateY
  70           optionsMask:(uint8_t)optionsMask
  71       optionsOverride:(uint8_t)optionsOverride
  72     completionHandler:(ResponseHandler)completionHandler;
  73 - (void)moveColorTemperature:(uint8_t)moveMode
  74                         rate:(uint16_t)rate
  75      colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
  76      colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
  77                  optionsMask:(uint8_t)optionsMask
  78              optionsOverride:(uint8_t)optionsOverride
  79            completionHandler:(ResponseHandler)completionHandler;
  80 - (void)moveHue:(uint8_t)moveMode
  81                  rate:(uint8_t)rate
  82           optionsMask:(uint8_t)optionsMask
  83       optionsOverride:(uint8_t)optionsOverride
  84     completionHandler:(ResponseHandler)completionHandler;
  85 - (void)moveSaturation:(uint8_t)moveMode
  86                   rate:(uint8_t)rate
  87            optionsMask:(uint8_t)optionsMask
  88        optionsOverride:(uint8_t)optionsOverride
  89      completionHandler:(ResponseHandler)completionHandler;
  90 - (void)moveToColor:(uint16_t)colorX
  91                colorY:(uint16_t)colorY
  92        transitionTime:(uint16_t)transitionTime
  93           optionsMask:(uint8_t)optionsMask
  94       optionsOverride:(uint8_t)optionsOverride
  95     completionHandler:(ResponseHandler)completionHandler;
  96 - (void)moveToColorTemperature:(uint16_t)colorTemperature
  97                 transitionTime:(uint16_t)transitionTime
  98                    optionsMask:(uint8_t)optionsMask
  99                optionsOverride:(uint8_t)optionsOverride
 100              completionHandler:(ResponseHandler)completionHandler;
 101 - (void)moveToHue:(uint8_t)hue
 102             direction:(uint8_t)direction
 103        transitionTime:(uint16_t)transitionTime
 104           optionsMask:(uint8_t)optionsMask
 105       optionsOverride:(uint8_t)optionsOverride
 106     completionHandler:(ResponseHandler)completionHandler;
 107 - (void)moveToHueAndSaturation:(uint8_t)hue
 108                     saturation:(uint8_t)saturation
 109                 transitionTime:(uint16_t)transitionTime
 110                    optionsMask:(uint8_t)optionsMask
 111                optionsOverride:(uint8_t)optionsOverride
 112              completionHandler:(ResponseHandler)completionHandler;
 113 - (void)moveToSaturation:(uint8_t)saturation
 114           transitionTime:(uint16_t)transitionTime
 115              optionsMask:(uint8_t)optionsMask
 116          optionsOverride:(uint8_t)optionsOverride
 117        completionHandler:(ResponseHandler)completionHandler;
 118 - (void)stepColor:(int16_t)stepX
 119                 stepY:(int16_t)stepY
 120        transitionTime:(uint16_t)transitionTime
 121           optionsMask:(uint8_t)optionsMask
 122       optionsOverride:(uint8_t)optionsOverride
 123     completionHandler:(ResponseHandler)completionHandler;
 124 - (void)stepColorTemperature:(uint8_t)stepMode
 125                     stepSize:(uint16_t)stepSize
 126               transitionTime:(uint16_t)transitionTime
 127      colorTemperatureMinimum:(uint16_t)colorTemperatureMinimum
 128      colorTemperatureMaximum:(uint16_t)colorTemperatureMaximum
 129                  optionsMask:(uint8_t)optionsMask
 130              optionsOverride:(uint8_t)optionsOverride
 131            completionHandler:(ResponseHandler)completionHandler;
 132 - (void)stepHue:(uint8_t)stepMode
 133              stepSize:(uint8_t)stepSize
 134        transitionTime:(uint8_t)transitionTime
 135           optionsMask:(uint8_t)optionsMask
 136       optionsOverride:(uint8_t)optionsOverride
 137     completionHandler:(ResponseHandler)completionHandler;
 138 - (void)stepSaturation:(uint8_t)stepMode
 139               stepSize:(uint8_t)stepSize
 140         transitionTime:(uint8_t)transitionTime
 141            optionsMask:(uint8_t)optionsMask
 142        optionsOverride:(uint8_t)optionsOverride
 143      completionHandler:(ResponseHandler)completionHandler;
 144 - (void)stopMoveStep:(uint8_t)optionsMask
 145       optionsOverride:(uint8_t)optionsOverride
 146     completionHandler:(ResponseHandler)completionHandler;
 147
 148 - (void)readAttributeCurrentHue:(ResponseHandler)completionHandler;
 149 - (void)configureAttributeCurrentHue:(uint16_t)minInterval
 150                          maxInterval:(uint16_t)maxInterval
 151                               change:(uint8_t)change
 152                    completionHandler:(ResponseHandler)completionHandler;
 153 - (void)reportAttributeCurrentHue:(ResponseHandler)reportHandler;
 154 - (void)readAttributeCurrentSaturation:(ResponseHandler)completionHandler;
 155 - (void)configureAttributeCurrentSaturation:(uint16_t)minInterval
 156                                 maxInterval:(uint16_t)maxInterval
 157                                      change:(uint8_t)change
 158                           completionHandler:(ResponseHandler)completionHandler;
 159 - (void)reportAttributeCurrentSaturation:(ResponseHandler)reportHandler;
 160 - (void)readAttributeRemainingTime:(ResponseHandler)completionHandler;
 161 - (void)readAttributeCurrentX:(ResponseHandler)completionHandler;
 162 - (void)configureAttributeCurrentX:(uint16_t)minInterval
 163                        maxInterval:(uint16_t)maxInterval
 164                             change:(uint16_t)change
 165                  completionHandler:(ResponseHandler)completionHandler;
 166 - (void)reportAttributeCurrentX:(ResponseHandler)reportHandler;
 167 - (void)readAttributeCurrentY:(ResponseHandler)completionHandler;
 168 - (void)configureAttributeCurrentY:(uint16_t)minInterval
 169                        maxInterval:(uint16_t)maxInterval
 170                             change:(uint16_t)change
 171                  completionHandler:(ResponseHandler)completionHandler;
 172 - (void)reportAttributeCurrentY:(ResponseHandler)reportHandler;
 173 - (void)readAttributeDriftCompensation:(ResponseHandler)completionHandler;
 174 - (void)readAttributeCompensationText:(ResponseHandler)completionHandler;
 175 - (void)readAttributeColorTemperature:(ResponseHandler)completionHandler;
 176 - (void)configureAttributeColorTemperature:(uint16_t)minInterval
 177                                maxInterval:(uint16_t)maxInterval
 178                                     change:(uint16_t)change
 179                          completionHandler:(ResponseHandler)completionHandler;
 180 - (void)reportAttributeColorTemperature:(ResponseHandler)reportHandler;
 181 - (void)readAttributeColorMode:(ResponseHandler)completionHandler;
 182 - (void)readAttributeColorControlOptions:(ResponseHandler)completionHandler;
 183 - (void)writeAttributeColorControlOptions:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
 184 - (void)readAttributeNumberOfPrimaries:(ResponseHandler)completionHandler;
 185 - (void)readAttributePrimary1X:(ResponseHandler)completionHandler;
 186 - (void)readAttributePrimary1Y:(ResponseHandler)completionHandler;
 187 - (void)readAttributePrimary1Intensity:(ResponseHandler)completionHandler;
 188 - (void)readAttributePrimary2X:(ResponseHandler)completionHandler;
 189 - (void)readAttributePrimary2Y:(ResponseHandler)completionHandler;
 190 - (void)readAttributePrimary2Intensity:(ResponseHandler)completionHandler;
 191 - (void)readAttributePrimary3X:(ResponseHandler)completionHandler;
 192 - (void)readAttributePrimary3Y:(ResponseHandler)completionHandler;
 193 - (void)readAttributePrimary3Intensity:(ResponseHandler)completionHandler;
 194 - (void)readAttributePrimary4X:(ResponseHandler)completionHandler;
 195 - (void)readAttributePrimary4Y:(ResponseHandler)completionHandler;
 196 - (void)readAttributePrimary4Intensity:(ResponseHandler)completionHandler;
 197 - (void)readAttributePrimary5X:(ResponseHandler)completionHandler;
 198 - (void)readAttributePrimary5Y:(ResponseHandler)completionHandler;
 199 - (void)readAttributePrimary5Intensity:(ResponseHandler)completionHandler;
 200 - (void)readAttributePrimary6X:(ResponseHandler)completionHandler;
 201 - (void)readAttributePrimary6Y:(ResponseHandler)completionHandler;
 202 - (void)readAttributePrimary6Intensity:(ResponseHandler)completionHandler;
 203 - (void)readAttributeWhitePointX:(ResponseHandler)completionHandler;
 204 - (void)writeAttributeWhitePointX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 205 - (void)readAttributeWhitePointY:(ResponseHandler)completionHandler;
 206 - (void)writeAttributeWhitePointY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 207 - (void)readAttributeColorPointRX:(ResponseHandler)completionHandler;
 208 - (void)writeAttributeColorPointRX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 209 - (void)readAttributeColorPointRY:(ResponseHandler)completionHandler;
 210 - (void)writeAttributeColorPointRY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 211 - (void)readAttributeColorPointRIntensity:(ResponseHandler)completionHandler;
 212 - (void)writeAttributeColorPointRIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
 213 - (void)readAttributeColorPointGX:(ResponseHandler)completionHandler;
 214 - (void)writeAttributeColorPointGX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 215 - (void)readAttributeColorPointGY:(ResponseHandler)completionHandler;
 216 - (void)writeAttributeColorPointGY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 217 - (void)readAttributeColorPointGIntensity:(ResponseHandler)completionHandler;
 218 - (void)writeAttributeColorPointGIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
 219 - (void)readAttributeColorPointBX:(ResponseHandler)completionHandler;
 220 - (void)writeAttributeColorPointBX:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 221 - (void)readAttributeColorPointBY:(ResponseHandler)completionHandler;
 222 - (void)writeAttributeColorPointBY:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 223 - (void)readAttributeColorPointBIntensity:(ResponseHandler)completionHandler;
 224 - (void)writeAttributeColorPointBIntensity:(uint8_t)value completionHandler:(ResponseHandler)completionHandler;
 225 - (void)readAttributeEnhancedCurrentHue:(ResponseHandler)completionHandler;
 226 - (void)readAttributeEnhancedColorMode:(ResponseHandler)completionHandler;
 227 - (void)readAttributeColorLoopActive:(ResponseHandler)completionHandler;
 228 - (void)readAttributeColorLoopDirection:(ResponseHandler)completionHandler;
 229 - (void)readAttributeColorLoopTime:(ResponseHandler)completionHandler;
 230 - (void)readAttributeColorCapabilities:(ResponseHandler)completionHandler;
 231 - (void)readAttributeColorTempPhysicalMin:(ResponseHandler)completionHandler;
 232 - (void)readAttributeColorTempPhysicalMax:(ResponseHandler)completionHandler;
 233 - (void)readAttributeCoupleColorTempToLevelMinMireds:(ResponseHandler)completionHandler;
 234 - (void)readAttributeStartUpColorTemperatureMireds:(ResponseHandler)completionHandler;
 235 - (void)writeAttributeStartUpColorTemperatureMireds:(uint16_t)value completionHandler:(ResponseHandler)completionHandler;
 236 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
 237
 238 @end
 239
 240 /**
 241  * Cluster Door Lock
 242  *
 243  */
 244 @interface CHIPDoorLock : CHIPCluster
 245
 246 - (void)clearAllPins:(ResponseHandler)completionHandler;
 247 - (void)clearAllRfids:(ResponseHandler)completionHandler;
 248 - (void)clearHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
 249 - (void)clearPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 250 - (void)clearRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 251 - (void)clearWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 252 - (void)clearYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 253 - (void)getHolidaySchedule:(uint8_t)scheduleId completionHandler:(ResponseHandler)completionHandler;
 254 - (void)getLogRecord:(uint16_t)logIndex completionHandler:(ResponseHandler)completionHandler;
 255 - (void)getPin:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 256 - (void)getRfid:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 257 - (void)getUserType:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 258 - (void)getWeekdaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 259 - (void)getYeardaySchedule:(uint8_t)scheduleId userId:(uint16_t)userId completionHandler:(ResponseHandler)completionHandler;
 260 - (void)lockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
 261 - (void)setHolidaySchedule:(uint8_t)scheduleId
 262                 localStartTime:(uint32_t)localStartTime
 263                   localEndTime:(uint32_t)localEndTime
 264     operatingModeDuringHoliday:(uint8_t)operatingModeDuringHoliday
 265              completionHandler:(ResponseHandler)completionHandler;
 266 - (void)setPin:(uint16_t)userId
 267            userStatus:(uint8_t)userStatus
 268              userType:(uint8_t)userType
 269                   pin:(NSString *)pin
 270     completionHandler:(ResponseHandler)completionHandler;
 271 - (void)setRfid:(uint16_t)userId
 272            userStatus:(uint8_t)userStatus
 273              userType:(uint8_t)userType
 274                    id:(NSString *)id
 275     completionHandler:(ResponseHandler)completionHandler;
 276 - (void)setUserType:(uint16_t)userId userType:(uint8_t)userType completionHandler:(ResponseHandler)completionHandler;
 277 - (void)setWeekdaySchedule:(uint8_t)scheduleId
 278                     userId:(uint16_t)userId
 279                   daysMask:(uint8_t)daysMask
 280                  startHour:(uint8_t)startHour
 281                startMinute:(uint8_t)startMinute
 282                    endHour:(uint8_t)endHour
 283                  endMinute:(uint8_t)endMinute
 284          completionHandler:(ResponseHandler)completionHandler;
 285 - (void)setYeardaySchedule:(uint8_t)scheduleId
 286                     userId:(uint16_t)userId
 287             localStartTime:(uint32_t)localStartTime
 288               localEndTime:(uint32_t)localEndTime
 289          completionHandler:(ResponseHandler)completionHandler;
 290 - (void)unlockDoor:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
 291 - (void)unlockWithTimeout:(uint16_t)timeoutInSeconds pin:(NSString *)pin completionHandler:(ResponseHandler)completionHandler;
 292
 293 - (void)readAttributeLockState:(ResponseHandler)completionHandler;
 294 - (void)configureAttributeLockState:(uint16_t)minInterval
 295                         maxInterval:(uint16_t)maxInterval
 296                   completionHandler:(ResponseHandler)completionHandler;
 297 - (void)reportAttributeLockState:(ResponseHandler)reportHandler;
 298 - (void)readAttributeLockType:(ResponseHandler)completionHandler;
 299 - (void)readAttributeActuatorEnabled:(ResponseHandler)completionHandler;
 300 - (void)readAttributeClusterRevision:(ResponseHandler)completionHandler;
 301
 302 @end
 303
 304 NS_ASSUME_NONNULL_END
 305
 306 #endif /* CHIP_CLUSTERS_H */