diff options
| author | Dario Nieuwenhuis <[email protected]> | 2024-01-11 21:23:07 +0100 |
|---|---|---|
| committer | Dario Nieuwenhuis <[email protected]> | 2024-01-11 21:23:07 +0100 |
| commit | e18d6737212fe9a2a606cef210c64bf45ecc925c (patch) | |
| tree | b883d932d82cc89a02ef5f7de6fc520521090676 /embassy-stm32/README.md | |
| parent | 0d62e9c96ca14d9d9596f72d090e41855050e83c (diff) | |
More readme fixes.
Diffstat (limited to 'embassy-stm32/README.md')
| -rw-r--r-- | embassy-stm32/README.md | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/embassy-stm32/README.md b/embassy-stm32/README.md index 23c1bf967..e9ae455a4 100644 --- a/embassy-stm32/README.md +++ b/embassy-stm32/README.md | |||
| @@ -19,7 +19,20 @@ In practice, this works as follows: | |||
| 19 | 19 | ||
| 20 | Be aware that, while embassy-stm32 strives to consistently support all peripherals across all chips, this approach can lead to slightly different APIs and capabilities being available on different families. Check the [documentation](https://docs.embassy.dev/embassy-stm32/) for the specific chip you’re using to confirm exactly what’s available. | 20 | Be aware that, while embassy-stm32 strives to consistently support all peripherals across all chips, this approach can lead to slightly different APIs and capabilities being available on different families. Check the [documentation](https://docs.embassy.dev/embassy-stm32/) for the specific chip you’re using to confirm exactly what’s available. |
| 21 | 21 | ||
| 22 | ## embassy-time Time Driver | 22 | ## Embedded-hal |
| 23 | If the `time` feature is enabled, embassy-stm32 provides a time driver for use with [embassy-time](https://docs.embassy.dev/embassy-time/). You can pick which hardware timer is used for this internally via the `time-driver-*` features, or let embassy pick with `time-driver-any`. | ||
| 24 | 23 | ||
| 25 | embassy-time has a default tick rate of 1MHz, which is fast enough to cause problems with the 16-bit timers currently supported by the embassy-stm32 time driver (specifically, if a critical section delays an IRQ by more than 32ms). To avoid this, it’s recommended to pick a lower tick rate. 32.768kHz is a reasonable default for many purposes. \ No newline at end of file | 24 | The `embassy-stm32` 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). |
| 25 | |||
| 26 | ## `embassy-time` time driver | ||
| 27 | If a `time-driver-*` feature is enabled, embassy-stm32 provides a time driver for use with [embassy-time](https://docs.embassy.dev/embassy-time/). You can pick which hardware timer is used for this internally via the `time-driver-tim*` features, or let embassy pick with `time-driver-any`. | ||
| 28 | |||
| 29 | embassy-time has a default tick rate of 1MHz, which is fast enough to cause problems with the 16-bit timers currently supported by the embassy-stm32 time driver (specifically, if a critical section delays an IRQ by more than 32ms). To avoid this, it’s recommended to pick a lower tick rate. 32.768kHz is a reasonable default for many purposes. | ||
| 30 | |||
| 31 | ## Interoperability | ||
| 32 | |||
| 33 | This crate can run on any executor. | ||
| 34 | |||
| 35 | Optionally, some features requiring [`embassy-time`](https://crates.io/crates/embassy-time) can be activated with the `time` feature. If you enable it, | ||
| 36 | you must link an `embassy-time` driver in your project. | ||
| 37 | |||
| 38 | The `low-power` feature integrates specifically with `embassy-executor`, it can't be ued on other executors for now. | ||