Tuya iOS Smart Life App SDK 5.15.0
<ThingSmartActivatorMatterProtocol> Protocol Reference

#import <ThingSmartActivatorMatterProtocol.h>

Inheritance diagram for <ThingSmartActivatorMatterProtocol>:
ThingSmartActivatorDiscovery(Matter) ThingSmartActivatorDiscovery(Matter)

Instance Methods

(ThingSmartActivatorDeviceModel *) - parseSetupCode:
 
(void) - continueCommissioningDevice:ignoreAttestationFailure:error:
 
(void) - continueCommissionDevice:typeModel:
 
(void) - startScanAvailableWIFI
 scan device acvailable wifi list. More...
 
(ThingSmartActivatorDeviceModel *) - parseSetupCode:
 
(void) - continueCommissioningDevice:ignoreAttestationFailure:error:
 
(void) - continueCommissionDevice:typeModel:
 
(void) - startScanAvailableWIFI
 scan device acvailable wifi list. More...
 

Class Methods

(void) + setMatterConfigKey:
 
(void) + setMatterConfigKey:
 

Detailed Description

Definition at line 12 of file ThingSmartActivatorMatterProtocol.h.

Method Documentation

◆ continueCommissionDevice:typeModel: [1/2]

- (void) continueCommissionDevice: (ThingSmartActivatorDeviceModel *)  deviceModel
typeModel: (ThingSmartActivatorTypeMatterModel *)  typeModel 

Continue pair WIFI or Thread matter device when session establishment completed.

Notice: There are some rules before use this api to continue pair the matter device.

  1. Can only be used after the - matterCommissioningSessionEstablishmentComplete:
  2. The routingType must be equal to ThingMatterRoutingTypeThing. (routingType can be known by -matterRoutingComplete:)
  3. If you are pairing thread device ␈and want to set gateway device, you can set gwid in ThingSmartActivatorTypeMatterModel and use this api after the - matterCommissioningSessionEstablishmentComplete:
Parameters
deviceModelthe matter devicemodel.
typeModelNetwork configuration type.

◆ continueCommissionDevice:typeModel: [2/2]

- (void) continueCommissionDevice: (ThingSmartActivatorDeviceModel *)  deviceModel
typeModel: (ThingSmartActivatorTypeMatterModel *)  typeModel 

Continue pair WIFI or Thread matter device when session establishment completed.

Notice: There are some rules before use this api to continue pair the matter device.

  1. Can only be used after the - matterCommissioningSessionEstablishmentComplete:
  2. The routingType must be equal to ThingMatterRoutingTypeThing. (routingType can be known by -matterRoutingComplete:)
  3. If you are pairing thread device ␈and want to set gateway device, you can set gwid in ThingSmartActivatorTypeMatterModel and use this api after the - matterCommissioningSessionEstablishmentComplete:
Parameters
deviceModelthe matter devicemodel.
typeModelNetwork configuration type.

◆ continueCommissioningDevice:ignoreAttestationFailure:error: [1/2]

- (void) continueCommissioningDevice: (void *)  device
ignoreAttestationFailure: (BOOL)  ignoreAttestationFailure
error: (NSError *__autoreleasing *)  error 

Continue the pairing or NOT.

Notice: Can only be used after the -matterDeviceAttestation:error: delegate callback.

Parameters
deviceIt MUST BE the device object through the -matterDeviceAttestation:error: delegate callback.
ignoreAttestationFailureIgnore the attestation fail or NOT. YES - continue pairing, NO - interrupt pairing.
errorthe error info.

◆ continueCommissioningDevice:ignoreAttestationFailure:error: [2/2]

- (void) continueCommissioningDevice: (void *)  device
ignoreAttestationFailure: (BOOL)  ignoreAttestationFailure
error: (NSError *__autoreleasing *)  error 

Continue the pairing or NOT.

Notice: Can only be used after the -matterDeviceAttestation:error: delegate callback.

Parameters
deviceIt MUST BE the device object through the -matterDeviceAttestation:error: delegate callback.
ignoreAttestationFailureIgnore the attestation fail or NOT. YES - continue pairing, NO - interrupt pairing.
errorthe error info.

◆ parseSetupCode: [1/2]

- (ThingSmartActivatorDeviceModel *) parseSetupCode: (NSString *)  qrString

Check the matter code is legal or not. Returns nil if it is invalid.

Parameters
qrStringThe matter QRCode string or Manual Code string.

◆ parseSetupCode: [2/2]

- (ThingSmartActivatorDeviceModel *) parseSetupCode: (NSString *)  qrString

Check the matter code is legal or not. Returns nil if it is invalid.

Parameters
qrStringThe matter QRCode string or Manual Code string.

◆ setMatterConfigKey: [1/2]

+ (void) setMatterConfigKey: (NSString *)  configKey

Set your App Groups identify to share data with Matter Extension

Notice

  1. Please check the configKey must be same as the App Groups identify which is both chose it to Matter Extension Target and your App Main Target.
  2. Please call this API before start pairing, Usually this api is called after the App is started and before the matter device activator starts.
  • Parameter configKey: The App Groups identify.

◆ setMatterConfigKey: [2/2]

+ (void) setMatterConfigKey: (NSString *)  configKey

Set your App Groups identify to share data with Matter Extension

Notice

  1. Please check the configKey must be same as the App Groups identify which is both chose it to Matter Extension Target and your App Main Target.
  2. Please call this API before start pairing, Usually this api is called after the App is started and before the matter device activator starts.
  • Parameter configKey: The App Groups identify.

◆ startScanAvailableWIFI [1/2]

- (void) startScanAvailableWIFI

scan device acvailable wifi list.

◆ startScanAvailableWIFI [2/2]

- (void) startScanAvailableWIFI

scan device acvailable wifi list.


The documentation for this protocol was generated from the following files: