网点排队设备组件技术规范

网点排队设备组件技术规范目录TOC\o"1-3"1概述52设备组件规格62.1.1排队设备COM组件62.1.2排队设备Dll文件63驱动接口83.1公共接口说明83.1.1方法83.2刷卡器83.2.1接受用户刷卡83.2.2读取银行卡信息83.2.3取消用户刷卡93.3IC卡读卡器93.3.1接受用户刷卡93.3.2读取银行卡信息93.3.3取消用户刷卡103.4二代身份证读卡器103.4.1接受用户刷卡103.4.2读取身份证信息103.4.3取消用户刷卡113.5凭条打印机113.5.1打印一行(不自动换行) 113.5.2进纸一行113.5.3切纸113.5.4获取打印机状态123.5.5设置左边界123.5.6设置打印字体大小123.5.7设置粗体或者取消粗体打印133.5.8打印准备133.5.9下载NV位图133.5.10打印NV位图133.6播音设备143.6.1方法143.6.2事件143.6.3属性143.7窗口屏153.7.1方法153.7.2事件163.7.3属性163.8呼叫器163.8.1方法163.8.2事件173.8.3属性173.9评价器183.9.1方法183.9.2事件203.9.3属性213.10综合屏213.10.1方法213.10.2事件223.10.3属性224播音及显屏格式配置文件234.1说明234.1.1播音及显屏格式配置文件样例234.2格式定义说明244.2.1Form 244.2.2Field 244.2.3Text 244.2.4Space 244.2.5Variable 244.2.6Play 244.2.7OutputMode 244.2.8Sound 25概述设备产商需要按本系统的接口规范提供相关的硬件驱动。呼叫器、窗口屏、综合屏、播音设备、评价器的设备驱动需编译为COM组件；刷卡器、二代证、凭条打印机的设备驱动需编译为Win32DLL文件；设备组件规格排队设备COM组件播音设备、窗口屏、呼叫器、评价器、综合屏需要按照以下所规定的规格生成COM组件。设备类别设备组件文件名接口名ProgIDCLSIDTypeLibGUID呼叫器Caller.dllCallerDevCaller.CallerDev30692A8D-3093-4420-97C1-D7EB30795F067D458696-92BC-44F8-A860-8AC3FEF95840详见附件内Caller.idl与CallerDev.rgs文件评价器Opinion.dllOpinioerOpinion.OpinioerDC5F9077-C7BF-4437-A65E-766E5FD1F7E040623E1B-86BF-4CC2-9637-D39C3910C详见附件内Opinion.idl与Opinioer.rgs文件窗口屏WindowDisp.dllWinDispWindowDisp.WinDisp8A240BD4-3109-4275-A68B-1B5C7B0DEBEB73A601FC-B5A6-4037-A9DD-E763F42A详见附件内WindowDisp.idl与WinDisp.rgs文件综合屏SyntheDisp.dllSynDispSyntheDisp.SynDispF7B26E50-6EF5-464E-9C75-835924EF18EF25ADD009-FB81-4D8A-B0BA-D39CE4738F80详见附件内SyntheDisp.idl与SynDisp.rgs文件播音BroadCast.dllSoundBroadCast.Sound5CB2F7D6-AA8D-416E-8CE0-DF7A05BD227EBBD17A67-966B-4D99-9D97-E3186A04B6E3详见附件内BroadCast.idl与Sound.rgs文件排队设备Dll文件刷卡器、二代证、凭条打印机的设备驱动需编译为Win32DLL文件；设备类别设备驱动DLL文件名文件部署位置刷卡器SP_SwipeCarder.dll系统盘的WINDOWS\system32\ＩＣ卡读卡器SP_ICCarder.dll系统盘的WINDOWS\system32\二代证SP_IDCarder.dll系统盘的WINDOWS\system32\凭条打印机SP_ReceiptPrinter.dll系统盘的WINDOWS\system32\驱动接口公共接口说明公共接口定义的方法事件为本章节设备驱动均须实现的；方法SPConnect需在初始启动时调用本方法来启动设备，该方法可能分配资源并初始化硬件，需要一点时间。此方法为同步方法。原型shortSPConnect()返回值0：成功SPDisconnect关闭与设备的连接，释放资源。关闭设备可能需要一点时间（取决于SP）。设备关闭后不能再使用，直到调用方法SPConnect来重新打开设备。此方法为同步方法。原型voidSPDisconnect()参数表无刷卡器接受用户刷卡int__stdcallAcceptCard()功能：清空缓冲区、使设备处于可以接受刷卡的状态;返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)读取银行卡信息int__stdcallCardReadTrack(char*CardNo,char*Track1,char*Track2,char*Track3)功能：读取当前刷卡器缓冲区的有效卡数据。如读到有效卡数据返回成功，给相应出参赋值；如没有刷卡数据则返回成功，无需给相应出参赋值；如果读取到无效卡数据或其他故障则返回失败；无需给相应出参赋值无需等待用户刷卡，由上层应用循环调用。入参数：出参数：CardNo：银行卡号，字节数31；Track1：磁道1数据，字节数31；Track2：磁道2数据，字节数51；Track3：磁道3数据，字节数121；返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)取消用户刷卡int__stdcallCancelAcceptCard()功能：厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)IC卡读卡器接受用户刷卡int__stdcallAcceptCard()功能：清空缓冲区、使设备处于可以接受刷卡的状态;返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)读取银行卡信息int__stdcallCardReadTrack(char*CardNo,char*Track1,char*Track2,char*Track3)功能：读取当前读卡器中的有效卡数据。如读到有效卡数据返回成功，给相应出参赋值；如没有刷卡数据则返回成功，无需给相应出参赋值；如果读取到无效卡数据或其他故障则返回失败；无需给相应出参赋值无需等待用户刷卡，由上层应用循环调用。入参数：出参数：CardNo：银行卡号，字节数31；Track1：磁道1数据，字节数31；Track2：磁道2数据，字节数51；Track3：磁道3数据，字节数121；返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)取消用户刷卡int__stdcallCancelAcceptCard()功能：厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)二代身份证读卡器接受用户刷卡int__stdcallAcceptCard()功能：清空缓冲区、使设备处于可以接受刷卡的状态;返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)读取身份证信息int__stdcallReadBaseInfos(char*Name,char*Gender,char*Folk,char*BirthDay,char*Code,char*Address,char*Agency,char*ExpireStart,char*ExpireEnd,char*Photo1,char*Photo2)功能：本函数用于读取当前卡中基本信息，包括文字信息与图像信息。文字信息以字符串格式输出。如果有身份证正面图片和反面图片则以图片文件保存(jpg或bmp)。如读到有效卡数据返回成功，给相应出参赋值；如没有放卡则返回成功，无需给相应出参赋值；如果读取到无效卡数据或其他故障则返回失败；无需给相应出参赋值无需等待用户刷卡，由上层应用循环调用。出参数：Name姓名信息。字节数31。Gender性别信息（男或者女），字节数3。Folk民族信息，字节数10。BirthDay生日期信息，字节数9，格式为：YYYYMMDD。Code身份证号码信息，字节数19。Address地址信息，字节数71。Agency签证机关信息，字节数31。ExpireStart有效期起始日期信息，字节数9,格式为：CCYYMMDD。ExpireEnd有效期截至日期信息，字节数9，格式为：CCYYMMDD，有效期为长期的表示为汉字“长期”。Photo1：如果有身份证正面图片，则赋值为正面图片文件的绝对路径；字节数51;Photo2：如果有身份证反面图片，则赋值为反面图片文件的绝对路径；字节数51;返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)取消用户刷卡int__stdcallCancelAcceptCard()功能：厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)凭条打印机打印一行(不自动换行)int__stdcallPrtPrintLine(constchar*pcData)功能：打印一行(不自动换行)入参数：constchar*pcData打印的数据出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)进纸一行int__stdcallPrtFeed()功能：进纸一行入参数：无出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)切纸Int__stdcallPrtCut()功能：切纸入参数：无出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)获取打印机状态int__stdcallPrtState(int*piStatus)功能：打印机状态入参数:无出参数: piStatus：1缺纸，2纸将尽，3正常，11打印头抬起，12打印头异常，13切刀异常，19其他错误返回值:函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)设置左边界int__stdcallPrtSetLeft(intiLeft)功能：设置左边界入参数：intiLeft取值为0～65535，表示打印机水平移动单位的倍数；如传入值为15，实际效果=15*打印机水平移动单位；出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)设置打印字体大小int__stdcallPrtSetFontSize(intiHeng,intiZong)功能：设置打印的字体的大小入参数：intiHeng横向放大倍数1~6intiZong纵向放大倍数1~6出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)设置粗体或者取消粗体打印int__stdcallPrtSetBold(inttag)功能：设置粗体或者取消粗体打印入参数：inttag1：设置粗体0.取消粗体出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)打印准备int__stdcallPrtInit()功能：打印前调用一次该方法、驱动准备打印；入参数：无出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)下载NV位图int__stdcallPrtLoadNvBmp(char*FilePath)功能：把位图文件下载到打印机的NV存储区（掉电不丢失）；入参数：FilePath：位图路径，位图大小必须是8的倍数出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)打印NV位图int__stdcallPrtPrintNvBmp(intMode)功能：把位图文件下载到打印机的NV存储区（掉电不丢失）；入参数：Mode：打印模式0:正常1:倍宽2:倍高3:倍宽倍高出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0),CODE_FAIL(-1)播音设备方法Play该方法用于播放叫号信息；播音内容格式及语种由驱动产商提供可配置。异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条信息已播音完成。原型voidPlay(BSTRdevId,BSTRInfo,BSTRformName)参数表devId 播音设备标识；有多路播音设备，可以选使用哪路。Info 要播放的内容，对应于播放格式配置中各项域的值；域的分割符定为##。formName 显示格式的标识，该播音格式和语种可配置，如果要新增或修改格式时不需要改程序；HYPERLINK参见播音及显屏格式配置文件formName取值：Info取值：BroadcastCall 窗口号##办理号码如2##A001CallManager 窗口号 如2事件属性窗口屏方法Display该方法用于立即更新窗口屏临时显示的信息；屏重新上电或显示超时该信息被丢弃，当显示超时屏幕却换回宣传信息；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给屏显示了。原型voidDisplay(BSTRdevId,BSTRInfo,BSTRformName)参数表devId 显屏的设备标识Info 要评价器显示的内容，对应于显示格式配置中各项域的值；域的分割符为##。formName显示格式的标识，该标识对应于设备驱动中的一个显示格式配置信息，包括显示方式、停留时间等可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；HYPERLINK参见播音及显屏格式配置文件formName取值：Info取值：ScreenDisplayCall 窗口号##排队号如①##A001ScreenDisplayDefault 要显示的内容如①##暂停服务InitialDisplay该方法用于更新窗口屏空闲显示的宣传信息；该信息被永久存储在显屏中；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给屏显示成功了。原型voidInitialDisplay(BSTRdevId,BSTRInfo,BSTRformName)参数表devId 显屏的设备标识Info 要显示的内容formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；formName取值：Info取值：ScreenDisplayIni 要显示的内容事件属性呼叫器方法Display该方法用于更新呼叫器的显示信息；按指定的格式模板显示；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给呼叫器显示成功了。原型voidDisplay(BSTRdevId,BSTRinfo,BSTRformName)参数表devId 呼叫器设备标识info 要呼叫器显示的内容，对应于显示格式配置中各项域的值；域的分割符定为##。formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；HYPERLINK参见播音及显屏格式配置文件formName取值：Info取值：CallerDisplayCall 办理号码##等待人数如A001##13CallerDisplayDefault 提示信息 如操作成功Beep该方法用于让呼叫器发出翁鸣声；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给呼叫器执行完成了。原型voidBeep(BSTRdevId,inttimes)参数表devId呼叫器设备标识times要翁鸣的次数事件ActionReceived柜员在呼叫器触发的功能事件；原型voidActionReceived(BSTRdevId,BSTRaction,BSTRparameters)参数表devId呼叫器设备标识action功能标识，取值范围（大小写敏感）： Login：签到；parameters中参数1的值为柜员号，参数2的值为密码Logout：签退Call：呼叫ReCall：重呼SelectCall：选呼；parameters中参数1的值为要选呼的号码；Pause：暂停服务Transfer：转移；parameters中参数1的值为要转移的窗口号；Welcome：你好Appraise：请评价parameters功能标识所对应的参数，充许为空；如果有多个参数之间以“##”作为分隔符；属性评价器方法Login该方法更新评价器当前签到柜员的工号、星级；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型voidLogin(BSTRdevId,BSTRuserId,intstars)参数表devId评价器设备标识。userId签到柜员的工号。starts签到柜员的星级；取值范围：0：表示无星级1：表示一星级2：表示二星级3：表示三星级4：表示四星级5：表示五星级Logout该方法更新评价器为柜员签退状态；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型voidLogout(BSTRdevId,BSTRuserId)参数表userId签到柜员的工号。PlayWelcome该方法实现评价器播放对客户的欢迎信息（语音）；该语音信息已存储在评价器中。异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型voidPlayWelcome(BSTRdevId)参数表devId评价器设备标识。Appraise该方法实现评价器播放请客户评价的提示信息（语音）；该语音信息已存储在评价器中。异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型voidAppraise(BSTRdevId)参数表devId评价器设备标识。Display该方法用于立即更新评价器临时显示的信息；评价器重新上电或显示超时该信息被丢弃，当显示超时屏幕却换回宣传信息；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型voidDisplay(BSTRdevId,BSTRinfo,BSTRformName)参数表devId 评价器的设备标识info 要评价器显示的内容，对应于显示格式配置中各项域的值；域的分割符为##。formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；HYPERLINK参见播音及显屏格式配置文件formName取值：Info取值：AppraiseDisplayDefault 要显示的内容InitialDisplay该方法用于更新评价器空闲显示的宣传信息；该信息被永久存储在评价器中；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型voidInitialDisplay(BSTRdevId,BSTRinfo,BSTRformName)参数表devId 评价器的设备标识info 要评价器显示的内容，对应于显示格式配置中各项域的值；域的分割符为##。formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；HYPERLINK参见播音及显屏格式配置文件formName取值：Info取值：AppraiseDisplayIni 要显示的内容事件Appraised(BSTRdevId,BSTRresul,intserviceTime)当客户对柜员作出评价后；评价器触发该事件。原型voidAppraised(BSTRdevId,BSTRInfo,BSTRformName)参数表devId 评价器设备标识。resul 客户的评价结果。取值范围： 空：表示客户在指定的时间范围内没有作出评价；1：表示很满意 2：表示满意 3：表示一般 4：不满意 5：很不满意serviceTime 表示本次为客户服务的时间长度、从播放欢迎信息开始计时到请客户评价作为结止的时长，单位为秒；如果该值为-1，系统则采用调用PlayWelcome到StartedAppraise的时差作为服务时长；属性综合屏方法Display该方法用于综合屏显示叫号信息，最近一条信息显示在综合屏的第一行；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给综合屏执行完成了。原型voidDisplay(BSTRdevId,BSTRinfo,BSTRformName)参数表devId 综合屏的设备标识info 要评价器显示的内容，对应于显示格式配置中各项域的值；域的分割符为##。formName 显示格式的标识，该标识对应于设备驱动中的一个显示格式配置信息，包括显示方式、停留时间等可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；HYPERLINK参见播音及显屏格式配置文件formName取值：Info取值：BigScreenDisplayCall 窗口号##排队号如①##A001InitialDisplay该方法用于更新综合屏空闲显示的宣传信息；该信息被永久存储在显屏中；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给综合屏执行完成了。原型voidInitialDisplay(BSTRdevId,BSTRinfo,BSTRformName)参数表devId 综合屏的设备标识info 要显示的内容formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；HYPERLINK参见播音及显屏格式配置文件formName取值：Info取值：BigScreenDisplayIni 要显示的内容事件属性播音及显屏格式配置文件说明因目前各排队厂商的硬件存在较大差异，没有统一行业标准规格；因此把信息显示及播音的相关格式配置由设备驱动层来实现，更有利于厂商设备功能的展示和扩展。本文中提供的配置格式定义可供各厂商参考，但不作为硬性要求。播音及显屏格式配置文件样例<?xmlversion="1.0"encoding="GB2312"?><root> <Formname="ScreenCall"> <Fields> <Fieldalignment="left"> <Textfont="宋体"size="10"color="red"value="当前办理"/> <Spacelength="2"/> <Variablevalue="{0}"/> </Field> <F