remove old junk
This commit is contained in:
franchioping
parent
76f1651736
commit
e7855d0140
7
LICENSE
7
LICENSE
|
|
@ -1,7 +0,0 @@
|
|||
Copyright 2021 Espressif Systems (Shanghai) CO LTD
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
124
README.md
124
README.md
|
|
@ -1,124 +0,0 @@
|
|||
# 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
|
||||
```
|
||||
Loading…
Reference in New Issue