From b8cb74ec5fab562c0818461ff580d1c31041512b Mon Sep 17 00:00:00 2001 From: Andrew Morrow Date: Mon, 16 Dec 2024 15:32:52 -0500 Subject: [PATCH] Document new Rust 1.83 requirement and add a new troubleshooting hint --- docs/installation/viam-micro-server-dev.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/installation/viam-micro-server-dev.md b/docs/installation/viam-micro-server-dev.md index dc3505dfd8..7dad338762 100644 --- a/docs/installation/viam-micro-server-dev.md +++ b/docs/installation/viam-micro-server-dev.md @@ -82,7 +82,7 @@ The instructions below are for configuring a development environment in order to 1. Use `espup` to download and install the ESP Rust toolchain: ```sh { class="command-line" data-prompt="$"} - espup install -s -f /dev/null -v 1.76.0 + espup install -s -f /dev/null -v 1.83.0 ``` {{< alert title="Note" color="tip" >}} @@ -275,6 +275,13 @@ For further details on `viam-micro-server` development, including credentials ma This is caused by an [upstream bug](https://github.com/esp-rs/esp-idf-template/issues/174). To work around this issue, ensure that `CRATE_CC_NO_DEFAULTS=1` is set in the environment when building. +### Error: `error: externally-managed-environment` when building ESP-IDF on macOS + +This is encountered when attempting to build ESP-IDF projects while using Python obtained from Homebrew. +Homebrew's Python infrastructure is not intended for end-user consumption but is instead made available to support Homebrew packages which require a python interpreter. +The preferred workaround for this issue is to obtain a user-facing python installation not from Homebrew, but there are other, less safe, workarounds. +Please see the macOS specific notes in the [development technical notes on GitHub](https://github.com/viamrobotics/micro-rdk/blob/main/DEVELOPMENT.md#fixing-esp-builds-on-macos) for more details. + ### Error: Failed to open serial port If you run into the error `Failed to open serial port` when flashing your ESP32 with Linux, make sure the user is added to the group `dialout` with `sudo gpasswd -a $USER dialout`.