viam.gen.component.servo.v1.servo_pb2

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

Module Contents

Classes

MoveRequest	Abstract base class for protocol messages.
MoveResponse	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.
Status	Abstract base class for protocol messages.
IsMovingRequest	Abstract base class for protocol messages.
IsMovingResponse	Abstract base class for protocol messages.

Attributes

DESCRIPTOR
global___MoveRequest
global___MoveResponse
global___GetPositionRequest
global___GetPositionResponse
global___StopRequest
global___StopResponse
global___Status
global___IsMovingRequest
global___IsMovingResponse

viam.gen.component.servo.v1.servo_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.servo.v1.servo_pb2.MoveRequest(*, name: str = ..., angle_deg: int = ..., 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

the name of the servo, as registered

angle_deg: int

the degrees by which to rotate the servo. Accepted values are between 0 and 180

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.servo.v1.servo_pb2.global___MoveRequest

class viam.gen.component.servo.v1.servo_pb2.MoveResponse

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.servo.v1.servo_pb2.global___MoveResponse

class viam.gen.component.servo.v1.servo_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

the name of the servo, as registered

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.servo.v1.servo_pb2.global___GetPositionRequest

class viam.gen.component.servo.v1.servo_pb2.GetPositionResponse(*, position_deg: int = ...)

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_deg: int

the degrees from neutral by which the servo is currently rotated. Values are between 0 and 180

viam.gen.component.servo.v1.servo_pb2.global___GetPositionResponse

class viam.gen.component.servo.v1.servo_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 servo

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.servo.v1.servo_pb2.global___StopRequest

class viam.gen.component.servo.v1.servo_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.servo.v1.servo_pb2.global___StopResponse

class viam.gen.component.servo.v1.servo_pb2.Status(*, position_deg: int = ..., 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.

position_deg: int

is_moving: bool

viam.gen.component.servo.v1.servo_pb2.global___Status

class viam.gen.component.servo.v1.servo_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.servo.v1.servo_pb2.global___IsMovingRequest

class viam.gen.component.servo.v1.servo_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.servo.v1.servo_pb2.global___IsMovingResponse