常用设备协议
注意：设置设备某功能参数之前，需要先获取设备中该功能的当前参数，然后按需修改部分参数，最后发送设置参数指令即可。例如：配置周界预警参数，需要按照下面的操作步骤进行配置：
- 下发【获取周界预警参数】指令，获取设备当前配置的周界预警参数。
- 以第一步获取到的周界预警参数对象为基础，按需增加或者修改对象中的部分参数。
- 将改动后的参数对象作为传参，下发【设置周界预警参数】指令给设备。
- 参数配置完成。
云台管理
注意：- 要求设备需要有 ptz 设备能力集，详情见【设备能力集介绍】。
- 如下设备接入协议支持该透传指令：中维协议3.0、国标28181、海康EHOME2.0、海康EHOME4.0、海康ISUP、大华主动注册。
云台移动或缩放
请求协议
{
"method": "ptz_move_start",
"param": {
"channelid": 0,//通道号，IPC固定为0
"panLeft": -254,//左右控制，正负表示方向，+向左，-表示向右，绝对值表示速度，取值范围0-255
"tiltUp": -254,//上下控制，正负表示方向，+向左，-表示向右，绝对值表示速度，取值范围0-255
"zoomIn": 254//变倍控制，正负表示方向，+放大，-缩小，绝对值表示速度，取值范围0-255【变倍的速度不起实际作用，球机对焦算法会自适应变倍速度】
}
}
返回信息
{
"method": "ptz_move_start",
"result": {},
"error": {
"errorcode": -32602,
"message": "Invalid Params"
}
}
错误码
| 错误码 | 错误信息 |
|---|---|
| 0 | 成功 |
| -32602 | 传入参数无效（通道ID、速度） |
| -32603 | 云台开始移动失败 |
停止移动或缩放
请求协议
{
"method": "ptz_move_stop",
"param": {
"channelid": 0//通道号，IPC固定为0
}
}
返回信息
{
"method": "ptz_move_stop",
"result": {},
"error": {
"errorcode": 0
}
}
错误码
| 错误码 | 错误信息 |
|---|---|
| 0 | 成功 |
| -32602 | 通道ID无效 |
| -32603 | 云台停止移动失败 |
控制聚焦或光圈
请求协议
{
"method": "ptz_fi_start",
"param": {
"channelid": 0,//通道号，IPC固定为0
"focusFar": -254,//对焦控制，正负表示方向，绝对值表示速度，取值范围0-255【目前速度不起实际作用】【对焦控制必须先配置球机为手动对焦模式，自动对焦模式下，手动控制也生效，但最后仍然会进行一次自动对焦】
"irisOpen": 254//光圈控制，正负表示方向，绝对值表示速度，取值范围0-255【目前速度不起实际作用】
}
}
返回信息
{
"method": "ptz_fi_start",
"result": {},
"error": {
"errorcode": -32602,
"message": "Invalid Params"
}
}
错误码
| 错误码 | 错误信息 |
|---|---|
| 0 | 成功 |
| -32602 | 传入参数无效（通道ID、聚焦速度、光圈速度） |
| -32603 | 控制聚焦和光圈开始失败 |
停止聚焦或光圈
请求协议
{
"method": "ptz_fi_stop",
"param": {
"channelid": 0 //通道号，IPC固定为0
}
}
返回信息
{
"method": "ptz_fi_stop",
"result": {},
"error": {
"errorcode": -32602,
"message": "Invalid Params"
}
}
错误码
| 错误码 | 错误信息 |
|---|---|
| 0 | 成功 |
| -32602 | 通道ID无效 |
| -32603 | 控制聚焦和光圈停止失败 |
一键布防设置
报警联动总布防状态获取
请求协议
{
"method": "alarm_link_defence_get",
"param": {
"channelid": 0
}
}
返回信息
{
"method": "alarm_link_defence_get",
"result": {
"status": "open,close,disable" // 打开，关闭，禁用(当前没有开启任何报警联动)
},
"error": {
"errorcode": 0
}
}
报警联动总布防状态设置
请求协议
{
"method": "alarm_link_defence_set",
"param": {
"channelid": 0,
"status": "open,close"// 打开，关闭
}
}
返回信息
{
"method": "alarm_link_defence_set",
"result": {},
"error": {
"errorcode": 0
}
}
隐私遮蔽配置
注意：- 要求设备需要有 physicalcover 设备能力集，详情见【设备能力集介绍】。
获取隐私遮蔽参数
请求协议
{
"method": "privacy_hide_get_param",
"param": {
"channelid": 0 //通道号，从0开始。
}
}
返回信息
{
"method": "privacy_hide_get_param",
"result": {
"bEnable": false
},
"error": {
"errorcode": 0
}
}
设置隐私遮蔽参数
请求协议
{
"method": "privacy_hide_set_param",
"param": {
"channelid": 0, //通道号，从0开始。
"bEnable": false,
"bOnlyHide": false //是否只遮挡画面，true表示只遮挡画面，false表示遮挡画面并且云台转到隐私位置
}
}
返回信息
{
"method": "privacy_hide_set_param",
"result": {},
"error": {
"errorcode": 0
}
}
移动侦测配置
注意：- 要求设备需要有 motiondetect 设备能力集，详情见【设备能力集介绍】。
- 能力集中有【人形检测】的能力，可以进行【人形检测配置】，不能进行【移动侦测配置】，操作移动侦测会报错。
- 能力集中没有【人形检测】的能力，不能进行【人形检测配置】，只能进行【移动侦测配置】。
- 【移动侦测配置】中的 "请求协议" 、 "返回信息" 与【人形检测配置】一致。
获取移动侦测参数
请求协议
{
"method": "mdetect_get_param",
"param": {
"channelid": 0//通道号，IPC固定为0
}
}
返回信息
{
"method": "mdetect_get_param",=
"result": {
"bEnable": true, //是否开启
"detNameList":[
{
"type": "", //object,body,vehicle,nonmotor
"name": "" //中文名称:物体检测,人形检测,车辆检测,非机动车检测
}
], //检测名称列表
"detType":["object","body","vehicle","nonmotor"],// 检测类型，object：物体检测 body：人形检测 vehicle：车辆检测 nonmotor: 非机动车检测
"alarm_link_id":1, //报警联动计划id
"alarm_defence_plan_id":1, //布防时间计划id
"bEnableSMD": true, //开启人形检测，注意开启人形的时候必须把bEnable和bEnableSMD都置为true
"detecttype": "object, body, face", //类型: 移动检测,人形检测,人脸检测,ivp.json中的bFaceCapSupport为false，则nvr不能配置此字段
"bAlarming": true, //是否正在触发
"bEnableRecord": false, //录像
"sensitivity": 80, //灵敏度，范围0～255
"delay": 10, //持续时间
"videoChannel": 1, //绑定的视频通道
"bSnapshot": false, //抓图
"nPreset": 0, //报警联动预置位，-1表示未关联
"bBuzzing": false, //蜂鸣器
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bOutFTP": false, //发送FTP
"bSendToAlmServer": false, //发送报警服务器
"bAlarmSoundEnable": false, //报警声音
"bMarkObject": false, //标记检测目标
"bReportObject": false, //上报检测目标
"bPtzAutoTraceObject": false, //云台追踪目标
"ptzTraceSec":300, //云台跟踪目标跟踪时间
"bGunDomeTrace": false, //枪球跟踪
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
],
"bUseGrids": true, //true使用网格设置区域；false使用矩形
"maxRect": 4, //矩形最大个数
"maxRectW": 1000, //矩形最大宽度
"maxRectH": 1000, //矩形最大高度
"rects": [ //矩形数组
{
"x": 0,
"y": 0,
"w": 100,
"h": 100
}
],
"grids": {
"cntRow": 22, //网格行数
"cntCol": 22, //网格列数
"strid": 6, //跨度。每行使用的整型个数。
"value":[12345, 12354] //每个整型代表32个网格，bit0在左边。每strid个整型表示一行数据
},
"task":{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
}
},
"error": {
"errorcode": -1,
"message": "Failed to get motion detect parameters!"
}
}
设置移动侦测参数
请求协议
{
"method": "mdetect_set_param",
"param": {
"channelid": 0, //通道号，从0开始。
"md":{
"bEnable": true, //是否开启
"detType":["object","body","vehicle","nonmotor"],// 检测类型，object：物体检测 body：人形检测 vehicle：车辆检测 nonmotor: 非机动车检测
"bEnableSMD": true, //开启人形检测，注意开启人形的时候必须把bEnable和bEnableSMD都置为true
"detecttype": "object,body,face",//人脸移动检测类型,ivp.json中的bFaceCapSupport为false，则nvr不能配置此字段
"bEnableRecord": false, //录像
"sensitivity": 80, //灵敏度，范围0～255
"delay": 10, //持续时间
"videoChannel": 1, //绑定的视频通道
"bSnapshot": false, //抓图
"nPreset": 0, //报警联动预置位，-1表示未关联
"bBuzzing": false, //蜂鸣器
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bOutFTP": false, //发送FTP
"bSendToAlmServer": false, //发送报警服务器
"bAlarmSoundEnable": false, //报警声音
"bMarkObject": false, //标记检测目标
"bReportObject": false, //上报检测目标
"bPtzAutoTraceObject": false, //云台追踪目标
"ptzTraceSec":300, //云台跟踪目标跟踪时间
"bGunDomeTrace": false, //枪球跟踪
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
],
"bUseGrids": true, //true使用网格设置区域；false使用矩形
"rects":[ //矩形数组
{
"x": 0,
"y": 0,
"w": 100,
"h": 100
}
],
"grids": {
"value":[12345, 12354] //每个整型代表32个网格，bit0在左边。每strid个整型表示一行数据
},
"task":{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警，false表示按时间段报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
}
}
}
}
返回信息
{
"method": "mdetect_set_param",
"result": {},
"error": {
"errorcode": 0
}
}
视频遮挡配置
注意：- 如果设置报警声音为开启状态，要求设备需要有 alarmsound 设备能力集，详情见【设备能力集介绍】。
获取视频遮挡参数
请求协议
{
"method": "ivp_hide_get_param",
"param": {
"channelid": 0
}
}
返回信息
{
"method": "ivp_hide_get_param",
"result": {
"bEnable": false, //是否启用
"alarm_link_id":1, //报警联动计划id
"alarm_defence_plan_id":1, //布防时间计划id
"nSen": 0, //灵敏度0~100
"maxRectW": 1000, //视频输入最大宽度
"maxRectH": 1000, //视频输入最大高度
"task":
{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警，false表示按时间段报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
},
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bEnableRecord": false, //录像
"bAlarmSoundEnable": false, //报警声音
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
]
},
"error": {
"errorcode": 0
}
}
设置视频遮挡参数
请求协议
{
"method": "ivp_hide_set_param",
"param": {
"channelid": 0,
"bEnable": false, //是否启用
"nSen": 0, //灵敏度0~100
"task":
{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警，false表示按时间段报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
},
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bEnableRecord": false, //录像
"bAlarmSoundEnable": false, //报警声音
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
]
}
}
返回信息
{
"method": "ivp_hide_set_param",
"result": {},
"error": {
"errorcode": 0
}
}
人形检测配置
注意：- 要求设备需要有 peopledetect 设备能力集，详情见【设备能力集介绍】。
- 能力集中有【人形检测】的能力，可以进行【人形检测配置】，不能进行【移动侦测配置】，操作移动侦测会报错。
- 能力集中没有【人形检测】的能力，不能进行【人形检测配置】，只能进行【移动侦测配置】。
- 【人形检测配置】中的 "请求协议" 、 "返回信息" 与【移动侦测配置】一致。
获取人形检测参数
请求协议
{
"method": "mdetect_get_param",
"param": {
"channelid": 0//通道号，IPC固定为0
}
}
返回信息
{
"method": "mdetect_get_param",=
"result": {
"bEnable": true, //是否开启
"detNameList":[
{
"type": "", //object,body,vehicle,nonmotor
"name": "" //中文名称:物体检测,人形检测,车辆检测,非机动车检测
}
], //检测名称列表
"detType":["object","body","vehicle","nonmotor"],// 检测类型，object：物体检测 body：人形检测 vehicle：车辆检测 nonmotor: 非机动车检测
"alarm_link_id":1, //报警联动计划id
"alarm_defence_plan_id":1, //布防时间计划id
"bEnableSMD": true, //开启人形检测，注意开启人形的时候必须把bEnable和bEnableSMD都置为true
"detecttype": "object, body, face", //类型: 移动检测,人形检测,人脸检测,ivp.json中的bFaceCapSupport为false，则nvr不能配置此字段
"bAlarming": true, //是否正在触发
"bEnableRecord": false, //录像
"sensitivity": 80, //灵敏度，范围0～255
"delay": 10, //持续时间
"videoChannel": 1, //绑定的视频通道
"bSnapshot": false, //抓图
"nPreset": 0, //报警联动预置位，-1表示未关联
"bBuzzing": false, //蜂鸣器
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bOutFTP": false, //发送FTP
"bSendToAlmServer": false, //发送报警服务器
"bAlarmSoundEnable": false, //报警声音
"bMarkObject": false, //标记检测目标
"bReportObject": false, //上报检测目标
"bPtzAutoTraceObject": false, //云台追踪目标
"ptzTraceSec":300, //云台跟踪目标跟踪时间
"bGunDomeTrace": false, //枪球跟踪
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
],
"bUseGrids": true, //true使用网格设置区域；false使用矩形
"maxRect": 4, //矩形最大个数
"maxRectW": 1000, //矩形最大宽度
"maxRectH": 1000, //矩形最大高度
"rects": [ //矩形数组
{
"x": 0,
"y": 0,
"w": 100,
"h": 100
}
],
"grids": {
"cntRow": 22, //网格行数
"cntCol": 22, //网格列数
"strid": 6, //跨度。每行使用的整型个数。
"value":[12345, 12354] //每个整型代表32个网格，bit0在左边。每strid个整型表示一行数据
},
"task":{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
}
},
"error": {
"errorcode": -1,
"message": "Failed to get motion detect parameters!"
}
}
设置人形检测参数
请求协议
{
"method": "mdetect_set_param",
"param": {
"channelid": 0, //通道号，从0开始。
"md":{
"bEnable": true, //是否开启
"detType":["object","body","vehicle","nonmotor"],// 检测类型，object: 物体检测 body: 人形检测 vehicle: 车辆检测 nonmotor: 非机动车检测
"bEnableSMD": true, //开启人形检测，注意开启人形的时候必须把bEnable和bEnableSMD都置为true
"detecttype": "object,body,face",//人脸移动检测类型,ivp.json中的bFaceCapSupport为false，则nvr不能配置此字段
"bEnableRecord": false, //录像
"sensitivity": 80, //灵敏度，范围0～255
"delay": 10, //持续时间
"videoChannel": 1, //绑定的视频通道
"bSnapshot": false, //抓图
"nPreset": 0, //报警联动预置位，-1表示未关联
"bBuzzing": false, //蜂鸣器
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bOutFTP": false, //发送FTP
"bSendToAlmServer": false, //发送报警服务器
"bAlarmSoundEnable": false, //报警声音
"bMarkObject": false, //标记检测目标
"bReportObject": false, //上报检测目标
"bPtzAutoTraceObject": false, //云台追踪目标
"ptzTraceSec":300, //云台跟踪目标跟踪时间
"bGunDomeTrace": false, //枪球跟踪
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
],
"bUseGrids": true, //true使用网格设置区域；false使用矩形
"rects":[ //矩形数组
{
"x": 0,
"y": 0,
"w": 100,
"h": 100
}
],
"grids": {
"value":[12345, 12354] //每个整型代表32个网格，bit0在左边。每strid个整型表示一行数据
},
"task":{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警，false表示按时间段报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
}
}
}
}
返回信息
{
"method": "mdetect_set_param",
"result": {},
"error": {
"errorcode": 0
}
}
周界预警配置
注意：- 要求设备需要有 intelligent 设备能力集，详情见【设备能力集介绍】。
获取周界预警参数
请求协议
{
"method": "ivp_rl_get_param",
"param": {
"channelid": 0
}
}
返回信息
{
"method": "ivp_rl_get_param",
"result": {
"bEnable": false,
"nSen": 0, //灵敏度0~100
"nThreshold": 0, //阈值8~128
"nStayTime": 0, //停留时间0~300
"bDrawFrame": false, //显示绊线或防区
"bFlushFrame": false, //报警闪烁
"bMarkObject": false, //标记引起报警的物体
"bMarkAll": false, //标记全部运动物体
"bPtzAutoTraceObject": false, //云台追踪目标
"ptzTraceSec":300, //云台跟踪目标跟踪时间
"bGunDomeTrace": false, //枪球跟踪
"supportDetTypeList":[
{
"type": "", //object,body,vehicle,nonmotor
"name": "" //中文名称:物体检测,人形检测,车辆检测，非机动车检测
}
], //支持的检测类型
"detType":["object","body","vehicle","nonmotor"],// 检测类型，object：物体检测 body：人形检测 vehicle：车辆检测 nonmotor: 非机动车检测
"alarm_link_id":1, //报警联动计划id
"alarm_defence_plan_id":1, //布防时间计划id
"maxRectW": 1000, //视频输入最大宽度
"maxRectH": 1000, //视频输入最大高度
"maxRegion": 4, //最大区域个数
"stRegion":
[ //最多4个区域
{
"type": 0, //0: 区域 1：绊线
"stPoints": [
{
"x": 0,
"y": 0
}
], //区域的点的坐标,最多10个点，点的个数>=2,=2时是绊线
"nIvpCheckMode": 0 //检测方向 0：绊线从A到B方向检测 1: 绊线从B到A方向检测 2: 绊线从AB双向检测
}
],
"task":
{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警，false表示按时间段报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
},
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bEnableRecord": false, //录像
"bAlarmSoundEnable": false, //报警声音
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
]
},
"error": {
"errorcode": 0
}
}
设置周界预警参数
请求协议
{
"method": "alarm_link_defence_get",
"param": {
"channelid": 0,
"bEnable": false,
"nSen": 0, //灵敏度0~100
"nThreshold": 0, //阈值8~128
"nStayTime": 0, //停留时间0~300
"bDrawFrame": false, //显示绊线或防区
"bFlushFrame": false, //报警闪烁
"bMarkObject": false, //标记引起报警的物体
"bMarkAll": false, //标记全部运动物体
"bPtzAutoTraceObject": false, //云台追踪目标
"ptzTraceSec":300, //云台跟踪目标跟踪时间
"bGunDomeTrace": false, //枪球跟踪
"detType":["object","body","vehicle","nonmotor"],// 检测类型，object：物体检测 body：人形检测 vehicle：车辆检测 nonmotor: 非机动车检测
"stRegion":
[
{
"type": 0, //0: 区域 1：绊线
"stPoints": [
{
"x": 0,
"y": 0
}
], //区域的点的坐标,最多10个点，点的个数>=2,=2时是绊线
"nIvpCheckMode": 0 //检测方向 0：绊线从A到B方向检测 1: 绊线从B到A方向检测 2: 绊线从AB双向检测
}
], //最多4个区域
"task":
{ //报警预约
"bsos": false, //是否配置为紧急报警，true表示7*24小时报警，false表示按时间段报警
"bAllTime": true, //全时段布防
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
},
"bOutClient": false, //发送到客户端软件
"bOutEmail": false, //发送邮件
"bEnableRecord": false, //录像
"bAlarmSoundEnable": false, //报警声音
"WhiteLight":{ //白光灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100），0：弱 50：强 100：长亮
},
"AlarmLight":{ //报警灯设置
"bEnable":false, //闪烁使能
"Strength":0 //闪烁强度（0~100）
},
"alarmout": //关联的开关量报警输出：一个报警输入可关联多路报警输出
[
{
"almout_id": 0, //关联报警输出的id
"type":"unknown,door,pir,smoke,gas,curtain", //报警输入类型：未知类型，门磁，红外，烟感，燃气探测，幕帘探测
"bNormallyClosed": false //false正常情况下是断开的，报警的时候闭合
}
]
}
}
返回信息
{
"method": "ivp_rl_set_param",
"result": {},
"error": {
"errorcode": 0
}
}
智能跟踪配置
注意：- 要求设备需要有 ptzautotrace 设备能力集，详情见【设备能力集介绍】。
获取智能跟踪参数
请求协议
{
"method": "ptz_trace_get_param",
"param": {
"channelid": 0
}
}
返回信息
{
"method": "ptz_trace_get_param",
"result":{
"autoEnable": false, //开启自动跟踪
"trace_sec": 20 //跟踪时长 秒
},
"error": {
"errorcode": 0
}
}
设置智能跟踪参数
请求协议
{
"method": "ptz_trace_set_param",
"param": {
"channelid": 0, //通道号
"autoEnable": false, //开启自动跟踪
"trace_sec": 20 //跟踪时长 秒
}
}
返回信息
{
"method": "ptz_trace_set_param",
"result": {},
"error": {
"errorcode": 0
}
}
设备指示灯配置
注意：- 要求设备需要有 statuslight 设备能力集，详情见【设备能力集介绍】。
获取设备指示灯参数
请求协议
{
"method": "dev_get_indicatorled",
"param": {
"channelid": 0
}
}
返回信息
{
"method": "dev_get_indicatorled",
"result": {
"mode": 0 //自动:0 ,常开:1,常灭:2
},
"error": {
"errorcode": 0
}
}
设置设备指示灯参数
请求协议
{
"method": "dev_set_indicatorled",
"param": {
"channelid":0, //通道号，从0开始。-1表示本机
"mode": 0 //自动:0 ,常开:1,常灭:2
}
}
返回信息
{
"method": "dev_set_indicatorled",
"result": {},
"error": {
"errorcode": 0
}
}
设备喇叭声音配置
注意：- 要求设备需要有 audioout 设备能力集，详情见【设备能力集介绍】。
获取喇叭声音开关状态
请求协议
{
"method": "ao_get_param",
"param": {
"channelid": 0
}
}
返回信息
{
"method": "ao_get_param",
"result": {
"bEnable": true,
"sampleRate": 8000, //采样率
"bitWidth": 16, //位宽
"cntChannel": 1, //通道数
"encType": "none,pcm,g711a,g711u,g726,aac,adpcm", //编码格式
"bitRate":128, //AAC编码会用到，kbps
"aoGain": 0 //音频输入增益校准值，范围(0~100)
},
"error": {
"errorcode": 0
}
}
设置喇叭声音开关
请求协议
{
"method": "ao_set_param",
"param": {
"channelid": 0, //音频通道，从0开始。
"audioAttr": {
"bEnable": true,
"sampleRate": 8000, //采样率
"bitWidth": 16, //位宽
"cntChannel": 1, //通道数
"encType": "none,pcm,g711a,g711u,g726,aac,adpcm", //编码格式
"bitRate":128, //AAC编码会用到，kbps
"aoGain": 0 //音频输入增益校准值，范围(0~100)
}
}
}
返回信息
{
"method": "ao_set_param",
"result": {},
"error": {
"errorcode": 0
}
}
设备报警语音配置
注意：- 要求设备需要有 alarmsound 设备能力集，详情见【设备能力集介绍】。
获取报警语音配置参数
请求协议
{
"method": "alarm_sound_get",
"param": {
"channelid": 0, //通道号
"file_name": "name", //文件名称
"bGetData": false, //是否获取文件数据
"type":"doorbell" //没有type字段，保持原逻辑；有type字段，区分类型，doorbell门铃
}
}
返回信息
{
"method": "alarm_sound_get",
"result": {
"file_name": "name", //文件名称
"file_type": "g711u,aac", //音频编码格式
"file_data": "base64(audio_data)" //base64编码的音频文件：音频文件最长10s，711编码大小为80KB
},
"error": {
"errorcode": 0
}
}
设置报警语音配置参数
请求协议
{
"method": "alarm_sound_set",
"param": {
"channelid": 0, //通道号
"file_name": "name", //文件名称
"file_type": "g711u,aac", //音频编码格式
"file_data": "base64(audio_data)", //base64编码的音频文件：音频文件最长10s，711编码大小为80KB
"type":"doorbell" //没有type字段，保持原逻辑；有type字段，区分类型，doorbell门铃
}
}
返回信息
{
"method": "alarm_sound_set",
"result": {},
"error": {
"errorcode": 0
}
}
播放设备报警语音
请求协议
{
"method": "alarm_out_trigger",
"param": {
"channelid": 0, //通道号
"delay": 10, //报警持续时间，单位秒
//报警类型：声音报警,白光灯报警,声光报警,报警输出,红蓝灯报警
"alarmOutType": "sound,whiteLight,soundWhiteLight,alarmOut,AlarmLight",
"WhiteLightStrength":0, //白光灯报警闪烁强度（0~100），0：弱 50：强 100：长亮，可选项
"almout_id": 0 //开关量报警输出ID，可选项
}
}
返回信息
{
"method": "alarm_out_trigger",
"result": {},
"error": {
"errorcode": 0
}
}
设备录像模式配置
注意：- 要求设备需要有 localstorage 设备能力集，详情见【设备能力集介绍】。
获取设备录像模式
请求协议
{
"method": "record_get",
"param": {
"channelid": 0 //通道号
}
}
返回信息
{
"method": "record_get",
"result": {
"record_params": [
{
"channelid": 0, //通道号，从0开始。
"streamid": 0,
"streamid_list": [0, 1], //支持的录像通道列表 0 高清 1标清
"brecording": false, //是否正在录像
"normal_record": false,
"time_record": false,
"disconnect_record": false, //断开录像
"alarm_record": false, //报警录像
"sd_prerecord":{
"bEnable": false, //是否使能
"Duration": 120 //录像缓存时长 s，预留
},
"extract_record": false, //缩时录像
"extract_sec": 4, //缩时录像抽帧间隔
"packettimelen_list": //录像时长列表，ipc传递，后期扩展或者删除 int 类型
[
5, // 5分钟
10, // 10分钟
20, // 20分钟
30 //30分钟
],
"packettimelen": 10, //打包时长，单位分钟
"wakeup_record": false, //唤醒录像
"wakeup_record_len_list": //唤醒录像时长列表，单位秒
[
5, // 5秒
10, // 10秒
20, // 20秒
30, // 30秒
60 // 60秒
],
"wakeup_record_len": 10,//唤醒录像时长，单位秒
"bRecAudio": true, //是否录制音频
"bOutFTP": false, //发送到FTP
"task":{ //定时录像
"maxTime": 8, //每天布防时间段的最大数
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
}
}
]
},
"error": {
"errorcode": 0
}
}
设置设备录像模式
请求协议
{
"method": "record_set",
"param": {
"record_params": [
{
"channelid": 0, //通道号，从0开始。
"streamid": 0,
"normal_record": false,
"time_record": false,
"disconnect_record": false, //断网录像
"alarm_record": false, //报警录像
"sd_prerecord":{
"bEnable": false, //是否使能
"Duration": 120 //录像缓存时长 s，预留
},
"extract_record": false, //缩时录像
"extract_sec": 4, //缩时录像抽帧间隔
"packettimelen": 10, //打包时长，单位分钟
"wakeup_record": false, // 唤醒录像
"wakeup_record_len": 10, //唤醒录像时长，单位秒
"bRecAudio": true, //是否录制音频
"bOutFTP": false, //发送到FTP
"task":{ //定时录像
"time":
[
{
"week": "Mon,Tues,Wed,Thur,Fri,Sat,Sun,EveryDay", //星期1~7,每天
"begin_hour": 12, //开始小时
"begin_min": 20, //开始分钟
"begin_sec": 30, //开始秒
"end_hour": 12, //结束小时
"end_min": 30, //结束分钟
"end_sec": 40 //结束秒
}
]
}
}
]
}
}
返回信息
{
"method": "record_set",
"result": {},
"error": {
"errorcode": 0
}
}
图像设置
获取图像调节参数
请求协议
{
"method": "image_get_adjust_param",
"param": {
"channelid": 0
}
}
返回信息
{
"method": "image_get_adjust_param",
"result": {
"contrast": 50, //对比度，范围0～255
"brightness": 50, //亮度，范围0～255
"saturation": 50, //饱和度，范围0～255
"sharpen": 50, //锐度，范围0～255
"bEnableMI": true, //镜像
"bEnableST": true, //翻转
"rotate": 0, //0:无旋转1：90度2：180度3：270度
"style": 0, //0：标准1：通透2：柔和
"bEnableSmartSensor": true //智能光敏开关
},
"error": {
"errorcode": -1,
"message": "Failed to get image adjust parameters!"
}
}
设置图像调节参数
请求协议
{
"method": "image_set_adjust_param",
"param": {
"channelid": 0,
"contrast": 50, //对比度，范围0～255
"brightness": 50, //亮度，范围0～255
"saturation": 50, //饱和度，范围0～255
"sharpen": 50, //锐度，范围0～255
"bEnableMI": true, //镜像
"bEnableST": true, //翻转
"rotate": 0, //0:无旋转1：90度2：180度3：270度
"style": 0, //0：标准1：通透2：柔和
"bEnableSmartSensor": true //智能光敏开关
}
}
返回信息
{
"method": "image_set_adjust_param",
"error": {
"errorcode": -1,
"message": "Failed to set image adjust parameters!"
}
}
修改设备名称
获取设备信息
请求协议
{
"method": "dev_get_info",
"param": {}
}
返回信息
{
"method": "dev_get_info",
"result": {
"bDiscoverable": true, //是否可以被搜到
"hostname": "HD IPC",
"name": "HD IPC", //设备名称
"nameSync": {
"enable": true,
"chn": [
0,
1,
2
]
},
"rebootDay":
"never,everyday,everysunday,everymonday,everytuesday,everywednesday,everythursday,everyfriday,everysaturday", //自动重启日期
"rebootHour": 0, //自动重启时间
"syslanguage": "chinese", //系统语言
"supportedLangs": [
"chinese",
"english"
],
"encryptEn": true
},
"error": {}
}
设置设备信息
请求协议
{
"method": "dev_set_info",
"param": {
"bDiscoverable": true, //是否可以被搜到
"hostname": "HD IPC",
"name": "HD IPC", //设备名称
"nameSync": {
"enable": true,
"chn": [
0,
1,
2
]
},
"rebootDay":
"never,everyday,everysunday,everymonday,everytuesday,everywednesday,everythursday,everyfriday,everysaturday",//自动重启日期
"rebootHour": 0, //自动重启时间
"syslanguage": "chinese,english", //系统语言
"encryptEn": true
}
}
返回信息
{
"method": "dev_set_info",
"result": {},
"error": {}
}
设备重启
请求协议
{
"method": "dev_reboot",
"param": {
"channelid": 0, //通道号，从0开始。-1表示本机
"delaymSec": 1000
}
}
返回信息
{
"method": "dev_reboot",
"result": {},
"error": {}
}
获取存储信息
请求协议
{
"method": "storage_get_info",
"param": {}
}
返回信息
{
"method": "storage_get_info",
"result": {
"disk": [
{
"diskNum": 0, //硬盘序号
"devName": "/dev/sda", //设备文件名
"sn": "wd32115", //序列号
"sizeMB": 1024, //容量，单位MB
"usedMB": 1024, //使用量，单位MB
"bCurDisk": true, //是否是正在使用的硬盘
"partitionCount": 1, //分区个数
"curPart": 1, //当前正在使用的分区
//normal:正常，unformated：未格式化，formating：正在格式化，breakdown：损坏
// ex_otherdata：存在其他文件，readonly：SD卡只读，type_unsupported：SD卡类型不支持
"status": "normal, unformated,formating,breakdown,ex_otherdata,readonly,type_unsupported",
"fs": "fat32, ntfs, jvfs" //文件系统
}
]
},
"error": {
"errorcode": -1,
"message": "Failed to get storage information!"
}
}
SD卡格式化
请求协议
{
"method": "storage_format",
"param": {
"diskNum": 0, //硬盘序号
"diskName": "/dev/sda", //设备文件名,设备名和硬盘序号必须都正确。
"partionNum": 0 //分区序号，从0开始。>=0表示单独格式化某个分区 -1表示格式化整个硬盘
}
}
返回信息
{
"method": "storage_format",
"result": {},
"error": {
"errorcode": -1,
"message": "Failed to format SDCard"
}
}
获取设备硬件信息
请求协议
{
"method": "dev_get_hwinfo",
"param": {}
}
返回信息
{
"method": "dev_get_hwinfo",
"result": {
"devType": "IPC,NVR,DVR", //设备类型
"devModel": "JVS-N71-HD", //产品型号
"type": "IPC,NVR,DVR",
"hardware": "V1.0", //hardware
"sn": "112233", //序列号
"firmware": "V1.0", //固件版本
"uiVersion": "V1.0", //界面版本
"temperVersion": "1.0.1", //测温模块固件版本
"manufacture": "JOVISION", //制造商
"model": "JVS-N71-HD", //产品型号
"custom": "NULL, KUAIYU", //客户定制需求，可扩展
"bHomeIPC": false,
"bPtzSupport": true,
"PtzFirmware": 375,
"bAFSupport": false,
"bPTZPrivacySupport": false,
"bOnlyDirPtzSupport": true,
"baudiocodecSupport": true,
"bNVModifySupport": true,
"bwdrsupport": true,
"bDemistSupport": true,
"bStarSupport": true,
"bLDCSupport": true,
"brotateSupport": true,
"bExpSupport": true,
"bFaceModeSupport": true,
"bVlpnIrSupport": false,
"bWifiSupport": true,
"bDDNSSupport": true,
"bGB28181Support": true,
"bGB35114Support": true,
"bGA1400Support": true,
"bFTPSupport": true,
"bNFSSupport": true,
"bAlarmServiceSupport": false,
"bRTMPSupport": false,
"bFishEye": false,
"bImageADSupport": true,
"bMultiOsdSupport": true,
"bEightPrivacy": true,
"bMDGridSupport": true,
"bChatSupport": true,
"bEnableOnlineSupport": true,
"channelCnt": 1, //通道个数
"streamCnt": 3, //每个通道的码流个数
"ystID": "A402153844",
"bRemoteDesk": true,
"bWebConfig": false,
"bDstConfigSupport": false,
"bMDRepelWithIVP": false,
"bDualLightSupport": false,
"bAlarmLightSupport": false,
"bAlarmLedSupport": false,
"bAlarmSoundSupport": false,
"AlarmSoundSampleRate": 8000,
"bModBusSupport": false,
"bSecurityViewSupport": false,
"bSnapTimingSupport": false,
"bPDSupport": false,
"bMDSupport": false,
"b4GSupport": false,
"bPtzAutoTraceSupport": false,
"bIntelligenceUpload": true,
"WebProtocol": "HTTP,HTTPS",
"bSupport3DLocate": false,
"bSupportMTrack": false,
"bSupportHomeCloud": false,
"bSupportTimePointPlay": false,
"RemoteChatAudioMode": "TWO_WAY",
"defChatAudioMode": "ONE_WAY",
"MobileQuality": "HIGH",
"IndicatorLedMode": 0,
"alarm": {
"type": "buildin, alarmbox",
"cntAlmGroup": 1,
"cntAlmin_perGroup": 1,
"cntAlmout": 1
},
"audio": {
"cntAi": 1,
"cntAo": 1
},
"bIspLibSupport": false,
"ispVersion": "5678",
"bSDSupport": false,
"bJVMPSupport": false,
"bRecordSupport": false,
"bIntelligenceSupport": false,
"bAlarmCancelSupport": false,
"bAlarmSoundPlanSupport": false,
"bHourlyChimeSupport": false,
"bSimpleRecoverySupport": false,
"ability": [ //设备能力集
"osd",
"simpleDefence",
"driveAway",
"AdDriveAway",
"YSTOldCompatibility",
"alarmEvent",
"lowPower",
"batteryCamera",
"netDetection",
"devMonitoring",
"ystConfigured",
"logSearchByTimeSection",
"activeCall",
"lpr",
"whitelightCtrl",
"statusledCtrl"
]
},
"error": {}
}
获取网络配置
请求协议
{
"method": "ifconfig_get_inet",
"param": {}
}
返回信息
{
"method": "ifconfig_get_inet",
"result": {
"iface": "eth,ppp,wifi", //接口类型
"eth": {
"name": "eth0",
"bDHCP": true, //自动获取ip使能
"bAutoAdapt": true, //自适应ip使能
"bSmartOnline": true, //智能上下线使能
"bEnableOnline": true, //允许上线
"bIPLock": false, //IP地址锁定使能
"addr": "192.168.7.160",
"mask": "255.255.255.0",
"gateway": "192.168.7.1",
"mac": "E0:62:90:33:58:C7",
"dns": "202.102.128.68",
"dns2": "8.8.4.4",
"speed": 100
},
"ppp": {
"name": "adsl",
"username": "qlc",
"passwd": "123456"
},
"wifi": {
"name": "hehe",
"ssid": "jovetech",
"passwd": "111111",
"quality": 100,
"keystat": -1,
"iestat": "open,shared,wep,wpa,wpa2,plain",
"mode": "sta,ap",
"bDHCP": true,
"addr": "192.168.7.160",
"mask": "255.255.255.0",
"gateway": "192.168.7.1",
"mac": "E0:62:90:33:58:C7",
"dns": "202.102.128.68"
},
"ddns": {
"server": "Dyndns DDNS",
"domain": "www.jovision.com",
"user": "admin",
"passwd": "123456"
},
"_4G": {
"iccid": "8986032046208250378", //4G卡号
"mode": "4G",
"quality": -90
}
},
"error": {
"errorcode": -1,
"message": "Failed to get network configuration!"
}
}