目錄 [TOC] ## 一、創恒云(舊平臺)獲取Access_Token ~~~[api] post:https://cloud.truhigh.com/api/cloud/v1/get-token *name:name=默認值#創恒云用戶名 *password:password=默認值#創恒云密碼 <<< success <<< error ~~~ 返回內容描述 | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | msg| 描述| string | 返回信息 | | code| 結果| int | 1 驗證通過、-1 驗證失敗 | | access_token| Access_Token| string | 成功時返回，時效為2小時，過期請重新獲取| | userkey| userkey| string | 成功時返回，用戶的key| | userId| userId| string | 成功時返回，用戶的id| >[danger] **以下的請求都需要在請求頭部加入'Authorization=access_token'，否則會導致驗證不通過** ## 二、創恒云(舊平臺)根據用戶信息獲取DTU設備列表 >[success]請求地址 `https://cloud.truhigh.com/api/cloud/v1/get-dtu-information` 請求類型 `GET` 請求參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | key| 用戶的key(必須)| string | 第一個API已獲取 | | owner| 用戶的id(必須) | string | 第一個API已獲取 | | page| 頁數 | string/int | 分頁的頁數 | | size| 頁大小 | string/int | 一頁限制幾條 | 返回參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | code| 結果| int | 1 獲取成功、-1 獲取失敗 | | msg| 返回信息| string| 失敗時返回 | | list| DTU設備列表| Array| 成功時返回| 返回示例 ``` { "code": 1, "list": [ //DTU設備列表 { "username": "lch", "starttime": "網關上線時間", //只有網關在線才會有此字段 "_id": "5e6880181e3a2c7354e56edb", "freestyle": 2, "sid": "mdrwrszj0", "pcid": "P401A2191203083", //DTU設備SN號 "name": "P401A2191203083", "__v": 0, "comid": "P401A2191203083P401A219120308391127c9bd41740458f5493497f4c372f", "pkey": "91127c9bd41740458f5493497f4c372f", "monitor\_camera": null, "owner": null, "ppiAddress": 0, "purpose": "datatrans", "utime": "2020-03-11T06:07:20.028Z", "ctime": "2020-03-11T06:07:20.000Z", "cover": "[http://www.placehold.it/200x150/EFEFEF/AAAAAA&amp;text=no+image](http://www.placehold.it/200x150/EFEFEF/AAAAAA&text=no+image)", "location": { "detailedAddr": "", "district": "", "city": "", "province": "" }, "inquireTim": 1000, "inquirePeriod": 5, "open": 0, "Stopbits": 1, "Databits": 8, "Parity": "無校驗", "Baudrate": 9600 }.... ], "deviceGroupList": [], "pager": { "page": 1, //頁數 "size": 15, //頁大小 "total": 12 //總數 } } ``` ## 三、創恒云(舊平臺)根據DTU設備SN號獲取DTU下設備列表 >[success]請求地址 `https://cloud.truhigh.com/api/cloud/v2/get-device-list` 請求類型 `GET` 請求參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | sn| DTU設備的SN號 |string | DTU設備的唯一SN號 | 返回參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | code| 結果| int | 1 獲取成功、-1 獲取失敗 | | msg| 返回信息| string| 失敗時返回 | | list| DTU下設備列表| Array| 成功時返回| 返回示例 ``` { "code": 1, "list": [ { "_id": "5e999efc7a2d7d312147b3d0", //設備id "NO": 36002, "userid": "5c9c426f15092dd36059fe6b", "sid": "ysg60qsac", "parent": "5dd7641be8ad701eed29a934", "modbusRule": { //點表 "_id": "5e990da07a2d7d3121449ff6", "name": "ceshi", "type": "modbusRTU" }, "slaveAddr": 1, "note": "ceshi", "Texp": "T1", "Fexp": "F1", "ctime": "2020-04-17T12:20:12.340Z", "__v": 0 } ... ] } ``` ## 四、創恒云(舊平臺)獲取用戶設備詳細信息 >[success]請求地址 `https://cloud.truhigh.com/api/cloud/v2/get-device-information` 請求類型 `GET` >[danger] **需要在請求頭部加入'Authorization=access_token'，否則會導致驗證不通過，access_token獲取請查看第一個API** 請求參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | _id| 設備唯一id | string | 設備的_id字段 | **創恒云平臺查看設備唯一id**   返回參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | code| 結果| int | 1 獲取成功、-1 獲取失敗 | | msg| 返回信息| string| 失敗時返回 | | item| 設備信息| Object| 成功時返回| **item字段描述** ``` "item":{ ????????"_id":"5f890ed5******0ab9147fc", //設備ID ????????"NO":22251, ????????"userid":"5efd49******a34f4ce558b", //用戶ID ????????"sid":"4b7***ijp", //設備SID ????????"parent":{ ????????????"_id":"5f0be7******e24dfd089c0b", //DTU設備ID ????????????"freestyle":2, ????????????"sid":"ctd7***l2s", //DTU設備SID ????????????"pcid":"P411A*******2001", //DTU設備SN號 ????????????"name":"P411A*******2001", ????????????"ppiAddress":0, ????????????"purpose":"datacollection", ????????????"utime":"2020-07-13T04:48:32.500Z", ????????????"ctime":"2020-07-13T04:48:32.000Z", ????????????"cover":"[http://www.placehold.it/200x150/EFEFEF/AAAAAA&text=no+image](http://www.placehold.it/200x150/EFEFEF/AAAAAA&text=no+image)", ????????????"inquireTim":1000, //輪詢周期 ????????????"inquirePeriod":2, ????????????"open":0, ????????????"Stopbits":1, //停止位 ????????????"Databits":8, //數據位 ????????????"Parity":"無校驗", //校驗位 ????????????"Baudrate":9600, //波特率 ????????????"__v":0, ????????????"comid":"P411A*******A1191012001b5d16384ad2442f6fc73c671a500b13f", ????????????"location":{ ????????????????"detailedAddr":"", ????????????????"district":"歷下區", ????????????????"city":"濟南市", ????????????????"province":"山東省", ????????????????"longitude":117.429344, ????????????????"latitude":36.690586 ????????????}, //地理位置信息 ????????????"pkey":"b5d1638********c73c671a500b13f", ????????????"monitor_camera":null, ????????????"owner":null ????????}, ????????"modbusRule":{ ????????????"_id":"5efd6f1e7***********5e0", //點表ID ????????????"name":"SIEMENS", ????????????"note":"", ????????????"type":"PPI", //點表類型modbusRTU、PPI ????????????"userid":"5efd490*********e558b", ????????????"template":"single", ????????????"utime":"2020-07-18T02:42:09.615Z", ????????????"ctime":"2020-07-02T05:22:38.683Z", ????????????"page":[ ], ????????????"table":[ { "plcAddr":1, "_XID":"row_0", "note":"", "formula":"", //正反向公式，中間以逗號隔開 "originMax":"", "originMin":"", "max":"", //最大值 "min":"", //最小值 "byteOrder":"", //字節順序 "dataBits":"", //數據位 "format":"", //數據格式 "address":"0", //地址 "register":"RWCoil", //寄存器類型 "fixed":"", "unit":"", //單位 "name":"輸出0", "index":"#1" ????????????????}， ........ ????????????], //modbusRTU點表 ????????????"__v":0, ????????????"ppiTable":{ ????????????????"ky******54z":{ ????????????????????"formula":"", ????????????????????"_XID":"row_3", ????????????????????"sid":"ky******4z", //數據點的SID ????????????????????"note":"", ????????????????????"formula2":"", //反向公式 ????????????????????"formula1":"", //正向公式 ????????????????????"oType":"read_w", //類型 ????????????????????"address":"M20.0", //地址 ????????????????????"format":"BIT", //數據格式 ????????????????????"unit":"1", ????????????????????"name":"模式選擇", ????????????????????"index":"#3" ????????????????}, .......... } //西門子PPI點表 ????????}, ????????"slaveAddr":2, //從機地址 ????????"note":"測試2", //設備名稱 ????????"Texp":"T1", ????????"Fexp":"F1", ????????"ctime":"2020-10-16T03:09:09.157Z", ????????"__v":0, ????????"devtype":"SIEMENS", ????????"protocol":"Modbus?RTU", ????????"inquirePeriod":2, ????????"inquireTim":1000, ????????"online":false //設備在線離線狀態 ????} ``` ## 五、創恒云(舊平臺)獲取ModbusRTU設備數據 >[success]請求地址 `https://cloud.truhigh.com/api/cloud/v3/get-modbus-data` 請求類型 `GET` >[danger] **需要在請求頭部加入'Authorization=access_token'，否則會導致驗證不通過，access_token獲取請查看第一個API** 請求參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | deviceId| 設備唯一id | string | 設備的_id字段 | 返回參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | success| 結果| bool| true 獲取成功、false 獲取失敗 | | msg| 返回信息| string| 失敗時返回 | | modbusRule| 數據信息| Object| 成功時返回| **modbusRule字段描述** ``` "modbusRule": { "_id":"5d1ad387******35b613ae98", //點表ID "name":"測試點表", "type":"modbusRTU", //協議類型 "userid":"5cd8ccaf4*******1f7ee9927", //用戶ID "__v":0, "note":"備注信息", "template":"single", "utime":"2019-10-16T06:28:12.749Z", "ctime":"2019-07-02T03:46:15.990Z", "page":[ ], "table":[ ????????{ ????????????"time":1602824245358, //數據獲取的時間 ????????????"data":9460, //獲取的數據值 ????????????"index":"#0", ????????????"name":"測試點1", ????????????"unit":"mm", //單位 ????????????"fixed":"", ????????????"register":"RHoding", //寄存器類型 ????????????"address":"0", //地址 ????????????"format":"16Unsigned", //數據格式 ????????????"dataBits":"", //數據位 ????????????"byteOrder":"", //字節順序 ????????????"min":"", ????????????"max":"", ????????????"originMin":"", ????????????"originMax":"", ????????????"formula":"", ????????????"note":"", ????????????"plcAddr":40001 //plc地址 ????????}, .......... ????] } ``` ## 六、創恒云(舊平臺)獲取PPI設備數據 >[success]請求地址 `https://cloud.truhigh.com/api/cloud/v3/get-ppi-data` 請求類型 `GET` >[danger] **需要在請求頭部加入'Authorization=access_token'，否則會導致驗證不通過，access_token獲取請查看第一個API** 請求參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | _id| 設備唯一id | string | 設備的_id字段 | 返回參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | code| 結果| int| 1獲取成功、0獲取失敗 | | msg| 返回信息| string| 失敗時返回 | | modbusRule| 數據信息| Object| 成功時返回| **modbusRule字段描述** ``` "modbusRule": { "_id":"5db6949*******05863575ded", "name":"測試PPI點表", "note":"", "type":"PPI", "userid":"5db68be******34dfa36", "__v":0, "ppiTable":[ ????????{ ????????????"time":1602827325657, //數據獲取的時間 ????????????"data":0, //獲取的數據值 ????????????"formula":"", ????????????"_XID":"row_2", ????????????"sid":"be***3g0y", //數據點SID ????????????"note":"測試", ????????????"formula2":"", //反向公式 ????????????"formula1":"", //正向公式 ????????????"oType":"read_w", //寄存器類型 ????????????"address":"M0.0", //數據地址 ????????????"format":"BIT", //數據格式 ????????????"unit":"", ????????????"name":"測試點", ????????????"index":2 ????????}, ????], "template":"single", "utime":"2020-02-13T06:58:41.499Z", "ctime":"2019-10-28T07:11:15.952Z", "page":[ ], "table":[ ] } ``` ## 七、創恒云(舊平臺)下發Modbus設備數據 >[success]請求地址 `https://cloud.truhigh.com/api/cloud/v3/set-modbus-data` 請求類型 `POST` >[danger] **需要在請求頭部加入'Authorization=access_token'，否則會導致驗證不通過，access_token獲取請查看第一個API** 請求參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | sid| 設備唯一sid | string | 設備的sid字段 | | address| 設備從機地址 | int| 設備的slaveAddr字段 | | code| 根據當前數據點的寄存器類型整合| int| 見下方注釋1 | | start| 起始地址 | string | 當前數據點的address字段 | | data| 整合發送數據 | float / null| 見下方注釋2 | |sn|DTU設備SN號 |string|可看第四個API信息，返回值內有詳細標注| |wData|要發送的具體信息| Object|見下方注釋3| >[success]**注釋** 1.code: 當前數據點的register字段 (RWCoil，RCoil)為5， （RWHoding，WHoding）為6 2.data: <1>數據點類型為BIT類型：要發送數據為1時，data為0xff；要發送數據為0時，data為0x00; <2>數據點類型不是BIT類型時：<1>如果當前數據點的(min,max,originMin,originMax)字段全部未賦值，直接將要發送的數據轉為浮點型；<2>如果當前數據點的(min,max,originMin,originMax)字段已賦值，則執行下方數據轉換代碼: ``` v?=?parseFloat(v) // v為要下發的數據 min?=?parseFloat(min) // min為數據點的min字段 max?=?parseFloat(max) // max為數據點的max字段 oMin?=?parseFloat(originMin) // originMin為數據點的originMin字段 oMax?=?parseFloat(originMax) // originMax為數據點的originMax字段 var rs?=?(v?-?min)?/?(max?-?min)?*?(oMax?-?oMin)?+?oMin data = isNaN(rs)???null?:?rs.toFixed(4) ``` >[success]**注釋** 3.wData內為下方表格數據 | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | dtuId| DTU設備SID| string| DTU設備SID ，可看第四個API信息，返回值內有詳細標注 | | deviceId| 設備SID| string| 設備SID，可看第四個API信息，返回值內有詳細標注 | | plcAdress| 數據點的PLC地址| int| 數據點的plcAddr字段 | | data| 要下發的數據| string/int| 要下發的數據 | | category| 數據點的數據格式| string| 數據點的format字段 | | register| 數據點寄存器格式| string| 數據點的register字段:(RWCoil,RCoil)為Coil；(RDiscrete)為Discrete；(RWHoding,RHoding,WHoding)為Hoding；(RInput)為Input | | formula| 數據點公式| string| 數據點的formula字段 | | byteOrder| 數據點字節順序| string| 數據點的byteOrder字段 | 返回參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | code| 結果| int| 1 下發成功、-1 下發失敗 | | msg| 返回信息| string| 失敗時返回 | ## 八、創恒云(舊平臺)下發PPI設備數據 >[success]請求地址 `https://cloud.truhigh.com/api/cloud/v3/set-ppi-data` 請求類型 `POST` >[danger] **需要在請求頭部加入'Authorization=access_token'，否則會導致驗證不通過，access_token獲取請查看第一個API** 請求參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | _id| 設備唯一ID| string | 設備的_id字段 | | sid| 數據點唯一sid| string | 數據點的sid字段 | | writeData| 要下發的數據| float/int/string| 要下發的數據 (BIT類型下發數據為int，其他類型下發數據為float或string) | 返回參數及說明: | 字段 |說明 | 類型 |備注 | | --- | --- | --- | --- | | code| 結果| int| 1 下發成功、0 下發失敗 | | msg| 返回信息| string| 失敗時返回 |