Skip to content

Commit deb5a8e

Browse files
committed
few more
1 parent da72ffa commit deb5a8e

File tree

8 files changed

+20
-17
lines changed

8 files changed

+20
-17
lines changed

docs/dev/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ aliases:
4848

4949
<div class="max-page frontpage">
5050

51-
Once you've set up your machine you can control your device and any attached physical hardware with [Viam APIs](/dev/reference/APIs), for example:
51+
Once you've set up your machine you can control your device and any attached physical hardware with [Viam APIs](/dev/reference/apis/), for example:
5252

5353
{{< tabs class="horizontalheaders program" navheader="Examples">}}
5454
{{% tab name="Drive a base" %}}

docs/dev/reference/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ Users can now have [access to different fleet management capabilities](/manage/m
349349

350350
{{% changelog date="2023-11-30" color="added" title="Authenticate with location API key" %}}
351351

352-
You can now use [API keys for authentication](/sdks/#authentication).
352+
You can now use [API keys for authentication](/dev/tools/cli/#authenticate).
353353
API keys allow you to assign the minimum required permissions for usage.
354354
Location secrets, the previous method of authentication, is deprecated and will be removed in a future release.
355355

docs/dev/tools/cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ By default, new organization API keys are created with **Owner** permissions, gi
156156
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.
157157
{{% /alert %}}
158158

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/).
160160
To switch to using an organization API key for authentication right away, [logout](#logout) then log back in using `viam login api-key`.
161161

162162
An organization can have multiple API keys.
@@ -195,7 +195,7 @@ By default, new location API keys are created with **Owner** permissions, giving
195195
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.
196196
{{% /alert %}}
197197

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/).
199199
To switch to using a location API key for authentication right away, [logout](#logout) then log back in using `viam login api-key`.
200200

201201
A location can have multiple API keys.
@@ -233,7 +233,7 @@ Keep these key values safe.
233233
Authenticating using a machine part API key gives the authenticated CLI session full read and write access to your machine.
234234
{{% /alert %}}
235235

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/).
237237
To switch to using a machine part API key for authentication right away, [logout](#logout) then log back in using `viam login api-key`.
238238

239239
A location can have multiple API keys.

docs/operate/reference/architecture/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Now imagine you want to run code to turn on a fan when the temperature sensor re
153153
- Configure the fan motor as a motor component and wire the fan motor relay to the same board as the sensor.
154154
- 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.
155155
- 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.
157157
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.
158158

159159
![A desktop computer (client in this case) sends commands to robot 1 (server) with gRPC over wifi.](/build/program/sdks/robot-client.png)

docs/tutorials/services/constrain-motion.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,10 +309,10 @@ If we changed it to `theta=90` or `theta=270`, the gripper jaws would open verti
309309

310310
## Add a motion constraint
311311

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).
313313
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.
314314

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.
316316
However, since this opens up many more options for potential paths, it is much more computationally intensive than the linear constraint.
317317

318318
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:

static/include/services/apis/generated/motion.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ The motion service takes the volumes associated with all configured machine comp
3737
Transforms can be used to account for geometries that are attached to the robot but not configured as robot components.
3838
For example, you could use a transform to represent the volume of a marker held in your machine's gripper.
3939
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.
4142
- `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.
4243
- `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.
4344

@@ -145,7 +146,7 @@ Make sure the [SLAM service](/operate/reference/services/slam/) you use alongsid
145146
- `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.
146147
- `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.
147148
- `configuration` ([viam.proto.service.motion.MotionConfiguration](https://python.viam.dev/autoapi/viam/gen/service/motion/v1/motion_pb2/index.html#viam.gen.service.motion.v1.motion_pb2.MotionConfiguration)) (optional):
148-
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.
149150

150151
- `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.
151152
- `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/
189190

190191
- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
191192
- `req` [(MoveOnMapReq)](https://pkg.go.dev/go.viam.com/rdk/services/motion#MoveOnMapReq):
192-
A `MoveOnMapReq` which contains the following values:
193+
A `MoveOnMapReq` which contains the following values:
193194

194195
- `ComponentName` [(resource.Name)](https://pkg.go.dev/go.viam.com/rdk/resource#Name): The `resource.Name` of the base to move.
195196
- `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
291292
- `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>
292293
- `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>
293294
- `configuration` ([viam.proto.service.motion.MotionConfiguration](https://python.viam.dev/autoapi/viam/gen/service/motion/v1/motion_pb2/index.html#viam.gen.service.motion.v1.motion_pb2.MotionConfiguration)) (optional):
294-
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.
295296

296297
- `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.
297298
- `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/
335336

336337
- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
337338
- `req` [(MoveOnGlobeReq)](https://pkg.go.dev/go.viam.com/rdk/services/motion#MoveOnGlobeReq):
338-
A `MoveOnGlobeReq` which contains the following values:
339+
A `MoveOnGlobeReq` which contains the following values:
339340

340341
- `componentName` [(resource.Name)](https://pkg.go.dev/go.viam.com/rdk/resource#Name): The `resource.Name` of the base to move.
341342
- `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
415416
When `supplemental_transforms` are provided, a frame system is created within the context of the `GetPose` function.
416417
This new frame system builds off the machine's frame system and incorporates the `Transform`s provided.
417418
If the result of adding the `Transform`s results in a disconnected frame system, an error is thrown.
419+
418420
- `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.
419421
- `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.
420422

@@ -491,7 +493,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
491493
- `ctx` [(Context)](https://pkg.go.dev/context#Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
492494
- `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.
493495
- `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.
495497
A `LinkInFrame` represents an additional frame which is added to the machine's frame system.
496498
It consists of:
497499

@@ -500,11 +502,12 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
500502
When `supplementalTransforms` are provided, a frame system is created within the context of the `GetPose` function.
501503
This new frame system builds off the machine's frame system and incorporates the `LinkInFrame`s provided.
502504
If the result of adding the `LinkInFrame`s results in a disconnected frame system, an error is thrown.
505+
503506
- `extra` [(map[string]interface{})](https://go.dev/blog/maps): Extra options to pass to the underlying RPC call.
504507

505508
**Returns:**
506509

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.
508511
- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
509512

510513
**Example:**
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Pass in optional [motion constraints](/services/motion/constraints/).
1+
Pass in optional [motion constraints](/operate/reference/services/motion/constraints/).
22
By default, motion is unconstrained with the exception of obstacle avoidance.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Pass in [motion constraints](/services/motion/constraints/).
1+
Pass in [motion constraints](/operate/reference/services/motion/constraints/).
22
By default, motion is unconstrained with the exception of obstacle avoidance.

0 commit comments

Comments
 (0)