diff --git a/components/input/input.go b/components/input/input.go index 37c8eb74d40..cdfb8b19355 100644 --- a/components/input/input.go +++ b/components/input/input.go @@ -1,4 +1,7 @@ // Package input provides human input, such as buttons, switches, knobs, gamepads, joysticks, keyboards, mice, etc. +// For more information, see the [input controller component docs]. +// +// [input controller component docs]: https://docs.viam.com/components/input-controller/ package input import ( @@ -35,6 +38,7 @@ func Named(name string) resource.Name { // Controller is a logical "container" more than an actual device // Could be a single gamepad, or a collection of digitalInterrupts and analogReaders, a keyboard, etc. +// For more information, see the [input controller component docs]. // // Controls example: // @@ -64,6 +68,8 @@ func Named(name string) resource.Name { // return errors.New("button `ButtonStart` not found; controller may be disconnected") // } // Mycontroller.RegisterControlCallback(context.Background(), input.ButtonStart, triggers, printStartTime, nil) +// +// [input controller component docs]: https://docs.viam.com/components/input-controller/ type Controller interface { resource.Resource diff --git a/components/motor/motor.go b/components/motor/motor.go index 78f8edaa78c..0a2796814fa 100644 --- a/components/motor/motor.go +++ b/components/motor/motor.go @@ -1,3 +1,7 @@ +// Package motor defines machines that convert electricity into rotary motion. +// For more information, see the [motor component docs]. +// +// [motor component docs]: https://docs.viam.com/components/motor/ package motor import ( @@ -37,6 +41,7 @@ const SubtypeName = "motor" var API = resource.APINamespaceRDK.WithComponentType(SubtypeName) // A Motor represents a physical motor connected to a board. +// For more information, see the [motor component docs]. // // SetPower example: // @@ -92,6 +97,8 @@ var API = resource.APINamespaceRDK.WithComponentType(SubtypeName) // logger.Info(powered) // logger.Info("Power percent:") // logger.Info(pct) +// +// [motor component docs]: https://docs.viam.com/components/motor/ type Motor interface { resource.Resource resource.Actuator diff --git a/components/movementsensor/movementsensor.go b/components/movementsensor/movementsensor.go index 78adeffe749..e458b29343f 100644 --- a/components/movementsensor/movementsensor.go +++ b/components/movementsensor/movementsensor.go @@ -1,4 +1,7 @@ -// Package movementsensor defines the interfaces of a MovementSensor +// Package movementsensor defines the interfaces of a MovementSensor. +// For more information, see the [movement sensor component docs]. +// +// [movement sensor component docs]: https://docs.viam.com/components/movement-sensor/ package movementsensor import ( @@ -65,6 +68,7 @@ func Named(name string) resource.Name { } // A MovementSensor reports information about the robot's direction, position and speed. +// For more information, see the [movement sensor component docs]. // // Position example: // @@ -117,6 +121,8 @@ func Named(name string) resource.Name { // // // Get the accuracy of the movement sensor. // accuracy, err := myMovementSensor.Accuracy(context.Background(), nil) +// +// [movement sensor component docs]: https://docs.viam.com/components/movement-sensor/ type MovementSensor interface { resource.Sensor resource.Resource diff --git a/components/posetracker/pose_tracker.go b/components/posetracker/pose_tracker.go index 7d3e9586d00..969f2c8a8c9 100644 --- a/components/posetracker/pose_tracker.go +++ b/components/posetracker/pose_tracker.go @@ -1,5 +1,5 @@ // Package posetracker contains the interface and gRPC infrastructure -// for a pose tracker component +// for a pose tracker component. package posetracker import ( diff --git a/components/powersensor/powersensor.go b/components/powersensor/powersensor.go index 5e703d6c9e2..bcf371bd39b 100644 --- a/components/powersensor/powersensor.go +++ b/components/powersensor/powersensor.go @@ -1,4 +1,7 @@ -// Package powersensor defines the interfaces of a powersensor +// Package powersensor defines the interfaces of a powersensor. +// For more information, see the [power sensor component docs]. +// +// [power sensor component docs]: https://docs.viam.com/components/power-sensor/ package powersensor import ( @@ -48,6 +51,7 @@ func Named(name string) resource.Name { } // A PowerSensor reports information about voltage, current and power. +// For more information, see the [power sensor component docs]. // // Voltage example: // @@ -63,6 +67,8 @@ func Named(name string) resource.Name { // // // Get the power measurement from device in watts. // power, err := myPowerSensor.Power(context.Background(), nil) +// +// [power sensor component docs]: https://docs.viam.com/components/power-sensor/ type PowerSensor interface { resource.Sensor resource.Resource diff --git a/components/sensor/sensor.go b/components/sensor/sensor.go index 2df2b048d2e..db8debd8d04 100644 --- a/components/sensor/sensor.go +++ b/components/sensor/sensor.go @@ -1,4 +1,7 @@ // Package sensor defines an abstract sensing device that can provide measurement readings. +// For more information, see the [sensor component docs]. +// +// [sensor component docs]: https://docs.viam.com/components/sensor/ package sensor import ( diff --git a/components/servo/servo.go b/components/servo/servo.go index 9846a11a315..392dc61fe28 100644 --- a/components/servo/servo.go +++ b/components/servo/servo.go @@ -1,3 +1,7 @@ +// Package servo supports “RC” or “hobby” servo motors. +// For more information, see the [servo component docs]. +// +// [servo component docs]: https://docs.viam.com/components/servo/ package servo import ( @@ -31,6 +35,7 @@ const SubtypeName = "servo" var API = resource.APINamespaceRDK.WithComponentType(SubtypeName) // A Servo represents a physical servo connected to a board. +// For more information, see the [servo component docs]. // // Move example: // @@ -50,6 +55,8 @@ var API = resource.APINamespaceRDK.WithComponentType(SubtypeName) // // logger.Info("Position 1: ", pos1) // logger.Info("Position 2: ", pos2) +// +// [servo component docs]: https://docs.viam.com/components/servo/ type Servo interface { resource.Resource resource.Actuator diff --git a/resource/resource.go b/resource/resource.go index a910653b85b..9a7a9b4b267 100644 --- a/resource/resource.go +++ b/resource/resource.go @@ -150,11 +150,14 @@ func ContainsReservedCharacter(val string) error { // A Sensor represents a general purpose sensor that can give arbitrary readings // of all readings that it is sensing. +// For more information, see the [sensor component docs]. // // Readings example: // // // Get the readings provided by the sensor. // readings, err := mySensor.Readings(context.Background(), nil) +// +// [sensor component docs]: https://docs.viam.com/components/sensor/ type Sensor interface { // Readings return data specific to the type of sensor and can be of any type. Readings(ctx context.Context, extra map[string]interface{}) (map[string]interface{}, error)