max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Modern embedded framework, using Rust and async.
775 Commits 67 Branches 32 Tags 16 MiB
Rust 98.9%
Shell 0.9%
Python 0.2%
2bbde6c4e1
Go to file
Dario Nieuwenhuis 2bbde6c4e1
Merge pull request #225 from rukai/fix_stm32_warnings2 
Fix stm32 warnings
2021-06-06 00:42:28 +02:00
.github/workflows Move examples to a subdirectory 2021-06-02 01:32:19 +02:00
.vscode Move examples to a subdirectory 2021-06-02 01:32:19 +02:00
embassy Add Unborrow trait bound for Interrupt 2021-06-04 23:42:25 +02:00
embassy-extras Mark Unborrow as unsafe to implement 2021-05-19 23:29:33 +02:00
embassy-macros Assume tim2 in macro and remove clock setup in chip specific rcc init 2021-05-26 21:42:07 +02:00
embassy-net Update heapless 2021-06-04 01:35:04 +02:00
embassy-nrf fix errors 2021-06-05 12:02:17 +02:00
embassy-rp Merge pull request #195 from embassy-rs/unborrow-mk2 2021-05-20 04:14:38 +02:00
embassy-std Add std version of embassy::main 2021-04-12 14:14:03 +02:00
embassy-stm32 Fix stm32 warnings 2021-06-06 00:46:20 +10:00
embassy-traits nrf async twim 2021-06-04 17:31:35 +02:00
examples Fix stm32 warnings 2021-06-06 00:46:20 +10:00
stm32-data@33dfa67486 Create the new peripheral_pins! macro table. 2021-06-03 13:12:38 -04:00
stm32-metapac Remove the exti_interrupts table. 2021-06-03 14:18:58 -04:00
.gitignore Merge remote-tracking branch 'embassy-net/main' 2021-05-28 23:07:27 +02:00
.gitmodules Add stm32-metapac crate, with codegen in rust 2021-05-31 02:40:58 +02:00
Cargo.example.toml Move examples to a subdirectory 2021-06-02 01:32:19 +02:00
ci.sh Add medium-ip, medium-ethernet Cargo features 2021-04-12 21:00:23 +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 readme: add wiki link 2021-03-22 17:21:08 -05:00
rust-toolchain.toml Revert "Update rust nightly" 2021-06-03 00:49:03 +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.

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.