Class SensorClient

constructor

• new SensorClient(client: Client, name: string, options?: Options): SensorClient

  Parameters

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

  Returns SensorClient

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

  import { Struct } from '@viamrobotics/sdk';
  
  const result = await resource.doCommand(
    Struct.fromJson({
      myCommand: { key: 'value' },
    })
  );
  Copy

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 sensor = new VIAM.SensorClient(machine, 'my_sensor');
  
  // Get the readings of a sensor.
  const readings = await sensor.getReadings();
  Copy

  For more information, see Sensor API.