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

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.inputcontroller.v1.input_controller_pb2.Global___GetControlsRequest = 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.

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

type viam.gen.component.inputcontroller.v1.input_controller_pb2.Global___GetControlsResponse = 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

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.inputcontroller.v1.input_controller_pb2.Global___GetEventsRequest = 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.

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

type viam.gen.component.inputcontroller.v1.input_controller_pb2.Global___GetEventsResponse = 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

event() → Global___Event: Digitally assert a given event

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.inputcontroller.v1.input_controller_pb2.Global___TriggerEventRequest = 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.

type viam.gen.component.inputcontroller.v1.input_controller_pb2.Global___TriggerEventResponse = 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

time() → google.protobuf.timestamp_pb2.Timestamp: Timestamp of event

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.inputcontroller.v1.input_controller_pb2.Global___Event = 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)

events() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: Specify which event types to recieve events for

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

events() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___StreamEventsRequest]: A list of Events

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.inputcontroller.v1.input_controller_pb2.Global___StreamEventsRequest = 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.

event() → Global___Event: Event for a controller

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.inputcontroller.v1.input_controller_pb2.Global___StreamEventsResponse = 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.

events() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Event]

type viam.gen.component.inputcontroller.v1.input_controller_pb2.Global___Status = Status