版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領(lǐng)
文檔簡介
IV餐飲用戶燃氣報警控制系統(tǒng)遠程監(jiān)控裝置通訊協(xié)議及平臺接口標準范圍本標準規(guī)定了燃氣泄漏報警器的相關(guān)術(shù)語、符號和縮略語定義;也規(guī)定了NB-IoT、5G、4G、3G、2G等終端設(shè)備的通信協(xié)議和通信加密要求;還規(guī)定了終端設(shè)備的編碼規(guī)則及設(shè)備的接入要求。本標準適用于獨立式燃氣泄漏報警器和可燃氣體報警控制器的4G、NB-IoT等智能通信功能實現(xiàn),以及報警器平臺的終端設(shè)備系統(tǒng)接入。本通訊協(xié)議支持NB-IoT、5G、4G等物聯(lián)網(wǎng)通訊協(xié)議。規(guī)范性引用文件下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中,注日期的引用文件,僅該日期對應(yīng)的版本適用于本文件;不注日期的引用文件,其最新版本(包括所有的修改單)適用于本標準。GB/T17964-2000信息技術(shù)安全技術(shù)n位塊密碼算法的操作方式GB/T22239-2008信息安全技術(shù)信息系統(tǒng)安全等級保護基本要求GB15322.1-2019可燃氣體探測器第1部分:工業(yè)及商業(yè)用途點型可燃氣體探測器基于窄帶物聯(lián)網(wǎng)(NB-IoT)技術(shù)的燃氣智能抄表系統(tǒng)(中國城市燃氣協(xié)會發(fā)布)GB15322.2—2019可燃氣體探測器第2部分:家用可燃氣體探測器GB16808-2008可燃氣體報警控制器術(shù)語和定義下列術(shù)語和定義適用于本文件。IoT通訊平臺IoT通訊平臺稱主站,是采用蜂窩移動通信(含2G、3G、4G、NB-IoT)方式完成對報警器的數(shù)據(jù)采集、傳輸、控制。物聯(lián)網(wǎng)報警器以傳感器為基礎(chǔ),加裝電子控制電路,具有數(shù)據(jù)采集、存儲等功能,并采用物聯(lián)網(wǎng)通信技術(shù)進行數(shù)據(jù)傳輸?shù)膱缶鳌B設(shè)備NB-IoT終端設(shè)備的簡稱,特指采用NB-IoT技術(shù),可直接與主站系統(tǒng)互聯(lián)的終端設(shè)備。NB設(shè)備指采用NB-IoT接口通訊的燃氣泄漏報警器。4G設(shè)備4G終端設(shè)備的簡稱,特指采用4G通訊技術(shù),可直接與主站系統(tǒng)互聯(lián)的終端設(shè)備。4G設(shè)備包含獨立式燃氣泄漏報警器和可燃氣體報警控制器。數(shù)據(jù)要求數(shù)據(jù)類型協(xié)議描述中純數(shù)字均為10進制,以0x開頭均為16進制,選填數(shù)據(jù)必須占位,占位符0x00。短整型:2字節(jié),小端對齊,低字節(jié)在前整型:4字節(jié),小端對齊,低字節(jié)在前浮點數(shù):4字節(jié),IEEE754標準ASCII碼:高字節(jié)在前BCD碼:高字節(jié)在前數(shù)據(jù)傳輸約定一次完整的通訊過程有以下三種情況觸發(fā):第一種情況,達到設(shè)定上報周期時間時觸發(fā),報警器自動上報數(shù)據(jù);第二種情況,發(fā)現(xiàn)實時報警時觸發(fā),報警器上報報警信息;第三種情況,現(xiàn)場人員長按鍵5秒觸發(fā),報警器臨時性上報數(shù)據(jù)。發(fā)送指令30秒后未收到回復(fù)指令,判定為通訊超時,需重新發(fā)送,重發(fā)次數(shù)不超過3次。連續(xù)3次發(fā)送超時,判定為失敗。編碼規(guī)則幀格式幀格式見表1。表1幀格式說明域名稱長度說明幀頭1(HEX)0x68幀長度2(HEX)從協(xié)議版本號到數(shù)據(jù)域數(shù)據(jù)的字節(jié)長度。協(xié)議版本號1(HEX)0x20:表示2.0版本,此協(xié)議版本為2.0密鑰版本號1(HEX)0x10:表示1.0密鑰版本,默認地址8(BCD)小端模式,控制器地址,獨立式報警器為報警器地址??刂拼a1(HEX)命令碼2(HEX)幀序號2(HEX)從0x0001開始計算,累加到0xFFFF后從0x0001重新開始計數(shù),序號用于多幀數(shù)據(jù)傳輸校驗,其它幀固定填1.數(shù)據(jù)域N(HEX)數(shù)據(jù)域加密時,如果原始數(shù)據(jù)長度為0,則需填充16字節(jié),長度為0x10;CRC162(HEX)CRC16,從起始符至數(shù)據(jù)域的結(jié)束(需要加密處理的需先進行加密處理,再計算校驗碼)結(jié)束符1(HEX)0x16控制碼控制碼見表2。表2控制碼說明位定義位01備注傳輸方向B0下行上行是否加密B1不加密加密是否結(jié)束幀B2未結(jié)束結(jié)束是否需要應(yīng)答B(yǎng)3無需應(yīng)答需要應(yīng)答發(fā)起標志B4命令發(fā)起端命令應(yīng)答端讀寫標志B5讀命令寫命令配置命令有效B6-7保留下行:指主站向終端設(shè)備發(fā)送數(shù)據(jù);上行:指終端設(shè)備向主站發(fā)送數(shù)據(jù);對要求加密的命令數(shù)據(jù),如果按明文發(fā)送,應(yīng)判定該數(shù)據(jù)無效。對數(shù)據(jù)域需要加密的命令幀,在發(fā)送命令時需先對數(shù)據(jù)域加密,再計算校驗碼。報警器接收到命令幀后,需先判斷校驗碼是否正確。如果校驗不合格,為無效命令幀。如果校驗碼正確后再解密,解密數(shù)據(jù)后需要首先根據(jù)數(shù)據(jù)填充規(guī)則(數(shù)據(jù)末端必須至少有0x80,如果0x80后面還有數(shù)據(jù)必須為0x00)判斷數(shù)據(jù)加密的有效性,通過后再根據(jù)協(xié)議解析數(shù)據(jù)格式是否符合要求。設(shè)備編碼設(shè)備編碼規(guī)則定義見表3。通信數(shù)據(jù)流與實際設(shè)備編碼順序?qū)?yīng),當實際設(shè)備編碼不足8字節(jié)時,在高端補零。表3設(shè)備編碼規(guī)則定義數(shù)據(jù)內(nèi)容說明廠家代碼(1字節(jié))各設(shè)備廠商根據(jù)“廠家代碼約定”填寫設(shè)備類型(1字節(jié))1--工商業(yè)報警器2--家用報警器生產(chǎn)年月(2字節(jié))生產(chǎn)序列號(4字節(jié))廠家代碼約定說明:廠家代碼分配由對接人處統(tǒng)一分配管理廠家代碼廠家1011121314校驗校驗的算法為:從起始符開始,到數(shù)據(jù)區(qū)結(jié)束,所有字節(jié)的CRC16校驗。CRC16:多項式采用CCITT:X16+X12+X5+1,種子:0x1D0F。CRC16算法如下:CRC16算法示例說明幀序號幀序號從0x01開始,當只有1幀時,幀序號固定為0x01,當有多幀時,幀序號從0x01開始依次遞增。每次會話的上下行幀序號須保持一致。數(shù)據(jù)區(qū)根據(jù)規(guī)范,數(shù)據(jù)區(qū)數(shù)據(jù)參見命令定義。命令詳情命令列表說明見表4。表4命令列表說明命令碼命令說明備注0x0102網(wǎng)絡(luò)參數(shù)(下行)網(wǎng)絡(luò)參數(shù)設(shè)置。0x0103上報周期(下行)上報周期參數(shù)設(shè)置。0x0104報警門限(下行)報警門限參數(shù)設(shè)置。0x0301數(shù)據(jù)上報(上行)0x0001tcp注冊(上行)tcp時需要0x0002tcp心跳(上行)tcp時需要網(wǎng)絡(luò)參數(shù)網(wǎng)絡(luò)參數(shù)的要求見表5。表5網(wǎng)絡(luò)參數(shù)名稱字節(jié)長度說明網(wǎng)址長度1HEX表示,最大值80網(wǎng)址NASCII表示端口長度1HEX表示,最大值10,沒有為0端口NASCII表示用戶名長度1HEX表示,用戶名長度(最大不要超過30個),沒有為0用戶名NASCII表示,如:“admin”密碼(接入點)長度1HEX表示,密碼長度(最大不要超過30個),沒有為0密碼(接入點)NASCII表示如,“123456”(CMMTM)APN長度1HEX表示,最大值30,沒有為0APNN應(yīng)答的要求見表6。表6應(yīng)答名稱字節(jié)長度說明返回碼10x00--成功0x01--參數(shù)錯0x02--存儲失敗0x03--校準失敗0x04--校準值超出范圍0x05--其它錯誤預(yù)留4預(yù)留上報周期上報周期參數(shù)設(shè)定的要求見表7。表7上報周期名稱字節(jié)長度說明上報周期參數(shù)長度1HEX表示上報周期11上報周期:1HEX單位0-天,1-月+1HEX次數(shù)。+時間6BCD碼(上報數(shù)據(jù)起始時間)3HEX預(yù)留。應(yīng)答的要求見表6。報警門限定報警門限設(shè)定的要求見表8。表8報警門限名稱數(shù)據(jù)長度說明報警參數(shù)長度1HEX表示,必須限制用戶權(quán)限1HEX表示,地址:1-0xfe0-表示廣播地址1傳感器類型見表174HEX表示,float,報警門限值4預(yù)留應(yīng)答的要求見表6。主動上傳主動上傳的要求見表9。表9主動上傳要求名稱數(shù)據(jù)長度說明設(shè)備類型1HEX1--工商業(yè)報警器2--家用報警器硬件版本號2BCD低字節(jié)在前,例:0x10,0x00表示1.0,0xFFFF表示無效軟件版本號2BCD低字節(jié)在前,例:0x10,0x00表示1.0,0xFFFF表示無效信號強度2HEXNB:填RSSI,有符號數(shù);例:-110dBm0xFF92,2G/3G/4G/LTE:填信號強度值。信噪比2HEXNB:填SNR,有符號數(shù)。0xFFFF表示無效。信號接收功率2HEXNB:填RSRP,0xFFFF表示無效數(shù)據(jù)條數(shù)1HEX表示數(shù)據(jù)數(shù)量。探頭數(shù)據(jù)1N探頭數(shù)據(jù)詳情見表10探頭數(shù)據(jù)2N......N......表10探頭數(shù)據(jù)名稱數(shù)據(jù)長度數(shù)據(jù)類型說明探頭地址1HEX從1開始,int類型依次遞增,系統(tǒng)式報警器有效,獨立式報警器填0xFF。當前采集時間7BCD低位在前高位在后,無效全0xFF探頭硬件版本號2BCD低字節(jié)在前,例:0x10,0x00表示1.0,無效0xFFFF探頭軟件版本號2BCD低字節(jié)在前,例:0x10,0x00表示1.0,無效0xFFFF探頭狀態(tài)1HEX0x00--正常;Bit0存儲器故障狀態(tài)0--正常1--故障Bit1藍牙故障狀態(tài)0--正常1--故障Bit2與切斷閥通訊狀態(tài)0--正常1--故障Bit3切斷閥電池狀態(tài)0--正常1--欠壓Bit4時鐘狀態(tài)0--正常1--故障Bit5探頭與控制器連接狀態(tài)0--正常1--失聯(lián)其它--預(yù)留。閥門電池電壓1HEX單位V,1位小數(shù),無效0xFF傳感器數(shù)據(jù)數(shù)量1HEX傳感器數(shù)據(jù)1見表11......傳感器數(shù)據(jù)N見表11表11傳感器數(shù)據(jù)傳感器檢測類型1HEX傳感器類型見表17傳感器狀態(tài)1HEX0x00--正常;0x01--傳感器故障;0x02--報警;家用0x03--低限報警;工商業(yè)0x04--高限報警;工商業(yè)0x05--壽命報警;0x06--0xfe--預(yù)留。檢測值4HEXfloat;無效全0xFF報警門限參數(shù)4HEXfloat;無效全0xFF檢測單位1HEX檢測值對應(yīng)單位見表18傳感器溫度4HEXfloat;無效全0xFF濕度4HEXfloat;無效全0xFF備用7HEX無效全0xFF。主動上報應(yīng)答的要求見表12。表12應(yīng)答幀的要求名稱字節(jié)長度說明返回碼1(HEX)0x00--成功0x01--參數(shù)錯0x02--存儲失敗0x03--校準失敗0x04--校準值超出范圍0x05--其它錯誤預(yù)留4預(yù)留tcp注冊tcp注冊的要求見表13。表13注冊包名稱字節(jié)長度說明設(shè)備類型1HEX1--工商業(yè)報警器2--家用報警器硬件版本號2BCD低字節(jié)在前,例:0x10,0x00表示1.0,0xFFFF表示無效軟件版本號2BCD低字節(jié)在前,例:0x10,0x00表示1.0,0xFFFF表示無效CCID20ASCII設(shè)備端通訊模組的CCID信息,若無此信息由FF填充預(yù)留4HEX預(yù)留tcp注冊應(yīng)答的要求見表14。表14應(yīng)答幀的要求名稱字節(jié)長度說明返回碼1(HEX)0x00--成功0x01--參數(shù)錯0x02--存儲失敗0x03--校準失敗0x04--校準值超出范圍0x05--其它錯誤預(yù)留4預(yù)留tcp心跳tcp心跳的要求見表15。表15心跳包名稱字節(jié)長度說明信號強度2HEXNB:填RSSI,有符號數(shù);例:-110dBm0xFF92,2G/3G/4G/LTE:填信號強度值。信噪比2HEXNB:填SNR,有符號數(shù)。0xFFFF表示無效。信號接收功率2HEXNB:填RSRP,0xFFFF表示無效預(yù)留4HEX預(yù)留tcp心跳應(yīng)答的要求見表16。表16心跳應(yīng)答幀的要求名稱字節(jié)長度說明返回碼1(HEX)0x00--成功0x01--參數(shù)錯0x02--存儲失敗0x03--校準失敗0x04--校準值超出范圍0x05--其它錯誤預(yù)留4預(yù)留狀態(tài)類型表表17傳感器類型名稱說明傳感器類型0:甲烷,1:氫氣,2:人工煤氣,3:液化氣,4:油制氣,5:丙烷,6:己烷,7:環(huán)氧乙烷,8:硅烷,9:氯甲烷,10:乙炔,11:乙烯,12:丙烯,13:苯乙烯,14:甲醇,15:乙醇,16:異丙醇,17:苯,18:甲苯,19:二甲苯,20:丙酮,21:丁酮,22:甲醛,23:乙醚,24:二甲醚,25:石油醚,26:乙酸乙酯,27:乙酸異戊酯,28:汽油,29:柴油,30:可燃氣體,31:航空煤油,32:四氫呋喃,33:丙烯腈,34:DMF,35:氨氣,36:氧氣,37:氯氣,38:一氧化碳,39:二氧化碳,40:一氧化氮,41:二氧化氮,42:二氧化硫,43:硫化氫,44:氯化氫,45:氰化氫,46:磷化氫,47:氟化氫,48:混合氣,49:溫度,50:壓力表18單位含義名稱說明單位1:%LEL,2:%VOL,3:PPM,4:μmol/mol,5:mg/m3,6:%RH,7:m,8:m/s,9:km/h,10:LX,11:Pa,12:DB,13:m3數(shù)據(jù)交換內(nèi)容基本數(shù)據(jù)點位信息映射到地圖上到具體的位置,同一個監(jiān)測點位下可以綁定多個燃氣泄漏報警器設(shè)備,不同的監(jiān)測點位以監(jiān)測點位編碼區(qū)分。設(shè)備信息燃氣泄漏報警器設(shè)備信息。預(yù)警信息燃氣泄漏報警器設(shè)備上報的預(yù)警信息。實時采集記錄燃氣泄漏報警器設(shè)備上報的實時采集記錄。信息實體點位信息字段字段名稱字段類型字段說明domainId域ID數(shù)字固定分配orgCode組織編碼文本固定分配orgName組織名稱文本固定分配goverCode行政編碼文本省市區(qū)街道4級地址,編碼參考國家行政區(qū)劃編碼,保留12位長度goverName行政名稱文本省市區(qū)街道m(xù)onitorCode點位編碼文本點位唯一標識monitorType監(jiān)測類別數(shù)字固定值:100001(用氣監(jiān)測)monitorSubType點位類型數(shù)字數(shù)據(jù)字典:101monitorName點位名稱文本根據(jù)居民和非居情況,非居點位輸入店招名稱,例如:建華飯店、叫了只炸雞(灌口總店),居民點位輸入用戶聯(lián)系人,例如:黃永春;address定位地址文本基于GIS地圖的定位地址detailAddress詳細地址文本具體位置信息,包括街道門牌號等,例如:廈門市湖里區(qū)金山西里127號301;lng經(jīng)度浮點火星坐標系GCJ-02lat緯度浮點火星坐標系GCJ-02linkMan聯(lián)系人文本該監(jiān)測點位的聯(lián)系人姓名,例如:李冰心;linkPhone聯(lián)系電話文本該聯(lián)系人的手機號(11位手機號),發(fā)生告警時會發(fā)送短信通知到該手機號,例如gasType燃氣種類數(shù)字數(shù)據(jù)字典:118gasSupplier供氣企業(yè)數(shù)字數(shù)據(jù)字典:119userType用戶種類數(shù)字數(shù)據(jù)字典:120industry所屬行業(yè)數(shù)字數(shù)據(jù)字典:121property所屬物業(yè)文本具體的物業(yè)公司propertyPhone物業(yè)電話文本物業(yè)公司電話note備注文本設(shè)備信息字段字段名稱字段類型字段說明domainId域ID數(shù)字固定分配orgCode組織編碼文本固定分配orgName組織名稱文本固定分配goverCode行政編碼文本省市區(qū)街道4級地址,編碼參考國家行政區(qū)劃編碼,保留12位長度goverName行政名稱文本省市區(qū)街道devCode設(shè)備編號文本廠家設(shè)備上的唯一識別號,系統(tǒng)會以該號進行數(shù)據(jù)采集對應(yīng);如果存在多個探頭的情況下,設(shè)備編號后綴標注“-1、-2”例如:81108222206-1、81108222206-2devName設(shè)備名稱文本默認填寫點位名稱,如果存在多個探頭的情況下,點位名稱后綴標注“-1、-2”例如:建華飯店-1、建華飯店-2;devType設(shè)備類型數(shù)字固定值:102002(燃氣泄漏報警器)monitorCode點位編碼文本所屬點位唯一標識address定位地址文本基于GIS地圖的定位地址factory設(shè)備廠家數(shù)字數(shù)據(jù)字典:116model設(shè)備型號數(shù)字數(shù)據(jù)字典:117manufactureDate出廠日期文本如:2022-11-11validPeriod有效周期數(shù)字傳感器有效期年限,比如:3年location安裝位置文本值如下:廚房吊頂、廚房、儲藏室、儲瓶間、浴室、陽臺、過道、戶外、熱水器旁、廠房內(nèi)、操作間、車間、其他;maintenanceCompany維保單位文本售后聯(lián)系單位maintenanceMan維保聯(lián)系人文本售后聯(lián)系人maintenancePhone維保電話文本售后聯(lián)系電話lng經(jīng)度浮點火星坐標系GCJ-02)lat緯度浮點火星坐標系GCJ-02)switchValve是否有切斷閥數(shù)字設(shè)備是否帶有切斷閥,是:1,否:0note備注文本預(yù)警信息字段字段名稱字段類型字段說明domainId域ID數(shù)字固定分配warningId預(yù)警ID文本預(yù)警唯一標識devCode設(shè)備編號文本設(shè)備信息中的設(shè)備編號warningType預(yù)警類型數(shù)字數(shù)據(jù)字典:103warningTime預(yù)警時間時間設(shè)備產(chǎn)生預(yù)警的時間uploadTime上報時間時間系統(tǒng)接收到預(yù)警的時間dataCode預(yù)警監(jiān)測編碼文本預(yù)警指標編碼,如:CH4,C3H8,CO等dataName預(yù)警監(jiān)測名稱文本預(yù)警指標名稱,如:甲烷,丙烷,一氧化碳等dataValue預(yù)警監(jiān)測值文本預(yù)警的值dataUnit預(yù)警監(jiān)測單位文本預(yù)警指標對應(yīng)的單位實時采集記錄字段字段名稱字段類型字段說明domainId域ID數(shù)字固定分配devCode設(shè)備編號文本設(shè)備信息中的設(shè)備編號devStatus設(shè)備狀態(tài)數(shù)字設(shè)備采集時的狀態(tài),數(shù)據(jù)字典:112uploadTime上報時間時間系統(tǒng)收到采集數(shù)據(jù)的時間uploadInfo上報詳情文本設(shè)備采集的指標數(shù)據(jù),JOSN對象數(shù)組格式,每一個對象需包括dataCode(采集指標編碼)、dataName(采集指標名稱)、dataValue(采集指標值)、dataUnit(采集指標單位)四個屬性。數(shù)據(jù)字典名稱編碼參照值監(jiān)測類型100001用氣監(jiān)測點位類型101001居民點位類型101002政府點位類型101003學校點位類型101004醫(yī)院點位類型101005商業(yè)點位類型101006工業(yè)點位類型101007酒店點位類型101008非居其他設(shè)備類型102002燃氣泄漏報警器預(yù)警類型103008燃氣泄漏預(yù)警類型103023設(shè)備離線預(yù)警類型103024燃氣超低限濃度預(yù)警類型103025燃氣超高限濃度預(yù)警類型103026壽命告警預(yù)警類型103027一氧化碳泄漏預(yù)警類型103028傳感器故障預(yù)警類型103029存儲器故障預(yù)警類型103030切斷閥通訊故障預(yù)警類型103031切斷閥電池故障預(yù)警類型103032報警器故障預(yù)警類型103033藍牙故障用氣性質(zhì)107001居民用氣性質(zhì)107002非居設(shè)備狀態(tài)112001正常設(shè)備狀態(tài)112002預(yù)警設(shè)備狀態(tài)112003故障設(shè)備狀態(tài)112004離線點位狀態(tài)113001正常點位狀態(tài)113002預(yù)警點位狀態(tài)113003故障點位狀態(tài)113004離線設(shè)備廠家116001廠家A設(shè)備廠家116002廠家B設(shè)備型號117100MODEL-1燃氣種類118001天然氣燃氣種類118002液化石油氣供氣企業(yè)119001廈門HR燃氣有限公司供氣企業(yè)119002廈門中油鷺航油氣有限公司供氣企業(yè)119003廈門集順石油液化氣有限公司供氣企業(yè)119004廈門華達石化工程有限公司供氣企業(yè)119005廈門市同安金裕盛液化氣有限公司供氣企業(yè)119006廈門市杏泰液化氣有限公司供氣企業(yè)119007廈門市同氣燃氣有限公司用戶種類120001一般居民用戶種類120002超高層居民用戶種類120003商業(yè)用戶用戶種類120004工業(yè)用戶所屬行業(yè)121001普通居民所屬行業(yè)121002機關(guān)單位所屬行業(yè)121003醫(yī)院所屬行業(yè)121004學校所屬行業(yè)121005綜合體所屬行業(yè)121006公共福利所屬行業(yè)121007文旅酒店所屬行業(yè)121008商務(wù)餐飲所屬行業(yè)121009特種服務(wù)所屬行業(yè)121010廠礦企業(yè)所屬行業(yè)121011其它處置反饋124001有效告警處置反饋124002設(shè)備誤報處置反饋124003用戶測試處置反饋124004鋼瓶換氣處置反饋124009其他平臺接口格式要求接口分類本文件接口遵循RESTfulAPI規(guī)范,數(shù)據(jù)接口包括外部檔案數(shù)據(jù)同步、預(yù)警數(shù)據(jù)推送、預(yù)警處置三類。接口格式接口描述基于如下基本格式:WebService::=<METHOD><ENTRY>[<PARAM>][<HEADER>][<STREAM>]各字段的含義如下表所示。HTTP請求的返回結(jié)果包含兩部分:一部分為HTTP消息的狀態(tài)碼(StatusCode),表示響應(yīng)的狀態(tài);另一部分為HTTP請求的消息體,消息體默認采用JSON格式進行封裝。字段含義<METHOD>HTTP請求的方法,本接口中使用到的值有GET,POST,PUT和DELETE,名取值的含義參考HTTP協(xié)議。<ENTRY>Web服務(wù)接口的入口地址。<PARAM>可選參數(shù),用以傳遞少量的參數(shù)信息。<HEADER>HTTP請求的消息頭部。<STREAM>可選的附加流信息,用以傳遞大量的參數(shù)信息。所有接口定義格式說明如下:接口名:接口的名稱;說明:對接口內(nèi)容的描述;調(diào)用格式:調(diào)用web服務(wù)時的語法格式;語義:對調(diào)用格式的解釋:調(diào)用結(jié)果:web服務(wù)調(diào)用結(jié)果,包括成功狀態(tài)和失敗狀態(tài)的下的響應(yīng)信息。如無特殊說明,所有Web服務(wù)接口調(diào)用時都應(yīng)完成接口簽名。簽名格式見下表:參數(shù)名稱格式必填說明startstring是00request-methodstring是請求類型,按https標準執(zhí)行.PUT/DELETE/POST/GETcontent-typestring是請求內(nèi)容的類型sign-secretstring是應(yīng)用服務(wù)系統(tǒng)授權(quán)密鑰access-tokenstring是應(yīng)用服務(wù)系統(tǒng)授權(quán)Tokenaccess-idstring是應(yīng)用服務(wù)系統(tǒng)授權(quán)應(yīng)用編號bodystring是傳輸?shù)臄?shù)據(jù)流endstring是00簽名算法采用:HmacSHA,是一種基于密鑰的報文完整性的驗證方法,不可逆加密,其安全性是建立在Hash加密算法基礎(chǔ)上的。它要求通信雙方共享密鑰、約定算法、對報文進行Hash運算,形成固定長度的認證碼。通信雙方通過認證碼的校驗來確定報文的合法性。HMAC是密鑰相關(guān)的哈希運算消息認證碼(Hash-basedMessageAuthenticationCode),HMAC運算利用哈希算法,以一個密鑰和一個消息為輸入,生成一個消息摘要作為輸出。HTTP狀態(tài)碼常用的HTTP狀態(tài)碼表示及含義見下表,未列舉狀態(tài)碼的名稱及含義參考HTTP協(xié)議的定義。狀態(tài)碼編號狀態(tài)碼名稱含義200OK請求己成功。201Created對象或資源己成功創(chuàng)建。202Accepted操作己被成功接受。302Found重定向跳轉(zhuǎn)。400BadRequest請求的內(nèi)容丟失或不合法。401Unauthorized當前請求需要用戶驗證。404NotFound請求的內(nèi)容不存在.405MethodNotAllowed客戶端請求中的方法被禁止。409Conflict訪問沖突,訪問資源已被上鎖或可能導致服務(wù)器內(nèi)部狀態(tài)出錯。415UnsupportedMediaType服務(wù)器無法處理請求附帶的媒體格式。500InternalServerError服務(wù)器出現(xiàn)內(nèi)部錯誤,無法正確響應(yīng)請求。503ServiceUnavailable服務(wù)器服務(wù)暫不可用。平臺接口信息監(jiān)測點位新增接口名:point/add說明:新增監(jiān)測點位檔案調(diào)用格式:POST/qj-ant-monitor/v1/openapi/point/add<STREAM>語義:創(chuàng)建監(jiān)測點位。附加流<STREAM>指定該點位所涉及的相關(guān)信息,包括但不限于:點位名稱、點位編碼、點位類型、點位地址、點位聯(lián)系人等,支持JSON格式。調(diào)用結(jié)果:成功狀態(tài):返回HTTP狀態(tài)碼為200。失敗狀態(tài):返回失敗對應(yīng)的HTTP狀態(tài)碼及采用JSON封裝的響應(yīng)結(jié)果。響應(yīng)結(jié)果包含失敗原因,具體狀態(tài)碼參見目錄8.3。監(jiān)測點位編輯接口名:point/edit說明:編輯監(jiān)測點位檔案調(diào)用格式:POST/qj-ant-monitor/v1/openapi/point/edit<STREAM>語義:更新指定點位編碼的點位檔案信息。附加流<STREAM>為更新后的數(shù)據(jù)對象,支持JSON格式。調(diào)用結(jié)果:成功狀態(tài):返回HTTP狀態(tài)碼為200。失敗狀態(tài):返回失敗對應(yīng)的HTTP狀態(tài)碼及采用JSON封裝的響應(yīng)結(jié)果。響應(yīng)結(jié)果包含失敗原因,具體狀態(tài)碼參見目錄8.3。監(jiān)測點位刪除接口名:point/del說明:刪除監(jiān)測點位,同時會級聯(lián)刪除該點位綁定的所有設(shè)備。調(diào)用格式:DELETE/qj-ant-monitor/v1/openapi/point/del?domainId={domainId}&monitorCode={monitorCode}語義:刪除指定點位編碼的點位檔案信息。調(diào)用結(jié)果:成功狀態(tài):返回HTTP狀態(tài)碼為200。失敗狀態(tài):返回失敗對應(yīng)的HTTP狀態(tài)碼及采用JSON封裝的響應(yīng)結(jié)果。響應(yīng)結(jié)果包含失敗原因,具體狀態(tài)碼參見目錄8.3。設(shè)備新增接口名:device/add說明:新增監(jiān)測設(shè)備檔案調(diào)用格式:POST/qj-ant-monitor/v1/openapi/device/add<STREAM>語義:創(chuàng)建監(jiān)測設(shè)備。附加流<STREAM>指定該設(shè)備所涉及的相關(guān)信息,包括但不限于:設(shè)備名稱、設(shè)備編碼、設(shè)備類型、安裝地址等,同時通過<STREAM>中指定的點位編碼(monitorCode)將設(shè)備綁定到該監(jiān)測點位上。支持JSON格式。調(diào)用結(jié)果:成功狀態(tài):返回HTTP狀態(tài)碼為200。失敗狀態(tài):返回失敗對應(yīng)的HTTP狀態(tài)碼及采用JSON封裝的響應(yīng)結(jié)果。響應(yīng)結(jié)果包含失敗原因,具體狀態(tài)碼參見目錄8.3。設(shè)備編輯接口名:device/edit說
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
- 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 二零二五年管涵施工與建筑廢棄物處理合同3篇
- 二零二五年度集裝箱購置與綠色港口運營合同3篇
- 二零二五年度集資房項目審計與財務(wù)報表編制合同3篇
- 2024年海南經(jīng)貿(mào)職業(yè)技術(shù)學院高職單招職業(yè)適應(yīng)性測試歷年參考題庫含答案解析
- 安全管理之燃氣管道需要注意安全措施
- 二零二五年戶外廣告安裝工程量清單及結(jié)算合同3篇
- 吉林省農(nóng)安縣九年級物理全冊182電功率課件新版新人教版
- 2024年河南質(zhì)量工程職業(yè)學院高職單招職業(yè)技能測驗歷年參考題庫(頻考版)含答案解析
- 2024年河南工業(yè)和信息化職業(yè)學院高職單招職業(yè)技能測驗歷年參考題庫(頻考版)含答案解析
- 2024年河北政法職業(yè)學院高職單招職業(yè)技能測驗歷年參考題庫(頻考版)含答案解析
- 二年級美術(shù)復(fù)習計劃
- 物業(yè)采購工作總結(jié)
- 組織文化與領(lǐng)導力
- 膠粘性不良改善報告
- 電子商務(wù)客服全套培訓方案
- 河北省石家莊市橋西區(qū)2023-2024學年九年級上冊期末英語模擬試題(附答案)
- 《產(chǎn)品價值點》課件
- 2023年燃氣安全生產(chǎn)工作匯報材料
- 考研英語5500大綱詞匯亂序打印版
- 供貨商合同協(xié)議書簡單版正規(guī)范本(通用版)
- 2023迎春幫困活動總結(jié)
評論
0/150
提交評論