diff options
| author | Ulf Lilleengen <[email protected]> | 2024-01-11 19:21:33 +0100 |
|---|---|---|
| committer | Ulf Lilleengen <[email protected]> | 2024-01-11 19:21:33 +0100 |
| commit | f9e274e0574c58b0132612eb5aae81ea51a4b931 (patch) | |
| tree | 2485abf6cd9a38bf8b62de4998159a2a957725f3 | |
| parent | 3119aeec5cc05f78a6551ae845f2dbc659bb631a (diff) | |
docs: more docs on nrf
| -rw-r--r-- | embassy-nrf/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md index 39de3854b..18cb21f46 100644 --- a/embassy-nrf/README.md +++ b/embassy-nrf/README.md | |||
| @@ -8,6 +8,20 @@ complete operations in low power mod and handling interrupts, so that applicatio | |||
| 8 | 8 | ||
| 9 | 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. | 9 | 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. |
| 10 | 10 | ||
| 11 | ## Hardware support | ||
| 12 | |||
| 13 | The `embassy-nrf` HAL supports most variants of the nRF family: | ||
| 14 | |||
| 15 | * nRF52 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf52840)) | ||
| 16 | * nRF53 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf5340)) | ||
| 17 | * nRF91 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf9160)) | ||
| 18 | |||
| 19 | 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). | ||
| 20 | |||
| 21 | ## API | ||
| 22 | |||
| 23 | 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). | ||
| 24 | |||
| 11 | ## EasyDMA considerations | 25 | ## EasyDMA considerations |
| 12 | 26 | ||
| 13 | On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting | 27 | On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting |