Skip to content

Commit

Permalink
Make updates from machine management QA
Browse files Browse the repository at this point in the history
  • Loading branch information
sguequierre committed Sep 30, 2024
1 parent 3ffa838 commit 91a512d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion resource/resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ implementation of an API), and Name (which represents a specific instantiation o
Both API and Model have a "triplet" format that begins with a namespace. API has "namespace:type:subtype" with "type" in this
case being either "service" or "component." Model has "namespace:modelfamily:modelname" with "modelfamily" being somewhat arbitrary
and useful mostly for organization/grouping. Note that each "tier" contains the tier to the left it. Such that ModelFamily contains
and useful mostly for organization/grouping. Note that each "tier" contains the tier to the left of it. Such that ModelFamily contains
Namespace, and Model itself contains ModelFamily.
An example resource (say, a motor) may use the motor API and thus have the API "rdk:component:motor" and have a model such as
Expand Down
12 changes: 5 additions & 7 deletions robot/robot.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,10 @@ const (
// DiscoverComponents example:
//
// // Define a new discovery query.
// q := resource.NewDiscoveryQuery(acme.API, resource.Model{Name: "some model"})
// q := resource.NewDiscoveryQuery(camera.API, resource.Model{Name: "webcam", Family: resource.DefaultModelFamily})
//
// // Define a list of discovery queries.
// qs := []resource.DiscoverQuery{q}
//
// // Get component configurations with these queries.
// component_configs, err := machine.DiscoverComponents(context.Background(), []resource.DiscoveryQuery{qs})
// // Define a list of discovery queries and get potential component configurations with these queries.
// out, err := machine.DiscoverComponents(context.Background(), []resource.DiscoveryQuery{q})
//
// ResourceNames example:
//
Expand Down Expand Up @@ -92,7 +89,8 @@ const (
// // Shut down the robot.
// err := machine.Shutdown(ctx)
type Robot interface {
// DiscoverComponents returns discovered component configurations.
// DiscoverComponents returns discovered potential component configurations.
// Only implemented for webcam cameras in builtin components.
DiscoverComponents(ctx context.Context, qs []resource.DiscoveryQuery) ([]resource.Discovery, error)

// RemoteByName returns a remote robot by name.
Expand Down

0 comments on commit 91a512d

Please sign in to comment.