viam.gen.component.gantry.v1.gantry_pb2

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

Module Contents

Classes

GetPositionRequest	Abstract base class for protocol messages.
GetPositionResponse	Abstract base class for protocol messages.
MoveToPositionRequest	Abstract base class for protocol messages.
MoveToPositionResponse	Abstract base class for protocol messages.
HomeRequest	Abstract base class for protocol messages.
HomeResponse	Abstract base class for protocol messages.
GetLengthsRequest	Abstract base class for protocol messages.
GetLengthsResponse	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.

Attributes

DESCRIPTOR
global___GetPositionRequest
global___GetPositionResponse
global___MoveToPositionRequest
global___MoveToPositionResponse
global___HomeRequest
global___HomeResponse
global___GetLengthsRequest
global___GetLengthsResponse
global___StopRequest
global___StopResponse
global___Status
global___IsMovingRequest
global___IsMovingResponse

viam.gen.component.gantry.v1.gantry_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.gantry.v1.gantry_pb2.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

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.gantry.v1.gantry_pb2.global___GetPositionRequest

class viam.gen.component.gantry.v1.gantry_pb2.GetPositionResponse(*, positions_mm: 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 positions_mm: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]

viam.gen.component.gantry.v1.gantry_pb2.global___GetPositionResponse

class viam.gen.component.gantry.v1.gantry_pb2.MoveToPositionRequest(*, name: str = ..., positions_mm: collections.abc.Iterable[float] | None = ..., speeds_mm_per_sec: collections.abc.Iterable[float] | 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.

property positions_mm: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]

Number of millimeters to move the gantry by respective to each axis.

property speeds_mm_per_sec: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]

Speeds to move each gantry axis must match length and order of positions_mm.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

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.gantry.v1.gantry_pb2.global___MoveToPositionRequest

class viam.gen.component.gantry.v1.gantry_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.gantry.v1.gantry_pb2.global___MoveToPositionResponse

class viam.gen.component.gantry.v1.gantry_pb2.HomeRequest(*, 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

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.gantry.v1.gantry_pb2.global___HomeRequest

class viam.gen.component.gantry.v1.gantry_pb2.HomeResponse(*, homed: 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.

homed: bool

A bool describing whether the gantry has completed homing

viam.gen.component.gantry.v1.gantry_pb2.global___HomeResponse

class viam.gen.component.gantry.v1.gantry_pb2.GetLengthsRequest(*, 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

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.gantry.v1.gantry_pb2.global___GetLengthsRequest

class viam.gen.component.gantry.v1.gantry_pb2.GetLengthsResponse(*, lengths_mm: 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 lengths_mm: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]

viam.gen.component.gantry.v1.gantry_pb2.global___GetLengthsResponse

class viam.gen.component.gantry.v1.gantry_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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a gantry

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.gantry.v1.gantry_pb2.global___StopRequest

class viam.gen.component.gantry.v1.gantry_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.gantry.v1.gantry_pb2.global___StopResponse

class viam.gen.component.gantry.v1.gantry_pb2.Status(*, positions_mm: collections.abc.Iterable[float] | None = ..., lengths_mm: collections.abc.Iterable[float] | 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.

property positions_mm: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]

property lengths_mm: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]

is_moving: bool

viam.gen.component.gantry.v1.gantry_pb2.global___Status

class viam.gen.component.gantry.v1.gantry_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.gantry.v1.gantry_pb2.global___IsMovingRequest

class viam.gen.component.gantry.v1.gantry_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.gantry.v1.gantry_pb2.global___IsMovingResponse