NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Modern embedded framework, using Rust and async.
830 commits 3 branches 0 tags 20 MiB
Rust 98.8%
Shell 0.9%
Python 0.2%
Find a file
Ulf Lilleengen 0a9022d59f Enable timer clock in RCC on timer start 
* Moves the tim2-specific code into macro which always uses TIM2
* For peripherals without clock specified, attempt to locate enable and
  reset registers in the RCC block matching the peripheral name. This
  could be useful for peripherals where deducing the clock name might
  not be feasible, but it remains to be tested with more chip families
  to see if it is sufficiently accurate.
2021-06-10 09:37:30 +02:00
.github/workflows Run metapac full gen in Ci 2021-06-10 03:05:44 +02:00
.vscode fmt: Add dunmy use to avoid "unused variable" errors when no log is enabled. 2021-06-07 03:21:37 +02:00
embassy fmt: Add dunmy use to avoid "unused variable" errors when no log is enabled. 2021-06-07 03:21:37 +02:00
embassy-extras fmt: Add dunmy use to avoid "unused variable" errors when no log is enabled. 2021-06-07 03:21:37 +02:00
embassy-macros Enable timer clock in RCC on timer start 2021-06-10 09:37:30 +02:00
embassy-net fmt: Add dunmy use to avoid "unused variable" errors when no log is enabled. 2021-06-07 03:21:37 +02:00
embassy-nrf embassy-nrf: twim derive defmt 2021-06-07 19:09:03 -07:00
embassy-rp fmt: Add dunmy use to avoid "unused variable" errors when no log is enabled. 2021-06-07 03:21:37 +02:00
embassy-std Add std version of embassy::main 2021-04-12 14:14:03 +02:00
embassy-stm32 Enable timer clock in RCC on timer start 2021-06-10 09:37:30 +02:00
embassy-traits nrf async twim 2021-06-04 17:31:35 +02:00
examples Add examples for STM32L0 2021-06-09 23:09:48 +02:00
stm32-data@a33b0b94b0 Update reference to missing H7AB 2021-06-10 08:58:18 +02:00
stm32-metapac Enable timer clock in RCC on timer start 2021-06-10 09:37:30 +02: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 Add all examples to workspace template 2021-06-09 23:12:25 +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 Improve examples section of readme 2021-06-05 13:34:44 +10: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.

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.