no_std Hardware Abstraction Layers for ESP32 microcontrollers
Go to file
Easyoakland 30276e1609
implement wifi event handling with data (#2453)
* implement event handling for apsta{,dis}connect and probe

add to wifi_access_point example

* hide internal `Option` to simplify api

* move handler call logic to event.rs

* update_handler_leak

* - Add comments

- match simpler api from `std::panic::update_hook`

- do not assume size_of in prelude

- make all events handleable

- box static instead of leak

* update changelog

* elide lifetime on default handler

* newtypes for all event types.

* add doc to newtypes

* fix previous doc example

* - `get_handler` -> `handler`
- pass critical section to event handlers
- comment on perf of Box<ZST>
- don't pass `prev` in `update_handler`, instead call previous handler first unconditionally

* pass cs to dispatch_event_handler

* don't print "unhandled event" for handled events.
2024-11-13 08:49:41 +00:00
.cargo into_async (#2430) 2024-11-04 09:32:12 +00:00
.github Add CHANGELOG.md for remaining packages which do not have one (#2518) 2024-11-12 10:17:11 +00:00
documentation Tweak guidelines (#2482) 2024-11-08 11:50:52 +00:00
esp-alloc New package releases (#2310) 2024-10-10 10:19:04 +00:00
esp-backtrace New package releases (#2310) 2024-10-10 10:19:04 +00:00
esp-build Add CHANGELOG.md for remaining packages which do not have one (#2518) 2024-11-12 10:17:11 +00:00
esp-config Add CHANGELOG.md for remaining packages which do not have one (#2518) 2024-11-12 10:17:11 +00:00
esp-hal Remove redundant Enable trait (#2523) 2024-11-13 08:26:18 +00:00
esp-hal-embassy Add validation to esp-config (#2475) 2024-11-12 10:14:14 +00:00
esp-hal-procmacros Add CHANGELOG.md for remaining packages which do not have one (#2518) 2024-11-12 10:17:11 +00:00
esp-ieee802154 Add validation to esp-config (#2475) 2024-11-12 10:14:14 +00:00
esp-lp-hal New package releases (#2310) 2024-10-10 10:19:04 +00:00
esp-metadata Add CHANGELOG.md for remaining packages which do not have one (#2518) 2024-11-12 10:17:11 +00:00
esp-println Make our nightly CI checks pass (#2356) 2024-11-01 10:31:56 +00:00
esp-riscv-rt RISC-V: Fix interrupt stack alignment (#2425) 2024-10-29 11:45:30 +00:00
esp-storage Add MultiwriteNorFlash trait to FlashStorage (#2478) 2024-11-07 13:58:32 +00:00
esp-wifi implement wifi event handling with data (#2453) 2024-11-13 08:49:41 +00:00
examples implement wifi event handling with data (#2453) 2024-11-13 08:49:41 +00:00
extras esp-wifi: Remove unneeded features (#2446) 2024-11-08 13:30:33 +00:00
hil-test Remove pins from Io (#2508) 2024-11-12 10:36:25 +00:00
resources Some xtask/metadata cleanups (#1965) 2024-08-19 06:49:05 +00:00
xtask Remove the integrated blocking networking stack (#2488) 2024-11-12 11:43:01 +00:00
xtensa-lx Add CHANGELOG.md for remaining packages which do not have one (#2518) 2024-11-12 10:17:11 +00:00
xtensa-lx-rt Fix restoring of CPENABLE (#2315) 2024-10-09 10:33:31 +00:00
.gitattributes Set merge=union git attribute for CHANGELOG.md 2023-07-12 09:24:09 -07:00
.gitignore Tweak the documentation URL slightly (#1250) 2024-03-07 17:19:07 +00:00
Cargo.toml esp-config (#2156) 2024-09-19 08:58:29 +00:00
LICENSE-APACHE Initial commit 2021-10-19 15:00:41 -07:00
LICENSE-MIT Initial commit 2021-10-19 15:00:41 -07:00
README.md make contribution docs more visible (#1947) 2024-08-15 07:58:06 +00:00
rustfmt.toml Begin adding some doc comments, update rustfmt config 2022-01-10 15:23:01 -08:00

esp-hal

GitHub Actions Workflow Status GitHub Actions Workflow Status MIT/Apache-2.0 licensed Matrix

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, ESP32-C3, ESP32-C6
  • ESP32-H Series: ESP32-H2
  • ESP32-S Series: ESP32-S2, ESP32-S3

Additionally provides limited support for programming the low-power RISC-V cores found on the ESP32-C6, ESP32-S2, and ESP32-S3 via the esp-lp-hal package.

These packages are all no_std; if you are looking for std support, please use esp-idf-svc instead.

If you have any questions, comments, or concerns, please open an issue, start a new discussion, or join us on Matrix. For additional information regarding any of the crates in this repository, please refer to the relevant crate's README.

Note

This project is still in the relatively early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented but have varying levels of functionality. For most tasks, this should be usable already, however some more advanced or uncommon features may not yet be implemented.

Getting Started

For information relating to the development of Rust applications on ESP devices, please first read The Rust on ESP Book.

For information about the HAL and how to use it in your own projects, please refer to the documentation.

Resources

Crates

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.

Contributing

We have a number of living documents to aid contributing to the project, please give these a read before modifying code:

License

Licensed under either of:

at your option.

Contribution notice

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.