对公自助服务终端设备开发接口设计

对公自助服务终端设备驱动接口文档

2015年5月5日

对公自助服务终端设备驱动接口文档

目

1录驱动接口需求.............................................................................................................................3

1.1设备监控查询接口需求................................................................................................3

1.2RF卡读卡接口需求.......................................................................................................5

1.3打印情况反馈接口需求................................................................................................6

1.4密码键盘输入接口需求................................................................................................8

1.5读身份证接口...............................................................................................................10

2

对公自助服务终端设备驱动接口文档

1驱动接口需求1.1设备监控查询接口需求

接口功能：为了方便系统管理人员即时了解各网点部署的自助设备的运行情况，自助设备必须提供一个软件接口供应用程序调用，能够实时获取机器各部件的运行状况。接口以dll文件形式发布，具体要求如下：

dll文件名：Recp_Monitor.dll?获取监控信息dll函数定义：int

GetMediaStatus(intnDevType,unsignedlong

timeout,LPSTATUSlpStatus)参数说明：

nDevType:设备类型,每个值对应唯一的设备,参见注1timeout:

命令执行超时时间，0表示无限等待

pStatus：状态信息，参见注2返回值：

<0：查询状态失败，并制定对应错误码，参见注30：查询状态成功注1：

#define

#define#define#define#define#define#define

DEV_PRINTERDEV_RFREADERDEV_MGREADERDEV_PINPADDEV_SCANNERDEV_PRINTER_SLOT1DEV_PRINTER_SLOT2

3

123451112

//激光打印机//RF卡读卡器//磁条卡读卡器//密码键盘//二维码扫描枪//激光打印机1号纸盒//激光打印机2号纸盒

对公自助服务终端设备驱动接口文档

#define

#defineDEV_PRINTER_SLOT3DEV_PRINTER_SLOT41314//激光打印机3号纸盒//激光打印机4号纸盒

注2：

LPSTATUSlpStatus定义如下

typedefST_Media_Status

{

WORDfwStatus;

WORDfwSubStatus;

WORDfwDevNo;

WORDfwErrorCode;

LPSTRlpszExtra;//设备主状态//设备辅助状态//固件编号//错误码//扩展字段

}STATUS,*LPSTATUS;

//fwMedia:设备主状态

#defineSTATUS_DEV_ONLINE0//设备状态正常#defineSTATUS_DEV_OFFLINE1//设备未打开

#defineSTATUS_DEV_NODEVICE2//无设备

#defineSTATUS_DEV_NOINK3//打印机无油墨#defineSTATUS_DEV_PAPERJAM4//打印机卡纸#defineSTATUS_DEV_HARDWAREERROR99//设备其他故障注：

1、当打印机卡纸或缺油墨时，优先返回状态3或4，仅当无法识别错误时才返回99

2、当读卡器、密码键盘或扫描枪等发生故障时，返回99

当设备类型为11~14（纸盒）时，只能返回以下状态

#defineSTATUS_SLOT_ERROR10

#defineSTATUS_SLOT_FULL11

#defineSTATUS_SLOT_LOWER12

#defineSTATUS_SLOT_EMPTY13//无法检测纸盒状态//纸张充足//剩余少量纸//没有纸张(纸盒空)

//fwSubStatus:设备子（辅助）状态（当设备类型为打印机时，用于获取油墨状况）#defineSTATUS_PRT_FULLINK0//油墨充足#defineSTATUS_PRT_LOWERINK1//油墨不足

注：如果nDevType为1（打印机）时，必须返回这个辅助状态；当nDevType不为1时，可以填0

//fwDevNo：固件编号

返回对应设备固件编号值，不存在返回0

//fwErrorCode

0:设备正常

其他具体错误待定

//lpszExtra

4

对公自助服务终端设备驱动接口文档

该字符串返回的为扩展字段，可以用来描述对应fwErrorCode错误码意义。设备正常时，值可以为NULL。

注3：

#define

#define

#define

#defineZJ_SUCCESSZJ_ERR_TIMEOUTZJ_ERR_INTERNAL_ERRORZJ_ERR_INVALID_DATA0-1-2-3执行成功命令执行超时命令执行报错参数输入非法

1.2RF卡读卡接口需求

接口功能：自助设备需要提供一个基于dll的api函数用于读取ID卡的卡号

dll文件名：Recp_readcard.dll

?读取ID卡卡号

dll函数定义：int

参数说明：

Data：存放读入的卡号，供调用者使用

Errmsg：出错时存放错误信息

返回值：

非0

要求：

只有在读卡状态下才开启蜂鸣声。读取成功读取失败，同时在Errmsg参数中保存错误信息getcardno(char*Data，char*errmsg)

5