Coordination repository of the embedded devices Working Group
Clone or download
bors[bot] and adamgreen Merge #251
251: Update bookshelf URLs to new location r=therealprof a=adamgreen

Documentation was recently moved to docs.rust-embedded.org and the old
links on this page now result in 404 errors.

Fixes #250

Co-authored-by: Adam Green <adamgreen@users.noreply.github.com>
Latest commit af8fda7 Nov 8, 2018

README.md

Embedded devices Working Group

Coordination repository of the embedded devices Working Group (WG)

This repository issue tracker is used by the embedded WG to coordinate efforts towards making Rust a great choice for embedded development.

Want to get started with embedded development with Rust? Check out our embedded Rust book and the rest of our bookshelf.

Vision

What is it that we really want? At a broad level:

  • To improve the absolute quality (functionality, safety, performance) of embedded software in the wild.
  • To improve the productivity of embedded software development teams, by reducing the tangible and intangible costs of achieving a level of quality.
  • To improve the experience for programmers developing for embedded systems.
  • To make embedded systems programming more accessible for people that are not already embedded systems developers.

What we do

At a high level we have two main tasks:

We work with the community to improve the embedded ecosystem.

  • We maintain and develop core crates in the embedded ecosystem ensuring that the development roadmap aligns with the needs of its users. You can find all the crates we maintain in the Organization section.

  • We develop and curate resources about embedded Rust development. Check our bookshelf!

  • We maintain and moderate the venues the embedded community uses to discuss. That includes this coordination repository and our IRC channel (#rust-embedded @ irc.mozilla.org).

And, we serve as a bridge between the Rust teams and the embedded community.

  • If you need a language or a compiler feature to improve your embedded software let us know and we'll discuss your request with the appropriate Rust team. For example, see this request for making the compiler emit information about the stack usage of functions, which was later implemented as an experimental feature.
  • Similarly, if you need some unstable API in the standard library to be stabilized to make your crate work on the stable we'll forward your request to the library team. For example, see this proposal to add ARM instructions to core::arch::arm to eliminate the need for the unstable inline assembly feature (asm!) in the most common scenarios.

How you can help

Everyone can contribute to the embedded WG efforts! There are several ways to help out:

  • Let us know where the gaps are. If you think the language, the compiler, the tooling, the documentation or the crate ecosystem is lacking some feature, information or library to build embedded software let us know and we'll bring it up to the Rust teams or organize the community to build the crates or tools to fill the gaps.
  • Participate in RFC (Request For Comments) threads. We are always looking into ways to improve. This may involve things from changing how we run the WG to landing major breaking changes in core crates. To ensure we are actually making things better we need your input! That's why all these changes are preceded by an "RFC", a discussion thread (which may or may not be backed by a proper RFC document) where we evaluate the pros and cons of a proposal and explore alternatives. Only after there's consensus on accepting the proposal is the proposal made effective.
  • Help wanted!. There's always lots to do but the WG members only have so much free time. You can help us fixing bugs, implementing features, writing tests, trying out examples and tutorials, writing documentation, fixing typos, etc. We'll mentor you through these tasks and review your work. In some cases you may not even need previous embedded experience or access embedded hardware to help us out so don't let that discourage you from checking out our help wanted issues.
  • Join our weekly meetings on IRC. We use these meetings as a faster, synchronous alternative to the RFC threads on GitHub. The agenda is posted in the issue tracker of this repository in advance to the meeting. Everyone is free to join the meeting and share their thoughts. You can also nominate an existing GH thread for discussion if you think it would benefit from a more synchronous discussion.
  • We have several teams focused on different areas: tooling, Cortex-M crates, etc. and each team maintains several projects (crates, docs and / or tools) that live under the rust-embedded organization. You can collaborate with the maintenance and development of these projects by becoming a project collaborator (consult with the team that owns the project) or by joining the team.

Organization

The WG is composed of a lead and several teams whose functions are defined in RFC #136. The embedded WG develops and maintains a large set of projects under the rust-embedded organization. This section lists all the teams and all the projects owned by the WG.

The WG lead

@japaric is the current lead of the embedded WG. His functions are:

  • Representing the WG in meetings where other Rust teams participate.
  • Communicating the needs of the embedded Rust community (e.g. language features, core API stabilization) to the Rust teams.
  • Giving the casting vote on intra-WG decisions where no voting majority can be achieved.

The Cortex-A team

The Cortex-A team develops and maintains the core of the Cortex-A crate ecosystem.

Members

Projects

Projects maintained by this team.

The Cortex-M team

The Cortex-M team develops and maintains the core of the Cortex-M crate ecosystem.

Members

Projects

Projects maintained by this team.

The Cortex-R team

The Cortex-R team develops and maintains the core of the Cortex-R crate ecosystem.

Members

Projects

It's early days for this team. They don't maintain projects within this organization at the moment.

The embedded Linux team

The embedded Linux team develops and maintains the core of the embedded Linux crate ecosystem.

Members

Projects

Projects maintained by the embedded Linux team

The HAL team

The HAL team develops and maintains crates that ease the development of Hardware Abstraction Layers, Board Support Crates and drivers.

Members

Projects

Projects maintained by the HAL team.

The MSP430 team

The MS430 team develops and maintains the core of the MSP430 crate ecosystem.

Members

Projects

Projects maintained by this team

The infrastructure team

The infrastructure team manages our domains, DNS records, e-mail aliases, etc.

Members

Projects

Projects maintained by this team

The RISCV team

The RISCV team develops and maintains the core of the RISCV crate ecosystem.

Members

Projects

Projects maintained by this team

The resources team

The resources team develops, maintains and curates resources on embedded Rust.

Members

Projects

Projects maintained by the resources team

The tools team

The tools team maintains and develops core embedded tools.

Members

Projects

Projects maintained by the tools team

The IRR 2018 team

This team consists of the participants of the Increasing Rust Reach (2018) program who worked on the embedded project of adding CI tests for embedded platforms to the compiler, and their mentor.

The old guard

This list is the membership of the embedded WG when it was first created and it's kept around for historical purposes. All the people in this list are members of the rust-embedded organization and most of them are members of one of the teams listed above.

Contact

You can usually find the members of the embedded WG on the #rust-embedded channel (server: irc.mozilla.org).

Our IRC channel is logged using logbot and you can find the logs at https://mozilla.logbot.info/rust-embedded

Other projects

These are other projects you may be interested in but that (currently) are not owned by the WG.

On going community efforts

embedded-hal

embedded-hal is a project that aims to build a standard set of traits (interfaces) for I/O functionality common in embedded devices: Serial, I2C, etc. with the goal of serving as a base for building reusable driver crates, crates to interface with external components like sensors.

There are plenty of traits that still need to be designed, in particular ones that involve async I/O. Join the discussion and help us design the missing traits so that they'll fulfill your needs.

The weekly driver initiative

To put the embedded-hal to test and to expand the embedded crates.io ecosystem we are running the weekly driver initiative. The goal is to release a new no_std, generic, embedded-hal driver crate every one or two weeks.

There's lots of cool devices that would be great to have drivers for. Join the initiative and help us grow the embedded crates.io ecosystem!

Awesome embedded Rust

The community is building a curated list of crates useful for embedded development. In this list you'll find driver crates, board support crates and general purpose no-std crates. Help us improve this list by adding your crate via PR or by tackling any of our help wanted issues.

Embedded category in the user forum

As an experiment the Rust lang user forum has gained a new embedded category.

This is meant as a friendly exchange for anyone interested in embedded topics with Rust.

So if you want to discuss ideas, problems or solutions please feel free to chime in on existing topics or create a new one!

RFCs

When the team deems it necessary the RFC process may be used to make decisions or to design processes, user interfaces, APIs, etc.

Learn more about the Rust's RFC process (which is the same as our own) here.

To create an RFC, simply:

  • clone this repo to your own personal one
  • copy 0000-template.md to text/0000-my-feature.md (where "my-feature" is descriptive. Don't assign an RFC number yet)
  • fill in the details of your RFC in that file
  • Open an pull request with this repository