Class default

Hierarchy (View Summary)

DeviceWithPowerToggleBrightnessColorTemperature<StatusBody, CommandBody>
- default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath getHubDeviceId getPowerStatus getStatus sendCommand setBrightness setColorTemperature toggle turnOff turnOn

Constructors

constructor

new default(deviceId: string, deps: Deps): default
Parameters
- deviceId: string
- deps: Deps
Returns default
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.constructor
- Defined in devices/Device.ts:30

Properties

`Protected` `Readonly`_deps

_deps: Deps

`Protected` `Readonly`_deviceId

_deviceId: string

Methods

`Protected`_getPath

_getPath(path: string): string
Parameters
- path: string
Returns string
Inherited from DeviceWithPowerToggleBrightnessColorTemperature._getPath
- Defined in devices/Device.ts:35

getHubDeviceId

getHubDeviceId(): Promise<string>
Returns Promise<string>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.getHubDeviceId
- Defined in devices/Device.ts:61

getPowerStatus

getPowerStatus(): Promise<"on" | "off">
Returns Promise<"on" | "off">
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.getPowerStatus
- Defined in devices/Device.ts:86

getStatus

getStatus(options?: GetStatusOptions): Promise<StatusBody>
Parameters
- options: GetStatusOptions = {}
Returns Promise<StatusBody>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.getStatus
- Defined in devices/Device.ts:46

`Protected`sendCommand

sendCommand(command: string, parameter?: any): Promise<any>
Parameters
- command: string
- parameter: any = "default"
Returns Promise<any>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.sendCommand
- Defined in devices/Device.ts:66

setBrightness

setBrightness(brightness: number): Promise<any>
Set brightness.
Parameters
- brightness: number
  Number between 0 and 100.
Returns Promise<any>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.setBrightness
- Defined in devices/Device.ts:131

setColorTemperature

setColorTemperature(colorTemperature: number): Promise<any>
Set color temperature.
Parameters
- colorTemperature: number
  Number between 2700 and 6500.
Returns Promise<any>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.setColorTemperature
- Defined in devices/Device.ts:164

toggle

toggle(): Promise<any>
Toggle the device power state.

Returns Promise<any>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.toggle
- Defined in devices/Device.ts:118

turnOff

turnOff(): Promise<any>
Set the device to off state.

Returns Promise<any>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.turnOff
- Defined in devices/Device.ts:106

turnOn

turnOn(): Promise<any>
Set the device to on state.

Returns Promise<any>
Inherited from DeviceWithPowerToggleBrightnessColorTemperature.turnOn
- Defined in devices/Device.ts:99