Interface Discovery

A service that enables various computer vision algorithms

interface Discovery {
    discoverResources: (extra?: Struct) => Promise<ComponentConfig[]>;
    name: string;
    doCommand(command: Struct | Record<string, JsonValue>): Promise<JsonValue>;
}

Hierarchy (View Summary)

Resource
- Discovery

Implemented by

DiscoveryClient

Index

Properties

discoverResources name

Methods

Properties

discoverResources

discoverResources: (extra?: Struct) => Promise<ComponentConfig[]>

Get a list of component configs of all discovered components.

Type declaration

- (extra?: Struct): Promise<ComponentConfig[]>
- Parameters
  - Optionalextra: Struct
  Returns Promise<ComponentConfig[]>
  - The list of ComponentConfigs.

`Readonly`name

name: string

The name of the resource.

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' } })
);
```
Inherited from Resource.doCommand