Skip to content

Commit 184f277

Browse files
committed
Apply some of Esha's new docs feedback
1 parent e1eb88f commit 184f277

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

docs/operate/get-started/other-hardware/micro-module.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ aliases:
2626
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.
2727

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

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

3838
## Required software
3939

40-
`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:
40+
The micro-RDK (from which `viam-micro-server` is built) is written in Rust.
41+
To be able to develop for `viam-micro-server` on macOS and Linux systems, you must install the following software on your development machine:
4142

4243
1. Install dependencies:
4344

docs/operate/get-started/setup.md

-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Viam can run on any computer that runs one of the following operating systems:
4242
Viam also offers a lightweight binary to support the following 32-bit microcontrollers:
4343

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

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

docs/operate/get-started/supported-hardware/_index.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ In addition to physical hardware, there are "virtual" hardware modules that do n
117117
- [A "sensor" that allows you to designate a primary sensor and backup sensors in case of failure](https://github.com/viam-modules/failover)
118118
- [A ChatGPT integration module](https://github.com/jeremyrhyde/chat-gpt-module)
119119

120-
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.
120+
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.
121121

122122
## Add software services to your machine
123123

@@ -138,6 +138,9 @@ To add a service to your machine:
138138

139139
## How modules run
140140

141-
Modules run alongside [`viam-server`](/operate/reference/viam-server/) as separate processes, communicating with `viam-server` over UNIX sockets.
141+
Modules for 64-bit architecture run alongside [`viam-server`](/operate/reference/viam-server/) as separate processes, communicating with `viam-server` over UNIX sockets.
142142
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.
143143
`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.
144+
145+
For microcontrollers, a single firmware build that includes the micro-RDK and one or more modules must be flashed onto the device.
146+
Note that in order to add the module successfully to the machine’s configuration, the module needs to exist in the firmware build.

docs/operate/reference/components/board/esp32.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ micrordk_component: true
1919

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

22-
Viam recommends purchasing the ESP32 with a development board. The following ESP32 microcontrollers are supported:
22+
Viam recommends purchasing the ESP32 with a development board.
23+
The following ESP32 microcontrollers are supported:
2324

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

2727
Your microcontroller should have at least the following resources available to work with `viam-micro-server`:

static/include/micro-rdk-hardware.md

-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Viam recommends purchasing the ESP32 with a [development board](https://www.espr
33
The following ESP32 microcontrollers are supported:
44

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

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

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

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

0 commit comments

Comments
 (0)