Interface PowerSensor

Represents any sensor that reports voltage, current, and/or power

interface PowerSensor {
    doCommand: ((command) => Promise<StructType>);
    getCurrent(extra?): Promise<readonly [number, boolean]>;
    getPower(extra?): Promise<number>;
    getReadings(extra?): Promise<Record<string, unknown>>;
    getVoltage(extra?): Promise<readonly [number, boolean]>;
}

Hierarchy (view full)

Implemented by

Properties

doCommand

Methods

getCurrent getPower getReadings getVoltage

Properties

doCommand

doCommand: ((command) => Promise<StructType>)

Send/Receive arbitrary commands to the resource.

Type declaration

Methods

getCurrent

  • getCurrent(extra?): Promise<readonly [number, boolean]>

  • Get Current in amps and a boolean that returns true if AC

    Parameters

    Returns Promise<readonly [number, boolean]>

getPower

  • getPower(extra?): Promise<number>

  • Get Power in watts

    Parameters

    Returns Promise<number>

getReadings

  • getReadings(extra?): Promise<Record<string, unknown>>

  • Return the readings of a sensor.

    Parameters

    Returns Promise<Record<string, unknown>>

getVoltage

  • getVoltage(extra?): Promise<readonly [number, boolean]>

  • Get Voltage in volts and a boolean that returns true if AC

    Parameters

    Returns Promise<readonly [number, boolean]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc