Interface Switch

Represents a physical switch with multiple positions.

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

Hierarchy (View Summary, Expand)

Implemented by

Properties

getNumberOfPositions getPosition name setPosition

Methods

doCommand

Properties

getNumberOfPositions

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

Get the total number of positions available on the switch.

getPosition

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

Get the current position of the switch.

Readonlyname

name: string

The name of the resource.

setPosition

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

Set the switch to a specific position.

Methods

doCommand

Settings

Member Visibility

On This Page

Properties
Methods
MMNEPVFCICPMFPCPTTAAATR