Android Pos 打印机支持库(适合市场常见打印机使用)

PrintSupport(专注于 收据 与 标签 的打印工具)

概述

① 集成多个品牌打印机的SDK：GPrinter(佳博)，Epson(爱普森)，Bixolon(必胜龙)，
② 已调试支持的打印机品牌：GPrinter(佳博)，Epson(爱普森)，Bixolon(必胜龙)，XPrinter(芯烨)，Element(元素)
③ 支持局域网，USB，蓝牙通讯(具体情况取决于打印机以及使用的SDK策略)
④ 开发者只需要关心打印的数据，无需关心打印的过程，减轻各SDK的对接成本
⑤ 需要打印时自动建立连接，外打印完成自动销毁链接，减少通道占用率，稳定可靠
⑥ 内置任务定时器，定时轮询任务队列，保证每个任务都被执行，防止任务丢失
⑥ 只支持Esc(收据)，Tsc(标签) 两种指令；其他如针式，A4打印不在对接范围内所以不考虑对接
⑦ 由于打印机有限，需要使用的朋友可以直接拉取源码进行调试
⑧ SDK选择优先级建议：GPrinter > Epson > Bixolon > StarX
⑨ 使用 图像 打印时效果更佳：DrawingSupport

获取使用

1. Add it in your root build.gradle at the end of repositories:

dependencyResolutionManagement {
  repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
  repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
  }
}

2. Add the dependency:

implementation 'com.github.Yiwei099:PrintSupport:$releaseVersion'

详情

1. GPrinter SDK(佳博)

指路：佳博打印机官网
详细测试用例请看 GPrinterActivity.kt
调试状态：Esc✅，Tsc✅，局域网✅，USB✅，蓝牙✅，Esc图像✅，Esc指令✅，Tsc图像✅，Tsc指令✖️
实测此SDK可通讯大多数品牌的打印机；如：GPrinter(佳博)，XPrinter(芯烨)，Epson(爱普森)，Bixolon(必胜龙)，Element(元素)

a. 创建

//局域网通讯
val key = "192.168.100.150"
val printer = EscNetGPrinter(context, netKey) //打印Esc
val printer = TscNetGPrinter(context,netKey) //打印Tsc

//USB通讯(SerialNumber为可选)
val usbKey = "vendorId+productId+SerialNumber"
val printer = EscUsbGPrinter(context,vendorId,productId,serialNumber) //打印Esc
val printer = TscUsbGPrinter(context,vendorId,productId,serialNumber) //打印Tsc

//蓝牙通讯
val macAddress = "66:22:E2:4C:CB:DD"
val printer = EscBtGPrinter(context,macAddress) //打印Esc
val printer = TscBtGPrinter(context,macAddress) //打印Tsc

b. 打印

//以图片的形式打印
val mission = GraphicMission(bitmapArray)

//以SDK指令形式打印
val mission = CommandMission(escCommand)

//调用addMission即可
printer.addMission(mission)

c. 销毁(必要时)

printer.onDestroy()

2. Epson SDK(爱普森)

指路：Epson 打印机官网
详细测试用例请看 EpsonPrinterActivity.kt
调试状态：Esc✅，Tsc✖️，局域网✅，USB✅，蓝牙✖️，Esc图像✅，Esc指令✅(部分)，Tsc图像✅，Tsc指令✖️
实测只能与自己品牌的打印机通讯

a. 创建

//通讯方式：局域网/USB/蓝牙
val interface = Net/Usb/BlueTooth

//通讯地址：局域网IP/USB地址/蓝牙地址
val target = "192.168.0.1"

//创建打印机，必要时可指定Epson打印机的型号
val printer = EpsonPrinter(context,interface,target)

b. 打印

//以图片的形式打印
val mission = GraphicMission(bitmapArray)

//以SDK指令形式打印
val mission = EpsonMission(
                mutableListOf<BaseEpsonMissionParam>().apply {
                    add(CommandMissionParam(getOpenBoxCommandByByteArray()))
                }
              )

//调用addMission即可
printer.addMission(mission)

c. 销毁(必要时)

printer.onDestroy()

d. 检索打印机

//检索参数(局域网/蓝牙/USB)，(打印机/扫码枪/输入设备)
val option = FilterOption()
//监听结果(返回单个设备)
val listener = DiscoveryListener()

//开始检索
Discovery.start(mContext,option,listener)

//结束检索
Discovery.stop()

3.Bixolon(必胜龙标签)

指路：Bixolon 打印机官网
详细测试用例请看 BixolonPrinterActivity.kt
调试状态：Tsc✅，Esc✖️，局域网✅，USB✖️，蓝牙✖️，Esc图像✖️，Esc指令✖️，Tsc图像✅，Tsc指令✖️

a. 初始化JNI

//建议在 Application 初始化时调用
BixolonUtils.getInstance().initLibrary()

b. 创建

//局域网通讯
val key = "192.168.100.155"
val printer = BixolonNetLabelPrinter(mContext)

c. 打印

//以图片的形式打印
val mission = GraphicMission(bitmapArray)
printer.addMission(mission)

d. 销毁(必要时)

printer.onDestroy()

e. 检索 Net 打印机

//任意存在或不存在的IP地址
val ip = "192.168.3.12"

//创建任意必胜龙打印机
val printer = BixolonNetLabelPrinter(mContext,ip).apply{
    setOnFindPrinterCallBack {
        it.forEach {content->
            //返回的结果，结构为：macAddress + address + port
        }
    }
}

//开始检索
printer.startFindPrinter()

4.打开钱箱

开钱箱的Byte指令从佳博SDK中获得，不一定适用所有打印机，若该指令无效请使用自己已测试通过的指令数组再使用本库发送

//佳博打印机开钱箱
printer.addMission(GPrinterMission(GPrinterMission.getOpenBoxCommand()))

//其它打印机开钱箱：如 Epson
printer.addMission(
    EpsonMission(
        mutableListOf<BaseEpsonMissionParam>().apply {
            add(CommandMissionParam(getOpenBoxCommandByByteArray()))
        }
    )
)

//佳博SDK开钱箱Byte指令
private fun getOpenBoxCommandByByteArray(): ByteArray {
    return SDKUtils.convertVectorByteToBytes(GPrinterMission.getOpenBoxCommand())
}
                

常见问题

1. 使用 Bixolon(必胜龙)标签打印机SDK 时崩溃

检查是否已经初始化该 SDK 的 JNI

//建议在 Application 初始化时调用
BixolonUtils.getInstance().initLibrary()

2. 高版本 Android 系统中使用 USB 通讯模式发起打印时打印机没有反馈

① 检查是否已经对当前 USB 设备授权；若没有授权，建议在 Activity 中的生命周期中使用广播接收器，在 USB 设备接入时发起权限申请(即使是 USB 接触不良，自动断开/接入 也能自动发起)
② 佳博SDK内也会自动帮我们申请，但只有在发起连接时才会，不发起打印就不会发起连接，也就无法申请权限，可能会造成漏打
③ 有的设备系统可以设置 USB 白名单，无需授权即可访问 USB 设备

override fun onUsbAttached(intent: Intent) {
    intent.getParcelableExtra<UsbDevice>(UsbManager.EXTRA_DEVICE)?.let {usbDevice->
        val b = usbManager.hasPermission(usbDevice)
        val usbKey = "${usbDevice.vendorId}-${usbDevice.productId}"
        if (!b){
            val mPermissionIntent = PendingIntent.getBroadcast(this,0,Intent(UsbBroadcastReceiver.ACTION_USB_PERMISSION),0)
            usbManager.requestPermission(it, mPermissionIntent)
            //授权后无需再进行任何操作，打印机内部会定时轮询自动执行打印
        }
}

Print support by android(不定期更新)