max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Modern embedded framework, using Rust and async.
1,822 Commits 67 Branches 32 Tags 16 MiB
Rust 98.9%
Shell 0.9%
Python 0.2%
1a7b9e3279
Go to file
bors[bot] 1a7b9e3279
Merge #542 
542: nrf/gpiote: remove PortInput, move impls to Input/FlexPin. r=Dirbaio a=Dirbaio

`PortInput` is just a dumb wrapper around `Input`, it has no reason whatsoever to exist. This PR moves the `wait_for_x` functionality to `Input` directly.

It also adds it to `FlexPin` for completeness and consistency with `Input`.

(The reason `PortInput` exists is a while ago `GPIOTE` was an owned singleton that you had to initialize, so `PortInput::new()` would require it to enforce it's been initialized. This doesn't apply anymore now that GPIOTE is "global")

Co-authored-by: Dario Nieuwenhuis <dirbaio@dirbaio.net>
2021-12-14 14:09:59 +00:00
.github stm32: add gpio HIL test 2021-12-06 22:05:41 +01:00
.vscode Add all example crates to linked projects (commented out) 2021-12-09 19:44:41 -06:00
docs Fix doc example compile 2021-12-10 12:58:23 +01:00
embassy Stm flush required implementing also, along with std alloc split 2021-12-10 15:11:41 +11:00
embassy-hal-common Provides AsyncWrite with flush 2021-12-10 12:16:08 +11:00
embassy-lora Flush MISO before transfer operation 2021-12-03 09:53:28 +01:00
embassy-macros Fix interrupt_take macro by specifying path to panic macro. 2021-11-23 11:00:37 +01:00
embassy-net Use smoltcp 0.8.0 from crates.io. 2021-12-12 15:32:36 +01:00
embassy-nrf Merge #542 2021-12-14 14:09:59 +00:00
embassy-rp Update to defmt 3.0ish. 2021-11-15 11:09:08 -05:00
embassy-stm32 Stm flush required implementing also, along with std alloc split 2021-12-10 15:11:41 +11:00
embassy-traits Fix missing lifetime bounds 2021-11-21 10:10:28 +00:00
examples Merge #542 2021-12-14 14:09:59 +00:00
stm32-data@5506d27471 stm32/usart: unify v1 and v2 2021-12-08 05:12:48 +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
tests/stm32 stm32/tests: add uart, uart_dma tests. 2021-12-08 05:43:39 +01:00
xtask Update lots of deps 2021-09-11 01:35:23 +02:00
.gitignore Enable running ci.sh locally multiple-times. 2021-12-09 12:37:44 +01:00
.gitmodules Add stm32-metapac crate, with codegen in rust 2021-05-31 02:40:58 +02:00
ci.sh Merge #533 2021-12-13 00:07:39 +00: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 Some notes in the readme about docs 2021-12-13 13:23:18 +01: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, go to https://embassy.dev.

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

HALs

Hardware Absraction Layers with asynchronous behaviors are provided for a variety of platforms. For example, 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. For example:

  • 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
  • Change directory to the sample's base directory. For example:
cd examples/nrf
  • Run the example

For example:

cargo run --bin blinky

Developing Embassy with Rust Analyzer based editors

The Rust Analyzer is used by Visual Studio Code and others. Given the multiple targets that Embassy serves, there is no Cargo workspace file. Instead, the Rust Analyzer must be told of the target project to work with. In the case of Visual Studio Code, please refer to the .vscode/settings.json file's rust-analyzer.linkedProjectssetting.

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.

Documentation

Embassy documentation is located in the docs/ folder. The documentation is built in embassy-book and published to https://embassy.dev by CI.

Why the name?

EMBedded ASYnc! :)

License

This work is licensed under either of

at your option.