History

bjoernQ 0f58f84873 Bump version of xtensa-lx, use correct features		2022-04-20 08:32:45 -07:00
..
.cargo	Move linker scripts to sub-folders	2022-02-18 12:00:05 +01:00
examples	Update xtensa-lx-rt, fix interrupt related examples	2022-04-04 08:52:27 -07:00
ld	Move linker scripts to sub-folders	2022-02-18 12:00:05 +01:00
src	Merge branch 'main' into feature/spi	2022-03-10 17:51:18 +01:00
build.rs	Move linker scripts to sub-folders	2022-02-18 12:00:05 +01:00
Cargo.toml	Bump version of xtensa-lx, use correct features	2022-04-20 08:32:45 -07:00
README.md	Various updates all READMEs	2022-01-12 13:52:01 -08: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-S2 from Espressif. Implements a number of the traits defined by 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. Refer to the Getting Stared section below for more information.

Documentation

Getting Started

Installing the Rust Compiler

Pre-built compilers are available for most common operating systems and architectures via the esp-rs/rust-build repository. This repository additionally provides scripts to simplify the installation process.

For Linux or macOS:

$ curl -LO https://raw.githubusercontent.com/esp-rs/rust-build/main/install-rust-toolchain.sh
$ chmod +x install-rust-toolchain.sh
$ ./install-rust-toolchain.sh

For Windows:

PS> Invoke-WebRequest https://raw.githubusercontent.com/esp-rs/rust-build/main/Install-RustToolchain.ps1 -OutFile Install-RustToolchain.ps1
PS> .\Install-RustToolchain.ps1

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.