diff --git a/esp-hal-common/README.md b/esp-hal-common/README.md new file mode 100644 index 000000000..4500910ed --- /dev/null +++ b/esp-hal-common/README.md @@ -0,0 +1,33 @@ +# esp-hal-common + +[![Crates.io](https://img.shields.io/crates/v/esp-hal-common.svg)](https://crates.io/crates/esp-hal-common) +[![Docs](https://docs.rs/esp-hal-common/badge.svg)](https://docs.rs/esp-hal-common/) +![Crates.io](https://img.shields.io/crates/l/esp-hal-common) + +`no_std` HAL implementations for the peripherals which are common among Espressif devices. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal). + +This crate should not be used directly; you should use one of the device-specific HAL crates instead: + +- [esp32-hal](../esp32-hal/README.md) +- [esp32c3-hal](../esp32c3-hal/README.md) +- [esp32s2-hal](../esp32s2-hal/README.md) +- [esp32s3-hal](../esp32s3-hal/README.md) + +## [Documentation] + +[documentation]: https://docs.rs/esp-hal-common/ + +## License + +Licensed under either of: + +- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](../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. diff --git a/esp32-hal/README.md b/esp32-hal/README.md index 5ebd100c6..8ce1dbf16 100644 --- a/esp32-hal/README.md +++ b/esp32-hal/README.md @@ -1 +1,49 @@ # esp32-hal + +[![Crates.io](https://img.shields.io/crates/v/esp32-hal.svg)](https://crates.io/crates/esp32-hal) +[![Docs](https://docs.rs/esp32-hal/badge.svg)](https://docs.rs/esp32-hal/) +![Crates.io](https://img.shields.io/crates/l/esp32-hal) + +`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). + +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 Stared](#getting-started) section below for more information. + +## [Documentation] + +[documentation]: https://docs.rs/esp32-hal/ + +## Getting Started + +### Installing the Rust Compiler + +Pre-built compilers are available for most common operating systems and architectures via the [esp-rs/rust-build](https://github.com/esp-rs/rust-build) repository. This repository additionally provides scripts to simplify the installation process. + +For _Linux_ or _macOS_: + +```shell +$ 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_: + +```shell +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](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](../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. diff --git a/esp32c3-hal/README.md b/esp32c3-hal/README.md index 402b1f0b9..c3d335fe4 100644 --- a/esp32c3-hal/README.md +++ b/esp32c3-hal/README.md @@ -1 +1,38 @@ # esp32c3-hal + +[![Crates.io](https://img.shields.io/crates/v/esp32c3-hal.svg)](https://crates.io/crates/esp32c3-hal) +[![Docs](https://docs.rs/esp32c3-hal/badge.svg)](https://docs.rs/esp32c3-hal/) +![Crates.io](https://img.shields.io/crates/l/esp32c3-hal) + +`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). + +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 Stared](#getting-started) section below for more information. + +## [Documentation] + +[documentation]: https://docs.rs/esp32c3-hal/ + +## 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/): + +```shell +$ rustup target add riscv32imc-unknown-none-elf +``` + +## License + +Licensed under either of: + +- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](../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. diff --git a/esp32s2-hal/README.md b/esp32s2-hal/README.md index 799d64b45..11841de8b 100644 --- a/esp32s2-hal/README.md +++ b/esp32s2-hal/README.md @@ -1 +1,49 @@ # esp32s2-hal + +[![Crates.io](https://img.shields.io/crates/v/esp32s2-hal.svg)](https://crates.io/crates/esp32s2-hal) +[![Docs](https://docs.rs/esp32s2-hal/badge.svg)](https://docs.rs/esp32s2-hal/) +![Crates.io](https://img.shields.io/crates/l/esp32s2-hal) + +`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). + +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 Stared](#getting-started) section below for more information. + +## [Documentation] + +[documentation]: https://docs.rs/esp32s2-hal/ + +## Getting Started + +### Installing the Rust Compiler + +Pre-built compilers are available for most common operating systems and architectures via the [esp-rs/rust-build](https://github.com/esp-rs/rust-build) repository. This repository additionally provides scripts to simplify the installation process. + +For _Linux_ or _macOS_: + +```shell +$ 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_: + +```shell +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](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](../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. diff --git a/esp32s3-hal/README.md b/esp32s3-hal/README.md index 75d4c72a8..459754146 100644 --- a/esp32s3-hal/README.md +++ b/esp32s3-hal/README.md @@ -1 +1,49 @@ # esp32s3-hal + +[![Crates.io](https://img.shields.io/crates/v/esp32s3-hal.svg)](https://crates.io/crates/esp32s3-hal) +[![Docs](https://docs.rs/esp32s3-hal/badge.svg)](https://docs.rs/esp32s3-hal/) +![Crates.io](https://img.shields.io/crates/l/esp32s3-hal) + +`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). + +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 Stared](#getting-started) section below for more information. + +## [Documentation] + +[documentation]: https://docs.rs/esp32s3-hal/ + +## Getting Started + +### Installing the Rust Compiler + +Pre-built compilers are available for most common operating systems and architectures via the [esp-rs/rust-build](https://github.com/esp-rs/rust-build) repository. This repository additionally provides scripts to simplify the installation process. + +For _Linux_ or _macOS_: + +```shell +$ 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_: + +```shell +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](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](../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.