rt-thread README

The project's README from github.com/RT-Thread/rt-thread. As one markdown file: README.md.

English | 中文 | Español | Deutsch

GitHubStars GiteeStars GitHub GitHub release Gitter GitHub pull-requests PRs Welcome RT-Thread BSP Static Build Check MemBrowse Featured|HelloGitHub

RT-Thread

RT-Thread was born in 2006, it is an open source, neutral, and community-based real-time operating system (RTOS).

RT-Thread is mainly written in C language, easy to understand and easy to port(can be quickly port to a wide range of mainstream MCUs and module chips). It applies object-oriented programming methods to real-time system design, making the code elegant, structured, modular, and very tailorable.

RT-Thread has Standard version and Nano version. For resource-constrained microcontroller (MCU) systems, the Nano version that requires only 3KB Flash and 1.2KB RAM memory resources can be tailored with easy-to-use tools. For resource-rich IoT devices, RT-Thread can use the on-line software package management tool, together with system configuration tools, to achieve intuitive and rapid modular cutting, seamlessly import rich software packages; thus, achieving complex functions like Android's graphical interface and touch sliding effects, smart voice interaction effects, and so on.

RT-Thread Architecture

RT-Thread has not only a real-time kernel, but also rich components. Its architecture is as follows:

architecture

It includes:

RT-Thread Features

Code Catalogue

RT-Thread source code catalog is shown as follow:

Name Description
bsp Board Support Package based on the porting of various development boards
components Components, such as finsh shell, file system, protocol stack etc.
documentation Related documents, like coding style, doxygen etc.
examples Related sample code
include Head files of RT-Thread kernel
libcpu CPU porting code such as ARM/MIPS/RISC-V etc.
src The source files for the RT-Thread kernel.
tools The script files for the RT-Thread command build tool.

RT-Thread has now been ported for nearly 200 development boards, most BSPs support MDK, IAR development environment and GCC compiler, and have provided default MDK and IAR project, which allows users to add their own application code directly based on the project. Each BSP has a similar directory structure, and most BSPs provide a README.md file, which is a markdown-format file that contains the basic introduction of BSP, and introduces how to simply start using BSP.

Resources

Supported Architectures

RT-Thread supports many architectures, and has covered the major architectures in current applications. Architecture and chip manufacturer involved:

Supported IDE and Compiler

The main IDE/compilers supported by RT-Thread are:

RT-Thread Studio IDE

User Manual | Tutorial Videos

RT-Thread Studio IDE (a.k.a. RT-Studio) is a one-stop intergrated development environment built by RT-Thread team. It has a easy-to-use graphical configuration system and a wealth of software packages and components resources. RT-Studio has the features of project creation, configuration and management,as well as code editing, SDK management, build configuration, debugging configuration, program download and debug. We're looking to make the use of RT-Studio as intuitive as possible, reducing the duplication of work and improving the development efficiency.

studio

Env Tool

User Manual | Tutorial Videos

In the early stage, RT-Thread team also created an auxiliary tool called Env. It is an auxiliary tool with a TUI (Text-based user interface). Developers can use Env tool to configure and generate the GCC, Keil MDK, and IAR projects.

env

Getting Started

RT-Thread Programming Guide | RT-Thread Studio IDE | Kernel Sample | RT-Thread Beginners Guide

Based on STM32F103 BluePill | Raspberry Pi Pico

Simulator

RT-Thread BSP can be compiled directly and downloaded to the corresponding development board for use. In addition, RT-Thread also provides qemu-vexpress-a9 BSP, which can be used without hardware platform. See the getting started guide below for details. Getting Started of QEMU with Env: Windows | Linux Ubuntu | Mac OS

License

RT-Thread follows the Apache License 2.0 free software license. It's completely open-source, can be used in commercial applications for free, does not require the disclosure of code, and has no potential commercial risk. License information and copyright information can generally be seen at the beginning of the code:

/* Copyright (c) 2006-2018, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 * ...
 */

Community

RT-Thread is very grateful for the support from all community developers, and if you have any ideas, suggestions or questions in the process of using RT-Thread, RT-Thread can be reached by the following means, and we are also updating RT-Thread in real time on these channels. At the same time, any questions can be asked in the issue section of RT-Thread repository or RT-Thread forum, and community members will answer them.

Website | Github | Twitter | LinkedIn | Youtube | Facebook | Medium

Contribution

If you are interested in RT-Thread and want to join in the development of RT-Thread and become a code contributor,please refer to the Code Contribution Guide.

Thanks for the following contributors!

rt-thread (RT-Thread/rt-thread)

Searching Database…

12.3K ·GitHub
What is this?RT-Thread is an open source, community-based real-time operating system (RTOS) for embedded and IoT devices, mainly written in C.
Is this a full OS or just a kernel library?It is a full RTOS with a real-time kernel plus a rich components and service layer (filesystem, network stack, device framework) and an online software package ecosystem of 450+ packages.
How do I get started building and running RT-Thread?You can flash a BSP directly to a supported development board, or use the RT-Thread Studio IDE or the Env TUI tool to configure and generate GCC/Keil MDK/IAR projects; there's also a qemu-vexpress-a9 BSP to try it without hardware.
Which compilers and architectures does it support?It supports mainstream toolchains GCC, Keil MDK and IAR, and has been ported to ARM Cortex-M/A, ARM7/9/11, MIPS32, RISC-V, ARC, DSP, C-Sky and x86 across ~200 development boards.
How small can it be squeezed down for a tiny microcontroller?The Nano version needs only about 3KB Flash and 1.2KB RAM, so it can run even on very resource-constrained MCUs, while the Standard version supports richer package-based functionality for IoT devices.
Who is this aimed at — hobbyists or production embedded developers?It targets embedded/IoT firmware developers building on MCUs and SoCs for both resource-constrained devices and richer IoT products, from hobbyist boards like Raspberry Pi Pico to commercial chip platforms.
Can I use this commercially without releasing my source code?Yes, RT-Thread is licensed under Apache License 2.0, which is fully open source, free for commercial use, and does not require disclosing your code.
What does the package ecosystem actually give me?Through an online software package management tool you can pull in reusable modules for things like graphical interfaces similar to Android, touch sliding effects, and smart voice interaction, letting you build complex IoT features quickly instead of writing them from scratch.
Does RT-Thread support object-oriented design in C?Yes, it applies object-oriented programming methods to its real-time system design, which keeps the kernel code structured, modular, and easy to tailor despite being written in plain C.
Are there standard API interfaces like POSIX?Yes, RT-Thread offers a variety of standard interfaces including POSIX, CMSIS, and a C++ application environment, making it easier to port existing code or developer skills onto it.
How is the source code organized?The repository splits into folders like bsp (board support packages), components (shell, filesystem, protocol stacks), libcpu (CPU porting for ARM/MIPS/RISC-V), include (kernel headers), src (kernel source), and tools (build scripts).
Creator
RT-Thread
Size
1011.1 MB
Stars
12.3K
Age
13y
Commits · 90 Days