Getting started

So you want to try Embassy, great! To get started, there are a few tools you need to install:

  • rustup - the Rust toolchain is needed to compile Rust code.

  • probe-run - to flash the firmware on your device. If you already have other tools like OpenOCD setup, you can use that as well.

If you don’t have any supported board, don’t worry: you can also run embassy on your PC using the std examples.

Getting a board with examples

Embassy supports many microcontroller families, but the easiest ways to get started is if you have one of the more common development kits.

nRF kits

STM32 kits

RP2040 kits

Running an example

First you need to clone the [github repository];

git clone https://github.com/embassy-rs/embassy.git
cd embassy
git submodule update --init

You can run an example by opening a terminal and entering the following commands:

cd examples/nrf
DEFMT_LOG=info cargo run --bin blinky --release
The DEFMT_LOG environment variable controls the example log verbosity. If you do not specify it, you will not see anything logged to the console.

Whats next?

Congratulations, you have your first Embassy application running! Here are some alternatives on where to go from here: