一体化终端设备技术规范.doc

.智能终端接口规范版本号 1.0福建三元达软件有限公司二一四年六月文档变更说明版本编号变更类型简要说明（变更内容和变更范围）日期变更人V1.0新建创建并拟制初稿2014/6/24朱有文变更类型：新建，修改，增加，删除目录1.前言42.目的范围53.原则54.术语及缩略语55.写卡器设备功能域接口65.1组件名称65.2函数说明65.3调用过程146.二代证身份识别设备功能域接口146.1组件名称146.2函数说明156.3调用过程187.写卡器设备功能域接口187.1组件名称187.2函数说明197.3调用过程238.银行卡读卡器设备功能域接口248.1组件名称248.2函数说明248.3调用过程279.一体机组件名称2810.一体机接口规范281)一体机二代证读卡282)一体机SIM卡读写卡283)一体机打印机28.1. 前言近几年，随着Android、iOS等智能终端操作系统的推广，智能终端功能越来越丰富，越来越被大众所接受，移动互联网正欣欣向荣。智能终端具有体积小、携带方便、移动办公等优势。移动顺应时代潮流，利用移动互联网新技术，采取更为积极主动的营销和服务模式，也建立了包括智能终端版CRM等移动应用，完善了自身的运营支撑能力，以适应市场的需要，提升了自身竞争力，保持自身的行业优势。移动智能终端应用在业务办理过程中，使用到了多种多样的外接设备辅助办公，如蓝牙打印机、蓝牙二代证读卡器、蓝牙SIM信息读卡器等，为企业办公、客户带来的极大的方便。与此同时也带来了问题，同种设备不同厂商在实现方式上各有差别，要兼容不同的外设厂商就必须付出等量的劳动力。因此建立一套智能终端外设接口规范刻不容缓。智能终端外设接口规范明确了外设接入移动智能终端应用的技术规范、业务功能，以指导各外设厂家如何根据规范接入移动智能终端应用。2. 目的范围 智能终端外设接口规范适用于指导各外设厂家将其外设按照规范合理、高效、快速地接入移动智能终端应用，是各外设厂家接入移动智能终端应用的主要依据。本规范规定了外设的技术规范、业务功能，操作流程。3. 原则本规范尽可能依据现有外设的行业技术规范，并能尽量最大化兼容各外设厂商。4. 术语及缩略语下列术语和缩略语适用于本规范：Android是一种以Linux为基础的开放源码操作系统，主要使用于便携设备。iOSiOS是由苹果公司开发的手持设备操作系统。iOS与苹果的Mac OS X操作系统一样，它也是以Darwin为基础的，因此同样属于类Unix的商业操作系统。客户是指一个正在使用及可能使用移动（包括第三方合作伙伴）提供的产品和服务的个人、企业或者其他团体。蓝牙是一种支持设备短距离通信（一般10m内）的无线电技术。能在包括移动电话、PDA、无线耳机、笔记本电脑、相关外设等众多设备之间进行无线信息交换。用户用户是移动客户订购产品的实例。包括资源占用、用户价值、订购信息。智能终端是指像个人电脑一样，具有独立的操作系统，可以由用户自行安装软件、游戏等第三方服务商提供的程序，通过此类程序来不断对终端的功能进行扩充，并可以通过移动通讯网络来实现无线网络接入的这样一类终端的总称。二代证第二代居民身份证CRM客户关系管理(Customer Relationship Management)SIM用户识别卡（Subscriber Identity Module）5. 写卡器设备功能域接口5.1组件名称CMCC_PRINT_厂家英文名缩写_厂家设备型号缩写.so5.2函数说明1) 连接打印机方法描述连接打印机包名+类名com.cmcc.nativepackage.Printer方法名public static native int openPrinter(int printerType,String deviceId,String password)属性变量名称类型变量含义备注入口参数printerTypeint打印机类型printerType 1：USB打印机(包括USB智能终端外设一体机中的打印机)2：蓝牙打印机（包括蓝牙智能终端外设一体机中的打印机）3：串口打印机（包括串口智能终端外设一体机中的打印机）4、内置打印机（包括智能终端一体机中的打印机）入口参数deviceIdString设备ID当printerType为2时，deviceId为打印机MAC地址。当printerType为3时，deviceId为USB 卡(线)转换的串口，如/dev/ttyUSB0。入口参数passwordString密码预留字段返回值int0Success；非0状态码 Fail附加说明password是为了将来可能出现的wifi设备预留的参数。2) 关闭打印机方法描述关闭与打印机的连接包名+类名com.cmcc.nativepackage.Printer方法名public static native int closePrinter()属性变量名称类型变量含义备注返回值int0Success；非0状态码 Fail附加说明无3) 获取组件版本信息方法描述获取各厂商打印机组件的版本信息。包名+类名com.cmcc.nativepackage.Printer方法名public static native int getPrinterVersion(byte version)属性变量名称类型变量含义备注出口参数versionbyte版本号各厂商打印机组件的版本号(三位整数)，数值越大代表版本越高。返回值int0Success；非0状态码 Fail附加说明无4) 初始化打印机方法描述初始化打印机，清除打印缓冲区中的数据，复位打印机打印参数到打印机缺省参数。包名+类名com.cmcc.nativepackage.Printer方法名public static native int initialPrinter()属性变量名称类型变量含义备注返回值int0Success；非0状态码 Fail附加说明不是完全恢复到出厂设置，只是将打印指令参数恢复到打印机缺省参数。点距是指打印的内容每个点之间的距离。具体缺省设置包括如下：1.字体宽高缩放比例：1；2.对齐方式：左对齐；3.左边距：0个点距；4.右边距: 0个点距；5.行间距：8个点距；6.字符间距：0个点距；7.打印方向：横打；8.非粗体打印；9.非下划线打印；10.非反白打印。5) 设置字体宽高缩放比例方法描述设置打印机字符串的字符宽高缩放比例。包名+类名com.cmcc.nativepackage.Printer方法名public static native int setZoonIn(int widthZoonIn,int heightZoonIn)属性变量名称类型变量含义备注入口参数widthZoonInint字体放大宽度相比正常字体宽度的倍数，必须是正整数入口参数heightZoonInint字体放大高度相比正常字体高度的倍数，必须是正整数。返回值int0Success；非0状态码 Fail附加说明打印机字体宽高缩放比例缺省设置为 1。厂商必须支持宽高缩放比为正常字体两倍或以上。6) 设置对齐方式方法描述设置打印机字符串的对齐方式。包名+类名com.cmcc.nativepackage.Printer方法名public static native int setAlignType(int alignType)属性变量名称类型变量含义备注入口参数alignTypeint对齐方式0：左对齐；1：居中对齐；2：右对齐返回值int0Success；非0状态码 Fail附加说明1.打印机缺省设置为左对齐。2.仅在一行开始处理时，该命令才有效。3.竖向打印不支持设置对齐方式，默认上对齐。7) 设置左边距方法描述设置打印机每行字符左边距为n 个点距包名+类名com.cmcc.nativepackage.Printer方法名public static native int setLeftMargin(int n)属性变量名称类型变量含义备注入口参数nint左边点距返回值int0Success；非0状态码 Fail附加说明1. 左边距位置表示打印内容的左侧边缘位置。2. 点距是指打印的内容每个点之间的距离。8) 设置右边距方法描述设置打印机每行字符右边距为n 个点距包名+类名com.cmcc.nativepackage.Printer方法名public static native int setRightMargin(int n)属性变量名称类型变量含义备注入口参数nint右边点距返回值int0Success；非0状态码 Fail附加说明1. 右边距位置表示打印内容的右侧边缘位置。2. 点距是指打印的内容每个点之间的距离。9) 设置行间距方法描述设置打印机字符串的字符行间距为 n 个垂直点距包名+类名com.cmcc.nativepackage.Printer方法名public static native int setLineSpacingByDotPitch (int n)属性变量名称类型变量含义备注入口参数nint垂直点距返回值int0Success；非0状态码 Fail附加说明1.打印机行间距缺省设置为8。2.仅在一行开始处理时，该命令才有效。3. 点距是指打印的内容每个点之间的距离。10) 设置字符间距方法描述设置打印机字符串的字符间距为 n个水平点距包名+类名com.cmcc.nativepackage.Printer方法名public static native int setWordSpacingByDotPitch(int n)属性变量名称类型变量含义备注入口参数nint水平点距取值范围：0 n 255返回值int0Success；非0状态码 Fail附加说明1.打印机字符间距缺省设置为0。2.在倍宽模式下，字符右侧间距是正常值的两倍。当字符被放大时，字符右侧间距被放大同样的倍数。该函数同时影响英文和汉字字符的设定。3. 点距是指打印的内容每个点之间的距离。11) 设置打印方向方法描述设置打印机字符串的打印方向包名+类名com.cmcc.nativepackage.Printer方法名public static native int setPrintOrientation (int printOrientation)属性变量名称类型变量含义备注入口参数nprintOrientation打印方向0：竖打1：横打返回值int0Success；非0状态码 Fail附加说明1.打印机缺省设置为横打。2.设置打印方向后，所有的打印都按照此格式打印。3.竖向不支持设置对齐方式，默认上对齐。12) 设置/取消粗体打印方法描述设置打印机字符串是否粗体打印包名+类名com.cmcc.nativepackage.Printer方法名public static native int setBold(int n)属性变量名称类型变量含义备注入口参数nint是否粗体0：取消粗体打印设置；1：设置粗体打印返回值int0Success；非0状态码 Fail附加说明打印机缺省设置为非粗体打印。13) 设置/取消下划线打印方法描述设置打印机字符串是否下划线打印包名+类名com.cmcc.nativepackage.Printer方法名public static native int setUnderLine(int n)属性变量名称类型变量含义备注入口参数nint是否下划线打印0：取消下划线打印；1：设置下划线打印返回值int0Success；非0状态码 Fail附加说明打印机缺省设置为非下划线打印。14) 设置/取消反白打印方法描述设置打印机字符串是否反白打印包名+类名com.cmcc.nativepackage.Printer方法名public static native int setInverse(int n)属性变量名称类型变量含义备注入口参数nint是否反白打印0：取消反白打印；1：设置反白打印返回值int0Success；非0状态码 Fail附加说明打印机缺省设置为非反白打印。15) 打印字符串方法描述打印字符串包名+类名com.cmcc.nativepackage.Printer方法名public static native int print(String content)属性变量名称类型变量含义备注入口参数contentString打印字符串打印字符串，可包括多行打印数据，使用”n”表示换行。返回值int0Success；非0状态码 Fail附加说明当每行数据超出打印纸张宽度时打印机输出自动换行。16) 打印HTML格式数据方法描述打印HTML格式数据包名+类名com.cmcc.nativepackage.Printer方法名public static native int printHTML(String content)属性变量名称类型变量含义备注入口参数contentStringHTML格式数据返回值int0Success；非0状态码 Fail附加说明支持常用html标签。5.3调用过程图 1打印流程1、 加载组件，调用加载外设组件流程。2、 建立与热敏打印机的连接。3、 调用组件的初始化打印机方法。4、 调用组件的设置打印机参数方法集，如设置对齐方式、设置行间距等方法。5、 调用组件的打印字符或打印HTML格式数据方法。6、 打印机打印票据。7. 关闭连接。6. 二代证身份识别设备功能域接口6.1组件名称CMCC_IDCARD_厂家英文名缩写_厂家设备型号缩写.so6.2函数说明1) 连接二代证身份识别设备方法描述连接二代证身份识别设备包名+类名com.cmcc.nativepackage.IDCard方法名public static native int openIDCard(int idCardType,String deviceId,String password)属性变量名称类型变量含义备注入口参数idCardTypeint二代证身份识别设备类型idCardType 1：USB二代证身份识别设备(包括USB智能终端外设一体机中的二代证身份识别设备)2：蓝牙二代证身份识别设备（包括蓝牙智能终端外设一体机中的二代证身份识别设备）3：串口二代证身份识别设备（包括串口智能终端外设一体机中的二代证身份识别设备）4、内置二代证身份识别设备（包括智能终端一体机中的二代证身份识别设备）入口参数deviceIdString设备ID 当idCardType 为2时deviceId为蓝牙二代证身份识别设备MAC地址当idCardType为3时deviceId为USB 卡(线)转换的串口，如/dev/ttyUSB0。入口参数passwordString密码预留字段返回值int0Success；非0状态码 Fail附加说明password是为了将来可能出现的wifi设备预留的参数。2) 关闭二代证身份识别设备方法描述关闭与二代证身份识别设备的连接包名+类名com.cmcc.nativepackage.IDCard方法名public static native int closeIDCard()属性变量名称类型变量含义备注返回值int0Success；非0状态码 Fail附加说明无3) 获取组件版本信息方法描述获取各厂商二代证身份识别设备组件的版本信息。包名+类名com.cmcc.nativepackage.IDCard方法名public static native int getIDCardVersion(byte version)属性变量名称类型变量含义备注出口参数versionbyte版本号各厂商二代证身份识别设备组件的版本号(三位整数)，数值越大代表版本越高。返回值int0Success；非0状态码 Fail附加说明无4) 初始化二代证身份识别设备方法描述初始化二代证身份识别设备，清除二代证身份识别设备内缓存数据。包名+类名com.cmcc.nativepackage.IDCard方法名public static native int initialIDCard ()属性变量名称类型变量含义备注返回值int0Success；非0 状态码 Fail附加说明无5) 获得二代证信息方法描述获得二代证信息包名+类名com.cmcc.nativepackage.IDCard方法名public static native int getIdCardInfo(String idCardInfo,byte img)属性变量名称类型变量含义备注出口参数idCardInfoString二代证基本信息数组长度为9，内容按顺序分别为：姓名、性别、民族、出生年月、地址、公民身份号码、签发机关、有效期限，照片保存地址。出口参数imgbyte照片文件内容证件头像图片BASE64编码返回值int0Success；非0状态码 Fail附加说明无6.3调用过程图 2二代证身份识别流程图示1、 加载组件，调用加载外设组件流程。2、 建立与二代证身份识别设备的连接。3、 调用组件的初始化二代证身份识别设备方法。4、 调用组件的获取二代证信息方法。5、 页面显示二代证身份信息。6、 关闭连接。7. 写卡器设备功能域接口7.1组件名称CMCC_SIMCARD_厂家英文名缩写_厂家设备型号缩写.so7.2函数说明1) 获取版本信息方法描述通过该函数获取统一写卡组件的版本信息。包名+类名com.cmcc.nativepackage.SimCard方法名public static native int GetOPSVersion (char Version)属性变量名称类型变量含义备注出口参数Versionchar版本号方法返回，统一写卡组件版本信息返回值int0Success；非0状态码 Fail附加说明无2) 读空卡序列号方法描述该函数用于读取卡片空卡序列号，该函数支持本标准发布前和发布后的所有现场写卡系统空卡。因此CRM客户端可通过调用GetCardSN判断是否为本标准发布后生产的空卡。包名+类名com.cmcc.nativepackage.SimCard方法名public static native int GetCardSN(char CardSN)属性变量名称类型变量含义备注出口参数CardSNchar空卡序列号空卡序列号，如卡片符合中国移动SIM卡远程写卡业务规范v1.0.0版本，则长度为16位，如卡片符合中国移动现场写卡技术规范，则长度为20位。返回值int0Success；非0状态码 Fail附加说明无3) 读取卡片信息方法描述该函数用于读取卡片信息，卡片信息包含卡片ICCID、卡片空卡序列号.包名+类名com.cmcc.nativepackage.SimCard方法名public static native int GetCardInfo (char CardInfo)属性变量名称类型变量含义备注出口参数CardInfochar该参数包含卡片ICCID、卡片空卡序列号格式【iccid+（iccid+.）+空卡序列号】该参数包含卡片ICCID、卡片空卡序列号。格式为TLV格式，具体参见NGBOSS2-CRM(V4 5) (U)SIM卡写卡技术规范支撑分册20130722.doc第8.3.3节。其中卡片ICCID如果为一卡多号卡，可出现多次。具体请参见NGBOSS2-CRM(V4 5) (U)SIM卡写卡技术规范支撑分册20130722.doc第7.7一卡多号卡写卡及第8.2.1节空卡判断。返回值int0Success；非0状态码 Fail附加说明无4) 实时写卡数据写入方法描述该函数用于实时写卡数据写入。函数返回值为0时表示统一写卡组件向卡片发送写卡数据成功并得到卡片响应。写卡是否成功须根据Result判断.包名+类名com.cmcc.nativepackage.SimCard方法名public static native int WriteCard(char IssueData, char Result)属性变量名称类型变量含义备注入口参数IssueDatachar现场写卡系统生成的写卡下行报文现场写卡系统生成的写卡下行报文，如多条报文，用“|”分隔。出口参数Resultchar卡片返回结果卡片返回结果，格式参见NGBOSS2-CRM(V4 5) (U)SIM卡写卡技术规范支撑分册20130722.doc第8.3.3.2节中第3部分“返回数据格式”说明。CRM向现场写卡系统回传写卡结果时须传带MAC值的完整结果。返回值int0Success；非0状态码 Fail附加说明无5) 获取错误信息方法描述该函数用于获取错误信息，统一写卡组件将返回最近一次函数调用的错误信息。包名+类名com.cmcc.nativepackage.SimCard方法名public static native int GetOPSErrorMsg(int ErrorCode, char ErrorMsg)属性变量名称类型变量含义备注出口参数ErrorCodeint最近一次接口调用的错误代码该参数为统一写卡组件最近一次接口调用的错误代码，如最近一次执行成功则该参数返回0。出口参数ErrorMsgchar最近一次接口调用的错误描述该参数为统一写卡组件最近一次接口调用的错误描述，如最近一次执行成功则该参数返回字符串“NoError”。返回值int0Success；非0状态码 Fail附加说明无6) 获取读卡器信息方法描述通过该函数连接读卡器。包名+类名com.cmcc.nativepackage.SimCard方法名public static native int ConfigReader(int ReaderType, char DeviceID, char Password)属性变量名称类型变量含义备注入口参数ReaderTypeint读卡器类型1、USB口读卡器（CM-READER协议）；2、蓝牙读卡器；3、串口读卡器；4、内置读卡器入口参数DeviceIDchar设备号1.ReaderType为1时取值如下：WINDOWS: PCSC读卡器名称,Linux: PCSC读卡器名称Android:USB读卡器VID+PID的16进制字符串，如VID为23D8，PID为0185，则值为23D801852.ReaderType为2时为蓝牙读卡器MAC地址的16进制字符串,如读卡器MAC地址为11:22:33:44:55:66，则值为112233445566。3.ReaderType为3时取值如下：WINDOWS: 串口名称，如COM1 Linux: 终端主机自带的串口，如/dev/ttyS0USB卡(线)转换的串口，如/dev/ttyUSB0Android: 终端主机自带的串口，如/dev/ttyS0USB卡(线)转换的串口，如/dev/ttyUSB04.ReaderType为4时取值如下：可以设置为固定值，也可以不配置入口参数Passwordchar蓝牙读卡器连接密码蓝牙读卡器连接密码，该字段为预留字段。返回值int0Success；非0状态码 Fail附加说明无7.3调用过程读卡图 3读卡流程图1、 加载组件，调用加载外设组件流程。2、 通过外设组件相关函数调用统一写卡组件各函数进行读卡。3、 显示读卡结果。写卡图 4写卡流程图1、 加载组件，调用加载外设组件流程。2、 通过外设组件相关函数调用统一写卡组件各函数进行写卡，具体步骤请参见中国移动现场写卡技术规范2.0。3、 显示写卡结果。8. 银行卡读卡器设备功能域接口8.1组件名称CMCC_BANKCARD_厂家英文名缩写_厂家设备型号缩写.so8.2函数说明1) 连接银行卡读卡器设备方法描述连接银行卡读卡器设备包名+类名com.cmcc.nativepackage.BankCard方法名public static native int openBankCard(int bankCardType,String deviceId,String password)属性变量名称类型变量含义备注入口参数bankCardTypeint银行卡读卡器设备类型bankCardType 1：USB银行卡读卡器设备(包括USB智能终端外设一体机中的银行卡读卡器设备)2：蓝牙银行卡读卡器设备（包括蓝牙智能终端外设一体机中的银行卡读卡器设备）3：串口银行卡读卡器设备（包括串口智能终端外设一体机中的银行卡读卡器设备）4、内置银行卡读卡器设备（包括智能终端一体机中的银行卡读卡器设备）入口参数deviceIdString设备ID当bankCardType为2时，deviceId为银行卡读卡器设备MAC地址。当bankCardType为3时，deviceId为USB 卡(线)转换的串口，如/d