aboutsummaryrefslogtreecommitdiff
path: root/embassy-nrf
diff options
context:
space:
mode:
authorDario Nieuwenhuis <[email protected]>2024-01-11 19:52:18 +0000
committerGitHub <[email protected]>2024-01-11 19:52:18 +0000
commitb0b1ef9181a9e0bfd85717fd61fee97c875c26bc (patch)
treea83a81a1f4bd7c06fb3ccde309655e2b108121f3 /embassy-nrf
parent1d7751c2b89f37047f316a5032c9a988248d02a7 (diff)
parent10b857250c6de54ccab568d1f139e856773ef113 (diff)
Merge pull request #2436 from embassy-rs/embassy-nrf-docs-nrf91-example
Embassy nrf docs and nrf91 example
Diffstat (limited to 'embassy-nrf')
-rw-r--r--embassy-nrf/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md
index 5e2bd86de..1ead96b2c 100644
--- a/embassy-nrf/README.md
+++ b/embassy-nrf/README.md
@@ -8,6 +8,26 @@ complete operations in low power mod and handling interrupts, so that applicatio
8 8
9NOTE: The Embassy HALs can be used both for non-async and async operations. For async, you can choose which runtime you want to use. 9NOTE: 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
11For a complete list of available peripherals and features, see the [embassy-nrf documentation](https://docs.embassy.dev/embassy-nrf).
12
13## Hardware support
14
15The `embassy-nrf` HAL supports most variants of the nRF family:
16
17* nRF52 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf52840))
18* nRF53 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf5340))
19* nRF91 ([examples](https://github.com/embassy-rs/embassy/tree/main/examples/nrf9160))
20
21Most peripherals are supported.
22
23## Time driver
24
25If the `time` feature is enabled, the HAL uses the RTC peripheral as a global time driver for [embassy-time](https://crates.io/crates/embassy-time), with a tick rate of 32768 Hz.
26
27## Embedded-hal
28
29The `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).
30
11## EasyDMA considerations 31## EasyDMA considerations
12 32
13On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting 33On nRF chips, peripherals can use the so called EasyDMA feature to offload the task of interacting