《數(shù)字家庭平臺接口規(guī)范》_第1頁
《數(shù)字家庭平臺接口規(guī)范》_第2頁
《數(shù)字家庭平臺接口規(guī)范》_第3頁
《數(shù)字家庭平臺接口規(guī)范》_第4頁
《數(shù)字家庭平臺接口規(guī)范》_第5頁
已閱讀5頁,還剩14頁未讀, 繼續(xù)免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

ICS35.240.01

P0X

團體標準

T/ZSPH0X-2023

數(shù)字家庭平臺接口規(guī)范

Theinterfacespecificationofdigitalhomeplatform

(征求意見稿)

2023-XX-XX發(fā)布2023-XX-XX實施

中關村樂家智慧居住區(qū)產業(yè)技術聯(lián)盟發(fā)布

T/ZSPHXXXXX—XXXX

數(shù)字家庭平臺接口規(guī)范

1范圍

本標準規(guī)定了數(shù)字家庭的平臺模型架構、平臺硬件要求、平臺功能要求和平臺傳輸安全要求等。

本標準適用于數(shù)字家庭平臺。

2規(guī)范性引用文件

下列文件中的內容通過文中的規(guī)范性引用而構成本文件必不可少的條款。其中,注日期的引用文件,

僅該日期對應的版本適用于本文件;不注日期的引用文件,其最新版本(包括所有的修改單)適用于

本文件。

GB15629.1102-2003信息技術系統(tǒng)間遠程通信和信息交換局域網和城域網特定要求第11部分:

無線局域網媒體訪問控制和物理層規(guī)范:2.4GHz頻段較高速物理層擴展規(guī)范

GB15629.1104-2006信息技術系統(tǒng)間遠程通信和信息交換局域網和城域網特定要求第11部分:

無線局域網媒體訪問控制和物理層規(guī)范:2.4GHz頻段更高數(shù)據(jù)速率擴展規(guī)范

GB/T35143物聯(lián)網智能家居數(shù)據(jù)和設備編碼

3術語和定義

下列術語和定義適用于本文件。

3.1

家庭網絡homenetwork

將家庭套內音視頻設備、家用電器、信息設備、水電氣暖計量表、照明系統(tǒng)、安防報警求助系統(tǒng)等

連接在一起組成的一種局域網絡。

3.2

家庭網關homegateway

對家庭網絡內部所有網關的統(tǒng)稱,提供協(xié)議轉換、設備管理和網絡管理等功能。

3.3

物聯(lián)網網關internetofthingsgateway

連接家庭子網和家庭主網的主要設備,通過以太網接口與家庭網絡連接,通過有線及無線方式與控

制器、傳感器等設備連接,并對家庭子網內的設備及業(yè)務進行統(tǒng)一協(xié)調控制。

注:主要功能是接口及協(xié)議轉換,在某些應用場景下,可嵌入在家庭網關里,實現(xiàn)兩個設備的融合。

3.4

3

T/ZSPHXXXXX—XXXX

家庭主網homeprimarynetwork

支撐家庭視頻監(jiān)控、多媒體影音娛樂、IPTV等數(shù)據(jù)業(yè)務的網絡。

3.5

家庭子網homeLow-speedsub-network

支撐家庭傳感類、監(jiān)測類及控制類等物聯(lián)網業(yè)務的網絡。

3.6

數(shù)字家庭平臺digitalhomeplatform

在家庭套內實現(xiàn)信息設備、通信設備、娛樂設備、家用電器、自動控制設備、照明設備、安全防范

(監(jiān)控)裝置及計量表設備、家庭求助報警等設備互連和管理,以及數(shù)據(jù)共享的系統(tǒng),并實現(xiàn)與外部網

絡的互聯(lián)互通。

3.7

控制器controller

能夠接收控制指令,并對家庭內電氣設備或家居設施做出相應的操作。

3.8

受控設備equipmentundercontrol

家庭套內能夠接受自動或智能控制的電氣設備或家居設施,如照明燈具、家用電器、電動窗簾等。

3.9

云服務器cloudserver

部署在家庭網絡之外的互聯(lián)網上,對家庭網絡網關、控制終端等設備及業(yè)務進行統(tǒng)一控制、管理、

協(xié)調的服務器系統(tǒng);是實現(xiàn)家庭信息化遠程應用服務的關鍵。

4縮略語

下列縮略語適用于本文件。

API應用程序編程接口(ApplicationProgrammingInterface)

DHCP動態(tài)主機配置協(xié)議(DynamicHostConfigurationProtocol)

DISP數(shù)字身份安全平臺(Digitalidentitysecurityplatform)

ID身份證(Identification)

IP互聯(lián)網協(xié)議(InternetProtocol)

LAN局域網(LocalAreaNetwork)

MAC媒體訪問控制(MediaAccessControl)

MQTT消息隊列遙測傳輸協(xié)議(MessageQueuingTelemetryTransport)

PC個人計算機(PersonalComputer)

PPPoE以太網上的點到點協(xié)議(Point-to-PointProtocoloverEthernet)

QoS服務質量(QualityofService)

4

T/ZSPHXXXXX—XXXX

SIP會話初始協(xié)議(SessionInitiationProtocol)

SSID服務器集標識(ServiceSetIdentifier)

VLAN虛擬局域網(VirtualLocalAreaNetwork)

WAN廣域網(WideAreaNetwork)

WEP有線等效加密(WiredEquivalentPrivacy)

5平臺模型架構

數(shù)字家庭平臺架構應包括平臺和開放接口,開放接口包括服務應用接口和設備/能力接口,接口可

使用HTTPS、MQTT等傳輸協(xié)議,平臺體系架構見圖1。

圖1數(shù)字家庭平臺架構示意圖

5.1平臺

數(shù)字家庭平臺包括多種基礎功能和能力,應包括AI算力、家庭數(shù)據(jù)、家庭用戶、交互展示、分布存

儲、日志/異常。通過接口平臺可將第三方平臺、設備接入,并為用戶提供多樣化的服務。

5.2應用服務接口

服務應用接口分為服務應用開發(fā)接口和服務應用管理接口;

服務應用開發(fā)接口用于應用程序的開發(fā),包括總線接口、數(shù)據(jù)類接口、UI接口和資源務接口,服務

應用開發(fā)應明確所調用的接口;

服務應用管理接口用于管理平臺上已部署的服務應用,應包括應用注冊接口、推薦類接口、安裝接

口和評價接口,同時還應提供應用部署、監(jiān)控管理、身份認證、訪問控制、權限管理等的接口。

5.3設備/能力接口

設備/能力接口分為服務平臺接入接口和設備接入接口;

服務平臺接入接口用于連接服務應用和數(shù)字家庭平臺,應包括用戶接口、支付接口和安全接口,應

明確用戶、支付和安全的接口;

設備接入接口用于連接各種設備,應包括讀寫接口、數(shù)據(jù)分析接口、認證接口和增強接口,并提供

家庭電氣設備、邊緣網關等邊緣資源管理和標識的接口。

5

T/ZSPHXXXXX—XXXX

6平臺硬件要求

6.1平臺邊緣設備

6.1.1一般要求

平臺邊緣設備是指位于平臺邊緣,靠近用戶或數(shù)據(jù)源的設備,本節(jié)僅對邊緣家庭網關設備進行要求。

6.1.2接口要求

家庭網關接口需滿足以下要求:

a)家庭網關對上,宜采用光纖、對絞電纜、同軸電纜接入互聯(lián)網網絡;

b)家庭網關對下,需滿足以下要求:

1)應支持至少1個1000Mbit/s接口;

2)應支持Wi-Fi接入接口;

3)宜支持至少1個USB接口,并符合USB2.0及以上規(guī)范;

4)可支持電話接口;

5)可支持電視接口;

6)可提供其它有線及無線通信協(xié)議接口。

6.1.3家庭網關功能要求

家庭網關功能應符合下列要求:

a)家庭網關應支持路由工作模式、橋接工作模式、橋接路由混合工作模式三種;

b)家庭網關應支持端口綁定、VLAN綁定和路由轉發(fā)三種轉發(fā)方式;

c)家庭網關應支持家庭網絡內部各個有線和無線Wi-Fi終端之間相互訪問,數(shù)據(jù)流無需通過WAN

連接;

d)家庭網關應支持IPv4、IPv6協(xié)議棧,并支持同時運行IPv4/IPv6雙協(xié)議棧。WAN側應支持靜

態(tài)配置IP地址、DHCP、PPPoE三種方式獲取WAN連接的IP地址,LAN側應支持DHCPv4Server;

e)家庭網關應支持QoS功能,包括業(yè)務流分類和標記功能;業(yè)務流統(tǒng)計、限速和優(yōu)先級調度功能;

于下掛設備的統(tǒng)計和限速功能;

f)家庭網關應通過內置語音網關方式采用SIP協(xié)議實現(xiàn)IP電話業(yè)務。

6.2云服務器要求

云服務器應符合下列要求:

a)數(shù)字家庭平臺通過云服務器實現(xiàn)對家庭網關、物聯(lián)網網關、控制器等設備及系統(tǒng)的統(tǒng)一協(xié)調管

理;

b)云服務器可根據(jù)需求部署在互聯(lián)網數(shù)據(jù)中心或社區(qū)、住宅區(qū)等物管中心機房;

c)云服務器應提供后臺管理系統(tǒng);

d)云服務器應滿足以下基本功能:

1)接收家庭網關或物聯(lián)網網關所發(fā)送的設備狀態(tài)信息,并進行處理;

2)協(xié)調終端控制器和家庭網關或物聯(lián)網網關之間控制命令的交互。

e)云服務器設備及其部署應符合以下要求:

1)云服務器硬件性能應滿足大規(guī)模設備的同時接入、并發(fā)訪問等性能要求;

2)云服務器所部署物理環(huán)境應確保安全可靠;

3)云服務器應建立網絡及信息安全防范措施,防止非法訪問,確保數(shù)據(jù)安全。

6

T/ZSPHXXXXX—XXXX

6.3平臺交互設備要求

平臺交互設備應符合下列要求:

a)平臺交互宜采用專用控制終端設備,或運行在智能手機、平板個人計算機、訪客對講室內機等

終端設備上;

b)平臺交互控制軟件宜是專用應用程序軟件,應具有人機交互界面;

c)平臺交互應通過Wi-Fi或移動通信網絡,實現(xiàn)對受控設備的本地及遠程控制;

d)平臺交互控制程序應具備擴展性、兼容性、可移植性。

7平臺功能要求

7.1功能說明

平臺功能應能夠有效管理邊緣設備、云端資源和交互設備,應包含邊緣管理要求、云端管理要求、

交互設備管理要求。

7.2邊緣端管理要求

7.2.1一般規(guī)定

邊緣網絡管理應符合下列要求:

a)邊緣網絡管理可由運行在PC上的獨立的網絡管理系統(tǒng)軟件實現(xiàn),也可根據(jù)需要由嵌入到家庭

網關里的功能模塊實現(xiàn);

b)邊緣網絡管理軟件或模塊應對家庭網關進行遠程管理,包括以下管理功能:

1)對家庭網關上的數(shù)據(jù)、語音、視頻、QoS等功能進行部署、管理和控制;

2)對家庭網關的遠程狀態(tài)查詢、故障管理、設備配置和軟件升級;

3)對家庭網關的智能應用進行加載、配置及生命周期管理。

7.2.2設備信息管理

設備信息管理需符合下列要求:

a)設備信息管理對象應包括通用及個性化信息;

b)通用信息包括設備類型信息和設備業(yè)務能力信息;

c)設備個性化信息包括設備MAC地址、唯一ID等固定信息和IP地址信息、最近連接信息等設備

動態(tài)信息。

7.2.3網元管理

網元管理應包括故障診斷、網絡應用服務、設備認證、狀態(tài)監(jiān)視、參數(shù)配置、軟件升級、告警、設

備信息、版本/配置文件信息、業(yè)務代碼的管理,設備分組管理等能力。

7.2.4故障管理

故障管理應符合下列要求:

a)故障管理應通過管理平臺對家庭網關、及下掛設備進行故障定位;

b)故障管理應給網絡運維管理人員提供友好的故障診斷人機交互界面。

7.2.5擴展功能管理

7

T/ZSPHXXXXX—XXXX

擴展功能管理應符合下列要求:

a)邊緣網絡管理功能宜支持家庭網關軟件和網關插件管理,包括遠程安裝、升級、卸載;

b)邊緣網絡管理功能宜支持軟探針功能,并對家庭網絡質量進行采集、存儲、評估和調優(yōu)化的能

力;

c)邊緣網絡管理功能應提供報表分析和管理能力,包括:家庭網關報表、WIFI性能報表和WIFI

覆蓋報表;

d)邊緣網絡管理功能應提供對單個家庭的一鍵檢測功能,并且能夠診斷常見的家庭網絡故障。

7.3云端管理要求

云服務器應具備賬戶管理、設備管理、狀態(tài)管理、消息發(fā)送、數(shù)據(jù)同步、日志管理、升級維護及其

他等后臺管理功能模塊。各項模塊應支持以下功能:

a)每個賬戶只能管理自己家庭的家庭網關、受控終端、終端控制器等設備;

b)支持自動發(fā)現(xiàn)管理智能設備,且支持設備信息的配置、設備的添加、刪除等操作;

c)對所有數(shù)字家庭平臺設備的狀態(tài)信息進行管理和查看;

d)支持終端控制器、物聯(lián)網網關與云服務器平臺間的數(shù)據(jù)同步;

e)對云服務器的運行日志、操作日志、異常日志、安全日志進行管理;

f)通過云服務器對家庭物聯(lián)網網關、終端控制器等設備軟件系統(tǒng)進行遠程升級;

g)數(shù)字家庭平臺設備接口技術要求參照附錄A;

h)數(shù)字家庭平臺服務接口技術要求參照附錄B;

i)數(shù)字家庭平臺應具有設備物模型,設備建模方法可參考附錄C。

7.4平臺交互管理要求

平臺交互應符合下列要求:

a)平臺交互應提供用戶注冊登錄、設備管理、歷史信息管理等功能界面;

b)平臺交互應提供家居安全防范、家用電器控制、環(huán)境監(jiān)測、家庭娛樂等智能家居應用服務人機

交互操作界面;

c)平臺交互人機交互界面應符合以下特性:

1)應可對受控設備的狀態(tài)進行直觀顯示,當受控設備狀態(tài)發(fā)生改變時,應可實時更新;

2)當用戶進行操作時,系統(tǒng)界面應對用戶的操作提供清晰明確的信息反饋。

8平臺傳輸安全要求

8.1.1總體說明

平臺傳輸安全要求包括綜合信息箱系統(tǒng)安全、網絡通信安全、設備安全接入、社區(qū)網絡與家庭網絡

的安全隔離等功能。

8.1.2綜合信息箱系統(tǒng)安全

綜合信息箱操作系統(tǒng)需滿足以下要求:

a)綜合信息箱操作系統(tǒng)應進行安全加固,只開放必須端口,其他服務均必須裁剪或停止運行;

b)除操作系統(tǒng)以外的應用軟件不應以管理員身份安裝運行;

c)綜合信息箱應進行數(shù)據(jù)分級分類,并滿足GB/T35143-2017相關要求;

d)綜合信息箱系統(tǒng)服務端口不對廣域網提供服務,只對局域網安全接入設備提供網絡服務;

8

T/ZSPHXXXXX—XXXX

e)綜合信息箱應與DISP進行身份互證。

8.1.3認證與管理

設備認證以及通信安全

家庭網絡平臺應建立認證機制,對接入的終端設備進行認證,并驗證設備接入家庭網絡平臺的權限。

家庭網絡平臺應支持HTTPS/SFTP/FTPS/WSS/TLS等安全通信協(xié)議。

設備的認證信息應包括:

——設備認證密鑰;

——設備認證證書;

——設備唯一標識符。

設備的通信安全應包括:

——不能用認證密鑰加密通信數(shù)據(jù);

——使用認證密鑰與家庭網絡平臺協(xié)商臨時密鑰進行通信;

——當連接斷開后,需要重新協(xié)商臨時密鑰。

用戶身份認證

家庭網絡平臺應對訪問用戶進行身份認證,確保用戶身份合法性。只有用戶提供合法賬號和密碼才

可以使用該業(yè)務,并在認證后始終在同一設備上使用該業(yè)務。

認證過程需要提供的信息應包括:

a)賬號和密碼

——用戶通過密碼操作,才可以對網關或其它設備進行配置或管理。

——系統(tǒng)應支持至少普通用戶和管理員用戶兩級權限管理。

b)密鑰

——用于在傳輸中加密賬號和密碼。

c)用戶通過手機等設備在局域網進行通信時,家庭網絡平臺也應對訪問用戶進行身份鑒權。

WLAN網絡安全

對于采用WLAN的家庭網絡,應支持以下一種或多種無線安全協(xié)議,以保障WLAN的安全:

a)啟動或關閉SSID廣播功能;

b)靜態(tài)64/128位WEP加密;

c)MAC地址過濾功能,實現(xiàn)接入用戶的接入控制;

d)支持GB15629.1102-2003、GB15629.1104-2006中所規(guī)定的安全協(xié)議。

網絡隔離

社區(qū)網絡不應直連到家庭交換網絡,應連接具有安全接口的終端設備,如綜合信息箱計算模塊、顯

示終端等。

9

T/ZSPHXXXXX—XXXX

附錄A

(資料性附錄)

云服務接口

A.1用戶接口

云服務平臺與各設備廠家,采用云云對接的方式,使用OAuth2.0接口技術。OAuth采用HTTPS傳

輸內容來保證數(shù)據(jù)的安全性。設備廠家需要在互聯(lián)互通云上注冊賬號,需要填寫信息如下:

表1互聯(lián)互通注冊信息

描述備注是否必須

ClientID客戶端標識設備廠家分配給互聯(lián)互通接口訪問時的ID必填

ClientSecret客戶端秘鑰設備廠家分配給互聯(lián)互通接口訪問時的秘鑰必填

AccessTokenURL訪問令牌URL獲取令牌URL必填

授權賬號URL授權賬號URL必填

設備指令URL設備指令URL必填

RefreshURL刷新令牌時的URL默認使用AccesstokenURL可選

該流程采用OAuth規(guī)范,如圖A.1所示。

圖A.1OAuth規(guī)范流程

互聯(lián)互通云主動將userID(或者UUID)、AccessToken,F(xiàn)reshToken發(fā)送給廠家的設備云。設備

廠家拿到該信息后完成用戶與互聯(lián)互通云平臺的綁定關系。

{

“Token”:”xxxxx”,

“Userid”:”xxxxxx”,

10

T/ZSPHXXXXX—XXXX

“FreshToken”:”xxxxxxx”,

“Exprirein”:”172800”

}

A.2設備獲取

A.2.1設備模型

設備廠家需要在互聯(lián)互通云平臺上創(chuàng)建設備模型,如設備有哪些屬性,屬性值范圍是多少等,不通

用的設備屬性,需要與互聯(lián)互通云平臺聯(lián)合開發(fā),如圖A.2所示。

圖A.2互聯(lián)互通設備模型

A.2.2設備配網

設備配網由各廠家完成,互聯(lián)互通APP不提供設備配網綁定等功能。

A.2.3設備列表

用戶通過以下流程獲取設備列表,如圖A.3所示。

圖A.3用戶獲取設備列表流程

樣例:

{

11

T/ZSPHXXXXX—XXXX

“uuid”:”xxxxx”,

“action”:”dev_list”,

“device_list”:[

{

“device_id”:xxxx,

“device_name”:”開關”,

“type”:”開關”

},

{

“device_id”:xxxx,

“device_name”:”空調”,

“type”:”空調”

},

]

}

A.2.4設備管理

不同設備廠家需要通過以下流程進行管理,如圖A.4所示。

圖A.4設備管理流程

樣例:

{

“uuid”:”xxxxx”,

“action”:”dev_set”,

12

T/ZSPHXXXXX—XXXX

“device_id”:xxxx,

“properties”:[

{

“property_id”:1,

“property_value”:0

},

{

“property_id”:2,

“property_value”:20

},

]

}

A.2.5設備操作

不同設備廠家需要相互管理對方設備時,必須通過互聯(lián)互通云平臺來訪問,互聯(lián)互通云平臺需要過

濾請求方發(fā)起的設備,只返回第三方廠家的設備,如圖A.5所示。

圖A.5設備操作流程

樣例:

{

“uuid”:”xxxxx”,

“action”:”dev_set”,

13

T/ZSPHXXXXX—XXXX

“device_id”:xxxx,

“properties”:[

{

“property_id”:1,

“property_value”:0

},

{

“property_id”:2,

“property_value”:20

},

]

}

14

T/ZSPHXXXXX—XXXX

附錄B

(資料性附錄)

開放服務接口

B.1開放服務接口

數(shù)字家庭平臺為開放服務平臺提供插件接口,第三方服務平臺可開發(fā)插件,發(fā)布到數(shù)字家庭服務互

聯(lián)互通平臺,第三方服務平臺通過以下流程完成插件導入:

a)第三方服務平臺申請開發(fā)的插件類型;

b)數(shù)字家庭服務平臺提供開發(fā)API;

c)第三方服務平臺完成插件開發(fā)后,將插件部署到數(shù)字家庭服務平臺。

圖B.1開放服務接口流程

B.2用戶信息授權

當?shù)谌椒詹渴鸬綌?shù)字家庭服務平臺后,服務需獲取登錄功能,并采用數(shù)字家庭服務平臺的授

權接口作為唯一的登錄接口。

第三方服務獲取數(shù)字家庭用戶信息的流程如下:

a)第三方服務請求使用數(shù)字家庭服務平臺接口登錄授權;

b)數(shù)字家庭服務平臺返回登錄結果,如果授權成功,則返回身份令牌;

c)第三方服務使用用戶身份令牌,通過第三方服務后臺,向數(shù)字家庭服務平臺查詢用戶信息;

d)數(shù)字家庭服務平臺返回用戶信息給第三方服務后臺,再返回給服務。

15

T/ZSPHXXXXX—XXXX

圖B.2用戶信息授權流程

16

T/ZSPHXXXXX—XXXX

附錄C

(資料性附錄)

設備物模型抽象

C.1設備抽象原則

設備物模型抽象的基本邏輯架構如圖C.1所示,要素說明如下:

a)設備(device):指應用節(jié)點,可以通過不同的服務集合來描述其功能集;

b)服務(service):指一個獨立而有意義的功能組,該功能組可以在不同類型的應用節(jié)點間復用;

c)屬性(property):描述應用節(jié)點的狀態(tài)和功能的最小單位;

d)方法(action):用以實現(xiàn)服務的特定功能,這類功能不能通過單個屬性的讀寫來完成;

e)事件(event):應用節(jié)點主動上報的特定信息。

圖C.1數(shù)據(jù)模型邏輯架構圖

C.2屬性

屬性是服務的一個基本組成單位,屬性的目的和使用規(guī)則需滿足以下要求:

a)屬性的描述應至少包含下列三項:

1)屬性定義(type):應保證唯一性;且屬性類型的定義需符合小駝峰規(guī)則(lowerCamelCase);

屬性類型的命名規(guī)則建議使用"<xxxVx>":"<property>":"<name>":"<propertyUUID>"格

式,具體規(guī)范見表C.1:

表C.1屬性定義明細

屬性名稱備注

xxxVx

property保留字

name屬性名稱

propertyUUID屬性的唯一使用32bit的無符號整型描述,其中高位的8bits用來為固定值”00000010B”,

標識標識該內容為property,剩余的24bits被用來標識屬性。

注:本文件中的“xxx”為自定義標識符。

2)屬性值數(shù)據(jù)類型(dataType):可以為單一屬性指定多個數(shù)據(jù)類型;

3)訪問權限(access):應包含讀(R),寫(W),通知(N)。

b)屬性的描述還可以包含其它的字段:

1)描述(description):用以說明屬性的目的等;

2)取值范圍(valueRange):整型和浮點型屬性取值范圍的約束;

3)步進約束(step):整型和浮點型的屬性的步進約束;

17

T/ZSPHXXXXX—XXXX

4)精度(precision):整型和浮點型數(shù)據(jù)的精度;

5)取值列表(valueList):枚舉類型屬性的取值范圍的約束,每一枚舉值分配一特定索引,

建議索引從0開始;

6)單位(units):整型和浮點型數(shù)據(jù)的單位,可以為一個屬性指定多個單位;

7)最大長度(maxLength):字符串類型屬性的最大長度約束;

8)最小長度(minLength):字符串類型屬性的最小長度約束;

9)格式(format):字符串類型屬性的內容和格式的約束,例如日期,統(tǒng)一資源標識符,IP地

址等;

10)模式(pattern):字符串類型屬性的特定樣式的約束,使用正則表達式表示;

11)默認值(default):屬性的默認值。

c)數(shù)組與結構體類型的屬性其包含的數(shù)據(jù)會被分配一個索引進行標識。

C.3方法

方法指為實現(xiàn)服務特定功能而觸發(fā)的應用層動作的指令,方法的定義需滿足以下規(guī)則:

a)方法的輸入參數(shù)和輸出參數(shù)可以為空;

b)方法的名稱應保持唯一性,即方法的名稱在本文件定義的所有方法中應具有不可重復性;

c)不同的方法應解耦,即本文件內定義的方法不能依賴于另一個方法的執(zhí)行結果;

d)同一服務內不應包含具有相同功能的兩個方法,即在同一服務內的方法應該具有不同的功能;

e)方法的定義需要包含如下字段:

1)方法定義(type):其命名需符合小駝峰規(guī)則,方法類型的命名規(guī)則建議使用

"<xxxVx>":"<action>":"<name>":"<actionUUID>"的格式,具體規(guī)范見表C.2:

表C.2方法定義明細

屬性名稱備注

xxxVx

action保留字

name屬性名稱

actionUUI屬性的唯一使用32bit的無符號整型描述,其中高位的8bits用來為固定值”0000011B”,標

D標識識該內容為方法,剩余的24bits被用來標識操作。

2)描述(description):方法的描述,用以說明方法的目的或者使用規(guī)則等;

3)輸入參數(shù)(inParamter):輸入參數(shù)列表,可以為0或者多個;輸入參數(shù)列表中每一參數(shù)

分配一索引,該索引從1開始分配;

4)輸出參數(shù)(outParamter):輸出參數(shù)列表,可以為0或者多個;輸出參數(shù)列表中每一參數(shù)

分配一索引,該索引從1開始分配。

C.4事件

事件一般指應用節(jié)點需要主動推送給特定類型的信息。事件的類型包括:一般消息(message,例

如設備上線/下線)、告警消息(alert,例如冰箱門未關)和設備故障消息(fault,例如壓縮機不工作)。

用戶側主動訂閱后發(fā)生的通知不在事件定義的范圍內。

事件的定義需要包含以下字段:

a)事件定義(type):其命名需符合小駝峰規(guī)則,事件類型的命名規(guī)則建議使用

"<xxxVx>":"<event>":"<name>":"<eventUUID>"的格式,具體規(guī)范見表C.3:

18

T/ZSPHXXXXX—XXXX

表C.3事件定義明細

屬性名稱備注

xxxVx

event保留字

name屬性名稱

eventUUI屬性的唯一標使用32bit的無符號整型描述,其中高位的8bits用來為固定值”00000100B”,

D識標識該內容為事件,剩余的

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論