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
这是什么?RT-Thread 是一款开源、由社区驱动的实时操作系统(RTOS),面向嵌入式和物联网设备,主要使用 C 语言编写。
这是完整的操作系统,还是只是一个内核库?它是一个完整的实时操作系统,包含实时内核,以及丰富的组件和服务层(文件系统、网络协议栈、设备框架),还有一个包含 450 多个软件包的在线软件包生态。
我该如何开始构建和运行 RT-Thread?你可以把 BSP 直接烧录到受支持的开发板上,也可以使用 RT-Thread Studio IDE 或 Env 终端工具来配置项目,并生成 GCC、Keil MDK 或 IAR 工程;此外还提供 qemu-vexpress-a9 BSP,无需硬件即可体验。
它支持哪些编译器和架构?它支持主流工具链 GCC、Keil MDK 和 IAR,已移植到 ARM Cortex-M/A、ARM7/9/11、MIPS32、RISC-V、ARC、DSP、C-Sky 和 x86 等架构,覆盖约 200 款开发板。
在很小的单片机上,它最少能精简到多小?Nano 版本只需约 3KB Flash 和 1.2KB RAM,即使是资源非常有限的单片机也能运行;标准版则支持功能更丰富的软件包,适合物联网设备。
它面向的是爱好者,还是专业的嵌入式开发者?它面向在单片机和 SoC 上开发的嵌入式/物联网固件工程师,既适用于资源受限的设备,也适用于功能更丰富的物联网产品,从树莓派 Pico 这类爱好者开发板到商用芯片平台都有覆盖。
我能否在商业项目中使用它,而无需公开源代码?可以。RT-Thread 采用 Apache License 2.0 许可证,属于完全开源协议,可免费用于商业用途,且不要求公开你的代码。
软件包生态具体能给我带来什么?通过在线软件包管理工具,你可以直接引入现成的可复用模块,例如类似 Android 的图形界面、触摸滑动效果和智能语音交互等,无需从零编写,就能快速实现复杂的物联网功能。
RT-Thread 支持用 C 语言实现面向对象的设计吗?支持。它将面向对象的编程方法应用于实时系统设计中,因此即便使用纯 C 语言编写,内核代码依然结构清晰、模块化,并且易于裁剪。
有没有像 POSIX 这样的标准 API 接口?有。RT-Thread 提供多种标准接口,包括 POSIX、CMSIS 以及 C++ 应用环境,便于将已有代码或开发者的技能迁移到该系统上。
源代码是如何组织的?代码仓库分为多个文件夹:bsp(板级支持包)、components(shell、文件系统、协议栈等组件)、libcpu(ARM/MIPS/RISC-V 等 CPU 移植代码)、include(内核头文件)、src(内核源代码)以及 tools(构建脚本)。
Creator
RT-Thread
Size
1010.7 MB
Stars
12.3K
Age
13y
Commits · 90 Days