開發與維運

AliOS Things 新版文檔庫上線啦

為了更好的服務開發者,提高開發AliOS Things應用的效率,在2021年4月30日AliOS Things 3.3.0版本開源同時,我們推出了近40萬字的AliOS Things新版文檔庫。

新版文檔庫秉承簡單、易懂、方便、提效的原則,提供層次清晰的目錄結構、豐富詳實的說明內容、簡單易用的貢獻文檔接口以及多個訪問入口等新特性,文檔庫界面如下圖。
image.png

結構清晰
為方便開發者能夠迅速的定位到目標內容,我們對AliOS Things操作系統內核、組件、案例、API以及配套開發工具的所有相關文檔進行了梳理分層,形成清晰目錄結構:

AliOS Things 概述
提供AliOS Things 操作系統框架、版本說明、文檔入口、支持硬件、開發者交流通道等信息。

快速開始
為用戶提供基於HaaS100或HaaS EDU k1硬件,快速搭建開發環境、下載源碼、運行簡單示例工程或設備連接阿里雲示例工程的方法。

開發工具
介紹AliOS Things操作系統配套的開發環境aos-studio、構建工具aos-tools以及構建配置package.yaml的使用方法。

內核編程
從AliOS Things操作系統內核實現原理出發,提供任務、互斥量、信號量等功能的使用示例,幫助開發者為其應用編程選擇合適的內核能力以及正確使用API。

組件介紹
組件是AliOS Things操作系統為物聯網應用開發提供的上層能力。該板塊列出了所有開源組件的使用說明,幫助用戶快速的瞭解組件的用途和使用方法。

案例開發
案例是AliOS Things操作系統根據典型的物聯網應用場景為開發者打造的示例工程。該板塊列出了每個案例所需的軟硬件條件和使用說明,方便開發者在此基礎上快速的打造屬於自己的物聯網應用。

開發者貢獻
為開發者貢獻文檔、貢獻代碼提供操作指南。

API用戶手冊
對內核和組件常用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下:

image.png

開發者若發現文檔存在描述錯誤或缺少內容,可以按照貢獻文檔說明提供的方法,在目標文檔上方點擊“更正文檔”,進入文檔編輯頁面對文檔進行修改,並提交審核。“更正文檔”字樣位置如下圖:

image.png

訪問入口

為兼顧不同用戶的使用習慣,我們為AliOS Things新版文檔庫提供了多個訪問入口:

AliOS Things新版文檔庫
用戶可通過訪問地址,進入AliOS Things新版文檔庫。

AliOS Things文檔中心

進入AliOS Things文檔中心,在左側菜單欄點擊“AliOS Things 文檔庫(新)”,點擊“主要內容”下方的板塊標題,即可進入AliOS Things新版文檔中心閱讀對應板塊的內容。

image.png

阿里雲官網
進入阿里雲官網主頁,在主頁右上方點擊“文檔”菜單進入阿里雲文檔中心。
image.png

在阿里雲文檔中心頁面,找到“物聯網”板塊,選擇“IoT物聯網操作系統”即可進入AliOS Things文檔中心。

image.png

HaaS官網
進入HaaS官網主頁,點擊“學習路徑”菜單即可進入AliOS Things新版文檔庫。
image.png

開發指南
如需更多技術支持,可加入釘釘開發者群,或者關注微信公眾號。
image.png

Leave a Reply

Your email address will not be published. Required fields are marked *