Gitroom - Libraries

TinyTuya

0

Python API for Tuya WiFi smart devices using a direct local area network (LAN) connection or the cloud (TuyaCloud API).

Infrastructure

device
tuya
pytuya
smarthome

TinyTuya

License PyPI version Build Test Contrib Test PyPI - Python Version PyPI Downloads

Python module to interface with Tuya WiFi smart devices

Description

This python module controls and reads state of Tuya compatible WiFi Smart Devices (Plugs, Switches, Lights, Window Covers, etc.) using the local area network (LAN) or the cloud (TuyaCloud API). This is a compatible replacement for the pytuya PyPI module and currently supports Tuya Protocols 3.1, 3.2, 3.3, 3.4 and 3.5.

Tuya devices are designed to communicate with the TuyaCloud but most also expose a local area network API. This allows us to directly control the devices without using the cloud. This python module provides a way to poll status and issue commands to these devices.

TinyTuya can also connect to the Tuya Cloud to poll status and issue commands to Tuya devices.

TinyTuya Diagram

# Example Usage of TinyTuya
import tinytuya

d = tinytuya.Device('DEVICE_ID_HERE', 'IP_ADDRESS_HERE', 'LOCAL_KEY_HERE', version=3.3)
data = d.status() 
print('Device status: %r' % data)

NOTE: Devices need to be activated by Smart Life App.

TinyTuya Installation

# Install TinyTuya Library
python -m pip install tinytuya

# Optional: Install Command Line Tool
pipx install tinytuya

Pip will attempt to install cryptography, requests and colorama if not already installed.

Tuya Device Preparation

Controlling and monitoring Tuya devices on your network requires the following:

  • Address - Network address (IPv4) of the device e.g. 10.0.1.100
  • Device ID - Unique identifier for the Tuya device
  • Version - Tuya protocol version used (3.1, 3.2, 3.3, 3.4 or 3.5)
  • Local_Key - Security key needed to access the Tuya device. See Setup Wizard to get these keys.

Network Scanner

TinyTuya has a built in network scanner that can be used to find Tuya Devices on your local network. It will show Address, Device ID and Version for each device. Your LAN and firewall will need to allow UDP (6666, 6667 and 7000) and TCP (6668) traffic.

python -m tinytuya scan

Setup Wizard - Getting Local Keys

TinyTuya has a built-in setup Wizard that uses the Tuya IoT Cloud Platform to generate a JSON list (devices.json) of all your registered devices, including secret Local_Key and Name of your devices. Follow the steps below:

  1. PAIR - Download the Smart Life App or Tuya Smart App, available for iPhone or Android. Set up your SmartLife account and pair all of your Tuya devices (this is important as you cannot access a device that has not been paired). Do not use a 'guest' account, otherwise it will get deleted without confirmation at step 3.

  2. SCAN (Optional) - Run the TinyTuya scan to get a list of Tuya devices on your network. It will show device Address, Device ID and Version number (3.x):

    python -m tinytuya scan

    NOTE: You will need to use one of the displayed Device IDs for step 4.

  3. TUYA ACCOUNT - Set up a Tuya Account (see PDF Instructions):

    • NOTE: Tuya often changes their portal and services. Please open an issue with screenshots if we need to update these instructions.
    • Create a Tuya Developer account on iot.tuya.com. When it asks for the "Account Type", select "Skip this step..." (see screenshot).
    • Click on "Cloud" icon -> "Create Cloud Project"
      1. Pick the correct Data Center "Region" for your location (check HERE to find your Region). This will be used by TinyTuya Wizard (screenshot).
      2. Skip the configuration wizard but remember the Authorization Key: API ID and Secret for below (screenshot).
    • Click on "Cloud" icon -> Select your project -> Devices -> Link Tuya App Account (see screenshot)
    • Click Add App Account (screenshot) and it will pop-up a "Link Tuya App Account" dialog, chose "Automatic" and "Read Only Status" (it will still alow commands). Click OK and it will display a QR code. Scan the QR code with the Smart Life app on your Phone (see step 1 above) by going to the "Me" tab in the Smart Life app and clicking on the QR code button [..] in the upper right hand corner of the app. When you scan the QR code, it will link all of the devices registered in your Smart Life app into your Tuya IoT project. If the QR code will not scan then make sure to disable any browser theming plug-ins (such as Dark Reader) and try again.
    • NO DEVICES? If no devices show up after scanning the QR code, you will need to select a different data center and edit your project (or create a new one) until you see your paired devices from the Smart Life App show up. (screenshot). The data center may not be the most logical. As an example, some in the UK have reported needing to select "Central Europe" instead of "Western Europe".
    • SERVICE API: Under "Service API" ensure these APIs are listed: IoT Core and Authorization. To be sure, click subscribe again on every service. Very important: disable popup blockers otherwise subscribing won't work without providing any indication of a failure. Make sure you authorize your Project to use those APIs:
      • Click "Service API" tab
      • Click "Go to Authorize" button
      • Select the API Groups from the dropdown and click Subscribe (screenshot)
    • RENEWAL: The subscription to the IoT Core service expires after some time. By default, when you subscribe to it for the first time, it will last for one month. Once expired, the setup wizard won't be able to communicate with the Tuya account anymore, so it needs to be renewed. As of November 12th 2024, it can be renewed for a duration of 1, 3 or 6 months by simply filling in a form with some basic information (e.g. purpose of the project, type of developer).

  4. WIZARD - Run Setup Wizard:

    • From your Linux/Mac/Win PC run the TinyTuya Setup Wizard to fetch the Local_Keys for all of your registered devices: 
      python -m tinytuya wizard   # use -nocolor for non-ANSI-color terminals
    • The Wizard will prompt you for the API ID key, API Secret, API Region (cn, us, us-e, eu, eu-w, or in) from your Tuya IoT project as set in Step 3 above.
      • To find those again, go to iot.tuya.com, choose your project and click Overview
        • API Key: Access ID/Client ID
        • API Secret: Access Secret/Client Secret
    • It will also ask for a sample Device ID. You can have the wizard scan for one (enter scan), use one from step 2 above or in the Device List on your Tuya IoT project.
    • The Wizard will poll the Tuya IoT Cloud Platform and print a JSON list of all your registered devices with the "name", "id" and "key" of your registered device(s). The "key"s in this list are the Devices' Local_Key you will use to access your device.
    • In addition to displaying the list of devices, Wizard will create a local file devices.json that TinyTuya will use to provide additional details for scan results from tinytuya.deviceScan() or when running python -m tinytuya scan. The wizard also creates a local file tuya-raw.json that contains the entire payload from Tuya Cloud.
    • The Wizard will ask if you want to poll all the devices. If you do, it will display the status of all devices on record and create a snapshot.json file with these results. Make sure your LAN and firewall permit UDP (6666, 6667 and 7000) and TCP (6668) traffic.

Notes:

  • If you ever reset or re-pair your smart devices, the Local_Key will be reset and you will need to repeat the steps above.
  • The TinyTuya Wizard was inspired by the TuyAPI CLI which is an alternative way to fetch the Local_Keys: npm i @tuyapi/cli -g and run tuya-cli wizard

Programming with TinyTuya

After importing tinytuya, you create a device handle for the device you want to read or control. Here is an example for a Tuya smart switch or plug:

import tinytuya

# Connect to Device
d = tinytuya.OutletDevice(
    dev_id='DEVICE_ID_HERE',
    address='IP_ADDRESS_HERE',      # Or set to 'Auto' to auto-discover IP address
    local_key='LOCAL_KEY_HERE', 
    version=3.3)

# Get Status
data = d.status() 
print('set_status() result %r' % data)

# Turn On
d.turn_on()

# Turn Off
d.turn_off()

TinyTuya Module Classes and Functions

Classes

  AESCipher - Cryptography Helpers
  XenonDevice(args...) - Base Class
    Device(args...) - Tuya Class for Devices
      OutletDevice(args...)
      CoverDevice(args...)
      BulbDevice(args...)
        Where args:
          dev_id (str): Device ID e.g. 01234567891234567890
          address (str): Device Network IP Address e.g. 10.0.1.99 or "Auto" to auto-find
          local_key (str): The encryption key
          dev_type (str): Device type for payload options (see below)
          version = 3.1 (float): Tuya Protocol (e.g. 3.1, 3.2, 3.3, 3.4, 3.5)
          persist = False (bool): Keep TCP link open
          cid = None (str): Optional sub device id
          node_id = None (str): Alias for cid
          parent = None (object): Gateway device object this is a child of
          port = TCPPORT (int): The port to connect to device
          connection_timeout = 5 (int): Timeout in seconds
          connection_retry_limit = 5 (int)
          connection_retry_delay = 5 (int)

          Total timeout = (connection_timeout * connection_retry_limit) + 
                          (connection_retry_delay * (connection_retry_limit - 1))
                          Defaults: (5 * 5) + (5 * (5 - 1)) = 45 seconds
                        
  Cloud(apiRegion, apiKey, apiSecret, apiDeviceID, new_sign_algorithm)

TinyTuya Base Functions
    devices = deviceScan()                        # Returns dictionary of devices found on local network
    scan()                                        # Interactive scan of local network
    wizard()                                      # Interactive setup wizard
    set_debug(toggle, color)                      # Activate verbose debugging output
    pack_message(msg, hmac_key)                   # Packs a TuyaMessage(), encrypting or adding a CRC if required 
    unpack_message(data, hmac_key, header, 
                    no_retcode)                   # Unpacks a TuyaMessage() 
    parse_header(data)                            # Unpacks just the header part of a message into a TuyaHeader()
    find_device(dev_id, address)                  # Scans network for Tuya devices with either ID = dev_id or IP = address
    device_info(dev_id)                           # Searches DEVICEFILE (usually devices.json) for device with ID
    assign_dp_mappings(tuyadevices, mappings)     # Adds mappings to all the devices in the tuyadevices list
    decrypt_udp(msg)                              # Decrypts a UDP network broadcast packet

 Device Functions (All Devices)
    json = status()                               # returns json payload
    subdev_query(nowait)                          # query sub-device status (only for gateway devices)
    set_version(version)                          # 3.1 [default], 3.2, 3.3 or 3.4
    set_socketPersistent(False/True)              # False [default] or True
    set_socketNODELAY(False/True)                 # False or True [default]
    set_socketRetryLimit(integer)                 # retry count limit [default 5]
    set_socketRetryDelay(integer)                 # retry delay [default 5]
    set_socketTimeout(timeout)                    # set connection timeout in seconds [default 5]
    set_dpsUsed(dps_to_request)                   # add data points (DPS) to request
    add_dps_to_request(index)                     # add data point (DPS) index set to None
    set_retry(retry=True)                         # retry if response payload is truncated
    set_status(on, switch=1, nowait)              # Set status of switch to 'on' or 'off' (bool)
    set_value(index, value, nowait)               # Set int value of any index.
    set_multiple_values(index_value_dict, nowait) # Set multiple values with a single request
    heartbeat(nowait)                             # Send heartbeat to device
    updatedps(index=[1], nowait)                  # Send updatedps command to device
    turn_on(switch=1, nowait)                     # Turn on device / switch #
    turn_off(switch=1, nowait)                    # Turn off
    set_timer(num_secs, nowait)                   # Set timer for num_secs
    set_sendWait(num_secs)                        # Time to wait after sending commands before pulling response
    detect_available_dps()                        # Return list of DPS available from device
    generate_payload(command, data,...            # Generate TuyaMessage payload for command with data
    send(payload)                                 # Send payload to device (do not wait for response)
    receive()                                     # Receive payload from device

OutletDevice Additional Functions
    set_dimmer(percentage):

BulbDevice Additional Functions
    set_colour(r, g, b, nowait):
    set_hsv(h, s, v, nowait):
    set_white(brightness, colourtemp, nowait):
    set_white_percentage(brightness=100, colourtemp=0, nowait):
    set_brightness(brightness, nowait):
    set_brightness_percentage(brightness=100, nowait):
    set_colourtemp(colourtemp, nowait):
    set_colourtemp_percentage(colourtemp=100, nowait):
    set_scene(scene, nowait):                     # 1=nature, 3=rave, 4=rainbow
    set_mode(mode='white', nowait):               # white, colour, scene, music
    result = brightness():
    result = colourtemp():
    (r, g, b) = colour_rgb():
    (h,s,v) = colour_hsv()
    result = state():

CoverDevice Additional Functions
    open_cover(switch=1):
    close_cover(switch=1):
    stop_cover(switch=1):

Cloud Functions
    setregion(apiRegion)
    cloudrequest(url, action=[POST if post else GET], post={}, query={})
    getdevices(verbose=False)
    getstatus(deviceid)
    getfunctions(deviceid)
    getproperties(deviceid)
    getdps(deviceid)
    sendcommand(deviceid, commands [, uri])
    getconnectstatus(deviceid)
    getdevicelog(deviceid, start=[now - 1 day], end=[now], evtype="1,2,3,4,5,6,7,8,9,10", size=100, params={})
      -> when start or end are negative, they are the number of days before "right now"
          i.e. "start=-1" is 1 day ago, "start=-7" is 7 days ago

TinyTuya Error Codes

Starting with v1.2.0 TinyTuya functions will return error details in the JSON data responses instead of raising exceptions. The format for this response:

{ "Error":"Invalid JSON Payload", "Err":"900", "Payload":"{Tuya Message}" }

The "Err" number will be one of these:

  • 900 (ERR_JSON) - Invalid JSON Response from Device
  • 901 (ERR_CONNECT) - Network Error: Unable to Connect
  • 902 (ERR_TIMEOUT) - Timeout Waiting for Device
  • 903 (ERR_RANGE) - Specified Value Out of Range
  • 904 (ERR_PAYLOAD) - Unexpected Payload from Device
  • 905 (ERR_OFFLINE) - Network Error: Device Unreachable
  • 906 (ERR_STATE) - Device in Unknown State
  • 907 (ERR_FUNCTION) - Function Not Supported by Device
  • 908 (ERR_DEVTYPE) - Device22 Detected: Retry Command
  • 909 (ERR_CLOUDKEY) - Missing Tuya Cloud Key and Secret
  • 910 (ERR_CLOUDRESP) - Invalid JSON Response from Cloud
  • 911 (ERR_CLOUDTOKEN) - Unable to Get Cloud Token
  • 912 (ERR_PARAMS) - Missing Function Parameters
  • 913 (ERR_CLOUD) - Error Response from Tuya Cloud
  • 914 (ERR_KEY_OR_VER) - Check device key or version

Example Usage

See the sample python script test.py for an OutletDevice example or look in the examples directory for other scripts.

import tinytuya

"""
OUTLET Device
"""
d = tinytuya.Device('DEVICE_ID_HERE', 'IP_ADDRESS_HERE', 'LOCAL_KEY_HERE', version=3.3)
data = d.status()  

# Show status and state of first controlled switch on device
print('Dictionary %r' % data)
print('State (bool, true is ON) %r' % data['dps']['1'])  

# Toggle switch state
switch_state = data['dps']['1']
data = d.set_status(not switch_state)  # This requires a valid key
if data:
    print('set_status() result %r' % data)

# On a switch that has 4 controllable ports, turn the fourth OFF (1 is the first)
data = d.set_status(False, 4)
if data:
    print('set_status() result %r' % data)
    print('set_status() extra %r' % data[20:-8])

"""
RGB Bulb Device
"""
import time

d = tinytuya.BulbDevice('DEVICE_ID_HERE', 'IP_ADDRESS_HERE', 'LOCAL_KEY_HERE')
d.set_version(3.3)  # IMPORTANT to set this regardless of version
d.set_socketPersistent(True)  # Optional: Keep socket open for multiple commands
data = d.status()

# Show status of first controlled switch on device
print('Dictionary %r' % data)

# Set to RED Color - set_colour(r, g, b):
d.set_colour(255,0,0)  

# Cycle through the Rainbow
rainbow = {"red": [255, 0, 0], "orange": [255, 127, 0], "yellow": [255, 200, 0],
          "green": [0, 255, 0], "blue": [0, 0, 255], "indigo": [46, 43, 95],
          "violet": [139, 0, 255]}
for color in rainbow:
    [r, g, b] = rainbow[color]
    d.set_colour(r, g, b, nowait=True)  # nowait = Go fast don't wait for response
    time.sleep(0.25)

# Brightness: Type A devices range = 25-255 and Type B = 10-1000
d.set_brightness(1000)

# Set to White - set_white(brightness, colourtemp):
#    colourtemp: Type A devices range = 0-255 and Type B = 0-1000
d.set_white(1000,10)

# Set Bulb to Scene Mode
d.set_mode('scene')

# Scene Example: Set Color Rotation Scene
d.set_value(25, '07464602000003e803e800000000464602007803e803e80000000046460200f003e803e800000000464602003d03e803e80000000046460200ae03e803e800000000464602011303e803e800000000')

Example Device Monitor

You can set up a persistent connection to a device and then monitor the state changes with a continual loop. This is helpful for troubleshooting and discovering DPS values.

import tinytuya

d = tinytuya.OutletDevice('DEVICEID', 'DEVICEIP', 'DEVICEKEY', version=3.3, persist=True)

print(" > Send Request for Status < ")
d.status(nowait=True)

print(" > Begin Monitor Loop <")
while(True):
    # See if any data is available
    data = d.receive()
    print('Received Payload: %r' % data)

    # Send keep-alive heartbeat
    if not data:
        print(" > Send Heartbeat Ping < ")
    	d.heartbeat()

    # NOTE If you are not seeing updates, you can force them - uncomment:
    # print(" > Send Request for Status < ")
    # d.status(nowait=True)

    # NOTE Some smart plugs require an UPDATEDPS command to update power data
    # print(" > Send DPS Update Request < ")
    # payload = d.generate_payload(tinytuya.UPDATEDPS)
    # d.send(payload)

Tuya Cloud Access

You can poll and manage Tuya devices using the Cloud class and functions.

CAUTION: The free Tuya IoT Developer (Trial) account allows a very limited number of Cloud API calls. Be aware of the restrictions before enabling any automation that makes frequent calls.

import tinytuya

# Connect to Tuya Cloud
# c = tinytuya.Cloud()  # uses tinytuya.json 
c = tinytuya.Cloud(
        apiRegion="us", 
        apiKey="xxxxxxxxxxxxxxxxxxxx", 
        apiSecret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", 
        apiDeviceID="xxxxxxxxxxxxxxxxxxID")

# Display list of devices
devices = c.getdevices()
print("Device List: %r" % devices)

# Select a Device ID to Test
id = "xxxxxxxxxxxxxxxxxxID"

# Display Properties of Device
result = c.getproperties(id)
print("Properties of device:\n", result)

# Display Status of Device
result = c.getstatus(id)
print("Status of device:\n", result)

# Send Command - Turn on switch
commands = {
    "commands": [
        {"code": "switch_1", "value": True},
        {"code": "countdown_1", "value": 0},
    ]
}
print("Sending command...")
result = c.sendcommand(id,commands)
print("Results\n:", result)

Up to one week of device logs can also be pulled from the Cloud. By default getdevicelog() will pull 1 day of logs or 5000 log entries, whichever comes first. The returned timestamps are unixtime*1000, and event_id 7 (data report) will probably be the most useful.

import tinytuya
import json

c = tinytuya.Cloud()
#r = c.getdevicelog( '00112233445566778899', start=-1, end=0, size=0, max_fetches=50 )
#r = c.getdevicelog( '00112233445566778899', start=1669990000, end=1669990300, size=20 )
r = c.getdevicelog( '00112233445566778899' )
print( json.dumps(r, indent=2) )

Encryption Notes

Tuya devices use AES encryption which is not available in the Python standard library. PyCA/cryptography is recommended and installed by default. Other options include PyCryptodome , PyCrypto and pyaes.

  • Deprecation notice for pyaes: The pyaes library works for Tuya Protocol <= 3.4 but will not work for 3.5 devices. This is because pyaes does not support GCM which is required for v3.5 devices.

Command Line

TinyTuya provides a built-in command line interface to get Local key, scan and poll devices.

Installation

# Option-1: pip install tinytuya
python -m tinytuya

# Option-2: pipx install tinytuya
tinytuya

Command Line Usage

tinytuya <command> [-debug] [-nocolor] [-h] [-yes] [-no-poll] [-device-file FILE] [-snapshot-file FILE]

  wizard         Launch Setup Wizard to get Tuya Local KEYs.
  scan           Scan local network for Tuya devices.
  devices        Scan all devices listed in devices.json file.
  snapshot       Scan devices listed in snapshot.json file.
  json           Scan devices listed in snapshot.json file [JSON].

  Wizard
      tinytuya wizard [-h] [-debug] [-force [0.0.0.0/24 ...]] [-no-broadcasts] [-nocolor] [-yes] [-no-poll]
                [-device-file FILE] [-raw-response-file FILE] [-snapshot-file FILE] [-credentials-file FILE]
                [-key KEY] [-secret SECRET] [-region {cn,eu,eu-w,in,us,us-e}] [-device DEVICE [DEVICE ...]]
                [-dry-run] [max_time]

        Common Options
        max_time             Maximum time to find Tuya devices [Default: 18]
        -no-broadcasts       Ignore broadcast packets when force scanning
        -nocolor             Disable color text output.
        -debug               Activate debug mode.
        -h, -help            Show usage help for command.
        -yes, -y             Answer "yes" to all questions
        -no-poll, -no        Answer "no" to "Poll?" (overrides -yes)
        -device-file FILE    JSON file to load devices from [Default: devices.json]
        -snapshot-file FILE  JSON file to load/save snapshot from/to [Default: snapshot.json]
        -force [0.0.0.0/24 ...], -f [0.0.0.0/24 ...]
                             Force network scan of device IP addresses [Default: Auto-detects net/mask]
        -no-broadcasts       Ignore broadcast packets when force scanning
        -raw-response-file   JSON file to save the raw server response to [Default: tuya-raw.json]

        Wizard Cloud API Options
        -dry-run             Do not actually connect to the Cloud
        -credentials-file    JSON file to load/save Cloud credentials from/to [Default: tinytuya.json]
        -key KEY             Cloud API Key to use
        -secret SECRET       Cloud API Secret to use
        -region              Cloud API Region to use {cn,eu,eu-w,in,us,us-e}
        -device DEVICE(S)    One or more Device ID(s) to use

  Scan
      tinytuya scan [-h] [-debug] [-force [0.0.0.0/24 ...]] [-no-broadcasts] [-nocolor] [-yes] 
                [-device-file FILE] [-snapshot-file FILE] [max_time]

  Devices
      tinytuya devices [-h] [-debug] [-force [0.0.0.0/24 ...]] [-no-broadcasts] [-nocolor] [-yes] 
                [-no-poll] [-device-file FILE] [-snapshot-file FILE] [max_time]

  Snapshot
      tinytuya snapshot [-h] [-debug] [-nocolor] [-yes] [-no-poll] [-device-file FILE] [-snapshot-file FILE]

  JSON
      tinytuya json [-h] [-debug] [-device-file FILE] [-snapshot-file FILE]

Scan Tool

The function tinytuya.scan() will listen to your local network (UDP 6666 and 6667) and identify Tuya devices broadcasting their Address, Device ID, Product ID and Version and will print that and their stats to stdout. This can help you get a list of compatible devices on your network. The tinytuya.deviceScan() function returns all found devices and their stats (via dictionary result).

You can run the scanner from the command line using these interactive commands:

# Listen for Tuya Devices and match to devices.json if available
python -m tinytuya scan

# The above creates a snapshot.json file with IP addresses for devices
# You can use this command to get a rapid poll of status of all devices
python -m tinytuya snapshot

# The sames thing as above but with a non-interactive JSON response
python -m tinytuya json

# List all register devices discovered from Wizard and poll them
python -m tinytuya devices

By default, the scan functions will retry 15 times to find new devices. If you are not seeing all your devices, you can increase max_retries by passing an optional arguments (eg. 50 retries):

# command line
python -m tinytuya scan 50

# invoke verbose interactive scan
tinytuya.scan(50)

# return payload of devices
devices = tinytuya.deviceScan(false, 50)

Troubleshooting

  • Tuya devices only allow one TCP connection at a time. Make sure you close the TuyaSmart or SmartLife app before using TinyTuya to connect.
  • Some devices ship with older firmware that may not work with TinyTuya. If you're experiencing issues, please try updating the device's firmware in the official app.
  • The LOCAL KEY for Tuya devices will change every time a device is removed and re-added to the TuyaSmart app. If you're getting decrypt errors, try getting the key again as it might have changed.
  • Devices running protocol version 3.1 (e.g. below Firmware 1.0.5) do not require a device Local_Key to read the status. All devices will require a device Local_Key to control the device.
  • Some devices with 22 character IDs will require additional setting to poll correctly. TinyTuya will attempt to detect and accomodate for this, but it can be specified directly: 
    a = tinytuya.OutletDevice('here_is_my_key', '192.168.x.x', 'secret_key_here', 'device22')
a.set_version(3.3)
a.set_dpsUsed({"1": None})  # This needs to be a datapoint available on the device
data =  a.status()
print(data)
  • Windows 10 Users - TinyTuya wizard and scan interactive tools use ANSI color. This will work correctly in PowerShell but will show cryptic escape codes when run in Windows CMD. You can fix this by using the -nocolor option on tinytuya, or by changing the Windows CMD console registry to process ANSI escape codes by doing something like this: 
    reg add HKEY_CURRENT_USER\Console /v VirtualTerminalLevel /t REG_DWORD /d 0x00000001 /f

User Contributed Device Modules

In addition to the built-in OutletDevice, BulbDevice and CoverDevice device support, the community is encourage to submit additional device modules which are available here: Contrib Library:

# Example usage of community contributed device modules
from tinytuya.Contrib import ThermostatDevice

thermo = ThermostatDevice( 'abcdefghijklmnop123456', '172.28.321.475', '1234567890123abc' )

Tuya Data Points - DPS Table

The Tuya devices send back data points (DPS) also called device function points, in a json string. The DPS attributes define the state of the device. Each key in the DPS dictionary refers to key value pair, the key is the DP ID and its value is the dpValue. You can refer to the Tuya developer platform for definition of function points for the products.

The following table represents several of the standard Tuya DPS values and their properties. It represents data compiled from Tuya documentation and self-discovery. Devices may vary. Feedback or additional data would would be appreciated. Please submit a Issue or Pull Request if you have additional data that would be helpful for others.

To find Tuya DPS for devices not listed below, you can discover the DPS values using the Tuya IoT platform. See this help here: Find your Data Point.

DPS Read and Set Example:

# Read Value of DPS 25
data = d.status()  
print("Value of DPS 25 is ", data['dps']['25'])

# Set Value of DPS 25
d.set_value(25, '010e0d0000000000000003e803e8')

Version 3.1 Devices

Version 3.1 (and some 3.3) - Plug or Switch Type

DP IDFunction PointTypeRangeUnits
1SwitchboolTrue/False
2Countdown?integer0-86400s
4Currentinteger0-30000mA
5Powerinteger0-50000W
6Voltageinteger0-5000V

Version 3.1 - Light Type (RGB)

DP IDFunction PointTypeRangeUnits
1SwitchboolTrue/False
2Modeenumwhite,colour,scene,music
3Brightinteger10-1000*
4Color Tempinteger0-1000*
5Colorhexstringr:0-255,g:0-255,b:0-255,h:0-360,s:0-255,v:0-255rgb+hsv

Version 3.3 Devices

Version 3.3 - Plug, Switch, Power Strip Type

DP IDFunction PointTypeRangeUnits
1Switch 1boolTrue/False
2Switch 2boolTrue/False
3Switch 3boolTrue/False
4Switch 4boolTrue/False
5Switch 5boolTrue/False
6Switch 6boolTrue/False
7Switch 7/usbboolTrue/False
9Countdown 1integer0-86400s
10Countdown 2integer0-86400s
11Countdown 3integer0-86400s
12Countdown 4integer0-86400s
13Countdown 5integer0-86400s
14Countdown 6integer0-86400s
15Countdown 7integer0-86400s
17Add Electricityinteger0-50000kwh
18Currentinteger0-30000mA
19Powerinteger0-50000W
20Voltageinteger0-5000V
21Test Bitinteger0-5n/a
22Voltage coeff.integer0-1000000
23Current coeff.integer0-1000000
24Power coeff.integer0-1000000
25Electricity coeff.integer0-1000000
26Faultfaultov_cr
38Power-on state settingenumoff, on, memory
39Overcharge SwitchboolTrue/False
40Indicator status settingenumnone, on, relay, pos
41Child LockboolTrue/False
42UNKNOWN
43UNKNOWN
44UNKNOWN

Note: Some 3.3 energy management plugs use the DPS values of the 3.1 plug above.

Version 3.3 - Dimmer Switch

DP IDFunction PointTypeRangeUnits
1SwitchboolTrue/False
2Brightnessinteger10-1000*
3Minimum of Brightnessinteger10-1000*
4Type of light source1enumLED,incandescent,halogen
5Modeenumwhite

Version 3.3 - Light Type (RGB)

DP IDFunction PointTypeRangeUnits
20SwitchboolTrue/False
21Modeenumwhite,colour,scene,music
22Brightinteger10-1000*
23Color Tempinteger0-1000
24Colorhexstringh:0-360,s:0-1000,v:0-1000hsv
25Scenestringn/a
26Left timeinteger0-86400s
27Musicstringn/a
28Debuggerstringn/a
29Debugstringn/a
30Rhythmsn/an/a
31Go To Sleepn/an/a
32Wake Upn/an/a
33Power Off Memoryn/an/a
34Do not Disturbn/an/a
41Remote Control Switchn/an/a
209Cycle Timingn/an/a
210Vaction Timingn/an/a

Version 3.3 - Automated Curtain Type

DP IDFunction PointTypeRangeUnits
1Curtain Switch 1enumopen, stop, close, continue
2Percent control 1integer0-100%
3Accurate Calibration 1enumstart, end
4Curtain Switch 2enumopen, stop, close, continue
5Percent control 2integer0-100
6Accurate Calibration 2enumstart, end
8Motor Steer 1enumforward, back
9Motor steer 2enumforward, back
10Quick Calibration 1integer1-180s
11Quick Calibration 2integer1-180s
12Motor Mode 1enumstrong_power, dry_contact
13Motor Mode 2enumstrong_power, dry_contact
14Light modeenumrelay, pos, none

Version 3.3 - Fan Switch Type

DP IDFunction PointTypeRangeUnits
1Fan switchboolTrue/Falsen/a
2Fan countdowninteger0-86400s
3Fan speedenumlevel_1, level_2, level_3, level_4, level_5
4Fan speedinteger1-100%
5Fan light switchboolTrue/False
6Brightness integerinteger10-1000
7Fan light countdowninteger0-86400
8Minimum brightnessinteger10-1000
9Maximum brightnessinteger10-1000
10Modeenumwhite
11Power-on state settingenumoff, on, memory
12Indicator status settingenumnone, relay, pos
13Backlight switchboolTrue/False

Version 3.3 - Universal IR Controller with optional Temp/Humidity

DP IDFunction PointTypeRangeUnits
101Current Temperatureinteger0-60010x Celsius
102Current Humidityinteger0-100%
201IR Commands (set only)JSON*n/an/a
# The IR Commands JSON has the following format:
command = {
    "control": "send_ir",
    "head": "",
    "key1": "[[TO_BE_REPLACED]]",
    "type": 0,
    "delay": 300,
}
# Sending the IR command:
payload = d.generate_payload(tinytuya.CONTROL, {"201": json.dumps(command)})
d.send(payload)

The key1 attribute is a base64 string that contains the IR signal. You can extract it using this procedure:

  1. Register a new IR device on Tuya Smart / Smart Life app (if not registered already) and map, setup or import your buttons.
  2. Tap multiple times on the button you wish to control.
  3. Go to Tuya IoT Platform and select your app under Cloud > Development section.
  4. Go to to the Device tab and select "Debug Device" on the parent device. Browse Device Logs section and retrieve the key1 attribute that matches your tapping timestamp from step 2 above. Use that key1 attribute in the payload example above.

You need to repeat these steps for each button (cloud logging is not always sequential).

Version 3.3 - Sensor Type

Important Note: Battery-powered Tuya sensors are usually designed to stay in sleep mode until a state change (eg.open or close alert). This means you will not be able to poll these devices except in the brief moment they awake, connect to the WiFi and send their state update payload the the Tuya Cloud. Keep in mind that if you manage to poll the device enough to keep it awake, you will likely quickly drain the battery.

DP IDFunction PointTypeRangeUnits
1Door SensorboolTrue/False
2Battery level stateenumlow, middle, high
3Battery levelinteger0-100%
4Temper alarmboolTrue/False
5Flooding Detection Stateenumalarm, normal
6Luminance detection stateenumlow, middle, high, strong
7Current Luminanceinteger0-100%
8Current Temperatureinteger400-2000
9Current Humidityinteger0-100%
10Shake Stateenumnormal, vibration, drop, tilt
11Pressure Stateenumalarm, normal
12PIR stateenumpir, none
13Smoke Detection Stateenumalarm, normal
14Smoke valueinteger0-1000
15Alarm Volumeenumlow, middle, high, mute
16Alarm Ringtoneenum1, 2, 3, 4, 5
17Alarm Timeinteger0-60s
18Auto-DetectboolTrue/False
19Auto-Detect Resultenumchecking, check_success, check_failure, others
20PreheatboolTrue/False
21Fault Alarmfaultfault, serious_fault, sensor_fault, probe_fault, power_faultBarrier
22LifecycleboolTrue/False
23Alarm SwitchboolTrue/False
24SilenceboolTrue/False
25Gas Detection Stateenumalarm, normal
26Detected Gasinteger0-1000
27CH4 Detection Stateenumalarm, normal
28CH4 valueinteger0-1000
29Alarm stateenumalarm_sound, alarm_light, alarm_sound_light, normal
30VOC Detection Stateenumalarm, normal
31VOC valueinteger0-999
32PM2.5 stateenumalarm, normal
33PM2.5 valueinteger0-999
34CO stateenumalarm, normal
35CO valueinteger0-1000
36CO2 Detection Stateenumalarm, normal
37CO2 valueinteger0-1000
38Formaldehyde Detection Stateenumalarm, normal
39CH2O valueinteger0-1000
40Master modeenumdisarmed, arm, home, sos
41Air quality indexenumlevel_1, level_2, level_3, level_4, level_5, level_6

NOTE (*) - The range can vary depending on the device. As an example, for dimmers, it may be 10-1000 or 25-255.

Version 3.3 - WiFi Air Quality Detector PM2.5/Formaldehyde/VOC/CO2/Temperature/Humidity

DP IDFunction PointTypeRangeUnits
2PM2.5 valueinteger0 - 999ug/m3
18Current Temperatureinteger0 - 850˚C (multiplied by 10)
19Current Humidityinteger0 - 1000% (multiplied by 10)
20CH2O (Formaldehyde) valueinteger0 - 1000ppm
21VOC (Volatile organic compound) valueinteger0 - 2000ppm
22CO2 valueinteger350 - 2000ppm

Example device: https://www.aliexpress.com/item/1005005034880204.html

Version 3.3 - Robot Mower Type

DP IDFunction PointTypeRangeUnits
6Batteryinteger0-100%
101Machine Statusenum
  • STANDBY MOWING
  • CHARGING
  • EMERGENCY
  • LOCKED
  • PAUSED
  • PARK
  • CHARGING_WITH_TASK_SUSPEND
  • FIXED_MOWING
102Machine errorinteger0, ?
103Machine warningenum
  • MOWER_LEAN
  • MOWER_EMERGENCY
  • MOWER_UI_LOCKED
    104Rain modebooleanTrue/False
    105Work timeinterger1-99hours
    106Machine passwordbyte str?
    107Clear machine appointmentbooleanTrue/False
    108Query machine reservationbooleanTrue/False
    109Query partition parametersbooleanTrue/False
    110Report machine reservationbyte str
    111Error logbyte str
    112Work logbyte str
    113Partition parametersbyte str
    114Work modeenumAutoMode/??

    Reference pymoebot for further definition.

    Version 3.3 - 24v Thermostat (i.e. PCT513-TY)

    DP IDFunction PointTypeRangeUnits
    2System Modeenum[ 'auto' 'cool' 'heat' 'off' others? ]
    16Center of Setpoint, High-Resolution °Cinteger500-3200°C x 100 in steps of 50
    17Center of Setpoint, °Finteger20-102°F
    18*Cooling Setpoint, Low-Resolution °Finteger20-102°F
    19*Cooling Setpoint, Low-Resolution °Cinteger500-3200°C
    20*Heating Setpoint, Low-Resolution °Finteger20-102°F
    23Display Unitsenum[ 'f' 'c' ]
    24Current Temperature, High-Resolution °Cinteger500-3200°C x 100 in steps of 50
    26*Heating Setpoint, Low-Resolution °Cinteger5-32°C
    27*Temperature Correctioninteger-10 - +10
    29Current Temperature, °Finteger20-102°F
    34Current Humidityinteger0-100%
    45Fault Flagsbitmask[ e1 e2 e3 ]
    107System Typeinteger-as-string??
    108*Cooling Setpoint, High-Resolution °Cinteger500-3200°C x 100 in steps of 50
    109*Heating Setpoint, High-Resolution °Cinteger500-3200°C x 100 in steps of 50
    110*Cooling Setpoint, °Finteger20-102°F
    111*Heating Setpoint, °Finteger20-102°F
    115Fan Modeenum[ 'auto' 'cycle' 'on' ]
    116"at home/away from home"integer-as-string??
    118Schedule Database64binary blob
    119Schedule EnabledboolTrue/False
    120Hold/Scheduleenum[ 'permhold' 'temphold' 'followschedule' ]
    121Vacation Database64binary blob
    122Sensor Data, list 1base64binary blob
    123Minimum Fan Run Timeinteger0-55minutes per hour
    125Sensor Data, list 2base64binary blob
    126Sensor Data, list 3base64binary blob
    127Sensor Data, list 4base64binary blob
    128Sensor Data, list 5base64binary blob
    129System Stateenum[ 'fanon' 'coolfanon' 'alloff' others? ]
    130Weather Forcast???

    NOTE (*) - Depending on the firmware, either 18/19/20/26/27 or 108/109/110/111/x are used, not both

    A user contributed module is available for this device in the Contrib library:

    from tinytuya.Contrib import ThermostatDevice

thermo = ThermostatDevice( 'abcdefghijklmnop123456', '172.28.321.475', '1234567890123abc' )

    For info on the Sensor Data lists, see https://github.com/jasonacox/tinytuya/discussions/139

    Version 3.4 - WIFI Dual Meter (i.e. PJ1103A)

    DP IDFunction PointTypeRangeUnits
    1Forward energy totalintegerkWh x 100
    2Reverse energy totalintegerkWh x 100
    101Power (A)integerW x 10
    102Direction of current flow (A)enum
    • FORWARD
    • REVERSE
    104Direction of current flow (B)enum
    • FORWARD
    • REVERSE
    105Power (B)integerW x 10
    106Energy forward (A)integerkWh x 100
    107Energy reverse (A)integerkWh x 100
    108Energy forward (B)integerkWh x 100
    109Energy reverse (B)integerkWh x 100
    110Power Factor (A)integervalue x 100
    111AC frequencyintegerHz x 100
    112AC voltageintegerV x 10
    113Current (A)integermA
    114Current (B)integermA
    115Total powerintegerW x 10
    116Voltage Calibrationinteger800-1200value * 1000
    117Current Calibration (A)integer800-1200value * 1000
    118Power Calibration (A)integer800-1200value * 1000
    119Energy Calibration forward (A)integer800-1200value * 1000
    121Power Factor (B)integervalue x 100
    122Frequency Calibrationinteger800-1200value * 1000
    123Current Calibration (B)integer800-1200value * 1000
    124Power Calibration (B)integer800-1200value * 1000
    125Energy Calibration forward (B)integer800-1200value * 1000
    127Energy Calibration reverse (A)integer800-1200value * 1000
    128Energy Calibration reverse (B)integer800-1200value * 1000
    129Report Rate Controlinteger3-60s

    Note: (A) or (B) means channel A or channel B

    A user contributed module is available for this device in the Contrib library:

    
wdm = WiFiDualMeterDevice.WiFiDualMeterDevice(
    dev_id='abcdefghijklmnop123456',
    address='192.168.0.29',      # Or set to 'Auto' to auto-discover IP address
    local_key='1234567890123abc',
    version=3.4)

    Tuya References

    Credits

    • TuyAPI https://github.com/codetheweb/tuyapi by codetheweb and blackrozes. Protocol reverse engineering from jepsonrob and clach04.
    • PyTuya https://github.com/clach04/python-tuya by clach04. The origin of this python module (now abandoned). Thanks to nijave for pycryptodome support and testing, Exilit for unittests and docstrings, mike-gracia for improved Python version support, samuscherer for RGB Bulb support, magneticflux for improved Python version support, sean6541 for initial PyPi package and Home Assistant support https://github.com/sean6541/tuya-homeassistant, ziirish - for resolving a dependency problem related to version numbers at install time
    • https://github.com/rospogrigio/localtuya-homeassistant by rospogrigio. Updated pytuya to support devices with Device IDs of 22 characters
    • Thanks to @uzlonewolf, our top contributor and resident wizard, for expanding the Outlet/Cover/Bulb/Cloud modules into separate files, introducing Contrib structure for user generated device modules, making enhancements to TuyaMessage logic for multi-payload messages, rewriting the scanner and adding Tuya Protocol 3.2, 3.4 & 3.5 support to TinyTuya!
    • Finally, thanks to the entire TinyTuya community for the great engagement, contributions and encouragement! See RELEASE notes for the ever growing journal of improvements and the incredible list of talent making this project possible.

    Related Projects

    TinyTuya Powered Projects

    Please feel free to submit a PR or open an issue to add your project.