智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

一、HTTP API 介面規範

介面鑑權

使用smartassistant介面,需將使用者憑證smart-assistant-token,放在http請求的header中。格式如下:

2. 返回標準資料結構

smartassistant介面均返回JSON格式資料,格式如下:

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

3.

錯誤碼列表

二、裝置類外掛實現

開發前先閱讀外掛設計概要:外掛系統設計技術概要

使用 plugin-sdk(code:/pkg/plugin/sdk) 可以忽略不重要的邏輯,快速實現外掛

外掛實現

1) 獲取sdk

2) 定義裝置

sdk中提供了預定義的裝置模型,使用模型可以方便SA有效進行管理和控制

裝置物模型設計如下:

light_bulb燈泡

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

switch開關

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

outlet插座

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

info裝置詳情

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

curtain窗簾

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

3) 實現裝置介面 定義好裝置之後,需要為裝置實現如下幾個方法:

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

實現如下:

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

4) 初始化和執行

定義好裝置和實現方法後,執行外掛服務(包括grpc和http服務)

智慧家居開源生態—正確的HTTP API 介面規範以及裝置類外掛實現

這樣服務就會執行起來,並透過SA的etcd地址0。0。0。0:2379註冊外掛服務, SA會透過etcd發現外掛服務並且建立通道開始通訊並且轉發請求和命令。

接著就可以開始了。

TAG: 外掛裝置介面SDKSa