Class Lighting

Hierarchy

Lighting

Index

Constructors

Accessors

Methods

getLightDetails getLightState setLightState

Constructors

constructor

new Lighting(device, apiModuleName, setLightStateMethodName): Lighting
Parameters
- device: Bulb
- apiModuleName: string
- setLightStateMethodName: string
Returns Lighting
- Defined in src/bulb/lighting.ts:94

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 src/bulb/lighting.ts:104

Methods

getLightDetails

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

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

Throws
ResponseError
- Defined in src/bulb/lighting.ts:220

getLightState

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

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

Throws
ResponseError
- Defined in src/bulb/lighting.ts:143

setLightState

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

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

Generated using TypeDoc