From f9e274e0574c58b0132612eb5aae81ea51a4b931 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen <ulf.lilleengen@gmail.com> Date: Thu, 11 Jan 2024 19:21:33 +0100 Subject: [PATCH] docs: more docs on nrf --- embassy-nrf/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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 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 On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting