Class MovementSensorClient

constructor

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

  Parameters

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

  Returns MovementSensorClient

callOptions

Readonlyname

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' } })
  );
  Copy

getAccuracy

• getAccuracy(extra?: {}, callOptions?: CallOptions): Promise<GetAccuracyResponse>

  Get the accuracy of various sensors.

  Parameters

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

  Returns Promise<GetAccuracyResponse>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const accuracy = await movementSensor.getAccuracy();
  Copy

  For more information, see Movement Sensor API.

getAngularVelocity

• getAngularVelocity(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<commonApi.Vector3>

  Get the angular velocity across x/y/z axes.

  Parameters

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

  Returns Promise<commonApi.Vector3>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const angularVelocity = await movementSensor.getAngularVelocity();
  Copy

  For more information, see Movement Sensor API.

getCompassHeading

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

  Get the compass heading, which is a number from 0-359 where 0 is North, 90 is East, 180 is South, and 270 is West.

  Parameters

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

  Returns Promise<number>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const compassHeading = await movementSensor.getCompassHeading();
  Copy

  For more information, see Movement Sensor API.

getLinearAcceleration

• getLinearAcceleration(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<commonApi.Vector3>

  Get linear acceleration across x/y/z axes.

  Parameters

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

  Returns Promise<commonApi.Vector3>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const linearAcceleration =
    await movementSensor.getLinearAcceleration();
  Copy

  For more information, see Movement Sensor API.

getLinearVelocity

• getLinearVelocity(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<commonApi.Vector3>

  Get linear velocity across x/y/z axes.

  Parameters

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

  Returns Promise<commonApi.Vector3>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const linearVelocity = await movementSensor.getLinearVelocity();
  Copy

  For more information, see Movement Sensor API.

getOrientation

• getOrientation(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<commonApi.Orientation>

  Get the current orientation of the sensor.

  Parameters

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

  Returns Promise<commonApi.Orientation>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const orientation = await movementSensor.getOrientation();
  Copy

  For more information, see Movement Sensor API.

getPosition

• getPosition(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<movementSensorApi.GetPositionResponse>

  Get the current position latitude, longitude, and altitude.

  Parameters

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

  Returns Promise<movementSensorApi.GetPositionResponse>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const position = await movementSensor.getPosition();
  Copy

  For more information, see Movement Sensor API.

getProperties

• getProperties(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<movementSensorApi.GetPropertiesResponse>

  Get the properties of this movement sensor.

  Parameters

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

  Returns Promise<movementSensorApi.GetPropertiesResponse>

  Example

  const movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const properties = await movementSensor.getProperties();
  Copy

  For more information, see Movement 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 movementSensor = new VIAM.MovementSensorClient(
    machine,
    'my_movement_sensor'
  );
  const readings = await movementSensor.getReadings();
  Copy

  For more information, see Movement Sensor API.