LailaTheElf/embassy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: more docs on nrf

Browse Source
This commit is contained in:
Ulf Lilleengen 2024-01-11 19:21:33 +01:00
parent 3119aeec5c
commit f9e274e057
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
embassy-nrf/README.md
View File

@ -8,6 +8,20 @@ complete operations in low power mod and handling interrupts, so that applicatio
NOTE: The Embassy HALs can be used both for non-async and async operations. For async, you can choose which runtime you want to use. NOTE: The Embassy HALs can be used both for non-async and async operations. For async, you can choose which runtime you want to use.
## Hardware support
The `embassy-nrf` HAL supports most variants of the nRF family:
* nRF52 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf52840))
* nRF53 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf5340))
* nRF91 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf9160))
Most peripherals are supported. For a complete list of available peripherals and features, see the [documentation](https://docs.embassy.dev/embassy-nrf/git/nrf52805/index.html).
## API
The `embassy-nrf` HAL implements the traits from [embedded-hal](https://crates.io/crates/embedded-hal) (v0.2 and 1.0) and [embedded-hal-async](https://crates.io/crates/embedded-hal-async), as well as [embedded-io](https://crates.io/crates/embedded-io) and [embedded-io-async](https://crates.io/crates/embedded-io-async).
## EasyDMA considerations ## EasyDMA considerations
On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting