xGprinterPlus

connectBle disConnect getPrinterStatus setPrinterCommandType printLabel

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码供您参考。

概述

xGprinterPlus装了佳博热敏打印机官方2.2.1版SDK,可通过蓝牙、usb、网口连接打印机，同时支持ESC和TSC打印2中模式打印。

固件要求

Android：4.0及以上

connectDevices

连接多设备

connectDevices(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：

err：

  • 类型：JSON对象
  • 内部字段：
  2.     msg: ''
  3. }

示例代码

  1. var demo = api.require('xGprinterPlus');
  2. demo.connectDevices(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.5及更高版本

connectBle

蓝牙连接(仅单设备时使用)

connectBle(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ''
  3. }

示例代码

  1. var demo = api.require('xGprinterPlus');
  2. demo.connectBle(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.5及更高版本

connectUsb

USB连接(仅单设备时使用)

connectUsb(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ''
  3. }

示例代码

  1. var demo = api.require('xGprinterPlus');
  2. demo.connectUsb(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.5及更高版本

disConnect

断开连接(仅单设备时使用)

disConnect(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3. }
  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ''
  3. }

示例代码

可用性

Android系统

可提供的1.0.5及更高版本

printTest

打印测试页

printTest({params},callback(ret, err))

xh：

  • 类型：数字型
  • 描述：（可选项）指定打印机0-3。
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ''
  3. }

示例代码

  1. var demo = api.require('xGprinterPlus');
  2. demo.printTest(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.5及更高版本

getPrinterStatus

查询打印机状态

getPrinterStatus({params},callback(ret, err))

params

xh：

  • 类型：数字型
  • 描述：（可选项）指定打印机0-3。
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     message : "打印机正常"     // 打印机状态描述
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ''
  3. }

示例代码

  1. var obj = api.require('xGprinterPlus');
  2. obj.getPrinterStatus(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.5及更高版本

getConnectState

查询打印机连接状态

getConnectState()

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     state : [false,false,false,false]     // 0-3个打印机连接状态
  4. }

示例代码

  1. var obj = api.require('xGprinterPlus');
  2. var ret = obj.getConnectState();
  3. alert(JSON.stringify(ret));

可用性

Android系统

可提供的1.0.5及更高版本

setPrinterCommandType

切换打印模式

setPrinterCommandType({params},callback(ret, err))

params

xh：

  • 类型：数字型
  • 描述：（可选项）指定打印机0-3。
  • 默认值：0

commandType：

  • 类型：数字型
  • 描述：（必输项）0 : 面单模式 1 :票据模式 2 :标签模式。

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3. }
  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ''
  3. }

可用性

Android系统

可提供的1.0.5及更高版本

printReceipt

打印票据(ESC模式打印，确保打印机处于票据模式)

printReceipt({params}, callback(ret, err))

params

xh：

  • 类型：数字型
  • 描述：（可选项）指定打印机0-3。
  • 默认值：0

rows：

  • 类型：数组
  • 描述：（必输项）打印数据。
  1. [{
  2.     lineType: 'lines',//打印空行,要传行数
  3.     data : 0   //要打印的空行行数
  4. },{
  5.     lineType: 'style',   //设置样式
  6.     data : [0,0,0,0,0]    //字体A/B:(0:A|1:B);是否加粗:(0:关闭|1:开启);倍高:(0:关闭|1:开启);倍宽:(0:关闭|1:开启);下划线:(0:关闭|1:开启)
  7. },{
  8.     lineType: 'align',   //设置字体位置
  9.     data : 'center',    //left|center|right
  10. },{
  11.     lineType: 'text',   //设置打印内容
  12.     data : '打印文本'
  13. },{
  14.     lineType: 'lineFeed'   //设置空行,不需要设置行数
  15. },{
  16.     lineType: 'image',  //设置打印图片
  17.     data : 'widget://image/huibo_logo.png'  //支持 fs:// widget:// 路径
  18. },{
  19.     lineType: 'barcodePosition',  //设置条码可识别字符位置
  20.     data: 'below'   //设置打印位置 above|aboveAndBelow|below|noPrint
  21. },{
  22.     lineType: 'barcodeHeight',  //设置条码高度
  23.     data : 60  //条码高度
  24. },{
  25.     lineType: 'barcodeWidth',  //设置条码单元宽度
  26.     data : 1 //宽度为1点
  27. },{
  28.     lineType: 'code128',  //打印Code128码
  29.     data : '123456789'
  30. },{
  31.     lineType: 'levelForQRCode',  //设置纠错等级
  32.     data : 31
  33. },{
  34.     lineType: 'moduleForQRCode',  //设置qrcode模块大小
  35.     data : 3
  36. },{
  37.     lineType: 'qrcode',  //设置qrcode内容
  38.     data : 'qrcode内容' 
  39. },{
  40.     lineType: 'openBox'  //开钱箱
  41. },{
  42.     lineType: 'ImmediatelyOpenBox'  //立即开钱箱
  43. },{
  44. }]

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg:""
  3. }

示例代码

  1. var obj = api.require('xGprinterPlus');
  2. demo.printReceipt({
  3.     rows : [{
  4.         lineType : 'lines',
  5.         data : 3
  6.     },{//设置打印居中
  7.         lineType : 'align',
  8.         data : 'center'
  9.     },{//设置为倍高倍宽
  10.         lineType : 'style',
  11.         data : [0,0,1,1,0]
  12.     },{// 打印文字
  13.         lineType : 'text',
  14.         data : 'Sample\n'
  15.     },{
  16.         lineType : 'lineFeed'
  17.     },{//取消倍高倍宽
  18.         lineType : 'style',
  19.         data : [0,0,0,0,0]
  20.     },{//设置打印左对齐
  21.         lineType : 'align',
  22.         data : 'left'
  23.     },{// 打印文字
  24.         lineType : 'text',
  25.         data : 'Print text\n'
  26.     },{// 打印文字
  27.         lineType : 'text',
  28.         data : 'Welcome to use printer!\n'
  29.     },{
  30.         lineType : 'lineFeed'
  31.     },{// 打印文字
  32.         lineType : 'text',
  33.         data : 'Print bitmap!\n'
  34.     },{
  35.         lineType : 'image',
  36.         data : 'widget://image/huibo_logo.png'
  37.     },{// 打印文字
  38.         lineType : 'text',
  39.         data : 'Print code128\n'
  40.     },{//设置条码可识别字符位置在条码下方
  41.         lineType : 'barcodePosition',
  42.         data : 'below'
  43.     },{//设置条码高度为60点
  44.         lineType : 'barcodeHeight',
  45.         data : 60
  46.     },{//设置条码单元宽度为1点
  47.         lineType : 'barcodeWidth',
  48.         data : 1
  49.     },{//打印Code128码
  50.         lineType : 'code128',
  51.         data : '123456789'
  52.     },{
  54.     },{// 打印文字
  55.         lineType : 'text',
  56.         data : 'Print QRcode\n'
  57.     },{//设置纠错等级
  58.         lineType : 'levelForQRCode',
  59.         data : 31
  60.     },{//设置qrcode模块大小
  61.         lineType : 'levelForQRCode',
  62.         data : 3
  63.     },{//设置qrcode内容
  64.         lineType : 'qrcode',
  65.         data : "www.printer.com.cn"
  66.     },{
  67.         lineType : 'lineFeed'
  68.     },{//设置打印居中
  69.         lineType : 'align',
  70.         data : 'center'
  71.     },{// 打印文字
  72.         lineType : 'text',
  73.         data : 'Completed!\r\n'
  74.     },{//开钱箱
  75.         lineType : 'openBox'
  76.     }]
  77. },function(ret, err){
  78.     alert(JSON.stringify(ret)+"   "+ JSON.stringify(err));
  79. });

可用性

Android系统

可提供的1.0.5及更高版本

printLabel

打印标签(TSC模式打印，确保打印机处于标签模式)

printLabel({params}, callback(ret, err))

params

xh：

  • 类型：数字型
  • 描述：（可选项）指定打印机0-3。
  • 默认值：0

rows：

  • 类型：数组
  • 描述：（必输项）打印数据。
  1. [{
  2.     lineType: 'size',//设置标签尺寸，按照实际尺寸设置
  3.     width : 80,
  4.     height : 72
  5. },{
  6.     lineType: 'gap',   //设置标签间隙，按照实际尺寸设置
  7.     data : 0    //如果为无间隙纸则设置为0
  8. },{
  9.     lineType: 'direction',   //设置打印方向
  10.     direction : 'backward',   //backward|forward
  11.     mirror : 'normal'         //normal|mirror
  12. },{
  13.     lineType: 'reference',   /设置原点坐标
  14.     x : 0 ,
  15.     y : 0
  16. },{
  17.     lineType: 'tear',   //撕纸模式开启
  18.     data : true
  19. },{
  20.     lineType: 'cls'  // 清除打印缓冲区
  21. },{
  22.     lineType: 'text',  //绘制简体中文
  23.     x : 20 ,
  24.     y : 20,
  25.     rotation : 0, // 0|90|180|270
  26.     xscal : 1,    //1~10
  27.     yscal : 1,     //1~10
  28.     data : '要打印的文字'
  29. },{
  30.     lineType: 'image',  //绘制图片
  31.     x : 20,
  32.     y : 50,
  33.     data : 'widget://image/huibo_logo.png' //支持fs:// widget://
  34. },{
  35.     lineType: 'qrcode',  绘制qrcode
  36.     x : 250 ,
  37.     y : 80 ,
  38.     level : 'L',  //L|M|H|Q
  39.     cellwith : 5,
  40.     rotation : 0, // 0|90|180|270
  41.     data : '要打印的二维码内容'
  42. },{
  43.     lineType: 'code128',  //绘制一维条码
  44.     x : 250 ,
  45.     y : 80 ,
  46.     height : 100,
  47.     rotation : 0, // 0|90|180|270
  48.     data : '123456789'
  49. },{
  50.     lineType: 'bar',  //画线
  51.     x : 0 ,
  52.     y : 0 ,
  53.     width : 0
  54.     height : 0
  55. }]

openBox：

  • 类型：布尔型
  • 描述：（可选项）是否打开钱箱。
  • 默认值：true

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg:""
  3. }

示例代码

  1. var obj = api.require('xGprinterPlus');
  2. demo.printLabel({
  3.     rows : [{
  4.         lineType : 'size',
  5.         width : 80,
  6.         height : 72
  7.     },{
  8.         lineType : 'gap',
  9.         data : 0
  10.     },{
  11.         lineType : 'cls'
  12.     },{
  13.         lineType : 'gap',
  14.         data : 0
  15.     },{// 左边框
  16.         lineType : 'bar',
  17.         x : 16,
  18.         y :  0,
  19.         width : 4,
  20.         height : 556
  21.     },{// 上边框
  22.         lineType : 'bar',
  23.         x : 16,
  24.         y :  0,
  25.         width : 608,
  26.         height : 8
  27.     },{// 右边框
  28.         lineType : 'bar',
  29.         x : 624,
  30.         y :  0,
  31.         width : 4,
  32.         height : 556
  33.     },{// 下边框
  34.         lineType : 'bar',
  35.         x : 16,
  36.         y :  556,
  37.         width : 608,
  38.         height : 4
  39.     },{// 图片单元格竖线
  40.         lineType : 'bar',
  41.         x : 16 + 130,
  42.         y :  0,
  43.         width : 2,
  44.         height : 106
  45.     },{//绘制图片
  46.         lineType : 'image',
  47.         x : 16 + 8,
  48.         data : 'widget://image/huibo_logo.png'
  49.     },{//绘制文本
  50.         lineType : 'text',
  51.         x : 16 + 8,
  52.         y :  8,
  53.         rotation : 0,
  54.         xscal : 1,
  55.         yscal : 1,
  56.         data : '青岛汇博通商贸有限公司'
  57.     },{// 图片单元格横线
  58.         lineType : 'bar',
  59.         x : 16 + 130,
  60.         y :  56,
  61.         width : 640 - 130 - 16 - 16,
  62.         height : 2
  63.     },{// 二维码旁边竖线
  64.         lineType : 'bar',
  65.         x : 16 + 320,
  66.         y :  106,
  67.         width : 2,
  68.         height : 556 - 106
  69.     },{// 横线
  70.         lineType : 'bar',
  71.         x : 16 ,
  72.         y :  106,
  73.         width : 608,
  74.         height : 2
  75.     },{//绘制文本
  76.         lineType : 'text',
  77.         x : 16 + 4,
  78.         y :  106 + 2,
  79.         rotation : 0,
  80.         xscal : 1,
  81.         yscal : 2,
  83.     },{//绘制文本
  84.         lineType : 'text',
  85.         x : 16 + 320 + 2,
  86.         y :  106 + 2,
  87.         rotation : 0,
  88.         xscal : 1,
  89.         yscal : 2,
  90.         data : '钢厂资源号：ML123456789'
  91.     },{// 横线
  92.         lineType : 'bar',
  93.         x : 16 + 320 + 2 ,
  94.         y :  156,
  95.         width : 608,
  96.         height : 2
  97.     },{//绘制code128
  98.         lineType : 'code128',
  99.         x : 16 + 16,
  100.         y :  156 + 2,
  101.         height : 48,
  102.         rotation : 0,
  103.         data : '1234567890'
  104.     },{//绘制文本
  105.         lineType : 'text',
  106.         x : 16 + 320 + 2,
  107.         y :  156 + 2,
  108.         rotation : 0,
  109.         xscal : 1,
  110.         yscal : 2,
  111.         data : '母卷号：P123456789'
  112.     },{// 横线
  113.         lineType : 'bar',
  114.         x : 16 ,
  115.         y :  206,
  116.         width : 608,
  117.         height : 2
  118.     },{//绘制文本
  119.         lineType : 'text',
  120.         x : 16 + 4,
  121.         y :  206 + 2,
  122.         rotation : 0,
  123.         xscal : 1,
  124.         yscal : 2,
  125.         data : '品名：冷轧卷'
  126.     },{//绘制文本
  127.         lineType : 'text',
  128.         x : 16 + 320 + 2,
  129.         y :  206 + 2,
  130.         rotation : 0,
  131.         xscal : 1,
  132.         yscal : 2,
  133.         data : '牌号：DC06'
  134.     },{// 横线
  135.         lineType : 'bar',
  136.         x : 16 ,
  137.         y :  256,
  138.         width : 608,
  139.         height : 2
  140.     },{//绘制文本
  141.         lineType : 'text',
  142.         x : 16 + 4,
  143.         y :  256 + 2,
  144.         rotation : 0,
  145.         xscal : 1,
  146.         yscal : 2,
  147.         data : '规格：1.2*1250*C'
  148.     },{//绘制文本
  149.         lineType : 'text',
  150.         x : 16 + 320 + 2,
  151.         y :  256 + 2,
  152.         rotation : 0,
  153.         xscal : 1,
  154.         yscal : 2,
  155.         data : '净重：10.5t'
  156.     },{// 横线
  157.         lineType : 'bar',
  158.         x : 16 ,
  159.         y :  306,
  160.         width : 608,
  161.         height : 2
  162.     },{//绘制文本
  163.         lineType : 'text',
  164.         x : 16 + 4,
  165.         y :  306 + 2,
  166.         rotation : 0,
  167.         xscal : 1,
  168.         yscal : 2,
  169.         data : '毛重：10.8t'
  170.     },{//绘制文本
  171.         lineType : 'text',
  172.         x : 16 + 320 + 2,
  173.         y :  306 + 2,
  174.         rotation : 0,
  175.         xscal : 1,
  176.         yscal : 2,
  177.         data : '件数：1'
  178.     },{// 横线
  179.         lineType : 'bar',
  180.         x : 16 ,
  181.         y :  356,
  182.         width : 608,
  183.         height : 2
  184.     },{//绘制文本
  185.         lineType : 'text',
  186.         x : 16 + 4,
  187.         y :  356 + 2,
  188.         rotation : 0,
  189.         xscal : 1,
  190.         yscal : 2,
  191.         data : '库区：原料区'
  192.     },{//绘制qrcode
  193.         lineType : 'qrcode',
  194.         x : 16 + 320 + 2 + 100,
  195.         y :  356 + 2 + 25,
  196.         level : 'L',
  197.         cellwith : 5,
  198.         rotation : 0,
  199.         data : '捆包号|钢厂资源号|母卷号|品名|牌号|规格|净重|毛重'
  200.     },{// 横线
  201.         lineType : 'bar',
  202.         x : 16 ,
  203.         y :  406,
  204.         width : 320,
  205.         height : 2
  206.     },{//绘制文本
  207.         lineType : 'text',
  208.         x : 16 + 4,
  209.         y :  406 + 2,
  210.         rotation : 0,
  211.         xscal : 1,
  212.         yscal : 2,
  213.         data : '库位：YC-02'
  214.     },{// 横线
  215.         lineType : 'bar',
  216.         x : 16 ,
  217.         y :  456,
  218.         width : 320,
  219.         height : 2
  220.     },{//绘制文本
  221.         lineType : 'text',
  222.         x : 16 + 4,
  223.         y :  456 + 2,
  224.         rotation : 0,
  225.         xscal : 1,
  226.         yscal : 2,
  227.         data : '收货单位:英大'
  228.     },{// 横线
  229.         lineType : 'bar',
  230.         x : 16 ,
  231.         y :  506,
  232.         width : 320,
  233.         height : 2
  234.     },{//绘制文本
  235.         lineType : 'text',
  236.         x : 16 + 4,
  237.         y :  506 + 2,
  238.         rotation : 0,
  239.         xscal : 1,
  240.         yscal : 2,
  241.         data : '日期:2016.06.12'
  242.     }]
  243. },function(ret, err){
  244.     alert(JSON.stringify(ret)+"   "+ JSON.stringify(err));
  245. });

可用性

Android系统

可提供的1.0.5及更高版本

connectBleByMacAddress

根据mac地址连接蓝牙设备(仅单设备时使用)

connectBleByMacAddress(callback(ret, err))

params

macAddress：

  • 类型：字符串型
  • 描述：（必填项）指定需要连接的蓝牙设备的mac地址。

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ''
  3. }

示例代码

Android系统