viam.proto.component.inputcontroller

@generated by Viam. Do not edit manually!

Package Contents

Classes

InputControllerServiceBase	Helper class that provides a standard way to create an ABC using
InputControllerServiceStub
Event	Abstract base class for protocol messages.
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.
Status	Abstract base class for protocol messages.
StreamEventsRequest	Abstract base class for protocol messages.
StreamEventsResponse	Abstract base class for protocol messages.
TriggerEventRequest	Abstract base class for protocol messages.
TriggerEventResponse	Abstract base class for protocol messages.

class viam.proto.component.inputcontroller.InputControllerServiceBase

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract async GetControls(stream: grpclib.server.Stream[component.inputcontroller.v1.input_controller_pb2.GetControlsRequest, component.inputcontroller.v1.input_controller_pb2.GetControlsResponse]) → None

abstract async GetEvents(stream: grpclib.server.Stream[component.inputcontroller.v1.input_controller_pb2.GetEventsRequest, component.inputcontroller.v1.input_controller_pb2.GetEventsResponse]) → None

abstract async StreamEvents(stream: grpclib.server.Stream[component.inputcontroller.v1.input_controller_pb2.StreamEventsRequest, component.inputcontroller.v1.input_controller_pb2.StreamEventsResponse]) → None

abstract async TriggerEvent(stream: grpclib.server.Stream[component.inputcontroller.v1.input_controller_pb2.TriggerEventRequest, component.inputcontroller.v1.input_controller_pb2.TriggerEventResponse]) → None

abstract async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None

abstract async GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) → None

__mapping__() → Dict[str, grpclib.const.Handler]

class viam.proto.component.inputcontroller.InputControllerServiceStub(channel: grpclib.client.Channel)

class viam.proto.component.inputcontroller.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.

property time: google.protobuf.timestamp_pb2.Timestamp

Timestamp of event

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

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.

class viam.proto.component.inputcontroller.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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

controller: str

Name of an input controller

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.

class viam.proto.component.inputcontroller.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

class viam.proto.component.inputcontroller.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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

controller: str

Name of an input controller

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.

class viam.proto.component.inputcontroller.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

class viam.proto.component.inputcontroller.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]

class viam.proto.component.inputcontroller.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.

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

control: str

Name of a control (button or axis)

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

controller: str

Name of an input controller

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.

class viam.proto.component.inputcontroller.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.

class viam.proto.component.inputcontroller.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.

property event: global___Event

Digitally assert a given event

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

controller: str

Name of an input controller

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.

class viam.proto.component.inputcontroller.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.