Mercury系统指令集综述.docx

1、Mercury系统指令集综述Mercury系统指令集版本 1.0k， 2002年9月2日作者：吴亦瓯目录I.综述本指令集用于定义Mercury系统的功能表实现，并用于规定客户端对服务器的调用格式，以及服务器向客户端返回数据的格式。a)基本格式本指令集采用格式化字符串和结束符组成。指令名，参数名大小写敏感。每条指令结束，必须有结束符。结束符为：#字符串中由“键-值对”和分隔符组成。 “键-值对”格式如下：Key:=Value其中，Key为任意键名，应符合.net变量名规则。Value为字符串，可以包括字母和字符，但不可以包括 | , ; ，因为这些字符是本指令集的分隔符。键和值之间，用“:=”连

2、接。分隔符有4级。分别为：& | , ;&用来分割“键-值对”。| , ; 作为值中的分割符，可用于表示比较复杂的值。Value的空值为空字符串：“”。（注意：构造指令字符串时，不要加上双引号，一般来讲，等号后为空。）b)公用键以下键因为使用的指令较多，在此集中说明。1)发送必选键所有指令，都应该包含以下键：ActID本指令的指令代码。CID发出本指令的客户端代码。SID本指令的流水号。除了ClientReg外，所有指令都应该由客户端指定SID.2)返回必选键ActID: 对应发送指令的ActID。SID: 用于与发送指令对应。Successed: T|F，表示指令是否成功执行。ErrCode

3、: 如果未成功，错误代码。ErrDesc: 如果未成功，错误的描述。3)可选键SIM接受指令的通信设备ID。可为空。HostName接受指令的通信设备的宿主名（例如车牌号）。当SIM为空时，此参数有效，否则以SIM为准。RValue发送端期望原封不动返回的值。可用于对指令的判别处理。说明：如无特殊说明在所有需要给出SIM的指令，都可以替代性的给出HostName。但这些指令中，不应二者都不给出。II.指令集详述以下各指令中，如无特殊说明，都应包括 I (b)中规定的必选键，并按其规定使用。a)初始化1)ClientReg指令定义：本指令用于客户端向中心注册。所有客户端在发起请求前，都必须向中心

4、注册，并得到中心的认证，才能继续执行操作。发送参数表：CID: 空值SID: 空值UID: 用户登录名PWD: 用户口令ChannelType: 客户端与服务器的通信通道类型。可以为下列值:Q: Message QueueT: TCP/IPR: RemotingW: WebClientAddress: 客户端地址。仅当ChannelType=Q时有效，此时此值为客户端接收服务器返回的消息的Message Queue Path.ClientType: 客户端软件的类型。可以为下列值：T: 客户端为终端应用，直接面向最终用户。S: 客户端为服务应用，作为服务运行，如报警监控，预约呼车，Exchan

5、ge LinkClientAppName: 客户端软件的应用名。返回参数表：CID: 如果指令成功，返回系统分配的客户端ID。SvrTime: 当前服务器的系统时间。其他说明：此指令成功执行后，客户端才能获得有效的CID。客户端必须自行维护CID。以后所有指令都必须携带此CID方能被服务器接受。服务器会纪录客户的UID/PWD。以后指令不必再携带UID/PWD。2)ClientUnReg指令定义： 本指令用于客户端向服务器声明退出。发送参数表：公用参数返回参数表：公用参数。其他说明：建议客户端正常退出时发送本指令。如果不发送，服务器的垃圾收集可自动删除客户端注册，但会有一定延迟。3)Clien

6、tConnect指令定义： 客户端在意外情况下与服务器断开（3分钟内，否则服务器将清除该客户端），或者发出ClientDisconnect 之后，需要重新登陆上来时，可以发出该指令。注意：此时客户端必须指明系统原先分配的CID发送参数表：公用参数返回参数表：公用参数SvrTime: 当前服务器的系统时间。4)ClientDisconnect指令定义： 客户端需要保留对某些车辆的呼叫状态时可以暂时断开与服务器的连接。最大时间限制可以通过配置参数设定。（默认值为：60分钟）发送参数表：公用参数返回参数表：公用参数b)查询静态信息5)QueryGKDB指令定义：本指令用于客户端查询服务器中核心数据库

7、的数据。发送参数表：ObjType: 指定要查询的对象类型。可以为以下值：DEV: Device对象可选KeyField:SIM, DevIDHOST: Host对象可选KeyField:NameUSER: User对象可选KeyField:NameKeyField: 指定查询所用的关键字段允许同时查询多个字段，各关键字间用“|”分隔。KeyValue: 给出查询字段的值。可以一次查询多个字段的值。多个值之间用“|”分格。返回参数表： Fields: 字段名，多个字段用“|”分割。Value: 字段值，多个字段用“|”分割。当查询为多个值时，返回的纪录之间用 “；”分隔Value可能为空值其他

8、说明：调用本指令需要用户对对象有权限。6)GetSysInfo指令定义：本指令用于客户端查询服务器系统的基本信息。发送参数表：公用参数。返回参数表： Version: 服务器系统的版本号。多个软件版本用“|”分割，每个格式为：“软件名，版本号”AdapterAddr: GPS Adapter服务的地址。格式为：Q, Queue Path|T，IP:PortDataWinAddr: GPSDataWin服务的地址。格式为：Q, Queue Path|T，IP:PortCenterName: 中心名。每个GPS Server的唯一ID其他说明：调用本指令需要管理员权限。7)QueryAdapter

9、指令定义：本指令用于查询当前连接Adapter的客户程序情况。发送参数表：QueryCat: 要查询的类别。可以为下列值：RegConn: 列出当前连接在本Adapter上的所有客户信息，包括Service和Exchange.Service: 列出当前本中心上的Service.Exchange: 获得当前Exchange连接情况，以及通过Exchange请求的数据情况。返回参数表：QueryCat: 要查询的类别。与发送给出的值相同。AdapterRPT: 根据不同的QueryCat, Adapter返回的数据。根据QueryCat的不同，格式有所不同。如下：RegConn:格式：CID,UI

10、D,ClientType,ClientAppName|CID,UID,ClientType,ClientAppName 其内容相当于ClientReg时填写的内容。直接将值返回。顺序必须按上述顺序。Service: 格式：CID,UID,ServiceName,ServiceOtherData|直接将值返回。顺序必须按上述顺序。ServiceName实际上是ClientAppName, ServiceOtherData为Service自行维护的，要返回给客户端的其他信息，但要注意其中的分隔符不要有“，”或“|”。Exchange: 格式：ECID,UID,GCID|ECID: Exchange

11、 Client IDUID: UserID.GSID: Gps Server ID其他说明：调用本指令需要管理员权限。8)QueryDataWin指令定义：本指令用于客户端从DataWindow取得数据。发送参数表：SIM: 要查询的设备的SIM卡号。一次可查询多个设备，各SIM用“|”隔开。如果SIM为“0”则按此条指令按以下规则处理：返回当前在DataWin中所有设备的最后一条数据。但此数据时间不应早于StartTime。如果StatrTime=“”则忽略此限制。除StartTime外其他参数全部忽略。StartTime:要求的结果信息最早时间。格式为yyyy-MM-dd HH:mm:ss

12、，如2001年11月8日14点20分3秒表示为2001-11-8 14:20:3。如果StartTime=“”，则相当于不限制开始时间。ResultNum:要求的结果信息条数。Latest: T|F逻辑值。设定返回的信息是否必须为最新数据。QUID可选。指定用于执行查询的用户ID。如果不给，则使用客户端当前用户。QPWD可选。给出QUID对应的口令。ClientAddress内部使用。为返回数据的地址。返回参数表：DataWinResult:格式：SIM,GPSREC;GPSREC2;GPSRECn|SIM,GPSRECGPSREC格式：Lon$Lat$Speed$Dir$SatNum$Sta

13、tus$GPSTime$MSGTime$Other其中，GPSTime为GPS设备的定位时间，MSGTime为消息到达系统的时间。分隔符为”$”。其他说明：发送参数的值以及期望结果，见下表：StartTimeResultNumLatest结果空0Any本设备当前在DataWin中所有数据。指定时间0Any从指定时间起到最新所有数据。空nT最新n条。不够n条则返回所有最新数据。指定时间NT最新n条，但不超过指定时间。不够n条则到指定时间止。指定时间nF指定时间起n条，不够n条则到目前最新一条止。对于查询的设备，如果没给出QUID，则客户端的连接用户必须有相应的权限。如果给出了QUID，则QUID

14、用户必须有相应权限。9)QueryHistoryData指令定义：本指令用于获得某一设备在某段时间内的历史数据。发送参数表：SIM: 要查询的设备的SIM卡号。一次可查询一个设备。StartTime:要求的结果信息最早时间。格式为yyyy-MM-dd HH:mm:ss，如2001年11月8日14点20分3秒表示为2001-11-8 14:20:3。EndTime要求的结果信息最晚时间。格式为yyyy-MM-dd HH:mm:ss，如2001年11月8日14点20分3秒表示为2001-11-8 14:20:3。Latest: T|F逻辑值。设定返回的信息是否必须为最新数据。此设定仅当结果纪录数超

15、过最大结果数限制，并且AutoFit=F时有效。当Latest=T时，返回的结果满足EndTime条件。否则，满足StartTime条件。AutoFit: T|F逻辑值。设定当结果记录数多于最大允许结果时，是否自动调整结果集的间隔，以返回覆盖查询时间段并且不超过记录数限制的结果集。调整方法如下：设在给定时间段内总记录数为N，最大允许记录数为M则，当NM时，r=N/M（四舍五入取整），每r条记录，取星数最多的记录为有效记录返回给客户端。目前系统规定：N=10000; M=1000QUID可选。指定用于执行查询的用户ID。如果不给，则使用客户端当前用户。QPWD可选。给出QUID对应的口令。Cli

16、entAddress内部使用。为返回数据的地址。返回参数表：本指令可能产生多条返回参数。但每条都有同样的SID。每条的结构如下：ResultRecCount: 整数。表示返回结果的总纪录数。ResultPageCount: 整数。表示返回结果包的总数。ResultPageIndex:整数。表示本次返回记录包的顺序号。AutoFit: T|F逻辑值。表示是否进行了AutoFit。参见发送参数的AutoFit.ExceedResult: T|F逻辑值。表示结果记录数是否超出了最大结果数限制。SIM:结果设备的SIM卡号。HistoryREC:字符串。返回的数据包。格式：GPSREC;GPSREC2

17、;GPSRECnGPSREC格式：Lon$Lat$Speed$Dir$SatNum$Status$GPSTime$MSGTime其中，GPSTime为GPS设备的定位时间，MSGTime为消息到达系统的时间。分隔符为”$”。其他说明：对于查询的设备，如果没给出QUID，则客户端的连接用户必须有相应的权限。如果给出了QUID，则QUID用户必须有相应权限。10)QueryUserAuth指令定义：本指令用于测试用户对设备的权限以及用户自身权限。发送参数表：SIM:要查询的设备的SIM卡号。一次只可查询一个设备。QUID指定要测试权限的用户ID。如果不给，则使用客户端当前用户。AuthType:指

18、定要测试的是用户权限还是用户对设备的授权。可取下列值：A: 测试的是用户对设备的权限，SIM参数指定设备。R: 测试的是用户自身权限，SIM值无效。L: 不进行测试，而是列出用户对设备的所有权限，以及用户自身权限。RightCode:指定要测试的权限类型。可取下列值：1: 用户对设备的查询位置权限2: 用户对设备的位置呼叫权限3: 用户对设备的控制权限4: 用户对设备的发格式信息权限5: 用户对设备的发无格式信息(RawMessage)权限6: 用户查询设备当前状态权限A: 用户可收到Alarm权限I: 用户可收到Message权限 （包含RawMessage和格式Message）R: 用户可

19、重复注册权限返回参数表：当AuthType=A或R时返回：Auth: T|F，表示此权限测试是否通过。当AuthType=L返回：RightCode: 权限列表。定义同发送的RightCode。格式为连续字符。例如：146A。其他说明：由于只查询用户权限，所以不需要用户口令。11)QueryUserDeviceAuth指令定义：本指令用于查询某一用户有权限的所有设备。发送参数表：QUID指定要查询的用户ID。如果不给，则使用客户端当前用户。QPWD指定要查询的用户口令。仅当QUID给出时使用。HostGroupID可选。如果给出，则查询范围限定在指定Host组。返回参数表：RightCode列

20、出用户有权限的设备列表。格式如下：SIM,HOSTNAME,RightCode| SIM,HOSTNAME,RightCode|SIM：设备SIM号。HOSTNAME为设备宿主名RightCode:用户对设备所拥有的权限类型。可取下列值：1: 用户对设备的查询位置权限2: 用户对设备的位置呼叫权限3: 用户对设备的控制权限4: 用户对设备的发格式信息权限5: 用户对设备的发无格式信息(RawMessage)权限6: 用户查询设备当前状态权限其他说明：12)QueryUserHostGroupAuth指令定义：本指令用于查询某一用户有权限的宿主组。发送参数表：QUID指定要查询的用户ID。如果不

21、给，则使用客户端当前用户。QPWD指定要查询的用户口令。仅当QUID给出时使用。返回参数表：GroupList列出用户有权限的组名和ID列表。格式如下：HostGroupName,GroupID|HostgroupName,GroupID | HostGroupName,GroupID其他说明：13)QueryDevCompatible指令定义：本指令用于查询某设备的下行控制指令兼容性。发送参数表：SIM:要查询的设备的SIM卡号。一次只可查询一个设备。由原始调用者（客户端）填写。返回参数表：SIM: 设备的SIM卡号DFactoryID: 设备厂家名称DFactoryID生产厂家代号对照表代

22、号公司名称备注00（立移讯车台）原始车台01北京移舟启程信息技术有限公司02深圳华强通信技术有限公司03摩托罗拉04北京大恒05北京长征航信704所06台湾AVL-200007赛格08深圳伊爱公司09南京中兴通讯公司和高通公司10龙运通科技有限公司11厦门雅讯有限公司12北京赛博有限公司13四川大科星有限公司14北京康讯科技股份有限公司DVersion:设备版本号，长度为四位，如3.00表示为0300版本号表（目前兼容的设备表）序号版本号对应设备协议版本号校验方式数据包头说明1立移讯假车台测试用1无校验FFAA FFAB FFAC FFAD2移舟车台0300北京移舟GPS车载定位监控系统V3.

23、0 YQ-YF010-013-20012异或校验FF80 FF70 FF50奥星天网用通用协议3移舟行车记录仪0301北京移舟GPS多功能行车记录仪系统成都专用版V1.0 YQP001-T-A0022异或校验FF9A FF9B FF9C FF9D行车记录仪用成都专用4赛格车台0300基于GSM网的GPS监控报警系统车载终端与通信网关通信协议(SEG-9888系列2000型)1无校验（编号：T2000_000002_325704所车台0100704所GSM车辆调度系统通信协议（修订版）1无校验.3D TT/.北京704所车台6深圳华强车台0500深圳华强GSM二代无线传输协议版本5.0HQ600

24、6系列B(货运型)1无校验*华强车台7台湾AVL车台0300車輛定位系統AVL-2000使用手冊1无校验#广东凌科代理输出接设防撤防开关8台湾AVL车台0301 車輛定位系統AVL-2000使用手冊1无校验#广东凌科代理输出接断油接通油路开关9移舟一键通小车台0301GPS车载定位监控调度系统车载单元与监控中心通信协议（版本：Ver3.12B）2异或校验移舟一键通10移舟行车记录仪0300北京移舟GPS多功能行车记录仪系统V3.0 YQP001-T-A0022异或校验FF90 FF97 FF98 FF99行车记录仪用通用协议11移舟一键通小车台0302AXP系列GPS车载定位仪车载单元与控制中

25、心通信协议1.0版2异或校验F080 F070 F050移舟一键通小车台12移舟云南烟草车台03042异或校验FF01移舟云南烟草车台13无锡版出租车0305出租车项目通讯协议（1.2）(12.3)2异或校验FF10,FF11移舟无锡版出租车车台14杭州版出租车0306杭州出租与中心协议（10月23日）2异或校验F02A,F02B,F02C,F02D移舟杭州版出租车车台15杭州口岸国际物流0307杭州口岸国际物流专用版1.0版2异或校验F03A F03B F03C F03D移舟杭州口岸国际物流专用版车台16无锡新（2003.1）出租车0303新无锡出租与中心协议（200301月07日）.doc

26、2异或校验F027,F029移舟无锡新版出租车车台17移舟晓位星0100随身宝通讯协议2异或校验FFE0晓位星18深圳伊爱公司车台0100无1无校验目前崭定为ER,E0,E1,F0,80,92,B2,B3,A4将来统一为EI深圳伊爱公司车台19南京中兴通讯公司接入的GpsOne设备0300L1接口协议无校验?通过L1协议接入南京中兴通讯公司的MPC(移动定为中心)兼容高通公司的基于CDMA的GpsOne设备20北京龙运通科技公司介入的AGPS设备0300Lif接口协议无校验通过Lif协议接入龙运通科技公司的MPC(移动定为中心)兼容其AGps设备21厦门雅讯0300无校验厦门雅讯GK11022

27、北京赛博0300无校验北京赛博030023北京移舟云南玉溪红塔车台03082异或校验FF01,FF21,FF2224四川大科星0300无校验四川大科星030025塞格0301无校验塞格030126北京移舟GPRS车台0309GGPRS车载定位仪车载单元与监控中心通信协议 (版本：Ver1.0) 异或校验和CRC校验移舟GPRS车台030927北京移舟CDMA车台0310吴无锡CDMA出租车车台异或校验和CRC校验移舟GPRS车台031028北京康讯0300无校验北京康讯车台030029北京移舟定位通0311定位通”车载定位议车载单元与监控中心通信协议(版本：Ver1.0)异或校验F088,F089,F08A北京移舟定位通031130北京移舟无锡CDMA0312CDMAYNM6000车载单元与中心通信协议(无锡版）.doc异或校验北京移舟无锡CDMA0312DType: 设备种类设备种类定义对照表代号设备类型备注01车载控制单元（车台）02随身宝（晓位星）03报警器04行驶记录仪（绿匣子）05CDMA的GpsOne06龙运通的AGPSDPWD: 设备口令DCheckSum: 设备校验方式校验方式，控制单元内部用的编码校验方式对照表代号意义代号意义1无校验2异或校验3FEC-15校验4FEC-2校验5