更新记录

1.0.15(2020-12-14)

添加串口监听器

1.0.14(2020-12-10)

添加readMaxBufferSize方法

查看更多

平台兼容性

Android iOS
适用版本区间:4.4 - 11.0 ×

原生插件通用使用流程:

  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原生插件配置”->”云端插件“列表中删除该插件重新选择


说明

  • 此插件使用rxjava、usb-serial-for-android框架实现
  • 本插件支持DLT645规约,其他规约请联系本人进行扩展
  • 如果不是DLT645规约sendAndRead失效,可以使用send、read方法代替
  • 请认真阅读API

使用方法

const serialPort = uni.requireNativePlugin("ttarigo-serial")

usbSerial.registerUsb(true, params=>{
    if(params.status && params.devices.length > 0) {
         usbSerial.open(params.devices[0], open=>{
            usbSerial.setParams({baudRate: 38400}, setParams=>{
                uni.showToast({
                    title: '已连接到设备' + JSON.stringify(setParams),
                    icon: 'none'
                })

            })
         })
    }
})

API

  • 所有方法回调参数格式
    {
    msg: '状态描述',
    status: true, // 可以是bool,也可以是int
    // 回调数据见各个接口
    }
  • 方法

    
    // 注册USB插拔动作监听
    registerUsb(params=>{
            /*  params: {
                msg: '',
                status: true/false,
                deivces: [] //设备名称数组,想连接那个设备就用那个名字,以下调用open方法
        */
    })
    
    // 注销usb监听,与registerUsb必须成对出现
    unRegisterUsb(params=>{ 
        /*
        params: {
            status: true/false,
            msg: ''
        }
        */
    })
    
    // 根据device的名称连接设备
    serialPort.open(params.devices[0], openParams=>{
        /*
            openParams: {
                status: true/false, // 连接是否成功,
                msg: ''// 连接描述
            }
        */
    }); 
    
    // 获取连接状态
    serialPort.getConnectStatus(params=>{
        /*
        params: {
            status: true/false, // 是否连接,
            msg: ''// 连接描述
        }
        */
    }) 
    // 直接获取连接状态
    let status = demo.getConnectStatus()
    
    // 这里的bytes就是从串口读取的数据,如果有数据就这个调用这个回调函数
    // android原生开启一个无限循环一直读取串口数据,如果此次没有读到数据延迟10纳秒再继续读取
    // android原生在没有监听器的时候不会开启无限循环
    // 因为原生用map存储监听器,所以多个addListener调用顺序随机
    serialPort.addListener("listener1", bytes=>{
    
    })
    
    // 移除名为listener1的监听器
    serialPort.removeListener("listener1", params=>{
    
    })
    
    // 发送并接收
    // 暂时只能发送字节数组,接收字节数组,第二个布尔参数为是否需要响应(发送的这个帧是否需要响应,如false则不会回调)
    // 此方法只支持DLT645规约,其他规约请联系我
    serialPort.sendAndRead([0x68, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x68, 0x13, 0x00, 0xDF, 0x16], true, params=>{
    /*
        params: {
        msg: '', // 描述,
            status: '',// 是否发送成功,
            data: [] // 响应数据(符合DLT645规约的帧)
        }
    */
    })
    
    // 设置参数 / params: baudRate比特率,dataBits数据位,stopBits停止位,parity校验位(0:none, 1: odd, 2:even) 
    serialPort.setParams(params, p=>{ 
        /*
         p: { msg: '', status: true/false // 是否成功 } 
         */
    })

// 添加主动上报监听(本人设备没有主动上报功能,请使用人自行测试,有问题联系我) // 本方法只针对DLT645 // 第一个参数为主动上报数据标识,4个长度的字节数组 // 监听多个主动上报就多调用几次,传入不同的数据标识即可 serialPort.addReport([0x01,0x02,0x03,0x04], params=>{ / params: { msg: '', // 描述, status: '',// 是否发送成功, data: [] // 响应数据(符合DLT645规约的帧) } / })

// 发送帧
// 注意:这里的回调参数只有发送成功或失败不会读取串口返回数据,send与read配合使用
serialPort.send([0x68, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x68, 0x13, 0x00, 0xDF, 0x16], param=>{
    /*
        param: {
            status: true/false, // 是否成功
            msg: ''
        }
    */
})
// 发送ascii字符串,同send用法
serialPort.sendAscii(asciiStr, params=>{

})
// 读取串口数据
// size:int类型,缓冲区大小
serialPort.readMaxBufferSize(size, params=>{
/*
    params: {
        msg: '', // 描述,
        status: '',// 是否发送成功,
        data: [] // 串口数据
    }
*/
})
// 读取串口数据
// 此方法读取串口数据后会将当前串口数据删除
serialPort.read(param=>{
/*
    params: {
        msg: '', // 描述,
        status: '',// 是否发送成功,
        data: [] // 串口数据
    }
*/
})
// 读取串口数据并以ascii字符串形式返回, 同read方法
serialPort.readAscii(param=>{

}) // 取消当前发送任务 serialPort.cancelCurrentTask(params=>{ / params: { msg: '', // 描述, status: true } / }) // 设置超时时间 // 时间单位为毫秒 demo.setTimeout(1000, params=>{ })

// 设置DTR 

// true 打开DTR, false 关闭 demo.setDTR(true, params=>{ })

// 设置RTS 
// true 打开RTS, false 关闭
demo.setRTS(true, params=>{ })
// 重试次数
demo.setRetry(3, params=>{

})
// 关闭串口 
demo.close()
```

隐私、权限声明

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

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

插件不采集任何数据

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

许可协议

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

  1. Definitions.

    "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

    "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

    "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

    "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

    "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

    "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

    "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

    "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

    "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

    "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

  3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

  4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

    (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and

    (b) You must cause any modified files to carry prominent notices stating that You changed the files; and

    (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

    (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

    You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

  5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

  6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

  7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

  8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

  9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

    END OF TERMS AND CONDITIONS

    APPENDIX: How to apply the Apache License to your work.

    To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

    Copyright [yyyy] [name of copyright owner]

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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