aboutsummaryrefslogtreecommitdiff
path: root/embassy-rp
diff options
context:
space:
mode:
authorDario Nieuwenhuis <[email protected]>2024-01-11 21:23:07 +0100
committerDario Nieuwenhuis <[email protected]>2024-01-11 21:23:07 +0100
commite18d6737212fe9a2a606cef210c64bf45ecc925c (patch)
treeb883d932d82cc89a02ef5f7de6fc520521090676 /embassy-rp
parent0d62e9c96ca14d9d9596f72d090e41855050e83c (diff)
More readme fixes.
Diffstat (limited to 'embassy-rp')
-rw-r--r--embassy-rp/README.md24
1 files changed, 21 insertions, 3 deletions
diff --git a/embassy-rp/README.md b/embassy-rp/README.md
index 1d14eca52..8cf7da994 100644
--- a/embassy-rp/README.md
+++ b/embassy-rp/README.md
@@ -2,8 +2,26 @@
2 2
3HALs implement safe, idiomatic Rust APIs to use the hardware capabilities, so raw register manipulation is not needed. 3HALs implement safe, idiomatic Rust APIs to use the hardware capabilities, so raw register manipulation is not needed.
4 4
5The Embassy RP HAL targets the Raspberry Pi 2040 family of hardware. The HAL implements both blocking and async APIs 5The embassy-rp HAL targets the Raspberry Pi RP2040 microcontroller. The HAL implements both blocking and async APIs
6for many peripherals. The benefit of using the async APIs is that the HAL takes care of waiting for peripherals to 6for many peripherals. The benefit of using the async APIs is that the HAL takes care of waiting for peripherals to
7complete operations in low power mod and handling interrupts, so that applications can focus on more important matters. 7complete operations in low power mode and handling interrupts, so that applications can focus on more important matters.
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. 9* [embassy-rp on crates.io](https://crates.io/crates/embassy-rp)
10* [Documentation](https://docs.embassy.dev/embassy-rp/)
11* [Source](https://github.com/embassy-rs/embassy/tree/main/embassy-rp)
12* [Examples](https://github.com/embassy-rs/embassy/tree/main/examples/rp/src/bin)
13
14## `embassy-time` time driver
15
16If the `time-driver` feature is enabled, the HAL uses the TIMER peripheral as a global time driver for [embassy-time](https://crates.io/crates/embassy-time), with a tick rate of 1MHz.
17
18## Embedded-hal
19
20The `embassy-rp` 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).
21
22## Interoperability
23
24This crate can run on any executor.
25
26Optionally, some features requiring [`embassy-time`](https://crates.io/crates/embassy-time) can be activated with the `time` feature. If you enable it,
27you must link an `embassy-time` driver in your project.