https://github.com/nrf-rs/microbit
A Rust crate for BBC micro:bit development
https://github.com/nrf-rs/microbit
Last synced: 7 months ago
JSON representation
A Rust crate for BBC micro:bit development
- Host: GitHub
- URL: https://github.com/nrf-rs/microbit
- Owner: nrf-rs
- License: 0bsd
- Created: 2018-01-21T20:59:23.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-04-29T22:08:54.000Z (8 months ago)
- Last Synced: 2025-05-03T10:47:35.596Z (8 months ago)
- Language: Rust
- Homepage:
- Size: 493 KB
- Stars: 300
- Watchers: 14
- Forks: 65
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-0BSD.txt
Awesome Lists containing this project
README
# microbit
_microbit_ contains everything required getting started using Rust to create firmwares for the fabulous
[BBC micro:bit](https://microbit.org) microcontroller board. This little board has everything and a kitchen sink built-in,
even a capable debugging interface.
## Getting started
All you need to start programming this device is:
* A BBC micro:bit board
* A computer (known to work with macOS, Linux and Windows)
* A bit of open source software
### Know your version
The micro:bit comes in different versions. There is a separate crate for each major board version. See the table below to identify
which crate you need to use.
| Crate | Board version | Board image | Docs | crates.io | target |
| ------------------------------ | ------------- | ----------- | ---- | --------- | ------ |
| [`microbit`](./microbit) | V1 | [
](https://github.com/microbit-foundation/microbit-svg/blob/master/microbit-drawing-back-1-5.png) | [](https://docs.rs/microbit) | [](https://crates.io/crates/microbit) | `thumbv6m-none-eabi` |
| [`microbit-v2`](./microbit-v2) | V2 | [
](https://github.com/microbit-foundation/microbit-svg/blob/master/microbit-drawing-back-2.png) | [](https://docs.rs/microbit-v2) | [](https://crates.io/crates/microbit-v2) | `thumbv7em-none-eabihf` |
### Install dependencies
The examples make use of some of the fantastic tooling from the [knurling](https://knurling.ferrous-systems.com/) and [probe-rs](https://probe.rs/) projects.
In order to run the examples you need to install [`probe-rs`](https://probe.rs/docs/getting-started/installation)
and [`flip-link`](https://github.com/knurling-rs/flip-link#installation).
```bash
> cargo install probe-rs-tools flip-link
```
### Run an example
The first thing to try is one of the [examples](./examples) in this repository. Plug in your micro:bit and
run one of the commands below.
*For micro:bit V1*
```bash
> cargo run --release --manifest-path ./examples/display-blocking/Cargo.toml --features v1 --target thumbv6m-none-eabi
```
*For micro:bit V2*
```bash
> cargo run --release --manifest-path ./examples/display-blocking/Cargo.toml --features v2 --target thumbv7em-none-eabihf
```
You should see a lot of build output, the orange LED on the back of the micro:bit should flash quickly, and
a message should appear on the LED display.
Congratulations! You've flashed your first Rust program onto your micro:bit!
## Further reading
A guide to embedded development with Rust on the _micro:bit_ using this crate can be found in the [MicroRust book](https://droogmic.github.io/microrust/).
Other useful resources:
- [micro:bit developer community](https://tech.microbit.org)
- [micro:bit hardware overview](https://tech.microbit.org/hardware/)
- [nrf-hal](https://github.com/nrf-rs/nrf-hal#readme) the hardware abstraction layer (HAL) this repository is based on
## License
[0-clause BSD license](LICENSE-0BSD.txt).