Skip to content

Commit a6f0168

Browse files
Update Darwin availability annotations to account for new release. (project-chip#36304)
1 parent 6fd08a0 commit a6f0168

14 files changed

+180
-221
lines changed

src/darwin/Framework/CHIP/MTRBackwardsCompatShims.h

+7-14
Original file line numberDiff line numberDiff line change
@@ -168,27 +168,20 @@ typedef NS_ENUM(uint8_t, MTROTASoftwareUpdateRequestorOTAUpdateState) {
168168
* SaturationMoveMode and SaturationStepMode.
169169
*/
170170
typedef NS_ENUM(uint8_t, MTRColorControlSaturationMoveMode) {
171-
MTRColorControlSaturationMoveModeStop MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
172-
MTR_NEWLY_DEPRECATED("Please use MTRColorControlMoveModeStop")
171+
MTRColorControlSaturationMoveModeStop MTR_DEPRECATED("Please use MTRColorControlMoveModeStop", ios(16.1, 18.2), macos(13.0, 15.2), watchos(9.1, 11.2), tvos(16.1, 18.2))
173172
= 0x00,
174-
MTRColorControlSaturationMoveModeUp MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
175-
MTR_NEWLY_DEPRECATED("Please use MTRColorControlMoveModeUp")
173+
MTRColorControlSaturationMoveModeUp MTR_DEPRECATED("Please use MTRColorControlMoveModeUp", ios(16.1, 18.2), macos(13.0, 15.2), watchos(9.1, 11.2), tvos(16.1, 18.2))
176174
= 0x01,
177-
MTRColorControlSaturationMoveModeDown MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
178-
MTR_NEWLY_DEPRECATED("Please use MTRColorControlMoveModeDown")
175+
MTRColorControlSaturationMoveModeDown MTR_DEPRECATED("Please use MTRColorControlMoveModeDown", ios(16.1, 18.2), macos(13.0, 15.2), watchos(9.1, 11.2), tvos(16.1, 18.2))
179176
= 0x03,
180-
} MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
181-
MTR_NEWLY_DEPRECATED("Please use MTRColorControlMoveMode");
177+
} MTR_DEPRECATED("Please use MTRColorControlMoveMode", ios(16.1, 18.2), macos(13.0, 15.2), watchos(9.1, 11.2), tvos(16.1, 18.2));
182178

183179
typedef NS_ENUM(uint8_t, MTRColorControlSaturationStepMode) {
184-
MTRColorControlSaturationStepModeUp MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
185-
MTR_NEWLY_DEPRECATED("Please use MTRColorControlStepModeUp")
180+
MTRColorControlSaturationStepModeUp MTR_DEPRECATED("Please use MTRColorControlStepModeUp", ios(16.1, 18.2), macos(13.0, 15.2), watchos(9.1, 11.2), tvos(16.1, 18.2))
186181
= 0x01,
187-
MTRColorControlSaturationStepModeDown MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
188-
MTR_NEWLY_DEPRECATED("Please use MTRColorControlStepModeDown")
182+
MTRColorControlSaturationStepModeDown MTR_DEPRECATED("Please use MTRColorControlStepModeDown", ios(16.1, 18.2), macos(13.0, 15.2), watchos(9.1, 11.2), tvos(16.1, 18.2))
189183
= 0x03,
190-
} MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
191-
MTR_NEWLY_DEPRECATED("Please use MTRColorControlStepMode");
184+
} MTR_DEPRECATED("Please use MTRColorControlStepMode", ios(16.1, 18.2), macos(13.0, 15.2), watchos(9.1, 11.2), tvos(16.1, 18.2));
192185

193186
#pragma mark - Clusters that were removed wholesale: OnOffSwitchConfiguration
194187

src/darwin/Framework/CHIP/MTRCertificateInfo.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4))
6868
/**
6969
* Public key data for this certificate
7070
*/
71-
@property (nullable, readonly, retain) NSData * publicKeyData MTR_NEWLY_AVAILABLE;
71+
@property (nullable, readonly, retain) NSData * publicKeyData MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
7272

7373
@end
7474

src/darwin/Framework/CHIP/MTRClusterNames.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ MTR_EXTERN MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6)) NSSt
4949
* or '<Unknown commandID %d>' (if the cluster ID is known but the command ID is not known)
5050
* will be returned.
5151
*/
52-
MTR_EXTERN MTR_NEWLY_AVAILABLE NSString * MTRRequestCommandNameForID(MTRClusterIDType clusterID, MTRCommandIDType commandID);
52+
MTR_EXTERN MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2)) NSString * MTRRequestCommandNameForID(MTRClusterIDType clusterID, MTRCommandIDType commandID);
5353

5454
/**
5555
* Resolve Matter response (server to client) command IDs into a descriptive string.
@@ -58,7 +58,7 @@ MTR_EXTERN MTR_NEWLY_AVAILABLE NSString * MTRRequestCommandNameForID(MTRClusterI
5858
* or '<Unknown commandID %d>' (if the cluster ID is known but the command ID is not known)
5959
* will be returned.
6060
*/
61-
MTR_EXTERN MTR_NEWLY_AVAILABLE NSString * MTRResponseCommandNameForID(MTRClusterIDType clusterID, MTRCommandIDType commandID);
61+
MTR_EXTERN MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2)) NSString * MTRResponseCommandNameForID(MTRClusterIDType clusterID, MTRCommandIDType commandID);
6262

6363
/**
6464
* Resolve Matter event IDs into a descriptive string.
@@ -67,4 +67,4 @@ MTR_EXTERN MTR_NEWLY_AVAILABLE NSString * MTRResponseCommandNameForID(MTRCluster
6767
* or '<Unknown eventID %d>' (if the cluster ID is known but the event ID is not known)
6868
* will be returned.
6969
*/
70-
MTR_EXTERN MTR_NEWLY_AVAILABLE NSString * MTREventNameForID(MTRClusterIDType clusterID, MTREventIDType eventID);
70+
MTR_EXTERN MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2)) NSString * MTREventNameForID(MTRClusterIDType clusterID, MTREventIDType eventID);

src/darwin/Framework/CHIP/MTRDevice.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
212212
* documentation for MTRDeviceResponseHandler. Each one will have an
213213
* MTRAttributePathKey and an MTRDataKey.
214214
*/
215-
- (NSArray<NSDictionary<NSString *, id> *> *)readAttributePaths:(NSArray<MTRAttributeRequestPath *> *)attributePaths MTR_NEWLY_AVAILABLE;
215+
- (NSArray<NSDictionary<NSString *, id> *> *)readAttributePaths:(NSArray<MTRAttributeRequestPath *> *)attributePaths MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
216216

217217
/**
218218
* Invoke a command with a designated command path

src/darwin/Framework/CHIP/MTRDeviceController.h

+5-5
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
6868
/**
6969
* If true, the controller has been suspended via `suspend` and not resumed yet.
7070
*/
71-
@property (readonly, nonatomic, getter=isSuspended) BOOL suspended MTR_NEWLY_AVAILABLE;
71+
@property (readonly, nonatomic, getter=isSuspended) BOOL suspended MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
7272

7373
/**
7474
* The ID assigned to this controller at creation time.
@@ -210,14 +210,14 @@ MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
210210
* @param[in] queue The queue on which the callbacks will be delivered
211211
*/
212212
- (void)addDeviceControllerDelegate:(id<MTRDeviceControllerDelegate>)delegate
213-
queue:(dispatch_queue_t)queue MTR_NEWLY_AVAILABLE;
213+
queue:(dispatch_queue_t)queue MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
214214

215215
/**
216216
* Removes a Delegate from the device controller
217217
*
218218
* @param[in] delegate The delegate to be removed
219219
*/
220-
- (void)removeDeviceControllerDelegate:(id<MTRDeviceControllerDelegate>)delegate MTR_NEWLY_AVAILABLE;
220+
- (void)removeDeviceControllerDelegate:(id<MTRDeviceControllerDelegate>)delegate MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
221221

222222
/**
223223
* Start scanning for commissionable devices.
@@ -289,7 +289,7 @@ MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
289289
*
290290
* Suspending an already-suspended controller has no effect.
291291
*/
292-
- (void)suspend MTR_NEWLY_AVAILABLE;
292+
- (void)suspend MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
293293

294294
/**
295295
* Resume the controller. This has no effect if the controller is not
@@ -298,7 +298,7 @@ MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
298298
* A resume following any number of suspend calls will resume the controller;
299299
* there does not need to be a resume call to match every suspend call.
300300
*/
301-
- (void)resume MTR_NEWLY_AVAILABLE;
301+
- (void)resume MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
302302

303303
/**
304304
* Shut down the controller. Calls to shutdown after the first one are NO-OPs.

src/darwin/Framework/CHIP/MTRDeviceControllerDelegate.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4))
112112
* the controller will be in the specified state.
113113
*/
114114
- (void)controller:(MTRDeviceController *)controller
115-
suspendedChangedTo:(BOOL)suspended MTR_NEWLY_AVAILABLE;
115+
suspendedChangedTo:(BOOL)suspended MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
116116
@end
117117

118118
typedef NS_ENUM(NSUInteger, MTRPairingStatus) {

src/darwin/Framework/CHIP/MTRDeviceControllerParameters.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,11 @@ MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6))
153153
/**
154154
* The root certificate we were initialized with.
155155
*/
156-
@property (nonatomic, copy, readonly) MTRCertificateDERBytes rootCertificate MTR_NEWLY_AVAILABLE;
156+
@property (nonatomic, copy, readonly) MTRCertificateDERBytes rootCertificate MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
157157

158158
@end
159159

160-
MTR_NEWLY_AVAILABLE
160+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
161161
@interface MTRXPCDeviceControllerParameters : MTRDeviceControllerAbstractParameters
162162

163163
- (instancetype)init NS_UNAVAILABLE;
@@ -174,8 +174,8 @@ MTR_NEWLY_AVAILABLE
174174
- (instancetype)initWithXPConnectionBlock:(NSXPCConnection * (^)(void) )xpcConnectionBlock
175175
uniqueIdentifier:(NSUUID *)uniqueIdentifier;
176176

177-
@property (atomic, readonly, retain) NSUUID * uniqueIdentifier MTR_NEWLY_AVAILABLE;
178-
@property (readonly, strong, nonatomic) NSXPCConnection * (^xpcConnectionBlock)(void) MTR_NEWLY_AVAILABLE;
177+
@property (atomic, readonly, retain) NSUUID * uniqueIdentifier MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
178+
@property (readonly, strong, nonatomic) NSXPCConnection * (^xpcConnectionBlock)(void) MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
179179

180180
@end
181181

src/darwin/Framework/CHIP/MTRDeviceType.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
NS_ASSUME_NONNULL_BEGIN
2525

26-
MTR_NEWLY_AVAILABLE
26+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
2727
@interface MTRDeviceType : NSObject
2828

2929
/**

src/darwin/Framework/CHIP/XPC Protocol/MTRXPCClientProtocol.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
NS_ASSUME_NONNULL_BEGIN
2121

22-
MTR_NEWLY_AVAILABLE
22+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
2323
@protocol MTRXPCClientProtocol_MTRDevice <NSObject>
2424
- (oneway void)device:(NSNumber *)nodeID stateChanged:(MTRDeviceState)state;
2525
- (oneway void)device:(NSNumber *)nodeID receivedAttributeReport:(NSArray<NSDictionary<NSString *, id> *> *)attributeReport;
@@ -30,7 +30,7 @@ MTR_NEWLY_AVAILABLE
3030
- (oneway void)device:(NSNumber *)nodeID internalStateUpdated:(NSDictionary *)dictionary;
3131
@end
3232

33-
MTR_NEWLY_AVAILABLE
33+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
3434
@protocol MTRXPCClientProtocol_MTRDeviceController <NSObject>
3535
// Not Supported via XPC
3636
//- (oneway void)controller:(NSUUID *)controller statusUpdate:(MTRCommissioningStatus)status;
@@ -41,7 +41,7 @@ MTR_NEWLY_AVAILABLE
4141
- (oneway void)controller:(NSUUID *)controller controllerConfigurationUpdated:(NSDictionary *)configuration;
4242
@end
4343

44-
MTR_NEWLY_AVAILABLE
44+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
4545
@protocol MTRXPCClientProtocol <NSObject, MTRXPCClientProtocol_MTRDevice, MTRXPCClientProtocol_MTRDeviceController>
4646
@end
4747

src/darwin/Framework/CHIP/XPC Protocol/MTRXPCServerProtocol.h

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@
1818

1919
NS_ASSUME_NONNULL_BEGIN
2020

21-
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationNodeIDsKey MTR_NEWLY_AVAILABLE;
22-
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationNodeIDKey MTR_NEWLY_AVAILABLE;
23-
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationControllerContextKey MTR_NEWLY_AVAILABLE;
21+
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationNodeIDsKey MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
22+
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationNodeIDKey MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
23+
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationControllerContextKey MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));
2424
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationControllerNodeIDKey MTR_NEWLY_AVAILABLE;
2525
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationControllerIsRunningKey MTR_NEWLY_AVAILABLE;
2626
MTR_EXTERN NSString * const MTRDeviceControllerRegistrationDeviceInternalStateKey MTR_NEWLY_AVAILABLE;
2727

28-
MTR_NEWLY_AVAILABLE
28+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
2929
@protocol MTRXPCServerProtocol_MTRDevice <NSObject>
3030

3131
- (oneway void)deviceController:(NSUUID *)controller nodeID:(NSNumber *)nodeID getStateWithReply:(void (^)(MTRDeviceState state))reply;
@@ -53,7 +53,7 @@ MTR_NEWLY_AVAILABLE
5353

5454
@end
5555

56-
MTR_NEWLY_AVAILABLE
56+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
5757
@protocol MTRXPCServerProtocol_MTRDeviceController <NSObject>
5858

5959
@optional
@@ -76,7 +76,7 @@ MTR_NEWLY_AVAILABLE
7676

7777
@end
7878

79-
MTR_NEWLY_AVAILABLE
79+
MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2))
8080
@protocol MTRXPCServerProtocol <NSObject, MTRXPCServerProtocol_MTRDevice, MTRXPCServerProtocol_MTRDeviceController>
8181
@optional
8282
- (oneway void)deviceController:(NSUUID *)controller checkInWithContext:(NSDictionary *)context;

src/darwin/Framework/CHIP/templates/MTRClusterConstants.zapt

+1-1
Original file line numberDiff line numberDiff line change
@@ -236,4 +236,4 @@ typedef NS_ENUM(uint32_t, MTRDeviceTypeIDType) {
236236
MTRDeviceTypeIDType{{asUpperCamelCase caption preserveAcronyms=true}}ID {{availability "" deviceType=(asUpperCamelCase caption preserveAcronyms=true)}} = {{asHex code 8}},
237237
{{/if}}
238238
{{/zcl_device_types}}
239-
} MTR_NEWLY_AVAILABLE;
239+
} MTR_AVAILABLE(ios(18.2), macos(15.2), watchos(11.2), tvos(18.2));

src/darwin/Framework/CHIP/templates/availability.yaml

+15-2
Original file line numberDiff line numberDiff line change
@@ -9682,8 +9682,12 @@
96829682
- Presets
96839683
- MatterScheduleConfiguration
96849684

9685-
- release: "Future"
9686-
versions: "future"
9685+
- release: "6C44AB2F-2F6B-4B57-B523-5CD89584986F"
9686+
versions:
9687+
iOS: "18.2"
9688+
macOS: "15.2"
9689+
watchOS: "11.2"
9690+
tvOS: "18.2"
96879691
introduced:
96889692
enums:
96899693
ColorControl:
@@ -10077,3 +10081,12 @@
1007710081
- ColorLoop
1007810082
- XY
1007910083
- ColorTemperature
10084+
10085+
- release: "Future"
10086+
versions: "future"
10087+
provisional:
10088+
device types:
10089+
- BatteryStorage
10090+
- HeatPump
10091+
- SolarPower
10092+
- WaterHeater

0 commit comments

Comments
 (0)