本仓库于 2024-08-01 起不再维护测试用例，只维护 Library 的功能
查阅或使用演示App：UniversalPrinter2024-10-22：国内大多数情况下使用佳博的SDK就可以满足需求，所以从 1.3.0 起对本库进行了组件化拆包，使用其它品牌的 SDK 也是按需添加依赖即可
| 包名 | 描述 | 依赖方式 |
|---|---|---|
| GPrinter | 佳博 | com.github.Yiwei099.PrintSupport:GPrinter:$releaseVersion |
| Epson | 爱普森 | com.github.Yiwei099.PrintSupport:Epson:$releaseVersion |
| Bixolon | 必胜龙 | com.github.Yiwei099.PrintSupport:Bixolon:$releaseVersion |
| PrintSupport | 总包(佳博，爱普森，必胜龙) | com.github.Yiwei099.PrintSupport:$releaseVersion |
| libcommon | 基础包(必须) | com.github.Yiwei099.PrintSupport:libcommon:$releaseVersion |
① 集成多个品牌打印机的SDK：GPrinter(佳博)，Epson(爱普森)，Bixolon(必胜龙)，StarX(待接入)
② 已调试支持的打印机品牌：GPrinter(佳博)，Epson(爱普森)，Bixolon(必胜龙)，XPrinter(芯烨)，Element(元素)
③ 支持局域网，USB，蓝牙通讯(具体情况取决于打印机以及使用的SDK策略)
④ 开发者只需要关心打印的数据，无需关心打印的过程，减轻各SDK的对接成本
⑤ 需要打印时自动建立连接，外打印完成自动销毁链接，减少通道占用率，稳定可靠
⑥ 内置任务定时器，定时轮询任务队列，保证每个任务都被执行，防止任务丢失
⑥ 只支持Esc(收据)，Tsc(标签) 两种指令；其他如针式，A4打印不在对接范围内所以不考虑对接
⑦ (New)佳博SDK支持自动校验打印机指令 ⑧ 由于打印机有限，需要使用的朋友可以直接拉取源码进行调试
⑨ SDK选择优先级建议：GPrinter > Epson > Bixolon > StarX
⑩ 使用 图像 打印时效果更佳：DrawingSupport
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
}
implementation 'com.github.Yiwei099:PrintSupport:$releaseVersion'
由于本库设置的版本要求为：
compileSdkVersion = 33
targetSdkVersion = 33
minSdkVersion = 24
可能会有很多项目没适配，可以把 module 下载下去修改版本进行依赖
指路：佳博打印机官网
详细测试用例请看 GPrinterActivity.kt
调试状态：Esc✅，Tsc✅，局域网✅，USB✅，蓝牙✅，Esc图像✅，Esc指令✅，Tsc图像✅，Tsc指令✖️
实测此SDK可通讯大多数品牌的打印机；如：GPrinter(佳博)，XPrinter(芯烨)，Epson(爱普森)，Bixolon(必胜龙)，Element(元素)
//局域网通讯
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
//未明确指令类型
//自己打印机校验指令的指令
val command :ByteArray = ByteArray()
val unknowBtPrinter = UnKnowBtGPrinter(context,address,command){
//...解析打印机返回数据，获取指令类型，并返回指令类型告知打印机
return when(data){
...-> Command.Esc
...-> Command.Tsc
else-> null
}
}
//以图片的形式打印
//从 1.2.0 或1.2.0-Alpha版本开始，如果您的标签内容高度非自适应则需要指定标签高度
val mission = GraphicMission(
bitmapArray,
bitmapHeight:Int = 30,//标签高度
bitmapWidth:Int = 40,//标签宽度
selfAdaptionHeight:Boolean = false,//固定高度
)
//以SDK指令形式打印
val mission = CommandMission(escCommand)
//调用addMission即可
printer.addMission(mission)
printer.onDestroy()
指路：Epson 打印机官网
详细测试用例请看 EpsonPrinterActivity.kt
调试状态：Esc✅，Tsc✖️，局域网✅，USB✅，蓝牙✖️，Esc图像✅，Esc指令✅(部分)，Tsc图像✅，Tsc指令✖️
实测只能与自己品牌的打印机通讯
//通讯方式：局域网/USB/蓝牙
val interface = Net/Usb/BlueTooth
//通讯地址：局域网IP/USB地址/蓝牙地址
val target = "192.168.0.1"
//创建打印机，必要时可指定Epson打印机的型号
val printer = EpsonPrinter(context,interface,target)
//以图片的形式打印
//从 1.2.0 或1.2.0-Alpha版本开始，如果您的标签内容高度非自适应则需要指定标签高度
val mission = GraphicMission(
bitmapArray,
bitmapHeight:Int = 30,//标签高度
bitmapWidth:Int = 40,//标签宽度
selfAdaptionHeight:Boolean = false,//固定高度
)
//以SDK指令形式打印
val mission = EpsonMission(
mutableListOf<BaseEpsonMissionParam>().apply {
add(CommandMissionParam(getOpenBoxCommandByByteArray()))
}
)
//调用addMission即可
printer.addMission(mission)
printer.onDestroy()
//检索参数(局域网/蓝牙/USB)，(打印机/扫码枪/输入设备)
val option = FilterOption()
//监听结果(返回单个设备)
val listener = DiscoveryListener()
//开始检索
Discovery.start(mContext,option,listener)
//结束检索
Discovery.stop()
指路：Bixolon 打印机官网
详细测试用例请看 BixolonPrinterActivity.kt
调试状态：Tsc✅，Esc✖️，局域网✅，USB✖️，蓝牙✖️，Esc图像✖️，Esc指令✖️，Tsc图像✅，Tsc指令✖️
//建议在 Application 初始化时调用
BixolonUtils.getInstance().initLibrary()
//局域网通讯
val key = "192.168.100.155"
val printer = BixolonNetLabelPrinter(mContext)
//以图片的形式打印
//从 1.2.0 或1.2.0-Alpha版本开始，如果您的标签内容高度非自适应则需要指定标签高度
val mission = GraphicMission(
bitmapArray,
bitmapHeight:Int = 30,//标签高度
bitmapWidth:Int = 40,//标签宽度
selfAdaptionHeight:Boolean = false,//固定高度
)
printer.addMission(mission)
printer.onDestroy()
//任意存在或不存在的IP地址
val ip = "192.168.3.12"
//创建任意必胜龙打印机
val printer = BixolonNetLabelPrinter(mContext,ip).apply{
setOnFindPrinterCallBack {
it.forEach {content->
//返回的结果，结构为：macAddress + address + port
}
}
}
//开始检索
printer.startFindPrinter()
详细测试用例请看 NativeUsbActivity.kt 此方式对比 GPrinter(佳博SDK) 的 USB打印只是连接与发送过程的差异；有的设备USB通讯异常，所以开发出了 NativeUsb，它的连接和发送不依赖任何SDK，但是指令还是使用佳博的指令
//实例化打印机
val printer = NativeUsbPrinter(
mContext: Context, //上下文对象
usbDevice: UsbDevice, //USB设备实例
commandType:Command, //指令类型：ESC/TSC
bufferSize: Int = 16384, //缓冲区大小
timeOut: Int = 3000, //超时时间
density: DENSITY = LabelCommand.DENSITY.DNESITY1, //打印浓度
adjustX: Int = 0, //左侧偏移
adjustY: Int = 0, //顶部偏移
)
//以图片的形式打印
//从 1.2.0 或1.2.0-Alpha版本开始，如果您的标签内容高度非自适应则需要指定标签高度
val mission = GraphicMission(
bitmapArray,
bitmapHeight:Int = 30,//标签高度
bitmapWidth:Int = 40,//标签宽度
selfAdaptionHeight:Boolean = false,//固定高度
)
//以SDK指令形式打印
val mission = CommandMission(escCommand)
//调用addMission即可
printer.addMission(mission)
printer.onDestroy()
开钱箱的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())
}
① 调整生成图片时的宽度，控制调试在标签打印机的有效打印范围 ② 指路生成图片工具：DrawingSupport
③ 市场常见小票纸尺寸为58和80，所以使用 DrawingSupport 生成图片的最大宽度为 48 * 8 = 384 和 72 * 8 = 576
④ 市场常见的标签纸尺寸为 40 * 30，40 * 60，40 * 80；以 40 * 60 的尺寸为例，宽 = 40 * 8 = 320，高 = 60 * 8 = 480；所以使用 DrawingSupport 生成图片的尺寸为 320 * 480
检查是否已经初始化该 SDK 的 JNI
//建议在 Application 初始化时调用
BixolonUtils.getInstance().initLibrary()
① 检查是否已经对当前 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)
//授权后无需再进行任何操作，打印机内部会定时轮询自动执行打印
}
}
| 错误码 | 解释 |
|---|---|
| 0 | 通用成功 |
| -1 | 通用异常(未知原因) |
| -2 | 连接失败 |
| -3 | 连接异常 |
| -4 | 打印失败 |
| -5 | 打印异常 |
| -6 | 断开连接异常 |
| -7 | Automatic recovery error occurred |
| -8 | Cover open error occurred(盖子未关闭) |
| -9 | Auto cutter error occurred(切纸异常) |
| -10 | Mechanical error occurred(打印机机械错误) |
| -11 | No paper is left in the roll paper end detector(未检测到打印纸) |
| -12 | Unrecoverable error occurred |
| -13 | Error exists in the requested document syntax |
| -14 | Printer specified by the device ID does not exist.(找不到打印机) |
| -15 | Error occurred with the printing system |
| -16 | Error was detected with the communication port |
| -17 | Print timeout occurred.(超时) |
| -18 | Specified print job ID does not exist |
| -19 | Print queue is full |
| -20 | Battery has run out.(电量低) |
| -21 | The number of print jobs sent to the printer has exceeded the allowable limit |
| -22 | The size of the print job data exceeds the capacity of the printer |
| -23 | rint command sent while waiting for paper removal |
| -24 | 图像任务尺寸异常 |
| -25 | 没有权限 |
| -26 | 指令异常 |
