Skip to content

Commit

Permalink
DOCS-3032: Update component pages for user needs (#3592)
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Oct 17, 2024
1 parent 3279639 commit 407d55c
Show file tree
Hide file tree
Showing 149 changed files with 629 additions and 202 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update_sdk_methods.py
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@
"organization settings page": "/cloud/organizations/",
"image tags": "/services/data/dataset/#image-tags",
"API key": "/fleet/cli/#authenticate",
"board model": "/components/board/#available-models"
"board model": "/components/board/#configuration"
}

## Language-specific resource name overrides:
Expand Down
2 changes: 1 addition & 1 deletion docs/appendix/try-viam/rover-resources/rover-tutorial-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ If the Pi has power, the lights on the Raspberry Pi will light up.

### Connect to the Viam app

While the Pi boots, go to the [Viam app](https://app.viam.com/robots) and [add a machine](/cloud/machines/#add-a-new-machine).
While the Pi boots, go to the [Viam app](https://app.viam.com/robots) and add a new machine.
Navigate to the **CONFIGURE** tab and find your machine's card.
An alert will be present directing you to **Set up your machine part**.
Click **View setup instructions** to open the setup instructions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ Enable the I<sup>2</sup>C protocol on your Pi to get readings from the power sen

If you followed the instructions in the [Pi installation guide](/installation/prepare/rpi-setup/), you should have already made an account on the [Viam app](https://app.viam.com), installed `viam-server` on the board, and added a new machine.

If not, make sure to [prepare your device and install `viam-server`](/installation/viam-server-setup/), and then [add a new machine](/cloud/machines/#add-a-new-machine).
If not, add a new machine in the [Viam app](https://app.viam.com) and follow the {{< glossary_tooltip term_id="setup" text="setup instructions" >}} until your machine is connected.

To configure your rover so you can start driving it, [add a Viam Rover 2 Fragment to your machine](/appendix/try-viam/rover-resources/rover-tutorial-fragments/).

Expand Down
10 changes: 7 additions & 3 deletions docs/components/arm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you have a physical robotic arm, consisting of a serial chain of joints and l
Arms have two ends: one fixed in place, and one with a device you can position.
When controlling an arm, you can place its end effector at arbitrary cartesian positions relative to the base of the arm.

## Available models
## Configuration

To use a robotic arm, you need to add it to your machine's configuration.
Go to your machine's **CONFIGURE** page, and add a model that supports your arm.
Expand Down Expand Up @@ -88,9 +88,13 @@ Arm drivers are also paired, in the RDK, with JSON files that describe the kinem

## Troubleshooting

You can find additional assistance in the [Troubleshooting section](/appendix/troubleshooting/).
If your arm is not working as expected, follow these steps:

You can also ask questions on the [Community Discord](https://discord.gg/viam) and we will be happy to help.
1. Check your machine logs on the **LOGS** tab to check for errors.
2. Review your arm model's documentation to ensure you have configured all required attributes.
3. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the arm there.

If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.

## Next steps

Expand Down
6 changes: 5 additions & 1 deletion docs/components/arm/eva.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,13 @@ Configure an `eva` arm to integrate a [Automata Eva](https://automata.tech/produ

{{< readfile "/static/include/components/test-control/arm-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/arm.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/arm/" customTitle="Arm API" noimage="true" %}}
Expand Down
8 changes: 6 additions & 2 deletions docs/components/arm/fake.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,18 @@ The following attributes are available for `fake` arms:
<!-- prettier-ignore -->
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `arm-model` | string | Optional | Model name of the robotic arm model you want your fake arm to act as. See [built-in arm models](../#available-models) for supported model names. |
| `arm-model` | string | Optional | Model name of the robotic arm model you want your fake arm to act as. See [built-in arm models](../#configuration) for supported model names. |
| `model-path` | string | Optional | The path to the [kinematic configuration file](/internals/kinematic-chain-config/) of the arm driver you want your fake arm to act as. This path should point to the exact location where the file is located on your computer running `viam-server`. |

{{< readfile "/static/include/components/test-control/arm-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/arm.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/arm/" customTitle="Arm API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/arm/lite6.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,13 @@ var result = myArm.doCommand(command);
{{% /tab %}}
{{< /tabs >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/arm.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/arm/" customTitle="Arm API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/arm/ur5e.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,13 @@ The following attributes are available for `ur5e` arms:

{{< readfile "/static/include/components/test-control/arm-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/arm.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/arm/" customTitle="Arm API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/arm/xarm6.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,13 @@ var result = myArm.doCommand(command);
{{% /tab %}}
{{< /tabs >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/arm.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/arm/" customTitle="Arm API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/arm/xarm7.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,13 @@ var result = myArm.doCommand(command);
{{% /tab %}}
{{< /tabs >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/arm.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/arm/" customTitle="Arm API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/arm/yahboom-dofbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,13 @@ Edit and fill in the attributes as applicable.

{{< readfile "/static/include/components/test-control/arm-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/arm.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/arm/" customTitle="Arm API" noimage="true" %}}
Expand Down
17 changes: 14 additions & 3 deletions docs/components/base/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If you have a mobile robot, use a base component to coordinate the motion of its
<img src="base-trk-rover-w-arm.png" alt="A robot comprised of a wheeled base (motors, wheels and chassis) as well as some other components. The wheels are highlighted to indicate that they are part of the concept of a 'base', while the non-base components are not highlighted. The width and circumference are required attributes when configuring a base component." class="imgzoom aligncenter" style="width: 500px">
</p>

## Available models
## Configuration

To use a rover or other base, you need to add it to your machine's configuration.

Expand Down Expand Up @@ -71,9 +71,20 @@ The [base API](/appendix/apis/components/base/) supports the following methods:

## Troubleshooting

You can find additional assistance in the [Troubleshooting section](/appendix/troubleshooting/).
If your base is not working as expected, follow these steps:

{{< snippet "social.md" >}}
1. Check your machine logs on the **LOGS** tab to check for errors.
1. Review your base model's documentation to ensure you have configured all required attributes.
1. Review your configuration for any motors that are components of the base.
Check that the names of the motor components match the list of motors you configured on the base.
1. If a motor is spinning in an unexpected direction, try using the `dir_flip` attribute in its config, or try swapping the wires running to the motor to change its direction.
1. Check that all wires are securely attached to the correct pins.
1. If you are using a battery to power the base, check that it is adequately charged.
If the motors are drawing more power than the battery can supply, the single-board computer may be power cycling.
Consider using a wall power supply for testing purposes to rule out this issue.
1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the base there.

If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.

## Next steps

Expand Down
6 changes: 5 additions & 1 deletion docs/components/base/boat.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,13 @@ Each [motor](/components/motor/) inside of `Motors` has the following attributes

{{< readfile "/static/include/components/test-control/base-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/base.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/base/" customTitle="Base API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/base/fake.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,13 @@ See [GitHub](https://github.com/viamrobotics/rdk/blob/main/components/base/fake/

{{< readfile "/static/include/components/test-control/base-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/base.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/base/" customTitle="Base API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/base/sensor-controlled.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,13 @@ The position, orientation, and linear and angular velocity of the rover changing

{{<gif webm_src="/components/encoded-motor/controls_change.webm" mp4_src="/components/encoded-motor/controls_change.mp4" alt="The control tab of a movement sensor on a base with encoded motors as it turns">}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/base.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/base/" customTitle="Base API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/base/two_wheeled_base.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,13 @@ The following attributes are available for `two_wheeled_base` bases:

{{< readfile "/static/include/components/test-control/base-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/base.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/base/" customTitle="Base API" noimage="true" %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/components/base/wheeled.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,13 @@ Note that your base's wiring will vary depending on your choice of board, motors

{{< readfile "/static/include/components/test-control/base-control.md" >}}

## Troubleshooting

{{< readfile "/static/include/components/troubleshoot/base.md" >}}

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/base/" customTitle="Base API" noimage="true" %}}
Expand Down
11 changes: 8 additions & 3 deletions docs/components/board/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ If there is no board model for your board:

{{< /alert >}}

## Available models
## Configuration

To use GPIO pins, you need to add a board component to your machine's configuration.
Go to your machine's **CONFIGURE** page, and add a model that supports your board.
Expand Down Expand Up @@ -80,9 +80,14 @@ The [board API](/appendix/apis/components/board/) supports the following methods

## Troubleshooting

You can find additional assistance in the [Troubleshooting section](/appendix/troubleshooting/).
If your board is not working as expected, follow these steps:

{{< snippet "social.md" >}}
1. Check your machine logs on the **LOGS** tab to check for errors.
1. Review your board model's documentation to ensure you have configured all required attributes.
1. Check that all wires are securely connected.
1. Click on the **TEST** panel on the **CONFIGURE** or **CONTROL** tab and test if you can use the board there.

If none of these steps work, reach out to us on the [Community Discord](https://discord.gg/viam) and we will be happy to help.

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/beaglebone.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Configuring these attributes on your board allows you to integrate [digital inte

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/customlinux.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ The following attributes are available for `customlinux` boards:

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/esp32.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Then, follow these requirements to change the PWM frequencies of a pin:

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/fake.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Configuring these attributes on your board allows you to integrate [analog-to-di

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/jetson.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Configuring these attributes on your board allows you to integrate [digital inte

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/numato.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Configuring these attributes on your board allows you to integrate [analog-to-di

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/odroid.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Configuring these attributes on your board allows you to integrate [digital inte

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
4 changes: 2 additions & 2 deletions docs/components/board/orangepi.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ There is no setup guide available for the Orange Pi Zero 2W.
If you have one of these boards, you can image it with [an Ubuntu image](https://drive.google.com/drive/folders/1g806xyPnVFyM8Dz_6wAWeoTzaDg3PH4Z) to prepare it for running `viam-server`.
{{% /alert %}}

Once you have prepared your board, [add a new machine in your desired location](/cloud/machines/#add-a-new-machine) in the [Viam app](https://app.viam.com) and follow your new machine part's {{< glossary_tooltip term_id="setup" text="setup instructions" >}} to install `viam-server` on your board and connect to the Viam app.
Once you have prepared your board, add a new machine in the [Viam app](https://app.viam.com) and follow your new machine part's {{< glossary_tooltip term_id="setup" text="setup instructions" >}} to install `viam-server` on your board and connect to the Viam app.

To use the GPIO pins on your board to [configure a smart machine](/configure/) with your Orange Pi computer, configure your board as a {{< glossary_tooltip term_id="component" text="component" >}} of your machine in [the Viam app](https://app.viam.com):

Expand Down Expand Up @@ -124,7 +124,7 @@ Configure these attributes on your board to integrate [analog-to-digital convert

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/pca9685.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following attributes are available for `pca9685` boards:

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/components/board/pi5.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Configuring these attributes on your board allows you to integrate [analog-to-di

## Next steps

For more configuration and development info, see:
For more configuration and usage info, see:

{{< cards >}}
{{% card link="/appendix/apis/components/board/" customTitle="Board API" noimage="true" %}}
Expand Down
Loading

0 comments on commit 407d55c

Please sign in to comment.