设备(门禁主机)
网络 SDK 编程指南
V5.2
设备网络 SDK 编程指南
I
声 明
非常感谢您购买我公司的产品，如果您有什么疑问或需要请随时联系我们。
我们已尽量保证手册内容的完整性与准确性，但也不免出现技术上不准确、与产品功能及操作不相符
或印刷错误等情况，如有任何疑问或争议，请以我司最终解释为准。
产品和手册将实时进行更新，恕不另行通知。
本手册中内容仅为用户提供参考指导作用，请以 SDK 实际内容为准。
设备网络 SDK 编程指南
II
目 录
声 明 ................................................................................................................................................................................... I
目 录 .................................................................................................................................................................................. II
1 SDK 简介....................................................................................................................................................................... 1
2 SDK 版本更新 ............................................................................................................................................................... 4
3 函数调用顺序 .............................................................................................................................................................. 9
3.1 SDK 接口调用主要流程 ...................................................................................................................................... 9
3.2 门参数/读卡器参数配置流程 .......................................................................................................................... 10
3.3 计划配置流程 .................................................................................................................................................... 11
3.3.1 门状态计划配置流程 ............................................................................................................................... 12
3.3.2 读卡器验证方式计划配置流程................................................................................................................ 13
3.3.3 卡权限计划模板配置流程 ....................................................................................................................... 14
3.4 布防获取门禁事件流程 .................................................................................................................................... 15
3.5 获取和下发卡号相关联参数流程 .................................................................................................................... 16
3.6 远程开门控制流程 ............................................................................................................................................ 17
3.7 手动抓拍流程 .................................................................................................................................................... 18
3.8 联动抓拍流程 .................................................................................................................................................... 18
4 函数调用实例 ............................................................................................................................................................ 20
4.1 门参数配置示例代码 ........................................................................................................................................ 20
4.2 读卡器参数配置示例代码 ................................................................................................................................ 22
4.3 门状态计划配置示例代码 ................................................................................................................................ 24
4.4 读卡器验证方式计划配置示例代码 ................................................................................................................ 28
4.5 卡权限计划模板配置示例代码 ........................................................................................................................ 32
4.6 布防获取门禁事件示例代码 ............................................................................................................................ 35
4.7 获取和下发卡号相关联参数示例代码 ............................................................................................................ 37
4.8 远程开门示例代码 ............................................................................................................................................ 43
4.9 联动抓拍示例代码 ............................................................................................................................................ 45
5 功能接口介绍 ............................................................................................................................................................ 49
5.1 通用接口介绍 .................................................................................................................................................... 49
5.2 门禁主机功能接口 ............................................................................................................................................ 49
5.3 指纹门禁一体机功能接口 ................................................................................................................................ 57
6 函数说明 .................................................................................................................................................................... 62
6.1 SDK 初始化 ........................................................................................................................................................ 62
6.1.1 初始化 SDK NET_DVR_Init ........................................................................................................................ 62
6.1.2 释放 SDK 资源 NET_DVR_Cleanup ............................................................................................................ 62
6.2 SDK 本地功能 .................................................................................................................................................... 62
SDK 本地参数配置 ..................................................................................................................................................... 62
6.2.1 获取 SDK 本地参数 NET_DVR_GetSDKLocalCfg ....................................................................................... 62
6.2.2 设置 SDK 本地参数 NET_DVR_SetSDKLocalCfg ........................................................................................ 63
连接和接收超时时间及重连设置 ............................................................................................................................ 63
6.2.3 设置网络连接超时时间和连接尝试次数 NET_DVR_SetConnectTime ................................................... 63
6.2.4 设置重连功能 NET_DVR_SetReconnect ................................................................................................... 64
6.2.5 设置接收超时时间 NET_DVR_SetRecvTimeOut ...................................................................................... 64
设备网络 SDK 编程指南
III
多网卡绑定 ................................................................................................................................................................ 64
6.2.6 获取所有 IP，用于支持多网卡接口 NET_DVR_GetLocalIP .................................................................... 64
6.2.7 设置 IP 绑定 NET_DVR_SetValidIP ............................................................................................................ 65
SDK 版本、状态和能力 ............................................................................................................................................. 65
6.2.8 获取 SDK 的版本号和 build 信息 NET_DVR_GetSDKBuildVersion .......................................................... 65
6.2.9 获取当前 SDK 的状态信息 NET_DVR_GetSDKState ................................................................................. 65
6.2.10 获取当前 SDK 的功能信息 NET_DVR_GetSDKAbility .............................................................................. 65
SDK 启用写日志 ......................................................................................................................................................... 66
6.2.11 启用写日志文件 NET_DVR_SetLogToFile ................................................................................................. 66
异常消息回调 ............................................................................................................................................................ 66
6.2.12 注册接收异常、重连等消息的窗口句柄或回调函数 NET_DVR_SetExceptionCallBack_V30 ............... 66
获取错误信息 ............................................................................................................................................................ 68
6.2.13 返回最后操作的错误码 NET_DVR_GetLastError ..................................................................................... 68
6.2.14 返回最后操作的错误码信息 NET_DVR_GetErrorMsg ............................................................................. 68
6.3 用户注册 ............................................................................................................................................................ 69
6.3.1 激活设备 NET_DVR_ActivateDevice ......................................................................................................... 69
6.3.2 通过解析服务器，获取设备的动态 IP 地址和端口号 NET_DVR_GetDVRIPByResolveSvr_EX .............. 69
6.3.3 用户注册设备 NET_DVR_Login_V40 ........................................................................................................ 69
6.3.4 用户注销 NET_DVR_Logout ...................................................................................................................... 70
6.4 获取设备能力集 ................................................................................................................................................ 70
6.4.1 获取设备能力集 NET_DVR_GetDeviceAbility .......................................................................................... 70
6.4.2 获取门禁总能力集 NET_DVR_STDXMLConfig .......................................................................................... 71
6.5 布防、撤防 ........................................................................................................................................................ 72
设置报警等信息上传的回调函数 ............................................................................................................................ 72
6.5.1 注册报警回调函数 NET_DVR_SetDVRMessageCallBack_V31.................................................................. 72
布防撤防 .................................................................................................................................................................... 73
6.5.2 建立报警上传通道，获取报警等信息 NET_DVR_SetupAlarmChan_V41 .............................................. 73
6.5.3 撤销报警上传通道 NET_DVR_CloseAlarmChan_V30 .............................................................................. 73
6.6 远程参数配置 .................................................................................................................................................... 73
通用参数配置 ............................................................................................................................................................ 73
6.6.1 获取设备的配置信息 NET_DVR_GetDVRConfig ...................................................................................... 73
6.6.2 设置设备的配置信息 NET_DVR_SetDVRConfig ....................................................................................... 74
门禁相关参数配置 .................................................................................................................................................... 75
6.6.3 获取设备的配置信息 NET_DVR_GetDVRConfig ...................................................................................... 75
6.6.4 设置设备的配置信息 NET_DVR_SetDVRConfig ....................................................................................... 77
6.6.5 批量获取配置信息 NET_DVR_GetDeviceConfig ...................................................................................... 79
6.6.6 批量设置配置信息 NET_DVR_SetDeviceConfig ....................................................................................... 80
RS485/防区/触发器配置和控制 ................................................................................................................................ 82
6.6.7 获取 NET_DVR_GetDVRConfig .................................................................................................................. 82
6.6.8 设置 NET_DVR_SetDVRConfig ................................................................................................................... 82
6.6.9 设置触发器 NET_DVR_SetAlarmHostOut ................................................................................................ 83
6.6.10 对防区布防 NET_DVR_AlarmHostSetupAlarmChan ................................................................................ 83
6.6.11 对防区撤防 NET_DVR_AlarmHostCloseAlarmChan................................................................................. 83
获取所有防区/触发器及外接模块 ........................................................................................................................... 84
设备网络 SDK 编程指南
IV
6.6.12 启动长连接远程配置 NET_DVR_StartRemoteConfig ............................................................................... 84
6.6.13 逐个获取查找到的结果信息 NET_DVR_GetNextRemoteConfig ............................................................ 85
6.6.14 关闭长连接配置接口所创建的句柄，释放资源 NET_DVR_StopRemoteConfig ................................... 86
用户配置 .................................................................................................................................................................... 86
6.6.15 获取设备用户配置 NET_DVR_GetAlarmDeviceUser ............................................................................... 86
6.6.16 设置设备用户配置 NET_DVR_SetAlarmDeviceUser ............................................................................... 87
长连接参数配置 ........................................................................................................................................................ 87
6.6.17 启动长连接远程配置 NET_DVR_StartRemoteConfig ............................................................................... 87
6.6.18 发送长连接数据 NET_DVR_SendRemoteConfig ...................................................................................... 89
6.6.19 关闭长连接配置接口所创建的句柄，释放资源 NET_DVR_StopRemoteConfig ................................... 90
6.7 远程控制 ............................................................................................................................................................ 90
6.7.1 远程控制 NET_DVR_RemoteControl ......................................................................................................... 90
6.8 门禁控制 ............................................................................................................................................................ 91
6.8.1 门禁控制 NET_DVR_ControlGateway ...................................................................................................... 91
6.9 就地控制器相关 ................................................................................................................................................ 91
6.9.1 就地控制器管理 NET_DVR_STDXMLConfig ............................................................................................. 91
6.9.2 就地控制器控制 NET_DVR_STDXMLConfig ............................................................................................. 92
6.9.3 就地控制器搜索及状态查询 NET_DVR_StartRemoteConfig ................................................................... 93
6.10 USB 设备管理 .................................................................................................................................................... 94
6.10.1 USB 设备管理 NET_DVR_STDXMLConfig ................................................................................................. 94
6.11 可视对讲呼叫功能 ............................................................................................................................................ 95
6.11.1 启动长连接远程配置 NET_DVR_StartRemoteConfig ............................................................................... 95
6.11.2 发送长连接数据 NET_DVR_SendRemoteConfig ...................................................................................... 97
6.11.3 关闭长连接配置接口所创建的句柄，释放资源 NET_DVR_StopRemoteConfig ................................... 97
6.12 考勤相关功能 .................................................................................................................................................... 98
6.12.1 考勤相关配置 NET_DVR_STDXMLConfig ................................................................................................. 98
6.13 手动抓拍 .......................................................................................................................................................... 100
6.13.1 单帧数据捕获并保存成 JPEG 图片 NET_DVR_CaptureJPEGPicture ...................................................... 100
6.13.2 单帧数据捕获并保存成 JPEG 存放在指定的内存空间中 NET_DVR_CaptureJPEGPicture_NEW ........ 100
6.13.3 网络触发抓拍 NET_DVR_ContinuousShoot ........................................................................................... 100
6.14 底图功能 .......................................................................................................................................................... 101
6.14.1 底图上传 NET_DVR_PicUpload ............................................................................................................... 101
6.14.2 获取图片上传的进度 NET_DVR_GetPicUploadProgress ........................................................................ 101
6.14.3 获取远程上传的状态 NET_DVR_GetPicUploadState ............................................................................. 101
6.14.4 关闭上传句柄，释放资源 NET_DVR_CloseUploadHandle .................................................................... 102
6.14.5 远程控制 NET_DVR_RemoteControl ....................................................................................................... 102
6.15 设备维护管理 .................................................................................................................................................. 102
在线状态检测 .......................................................................................................................................................... 102
6.15.1 设备在线状态检测 NET_DVR_RemoteControl ....................................................................................... 102
远程升级 .................................................................................................................................................................. 103
6.15.2 设置远程升级时网络环境 NET_DVR_SetNetworkEnvironment ............................................................ 103
6.15.3 远程升级 NET_DVR_Upgrade ................................................................................................................. 103
6.15.4 获取远程升级的进度 NET_DVR_GetUpgradeProgress .......................................................................... 103
6.15.5 获取远程升级的状态 NET_DVR_GetUpgradeState ................................................................................ 104
