You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
LiteOS-Reading/src/README.md

124 lines
5.4 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

[![star](https://gitee.com/LiteOS/LiteOS/badge/star.svg?theme=gvp)](https://gitee.com/LiteOS/LiteOS/stargazers)
[![fork](https://gitee.com/LiteOS/LiteOS/badge/fork.svg?theme=gvp)](https://gitee.com/LiteOS/LiteOS/members)
[View English](README_EN.md)
## Huawei LiteOS简介
Huawei LiteOS是华为面向物联网领域开发的一个基于实时内核的轻量级操作系统。本项目属于<a href="https://www.huaweicloud.com/product/liteos.html" target="_blank">华为物联网操作系统[Huawei LiteOS]</a>源码现有基础内核包括不可裁剪的极小内核和可裁剪的其他模块。极小内核包含任务管理、内存管理、异常管理、系统时钟和中断管理。可裁剪模块包括信号量、互斥锁、队列管理、事件管理、软件定时器等。除了基础内核Huawei LiteOS还提供了增强内核包括C++支持、低功耗以及维测模块。低功耗通过支持Tickless机制、run-stop休眠唤醒可以极大地降低系统功耗。维测部分包含了获取CPU占用率、Trace事件跟踪、Shell命令行等功能。
Huawei LiteOS同时提供端云协同能力集成了LwM2M、CoAP、mbedtls、LwIP全套IoT互联协议栈且在LwM2M的基础上提供了AgentTiny模块用户只需关注自身的应用而不必关注LwM2M实现细节直接使用AgentTiny封装的接口即可简单快速实现与云平台安全可靠的连接。
Huawei LiteOS自开源社区发布以来围绕NB-IoT物联网市场从技术、生态、解决方案、商用支持等多维度使能合作伙伴构建开源的物联网生态。目前已经聚合了50+ MCU和解决方案合作伙伴共同推出一批开源开发套件和行业解决方案帮助众多行业客户快速推出物联网终端和服务客户涵盖抄表、停车、路灯、环保、共享单车、物流等众多行业为开发者提供 “一站式” 完整软件平台,可有效降低开发门槛、缩短开发周期。
关于Huawei LiteOS更详细的介绍详见[LiteOS产品介绍](./doc/LiteOS_Introduction.md)。
## Huawei LiteOS 资料中文网
<a href="https://support.huaweicloud.com/LiteOS/index.html" target="_blank">Huawei LiteOS官方文档中心</a>
## LiteOS 代码导读
[LiteOS内核源代码目录说明](./doc/LiteOS_Code_Info.md)
该文档描述的是LiteOS内核源代码的详细信息。通过此文档读者可以了解LiteOS的源代码结构以及LiteOS的main()函数的功能。
## LiteOS 编译介绍和开发工具
[LiteOS编译介绍和开发工具](./doc/LiteOS_Build_and_IDE.md)
该文档介绍了LiteOS的编译框架以及如何在Linux和Windows下编译LiteOS。
## LiteOS 快速入门
[LiteOS快速入门](./doc/LiteOS_Quick_Start.md)
该文档介绍如何快速将LiteOS在开发板和QEMU模拟器上运行起来。
## LiteOS 移植指南
[LiteOS移植指南](./doc/LiteOS_Porting_Guide.md)
该文档基于STM32芯片平台详细介绍如何快速移植LiteOS。
## LiteOS 内核开发指南
[LiteOS内核开发指南](./doc/LiteOS_Kernel_Developer_Guide.md)
该文档详细讲解了LiteOS各模块开发及其实现原理。用户可以通过阅读该文档学习各模块的使用。
## LiteOS 组件开发指南
<a href="https://gitee.com/LiteOS/LiteOS_Components/tree/master" target="_blank">LiteOS组件开发指南</a>
该文档详细介绍了LiteOS组件的构成以及完整的开发流程。用户可以通过阅读该文档了解LiteOS组件框架和开发流程。
## LiteOS 维测指南
[LiteOS维测指南](./doc/LiteOS_Maintenance_Guide.md)
该文档详细介绍了LiteOS具备的维测能力包括内存调测方法、IPC通信调测方法、Trace、调度统计、获取CPU占用率等。
## LiteOS Shell
[Shell使用教程](./shell/README_CN.md)
该文档详细讲解了在LiteOS如何定制用户自定义Shell命令以及如何执行内置的Shell命令。
## LiteOS 标准库
[LiteOS标准库](./doc/LiteOS_Standard_Library.md)
该文档列出了LiteOS支持的POSIX、CMSIS等接口。
## LiteOS Demos
[LiteOS demos](./demos)目录下包含了LiteOS提供的各模块Demo及其文档。文档详细介绍了Demo的功能以及运行方法。
## LiteOS API参考
<a href="https://www.huawei.com/minisite/liteos/cn/api/index.html" target="_blank">API参考</a>请访问LiteOS官网。
## LiteOS 代码贡献必读
[LiteOS 代码&文档贡献指南](./doc/LiteOS_Contribute_Guide.md)
该文档包含LiteOS的编程规范、文档写作规范、提交代码&文档时信息的填写规范、以及如何提交到LiteOS仓库。
## LiteOS 支持的硬件
* LiteOS开源项目目前支持ARM Cortex-M0Cortex-M3Cortex-M4Cortex-M7Cortex-A等芯片架构
* LiteOS联合业界主流MCU厂家通过开发者活动目前已经适配了多种通用MCU开发套件
## 开源协议
* 遵循BSD-3开源许可协议
* [Huawei LiteOS 知识产权政策](./doc/LiteOS_Contribute_Guide.md#协议)
## 联系我们
* 技术支持
欢迎<a href="https://gitee.com/LiteOS/LiteOS/issues" target="_blank">提交issue</a>对关心的问题发起讨论,或到<a href="https://bbs.huaweicloud.com/forum/forum-729-1.html" target="_blank">LiteOS论坛</a>发起交流。
您也可以发送问题至邮箱LiteOSSupport@huawei.com。
* 技术合作
如您有合作意向希望加入Huawei LiteOS生态合作伙伴请发邮件至LiteOSSupport@huawei.com或访问<a href="http://www.huawei.com/liteos" target="_blank">LiteOS官网</a>,进一步了解详细信息。