mirror of https://github.com/rust-embedded/awesome-embedded-rust.git synced 2024-11-18 07:29:49 +00:00

Curated list of resources for Embedded and Low-level development in the Rust programming language

awesome awesome-list embedded embedded-systems libraries rust

Find a file

bors[bot] f293be1b92 Merge #220 220: Reflect the OS tutorials rewrite r=adamgreig a=andre-richter Its no longer a collection of bare-metal tutorials, but a series about writing an OS. Co-authored-by: Andre Richter <andre-richter@users.noreply.github.com>		2019-11-25 00:32:16 +00:00
.github	set up CI	2019-03-06 19:00:01 +01:00
.travis.yml	set up CI	2019-03-06 19:00:01 +01:00
Code-of-Conduct.md	Mention EWG as point of contact	2018-04-21 10:38:20 +03:00
CODE_OF_CONDUCT.md	README: mention the CoC and who maintains this repo	2018-08-07 00:36:02 -05:00
CONTRIBUTING.md	Clean up contribution guidelines	2018-04-21 10:38:20 +03:00
LICENSE-CC0	initial commit	2018-04-01 23:17:28 +02:00
README.md	Reflect the OS tutorials rewrite	2019-11-24 23:27:35 +01:00
rust-embedded-logo-256x256.png	Add logo	2018-04-06 18:03:26 +02:00

README.md

Embedded Rust

This is a curated list of resources related to embedded and low-level programming in the programming language Rust, including a list of useful crates.

This project is developed and maintained by the Resources team.

Don't see something you want or need here? Add it to the Not Yet Awesome Embedded Rust list!

Community
Books, blogs and training materials
Tools
Peripheral Access Crates
- Microchip
- Nordic
- NXP
- SiFive
- Silicon Labs
- STMicroelectronics
- Texas Instruments
- MSP430
- Ambiq Micro
HAL implementation crates
- OS
- Nordic
- NXP
- SiFive
- STMicroelectronics
- Texas Instruments
- Espressif
- Silicon Labs
- XMC
Architecture support crates
- ARM
- RISC-V
- MIPS
Board support crates
Component abstraction crates
Driver crates
- WIP
no-std crates
- WIP
Rust forks
- AVR
Firmware projects
License

Community

In 2018 Rust community has created an embedded workgroup to help drive adoption in the Rust ecosystem.

Embedded WG, including newsletters with progress updates.
You can usually find community members (including embedded WG members) in the #rust-embedded:matrix.org Matrix room.
embedded.rs Telegram chat about Rust for microcontrollers in Russian language.

Books, blogs and training materials

The Embedded Rust Book - An introductory book about using the Rust Programming Language on "Bare Metal" embedded systems, such as Microcontrollers.
Discovery by @rust-embedded — this book is an introductory course on microcontroller-based embedded systems that uses Rust as the teaching language. Original author: @japaric
Cortex-M Quickstart by @japaric – a template and introduction to embedded Rust, suitable for developers familiar to embedded development but new to embedded Rust.
Exploring Rust on Teensy by @branan — Beginner set of articles on getting into embedded dev in Rust.
Pragmatic Bare Metal Rust A starter article about starting Rust development on STM32 microcontrollers (cubeMX + FFI).
Using Rust in an Embedded Project: A Simple Example Article and some links on setting up Rust cross-compiling.
Robigalia general purpose robust operating system in Rust running on secure seL4 microkernel.
Tock An embedded operating system designed for running multiple concurrent, mutually distrustful applications on low-memory and low-power microcontrollers
intermezzOS A small teaching operating system in Rust. A book with some explanations is also included.
Raspberry Pi Bare Metal Programming with Rust
- 32-bit Version (most Pi1 and Pi2 variants) A starter article on OSdev with Rust on RPi (cross-compiler setup and a very basic LED-blinking kernel).
Fearless concurrency by @japaric — How to easily develop Rust programs for pretty much any ARM Cortex-M microcontroller with memory-safe concurrency.
RTFM v0.5 Real-Time For the Masses — A concurrency framework for building real time systems:
- cortex-m rtfm RTFM framework for ARM Cortex-M microcontrollers
- msp430 rtfm RTFM framework for MSP430 MCUs
FreeRTOS.rs Rust interface for the FreeRTOS API
MicroRust Introductory book for embedded development in Rust on the micro:bit.
Physical Computing With Rust A (WIP) guide to physical computing with Rust on the Raspberry Pi.
Internet of Streams A video series by @jamesmunns building a bare metal IoT Sensor Node Platform from (nearly) scratch in Rust
Writing an embedded OS in Rust on the Raspberry Pi A set of tutorials that give a guided, step-by-step tour of how to write a monolithic Operating System kernel for an embedded system from scratch. Runs on the Raspberry Pi 3 and the Raspberry Pi 4.

Tools

xargo Rust package manager with support for non-default std libraries — build rust runtime for your own embedded system.
- xargo is great but it's in maintenance mode, cargo-xbuild is catching up as intended replacement.
svd2rust Generate Rust structs with register mappings from SVD files.
μtest unit testing for microcontrollers and other no-std systems.
embedded-hal-mock Mock implementation of embedded-hal traits for testing without accessing real hardware. -
bindgen Automatically generates Rust FFI bindings to C and C++ libraries. -
cortex-m semihosting Semihosting for ARM Cortex-M processors
bobbin-cli A Rust command line tool to simplify embedded development and deployment.
cargo-fel4 A Cargo subcommand for working with feL4 projects. -

Peripheral Access Crates

Peripheral Access Crates were also called Device Crates.

NOTE You may be able to find even more peripheral access crates by searching for the svd2rust keyword on crates.io!

Microchip

atsamd21 Peripheral access API for Microchip (formerly Atmel) SAMD21 microcontrollers. This git repo hosts both the peripheral access crate and the hal.
atsamd51 Peripheral access API for Microchip (formerly Atmel) SAMD51 microcontrollers. This git repo hosts both the peripheral access crate and the hal.
avr-device Peripheral access API for Microchip (formerly Atmel) AVR microcontroller family.
sam3x8e Peripheral access API for Atmel SAMD3X8E microcontrollers (generated using svd2rust) -

Nordic

nrf51 Peripheral access API for nRF51 microcontrollers (generated using svd2rust) -
nrf52810-pac - Peripheral access API for the nRF52810 microcontroller (generated using svd2rust) -
nrf52832-pac - Peripheral access API for the nRF52832 microcontroller (generated using svd2rust) -
nrf52840-pac - Peripheral access API for the nRF52840 microcontroller (generated using svd2rust) -

NXP

SiFive

e310x - svd2rust generated interface to SiFive Freedom E310 MCUs -

Silicon Labs

efm32pg12-pac - Peripheral access API for Silicon Labs EFM32PG12 microcontrollers -

STMicroelectronics

The stm32-rs project has peripheral access APIs for most STM32 microcontrollers (generated using svd2rust):

Texas Instruments

tm4c123x Peripheral access API for TM4C123x microcontrollers (generated using svd2rust)
tm4c129x Peripheral access API for TM4C129x microcontrollers (generated using svd2rust)

MSP430

msp430g2553 Peripheral access API for MSP430G2553 microcontrollers (generated using svd2rust)
- msp430 quickstart some examples for msp430

Ambiq Micro

ambiq-apollo3-pac Peripheral access API for Ambiq Apollo3 microcontrollers (generated using svd2rust)

GigaDevice

gd32vf103-pac Peripheral access API for GD32VF103 RISC-V microcontrollers (generated using svd2rust) -

HAL implementation crates

Implementations of embedded-hal for microcontroller families and systems running some OS. -

NOTE You may be able to find even more HAL implementation crates by searching for the embedded-hal-impl and embedded-hal keywords on crates.io!