Interface PowerSensor

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

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

Hierarchy (View Summary)

Implemented by

Properties

name

Methods

doCommand getCurrent getPower getReadings getVoltage

Properties

Readonlyname

name: string

The name of the resource.

Methods

doCommand

  • doCommand(command: Struct | Record<string, JsonValue>): Promise<JsonValue>

    Send/Receive arbitrary commands to the resource.

    Parameters

    • command: Struct | Record<string, JsonValue>

      The command to execute. Accepts either a Struct or a plain object, which will be converted automatically.

    Returns Promise<JsonValue>

    Example

    // Plain object (recommended)
    const result = await resource.doCommand({
      myCommand: { key: 'value' },
    });

    // Struct (still supported)
    import { Struct } from '@viamrobotics/sdk';

    const result = await resource.doCommand(
      Struct.fromJson({ myCommand: { key: 'value' } })
    );

getCurrent

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

    Get Current in amps and a boolean indicating whether the voltage is AC (true) or DC (false).

    Parameters

    Returns Promise<readonly [number, boolean]>

    Example

    const powerSensor = new VIAM.PowerSensorClient(
      machine,
      'my_power_sensor'
    );
    const [current, isAc] = await powerSensor.getCurrent();

    For more information, see Power Sensor API.

getPower

  • getPower(extra?: Struct): Promise<number>

    Get power in watts.

    Parameters

    Returns Promise<number>

    Example

    const powerSensor = new VIAM.PowerSensorClient(
      machine,
      'my_power_sensor'
    );
    const power = await powerSensor.getPower();

    For more information, see Power Sensor API.

getReadings

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

    Return the readings of a sensor.

    Parameters

    Returns Promise<Record<string, JsonValue>>

    Example

    const powerSensor = new VIAM.PowerSensorClient(
      machine,
      'my_power_sensor'
    );
    const readings = await powerSensor.getReadings();

    For more information, see Power Sensor API.

getVoltage

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

    Get voltage in volts and a boolean indicating whether the voltage is AC (true) or DC (false).

    Parameters

    Returns Promise<readonly [number, boolean]>

    Example

    const powerSensor = new VIAM.PowerSensorClient(
      machine,
      'my_power_sensor'
    );
    const [voltage, isAc] = await powerSensor.getVoltage();

    For more information, see Power Sensor API.

Settings

Member Visibility

On This Page

Properties
Methods