viam.gen.component.encoder.v1.encoder_pb2

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

Attributes

`DESCRIPTOR`
`POSITION_TYPE_UNSPECIFIED`
`POSITION_TYPE_TICKS_COUNT`	Return type for relative encoders that report
`POSITION_TYPE_ANGLE_DEGREES`	Return type for absolute encoders that report
`global___PositionType`
`global___GetPositionRequest`
`global___GetPositionResponse`
`global___ResetPositionRequest`
`global___ResetPositionResponse`
`global___GetPropertiesRequest`
`global___GetPropertiesResponse`

Classes

`PositionType`
`GetPositionRequest`	Abstract base class for protocol messages.
`GetPositionResponse`	Abstract base class for protocol messages.
`ResetPositionRequest`	Abstract base class for protocol messages.
`ResetPositionResponse`	Abstract base class for protocol messages.
`GetPropertiesRequest`	Abstract base class for protocol messages.
`GetPropertiesResponse`	Abstract base class for protocol messages.

Module Contents

viam.gen.component.encoder.v1.encoder_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.encoder.v1.encoder_pb2.PositionType: Bases: _PositionType

viam.gen.component.encoder.v1.encoder_pb2.POSITION_TYPE_UNSPECIFIED: PositionType

viam.gen.component.encoder.v1.encoder_pb2.POSITION_TYPE_TICKS_COUNT: PositionType: Return type for relative encoders that report how far they’ve gone from a start position

viam.gen.component.encoder.v1.encoder_pb2.POSITION_TYPE_ANGLE_DEGREES: PositionType: Return type for absolute encoders that report their position in degrees along the radial axis

viam.gen.component.encoder.v1.encoder_pb2.global___PositionType

class viam.gen.component.encoder.v1.encoder_pb2.GetPositionRequest(*, name: str = ..., position_type: global___PositionType | None = ..., 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 encoder

position_type: global___PositionType: If supplied, the response will return the specified position type. If the driver does not implement the requested type, this call will return an error. If position type is not specified, the response will return a default according to the driver.

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['_position_type', b'_position_type', 'extra', b'extra', 'position_type', b'position_type']) → 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.

WhichOneof(oneof_group: Literal['_position_type', b'_position_type']) → Literal['position_type'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.component.encoder.v1.encoder_pb2.global___GetPositionRequest

class viam.gen.component.encoder.v1.encoder_pb2.GetPositionResponse(*, value: float = ..., position_type: global___PositionType = ...)

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.

value: float

position_type: global___PositionType

viam.gen.component.encoder.v1.encoder_pb2.global___GetPositionResponse

class viam.gen.component.encoder.v1.encoder_pb2.ResetPositionRequest(*, 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 an encoder

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the 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, 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.encoder.v1.encoder_pb2.global___ResetPositionRequest

class viam.gen.component.encoder.v1.encoder_pb2.ResetPositionResponse

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.encoder.v1.encoder_pb2.global___ResetPositionResponse

class viam.gen.component.encoder.v1.encoder_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 the encoder

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the 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, 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.encoder.v1.encoder_pb2.global___GetPropertiesRequest

class viam.gen.component.encoder.v1.encoder_pb2.GetPropertiesResponse(*, ticks_count_supported: bool = ..., angle_degrees_supported: 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.

ticks_count_supported: bool

angle_degrees_supported: bool

viam.gen.component.encoder.v1.encoder_pb2.global___GetPropertiesResponse