gpajot/local-tuya repository overview

⁠local-tuya

Control Tuya devices with MQTT over LAN.

• Features⁠
• Supported devices⁠
• Installation⁠
• Architecture⁠

⁠Features

• fully asynchronous
• persistent and robust communication to the device and to MQTT
• MQTT discovery⁠
• automatic remote device state updates (remotes can still be used)
• configurable buffering for subsequent updates
• constraints between device commands

⁠Supported devices

• Airton AC⁠
• Ceiling Fan⁠

⁠Installation

Run the docker image:

docker run -v $CONFIG_DIR:/app/config:ro gpajot/local-tuya

⁠Configuration

The minimal config is:

mqtt:
  discovery_prefix: {YOUR_PREFIX_HERE}
  hostname: 127.0.0.1
devices:
  - name: My AC
    model: Airton AC
    config:
      tuya:
        id_: {DEVICE_ID_HERE}
        address: {DEVICE_IP_HERE}
        key: {DEVICE_KEY_HERE}

To control a device you will need these 3 things:

• the device ID
• the device local IP address
• the device local key (encryption key generated upon pairing)

⁠Architecture

This library is composed of three main components:

• the Tuya protocol
• the device
• the MQTT client

⁠Tuya protocol

The Tuya protocol is responsible for handling communication details with the Tuya device. Its interface consists of an asynchronous method to update the device and exposes state changes via events.

See protocol module⁠.

⁠Device

The device handles higher level functional logic such as buffering, constraints and specific device commands.

See device module⁠.

⁠MQTT client

Communication with home hubs through MQTT, supporting auto discovery.

See mqtt module⁠.