History

sanxus c196b67587 Improve spi master constructor (#901 ) * make pins optional for Spi::new (master, full-duplex mode) * add additional method to setup spi pins (master, full-duplex mode) * add additional method to setup spi pins (master, half-duplex mode) * remove generic type parameters for Spi::new * update documentation * make `with_pins` could be chained * update CHANGELOG.md * update CHANGELOG.md * make the return value of a method like `with_{}` owned fix (maybe?) all broken examples caused by the change (esp32-hal) * fix (maybe?) all broken examples caused by the change (esp32c2-hal) * fix (maybe?) all broken examples caused by the change (esp32c3-hal) * fix (maybe?) all broken examples caused by the change (esp32c6-hal) * fix (maybe?) all broken examples caused by the change (esp32h2-hal) * fix (maybe?) all broken examples caused by the change (esp32s2-hal) * fix (maybe?) all broken examples caused by the change (esp32s3-hal) * rerun 'cargo fmt' for esp-hal-common * rerun 'cargo fmt' for the rest of examples		2023-11-08 12:11:58 +01:00
..
.cargo	Add LLD option for all Xtensa chips (#861 )	2023-10-25 11:49:42 +01:00
examples	Improve spi master constructor (#901 )	2023-11-08 12:11:58 +01:00
ld	Add LLD option for all Xtensa chips (#861 )	2023-10-25 11:49:42 +01:00
src	Assorted analog-related simplifications/clean up (#857 )	2023-10-19 13:37:14 +02:00
build.rs	Add LLD option for all Xtensa chips (#861 )	2023-10-25 11:49:42 +01:00
Cargo.toml	Pin static_cell (#899 )	2023-11-03 08:05:37 +01:00
README.md	Update each HAL package's `README`	2023-08-23 07:42:56 -07:00
rust-toolchain.toml	Add a minimal HAL crate for the ESP32 with a serial example	2021-10-21 17:28:02 -07:00

README.md

esp32-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.