更新记录

1.0.4（2024-04-18）

• 修复产品名称 productName为空时无法打开设备的问题
• 增加持续授权示例，USB设备重新插拔无需再次授权（系统重启后需要重新授权），详细操作请看操作说明持续授权部分

1.0.3（2024-03-26）

• 添加数据发送 api sendBytes、sendHex
• 添加设备订阅 api registerUsbAttach，实现设备插拔提示
• 添加消息订阅 api subscribe，实现数据监听
• read 增加format参数，控制返回的数据格式：16进制字符串或者ASCII字符串

1.0.2（2024-03-26）

• 添加armeabi-v7a 、arm64-v8a、 x86系统支持
• 添加USB权限判断
• 修改 getDeviceList 为同步方法
• 替换forEach、流式api等在安卓6低版本系统不支持的函数，目前插件支持Android 5到Android 13
• 优化数据读取、设备打开和关闭，弃用ExecutorService
• 感谢814***@qq.com测试发现的问题

平台兼容性

usb-serial

UTS开发文档

UTS 语法 UTS API插件 UTS 组件插件 Hello UTS

插件说明

本插件参考于usb-serial-for-android项目

usb转串口支持如下USB转串口转换芯片：

• FTDI FT232R, FT232H, FT2232H, FT4232H, FT230X, FT231X, FT234XD
• Prolific PL2303
• Silabs CP2102, CP210*
• Qinheng CH340, CH341A, CH9102

更多信息参考usb-serial-for-android

已实现功能

• [x] 获取设备列表
• [x] 打开指定设备
• [x] 设置参数
• [x] 读取数据
• [x] 监听数据
• [x] 写入数据
• [x] 插入设备提示
• [ ] 流控
• [ ] ...

使用方法

1、导入插件，打包自定义基座

2、引入插件 —— UsbSerial类

import { UsbSerial } from '@/uni_modules/shmily-usb-serial';

3、初始化实例

const usbSerial = new UsbSerial();

4、查询设备

const list = usbSerial.getDeviceList();

示例如下：

[
    {
        "productName": "USB Serial",
        "deviceId": 1008,
        "deviceName": "/dev/bus/usb/001/008",
        "productId": 29987,
        "protocol": 0
    },
    {
        "productName": "ILITEK-TP",
        "deviceId": 2005,
        "deviceName": "/dev/bus/usb/002/005",
        "productId": 1,
        "protocol": 0
    },
    {
        "productName": "802.11ac NIC",
        "deviceId": 2004,
        "deviceName": "/dev/bus/usb/002/004",
        "productId": 51217,
        "protocol": 0
    }
]

5、打开设备并设置参数

// 外层别忘了加async，或者使用.then
const success = await usbSerial.connect({
    productName: 'USB Serial', // 产品名称，请填写实际值
    productId: 29987, // 产品id，请填写实际值
    baudRate: 115200, // 波特率，请填写实际值
    dataBits: 8, // 数据位，请填写实际值
    stopBits: 1, // 停止位，请填写实际值
    parity: 0,   // 校验位，请填写实际值
});
//  根据success判断是否打开成功，失败的情况有可能设备不存在或者出错了

6、读取数据（两种格式）

// HEX 或者 STRING 是固定写法，不要改成具体值
const { content, success } = usbSerial.read('HEX');
// content: 32 2E 33 39 0D 0A 

or

const { content, success } = usbSerial.read('STRING');
// content: 2.38\r\n

// 根据success判断是否读取成功，content是读取到的数据
// 如果读取失败，content返回的是原因，比如：Serial port is not connected

7、发送数据（两种格式）

// 字节数组格式
usbSerial.sendBytes('hello world');
// 16进制格式
usbSerial.sendHex('5A 04 01 5F');

8、订阅、取消订阅消息（回调建议使用节流函数包装下）

// 订阅
usbSerial.subscribe('HEX', (data) => {});

or

usbSerial.subscribe('STRING', (data) => {});
// data是监听到的数据，格式同read

// 取消订阅
usbSerial.unsubscribe();

9、订阅、取消订阅设备

// 订阅
usbSerial.registerUsbAttach((action) => {
// action: true表示设备插入   false表示设备移除
});
// 取消订阅
usbSerial.unregisterUsbAttach();

10、关闭连接

// 外层别忘了加async，或者使用.then
const success = await usbSerial.disconnect();
// 根据success判断是否关闭成功

11、持续授权（如果没有这样的需求，不要设置）

第一步：项目根目录下创建AndroidManifest.xml文件，写入以下内容：

  <?xml version="1.0" encoding="utf-8"?>
  <manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools"
    package="app包名">
    <application>
      <activity android:name="io.dcloud.PandoraEntry">
        <intent-filter>
          <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
        </intent-filter>
        <meta-data android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" android:resource="@xml/device_filter" />
      </activity>
    </application>
  </manifest>

将 app包名替换成你app实际的Android包名， 包名可以在打包页面查看。

第二步：将示例工程根目录下面的nativeResources目录复制到你的项目根目录下，确保 nativeResources/res/xml/device_filter.xml 存在，至此配置完成，重新打包自定义基座后生效。

在第一次打开设备授权时勾选 "[√]连接xxx后一律打开xxx" 即可实现持续授权，app重启或者USB设备重新插拔也不需要申请权限。但是如果系统重启了，需要重新授权！！！

注意：配置持续授权后，设备插入时会自动唤起app，如果app处于后台，会自动切换到前台。如果app未启动，会自动打开app。

提供的其他方法

// 设备是否已打开
const isConnect = usbSerial.isConnect();
// true or false

类型参考

// 设备实例
type DeviceItem = {
  deviceName : string,
  deviceId : number,
  protocol : number,
  productId : number,
  productName ?: string
}

// 连接设备参数
type ConnectOptions = {
  productName : string, // 产品名称（一般是固定的）
  productId : number, // 产品id（一般是固定的）
  baudRate : number, // 波特率
  dataBits : number, // 数据位 5数据位：5 6数据位：6 7数据位：7 8数据位：8
  stopBits : number, // 停止位 1停止位：1 1.5停止位：3 2停止位：2
  parity : number,   // 校验位 无校验：0 奇校验：1 偶校验：2  标志奇偶校验：3 空间奇偶校验：4
}

// 设备数据返回
type UsbData = {
  content : string | null,
  success : boolean
}

// 数据返回格式
type ReturnFormat = 'HEX' | 'STRING'