Firmware Flashing and Authorization

Last Updated on : 2024-06-26 05:41:09download

After you complete the development with Tuya Zigbee SDK, you need to flash the compiled binary file and the license to the chip so that your network module can be connected to the Tuya Developer Platform and communicate with the cloud. This topic describes two approaches to flashing and authorization.

Flashing and authorization

Flashing and authorization combined

You use Tuya’s host that is integrated with the flashing tool to write firmware and license to the chip.

Before having your chip flashed, you need to upload the compiled binary file to the Tuya Developer Platform according to the requirements and get the license.

Flashing and authorization separated

You do not use Tuya’s host, or you only use Tuya’s host to flash license for authorization and use a third-party flashing software to write binary files to the chip.

This approach applies to two situations in terms of writing license.

  • Write the license using Tuya’s host: Tuya provides the license and you enter it on Tuya’s host. The license is written to the chip through serial communication.
  • Write the license without using Tuya’s host: Tuya provides a license list in a spreadsheet. You need to parse and write the license to the chip.

Get the license

You will get binary files after compilation, as shown below.

Firmware Flashing and Authorization

The bin files with the suffix QIO and OTA are used for production and OTA updates respectively.

Filename Description
sample_smart_plug_1_QIO_1.0.0.s37 It is used for production and applies to modules that run the flash memory in QIO (Quad I/O) mode.
sample_smart_plug_1_OTA_1.0.0.bin It is used for configuring OTA firmware updates on the Tuya Developer Platform.

The following procedure describes how to get upload firmware to the Tuya Developer Platform and get the license.

  1. Log in to the Tuya Developer Platform and create a product.

  2. In the third step of Hardware Development, select Tuya Standard Module SDK and click Add custom firmware.

    Firmware Flashing and Authorization

  3. Complete the required information and click Upload Firmware. The Firmware Identifier must be consistent with the file name of the firmware to be uploaded.
    Firmware Flashing and Authorization

  4. Upload your compiled binary file in the corresponding field and click Save.

    Firmware Flashing and Authorization
  5. Enable the firmware.

    Firmware Flashing and Authorization

    After the above steps are successfully completed, your screen will look like this.

    Firmware Flashing and Authorization

Now, you can request the license. Tuya provides the license in three modes.

Firmware Flashing and Authorization

The Zigbee SDK does not support license list.

License name Applicable solution Description
Production certificate Flashing and authorization combined Production certificate is the delivery mode for the combined firmware flashing and authorization solution. Tuya flashes the encrypted license to the chip using its proprietary host. The information of the firmware key will be verified to avoid writing any incorrect firmware information. This solution is recommended, but note that it supports Tuya standard chips only.
Production Certificate - Authorization Only Flashing and authorization separated Production certificate - authorization only is the delivery mode for the independent firmware flashing and authorization solution. Tuya flashes the encrypted license to the chip using its proprietary host. The information of the firmware key will not be verified. This solution applies to authorizing non-Tuya standard chips.
License list Not recommended. If you want to use it, file a service ticket to consult technical support. License list provides the plaintext of the license, which is not recommended. You must develop a host to flash the license to your chip.

Get the flashing tool

With production certificate

  1. Log in to the PMS.

  2. Click Knowledge Base Management > Software Download. Find and download the Cloud Module Burning Authorization Platform.

    Firmware Flashing and Authorization

With production certificate (authorization only)

  • In debugging, install the independent authorization tool to write the license to your module.
  • In production, download and install the Cloud Module Burning Authorization Platform. You can get the tool the same way as the process with production certificate.

With license list

Tuya provides the license in plain text and you need to develop a tool and write the license to your module.

Procedure

The following table lists adapted chips and documentation regarding flashing and authorization.

Chipset platform Flashing and authorization
EFR32MG21A020 Flash Firmware to and Authorize ZS and TYZS Modules
EFR32MG13P732 Flash Firmware to and Authorize ZS and TYZS Modules