viam.gen.component.arm.v1.arm_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes

`DESCRIPTOR`
`global___GetEndPositionRequest`
`global___GetEndPositionResponse`
`global___JointPositions`
`global___GetJointPositionsRequest`
`global___GetJointPositionsResponse`
`global___MoveToPositionRequest`
`global___MoveToPositionResponse`
`global___MoveToJointPositionsRequest`
`global___MoveToJointPositionsResponse`
`global___MoveThroughJointPositionsRequest`
`global___MoveThroughJointPositionsResponse`
`global___StopRequest`
`global___StopResponse`
`global___Status`
`global___IsMovingRequest`
`global___IsMovingResponse`
`global___MoveOptions`

Classes

`GetEndPositionRequest`	Abstract base class for protocol messages.
`GetEndPositionResponse`	Abstract base class for protocol messages.
`JointPositions`	Abstract base class for protocol messages.
`GetJointPositionsRequest`	Abstract base class for protocol messages.
`GetJointPositionsResponse`	Abstract base class for protocol messages.
`MoveToPositionRequest`	Moves an arm to the specified pose that is within the reference frame of the arm.
`MoveToPositionResponse`	Abstract base class for protocol messages.
`MoveToJointPositionsRequest`	Abstract base class for protocol messages.
`MoveToJointPositionsResponse`	Abstract base class for protocol messages.
`MoveThroughJointPositionsRequest`	Abstract base class for protocol messages.
`MoveThroughJointPositionsResponse`	Abstract base class for protocol messages.
`StopRequest`	Abstract base class for protocol messages.
`StopResponse`	Abstract base class for protocol messages.
`Status`	Abstract base class for protocol messages.
`IsMovingRequest`	Abstract base class for protocol messages.
`IsMovingResponse`	Abstract base class for protocol messages.
`MoveOptions`	Abstract base class for protocol messages.

Module Contents

viam.gen.component.arm.v1.arm_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.arm.v1.arm_pb2.GetEndPositionRequest(*, 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.

name: str: Name of an arm

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

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.

viam.gen.component.arm.v1.arm_pb2.global___GetEndPositionRequest

class viam.gen.component.arm.v1.arm_pb2.GetEndPositionResponse(*, pose: viam.gen.common.v1.common_pb2.Pose | 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 pose: viam.gen.common.v1.common_pb2.Pose: Returns 6d pose of the end effector relative to the base, represented by X,Y,Z coordinates which express millimeters and theta, ox, oy, oz coordinates which express an orientation vector

HasField(field_name: Literal['pose', b'pose']) → 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.

viam.gen.component.arm.v1.arm_pb2.global___GetEndPositionResponse

class viam.gen.component.arm.v1.arm_pb2.JointPositions(*, values: collections.abc.Iterable[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.

property values: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]: A list of joint positions. Rotations values are in degrees, translational values in mm. There should be 1 entry in the list per joint DOF, ordered spatially from the base toward the end effector of the arm

viam.gen.component.arm.v1.arm_pb2.global___JointPositions

class viam.gen.component.arm.v1.arm_pb2.GetJointPositionsRequest(*, 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.

name: str: Name of an arm

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

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.

viam.gen.component.arm.v1.arm_pb2.global___GetJointPositionsRequest

class viam.gen.component.arm.v1.arm_pb2.GetJointPositionsResponse(*, positions: global___JointPositions | 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 positions: global___JointPositions: a list JointPositions

HasField(field_name: Literal['positions', b'positions']) → 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.

viam.gen.component.arm.v1.arm_pb2.global___GetJointPositionsResponse

class viam.gen.component.arm.v1.arm_pb2.MoveToPositionRequest(*, name: str = ..., to: viam.gen.common.v1.common_pb2.Pose | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Moves an arm to the specified pose that is within the reference frame of the arm. Move request in Motion API has the same behavior except that it performs obstacle avoidance when a world_state message is specified.

name: str: Name of an arm

property to: viam.gen.common.v1.common_pb2.Pose: The destination to move the arm to; this is from the reference frame of the arm.

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

HasField(field_name: Literal['extra', b'extra', 'to', b'to']) → 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.

viam.gen.component.arm.v1.arm_pb2.global___MoveToPositionRequest

class viam.gen.component.arm.v1.arm_pb2.MoveToPositionResponse

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.

viam.gen.component.arm.v1.arm_pb2.global___MoveToPositionResponse

class viam.gen.component.arm.v1.arm_pb2.MoveToJointPositionsRequest(*, name: str = ..., positions: global___JointPositions | None = ..., 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.

name: str: Name of an arm

property positions: global___JointPositions: A list of joint positions There should be 1 entry in the list per joint DOF, ordered spatially from the base toward the end effector

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

HasField(field_name: Literal['extra', b'extra', 'positions', b'positions']) → 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.

viam.gen.component.arm.v1.arm_pb2.global___MoveToJointPositionsRequest

class viam.gen.component.arm.v1.arm_pb2.MoveToJointPositionsResponse

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.

viam.gen.component.arm.v1.arm_pb2.global___MoveToJointPositionsResponse

class viam.gen.component.arm.v1.arm_pb2.MoveThroughJointPositionsRequest(*, name: str = ..., positions: collections.abc.Iterable[global___JointPositions] | None = ..., options: global___MoveOptions | None = ..., 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.

name: str: Name of an arm

property positions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___JointPositions]: A list of joint positions which will be moved to in the order they are specified

property options: global___MoveOptions: optional specifications to be obeyed during the motion

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

HasField(field_name: Literal['_options', b'_options', 'extra', b'extra', 'options', b'options']) → 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['_options', b'_options']) → Literal['options'] | 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

viam.gen.component.arm.v1.arm_pb2.global___MoveThroughJointPositionsRequest

class viam.gen.component.arm.v1.arm_pb2.MoveThroughJointPositionsResponse

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.

viam.gen.component.arm.v1.arm_pb2.global___MoveThroughJointPositionsResponse

class viam.gen.component.arm.v1.arm_pb2.StopRequest(*, 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.

name: str: Name of an arm

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

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.

viam.gen.component.arm.v1.arm_pb2.global___StopRequest

class viam.gen.component.arm.v1.arm_pb2.StopResponse

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.

viam.gen.component.arm.v1.arm_pb2.global___StopResponse

class viam.gen.component.arm.v1.arm_pb2.Status(*, end_position: viam.gen.common.v1.common_pb2.Pose | None = ..., joint_positions: global___JointPositions | None = ..., is_moving: 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.

is_moving: bool

property end_position: viam.gen.common.v1.common_pb2.Pose

property joint_positions: global___JointPositions

HasField(field_name: Literal['end_position', b'end_position', 'joint_positions', b'joint_positions']) → 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.

viam.gen.component.arm.v1.arm_pb2.global___Status

class viam.gen.component.arm.v1.arm_pb2.IsMovingRequest(*, name: str = ...)

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.

name: str

viam.gen.component.arm.v1.arm_pb2.global___IsMovingRequest

class viam.gen.component.arm.v1.arm_pb2.IsMovingResponse(*, is_moving: 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.

is_moving: bool

viam.gen.component.arm.v1.arm_pb2.global___IsMovingResponse

class viam.gen.component.arm.v1.arm_pb2.MoveOptions(*, max_vel_degs_per_sec: float | None = ..., max_acc_degs_per_sec2: 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.

max_vel_degs_per_sec: float: Maximum allowable velocity of an arm joint, in degrees per second

max_acc_degs_per_sec2: float: Maximum allowable acceleration of an arm joint, in degrees per second squared

HasField(field_name: Literal['_max_acc_degs_per_sec2', b'_max_acc_degs_per_sec2', '_max_vel_degs_per_sec', b'_max_vel_degs_per_sec', 'max_acc_degs_per_sec2', b'max_acc_degs_per_sec2', 'max_vel_degs_per_sec', b'max_vel_degs_per_sec']) → 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['_max_acc_degs_per_sec2', b'_max_acc_degs_per_sec2']) → Literal['max_acc_degs_per_sec2'] | None

WhichOneof(oneof_group: Literal['_max_vel_degs_per_sec', b'_max_vel_degs_per_sec']) → Literal['max_vel_degs_per_sec'] | 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

viam.gen.component.arm.v1.arm_pb2.global___MoveOptions