viam.gen.component.motor.v1.motor_pb2

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

Classes

`SetPowerRequest`	Abstract base class for protocol messages.
`SetPowerResponse`	Abstract base class for protocol messages.
`GoForRequest`	Abstract base class for protocol messages.
`GoForResponse`	Abstract base class for protocol messages.
`GoToRequest`	Abstract base class for protocol messages.
`GoToResponse`	Abstract base class for protocol messages.
`SetRPMRequest`	Abstract base class for protocol messages.
`SetRPMResponse`	Abstract base class for protocol messages.
`ResetZeroPositionRequest`	Abstract base class for protocol messages.
`ResetZeroPositionResponse`	Abstract base class for protocol messages.
`GetPositionRequest`	Abstract base class for protocol messages.
`GetPositionResponse`	Abstract base class for protocol messages.
`StopRequest`	Abstract base class for protocol messages.
`StopResponse`	Abstract base class for protocol messages.
`IsPoweredRequest`	Abstract base class for protocol messages.
`IsPoweredResponse`	Abstract base class for protocol messages.
`GetPropertiesRequest`	Abstract base class for protocol messages.
`GetPropertiesResponse`	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.

Module Contents

viam.gen.component.motor.v1.motor_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.motor.v1.motor_pb2.SetPowerRequest(*, name: str = ..., power_pct: float = ..., 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 a motor

power_pct: float: Percentage of motor’s power, between -1 and 1

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___SetPowerRequest = SetPowerRequest

class viam.gen.component.motor.v1.motor_pb2.SetPowerResponse

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.

type viam.gen.component.motor.v1.motor_pb2.Global___SetPowerResponse = SetPowerResponse

class viam.gen.component.motor.v1.motor_pb2.GoForRequest(*, name: str = ..., rpm: float = ..., revolutions: float = ..., 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 a motor

rpm: float: Speed of motor travel in rotations per minute

revolutions: float: Number of revolutions relative to motor’s start position

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___GoForRequest = GoForRequest

class viam.gen.component.motor.v1.motor_pb2.GoForResponse

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.

type viam.gen.component.motor.v1.motor_pb2.Global___GoForResponse = GoForResponse

class viam.gen.component.motor.v1.motor_pb2.GoToRequest(*, name: str = ..., rpm: float = ..., position_revolutions: float = ..., 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 a motor

rpm: float: Speed of motor travel in rotations per minute

position_revolutions: float: Number of revolutions relative to motor’s home home/zero

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___GoToRequest = GoToRequest

class viam.gen.component.motor.v1.motor_pb2.GoToResponse

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.

type viam.gen.component.motor.v1.motor_pb2.Global___GoToResponse = GoToResponse

class viam.gen.component.motor.v1.motor_pb2.SetRPMRequest(*, name: str = ..., rpm: float = ..., 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 a motor

rpm: float: Speed of motor travel in rotations per minute

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___SetRPMRequest = SetRPMRequest

class viam.gen.component.motor.v1.motor_pb2.SetRPMResponse

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.

type viam.gen.component.motor.v1.motor_pb2.Global___SetRPMResponse = SetRPMResponse

class viam.gen.component.motor.v1.motor_pb2.ResetZeroPositionRequest(*, name: str = ..., offset: float = ..., 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 a motor

offset: float: Motor position

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___ResetZeroPositionRequest = ResetZeroPositionRequest

class viam.gen.component.motor.v1.motor_pb2.ResetZeroPositionResponse

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.

type viam.gen.component.motor.v1.motor_pb2.Global___ResetZeroPositionResponse = ResetZeroPositionResponse

class viam.gen.component.motor.v1.motor_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.

name: str: Name of a motor

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___GetPositionRequest = GetPositionRequest

class viam.gen.component.motor.v1.motor_pb2.GetPositionResponse(*, position: float = ...)

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.

position: float: Current position of the motor relative to its home

type viam.gen.component.motor.v1.motor_pb2.Global___GetPositionResponse = GetPositionResponse

class viam.gen.component.motor.v1.motor_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 a motor

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___StopRequest = StopRequest

class viam.gen.component.motor.v1.motor_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.

type viam.gen.component.motor.v1.motor_pb2.Global___StopResponse = StopResponse

class viam.gen.component.motor.v1.motor_pb2.IsPoweredRequest(*, 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 a motor

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___IsPoweredRequest = IsPoweredRequest

class viam.gen.component.motor.v1.motor_pb2.IsPoweredResponse(*, is_on: bool = ..., power_pct: float = ...)

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_on: bool: Returns true if the motor is on

power_pct: 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.

type viam.gen.component.motor.v1.motor_pb2.Global___IsPoweredResponse = IsPoweredResponse

class viam.gen.component.motor.v1.motor_pb2.GetPropertiesRequest(*, 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 a motor

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.motor.v1.motor_pb2.Global___GetPropertiesRequest = GetPropertiesRequest

class viam.gen.component.motor.v1.motor_pb2.GetPropertiesResponse(*, position_reporting: 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.

position_reporting: bool: Returns true if the motor supports reporting its position

type viam.gen.component.motor.v1.motor_pb2.Global___GetPropertiesResponse = GetPropertiesResponse

class viam.gen.component.motor.v1.motor_pb2.Status(*, is_powered: bool = ..., position: float = ..., 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_powered: bool: Returns true if the motor is powered

position: float: Returns current position of the motor relative to its home

is_moving: bool: Returns true if the motor is moving

type viam.gen.component.motor.v1.motor_pb2.Global___Status = Status

class viam.gen.component.motor.v1.motor_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

type viam.gen.component.motor.v1.motor_pb2.Global___IsMovingRequest = IsMovingRequest

class viam.gen.component.motor.v1.motor_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

type viam.gen.component.motor.v1.motor_pb2.Global___IsMovingResponse = IsMovingResponse

`DESCRIPTOR`
`Global___SetPowerRequest`
`Global___SetPowerResponse`
`Global___GoForRequest`
`Global___GoForResponse`
`Global___GoToRequest`
`Global___GoToResponse`
`Global___SetRPMRequest`
`Global___SetRPMResponse`
`Global___ResetZeroPositionRequest`
`Global___ResetZeroPositionResponse`
`Global___GetPositionRequest`
`Global___GetPositionResponse`
`Global___StopRequest`
`Global___StopResponse`
`Global___IsPoweredRequest`
`Global___IsPoweredResponse`
`Global___GetPropertiesRequest`
`Global___GetPropertiesResponse`
`Global___Status`
`Global___IsMovingRequest`
`Global___IsMovingResponse`

viam.gen.component.motor.v1.motor_pb2

Attributes

Classes

Module Contents