Skip to content

Commit 8a2e840

Browse files
committed
Base, arm examples and API description fixes
1 parent 0a90ad6 commit 8a2e840

File tree

7 files changed

+56
-7
lines changed

7 files changed

+56
-7
lines changed

docs/dev/reference/apis/components/arm.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@ title: "Arm API"
33
linkTitle: "Arm"
44
weight: 10
55
type: "docs"
6-
description: "Give commands to your arm components for linear motion planning, including self-collision prevention and obstacle avoidance."
6+
description: "Give commands to your arm components for linear motion planning."
77
icon: true
88
images: ["/icons/components/arm.svg"]
99
date: "2022-01-01"
1010
# updated: "" # When the content was last entirely checked
1111
---
1212

13-
The arm API allows you to give commands to your [arm components](/components/arm/) for linear motion planning, including self-collision prevention and obstacle avoidance.
13+
The arm API allows you to give commands to your [arm components](/components/arm/) for linear motion planning.
14+
If you want self-collision prevention and obstacle avoidance, use the [motion API](/dev/reference/apis/services/motion/).
1415

1516
The arm component supports the following methods:
1617

docs/dev/reference/apis/services/motion.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: "Motion Service API"
33
linkTitle: "Motion"
44
weight: 40
55
type: "docs"
6-
description: "Give commands to move a machine based on a SLAM map or GPS coordinates or to move a machine's components from one location to another."
6+
description: "Give commands to move a machine's components from one location or pose to another."
77
icon: true
88
images: ["/icons/components/arm.svg"]
99
date: "2022-01-01"
1010
# updated: "" # When the content was last entirely checked
1111
---
1212

13-
The motion service API allows you to give commands to your [motion service](/services/motion/) for moving a machine based on a SLAM map or GPS coordinates or for moving a machine's components from one location to another.
13+
The motion service API allows you to give commands to your [motion service](/services/motion/) for moving a mobile robot based on a SLAM map or GPS coordinates or for moving a machine's components from one pose to another.
1414

1515
The motion service supports the following methods:
1616

docs/operate/control/mobile-app.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ class BaseScreen extends StatelessWidget {
7878
See the guide for full code and instructions to get started by building a simple app to control a rented Viam rover:
7979

8080
{{< cards >}}
81-
{{% card link="/tutorials/control/mobile-app/drive-rover/" %}}
81+
{{% card link="/tutorials/control/drive-rover/" %}}
8282
{{< /cards >}}
8383

8484
For a more in-depth guide with more screens, see the following guide:

docs/operate/mobility/define-obstacles.md

+7
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,10 @@ type: "docs"
77
no_list: true
88
description: "Spatially describe your robot's working environment for collision avoidance."
99
---
10+
11+
## Example usage
12+
13+
{{< cards >}}
14+
{{% card link="/tutorials/services/constrain-motion/" %}}
15+
{{% card link="/tutorials/projects/claw-game/" %}}
16+
{{< /cards >}}

docs/operate/mobility/move-arm.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,21 @@ no_list: true
88
description: "Move an arm with joint positions or automated motion planning."
99
---
1010

11-
You can move a robotic arm either with the direct joint position commands of the [arm API](/dev/reference/apis/components/arm/), or with automated complex motion planning using the [motion planning service API](/dev/reference/apis/services/motion/).
11+
You have two options for moving a robotic arm:
12+
13+
- Use direct joint position commands and simple linear commands with the [arm API](/dev/reference/apis/components/arm/)
14+
- Use automated complex motion planning with the [motion planning service API](/dev/reference/apis/services/motion/)
1215

1316
{{< cards >}}
1417
{{% card link="/dev/reference/apis/components/arm/" %}}
1518
{{% card link="/dev/reference/apis/services/motion/" %}}
1619
{{< /cards >}}
20+
21+
## Tutorials and example usage
22+
23+
{{< cards >}}
24+
{{% card link="/how-tos/move-robot-arm/" %}}
25+
{{% card link="/tutorials/services/plan-motion-with-arm-gripper/" %}}
26+
{{% card link="/tutorials/services/constrain-motion/" %}}
27+
{{% card link="/tutorials/projects/claw-game/" %}}
28+
{{< /cards >}}

docs/operate/mobility/move-base.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
11
---
22
linkTitle: "Move a base"
3-
title: "Move a base through space"
3+
title: "Move a wheeled robot base"
44
weight: 40
55
layout: "docs"
66
type: "docs"
77
no_list: true
88
description: "Move a mobile robot with manual or autonomous navigation."
99
---
10+
11+
You have three options for moving a mobile robot base:
12+
13+
- Give direct commands such as `Spin` and `MoveStraight` using the [base API](/dev/reference/apis/components/base/)
14+
- Send the base to a destination on a SLAM map or to a GPS coordinate using the [motion planning service API's](/dev/reference/apis/services/motion/) `MoveOnMap` or `MoveOnGlobe` commands, respectively
15+
- Define waypoints and move your base along those waypoints while avoiding obstacles, using the [navigation service API](/dev/reference/apis/services/navigation)
16+
17+
{{< cards >}}
18+
{{% card link="/dev/reference/apis/components/base/" %}}
19+
{{% card link="/dev/reference/apis/services/motion/" %}}
20+
{{% card link="/dev/reference/apis/services/navigation/" %}}
21+
{{< /cards >}}
22+
23+
## Example usage
24+
25+
{{< cards >}}
26+
{{% card link="/tutorials/control/drive-rover/" %}}
27+
{{% card link="/tutorials/services/navigate-with-rover-base/" %}}
28+
{{< /cards >}}

docs/operate/mobility/move-gantry.md

+10
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,13 @@ type: "docs"
77
no_list: true
88
description: "Move a gantry with linear actuator positions or automated motion planning."
99
---
10+
11+
You have two options for moving a gantry:
12+
13+
- Move each axis of the gantry directly with the [gantry API](/dev/reference/apis/components/gantry/)
14+
- Use automated complex motion planning with the [motion planning service API](/dev/reference/apis/services/motion/)
15+
16+
{{< cards >}}
17+
{{% card link="/dev/reference/apis/components/gantry/" %}}
18+
{{% card link="/dev/reference/apis/services/motion/" %}}
19+
{{< /cards >}}

0 commit comments

Comments
 (0)