`viam.proto.component.movementsensor`

@generated by Viam. Do not edit manually!

Package Contents

Classes

`MovementSensorServiceBase`	Helper class that provides a standard way to create an ABC using
`MovementSensorServiceStub`
`GetAccuracyRequest`	Abstract base class for protocol messages.
`GetAccuracyResponse`	Abstract base class for protocol messages.
`GetAngularVelocityRequest`	Abstract base class for protocol messages.
`GetAngularVelocityResponse`	Abstract base class for protocol messages.
`GetCompassHeadingRequest`	Abstract base class for protocol messages.
`GetCompassHeadingResponse`	Abstract base class for protocol messages.
`GetLinearAccelerationRequest`	Abstract base class for protocol messages.
`GetLinearAccelerationResponse`	Abstract base class for protocol messages.
`GetLinearVelocityRequest`	Abstract base class for protocol messages.
`GetLinearVelocityResponse`	Abstract base class for protocol messages.
`GetOrientationRequest`	Abstract base class for protocol messages.
`GetOrientationResponse`	Abstract base class for protocol messages.
`GetPositionRequest`	Abstract base class for protocol messages.
`GetPositionResponse`	Abstract base class for protocol messages.
`GetPropertiesRequest`	Abstract base class for protocol messages.
`GetPropertiesResponse`	Abstract base class for protocol messages.

class viam.proto.component.movementsensor.MovementSensorServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract async GetLinearVelocity(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetLinearVelocityRequest, component.movementsensor.v1.movementsensor_pb2.GetLinearVelocityResponse]) → None[source]

abstract async GetAngularVelocity(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetAngularVelocityRequest, component.movementsensor.v1.movementsensor_pb2.GetAngularVelocityResponse]) → None[source]

abstract async GetCompassHeading(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetCompassHeadingRequest, component.movementsensor.v1.movementsensor_pb2.GetCompassHeadingResponse]) → None[source]

abstract async GetOrientation(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetOrientationRequest, component.movementsensor.v1.movementsensor_pb2.GetOrientationResponse]) → None[source]

abstract async GetPosition(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetPositionRequest, component.movementsensor.v1.movementsensor_pb2.GetPositionResponse]) → None[source]

abstract async GetProperties(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetPropertiesRequest, component.movementsensor.v1.movementsensor_pb2.GetPropertiesResponse]) → None[source]

abstract async GetAccuracy(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetAccuracyRequest, component.movementsensor.v1.movementsensor_pb2.GetAccuracyResponse]) → None[source]

abstract async GetLinearAcceleration(stream: grpclib.server.Stream[component.movementsensor.v1.movementsensor_pb2.GetLinearAccelerationRequest, component.movementsensor.v1.movementsensor_pb2.GetLinearAccelerationResponse]) → None[source]

abstract async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

abstract async GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) → None[source]

abstract async GetReadings(stream: grpclib.server.Stream[common.v1.common_pb2.GetReadingsRequest, common.v1.common_pb2.GetReadingsResponse]) → None[source]

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.component.movementsensor.MovementSensorServiceStub(channel: grpclib.client.Channel)[source]

class viam.proto.component.movementsensor.GetAccuracyRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetAccuracyResponse(*, accuracy: collections.abc.Mapping[str, float] | None = ..., position_hdop: float | None = ..., position_vdop: float | None = ..., position_nmea_gga_fix: int | None = ..., compass_degrees_error: float | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class AccuracyEntry(*, key: str = ..., value: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str

value: float

property accuracy: google.protobuf.internal.containers.ScalarMap[str, float]

position_hdop: float

position_vdop: float

position_nmea_gga_fix: int

compass_degrees_error: float

HasField(field_name: Literal[_compass_degrees_error, b'_compass_degrees_error', _position_hdop, b'_position_hdop', _position_nmea_gga_fix, b'_position_nmea_gga_fix', _position_vdop, b'_position_vdop', compass_degrees_error, b'compass_degrees_error', position_hdop, b'position_hdop', position_nmea_gga_fix, b'position_nmea_gga_fix', position_vdop, b'position_vdop']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_compass_degrees_error, b'_compass_degrees_error']) → Literal[compass_degrees_error] | None

WhichOneof(oneof_group: Literal[_position_hdop, b'_position_hdop']) → Literal[position_hdop] | None

WhichOneof(oneof_group: Literal[_position_nmea_gga_fix, b'_position_nmea_gga_fix']) → Literal[position_nmea_gga_fix] | None

WhichOneof(oneof_group: Literal[_position_vdop, b'_position_vdop']) → Literal[position_vdop] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

class viam.proto.component.movementsensor.GetAngularVelocityRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetAngularVelocityResponse(*, angular_velocity: viam.gen.common.v1.common_pb2.Vector3 | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property angular_velocity: viam.gen.common.v1.common_pb2.Vector3: Angular velocity in degrees/s across x/y/z axes

HasField(field_name: Literal[angular_velocity, b'angular_velocity']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetCompassHeadingRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetCompassHeadingResponse(*, value: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

value: float: A number from 0-359 in degrees where 0 is North, 90 is East, 180 is South, and 270 is West

class viam.proto.component.movementsensor.GetLinearAccelerationRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetLinearAccelerationResponse(*, linear_acceleration: viam.gen.common.v1.common_pb2.Vector3 | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property linear_acceleration: viam.gen.common.v1.common_pb2.Vector3: Linear acceleration in m/s across x/y/z axes

HasField(field_name: Literal[linear_acceleration, b'linear_acceleration']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetLinearVelocityRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetLinearVelocityResponse(*, linear_velocity: viam.gen.common.v1.common_pb2.Vector3 | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property linear_velocity: viam.gen.common.v1.common_pb2.Vector3: Linear velocity in m/s across x/y/z axes

HasField(field_name: Literal[linear_velocity, b'linear_velocity']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetOrientationRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetOrientationResponse(*, orientation: viam.gen.common.v1.common_pb2.Orientation | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property orientation: viam.gen.common.v1.common_pb2.Orientation: Orientation is returned as an orientation message with OX OY OZ as unit-normalized components of the axis of the vector, and Theta in degrees

HasField(field_name: Literal[orientation, b'orientation']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetPositionRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetPositionResponse(*, coordinate: viam.gen.common.v1.common_pb2.GeoPoint | None = ..., altitude_m: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property coordinate: viam.gen.common.v1.common_pb2.GeoPoint: Position is returned in a coordinate of latitute and longitude and an altidue in meters

altitude_m: float

HasField(field_name: Literal[coordinate, b'coordinate']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetPropertiesRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

name: str: Name of a movement sensor

HasField(field_name: Literal[extra, b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.movementsensor.GetPropertiesResponse(*, linear_velocity_supported: bool = ..., angular_velocity_supported: bool = ..., orientation_supported: bool = ..., position_supported: bool = ..., compass_heading_supported: bool = ..., linear_acceleration_supported: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

linear_velocity_supported: bool

angular_velocity_supported: bool

orientation_supported: bool

position_supported: bool

compass_heading_supported: bool

linear_acceleration_supported: bool

viam.proto.component.movementsensor

Package Contents

Classes

`viam.proto.component.movementsensor`