CLOUD云智能管理卡動環(huán)API接口
智能管理卡,對于動環(huán)系統(tǒng),除提供Modbus接口(見"CLOUD云-MODBUS協(xié)議.pdf")以外,還提供Http,TCP/IP兩種純IP方式的通訊API接口。
1,Http模式設置:
不需任何設置,CLOUD云智能管理卡即提供Http模式的通訊功能。CLOUD云管理卡與動環(huán)系統(tǒng)可互為服務端和客戶端,相互使用POST方式傳送數(shù)據(jù)。
2,TCP/IP模式設置:
CLOUD云管理卡為服務端。
打開瀏覽器(如IE等),在地址欄輸入管理卡的IP地址。(如何設置和獲取管理卡的IP地址,請參考文檔“CLOUD云-設置IP地址“)。
2,選擇:集成設置:
設置TCP端口為2390即可。
3,TCP/IP要保持常連模式。
以上兩種API接口(Http,TCP/IP)模式,均不影響智能管理卡遠程控制管理功能。
3,通訊協(xié)議:
a, 發(fā)送指令和數(shù)據(jù):
向CLOUD云智能管理卡按標準JSON格式發(fā)送指令和數(shù)據(jù)。
如:
{
"session":"1234",
"pass":"123456",
"new_pass":"AYI9 123456",
"host":"http://192.168.0.100:9000/post",
"cmd":"QAD",
}
其中:
(1) sessoin:為指令序號,以此辨別返回結果是否屬于本次指令;
(2) pass :為管理卡密碼,初始密碼為空。如果密碼為空,該字段可以不需要;
(3)new_pass :為管理卡設置新的密碼。如果字段內(nèi)容為 clear,表示要清空密碼,否則,字段內(nèi)容不能為空。
(3) host : 返回結果的目標地址;如果使用TCP/IP方式,該字段可以不要;
(4) cmd :發(fā)送要CLOUD云管理卡的指令(大寫)。
包括但不限于以下指令:RTD,QAD,SON,SOFF,BZON,BZOFF,T
b,返回數(shù)據(jù)格式:
返回數(shù)據(jù)格式同樣也為標準JSON格式:
(1)結果錯誤或者無法執(zhí)行的指令,返回格式為:
{
"result":"xxx",
原指令,不包括{}號
}
或者
{
"result":"xxx",
"uid":"201701013805",
"session":"1234",
"cmd":"QAD",
}
其中xxx為錯誤代碼:
101 -- JSON_FORMAT ,JSON格式錯誤;
102 -- SESSION_LOSS,沒有session 字段;
103 -- PASSWORD_ERROR ,密碼錯誤;
104 -- HOST_NO ,沒有host 字段;
105 -- COMMAND_NO , 沒有指令字段;
106 -- PASSTOOLENGTH,密碼太長,超過15位了。
201 -- BUSY ,系統(tǒng)繁忙。
(2) 結果正確的返回格式:
{
"uid":"201701013805",
"session":"1234",
"cmd":"QAD",
"value":"xxxxxxxxxxxxxxxxxxxxxxxxx",
}
value返回結果:所有返回值均以 ( 開頭 。
(1) RTD指令,查詢UPS(電源)設備的額定信息, 返回格式:
(工廠名稱 硬件版本 機型 額定輸入電壓 額定輸出電壓 額定電流 輸出頻率 額定電池電壓 輸入輸出相數(shù) 額定功率,
如:
(Sunshine V1.0 C10KS 220 220 20 50.0 192 1/1 10000
返回格式以 ( 開頭, 各字段間用一個空格分隔。電壓單位為V,電流單位為 A,頻率單位為Hz ,功率單位為VA. 如果該字段沒有值,用---代替。共10個字段。
(2) QAD指令, 查詢UPS(電源)設備的實時數(shù)據(jù),返回格式:
(輸入電壓(R,S,T) 輸入頻率 輸入電流(R,S,T) 故障電壓 輸出電壓(R,S,T) 輸出頻率 輸出電流(R,S,T) 負載百分比(R,S,T) 電池電壓 電池剩余時間 電池容量百分比 機內(nèi)溫度 工作狀態(tài)
如:
(220.1 220.2 220.3 50.1 ---.- ---.- ---.- 149.5 221 222 223 50 5 6 7 20 30 25 216.5 31687 90 37.5 0000100000000011
返回格式以 ( 開頭, 各字段間用一個空格分隔。電壓單位為V,電流單位為 A,頻率單位為Hz ,功率單位為VA. 如果該字段沒有值,用---代替。共23個字段。
工作狀態(tài)b15(在前)~b0(在后)分別為:
b15: UPS類型: 0=ONLINE,1=BAKCUP ;
b14~b12: 保留未用;
b10~b11: 電池自檢放電結果: 00==未知, 1==失敗,2==成功;
b9: 保留未用;
b8: 0==不過載, 1==過載 ;
b7: 市電正常==0 ,不正常 == 1 ;
b6: 電池電壓: 0=不低,1=低 ;
b5: 0== 運行狀態(tài), 1==正在關機或關機狀態(tài) ;
b4: 0==打開狀態(tài),1==蜂鳴器靜音狀態(tài) ;
b0~b3: UPS狀態(tài):
0=POWE ON 上電狀態(tài)
1=STANDBY 待機狀態(tài)
2=BYPASS 旁路狀態(tài)
3=LINE 市電工作狀態(tài)
4=BAT 電池供電狀態(tài)
5=TEST 測試自檢放電狀態(tài)
6=FAULT 故障狀態(tài)
7=CONVERTER
8=HE 經(jīng)濟狀態(tài),基本等同于BYPASS
9=SHUTDOWN 關機狀態(tài)
(3)SON(),SOFF(),BZON(),BZOFF(),T() 指令,控制UPS狀態(tài),返回結果:
a,執(zhí)行成功返回:(OK
b,不能執(zhí)行或執(zhí)行失敗返回: (FAILED
(4) 其他對設備的查詢,根據(jù)設備內(nèi)的協(xié)議返回結果;
控制指令執(zhí)行成功,返回: (OK, 失敗返回:(FAILED .