應用APP與電力邊緣計算框架公共交互接口

1、應用APP與邊緣計算框架公共交互接口A.1 MQTT交互主題邊緣計算框架與應用APP之間的基礎(chǔ)功能交互主題如表A.1所示。交互主題分類業(yè)務(wù)功能主題用途發(fā)送方（publisher）訂閱方（subscriber）云邊交互相關(guān)數(shù)據(jù)上報/v1/$appName/service/data用于業(yè)務(wù)APP對框架發(fā)送業(yè)務(wù)數(shù)據(jù)APP邊緣框架事件上報/v1/$appName/service/event用于業(yè)務(wù)APP對框架發(fā)送緊急事件APP邊緣框架控制命令下發(fā)/v1/$appName/service/command用于框架轉(zhuǎn)發(fā)物管平臺對下的控制命令邊緣框架APP/v1/$appName/service/reply用

2、于業(yè)務(wù)APP對框架發(fā)送服務(wù)響應APP邊緣框架業(yè)務(wù)配置更新/v1/$appName/app/command用于框架通知APP更新業(yè)務(wù)配置文件邊緣框架APP/v1/$appName/app/reply用于APP對框架發(fā)送配置文件更新的響應APP邊緣框架端設(shè)備管理/v1/$appName/topo/request用于業(yè)務(wù)APP對框架發(fā)送添加端設(shè)備、刪除端設(shè)備、更新請求APP邊緣框架/v1/$appName/topo/response用于框架對業(yè)務(wù)APP發(fā)送端設(shè)備操作請求的響應邊緣框架APP數(shù)據(jù)共享庫相關(guān)數(shù)據(jù)存儲、查詢、刪除/v1/$appName/database/request用于APP對數(shù)據(jù)的存

3、儲、查詢、刪除。APP邊緣框架數(shù)據(jù)響應/v1/$appName/database/response用于邊緣框架對APP數(shù)據(jù)請求的響應邊緣框架APP設(shè)備屬性請求/v1/$appName/edge_properties/request用于APP請求設(shè)備屬性。APP邊緣框架設(shè)備屬性響應/v1/$appName/edge_properties/response用于邊緣框架對APP設(shè)備屬性請求的響應邊緣框架APPA.2 報文格式APP上送邊緣計算框架的報文均以JSON格式描述，通用報文字段如表A.2所示。通用報文格式名稱類型是否必選描述typestring是消息類型，全大寫，單詞中間用“_”隔開midn

4、umber是消息ID，會話發(fā)起者自主生成，響應者與其一致paramobject是報文內(nèi)容，詳見各報文定義timestampnumber是時間戳，毫秒精度，根據(jù)當前時間生成A.3 接口與報文規(guī)范A.3.1 端設(shè)備添加請求端設(shè)備添加請求具體實現(xiàn)方式如下： 方向：APP - 邊緣框架 主題：/v1/$appName/topo/request 端設(shè)備的新增、狀態(tài)更新、刪除等操作均由APP發(fā)起，由邊緣框架轉(zhuǎn)發(fā)到平臺，平臺下發(fā)為每個端設(shè)備生成的deviceID，邊緣框架不保存deviceID的信息，nodeId與deviceID對應關(guān)系由APP負責維護。在后續(xù)上報數(shù)據(jù)階段，APP上報數(shù)據(jù)中需帶有devic

5、eID標明數(shù)據(jù)的來源。業(yè)務(wù)APP向邊緣計算框架發(fā)起添加端設(shè)備請求，其字段說明如表A.3所示：type字段取值為：CMD_TOPO_ADD。端設(shè)備添加報文格式名稱類型是否必需描述typestring是CMD_TOPO_ADDmidnumber是該消息的編號，自主生成timestampnumber是毫秒精度，根據(jù)當前時間生成expirenumber是默認為-1 表示永不過期paramobject是詳見下表param字段內(nèi)容名稱類型是否必需描述nodeInfoarray是端設(shè)備信息列表，列表大小1100Array字段說明字段類型是否必選描述nodeIdstring是端設(shè)備唯一標識namestring

6、是端設(shè)備名稱descriptionstring是端設(shè)備描述mfgInfostring是端設(shè)備廠商信息nodeModelstring是端設(shè)備型號表A.5 (續(xù))字段類型是否必選描述modelIdstring否端設(shè)備模型編號A.3.2 端設(shè)備添加響應端設(shè)備添加響應具體實現(xiàn)方式如下： 方向：邊緣框架 - APP 主題：/v1/$appName/topo/response 邊緣計算框架在獲取了平臺的響應后，返回業(yè)務(wù)APP響應,其報文字段說明如表A.6所示：type字段取值為：CMD_TOPO_ADD；result字段如表A.7所示。添加端設(shè)備應答字段說明名稱類型是否必需描述typestring是CMD

7、_TOPO_ADDmidnumber是在報文中該值為對應控制報文的IDresultarray否添加端設(shè)備的結(jié)果信息，列表大小1100codenumber是標識應答的返回碼msgstring否應答結(jié)果描述，字符串，最大256字符Array字段說明字段類型是否必選參數(shù)描述statusCodenumber是請求處理的結(jié)果碼，200 表示成功，400 表示失敗statusDescstring否響應狀態(tài)描述nodeIdstring是端設(shè)備唯一標識deviceIdstring是平臺生成的設(shè)備唯一標識profileObject否該端設(shè)備的過濾模型，由邊緣框架下載、過濾A.3.3 端設(shè)備刪除請求端設(shè)備刪除請求

8、具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/topo/request 業(yè)務(wù)APP向邊緣計算網(wǎng)關(guān)發(fā)起刪除設(shè)備請求。其字段說明如表A.8所示：type字段取值為：CMD_TOPO_DEL，param字段如表A.9所示。刪除端設(shè)備命令字段說明名稱類型是否必需描述typestring是CMD_TOPO_DELmidnumber是該消息的編號，自主生成表A.8 (續(xù))名稱類型是否必需描述paramobject是參數(shù)，詳見表A.9timestampnumber是毫秒精度刪除端設(shè)備命令param字段說明字段類型是否必選描述nodeIdsarray是端設(shè)備ID列表，列表大小1

9、100，string數(shù)組A.3.4 端設(shè)備刪除響應端設(shè)備刪除響應具體實現(xiàn)方式如下： 方向：邊緣框架 -APP 主題：/v1/$appName/topo/response 邊緣計算框架在獲取了平臺的響應后，返回業(yè)務(wù)APP響應。其報文字段說明如表A.10所示：type字段取值為：CMD_TOPO_DEL；param字段如表A.11所示。端設(shè)備刪除報文格式名稱類型是否必需描述typestring是CMD_TOPO_ DELmidnumber是在報文中該值為對應控制報文的IDparamobject是設(shè)備刪除的結(jié)果響應codenumber是標識應答的返回碼msgstring否應答結(jié)果描述，字符串，最大2

10、56字符param字段說明字段類型是否必選參數(shù)描述resultarray否設(shè)備刪除的結(jié)果信息result段說明字段類型是否必選參數(shù)描述statusCodenumber是請求處理的結(jié)果碼，“200”表示成功，“400”表示失敗statusDescstring否結(jié)果描述deviceIdstring是平臺生成的設(shè)備唯一標識A.3.5 端設(shè)備狀態(tài)更新上報端設(shè)備狀態(tài)更新上報具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/topo/request 業(yè)務(wù)APP向邊緣計算網(wǎng)關(guān)發(fā)起更新終端設(shè)備信息請求。其字段說明如表A.13所示：type字段取值為：CMD_TOPO_UPDATE，

11、param字段如表A.14所示。端設(shè)備更新字段說明名稱類型是否必需描述typestring是CMD_TOPO_UPDATEmidnumber是該消息的編號，自主生成paramobject是參數(shù)，詳見表A.14timestampnumber是毫秒精度param字段說明字段類型是否必選參數(shù)描述nodeStatusesarray是端設(shè)備狀態(tài)列表，列表大小1100NodeStatus結(jié)構(gòu)體字段說明字段類型是否必選參數(shù)描述deviceIdstring是平臺生成的端設(shè)備唯一標識statusstring是端設(shè)備狀態(tài)：OFFLINE：設(shè)備離線，ONLINE： 設(shè)備上線A.3.6 端設(shè)備狀態(tài)更新響應端設(shè)備狀態(tài)更

12、新響應具體實現(xiàn)方式如下： 方向：邊緣框架 -APP 主題：/v1/$appName/topo/response 邊緣計算網(wǎng)關(guān)收到物聯(lián)管理平臺的響應后，向APP發(fā)送響應報文。其字段說明如表A.16所示：type字段取值為：CMD_TOPO_UPDATE，param字段如表A.17所示。報文格式名稱類型是否必需描述typestring是CMD_TOPO_UPDATEmidnumber是在報文中該值為對應控制報文的IDparamobject是設(shè)備更新的結(jié)果響應codenumber是標識應答的返回碼msgstring否應答結(jié)果描述，字符串，最大256字符param結(jié)構(gòu)體字段說明字段類型是否必選參數(shù)描述

13、resultarray否更新設(shè)備狀態(tài)信息Array結(jié)構(gòu)體字段說明字段類型是否必選參數(shù)描述statusCodenumber是請求處理的結(jié)果碼，“200”表示成功，“400”表示失敗statusDescstring否結(jié)果狀態(tài)描述deviceIdstring是端設(shè)備唯一標識A.3.7 數(shù)據(jù)主動上報數(shù)據(jù)主動上報具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/service/data APP向邊緣計算框架主動上報業(yè)務(wù)數(shù)據(jù)，邊緣框架根據(jù)對應的物模型過濾后上報。報文格式如 REF _Ref32999849 h * MERGEFORMAT 報文格式所示，其中type字段取值為：C

14、MD_REPORTDATA，param如表A.20所示。報文格式名稱類型是否必需描述typestring是CMD_REPORTDATAmidnumber是在報文中該值為報文ID，自主生成paramobject是根據(jù)物模型規(guī)范定義deviceIdstring是報文中的數(shù)據(jù)屬于哪個邊緣設(shè)備timestampnumber是毫秒精度param結(jié)構(gòu)體字段說明字段類型是否必選描述cmdstring是數(shù)據(jù)屬于哪個類別，與業(yè)務(wù)相關(guān)，上送業(yè)務(wù)主站需要deviceIdstring是主站為端設(shè)備分配的唯一IDdatajson是數(shù)據(jù)以物模型規(guī)范的數(shù)據(jù)格式上報A.3.8 事件主動上報數(shù)據(jù)主動上報具體實現(xiàn)方式如下： 方向

15、：APP -邊緣框架 主題：/v1/$appName/service/event APP向邊設(shè)備主動上報緊急事件。報文格式如表A.21所示，其中type字段取值為：CMD_REPORTEVENT，param如表A.22所示。報文格式名稱類型是否必需描述typestring是CMD_REPORTEVENTmidnumber是該消息的編號，自主生成deviceIdstring是報文中的數(shù)據(jù)屬于哪個邊緣設(shè)備paramobject是根據(jù)物模型規(guī)范定義timestampnumber是毫秒精度param格式名稱類型是否必需描述deviceIdstring是主站為端設(shè)備分配的唯一IDeventstring是

16、事件類型dataJSON對象否根據(jù)物模型規(guī)范定義緊急事件的描述A.3.9 控制命令下發(fā)控制命令下發(fā)具體實現(xiàn)方式如下： 方向：邊緣框架 -APP 主題：/v1/$appName/service/command 邊緣計算框架轉(zhuǎn)發(fā)物聯(lián)管理平臺對終端設(shè)備的控制命令，App主動訂閱主題，其中param字段需與物模型定義相同，此處不做要求（對于業(yè)務(wù)自定義的控制報文，也需要在模型文件中給出描述）。報文格式如表A.23所示。業(yè)務(wù)控制報文格式名稱類型是否必需描述typestring是CMD_SERVICEmidnumber是在報文中該值為報文IDparamobject是根據(jù)物模型規(guī)范定義deviceIdstri

17、ng是報文中的數(shù)據(jù)屬于哪個端設(shè)備expirenumber否超時時間timestampnumber是毫秒精度A.3.10 控制命令響應控制命令響應具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/service/reply 邊緣計算框架轉(zhuǎn)發(fā)的控制命令在APP完成執(zhí)行后，返回響應報文。報文格式如表A.24所示，其中mid為對應控制報文的ID。報文格式名稱類型是否必需描述typestring是CMD_SERVICEmidnumber是與下發(fā)報文一致timestampnumber是毫秒精度paramobject否根據(jù)物模型規(guī)范定義codenumber是標識應答的返回碼msg

18、string否應答結(jié)果描述，字符串，最大256字符A.3.11 業(yè)務(wù)配置更新下發(fā)業(yè)務(wù)配置更新下發(fā)具體實現(xiàn)方式如下： 方向：邊緣框架 -APP 主題：/v1/$appName/app/ command 邊緣計算框架向業(yè)務(wù)APP發(fā)送更新配置文件的報文，App主動訂閱，appName表示APP的名稱。報文格式如表A.25所示。其中param中包含的內(nèi)容如表A.26所示。業(yè)務(wù)配置命令報文格式名稱類型是否必需描述typestring是CMD_CONFIG_DOWNmidnumber是該消息的編號deviceIdstring是邊設(shè)備IDparamobject是詳見下表expirenumber否過期時間ti

19、mestampnumber是毫秒精度Param格式名稱類型是否必需描述containerstring是容器名稱appNamestring是App名稱namestring是文件名稱configFilestring是配置命令內(nèi)容Base64編碼內(nèi)容A.3.12 業(yè)務(wù)配置更新響應業(yè)務(wù)配置更新響應具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/app/reply 邊緣計算框架轉(zhuǎn)發(fā)的更新配文件的命令在APP完成執(zhí)行后，返回響應報文，其中topic中需包含app的名稱。報文格式如表A.27所示，其中mid為對應控制報文的ID。業(yè)務(wù)配置響應報文格式名稱類型是否必需描述types

20、tring是CMD_CONFIG_REPLYmidnumber是與下發(fā)報文一致codenumber是標識應答的返回碼msgstring否應答結(jié)果描述，字符串，最大256字符A.3.13 存儲數(shù)據(jù)請求存儲數(shù)據(jù)請求具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/database/request 實時數(shù)據(jù)存儲接口用于APP自主通過邊緣計算框架向數(shù)據(jù)共享庫存儲實時數(shù)據(jù)，保障數(shù)據(jù)安全性，防止APP突然故障導致數(shù)據(jù)丟失，每一次存儲的數(shù)據(jù)由dataKey字段唯一標識。APP發(fā)布Topic：/v1/$appName/database/request，其中appName是發(fā)起請求A

21、PP的名稱。報文格式名稱類型是否必需描述typestring是DATABASE_DATA_SAVEmidnumber是在報文中該值為報文ID，自主生成paramobject是請求參數(shù)，詳見表A.29timestampnumber是毫秒精度param結(jié)構(gòu)體字段說明字段類型是否必選描述deviceIdstring否主站為端設(shè)備分配的唯一IDdataKeystring是實時數(shù)據(jù)主鍵datajson是實時數(shù)據(jù)內(nèi)容A.3.14 存儲數(shù)據(jù)響應存儲數(shù)據(jù)響應具體實現(xiàn)方式如下： 方向：邊緣框架 - APP 主題：/v1/$appName/database/response APP訂閱Topic：/v1/$app

22、Name/database/response，其中appName是發(fā)起請求APP的名稱。報文格式名稱類型是否必需描述typestring是DATABASE_DATA_SAVE表A.30 (續(xù))名稱類型是否必需描述midnumber是在報文中該值為對應控制報文的IDcodenumber是標識應答的返回碼msgstring否應答結(jié)果描述，字符串，最大256字符A.3.15 獲取數(shù)據(jù)請求獲取數(shù)據(jù)請求具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/database/request APP根據(jù)dataKey字段向數(shù)據(jù)共享庫請求相對應的一段數(shù)據(jù)。APP發(fā)布Topic：/v1/

23、$appName/database/request，其中appName是發(fā)起請求APP的名稱。報文格式名稱類型是否必需描述typestring是DATABASE_DATA_REQUESTmidnumber是該消息的編號paramobject是請求參數(shù)，詳見表A.32param結(jié)構(gòu)體字段說明字段類型是否必選描述deviceIdstring否指定的設(shè)備IDdataKeystring是實時數(shù)據(jù)主鍵A.3.16 獲取數(shù)據(jù)響應獲取數(shù)據(jù)響應具體實現(xiàn)方式如下： 方向：邊緣框架 - APP 主題：/v1/$appName/database/response APP訂閱Topic：/v1/$appName/da

24、tabase/response，其中appName是發(fā)起請求APP的名稱。報文格式名稱類型是否必需描述typestring是DATABASE_DATA_REQUESTmidnumber是在報文中該值為報文IDparamobject是根據(jù)物模型規(guī)范定義codenumber是標識應答的返回碼param結(jié)構(gòu)體字段說明字段類型是否必選描述deviceIdstring否平臺生成的端設(shè)備唯一標識dataKeyjson是實時數(shù)據(jù)主鍵datajson是實時數(shù)據(jù)內(nèi)容A.3.17 刪除數(shù)據(jù)請求刪除數(shù)據(jù)請求具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/database/request

25、 APP根據(jù)dataKey字段向數(shù)據(jù)共享庫刪除相對應的一段數(shù)據(jù)。APP發(fā)布Topic：/v1/$appName/database/request，其中appName是發(fā)起請求APP的名稱。 報文格式名稱類型是否必需描述typestring是DATABASE_DATA_DELmidnumber是在報文中該值為報文ID，自主生成paramobject是請求參數(shù)，詳見表A.36param結(jié)構(gòu)體字段說明字段類型是否必選描述deviceIdstring否指定的設(shè)備IDdataKeystring是實時數(shù)據(jù)主鍵A.3.18 刪除數(shù)據(jù)響應刪除數(shù)據(jù)響應具體實現(xiàn)方式如下： 方向：邊緣框架 - APP 主題：/v1

26、/$appName/database/responsec) APP訂閱Topic：/v1/$appName/database/response，其中appName是發(fā)起請求APP的名稱。報文格式名稱類型是否必需描述typestring是DATABASE_DATA_DELmidnumber是在報文中該值為對應控制報文的IDcodenumber是標識應答的返回碼msgstring否應答結(jié)果描述，字符串，最大256字符A.3.19 獲取設(shè)備屬性請求獲取設(shè)備屬性請求具體實現(xiàn)方式如下： 方向：APP -邊緣框架 主題：/v1/$appName/edge_properties/request APP發(fā)布T

27、opic：/v1/$appName/edge_properties/request，其中appName是請求APP的名稱。其中param為空即可。報文格式名稱類型是否必需描述typestring是EDGE_PROP_REQUESTmidnumber是該消息的編號paramobject否A.3.20 獲取設(shè)備屬性響應獲取設(shè)備屬性響應具體實現(xiàn)方式如下： 方向：邊緣框架 - APP 主題：/v1/$appName/edge_properties/response APP訂閱Topic：/v1/$appName/edge_properties/response，其中appName是請求APP的名稱。報文格式名稱類型是否必需描述typestring是EDGE_PROP_REQUESTmidnumber是在報文中該值為