forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Darwin] Duplicate MTRDeviceController with
git cp (project-chip#34828
) * Keep MTRDeviceController.h * Copy MTRDeviceController.h into MTRDeviceController_Concrete.h * Set back MTRDeviceController.h file * Keep MTRDeviceController.mm * Copy MTRDeviceController.mm into MTRDeviceController_Concrete.mm * Set back MTRDeviceController.mm file
- Loading branch information
1 parent
faef75c
commit 96813aa
Showing
2 changed files
with
2,331 additions
and
0 deletions.
There are no files selected for viewing
343 changes: 343 additions & 0 deletions
343
src/darwin/Framework/CHIP/MTRDeviceController_Concrete.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,343 @@ | ||
| /** | ||
| * | ||
| * Copyright (c) 2020-2023 Project CHIP Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #import <Foundation/Foundation.h> | ||
|
|
||
| #import <Matter/MTRCommissionableBrowserDelegate.h> | ||
| #import <Matter/MTRDefines.h> | ||
| #import <Matter/MTROperationalCertificateIssuer.h> | ||
|
|
||
| @class MTRBaseDevice; | ||
| @class MTRServerEndpoint; // Defined in MTRServerEndpoint.h, which imports MTRAccessGrant.h, which imports MTRBaseClusters.h, which imports this file, so we can't import it. | ||
|
|
||
| @class MTRDeviceControllerAbstractParameters; | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| MTR_DEPRECATED("Please use MTRBaseDevice deviceWithNodeID", ios(16.1, 16.4), macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)) | ||
| typedef void (^MTRDeviceConnectionCallback)(MTRBaseDevice * _Nullable device, NSError * _Nullable error); | ||
|
|
||
| @class MTRCommissioningParameters; | ||
| @class MTRCommissionableBrowserResult; | ||
| @class MTRSetupPayload; | ||
| @protocol MTRDevicePairingDelegate; | ||
| @protocol MTRDeviceControllerDelegate; | ||
|
|
||
| MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1)) | ||
| @interface MTRDeviceController : NSObject | ||
|
|
||
| /** | ||
| * Controllers are created via the MTRDeviceControllerFactory object or | ||
| * initialized via initWithParameters:error:. | ||
| */ | ||
| - (instancetype)init NS_UNAVAILABLE; | ||
| + (instancetype)new NS_UNAVAILABLE; | ||
|
|
||
| /** | ||
| * Initialize a device controller with the provided parameters. This will: | ||
| * | ||
| * 1) Auto-start the MTRDeviceControllerFactory in storage-per-controller mode | ||
| * if it has not already been started. | ||
| * 2) Return nil or a running controller. | ||
| * | ||
| * Once this returns non-nil, it's the caller's responsibility to call shutdown | ||
| * on the controller to avoid leaking it. | ||
| */ | ||
| - (nullable instancetype)initWithParameters:(MTRDeviceControllerAbstractParameters *)parameters | ||
| error:(NSError * __autoreleasing *)error MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6)); | ||
|
|
||
| /** | ||
| * If true, the controller has not been shut down yet. | ||
| */ | ||
| @property (readonly, nonatomic, getter=isRunning) BOOL running; | ||
|
|
||
| /** | ||
| * The ID assigned to this controller at creation time. | ||
| */ | ||
| @property (readonly, nonatomic) NSUUID * uniqueIdentifier MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6)); | ||
|
|
||
| /** | ||
| * Return the Node ID assigned to the controller. Will return nil if the | ||
| * controller is not running (and hence does not know its node id). | ||
| */ | ||
| @property (readonly, nonatomic, nullable) | ||
| NSNumber * controllerNodeID MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)); | ||
|
|
||
| /** | ||
| * Set up a commissioning session for a device, using the provided setup payload | ||
| * to discover it and connect to it. | ||
| * | ||
| * @param payload a setup payload (probably created from a QR code or numeric | ||
| * code onboarding payload). | ||
| * @param newNodeID the planned node id for the node. | ||
| * @error error indication if discovery can't start at all (e.g. because the | ||
| * setup payload is invalid). | ||
| * | ||
| * The IP and port for the device will be discovered automatically based on the | ||
| * provided discriminator. | ||
| * | ||
| * Then a PASE session will be established with the device, unless an error | ||
| * occurs. MTRDeviceControllerDelegate will be notified as follows: | ||
| * | ||
| * * Discovery fails: onStatusUpdate with MTRCommissioningStatusFailed. | ||
| * | ||
| * * Discovery succeeds but commissioning session setup fails: onPairingComplete | ||
| * with an error. | ||
| * | ||
| * * Commissioning session setup succeeds: onPairingComplete with no error. | ||
| * | ||
| * Once a commissioning session is set up, getDeviceBeingCommissioned | ||
| * can be used to get an MTRBaseDevice and discover what sort of network | ||
| * credentials the device might need, and commissionDevice can be used to | ||
| * commission the device. | ||
| */ | ||
| - (BOOL)setupCommissioningSessionWithPayload:(MTRSetupPayload *)payload | ||
| newNodeID:(NSNumber *)newNodeID | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_AVAILABLE(ios(16.2), macos(13.1), watchos(9.2), tvos(16.2)); | ||
|
|
||
| /** | ||
| * Set up a commissioning session for a device, using the provided discovered | ||
| * result to connect to it. | ||
| * | ||
| * @param discoveredDevice a previously discovered device. | ||
| * @param payload a setup payload (probably created from a QR code or numeric | ||
| * code onboarding payload). | ||
| * @param newNodeID the planned node id for the node. | ||
| * @error error indication if the commissioning session establishment can't start at all. | ||
| * | ||
| * The connection information for the device will be retrieved from the discovered device. | ||
| * A device discovered over DNS-SD will use the discovered IPs/ports, while a device discovered | ||
| * over BLE will use the underlying CBPeripheral. | ||
| * | ||
| * Then a PASE session will be established with the device, unless an error | ||
| * occurs. MTRDeviceControllerDelegate will be notified as follows: | ||
| * | ||
| * * Invalid connection information: onStatusUpdate with MTRCommissioningStatusFailed. | ||
| * | ||
| * * Commissioning session setup fails: onPairingComplete with an error. | ||
| * | ||
| * * Commissioning session setup succeeds: onPairingComplete with no error. | ||
| * | ||
| * Once a commissioning session is set up, getDeviceBeingCommissioned | ||
| * can be used to get an MTRBaseDevice and discover what sort of network | ||
| * credentials the device might need, and commissionDevice can be used to | ||
| * commission the device. | ||
| */ | ||
| - (BOOL)setupCommissioningSessionWithDiscoveredDevice:(MTRCommissionableBrowserResult *)discoveredDevice | ||
| payload:(MTRSetupPayload *)payload | ||
| newNodeID:(NSNumber *)newNodeID | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_AVAILABLE(ios(17.0), macos(14.0), watchos(10.0), tvos(17.0)); | ||
|
|
||
| /** | ||
| * Commission the node with the given node ID. The node ID must match the node | ||
| * ID that was used to set up the commissioning session. | ||
| */ | ||
| - (BOOL)commissionNodeWithID:(NSNumber *)nodeID | ||
| commissioningParams:(MTRCommissioningParameters *)commissioningParams | ||
| error:(NSError * __autoreleasing *)error MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)); | ||
|
|
||
| /** | ||
| * Call this method after MTRDeviceAttestationDelegate | ||
| * deviceAttestationFailedForController:opaqueDeviceHandle:error: or | ||
| * deviceAttestationCompletedForController:opaqueDeviceHandle:attestationDeviceInfo:error: | ||
| * is called to continue commissioning the device. | ||
| */ | ||
| - (BOOL)continueCommissioningDevice:(void *)opaqueDeviceHandle | ||
| ignoreAttestationFailure:(BOOL)ignoreAttestationFailure | ||
| error:(NSError * __autoreleasing *)error; | ||
|
|
||
| /** | ||
| * Cancel commissioning for the given node id. This will shut down any existing | ||
| * commissioning session for that node id. | ||
| */ | ||
| - (BOOL)cancelCommissioningForNodeID:(NSNumber *)nodeID | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)); | ||
|
|
||
| /** | ||
| * Get an MTRBaseDevice for a commissioning session that was set up for the | ||
| * given node ID. Returns nil if no such commissioning session is available. | ||
| */ | ||
| - (nullable MTRBaseDevice *)deviceBeingCommissionedWithNodeID:(NSNumber *)nodeID | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)); | ||
|
|
||
| - (void)preWarmCommissioningSession MTR_DEPRECATED("-[MTRDeviceControllerFactory preWarmCommissioningSession]", ios(16.4, 17.6), macos(13.3, 14.6), watchos(9.4, 10.6), tvos(16.4, 17.6)); | ||
|
|
||
| /** | ||
| * Set the Delegate for the device controller as well as the Queue on which the Delegate callbacks will be triggered | ||
| * | ||
| * @param[in] delegate The delegate the commissioning process should use | ||
| * | ||
| * @param[in] queue The queue on which the callbacks will be delivered | ||
| */ | ||
| - (void)setDeviceControllerDelegate:(id<MTRDeviceControllerDelegate>)delegate | ||
| queue:(dispatch_queue_t)queue MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)); | ||
|
|
||
| /** | ||
| * Start scanning for commissionable devices. | ||
| * | ||
| * This method will fail if the controller factory is not running or the browse has already been started. | ||
| */ | ||
| - (BOOL)startBrowseForCommissionables:(id<MTRCommissionableBrowserDelegate>)delegate | ||
| queue:(dispatch_queue_t)queue MTR_AVAILABLE(ios(17.0), macos(14.0), watchos(10.0), tvos(17.0)); | ||
|
|
||
| /** | ||
| * Stop scanning for commissionable devices. | ||
| * | ||
| * This method will fail if the controller factory is not running or the browse has not been started. | ||
| */ | ||
| - (BOOL)stopBrowseForCommissionables MTR_AVAILABLE(ios(17.0), macos(14.0), watchos(10.0), tvos(17.0)); | ||
|
|
||
| /** | ||
| * Return the attestation challenge for the secure session of the device being commissioned. | ||
| * | ||
| * Attempts to retrieve the attestation challenge for a commissionee with the given Device ID. | ||
| * Returns nil if given Device ID does not match an active commissionee, or if a Secure Session is not availale. | ||
| */ | ||
| - (NSData * _Nullable)attestationChallengeForDeviceID:(NSNumber *)deviceID | ||
| MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)); | ||
|
|
||
| /** | ||
| * Add a server endpoint for this controller. The endpoint starts off enabled. | ||
| * | ||
| * Will fail in the following cases: | ||
| * | ||
| * 1) There is already an endpoint defined with the given endpoint id. | ||
| * 2) There are too many endpoints defined already. | ||
| */ | ||
| - (BOOL)addServerEndpoint:(MTRServerEndpoint *)endpoint MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6)); | ||
|
|
||
| /** | ||
| * Remove the given server endpoint from this controller. If the endpoint is | ||
| * not attached to this controller, will just call the completion and do nothing | ||
| * else. | ||
| */ | ||
| - (void)removeServerEndpoint:(MTRServerEndpoint *)endpoint queue:(dispatch_queue_t)queue completion:(dispatch_block_t)completion MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6)); | ||
|
|
||
| /** | ||
| * Remove the given server endpoint without being notified when the removal | ||
| * completes. | ||
| */ | ||
| - (void)removeServerEndpoint:(MTRServerEndpoint *)endpoint MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6)); | ||
|
|
||
| /** | ||
| * Compute a PASE verifier for the desired setup passcode. | ||
| * | ||
| * @param[in] setupPasscode The desired passcode to use. | ||
| * @param[in] iterations The number of iterations to use when generating the verifier. | ||
| * @param[in] salt The 16-byte salt for verifier computation. | ||
| * | ||
| * Returns nil on errors (e.g. salt has the wrong size), otherwise the computed | ||
| * verifier bytes. | ||
| */ | ||
| + (nullable NSData *)computePASEVerifierForSetupPasscode:(NSNumber *)setupPasscode | ||
| iterations:(NSNumber *)iterations | ||
| salt:(NSData *)salt | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_AVAILABLE(ios(16.4), macos(13.3), watchos(9.4), tvos(16.4)); | ||
|
|
||
| /** | ||
| * Shut down the controller. Calls to shutdown after the first one are NO-OPs. | ||
| * This must be called, either directly or via shutting down the | ||
| * MTRDeviceControllerFactory, to avoid leaking the controller. | ||
| */ | ||
| - (void)shutdown; | ||
|
|
||
| @end | ||
|
|
||
| @interface MTRDeviceController (Deprecated) | ||
|
|
||
| @property (readonly, nonatomic, nullable) NSNumber * controllerNodeId MTR_DEPRECATED( | ||
| "Please use controllerNodeID", ios(16.1, 16.4), macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
|
|
||
| - (nullable NSData *)fetchAttestationChallengeForDeviceId:(uint64_t)deviceId | ||
| MTR_DEPRECATED( | ||
| "Please use attestationChallengeForDeviceID", ios(16.1, 16.4), macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
|
|
||
| - (BOOL)getBaseDevice:(uint64_t)deviceID | ||
| queue:(dispatch_queue_t)queue | ||
| completionHandler:(MTRDeviceConnectionCallback)completionHandler | ||
| MTR_DEPRECATED("Please use [MTRBaseDevice deviceWithNodeID:controller:]", ios(16.1, 16.4), macos(13.0, 13.3), watchos(9.1, 9.4), | ||
| tvos(16.1, 16.4)); | ||
|
|
||
| - (BOOL)pairDevice:(uint64_t)deviceID | ||
| discriminator:(uint16_t)discriminator | ||
| setupPINCode:(uint32_t)setupPINCode | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED("Please use setupCommissioningSessionWithPayload:newNodeID:error:", ios(16.1, 16.4), macos(13.0, 13.3), | ||
| watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
| - (BOOL)pairDevice:(uint64_t)deviceID | ||
| address:(NSString *)address | ||
| port:(uint16_t)port | ||
| setupPINCode:(uint32_t)setupPINCode | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED("Please use setupCommissioningSessionWithPayload:newNodeID:error:", ios(16.1, 16.4), macos(13.0, 13.3), | ||
| watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
| - (BOOL)pairDevice:(uint64_t)deviceID | ||
| onboardingPayload:(NSString *)onboardingPayload | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED("Please use setupCommissioningSessionWithPayload:newNodeID:error:", ios(16.1, 16.4), macos(13.0, 13.3), | ||
| watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
| - (BOOL)commissionDevice:(uint64_t)deviceId | ||
| commissioningParams:(MTRCommissioningParameters *)commissioningParams | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED("Please use commissionNodeWithID:commissioningParams:error:", ios(16.1, 16.4), macos(13.0, 13.3), | ||
| watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
|
|
||
| - (BOOL)stopDevicePairing:(uint64_t)deviceID | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED( | ||
| "Please use cancelCommissioningForNodeID:error:", ios(16.1, 16.4), macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
|
|
||
| - (nullable MTRBaseDevice *)getDeviceBeingCommissioned:(uint64_t)deviceId | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED("Please use deviceBeingCommissionedWithNodeID:error:", ios(16.1, 16.4), macos(13.0, 13.3), watchos(9.1, 9.4), | ||
| tvos(16.1, 16.4)); | ||
|
|
||
| - (BOOL)openPairingWindow:(uint64_t)deviceID | ||
| duration:(NSUInteger)duration | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED("Please use MTRDevice or MTRBaseDevice openCommissioningWindowWithSetupPasscode", ios(16.1, 16.4), | ||
| macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
| - (nullable NSString *)openPairingWindowWithPIN:(uint64_t)deviceID | ||
| duration:(NSUInteger)duration | ||
| discriminator:(NSUInteger)discriminator | ||
| setupPIN:(NSUInteger)setupPIN | ||
| error:(NSError * __autoreleasing *)error | ||
| MTR_DEPRECATED("Please use MTRDevice or MTRBaseDevice openCommissioningWindowWithSetupPasscode", ios(16.1, 16.4), | ||
| macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
|
|
||
| - (nullable NSData *)computePaseVerifier:(uint32_t)setupPincode | ||
| iterations:(uint32_t)iterations | ||
| salt:(NSData *)salt | ||
| MTR_DEPRECATED("Please use computePASEVerifierForSetupPasscode:iterations:salt:error:", ios(16.1, 16.4), macos(13.0, 13.3), | ||
| watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
|
|
||
| - (void)setPairingDelegate:(id<MTRDevicePairingDelegate>)delegate | ||
| queue:(dispatch_queue_t)queue MTR_DEPRECATED("Please use setDeviceControllerDelegate:", ios(16.1, 16.4), | ||
| macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
|
|
||
| - (void)setNocChainIssuer:(id<MTRNOCChainIssuer>)nocChainIssuer | ||
| queue:(dispatch_queue_t)queue | ||
| MTR_DEPRECATED("Please set the operationalCertificateIssuer in the MTRDeviceControllerStartupParams instead.", ios(16.1, 16.4), | ||
| macos(13.0, 13.3), watchos(9.1, 9.4), tvos(16.1, 16.4)); | ||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
Oops, something went wrong.