Tuya iOS Smart Life App SDK 5.15.0
Instance Methods | Properties | List of all members
ThingSmartMatterActivator Class Reference

#import <ThingSmartMatterActivator.h>

Inheritance diagram for ThingSmartMatterActivator:

Instance Methods

(nullable ThingSmartMatterSetupPayload *) - parseSetupCode:
 shareInstance More...
 
(void) - connectDeviceWithConnectDeviceBuilder:timeout:
 
(void) - commissionDevice:commissionModel:
 
(void) - continueCommissioningDevice:ignoreAttestationFailure:error:
 
(void) - startScanAvailableWIFI
 scan device acvailable wifi list. More...
 
(void) - cancelActivator
 Cancel current activator. More...
 
(nullable ThingSmartMatterSetupPayload *) - parseSetupCode:
 shareInstance More...
 
(void) - connectDeviceWithConnectDeviceBuilder:timeout:
 
(void) - commissionDevice:commissionModel:
 
(void) - continueCommissioningDevice:ignoreAttestationFailure:error:
 
(void) - startScanAvailableWIFI
 scan device acvailable wifi list. More...
 
(void) - cancelActivator
 Cancel current activator. More...
 
(nullable ThingSmartMatterSetupPayload *) - checkMatterCodeInvalid:
 
(nullable ThingSmartMatterSetupPayload *) - checkMatterCodeInvalid:
 
(void) - pairDeviceWithSetupPayload:toke:spaceId:timeout:
 
(void) - pairDeviceWithSetupPayload:toke:spaceId:timeout:
 
(void) - setGatewayDeviceBeforePairing:
 
(void) - setGatewayDeviceBeforePairing:
 
(void) - continueCommissionDevice:WithSSID:password:
 
(void) - continueCommissionDevice:WithSSID:password:
 

Properties

id< ThingSmartMatterActivatorDelegate > delegate
 
ThingSmartMatterDeviceModel * currentDeviceModel
 

Detailed Description

Definition at line 76 of file ThingSmartMatterActivator.h.

Method Documentation

◆ cancelActivator [1/2]

- (void) cancelActivator

Cancel current activator.

◆ cancelActivator [2/2]

- (void) cancelActivator

Cancel current activator.

◆ checkMatterCodeInvalid: [1/2]

- (nullable ThingSmartMatterSetupPayload *) checkMatterCodeInvalid: ("Will be removed in the)  future
(please use connectDeviceWithSetupPayload")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ checkMatterCodeInvalid: [2/2]

- (nullable ThingSmartMatterSetupPayload *) checkMatterCodeInvalid: ("Will be removed in the)  future
(please use connectDeviceWithSetupPayload")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ commissionDevice:commissionModel: [1/2]

- (void) commissionDevice: (nonnull ThingSmartMatterDeviceModel *)  deviceModel
commissionModel: (ThingSmartMatterCommissionModel *)  commissionModel 

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 ThingSmartMatterCommissionModel and use this api after the - matterCommissioningSessionEstablishmentComplete:
    • Parameters:
      • deviceModel: the matter devicemodel.
      • commissionModel: commissionSetupModel

◆ commissionDevice:commissionModel: [2/2]

- (void) commissionDevice: (nonnull ThingSmartMatterDeviceModel *)  deviceModel
commissionModel: (ThingSmartMatterCommissionModel *)  commissionModel 

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 ThingSmartMatterCommissionModel and use this api after the - matterCommissioningSessionEstablishmentComplete:
    • Parameters:
      • deviceModel: the matter devicemodel.
      • commissionModel: commissionSetupModel

◆ connectDeviceWithConnectDeviceBuilder:timeout: [1/2]

- (void) connectDeviceWithConnectDeviceBuilder: (ThingSmartConnectDeviceBuilder *)  builder
timeout: (NSTimeInterval)  timeout 

Start connect the matter device.

  • Parameters:
    • payload: The matter setup model.
    • token: Thing activator token.
    • spaceId: The homeId

◆ connectDeviceWithConnectDeviceBuilder:timeout: [2/2]

- (void) connectDeviceWithConnectDeviceBuilder: (ThingSmartConnectDeviceBuilder *)  builder
timeout: (NSTimeInterval)  timeout 

Start connect the matter device.

  • Parameters:
    • payload: The matter setup model.
    • token: Thing activator token.
    • spaceId: The homeId

◆ continueCommissionDevice:WithSSID:password: [1/2]

- (void) continueCommissionDevice: (nonnull ThingSmartMatterDeviceModel *)  deviceModel
WithSSID: (nonnull NSString *)  ssid
password: ("Will be removed in the)  future
(please use commissionDevice:commissionModel:")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ continueCommissionDevice:WithSSID:password: [2/2]

- (void) continueCommissionDevice: (nonnull ThingSmartMatterDeviceModel *)  deviceModel
WithSSID: (nonnull NSString *)  ssid
password: ("Will be removed in the)  future
(please use commissionDevice:commissionModel:")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ 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:
    • device: It MUST BE the device object through the -matterDeviceAttestation:error: delegate callback.
    • ignoreAttestationFailure: Ignore the attestation fail or NOT. YES - continue pairing, NO - interrupt pairing.
    • error: the 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:
    • device: It MUST BE the device object through the -matterDeviceAttestation:error: delegate callback.
    • ignoreAttestationFailure: Ignore the attestation fail or NOT. YES - continue pairing, NO - interrupt pairing.
    • error: the error info.

◆ pairDeviceWithSetupPayload:toke:spaceId:timeout: [1/2]

- (void) pairDeviceWithSetupPayload: (ThingSmartMatterSetupPayload *)  payload
toke: (NSString *)  token
spaceId: (long long)  spaceId
timeout: ("Will be removed in the)  future
(please use connectDeviceWithSetupPayload")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ pairDeviceWithSetupPayload:toke:spaceId:timeout: [2/2]

- (void) pairDeviceWithSetupPayload: (ThingSmartMatterSetupPayload *)  payload
toke: (NSString *)  token
spaceId: (long long)  spaceId
timeout: ("Will be removed in the)  future
(please use connectDeviceWithSetupPayload")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ parseSetupCode: [1/2]

- (nullable ThingSmartMatterSetupPayload *) parseSetupCode: (NSString *)  matterCode

shareInstance

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

  • Parameter matterCode: The matter QRCode string or Manual Code string.

◆ parseSetupCode: [2/2]

- (nullable ThingSmartMatterSetupPayload *) parseSetupCode: (NSString *)  matterCode

shareInstance

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

  • Parameter matterCode: The matter QRCode string or Manual Code string.

◆ setGatewayDeviceBeforePairing: [1/2]

- (void) setGatewayDeviceBeforePairing: ("⚠️⚠️⚠️ This api causes issues. Will be removed in the)  future
(if you want set)  gwid
(please set in commissionDevice:commssionModel:")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ setGatewayDeviceBeforePairing: [2/2]

- (void) setGatewayDeviceBeforePairing: ("⚠️⚠️⚠️ This api causes issues. Will be removed in the)  future
(if you want set)  gwid
(please set in commissionDevice:commssionModel:")  __deprecated_msg 

Provided by category ThingSmartMatterActivator(Deprecated).

◆ startScanAvailableWIFI [1/2]

- (void) startScanAvailableWIFI

scan device acvailable wifi list.

◆ startScanAvailableWIFI [2/2]

- (void) startScanAvailableWIFI

scan device acvailable wifi list.

Property Documentation

◆ currentDeviceModel

- (ThingSmartMatterDeviceModel *) currentDeviceModel
readnonatomicstrong

Definition at line 80 of file ThingSmartMatterActivator.h.

◆ delegate

- (id< ThingSmartMatterActivatorDelegate >) delegate
readwritenonatomicweak

Definition at line 78 of file ThingSmartMatterActivator.h.

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