History

Jesse Braham ecb3c31d21 Document package features and supported image formats (#758 ) * Hide internal-only RMT macros from documentation * Document the features of each chip-specific HAL package * Document the supported image formats for relevant packages		2023-08-28 07:34:59 -07:00
..
.cargo	Add bare-bones PSRAM support for ESP32-S2	2023-04-25 16:47:57 +02:00
examples	feat(hmac): Add HMAC driver for hardware acceleration (#755 )	2023-08-28 08:54:41 +02:00
ld	Fixed wrong `dram_seg` length in `esp32s2-hal` linker script (#732 ) (#734 )	2023-08-16 13:26:52 +02:00
src	Document package features and supported image formats (#758 )	2023-08-28 07:34:59 -07:00
build.rs	Add bare-bones PSRAM support for ESP32-S2	2023-04-25 16:47:57 +02:00
Cargo.toml	feat(hmac): Add HMAC driver for hardware acceleration (#755 )	2023-08-28 08:54:41 +02:00
README.md	Update each HAL package's `README`	2023-08-23 07:42:56 -07:00
rust-toolchain.toml	Add the (incomplete and non-buildable) esp32s2-hal and esp32s3-hal packages	2021-11-23 14:11:51 -08:00

README.md

esp32s2-hal

no_std HAL for the ESP32 from Espressif.

Implements a number of the traits defined in 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.

Please refer to the documentation for more information.

Documentation

Resources

Getting Started

Installing the Rust Compiler

We provide a tool, espup, for easily installing the Rust toolchain with Xtensa support:

cargo install espup
espup install

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:

. $HOME/export-esp.sh

See the Installation chapter of The Rust on ESP Book for more details.

License

Licensed under either of:

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.