@@ -75,11 +75,15 @@ func Named(name string) resource.Name {
75
75
// // Get the current position of the movement sensor above sea level in meters.
76
76
// position, altitude, err := myMovementSensor.Position(context.Background(), nil)
77
77
//
78
+ // For more information, see the [Position method docs].
79
+ //
78
80
// LinearVelocity example:
79
81
//
80
82
// // Get the current linear velocity of the movement sensor.
81
83
// linVel, err := myMovementSensor.LinearVelocity(context.Background(), nil)
82
84
//
85
+ // For more information, see the [LinearVelocity method docs].
86
+ //
83
87
// AngularVelocity example:
84
88
//
85
89
// // Get the current angular velocity of the movement sensor.
@@ -88,16 +92,22 @@ func Named(name string) resource.Name {
88
92
// // Get the y component of angular velocity.
89
93
// yAngVel := angVel.Y
90
94
//
95
+ // For more information, see the [AngularVelocity method docs].
96
+ //
91
97
// LinearAcceleration example:
92
98
//
93
99
// // Get the current linear acceleration of the movement sensor.
94
100
// linAcc, err := myMovementSensor.LinearAcceleration(context.Background(), nil)
95
101
//
102
+ // For more information, see the [LinearAcceleration method docs].
103
+ //
96
104
// CompassHeading example:
97
105
//
98
106
// // Get the current compass heading of the movement sensor.
99
107
// heading, err := myMovementSensor.CompassHeading(context.Background(), nil)
100
108
//
109
+ // For more information, see the [CompassHeading method docs].
110
+ //
101
111
// Orientation example:
102
112
//
103
113
// // Get the current orientation of the movement sensor.
@@ -112,17 +122,31 @@ func Named(name string) resource.Name {
112
122
// logger.Info("The z component of the orientation vector: ", orientation.OZ)
113
123
// logger.Info("The number of degrees that the movement sensor is rotated about the vector: ", orientation.Theta)
114
124
//
125
+ // For more information, see the [Orientation method docs].
126
+ //
115
127
// Properties example:
116
128
//
117
129
// // Get the supported properties of the movement sensor.
118
130
// properties, err := myMovementSensor.Properties(context.Background(), nil)
119
131
//
132
+ // For more information, see the [Properties method docs].
133
+ //
120
134
// Accuracy example:
121
135
//
122
136
// // Get the accuracy of the movement sensor.
123
137
// accuracy, err := myMovementSensor.Accuracy(context.Background(), nil)
124
138
//
125
- // [movement sensor component docs]: https://docs.viam.com/components/movement-sensor/
139
+ // For more information, see the [Accuracy method docs].
140
+ //
141
+ // [movement sensor component docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/
142
+ // [Position method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getposition
143
+ // [LinearVelocity method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getlinearvelocity
144
+ // [AngularVelocity method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getangularvelocity
145
+ // [LinearAcceleration method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getlinearacceleration
146
+ // [CompassHeading method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getcompassheading
147
+ // [Orientation method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getorientation
148
+ // [Properties method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getproperties
149
+ // [Accuracy method docs]: https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getaccuracy
126
150
type MovementSensor interface {
127
151
resource.Sensor
128
152
resource.Resource
0 commit comments