yeelight-wifi 2.2.0 | Documentation

yeelight-wifi

2.2.0

YeelightSearch ▸
- Instance members
- #addLight
- #getYeelights
- #getYeelightById
- #refresh
Yeelight ▸
- Instance members
- #getId
- #getModel
- #getName
- #setName
- #getValues
- #toggle
- #setDefaultState
- #setColorTemperature
- #setBrightness
- #turnOn
- #turnOff
- #setScene
- #setRGB
- #setHSV
- #addCron
- #getCron
- #deleteCron
- #setAdjust
- #setMusicMode
- #startColorFlow
- #stopColorFlow

YeelightSearch

Create a new instance of the YeelightSearch class and start searching for new Yeelights once a Yeelight has been found it will create an Yeelight instance and emits the 'found' event light the Yeelight instance as payload

new YeelightSearch()

Extends EventEmitter

Instance Members

▸ addLight(lightdata)

src/index.js

adds a new light to the lights array

addLight(lightdata: any)

Parameters

lightdata (any)

▸ getYeelights()

src/index.js

returns a list of all found Yeelights

getYeelights(): array<Yeelight>

Returns

array<Yeelight>: array with yeelight instances

▸ getYeelightById(id)

src/index.js

returns one Yeelight found by id

getYeelightById(id: string): Yeelight

Parameters

id (string) Yeelight Id

Returns

Yeelight: Yeelight instance

▸ refresh()

src/index.js

refresh lights sending a new m-search

refresh()

Yeelight

src/Yeelight.js

Class Yeelight provides all functionality

new Yeelight(data: any, yeelightData: object)

Extends EventEmitter

Parameters

data (any)

yeelightData (object)

Example

{
 LOCATION: 'yeelight://10.0.0.33:55443',
 ID: '0x0000000000000000',
 SUPPORT: 'get_prop set_default set_power toggle set_bright start_cf stop_cf set_scene cron_add cron_get cron_del set_ct_abx set_rgb set_hsv set_adjust set_music set_name',
 NAME: 'Living Room',
 MODEL: 'color',
}

Instance Members

▸ getId()

src/Yeelight.js

returns The ID provided by the Yeelight

getId(): string

Returns

string: uuid given by the yeelightData

▸ getModel()

src/Yeelight.js

returns The MODEL provided by the Yeelight

getModel(): string

Returns

string: model string 'color' or 'mono'

▸ getName()

src/Yeelight.js

returns The NAME provided by the Yeelight

getName(): string

Returns

string: Yeelight name

▸ setName(name)

src/Yeelight.js

Sets the name on the Yeelight

setName(name: string): Promise

Parameters

name (string)

Returns

Promise: will be invoked after successfull or failed send

▸ getValues(props)

src/Yeelight.js

This method is used to retrieve current property of smart LED.

getValues(props: array): Promise

Parameters

props (array) The parameter is a list of property names and the response contains a list of corresponding property values. If the requested property name is not recognized by smart LED, then a empty string value ("") will be returned.

Returns

Promise: will be invoked after successfull or failed send

Example

getValues('power', 'bright');

▸ toggle()

src/Yeelight.js

This method is used to toggle the smart LED.

toggle(): Promise

Returns

Promise: will be invoked after successfull or failed send

▸ setDefaultState()

src/Yeelight.js

This method is used to save current state of smart LED in persistent memory. So if user powers off and then powers on the smart LED again (hard power reset), the smart LED will show last saved state.

setDefaultState(): Promise

Returns

Promise: will be invoked after successfull or failed send

▸ setColorTemperature(temperature, effect, time)

src/Yeelight.js

Will change the color temperature of the Yeelight

setColorTemperature(temperature: string, effect: string, time: number): Promise

Parameters

temperature (string) is the target color temperature. The type is integer and range is 1700 ~ 6500 (k).

effect

(string
            = 'smooth')

support two values: 'sudden' and 'smooth'. If effect is 'sudden', then the color temperature will be changed directly to target value, under this case, the third parameter 'duration' is ignored. If effect is 'smooth', then the color temperature will be changed to target value in a gradual fashion, under this case, the total time of gradual change is specified in third parameter "duration".

time

(number
            = 1000)

time specifies the total time of the gradual changing. The unit is milliseconds. The minimum support duration is 30 milliseconds.

Returns

Promise: will be invoked after successfull or failed send

Example

setColorTemperature(5000);
setColorTemperature(5000, 'sudden');
setColorTemperature(5000, 'smooth', 1000);

▸ setBrightness(brightness, effect, time)

src/Yeelight.js

This method is used to change the brightness of a smart LED.

setBrightness(brightness: string, effect: string, time: number): Promise

Parameters

brightness (string) is the target brightness. The type is integer and ranges from 1 to 100. The brightness is a percentage instead of a absolute value. 100 means maximum brightness while 1 means the minimum brightness.

effect

(string
            = 'smooth')

Refer to 'setColorTemperature' method.

time

(number
            = 1000)

Refer to 'setColorTemperature' method.

Returns

Promise: will be invoked after successfull or failed send

Example

setBrightness(25);
setBrightness(25, 'sudden');
setBrightness(25, 'smooth', 1000);

▸ turnOn(effect, time)

src/Yeelight.js

This method is used to switch on the smart LED (software managed on/off).

turnOn(effect: string, time: number): Promise

Parameters

effect

(string
            = 'smooth')

Refer to 'setColorTemperature' method.

time

(number
            = 1000)

Refer to 'setColorTemperature' method.

Returns

Promise: will be invoked after successfull or failed send

Example

turnOn();
turnOn('sudden');
turnOn('smooth', 1000);

▸ turnOff(effect, time)

src/Yeelight.js

This method is used to switch off the smart LED (software managed on/off).

turnOff(effect: string, time: number): Promise

Parameters

effect

(string
            = 'smooth')

Refer to 'setColorTemperature' method.

time

(number
            = 1000)

Refer to 'setColorTemperature' method.

Returns

Promise: will be invoked after successfull or failed send

Example

turnOff();
turnOff('sudden');
turnOff('smooth', 1000);

▸ setScene(params)

src/Yeelight.js

This method is used to set the smart LED directly to specified state. If + the smart LED is off, then it will turn on the smart LED firstly and then apply the specified command.

setScene(params: array): Promise

Parameters

params (array) can be "color", "hsv", "ct", "cf", "auto_dealy_off".
"color" means change the smart LED to specified color and brightness.
"hsv" means change the smart LED to specified color and brightness"
"ct" means change the smart LED to specified ct and brightness.
"cf" means start a color flow in specified fashion.
c"auto_delay_off" means turn on the smart LED to specified brightness and start a sleep timer to turn off the light after the specified minutes. "val1", "val2", "val3" are class specific.

Returns

Promise: will be invoked after successfull or failed send

Example

setScene(['color', 65280, 70]);
setScene(['hsv', 300, 70, 100]);
setScene(['ct', 5400, 100]);
setScene(['cf', 0, 0, '500,1,255,100,1000,1,16776960,70']);

▸ setRGB(hex, effect, time)

src/Yeelight.js

This method is used to change the color of a smart LED.

setRGB(hex: string, effect: string, time: number): Promise

Parameters

hex (string) is the target color, whose type is integer. It should be expressed in hex 0xFFFFFF.

effect

(string
            = 'smooth')

Refer to 'setColorTemperature' method.

time

(number
            = 1000)

Refer to 'setColorTemperature' method.

Returns

Promise: will be invoked after successfull or failed send

Example

setRGB('#ffffff');
setRGB('#ffffff', 'sudden');
setRGB('#ffffff', 'smooth', 1000);

▸ setHSV(hue, saturation, effect, time)

src/Yeelight.js

This method is used to change the color of a smart LED.

setHSV(hue: string, saturation: string, effect: string, time: number): Promise

Parameters

hue (string) "hue" is the target hue value, whose type is integer. It should be expressed in decimal integer ranges from 0 to 359.

saturation (string) is the target saturation value whose type is integer. It's range is 0 to 100.

effect

(string
            = 'smooth')

Refer to 'setColorTemperature' method.

time

(number
            = 1000)

Refer to 'setColorTemperature' method.

Returns

Promise: will be invoked after successfull or failed send

Example

setHSV(100, 50);
setHSV(100, 50, 'sudden');
setHSV(100, 50, 'smooth', 1000);

▸ addCron(type, value)

src/Yeelight.js

This method is used to start a timer job on the smart LED.

addCron(type: string, value: string): Promise

Parameters

type (string) currently can only be 0. (means power off)

value (string) is the length of the timer (in minutes).

Returns

Promise: will be invoked after successfull or failed send

Example

addCron(0, 15);

▸ getCron(index, type)

src/Yeelight.js

This method is used to retrieve the setting of the current cron job of the specified type.

getCron(index: any, type: string): Promise

Parameters

index (any)

type (string) the type of the cron job. (currently only support 0).

Returns

Promise: will be invoked after successfull or failed send

Example

getCron(0);

▸ deleteCron(index, type)

src/Yeelight.js

This method is used to stop the specified cron job.

deleteCron(index: any, type: string): Promise

Parameters

index (any)

type (string) the type of the cron job. (currently only support 0).

Returns

Promise: will be invoked after successfull or failed send

Example

deleteCron(0);

▸ setAdjust(action, prop)

src/Yeelight.js

This method is used to change brightness, CT or color of a smart LED without knowing the current value, it's main used by controllers.

setAdjust(action: string, prop: string): Promise

Parameters

action (string) the direction of the adjustment. The valid value can be:
'increase': increase the specified property
'decrease': decrease the specified property
'circle': increase the specified property, after it reaches the max value, go back to minimum value

prop (string) the property to adjust. The valid value can be:
'bright': adjust brightness.
'ct': adjust color temperature.
'color': adjust color. (When 'prop' is 'color', the 'action' can only be 'circle', otherwise, it will be deemed as invalid request.)

Returns

Promise: will be invoked after successfull or failed send

Example

setAdjust('increase', 'bright');

▸ setMusicMode(action, host, port)

src/Yeelight.js

This method is used to start or stop music mode on a device. Under music mode, no property will be reported and no message quota is checked.

setMusicMode(action: number, host: string, port: string): Promise

Parameters

action (number) the action of set_music command. The valid value can be:
0: turn off music mode.
1: turn on music mode.

host (string) the IP address of the music server.

port (string) the TCP port music application is listening on

Returns

Promise: will be invoked after successfull or failed send

Example

setMusicMode(0, '10.0.0.1', 4000);

▸ startColorFlow(count, action, flowExpression)

src/Yeelight.js

This method is used to start a color flow. Color flow is a series of smart LED visible state changing. It can be brightness changing, color changing or color temperature changing.

startColorFlow(count: number, action: string, flowExpression: string): Promise

Parameters

count (number) is the total number of visible state changing before color flow stopped. 0 means infinite loop on the state changing.

action (string) is the action taken after the flow is stopped.
0: means smart LED recover to the state before the color flow started.
1: means smart LED stay at the state when the flow is stopped.
2: means turn off the smart LED after the flow is stopped.

flowExpression (string) is the expression of the state changing series.

Returns

Promise: will be invoked after successfull or failed send

Example

startColorFlow(4, 2, '1000, 2, 2700, 100, 500, 1, 255, 10, 500, 2, 5000, 1');

▸ stopColorFlow()

src/Yeelight.js

This method is used to stop a running color flow

stopColorFlow(): Promise

Returns

Promise: will be invoked after successfull or failed send

Example

stopColorFlow();