Class PowerSensorClient

constructor

• new PowerSensorClient(
      client: RobotClient,
      name: string,
      options?: Options,
  ): PowerSensorClient

  Parameters

  • client: RobotClient
  • name: string
  • options: Options = {}

  Returns PowerSensorClient

callOptions

Readonlyname

doCommand

• doCommand(command: Struct, callOptions?: CallOptions): Promise<JsonValue>

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct

    The command to execute.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  Example

  const result = await resource.doCommand({
    name: 'myCommand',
    args: { key: 'value' },
  });
  Copy

getCurrent

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

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

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<readonly [number, boolean]>

  Example

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

  For more information, see Power Sensor API.

getPower

• getPower(extra?: {}, callOptions?: CallOptions): Promise<number>

  Get power in watts.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<number>

  Example

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

  For more information, see Power Sensor API.

getReadings

• getReadings(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<Record<string, JsonValue>>

  Return the readings of a sensor.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<Record<string, JsonValue>>

  Example

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

  For more information, see Power Sensor API.

getVoltage

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

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

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<readonly [number, boolean]>

  Example

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

  For more information, see Power Sensor API.