Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Light

The light device class.

This class manipulates light.

Hierarchy

  • InfraredDevice<LightCommand>
    • Light

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly client

client: RestClient

Protected Readonly deviceId

deviceId: string

Protected Readonly deviceType

deviceType: RegExp = ...

Methods

changeBrightness

  • changeBrightness(brightness: "up" | "down"): Promise<Record<string, never>>

  • Change the brightness.

    Parameters

    • brightness: "up" | "down"

      If set to up (resp. down), the brightness level increases (resp. decreases).

    Returns Promise<Record<string, never>>

Protected manipulate

  • manipulate(command: LightCommand): Promise<Record<string, never>>

  • Parameters

    • command: LightCommand

    Returns Promise<Record<string, never>>

turnOff

  • turnOff(): Promise<Record<string, never>>

  • Turn off the device.

    Returns Promise<Record<string, never>>

    Response of the command execution.

turnOn

  • turnOn(): Promise<Record<string, never>>

  • Turn on the device.

    Returns Promise<Record<string, never>>

    Response of the command execution.

validateId

  • validateId(): Promise<boolean>

  • Check if the device type associated with the device ID is consistent with the class.

    throws

    Will throw an error if the device ID is not found in the infrared remote list.

    Returns Promise<boolean>

    true if the device type is consistent with the class, false otherwise.

Generated using TypeDoc