npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

tuyapi

4.0.4 • Public • Published

TuyAPI 🌧 🔌

XO code style Build Status Coverage Status Node Version

A library for communicating with devices that use the Tuya cloud network. These devices are branded under many different names, but if your device works with the TuyaSmart app or port 6668 is open on your device chances are this library will work.

Installation

npm install codetheweb/tuyapi

Basic Usage

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

These examples should report the current status, set the default property to the opposite of what it currently is, then report the changed status. They will need to be adapted if your device does not have a boolean property at index 1 (i.e. it doesn't have an on/off property).

Asynchronous (event based, recommended)

const TuyAPI = require('tuyapi');
 
const device = new TuyAPI({
  id: 'xxxxxxxxxxxxxxxxxxxx',
  key: 'xxxxxxxxxxxxxxxx'});
 
let stateHasChanged = false;
 
// Find device on network
device.find().then(() => {
  // Connect to device
  device.connect();
});
 
// Add event listeners
device.on('connected', () => {
  console.log('Connected to device!');
});
 
device.on('disconnected', () => {
  console.log('Disconnected from device.');
});
 
device.on('error', error => {
  console.log('Error!', error);
});
 
device.on('data', data => {
  console.log('Data from device:', data);
 
  console.log(`Boolean status of default property: ${data.dps['1']}.`);
 
  // Set default property to opposite
  if (!stateHasChanged) {
    device.set({set: !(data.dps['1'])});
 
    // Otherwise we'll be stuck in an endless
    // loop of toggling the state.
    stateHasChanged = true;
  }
});
 
// Disconnect after 10 seconds
setTimeout(() => { device.disconnect(); }, 10000);

Synchronous

const TuyAPI = require('tuyapi');
 
const device = new TuyAPI({
  id: 'xxxxxxxxxxxxxxxxxxxx',
  key: 'xxxxxxxxxxxxxxxx'});
 
(async () => {
  await device.find();
 
  await device.connect();
 
  let status = await device.get();
 
  console.log(`Current status: ${status}.`);
 
  await device.set({set: !status});
 
  status = await device.get();
 
  console.log(`New status: ${status}.`);
 
  device.disconnect();
})();

📝 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.

📓 Documentation

See the docs.

TODO

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

Contributing

See CONTRIBUTING.

Contributors

(If you're not on the above list, open a PR.)

Related

Flash alternative firmware

  • tuya-convert a project that allows you to flash custom firmware OTA on devices

Ports

Clients for Tuya's Cloud

Projects built with TuyAPI

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

forthebadge forthebadge

install

npm i tuyapi

Downloadsweekly downloads

528

version

4.0.4

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability