viam.gen.component.inputcontroller.v1.input_controller_pb2

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

Attributes

DESCRIPTOR

global___GetControlsRequest

global___GetControlsResponse

global___GetEventsRequest

global___GetEventsResponse

global___TriggerEventRequest

global___TriggerEventResponse

global___Event

global___StreamEventsRequest

global___StreamEventsResponse

global___Status

Classes

GetControlsRequest

Abstract base class for protocol messages.

GetControlsResponse

Abstract base class for protocol messages.

GetEventsRequest

Abstract base class for protocol messages.

GetEventsResponse

Abstract base class for protocol messages.

TriggerEventRequest

Abstract base class for protocol messages.

TriggerEventResponse

Abstract base class for protocol messages.

Event

Abstract base class for protocol messages.

StreamEventsRequest

Abstract base class for protocol messages.

StreamEventsResponse

Abstract base class for protocol messages.

Status

Abstract base class for protocol messages.

Module Contents

viam.gen.component.inputcontroller.v1.input_controller_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class viam.gen.component.inputcontroller.v1.input_controller_pb2.GetControlsRequest(*, controller: 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.

controller: str

Name of an input controller

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.inputcontroller.v1.input_controller_pb2.global___GetControlsRequest
class viam.gen.component.inputcontroller.v1.input_controller_pb2.GetControlsResponse(*, controls: collections.abc.Iterable[str] | 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 controls: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Returns a list of all the controls (buttons and axes) that are available to a given Input Controller

viam.gen.component.inputcontroller.v1.input_controller_pb2.global___GetControlsResponse
class viam.gen.component.inputcontroller.v1.input_controller_pb2.GetEventsRequest(*, controller: 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.

controller: str

Name of an input controller

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.inputcontroller.v1.input_controller_pb2.global___GetEventsRequest
class viam.gen.component.inputcontroller.v1.input_controller_pb2.GetEventsResponse(*, events: collections.abc.Iterable[global___Event] | 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 events: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Event]

Returns a list of the most recent event for each control on a given InputController. Effectively provides the current “state” of all buttons/axes on a given input controller

viam.gen.component.inputcontroller.v1.input_controller_pb2.global___GetEventsResponse
class viam.gen.component.inputcontroller.v1.input_controller_pb2.TriggerEventRequest(*, controller: str = ..., event: global___Event | 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.

controller: str

Name of an input controller

property event: global___Event

Digitally assert a given event

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

HasField(field_name: Literal['event', b'event', '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.inputcontroller.v1.input_controller_pb2.global___TriggerEventRequest
class viam.gen.component.inputcontroller.v1.input_controller_pb2.TriggerEventResponse

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.inputcontroller.v1.input_controller_pb2.global___TriggerEventResponse
class viam.gen.component.inputcontroller.v1.input_controller_pb2.Event(*, time: google.protobuf.timestamp_pb2.Timestamp | None = ..., event: str = ..., control: str = ..., value: 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.

event: str

ButtonPress, ButtonRelease)

Type:

An event type (eg

control: str

AbsoluteX)

Type:

A control, can be a button (eg

Type:

ButtonSouth) or an axis (eg

value: float

0 or 1 for buttons, -1.0 to +1.0 for axes

property time: google.protobuf.timestamp_pb2.Timestamp

Timestamp of event

HasField(field_name: Literal['time', b'time']) 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.inputcontroller.v1.input_controller_pb2.global___Event
class viam.gen.component.inputcontroller.v1.input_controller_pb2.StreamEventsRequest(*, controller: str = ..., events: collections.abc.Iterable[global___StreamEventsRequest] | 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.

class Events(*, control: str = ..., events: collections.abc.Iterable[str] | None = ..., cancelled_events: collections.abc.Iterable[str] | 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.

control: str

Name of a control (button or axis)

property events: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Specify which event types to recieve events for

property cancelled_events: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Specify which event types to stop recieving events for This can be an empty list

controller: str

Name of an input controller

property events: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___StreamEventsRequest]

A list of Events

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.inputcontroller.v1.input_controller_pb2.global___StreamEventsRequest
class viam.gen.component.inputcontroller.v1.input_controller_pb2.StreamEventsResponse(*, event: global___Event | 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 event: global___Event

Event for a controller

HasField(field_name: Literal['event', b'event']) 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.inputcontroller.v1.input_controller_pb2.global___StreamEventsResponse
class viam.gen.component.inputcontroller.v1.input_controller_pb2.Status(*, events: collections.abc.Iterable[global___Event] | 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 events: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Event]
viam.gen.component.inputcontroller.v1.input_controller_pb2.global___Status