From ad0e2bdb66872b14acf51f3a03e47b6af0834c91 Mon Sep 17 00:00:00 2001 From: John Date: Mon, 10 Feb 2025 13:10:31 -0500 Subject: [PATCH] update README --- README.md | 31 ++++++++++++------------------- meta.json | 4 +++- 2 files changed, 15 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a928783..ca5a6b2 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ This [uln2003 module](https://app.viam.com/module/viam/uln2003) implements a [ULN2003](https://www.ti.com/product/ULN2003A), used for low-current and low-precision applications using the [`rdk:component:motor` API](https://docs.viam.com/appendix/apis/components/motor/). It supports full, half, and quarter stepping with 4096 steps in a rotation in full-step mode. -## Configure your 28byj-48 motor - > [!NOTE] > Before configuring your motor, you must [create a machine](https://docs.viam.com/cloud/machines/#add-a-new-machine). Navigate to the [**CONFIGURE** tab](https://docs.viam.com/configure/) of your [machine](https://docs.viam.com/fleet/machines/) in the [Viam app](https://app.viam.com/). [Add motor / uln2003:28byj-48 to your machine](https://docs.viam.com/configure/#components). +## Configure your 28byj-48 motor + On the new component panel, copy and paste the following attribute template into your motor's attributes field: ```json @@ -37,30 +37,23 @@ The following attributes are available for `viam:uln2003:28byj-48` motors: Refer to your motor and motor driver data sheets for specifics. -## Example configuration +### Example configuration -### `viam:uln2003:28byj-48` ```json { - "name": "", - "model": "viam:uln2003:28byj-48", - "type": "motor", - "namespace": "rdk", - "attributes": { - "board": "example-board", - "pins": { - "in1": "11", - "in2": "12", - "in3": "13", - "in4": "15" - }, - "ticks_per_rotation": 4096 - } - "depends_on": [] + "board": "example-board", + "pins": { + "in1": "11", + "in2": "12", + "in3": "13", + "in4": "15" + }, + "ticks_per_rotation": 4096 } ``` ### Next Steps + - To test your motor, expand the **TEST** section of its configuration pane or go to the [**CONTROL** tab](https://docs.viam.com/fleet/control/). - To write code against your motor, use one of the [available SDKs](https://docs.viam.com/sdks/). - To view examples using a motor component, explore [these tutorials](https://docs.viam.com/tutorials/). diff --git a/meta.json b/meta.json index e7da999..2cf7894 100644 --- a/meta.json +++ b/meta.json @@ -7,7 +7,9 @@ "models": [ { "api": "rdk:component:motor", - "model": "viam:uln2003:28byj-48" + "model": "viam:uln2003:28byj-48", + "short_description": "the uln2003 28byj-48 stepper motor", + "markdown_link": "README.md#configure-your-28byj-48-motor" } ], "build": {