Interface MovementSensor

Represents any sensor that reports information about the robot's direction, position, and/or speed.

interface MovementSensor {
    name: string;
    doCommand(command: Struct | Record<string, JsonValue>): Promise<JsonValue>;
    getAccuracy(extra?: Struct): Promise<GetAccuracyResponse>;
    getAngularVelocity(
        extra?: Struct,
    ): Promise<PlainMessage<commonApi.Vector3>>;
    getCompassHeading(extra?: Struct): Promise<number>;
    getLinearAcceleration(
        extra?: Struct,
    ): Promise<PlainMessage<commonApi.Vector3>>;
    getLinearVelocity(extra?: Struct): Promise<PlainMessage<commonApi.Vector3>>;
    getOrientation(
        extra?: Struct,
    ): Promise<PlainMessage<commonApi.Orientation>>;
    getPosition(extra?: Struct): Promise<movementSensorApi.GetPositionResponse>;
    getProperties(
        extra?: Struct,
    ): Promise<movementSensorApi.GetPropertiesResponse>;
    getReadings(extra?: Struct): Promise<Record<string, JsonValue>>;
}

Hierarchy (View Summary)

Resource
- MovementSensor

Implemented by

MovementSensorClient

Index

Properties

name

Methods

doCommand getAccuracy getAngularVelocity getCompassHeading getLinearAcceleration getLinearVelocity getOrientation getPosition getProperties getReadings

Properties

`Readonly`name

name: string

The name of the resource.

Methods

doCommand

doCommand(command: Struct | Record<string, JsonValue>): 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.
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' } })
);
```
Inherited from Resource.doCommand

getAccuracy

getAccuracy(extra?: Struct): Promise<GetAccuracyResponse>
Get the accuracy of various sensors.
Parameters
- Optionalextra: Struct
Returns Promise<GetAccuracyResponse>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const accuracy = await movementSensor.getAccuracy();
```
For more information, see Movement Sensor API.

getAngularVelocity

getAngularVelocity(extra?: Struct): Promise<PlainMessage<commonApi.Vector3>>
Get the angular velocity across x/y/z axes.
Parameters
- Optionalextra: Struct
Returns Promise<PlainMessage<commonApi.Vector3>>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const angularVelocity = await movementSensor.getAngularVelocity();
```
For more information, see Movement Sensor API.

getCompassHeading

getCompassHeading(extra?: Struct): 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
- Optionalextra: Struct
Returns Promise<number>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const compassHeading = await movementSensor.getCompassHeading();
```
For more information, see Movement Sensor API.

getLinearAcceleration

getLinearAcceleration(extra?: Struct): Promise<PlainMessage<commonApi.Vector3>>
Get linear acceleration across x/y/z axes.
Parameters
- Optionalextra: Struct
Returns Promise<PlainMessage<commonApi.Vector3>>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const linearAcceleration =
  await movementSensor.getLinearAcceleration();
```
For more information, see Movement Sensor API.

getLinearVelocity

getLinearVelocity(extra?: Struct): Promise<PlainMessage<commonApi.Vector3>>
Get linear velocity across x/y/z axes.
Parameters
- Optionalextra: Struct
Returns Promise<PlainMessage<commonApi.Vector3>>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const linearVelocity = await movementSensor.getLinearVelocity();
```
For more information, see Movement Sensor API.

getOrientation

getOrientation(extra?: Struct): Promise<PlainMessage<commonApi.Orientation>>
Get the current orientation of the sensor.
Parameters
- Optionalextra: Struct
Returns Promise<PlainMessage<commonApi.Orientation>>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const orientation = await movementSensor.getOrientation();
```
For more information, see Movement Sensor API.

getPosition

getPosition(extra?: Struct): Promise<movementSensorApi.GetPositionResponse>
Get the current position latitude, longitude, and altitude.
Parameters
- Optionalextra: Struct
Returns Promise<movementSensorApi.GetPositionResponse>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const position = await movementSensor.getPosition();
```
For more information, see Movement Sensor API.

getProperties

getProperties(extra?: Struct): Promise<movementSensorApi.GetPropertiesResponse>
Get the properties of this movement sensor.
Parameters
- Optionalextra: Struct
Returns Promise<movementSensorApi.GetPropertiesResponse>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const properties = await movementSensor.getProperties();
```
For more information, see Movement Sensor API.

getReadings

getReadings(extra?: Struct): Promise<Record<string, JsonValue>>
Return the readings of a sensor.
Parameters
- Optionalextra: Struct
Returns Promise<Record<string, JsonValue>>
Example
```
const movementSensor = new VIAM.MovementSensorClient(
  machine,
  'my_movement_sensor'
);
const readings = await movementSensor.getReadings();
```
For more information, see Movement Sensor API.

Interface MovementSensor

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Readonlyname

Methods

doCommand

Parameters

Returns Promise<JsonValue>

Example

getAccuracy

Parameters

Returns Promise<GetAccuracyResponse>

Example

getAngularVelocity

Parameters

Returns Promise<PlainMessage<commonApi.Vector3>>

Example

getCompassHeading

Parameters

Returns Promise<number>

Example

getLinearAcceleration

Parameters

Returns Promise<PlainMessage<commonApi.Vector3>>

Example

getLinearVelocity

Parameters

Returns Promise<PlainMessage<commonApi.Vector3>>

Example

getOrientation

Parameters

Returns Promise<PlainMessage<commonApi.Orientation>>

Example

getPosition

Parameters

Returns Promise<movementSensorApi.GetPositionResponse>

Example

getProperties

Parameters

Returns Promise<movementSensorApi.GetPropertiesResponse>

Example

getReadings

Parameters

Returns Promise<Record<string, JsonValue>>

Example

Settings

On This Page

`Readonly`name