viam.proto.component.gantry

@generated by Viam. Do not edit manually!

Package Contents

Classes

GantryServiceBase	Helper class that provides a standard way to create an ABC using
GantryServiceStub
GetLengthsRequest	Abstract base class for protocol messages.
GetLengthsResponse	Abstract base class for protocol messages.
GetPositionRequest	Abstract base class for protocol messages.
GetPositionResponse	Abstract base class for protocol messages.
HomeRequest	Abstract base class for protocol messages.
HomeResponse	Abstract base class for protocol messages.
IsMovingRequest	Abstract base class for protocol messages.
IsMovingResponse	Abstract base class for protocol messages.
MoveToPositionRequest	Abstract base class for protocol messages.
MoveToPositionResponse	Abstract base class for protocol messages.
Status	Abstract base class for protocol messages.
StopRequest	Abstract base class for protocol messages.
StopResponse	Abstract base class for protocol messages.

class viam.proto.component.gantry.GantryServiceBase

Bases: abc.ABC

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

abstract async GetPosition(stream: grpclib.server.Stream[component.gantry.v1.gantry_pb2.GetPositionRequest, component.gantry.v1.gantry_pb2.GetPositionResponse]) → None

abstract async MoveToPosition(stream: grpclib.server.Stream[component.gantry.v1.gantry_pb2.MoveToPositionRequest, component.gantry.v1.gantry_pb2.MoveToPositionResponse]) → None

abstract async Home(stream: grpclib.server.Stream[component.gantry.v1.gantry_pb2.HomeRequest, component.gantry.v1.gantry_pb2.HomeResponse]) → None

abstract async GetLengths(stream: grpclib.server.Stream[component.gantry.v1.gantry_pb2.GetLengthsRequest, component.gantry.v1.gantry_pb2.GetLengthsResponse]) → None

abstract async Stop(stream: grpclib.server.Stream[component.gantry.v1.gantry_pb2.StopRequest, component.gantry.v1.gantry_pb2.StopResponse]) → None

abstract async IsMoving(stream: grpclib.server.Stream[component.gantry.v1.gantry_pb2.IsMovingRequest, component.gantry.v1.gantry_pb2.IsMovingResponse]) → None

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

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

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

class viam.proto.component.gantry.GantryServiceStub(channel: grpclib.client.Channel)

class viam.proto.component.gantry.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.

class viam.proto.component.gantry.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]

class viam.proto.component.gantry.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.

class viam.proto.component.gantry.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]

class viam.proto.component.gantry.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.

class viam.proto.component.gantry.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

class viam.proto.component.gantry.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

class viam.proto.component.gantry.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

class viam.proto.component.gantry.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.

class viam.proto.component.gantry.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.

class viam.proto.component.gantry.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

class viam.proto.component.gantry.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.

class viam.proto.component.gantry.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.