1. Wi-Fi Smart Lock Instructions

1.1. Term Explanation

1.2. Description

1.3. Lock Member Management

The door lock can be divided into family members and non-family members. Family members are Tuya home family members. For details, please refer to Family Management.

The following describes non-family member management operations in door locks

1.3.1. Get Lock Members

Declaration

- (void)getLockMemberListWithSuccess:(nullable void(^)(NSArray<TuyaSmartLockMemberModel *> *lockMemberModels))success
                             failure:(nullable TYFailureError)failure;

Parameters

TuyaSmartLockMemberModel

Example

Objc:

    TuyaSmartLockDevice *lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"];        
    [lock getLockMemberListWithSuccess:^(id result) {
        NSLog(@"result %@", result);
    } failure:^(NSError *error) {
        NSLog(@"error %@", error);
    }];

Swift:

    let lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")           
    lockDevice?.getLockMemberList(success: { (members) in
        print("result \(members)")
    }, failure: { (error) in
        if let e = error {
           print("error \(e)")
        }
    })

1.3.2. Create Lock Member

Create non-family members.

Declaration

- (void)addLockNormalUserWithUserName:(NSString *)userName
                          avatarImage:(nullable UIImage *)avatarImage
                      unlockRelations:(nullable NSArray<TuyaSmartLockRelationModel *> *)unlockRelations
                              success:(nullable TYSuccessString)success
                              failure:(nullable TYFailureError)failure;

Parameters

TuyaSmartLockRelationModel

typedef NS_ENUM(NSUInteger, TYLockUnlockType) {
    TYLockUnlockTypeFingerprint,
    TYLockUnlockTypePassword, 
    TYLockUnlockTypeTemporary,
    TYLockUnlockTypeDynamic,
    TYLockUnlockTypeCard,  
    TYLockUnlockTypeFace,  
    TYLockUnlockTypeKey, 
};

Example

Objc:

    TuyaSmartLockRelationModel *fingerModel = [[TuyaSmartLockRelationModel alloc] init];
    fingerModel.unlockType = TYLockUnlockTypeFingerprint;
    fingerModel.sn = 123;

    TuyaSmartLockRelationModel *faceModel = [[TuyaSmartLockRelationModel alloc] init];
    faceModel.unlockType = TYLockUnlockTypeFace;
    faceModel.sn = 23;

    // TuyaSmartLockDevice *lock
    self.lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"]; 
    [self.lock addLockNormalUserWithUserName:@"user name"
                                 avatarImage:[UIImage imageNamed:@"xxx.png"]
                                   unlockIds:@[fingerModel, faceModel]
                                     success:^(NSString *userId) {
        NSLog(@"result %@", userId);
    } failure:^(NSError *error) {
        NSLog(@"error %@", error);
    }];

Swift:

    let finger = TuyaSmartLockRelationModel()
    finger.unlockType = .fingerprint
    finger.sn = 123 

    let face = TuyaSmartLockRelationModel()
    face.unlockType = .face
    face.sn = 23
    self.lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")    
    self.lockDevice?.addLockNormalUser(withUserName: "user name", avatarImage: UIImage(named: "xxx.png"), unlockIds: [finger, face], success: { (userId) in
        print("add user success \(userId)")
    }, failure: { (error) in
        if let e = error {
            print("error \(e)")
        }
    })

1.3.3. Update Lock Member Information

Use SDK to update lock member information, including username, avatar, unlock password correspondence, etc.

Declaration

- (void)updateLockNormalUserWithUserId:(NSString *)userId
                              userName:(nullable NSString *)userName
                           avatarImage:(nullable UIImage *)avatarImage
                       unlockRelations:(nullable NSArray<TuyaSmartLockRelationModel *> *)unlockRelations
                               success:(nullable TYSuccessBOOL)success
                               failure:(nullable TYFailureError)failure;

Parameters

Example

Objc:

    TuyaSmartLockRelationModel *fingerModel = [[TuyaSmartLockRelationModel alloc] init];
    fingerModel.unlockType = TYLockUnlockTypeFingerprint;
    fingerModel.sn = 123;

    TuyaSmartLockRelationModel *faceModel = [[TuyaSmartLockRelationModel alloc] init];
    faceModel.unlockType = TYLockUnlockTypeFace;
    faceModel.sn = 23;

    // TuyaSmartLockDevice *lock
    self.lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"]; 
    [self.lock updateLockNormalUserWithUserId:@"user id" userName:@"" avatarImage:nil unlockRelations:@[fingerModel,faceModel] success:^(BOOL result) {
        NSLog(@"result %d", result);
    } failure:^(NSError *error) {
        NSLog(@"error %@", error);
    }];

Swift:

    let finger = TuyaSmartLockRelationModel()
    finger.unlockType = .fingerprint
    finger.sn = 123 

    let face = TuyaSmartLockRelationModel()
    face.unlockType = .face 
    face.sn = 23
    self.lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")  
    self.lockDevice?.updateLockNormalUser(withUserId: "user id", userName: "new user name", avatarImage: nil, unlockRelations: [finger, face], success: { (result) in
        print("result \(result)")
     }, failure: { (error) in
        if let e = error {
          print("error \(e)")
        }
     })

1.3.4. Delete Lock Member

Use the SDK to delete door lock member information. Deleting members does not delete existing passwords

Declaration

- (void)deleteLockUserWithUserId:(NSString *)userId
                         success:(nullable TYSuccessBOOL)success
                         failure:(nullable TYFailureError)failure;

Parameters

Example

Objc:

    TuyaSmartLockDevice *lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"]; 
    [lock deleteLockUserWithUserId:@"0000004zl1" success:^(BOOL result) {
         NSLog(@"delete result %d", result);
    } failure:^(NSError *error) {
         NSLog(@"error %@", error);
    }];

Swift:

    let lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")  
    lockDevice?.deleteLockUser(withUserId: "0000004zl1", success: { (result) in
        print("delete result \(result)")
    }, failure: { (error) in
        if let e = error {
            print("error \(e)")
        }
    })

1.4. Temporary Password

Use the SDK to create a temporary password and enter it on the door lock to unlock it.

title: Unlock with temporary password

participant lock
participant user
participant app
participant server

note over user: enter a 7-digit,\n numeric-only temporary password
app->server: create temporary password
server-->app: return result
user->lock: enter the password on the door lock, \nand the device trigger \nthe update of the password list
note over lock: update of the password list
user->lock: enter password 
note over lock: execute

1.4.1. Create Temporary Password

The temporary password can customize the validity period of the password. When the password is created, it needs to be synchronized on the door lock device.

Declaration

- (void)createLockTempPwd:(NSString *)password
                     name:(NSString *)name
            effectiveDate:(NSDate *)effectiveDate
              invalidDate:(NSDate *)invalidDate
              countryCode:(NSString *)countryCode
                    phone:(NSString *)phone
                  success:(nullable TYSuccessBOOL)success
                  failure:(nullable TYFailureError)failure;

Parameters

Example

Objc:

    TuyaSmartLockDevice *lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"];
    // 20 minute
    NSDate *invalidDate = [NSDate dateWithTimeInterval:60 * 20 sinceDate:[NSDate date]];
    [lock createLockTempPwd:@"1472589"
                       name:@"1472589hkk"
              effectiveDate:[NSDate date]
                invalidDate:invalidDate
                countryCode:@"86"
                      phone:@"13912345678"
                    success:^(BOOL result) {
        NSLog(@"result %d", result);
    } failure:^(NSError *error) {
        NSLog(@"error %@", error);
    }];

Swift:

    let lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")    
    lockDevice?.createLockTempPwd("1472589", name: "1472589hkk", effectiveDate: Date(), invalidDate: Date(timeIntervalSince1970: 60 * 20), countryCode: "86", phone: "13912345678", success: { (result) in
        print("result \(result)")
    }, failure: { (error) in
        if let e = error {
           print("error \(e)")
        }
    })

1.4.2. Get Temporary Password List

Use the SDK to get a list of temporary passwords, you can view the status of the use of temporary passwords

Declaration

- (void)getLockTempPwdListWithSuccess:(nullable void (^)( NSArray<TuyaSmartLockTempPwdModel *> *lockTempPwdModels))success
                              failure:(nullable TYFailureError)failure;

Parameters

TuyaSmartLockTempPwdModel

// password status
typedef NS_ENUM(NSUInteger, TYLockTempPwdStatusType) {
    TYLockTempPwdStatusTypeRemoved     = 0,
    TYLockTempPwdStatusTypeToBeDeleted = 3,

    TYLockTempPwdStatusTypeToBePubilsh = 1,
    TYLockTempPwdStatusTypePublished   = 2,
};

// password effective status
typedef NS_ENUM(NSUInteger, TYLockTempPwdEffectiveType) {
    TYLockMemberStatusTypeInvalid     = 1,
    TYLockMemberStatusTypeToBePubilsh = 2,
    TYLockMemberStatusTypeWorking     = 3,
    TYLockMemberStatusTypeToBeDeleted = 4,
    TYLockTempPwdEffectiveTypeExpired = 5,
};

Example

Objc:

    TuyaSmartLockDevice *lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"];
    [lock getLockTempPwdListWithSuccess:^(NSArray<TuyaSmartLockTempPwdModel *> * _Nullable lockTempPwdModels) {
         NSLog(@"result %@", lockTempPwdModels);
    } failure:^(NSError *error) {
         NSLog(@"error %@", error);
    }];

Swift:

    let lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")        
    lockDevice?.getLockTempPwdList(success: { (lockTempPwdModels) in
        print("result \(lockTempPwdModels)")
    }, failure: { (error) in
        if let e = error {
            print("error \(e)")
        }
    })

1.4.3. Delete Temporary Password

Use the SDK to delete the temporary password. After the deletion, the door lock device needs to be updated.

Declaration

- (void)deleteLockTempPwdWithPwdId:(NSInteger)tempPwdId
                             force:(BOOL)force
                           success:(nullable TYSuccessBOOL)success
                           failure:(nullable TYFailureError)failure;

Parameters

Example

Objc:

    TuyaSmartLockDevice *lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"];    
    [lock deleteLockTempPwdWithPwdId:1274067 force:YES success:^(BOOL result) {
        NSLog(@"delete result %d", result);
    } failure:^(NSError *error) {
        NSLog(@"error %@", error);
    }];

Swift:

    let lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")           
    lockDevice?.deleteLockTempPwd(withPwdId: 1274067, force: true, success: { (result) in
        print("delete result \(result)")
    }, failure: { (error) in
        if let e = error {
            print("error \(e)")
        }
    })

1.5. Dynamic Password

Use the SDK to get a dynamic password and enter it on the door lock to unlock. The dynamic password is valid for 5 minutes.

title: Unlock with dynamic password

participant lock
participant user
participant app
participant server

app->server: Request for dynamic password
server-->app: Returns dynamic password results
app-->user: Send password
note over user: Get dynamic password
user->lock: Input dynamic password
note over lock: Execute

1.5.1. Get Dynamic Password

Declaration

- (void)getLockDynamicPasswordWithSuccess:(nullable TYSuccessString)success
                                  failure:(nullable TYFailureError)failure;

Parameters

Example

Objc:

    TuyaSmartLockDevice *lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"];
    [lock getLockDynamicPasswordWithSuccess:^(NSString *result) {
        NSLog(@"Dynamic password acquisition results %@", result);
    } failure:^(NSError *error) {
        NSLog(@"error %@", error);
    }];

Swift:

    let lockDevice = TuyaSmartLockDevice(deviceId: "your_lock_device_id")
    lockDevice?.getLockDynamicPassword(success: { (pwd) in
        print("Dynamic password acquisition results \(pwd)")
    }, failure: { (error) in
        if let e = error {
            print("error \(e)")
        }
    })

1.6. Open the Lock Remotely

After triggering a remote door open request on the door lock, you can use the SDK to remotely open the door

Title: Remote Open

participant User
participant Lock
participant app

User->Lock: operate lock (4+#)
Lock->app: send open request
note over app: receive open request
app-->Lock: send open result
note over Lock: handle result

Declaration

- (void)replyRemoteUnlock:(BOOL)open
                  success:(nullable TYSuccessHandler)success
                  failure:(nullable TYFailureError)failure;

Parameters

TuyaSmartLockDeviceDelegate

After set TuyaSmartLockDevice delegate ，When the user operates the door lock for remote unlocking, the SDK will trigger the following callback method

- (void)device:(TuyaSmartLockDevice *)device didReceiveRemoteUnlockRequest:(NSInteger)seconds;

Example

Objc:

    // 4+#
    // TuyaSmartLockDevice *lock;
    self.lock = [TuyaSmartLockDevice deviceWithDeviceId:@"your_lock_device_id"];
    self.lock.delegate = self;

    - (void)device:(TuyaSmartLockDevice *)device didReceiveRemoteUnlockRequest:(NSInteger)seconds {
        NSLog(@"receive unlock request, last second %d", seconds);

        // second = 0，did reply
        if (seconds > 0) {
            BOOL open = YES;
            // execute reply remote
            [device replyRemoteUnlock:open success:^{
                NSLog(@"success");
            } failure:^(NSError *error) {
                NSLog(@"error %@", error);
            }];
        }
    }

Swift:

    // 4+#
    // var lock: TuyaSmartLockDevice
    self.lock = TuyaSmartLockDevice(deviceId: "your_lock_device_id")
    self.lock.delegate = self;

    func device(_ device: TuyaSmartLockDevice, didReceiveRemoteUnlockRequest seconds: Int) {
        print("receive unlock request, last second \(seconds) ";
        if seconds > 0 {
            let open = true; 
            // execute reply remote
            device.replyRemoteUnlock(open, success: {
                print("success")
            }) { (error) in
                if let e = error {
                    print("error: \(e)")
                }
            }
        }      
    }

1.7. Lock Record

Use SDK to obtain door lock records, including unlock records, doorbell records, alarm records, etc.

1.7.1. Get Lock Records

Declaration

- (void)getLockRecordListWithDpCodes:(NSArray<NSString *> *)dpCodes
                              offset:(NSInteger)offset
                               limit:(NSInteger)limit
                             success:(nullable void(^)(NSArray<TuyaSmartLockRecordModel *> *lockRecordModels))success
                             failure:(nullable TYFailureError)failure;

Parameters

TuyaSmartLockRecordModel

1.7.2. Get Door Lock Unlock Records

Use SDK to obtain door lock records, including unlock records, doorbell records, alarm records, etc.

Declaration

- (void)getUnlockRecordList:(NSInteger)offset
                      limit:(NSInteger)limit
                    success:(nullable void(^)(NSArray<TuyaSmartLockRecordModel *> *lockRecordModels))success
                    failure:(nullable TYFailureError)failure

Parameters

1.7.3. Get Lock Hijacking Record

Use the SDK to obtain the door lock hijacking record. You can query it based on the unlocking function definition point.

Declaration

- (void)getLockHijackRecordListWithDpCodes:(NSArray<NSString *> *)dpCodes
                                    offset:(NSInteger)offset
                                     limit:(NSInteger)limit
                                   success:(void(^)(NSArray<TuyaSmartLockRecordModel *> *))success
                                   failure:(nullable TYFailureError)failure;

Parameters

1.8. Wi-Fi Door Lock Function Points