Interface Switch

Represents a physical switch with multiple positions.

interface Switch {
    getNumberOfPositions: ((extra?) => Promise<number>);
    getPosition: ((extra?) => Promise<number>);
    setPosition: ((position, extra?) => Promise<void>);
    doCommand(command): Promise<JsonValue>;
}

Hierarchy (view full)

Implemented by

Properties

getNumberOfPositions: ((extra?) => Promise<number>)

Get the total number of positions available on the switch.

Type declaration

    • (extra?): Promise<number>
    • Parameters

      Returns Promise<number>

getPosition: ((extra?) => Promise<number>)

Get the current position of the switch.

Type declaration

    • (extra?): Promise<number>
    • Parameters

      Returns Promise<number>

setPosition: ((position, extra?) => Promise<void>)

Set the switch to a specific position.

Type declaration

    • (position, extra?): Promise<void>
    • Parameters

      • position: number
      • Optional extra: Struct

      Returns Promise<void>

Methods