Interface PowerSensor

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

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

Hierarchy (view full)

Sensor
- PowerSensor

Implemented by

PowerSensorClient

Index

Methods

doCommand getCurrent getPower getReadings getVoltage

Methods

doCommand

doCommand(command): Promise<JsonValue>
Send/Receive arbitrary commands to the resource.
Parameters
- command: Struct
  The command to execute.
Returns Promise<JsonValue>
Inherited from Sensor.doCommand

getCurrent

getCurrent(extra?): Promise<readonly [number, boolean]>
Get Current in amps and a boolean that returns true if AC
Parameters
- Optional extra: Struct
Returns Promise<readonly [number, boolean]>

getPower

getPower(extra?): Promise<number>
Get Power in watts
Parameters
- Optional extra: Struct
Returns Promise<number>

getReadings

getReadings(extra?): Promise<Record<string, JsonValue>>
Return the readings of a sensor.
Parameters
- Optional extra: Struct
Returns Promise<Record<string, JsonValue>>
Overrides Sensor.getReadings

getVoltage

getVoltage(extra?): Promise<readonly [number, boolean]>
Get Voltage in volts and a boolean that returns true if AC
Parameters
- Optional extra: Struct
Returns Promise<readonly [number, boolean]>

Generated using TypeDoc