diff options
| author | Lofty Inclination <[email protected]> | 2025-01-01 01:30:43 +0000 |
|---|---|---|
| committer | Lofty Inclination <[email protected]> | 2025-01-01 01:35:41 +0000 |
| commit | 81948b3f2f0cf8f5b671b05e8d16f077ad4483bd (patch) | |
| tree | 79480435c09ad7e9ce464fbe71bced6e9a1ba68e /embassy-stm32-wpan/src/lib.rs | |
| parent | 2d5e1e9cfa1cc9168a43ca3409be765e94719a70 (diff) | |
Add crate description
Diffstat (limited to 'embassy-stm32-wpan/src/lib.rs')
| -rw-r--r-- | embassy-stm32-wpan/src/lib.rs | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/embassy-stm32-wpan/src/lib.rs b/embassy-stm32-wpan/src/lib.rs index 00eaac867..25e6d965a 100644 --- a/embassy-stm32-wpan/src/lib.rs +++ b/embassy-stm32-wpan/src/lib.rs | |||
| @@ -1,3 +1,16 @@ | |||
| 1 | //! The embassy-stm32-wpan crate aims to provide safe use of the commands necessary to interface | ||
| 2 | //! with the Cortex C0 CPU2 coprocessor of STM32WB microcontrollers. It implements safe wrappers | ||
| 3 | //! around the Transport Layer, and in particular the system, memory, BLE and Mac channels. | ||
| 4 | //! | ||
| 5 | //! # Design | ||
| 6 | //! | ||
| 7 | //! This crate loosely follows the Application Note 5289 "How to build wireless applications with | ||
| 8 | //! STM32WB MCUs"; several of the startup procedures laid out in Annex 14.1 are implemented using | ||
| 9 | //! inline copies of the code contained within the `stm32wb_copro` C library. | ||
| 10 | //! | ||
| 11 | //! BLE commands are implemented via use of the [stm32wb_hci] crate, for which the | ||
| 12 | //! [stm32wb_hci::Controller] trait has been implemented. | ||
| 13 | |||
| 1 | #![no_std] | 14 | #![no_std] |
| 2 | #![allow(async_fn_in_trait)] | 15 | #![allow(async_fn_in_trait)] |
| 3 | #![doc = include_str!("../README.md")] | 16 | #![doc = include_str!("../README.md")] |