Discovery service API | Service APIs

Discovery service API

The discovery service API allows you to get a list of resources available to configure on a machine based on the hardware that is connected to or part of the machine. Discoverable resources can include components that are physically connected to the machine, as well as components that are available on the machine’s local network (depending on the implementation of the discovery service).

The discovery service supports the following methods:

Method Name	Description
`DiscoverResources`	Get a list of component configs of all resources available to configure on a machine based on the hardware that is connected to or part of the machine.
`GetResourceName`	Get the `ResourceName` for this instance of the service.
`DoCommand`	Execute model-specific commands.
`Close`	Safely shut down the resource and prevent further use.

API

DiscoverResources

Get a list of component configs of all resources available to configure on a machine based on the hardware that is connected to or part of the machine.

Parameters:

extra (Mapping[ str, Any]) (optional): Extra options to pass to the underlying RPC call.
timeout ( float) (optional): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call.

Returns:

( List[viam.proto.app.robot.ComponentConfig]): A list of ComponentConfigs that describe the components found by a discover service.

Example:

For more information, see the Python SDK Docs.

Parameters:

ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

([]resource.Config)
(error): An error, if one occurred.

Example:

For more information, see the Go SDK Docs.

Parameters:

extra (None) (optional)
callOptions (CallOptions) (optional)

Returns:

(Promise< ComponentConfig[]>): * The list of ComponentConfigs.

For more information, see the TypeScript SDK Docs.

Parameters:

extra Map < String, dynamic>? (optional)

Returns:

Future < List < ComponentConfig >>

Example:

For more information, see the Flutter SDK Docs.

GetResourceName

Get the ResourceName for this instance of the service.

Parameters:

name ( str) (required): The name of the Resource.

Returns:

( viam.proto.common.ResourceName): The ResourceName of this Resource.

Example:

For more information, see the Python SDK Docs.

Parameters:

None.

Returns:

(Name)

Example:

For more information, see the Go SDK Docs.

Parameters:

None.

Returns:

(string): The name of the resource.

Example:

For more information, see the TypeScript SDK Docs.

Parameters:

name String (required)

Returns:

ResourceName

For more information, see the Flutter SDK Docs.

DoCommand

Execute model-specific commands. If you are implementing your own generic service and want to add features that have no corresponding built-in API method, you can implement them with DoCommand.

Parameters:

command (Mapping[ str, ValueTypes]) (required): The command to execute.
timeout ( float) (optional): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call.

Returns:

(Mapping[ str, viam.utils.ValueTypes]): Result of the executed command.

Example:

For more information, see the Python SDK Docs.

Parameters:

ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
cmd (map[string]interface{}): The command to execute.

Returns:

(map[string]interface{}): The command response.
(error): An error, if one occurred.

Example:

For more information, see the Go SDK Docs.

Parameters:

command ( Struct) (required): The command to execute. Accepts either a Struct or a plain object, which will be converted automatically.
callOptions (CallOptions) (optional)

Returns:

(Promise< JsonValue >)

Example:

For more information, see the TypeScript SDK Docs.

Parameters:

command Map < String, dynamic> (required)

Returns:

Future < Map < String, dynamic>>

Example:

For more information, see the Flutter SDK Docs.

Close

Safely shut down the resource and prevent further use.

Python
Go

Parameters:

None.

Returns:

None.

Example:

For more information, see the Python SDK Docs.

Parameters:

ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.

Returns:

(error): An error, if one occurred.

Example:

For more information, see the Go SDK Docs.