平台与终端接口规范V13实际需要实施部分.docx
- 文档编号:7867460
- 上传时间:2023-01-26
- 格式:DOCX
- 页数:22
- 大小:111.23KB
平台与终端接口规范V13实际需要实施部分.docx
《平台与终端接口规范V13实际需要实施部分.docx》由会员分享,可在线阅读,更多相关《平台与终端接口规范V13实际需要实施部分.docx(22页珍藏版)》请在冰豆网上搜索。
平台与终端接口规范V13实际需要实施部分
1接口规范功能及流程
本接口规范支持PDU短信、CDMA1X、ADSL等承载方式。
1.1主终端登录前请求接入模块IP和端口
主终端/手机在登陆T8系统前,向分布式接入前置机请求获取主终端/手机接入模块IP和端口。
分布式接入前置机基于TCP/IP协议
端口:
IP:
分布式接入前置机根据负载均衡算法,将较空闲的接入模块IP和端口发给申请连入T8平台的主终端或手机。
流程如下图所示:
1.2终端获取安全码
在前置机获取到接入模块的IP和端口后,连接上接入模块,在登入之后需发送一条获取安全码的命令,以获取安全码与客户密码混合并加密,这个混合加密之后的密码是用于登陆鉴权。
流程如下图所示:
1.3终端设备登录
主终端必须登录到T8平台,才能与T8平台进行数据交互,除非流程有特别说明,否则T8平台不接受没有登录的主终端业务请求。
主终端登录流程如下图所示。
1.主终端向平台发送登录请求。
登录上报参数(参见“LOGIN_REQ包体定义”)。
2平台对主终端进行审核鉴权后,向主终端回送登录结果响应(参见“LOGIN_ACK包”)
3.主终端根据登录结果信息设置其状态。
如果允许接入到平台,主终端处于工作激活状态,根据设定的工作方式工作;
如果禁止接入到平台,主终端处于非激活状态,通过指示灯报警。
4.登录成功后,主终端如果是第一次登陆,需要向平台上报参数配置(参见终端设备向平台上报参数配置流程)
1.4终端设备登出
主终端在退出服务时向T8平台发送的信息(参见“LOGOUT_REQ”),表示主终端暂时不提供服务,T8平台收到后给予响应(参见“LOGOUT_ACK”包,)。
1.5主终端连接检查
需要长时间在线工作时,主终端需要定期向T8平台发送连接检查消息(参见“HEART_BEAT_REQ”包),表示处于工作状态,T8平台收到后给予响应(参见“HEART_BEAT_ACK”包)。
主终端如果连续接收不到T8平台的心跳响应信息的次数达到阈值,则主终端与T8平台之间可能处于通信故障状态,主终端通过指示灯报警。
流程如下:
1.6终端设备向平台上报配置信息
主终端在登入T8平台后或者主终端参数改变时,主动上报主终端的配置信息(参见“REPORT_CONFIG_REQ”)。
T8平台收到请求后将配置数据写入数据库,并发回响应ACK(参见“REPORT_CONFIG_ACK”)。
流程如下:
1.7终端设备与行业应用平台间的数据透传
主终端可以经由平台向应用系统发送自身的采集数据。
数据的传输采用TRANSPARENT_DATA_REQ及TRANSPARENT_DATA_ACK消息。
此数据包即可由主终端发起,平台确认(主动上报数据);也可能由T8平台发起,主终端确认(请求——应答模式)。
在TRANSPARENT_DATA_REQ和TRANSPARENT_DATA_REQ中的包体数据对于平台是透明、不可或不需理解的业务流数据,T8平台只是数据进行路由转发。
注意:
平台只是对数据进行存储转发。
响应消息只是代表接收方已经收到数据,不代表接收方已经对这些数据进行了业务上的处理。
流程如下:
1.8主终端设备告警故障上报
主终端在检查到自身发生异常时,将发起故障上报流程,将故障信息通过ALARM_REPORT_REQ(参见.“ALARM_REPORT_REQ”包)上报给平台,平台收到并处理后,通过ALARM_REPORT_ACK(参见“ALARM_REPORT_ACK”包)发送反馈信息给主终端。
流程如下:
1.9主终端软件远程下载升级
主终端可以通过平台或第三方的升级服务器对其软件进行升级。
主终端厂商将升级软件包发布到平台上,或由第三方的升级服务器通知T8平台有新的升级软件,由平台接收到升级文件或通知后在平台上创建升级事务,并向主终端下发升级通知。
终端接主终端收到升级通知后,根据其自身情况判断是否需要升级,并向T8平台响应(DOWNLOAD_INFO_ACK包,参见“DOWNLOAD_INFO_ACK包体定义”)。
主终端如果需要升级其软件,则在其空闲时向第三方的升级服务器请求下载升级文件。
流程如下:
1.10主终端上报软件升级信息
主终端如果进行了软件相关操作后,需要向T8平台上报软件操作的相关信息。
通过SOFTWARE_REPORT_REQ(参见.“SOFTWARE_UPDATE_REPORT_REQ”包)上报给T8平台,T8平台收到并处理后,通过SOFTWARE_UPDATE_REPORT_ACK(参见“SOFTWARE_UPDATE_REPORT_ACK”包)发送反馈信息给主终端。
流程如下:
2接口定义
接口定义的消息目前有2种:
Request和Response。
Request是请求消息,Response是对请求的响应,Request和Response消息是一一对应的。
2.1消息结构
2.2消息头格式
字段
长度(字节)
数据类型
备注
消息头
报文总长度
2
Integer
消息类型代码
2
Integer
CommandID
流水号
4
Integer
报文协议版本
2
OctetString
保留字
2
Integer
取值始终为0
主终端设备编码
16
OctetString
消息发送时刻
4
Integer
当前系统时间,从1970-1-100:
00:
00到当前的秒数。
状态
1
Integer
Request消息:
0代表不使用
Response消息:
1代表成功,2代表失败,3代表报文协议版本不兼容。
其他的值根据具体的消息类型代码而定。
报文字段说明:
报文总长度:
整个报文的长度;
消息类型代码:
标识该报文的消息,如:
远程配置、下载更新、数据采集等,即CommandID。
流水号:
唯一标识发送方发出的每一次监控管理请求。
接收方回复请求时,将该流水号原样返回。
发送方各自维护自己的流水号(从0x00000000到0xFFFFFFFF),每发出一次请求,该流水号自动加1。
报文协议版本:
标识报文发送方使用的报文协议版本,接收方可根据该编号进行相应的处理或拒绝。
协议版本用两个字节表示,第一个字节是主版本号,第二个字节是次版本号。
版本号均数字,例如2.1版本表示为0000001000000001。
保留字:
建议留作以后行业协议版本扩展使用,取值为0。
主终端设备编码:
主终端设备的唯一标识,由平台统一分配管理。
状态:
标识Response消息的执行状态。
Request消息填0.
2.3消息体定义
2.3.1字段说明
CRC32校验值:
该字段后面的所有字段进行CRC32计算后的值,如果后面没有字段,则该值为0。
接收方收到提交的消息包后,对CRC32校验字段后面的所有字段进行CRC32计算,将计算出来的值和该字段做比较,相等代表接收数据无误,否则错误。
2.3.2命令类型
2.3.2.1BEFORE_LOGIN_REQ包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x0200
1
接入设备类型
1代表主终端接入
2代表手机客户端接入
Integer
0x0208
Value部分的长度
用户账号
OctetString
2.3.2.2BEFORE_LOGIN_ACK包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x0201
Value部分的长度
主终端接入模块IP
OctetString
0x0202
2
主终端接入模块端口
Integer
0x0203
Value部分的长度
手机接入模块IP
OctetString
0x0204
2
手机接入模块端口
Integer
0x0205
Value部分的长度
FTP服务器IP
OctetString
0x0206
2
FTP服务器端口
Integer
说明:
如果是手机接入,消息体无0x0201,0x0202终端接入模块IP和端口。
如果是终端接入,消息体无0x0203,0x0204手机接入模块IP和端口。
2.3.2.3GET_AUTH_CODE_REQ包体定义
无消息体
2.3.2.4GET_AUTH_CODE_ACK包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x0207
16
安全码
OctetString
2.3.2.5LOGIN_REQ包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x0208
Value部分的长度
用户账号
OctetString
0x0209
32
网关登入鉴权码
(用户密码经MD5加密密文+安全码再进行一次MD5加密后长度32位的密文)
即(网关密码(md5)+安全码)(md5)
OctetString
0x020F
16
替换终端对应的旧终端序编码
OctetString
2.3.2.6LOGIN_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
4:
非法IMSI
5:
终端设备编码无效
6:
旧终端序编码无效
其他:
保留。
字段
长度
说明
数据
CRC32校验值
4
Integer
0x020C
4
网关接入序列号(也称网关短号)
网关短号生成规则:
总共4个字节
第一个字节代表在某个城市所注册的平台
后3个字节由注册的平台统一分配以个唯一标识的,用来区分网关
Integer
0x020D
Value部分的长度
FTP服务器上本网关专有目录访问密码
OctetString
0x020E
Value部分的长度
网关的外网IP位置
OctetString
2.3.2.7LOGOUT_REQ包体定义
没有消息体。
2.3.2.8LOGOUT_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
没有消息体。
2.3.2.9HEART_BEAT_REQ包体定义
由于要维持通讯过程,必须发送维持心跳包以维持,主终端在没有实际数据达到预先设置的间隔值时,发送HEART_BEAT_SINK包以维持当前过程据
字段
长度
说明
数据
CRC32校验值
4
Integer
0x3007
1
参见附录A中监控相关内容
Integer
0x3005
4
上一次心跳延时
Integer
0x3011
4
主终端上报丢包数
Integer
2.3.2.10HEART_BEAT_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
对HEART_BEAT_REQ的响应。
没有消息体
2.3.2.11TRANSPARENT_DATA_REQ包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x0026
Value部分的长度
终端与应用服务器之间的交互数据
OctetString
2.3.2.12TRANSPARENT_DATA_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
没有消息体
2.3.2.13REPORT_CONFIG_REQ包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x1000
Value部分的长度
软件名称
OctetString
0x1002
Value部分的长度
软件版本
OctetString
因网关可能同时运行多款软件,因此需上报多款软件信息,软件名称和软件版本必须成对出现,且不能更改顺序。
0x1000
Value部分的长度
软件名称
OctetString
0x1002
Value部分的长度
软件版本
OctetString
可选参数
参见附录A,配置参数相关内容。
参见附录A,统计相关内容里面的T8平台发给主终端部分。
2.3.2.14REPORT_CONFIG_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
没有消息体。
2.3.2.15ALARM_REPORT_REQ包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x3009
Value部分的长度
故障告警时间
yyyy-MM-ddHH:
mm:
ss
OctetString
0x300c
1
故障告警信息类型
Integer
0x3010
Value部分的长度
故障告警原因
OctetString
0x020A
1
是否为主终端
1为主终端
0为子终端
Integer
0x020B
16
告警设备序列号
OctetString
0x3012
Value部分的长度
用户的手机号码
多个手机号码以英文分号隔开
OctetString
可选参数
其他TAG组部分,TLV中TAG定义,参见附录A中监控相关内容。
2.3.2.16ALARM_REPORT_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
没有消息体
2.3.2.17BROADCAST_DOWNLOAD_INFO包体定义
对某类主终端,有新的软件版本时,T8定时向主终端广播发送升级通知。
字段
长度
说明
数据
CRC32校验值
4
Integer
0x1000
Value部分的长度
软件名称
OctetString
0x1002
Value部分的长度
软件版本
OctetString
0x1004
Value部分的长度
软件下载的URL
OctetString
0x1005
Value部分的长度
FTP软件下载目录访问用户名
OctetString
0x1006
Value部分的长度
FTP软件下载目录访问密码
OctetString
0x1007
Value部分的长度
软件大小
OctetString
2.3.2.18BROADCAST_DOWNLOAD_INFO_ACK包体定义
主终端对BROADCAST_DOWNLOAD_INFO的响应。
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
4:
已是最新版本,不需更新
5:
立即准备更新
6:
主终端正在执行业务,暂缓更新
7:
主终端不支持升级协议
8:
URL参数无效
没有消息体
2.3.2.19REQUEST_DOWNLOAD_INFO包体定义
主终端定时主动请求软件升级请求命令。
主要解决网关长时在线,不能通过登录后发送软件版本来达到升级的方式。
无消息体
2.3.2.20REQUEST_DOWNLOAD_INFO_ACK包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x1000
Value部分的长度
软件名称
OctetString
0x1002
Value部分的长度
软件版本
OctetString
0x1004
Value部分的长度
软件下载的URL
OctetString
0x1005
Value部分的长度
FTP软件下载目录访问用户名
OctetString
0x1006
Value部分的长度
FTP软件下载目录访问密码
OctetString
0x1007
Value部分的长度
软件大小
OctetString
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
4:
已是最新版本,不需更新
如果平台从数据库中查找主终端目前运行的所有软件程序都是最新的,则无消息体,消息头状态为4.
2.3.2.21SOFTWARE_UPDATE_REPORT_REQ包体定义
字段
长度
说明
数据
CRC32校验值
4
Integer
0x1000
Value部分的长度
软件名称
OctetString
0x1001
Value部分的长度
软件升级时间
yyyy-MM-dd24hh:
mm:
ss
OctetString
0x1002
Value部分的长度
软件版本
OctetString
0x1008
Value部分的长度
升级结果
(详情见附录)
OctetString
2.3.2.22SOFTWARE_UPDATE_REPORT_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
没有消息体
2.3.2.23SPLIT_REQ包体定义
发送方要将信息拆包发送的时候,使用该命令。
字段
长度
说明
数据
CRC32校验值
4
Integer
0x0025
6
分包机制参数(分包机制参见附录A)。
1~2字节——分包事务的ID,为分包机制发起方临时生成的随机数
3~4字节——子包总数
5~6字节——子包序号
Integer
0x0026
Value部分的长度
Value部分是实际要传输的数据
OctetString
2.3.2.24SPLIT_ACK包体定义
消息头状态取值:
1:
成功
2:
失败
3:
报文协议版本不兼容
没有消息体
3消息类型代码定义
消息类型
Command_id
说明
LOGIN_REQ
0x0001
设备向平台发送的登录包
LOGIN_ACK
0x8001
平台向设备发送的连接登录响应
LOGOUT_REQ
0x0002
设备与平台之间发送的断开连接
LOGOUT_ACK
0x8002
设备与平台之间发送的断开连接响应
HEART_BEAT_REQ
0x0003
设备向平台发送的维持过程连接
HEART_BEAT_ACK
0x8003
平台向设备发送的维持过程连接回应
TRANSPARENT_MASTER_DATA_REQ
0x0004
可以双向传输的透明数据
TRANSPARENT_MASTER_DATA_ACK
0x8004
对可以双向传输的透明数据包的响应
REPORT_CONFIG_REQ
0x0005
主终端主动向平台上报参数
REPORT_CONFIG_ACK
0x8005
平台收到参数响应ACK
ALARM_REPORT_REQ
0x0006
主终端上报告警和故障信息
ALARM_REPORT_ACK
0x8006
T8平台对收到的告警和故障信息进行响应
BROADCAST_DOWNLOAD_INFO
0x0007
平台向主终端广播发送升级通知。
BROADCAST_DOWNLOAD_INFO_ACK
0x8007
主终端对平台发起下载更新通知的响应
SOFTWARE_UPDATE_REPORT_REQ
0x0008
软件升级信息上报请求
SOFTWARE_UPDATE_REPORT_ACK
0x8008
软件升级信息上报响应
BEFORE_LOGIN_REQ
0x0009
登陆T8平台前,向分布式接入前置机请求获取接入模块IP和端口
BEFORE_LOGIN_ACK
0x8009
向分布式接入前置机下发接入模块IP和端口
GET_AUTH_CODE_REQ
0x000A
登陆验证安全码请求
GET_AUTH_CODE_ACK
0x800A
登陆验证安全码响应
SPLIT_REQ
0x000B
分包请求
SPLIT_ACK
0x800B
分包请求响应
REQUEST_DOWNLOAD_INFO
0x000C
主终端主动请求软件升级请求命令
REQUEST_DOWNLOAD_INFO_ACK
0x800C
平台向对主终端主动请求软件升级请求命令响应
[文档可能无法思考全面,请浏览后下载,另外祝您生活愉快,工作顺利,万事如意!
]
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 平台 终端 接口 规范 V13 实际 需要 实施 部分