TencentOS-tiny/README.md

214 lines
13 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 开放原子开源基金会首批孵化项目
![](./doc/image/introduction/TencentOS_tiny_log.png)
[![license](http://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/Tencent/TencentOS-tiny/blob/master/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Tencent/TencentOS-tiny/pulls)
[(English Documents Available)](README_en.md)
# 一、TobudOS 简介
[TobudOS ](https://cloud.tencent.com/product/tos-tiny) 是面向物联网领域开发的实时操作系统早期版本基于腾讯自研的物联网操作系统TencentOS Tiny2020年由腾讯捐赠到开放原子开源基金会进行孵化2023年正式更名为TobudOSTobudOS具有低功耗低资源占用模块化安全可靠等特点可有效提升物联网终端产品开发效率提供精简的 RTOS 内核,内核组件可裁剪可配置,可快速移植到多种主流 MCU (如 STM32 全系列) 及模组芯片上。而且,基于 RTOS 内核提供了丰富的物联网组件,内部集成主流物联网协议栈(如 CoAP/MQTT/TLS/DTLS/LoRaWAN/NB-IoT 等),可助力物联网终端设备及业务快速接入物联网云平台。
## 1、TobudOS 整体架构
![](./doc/image/introduction/TencentOS_tiny_Architecture.png)
TobudOS主体架构图从下到上主要包括
**CPU 库** TobudOS支持的 CPU IP 核架构,当前主要支持 ARM Cortex M0/3/4/7Cortex A7RISC-V、MSP430、AVR、STM8 等。
**驱动管理层** 包括板级支持包BSP主要由 MCU 芯片厂家开发与维护、硬件抽象层HAL主要由 TencentOS tiny 提供方便不同芯片的适配与移植、设备驱动Drivers例如 Wi-Fi、GPRS、LoRa 等模块的驱动程序)。
**内核** TobudOS 实时内核包括任务管理、实时调度、时间管理、中断管理、内存管理、异常处理、软件定时器、链表、消息队列、信号量、互斥锁、事件标志等模块。
**IoT 协议栈**TobudOS提供 lwip、AT Adapter、SAL 层,支持不同的网络硬件,例如以太网、串口 Wi-Fi、GPRS、NB-IoT、4G 等通信模块。TCP/IP 网络协议栈上提供常用的物联网协议栈,例如 CoAP、MQTT支撑终端业务快速接入腾讯云。
**安全框架**TobudOS为了确保物联网终端数据传输安全以及设备认证安全提供了完整的安全解决方案。安全框架提供的 DTLS 和 TLS 安全协议,加固了 COAP 及 MQTT 的传输层,可确保物联网终端在对接腾讯云时实现安全认证和数据加密;另外针对低资源的终端硬件,安全框架还提供与腾讯云 IoTHub 配套的密钥认证方案,确保资源受限设备也能在一定程度上实现设备安全认证。
**组件框架**TobudOS 提供文件系统、KV 存储、自组网、JS 引擎、低功耗框架、设备框架、OTA、调试工具链等一系列组件供用户根据业务场景选用。
**开放 API规划开发中**TobudOS 将在协议中间件和框架层上提供开放 API 函数,方便用户调用中间件功能,使用户无需过多关心中间件具体实现,快速对接腾讯云,实现终端业务上云的需求,期望最大程度减少终端物联网产品开发周期,节省开发成本。
**示例应用**TobudOS 提供的示例代码,模块测试代码等,方便用户参考使用。
## 2、TobudOS 优势
### (1).小体积
最小内核RAM 0.6KBROM 1.8KB
典型 LoraWAN 及传感器应用RAM 3.3KBROM 12KB
### (2).低功耗
休眠最低功耗低至 2uA
支持外设功耗管理框架
### (3).丰富的 IoT 组件
集成主流 IoT 协议栈
多种通信模组 SAL 层适配框架;
支持 OTA 升级
提供简单易用端云 API加速用户业务接入腾讯云
### (4).可靠的安全框架
多样化的安全分级方案
均衡安全需求&成本控制
### (5).良好的可移植性
内核及 IoT 组件高度解耦,提供标准适配层
提供自动化移植工具,提升开发效率
### (6).便捷的调试手段
提供云化的最后一屏调试功能
故障现场信息自动上传云平台,方便开发人员调试分析
## 3、TobudOS 携手合作伙伴共建 IoT 生态
![](./doc/image/introduction/Partners.png)
TobudOS 自开源发布以来也在努力发展合作伙伴,期待合作共赢,共同扩展 IoT 应用生态。目前已经与多家 MCU/IP 核厂家达成了合作包括意法半导体、恩智浦半导体、兆易半导体、ARM、华大半导体、芯来科技等也与无线 SOC 和模组厂家达成了广泛的合作关系包括瑞兴恒方、国民技术、Nordic 蓝牙、亮牛半导体、有人物联网等,
除了 MCU 和模组外TobudOS也积极推进终端产品及项目的落地目前已经形成了 AI 智慧农业、智能货柜、智慧会议室等方案并且在腾讯内部与微信支付、腾讯云智慧行业、AI 平台部、腾讯微瓴、QQ family 达成内部合作共同扩展行业生态同时也开始积极发展外部客户目前与深圳光合显示科技的墨水屏零售标签、鑫悦购充电桩等达成业务合作。TobudOS 将携手合作伙伴为物联网终端厂家提供更优质的 IoT 终端软件解决方案,方便各种物联网设备快速接入腾讯云,共同扩展 IoT 生态,更好地支撑智慧城市、智能水表、智能家居、智能穿戴、车联网等多种行业应用。
欢迎 IoT 相关项目合作,有合作需求的请邮件联系 TobudOS 官方工作人员邮箱地址supowang@tencent.com
# 二、TobudOS 代码目录
- [TobudOS 代码目录说明](./doc/09.Code_Directories.md)
# 三、TobudOS 参考文档
## 1、移植指南
- [TobudOS 移植指南KEIL 版本)](./doc/10.Porting_Manual_for_KEIL.md)
- [TobudOS移植指南IAR 版本)](./doc/11.Porting_Manual_for_IAR.md)
- [TobudOS移植指南GCC 版本)](./doc/12.Porting_Manual_for_GCC.md)
- [TobudOS移植指南基于 MDK pack)](./tools/mdk_pack/Documentation/README.md)
- [TobudOS 移植指南(基于 STM32 CubeMx)](./tools/STM32CubeMX_pack/Documentation/README.md)
## 2、TobudOS 开发指南
- [TobudOS 内核开发指南](./doc/04.Development_Manual.md)
- [TobudOS API 参考](./doc/05.SDK_Manual.md)
- [TobudOS对接腾讯云 IoTHub 开发指南](./doc/08.QCloud_IoTHub_Quick_Start.md)
## 3、TobudOS 腾讯云大学视频教程
- [TobudOS 端侧开发实践课](https://cloud.tencent.com/edu/paths/series/IoT)
# 四、TobudOS开源协议
- TobudOS 遵循 [BSD-3 开源许可协议](LICENSE)
# 五、TobudOS 支持的物联网平台
TobudOS能支持物联网终端设备和业务快速接入[腾讯云物联网平台 IoT Explorer](https://cloud.tencent.com/product/iotexplorer)。
TobudOS 结合腾讯云物联网开发平台 IoT Explorer已经构筑起连接通讯芯片到云开发的能力加上已经建设完成的国内最大规模 LoRa 网络,腾讯彻底打通从芯片通讯开发、网络支撑服务,物理设备定义管理,数据分析和多场景应用开发等全链条 IoT 云开发服务能力,重新定义了物联网开发模式,助力亿级设备多方式多模式低门槛接入腾讯云服务。作为物联网基础设施建设服务者,腾讯将持续打造开放的物联网生态体系,促进物联网生态良性发展。
# 六、TobudOS 快速入门参考
TobudOS 联合合作伙伴 (南京厚德物联网) 设计了定制开发板,如下图:
![](./doc/image/introduction/EVB_MX.png)
- [TobudOS 定制开发板介绍页](http://www.holdiot.com/product/showproduct.php?id=8),开发者可以基于定制开发板进行快速入门学习,点击下载参考文档
- [TobudOS 定制开发板入门指南](./doc/15.TencentOS_tiny_EVB_MX_Plus_Quick_Start.md)
# 七、贡献代码
- 1. 在您自己的 GitHub 账户下 Fork TobudOS 开源项目;
- 2. 根据您的需求在本地 clone 一份 TobudOS 代码;
- 3. 您修改或者新增功能后push 到您 fork 的远程分支;
- 4. 创建 pull request向 TobudOS官方开发分支提交合入请求
- 5. TobudOS 研发团队会定期 review 代码,通过测试后合入。
# 八、加入 TobudOS 官方 QQ 技术交流群
扫码加群,请备注 TobudOS 开发者,工作人员会根据备注进行审核:
![](./doc/image/introduction/qq.png)
# 九、第三方开发者评测
1.基于 TobudOS 的环境监测实战项目
[【TobudOS】环境监测实战项目最终完整版](https://www.bilibili.com/video/av73782956?from=search&seid=4421984671929108231)
感谢阿正的贡献
2.基于野火 stm32f103 开发板上移植的 TobudOS 例程、源码剖析、视频讲解。
感谢 CSDN 博客专家杰杰的贡献
## 简单上手:
- [超详细的 TobudOS 移植到 STM32F103 全教程](https://blog.csdn.net/jiejiemcu/article/details/101034426)
## 深度源码分析:
- [【TobudOS 学习】源码分析1——task](https://blog.csdn.net/jiejiemcu/article/details/99618912)
- [【TobudOS 学习】源码分析2——调度器](https://blog.csdn.net/jiejiemcu/article/details/99665883)
- [【TobudOS 学习】源码分析3——队列](https://blog.csdn.net/jiejiemcu/article/details/99687678)
- [【TobudOS 学习】源码分析4——消息队列](https://blog.csdn.net/jiejiemcu/article/details/99781093)
- [【TobudOS 学习】源码分析5——信号量](https://blog.csdn.net/jiejiemcu/article/details/100052643)
- [【TobudOS 学习】源码分析6——互斥锁](https://blog.csdn.net/jiejiemcu/article/details/100056641)
- [【TobudOS学习】源码分析7——事件](https://blog.csdn.net/jiejiemcu/article/details/100492219)
- [【TobudOS 学习】源码分析8——软件定时器](https://blog.csdn.net/jiejiemcu/article/details/101846089)
## 配套例程:
- [【TobudOS学习】例程0——hello world](https://github.com/jiejieTop/TencentOS-Demo/tree/master/hello-world)
- [【TobudOS 学习】例程1——task](https://github.com/jiejieTop/TencentOS-Demo/tree/master/01-task)
- [【TobudOS 学习】例程2——队列](https://github.com/jiejieTop/TencentOS-Demo/tree/master/02-queue)
- [【TobudOS 学习】例程3——消息队列](https://github.com/jiejieTop/TencentOS-Demo/tree/master/03-msg_queue)
- [【TobudOS学习】例程4——信号量](https://github.com/jiejieTop/TencentOS-Demo/tree/master/04-sem)
- [【TobudOS学习】例程5——互斥锁](https://github.com/jiejieTop/TencentOS-Demo/tree/master/05-mutex)
- [【TobudOS学习】例程6——事件](https://github.com/jiejieTop/TencentOS-Demo/tree/master/06-event)
- [【TobudOS学习】例程7——软件定时器](https://github.com/jiejieTop/TencentOS-Demo/tree/master/07-timer)
- [【TobudOS学习】例程8——内存池](https://github.com/jiejieTop/TencentOS-Demo/tree/master/08-mmblk)
- [【TobudOS学习】例程9——内存堆](https://github.com/jiejieTop/TencentOS-Demo/tree/master/09-mmheap)
## 视频教程:
- [【TobudOS学习】视频汇总](https://www.bilibili.com/video/av70478596?from=search&seid=10160676184801585522)
- [【视频】01-初识 TobudOS](https://www.bilibili.com/video/av70478596/?p=1)
- [【视频】02-TobudOS 基础知识](https://www.bilibili.com/video/av70478596/?p=2)
- [【视频】03-TobudOS 移植](https://www.bilibili.com/video/av70478596/?p=3)
- [【视频】04-TobudOS 任务 -1](https://www.bilibili.com/video/av70478596/?p=4)
- [【视频】05-TobudOS 任务 -2](https://www.bilibili.com/video/av70478596/?p=5)
- [【视频】06-TobudOS 队列 -1](https://www.bilibili.com/video/av70478596/?p=6)
- [【视频】07-TobudOS 队列 -2](https://www.bilibili.com/video/av70478596/?p=7)
- [【视频】08-TobudOS 消息队列](https://www.bilibili.com/video/av70478596/?p=8)
- [【视频】09-TobudOS 信号量 -1](https://www.bilibili.com/video/av70478596/?p=9)
- [【视频】10-TobudOS 信号量 -2](https://www.bilibili.com/video/av70478596/?p=10)
- [【视频】11-TobudOS互斥锁 -1](https://www.bilibili.com/video/av70478596/?p=11)
- [【视频】12-TobudOS 互斥锁 -2](https://www.bilibili.com/video/av70478596/?p=12)
- [【视频】13-TobudOS 互斥锁 -3](https://www.bilibili.com/video/av70478596/?p=13)
- [【视频】14-TobudOS 事件 -1](https://www.bilibili.com/video/av70478596/?p=14)
- [【视频】15-TobudOS 事件 -2](https://www.bilibili.com/video/av70478596/?p=15)
- [【视频】16-TobudOS 软件定时器 -1](https://www.bilibili.com/video/av70478596/?p=16)
- [【视频】17-TobudOS 软件定时器 -2](https://www.bilibili.com/video/av70478596/?p=11)
- [【视频】18-TobudOS 软件定时器 -3](https://www.bilibili.com/video/av70478596/?p=18)
## 相关 PPT 资料:
- [【TobudOS 学习】视频 PPT](https://github.com/jiejieTop/TencentOS-Demo/tree/master/PPT)