Skip to main content

ApartmentLock

1.ApartmentLock.getState

Get Current ApartmentLock State

BDDP

ParamValueDesc
methodApartmentLock.getStateGet Current State
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
token<String,Necessary>Net token of the ApartmentLock you use;

BUDP

ParamValueDesc
data.state<String,Necessary>Current lock state;"Locked"
data.battery<String,Necessary>The battery of the lock;Voltage now;will change to per later

2.ApartmentLock.lock

Lock ApartmentLock

BDDP

ParamValueDesc
methodApartmentLock.lockLock ApartmentLock
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
token<String,Necessary>Net token of the ApartmentLock you use;

BUDP

ParamValueDesc
data.state<String,Necessary>Current lock state;"Locked"
data.battery<String,Necessary>The battery of the lock;Voltage now;will change to per later

3.ApartmentLock.unlock

UnLock ApartmentLock

BDDP

ParamValueDesc
methodApartmentLock.closeUnLock ApartmentLock
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
token<String,Necessary>Net token of the ApartmentLock you use;

BUDP

ParamValueDesc
data.state<String,Necessary>Current lock state;"Locked"
data.battery<String,Necessary>The battery of the lock;Voltage now;will change to per later

4.ApartmentLock.addPwd

Add password to ApartmentLock

BDDP

ParamValueDesc
methodApartmentLock.addPwdAdd password to ApartmentLock
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
params.password<String,Necessary>Password,6-8 Number;
params.expires<Integer,Optional>Expire time,the unit is hour,null means forever,default null;
params.enable<Boolean,Optional>Is this password enable,default true;

BUDP

ParamValueDesc
state<String,Necessary>result,"SetSuccess"

5.ApartmentLock.updatePwd

Update password

BDDP

ParamValueDesc
methodApartmentLock.updatePwdUpdate Password
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
params.oldPwd<String,Necessary>The old password you want to update
params.newPwd<String,Optional>The new password,6-8 Number;Not update when null
params.expires<Integer,Optional>Expire time,the unit is hour,null means forever,default null;
params.enable<Boolean,Optional>Is this password enable,default true;

BUDP

ParamValueDesc
state<String,Necessary>result,"SetSuccess"

6.ApartmentLock.getTemporaryPassword

Get Temporary Password

BDDP

ParamValueDesc
methodApartmentLock.getTemporaryPasswordGet Temporary Password
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
params.expires<Integer,Necessary>Expire time,the unit is hour,between 0 and 24*7;

BUDP

ParamValueDesc
data.password<String,Necessary>The Temporary Password
data.expires<Integer,Necessary>The Expire Time

7.ApartmentLock.updateSuperPwd

Update Super Password

BDDP

ParamValueDesc
methodApartmentLock.updateSuperPwdUpdate Super Password
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
params.password<String,Necessary>The new super password,6-8 Number;

BUDP

ParamValueDesc
state<String,Necessary>result,"SetSuccess"

8.ApartmentLock.delPwd

Delete User Password

BDDP

ParamValueDesc
methodApartmentLock.delPwdDelete Apartment Lock's password
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;
params.password<String,Necessary>The password you want to update;

BUDP

ParamValueDesc
state<String,Necessary>result,"SetSuccess"

9.ApartmentLock.clearPwd

Clear User Password

BDDP

ParamValueDesc
methodApartmentLock.clearPwdClear Apartment Lock's password
targetDevice<String,Necessary>DeviceId of the ApartmentLock you use;

BUDP

ParamValueDesc
state<String,Necessary>result,"SetSuccess"

10.Callbacks

ParamValueDesc
data.state<String,Necessary>result,"Locked"
data.battery<String,Necessary>The battery of the lock;Voltage now;