tuyapi 3.1.5 | Documentation

tuyapi

3.1.5

TuyaDevice ▸
- Instance members
- #resolveId
- #resolveIds
- #get
- #set
- #connect
- #disconnect
- #isConnected
Events
TuyaDevice#error
TuyaDevice#connected
TuyaDevice#data
TuyaDevice#disconnected

Need help reading this?

TuyaDevice

Represents a Tuya device.

new TuyaDevice(options: Object)

Extends EventEmitter

Parameters

options (Object)

Name	Description
options.ip `String?`	IP of device
options.port `Number` (default `6668`)	port of device
options.id `String`	ID of device
options.key `String`	encryption key of device
options.productKey `String`	product key of device
options.version `Number` (default `3.1`)	protocol version
options.persistentConnection `Boolean` (default `false`)	whether or not to use a persistent socket with heartbeat packets

Example

const tuya = new TuyaDevice({id: 'xxxxxxxxxxxxxxxxxxxx',
                             key: 'xxxxxxxxxxxxxxxx',
                             persistentConnection: true})

Instance Members

▸ resolveId(options?)

Resolves ID stored in class to IP. If you didn't pass an IP to the constructor, you must call this before doing anything else.

resolveId(options: Object?): Promise<Boolean>

Parameters

options (Object?)

Name	Description
options.timeout `Number` (default `10`)	how long, in seconds, to wait for device to be resolved before timeout error is thrown

Returns

Promise<Boolean>: true if IP was found and device is ready to be used

Example

tuya.resolveIds().then(() => console.log('ready!'))

▸ resolveIds(options)

resolveIds(options: any)

Deprecated: since v3.0.0. Will be removed in v4.0.0. Use resolveId() instead.

Parameters

options (any)

▸ get(options?)

Gets a device's current status. Defaults to returning only the value of the first DPS index. If returnAsEvent = true, all options are ignored and all data returned from device is emitted as event.

get(options: Object?): Promise<Object>

Parameters

options (Object?)

Name	Description
options.schema `Boolean?`	true to return entire schema of device
options.dps `Number` (default `1`)	DPS index to return
options.returnAsEvent `Boolean` (default `false`)	true to emit `data` event when result is returned, false to return Promise

Returns

Promise<Object>: returns boolean if no options are provided, otherwise returns object of results

Example

// get all properties and emit event with data
tuya.get({returnAsEvent: true});

// get first, default property from device
tuya.get().then(status => console.log(status))

// get second property from device
tuya.get({dps: 2}).then(status => console.log(status))

// get all available data from device
tuya.get({schema: true}).then(data => console.log(data))

▸ set(options)

Sets a property on a device.

set(options: Object): Promise<Boolean>

Parameters

options (Object)

Name	Description
options.dps `Number` (default `1`)	DPS index to set
options.set `any?`	value to set
options.multiple `Boolean` (default `false`)	Whether or not multiple properties should be set with options.data
options.data `Object` (default `{}`)	Multiple properties to set at once. See above.

Returns

Promise<Boolean>: returns true if the command succeeded

Example

// set default property
tuya.set({set: true}).then(() => console.log('device was changed'))

// set custom property
tuya.set({dps: 2, set: true}).then(() => console.log('device was changed'))

// set multiple properties
tuya.set({
          multiple: true,
          data: {
            '1': true,
            '2': 'white'
         }}).then(() => console.log('device was changed'))

▸ connect()

Connects to the device, use to initally open a socket when using a persistent connection.

connect(): Promise<Boolean>

Returns

Promise<Boolean>:

▸ disconnect()

Disconnects from the device, use to close the socket or exit gracefully when using a persistent connection.

disconnect(): Promise<Boolean>

Returns

Promise<Boolean>:

▸ isConnected()

Returns current connection status to device. (true if connected, false otherwise.)

isConnected(): Boolean

Returns

Boolean:

Events

Events that TuyAPI emits.

Events

Events that TuyAPI emits.

TuyaDevice#error

Emitted on socket error, usually a result of a connection timeout. Also emitted on parsing errors.

TuyaDevice#error

Properties

error (Error) : error event

TuyaDevice#connected

Emitted when socket is connected to device. This event may be emitted multiple times within the same script, so don't use this as a trigger for your initialization code.

TuyaDevice#connected

TuyaDevice#data

Emitted when data is returned from device.

TuyaDevice#data

Properties

data (Object) : received data

commandByte (Number) : commandByte of result (e.g. 7=requested response, 8=proactive update from device)

TuyaDevice#disconnected

Emitted when a socket is disconnected from device. Not an exclusive event: error and disconnected may be emitted at the same time if, for example, the device goes off the network.

TuyaDevice#disconnected