yeelight-awesome

/// <reference types="node" /> import { EventEmitter } from "events"; import { AdjustType, Color, Command, CommandType, DevicePropery, FlowState, ICommandResult, IConfig, IEventResult, Scene, StartFlowAction } from "./models"; import { ILogger } from "./models/logger"; /** * The client to connect and control the light */ export declare class Yeelight extends EventEmitter { private options; private logger?; connected: boolean; autoReconnect: boolean; disablePing: boolean; autoReconnectTime: number; connectTimeout: number; private client; private commandId; private sentCommands; private resultCommands; private isConnecting; private isClosing; private isReconnecting; private reconnectTimeout; private pingTimeout; private readonly EVENT_NAME; /** * @constructor * @param {IConfig} options : The client config initial the client */ constructor(options: IConfig, logger?: ILogger); onData(data: Buffer): void; onMessage(result: ICommandResult): void; /** * Drop connection/listerners and clean up resources. */ disconnect(): Promise<void>; /** * establish connection to light, * @returns return promise of the current instance */ connect(): Promise<Yeelight>; setPower(turnOn?: boolean, effect?: "smooth" | "sudden", duration?: number): Promise<IEventResult>; /** * This method is used to start a timer job on the smart LED. * Only accepted if the smart LED is currently in "on" state * @param type currently can only be 0. (means power off) * @param time the length of the timer (in minutes). Request * @returns {Promise<IEventResult>} return a promise of IEventResult */ cronAdd(type: number, time: number): Promise<IEventResult>; /** * This method is used to retrieve the setting of the current cron job of the specified type. * @param type currently can only be 0. (means power off) * @returns {Promise<IEventResult>} return a promise of IEventResult */ cronGet(type: number): Promise<IEventResult>; /** * This method is used to retrieve the setting of the current cron job of the specified type. * @param type currently can only be 0. (means power off) * @returns {Promise<IEventResult>} return a promise of IEventResult */ cronDelete(type: number): Promise<IEventResult>; /** * This method is used to toggle the smart LED. * This method is used to switch on or off the smart LED (software managed on/off) * @returns {Promise<ICommandResult>} Return the promise indicate the command success or reject * @returns {Promise<IEventResult>} return a promise of IEventResult */ toggle(): Promise<IEventResult>; /** * 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. * For example, if user likes the current color (red) and brightness (50%) * and want to make this state as a default initial state (every time the smart LED is powered), * then he can use set_default to do a snapshot. * @returns {Promise<IEventResult>} return a promise of IEventResult */ setDefault(): Promise<IEventResult>; /** * 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. This is the most powerful command. * All our recommended scenes, * e.g. Sunrise/Sunset effect is implemented using this method. * With the flow expression, user can actually “program” the light effect. * @param {FlowState[]} states: Each visible state changing is defined to be a flow tuple that contains 4 elements: * [duration, mode, value, brightness]. A flow expression is a series of flow tuples. * So for above request example, it means: change CT to 2700K & maximum brightness gradually in 1000ms, * then change color to red & 10% brightness gradually in 500ms, then stay at this state for 5 seconds, * then change CT to 5000K & minimum brightness gradually in 500ms. * After 4 changes reached, stopped the flow and power off the smart LED. * @param {StarFlowAction} action: is the action taken after the flow is stopped * @param {number} repeat is the total number of visible state changing before color flow * stopped. 0 means infinite loop on the state changing. @default infinity * @returns {Promise<IEventResult>} return a promise of IEventResult */ startColorFlow(states: FlowState[], action?: StartFlowAction, repeat?: number): Promise<IEventResult>; /** * This method is used to stop a running color flow. */ stopColorFlow(): Promise<IEventResult>; /** * 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 * @param scene type of scene to update * @returns {Promise<IEventResult>} return a promise of IEventResult */ setScene<T extends Scene>(scene: T): Promise<IEventResult>; /** * This method is used to retrieve current property of smart LED. * @param {string[]} params The parameter is a list of property names and the response contains a * list of corresponding property values. * the requested property name is not recognized by smart LED, then a empty string value ("") will be returned. * Request Example: {"id":1,"method":"get_prop","params":["power", "not_exist", "bright"]} * Example: {"id":1, "result":["on", "", "100"]} * @returns {Promise<IEventResult>} return a promise of IEventResult */ getProperty(params: DevicePropery[]): Promise<IEventResult>; /** * This method is used to change the color temperature of a smart LED. * @param {number} ct the target color temperature. The type is integer and range is 1700 ~ 6500 (k). * @param {"smooth"| "sudden"} effect 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". * @param {number} duration specifies the total time of the gradual changing. The unit is milliseconds. * The minimum support duration is 30 milliseconds. * @returns {Promise<IEventResult>} return a promise of IEventResult */ setCtAbx(ct: number, effect?: "smooth" | "sudden", duration?: number): Promise<IEventResult>; /** * This method is used to change the color of a smart LED. * Only accepted if the smart LED is currently in "on" state. * @param color the target color, whose type is integer. * It should be expressed in decimal integer ranges from 0 to 16777215 (hex: 0xFFFFFF). * can be initial by new Color(233,255,244) * @param {"smooth"| "sudden"} effect 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". * @param {number} duration specifies the total time of the gradual changing. The unit is milliseconds. * The minimum support duration is 30 milliseconds. * @returns {Promise<IEventResult>} return a promise of IEventResult */ setRGB(color: Color, effect: "smooth" | "sudden", duration?: number): Promise<IEventResult>; /** * This method is used to change the color of a smart LED. * Only accepted if the smart LED is currently in "on" state. * @param hue the target hue, whose type is integer. * It should be expressed in decimal integer ranges from 0 to 359. * @param sat the target saturation, whose type is integer. * It should be expressed in decimal integer ranges from 0 to 100. * @param {"smooth"| "sudden"} effect 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". * @param {number} duration specifies the total time of the gradual changing. The unit is milliseconds. * The minimum support duration is 30 milliseconds. * @returns {Promise<IEventResult>} return a promise of IEventResult */ setHSV(hue: number, sat: number, effect?: "smooth" | "sudden", duration?: number): Promise<IEventResult>; /** * This method is used to change the color of a smart LED. * Only accepted if the smart LED is currently in "on" state. * @param brightness 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. * @param {"smooth"| "sudden"} effect 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". * @param {number} duration specifies the total time of the gradual changing. The unit is milliseconds. * The minimum support duration is 30 milliseconds. * @returns {Promise<IEventResult>} return a promise of IEventResult */ setBright(brightness: number, effect?: "smooth" | "sudden", duration?: number): Promise<IEventResult>; /** * @param command 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. * @param {AdjustType} adjustType 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 back to minimum value * @param {string} prop 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<IEventResult>} return a promise of IEventResult */ setAdjust(adjustType: AdjustType, prop: "bright" | "color" | "ct"): Promise<IEventResult>; /** * 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. * @param action the action of set_music command. The valid value can be: * 0: turn off music mode. * 1: turn on music mode. * @param {string} host the IP address of the music server. * @param {number} port the TCP port music application is listening on. * When control device wants to start music mode, it needs start a TCP server firstly and then call “set_music” * command to let the device know the IP and Port of the TCP listen socket. After received the command, * LED device will try to connect the specified peer address. If the TCP connection can be established successfully, * then control device could send all supported commands through this channel without limit to simulate any music * effect. The control device can stop music mode by explicitly send a stop command or just by closing the socket. * @returns {Promise<IEventResult>} return a promise of IEventResult */ setMusic(action: 0 | 1, host: string, port: number): Promise<IEventResult>; /** * This method is used to name the device. * The name will be stored on the device and reported in discovering response. * User can also read the name through “get_prop” method * @param {string} name the name of the device. * When using Yeelight official App, the device name is stored on cloud. * This method instead store the name on persistent memory of the device, so the two names could be different. * @returns {Promise<IEventResult>} return a promise of IEventResult */ setName(name: string): Promise<IEventResult>; /** * This method is used to adjust the brightness by specified percentage within specified duration. * @param {number} percentage the percentage to be adjusted. The range is: -100 ~ 100 * @param {number} duration the milisecond of animation * @returns {Promise<IEventResult>} return a promise of IEventResult */ adjust(type: CommandType.ADJUST_BRIGHT | CommandType.ADJUST_COLOR | CommandType.ADJUST_CT, percentage?: number, duration?: number): Promise<IEventResult>; /** * This method is used to just check if the connection is alive */ ping(): Promise<null>; /** * Use this function to send any command to the light, * please refer to specification to know the structure of command data * @param {Command} command The command to send to light via socket write * @returns {Promise<IEventResult>} return a promise of IEventResult */ sendCommand(command: Command): Promise<IEventResult>; private connectToIp; private wasConnected; private wasDisconnected; private _recoverNetworkError; private triggerPing; private closeConnection; }