Repository files navigation

The friendly Operating System for IoT!

RIOT is an open-source microcontroller operating system, designed to matchthe requirements of Internet of Things (IoT) devices and other embedded devices.It supports a range of devices that are typically found in the Internet of Things (IoT):8-bit, 16-bit and 32-bit microcontrollers.

RIOT is based on the following design principles: energy-efficiency, real-timecapabilities, small memory footprint, modularity, and uniform API access,independent of the underlying hardware (this API offers partial POSIXcompliance).

RIOT is developed by an international open source community which isindependent of specific vendors (e.g. similarly to the Linux community).RIOT is licensed with LGPLv2.1, a copyleft license which fostersindirect business models around the free open-source software platformprovided by RIOT, e.g. it is possible to link closed-source code with theLGPL code.

RIOT provides features including, but not limited to:

• a preemptive, tickless scheduler with priorities
• flexible memory management
• high resolution, long-term timers
• MTD abstraction layer
• File System integration
• support 200+ boards based on AVR, MSP430, ESP8266, ESP32, RISC-V,ARM7 and ARM Cortex-M
• the native port allows to run RIOT as-is on Linux and BSD.Multiple instances of RIOT running on a single machine can also beinterconnected via a simple virtual Ethernet bridge or via a simulatedIEEE 802.15.4 network (ZEP)
• IPv6
• 6LoWPAN (RFC4944, RFC6282, and RFC6775)
• UDP
• RPL (storing mode, P2P mode)
• CoAP
• OTA updates via SUIT
• MQTT
• USB (device mode)
• Display / Touchscreen support
• CCN-Lite
• LoRaWAN
• UWB
• Bluetooth (BLE) viaNimBLE

The most convenient way to get RIOT is to clone it via Git

$git clone https://github.com/RIOT-OS/RIOT

this will ensure that you get all the newest features and bug fixes with thecaveat of an ever changing work environment.

If you prefer things more stable, you can download the source code of one of ourquarter annual releasesvia Github as ZIP file or tarball. You canalso checkout a release in a cloned Git repository using

$git pull --tags$git checkout<YYYY.MM>

For more details on our release cycle, check ourdocumentation.

• You want to start the RIOT? Just follow ourquickstart guide ortry thistutorial.For specific toolchain installation, follow instructions in thegetting started page.
• The RIOT API itself can be built from the code using doxygen. The latestversion of the documentation is uploaded daily todoc.riot-os.org.

Using Windows? Usethis guide tosetup the development environment.

You can ask for help on the Forum or on Matrix. Please send bug reports andfeature requests to ourGitHub issue tracker

• forum is the default place to start asking forhelp. Our Forum provides an archive of prior questions and answers.
• For chat, we use#riot-os:matrix.org on theMatrix chat network.
• GitHub Issue tracker for issueswith the code and documentation.

For how our community is structured and governed, please see ourgovernance document.

Please include as much detail as you can that is relevant to your question, notonly "this isn't working". These details include:

1. What you want to achieve.
2. What have you tried so far (for example the commands you typed).
3. What happened so far.

RIOT closely collaborates with and inspires other open source projects, e.g.,Ariel OS, an IoT OS written in Rust. We are more than happy to collaborate with those who share ourvision.

To contribute something to RIOT, please refer to ourcontributing document.

• Github notifications:notifications@riot-os.org

• Most of the code developed by the RIOT community is licensed under the GNULesser General Public License (LGPL) version 2.1 as published by the FreeSoftware Foundation.
• Some external sources, especially files developed by SICS are published undera separate license.

All code files contain licensing information.

For more information, see the RIOT website:

https://www.riot-os.org