You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dev/tools/cli.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -156,7 +156,7 @@ By default, new organization API keys are created with **Owner** permissions, gi
156
156
You can change an API key's permissions from the Viam app on the [organizations page](/manage/reference/organize/) by clicking the **Show details** link next to your API key.
157
157
{{% /alert %}}
158
158
159
-
Once created, you can use the organization API key to authenticate future CLI sessions or to [use the SDKs](/sdks/#authentication).
159
+
Once created, you can use the organization API key to authenticate future CLI sessions or to [use the SDKs](/dev/reference/sdks/).
160
160
To switch to using an organization API key for authentication right away, [logout](#logout) then log back in using `viam login api-key`.
161
161
162
162
An organization can have multiple API keys.
@@ -195,7 +195,7 @@ By default, new location API keys are created with **Owner** permissions, giving
195
195
You can change an API key's permissions from the Viam app on the [organizations page](/manage/reference/organize/) by clicking the **Show details** link next to your API key.
196
196
{{% /alert %}}
197
197
198
-
Once created, you can use the location API key to authenticate future CLI sessions or to [connect to machines with the SDK](/sdks/#authentication).
198
+
Once created, you can use the location API key to authenticate future CLI sessions or to [connect to machines with the SDK](/dev/reference/sdks/).
199
199
To switch to using a location API key for authentication right away, [logout](#logout) then log back in using `viam login api-key`.
200
200
201
201
A location can have multiple API keys.
@@ -233,7 +233,7 @@ Keep these key values safe.
233
233
Authenticating using a machine part API key gives the authenticated CLI session full read and write access to your machine.
234
234
{{% /alert %}}
235
235
236
-
Once created, you can use the machine part API key to authenticate future CLI sessions or to [connect to your machine with the SDK](/sdks/#authentication).
236
+
Once created, you can use the machine part API key to authenticate future CLI sessions or to [connect to your machine with the SDK](/dev/reference/sdks/).
237
237
To switch to using a machine part API key for authentication right away, [logout](#logout) then log back in using `viam login api-key`.
Copy file name to clipboardExpand all lines: docs/operate/reference/architecture/_index.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ Now imagine you want to run code to turn on a fan when the temperature sensor re
153
153
- Configure the fan motor as a motor component and wire the fan motor relay to the same board as the sensor.
154
154
- Write your script using one of the Viam [SDKs](/dev/reference/sdks/), for example the Viam Python SDK, using the sensor API and motor API.
155
155
- You then run this code either locally on the SBC, or on a separate server.
156
-
See [Run code](/sdks/#run-code) for more options.
156
+
See [Create a headless app](/operate/control/headless-app/) for more information.
157
157
Your code connects to the machine, authenticating with API keys, and uses the [sensor API](/operate/reference/components/sensor/#api) to get readings and the [motor API](/operate/reference/components/motor/#api) to turn the motor on and off.
158
158
159
159

Copy file name to clipboardExpand all lines: docs/tutorials/services/constrain-motion.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -309,10 +309,10 @@ If we changed it to `theta=90` or `theta=270`, the gripper jaws would open verti
309
309
310
310
## Add a motion constraint
311
311
312
-
To keep the cup upright as the arm moves it from one place on the table to another, create a [linear constraint](/services/motion/constraints/#linear-constraint).
312
+
To keep the cup upright as the arm moves it from one place on the table to another, create a [linear constraint](/operate/reference/services/motion/constraints/#linear-constraint).
313
313
When you tell the robot to move the cup from one upright position to another, the linear constraint forces the gripper to move linearly and to maintain the upright orientation of the cup throughout the planned path.
314
314
315
-
You could try using an [orientation constraint](/services/motion/constraints/#orientation-constraint) instead, which would also constrain the orientation.
315
+
You could try using an [orientation constraint](/operate/reference/services/motion/constraints/#orientation-constraint) instead, which would also constrain the orientation.
316
316
However, since this opens up many more options for potential paths, it is much more computationally intensive than the linear constraint.
317
317
318
318
The code below creates a linear constraint and then uses that constraint to keep the cup upright and move it in a series of linear paths along the predetermined route while avoiding the obstacles we've defined:
Copy file name to clipboardExpand all lines: static/include/services/apis/generated/motion.md
+10-7Lines changed: 10 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,8 @@ The motion service takes the volumes associated with all configured machine comp
37
37
Transforms can be used to account for geometries that are attached to the robot but not configured as robot components.
38
38
For example, you could use a transform to represent the volume of a marker held in your machine's gripper.
39
39
Transforms are not added to the config or carried into later processes.
40
-
-`constraints` ([viam.proto.service.motion.Constraints](https://python.viam.dev/autoapi/viam/proto/service/motion/index.html#viam.proto.service.motion.Constraints)) (optional): Pass in [motion constraints](/services/motion/constraints/). By default, motion is unconstrained with the exception of obstacle avoidance.
40
+
41
+
-`constraints` ([viam.proto.service.motion.Constraints](https://python.viam.dev/autoapi/viam/proto/service/motion/index.html#viam.proto.service.motion.Constraints)) (optional): Pass in [motion constraints](/operate/reference/services/motion/constraints/). By default, motion is unconstrained with the exception of obstacle avoidance.
41
42
-`extra` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Extra options to pass to the underlying RPC call.
42
43
-`timeout` ([float](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)) (optional): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call.
43
44
@@ -145,7 +146,7 @@ Make sure the [SLAM service](/operate/reference/services/slam/) you use alongsid
145
146
-`destination` ([viam.proto.common.Pose](https://python.viam.dev/autoapi/viam/components/arm/index.html#viam.components.arm.Pose)) (required): The destination, which can be any [Pose](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Pose) with respect to the SLAM map's origin.
146
147
-`slam_service_name` ([viam.proto.common.ResourceName](https://python.viam.dev/autoapi/viam/gen/common/v1/common_pb2/index.html#viam.gen.common.v1.common_pb2.ResourceName)) (required): The `ResourceName` of the [SLAM service](/operate/reference/services/slam/) from which the SLAM map is requested.
The configuration you want to set across this machine for this motion service. This parameter and each of its fields are optional.
149
+
The configuration you want to set across this machine for this motion service. This parameter and each of its fields are optional.
149
150
150
151
-`obstacle_detectors`[(Iterable[ObstacleDetector])](https://python.viam.dev/autoapi/viam/proto/service/motion/index.html#viam.proto.service.motion.ObstacleDetector): The names of each [vision service](/operate/reference/services/vision/) and [camera](/operate/reference/components/camera/) resource pair you want to use for transient obstacle avoidance.
151
152
-`position_polling_frequency_hz`[(float)](https://docs.python.org/3/library/functions.html#float): The frequency in hz to poll the position of the machine.
@@ -189,7 +190,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
189
190
190
191
-`ctx`[(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
A `MoveOnMapReq` which contains the following values:
193
+
A `MoveOnMapReq` which contains the following values:
193
194
194
195
-`ComponentName`[(resource.Name)](https://pkg.go.dev/go.viam.com/rdk/resource#Name): The `resource.Name` of the base to move.
195
196
-`Destination`[(spatialmath.Pose)](https://pkg.go.dev/go.viam.com/rdk/spatialmath#Pose): The destination, which can be any [Pose](https://python.viam.dev/autoapi/viam/proto/common/index.html#viam.proto.common.Pose) with respect to the SLAM map's origin.
@@ -291,7 +292,7 @@ Translation in obstacles is not supported by the [navigation service](/operate/r
291
292
-`obstacles` ([Sequence[viam.proto.common.GeoGeometry]](https://python.viam.dev/autoapi/viam/gen/common/v1/common_pb2/index.html#viam.gen.common.v1.common_pb2.GeoGeometry)) (optional): Obstacles to consider when planning the motion of the component, with each represented as a `GeoGeometry`. <ul><li> Default: `None` </li></ul>
292
293
-`heading` ([float](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)) (optional): The compass heading, in degrees, that the machine's movement sensor should report at the `destination` point. <ul><li> Range: `[0-360)``0`: North, `90`: East, `180`: South, `270`: West </li><li>Default: `None`</li></ul>
The configuration you want to set across this machine for this motion service. This parameter and each of its fields are optional.
295
+
The configuration you want to set across this machine for this motion service. This parameter and each of its fields are optional.
295
296
296
297
-`obstacle_detectors`[(Iterable[ObstacleDetector])](https://python.viam.dev/autoapi/viam/proto/service/motion/index.html#viam.proto.service.motion.ObstacleDetector): The names of each [vision service](/operate/reference/services/vision/) and [camera](/operate/reference/components/camera/) resource pair you want to use for transient obstacle avoidance.
297
298
-`position_polling_frequency_hz`[(float)](https://docs.python.org/3/library/functions.html#float): The frequency in hz to poll the position of the machine.
@@ -335,7 +336,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
335
336
336
337
-`ctx`[(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
A `MoveOnGlobeReq` which contains the following values:
339
+
A `MoveOnGlobeReq` which contains the following values:
339
340
340
341
-`componentName`[(resource.Name)](https://pkg.go.dev/go.viam.com/rdk/resource#Name): The `resource.Name` of the base to move.
341
342
-`destination`[(\*geo.Point)](https://pkg.go.dev/github.com/kellydunn/golang-geo#Point): The location of the component's destination, represented in geographic notation as a [Point](https://pkg.go.dev/github.com/kellydunn/golang-geo#Point)_(lat, lng)_.
@@ -415,6 +416,7 @@ You can use the `supplemental_transforms` argument to augment the machine's exis
415
416
When `supplemental_transforms` are provided, a frame system is created within the context of the `GetPose` function.
416
417
This new frame system builds off the machine's frame system and incorporates the `Transform`s provided.
417
418
If the result of adding the `Transform`s results in a disconnected frame system, an error is thrown.
419
+
418
420
-`extra` (Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]) (optional): Extra options to pass to the underlying RPC call.
419
421
-`timeout` ([float](https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex)) (optional): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call.
420
422
@@ -491,7 +493,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
491
493
-`ctx`[(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
492
494
-`componentName`[(resource.Name)](https://pkg.go.dev/go.viam.com/rdk/resource#Name): The `resource.Name` of the piece of the machine whose pose is returned.
493
495
-`destinationFrame`[(string)](https://pkg.go.dev/builtin#string): The name of the frame with respect to which the component's pose is reported.
494
-
-`supplementalTransforms`[([]*referenceframe.LinkInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#LinkInFrame): An optional list of `LinkInFrame`s.
496
+
-`supplementalTransforms`[([]\*referenceframe.LinkInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#LinkInFrame): An optional list of `LinkInFrame`s.
495
497
A `LinkInFrame` represents an additional frame which is added to the machine's frame system.
496
498
It consists of:
497
499
@@ -500,11 +502,12 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
500
502
When `supplementalTransforms` are provided, a frame system is created within the context of the `GetPose` function.
501
503
This new frame system builds off the machine's frame system and incorporates the `LinkInFrame`s provided.
502
504
If the result of adding the `LinkInFrame`s results in a disconnected frame system, an error is thrown.
505
+
503
506
-`extra`[(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call.
504
507
505
508
**Returns:**
506
509
507
-
-[(*referenceframe.PoseInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#PoseInFrame): The pose of the component.
510
+
-[(\*referenceframe.PoseInFrame)](https://pkg.go.dev/go.viam.com/rdk/referenceframe#PoseInFrame): The pose of the component.
508
511
-[(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
0 commit comments