卡口视频监控系统手机APP接入服务器通信协议文档.docx

1、卡口视频监控系统手机APP接入服务器通信协议文档卡口视频监控系统手机APP接入服务器通信协议文档日期版本作者描述1.0目录1引言 31.1编写目的 31.2背景 31.3定义 31.4参考资料 32文档约定 33系统的结构 44传输协议 44.1协议介绍 44.2协议说明 44.2.1数据头 54.2.2数据优化 74.2.3数据内容 94.3数据类型 114.4协议事物 124.5协议简化定义 125协议枚举定义 125.1协议枚举定义值规则说明 125.2手持终端与中心服务器通信枚举 125.3卡口设备与中心服务器通信枚举 195.4通用响应枚举 216手持终端 226.1登录 226.2

2、保持在线 236.3用户管理 246.3.1获取用户列表 246.3.2添加帐号 246.3.3修改用户 256.3.1删除帐号 256.4修改密码 256.5卡口管理 266.5.1获取卡口列表 266.5.2添加卡口设备 266.5.3修改卡口设备 276.5.4删除卡口设备 276.6对讲 286.6.1发起对讲 286.6.2收到对讲 286.6.3结束对讲 296.6.4对方结束对讲 306.7实时语音广播 306.7.1发起广播 306.7.2结束广播 306.7.3卡口结束广播 316.8摄像机参数设置 316.8.1获取摄像机参数 316.8.2设置摄像机参数 336.9摄像机

3、录像设置 346.9.1获取录像计划 346.9.2设置录像计划 346.10摄像机录像设置 356.10.1获取抓图参数 356.10.2设置抓图参数 366.11区域入侵侦测开关 366.11.1获取区域入侵侦测 366.11.2设置区域入侵侦测 376.12摄像机报警 386.13摄像机状态 396.13.1摄像机上线 396.13.2摄像机掉线 396.14卡口状态 396.14.1卡口上线 396.14.2卡口掉线 396.15订阅设备状态 406.16取消订阅设备状态 406.17通知添加卡口设备 406.18通知删除卡口设备 416.19获取卡口详细信息 416.20获取报警录音

4、文件列表 416.21获取报警录音文件 426.22上传报警录音文件 426.23添加报警录音文件 426.24修改报警录音文件 436.25删除报警录音文件 436.26获取广播录音文件列表 446.27获取广播录音文件 446.28上传广播录音文件 446.29添加广播录音文件 446.30修改广播录音文件 456.31删除广播录音文件 456.32卡口报警联动 466.32.1获取卡口报警联动 466.32.2获取卡口报警联动录音文件 466.32.3上传卡口报警联动录音文件 476.32.4设置卡口报警联动 476.33文件上传下载 476.33.1下载文件 476.33.2上传文件

5、486.33.3取消流传输 496.33.4收到取消流传输 496.34卡口广播 496.34.1获取卡口广播 496.34.2设置卡口广播 506.34.3获取卡口广播录音文件 516.34.4上传卡口广播录音文件 516.35卡口LED显示 516.35.1获取卡口LED显示配置 516.34.2设置卡口LED显示配置 526.36预览卡口视频 536.36.1开流 536.36.2关流 546.37录像查询 546.37.1查询月录像(查询一个月中那些天有录像) 546.37.2查询录像详细 556.38查询报警图片 566.38.1查询报警图片 566.38.2获取报警抓图 586.3

6、9录像回放 586.39.1请求录像回放 586.39.2快播，慢播，暂停，继续 596.39.3停止回放 596.40录像下载 606.41控制云台 606.42到预置位 606.43开关扫描 616.44获取扫描状态 616.45获取卡口设备状态 626.46开关卡口设备电源 626.47获取气象信息 637卡口设备 637.1向卡口注册 637.2对讲 647.2.1发起对讲 647.2.2收到对讲 647.2.3结束对讲 657.2.4对方结束对讲 667.3实时语音广播 667.3.1手机请求广播 667.3.2手机挂断广播 667.4卡口报警联动 677.4.1获取卡口报警联动 6

7、77.4.2获取卡口报警联动录音文件 677.5上传下载 687.5.1收到下载请求 687.5.2收到上传请求 697.5.3收到取消流传输 707.6卡口广播 707.6.1获取卡口广播 707.6.2设置卡口广播 717.6.3获取卡口广播录音文件 717.6.4上传卡口广播录音文件 717.7卡口LED显示 727.7.1获取卡口LED显示配置 727.7.2设置卡口LED显示配置 737.8报警通知到卡口 747.9通知卡口同步时间 747.10控制云台 747.11到预置位 757.12开关扫描 757.13获取扫描状态 767.14获取卡口设备状态 767.15开关卡口设备电源

8、777.16获取气象信息 778网页配置 788.1网页登录 781引言1.1编写目的1.2背景1.3定义列出本文件中用到专门术语的定义和外文首字母组词的原词组。卡口接入服务器：卡口设备、IP摄像机，手持终端通过卡口接入服务器处理数据，转发信令，存取数据库，视音频转发。手持终端：安卓下开发的一款远程管理前端卡口等。中心服务器：卡口接入服务器简写1.4参考资料方案资料：2文档约定为方便阅读该文档，发起方使用如下所示的图形表示：响应方，使用另一种图形表示：3系统的结构4传输协议数据的传输协议由卡口接入服务器统一约定，各客户端逐步实现协议规范。4.1协议介绍目前，实现数据传输协议的设备有手机和卡口设

9、备和IP摄像机，卡口设备、手持终端同卡口接入服务器通信采用DKLPRT（XX实时通信协议）。当前借鉴RTMP协议的子协议AMF，该协议是Adobe公司的协议，主要用于数据交互和远程过程调用，在功能上与WebService相当。其特点主要有： 基于远程的异步方法调用 数据压缩率高 支持20种数据类型，满足各种使用场景 统一格式解析方法 便于系统扩展4.2协议说明手持终端和卡口设备与卡口接入服务器进行数据传输时，每次传输的数据包由数据头和数据内容两部分组成；下面以手持终端登录为例说明协议规则，手持终端向卡口接入服务器发送的数据（以十六进制表示）如下：03 00 00 00 00 00 00 00

10、76 00 01 00 00 13 00 03 00 07 43 6d 64 54 79 70 65 06 00 00 00 01 00 0d 54 72 61 6e 73 61 63 74 69 6f 6e 49 64 11 00 20 39 65 31 37 64 66 66 30 30 36 62 36 34 36 63 36 38 38 65 38 63 31 38 38 65 61 63 62 61 35 66 65 00 06 4f 62 6a 65 63 74 13 00 02 00 08 55 73 65 72 4e 61 6d 65 11 00 08 68 65 6c 70

11、73 6f 66 74 00 08 50 61 73 73 77 6f 72 64 11 00 06 31 32 33 34 35 36上面的数据包含了头和内容两部分，下面分别进行拆分说明。4.2.1数据头数据头包含的内容：03 00 00 00 00 00 00 00 76 00 01 00 00字节数据类型值字节数说明03byte31头类型和通道，前两位表示类型，后六位表示通道00 00 00 00int04时间戳00 00 00 76int1184数据大小00 01short12消息类型00 00short02流ID第一个字节03包含了两部分信息，即头类型和通道，将03以二进制形式表示为

12、00000011，前两位00表示头类型为0，后六位000011表示通道为3；头类型共有四个值，主要用于对数据头进行优化，降低网络传输流量，这在传输音频和视频信息的时候尤其有用。头类型详细说明见下表：值说明0完整的头数据包（时间戳、数据大小、消息类型、流ID）1没有流ID的头数据包2只包含时间戳的头数据包3空头，即头数据不包含任何信息对于通道信息，可表示的最大通道数为，有效的通道值为263（0和1 有特殊用途）；协议约定通道等于0或者1时，说明当前通道数不够用，需要进行通道扩充，即没有扩充时实际可用通道数为62个；当通道为0时，数据头会在第一个字节后面再增加一个字节以扩充通道数，一个字节可存储的

13、值范围为0255，此时可表示的最大通道数为，有效的通道值为64319；当通道为1时，数据头会在第一个字节后面再增加两个字节进行通道扩充，此时可表示的最大通道数为，有效的通道值为32065535。图3.2 数据通道扩展当通道扩展一个字节时，会有一个加减操作，当通道扩展两个字节时，则没有这一操作，因为此时可使用的通道数已经足够多，无须进行加减操作。这里重点介绍通道扩展一个字节时的相关操作，比如现在手持终端要给卡口接入服务器发送数据包，在构建数据头时，指定通道数为270，由于第一个字节的后六位最大可用的通道数为63，因此需要扩展一个字节，扩展的字节中实际存储的值为，其二进制形式的值如图3.3。图3.

14、3 206的二进制形式卡口接入服务器收到该数据包后，解析通道时，首先应判断数据头中第一个字节后六们的值，如果该值等于0，则说明有一个通道字节扩展，读出扩展字节的值，然后加上64即为实际通道的值。目前已经约定使用的通道如下表：通道说明3用于Command和Notify的消息类型6用于AudioData音频的消息类型7用于VideoData视频的消息类型8用于AckSize的消息类型9用于FileData的消息类型 11用于Heartbeat心跳包的消息类型数据头中的消息类型用来说明数据包的作用，当前使用的消息类型有六种，如下表：消息类型值说明Command1命令类型，主要用于发送与接收业务数据A

15、udioData3音频类型VideoData4视频类型Heartbeat5心跳包AckSize6接收数据数大小，结合音频和视频消息使用，防止网络阻塞FileData7文件传输，在文件传输中，时间戳有特殊意义，0表示正常传输，1标识文件无法读取，2发送文件结束None其它类型，目前未使用4.2.2数据优化数据优化主要是对数据包中数据头的优化，这需要头类型和数据通道共同发挥作用，由卡口接入服务器（服务器）与手持终端（客户端）采用共同的方式（数据传输协议）接收与获取数据头信息。在传输普通数据时，数据优化效果不明显，但是在传输音频或视频信息时，其优化效果则比较突出。在数据传输过程中，有一个针对数据头的

16、缓存机制，该缓存以通道和消息类型的形式保存在内存中，连接断开时则销毁缓存；缓存的键为数据通道，值为数据头。在构建数据头时，首先需要判断缓存中是否有对应通道的头信息，如果没有则将当前头添加缓存中，如果有则取出并与当前头进行对比，以确定头类型，最后根据头类型确定要发送数据头，详细流程如图3.4所示。图3.4 构建数据头流程当手持终端接收到卡口接入服务器发过来的一个数据包时，处理流程如图：卡口设备与手持终端以及中心服务器都使用相同协议通信。4.2.3数据内容数据内容即为数据包的后半部分，以下是对数据内容进行拆解：13 00 03 00 07 43 6d 64 54 79 70 65 06 00 00

17、 00 01 00 0d 54 72 61 6e 73 61 63 74 69 6f 6e 49 64 11 00 20 39 65 31 37 64 66 66 30 30 36 62 36 34 36 63 36 38 38 65 38 63 31 38 38 65 61 63 62 61 35 66 65 00 06 4f 62 6a 65 63 74 13 00 02 00 08 55 73 65 72 4e 61 6d 65 11 00 08 68 65 6c 70 73 6f 66 74 00 08 50 61 73 73 77 6f 72 64 11 00 06 31 32 33

18、 34 35 36字节数据类型值字节数说明13byte191Variant类型的数据类型00 03short32Variant包含的值的数量00 07short72第一个对象的键的长度43 6d 64 54 79 70 65stringCmdType7Variant的键06byte61Variant的键对应值的类型为整形00 00 00 01int14Variant的键对应值00 0dshort132第二个Variant的键的长度54 72 61 6e 73 61 63 74 69 6f 6e 49 64stringTransactionId13Variant的键11byte171Varian

19、t的键对应值的类型为字符串00 20short322Variant的键对应值的长度39 65 31 37 64 66 66 30 30 36 62 36 34 36 63 36 38 38 65 38 63 31 38 38 65 61 63 62 61 35 66 65string9e17dff006b646c688e8c188eacba5fe32Variant的键对应值00 06short62Variant的键的长度4f 62 6a 65 63 74stringObject6Variant的键13byte19Variant的键对应值为对象00 02short22Variant包含的值的数量

20、00 08short82Variant第一个键的长度55 73 65 72 4e 61 6d 65stringUserName8Variant第一个键11byte171Variant第一个键对应值数据类型00 08short82Variant第一个键对应值长度68 65 6c 70 73 6f 66 74stringDklpsoft8Variant第一个键对应值00 08short82Variant第二个键的长度50 61 73 73 77 6f 72 64stringPassword8Variant第二个键11byte171Variant第二个键对应值数据类型00 06short62Vari

21、ant第二个键对应值长度31 32 33 34 35 36string1234566Variant第二个键对应值拆分后的最终结果如下：dataCmdType = 1;dataTransactionId = 9e17dff006b646c688e8c188eacba5fe;dataObject = 对象;dataObjectUserName = Dklpsoft;dataObjectPassword = 123456;注意：在每一次的传输过程中，都必须有CmdType、TransactionId和Object键值对，如果没有，卡口接入服务器会认为这是一个错误的数据包。4.3数据类型数据包支持的数

22、据类型如下表：数据类型值说明V_NULL 1V_UNDEFINED2V_BOOL 3V_INT848位有符号整数V_INT16 5V_INT32 632位有符号整数V_INT64 7V_UINT88V_UINT169V_UINT3210V_UINT6411和V_INT64 效果一样，因此协议中不使用该数据类型V_DOUBLE12V_NUMERIC13V_TIMESTAMP14V_DATE15日期类型V_TIME16时间类型V_STRING17字符串类型，以UTF-8格式编码V_TYPED_MAP18V_MAP19对象类型V_BYTEARRAY20字节数组4.4协议事物信令中Transactio

23、nId(事物ID)，信令请求方生成唯一事物ID，信令响应方返回响应结果中事物ID必须是请求发起方的事物ID，以便于发起方做业务关联。事物本分有超时机制，超时控制由发起方自身维护，超时更具实际业务决定超时时长。4.5协议简化定义手持终端，中心服务器，卡口设备，网络通信都使用C+封装后的协议，所以在后面定义信令中省略必填部分如下：dataCmdType = 通信枚举信令号dataTransactionId = 事物ID;dataObject = 实际通信数据;_index_value_0在网络中实际不传输，在通信双方自己建立，其中0标识第一个，后面所有_index_value_0代替了N多个集合简

24、写了5协议枚举定义5.1协议枚举定义值规则说明协议枚举值定义：请求使用奇数，响应使用偶数，通知使用奇数，通知响应使用偶数。协议枚举值范围定义：1-10000卡口设备与中心中心交互使用，10000-20000手持终端与中心交互使用5.2手持终端与中心服务器通信枚举协议通信枚举信令号如下图：枚举值说明PhoneRequestLogin 10001手持终端登录中心服务器PhoneResponseLogin 10002中心服务器响应手持登录PhoneRequestGetUserList10003获取用户列表PhoneResponseGetUserList10004响应用户列表PhoneRequestA

25、ddUser10005添加用户PhoneResponseAddUser10006响应添加用户结果PhoneRequestUpdateUser10007更改用户信息PhoneResponseUpdateUser10008响应更改用户信息PhoneRequestDeleteUser10009删除用户 注意：Dklpsoft帐号禁止删除PhoneResponseDeleteUser10010响应删除用户PhoneRequestUpdatePassword10011修改用户自己的密码PhoneResponseUpdatePassword10012响应修改密码PhoneRequestGetBayonet

26、DeviceList10013获取卡口设备列表PhoneResponseGetBayonetDeviceList10014响应卡口设备列表PhoneRequestAddBayonetDevice10015添加卡口设备PhoneResponseAddBayonetDevice10016响应卡口设备添加PhoneRequestUpdateBayonetDevice10017更新卡口设备PhoneResponseUpdateBayonetDevice10018响应卡口更新结果PhoneRequestDeleteBayonetDevice10019删除卡口设备PhoneResponseDeleteBa

27、yonetDevice10020响应卡口设备删除PhoneRequestInvite10021手机发起呼叫PhoneResponseInviteRing10022响应振铃PhoneResponseInvite10024响应发起呼叫PhoneRequestInvited10025收到呼叫PhoneResponseInvitedRing10026响应收到呼叫回应振铃PhoneResponseInvited10028响应收到呼叫PhoneRequestInviteBye10029结束呼叫通话PhoneResponseInviteBye10030响应结束呼叫通话PhoneNotifyInviteBye

28、10031对方结束通话通知另外一方PhoneRequestBroadcast10033请求同卡口广播PhoneResponseBroadcast10034响应广播PhoneRequestBroadcastBye10035请求挂断广播PhoneResponseBroadcastBye10036响应挂断广播PhoneNotifyBroadcastdBye10037卡口掉线广播中断PhoneRequestGetCameraSetting10039获取摄像机参数PhoneResponseGetCameraSetting10040响应获取摄像机参数PhoneRequestSetCameraSetting10041设置摄像机参数PhoneResponseSetCameraSetting10042响应设置摄像机参数PhoneRequestGetRecordParam10043获取录像参数PhoneResponseGetRecordParam10044响应录像参数PhoneRequestSetRecordParam10045设置录像参数PhoneRespon