Interface Lighting

interface Lighting {
    get lightState(): LightState;
    getLightDetails(sendOptions?: SendOptions): Promise<unknown>;
    getLightState(sendOptions?: SendOptions): Promise<LightState>;
    setLightState(
        lightState: LightStateInput,
        sendOptions?: SendOptions,
    ): Promise<true>;
}

Index

Accessors

Methods

getLightDetails getLightState setLightState

Accessors

lightState

get lightState(): LightState
Returns cached results from last retrieval of lightingservice.get_light_state.

Returns LightState
cached results from last retrieval of lightingservice.get_light_state.
- Defined in packages/tplink-smarthome-api/src/bulb/lighting.ts:104

Methods

getLightDetails

getLightDetails(sendOptions?: SendOptions): Promise<unknown>
Get Bulb light details.

Requests lightingservice.get_light_details.
Parameters
- OptionalsendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
- Defined in packages/tplink-smarthome-api/src/bulb/lighting.ts:220

getLightState

getLightState(sendOptions?: SendOptions): Promise<LightState>
Get Bulb light state.

Requests lightingservice.get_light_state.
Parameters
- OptionalsendOptions: SendOptions
Returns Promise<LightState>
parsed JSON response

Throws
ResponseError
- Defined in packages/tplink-smarthome-api/src/bulb/lighting.ts:143

setLightState

setLightState(
lightState: LightStateInput,
sendOptions?: SendOptions,
): Promise<true>
Sets Bulb light state (on/off, brightness, color, etc).

Sends lightingservice.transition_light_state command.
Parameters
- lightState: LightStateInput
  light state
- OptionalsendOptions: SendOptions
  send options
Returns Promise<true>
- Defined in packages/tplink-smarthome-api/src/bulb/lighting.ts:166