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