Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply some feedback on new docs #3842

Merged
merged 6 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/operate/get-started/other-hardware/micro-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ aliases:
This page provides instructions for configuring a development environment for working with `viam-micro-server`, outlines the steps for performing various development tasks, and provides troubleshooting and development tips to help organize and streamline work.

{{< alert title="Looking to install viam-micro-server?" color="note" >}}
If you only want to install and use `viam-micro-server`, follow the normal [setup instructions](/operate/get-started/setup/) instead.
If you only want to install the pre-built `viam-micro-server` firmware with a default set of modules, follow the normal [setup instructions](/operate/get-started/setup/) instead.
{{< /alert >}}

The instructions below are for configuring a development environment in order to:
Expand All @@ -37,7 +37,8 @@ The instructions below are for configuring a development environment in order to

## Required software

`viam-micro-server` is written in Rust. To be able to develop for `viam-micro-server` on macOS and Linux systems, you must install the following software on your development machine:
The [micro-RDK](https://github.com/viamrobotics/micro-rdk) (from which `viam-micro-server` is built) is written in Rust.
To be able to develop for `viam-micro-server` on macOS and Linux systems, you must install the following software on your development machine:

1. Install dependencies:

Expand Down
1 change: 0 additions & 1 deletion docs/operate/get-started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Viam can run on any computer that runs one of the following operating systems:
Viam also offers a lightweight binary to support the following 32-bit microcontrollers:

- [ESP32-WROVER Series](https://www.espressif.com/en/products/modules/esp32)
- ESP32-WROOM Series (until v0.1.7)

ESP32 microcontrollers must have at least 2 cores, 384kB SRAM, 2MB PSRAM and 4MB flash to work with Viam.

Expand Down
10 changes: 7 additions & 3 deletions docs/operate/get-started/supported-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,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 `viam-micro-server`.
To use any of the built-in components, configure them according to their readmes.
To use a module with `viam-micro-server`, you need to [build firmware that combines `viam-micro-server` with one or more modules](/operate/get-started/other-hardware/micro-module/).
To use a module with `viam-micro-server`, 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 `viam-micro-server` with one or more modules](/operate/get-started/other-hardware/micro-module/).

<!--prettier-ignore-->
| Model | Description | Built-in |
Expand All @@ -109,6 +109,8 @@ After [installing `viam-server` or `viam-micro-server`](/operate/get-started/set

For details on configuring versioning and environment variables for modules, see [Modular Resource and Module Configuration Details](/operate/reference/module-configuration/).

Note that for microcontrollers, in order to add a module successfully to the machine’s configuration, the module needs to exist in the [firmware build](/operate/get-started/other-hardware/micro-module/).

### Configure virtual hardware components

In addition to physical hardware, there are "virtual" hardware modules that do not directly drive any physical hardware, but rather augment physical hardware with another layer of abstraction, or add other functionality, for example:
Expand All @@ -117,7 +119,7 @@ In addition to physical hardware, there are "virtual" hardware modules that do n
- [A "sensor" that allows you to designate a primary sensor and backup sensors in case of failure](https://github.com/viam-modules/failover)
- [A ChatGPT integration module](https://github.com/jeremyrhyde/chat-gpt-module)

These software-only "hardware" modules implement the same [component APIs](/dev/reference/apis/#component-apis) as physical hardware modules, and are configured in the same way as other components.
These software-only modules implement the same [component APIs](/dev/reference/apis/#component-apis) as physical hardware modules, and are configured in the same way as other components.

## Add software services to your machine

Expand All @@ -138,6 +140,8 @@ To add a service to your machine:

## How modules run

Modules run alongside [`viam-server`](/operate/reference/viam-server/) as separate processes, communicating with `viam-server` over UNIX sockets.
Modules for 64-bit architecture run alongside [`viam-server`](/operate/reference/viam-server/) as separate processes, communicating with `viam-server` over UNIX sockets.
When a module initializes, it registers its {{< glossary_tooltip term_id="model" text="model or models" >}} and associated [APIs](/dev/reference/apis/) with `viam-server`, making the new model available for use.
`viam-server` manages the [dependencies](/operate/reference/viam-server/#dependency-management), [start-up](/operate/reference/viam-server/#start-up), [reconfiguration](/operate/reference/viam-server/#reconfiguration), [data management](/data-ai/capture-data/capture-sync/), and [shutdown](/operate/reference/viam-server/#shutdown) behavior of your modular resource.

For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the micro-RDK and one or more modules onto your device.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the micro-RDK and one or more modules onto your device.
For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes MicroRDK and one or more modules onto your device.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is how we have it in a couple of other pages right now--I'm going to leave this as-is for now and we can always change later if there is a different agreed-upon styling

4 changes: 2 additions & 2 deletions docs/operate/reference/components/board/esp32.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ micrordk_component: true

Follow the [setup guide](/operate/get-started/setup/) to install and run `viam-micro-server` before configuring an `esp32` board.

Viam recommends purchasing the ESP32 with a development board. The following ESP32 microcontrollers are supported:
Viam recommends purchasing the ESP32 with a development board.
The following ESP32 microcontrollers are supported:

- ESP32-WROOM Series (until v0.1.7)
- ESP-32-WROVER Series

Your microcontroller should have at least the following resources available to work with `viam-micro-server`:
Expand Down
3 changes: 0 additions & 3 deletions static/include/micro-rdk-hardware.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Viam recommends purchasing the ESP32 with a [development board](https://www.espr
The following ESP32 microcontrollers are supported:

- [ESP32-WROVER Series](https://www.espressif.com/en/products/modules/esp32)
- [ESP32-WROOM Series](https://www.espressif.com/en/products/modules/esp32) (until v0.1.7)

You will also need a data cable to connect the microcontroller to your development machine.

Expand All @@ -12,8 +11,6 @@ Your microcontroller should have at least the following resources available to w
- 2 Cores + 384kB SRAM + 2MB PSRAM + 4MB Flash

{{< alert title="Tip" color="tip" >}}
The main difference between the WROOM and WROVER is that the WROVER has additional RAM with the SPIRAM chip.
If you would like to allow more than one concurrent connection to your device we recommend using the WROVER.
The WROVER allows a max of 3 incoming gRPC connections (whether over HTTP2 or WebRTC).
You can change this max by [building your own version of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/).
{{< /alert >}}
Loading