Merge branch 'master' into telink_all_clusters_app

project-chip · Nov 2, 2022 · b720ac5 · b720ac5
2 parents d529c65 + 887822a
commit b720ac5
Show file tree

Hide file tree

Showing 23 changed files with 1,522 additions and 1,277 deletions.
diff --git a/docs/VSCODE_DEVELOPMENT.md b/docs/VSCODE_DEVELOPMENT.md
@@ -21,7 +21,7 @@ Tested on:
 1. _Windows Only_ Install Ubuntu from the Windows App Store here:
    <https://www.microsoft.com/en-us/p/ubuntu-1804-lts/9n9tngvndl3q>
 1. Install [Docker](https://www.docker.com/) for your operating system of choice
-   from here: <https://docs.docker.com/install>
+   from here: <https://docs.docker.com/engine/install>
 1. Install [Visual Studio Code](https://code.visualstudio.com/) for your
    operating system of choice here: <https://code.visualstudio.com/Download>
 1. Install [Git](https://git-scm.com/) if you haven't already

diff --git a/examples/darwin-framework-tool/commands/payload/SetupPayloadParseCommand.mm b/examples/darwin-framework-tool/commands/payload/SetupPayloadParseCommand.mm
@@ -61,7 +61,7 @@
     NSString * codeString = [NSString stringWithCString:mCode encoding:NSASCIIStringEncoding];
     NSError * error;
     MTRSetupPayload * payload;
-    payload = [MTROnboardingPayloadParser setupPayloadForOnboardingPayload:codeString error:&error];
+    payload = [MTRSetupPayload setupPayloadWithOnboardingPayload:codeString error:&error];
     if (error) {
         LogNSError("Error: ", error);
         return CHIP_ERROR_INTERNAL;
@@ -78,37 +78,33 @@
     NSLog(@"ProductID:     %@", payload.productID);
     NSLog(@"Custom flow:   %tu    (%@)", payload.commissioningFlow, CustomFlowString(payload.commissioningFlow));
     {
-        if (payload.rendezvousInformation == nil) {
+        if (payload.discoveryCapabilities == MTRDiscoveryCapabilitiesUnknown) {
             NSLog(@"Capabilities:  UNKNOWN");
         } else {
             NSMutableString * humanFlags = [[NSMutableString alloc] init];
 
-            auto value = [payload.rendezvousInformation unsignedLongValue];
-            if (value == MTRDiscoveryCapabilitiesNone) {
-                [humanFlags appendString:@"NONE"];
-            } else {
-                if (value & MTRDiscoveryCapabilitiesSoftAP) {
-                    [humanFlags appendString:@"SoftAP"];
-                }
-                if (value & MTRDiscoveryCapabilitiesBLE) {
-                    if (!humanFlags) {
-                        [humanFlags appendString:@", "];
-                    }
-                    [humanFlags appendString:@"BLE"];
+            auto value = payload.discoveryCapabilities;
+            if (value & MTRDiscoveryCapabilitiesSoftAP) {
+                [humanFlags appendString:@"SoftAP"];
+            }
+            if (value & MTRDiscoveryCapabilitiesBLE) {
+                if (!humanFlags) {
+                    [humanFlags appendString:@", "];
                 }
-                if (value & MTRDiscoveryCapabilitiesOnNetwork) {
-                    if (!humanFlags) {
-                        [humanFlags appendString:@", "];
-                    }
-                    [humanFlags appendString:@"ON NETWORK"];
+                [humanFlags appendString:@"BLE"];
+            }
+            if (value & MTRDiscoveryCapabilitiesOnNetwork) {
+                if (!humanFlags) {
+                    [humanFlags appendString:@", "];
                 }
+                [humanFlags appendString:@"ON NETWORK"];
             }
 
             NSLog(@"Capabilities:  0x%02lX (%@)", static_cast<long>(value), humanFlags);
         }
     }
     NSLog(@"Discriminator: %@", payload.discriminator);
-    NSLog(@"Passcode:      %@", payload.setUpPINCode);
+    NSLog(@"Passcode:      %@", payload.setupPasscode);
 
     if (payload.serialNumber) {
         NSLog(@"SerialNumber: %@", payload.serialNumber);
@@ -120,8 +116,8 @@
         return CHIP_ERROR_INTERNAL;
     }
     for (const MTROptionalQRCodeInfo * info : optionalVendorData) {
-        bool isTypeString = [info.infoType isEqual:@(MTROptionalQRCodeInfoTypeString)];
-        bool isTypeInt32 = [info.infoType isEqual:@(MTROptionalQRCodeInfoTypeInt32)];
+        bool isTypeString = (info.type == MTROptionalQRCodeInfoTypeString);
+        bool isTypeInt32 = (info.type == MTROptionalQRCodeInfoTypeInt32);
         VerifyOrReturnError(isTypeString || isTypeInt32, CHIP_ERROR_INVALID_ARGUMENT);
 
         if (isTypeString) {

diff --git a/scripts/codegen.py b/scripts/codegen.py
@@ -15,10 +15,15 @@
 
 import click
 import logging
-import coloredlogs
 import enum
 import sys
 
+try:
+    import coloredlogs
+    _has_coloredlogs = True
+except:
+    _has_coloredlogs = False
+
 try:
     from idl.matter_idl_parser import CreateParser
 except:
@@ -94,8 +99,16 @@ def main(log_level, generator, output_dir, dry_run, name_only, expected_outputs,
     Parses MATTER IDL files (.matter) and performs SDK code generation
     as set up by the program arguments.
     """
-    coloredlogs.install(level=__LOG_LEVELS__[
-                        log_level], fmt='%(asctime)s %(levelname)-7s %(message)s')
+    if _has_coloredlogs:
+        coloredlogs.install(level=__LOG_LEVELS__[
+                            log_level], fmt='%(asctime)s %(levelname)-7s %(message)s')
+    else:
+        logging.basicConfig(
+            level=__LOG_LEVELS__[log_level],
+            format='%(asctime)s %(levelname)-7s %(message)s',
+            datefmt='%Y-%m-%d %H:%M:%S'
+        )
+
     logging.info("Parsing idl from %s" % idl_path)
     idl_tree = CreateParser().parse(open(idl_path, "rt").read())
 

diff --git a/src/darwin/Framework/CHIP/MTRBaseDevice.h b/src/darwin/Framework/CHIP/MTRBaseDevice.h
@@ -269,6 +269,67 @@ extern NSString * const MTRArrayValueType;
 
 @end
 
+@interface MTRAttributePath : NSObject <NSCopying>
+@property (nonatomic, readonly, strong, nonnull) NSNumber * endpoint;
+@property (nonatomic, readonly, strong, nonnull) NSNumber * cluster;
+@property (nonatomic, readonly, strong, nonnull) NSNumber * attribute;
+
++ (instancetype)attributePathWithEndpointID:(NSNumber *)endpointID
+                                  clusterID:(NSNumber *)clusterID
+                                attributeID:(NSNumber *)attributeID MTR_NEWLY_AVAILABLE;
+
+- (instancetype)init NS_UNAVAILABLE;
++ (instancetype)new NS_UNAVAILABLE;
+@end
+
+@interface MTREventPath : NSObject
+@property (nonatomic, readonly, strong, nonnull) NSNumber * endpoint;
+@property (nonatomic, readonly, strong, nonnull) NSNumber * cluster;
+@property (nonatomic, readonly, strong, nonnull) NSNumber * event;
+
++ (instancetype)eventPathWithEndpointID:(NSNumber *)endpointID
+                              clusterID:(NSNumber *)clusterID
+                                eventID:(NSNumber *)eventID MTR_NEWLY_AVAILABLE;
+
+- (instancetype)init NS_UNAVAILABLE;
++ (instancetype)new NS_UNAVAILABLE;
+@end
+
+@interface MTRCommandPath : NSObject
+@property (nonatomic, readonly, strong, nonnull) NSNumber * endpoint;
+@property (nonatomic, readonly, strong, nonnull) NSNumber * cluster;
+@property (nonatomic, readonly, strong, nonnull) NSNumber * command;
+
++ (instancetype)commandPathWithEndpointID:(NSNumber *)endpointID
+                                clusterID:(NSNumber *)clusterID
+                                commandID:(NSNumber *)commandID MTR_NEWLY_AVAILABLE;
+
+- (instancetype)init NS_UNAVAILABLE;
++ (instancetype)new NS_UNAVAILABLE;
+@end
+
+@interface MTRAttributeReport : NSObject
+@property (nonatomic, readonly, strong, nonnull) MTRAttributePath * path;
+// value is nullable because nullable attributes can have nil as value.
+@property (nonatomic, readonly, strong, nullable) id value;
+// If this specific path resulted in an error, the error (in the
+// MTRInteractionErrorDomain or MTRErrorDomain) that corresponds to this
+// path.
+@property (nonatomic, readonly, strong, nullable) NSError * error;
+@end
+
+@interface MTREventReport : NSObject
+@property (nonatomic, readonly, strong, nonnull) MTREventPath * path;
+@property (nonatomic, readonly, strong, nonnull) NSNumber * eventNumber; // chip::EventNumber type (uint64_t)
+@property (nonatomic, readonly, strong, nonnull) NSNumber * priority; // chip::app::PriorityLevel type (uint8_t)
+@property (nonatomic, readonly, strong, nonnull) NSNumber * timestamp; // chip::app::Timestamp.mValue type (uint64_t)
+@property (nonatomic, readonly, strong, nullable) id value;
+// If this specific path resulted in an error, the error (in the
+// MTRInteractionErrorDomain or MTRErrorDomain) that corresponds to this
+// path.
+@property (nonatomic, readonly, strong, nullable) NSError * error;
+@end
+
 @interface MTRBaseDevice (Deprecated)
 
 /**
@@ -331,19 +392,6 @@ extern NSString * const MTRArrayValueType;
 
 @end
 
-@interface MTRAttributePath : NSObject <NSCopying>
-@property (nonatomic, readonly, strong, nonnull) NSNumber * endpoint;
-@property (nonatomic, readonly, strong, nonnull) NSNumber * cluster;
-@property (nonatomic, readonly, strong, nonnull) NSNumber * attribute;
-
-+ (instancetype)attributePathWithEndpointID:(NSNumber *)endpointID
-                                  clusterID:(NSNumber *)clusterID
-                                attributeID:(NSNumber *)attributeID MTR_NEWLY_AVAILABLE;
-
-- (instancetype)init NS_UNAVAILABLE;
-+ (instancetype)new NS_UNAVAILABLE;
-@end
-
 @interface MTRAttributePath (Deprecated)
 
 + (instancetype)attributePathWithEndpointId:(NSNumber *)endpointId
@@ -353,19 +401,6 @@ extern NSString * const MTRArrayValueType;
 
 @end
 
-@interface MTREventPath : NSObject
-@property (nonatomic, readonly, strong, nonnull) NSNumber * endpoint;
-@property (nonatomic, readonly, strong, nonnull) NSNumber * cluster;
-@property (nonatomic, readonly, strong, nonnull) NSNumber * event;
-
-+ (instancetype)eventPathWithEndpointID:(NSNumber *)endpointID
-                              clusterID:(NSNumber *)clusterID
-                                eventID:(NSNumber *)eventID MTR_NEWLY_AVAILABLE;
-
-- (instancetype)init NS_UNAVAILABLE;
-+ (instancetype)new NS_UNAVAILABLE;
-@end
-
 @interface MTREventPath (Deprecated)
 
 + (instancetype)eventPathWithEndpointId:(NSNumber *)endpointId
@@ -375,19 +410,6 @@ extern NSString * const MTRArrayValueType;
 
 @end
 
-@interface MTRCommandPath : NSObject
-@property (nonatomic, readonly, strong, nonnull) NSNumber * endpoint;
-@property (nonatomic, readonly, strong, nonnull) NSNumber * cluster;
-@property (nonatomic, readonly, strong, nonnull) NSNumber * command;
-
-+ (instancetype)commandPathWithEndpointID:(NSNumber *)endpointID
-                                clusterID:(NSNumber *)clusterID
-                                commandID:(NSNumber *)commandID MTR_NEWLY_AVAILABLE;
-
-- (instancetype)init NS_UNAVAILABLE;
-+ (instancetype)new NS_UNAVAILABLE;
-@end
-
 @interface MTRCommandPath (Deprecated)
 
 + (instancetype)commandPathWithEndpointId:(NSNumber *)endpointId
@@ -397,26 +419,4 @@ extern NSString * const MTRArrayValueType;
 
 @end
 
-@interface MTRAttributeReport : NSObject
-@property (nonatomic, readonly, strong, nonnull) MTRAttributePath * path;
-// value is nullable because nullable attributes can have nil as value.
-@property (nonatomic, readonly, strong, nullable) id value;
-// If this specific path resulted in an error, the error (in the
-// MTRInteractionErrorDomain or MTRErrorDomain) that corresponds to this
-// path.
-@property (nonatomic, readonly, strong, nullable) NSError * error;
-@end
-
-@interface MTREventReport : NSObject
-@property (nonatomic, readonly, strong, nonnull) MTREventPath * path;
-@property (nonatomic, readonly, strong, nonnull) NSNumber * eventNumber; // chip::EventNumber type (uint64_t)
-@property (nonatomic, readonly, strong, nonnull) NSNumber * priority; // chip::app::PriorityLevel type (uint8_t)
-@property (nonatomic, readonly, strong, nonnull) NSNumber * timestamp; // chip::app::Timestamp.mValue type (uint64_t)
-@property (nonatomic, readonly, strong, nullable) id value;
-// If this specific path resulted in an error, the error (in the
-// MTRInteractionErrorDomain or MTRErrorDomain) that corresponds to this
-// path.
-@property (nonatomic, readonly, strong, nullable) NSError * error;
-@end
-
 NS_ASSUME_NONNULL_END
diff --git a/src/darwin/Framework/CHIP/MTRDevice.h b/src/darwin/Framework/CHIP/MTRDevice.h
@@ -166,17 +166,6 @@ typedef NS_ENUM(NSUInteger, MTRDeviceState) {
 
 @end
 
-@interface MTRDevice (Deprecated)
-
-/**
- * Deprecated MTRDevice APIs.
- */
-+ (instancetype)deviceWithNodeID:(uint64_t)nodeID
-                deviceController:(MTRDeviceController *)deviceController
-    MTR_NEWLY_DEPRECATED("Please use deviceWithNodeID:controller:");
-
-@end
-
 @protocol MTRDeviceDelegate <NSObject>
 @required
 /**
@@ -206,4 +195,15 @@ typedef NS_ENUM(NSUInteger, MTRDeviceState) {
 
 @end
 
+@interface MTRDevice (Deprecated)
+
+/**
+ * Deprecated MTRDevice APIs.
+ */
++ (instancetype)deviceWithNodeID:(uint64_t)nodeID
+                deviceController:(MTRDeviceController *)deviceController
+    MTR_NEWLY_DEPRECATED("Please use deviceWithNodeID:controller:");
+
+@end
+
 NS_ASSUME_NONNULL_END
diff --git a/src/darwin/Framework/CHIP/MTRDevice.mm b/src/darwin/Framework/CHIP/MTRDevice.mm
@@ -174,15 +174,16 @@ + (instancetype)deviceWithNodeID:(NSNumber *)nodeID controller:(MTRDeviceControl
 #pragma mark Subscription and delegate handling
 
 // subscription intervals are in seconds
-#define MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_DEFAULT (3600)
+#define MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_MIN (2)
+#define MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_MAX (60)
 
 - (void)setDelegate:(id<MTRDeviceDelegate>)delegate queue:(dispatch_queue_t)queue
 {
     os_unfair_lock_lock(&self->_lock);
 
     _weakDelegate = [MTRWeakReference weakReferenceWithObject:delegate];
     _delegateQueue = queue;
-    [self subscribeWithMinInterval:0 maxInterval:MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_DEFAULT];
+    [self setupSubscription];
 
     os_unfair_lock_unlock(&self->_lock);
 }
@@ -285,7 +286,7 @@ - (void)_handleEventReport:(NSArray<NSDictionary<NSString *, id> *> *)eventRepor
     os_unfair_lock_unlock(&self->_lock);
 }
 
-- (void)subscribeWithMinInterval:(uint16_t)minInterval maxInterval:(uint16_t)maxInterval
+- (void)setupSubscription
 {
     // for now just subscribe once
     if (_subscriptionActive) {
@@ -310,8 +311,19 @@ - (void)subscribeWithMinInterval:(uint16_t)minInterval maxInterval:(uint16_t)max
                            // We want to get event reports at the minInterval, not the maxInterval.
                            eventPath->mIsUrgentEvent = true;
                            ReadPrepareParams readParams(session.Value());
-                           readParams.mMinIntervalFloorSeconds = minInterval;
-                           readParams.mMaxIntervalCeilingSeconds = maxInterval;
+
+                           readParams.mMinIntervalFloorSeconds = 0;
+                           // Select a max interval based on the device's claimed idle sleep interval.
+                           auto idleSleepInterval = std::chrono::duration_cast<System::Clock::Seconds32>(
+                               session.Value()->GetRemoteMRPConfig().mIdleRetransTimeout);
+                           if (idleSleepInterval.count() < MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_MIN) {
+                               idleSleepInterval = System::Clock::Seconds32(MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_MIN);
+                           }
+                           if (idleSleepInterval.count() > MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_MAX) {
+                               idleSleepInterval = System::Clock::Seconds32(MTR_DEVICE_SUBSCRIPTION_MAX_INTERVAL_MAX);
+                           }
+                           readParams.mMaxIntervalCeilingSeconds = static_cast<uint16_t>(idleSleepInterval.count());
+
                            readParams.mpAttributePathParamsList = attributePath.get();
                            readParams.mAttributePathParamsListSize = 1;
                            readParams.mpEventPathParamsList = eventPath.get();

diff --git a/src/darwin/Framework/CHIP/MTRDeviceController+XPC.h b/src/darwin/Framework/CHIP/MTRDeviceController+XPC.h
@@ -77,14 +77,6 @@ typedef void (^MTRValuesHandler)(id _Nullable values, NSError * _Nullable error)
 
 @end
 
-@interface MTRDeviceController (Deprecated_XPC)
-
-+ (MTRDeviceController *)sharedControllerWithId:(id<NSCopying> _Nullable)controllerID
-                                xpcConnectBlock:(MTRXPCConnectBlock)xpcConnectBlock
-    MTR_NEWLY_DEPRECATED("Please use sharedControllerWithID:xpcConnectBlock:");
-
-@end
-
 /**
  * Protocol that remote object must support over XPC
  */
@@ -194,4 +186,12 @@ typedef void (^MTRValuesHandler)(id _Nullable values, NSError * _Nullable error)
 
 @end
 
+@interface MTRDeviceController (Deprecated_XPC)
+
++ (MTRDeviceController *)sharedControllerWithId:(id<NSCopying> _Nullable)controllerID
+                                xpcConnectBlock:(MTRXPCConnectBlock)xpcConnectBlock
+    MTR_NEWLY_DEPRECATED("Please use sharedControllerWithID:xpcConnectBlock:");
+
+@end
+
 NS_ASSUME_NONNULL_END