1. 概述
本文介绍在对接凌阳记录仪SunPlus方案时的自定义功能点,以便更好适配业务功能,请有需要的方案商按此文档进行对接;
2. 自定义点:
2.1 [可选]产品信息查询
- 功能描述 获取设备对应的产品型号、品牌商、方案商,用以APP来进行接口类别区分,并给品牌商进行设备的logo的定制,需要区分设备型号和品牌
- 命令描述 命令ID:0xD800 操作类型:查询字符串
响应结果:model@brand@sp,举例:S8PRO@pasens@FH,其中:
型号(model):本产品的型号,比如:S8PRO;不用的机型“型号”字段不一样;
brand:品牌公司,直接销售产品的公司,即方案商的客户,比如:pasens,如暂时没有定可以填NA
sp:方案商,举例:方案商名称为蓝天:"FH",这个名称方案商自己定即可,有助于APP更好的对接此方案商的方案接口;
当model@brand@sp中的某个字段没有的时候,用NA替代,比如:作为一家方案商的公版硬件,想和我们公版APP更好的适配兼容,只需要提供sp字段,形式为:NA@NA@FH
样例:
S8PRO@pasens@FH
3.接口协议
主要是业务功能和命令ID的对应关系,每家方案商可能按自己的有一套定义,这样公版app无法满足自动适配每家方案商,为此,APP定义一套标准的对应关系,如果是按这个对应关系定义的命令或是设置项,则直接用公版就可以; 否则需要使用 2.1节介绍信息进行设备区分,然后通知app对不同方案商的业务进行适配;
推荐方案商采用如下的ID和业务的定义关系,减少双方的对接成本,为整个行业效率提升做出贡献;
- 本规范化主要是针对业务ID进行规范:
ID | 菜单类型 - | 对应业务项 - | 备注 |
---|---|---|---|
0XD7AF | 开关 | HDR | |
0xD725 | 下拉选项 | 录制文件时长 | 循环录影的时长,比如1分钟、3分钟之类 |
0xD721 | 下拉选项 | 自动关机时长 | |
0xD720 | 下拉选项 | 自动进入屏保时长 | |
0xD724 | 开关 | 防抖 | 是否开启防抖 |
0X11112 | 下拉选项 | 缩时录影帧率 | 一般指缩时录影帧率,比如 1fps、2fps |
0X11113 | 下拉选项 | 缩时录影时长 | 停车监控时长,比如2H、12H、24H |
0x5010 | 下拉选项 | 曝光补偿 | |
0XD7B0 | 开关 | 移动侦测 | |
0XD7B1 | 开关 | MIC开关 | 录像是否录入音频 |
0XD7B2 | 下拉选项 | 碰撞感应 | 关闭、高、中、低 |
0xD7B3 | 开关 | 停车监控 | 是否开启停车监控 |
0xD7B5 | 下拉选项 | 设备语言 | 设备的语言选择:Englis、中文简体、中文繁体 |
0XD607 | 下拉选项 | 时间水印 | 录制视频显示时间水印的内容 |
0X11116 | 开关 | 自动录制 | 扬声器的音量:关闭、高、中、低 |
0XD7B2 | 下拉选项 | 碰撞感应 | 停车监控时长,比如2H、12H、24H |
0XD7B3 | 开关 | 停车守卫 | 停车监控开关 |
0x11119 | 开关 | 开机声音 | |
0XD7B5 | 下拉选项 | 记录仪语言 | |
0x1111B | 下拉选项 | 速度单位 | |
0XD7B1 | 开关 | MIC开关 | 录像是否录入音频 |
0XD7B2 | 下拉选项 | 碰撞感应 | 关闭、高、中、低 |
0x5003 | 下拉选项 | 图片质量 | 拍照图片质量 |
0XD7C0 | 控制 | 切换摄像头 | 参数 前路:0,后路:1 |
0XD7C3 | 控制 | 设备重启 | 重启设备 |
0XD7DB | 下拉选项 | 停车碰撞感应 | 关闭、低、中、高 |
原厂定义 | 其他 | 格式化 | 格式化设备的TF卡 |
原厂定义 | 其他 | 恢复出厂设置 | 恢复出厂设置 |
原厂定义 | 其他 | 固件版本 | 获取设备的固件版本号 |
原厂定义 | 其他 | Wifi名称 | |
原厂定义 | 其他 | Wifi密码 | |
0xD800 | 查询 | 产品信息 | 具体描述见2.1章节 |
0xD801 | 查询 | Mac地址获取 | 为了统计设备数量或是其他扩展功能,注意</br>此功能需要每个设备唯一,如果不好实现可以不支持该项 |
0xD802 | 查询 | 获取定制项 | 获取到的结果是一个字符串,字符串的每一位对应一个业务的定制化功能描述,具体参考《设备能力集查询》 |
注:
- 部分没有定义的功能,使用原厂的定义即可,如果有新的业务上述没有ID对应,请联系我们进行添加;
- 方案商根据需要选择上述中的某些项,不用一定要全部适配
- 方案商不需要显示的设置项目,不返回对应项目的查询值或是设备端不支持该ID即可
4 设备能力集查询
该字段是通过0xD802进行查询,获取到的结果是一个字符串,字符串的每一位对应一个业务的定制化功能描述;
功能描述 获取当前设备类型某些能力,app做相应的功能匹配,以便不同设备能力更好的在app上给用户提供不同的功能;
命令描述 通过设置项ID:0xD802进行查询, 操作类型:查询
结果中返回字符串,该字符串的长度根据需要自定义,如果需要定制的功能在第N,则该字符串就必需有N位,前面的每一位0是APP使用的默认值,其他值是根据具体业务的定制值:
00000101
其中String自动的每一位代表1个业务能力(方案商实现时,如果对某位的业务不支持或是不了解,默认填0):
第0位:GPS数据业务
- 0 不支持GPS
- 1 仅支持下载后的视频文件GPS数据获取;
- 2 支持下载后的视频文件、在线回放的视频文件GPS数据获取;
- 3 支持下载后的视频文件、在线回放的视频文件、实时画面GPS数据获取;
- 4 支持下载后的视频文件、实时画面GPS数据获取;
第1位:1-运动相机,0-记录仪(默认)
第2位:1-不支持停车监控相册,0-支持停车监控相册(默认)
第3位:1-该设备支持通过APP操作文件加锁,0-不支持(默认)
第4位:1- 不支持删除加锁文件;0-支持删除加锁文件(默认); 如果有需求不能删除加锁文件,修改此字段;
第5位:部分芯片拍照需要切换到拍照模式的,1- 不切换模式,直接录像码流抓拍,0-(默认)切换模式进行抓拍或是当前默认方式
第6位:回放是否使用rtsp的流,
0-(默认)-不使用rtsp的流,使用文件下载播放的方式,
1- 使用RTSP的协议TCP播放回放实时流
2- 使用RTSP的协议UDP播放回放实时流; 如果部分设备回放码率特别大,wifi传输会造成回放卡顿,需要使用rtsp播放小码流时,可以修改此字段(回放是否支持rtsp还需要设备端支持);
第7位:是否支持拍照功能,0(默认)-支持拍照功能, 1- 不支持拍照,只支持录像;部分设备资源不够,不支持拍照功能时,修改此字段,app上将会隐藏拍照按钮;
第8位:是否支持APP修改wifi名或wifi密码
- 0(默认)- 支持修改WiFi名和WiFi密码,
- 1-不支持修改WiFi名,支持修改WiFi密码,此时WiFi名将会隐藏;
- 2-支持修改WiFi名,不支持修改WiFi密码,此时WiFi密码将会隐藏;
- 3.不支持修改WiFi名,且不支持修改WiFi密码,此时WiFi名和密码都将会隐藏;
第n位:待补充