Mercury系统指令集综述.docx

Mercury系统指令集综述.docx

《Mercury系统指令集综述.docx》由会员分享，可在线阅读，更多相关《Mercury系统指令集综述.docx（79页珍藏版）》请在冰豆网上搜索。

Mercury系统指令集综述

Mercury系统指令集

版本1.0k，2002年9月2日

作者：

吴亦瓯

目录

I.综述

本指令集用于定义Mercury系统的功能表实现，并用于规定客户端对服务器的调用格式，以及服务器向客户端返回数据的格式。

a）基本格式

本指令集采用格式化字符串和结束符组成。

指令名，参数名大小写敏感。

每条指令结束，必须有结束符。

结束符为：

##

字符串中由“键-值对”和分隔符组成。

“键-值对”格式如下：

Key:

=Value

其中，Key为任意键名，应符合.net变量名规则。

Value为字符串，可以包括字母和字符，但不可以包括|,;，因为这些字符是本指令集的分隔符。

键和值之间，用“:

=”连接。

分隔符有4级。

分别为：

&&|,;

&&用来分割“键-值对”。

|,;作为值中的分割符，可用于表示比较复杂的值。

Value的空值为空字符串：

“”。

（注意：

构造指令字符串时，不要加上双引号，一般来讲，等号后为空。

）

b）公用键

以下键因为使用的指令较多，在此集中说明。

1）发送必选键

所有指令，都应该包含以下键：

●ActID

本指令的指令代码。

●CID

发出本指令的客户端代码。

●SID

本指令的流水号。

除了ClientReg外，所有指令都应该由客户端指定SID.

2）返回必选键

ActID:

对应发送指令的ActID。

SID:

用于与发送指令对应。

Successed:

T|F，表示指令是否成功执行。

ErrCode:

如果未成功，错误代码。

ErrDesc:

如果未成功，错误的描述。

3）可选键

●SIM

接受指令的通信设备ID。

可为空。

●HostName

接受指令的通信设备的宿主名（例如车牌号）。

当SIM为空时，此参数有效，否则以SIM为准。

●RValue

发送端期望原封不动返回的值。

可用于对指令的判别处理。

说明：

如无特殊说明在所有需要给出SIM的指令，都可以替代性的给出HostName。

但这些指令中，不应二者都不给出。

II.

指令集详述

以下各指令中，如无特殊说明，都应包括I（b）中规定的必选键，并按其规定使用。

a）初始化

1）ClientReg

●指令定义：

本指令用于客户端向中心注册。

所有客户端在发起请求前，都必须向中心注册，并得到中心的认证，才能继续执行操作。

●发送参数表：

⏹CID:

空值

⏹SID:

空值

⏹UID:

用户登录名

⏹PWD:

用户口令

⏹ChannelType:

客户端与服务器的通信通道类型。

可以为下列值:

◆Q:

MessageQueue

◆T:

TCP/IP

◆R:

Remoting

◆W:

Web

⏹ClientAddress:

客户端地址。

仅当ChannelType=Q时有效，此时此值为客户端接收服务器返回的消息的MessageQueuePath.

⏹ClientType:

客户端软件的类型。

可以为下列值：

◆T:

客户端为终端应用，直接面向最终用户。

◆S:

客户端为服务应用，作为服务运行，如报警监控，预约呼车，ExchangeLink

⏹ClientAppName:

客户端软件的应用名。

●返回参数表：

⏹CID:

如果指令成功，返回系统分配的客户端ID。

⏹SvrTime:

当前服务器的系统时间。

●其他说明：

此指令成功执行后，客户端才能获得有效的CID。

客户端必须自行维护CID。

以后所有指令都必须携带此CID方能被服务器接受。

服务器会纪录客户的UID/PWD。

以后指令不必再携带UID/PWD。

2）ClientUnReg

●指令定义：

本指令用于客户端向服务器声明退出。

●发送参数表：

公用参数

●返回参数表：

公用参数。

●其他说明：

建议客户端正常退出时发送本指令。

如果不发送，服务器的垃圾收集可自动删除客户端注册，但会有一定延迟。

3）ClientConnect

●指令定义：

客户端在意外情况下与服务器断开（3分钟内，否则服务器将清除该客户端），或者发出ClientDisconnect之后，需要重新登陆上来时，可以发出该指令。

注意：

此时客户端必须指明系统原先分配的CID

●发送参数表：

公用参数

●返回参数表：

公用参数

⏹SvrTime:

当前服务器的系统时间。

4）ClientDisconnect

●指令定义：

客户端需要保留对某些车辆的呼叫状态时可以暂时断开与服务器的连接。

最大时间限制可以通过配置参数设定。

（默认值为：

60分钟）

●发送参数表：

公用参数

●返回参数表：

公用参数

b）查询静态信息

5）QueryGKDB

●指令定义：

本指令用于客户端查询服务器中核心数据库的数据。

●发送参数表：

⏹ObjType:

指定要查询的对象类型。

可以为以下值：

◆DEV:

Device对象

可选KeyField:

SIM,DevID

◆HOST:

Host对象

可选KeyField:

Name

◆USER:

User对象

可选KeyField:

Name

⏹KeyField:

指定查询所用的关键字段

允许同时查询多个字段，各关键字间用“|”分隔。

⏹KeyValue:

给出查询字段的值。

◆可以一次查询多个字段的值。

◆多个值之间用“|”分格。

●返回参数表：

⏹Fields:

字段名，多个字段用“|”分割。

⏹Value:

字段值，多个字段用“|”分割。

◆当查询为多个值时，返回的纪录之间用“；”分隔

◆Value可能为空值

●其他说明：

调用本指令需要用户对对象有权限。

6）GetSysInfo

●指令定义：

本指令用于客户端查询服务器系统的基本信息。

●发送参数表：

公用参数。

●返回参数表：

⏹Version:

服务器系统的版本号。

多个软件版本用“|”分割，每个格式为：

“软件名，版本号”

⏹AdapterAddr:

GPSAdapter服务的地址。

格式为：

Q,QueuePath|T，IP:

Port

⏹DataWinAddr:

GPSDataWin服务的地址。

格式为：

Q,QueuePath|T，IP:

Port

⏹CenterName:

中心名。

每个GPSServer的唯一ID

●其他说明：

调用本指令需要管理员权限。

7）QueryAdapter

●指令定义：

本指令用于查询当前连接Adapter的客户程序情况。

●发送参数表：

⏹QueryCat:

要查询的类别。

可以为下列值：

◆RegConn:

列出当前连接在本Adapter上的所有客户信息，包括Service和Exchange.

◆Service:

列出当前本中心上的Service.

◆Exchange:

获得当前Exchange连接情况，以及通过Exchange请求的数据情况。

●返回参数表：

⏹QueryCat:

要查询的类别。

与发送给出的值相同。

⏹AdapterRPT:

根据不同的QueryCat,Adapter返回的数据。

根据QueryCat的不同，格式有所不同。

如下：

◆RegConn:

格式：

CID,UID,ClientType,ClientAppName|CID,UID,ClientType,ClientAppName

其内容相当于ClientReg时填写的内容。

直接将值返回。

顺序必须按上述顺序。

◆Service:

格式：

CID,UID,ServiceName,ServiceOtherData|……

直接将值返回。

顺序必须按上述顺序。

ServiceName实际上是ClientAppName,ServiceOtherData为Service自行维护的，要返回给客户端的其他信息，但要注意其中的分隔符不要有“，”或“|”。

◆Exchange:

格式：

ECID,UID,GCID|……

ECID:

ExchangeClientID

UID:

UserID.

GSID:

GpsServerID

●其他说明：

调用本指令需要管理员权限。

8）QueryDataWin

●指令定义：

本指令用于客户端从DataWindow取得数据。

●发送参数表：

⏹SIM:

要查询的设备的SIM卡号。

一次可查询多个设备，各SIM用“|”隔开。

如果SIM为“0”则按此条指令按以下规则处理：

返回当前在DataWin中所有设备的最后一条数据。

但此数据时间不应早于StartTime。

如果StatrTime=“”则忽略此限制。

除StartTime外其他参数全部忽略。

⏹StartTime:

要求的结果信息最早时间。

格式为yyyy-MM-ddHH:

mm:

ss，如2001年11月8日14点20分3秒表示为2001-11-814:

20:

3。

如果StartTime=“”，则相当于不限制开始时间。

⏹ResultNum:

要求的结果信息条数。

⏹Latest:

T|F

逻辑值。

设定返回的信息是否必须为最新数据。

⏹QUID

可选。

指定用于执行查询的用户ID。

如果不给，则使用客户端当前用户。

⏹QPWD

可选。

给出QUID对应的口令。

⏹ClientAddress

内部使用。

为返回数据的地址。

●返回参数表：

⏹DataWinResult:

格式：

SIM,GPSREC;GPSREC2;…GPSRECn|SIM,GPSREC……

GPSREC格式：

Lon$Lat$Speed$Dir$SatNum$Status$GPSTime$MSGTime$Other

其中，GPSTime为GPS设备的定位时间，MSGTime为消息到达系统的时间。

分隔符为”$”。

●其他说明：

发送参数的值以及期望结果，见下表：

StartTime

ResultNum

Latest

结果

空

0

Any

本设备当前在DataWin中所有数据。

指定时间

0

Any

从指定时间起到最新所有数据。

空

n

T

最新n条。

不够n条则返回所有最新数据。

指定时间

N

T

最新n条，但不超过指定时间。

不够n条则到指定时间止。

指定时间

n

F

指定时间起n条，不够n条则到目前最新一条止。

对于查询的设备，如果没给出QUID，则客户端的连接用户必须有相应的权限。

如果给出了QUID，则QUID用户必须有相应权限。

9）QueryHistoryData

●指令定义：

本指令用于获得某一设备在某段时间内的历史数据。

●发送参数表：

⏹SIM:

要查询的设备的SIM卡号。

一次可查询一个设备。

⏹StartTime:

要求的结果信息最早时间。

格式为yyyy-MM-ddHH:

mm:

ss，如2001年11月8日14点20分3秒表示为2001-11-814:

20:

3。

⏹EndTime

要求的结果信息最晚时间。

格式为yyyy-MM-ddHH:

mm:

ss，如2001年11月8日14点20分3秒表示为2001-11-814:

20:

3。

⏹Latest:

T|F

逻辑值。

设定返回的信息是否必须为最新数据。

此设定仅当结果纪录数超过最大结果数限制，并且AutoFit=F时有效。

当Latest=T时，返回的结果满足EndTime条件。

否则，满足StartTime条件。

⏹AutoFit:

T|F

逻辑值。

设定当结果记录数多于最大允许结果时，是否自动调整结果集的间隔，以返回覆盖查询时间段并且不超过记录数限制的结果集。

调整方法如下：

设在给定时间段内总记录数为N，最大允许记录数为M

则，当N

当N>M时，r=N/M（四舍五入取整），每r条记录，取星数最多的记录为有效记录返回给客户端。

目前系统规定：

N=10000;M=1000

⏹QUID

可选。

指定用于执行查询的用户ID。

如果不给，则使用客户端当前用户。

⏹QPWD

可选。

给出QUID对应的口令。

⏹ClientAddress

内部使用。

为返回数据的地址。

●返回参数表：

本指令可能产生多条返回参数。

但每条都有同样的SID。

每条的结构如下：

⏹ResultRecCount:

整数。

表示返回结果的总纪录数。

⏹ResultPageCount:

整数。

表示返回结果包的总数。

⏹ResultPageIndex:

整数。

表示本次返回记录包的顺序号。

⏹AutoFit:

T|F

逻辑值。

表示是否进行了AutoFit。

参见发送参数的AutoFit.

⏹ExceedResult:

T|F

逻辑值。

表示结果记录数是否超出了最大结果数限制。

⏹SIM:

结果设备的SIM卡号。

⏹HistoryREC:

字符串。

返回的数据包。

格式：

GPSREC;GPSREC2;…GPSRECn

GPSREC格式：

Lon$Lat$Speed$Dir$SatNum$Status$GPSTime$MSGTime

其中，GPSTime为GPS设备的定位时间，MSGTime为消息到达系统的时间。

分隔符为”$”。

●其他说明：

对于查询的设备，如果没给出QUID，则客户端的连接用户必须有相应的权限。

如果给出了QUID，则QUID用户必须有相应权限。

10）QueryUserAuth

●指令定义：

本指令用于测试用户对设备的权限以及用户自身权限。

●发送参数表：

⏹SIM:

要查询的设备的SIM卡号。

一次只可查询一个设备。

⏹QUID

指定要测试权限的用户ID。

如果不给，则使用客户端当前用户。

⏹AuthType:

指定要测试的是用户权限还是用户对设备的授权。

可取下列值：

◆A:

测试的是用户对设备的权限，SIM参数指定设备。

◆R:

测试的是用户自身权限，SIM值无效。

◆L:

不进行测试，而是列出用户对设备的所有权限，以及用户自身权限。

⏹RightCode:

指定要测试的权限类型。

可取下列值：

◆1:

用户对设备的查询位置权限

◆2:

用户对设备的位置呼叫权限

◆3:

用户对设备的控制权限

◆4:

用户对设备的发格式信息权限

◆5:

用户对设备的发无格式信息（RawMessage）权限

◆6:

用户查询设备当前状态权限

◆A:

用户可收到Alarm权限

◆I:

用户可收到Message权限（包含RawMessage和格式Message）

◆R:

用户可重复注册权限

●返回参数表：

当AuthType=A或R时返回：

⏹Auth:

T|F，表示此权限测试是否通过。

当AuthType=L返回：

⏹RightCode:

权限列表。

定义同发送的RightCode。

格式为连续字符。

例如：

146A。

●其他说明：

由于只查询用户权限，所以不需要用户口令。

11）QueryUserDeviceAuth

●指令定义：

本指令用于查询某一用户有权限的所有设备。

●发送参数表：

⏹QUID

指定要查询的用户ID。

如果不给，则使用客户端当前用户。

⏹QPWD

指定要查询的用户口令。

仅当QUID给出时使用。

⏹HostGroupID

可选。

如果给出，则查询范围限定在指定Host组。

●返回参数表：

⏹RightCode

列出用户有权限的设备列表。

格式如下：

SIM,HOSTNAME,RightCode|SIM,HOSTNAME,RightCode|……

◆SIM：

设备SIM号。

◆HOSTNAME为设备宿主名

◆RightCode:

用户对设备所拥有的权限类型。

可取下列值：

●1:

用户对设备的查询位置权限

●2:

用户对设备的位置呼叫权限

●3:

用户对设备的控制权限

●4:

用户对设备的发格式信息权限

●5:

用户对设备的发无格式信息（RawMessage）权限

●6:

用户查询设备当前状态权限

●其他说明：

12）QueryUserHostGroupAuth

●指令定义：

本指令用于查询某一用户有权限的宿主组。

●发送参数表：

⏹QUID

指定要查询的用户ID。

如果不给，则使用客户端当前用户。

⏹QPWD

指定要查询的用户口令。

仅当QUID给出时使用。

●返回参数表：

⏹GroupList

列出用户有权限的组名和ID列表。

格式如下：

HostGroupName,GroupID|HostgroupName,GroupID|……HostGroupName,GroupID

●其他说明：

13）QueryDevCompatible

●指令定义：

本指令用于查询某设备的下行控制指令兼容性。

●发送参数表：

⏹SIM:

要查询的设备的SIM卡号。

一次只可查询一个设备。

由原始调用者（客户端）填写。

●返回参数表：

⏹SIM:

设备的SIM卡号

⏹DFactoryID:

设备厂家名称

DFactoryID生产厂家代号对照表

代号

公司名称

备注

00

（立移讯车台）原始车台

01

北京移舟启程信息技术有限公司

02

深圳华强通信技术有限公司

03

摩托罗拉

04

北京大恒

05

北京长征航信704所

06

台湾AVL-2000

07

赛格

08

深圳伊爱公司

09

南京中兴通讯公司和高通公司

10

龙运通科技有限公司

11

厦门雅讯有限公司

12

北京赛博有限公司

13

四川大科星有限公司

14

北京康讯科技股份有限公司

⏹DVersion:

设备版本号，长度为四位，如3.00表示为0300

版本号表（目前兼容的设备表）

序号

版本号

对应设备协议版本号

校验方式

数据包头

说明

1

立移讯假车台

测试用

1无校验

FFAAFFABFFACFFAD

2

移舟车台0300

北京移舟《GPS车载定位监控系统》V3.0YQ-YF010-013-2001

2异或校验

FF80FF70FF50

奥星天网用

通用协议

3

移舟行车记录仪0301

北京移舟《GPS多功能行车记录仪系统》成都专用版V1.0YQP001-T-A002

2异或校验

FF9AFF9BFF9CFF9D

行车记录仪用

成都专用

4

赛格车台0300

基于GSM网的GPS监控报警系统车载终端与通信网关通信协议（SEG-9888系列2000型）

1无校验

（

编号：

T2000_000002_32

5

704所车台0100

704所《GSM车辆调度系统通信协议》（修订版）

1无校验

..3DTT/.

北京704所车台

6

深圳华强车台0500

深圳华强《GSM二代无线传输协议》版本5.0

HQ6006系列B（货运型）

1无校验

*

华强车台

7

台湾AVL车台0300

車輛定位系統AVL-2000

使用手冊

1无校验

#

广东凌科代理

输出接设防撤防开关

8

台湾AVL车台0301

車輛定位系統AVL-2000

使用手冊

1无校验

#

广东凌科代理

输出接断油接通油路开关

9

移舟一键通

小车台0301

GPS车载定位监控调度系统

车载单元与监控中心通信协议

（版本：

Ver3.12B）

2异或校验

移舟一键通

10

移舟行车记录仪0300

北京移舟《GPS多功能行车记录仪系统》V3.0YQP001-T-A002

2异或校验

FF90FF97FF98FF99

行车记录仪用

通用协议

11

移舟一键通小车台0302

AXP系列GPS车载定位仪

车载单元与控制中心通信协议1.0版

2异或校验

F080F070F050

移舟一键通小车台

12

移舟云南烟草车台0304

2异或校验

FF01

移舟云南烟草车台

13

无锡版出租车0305

出租车项目通讯协议（1.2）（12.3）

2异或校验

FF10,FF11

移舟无锡版出租车车台

14

杭州版出租车0306

杭州出租与中心协议（10月23日）

2异或校验

F02A,F02B,

F02C,F02D

移舟杭州版出租车车台

15

杭州口岸国际物流0307

杭州口岸国际物流专用版

1.0版

2异或校验

F03AF03BF03CF03D

移舟杭州口岸国际物流专用版车台

16

无锡新（2003.1）出租车0303

新无锡出租与中心协议（200301月07日）.doc

2异或校验

F027,F029

移舟无锡新版出租车车台

17

移舟晓位星0100

随身宝通讯协议

2异或校验

FFE0

晓位星

18

深圳伊爱公司车台0100

无

1无校验

目前崭定为ER,E0,E1,F0,

80,92,B2,B3,A4

将来统一为EI

深圳伊爱公司车台

19

南京中兴通讯公司接入的GpsOne设备

0300

L1接口协议

无校验

?

?

通过L1协议接入南京中兴通讯公司的MPC（移动定为中心）兼容高通公司的基于CDMA的GpsOne设备

20

北京龙运通科技公司介入的AGPS设备

0300

Lif接口协议

无校验

@@

通过Lif协议接入龙运通科技公司的MPC（移动定为中心）兼容其AGps设备

21

厦门雅讯

0300

无校验

厦门雅讯GK110

22

北京赛博

0300

无校验

北京赛博0300

23

北京移舟云南玉溪红塔车台

0308

2异或校验

FF01,FF21,FF22

24

四川大科星

0300

无校验

四川大科星0300

25

塞格0301

无校验

塞格0301

26

北京移舟GPRS车台

0309

GGPRS车载定位仪车载单元与监控中心通信协议

（版本：

Ver1.0）

异或校验和CRC校验

移舟GPRS车台

0309

27

北京移舟CDMA车台

0310

吴无锡CDMA出租车车台

异或校验和CRC校验

移舟GPRS车台

0310

28

北京康讯

0300

无校验

北京康讯车台

0300

29

北京移舟定位通0311

定位通”车载定位议车载单元与监控中心通信协议（版本：

Ver1.0）

异或校验

F088,F089,F08A

北京移舟定位通0311

30

北京移舟无锡CDMA0312

CDMAYNM6000车载单元与中心通信协议（无锡版）.doc

异或校验

北京移舟

无锡CDMA

0312

⏹DType:

设备种类

设备种类定义对照表

代号

设备类型

备注

01

车载控制单元（车台）

02

随身宝（晓位星）

03

报警器

04

行驶记录仪（绿匣子）

05

CDMA的GpsOne

06

龙运通的AGPS

⏹DPWD:

设备口令

⏹DCheckSum:

设备校验方式

校验方式，控制单元内部用的编码校验方式对照表

代号

意义

代号

意义

1

无校验

2

异或校验

3

FEC-15校验

4

FEC-2校验

5