Skip to main content

Firmware Upgrade

This guide explains how to perform a remote OTA update for custom firmware on the Tuya IoT Platform. The process follows seven steps: create firmware key → write key into firmware → upload a new version → publish → configure upgrade rule → verify → release.

Prerequisites​

  • A product created on the Tuya IoT Platform with a PID.
  • Device connected to Tuya Cloud (UUID / AuthKey configured).

Step 1: Create a Firmware Key​

A firmware key uniquely identifies a firmware on the platform. A single product (PID) can have multiple firmware keys, each corresponding to a different hardware variant or firmware branch.

  1. Log in to the Tuya IoT Platform and go to your product's Product Development > Hardware Development page.
  2. Select the cloud connection type and hardware module.

Select cloud connection type and hardware module
Select cloud connection type and hardware module

  • Cloud connection type: Select TuyaOS or TuyaOS AI.
  • Hardware module: If you are using a Tuya module, select the corresponding module solution from the hardware list. If you are using a custom module, this field can be left unselected.

  1. Click Add Custom Firmware.

    • If you selected a Tuya module, click Add Custom Firmware in the row of the selected module solution.
    • If you are using a custom module, click Add Custom Firmware in the custom firmware row.

  2. Fill in the firmware basic information and click Confirm. The platform generates a firmware key.

Fill in firmware information to generate firmware key
Fill in firmware information to generate firmware key

  • Firmware name: Can be customized.
  • Firmware type: Select Module Firmware (Direct Connect).
  • Network type: Select based on your module's connectivity.
  • Custom hardware does not support Tuya production solutions.
  1. Copy the generated firmware key — you will need to embed it in your firmware code.

Step 2: Write the Firmware Key into Firmware​

info

Setting firmware_key is optional. If omitted, the platform assumes there is only one firmware per PID and no key distinction is needed during OTA.

If the same PID has multiple firmwares with different keys (for example, a product with multiple hardware platforms such as T5, T3, etc.), you must set firmware_key so the device reports its key to the platform. Without this, the platform cannot determine which firmware to push to which device, and OTA upgrades will not work correctly.

  1. Define the firmware key in tuya_config.h (or the equivalent config header for your app):
#define TUYA_DEVICE_FIRMWAREKEY   "your_firmware_key_here"
  1. In tuya_main.c, find the tuya_iot_init call and add the firmware_key field:
ret = tuya_iot_init(&ai_client, &(const tuya_iot_config_t){
    .software_ver = PROJECT_VERSION,
    .productkey   = TUYA_PRODUCT_ID,
    .uuid         = license.uuid,
    .authkey      = license.authkey,
    .firmware_key = TUYA_DEVICE_FIRMWAREKEY,   // ← add this line
    .event_handler = user_event_handler_on,
    .network_check = user_network_check,
});

  1. Update the firmware version number.

    OTA upgrades follow a "lower to higher version" rule — the new firmware version must be higher than the version currently running on the device, otherwise the platform will not push the upgrade.

    Run the following command to open the configuration menu:

    tos.py config menu

    Navigate to the Configure Project submenu, find PROJECT_VERSION, and set it to a higher version number. The format is "xx.xx.xx" (for example, "1.0.1").

  2. Run tos.py clean -f, then rebuild and re-flash the firmware.

Step 3: Upload a New Firmware Version​

  1. In the left navigation, go to Product > Device > Firmware Management.
  2. Find the corresponding firmware key and click Add Firmware Version.

Add firmware version entry
Add firmware version entry

  1. Fill in the version number and release notes, then upload the compiled firmware files one by one. TuyaOpen produces three firmware types, identifiable by filename:

    Firmware TypeFilename PatternDescription
    Production firmwareContains QIOFor full-chip factory flashing
    User-partition firmwareContains UAFor partition-based factory flashing
    Upgrade firmwareContains UGFor remote OTA upgrades
    info

    TuyaOpen firmware does not currently support differential (delta) upgrades. Always upload the full firmware package.

Fill in firmware version info
Fill in firmware version info

  1. Click Save. The version is created with status Unpublished.

Step 4: Publish the Firmware Version​

Firmware versions are unpublished by default and must be published before they can be used for OTA.

  1. In the firmware version list, find the newly uploaded version and click Publish Firmware.
  2. Check Upgrade Firmware as the publish content and set the allowed usage scope (default: unrestricted).
  3. Confirm. The version status changes to Published.

Publish firmware version
Publish firmware version

Step 5: Configure the Upgrade Rule​

  1. In the left navigation, go to Product > Device > Firmware OTA.
  2. Under Firmware Source, select the firmware with the Custom Upload attribute.
  3. Click New Firmware Upgrade and fill in the configuration:

New firmware upgrade
New firmware upgrade

ParameterDescription
Firmware VersionSelect the newly published version
Upgrade MethodApp-prompted / App-forced / App-detected
Versions to UpgradeSelect the old versions to be upgraded (all lower versions selected by default)
RegionsSelect target regions (all regions selected by default)

Configure upgrade rule
Configure upgrade rule

  1. Click Confirm. An upgrade record is created.

Step 6: Verify​

It is recommended to verify the OTA flow on test devices before releasing to all users.

  1. Click Common Verification Devices to add test devices to the whitelist via App account or device ID.
  2. Click Verify to push the firmware to the test devices.
  3. Click Check Upgrade Completion to confirm the devices have successfully upgraded to the new version.

Verify firmware upgrade
Verify firmware upgrade

Step 7: Release​

After verification passes, click Release to push the upgrade.

  • Gradual rollout: Push to a small percentage of devices first (5% is recommended), monitor upgrade data, and gradually increase to 100%.
  • Full rollout: Push to all eligible devices immediately.

Release firmware upgrade
Release firmware upgrade

warning

Gradual rollout is strongly recommended. If a firmware issue is found after release, you can pause the rollout at any time and resume after the issue is resolved.

After release, check the Upgrade Device Details section to monitor the upgrade status per device.

References​