Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Fan

The fan device class.

This class manipulates fan.

Hierarchy

  • InfraredDevice<FanCommand>
    • Fan

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly client

client: RestClient

Protected Readonly deviceId

deviceId: string

Protected Readonly deviceType

deviceType: RegExp = ...

Methods

Protected manipulate

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

  • Parameters

    • command: FanCommand

    Returns Promise<Record<string, never>>

setSpeed

  • setSpeed(level: "low" | "high" | "middle"): Promise<Record<string, never>>

  • Set the fan speed.

    Parameters

    • level: "low" | "high" | "middle"

      Fan speed level.

    Returns Promise<Record<string, never>>

setTimer

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

  • Set the timer.

    Returns Promise<Record<string, never>>

swing

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

  • Swing the fan.

    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