Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 3.38 KB

README.md

File metadata and controls

49 lines (28 loc) · 3.38 KB

Mbed OS

Mbed OS Community Edition

Build status master

Arm Mbed OS is an open source embedded operating system designed specifically for the "things" in the Internet of Things. It includes all the features you need to develop a connected product based on an Arm Cortex-M microcontroller, including security, connectivity, an RTOS and drivers for sensors and I/O devices.

Mbed OS provides a platform that includes:

  • Security foundations.
  • Embedded networking libraries, e.g Wi-Fi and Ethernet drivers and network libraries using them
  • Drivers for microcontroller hardware features, including digital and analog I/O, PWM, and communications busses
  • Storage features, including file system and block device abstractions and low-level drivers

This is Mbed OS Community Edition (CE), a fork focused on improving the build system and tooling, fixing bugs, and keeping maintenance going after ARM's step back from the Mbed project.

License and contributions

The software is provided under the Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more information.

This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.

Folders containing files under different permissive license than Apache 2.0 are listed in the LICENSE file.

Getting started for developers

To start a new project that uses Mbed CE, see the setup guide here.

We have a developer website for asking questions, engaging with others, finding information on boards and components, using an online IDE and compiler, reading the documentation and learning about what's new and what's coming next in Mbed OS.

Additionally, the discussions page on this repo can be used for proposing and discussing specific code changes.

Documentation

Mbed CE Docs

For the Mbed CE code-level documentation (Doxygen), see here. For an auto-generated listing of target boards supported by Mbed, and the drivers & features each target supports, see the targets index here and the drivers index here.

Mbed CE is still working on more complete documentation infrastructure. Eventually, we hope to migrate all of the docs and examples as well. However, for now, see below to access those on the original Mbed OS docs site.

Original ARM Mbed OS Docs

For more information about Mbed OS, please see the published Mbed OS documentation. It includes general overview information, step-by-step tutorials, porting information and background reference materials about our architecture and tools.