max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Modern embedded framework, using Rust and async.
1,341 Commits 67 Branches 32 Tags 16 MiB
Rust 98.9%
Shell 0.9%
Python 0.2%
7ad6280e65
Go to file
Ulf Lilleengen 7ad6280e65 Add HAL for SubGhz peripheral for STM32 WL series 
Based on the HAL from stm32wl, the peripheral driver has been
modified to fit into embassy, using the embassy APIs, providing
operation of the radio peripheral.

The initial version does not offer any async APIs, but the example
shows how the radio IRQ can be used to perform async TX of the radio.
2021-09-02 10:39:56 +02:00
.github/workflows stm32: add G0 to Ci 2021-08-20 01:29:37 +02:00
.vscode Update vscode settings. 2021-07-16 14:41:20 -04:00
embassy Improve executor naming. Add docs. 2021-08-31 23:59:28 +02:00
embassy-hal-common Add HAL for SubGhz peripheral for STM32 WL series 2021-09-02 10:39:56 +02:00
embassy-macros Improve executor naming. Add docs. 2021-08-31 23:59:28 +02:00
embassy-net net: fix build with medium-ip 2021-08-20 15:06:06 +02:00
embassy-nrf nrf/saadc: don't use wake_on_interrupt. 2021-09-01 23:54:26 +02:00
embassy-rp time: allow storing state inside the driver struct. 2021-08-25 21:06:27 +02:00
embassy-std time: replace dyn clock/alarm with a global Driver trait 2021-08-05 19:14:09 +02:00
embassy-stm32 Add HAL for SubGhz peripheral for STM32 WL series 2021-09-02 10:39:56 +02:00
embassy-traits Rename Random impl to Rng. 2021-09-01 09:39:33 -04:00
examples Add HAL for SubGhz peripheral for STM32 WL series 2021-09-02 10:39:56 +02:00
stm32-data@3fb217ad3e Add HAL for SubGhz peripheral for STM32 WL series 2021-09-02 10:39:56 +02:00
stm32-metapac Update cortex-m-rt to v0.7 for stm32, rp. 2021-08-19 00:56:11 +02:00
stm32-metapac-gen Add support for STM32G0 2021-08-20 00:15:11 +02:00
xtask xtask runner for CI types of things and other utilities. 2021-08-17 15:23:08 -04:00
.gitignore stm32-metapac: ignore gen'd out dir 2021-08-19 17:44:29 +02:00
.gitmodules Add stm32-metapac crate, with codegen in rust 2021-05-31 02:40:58 +02:00
Cargo.example.toml std: fold into embassy core, add non-hacky time driver. 2021-08-25 21:06:27 +02:00
LICENSE-APACHE First commit 2020-09-22 18:03:43 +02:00
LICENSE-MIT First commit 2020-09-22 18:03:43 +02:00
README.md Trivial to trigger checks from CI. 2021-07-28 09:09:19 -04:00
rust-toolchain.toml Update nightly 2021-08-18 21:51:22 +02:00

README.md

Embassy

Embassy is a project to make async/await a first-class option for embedded development. For more information and instructions to get started, click here.

Traits and types

embassy provides a set of traits and types specifically designed for async usage.

  • embassy::io: AsyncBufRead, AsyncWrite. Traits for byte-stream IO, essentially no_std compatible versions of futures::io.
  • embassy::traits::flash: Flash device trait.
  • embassy::time: Clock and Alarm traits. Std-like Duration and Instant.
  • More traits for SPI, I2C, UART async HAL coming soon.

Executor

The embassy::executor module provides an async/await executor designed for embedded usage.

  • No alloc, no heap needed. Task futures are statically allocated.
  • No "fixed capacity" data structures, executor works with 1 or 1000 tasks without needing config/tuning.
  • Integrated timer queue: sleeping is easy, just do Timer::after(Duration::from_secs(1)).await;.
  • No busy-loop polling: CPU sleeps when there's no work to do, using interrupts or WFE/SEV.
  • Efficient polling: a wake will only poll the woken task, not all of them.
  • Fair: a task can't monopolize CPU time even if it's constantly being woken. All other tasks get a chance to run before a given task gets polled for the second time.
  • Creating multiple executor instances is supported, to run tasks with multiple priority levels. This allows higher-priority tasks to preempt lower-priority tasks.

Utils

embassy::util contains some lightweight async/await utilities, mainly helpful for async driver development (signaling a task that an interrupt has occured, for example).

embassy-nrf

The embassy-nrf crate contains implementations for nRF 52 series SoCs.

  • uarte: UARTE driver implementing AsyncBufRead and AsyncWrite.
  • qspi: QSPI driver implementing Flash.
  • gpiote: GPIOTE driver. Allows awaiting GPIO pin changes. Great for reading buttons or receiving interrupts from external chips.
  • rtc: RTC driver implementing Clock and Alarm, for use with embassy::executor.

Examples

Examples are found in the examples/ folder seperated by the chip manufacturer they are designed to run on:

  • examples/nrf are designed to run on the nrf52840-dk board (PCA10056) but should be easily adaptable to other nRF52 chips and boards.
  • examples/rp are for the RP2040 chip.
  • examples/stm32 are designed for the STM32F429ZI chip but should be easily adaptable to other STM32F4xx chips.
  • examples/std are designed to run locally on your pc.

Running examples

  • Setup git submodules (needed for STM32 examples)
git submodule init
git submodule update
  • Install probe-run with defmt support.
cargo install probe-run
  • Run the example
cargo run --bin rtc_async

Minimum supported Rust version (MSRV)

Required nightly version is specified in the rust-toolchain.toml file. Nightly is required for:

  • generic_associated_types: for trait funcs returning futures.
  • type_alias_impl_trait: for trait funcs returning futures implemented with async{} blocks, and for static-executor.

Stable support is a non-goal until these features get stabilized.

Why the name?

EMBedded ASYnc! :)

License

This work is licensed under either of

at your option.