Class InputControllerClient

A gRPC-web client for the Input Controller component.

Implements

InputController

Index

Constructors

Properties

client name options

Accessors

inputControllerService

Methods

doCommand getEvents triggerEvent

Constructors

constructor

new InputControllerClient(client, name, options?): InputControllerClient
Parameters
- client: RobotClient
- name: string
- options: Options = {}
Returns InputControllerClient

Properties

`Private` client

client: InputControllerServiceClient

`Private` `Readonly` name

name: string

`Private` `Readonly` options

options: Options

Accessors

`Private` inputControllerService

get inputControllerService(): InputControllerServiceClient
Returns InputControllerServiceClient

Methods

doCommand

doCommand(command): Promise<StructType>
Parameters
- command: StructType
Returns Promise<StructType>
Implementation of InputController.doCommand

getEvents

getEvents(extra?): Promise<inputControllerApi.Event.AsObject[]>
Returns a list of events representing the last event on each control.
Parameters
- extra: {} = {}
Returns Promise<inputControllerApi.Event.AsObject[]>
Implementation of InputController.getEvents

triggerEvent

triggerEvent(__namedParameters, extra?): Promise<void>
TriggerEvent, where supported, injects an InputControllerEvent into an input controller to (virtually) generate events like button presses or axis movements
Parameters
- __namedParameters: inputControllerApi.Event.AsObject
- extra: {} = {}
Returns Promise<void>
Implementation of InputController.triggerEvent

Generated using TypeDoc