2016年中国联通总部数字化营业厅一体化高拍仪设备接口规范目录一、更新历史................................................................................ 错误!未定义书签。
二、外设设备接口要求................................................................ 错误!未定义书签。
2.1. 电子凭证采集功能模块接口要求 .............................. 错误!未定义书签。
功能说明............................................................ 错误!未定义书签。
动态链接库名称................................................ 错误!未定义书签。
调用过程............................................................ 错误!未定义书签。
函数说明............................................................ 错误!未定义书签。
3.1. 二代身份证阅读及读写卡功能模块网页OCX控件规范错误!未定义书签。
控件引入............................................................ 错误!未定义书签。
控件方法............................................................ 错误!未定义书签。
控件属性............................................................ 错误!未定义书签。
软件安装............................................................ 错误!未定义书签。
基准测试网页.................................................... 错误!未定义书签。
一、更新历史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=1UserIdCardAddress=C: \DeviceDriverLog\ sign\[Unicom_Cap]UserIdCardPort=7 (设备端口)WriteLog=1MutiIdCardAddress=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.调用过程定义此接口所输出的参数、格式、大小等进行说明接口参数、函数格式等详见下一节。
各操作过程解释如下:2.1.4.函数说明2.1.4.1.打开设备2.1.4.2.关闭设备2.1.4.3.获得设备信息2.1.4.4.获得设备状态获取电子凭证采集设备状态函数2.1.4.5.预览视频(主摄像头) 预览视频(主摄像头)函数2.1.4.6.预览视频(辅摄像头)2.1.4.7.采集影像操作(主摄像头)电子凭证采集设备采集函数2.1.4.8.采集影像操作(辅摄像头)电子凭证采集设备采集函数2.1.4.9.凭证采集设备类型码定义范例电子凭证采集设备类型码定义范例3.1.二代身份证阅网页OCX控件规范二代证阅读功能及读写卡功能对接营业系统,需厂商提供网页OCX控件。
3.1.1.控件引入要求控件使用同一classid,OCX控件名称建议使用IDCardReader.ocx网页中能使用下面代码来访问OCX控件:<OBJECT classid="clsid:-7507-44FE-ACE8-2B3483D179B7"id="CVR_IDCard" name="CVR_IDCard" width=”0”height=”0”></OBJECT>3.1.2.控件方法控件要求提供以下方法:网页中能使用下面代码来访问OCX控件的方法,具体的方法示例:1.ListReaderCard 方法Var readerState = CVR_IDCard. ListReaderCard();2.ReadCard方法var strReadResult=CVR_IDCard.ReadCard();if (strReadResult=="0"){// 读卡成功}else {// 读卡失败alert(strReadResult);}3.1.3.控件属性控件要求提供以下属性,全为BSTR类型:要求在调用完控件的ReadCard()方法成功后,通过(如CVR_)上述属性都得到正确的取值。
3.1.4.软件安装要求厂商提供安装软件,该安装软件具备如下功能:驱动和控件等安装所需文件需打包在一个安装程序中,免驱动的设备需提供控件的安装程序。
驱动默认安装目录C:\IDCardReader。
安装浏览器的OCX控件及相关所依赖的文件,需符合本文档对OCX控件的要求。
驱动程序和OCX控件需支持WindowsXP,WIN7(包括32位和64位)。
浏览器需支持IE6,IE7,IE8以及360。
安装程序启动运行后能实现自动识别操作系统版本和浏览器版本而进行相应的安装,安装过程信息明确,尽量减少人工交互,并自动注册OCX控件。
对于已经安装过时版本控件的系统,要能保证读卡器软件安装后,新控件可以覆盖原控件并生效。
3.1.5.基准测试网页各厂家要保证基于如上操作系统和浏览器在基准测试网页上能测试通过,并保证不弹出安全提示对话框,说明插件符合规范要求。
3.2.读写卡功能模块网页OCX控件规范读写卡功能对接营业系统,需厂商提供网页OCX控件。
3.2.1.控件引入要求控件使用同一classid,OCX控件名称建议使用IDCardWriter.ocx网页中能使用下面代码来访问OCX控件:<OBJECT classid=" clsid:43E4D4FC-3CD8-459A-AAA1-698C1288DE93"id="IDCardWriter" name="IDCardWriter " width=”0”height=”0”></OBJECT>3.2.2.控件方法控件要求提供以下方法:1.GetErrMsg方法var err= IDCardWriter.GetErrMsg();alert(err);2.ListrCard 方法var str = IDCardWriter.ListCard();3.ConnectCard 方法var str = IDCardWriter.ListCard();var retConnect=IDCardReader.ConnectCard(str);4.TransmitCard 方法var str = IDCardWriter.ListCard();var retTrans= IDCardWriter.TransmitCard(cmd,str);5.DisconnectCard方法var str = IDCardWriter.ListCard();var retConnect=IDCardReader. DisconnectCard (str);3.2.1.软件安装要求厂商提供安装软件,该安装软件具备如下功能:驱动和控件等安装所需文件需打包在一个安装程序中,免驱动的设备需提供控件的安装程序。
驱动默认安装目录C:\ IDCardReader。
安装浏览器的OCX控件及相关所依赖的文件,需符合本文档对OCX控件的要求。
驱动程序和OCX控件需支持WindowsXP,WIN7(包括32位和64位)。
浏览器需支持IE6,IE7,IE8以及360。
安装程序启动运行后能实现自动识别操作系统版本和浏览器版本而进行相应的安装,安装过程信息明确,尽量减少人工交互,并自动注册OCX控件。
对于已经安装过时版本控件的系统,要能保证读卡器软件安装后,新控件可以覆盖原控件并生效。
3.2.2.基准测试网页各厂家要保证基于如上操作系统和浏览器在基准测试网页上能测试通过,并保证不弹出安全提示对话框,说明插件符合规范要求。