Zigbee Lock

Universal Docking Agreement

1. *Introduction*

The Tuya Zigbee serial port general protocol is a Tuya customorize Zigbee module serial port general protocol, which is mainly used for Tuya Zigbee module, it directly connected to other MCU serial ports for serial communication. Its block diagram is shown in Figure 1 below.

1.1 *Hardware connection*

The Tuya Zigbee module and MCU control both use DC 3.3V power supply.

The baud rate of UART communication between Tuya Zigbee module and MCU is 115200-8-N-1, and there is no data flow control. The UART interface pins use the standard logic. In the idle state, the TXD and RXD pins are both high level, the low level is the start bit and the high level is the stop bit. The pin stays high even even the device in hibernation.

There is a GPIO port reserved between the Tuya Zigbee module and the MCU, use as the module to wake up the MCU. The default setting is the internal pull-up state, which is effective when pulled down to 10ms. The MCU wakes up the Zigbee module by waking up the serial command. If the device is a strong current device, the MCU only needs to make a handshake connection when the device is powered on for the first time. If the device is a weak current device with dormant, apart from making a handshake connection when power on, the MCU needs to connect to the handshake connection before each active command is initiated.

*1.2 Timeout definition*

1.2.1 *Synchronization Timeout*

UART respond timeout time：500ms.

When the serial port of the module receives the wake-up frame of the MCU or the response frame of the wake-up frame, it will wake itself up for 500ms. At this time, the MCU can send other data. If the data interval between the two frames is 500ms, a wake-up frame needs to be added in the middle.

1.2.2 *Wake-up frame response timeout time*

After the module sends the wake-up frame, the MCU needs to respond within 20ms, otherwise the module will continue to resend it, twice each time. When the response frame of MCU is not received after 3 transmissions, the data to be transmitted will be stored in the transmission queue, and wait for the next wake up to send again.

2. *Serial port communication*

2.1 *Frame format*

The UART communication data frame between the Tuya Zigbee module and the MCU consists of the frame header (Front), version (Ver), serial number (Seq), command word (Cmd), data length (Length), data (Data) and checksum (Check) composition, definition and description are shown below. 2

2.2 *Frame format description*

Sheet 1：Frame format description

Note: The serial number (seq) is to check each frame. It is not necessary to use the same one. The range of seq is limited to (1 ~ 0xfff0). When the MCU needs to respond to the data sent by the module, the seq in the response frame uses the seq issued by the module. When the MCU needs to send data to the module actively, each time the data is issued, the seq needs to be incremented within the specified range.

Sheet 2：Cmd description sheet

Description：

1. All data larger than 1 byte is transmitted in big-endian mode

2. In general, the command word one send and one receive synchronization mechanism is adopted, that is, one party sends a command and the other responds. If the sender does not receive the correct response packet after timeout, the transmission timeout

Note: The specific communication method is subject to the “detailed protocol”

1. The module control command is issued and the MCU status is reported in asynchronous mode. Assuming that the module control command is issued with the "command word" as x and the MCU status is reported with the "command word" as y, as shown below:

1) Module control command is issued:

2) MCU status report:

MCU status reporting is divided into two cases: passive reporting and active reporting;

I. Passive reporting: The module sends a data command to the MCU. The MCU responds to the control command first, and then executes the command. The MCU reports the final result to the module. After receiving the module, it sends a response and the data exchange ends.

II. Proactive reporting: MCU status changes (physical operation or restart after power cut, etc.), reporting the current status to the module actively; MCU actively reporting as asynchronous operation, there is no status report response frame received within the timeout period, or the status of the response frame is unsuccessful, MCU must retransmit.

*2.3 datapoint Data unit format*

1) datapoint The command / status data unit is as follows:

2) Except for the "raw" type, the datapoint command / status data unit all belongs to the "obj" type datapoint.

3) The "command issuance" may include multiple datapoint "command data units".

4) "Command issuance" is an asynchronous processing protocol, corresponding to the "status report" of the MCU's datapoint.

3. *Protocol details*

3.1 *Wake up command*

Description：

Zigbee wakes MCU or MCU wakes zigbee with this command

This command will be resent 3 times until a response package is received. After being awakened, it will start to accept data. The maximum time for accepting is one second, and it will go sleep mode after more than 1 second.

This instruction is preceded by 7 BYTE preambles.

Module transmission：

MCU return：

Note: When the module actively wakes up the MCU, the serial number is fixed at 55 AA, and the ACK number returned by the MCU is also 55 AA;

When the MCU actively wakes up the module, the serial number is fixed at 00 00, and the module's ACK serial number returned by the MCU is also 00 00;

example:

1、Module wake up MCU：

Note: When the module actively wakes up the MCU, the serial number is fixed at 55 AA, and the ACK number returned by the MCU is also 55 AA;

When the MCU actively wakes up the module, the serial number is fixed at 00 00, and the module's ACK serial number returned by the MCU is also 00 00;

example:

1. The module wakes up the MCU:

Module send：

0x00 00 00 00 00 00 00 55 AA 03 55 AA 00 00 00 01

Leading code frame head version Seq command word data length checksum

MCU reply：

0x55 AA 03 55 AA 00 00 00 01

frame head version Seq command word data length checksum

2、MCU wake up module：

MCU send：

0x00 00 00 00 00 00 00 55 AA 03 00 00 00 00 00 02

Leading code frame head version Seq command word data length checksum

Module reply：

0x55 AA 03 00 00 00 00 00 02

frame head version Seq command word data length checksum

3.2 *Check product info*

Explanation:

1) product ID: Corresponds to the Tuya Developer Platform PID (Product Identification), which is generated by the Tuya Cloud Developer Platform and is used to record product related information in the cloud.

2) Product information consists of product ID and MCU software version.

3) MCU software version number format definition: in dotted decimal form, "x.x.x" (0 <= x <= 99), x is a decimal number.

Module send：

Example：0x55 AA 03 33 77 01 00 00 AD

Frame head *version Seq command word data length check sum*

MCU return：

Example：0x55 AA 03 33 77 01 00 1C 7B 22 70 22 3A 22 38 73 34 75 71 75 79 78 22 2C

Frame head *version Seq command word data length { " p " : " 8 s 4 u q u y x " ,*

22 76 22 3A 22 31 2E 30 2E 30 22 7D 01 7F

*" v " : " 1 . 0 . 0 " } check sum*

P means product ID is 8s4uquyx

V means MCUversion is 1.0.0

Support OTA

3.3 *Check the module network status*

​ Picture 4 module status sheet（8421）

explanation：

1) The device is not connected to the network: When the device is powered on for the first time, or fails to connect to the network, or is disconnected from the network, the device status is not connected to the network, this status will send to MCU.

2) The device is in the networked status: After the device is successfully connected to the network, the device is in the networked status; the status is sent to the MCU.

3) When the module detects the process of MCU restart or MCU disconnect then online again, it will actively send the module network status to the MCU.

4) When the network status of the module changes, it will actively send the network status of the module to the MCU.

MCU sends

example： 0x55 AA 03 00 00 02 00 00 04

​ Frame head *version Seq command word data length check sum*

Module return：

例：0x55 AA 03 00 00 02 00 01 03 08

Frame head *version Seq command word data length data check sum*

3.4 *Configure Zigbee module*

Description：

1) If the device is a low-voltage device, the MCU needs to send a wake-up command to the module first, and then send a configuration command to the module; a strong-power device directly sends a configuration command to the module.

a. There are two types of commands for configuring the Zigbee module, as shown in the figure below.

MCU send：

Example：0x55 AA 03 00 00 03 00 01 01 07

​ Frame head *version Seq command word data length data check sum*

Module return：

example：0x55 AA 03 00 00 03 00 01 00 06

Frame head *version Seq command word data length data check sum*

*3.5 Data Command issued*

Module send：

example：“doorbell select”，

0x55 AA 03 00 1C 04 00 05 0E 04 00 01 00 3A

Frame head *version Seq command word data length dpID dp type data length data check sum*

mcu返回：

例：0x55 AA 03 00 1C 04 00 01 00 23

Frame head *version Seq command word data length data check sum*

*3.6 MCU data reported*

Explanation：

1) After the MCU receives the 04 command, it must reply the 04 command immediately, and the reply is receivingcorrect or failed;

2) After receiving the 04 instruction successfully, the MCU will process the 04 instruction and send the processed result to the module through the 05 instruction, and inform the module of the 04 instruction execution status;

3) The module will immediately return ACK to the MCU after receiving the datapoint information of the 05 instruction;

4) Multiple datapoint "command data units" may be included. For details of the datapoint status data unit, see "Section 2.3", but the data frame length cannot exceed 64 bytes.

MCU send：

Example：“doorbell ring”，

0x55 AA 03 00 00 05 00 05 0E 01 00 01 01 1D

*Frame head version Seq command word data length dpID dp type data length data check sum*

Module return：

Example：0x55 AA 03 00 00 05 00 01 10 18

Frame head *version Seq command word data length data check sum*

*3.7 Zigbee notice*

Note: zigbee asynchronous notification or network status change notification

Module sends：

Example：“network status”effects：

0x55 AA 03 00 77 06 00 01 05 85

Frame head *version Seq command word data length data check sum*

MCU returns：

Example：“network status”respnse：

0x55 AA 03 00 77 06 00 01 10 90

Frame head *version Seq command word data length data check sum*

*3.8 Requesting a Dynamic Password*

Note: (1) The time data in the protocol is used to calculate the current dynamic password. The dynamic password calculation time here is the current Green Time. The device needs to give the module Green Time data.

(2)On the APP side, you can set a mixed calculation whether the device currently needs to add the administrator password to the participate dynamic passwords. Every time the device requests to verify the dynamic password again, it needs to lock all the current door of the module. Administrator password.

(3) The data length of the sending package is at least 15 bytes, time data + password + the number of administrator password groups transmitted (not including the optional administrator password).

MCU sends：

Example：

55 AA 03 00 00 07 00 1D 5B BC 3A 41 33 37 32 32 34 32 30 31 02 Frame head *version Seq command word data length time stamp active password Administrator password numbers*

06 30 31 32 33 34 35 08

*First set of password length The first administrator password Second set of password length* 31 32 33 34 35 36 37 38 30

*The second set of administrator passwords check sum*

Module return：

Example：55 AA 03 00 00 07 00 01 00 0A

Frame head *version Seq command word data length data check sum*

*3.9 Zigbee module functional test*

Note: The RF test method of the module is performed by loopback test between DUT (equipment under test) and GU (golden unit). That is, the DUT sends packets, and the GU sends the packets to DUT. Perform statistics and report the results to the MCU through the serial port. Round trip time interval is 3S.

1) Send the production test command within 300ms after power on.

MCU send：

Example：0x00 00 00 00 00 00 00 55 AA 03 00 00 09 00 01 19 25

Preamble Frame head *version Seq command word data length data check sum*

Module return：

Example：0x55 AA 03 00 00 09 00 02 01 3C 4A

Frame head *version Seq command word data length data check sum*

Note:****：support firmware version：1.0.4****

*3.10* *MCU* *OTA*

The MCU ota process is as follow:

**MCU version check**

If MCU upgrade is supported, this command must be implemented, and the MCU can also report actively;

Query scenarios: 1. During network distribution 2. When the MCU upgrade process is abnormal;

Proactive reporting scenarios: 1. After network pairing successful (must be added) 2. Upgrade finished;

Module send：

Example：0x55 AA 03 00 f0 0A 00 00 26

Frame head *version Seq command word data length check sum*

MCU response or module send：

*3.11 OTA update notice*

Module send

Example：0x55 AA 03 00 1C 0B 00 0F 30 31 32 33 34 35 36 37 41

Frame head *version Seq command word data length PID V*

MCU corresponding：

Example：0x55 AA 03 00 1C 0B 00 01 00 23

Frame head *version Seq command word data length data check sum*

*3.12 OTA firmware content requests*

MCU send：

Example：0x55 AA 03 00 f0 0C 00 06 26

Frame head *version Seq command word data length checksum*

Module corresponding：

Example：

55 AA 03 00 39 24 00 08 00 00 0D 2B 00 00 7D AB C7

Frame head *version Seq command word data length standard time* *local time check sum*

*3.13 OTA firmware upgrade result report*

Note: This result is reported after the MCU upgrade is completed; no matter whether the MCU upgrade is successful or failed, as long as the upgrade action is initiated, the upgrade process must be terminated through the result report command;

MCU sends：

Example：

0x55 AA 03 00 f0 0C 00 06 26

Frame head *version Seq command word data length checksum*

Module corresponding：

Example：0x55 AA 03 00 1C 0D 00 01 00 23

​ Frame head *version Seq command word data length data checksum*

*3.14 Data format for record-type status reporting (including time stamp)*

Explanation:

1) When the MCU data changes , such as various door opening actions, various alarm information, local password changes, etc., which involves the local operation of the door lock, the door lock MCU needs to use this command to send the corresponding DP data to the module;

2) When reporting the frame data, the frame needs to carry a time stamp. If the MCU has time data locally, the time stamp needs to be included in the data;

3) Multiple datapoint "command data units" can be included. For details of the datapoint status data unit, see "Section 2.3", but the data frame length cannot exceed 64 bytes.

MCUsend：

Example：“Fingerprint unlock”：

0x55 AA 03 00 00 23 00 0D 01 5B F6 67 B1 01 02

Frame head *version Seq command word data length MCU time time stamp dpID dp type*

00 04 00 00 00 0B AE

*data length data checksum*

“Password + fingerprint combination unlock”：

0x55 AA 03 00 00 23 00 15 00 5B F6 67 B1 02

Frame head *version Seq command word data length gateway time time stamp dpID(password)*

02 00 04 00 00 00 01 01 02 00 04 00 00 00 05 B8

*Dp type data length data dpID(pingerprint) dp type data length data checksum*

Data return：