Interface IWizLight

interface IWizLight {
    destroy(): void;
    getStatus(): Promise<IFullStateResponse>;
    setLightProps(props): Promise<Boolean>;
    setLightStatus(status): Promise<Boolean>;
}

Implemented by

WizLight

Index

Methods

destroy getStatus setLightProps setLightStatus

Methods

destroy

destroy(): void
Stops the Client.

Returns void
- Defined in client.interface.ts:86

getStatus

getStatus(): Promise<IFullStateResponse>
Returns the full status of the light, including if it is on/off, color, mc, rssi

Returns Promise<IFullStateResponse>
- Defined in client.interface.ts:82

setLightProps

setLightProps(props): Promise<Boolean>
Sets the properties of the light, i.e. color, dimming, cold or warm
Parameters
- props: ILightProps
  properties of the light, i.e. color, dimming, cold or warm
Returns Promise<Boolean>
- Defined in client.interface.ts:78

setLightStatus

setLightStatus(status): Promise<Boolean>
Turns the light on or off.
Parameters
- status: Boolean
  Status of the light, should it be ON(true) or OFF(false).
Returns Promise<Boolean>
- Defined in client.interface.ts:73