Class DiscoveryClient

constructor

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

  Parameters

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

  Returns DiscoveryClient

callOptions

Readonlyname

discoverResources

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

  Get a list of component configs of all discovered components.

  Parameters

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

  Returns Promise<ComponentConfig[]>

  • The list of ComponentConfigs.

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