tuyapi

TuyAPI 🌧 🔌

A library for communicating with devices that use the Tuya cloud network. These devices are branded under many different names, but if port 6668 is open on your device chances are this library will work with it. Currently only supports smart plugs, but it should be fairly trivial to add other types of devices.

Installation

npm install @codetheweb/tuyapi

Basic Usage

const TuyaDevice = require('tuyapi');

var tuya = new TuyaDevice({
  type: 'outlet',
  ip: 'xxx.yyy.0.zzz',
  id: 'xxxxxxxxxxxxxxxxxxxx',
  uid: 'xxxxxxxxxxxxxxxxxxxx',
  key: 'xxxxxxxxxxxxxxxx'});

tuya.getStatus(function(error, status) {
  if (error) { return console.log(error); }
  console.log('Status: ' + status);

  tuya.setStatus(!status, function(error, result) {
    if (error) { return console.log(error); }
    console.log('Result of setting status to ' + !status + ': ' + result);

    tuya.getStatus(function(error, status) {
      if (error) { return console.log(error); }
      console.log('New status: ' + status);
    });
  });
});

This should report the current status, set the device to the opposite of what it currently is, then report the changed status.

The id, uid, and key must be found by sniffing the app that came with your device. Your tool must be able to sniff HTTPS traffic for this to work. For macOS, Charles is probably the best option.

Docs

TuyaDevice

Represents a Tuya device.

Parameters

• options Object options for constructing a TuyaDevice
  • options.type string type of device (optional, default 'outlet')
  • options.ip string IP of device
  • options.port number port of device (optional, default 6668)
  • options.id string ID of device (called devId or gwId)
  • options.uid string UID of device
  • options.key string encryption key of device (called localKey)
  • options.version number protocol version (optional, default 3.1)

getStatus

Gets the device's current status.

Parameters

• callback function (error, result)

setStatus

Sets the device's status.

Parameters

• on boolean true for on, false for off
• callback function (error, result) returns true if the command succeeded

Tests

npm test (runs the xo style linter)

TODO

1. Reuse a TCP connection between subsequent commands, instead of creating a new one every time.
2. Figure out what the hex-encoded 'padding' is.
3. Autodiscovery of devices?

Contributors

• codetheweb
• blackrozes

Related

homebridge-tuya: a Homebridge plugin for Tuya devices