网点排队设备组件技术规范NEW.docx
《网点排队设备组件技术规范NEW.docx》由会员分享，可在线阅读，更多相关《网点排队设备组件技术规范NEW.docx（24页珍藏版）》请在冰豆网上搜索。
网点排队设备组件技术规范NEW
网点排队设备组件技术规范
目录
1概述5
2设备组件规格6
2.1.1排队设备COM组件6
2.1.2排队设备Dll文件6
3驱动接口8
3.1公共接口说明8
3.1.1方法8
3.2刷卡器8
3.2.1接受用户刷卡8
3.2.2读取银行卡信息8
3.2.3取消用户刷卡9
3.3IC卡读卡器9
3.3.1接受用户刷卡9
3.3.2读取银行卡信息9
3.3.3取消用户刷卡10
3.4二代身份证读卡器10
3.4.1接受用户刷卡10
3.4.2读取身份证信息10
3.4.3取消用户刷卡11
3.5凭条打印机11
3.5.1打印一行（不自动换行）11
3.5.2进纸一行11
3.5.3切纸11
3.5.4获取打印机状态12
3.5.5设置左边界12
3.5.6设置打印字体大小12
3.5.7设置粗体或者取消粗体打印13
3.5.8打印准备13
3.5.9下载NV位图13
3.5.10打印NV位图13
3.6播音设备14
3.6.1方法14
3.6.2事件14
3.6.3属性14
3.7窗口屏15
3.7.1方法15
3.7.2事件16
3.7.3属性16
3.8呼叫器16
3.8.1方法16
3.8.2事件17
3.8.3属性17
3.9评价器18
3.9.1方法18
3.9.2事件20
3.9.3属性21
3.10综合屏21
3.10.1方法21
3.10.2事件22
3.10.3属性22
4播音及显屏格式配置文件23
4.1说明23
4.1.1播音及显屏格式配置文件样例23
4.2格式定义说明24
4.2.1Form24
4.2.2Field24
4.2.3Text24
4.2.4Space24
4.2.5Variable24
4.2.6Play24
4.2.7OutputMode24
4.2.8Sound25
1概述
设备产商需要按本系统的接口规范提供相关的硬件驱动。
呼叫器、窗口屏、综合屏、播音设备、评价器的设备驱动需编译为COM组件；
刷卡器、二代证、凭条打印机的设备驱动需编译为Win32DLL文件；
2设备组件规格
2.1.1排队设备COM组件
播音设备、窗口屏、呼叫器、评价器、综合屏需要按照以下所规定的规格生成COM组件。
设备类别
设备组件文件名
接口名
ProgID
CLSID
TypeLib
GUID
呼叫器
Caller.dll
CallerDev
Caller.CallerDev
30692A8D-3093-4420-97C1-D7EB30795F06
7D458696-92BC-44F8-A860-8AC3FEF95840
详见附件内Caller.idl
与CallerDev.rgs文件
评价器
Opinion.dll
Opinioer
Opinion.Opinioer
DC5F9077-C7BF-4437-A65E-766E5FD1F7E0
40623E1B-86BF-4CC2-9637-D39C3910C48B
详见附件内Opinion.idl
与Opinioer.rgs文件
窗口屏
WindowDisp.dll
WinDisp
WindowDisp.WinDisp
8A240BD4-3109-4275-A68B-1B5C7B0DEBEB
73A601FC-B5A6-4037-A9DD-E763F42A4CAD
详见附件内
WindowDisp.idl
与WinDisp.rgs文件
综合屏
SyntheDisp.dll
SynDisp
SyntheDisp.SynDisp
F7B26E50-6EF5-464E-9C75-835924EF18EF
25ADD009-FB81-4D8A-B0BA-D39CE4738F80
详见附件内
SyntheDisp.idl
与SynDisp.rgs文件
播音
BroadCast.dll
Sound
BroadCast.Sound
5CB2F7D6-AA8D-416E-8CE0-DF7A05BD227E
BBD17A67-966B-4D99-9D97-E3186A04B6E3
详见附件内
BroadCast.idl
与Sound.rgs文件
2.1.2排队设备Dll文件
刷卡器、二代证、凭条打印机的设备驱动需编译为Win32DLL文件；
设备类别
设备驱动DLL文件名
文件部署位置
刷卡器
SP_SwipeCarder.dll
系统盘的WINDOWS\system32\
ＩＣ卡读卡器
SP_ICCarder.dll
系统盘的WINDOWS\system32\
二代证
SP_IDCarder.dll
系统盘的WINDOWS\system32\
凭条打印机
SP_ReceiptPrinter.dll
系统盘的WINDOWS\system32\
3驱动接口
3.1公共接口说明
公共接口定义的方法事件为本章节设备驱动均须实现的；
3.1.1方法
3.1.1.1SPConnect
需在初始启动时调用本方法来启动设备，该方法可能分配资源并初始化硬件，需要一点时间。
此方法为同步方法。
原型
shortSPConnect（）
返回值
0：
成功
3.1.1.2SPDisconnect
关闭与设备的连接，释放资源。
关闭设备可能需要一点时间（取决于SP）。
设备关闭后不能再使用，直到调用方法SPConnect来重新打开设备。
此方法为同步方法。
原型
voidSPDisconnect（）
参数表
无
3.2刷卡器
3.2.1接受用户刷卡
int__stdcallAcceptCard（）
功能：
清空缓冲区、使设备处于可以接受刷卡的状态;
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.2.2读取银行卡信息
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）
3.2.3取消用户刷卡
int__stdcallCancelAcceptCard（）
功能：
厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.3IC卡读卡器
3.3.1接受用户刷卡
int__stdcallAcceptCard（）
功能：
清空缓冲区、使设备处于可以接受刷卡的状态;
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.3.2读取银行卡信息
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）
3.3.3取消用户刷卡
int__stdcallCancelAcceptCard（）
功能：
厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.4二代身份证读卡器
3.4.1接受用户刷卡
int__stdcallAcceptCard（）
功能：
清空缓冲区、使设备处于可以接受刷卡的状态;
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.4.2读取身份证信息
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）
3.4.3取消用户刷卡
int__stdcallCancelAcceptCard（）
功能：
厂商根据自己的设备情况决定是否需要实现该函数，如果不需要则直接返回成功；
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5凭条打印机
3.5.1打印一行（不自动换行）
int__stdcallPrtPrintLine（constchar*pcData）
功能：
打印一行（不自动换行）
入参数：
constchar*pcData打印的数据
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.2进纸一行
int__stdcallPrtFeed（）
功能：
进纸一行
入参数：
无
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.3切纸
Int__stdcallPrtCut（）
功能：
切纸
入参数：
无
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.4获取打印机状态
int__stdcallPrtState（int*piStatus）
功能：
打印机状态
入参数:
无
出参数:
piStatus：
1缺纸，2纸将尽，3正常，11打印头抬起，12打印头异常，13切刀异常，19其他错误
返回值:
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.5设置左边界
int__stdcallPrtSetLeft（intiLeft）
功能：
设置左边界
入参数：
intiLeft取值为0～65535，表示打印机水平移动单位的倍数；
如传入值为15，实际效果=15*打印机水平移动单位；
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.6设置打印字体大小
int__stdcallPrtSetFontSize（intiHeng,intiZong）
功能：
设置打印的字体的大小
入参数：
intiHeng横向放大倍数1~6
intiZong纵向放大倍数1~6
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.7设置粗体或者取消粗体打印
int__stdcallPrtSetBold（inttag）
功能：
设置粗体或者取消粗体打印
入参数：
inttag1：
设置粗体0.取消粗体
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.8打印准备
int__stdcallPrtInit（）
功能：
打印前调用一次该方法、驱动准备打印；
入参数：
无
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.9下载NV位图
int__stdcallPrtLoadNvBmp（char*FilePath）
功能：
把位图文件下载到打印机的NV存储区（掉电不丢失）；
入参数：
FilePath：
位图路径，位图大小必须是8的倍数
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.5.10打印NV位图
int__stdcallPrtPrintNvBmp（intMode）
功能：
把位图文件下载到打印机的NV存储区（掉电不丢失）；
入参数：
Mode：
打印模式0:
正常1:
倍宽2:
倍高3:
倍宽倍高
出参数：
无
返回值：
函数执行成功或失败。
CODE_SUCCESS（0）,CODE_FAIL（-1）
3.6播音设备
3.6.1方法
3.6.1.1Play
该方法用于播放叫号信息；播音内容格式及语种由驱动产商提供可配置。
异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条信息已播音完成。
原型
voidPlay（BSTRdevId,BSTRInfo,BSTRformName）
参数表
devId播音设备标识；有多路播音设备，可以选使用哪路。
Info要播放的内容，对应于播放格式配置中各项域的值；域的分割符定为##。
formName显示格式的标识，该播音格式和语种可配置，如果要新增或修改格式时不需要改程序；参见播音及显屏格式配置文件
formName取值：
Info取值：
BroadcastCall窗口号##办理号码如2##A001
CallManager窗口号如2
3.6.2事件
3.6.3属性
3.7窗口屏
3.7.1方法
3.7.1.1Display
该方法用于立即更新窗口屏临时显示的信息；屏重新上电或显示超时该信息被丢弃，当显示超时屏幕却换回宣传信息；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给屏显示了。
原型
voidDisplay（BSTRdevId,BSTRInfo,BSTRformName）
参数表
devId显屏的设备标识
Info要评价器显示的内容，对应于显示格式配置中各项域的值；域的分割符为##。
formName显示格式的标识，该标识对应于设备驱动中的一个显示格式配置信息，包括显示方式、停留时间等可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；参见播音及显屏格式配置文件
formName取值：
Info取值：
ScreenDisplayCall窗口号##排队号如①##A001
ScreenDisplayDefault要显示的内容如①##暂停服务
3.7.1.2InitialDisplay
该方法用于更新窗口屏空闲显示的宣传信息；该信息被永久存储在显屏中；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给屏显示成功了。
原型
voidInitialDisplay（BSTRdevId,BSTRInfo,BSTRformName）
参数表
devId显屏的设备标识
Info要显示的内容
formName显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；
formName取值：
Info取值：
ScreenDisplayIni要显示的内容
3.7.2事件
3.7.3属性
3.8呼叫器
3.8.1方法
3.8.1.1Display
该方法用于更新呼叫器的显示信息；按指定的格式模板显示；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给呼叫器显示成功了。
原型
voidDisplay（BSTRdevId,BSTRinfo,BSTRformName）
参数表
devId呼叫器设备标识
info要呼叫器显示的内容，对应于显示格式配置中各项域的值；域的分割符定为##。
formName显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；参见播音及显屏格式配置文件
formName取值：
Info取值：
CallerDisplayCall办理号码##等待人数如A001##13
CallerDisplayDefault提示信息如操作成功
3.8.1.2Beep
该方法用于让呼叫器发出翁鸣声；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给呼叫器执行完成了。
原型
voidBeep（BSTRdevId,inttimes）
参数表
devId呼叫器设备标识
times要翁鸣的次数
3.8.2事件
3.8.2.1ActionReceived
柜员在呼叫器触发的功能事件；
原型
voidActionReceived（BSTRdevId,BSTRaction,BSTRparameters）
参数表
devId呼叫器设备标识
action功能标识，取值范围（大小写敏感）：
Login：
签到；parameters中参数1的值为柜员号，参数2的值为密码
Logout：
签退
Call：
呼叫
ReCall：
重呼
SelectCall：
选呼；parameters中参数1的值为要选呼的号码；
Pause：
暂停服务
Transfer：
转移；parameters中参数1的值为要转移的窗口号；
Welcome：
你好
Appraise：
请评价
parameters功能标识所对应的参数，充许为空；如果有多个参数之间以“##”作为分隔符；
3.8.3属性
3.9评价器
3.9.1方法
3.9.1.1Login
该方法更新评价器当前签到柜员的工号、星级；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。
原型
voidLogin（BSTRdevId,BSTRuserId,intstars）
参数表
devId评价器设备标识。
userId签到柜员的工号。
starts签到柜员的星级；
取值范围：
0：
表示无星级
1：
表示一星级
2：
表示二星级
3：
表示三星级
4：
表示四星级
5：
表示五星级
3.9.1.2Logout
该方法更新评价器为柜员签退状态；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。
原型
voidLogout（BSTRdevId,BSTRuserId）
参数表
userId签到柜员的工号。
3.9.1.3PlayWelcome
该方法实现评价器播放对客户的欢迎信息（语音）；该语音信息已存储在评价器中。
异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。
原型
voidPlayWelcome（BSTRdevId）
参数表
devId评价器设备标识。
3.9.1.4Appraise
该方法实现评价器播放请客户评价的提示信息（语音）；该语音信息已存储在评价器中。
异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。
原型
voidAppraise（BSTRdevId）
参数表
devId评价器设备标识。
3.9.1.5Display
该方法用于立即更新评价器临时显示的信息；评价器重新上电或显示超时该信息被丢弃，当显示超时屏幕却换回宣传信息；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。
原型
voidDisplay（BSTRdevId,BSTRinfo,BSTRformName）
参数表
devId评价器的设备标识
info要评价器显示的内容，对应于显示格式配置中各项域的值；域的分割符为##。
formName显示格式的标识，该显示格式要可配置，如果要新增或修改格式时不需要改程序；如该值为空，则按默认格式显示；参见播音及显屏格式配置文件
formName取值：
Info取值：
AppraiseDisplayDefault要显示的内容
3.9.1.6InitialDisplay
该方法用于更新评价器空闲显示的宣传信息；该信息被永久存储在评价器中；异步方法，该方法的返回只说明已添加到驱动的队列中，不代表本条指令已发送给评价器执行完成了。
原型
voidInitialDisplay（BSTRdevId,BSTRinfo,BSTRformName）
参数表
devId评价器的设备标识
info要评价器显示的内容，对应于显示格式
升级会员 