Update each HAL package's README
This commit is contained in:
Jesse Braham
Jesse Braham
parent
bf4efcfd7f
commit
3f345f78ba
@ -5,24 +5,41 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32 from Espressif. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32 from Espressif.
|
||||
|
||||
This device uses the Xtensa ISA, which is not officially supported by the Rust compiler. In order to develop for this device, you must use the Rust compiler fork with Xtensa support found at [esp-rs/rust](https://github.com/esp-rs/rust). Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the Xtensa ISA, which is not officially supported by the Rust compiler. In order to develop for this device, you must use the Rust compiler fork with Xtensa support, found at [esp-rs/rust](https://github.com/esp-rs/rust).
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler
|
||||
|
||||
```sh
|
||||
We provide a tool, [espup](https://github.com/esp-rs/espup/), for easily installing the Rust toolchain with Xtensa support:
|
||||
|
||||
```shell
|
||||
cargo install espup
|
||||
espup install
|
||||
# Unix
|
||||
```
|
||||
|
||||
Following installation of the Xtensa toolchain, if you are running a Unix-like operating system (macOS, Linux) then you must additionally export the necessary environment variables:
|
||||
|
||||
```shell
|
||||
. $HOME/export-esp.sh
|
||||
# Windows does not require sourcing any file
|
||||
```
|
||||
|
||||
See the [Installation chapter of The Rust on ESP Book](https://esp-rs.github.io/book/installation/index.html) for more details.
|
||||
|
||||
@ -5,22 +5,34 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32-C2 from Espressif. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32-C2 from Espressif.
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imc-unknown-none-elf` target. Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imc-unknown-none-elf` target.
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32c2-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp8684_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp8684_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler Target
|
||||
|
||||
The compilation target for this device is officially supported via the `stable` release channel and can be installed via [rustup](https://rustup.rs/):
|
||||
The compilation target for this device is officially supported by the mainline Rust compiler and can be installed using [rustup](https://rustup.rs/):
|
||||
|
||||
```shell
|
||||
$ rustup target add riscv32imc-unknown-none-elf
|
||||
rustup target add riscv32imc-unknown-none-elf
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
@ -5,146 +5,34 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32-C3 from Espressif. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32-C3 from Espressif.
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imc-unknown-none-elf` target. Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imc-unknown-none-elf` target.
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32c3-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler Target
|
||||
|
||||
The compilation target for this device is officially supported via the `stable` release channel and can be installed via [rustup](https://rustup.rs/):
|
||||
The compilation target for this device is officially supported by the mainline Rust compiler and can be installed using [rustup](https://rustup.rs/):
|
||||
|
||||
```shell
|
||||
$ rustup target add riscv32imc-unknown-none-elf
|
||||
```
|
||||
|
||||
### Supported boot methods
|
||||
|
||||
#### IDF Bootloader
|
||||
|
||||
The [IDF second stage bootloader](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/startup.html#second-stage-bootloader) is the default bootloader solution.
|
||||
|
||||
By default, [espflash](https://github.com/esp-rs/espflash) fetches the required binaries (Bootloader and Partition Table) and flashes them onto the target device together with the Rust-based application firmware image.
|
||||
|
||||
#### MCUboot Secure Bootloader
|
||||
|
||||
[MCUboot](https://github.com/mcu-tools/mcuboot) is a secure bootloader solution feature-wise equivalent to the [IDF Bootloader](#idf-bootloader).
|
||||
You may find more information on the documentation pages for MCUboot and the Espressif port:
|
||||
- https://docs.mcuboot.com/
|
||||
- https://docs.mcuboot.com/readme-espressif.html
|
||||
|
||||
##### Requirements
|
||||
|
||||
Booting from MCUboot secure bootloader requires the Rust application image to be built in a [MCUboot-specific image format](https://docs.mcuboot.com/design.html#image-format). You need to install the following dependencies:
|
||||
|
||||
```shell
|
||||
# Required for generating the object file in Intel HEX format
|
||||
cargo install cargo-binutils
|
||||
rustup component add llvm-tools-preview
|
||||
|
||||
# MCUboot's tool for image signing and key management
|
||||
pip install imgtool
|
||||
```
|
||||
|
||||
Currently, MCUboot is still not supported as a booting option in [espflash](https://github.com/esp-rs/espflash/issues/267), so you'll need to use the [esptool](https://github.com/espressif/esptool) utility for flashing both the MCUboot bootloader and the Rust application binaries:
|
||||
|
||||
```shell
|
||||
# Serial flasher utility for Espressif chips
|
||||
pip install esptool
|
||||
```
|
||||
|
||||
Download a prebuilt MCUboot bootloader image for the target device:
|
||||
|
||||
```shell
|
||||
# Prebuilt MCUboot bootloader binary
|
||||
curl -LO https://github.com/espressif/esp-nuttx-bootloader/releases/download/latest/mcuboot-esp32c3.bin
|
||||
```
|
||||
|
||||
##### Booting the Hello World example from MCUboot
|
||||
|
||||
Build the Hello World example with MCUboot support:
|
||||
|
||||
```shell
|
||||
cargo build --release --example hello_world --features mcu-boot
|
||||
```
|
||||
Then proceed to generating the application binary and flashing it onto the target device:
|
||||
|
||||
```shell
|
||||
# Generate the object file in Intel HEX format
|
||||
rust-objcopy -O ihex target/riscv32imc-unknown-none-elf/release/examples/hello_world app.hex
|
||||
|
||||
# Generate the application firmware image binary file in MCUboot-format
|
||||
imgtool sign --pad --align 4 -v 0 -s auto -H 32 --pad-header -S 0x100000 app.hex app.bin
|
||||
|
||||
# Flash the application firmware image binary onto the target device
|
||||
esptool.py -c esp32c3 -p /dev/ttyUSB0 -b 921600 --after no_reset write_flash -fs 4MB -fm dio -ff 40m 0x0 ./mcuboot-esp32c3.bin 0x110000 ./app.bin
|
||||
```
|
||||
Once the device is flashed, you may monitor the serial interface (e.g. with `picocom`):
|
||||
|
||||
```shell
|
||||
picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf
|
||||
```
|
||||
|
||||
Reset the board and MCUboot should load the Hello World example:
|
||||
```shell
|
||||
ESP-ROM:esp32c3-api1-20210207
|
||||
Build:Feb 7 2021
|
||||
rst:0x1 (POWERON),boot:0xc (SPI_FAST_FLASH_BOOT)
|
||||
SPIWP:0xee
|
||||
mode:DIO, clock div:2
|
||||
load:0x3fcd8598,len:0x10cc
|
||||
load:0x403c8000,len:0x2b90
|
||||
load:0x403d0000,len:0x1364
|
||||
entry 0x403c804a
|
||||
[esp32c3] [INF] Enabling RNG early entropy source...
|
||||
[esp32c3] [INF] *** Booting MCUboot build v1.8.0-86-g14763b1 ***
|
||||
[esp32c3] [INF] Primary image: magic=good, swap_type=0x2, copy_done=0x1, image_ok=0x3
|
||||
[esp32c3] [INF] Scratch: magic=unset, swap_type=0x1, copy_done=0x3, image_ok=0x3
|
||||
[esp32c3] [INF] Boot source: none
|
||||
[esp32c3] [INF] Swap type: test
|
||||
[esp32c3] [INF] Disabling RNG early entropy source...
|
||||
[esp32c3] [INF] br_image_off = 0x10000
|
||||
[esp32c3] [INF] ih_hdr_size = 0x20
|
||||
[esp32c3] [INF] DRAM segment: start=0x3fcd0000, size=0x0, vaddr=0x3fcd0000
|
||||
[esp32c3] [INF] IRAM segment: start=0x1d00, size=0x170c, vaddr=0x40380000
|
||||
[esp32c3] [INF] start=0x40380004
|
||||
Hello world!
|
||||
Hello world!
|
||||
Hello world!
|
||||
```
|
||||
|
||||
#### Direct Boot
|
||||
|
||||
[Direct Boot](https://github.com/espressif/esp32c3-direct-boot-example#direct-boot-in-esp32-c3) allows an application stored in the External Flash to be executed directly, without being copied into Internal RAM.
|
||||
|
||||
##### Booting the Hello World example using Direct Boot
|
||||
|
||||
Build the Hello World example with support for Direct Boot:
|
||||
|
||||
```shell
|
||||
cargo build --release --example hello_world --features direct-boot
|
||||
```
|
||||
|
||||
Then proceed to generating the application binary and flashing it onto the target device:
|
||||
|
||||
```shell
|
||||
cargo espflash --release --format direct-boot --features direct-boot --example hello_world --monitor
|
||||
```
|
||||
|
||||
The ROM Bootloader will identify the firmware image built with Direct Boot support and load it appropriately from the External Flash:
|
||||
|
||||
```shell
|
||||
ESP-ROM:esp32c3-api1-20210207
|
||||
Build:Feb 7 2021
|
||||
rst:0x1 (POWERON),boot:0xc (SPI_FAST_FLASH_BOOT)
|
||||
Hello world!
|
||||
Hello world!
|
||||
Hello world!
|
||||
rustup target add riscv32imc-unknown-none-elf
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
@ -5,59 +5,34 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32-C6 from Espressif. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32-C6 from Espressif.
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imac-unknown-none-elf` target. Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imac-unknown-none-elf` target.
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32c6-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-c6_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler Target
|
||||
|
||||
The compilation target for this device is officially supported via the `stable` release channel and can be installed via [rustup](https://rustup.rs/):
|
||||
The compilation target for this device is officially supported by the mainline Rust compiler and can be installed using [rustup](https://rustup.rs/):
|
||||
|
||||
```shell
|
||||
$ rustup target add riscv32imac-unknown-none-elf
|
||||
```
|
||||
|
||||
### Supported boot methods
|
||||
|
||||
#### IDF Bootloader
|
||||
|
||||
The [IDF second stage bootloader](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c6/api-guides/startup.html#second-stage-bootloader) is the default bootloader solution.
|
||||
|
||||
By default, [espflash](https://github.com/esp-rs/espflash) fetches the required binaries (Bootloader and Partition Table) and flashes them onto the target device together with the Rust-based application firmware image.
|
||||
|
||||
#### Direct Boot
|
||||
|
||||
[Direct Boot](https://github.com/espressif/esp32c3-direct-boot-example#direct-boot-in-esp32-c3) allows an application stored in the External Flash to be executed directly, without being copied into Internal RAM.
|
||||
|
||||
##### Booting the Hello World example using Direct Boot
|
||||
|
||||
Build the Hello World example with support for Direct Boot:
|
||||
|
||||
```shell
|
||||
cargo build --release --example hello_world --features direct-boot
|
||||
```
|
||||
|
||||
Then proceed to generating the application binary and flashing it onto the target device:
|
||||
|
||||
```shell
|
||||
cargo espflash --release --format direct-boot --features direct-boot --example hello_world --monitor
|
||||
```
|
||||
|
||||
The ROM Bootloader will identify the firmware image built with Direct Boot support and load it appropriately from the External Flash:
|
||||
|
||||
```shell
|
||||
ESP-ROM:esp32c6-20220919
|
||||
Build:Sep 19 2022
|
||||
rst:0x1 (POWERON),boot:0x6e (SPI_FAST_FLASH_BOOT)
|
||||
Hello world!
|
||||
Hello world!
|
||||
Hello world!
|
||||
rustup target add riscv32imac-unknown-none-elf
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
@ -5,22 +5,34 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32-C6 from Espressif's low-power coprocessor. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32-C6 from Espressif's low-power coprocessor.
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imac-unknown-none-elf` target. Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imac-unknown-none-elf` target.
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32c6-lp-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-c6_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler Target
|
||||
|
||||
The compilation target for this device is officially supported via the `stable` release channel and can be installed via [rustup](https://rustup.rs/):
|
||||
The compilation target for this device is officially supported by the mainline Rust compiler and can be installed using [rustup](https://rustup.rs/):
|
||||
|
||||
```shell
|
||||
$ rustup target add riscv32imac-unknown-none-elf
|
||||
rustup target add riscv32imac-unknown-none-elf
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
@ -5,59 +5,34 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32-H2 from Espressif. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32-H2 from Espressif.
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imac-unknown-none-elf` target. Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the RISC-V ISA, which is officially supported by the Rust compiler via the `riscv32imac-unknown-none-elf` target.
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32h2-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-h2_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler Target
|
||||
|
||||
The compilation target for this device is officially supported via the `stable` release channel and can be installed via [rustup](https://rustup.rs/):
|
||||
The compilation target for this device is officially supported by the mainline Rust compiler and can be installed using [rustup](https://rustup.rs/):
|
||||
|
||||
```shell
|
||||
$ rustup target add riscv32imac-unknown-none-elf
|
||||
```
|
||||
|
||||
### Supported boot methods
|
||||
|
||||
#### IDF Bootloader
|
||||
|
||||
The [IDF second stage bootloader](https://docs.espressif.com/projects/esp-idf/en/latest/esp32h2/api-guides/startup.html#second-stage-bootloader) is the default bootloader solution.
|
||||
|
||||
By default, [espflash](https://github.com/esp-rs/espflash) fetches the required binaries (Bootloader and Partition Table) and flashes them onto the target device together with the Rust-based application firmware image.
|
||||
|
||||
#### Direct Boot
|
||||
|
||||
[Direct Boot](https://github.com/espressif/esp32c3-direct-boot-example#direct-boot-in-esp32-c3) allows an application stored in the External Flash to be executed directly, without being copied into Internal RAM.
|
||||
|
||||
##### Booting the Hello World example using Direct Boot
|
||||
|
||||
Build the Hello World example with support for Direct Boot:
|
||||
|
||||
```shell
|
||||
cargo build --release --example hello_world --features direct-boot
|
||||
```
|
||||
|
||||
Then proceed to generating the application binary and flashing it onto the target device:
|
||||
|
||||
```shell
|
||||
cargo espflash --release --format direct-boot --features direct-boot --example hello_world --monitor
|
||||
```
|
||||
|
||||
The ROM Bootloader will identify the firmware image built with Direct Boot support and load it appropriately from the External Flash:
|
||||
|
||||
```shell
|
||||
ESP-ROM:esp32h2-20221101
|
||||
Build:Nov 1 2022
|
||||
rst:0x1 (POWERON),boot:0xc (SPI_FAST_FLASH_BOOT)
|
||||
Hello world!
|
||||
Hello world!
|
||||
Hello world!
|
||||
rustup target add riscv32imac-unknown-none-elf
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
@ -5,24 +5,41 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32-S2 from Espressif. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32 from Espressif.
|
||||
|
||||
This device uses the Xtensa ISA, which is not officially supported by the Rust compiler. In order to develop for this device, you must use the Rust compiler fork with Xtensa support found at [esp-rs/rust](https://github.com/esp-rs/rust). Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the Xtensa ISA, which is not officially supported by the Rust compiler. In order to develop for this device, you must use the Rust compiler fork with Xtensa support, found at [esp-rs/rust](https://github.com/esp-rs/rust).
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32s2-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler
|
||||
|
||||
```sh
|
||||
We provide a tool, [espup](https://github.com/esp-rs/espup/), for easily installing the Rust toolchain with Xtensa support:
|
||||
|
||||
```shell
|
||||
cargo install espup
|
||||
espup install
|
||||
# Unix
|
||||
```
|
||||
|
||||
Following installation of the Xtensa toolchain, if you are running a Unix-like operating system (macOS, Linux) then you must additionally export the necessary environment variables:
|
||||
|
||||
```shell
|
||||
. $HOME/export-esp.sh
|
||||
# Windows does not require sourcing any file
|
||||
```
|
||||
|
||||
See the [Installation chapter of The Rust on ESP Book](https://esp-rs.github.io/book/installation/index.html) for more details.
|
||||
|
||||
@ -5,24 +5,41 @@
|
||||
|
||||
[](https://matrix.to/#/#esp-rs:matrix.org)
|
||||
|
||||
`no_std` HAL for the ESP32-S3 from Espressif. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
`no_std` HAL for the ESP32 from Espressif.
|
||||
|
||||
This device uses the Xtensa ISA, which is not officially supported by the Rust compiler. In order to develop for this device, you must use the Rust compiler fork with Xtensa support found at [esp-rs/rust](https://github.com/esp-rs/rust). Refer to the [Getting Started](#getting-started) section below for more information.
|
||||
Implements a number of the traits defined in [embedded-hal](https://github.com/rust-embedded/embedded-hal).
|
||||
|
||||
This device uses the Xtensa ISA, which is not officially supported by the Rust compiler. In order to develop for this device, you must use the Rust compiler fork with Xtensa support, found at [esp-rs/rust](https://github.com/esp-rs/rust).
|
||||
|
||||
Please refer to the documentation for more information.
|
||||
|
||||
## [Documentation]
|
||||
|
||||
[documentation]: https://docs.rs/esp32s3-hal/
|
||||
|
||||
## Resources
|
||||
|
||||
- [Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf)
|
||||
- [Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-s3_technical_reference_manual_en.pdf)
|
||||
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
|
||||
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/index.html)
|
||||
- [The Rust on ESP Book](https://esp-rs.github.io/book/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installing the Rust Compiler
|
||||
|
||||
```sh
|
||||
We provide a tool, [espup](https://github.com/esp-rs/espup/), for easily installing the Rust toolchain with Xtensa support:
|
||||
|
||||
```shell
|
||||
cargo install espup
|
||||
espup install
|
||||
# Unix
|
||||
```
|
||||
|
||||
Following installation of the Xtensa toolchain, if you are running a Unix-like operating system (macOS, Linux) then you must additionally export the necessary environment variables:
|
||||
|
||||
```shell
|
||||
. $HOME/export-esp.sh
|
||||
# Windows does not require sourcing any file
|
||||
```
|
||||
|
||||
See the [Installation chapter of The Rust on ESP Book](https://esp-rs.github.io/book/installation/index.html) for more details.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user