max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Modern embedded framework, using Rust and async.
2,142 Commits 67 Branches 32 Tags 16 MiB
Rust 98.9%
Shell 0.9%
Python 0.2%
3047098c55
Go to file
bors[bot] 3047098c55
Merge #648 #656 
648: Fix nRF Saadc continuous sampling r=Dirbaio a=huntc

Starting the sampling task prior to starting the SAADC peripheral can lead to unexpected buffer behaviour with multiple channels. We now provide an init callback at the point where the SAADC has started for the first time. This callback can be used to kick off sampling via PPI.

We also need to trigger the SAADC to start sampling the next buffer when the previous one is ended so that we do not drop samples - the major benefit of double buffering.

Given these additional tasks, we now simplify the API by passing in the TIMER and two PPI channels.

As a bonus, we provide an async `calibrate` method as it is recommended to use before starting up the sampling.

The example has been updated to illustrate these new features along with the simplified API.

The changes here have been tested on my nRF52840-DK.

656: stm32: Refactor DMA interrupts r=Dirbaio a=GrantM11235

Previously, every dma interrupt handler called the same `on_irq`
function which had to check the state of every dma channel.

Now, each dma interrupt handler only calls an `on_irq` method for its
corresponding channel or channels.

Co-authored-by: huntc <huntchr@gmail.com>
Co-authored-by: Grant Miller <GrantM11235@gmail.com>
2022-03-09 00:43:17 +00:00
.github ci: add build with stable. 2022-02-12 01:16:31 +01:00
.vscode embassy, embassy-nrf: add nightly Cargo feature to gate nightly-only features. 2022-02-12 01:16:31 +01:00
docs Update after review 2022-02-23 13:24:09 +01:00
embassy docs: add metadata.embassy_docs to cargo tomls. 2022-03-04 18:03:41 +01:00
embassy-boot Address review comments 2022-02-09 12:46:46 +01:00
embassy-hal-common common/serial/usb: fix hang when write buffer gets full and then the bus resets. 2022-03-07 00:32:31 +01:00
embassy-lora Support unstable-trait feature for stm32 2022-01-26 22:39:06 +01:00
embassy-macros macros: cleanup, make work in stable. 2022-02-12 01:16:31 +01:00
embassy-net Use smoltcp 0.8.0 from crates.io. 2021-12-12 15:32:36 +01:00
embassy-nrf Simplifies the API by taking in the TIMER and PPI channels 2022-03-07 14:51:17 +11:00
embassy-rp rp: impl eh1.0 blocking traits 2022-02-15 17:29:05 +01:00
embassy-stm32 Ignore BDMA1 in H7 2022-03-08 16:46:42 -06:00
embassy-traits Add embassy-boot 2022-02-09 10:50:29 +01:00
examples Merge #648 #656 2022-03-09 00:43:17 +00:00
stm32-data@d3e8a2fe63 Update stm32-data 2022-03-08 16:31:14 -06:00
stm32-gen-features [manual] Add stm32f3 family to stm32-gen-features 2021-12-13 13:49:41 +05:30
stm32-metapac docs: add metadata.embassy_docs to cargo tomls. 2022-03-04 18:03:41 +01:00
stm32-metapac-gen stm32-metapac: remove all macrotables, deduplicate metadata files. 2022-02-26 03:23:09 +01:00
tests/stm32 Update tests 2022-03-08 17:35:37 -06:00
xtask Update lots of deps 2021-09-11 01:35:23 +02:00
.gitignore ci: add build with stable. 2022-02-12 01:16:31 +01:00
.gitmodules Add stm32-metapac crate, with codegen in rust 2021-05-31 02:40:58 +02:00
ci_stable.sh stm32: add rust stable support 2022-02-12 02:45:52 +01:00
ci.sh ci: add troublesome stm32 chips 2022-02-24 06:28:29 +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 traits: migrate Delay to embedded-hal 1.0+async, remove Rng and Flash. 2022-01-27 00:08:02 +01:00
rust-toolchain.toml Update nightly. 2022-02-21 05:27:02 +01: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.

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.