Class InputControllerClient

constructor

• new InputControllerClient(
      client: Client,
      name: string,
      options?: Options,
  ): InputControllerClient

  Parameters

  • client: Client
  • name: string
  • options: Options = {}

  Returns InputControllerClient

callOptions

Readonlyname

doCommand

• doCommand(
      command: Struct | Record<string, JsonValue>,
      callOptions?: CallOptions,
  ): Promise<JsonValue>

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct | Record<string, JsonValue>

    The command to execute. Accepts either a Struct or a plain object, which will be converted automatically.

  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  Example

  // Plain object (recommended)
  const result = await resource.doCommand({
    myCommand: { key: 'value' },
  });
  
  // Struct (still supported)
  import { Struct } from '@viamrobotics/sdk';
  
  const result = await resource.doCommand(Struct.fromJson({ myCommand: { key: 'value' } }));
  Copy

getEvents

• getEvents(extra?: {}, callOptions?: CallOptions): Promise<Event[]>

  Returns a list of events representing the last event on each control.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<Event[]>

  Example

  const controller = new VIAM.InputControllerClient(machine, 'my_controller');
  
  // Get the most recent Event for each Control
  const recentEvents = await controller.getEvents();
  console.log('Recent events:', recentEvents);
  Copy

  For more information, see Input Controller API.

getStatus

• getStatus(callOptions?: CallOptions): Promise<JsonValue>

  Get the status of the resource.

  Parameters

  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

triggerEvent

• triggerEvent(
      event: InputControllerEvent,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  TriggerEvent, where supported, injects an InputControllerEvent into an input controller to (virtually) generate events like button presses or axis movements.

  Parameters

  • event: InputControllerEvent
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

  Example

  const controller = new VIAM.InputControllerClient(machine, 'my_controller');
  
  // Create a "Button is Pressed" event for the control BUTTON_START
  const buttonPressEvent = new VIAM.InputControllerEvent({
    time: { seconds: BigInt(Math.floor(Date.now() / 1000)) },
    event: 'ButtonPress',
    control: 'ButtonStart',
    value: 1.0,
  });
  // Trigger the event
  await controller.triggerEvent(buttonPressEvent);
  Copy

  For more information, see Input Controller API.