:py:mod:`viam.gen.component.motor.v1.motor_pb2` =============================================== .. py:module:: viam.gen.component.motor.v1.motor_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: viam.gen.component.motor.v1.motor_pb2.SetPowerRequest viam.gen.component.motor.v1.motor_pb2.SetPowerResponse viam.gen.component.motor.v1.motor_pb2.GoForRequest viam.gen.component.motor.v1.motor_pb2.GoForResponse viam.gen.component.motor.v1.motor_pb2.GoToRequest viam.gen.component.motor.v1.motor_pb2.GoToResponse viam.gen.component.motor.v1.motor_pb2.ResetZeroPositionRequest viam.gen.component.motor.v1.motor_pb2.ResetZeroPositionResponse viam.gen.component.motor.v1.motor_pb2.GetPositionRequest viam.gen.component.motor.v1.motor_pb2.GetPositionResponse viam.gen.component.motor.v1.motor_pb2.StopRequest viam.gen.component.motor.v1.motor_pb2.StopResponse viam.gen.component.motor.v1.motor_pb2.IsPoweredRequest viam.gen.component.motor.v1.motor_pb2.IsPoweredResponse viam.gen.component.motor.v1.motor_pb2.GetPropertiesRequest viam.gen.component.motor.v1.motor_pb2.GetPropertiesResponse viam.gen.component.motor.v1.motor_pb2.Status viam.gen.component.motor.v1.motor_pb2.IsMovingRequest viam.gen.component.motor.v1.motor_pb2.IsMovingResponse Attributes ~~~~~~~~~~ .. autoapisummary:: viam.gen.component.motor.v1.motor_pb2.DESCRIPTOR viam.gen.component.motor.v1.motor_pb2.global___SetPowerRequest viam.gen.component.motor.v1.motor_pb2.global___SetPowerResponse viam.gen.component.motor.v1.motor_pb2.global___GoForRequest viam.gen.component.motor.v1.motor_pb2.global___GoForResponse viam.gen.component.motor.v1.motor_pb2.global___GoToRequest viam.gen.component.motor.v1.motor_pb2.global___GoToResponse viam.gen.component.motor.v1.motor_pb2.global___ResetZeroPositionRequest viam.gen.component.motor.v1.motor_pb2.global___ResetZeroPositionResponse viam.gen.component.motor.v1.motor_pb2.global___GetPositionRequest viam.gen.component.motor.v1.motor_pb2.global___GetPositionResponse viam.gen.component.motor.v1.motor_pb2.global___StopRequest viam.gen.component.motor.v1.motor_pb2.global___StopResponse viam.gen.component.motor.v1.motor_pb2.global___IsPoweredRequest viam.gen.component.motor.v1.motor_pb2.global___IsPoweredResponse viam.gen.component.motor.v1.motor_pb2.global___GetPropertiesRequest viam.gen.component.motor.v1.motor_pb2.global___GetPropertiesResponse viam.gen.component.motor.v1.motor_pb2.global___Status viam.gen.component.motor.v1.motor_pb2.global___IsMovingRequest viam.gen.component.motor.v1.motor_pb2.global___IsMovingResponse .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: SetPowerRequest(*, name: str = ..., power_pct: float = ..., 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 motor .. py:attribute:: power_pct :type: float Percentage of motor's power, between -1 and 1 .. 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___SetPowerRequest .. py:class:: SetPowerResponse 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___SetPowerResponse .. py:class:: GoForRequest(*, name: str = ..., rpm: float = ..., revolutions: float = ..., 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 motor .. py:attribute:: rpm :type: float Speed of motor travel in rotations per minute .. py:attribute:: revolutions :type: float Number of revolutions relative to motor's start position .. 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___GoForRequest .. py:class:: GoForResponse 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___GoForResponse .. py:class:: GoToRequest(*, name: str = ..., rpm: float = ..., position_revolutions: float = ..., 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 motor .. py:attribute:: rpm :type: float Speed of motor travel in rotations per minute .. py:attribute:: position_revolutions :type: float Number of revolutions relative to motor's home home/zero .. 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___GoToRequest .. py:class:: GoToResponse 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___GoToResponse .. py:class:: ResetZeroPositionRequest(*, name: str = ..., offset: float = ..., 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 motor .. py:attribute:: offset :type: float Motor position .. 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___ResetZeroPositionRequest .. py:class:: ResetZeroPositionResponse 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___ResetZeroPositionResponse .. 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 Name of a motor .. 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(*, position: float = ...) 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:: position :type: float Current position of the motor relative to its home .. py:data:: global___GetPositionResponse .. 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 motor .. 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:: IsPoweredRequest(*, 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 motor .. 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___IsPoweredRequest .. py:class:: IsPoweredResponse(*, is_on: bool = ..., power_pct: float = ...) 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_on :type: bool Returns true if the motor is on .. py:attribute:: power_pct :type: float Returns power percent (from 0 to 1, or from -1 to 1 for motors that support negative power), based on the last command sent to motor. If the last command was a stop command, this value will be 0. .. py:data:: global___IsPoweredResponse .. py:class:: GetPropertiesRequest(*, 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 motor .. 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___GetPropertiesRequest .. py:class:: GetPropertiesResponse(*, position_reporting: 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:: position_reporting :type: bool Returns true if the motor supports reporting its position .. py:data:: global___GetPropertiesResponse .. py:class:: Status(*, is_powered: bool = ..., position: float = ..., 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_powered :type: bool Returns true if the motor is powered .. py:attribute:: position :type: float Returns current position of the motor relative to its home .. py:attribute:: is_moving :type: bool Returns true if the motor is moving .. 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