:py:mod:`viam.gen.component.gantry.v1.gantry_pb2` ================================================= .. py:module:: viam.gen.component.gantry.v1.gantry_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: viam.gen.component.gantry.v1.gantry_pb2.GetPositionRequest viam.gen.component.gantry.v1.gantry_pb2.GetPositionResponse viam.gen.component.gantry.v1.gantry_pb2.MoveToPositionRequest viam.gen.component.gantry.v1.gantry_pb2.MoveToPositionResponse viam.gen.component.gantry.v1.gantry_pb2.HomeRequest viam.gen.component.gantry.v1.gantry_pb2.HomeResponse viam.gen.component.gantry.v1.gantry_pb2.GetLengthsRequest viam.gen.component.gantry.v1.gantry_pb2.GetLengthsResponse viam.gen.component.gantry.v1.gantry_pb2.StopRequest viam.gen.component.gantry.v1.gantry_pb2.StopResponse viam.gen.component.gantry.v1.gantry_pb2.Status viam.gen.component.gantry.v1.gantry_pb2.IsMovingRequest viam.gen.component.gantry.v1.gantry_pb2.IsMovingResponse Attributes ~~~~~~~~~~ .. autoapisummary:: viam.gen.component.gantry.v1.gantry_pb2.DESCRIPTOR viam.gen.component.gantry.v1.gantry_pb2.global___GetPositionRequest viam.gen.component.gantry.v1.gantry_pb2.global___GetPositionResponse viam.gen.component.gantry.v1.gantry_pb2.global___MoveToPositionRequest viam.gen.component.gantry.v1.gantry_pb2.global___MoveToPositionResponse viam.gen.component.gantry.v1.gantry_pb2.global___HomeRequest viam.gen.component.gantry.v1.gantry_pb2.global___HomeResponse viam.gen.component.gantry.v1.gantry_pb2.global___GetLengthsRequest viam.gen.component.gantry.v1.gantry_pb2.global___GetLengthsResponse viam.gen.component.gantry.v1.gantry_pb2.global___StopRequest viam.gen.component.gantry.v1.gantry_pb2.global___StopResponse viam.gen.component.gantry.v1.gantry_pb2.global___Status viam.gen.component.gantry.v1.gantry_pb2.global___IsMovingRequest viam.gen.component.gantry.v1.gantry_pb2.global___IsMovingResponse .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: GetPositionRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetPositionRequest .. py:class:: GetPositionResponse(*, positions_mm: collections.abc.Iterable[float] | None = ...) Bases: :py:obj:`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. .. py:property:: positions_mm :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float] .. py:data:: global___GetPositionResponse .. py:class:: 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: :py:obj:`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. .. py:property:: positions_mm :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float] Number of millimeters to move the gantry by respective to each axis. .. py:property:: speeds_mm_per_sec :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float] Speeds to move each gantry axis must match length and order of positions_mm. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___MoveToPositionRequest .. py:class:: MoveToPositionResponse Bases: :py:obj:`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. .. py:data:: global___MoveToPositionResponse .. py:class:: HomeRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___HomeRequest .. py:class:: HomeResponse(*, homed: bool = ...) Bases: :py:obj:`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. .. py:attribute:: homed :type: bool A bool describing whether the gantry has completed homing .. py:data:: global___HomeResponse .. py:class:: GetLengthsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetLengthsRequest .. py:class:: GetLengthsResponse(*, lengths_mm: collections.abc.Iterable[float] | None = ...) Bases: :py:obj:`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. .. py:property:: lengths_mm :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float] .. py:data:: global___GetLengthsResponse .. py:class:: StopRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str Name of a gantry .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___StopRequest .. py:class:: StopResponse Bases: :py:obj:`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. .. py:data:: global___StopResponse .. py:class:: Status(*, positions_mm: collections.abc.Iterable[float] | None = ..., lengths_mm: collections.abc.Iterable[float] | None = ..., is_moving: bool = ...) Bases: :py:obj:`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. .. py:property:: positions_mm :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float] .. py:property:: lengths_mm :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[float] .. py:attribute:: is_moving :type: bool .. py:data:: global___Status .. py:class:: IsMovingRequest(*, name: str = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:data:: global___IsMovingRequest .. py:class:: IsMovingResponse(*, is_moving: bool = ...) Bases: :py:obj:`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. .. py:attribute:: is_moving :type: bool .. py:data:: global___IsMovingResponse