Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Esha Maharishi <[email protected]>
  • Loading branch information
JessamyT and EshaMaharishi authored Jan 23, 2025
1 parent f1e211f commit a922909
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
10 changes: 4 additions & 6 deletions docs/operate/get-started/other-hardware/micro-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ aliases:
- /installation/viam-micro-server-dev/
---

[The Micro-RDK](https://github.com/viamrobotics/micro-rdk/) is the lightweight version of Viam's full Robot Development Kit, designed for resource-limited embedded systems (ESP32) that cannot run the fully-featured `viam-server`.
[The Micro-RDK](https://github.com/viamrobotics/micro-rdk/) is the lightweight version of Viam's full Robot Development Kit (RDK), designed for resource-limited embedded systems (ESP32) that cannot run the fully-featured `viam-server`.
`viam-micro-server` is the pre-built firmware built from the Micro-RDK and a default set of {{< glossary_tooltip term_id="module" text="modules" >}}, provided for convenience.
If you want to use different modules with the Micro-RDK, you can build your own firmware using the instructions on this page.

Expand All @@ -31,9 +31,7 @@ If you only want to install the pre-built `viam-micro-server` firmware with a de

{{< expand "Why does the Micro-RDK work differently from the full RDK?" >}}
Microcontrollers do not have full operating systems like single-board computers and general-purpose computers.
This means that it is generally harder to make software portable across multiple microcontrollers, and it means that microcontrollers can only run one "program" at a time.

Rather than being able to download and install an executable the way you can on a computer or single-board computer, a microcontroller must be flashed with firmware containing the entire logic to run.
This means that microcontrollers can only run one "program" at a time, and a microcontroller must be flashed with firmware containing the entire logic to run.

The Micro-RDK is a version of the RDK library written in Rust and designed to run on microcontrollers.
The Micro-RDK includes built-in support for several common hardware components, such as standard DC motors and an ultrasonic sensor.
Expand All @@ -46,7 +44,7 @@ The instructions below are for configuring a development environment in order to
- Develop custom firmware which combines the Micro-RDK with one or more modules.
- Develop modules for the Micro-RDK.

For advanced topics including development of the Micro-RDK itself, to add features and fix bugs, or to produce a build for a specific ESP-IDF version or platform for which Viam does not offer a pre-built solution, see [Viam Micro-RDK Development on GitHub](https://github.com/viamrobotics/micro-rdk/blob/main/DEVELOPMENT.md).
For advanced topics including development of the Micro-RDK itself, see [Viam Micro-RDK Development on GitHub](https://github.com/viamrobotics/micro-rdk/blob/main/DEVELOPMENT.md).

## Required software

Expand Down Expand Up @@ -111,7 +109,7 @@ If you would like to instead retain the setup script, replace `/dev/null` in the

## Build custom firmware

To create firmware that integrates an existing module with the Micro-RDK, and flash your machine with it, follow these steps.
To create firmware that integrates an existing module with the Micro-RDK, and flash your microcontroller with it, follow these steps.

1. Create a new machine and obtain its credentials:

Expand Down
2 changes: 1 addition & 1 deletion docs/operate/get-started/supported-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Modules in the list above are officially supported and maintained by Viam if and

The following is a selection of components (some built-ins and some modules) written for use with the Micro-RDK.
To use any of the built-in components, configure them according to their readmes.
To use a module with the Micro-RDK, you can either install the pre-built `viam-micro-server` firmware that ships with a few common modules, or [build your own firmware that combines the Micro-RDK with one or more modules](/operate/get-started/other-hardware/micro-module/).
You can either install the pre-built `viam-micro-server` firmware that ships with a few common modules, or [build your own firmware that combines the Micro-RDK with one or more modules of your choice](/operate/get-started/other-hardware/micro-module/).

<!--prettier-ignore-->
| Model | Description | Built-in |
Expand Down
6 changes: 3 additions & 3 deletions static/include/micro-create-your-own.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{< alert title="Add support for other models" color="note" >}}
If none of the existing models fit your use case, you can create a {{< glossary_tooltip term_id="modular-resource" text="modular resource" >}} to add support for it.

`viam-micro-server` works differently from the RDK, so creating modular resources for it is different.
Refer to the [Micro-RDK Module Template on GitHub](https://github.com/viamrobotics/micro-rdk/tree/main/templates/module) for information on how to create custom resources for your `viam-micro-server` machine.
You will need to [recompile and flash your ESP32 yourself](/operate/get-started/other-hardware/micro-module/) instead of using Viam's prebuilt binary and installer.
The Micro-RDK works differently from the RDK, so creating modular resources for it is different.
Refer to the [Micro-RDK Module Template on GitHub](https://github.com/viamrobotics/micro-rdk/tree/main/templates/module) for information on how to create custom resources for your microcontroller.
You will need to [build custom firmware and flash your ESP32 yourself](/operate/get-started/other-hardware/micro-module/) instead of using Viam's prebuilt binary and installer.
{{< /alert >}}

0 comments on commit a922909

Please sign in to comment.