Class DeviceWithPowerToggleBrightnessColor<StatusBody, CommandBody>

Type Parameters

StatusBody extends BaseDeviceWithPowerBrightnessColorStatusBody<DeviceTypes>
CommandBody

Hierarchy (View Summary)

DeviceWithPowerToggleBrightness<StatusBody, CommandBody>
- DeviceWithPowerToggleBrightnessColor
  - default
  - default

Index

Constructors

constructor

new DeviceWithPowerToggleBrightnessColor<
    StatusBody extends
        BaseDeviceWithPowerBrightnessColorStatusBody<
            | "Blind Tilt"
            | "Bot"
            | "Curtain"
            | "Curtain 3"
            | "Hub"
            | "Hub 2"
            | "Hub Plus"
            | "Hub Mini"
            | "Meter"
            | "MeterPlus"
            | "WoIOSensor"
            | "Smart Lock"
            | "Keypad"
            | "Keypad Touch"
            | "Remote"
            | "Motion Sensor"
            | "Contact Sensor"
            | "Ceiling Light"
            | "Ceiling Light Pro"
            | "Plug Mini (US)"
            | "Plug Mini (JP)"
            | "Plug"
            | "Strip Light"
            | "Color Bulb"
            | "Robot Vacuum Cleaner S1"
            | "Robot Vacuum Cleaner S1 Plus"
            | "Humidifier"
            | "Indoor Cam"
            | "Pan/Tilt Cam",
        >,
    CommandBody,
>(
    deviceId: string,
    deps: Deps,
): DeviceWithPowerToggleBrightnessColor<StatusBody, CommandBody>
Type Parameters
- StatusBody extends BaseDeviceWithPowerBrightnessColorStatusBody<
      | "Blind Tilt"
      | "Bot"
      | "Curtain"
      | "Curtain 3"
      | "Hub"
      | "Hub 2"
      | "Hub Plus"
      | "Hub Mini"
      | "Meter"
      | "MeterPlus"
      | "WoIOSensor"
      | "Smart Lock"
      | "Keypad"
      | "Keypad Touch"
      | "Remote"
      | "Motion Sensor"
      | "Contact Sensor"
      | "Ceiling Light"
      | "Ceiling Light Pro"
      | "Plug Mini (US)"
      | "Plug Mini (JP)"
      | "Plug"
      | "Strip Light"
      | "Color Bulb"
      | "Robot Vacuum Cleaner S1"
      | "Robot Vacuum Cleaner S1 Plus"
      | "Humidifier"
      | "Indoor Cam"
      | "Pan/Tilt Cam",
  >
- CommandBody
Parameters
- deviceId: string
- deps: Deps
Returns DeviceWithPowerToggleBrightnessColor<StatusBody, CommandBody>
Inherited from DeviceWithPowerToggleBrightness.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 DeviceWithPowerToggleBrightness._getPath
- Defined in devices/Device.ts:35

getHubDeviceId

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

getPowerStatus

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

getStatus

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

`Protected`sendCommand

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

setBrightness

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

setColor

setColor(rgb: [number, number, number]): Promise<CommandBody>
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<CommandBody>
- Defined in devices/Device.ts:150

toggle

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

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

turnOff

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

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

turnOn

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

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

Class DeviceWithPowerToggleBrightnessColor<StatusBody, CommandBody>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DeviceWithPowerToggleBrightnessColor<StatusBody, CommandBody>

Properties

Protected Readonly_deps

Protected Readonly_deviceId

Methods

Protected_getPath

Parameters

Returns string

getHubDeviceId

Returns Promise<string>

getPowerStatus

Returns Promise<"on" | "off">

getStatus

Parameters

Returns Promise<StatusBody>

ProtectedsendCommand

Parameters

Returns Promise<CommandBody>

setBrightness

Parameters

Returns Promise<CommandBody>

setColor

Parameters

Returns Promise<CommandBody>

toggle

Returns Promise<CommandBody>

turnOff

Returns Promise<CommandBody>

turnOn

Returns Promise<CommandBody>

Settings

On This Page

`Protected` `Readonly`_deps

`Protected` `Readonly`_deviceId

`Protected`_getPath

`Protected`sendCommand