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.

Installation

npm install codetheweb/tuyapi

Basic Usage

Asynchronous (event based, recommended)

const device = new TuyAPI({
  id: 'xxxxxxxxxxxxxxxxxxxx',
  key: 'xxxxxxxxxxxxxxxx',
  ip: 'xxx.xxx.xxx.xxx',
  persistentConnection: true});

device.on('connected',() => {
  console.log('Connected to device.');
});

device.on('disconnected',() => {
  console.log('Disconnected from device.');
});

device.on('data', data => {
  console.log('Data from device:', data);

  const status = data.dps['1'];

  console.log('Current status:', status);

  device.set({set: !status}).then(result => {
    console.log('Result of setting status:', result);
  });
});

device.on('error',(err) => {
  console.log('Error: ' + err);
});

device.connect();

// Disconnect after 10 seconds
setTimeout(() => { device.disconnect(); }, 10000);

Synchronous

const TuyAPI = require('tuyapi');

const device = new TuyAPI({
  id: 'xxxxxxxxxxxxxxxxxxxx',
  key: 'xxxxxxxxxxxxxxxx',
  ip: 'xxx.xxx.xxx.xxx'});

device.get().then(status => {
  console.log('Status:', status);

  device.set({set: !status}).then(result => {
    console.log('Result of setting status to ' + !status + ': ' + result);

    device.get().then(status => {
      console.log('New status:', status);
      return;
    });
  });
});

This should report the current status, set the device to the opposite of what it currently is, then report the changed status. The above examples will work with smart plugs; they may need some tweaking for other types of devices.

See the setup instructions for how to find the needed parameters.

📝 Notes

• Only one TCP connection can be in use with a device at once. If using this, do not have the app on your phone open.
• Some devices ship with older firmware that may not work with tuyapi. If you're experiencing issues, please try updating the device's firmware in the official app.

📓 Docs

See the docs.

TODO

1. Document details of protocol
2. Figure out correct CRC algorithm

Contributors

• codetheweb
• blackrozes
• clach04
• jepsonrob
• tjfontaine
• NorthernMan54
• Apollon77
• dresende

Related

Ports

• python-tuya a Python port by clach04
• m4rcus.TuyaCore a .NET port by Marcus-L

Projects built with TuyAPI

• tuya-cli: a CLI interface for Tuya devices
• homebridge-tuya: a Homebridge plugin for Tuya devices
• tuyaweb: a web interface for controlling devices by bmachek
• homebridge-igenix-air-conditioner: a Homebridge plugin for the Igenix IG9901WIFI air conditioner
• magichome-led-controller: a node to use magichome led RGB controller in node-red

To add your projects to either of the above lists, please open a pull request.