天天看點

AliOS Things 新版文檔庫上線啦結構清晰内容詳實文檔貢獻通路入口開發指南

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

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

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 新版文檔庫上線啦結構清晰内容詳實文檔貢獻通路入口開發指南

通路入口

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

使用者可通過通路位址:

,進入AliOS Things新版文檔庫。

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

AliOS Things 新版文檔庫上線啦結構清晰内容詳實文檔貢獻通路入口開發指南

阿裡雲官網:

https://www.aliyun.com/

進入阿裡雲官網首頁,在首頁右上方點選“文檔”菜單進入阿裡雲文檔中心。

AliOS Things 新版文檔庫上線啦結構清晰内容詳實文檔貢獻通路入口開發指南

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

AliOS Things 新版文檔庫上線啦結構清晰内容詳實文檔貢獻通路入口開發指南

進入HaaS官網首頁,點選“學習路徑”菜單即可進入AliOS Things新版文檔庫。

AliOS Things 新版文檔庫上線啦結構清晰内容詳實文檔貢獻通路入口開發指南

開發指南

如需更多技術支援,可加入釘釘開發者群,或者關注微信公衆号。

AliOS Things 新版文檔庫上線啦結構清晰内容詳實文檔貢獻通路入口開發指南

更多技術與解決方案介紹,請通路HaaS官方網站

https://haas.iot.aliyun.com