DOCS.md

Device

Represents a Yeelight device

constructor

Constructor

Parameters

• payload Object

sendCommand

Send command to device

Parameters

• command Object

Returns Promise<>

powerOn

Power on/off the device

Parameters

• power string
• effect string
• duration number

Returns Promise<>

createDeviceFromMessage

Create a Device instance from a raw message

Parameters

• msg Buffer

Returns Device

Discover

Extends EventEmitter

Discover Yeelight devices on demand

constructor

Constructor

discover

Start discovery of Yeelight Devices. It will send a multicast message and wait for response. Emits message event on response.

Returns Any

stop

Stop discovery

Logger

Logger class

constructor

Constructor

Parameters

• options Object

info

Log an info message

Parameters

• msg string

Returns Any

Store

MemoryStore

Extends Store

Memory store for Yeelight devices

constructor

Constructor

add

Add a Device to the store

Parameters

• device Device

Returns Any

getById

Get Device by Id

Parameters

• id string

Returns (Device | Any)

removeById

Remove Device from the store

Parameters

• id string

Returns Any

get

Get all devices

Returns Array<Device>

Watch

Extends EventEmitter

Class for watching for advertisments packets from Yeelight devices.

constructor

Constructor

watch

Start listening for advertisments packets from Yeelight devices. Emits message event on response.

Returns Any

stop

Stop watching

Yeelight

Extends EventEmitter

Device manager for your Yeelight devices

constructor

Constructor

Parameters

• options Object

discover

Start the discovery of connected Yeelight devices. Return devices found after discoveryTimeout.

Parameters

• discoveryTimeout number

Returns Promise<Array<Device>>

watch

Start watching for advertisment packets of Yeelight devices. Emits devices on device event.

Returns Any

stop

Stop watching

Returns Any