Class SensorClient

constructor

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

  Parameters

  • client: RobotClient
  • 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

  const result = await resource.doCommand({
    name: 'myCommand',
    args: { 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