viam.gen.component.motor.v1.motor_pb2

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

Module Contents

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

Attributes

DESCRIPTOR
global___SetPowerRequest
global___SetPowerResponse
global___GoForRequest
global___GoForResponse
global___GoToRequest
global___GoToResponse
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.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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a motor

power_pct: float

Percentage of motor’s power, between -1 and 1

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.motor.v1.motor_pb2.global___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.

viam.gen.component.motor.v1.motor_pb2.global___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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

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

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.motor.v1.motor_pb2.global___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.

viam.gen.component.motor.v1.motor_pb2.global___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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

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

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.motor.v1.motor_pb2.global___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.

viam.gen.component.motor.v1.motor_pb2.global___GoToResponse

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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a motor

offset: float

Motor position

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.motor.v1.motor_pb2.global___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.

viam.gen.component.motor.v1.motor_pb2.global___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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a motor

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.motor.v1.motor_pb2.global___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

viam.gen.component.motor.v1.motor_pb2.global___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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a motor

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.motor.v1.motor_pb2.global___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.

viam.gen.component.motor.v1.motor_pb2.global___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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a motor

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.motor.v1.motor_pb2.global___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.

viam.gen.component.motor.v1.motor_pb2.global___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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

Name of a motor

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.motor.v1.motor_pb2.global___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

viam.gen.component.motor.v1.motor_pb2.global___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

viam.gen.component.motor.v1.motor_pb2.global___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

viam.gen.component.motor.v1.motor_pb2.global___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

viam.gen.component.motor.v1.motor_pb2.global___IsMovingResponse