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

1、网点排队设备组件技术规范NEW网点排队设备组件技术规范目录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.3 IC卡读卡器 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 打印一行

2、(不自动换行) 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

3、.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.1 Form 244.2.2 Field 244.2.3 Text 244.2.4 Space 244.2.5 Variable 244.2.6 Play 244.2.7 OutputMode 244.2.8 Sound 251 概述设备产商需要按本系统的接口规范提供相关的硬件驱动。呼叫器、窗口屏、综合屏、播音设备、评价器的设备驱动需编译

4、为COM组件；刷卡器、二代证、凭条打印机的设备驱动需编译为Win32 DLL 文件； 2 设备组件规格2.1.1 排队设备COM组件播音设备、窗口屏、呼叫器、评价器、综合屏需要按照以下所规定的规格生成COM组件。设备类别设备组件文件名接口名ProgIDCLSIDTypeLibGUID呼叫器Caller.dllCallerDevCaller.CallerDev30692A8D-3093-4420-97C1-D7EB30795F067D458696-92BC-44F8-A860-8AC3FEF95840详见附件内Caller.idl与CallerDev.rgs 文件评价器Opinion.dllOp

5、inioerOpinion.OpinioerDC5F9077-C7BF-4437-A65E-766E5FD1F7E040623E1B-86BF-4CC2-9637-D39C3910C48B详见附件内Opinion.idl与Opinioer.rgs 文件窗口屏WindowDisp.dllWinDispWindowDisp.WinDisp8A240BD4-3109-4275-A68B-1B5C7B0DEBEB73A601FC-B5A6-4037-A9DD-E763F42A4CAD详见附件内 WindowDisp.idl与WinDisp.rgs文件综合屏SyntheDisp.dllSynDispSy

6、ntheDisp.SynDispF7B26E50-6EF5-464E-9C75-835924EF18EF25ADD009-FB81-4D8A-B0BA-D39CE4738F80详见附件内SyntheDisp.idl与SynDisp.rgs文件播音BroadCast.dllSoundBroadCast.Sound5CB2F7D6-AA8D-416E-8CE0-DF7A05BD227EBBD17A67-966B-4D99-9D97-E3186A04B6E3详见附件内Broad Cast.idl与Sound.rgs 文件2.1.2 排队设备Dll文件刷卡器、二代证、凭条打印机的设备驱动需编译为Win

7、32 DLL 文件；设备类别设备驱动DLL文件名文件部署位置刷卡器SP_SwipeCarder.dll系统盘的WINDOWSsystem32卡读卡器SP_ICCarder.dll系统盘的WINDOWSsystem32二代证SP_IDCarder.dll系统盘的WINDOWSsystem32凭条打印机SP_ReceiptPrinter.dll系统盘的WINDOWSsystem323 驱动接口3.1 公共接口说明公共接口定义的方法事件为本章节设备驱动均须实现的；3.1.1 方法3.1.1.1 SPConnect 需在初始启动时调用本方法来启动设备，该方法可能分配资源并初始化硬件，需要一点时间。此方

8、法为同步方法。 原型short SPConnect ()返回值0：成功3.1.1.2 SPDisconnect 关闭与设备的连接，释放资源。关闭设备可能需要一点时间（取决于SP）。设备关闭后不能再使用，直到调用方法SPConnect来重新打开设备。此方法为同步方法。 原型void SPDisconnect ()参数表无3.2 刷卡器3.2.1 接受用户刷卡int _stdcall AcceptCard ()功能：清空缓冲区、使设备处于可以接受刷卡的状态;返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.2.2 读取银行卡信息int _stdcall C

9、ardReadTrack(char * CardNo,char *Track1, char *Track2, char *Track3)功能： 读取当前刷卡器缓冲区的有效卡数据。如读到有效卡数据返回成功，给相应出参赋值；如没有刷卡数据则返回成功，无需给相应出参赋值；如果读取到无效卡数据或其他故障则返回失败；无需给相应出参赋值无需等待用户刷卡，由上层应用循环调用。入参数： 出参数：CardNo：银行卡号，字节数31；Track1：磁道1数据，字节数31；Track2：磁道2数据，字节数51；Track3：磁道3数据，字节数121；返回值：函数执行成功或失败。CODE_SUCCESS(0), CO

10、DE_FAIL(-1)3.2.3 取消用户刷卡int _stdcall CancelAcceptCard ()功能： 厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1) 3.3 IC卡读卡器3.3.1 接受用户刷卡int _stdcall AcceptCard ()功能：清空缓冲区、使设备处于可以接受刷卡的状态;返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.3.2 读取银行卡信息int _stdcall CardReadTrack(char

11、 * CardNo,char *Track1, char *Track2, char *Track3)功能： 读取当前读卡器中的有效卡数据。如读到有效卡数据返回成功，给相应出参赋值；如没有刷卡数据则返回成功，无需给相应出参赋值；如果读取到无效卡数据或其他故障则返回失败；无需给相应出参赋值无需等待用户刷卡，由上层应用循环调用。入参数： 出参数：CardNo：银行卡号，字节数31；Track1：磁道1数据，字节数31；Track2：磁道2数据，字节数51；Track3：磁道3数据，字节数121；返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.3.3 取消

12、用户刷卡int _stdcall CancelAcceptCard ()功能： 厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1) 3.4 二代身份证读卡器3.4.1 接受用户刷卡int _stdcall AcceptCard ()功能：清空缓冲区、使设备处于可以接受刷卡的状态;返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.4.2 读取身份证信息int _stdcall ReadBaseInfos( char * Name, char *

13、Gender, char * Folk,char *BirthDay, char * Code, char * Address,char *Agency, char * ExpireStart, char* ExpireEnd,char* Photo1,char * Photo2) 功能：本函数用于读取当前卡中基本信息，包括文字信息与图像信息。文字信息以字符串格式输出。如果有身份证正面图片和反面图片则以图片文件保存(jpg或bmp)。如读到有效卡数据返回成功，给相应出参赋值；如没有放卡则返回成功，无需给相应出参赋值；如果读取到无效卡数据或其他故障则返回失败；无需给相应出参赋值无需等待用户刷卡，

14、由上层应用循环调用。出参数：Name 姓名信息。字节数31。Gender性别信息（男或者女），字节数3。Folk 民族信息，字节数10。BirthDay 生日期信息 ，字节数9， 格式为：YYYYMMDD。Code 身份证号码信息 ，字节数19。Address 地址信息 ，字节数71。Agency 签证机关信息 ，字节数 31。ExpireStart 有效期起始日期信息 ，字节数 9, 格式为：CCYYMMDD。ExpireEnd 有效期截至日期信息 ，字节数 9，格式为：CCYYMMDD，有效期为长期的表示为汉字“长期”。 Photo1：如果有身份证正面图片，则赋值为正面图片文件的绝对路径；

15、字节数 51; Photo2：如果有身份证反面图片，则赋值为反面图片文件的绝对路径；字节数 51;返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.4.3 取消用户刷卡int _stdcall CancelAcceptCard ()功能： 厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5 凭条打印机3.5.1 打印一行(不自动换行)int _stdcall PrtPrintLine(const char * pcData)功能： 打印一

16、行(不自动换行)入参数： const char * pcData 打印的数据出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5.2 进纸一行int _stdcall PrtFeed()功能： 进纸一行入参数：无出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5.3 切纸Int _stdcall PrtCut()功能：切纸入参数：无出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5.4 获取打印机状态int _stdcall PrtSt

17、ate(int *piStatus)功能：打印机状态入参数: 无出参数: piStatus：1缺纸，2纸将尽，3正常，11打印头抬起，12打印头异常，13切刀异常，19其他错误返回值: 函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5.5 设置左边界int _stdcall PrtSetLeft(int iLeft)功能：设置左边界入参数：int iLeft 取值为065535，表示打印机水平移动单位的倍数；如传入值为15，实际效果=15*打印机水平移动单位；出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)

18、3.5.6 设置打印字体大小int _stdcall PrtSetFontSize(int iHeng,int iZong)功能：设置打印的字体的大小入参数： int iHeng 横向放大倍数16 int iZong 纵向放大倍数16出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5.7 设置粗体或者取消粗体打印int _stdcall PrtSetBold(int tag)功能： 设置粗体或者取消粗体打印入参数：int tag 1：设置粗体 0.取消粗体出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FA

19、IL(-1)3.5.8 打印准备int _stdcall PrtInit()功能： 打印前调用一次该方法、驱动准备打印；入参数：无出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5.9 下载NV位图int _stdcall PrtLoadNvBmp(char *FilePath)功能： 把位图文件下载到打印机的NV存储区（掉电不丢失）；入参数： FilePath：位图路径，位图大小必须是8的倍数出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.5.10 打印NV位图int _stdcall

20、 PrtPrintNvBmp(int Mode)功能： 把位图文件下载到打印机的NV存储区（掉电不丢失）；入参数： Mode：打印模式 0:正常 1:倍宽 2:倍高 3:倍宽倍高出参数：无返回值：函数执行成功或失败。CODE_SUCCESS(0), CODE_FAIL(-1)3.6 播音设备3.6.1 方法3.6.1.1 Play 该方法用于播放叫号信息；播音内容格式及语种由驱动产商提供可配置。异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条信息已播音完成。原型void Play (BSTR devId , BSTR Info, BSTR formName )参数表devId 播音

21、设备标识；有多路播音设备，可以选使用哪路。 Info 要播放的内容，对应于播放格式配置中各项域的值；域的分割符定为#。formName 显示格式的标识，该播音格式和语种可配置，如果要新增或修改格式时不需要改程序； 参见播音及显屏格式配置文件formName取值： Info取值：BroadcastCall 窗口号#办理号码 如2# A001CallManager 窗口号 如23.6.2 事件3.6.3 属性3.7 窗口屏3.7.1 方法3.7.1.1 Display 该方法用于立即更新窗口屏临时显示的信息；屏重新上电或显示超时该信息被丢弃，当显示超时屏幕却换回宣传信息；异步方法，该方法的返回只说

22、明已添加到驱动的队列中，不代表本条指令已发送给屏显示了。 原型void Display (BSTR devId , BSTR Info,BSTR formName )参数表devId 显屏的设备标识Info 要评价器显示的内容，对应于显示格式配置中各项域的值；域的分割符为#。formName 显示格式的标识，该标识对应于设备驱动中的一个显示格式配置信息，包括显示方式、停留时间等可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；参见播音及显屏格式配置文件formName取值： Info取值：ScreenDisplayCall 窗口号#排队号 如#A001ScreenDis

23、playDefault 要显示的内容 如#暂停服务3.7.1.2 InitialDisplay 该方法用于更新窗口屏空闲显示的宣传信息；该信息被永久存储在显屏中；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给屏显示成功了。原型void InitialDisplay (BSTR devId , BSTR Info,BSTR formName )参数表devId 显屏的设备标识Info 要显示的内容formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；formName取值： Info取值：ScreenDis

24、playIni 要显示的内容3.7.2 事件3.7.3 属性3.8 呼叫器3.8.1 方法3.8.1.1 Display该方法用于更新呼叫器的显示信息；按指定的格式模板显示；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给呼叫器显示成功了。原型void Display (BSTR devId , BSTR info , BSTR formName)参数表devId 呼叫器设备标识info 要呼叫器显示的内容，对应于显示格式配置中各项域的值；域的分割符定为#。formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式

25、显示；参见播音及显屏格式配置文件formName取值： Info取值：CallerDisplayCall 办理号码#等待人数 如A001#13CallerDisplayDefault 提示信息 如 操作成功3.8.1.2 Beep 该方法用于让呼叫器发出翁鸣声；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给呼叫器执行完成了。原型void Beep (BSTR devId , int times)参数表devId 呼叫器设备标识times 要翁鸣的次数3.8.2 事件3.8.2.1 ActionReceived柜员在呼叫器触发的功能事件；原型void ActionRec

26、eived (BSTR devId , BSTR action, BSTR parameters)参数表devId 呼叫器设备标识action 功能标识，取值范围（大小写敏感）： Login ：签到； parameters中参数1的值为柜员号，参数2的值为密码Logout：签退Call：呼叫ReCall：重呼SelectCall：选呼； parameters中参数1的值为要选呼的号码；Pause：暂停服务Transfer：转移； parameters中参数1的值为要转移的窗口号；Welcome：你好Appraise：请评价parameters 功能标识所对应的参数，充许为空；如果有多个参数之间

27、以“#”作为分隔符；3.8.3 属性3.9 评价器3.9.1 方法3.9.1.1 Login该方法更新评价器当前签到柜员的工号、星级；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型void Login (BSTR devId , BSTR userId , int stars)参数表devId 评价器设备标识。userId 签到柜员的工号。starts 签到柜员的星级；取值范围：0：表示无星级1：表示一星级2：表示二星级3：表示三星级4：表示四星级5：表示五星级3.9.1.2 Logout该方法更新评价器为柜员签退状态；异步方法，该方法的返回只说

28、明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型void Logout (BSTR devId, BSTR userId)参数表userId 签到柜员的工号。3.9.1.3 PlayWelcome该方法实现评价器播放对客户的欢迎信息（语音）；该语音信息已存储在评价器中。异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型void PlayWelcome (BSTR devId)参数表devId 评价器设备标识。3.9.1.4 Appraise该方法实现评价器播放请客户评价的提示信息（语音）；该语音信息已存储在评价器中。异步方法，该方

29、法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型void Appraise (BSTR devId)参数表devId 评价器设备标识。3.9.1.5 Display 该方法用于立即更新评价器临时显示的信息；评价器重新上电或显示超时该信息被丢弃，当显示超时屏幕却换回宣传信息；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型void Display (BSTR devId , BSTR info , BSTR formName )参数表devId 评价器的设备标识info 要评价器显示的内容，对应于显示格式配置中各项域的

30、值；域的分割符为#。formName 显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；参见播音及显屏格式配置文件formName取值： Info取值：AppraiseDisplayDefault 要显示的内容3.9.1.6 InitialDisplay 该方法用于更新评价器空闲显示的宣传信息；该信息被永久存储在评价器中；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。原型void InitialDisplay (BSTR devId , BSTR info, BSTR formName)参数表devId 评价器的设备标识info 要评价器显示的内容，对应于显示格式