Class GenericComponentClient

constructor

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

  Parameters

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

  Returns GenericComponentClient

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

getGeometries

• getGeometries(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<commonApi.Geometry[]>

  Get the geometries of the component in their current configuration.

  Parameters

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

  Returns Promise<commonApi.Geometry[]>

  Example

  const generic = new VIAM.GenericComponentClient(machine, 'my_generic_component');
  
  // Get the geometries of this component
  const geometries = await generic.getGeometries();
  console.log('Geometries:', geometries);
  Copy

  For more information, see Generic API.

getStatus

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

  Get the status of the resource.

  Parameters

  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>