Movement sensor API

import (
  "go.viam.com/rdk/components/movementsensor"
)

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (r3.Vector): A 3D vector containing three floats representing the linear velocity in the x, y and z directions in meters per second.
• (error): An error, if one occurred.

Example:

// Get the current linear velocity of the movement sensor.
linVel, err := myMovementSensor.LinearVelocity(context.Background(), nil)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Vector3>

Example:

var linVel = await myMovementSensor.linearVelocity();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (spatialmath.AngularVelocity): A 3D vector containing three floats representing the angular velocity about the x, y and z axes in degrees per second.
• (error): An error, if one occurred.

Example:

// Get the current angular velocity of the movement sensor.
angVel, err := myMovementSensor.AngularVelocity(context.Background(), nil)

// Get the y component of angular velocity.
yAngVel := angVel.Y

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Vector3>

Example:

var angVel = await myMovementSensor.angularVelocity();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (float64): The compass heading in degrees (between 0 and 360).
• (error): An error, if one occurred.

Example:

// Get the current compass heading of the movement sensor.
heading, err := myMovementSensor.CompassHeading(context.Background(), nil)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<double>

Example:

var compassHeading = await myMovementSensor.compassHeading();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (spatialmath.Orientation): Abstract base class for protocol messages, containing o_x, o_y, o_z, and theta, which together represent a vector pointing in the direction that the sensor is pointing, and the angle (theta) in degrees of the sensor’s rotation about that axis.
• (error): An error, if one occurred.

Example:

// Get the current orientation of the movement sensor.
sensorOrientation, err := myMovementSensor.Orientation(context.Background(), nil)

// Get the orientation vector.
orientation := sensorOrientation.OrientationVectorDegrees()

// Print out the orientation vector.
logger.Info("The x component of the orientation vector: ", orientation.OX)
logger.Info("The y component of the orientation vector: ", orientation.OY)
logger.Info("The z component of the orientation vector: ", orientation.OZ)
logger.Info("The number of degrees that the movement sensor is rotated about the vector: ", orientation.Theta)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Orientation>

Example:

var orientation = await myMovementSensor.orientation();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (*geo.Point): Contains the current latitude and longitude as floats.
• (float64): The altitude in meters.
• (error): An error, if one occurred.

Example:

// Get the current position of the movement sensor above sea level in meters.
position, altitude, err := myMovementSensor.Position(context.Background(), nil)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Position>

Example:

var position = await myMovementSensor.position();
var altitude = position.altitude;
var coordinates = position.coordinates;

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (*Properties): The supported properties of the movement sensor.
• (error): An error, if one occurred.

Example:

// Get the supported properties of the movement sensor.
properties, err := myMovementSensor.Properties(context.Background(), nil)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Properties>

Example:

var props = await myMovementSensor.properties();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (*Accuracy): The precision and reliability metrics of the movement sensor, which vary depending on model. This type contains the following fields:

  • AccuracyMap (map[string]float32): A mapping of specific measurement parameters to their accuracy values. The keys are string identifiers for each measurement (for example, “Hdop”, “Vdop”), and the values are their corresponding accuracy levels as float32.
  • Hdop (float32): Horizontal Dilution of Precision (HDOP) value. It indicates the level of accuracy of horizontal measurements. Lower values indicate improved reliability of positional measurements.
  • Vdop (float32): Vertical Dilution of Precision (VDOP) value. Similar to HDOP, it denotes the accuracy level of vertical measurements. Lower values indicate improved reliability of positional measurements.
  • NmeaFix (int32): An integer value representing the quality of the NMEA fix. See Novatel documentation for the meaning of each fix value.
  • CompassDegreeError (float32): The estimated error in compass readings, measured in degrees. This signifies the deviation or uncertainty in the sensor’s compass measurements. A lower value implies a more accurate compass direction.

• (error): An error, if one occurred.

Example:

// Get the accuracy of the movement sensor.
accuracy, err := myMovementSensor.Accuracy(context.Background(), nil)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Accuracy>

Example:

var accuracy = await myMovementSensor.accuracy();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (r3.Vector): A 3D vector containing three floats representing the linear acceleration in the x, y and z directions in meters per second per second (m/s²).
• (error): An error, if one occurred.

Example:

// Get the current linear acceleration of the movement sensor.
linAcc, err := myMovementSensor.LinearAcceleration(context.Background(), nil)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Vector3>

Example:

var linAccel = await myMovementSensor.linearAcceleration();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (map[string]interface{}): A map containing the measurements from the sensor. Contents depend on sensor model and can be of any type.
• (error): An error, if one occurred.

Example:

// Get the readings provided by the sensor.
readings, err := mySensor.Readings(context.Background(), nil)

For more information, see the Go SDK Docs.

Parameters:

• extra Map<String, dynamic>? (optional)

Returns:

• Future<Map<String, dynamic>>

Example:

var readings = await myMovementSensor.readings();

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• cmd (map[string]interface{}): The command to execute.

Returns:

• (map[string]interface{}): The command response.
• (error): An error, if one occurred.

Example:

myMovementSensor, err := movement_sensor.FromRobot(machine, "my_movement_sensor")

command := map[string]interface{}{"cmd": "test", "data1": 500}
result, err := myMovementSensor.DoCommand(context.Background(), command)

For more information, see the Go SDK Docs.

Parameters:

• command Map<String, dynamic> (required)

Returns:

• Future<Map<String, dynamic>>

Example:

// Example using doCommand with an arm component
const command = {'cmd': 'test', 'data1': 500};
var result = myArm.doCommand(command);

For more information, see the Flutter SDK Docs.

Parameters:

• name String (required)

Returns:

• ResourceName

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.

Returns:

• (error): An error, if one occurred.

Example:

myMovementSensor, err := movementsensor.FromRobot(machine, "my_movement_sensor")

err = myMovementSensor.Close(context.Background())

For more information, see the Go SDK Docs.