相關(guān)文檔

>> GServer實(shí)時(shí)接口(JSON)示例說(shuō)明

 

GServer實(shí)時(shí)接口(JSON)說(shuō)明：

本規(guī)范規(guī)定了直接接入EXLIVE平臺(tái)GServer應(yīng)用服務(wù)器的接口定義，采用TCP通訊方式，實(shí)現(xiàn)了用戶(hù)登錄、權(quán)限驗(yàn)證、各種數(shù)據(jù)傳輸?shù)裙δ堋?

本規(guī)范主要用來(lái)實(shí)現(xiàn)第三方軟件和GServer服務(wù)器實(shí)時(shí)互通，采用TCP傳輸方式，端口為1502，數(shù)據(jù)格式使用json格式。

數(shù)據(jù)分為數(shù)據(jù)頭(header)和數(shù)據(jù)體(body)兩個(gè)部分。

數(shù)據(jù)頭(header)部分格式為：

"header":
{
"cmd":"1000"
}

格式主要包含一個(gè)命令字(cmd)屬性，程序根據(jù)命令字來(lái)區(qū)分?jǐn)?shù)據(jù)體的內(nèi)容。數(shù)據(jù)體(body)部分包含的數(shù)據(jù)會(huì)根據(jù)數(shù)據(jù)頭中的命令字(cmd)而異。

 

 

第三方平臺(tái)數(shù)據(jù)轉(zhuǎn)入EXLIVE平臺(tái)步驟：

>> 獲取一個(gè)EXLIVE平臺(tái)帳號(hào)

>> 以TCP方式登錄EXLIVE平臺(tái)1502端口，參考用戶(hù)登錄命令1000

>> 等待exlive平臺(tái)登錄返回成功，如果返回結(jié)果不是success服務(wù)器將掐斷TCP連接

>> 收到成功后，第三方平臺(tái)需要間隔30秒發(fā)送心跳消息，參看客戶(hù)端心跳　1002

>> 連接成功后，第三方平臺(tái)可以按照　車(chē)輛定位數(shù)據(jù) 1007　格式上傳車(chē)輛數(shù)據(jù)

>> 第三方平臺(tái)退出連接可以發(fā)送　用戶(hù)退出 1001命令，然后斷開(kāi)TCP連接

 

自己開(kāi)發(fā)客戶(hù)端接入EXLIVE平臺(tái)GServer服務(wù)器步驟：

>> 獲取一個(gè)EXLIVE平臺(tái)帳號(hào)
>> 以TCP方式登錄EXLIVE平臺(tái)1502端口，參考用戶(hù)登錄命令1000
>> 等待exlive平臺(tái)登錄返回成功，如果返回結(jié)果不是success服務(wù)器將掐斷TCP連接
>> 收到成功后，第三方平臺(tái)需要間隔30秒發(fā)送心跳消息，參看客戶(hù)端心跳　1002
>>請(qǐng)求下發(fā)用戶(hù)下客戶(hù)和分組數(shù)據(jù) 1008
>>請(qǐng)求下發(fā)每個(gè)分組下的車(chē)輛數(shù)據(jù)　1010
>> 服務(wù)器向客戶(hù)端轉(zhuǎn)發(fā)車(chē)輛的實(shí)時(shí)定位數(shù)據(jù)　1007
>>客戶(hù)端向車(chē)載終端下發(fā)車(chē)機(jī)命令　1003
>> 客戶(hù)端退出連接，發(fā)送退出命令 1001，然后斷開(kāi)TCP連接

 

 

1.用戶(hù)從客戶(hù)端登錄GServer服務(wù)器

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1000

參數(shù)

參數(shù)	類(lèi)型	說(shuō)明
name	String	用戶(hù)名稱(chēng)
pass	String	用戶(hù)密碼
ver	String	客戶(hù)端版本，如 4.6936
type	String	客戶(hù)端類(lèi)型　json_common
mode	String	備用，填空

格式：

{
　"header":
　{
　　"cmd":"1000"
　},
　"body":
　{
　　"name":"exlive",
　　"pass":"000000",
　　"ver":"4.6936",
　　"type":"json_common",
　　"mode":""
　}
}

 

 

 

2.服務(wù)器對(duì)客戶(hù)端發(fā)送命令返回的通用應(yīng)答

數(shù)據(jù)發(fā)送方向：server —> client

命令字：8000

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
cmd	String	服務(wù)器接收到的命令字
result	String	結(jié)果success　成功　failed失敗

格式：

{
　"header":
　{
　　"cmd":"8000"
　},
　"body":
　{
　　"cmd":"1000",
　　"result":"success"
　}
}

 

 

3.用戶(hù)從客戶(hù)端退出/注銷(xiāo)登錄

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1001

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
data	String	空

格式：

{
　"header":
　{
　　"cmd":"1001"
　},
　"body":
　{
　　"data":""
　}
}

 

 

4.客戶(hù)端向服務(wù)器發(fā)送心跳消息

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1002

客戶(hù)端登錄成功后，需要按照30秒間隔向服務(wù)器發(fā)送心跳消息，如果3分鐘沒(méi)有收到客戶(hù)端發(fā)送的心跳消息，服務(wù)器端將主動(dòng)斷開(kāi)客戶(hù)端的連接

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
result	String	空

格式：

{
　"header":
　{
　　"cmd":"1002"
　},
　"body":
　{
　　"result":""
　}
}

 

 

5.服務(wù)器向客戶(hù)端發(fā)送通知消息

數(shù)據(jù)發(fā)送方向：client <—> server

命令字：1003

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
msg	String	消息內(nèi)容

格式：

{
　"header":
　{
　　"cmd":"1003"
　},
　"body":
　{
　　"msg":""
　}
}

 

 

6.客戶(hù)端向車(chē)載終端發(fā)送車(chē)機(jī)命令

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1004

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
terminalid	String	設(shè)備id
code	String	車(chē)牌號(hào)碼
cmdid	String	命令id
cmdpass	String	命令密碼

格式：

{
　"header":
　{
　　"cmd":"1004"
　},
　"body":
　{
　　"terminalid":"",
　　"code":"",
　　"cmdid":"7004",
　　"cmdpass":"",
　　"data":"<cmd><id>7000</id><param>上報(bào)間隔</param><para>上報(bào)次數(shù)</param><param>命令密碼</param></cmd>"
　}
}

 

 

7.服務(wù)器向客戶(hù)端轉(zhuǎn)發(fā)車(chē)輛實(shí)時(shí)定位數(shù)據(jù)

數(shù)據(jù)發(fā)送方向：server —> client

命令字：1007

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
code	String	車(chē)牌號(hào)碼
id	String	車(chē)輛ID
lat	String	緯度
lng	String	經(jīng)度
veo	String	速度
dir	String	方向
gpstime	String	格式為：2011-11-01 12:38:39
av	String	表示是否為有效定位， 0 無(wú)效定位， 1有效定位
alarm	String	是否報(bào)警， 0 無(wú)報(bào)警， 1 報(bào)警
oil	String	當(dāng)前油量
dis	String	當(dāng)前總里程
wstate	String	整數(shù)類(lèi)型狀態(tài)
cstate	String	狀態(tài)描述，可以為空
posinfo	String	位置描述，可以為空
p1	String	模擬量1
p2	String	模擬量2
temp	float	溫度
temp0	float	溫度1
temp1	float	溫度2
temp2	float	溫度3
temp3	float	溫度4

格式：

{
　"header":
　{
　　"cmd":"1007"
　},
　"body":
　{
　　"code":"",
　　"id":"",
　　"lat":"",
　　"lng":"",
　　"veo":"",
　　"dir":"",
　　"gpstime":"",
　　"av":"",
　　"alarm":"",
　　"oil":"",
　　"dis":"",
　　"wstate":"",
　　"cstate":"",
　　"posinfo":"",
　　"p1":"",
　　"p2":"",
       "temp":,
       "temp0":,
       "temp1":,
       "temp2":,
       "temp3":
　}
}

 

 

 

8.客戶(hù)端請(qǐng)求服務(wù)器下發(fā)用戶(hù)權(quán)限下客戶(hù)及分組數(shù)據(jù)

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1008

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
client	String	true 下發(fā)客戶(hù)關(guān)系數(shù)據(jù)，false 不下發(fā)

格式：

{
　"header":
　{
　　"cmd":"1008"
　},
　"body":
　{
　　"client":"true"
　}
}

 

 

9.服務(wù)器向客戶(hù)端下發(fā)用戶(hù)的客戶(hù)、分組數(shù)據(jù)

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1009

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
groupid	String	車(chē)輛分組的ID
relation	String	用戶(hù)的客戶(hù)
customer	String	分組的客戶(hù)
goupname	String	分組名稱(chēng)

格式：

{
　"header":
　{
　　"cmd":"1009"
　},
　"body":
　{
　　"groupid":"",
　　"relation":"",
　　"customer":"",
　　"goupname":""
　}
}

 

 

10.客戶(hù)端請(qǐng)求服務(wù)器下發(fā)用戶(hù)權(quán)限下分組的車(chē)輛數(shù)據(jù)

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1010

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
groupid	String	車(chē)輛分組ID

格式：

{
　"header":
　{
　　"cmd":"1010"
　},
　"body":
　{
　　"groupid":"1"
　}
}

 

 

11.服務(wù)器向客戶(hù)端下發(fā)用戶(hù)權(quán)限下指定分組的車(chē)輛靜態(tài)數(shù)據(jù)

數(shù)據(jù)發(fā)送方向：server —> client

命令字：1011

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
id	String	車(chē)輛ID
code	String	車(chē)牌號(hào)碼
sim	String	SIM卡號(hào)碼
terminalid	String	終端設(shè)備ID
groupname	String	車(chē)輛所屬分組名稱(chēng)
vhctype	String	車(chē)輛類(lèi)型
mobiletype	String	終端設(shè)備類(lèi)型

格式：

{
　"header":
　{
　　"cmd":"1011"
　},
　"body":
　{
　　"id":"",
　　"code":"",
　　"sim":"",
　　"terminalid":"",
　　"groupname":"",
　　"vhctype":"",
　　"mobiletype":""
　}
}

 

 

12.客戶(hù)端發(fā)送車(chē)機(jī)透?jìng)髅畹皆O(shè)備

數(shù)據(jù)發(fā)送方向：client —> server

命令字：1012

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
terminalid	String	設(shè)備ID
code	String	車(chē)牌號(hào)碼
cmdid	String	命令I(lǐng)D, 透?jìng)髅罟潭?513
cmdpass	String	透?jìng)髅蠲艽a,一般為空
data	String	透?jìng)鲾?shù)據(jù)的16進(jìn)制字符串

格式：

{
　"header":
　{
　　"cmd":"1012"
　},
　"body":
　{
　　"terminalid":"",
　　"code":"",
　　"cmdid":"",　
　　"cmdpass":"",
　　"data":""
　}
}

 

 

13.服務(wù)器轉(zhuǎn)發(fā)車(chē)載終端的透?jìng)鲾?shù)據(jù)到客戶(hù)端

數(shù)據(jù)發(fā)送方向：server —> client

命令字：1013

參數(shù)：

參數(shù)	類(lèi)型	說(shuō)明
terminalid	String	設(shè)備
code	String	車(chē)牌號(hào)碼
data	String	透?jìng)鲾?shù)據(jù)的16進(jìn)制字符串

格式：

{
　"header":
　{
　　"cmd":"1013"
　},
　"body":
　{
　　"terminalid":"",
　　"code":"",
　　"data":""
　}
}