Interface MovementSensor

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

Hierarchy

Resource
- MovementSensor

Implemented by

MovementSensorClient

Index

Properties

Methods

getAccuracy getAngularVelocity getCompassHeading getLinearAcceleration getLinearVelocity getOrientation getPosition getProperties getReadings

Properties

doCommand

doCommand: ((command: StructType) => Promise<StructType>)

Type declaration

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

Methods

getAccuracy

getAccuracy(extra?: StructType): Promise<Record<string, number>>
Get the accuracy of various sensors
Parameters
- Optional extra: StructType
Returns Promise<Record<string, number>>

getAngularVelocity

getAngularVelocity(extra?: StructType): Promise<commonApi.Vector3.AsObject>
Get the angular velocity across x/y/z axes
Parameters
- Optional extra: StructType
Returns Promise<commonApi.Vector3.AsObject>

getCompassHeading

getCompassHeading(extra?: StructType): 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
- Optional extra: StructType
Returns Promise<number>

getLinearAcceleration

getLinearAcceleration(extra?: StructType): Promise<commonApi.Vector3.AsObject>
Get linear acceleration across x/y/z axes
Parameters
- Optional extra: StructType
Returns Promise<commonApi.Vector3.AsObject>

getLinearVelocity

getLinearVelocity(extra?: StructType): Promise<commonApi.Vector3.AsObject>
Get linear velocity across x/y/z axes
Parameters
- Optional extra: StructType
Returns Promise<commonApi.Vector3.AsObject>

getOrientation

getOrientation(extra?: StructType): Promise<commonApi.Orientation.AsObject>
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
- Optional extra: StructType
Returns Promise<commonApi.Orientation.AsObject>

getPosition

getPosition(extra?: StructType): Promise<movementSensorApi.GetPositionResponse.AsObject>
Get the current position latitude, longitude, and altitude
Parameters
- Optional extra: StructType
Returns Promise<movementSensorApi.GetPositionResponse.AsObject>

getProperties

getProperties(extra?: StructType): Promise<movementSensorApi.GetPropertiesResponse.AsObject>
Get the properties of this movement sensor
Parameters
- Optional extra: StructType
Returns Promise<movementSensorApi.GetPropertiesResponse.AsObject>

getReadings

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

Generated using TypeDoc