更新记录

1.0.0(2020-12-07)

V1.0.0(2020-12-07) 初版发布


平台兼容性

Android Android CPU类型 iOS
适用版本区间:4.4 - 11.0 armeabi-v7a:未测试,arm64-v8a:未测试,x86:未测试 ×

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


因公司业务需要开发蓝牙打印机功能,首先使用的就是uniapp官方提供的API中的低功耗蓝牙相关命令,在使用中碰到无法发送大批量数据的情况,正发送就断开链接了,十分无奈,只好转而研究原生插件,刚好手上有佳博打印机安卓SDK示例工程,就基于此提炼出一个原生插件,一方面解决了我的问题,一方面也希望能解决同样碰到该问题的你。

我对接开发的蓝牙打印机牌子是QSPrinter,型号是5806,打印方式为标签打印,每台打印机需要设置黑标参数:纸张长度、最大宽度、起始位置、切纸位置等。

虽然我对接的打印机品牌和型号不一定与你的相同,但因为是基于ESC指令集,所以理论上各种品牌型号只要支持ESC指令的都应该能使用的。

有问题可联系我的微信号:rancedxk

使用说明:

注意:本插件只是提供蓝牙基本功能,以及二进制命令发送功能,并不提供命令封装,具体要根据业务怎么封装命令,请认真学习ESC命令手册,给大家造成了理解困扰,非常抱歉!

初始化

const Printer = uni.requireNativePlugin("DXK-Printer")

检测蓝牙权限

Printer.hasPermission(res=>{
    console.log("hasPermission result:" + JSON.stringify(res))
})

申请蓝牙权限

Printer.requestPermission(res=>{
    console.log("requestPermission result:" + JSON.stringify(res))
})

检测是否支持蓝牙

Printer.isSupport(res=>{
    console.log("isSupport result:" + JSON.stringify(res))
})

检测是否开启蓝牙

Printer.isOpen(res=>{
    console.log("isOpen result:" + JSON.stringify(res))
})

开启蓝牙

Printer.open(res=>{
    console.log("open result:" + JSON.stringify(res))
})

搜索蓝牙设备

Printer.startDiscovery(res=>{
    console.log("startDiscovery result:" + JSON.stringify(res))
    if(res.code==1){
        //code==1表示开始搜索设备成功
    }else if(res.code==2&&res.device.name&&res.device.address){
        //code==2表示搜索到一个设备,device即表示搜索到的设备信息
    }else if(res.code==3){
        //code==3表示结束设备搜索,系统会自动结束搜索,也可通过调用stopDiscovery方法主动结束,都会触发此处
    }
})

停止搜索蓝牙设备

Printer.stopDiscovery(res=>{
    console.log("stopDiscovery result:" + JSON.stringify(res))
})

连接设备

Printer.connectTo({
    address: '66:77:a8:98:09'
},res=>{
    console.log("connect result:" + JSON.stringify(res))
    if(res.code==-1){
        //连接失败
    }else{
        //连接成功
    }
})

向设备发送指令

注意:此处发送的命令[29,103,52]是查询打印机状态的功能,但实际并不会有任何回应,请结合自己的业务,认真学习研究ESC命令文档,不要再拿[29,103,52]测试了,也不要再拿这个问题来问我了!

Printer.send({
    data:[29,103,52]
},res=>{
    console.log("send result:" + JSON.stringify(res))
    if(res.status){
        //发送成功
    }else{
        if(res.code==1){
            //未连接打印机
        }else if(res.code==2){
            //打印命令为空
        }
    }
})

断开连接

Printer.disConnect(res=>{
    console.log("disConnect result:" + JSON.stringify(res))
    if(res.status){
        //断开连接成功
    }
})

完整示例(其中u-modal是引用自uViewUI中的组件)

<template>
    <view>
        <button type="primary" @click="hasPermission">检测蓝牙权限</button>
        <button type="primary" @click="requestPermission">申请蓝牙权限</button>
        <button type="primary" @click="isSupport">检测是否支持蓝牙</button>
        <button type="primary" @click="isOpen">检测是否开启蓝牙</button>
        <button type="primary" @click="open">开启蓝牙</button>
        <button type="primary" @click="startDiscovery">开始搜索蓝牙设备</button>
        <button type="primary" @click="stopDiscovery">停止搜索蓝牙设备</button>
        <scroll-view v-if="devices&&devices.length!=0" scroll-y="true" style="padding:10upx;">
            <view class="scroll-view-item uni-bg-red" v-for="device in devices" :key="device.address">
                <view class="uni-flex uni-row">
                    <view class="flex-item" @click="connectTo(device)">
                        <h2>{{device.name}}<span v-if="device.isPaired" style="color:green;">已配对</span></h2>{{device.address}}
                    </view>
                    <view class="flex-item" v-if="currDevice!=null&&currDevice.address==device.address">
                        <view v-if="state==1">连接中...</view>
                        <button type="primary" size="mini" @click="toEditCmd" v-if="state==2">发送数据</button>
                    </view>
                </view>
            </view>
        </scroll-view>
        <button type="primary" @click="disConnect" :disabled="state!=2">断开连接</button>

        <u-modal v-model="isEditCmd" :show-title="false" :show-cancel-button="true" confirm-text="发送" @confirm="doSendCmd">
            <view style="padding:5px;border:1px solid #eee;">
                <textarea v-model="cmd" maxlength="5000" rowspan="30" placeholder="请输入命令集,格式为十进制数字数组,如黑标参数查询命令:[29,103,52]" style="width:calc( 100% - 10px);padding:5px;"/>
            </view>
        </u-modal>
    </view>
</template>

<script>
    const Printer = uni.requireNativePlugin("DXK-Printer")
    export default {
        data() {
            return {
                devices:[],
                currDevice:null,
                state:0,
                isEditCmd:false,
                cmd:null
            }
        },
        onLoad() {
        },
        methods: {
            hasPermission(){
                console.log("hasPermission")
                Printer.hasPermission(res=>{
                    console.log("hasPermission result:" + JSON.stringify(res))
                })
            },
            requestPermission(){
                console.log("requestPermission")
                Printer.requestPermission(res=>{
                    console.log("requestPermission result:" + JSON.stringify(res))
                })
            },
            isSupport(){
                console.log("isSupport")
                Printer.isSupport(res=>{
                    console.log("isSupport result:" + JSON.stringify(res))
                })
            },
            isOpen(){
                console.log("isOpen")
                Printer.isOpen(res=>{
                    console.log("isOpen result:" + JSON.stringify(res))
                })
            },
            open(){
                console.log("open")
                Printer.open(res=>{
                    console.log("open result:" + JSON.stringify(res))
                })
            },
            startDiscovery(){
                console.log("startDiscovery")
                Printer.startDiscovery(res=>{
                    console.log("startDiscovery result:" + JSON.stringify(res))
                    if(res.code==1){
                        this.devices = []
                    }else if(res.code==2&&res.device.name&&res.device.address){
                        if(this.devices.findIndex(device=>device.address==res.device.address)<0){
                            this.devices.push(res.device)
                        }
                    }else if(res.code==3){
                        console.log("endDiscovery")
                    }
                })
            },
            stopDiscovery(){
                Printer.stopDiscovery(res=>{
                    console.log("stopDiscovery result:" + JSON.stringify(res))
                })
            },
            connectTo(device){
                this.currDevice = device
                this.state = 1
                console.log("connect to:" + JSON.stringify(device))
                Printer.connectTo({
                    address: device.address
                },res=>{
                    console.log("connect result:" + JSON.stringify(res))
                    if(res.code==-1){
                        this.currDevice = null
                        this.state = 0
                    }else{
                        this.state = 2
                    }
                })
            },
            toEditCmd(){
                //打开命令编辑弹窗
                this.cmd = null
                this.isEditCmd = true
            },
            doSendCmd(){
                console.log(this.cmd)
                let data = JSON.parse(this.cmd)
                console.log("send to:" + JSON.stringify(this.currDevice) + ",data:" + JSON.stringify(data))
                Printer.send({
                    data
                },res=>{
                    console.log("send result:" + JSON.stringify(res))
                    if(!res.status){
                        if(res.code==1){
                            uni.showToast("未连接打印机")
                        }else if(res.code==2){
                            uni.showToast("打印命令为空")
                        }
                    }
                    this.isEditCmd = false
                })
            },
            disConnect(){
                console.log("disConnect")
                Printer.disConnect(res=>{
                    console.log("disConnect result:" + JSON.stringify(res))
                    if(res.status){
                        this.state = 0
                    }
                })
            }
        }
    }
</script>

<style>
    .content {
        display: flex;
        flex-direction: column;
        align-items: center;
        justify-content: center;
    }

    .logo {
        height: 200rpx;
        width: 200rpx;
        margin-top: 200rpx;
        margin-left: auto;
        margin-right: auto;
        margin-bottom: 50rpx;
    }

    .text-area {
        display: flex;
        justify-content: center;
    }

    .title {
        font-size: 36rpx;
        color: #8f8f94;
    }
</style>

隐私、权限声明

1. 本插件需要申请的系统权限列表:

<uses-permission android:name="android.permission.BLUETOOTH" /> <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

作者未提供license.md

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问