Class default

Hierarchy (View Summary)

DeviceWithPowerToggleBrightnessColor<StatusBody, CommandBody>
- default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath getHubDeviceId getPowerStatus getStatus sendCommand setBrightness setColor setColorTemperature toggle turnOff turnOn

Constructors

constructor

new default(deviceId: string, deps: Deps): default
Parameters
- deviceId: string
- deps: Deps
Returns default
Inherited from DeviceWithPowerToggleBrightnessColor.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 DeviceWithPowerToggleBrightnessColor._getPath
- Defined in devices/Device.ts:35

getHubDeviceId

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

getPowerStatus

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

getStatus

getStatus(options?: GetStatusOptions): Promise<StatusBody>
Parameters
- options: GetStatusOptions = {}
Returns Promise<StatusBody>
Inherited from DeviceWithPowerToggleBrightnessColor.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 DeviceWithPowerToggleBrightnessColor.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 DeviceWithPowerToggleBrightnessColor.setBrightness
- Defined in devices/Device.ts:132

setColor

setColor(rgb: [number, number, number]): Promise<any>
Set color.
Parameters
- rgb: [number, number, number]
  An array of 3 numbers representing the RGB values.
  
  rgb[0] is the red value (0-255).
  
  rgb[1] is the green value (0-255).
  
  rgb[2] is the blue value (0-255).
  
  E.g., [255, 0, 0] is red.
Returns Promise<any>
Inherited from DeviceWithPowerToggleBrightnessColor.setColor
- Defined in devices/Device.ts:150

setColorTemperature

setColorTemperature(colorTemperature: number): Promise<any>
Set color temperature.
Parameters
- colorTemperature: number
  Number between 2700 and 6500.
Returns Promise<any>
- Defined in devices/SwitchBotColorBulb.ts:28

toggle

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

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

turnOff

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

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

turnOn

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

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