From 0de8c9802ddb07dcac547574c60769b07c7a715b Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Thu, 16 Jan 2025 15:34:15 -0800 Subject: [PATCH 1/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ad6f9c4a..61edb9455 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Table of Contents - [Getting Started](#getting-started) - [License](#license) -# Micro-RDK (Robot Development Kit for Microcontrollers) +# The Micro-RDK (Robot Development Kit for Microcontrollers) Viam provides an open source robot architecture that provides robotics functionality via simple APIs. From 7a590d0e97b9a204ba90a04a867e6ca5e6bc46b8 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Tue, 21 Jan 2025 15:24:24 -0800 Subject: [PATCH 2/4] Edit more instances --- DEVELOPMENT.md | 20 ++++++++++---------- OTA.md | 8 ++++---- micro-rdk-installer/README.md | 12 ++++++------ 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index bf72b85f1..2d535985d 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -21,16 +21,16 @@ on the Micro-RDK itself. ### Tree-level `cargo` configuration -The micro-rdk monorepo is only part of the development story: when -developing for or with Micro-RDK, there will be other directories in +The `micro-rdk` monorepo is only part of the development story: when +developing for or with the Micro-RDK, there will be other directories in play (e.g. projects generated from the template, etc.), and coordinating the state of these many directories and repositories can prove troublesome. A carefully placed `.cargo/config.toml` file can -inject settings for the entire tree of trees, including the micro-rdk +inject settings for the entire tree of trees, including the `micro-rdk` monorepo, projects, and modules. Simply create a `.cargo` directory as -a peer of your micro-rdk monorepo and any project directories, and +a peer of your `micro-rdk` monorepo and any project directories, and then create a `config.toml` file within it. Settings applied in that -file will now apply globally to all crates inside the micro-rdk as +file will now apply globally to all crates inside the Micro-RDK as well as to peer project directories. Here is an example layout: ``` @@ -156,10 +156,10 @@ paths forward: ### Patching in the local `micro-rdk` Monorepo at Tree Level -Again, if you are working with Micro-RDK, you probably have both the -`Micro-RDK` monorepo and various project directories associated with +Again, if you are working with the Micro-RDK, you probably have both the +`micro-rdk` monorepo and various project directories associated with it. Those projects quite often have their own `Cargo.toml` files that -have dependencies on micro-rdk by way of github: +have dependencies on the Micro-RDK by way of GitHub: ``` @@ -170,7 +170,7 @@ micro-rdk-modular-driver-example = { version = "0.2.2", git = "https://github.co ``` But just as often, what you actually want to do is to have these -projects use your __local_ micro-rdk state, and you end up hand +projects use your __local_ Micro-RDK state, and you end up hand editing the `Cargo.toml` file to point to a path instead: @@ -204,7 +204,7 @@ without needing local `Cargo.toml` edits. ### Customizing ESP-IDF configuration -The documented build procedures for Micro-RDK and Micro-RDK adjacent +The documented build procedures for the Micro-RDK and Micro-RDK-adjacent projects leverage the [`embuild` package](https://github.com/esp-rs/embuild) to automate the installation of the ESP-IDF framework. The default settings are usually what you want, but there are times when it may diff --git a/OTA.md b/OTA.md index 8be7648e0..f12152768 100644 --- a/OTA.md +++ b/OTA.md @@ -29,8 +29,8 @@ In the `url` field, enter the url where a firmware will be downloaded from - for cloud-hosted resources, embedded auth in the url is easiest, we don't support tokens yet -The `version` field is equivalent to a `tag` and can be any arbitrary string of up to 128 characters. -After successfully applying the new firmware, this `version` will be stored in NVS. +The `version` field is equivalent to a `tag` and can be any arbitrary string of up to 128 characters. +After successfully applying the new firmware, this `version` will be stored in NVS. This value is compared to that of the latest machine config from app.viam.com and will trigger the update process. @@ -90,7 +90,7 @@ The `make build-esp32-ota` command produces an App Image (described above), whic **This app image is what you must host, see [Firmware Hosting Options](#firmware-hosting-options).** -This build must be within the size limits of the smallest `ota_*` partition in a device's *current* partition table. +This build must be within the size limits of the smallest `ota_*` partition in a device's *current* partition table. This document assumes the user is using our included partition tables; should the final image be larger than the capacity of the ota partitions, the build will fail indicating so. To update a device's partition table, use the method in the [Full Build](#full-build) workflow. @@ -103,7 +103,7 @@ To update a device's partition table, use the method in the [Full Build](#full-b ### Cloud -The OTA Service in the micro-rdk currently supports **only HTTP/2**, this means that the hosting platform must support HTTP/2 connections. +The OTA Service in the Micro-RDK currently supports **only HTTP/2**, this means that the hosting platform must support HTTP/2 connections. While not all blob storage platform support HTTP/2, many offer Content Delivery Network (CDN) solutions that do. diff --git a/micro-rdk-installer/README.md b/micro-rdk-installer/README.md index 8be3d33a9..6f8e76a10 100644 --- a/micro-rdk-installer/README.md +++ b/micro-rdk-installer/README.md @@ -1,6 +1,6 @@ # The Viam Micro-RDK Installer -A CLI that allows a user to flash a build of Micro-RDK, along with their robot's credentials and their wifi information, directly to their esp32 without requiring installation of ESP-IDF, Rust, or Python. +A CLI that allows a user to flash a build of the Micro-RDK, along with their robot's credentials and their wifi information, directly to their esp32 without requiring installation of ESP-IDF, Rust, or Python. ## Option 1: Download Pre-Built Binaries @@ -22,15 +22,15 @@ Only necessary as an alternative to the previous Download step ## Usage ```text -A CLI that can flash a compilation of micro-RDK directly to an ESP32 provided configuration information +A CLI that can flash a compilation of the Micro-RDK directly to an ESP32 provided configuration information Usage: micro-rdk-installer [COMMAND] Commands: - write-flash Flash a pre-compiled binary with the micro-RDK server directly to an ESP32 connected to + write-flash Flash a pre-compiled binary (`viam-micro-server`) directly to an ESP32 connected to your computer via data cable write-credentials Write Wi-Fi and robot credentials to the NVS storage portion of a pre-compiled binary - running a micro-RDK server + running `viam-micro-server` create-nvs-partition Generate a binary of a complete NVS data partition that contains Wi-Fi and security credentials for a robot monitor Monitor a currently connected ESP32 @@ -45,14 +45,14 @@ Options: 1. Find your robot part at https://app.viam.com. Then navigate to the **Setup** tab 2. Regardless of your operating system, select **Mac** and press the button that appears in Step 2 to download the Viam app config for your robot 3. Run: `./micro-rdk-installer write-flash --app-config=` - 1. To see the micro-RDK server logs through the serial connection, add `--monitor` + 1. To see the `viam-micro-server` logs through the serial connection, add `--monitor` 2. If the program cannot auto-detect the serial port to which your ESP32 is connected, you may be prompted to select the correct one among a list ## Common Problems ### Linux Port Permissions -If a "Permission Denied" or similar port error occurs, first check the connection of the ESP32 to the machine's USB port. If +If a "Permission Denied" or similar port error occurs, first check the connection of the ESP32 to the machine's USB port. If connected and the error persists, run `sudo usermod -a -G dialout $USER` to add the current user to the `dialout` group, then try again. ### MacOS Executable Permissions From 995eec8131566fe178b31d001f661315adbd0e6c Mon Sep 17 00:00:00 2001 From: JessamyT Date: Tue, 21 Jan 2025 15:29:23 -0800 Subject: [PATCH 3/4] Couple more including a little linting --- examples/esp-idf-component/README.md | 11 ++++++----- micro-rdk-ffi/micrordklib-idf-component/README.md | 13 +++++-------- 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/examples/esp-idf-component/README.md b/examples/esp-idf-component/README.md index 48fcc14b0..4c3609778 100644 --- a/examples/esp-idf-component/README.md +++ b/examples/esp-idf-component/README.md @@ -1,16 +1,17 @@ # Using Micro-RDK as a library Example -This example cover shows how to use Micro-RDK into a new or existing ESP project. +This example cover shows how to use the Micro-RDK into a new or existing ESP project. ## How to configure the example -Open the project configuration menu (`idf.py menuconfig`). + +Open the project configuration menu (`idf.py menuconfig`). In the `Micro-RDK lib example configuration` menu: * Set the Wi-Fi configuration. * Set `WiFi SSID`. * Set `WiFi Password`. - + ## Build and Flash Build the project and flash it to the board, then run the monitor tool to view the serial output: @@ -23,6 +24,6 @@ See the Getting Started Guide for all the steps to configure and use the ESP-IDF * [ESP-IDF Getting Started Guide on ESP32](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html) -See the viam documentation for more information about Micro-RDK +See the Viam documentation for more information about the Micro-RDK: -* [Micro-RDK](https://docs.viam.com/get-started/installation/microcontrollers/) +* [Micro-RDK](https://docs.viam.com/operate/get-started/other-hardware/micro-module/) diff --git a/micro-rdk-ffi/micrordklib-idf-component/README.md b/micro-rdk-ffi/micrordklib-idf-component/README.md index 24e338cdb..9532e5b51 100644 --- a/micro-rdk-ffi/micrordklib-idf-component/README.md +++ b/micro-rdk-ffi/micrordklib-idf-component/README.md @@ -1,14 +1,11 @@ # Micro-RDK -The micro-RDK is a lightweight version of the Robot Development Kit (RDK) which can run on resource-limited embedded systems +The Micro-RDK is a lightweight version of the Robot Development Kit (RDK) which can run on resource-limited embedded systems -See the viam documentation for more information about Micro-RDK +See the viam documentation for more information about the Micro-RDK -* [Micro-RDK](https://docs.viam.com/get-started/installation/microcontrollers/) - - -# Example - -Get started with (example)[https://github.com/viamrobotics/micro-rdk/tree/main/esp-idf-component] +* [Micro-RDK](https://docs.viam.com/operate/get-started/other-hardware/micro-module/) +## Example +Get started with [example](https://github.com/viamrobotics/micro-rdk/tree/main/esp-idf-component]) From d307cc5bd568a1dd6eac6650c1d2bd8fcf1108ac Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Wed, 22 Jan 2025 15:33:20 -0800 Subject: [PATCH 4/4] Apply suggestions from code review --- examples/esp-idf-component/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/esp-idf-component/README.md b/examples/esp-idf-component/README.md index 4c3609778..6b3a2edc5 100644 --- a/examples/esp-idf-component/README.md +++ b/examples/esp-idf-component/README.md @@ -1,6 +1,6 @@ # Using Micro-RDK as a library Example -This example cover shows how to use the Micro-RDK into a new or existing ESP project. +This example shows how to use the Micro-RDK in a new or existing ESP project. ## How to configure the example