Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/espressif/rust-esp32-example
Example of Rust integration into an ESP-IDF project, for ESP32 series of chips
https://github.com/espressif/rust-esp32-example
Last synced: 2 days ago
JSON representation
Example of Rust integration into an ESP-IDF project, for ESP32 series of chips
- Host: GitHub
- URL: https://github.com/espressif/rust-esp32-example
- Owner: espressif
- License: mit
- Created: 2021-06-08T15:39:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-30T12:59:58.000Z (almost 2 years ago)
- Last Synced: 2024-09-18T16:00:03.517Z (8 days ago)
- Language: Rust
- Size: 90.8 KB
- Stars: 436
- Watchers: 18
- Forks: 36
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deprecation warning
The following example is suitable only for cases where the majority of logic is based on ESP-IDF. The example here uses so-called `idf first` approach.
We **recommend `cargo first` approach** described at https://github.com/esp-rs . The approach is simpler and available templates support Development Containers, GitPod, and CodeSpaces.
# Rust ESP32 Example
An example project demonstrating integration with Rust for the ESP32-S2 and ESP32-C3 microcontrollers.
This example starts a FreeRTOS task to call a function in Rust and display the results in C.
## Setup
First, install the ESP-IDF SDK as shown in the [Get Started](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html) guides. For best support of the ESP32-C3, install the SDK from the master branch.
### ESP32 and ESP32-S series
Installation instruction for Xtensa architecture is in project [esp-rs/rust-build](https://github.com/esp-rs/rust-build).
#### Podman/Docker image
Alternatively you might build the project in the container where image already contains pre-installed Rust and ESP-IDF.
Podman example with mapping multiple /dev/ttyUSB from host computer to the container:
```
podman run --device /dev/ttyUSB0 --device /dev/ttyUSB1 -it espressif/idf-rust-examples
```Docker (does not support flashing from container):
```
docker run -it espressif/idf-rust-examples
```Then follow instructions displayed on the screen.
### ESP32-C3
Install the RISCV target for Rust:
```sh
rustup target add riscv32i-unknown-none-elf
```## Configure
First ensure that the environment variables for the ESP32 SDK are properly set up. If you have followed the instructions in the Getting Started guide, activate the environment with the `get_idf` alias:
```sh
get_idf
```Next, configure the project for the desired MCU.
For the ESP32:
```sh
idf.py set-target esp32
idf.py menuconfig
```For the ESP32-S2:
```sh
idf.py set-target esp32s2
idf.py menuconfig
```For the ESP32-C3:
```sh
idf.py set-target esp32c3
idf.py menuconfig
```## Build
Build the project by running:
```sh
idf.py build
```This also runs Cargo internally, building a static library out of Rust code.
## Flash
Flash the compiled binary by running:
```sh
idf.py -p /dev/cu.SLAB_USBtoUART flash
```## Monitor
Connect to the UART over USB port to monitor the application console:
```sh
idf.py -p /dev/cu.SLABtoUART monitor
```To exit the monitor, press `Ctrl-]`.
## Debugging on ESP32-WROVER-KIT
```sh
openocd -f board/esp32-wrover-kit-3.3v.cfg
```## Table of footprints
Print the memory statistics of the project:
```sh
idf.py size-files
```or in `json` format:
```sh
$IDF_PATH/tools/idf_size.py --files --json build/esp32-hello-rust.map
```