max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Modern embedded framework, using Rust and async.
1,717 Commits 67 Branches 32 Tags 16 MiB
Rust 98.9%
Shell 0.9%
Python 0.2%
9500c8c17b
Go to file
bors[bot] 9500c8c17b
Merge #509 
509: Remove unsafe from nRF uarte and improve doco with rationale r=Dirbaio a=huntc

The constructors themselves are not strictly unsafe. Interactions with DMA can be generally unsafe if a future is dropped, but that's a separate issue. It is important that we use the `unsafe` keyword diligently as it can lead to confusion otherwise.

I've also provided some rationale re. the usage of [Uarte] vs [BufferedUarte].

Co-authored-by: huntc <huntchr@gmail.com>
2021-11-30 22:39:18 +00:00
.github ci: do main build with fully generated stm32-metapac. 2021-11-24 01:43:53 +01:00
.vscode stm32/pwm: allow using the advanced timer instances too. 2021-11-27 03:06:53 +01:00
embassy Some documentation corrections and expansion 2021-11-22 12:26:11 +11:00
embassy-hal-common Update to defmt 3.0ish. 2021-11-15 11:09:08 -05:00
embassy-lora Update to defmt 3.0ish. 2021-11-15 11:09:08 -05:00
embassy-macros Fix interrupt_take macro by specifying path to panic macro. 2021-11-23 11:00:37 +01:00
embassy-net Update smoltcp, fix build issues with no ethernet. 2021-11-26 21:09:44 +01:00
embassy-nrf Rationale for uarte usage 2021-12-01 09:37:09 +11:00
embassy-rp Update to defmt 3.0ish. 2021-11-15 11:09:08 -05:00
embassy-stm32 Update stm32-data: rcc regs info comes from yamls now. 2021-11-29 02:28:02 +01:00
embassy-traits Fix missing lifetime bounds 2021-11-21 10:10:28 +00:00
examples Removed unsafe from uarte 2021-12-01 09:14:24 +11:00
stm32-data@ec3fb03dc0 Update stm32-data: rcc regs info comes from yamls now. 2021-11-29 02:28:02 +01:00
stm32-gen-features stm32: add stm32g4 support. 2021-11-27 02:34:23 +01:00
stm32-metapac stm32-metapac: add pac feature to allow building only the macrotables. 2021-11-24 01:04:23 +01:00
stm32-metapac-gen Update stm32-data: rcc regs info comes from yamls now. 2021-11-29 02:28:02 +01:00
xtask Update lots of deps 2021-09-11 01:35:23 +02:00
.gitignore Update lots of deps 2021-09-11 01:35:23 +02:00
.gitmodules Add stm32-metapac crate, with codegen in rust 2021-05-31 02:40:58 +02:00
Cargo.example.toml Add missing examples to Cargo.example.toml 2021-10-26 17:33:28 +02:00
ci.sh Make ci script run on Mac OS X 2021-11-28 14:07:21 +01: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 Extend SAADC one shot support 2021-10-09 11:25:18 +11:00
rust-toolchain.toml Update nightly 2021-10-18 01:26:06 +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.

  • saadc: SAADC driver. Provides a full implementation of the one-shot sampling for analog channels.

  • 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.