Discovery service

A discovery service allows you to return a list of physical hardware available on a machine, and suggest configurations for those components to integrate the hardware into the machine. If you are creating a modular resource that depends on other resources that are discoverable in a systematic way, you can create a discovery service as part of your module to discover those resources.

Example usage

Imagine you are creating a vision service module that depends on a camera. To make it easier for users to configure the camera, you include a discovery service in your module. You implement the discovery service to report all the camera paths your computer or SBC finds. Users of your module can then:

1. Configure both the vision service and the discovery service in their machine’s configuration.
2. Click the Test panel in the discovery service configuration to see all cameras recognized by the machine, presented as a list of configuration snippets.
3. Create a camera with the copy-pasteable configuration snippet for the camera they want to use, with the camera path already filled in.
4. Use the configured camera in their vision service configuration.

To see this in action, see webcam discovery as an example.

To interact with a discovery service programmatically, use the discovery service API.

Configuration

To use a discovery service, you need to add it to your machine’s configuration.

Go to your machine’s CONFIGURE page, and add your discovery service.

The following list shows the available discovery service models. For additional configuration information, click on the model name:

• viam-server
• Micro-RDK

17 results:

Add support for other models

If none of the existing models fit your use case, you can create a modular resource to add support for it.

API

The discovery service API supports the following methods: