Skip to content

Commit

Permalink
DOCS-1098: Add link to modular resource examples in relevant resource…
Browse files Browse the repository at this point in the history
… pages (#1811)
  • Loading branch information
sguequierre authored Sep 13, 2023
1 parent 3c9770c commit a4bb76c
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/components/arm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ Supported arm models include:
| [`yahboom-dofbot`](yahboom-dofbot/) | [Yahboom DOFBOT](https://category.yahboom.net/collections/r-robotics-arm) |
| [`ur5e`](ur5e/) | [Universal Robots UR5e](https://www.universal-robots.com/products/ur5-robot) |

Follow [this guide](/extend/modular-resources/examples/custom-arm/) to implement your custom arm as a [modular resource](/extend/modular-resources/).

## Control your arm with Viam's client SDK libraries

To get started using Viam's SDKs to connect to and control your robot, go to your robot's page on [the Viam app](https://app.viam.com), navigate to the **Code sample** tab, select your preferred programming language, and copy the sample code generated.
Expand Down
9 changes: 9 additions & 0 deletions docs/components/motor/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ Model | Description <a name="model-table"></a>
[`roboclaw`](./roboclaw/) | [Standard brushed DC motor](https://en.wikipedia.org/wiki/DC_motor) driven by [Basicmicro's](https://www.basicmicro.com/) [RoboClaw](https://www.basicmicro.com/RoboClaw-2x30A-Motor-Controller_p_9.html) motor controller
[`fake`](./fake/) | Used to test code without hardware

Viam also provides the following motor models as [modular resources](/extend/modular-resources/):

Model | Description
----- | -----------
[`viam:odrive:canbus`](/extend/modular-resources/examples/odrive/) | An [ODrive S1](https://odriverobotics.com/shop/odrive-s1) motor driver with CANbus communication
[`viam:odrive:serial`](/extend/modular-resources/examples/odrive/) | An [ODrive S1](https://odriverobotics.com/shop/odrive-s1) motor driver with serial communication

These modules can be [added to your robot from the Viam registry](/extend/modular-resources/configure/#add-a-module-from-the-viam-registry).

## Control your motor with Viam's client SDK libraries

To get started using Viam's SDKs to connect to and control your robot, go to your robot's page on [the Viam app](https://app.viam.com), navigate to the **Code sample** tab, select your preferred programming language, and copy the sample code generated.
Expand Down
8 changes: 8 additions & 0 deletions docs/components/sensor/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ This allows you to have the same access and control of the sensor through Viam a

For an example of creating a custom component, see a [WiFi strength sensor built with the Viam Go SDK](https://github.com/viam-labs/wifi-sensor/blob/main/linuxwifi/linuxwifi.go) or [custom resource types implemented with the Viam Python SDK](https://github.com/viamrobotics/viam-python-sdk/tree/main/examples/).

Viam also provides the following sensor model as a [modular resource](/extend/modular-resources/):

Model | Description
----- | -----------
[`viam:visual_odometry:opencv_orb`](/extend/modular-resources/examples/odrive/) | A resource which uses monocular [visual odometry](https://en.wikipedia.org/wiki/Visual_odometry) to enable any [calibrated cameras](/components/camera/calibrate/) to function as a movement sensor

This module can be [added to your robot from the Viam registry](/extend/modular-resources/configure/#add-a-module-from-the-viam-registry).

## Control your sensor with Viam's client SDK libraries

To get started using Viam's SDKs to connect to and control your robot, go to your robot's page on [the Viam app](https://app.viam.com), navigate to the **Code sample** tab, select your preferred programming language, and copy the sample code generated.
Expand Down

0 comments on commit a4bb76c

Please sign in to comment.