3. VVDEV 使用说明
3.1. 概述
主程序
vvdev必需的依赖库文件
libvvdev.so硬件接入层基础功能动态库vvdev_conf.json主配置文件vvdev_param.json副配置文件（运行时自动生成，可读写，记录一些可由用户修改的配置）
可选插件
libqrcode.so二维码识别插件libonvifsvr.soOnvif主服务插件librtspsvr.soRtsp服务插件libextsensor.so外部传感器插件
可选文件
- 语音包 语音包有两种格式：wav 和 opus，如果在硬件层基础功能库 plugin_voicetalk_open 接口中返回的音频格式是 opus，则使用 opus 格式的语音包，否则使用wav格式语音包。语音包中包含中文和英文语音，如果不需要支持英文，可删除掉。语音包的路径在
vvdev_conf.json配置文件的 COMMON.speech_file_path 项中指定。
- 语音包 语音包有两种格式：wav 和 opus，如果在硬件层基础功能库 plugin_voicetalk_open 接口中返回的音频格式是 opus，则使用 opus 格式的语音包，否则使用wav格式语音包。语音包中包含中文和英文语音，如果不需要支持英文，可删除掉。语音包的路径在
请注意，语音包中会包含如
zh、en等多种语言的子目录，配置文件项中指定的路径是这些子目录的上一级目录。
3.2. 启动命令说明
将所有libvvdev.so依赖库和其它可选插件放在同一个文件夹下，如/lib/
将语音包文件解压后，放在某一文件夹下。如不需要语音提示则可跳过此步骤。
将vvdev_conf.json放在某一文件夹下，如/etc/。
启动命令为：
vvdev -L /lib/ -c /etc/vvdev_conf.json -d
注：
vvdev_conf.json文件在鱼眼摄像头出厂检测时，需要写入一些参数，因此，如果是鱼眼摄像头，请保证文件是可写的。
3.3. vvdev命令行选项说明
-h, --help 显示帮助
-v, --version 显示版本号
-d, --daemon 以后台进程方式运行
-c, --config 指定的主配置文件（带完整路径）
-L, --plugin-lib-path 依赖库及插件路径
-l, --log-level 日志等级（也可以在主配置文件中指定），0:NULL 1:FATAL 2:ALERT 3:CRIT 4:ERROR 5:WARN 6:NOTICE 7:INFO 8:DEBUG 9:TRACE 10:ALL
3.4. 主配置文件说明
主配置文件为一json文件，可从这里下载示例文件。
格式如下：
3.4.1 主配置项
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| COMMON | json | 是 | 基础配置 |
| DEFAULT | json | 是 | 一些默认值，其值可以被副配置文件中的配置值覆盖 |
| LOG | json | 是 | 日志文件相关配置 |
| GANGED_TYPE_x | json | 是 | x为数字，记录多个报警联动类型的联动方式 |
| xxxxx | json | 否 | xxxxx为十进制数字，表示事件类型，其内容为事件触发后所表现的方式 |
3.4.2 COMMON配置项说明
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| root_svr_url | string | 是 | 根服务器接入地址，默认：http://ppview.vveye.com:3000/webapi/device/ |
| dev_id_file | string | 是 | 设备序列号文件，带路径 |
| dev_key | string | 否 | 设备序列号授权码，不同厂家不同，通常为空 |
| app_key | string | 是 | 设备服务器接入授权码 |
| app_pass | string | 是 | 设备服务器接入授权码密钥 |
| plugin_path | string | 否 | 依赖库及插件路径，可由命令行参数指定（命令行优先） |
| speech_file_path | string | 否 | 语音文件路径 |
| default_lang | string | 否 | 默认的语言，zh-中文 en-英文，默认zh，在设备被添加到用户账号后，语言值可在副配置文件中修改为与客户端一致的语言值 |
3.4.3 DEFAULT配置项说明
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| motion_detection_enabled | int | 否 | 是否开启移动侦测报警，1=开启，0=关闭，默认1 |
| arm_snap | int | 否 | 布防时报警抓图默认张数，默认值为3 |
| disarm_snap | int | 否 | 撤防时事件抓图默认张数，默认值为0 |
| alert_rec_sec | int | 否 | 事件录像时长（秒)，默认60秒 |
| alert_act | int | 否 | 报警联动方式，0=无，其它=类型，默认0 |
| ptz_home_delay_sec | int | 否 | 云台无操作时回到home位时长，0=不回复 其它=时长（秒），默认0 |
| store_event_pic_type | int | 否 | 事件抓图存储方式，0=不存储，1=本地，2=云端，3=同时，默认2 |
| rtsp_svr_port | int | 否 | rtsp服务端端口，默认1554 |
| onvif_svr_port | int | 否 | onvif服务端口，默认8080 |
| alert_interval_sec | int | 否 | 报警间隔时间，秒，默认30 |
| username | string | 否 | 默认的设备用户名，默认admin |
| password | string | 否 | 默认的设备密码，默认admin |
| auto_adjust_bitrate | int | 否 | 是否在媒体流传输时自动根据网络状态调节码流大小，0=否，1=是，默为0 |
3.4.4 LOG配置项说明
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| enabled | int | 是 | 是否开启日志，0=否，1=是 |
| level | int | 是 | 日志级别，0:NULL 1:FATAL 2:ALERT 3:CRIT 4:ERROR 5:WARN 6:NOTICE 7:INFO 8:DEBUG 9:TRACE 10:ALL |
| filename | string | 是 | 日志文件名，带路径，如/tmp/vvdev.log |
3.4.5 GANGED_TYPE_X 配置项说明
X为报警联动方式编号
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | string | 是 | 名称 |
| start_time | int[] | 是 | 数组，联动动作开始时间，秒，如[0, 15]表示在事件发生后0秒、15秒分别触发某个联动动作 |
| act | int[] | 是 | 联动动作数组，与start_time对应，0=无动作 1=云台垂直扫描 2=云台水平扫描 3=预置位扫描 4=移动到预置位 5=上下左右扫描 6=回到home位 |
| preset | int[] | 是 | 当act为3时，保存所对应的预置位 |
3.4.6 XXXXX配置项说明
XXXXX为事件编号
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| name | string | 是 | 事件名称 |
| arm_push | int | 否 | 布防时触发是否推送，1=是，0=否，默认0 |
| disarm_push | int | 否 | 撤防时触发是否推送，1=是，0=否，默认0 |
| arm_alert | int | 否 | 布防时触发是否播放报警音，1=是，0=否，默认0 |
| disarm_alert | int | 否 | 撤防时触发是否播放报警音，1=是，0=否，默认0 |
| arm_snap | int | 否 | 布防时触发是否抓图，1=是，0=否，默认0 |
| disarm_snap | int | 否 | 撤防时触发是否抓图，1=是，0=否，默认0 |
| arm_rec | int | 否 | 布防时触发是否录像，1=是，0=否，默认0 |
| disarm_rec | int | 否 | 撤防时触发是否录像，1=是，0=否，默认0 |
| event_interval_sec | int | 否 | 触发间隔，秒，默认值是DEFAULT.alert_interval_sec，如不需要间隔，取0 |
| speech_id | int | 否 | 事件触发时播放的音频编号，默认是报警音，32=门铃声 |
| speech_times | int | 否 | 报警音重复播放次数，默认1 |
3.5. 可选插件说明
3.5.1 二维码识别插件
加载此插件后，设备会在无法连接互联网或设备尚未添加到用户账号下的情况下，自动从摄像头捕捉图像进行二维码识别。如没有此插件，则该功能不会开启。
二维码中包含有 wifi 的配置信息和用户账号信息，关键数据已加密，二维码由客户端生成（客户端SDK中有相应的接口）。当设备识别二维码后，根据二维码中的信息，设置无线网络的 ssid 和密码，连接无线上网后，将设备添加到用户账号下。
3.5.2 ONVIF 服务插件
加载此插件后，设备具备基本的 Onvif 服务能力。该 Onvif 服务已进行精简，仅保留了 NVR 接入时所必需的接口。
3.5.3 RTSP 服务插件
加载此插件后，设备具备 RTSP 服务能力，可与 Onvif 服务插件搭配使用，也可单独使用。
RTSP 的地址为：
rtsp://[ip]:[port]/live/[channel id]/[stream id]
其中，ip 为设备的 ip 地址，port 为 RTSP 服务端口，默认为1554，channel id为通道号，从0开始，stream id为码流号，从0开始。
3.5.4 声音文件说明
| 文件名 | 说明 |
|---|---|
| alarm.wav | 报警音 |
| arm_ok.wav | 布防成功 |
| disarm_ok.wav | 撤防成功 |
| beep.wav | 滴一声 |
| connecting.wav | 网络连接中 |
| qrcode_success.wav | 二维码识别成功 |
| bind_success.wav | 添加设备成功 |
| bind_failed.wav | 添加设备失败 |
| bind_no_auth.wav | 设备未授权（添加设备时） |
| binded_by_other.wav | 设备已被其它用户添加 |
| internet_connected.wav | 互联网连接成功 |
| enter_ap_mode.wav | 进入AP模式 |
| exit_ap_mode.wav | 退出AP模式 |
针对有433模块有外部传感器的设备(附加）
| 文件名 | 说明 |
|---|---|
| pls_match.wav | 请对码 |
| match_ok.wav | 对码成功 |
| door_bell.wav | 门铃 |