Class PowerSensorClient

A gRPC-web client for the PowerSensor component.

Implements

PowerSensor

Index

Constructors

Properties

callOptions name

Methods

doCommand getCurrent getPower getReadings getStatus getVoltage

Constructors

constructor

new PowerSensorClient(
    client: Client,
    name: string,
    options?: Options,
): PowerSensorClient
Parameters
- client: Client
- name: string
- options: Options = {}
Returns PowerSensorClient

Properties

callOptions

callOptions: CallOptions = ...

`Readonly`name

name: string

The name of the resource.

Methods

doCommand

doCommand(
command: Struct | Record<string, JsonValue>,
callOptions?: CallOptions,
): 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.
- callOptions: CallOptions = ...
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' } }));
```
Implementation of PowerSensor.doCommand

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();
```
For more information, see Power Sensor API.
Implementation of PowerSensor.getCurrent

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();
```
For more information, see Power Sensor API.
Implementation of PowerSensor.getPower

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();
```
For more information, see Power Sensor API.
Implementation of PowerSensor.getReadings

getStatus

getStatus(callOptions?: CallOptions): Promise<JsonValue>
Get the status of the resource.
Parameters
- callOptions: CallOptions = ...
Returns Promise<JsonValue>
Implementation of PowerSensor.getStatus

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();
```
For more information, see Power Sensor API.
Implementation of PowerSensor.getVoltage