itsscb/esp-hal
1
0
Fork 0
mirror of https://github.com/esp-rs/esp-hal.git synced 2025-09-27 12:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Top-level README.md updates, change to path dependency for esp-backtrace in hil-test package (#1588) (#1591)

Browse Source 
* Use path dependency instead of git for `esp-backtrace` in the `hil-test` package

* Top-level `README.md` updates
This commit is contained in:
Jesse Braham 2024-05-24 09:33:18 +00:00 committed by GitHub
parent a0a02ce2a8
commit b98dbe10d2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 16 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -8,7 +8,7 @@
Bare-metal (`no_std`) hardware abstraction layer for Espressif devices. Currently supports, to varying degrees, the following devices:
- ESP32 Series: _ESP32_
- ESP32-C Series: _ESP32-C2 (aka ESP8684), ESP32-C3 (aka ESP8685), ESP32-C6_
- ESP32-C Series: _ESP32-C2, ESP32-C3, ESP32-C6_
- ESP32-H Series: _ESP32-H2_
- ESP32-S Series: _ESP32-S2, ESP32-S3_
@ -49,29 +49,6 @@ For information about the HAL and how to use it in your own projects, please ref
This repository is home to a number of different packages; for more information regarding a particular package, please refer to its `README.md` and/or documentation.
## Ancillary Crates
There are a number of other crates within the [esp-rs organization] which can be used in conjunction with `esp-hal`:
| Crate | Description |
| :--------------: | :----------------------------------------------------------------------------: |
| [esp-backtrace] | Backtrace support for bare-metal applications |
| [esp-ieee802154] | Low-level IEEE802.15.4 driver for the ESP32-C6 and ESP32-H2 |
| [esp-openthread] | A bare-metal Thread implementation using `esp-ieee802154` |
| [esp-println] | Provides `print!` and `println!` implementations |
| [esp-storage] | Implementation of [embedded-storage] traits to access unencrypted flash memory |
| [esp-wifi] | `no_std` Wi-Fi/BLE/ESP-NOW support |
[esp-rs organization]: https://github.com/esp-rs
[esp-alloc]: https://github.com/esp-rs/esp-alloc
[esp-backtrace]: https://github.com/esp-rs/esp-backtrace
[esp-ieee802154]: https://github.com/esp-rs/esp-ieee802154
[esp-openthread]: https://github.com/esp-rs/esp-openthread
[esp-println]: https://github.com/esp-rs/esp-println
[esp-storage]: https://github.com/esp-rs/esp-storage
[embedded-storage]: https://github.com/rust-embedded-community/embedded-storage
[esp-wifi]: https://github.com/esp-rs/esp-wifi
## License
Licensed under either of:
@ -87,4 +64,4 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
any additional terms or conditions.
If you consider to contribute please make sure you checked the [contributing guide](./CONTRIBUTING.md) and the [API guidelines](https://github.com/esp-rs/esp-hal/blob/main/API-GUIDELINES.md)
If you consider contributing, please make sure you have read and understood our [contributing guide](./CONTRIBUTING.md) and [API guidelines](https://github.com/esp-rs/esp-hal/blob/main/API-GUIDELINES.md).

28
hil-test/Cargo.toml
View File

@ -20,6 +20,18 @@ harness = false
name = "crc"
harness = false
[[test]]
name = "delay"
harness = false
[[test]]
name = "ecc"
harness = false
[[test]]
name = "get_time"
harness = false
[[test]]
name = "gpio"
harness = false
@ -49,18 +61,6 @@ name = "uart_async"
harness = false
required-features = ["async", "embassy"]
[[test]]
name = "ecc"
harness = false
[[test]]
name = "get_time"
harness = false
[[test]]
name = "delay"
harness = false
[dependencies]
cfg-if = "1.0.0"
critical-section = "1.1.2"
@ -72,7 +72,7 @@ embedded-hal = "1.0.0"
embedded-hal-02 = { version = "0.2.7", package = "embedded-hal", features = ["unproven"] }
embedded-hal-async = { version = "1.0.0", optional = true }
embedded-hal-nb = { version = "1.0.0", optional = true }
esp-backtrace = { version = "0.11.1", git = "https://github.com/esp-rs/esp-backtrace", rev = "edff83c3945e8aa11081d8467af65803a82434ba", default-features = false, features = ["exception-handler", "panic-handler", "defmt", "semihosting"] }
esp-backtrace = { version = "0.11.1", path = "../esp-backtrace", default-features = false, features = ["exception-handler", "panic-handler", "defmt", "semihosting"] }
esp-hal = { path = "../esp-hal", features = ["defmt", "embedded-hal", "embedded-hal-02"], optional = true }
portable-atomic = "1.6.0"
@ -138,4 +138,4 @@ debug-assertions = false
incremental = false
opt-level = 3
lto = "fat"
overflow-checks = false
overflow-checks = false