NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Modern embedded framework, using Rust and async.
479 commits 3 branches 0 tags 20 MiB
Rust 98.8%
Shell 0.9%
Python 0.2%
Find a file
Ulf Lilleengen 9586365b07 Pass config directly to chip specific configure function 
This removes the need to duplicate the configuration for each individual
chip, but will instead pass on the configuration specified in the config
attribute.

Update nrf, stm32, rp macros with passing the config to a per-chip
configure function which assumes the appropriate configuration to be
passed to it.

To demonstrate this feature, the stm32l0xx clock setup and RTC is added which exposes
clock configuration different from stm32f4xx (and has a different set of timers and HAL APIs).
2021-04-22 09:10:46 +02:00
.github/workflows stm32: consolidate crates 2021-03-30 10:05:52 -05:00
.vscode Fix vscode settings 2021-04-14 16:01:14 +02:00
embassy Rename PeripheralBorrow to Unborrow 2021-04-14 19:59:52 +02:00
embassy-extras Rename PeripheralBorrow to Unborrow 2021-04-14 19:59:52 +02:00
embassy-macros Pass config directly to chip specific configure function 2021-04-22 09:10:46 +02:00
embassy-nrf Add detection of edge transitions for ports 2021-04-16 07:58:24 +02:00
embassy-nrf-examples Remove Pin from Flash trait 2021-04-14 17:04:40 +02:00
embassy-rp Rename PeripheralBorrow to Unborrow 2021-04-14 19:59:52 +02:00
embassy-rp-examples cleanup rp examples 2021-04-05 22:36:35 +02:00
embassy-std Add std version of embassy::main 2021-04-12 14:14:03 +02:00
embassy-std-examples Reexport macros at root, use eveywhere as #[embassy::task] 2021-03-29 03:00:48 +02:00
embassy-stm32 Pass config directly to chip specific configure function 2021-04-22 09:10:46 +02:00
embassy-stm32-examples Pass config directly to chip specific configure function 2021-04-22 09:10:46 +02:00
embassy-traits Remove Pin from Flash trait 2021-04-14 17:04:40 +02:00
.gitignore Remove workspace Cargo.toml, add template 2021-03-29 21:46:51 +02:00
Cargo.example.toml cargo: add examples back 2021-04-01 15:34:19 -05: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 readme: add wiki link 2021-03-22 17:21:08 -05: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.

Running the examples

Examples are for the nRF52840 chip but should be easily adaptable to other nRF52 chips.

GPIO pins are set up for the nrf52840-dk board (PCA10056)

  • Install probe-run with defmt support.
cargo install probe-run
  • Run the example
cargo run --bin rtc_async

Minimum supported Rust version (MSRV)

Only recent nighly supported. 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.