Class ButtonClient

constructor

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

  Parameters

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

  Returns ButtonClient

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

push

• push(extra?: {}, callOptions?: CallOptions): Promise<void>

  Push the button.

  Parameters

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

  Returns Promise<void>

  Example

  const button = new VIAM.ButtonClient(machine, 'my_button');
  
  // Push the button
  await button.push();
  Copy

  For more information, see Button API.