Class PowerSensorClient

A gRPC-web client for the PowerSensor component.

Hierarchy

PowerSensorClient

Implements

PowerSensor

Index

Constructors

Properties

client name options

Accessors

powersensorService

Methods

doCommand getCurrent getPower getReadings getVoltage

Constructors

constructor

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

Properties

`Private` client

client: PowerSensorServiceClient

`Private` `Readonly` name

name: string

`Private` `Readonly` options

options: Options

Accessors

`Private` powersensorService

get powersensorService(): PowerSensorServiceClient
Returns PowerSensorServiceClient

Methods

doCommand

doCommand(command: StructType): Promise<StructType>
Send/Receive arbitrary commands to the resource.
Parameters
- command: StructType
  
  The command to execute.
Returns Promise<StructType>

Implementation of PowerSensor.doCommand

getCurrent

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

Implementation of PowerSensor.getCurrent

getPower

getPower(extra?: {}): Promise<number>
Get Power in watts
Parameters
- extra: {} = {}
Returns Promise<number>

Implementation of PowerSensor.getPower

getReadings

getReadings(extra?: {}): Promise<Record<string, unknown>>
Return the readings of a sensor.
Parameters
- extra: {} = {}
Returns Promise<Record<string, unknown>>

Implementation of PowerSensor.getReadings

getVoltage

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

Implementation of PowerSensor.getVoltage

Generated using TypeDoc