Overview
This topic describes the data points (DPs) that can be implemented for the business locks.
Admin password management
Admin password management
Raw data type
Raw data: operation type + member type + password number + password length + password content
- Issue: Operation type + member type + password number + password length + password content
- Change/reset: Change + member type + password number + password length + password content
- Disable/enable: disabling + member type + password number
Data reporting:
- Change/reset + member type + password number + password length + password content
- Disable/enable + member type + password number + status
Implementation for the MCU:
- Level: The business lock user level is divided into three parts: admin, sub-admin, and tenant.
- Password number: The admin and sub-admin can be assigned to one user respectively.
01
indicates the admin and 02
indicates the sub-admin. The tenants can be assigned to N (≥100) users. Number of cards + number of passwords + number of fingerprints ≥ 100. The number of any single unlocking method ≤ 0.8N. N represents the total number of tenant users.
- Role permissions: The role of the upper level can create, delete, disable, enable, and reset the password assigned to the role of the lower level. Tenant users can only change their own passwords.
- Password digits: The admin and sub-admin passwords are 8 digits, which default to
66668888
and 12345678
respectively.
- Logic: The MCU parses the received DP and determines the member type and password number to execute the command accordingly. Then, it returns the operation result to the module.
- Only a successful operation can return the password content.
Tenant password
Create temporary passwords
Raw data type
DP structure:
Tuya serial number+Server serial number+Lock manufacturer ID+Start time+End time+Whether a one-time password is used+Password.
- Tuya serial number: Data[0] to Data[1]
- Server serial number: Data[2] to Data [3]
- Lock manufacturer ID: Data[4] to Data [5], defaulting to
0x0
and 0x0
- Start time: Data[6] to Data[9], standard timestamp
- End time: Data[10] to Data[13], standard timestamp
- Whether a one-time password is used: Data[14],
1
: one-time password. 0
: not one-time password
- Password: Data[15] to Data[20], 6-digit password in ASCII.
Implementation for the MCU:
- Logic: The MCU parses the received DP and takes the manufacturer ID as the password No. by default. It gets the time and password content and then creates a new password in the database. If the password is repeated or full, the corresponding status value will be returned.
- The server sends a password number, the Tuya serial number starts from 999 and decreases to 1. The manufacturer uses the manufacturer ID to store the password. The unlocking record is reported by the manufacturer ID.
- The newly created password (the Tuya serial number) starts from 999 and decreases to 1. The manufacturer ID defaults to 0. ![
DP 3: Delete temporary password
Raw data type
Report: Tuya serial number+Server serial number+Lock manufacturer ID. Content analysis: a) Tuya serial number: Data[0] and Data[1]. b) Server serial number: Data[2] and Data[3]. c) Lock manufacturer ID: Data[4] and Data [5.]
The server sends: Tuya serial number+Server serial number+Lock manufacturer ID+return status
Tuya serial number: Data[0] to Data [1]
Server serial number: Data[2] to Data [3]
Lock manufacturer ID: Data[4] to Data [5]
Return status: Data[6]
Implementation for the MCU:
Logic: The MCU parses the received DP and takes the manufacturer ID as the password No. by default. It gets the password and then deletes it. If the password does not exist, the MCU reports this DP and returns a failure. Otherwise, the deletion succeeds.
The manufacturer uses the manufacturer ID to delete a specific password.
Change temporary password
Raw data type
The format is the same as that used for creating temporary passwords.
Implementation for the MCU:
Logic: The MCU parses the received DP and takes the manufacturer ID as the password No. by default. It gets the time and password content by serial number and then overwrites the current valid time and password with the new data. If the password is repeated, the corresponding status value will be returned.
Disable and enable temporary password
Implementation for the MCU:
Logic: The MCU parses the received DP and takes the manufacturer ID as the password No. by default. It gets the password and then disables it. If the password does not exist, the MCU reports this DP and returns a failure. Otherwise, disabling the password succeeds.
Delete all temporary password
Implementation for the MCU:
When users use the app to restore the factory settings of the lock, the cloud sends a command to the lock to clear local temporary passwords.
If factory settings are restored and local temporary passwords are cleared, this DP is reported. This ensures that the temporary password records stored in the cloud are consistent with these stored locally.
If the lock failed to report DP 7 when factory settings are restored, DP 7 must be reported after the next pairing operation.
Offline password T0 time
The module proactively reports this DP to the server when it is connected or reconnected to the internet, or powered on.
The cloud will send a command on receiving the message from the module.
Implementation for the module is required. The MCU is not involved.
Report unlocking records
Implementation for the MCU:
Unlock with tenant password: The MCU determines the password number based on the password value. If the door is unlocked, it reports DP 13 with the password number. The password number is the manufacturer ID.
Unlock with dynamic password
- The dynamic password is 8 digits. If the MCU determines that the 8-digit password is not an admin or sub-admin password, it sends the password to the module. The module returns the verification result. If the door is unlocked successfully, the MCU reports the DP 16 to the module.
- The dynamic cryptographic algorithm is time-dependent.
Unlock with offline password
The dynamic password is 10 digits. The MCU sends the input password to the module. The module determines this is an offline password and returns the verification result. If the door is unlocked successfully, the MCU reports the DP 17 to the module. The length of raw data is 16 bytes.
Clear all offline password report
- The clear code is 10 digits. The MCU will report the received clear code to the module. The module determines whether this code is used to clear all offline passwords.
- The module returns the verification result to the MCU. The lock outputs a voice broadcast like ‘successful operation’.
- Report DP 18 to the server.
- The length of raw data is 16 bytes.
Unlock with card or fingerprint
Unknown unlocking attempts
- Definition: The door is detected to be opened without any authorized unlocking methods.
- Types:
- Unlock with mechanical keys.
- Unlock from the inside.
- Illegal unlocking. If the MCU detects that the lock cylinder is opened from the outside with no password input, it will report such an event to the module.
Alerts
Implementation for the MCU:
- If unlocking attempts fail five times, the MCU will report an alert to the module.
- If the door is not closed after a 10s timeout, the MCU will report an alert to the module.
- When the battery capacity is almost exhausted and the battery level is less than a preset value, the MCU will report an alert to the module before shut down.
The MCU can report the following parameters:
- 0x00: fingerprint attempt failed
- 0x01: password attempt failed
- 0x02: card attempt failed
- 0x03: face recognition failed
- 0x04: false lock
- 0x05: high temperature
- 0x06: door is not closed after timeout
- 0x07: lock tongue does not pop out
- 0x08: anti-pry alert
- 0x09: key insertion
- 0x0A: low power alert
- 0x0B: out of battery alert
- 0x0C: vibration alert
Local password changed report
Implementation for the MCU:
- Each time a lock is paired again, the MCU must report the default password of the admin and the sub-admin to the module through DP 24. The downlink data transmission is encrypted.
- This function is determined by the MCU, optional for the local operation.
- The new tenant is authorized for N days. N defaults to seven days. If a tenant is added locally, the MCU must report this event to the module. The manufacturer ID is used as the password number. The server will save the manufacturer ID.
Reset the lock
Implementation for the MCU:
- If a lock is physically reset to factory settings, the MCU must report DP 25 to the module. If reporting failed, it must report again after it is connected to the server. The server will clear all the authorized unlocking methods and records and reset the password of the admin and sub-admin to defaults.
- If a lock is reset by using the mobile app, the server will clear all the unlocking methods and records and send the DP 25 after the lock is paired again. The lock will clear all the authorized unlocking methods and reset the password of the admin and sub-admin to defaults.
Report lock status
Anti lock state:
The MCU reports record type data to carry the unlocking time. The admin can unlock a door in anti-lock state.
Lock settings
Language setting:
- 0=Chinese Simplified
- 1=English
- 2=Japanese
- 3=German
- 4=Spanish
- 5=Latin
- 6=French
- 7=Russian
- 8=Italian
- 9=Chinese Traditional
- 10=Korean
No value is returned if the operation failed. Specified values are returned if the operation succeeds.
Volume setting:
- 0x00: mute
- 0x01: low volume
- 0x02: medium volume
- 0x03: high volume
No value is returned if the operation failed. Specified values are returned if the operation succeeds.
Get lock status
Implementation for the MCU:
The enum data type. 1=Get battery level. 2=Get the inside double locking status. 3=Get door sensor status. 4=Get the deadbolt status. 0=Get all types of status. The server sends the specific enum value. The device reports the corresponding DPs. For example, if the server sends 1
, 2
, 3
, and 4
, the lock will report DP 26, DP 28, DP 27, and DP 29 respectively. If the server sends 0
, the lock reports DP 26, DP 28, DP 27, and DP 29 together.
Additional states and settings
In-house too long (DP 34):
This DP is implemented by the server.
To implement this feature, the MCU must enable the following two DPs:
- DP 21: Open the door from inside
- DP 35: Door opened
You set the threshold for the in-door duration to 72 hours.
User cards
Remotely send card or ID information to the lock: The SaaS application can send 8 to 16 digits encrypted data to the lock.
- DPs: remotely create, delete, update, disable, and enable user cards.
- DPs: remotely disable, and enable user cards.
Unlock by identity card
The MCU reports unlocking with ID card and card by using different DPs.
Delete single offline password
Send fingerprints
Remotely send fingerprints to the lock: The SaaS application can send encrypted fingerprint data to the lock.
For more information, see MCU Integration Protocol for Zigbee Lock.
- DPs: remotely add, delete, update, disable, and enable a fingerprint.
- DPs: remotely disable and enable a fingerprint.