Interface Button

Represents a physical button.

interface Button {
    name: string;
    push: (extra?: Struct) => Promise<void>;
    doCommand(command: Struct | Record<string, JsonValue>): Promise<JsonValue>;
}

Hierarchy (View Summary)

Implemented by

Properties

name push

Methods

doCommand

Properties

Readonlyname

name: string

The name of the resource.

push

push: (extra?: Struct) => Promise<void>

Push the button.

Example

const button = new VIAM.ButtonClient(machine, 'my_button');

// Push the button
await button.push();

For more information, see Button API.

Methods

doCommand

  • doCommand(command: Struct | Record<string, JsonValue>): 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.

    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' } })
    );

Settings

Member Visibility

On This Page

Properties
Methods