viam.components.movement_sensor.client
Module Contents
Classes
gRPC client for the MovementSensor component. |
- class viam.components.movement_sensor.client.MovementSensorClient(name: str, channel: grpclib.client.Channel)[source]
Bases:
viam.components.movement_sensor.movement_sensor.MovementSensor
,viam.resource.rpc_client_base.ReconfigurableResourceRPCClientBase
gRPC client for the MovementSensor component.
- async get_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) Tuple[viam.components.movement_sensor.GeoPoint, float] [source]
Get the current GeoPoint (latitude, longitude) and altitude (m)
- Returns:
The current lat/long, along with the altitude in m
- Return type:
Tuple[GeoPoint, float]
- async get_linear_velocity(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) viam.components.movement_sensor.Vector3 [source]
Get the current linear velocity as a
Vector3
with x, y, and z axes represented in m/sec- Returns:
The linear velocity in m/sec
- Return type:
- async get_angular_velocity(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) viam.components.movement_sensor.Vector3 [source]
Get the current angular velocity as a
Vector3
with x, y, and z axes represented in degrees/sec- Returns:
The angular velocity in degrees/sec
- Return type:
- async get_linear_acceleration(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) viam.components.movement_sensor.Vector3 [source]
Get the current linear acceleration as a
Vector3
with x, y, and z axes represented in m/sec^2- Returns:
The linear acceleration in m/sec^2
- Return type:
- async get_compass_heading(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) float [source]
Get the current compass heading in degrees
- Returns:
The compass heading in degrees
- Return type:
float
- async get_orientation(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) viam.components.movement_sensor.Orientation [source]
Get the current orientation
- Returns:
The orientation
- Return type:
- async get_properties(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) viam.components.movement_sensor.movement_sensor.MovementSensor.Properties [source]
Get the supported properties of this sensor
- Returns:
The properties
- Return type:
- async get_accuracy(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) Mapping[str, float] [source]
Get the accuracy of the various sensors
- Returns:
The accuracy
- Return type:
Dict[str, float]
- async get_readings(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) Mapping[str, Any] [source]
Obtain the measurements/data specific to this sensor. If a sensor is not configured to have a measurement or fails to read a piece of data, it will not appear in the readings dictionary.
- Returns:
The readings for the MovementSensor. Can be of any type.
- Return type:
Mapping[str, Any]
- async do_command(command: Mapping[str, viam.utils.ValueTypes], *, timeout: Optional[float] = None) Mapping[str, viam.utils.ValueTypes] [source]
Send/Receive arbitrary commands to the Resource
- Parameters:
command (Mapping[str, ValueTypes]) – The command to execute
- Raises:
NotImplementedError – Raised if the Resource does not support arbitrary commands
- Returns:
Result of the executed command
- Return type:
Mapping[str, ValueTypes]
- async get_geometries(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) List[viam.proto.common.Geometry] [source]
Get all geometries associated with the Component, in their current configuration, in the frame of the Component.
- Returns:
The geometries associated with the Component.
- Return type:
List[Geometry]
- classmethod from_robot(robot: viam.robot.client.RobotClient, name: str) typing_extensions.Self
Get the component named
name
from the provided robot.- Parameters:
robot (RobotClient) – The robot
name (str) – The name of the component
- Returns:
The component, if it exists on the robot
- Return type:
Self
- classmethod get_resource_name(name: str) viam.proto.common.ResourceName
Get the ResourceName for this Resource with the given name
- Parameters:
name (str) – The name of the Resource
- get_operation(kwargs: Mapping[str, Any]) viam.operations.Operation
Get the
Operation
associated with the currently running function.When writing custom resources, you should get the
Operation
by calling this function and check to see if it’s cancelled. If theOperation
is cancelled, then you can perform any necessary (terminating long running tasks, cleaning up connections, etc. ).- Parameters:
kwargs (Mapping[str, Any]) – The kwargs object containing the operation
- Returns:
The operation associated with this function
- Return type:
- async close()
Safely shut down the resource and prevent further use.
Close must be idempotent. Later configuration may allow a resource to be “open” again. If a resource does not want or need a close function, it is assumed that the resource does not need to retun errors when future non-Close methods are called.