为了更好的服务开发者,提高开发AliOS Things应用的效率,在2021年4月30日AliOS Things 3.3.0版本开源同时,我们推出了近40万字的AliOS Things新版文档库。
新版文档库秉承简单、易懂、方便、提效的原则,提供层次清晰的目录结构、丰富详实的说明内容、简单易用的贡献文档接口以及多个访问入口等新特性,文档库界面如下图。
结构清晰
为方便开发者能够迅速的定位到目标内容,我们对AliOS Things操作系统内核、组件、案例、API以及配套开发工具的所有相关文档进行了梳理分层,形成清晰目录结构:
提供AliOS Things 操作系统框架、版本说明、文档入口、支持硬件、开发者交流通道等信息。
为用户提供基于HaaS100或HaaS EDU k1硬件,快速搭建开发环境、下载源码、运行简单示例工程或设备连接阿里云示例工程的方法。
介绍AliOS Things操作系统配套的开发环境aos-studio、构建工具aos-tools以及构建配置package.yaml的使用方法。
从AliOS Things操作系统内核实现原理出发,提供任务、互斥量、信号量等功能的使用示例,帮助开发者为其应用编程选择合适的内核能力以及正确使用API。
组件是AliOS Things操作系统为物联网应用开发提供的上层能力。该板块列出了所有开源组件的使用说明,帮助用户快速的了解组件的用途和使用方法。
案例是AliOS Things操作系统根据典型的物联网应用场景为开发者打造的示例工程。该板块列出了每个案例所需的软硬件条件和使用说明,方便开发者在此基础上快速的打造属于自己的物联网应用。
为开发者贡献文档、贡献代码提供操作指南。
对内核和组件常用API的提供说明。
内容详实
文档库从多个层面详细介绍了AliOS Things操作系统内核、组件、案例、API以及配套开发工具以及开发者如何快速上手、贡献代码或文档等方面的内容。其中内核编程板块不仅提供了内核功能以及API的使用方法,还对实时操作系统调度、任务管理、任务互斥、任务间通信等机制做了原理性的说明,为那些想深入了解操作系统工作原理的开发者提供了学习指导。开发工具板块囊括了AliOS Things配套的开发环境、构建工具和配置文件的全部使用说明,后续还将在此版块扩充更多工具的相关内容。目前组件介绍板块包含40个组件的使用说明,案例开发板块包括12个经典案例的介绍。快速开始板块目前提供了引导开发者基于硬件HaaS100和HaaS EDU k1快速运行示例程序的操作说明,后续会随着支持硬件的多样化而不断扩充。开发者贡献板块为开发者贡献文档或代码提供操作指南,后续会对贡献规范提供进一步的详细说明。
文档贡献
此次文档库提供的所有内容均随AliOS Things V3.3.0版本的源代码在gitee上开源。其中案例、组件、内核的内容分别来源于对应各模块仓库下的README.md,例如:“HaaS物联网设备OTA解决方案”案例对应的代码仓库为ota_demo,那么ota_demo仓库根目录下的README.md就是该案例的使用说明文档。而系统概述、快速开始、开发工具、构建工具、开发贡献说明等文档均在仓库documentation下:
开发者若发现文档存在描述错误或缺少内容,可以按照贡献文档说明提供的方法,在目标文档上方点击“更正文档”,进入文档编辑页面对文档进行修改,并提交审核。“更正文档”字样位置如下图:
访问入口
为兼顾不同用户的使用习惯,我们为AliOS Things新版文档库提供了多个访问入口:
- AliOS Things新版文档库:https://haas.iot.aliyun.com/aliosthings/
用户可通过访问地址:https://haas.iot.aliyun.com/aliosthings/,进入AliOS Things新版文档库。
- AliOS Things文档中心:https://help.aliyun.com/product/123206.html?spm=a2c4g.750001.list.243.b1767b13EzBsGE
进入AliOS Things文档中心,在左侧菜单栏点击“AliOS Things 文档库(新)”,点击“主要内容”下方的板块标题,即可进入AliOS Things新版文档中心阅读对应板块的内容。
阿里云官网:https://www.aliyun.com/
进入阿里云官网主页,在主页右上方点击“文档”菜单进入阿里云文档中心。
在阿里云文档中心页面,找到“物联网”板块,选择“IoT物联网操作系统”即可进入AliOS Things文档中心。
- HaaS官网:https://haas.iot.aliyun.com/
进入HaaS官网主页,点击“学习路径”菜单即可进入AliOS Things新版文档库。
开发指南
如需更多技术支持,可加入钉钉开发者群,或者关注微信公众号。
更多技术与解决方案介绍,请访问HaaS官方网站https://haas.iot.aliyun.com。