联通数字化营业厅一体化高拍仪接口规范v

联通数字化营业厅一体化高拍仪接口规范v

文档编制序号：[KK8UY-LL9IO69-TTO6M3-MTOL89-FTT688] 2016年中国联通总部数字化营业厅 一体化高拍仪设备接口规范

目录 文件状态： [ ] 草稿 [√] 正式发布 [ ] 正在修改

当前版本： 1.0

作 者： 狄秋燕，朱雯莉，胡迪，孟莉莉

制作单位 中国联通信息化部 完成日期： 2016-7-28

审 核： 一、更新历史 2016.7.28 V1.0 初次编写 二、外设设备接口要求 2.1. 电子凭证采集功能模块接口要求 电子凭证采集功能模块，对接联通无纸化系统，外设接口类型为Windows DLL,接口调用方式采用stdcall标准调用，每个厂家的每类设备只能提供一个DLL文件。设备命名为设备类型.dll。 驱动文件存放地址对于windows系统，为安装操作系统所在盘的WINDOWS\system32目录下。在打开相关设备时，当输入参数端口号为-1时，驱动文件按照本地配置文件中设备对应的端口号调用相关设备，其它数值按照输入参数调用相应端口设备。 各驱动的命名如下： 驱动命名列表 设备类型描述 设备命名 电子扫描设备 Unicom_Cap.dll 设备本地配置文件说明：本地配置文件用来配置驱动日志地址信息。配置信息的windows存放在地址C:\DeviceDriverConf.ini中。 1. 驱动文件日志记录要求： WriteLog（WriteLog值为0：不记录日志；WriteLog值为1，不记录调用接口函数的参数；WriteLog值为2，记录调用接口函数的参数） 2. 配置文件格式为： [Unicom_Sign] UserIdCardPort=6 （设备端口） WriteLog=1 UserIdCardAddress=C: \DeviceDriverLog\ sign\ [Unicom_Cap] UserIdCardPort=7 （设备端口） WriteLog=1 MutiIdCardAddress=C: \DeviceDriverLog\ cap\ 3. 状态码常量定义 状态码（正常状态、运行状态、告警状态）建议用8位数字或字母表示。 第1位表示状态类型， 1：正常状态 2：运行信息 3：维护告警（级别：黄维护） 4：故障告警（红维修）。 第2-6位表示设备类型码。 第7-8位表示各部件的状态类型。 2.1.1. 功能说明 对此接口进行定义、作用、参数、描述等 定义电子凭证采集设备相关的打开、关闭、采集（为保证图像质量 可选预览模式）、连接状态查询、裁剪旋转等基本操作接口与操作流程与错误码等信息表示方式。 2.1.2. 动态链接库名称 设备厂家提供的主动态库名称为Unicom_Cap.dll，由设备厂商根据该DLL开发相应OCX插件。OCX插件与动态库之间的调用流程如图所示。设备厂商负责画面质量以及云终端兼容性。 图3-1 OCX插件与动态库之间的调用流程图 2.1.3. 调用过程 定义此接口所输出的参数、格式、大小等进行说明 接口参数、函数格式等详见下一节。各操作过程解释如下： 操作名 功能定义 备注 打开设备 通过上位机程序为设备分配必要的系统资源 关闭设备 释放设备所占用的系统资源

获得设备信息 返回设备PID、VID、唯一ID、厂商名称、设备型号、支持分辨率等信息 获得设备状态 调用设备自检程序，返回设备可用状态 采集影像操作（主摄像头） 采集资料影像图片，返回图片存储位置 (支持自动裁剪与手动裁剪模式) 采集影像操作（辅摄像头） 采集客户影像图片，返回图片存储位置

预览视频 （主摄像头） 在指定窗口上显示资料影像(支持自动和手动绘图) 预览视频 （辅摄像头） 在指定窗口上显示客户影像

照片旋转 旋转照片 类型码定义 操作指令所返回的各种状态码定义

2.1.4. 函数说明

2.1.4.1. 打开设备 打开电子凭证采集设备识读函数 函数描述 打开设备 函数名 int_stdcall OpenDevice(int Port,char* retMsg) 属性 变量名称 类型 变量含义 备 注

入口参数 Port int 端口号 USB端口从1000开始。USB1填1001，驱动自己处理Baud 波特率DataBits 数据位StopBits 停止位Parity 奇偶校验自行在驱动里处理

出口参数 retMsg char * 错误信息 执行失败时返回的错误信息，最大60字节

返回值 int 0－>Success； 状态码－> Fail 附加说明

2.1.4.2. 关闭设备

关闭电子凭证采集设备识读函数 函数描述 关闭设备 函数名 int_stdcall CloseDevice(char* retMsg) 属性 变量名称 类型 变量含义 备 注

出口参数 retMsg char * 错误信息 执行失败时返回的错误信息，最大60字节

返回值 int 0?Success； 状态码? Fail 附加说明

2.1.4.3. 获得设备信息

获取电子凭证采集设备信息函数 函数描述 获得设备信息

函数名 typedef struct { char pid[60]; //设备PID char uuid[60]; //唯一编号 char vid[60]; //设备VID

char[56] VendorName 厂家名称 char[32] ProductName 设备型号 char version[60]; //DLL版本号 char res[256]; //支持分辨率字符串，如”1920X1080,1366X768,640X480” }DeviceInfo; int _stdcall getDeviceInfo(DeviceInfo *info, char* retMsg); 属性 变量名称 类型 变量含义 备 注

入口参数 info DeviceInfo 设备信息 返回设备信息

出口参数 retMsg char* 执行结果中文解释 最大长度：60

返回值 retCode int 执行结果状态码 0? Success； 非0?retMsg解释

2.1.4.4. 获得设备状态

获取电子凭证采集设备状态函数 函数描述 获得设备状态 函数名 int _stdcall getDeviceStatus(int* code ，char* retMsg); 属性 变量名称 类型 变量含义 备 注

返回值 retCode int 执行结果状态码 0? Success； 非0?函数执行失败 出口参数 code int* 状态code

出口参数 retMsg char* 执行结果中文解释 最大长度：60 附加说明 主要查看设备是否连接，不处于正在被使用状态，并可正常调用读取函数。 附加说明2 出口参数对应设备状态：

2.1.4.5. 预览视频(主摄像头)

预览视频（主摄像头）函数 函数描述 预览视频 函数名 int _stdcall previewDeviceA(void* displayHandle, int type,int Angle, char* Resolution, char * retMsg) 属性 变量名称 类型 变量含义 备 注

返回值 retCode int 执行结果状态码 0? Success； 非0?retMsg解释 入口参数 displayHandle void* 视频显示控件句柄 Windows控件句柄 入口参数 type int 证件类型 见附件说明，主要用于根据类型提示裁剪区域

入口参数 Angle int 旋转角度 主要用于视频预览时旋转 只能为0，90，180，270

入口参数 Resolutioun char* 分辨率 主要用于视频预览时的分辨率，为空时自行定义

出口参数 retMsg char* 执行结果中文解释 最大长度：60 附加说明 主要预览资料影像。

附加说明2 所有凭证类型代码遵循以下解释： 0：未定义（手动裁切） 1：二代身份证 2: 临时身份证 3：户口本 4：中国护照 5：国际护照 6：军官证（士兵证） 7：港澳通行证 8：港澳居民往来内地通行证 9：台湾居民来往大陆通行证 10：二代证背面

2.1.4.6. 预览视频(辅摄像头)

预览视频（辅摄像头）函数 函数描述 预览视频 函数名 int _stdcall previewDeviceB(void* displayHandle, char * retMsg) 属性 变量名称 类型 变量含义 备 注

返回值 retCode int 执行结果状态码 0? Success； 非0?retMsg解释

入口参数 displayHandle void* 视频显示控件句柄 Windows控件句柄

出口参数 retMsg char* 执行结果中文解释 最大长度：60