From 184f277bb96c39ce40cb4a47080b590d495ffaa8 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 10 Jan 2025 16:34:08 -0800 Subject: [PATCH] Apply some of Esha's new docs feedback --- docs/operate/get-started/other-hardware/micro-module.md | 5 +++-- docs/operate/get-started/setup.md | 1 - docs/operate/get-started/supported-hardware/_index.md | 7 +++++-- docs/operate/reference/components/board/esp32.md | 4 ++-- static/include/micro-rdk-hardware.md | 3 --- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/operate/get-started/other-hardware/micro-module.md b/docs/operate/get-started/other-hardware/micro-module.md index 8744424348..a1c4231365 100644 --- a/docs/operate/get-started/other-hardware/micro-module.md +++ b/docs/operate/get-started/other-hardware/micro-module.md @@ -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 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: @@ -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 (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: diff --git a/docs/operate/get-started/setup.md b/docs/operate/get-started/setup.md index 229b35c5c5..4741ec8be8 100644 --- a/docs/operate/get-started/setup.md +++ b/docs/operate/get-started/setup.md @@ -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. diff --git a/docs/operate/get-started/supported-hardware/_index.md b/docs/operate/get-started/supported-hardware/_index.md index 535797b467..87b94757e0 100644 --- a/docs/operate/get-started/supported-hardware/_index.md +++ b/docs/operate/get-started/supported-hardware/_index.md @@ -117,7 +117,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 @@ -138,6 +138,9 @@ 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, a single firmware build that includes the micro-RDK and one or more modules must be flashed onto the device. +Note that in order to add the module successfully to the machine’s configuration, the module needs to exist in the firmware build. diff --git a/docs/operate/reference/components/board/esp32.md b/docs/operate/reference/components/board/esp32.md index e9b9661c30..fec04121e0 100644 --- a/docs/operate/reference/components/board/esp32.md +++ b/docs/operate/reference/components/board/esp32.md @@ -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`: diff --git a/static/include/micro-rdk-hardware.md b/static/include/micro-rdk-hardware.md index 6b9e9af193..661209a004 100644 --- a/static/include/micro-rdk-hardware.md +++ b/static/include/micro-rdk-hardware.md @@ -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. @@ -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 >}}