Skip to content

Commit

Permalink
Change yahboom documentation to modular. (#1921)
Browse files Browse the repository at this point in the history
randhid authored Sep 28, 2023
1 parent a647aa5 commit cc4d85a
Showing 2 changed files with 11 additions and 35 deletions.
1 change: 0 additions & 1 deletion docs/components/arm/_index.md
Original file line number Diff line number Diff line change
@@ -58,7 +58,6 @@ For configuration information, click on one of the supported arm models:
| [`xArm6`](xarm6/) | [UFACTORY xArm 6](https://www.ufactory.cc/product-page/ufactory-xarm-6) |
| [`xArm7`](xarm7/) | [UFACTORY xArm 7](https://www.ufactory.cc/product-page/ufactory-xarm-7) |
| [`xArmLite`](xarmlite/) | [UFACTORY Lite 6](https://www.ufactory.cc/product-page/ufactory-lite-6) |
| [`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/).
45 changes: 11 additions & 34 deletions docs/components/arm/yahboom-dofbot.md
Original file line number Diff line number Diff line change
@@ -3,21 +3,25 @@ title: "Configure a yahboom-dofbot Arm"
linkTitle: "yahboom-dofbot"
weight: 50
type: "docs"
description: "Configure a yahboom-dofbot arm."
draft: "true"
description: "Configure a Yahboom DOFBOT modular arm."
images: ["/icons/components/arm.svg"]
tags: ["arm", "components"]
---

Configure a `yahboom-dofbot` arm to add a [Yahboom DOFBOT](https://category.yahboom.net/collections/r-robotics-arm) to your robot:
Viam supports the [Yahboom DOFBOT](https://category.yahboom.net/collections/r-robotics-arm) arm as a [modular resource](https://github.com/viam-labs/yahboom).
Configure a `dofbot` arm to add it to your robot:

{{< tabs >}}
{{% tab name="Config Builder" %}}

Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
Click on the **Components** subtab and click **Create component**.
Select the `arm` type, then select the `yahboom-dofbot` model.
Select the `arm` type, then select the `rand:yahboom:dofbot` modular resource.
Enter a name for your arm and click **Create**.

There are no attributes available for this modular arm.

![Web UI configuration panel for an arm of model yahboom-dofbot in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/yahboom-dofbot-ui-config.png)

Edit and fill in the attributes as applicable.
@@ -29,13 +33,10 @@ Edit and fill in the attributes as applicable.
{
"components": [
{
"model": "yahboom-dofbot",
"name": "<your-arm-name>",
"model": "dofbot",
"type": "arm",
"attributes": {
"board": "<your-board-name>",
"i2c": "<your-i2c-name>"
},
"attributes": {},
"depends_on": []
}
]
@@ -48,40 +49,16 @@ Edit and fill in the attributes as applicable.
```json {class="line-numbers linkable-line-numbers"}
{
"components": [
{
"depends_on": [],
"model": "pi",
"name": "local",
"type": "board",
"attributes": {
"i2cs": [
{
"name": "bus1",
"bus": "1"
}
]
}
},
{
"name": "myarm",
"type": "arm",
"model": "yahboom-dofbot",
"attributes": {
"board": "local",
"i2c": "bus1"
},
"depends_on": ["local"]
"attributes": {},
"depends_on": []
}
]
}
```

{{% /tab %}}
{{< /tabs >}}

The following attributes are available for `yahboom-dofbot` arms:

<!-- prettier-ignore -->
| Attribute | Type | Inclusion | Description |
| --------- | ---- | ----------| ----------- |
| `i2c` | string | **Required** | The `name` of the Inter-Integrated Circuit (I<sup>2</sup>C) bus on your GPIO [board](/components/board/) where the connection to the `yahboom-dofbot` is made. See [configuration info](/components/board/#i2cs). |

0 comments on commit cc4d85a

Please sign in to comment.