Class ButtonClient

constructor

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

  Parameters

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

  Returns ButtonClient

callOptions

Readonlyname

doCommand

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

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct

    The command to execute.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  Example

  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.