Welcome to The Embedded Rust Book: An introductory book about using the Rust Programming Language on "Bare Metal" embedded systems, such as Microcontrollers.
The goals of this book are:
Get developers up to speed with embedded Rust development. i.e. How to set up a development environment.
Share current best practices about using Rust for embedded development. i.e. How to best use Rust language features to write more correct embedded software.
Serve as a cookbook in some cases. e.g. How do I do mix C and Rust in a single project?
This book tries to be as general as possible but to make things easier for both the readers and the writers it uses the ARM Cortex-M architectures in all its examples. However, the book assumes that the reader is not familiar with this particular architecture and explains details particular to this architecture where required.
Who This Book is For
This book assumes the following:
- You are comfortable using the Rust Programming Language, and have written, run, and debugged Rust applications on a desktop environment. You should also be familiar with the idioms of the 2018 edition as this book targets Rust 2018.
- You are comfortable developing and debugging embedded systems in another
language such as C, C++, or Ada, and are familiar with concepts such as:
- Cross Compilation
- Memory Mapped Peripherals
- Common interfaces such as I2C, SPI, Serial, etc.
If you are not yet comfortable with Rust, we highly suggest completing the Rust Book before reading this book.
If you are not yet comfortable with embedded systems, we highly suggest checking out our other resources before attempting to read this book.
How to Use This Book
This book generally assumes that you’re reading it front-to-back. Later chapters build on concepts in earlier chapters, and earlier chapters may not dig into details on a topic, revisiting the topic in a later chapter.
This book will be using the STM32F3DISCOVERY development board from STMicroelectronics for the majority of the examples contained within. This board is based on the ARM Cortex-M architecture, and while basic functionality is common across most CPUs based on this architecture, peripherals and other implementation details of Microcontrollers are different between different vendors, and often even different between Microcontroller families from the same vendor.
For this reason, we suggest purchasing the STM32F3DISCOVERY development board for the purpose of following the exmaples in this book.
HEADS UP Until the official release of this book, which is planned to coincide with the 2018 edition release of the Rust Programming Language, expect the sections of this book to change quite a bit. We recommend bookmarking the root of this book instead of any specific version.
Contributing to This Book
If you have trouble following the instructions in this book or find that some section of the book is not clear enough or hard to follow then that's a bug and it should be reported in the issue tracker of this book.
Pull requests fixing typos and adding new content are very welcome!