Go to file
Jamie Smith 97c267219a
Fix all Doxygen errors and make any future errors fatal (#118)
* Start working on fixing doxygen warnings

* Upgrade doxyfile to Doxygen 1.9.1

* Clean up some unmatched groups and add some exclusions

* Fix docs for rtos::ThisThread not showing up

* Fix up KV store docs

* Fix incorrect @files, some more incorrect groups

* Fix lots of broken links

* Start fixing mbedtls groups

* Fix more mbedtls docs

* Fix remaining mbedtls files with missing or incorrect grouping

* Fix a huge amount of PSA docs errors

* Fix a few more mbedtls docs errors

* Fix __cplusplus not defined for docs, clean up call in callback typedef, fix some docs errors

* Fix some broken doc links in HAL headers

* Fix more PSA doc errors

* Fix some doxygen errors in networking code

* Fix lots of network related doc errors

* Try and fix some CI failures

* Use Doxygen Action instead of doxygen in Mbed container to get the right version

* Try removing docs check

* Add first part of doxygen action

* Add next part of doxygen action

* Fix yaml syntax error

* Add in license check fix

* Try using verbose scancode

* Fix some more docs issues, workaround scancode-toolkit#3179

* Clean up the LoRaRadio get_state() function on each implementation.  Also fix some other compile and doc errors.

* Fix all remaining doxygen errors

* Fix escaping, for realsies this time

* Remove Doxygen unsupported config options, fix some more get_status() declarations

* Fix some UNITTESTS build errors

* Fix one more compile error

* Another unittest error
2022-12-30 18:41:41 -05:00
.github Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
TESTS Move Mbed TLS self tests to a separate configuration 2021-06-15 10:50:14 +01:00
UNITTESTS Rename inconsistently named testing-related variables. Also fix STM32CUBE not working from application code. 2022-09-14 00:25:29 -07:00
cmsis Fix ABI differences between mbed-baremetal and mbed-os, remove PlatformMutex 2022-09-14 00:25:30 -07:00
connectivity Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
docker_images/mbed-os-env Fix dockerfile typo 2022-09-14 00:25:26 -07:00
docs github actions for mbed-os-env docker management 2021-08-03 16:28:14 +01:00
drivers Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
events Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
extern Add external greentea-client dependency 2021-07-07 14:29:14 +01:00
features Rethink STM32 I2C v2 HAL (#78) 2022-11-20 17:46:30 -08:00
hal Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
platform Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
rtos Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
storage Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
targets Fix compilation of I2C code on static pinmap targets (#110) 2022-12-04 00:17:49 -08:00
tools Enable disabling target files for custom targets (#107) 2022-12-02 20:32:37 -08:00
.astylerc AStyle: fix indentation for longer lines 2018-05-24 14:15:52 +01:00
.codecheckignore .codecheckignore add STM mx_wifi files 2021-09-30 17:56:07 +02:00
.coveragerc Exclude libraries and tests from coverage numbers 2017-09-25 11:51:31 -05:00
.editorconfig Add .editorconfig file 2021-02-25 16:26:34 +01:00
.gitattributes Normalize line endings for IM880B startup files. 2019-07-15 14:56:22 +03:00
.gitignore Clean up top-level build file and build options, fix build issues on MinGW 2022-09-14 00:25:25 -07:00
.gitmodules Add docs generation workflow (#45) 2022-09-26 08:15:30 -07:00
.lgtm.yml Rename inconsistently named testing-related variables. Also fix STM32CUBE not working from application code. 2022-09-14 00:25:29 -07:00
.mergify.yml mergify: fix needs work labels 2021-10-14 15:01:16 +01:00
.pylintrc Add pylint configuration file 2016-08-16 11:48:45 -05:00
CMakeLists.txt Enable disabling target files for custom targets (#107) 2022-12-02 20:32:37 -08:00
CONTRIBUTING.md Fix links to documentation on https://os.mbed.com 2019-01-21 14:56:40 -08:00
DOXYGEN_FRONTPAGE.md Updating with new links and correct branding 2020-08-12 10:49:05 +01:00
Jenkinsfile Updated file comment 2018-08-20 12:31:40 +03:00
LICENSE-apache-2.0.txt license: rename to apache 2.0 txt file 2019-02-13 11:28:01 +00:00
LICENSE.md Update LICENSE.md 2021-08-05 14:13:57 +03:00
README.md Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
doxyfile_options Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
doxygen_options.json BLE: update doxygen exclusion pattern 2020-08-25 11:34:00 +01:00
logo.png Update readme to show that this is Mbed CE, and update templates to show that this is no longer an automated system 2022-09-14 00:25:30 -07:00
mbed.h Added Raw CAN (unlocked can read api) and updated the code for the 2021-06-29 12:46:21 +05:30

README.md

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.
  • Cloud management services.
  • Drivers for sensors, I/O devices and connectivity.

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

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

For the Mbed OS CE class-level documentation, see here

To contribute to this documentation, please see the mbed-os-5-docs repository.