更新记录

1.0.0（2025-03-14）

该模块提供了USB设备通信的基础功能，包括： 电池电量获取 通用串口通信 预留称重功能接口 预留参数灯功能接口

平台兼容性

USB驱动模块说明文档

功能概述

该模块提供了USB设备通信的基础功能，包括：

• 电池电量获取
• 通用串口通信
• 预留称重功能接口
• 预留参数灯功能接口

主要类和方法

1. 电池相关

getBatteryCapacity(): string

获取当前设备电池电量百分比，返回格式如"85%"。

2. CommonPortHelper 通用串口通信类

主要用于处理通用串口通信功能。

构造函数

constructor(baudRate: Int, pid: Int, vid: Int)

参数说明：

• baudRate: 波特率
• pid: USB设备的产品ID
• vid: USB设备的厂商ID

主要方法

1. open()

   • 功能：打开串口连接
   • 返回：boolean，表示是否成功打开

2. writeHex(data: string)

   • 功能：写入16进制数据
   • 参数：data - 16进制字符串
   • 返回：boolean，表示是否写入成功

3. read(callback, errorCallback)

   • 功能：读取串口数据
   • 参数：
     • callback: (deviceName: string, data: ByteArray) => Any
     • errorCallback: (error: Exception) => Any
   • 使用示例：

     portHelper.read(
     (device, data) => {
     console.log('收到数据:', device, data);
     },
     (error) => {
     console.error('错误:', error);
     }
     );

4. close()

   • 功能：关闭串口连接
   • 返回：boolean，表示是否成功关闭

5. isConnected(onDisconnect, onConnect)

   • 功能：监听连接状态
   • 参数：
     • onDisconnect: (is: boolean) => void
     • onConnect: () => void

3. 预留接口

模块中预留了以下两个类的实现：

• SteelyardSerialPortHelper: 用于称重相关功能
• ParamsLightPortHelper: 用于参数灯相关功能

使用示例

// 创建串口通信实例
const portHelper = new CommonPortHelper(9600, 0x1234, 0x5678);

// 打开连接
if (portHelper.open()) {
  // 监听连接状态
  portHelper.isConnected(
    (isDisconnected) => {
      console.log('设备断开连接:', isDisconnected);
    },
    () => {
      console.log('设备已连接');
    }
  );

  // 发送数据
  portHelper.writeHex("FF00FF");

  // 读取数据
  portHelper.read(
    (device, data) => {
      console.log('收到数据:', device, data);
    },
    (error) => {
      console.error('错误:', error);
    }
  );
}

// 获取电池电量
const batteryLevel = getBatteryCapacity();
console.log('当前电量:', batteryLevel);

注意事项

1. 使用前确保正确配置PID和VID
2. 建议在不使用时调用close()方法关闭连接
3. 读取操作建议在连接成功后进行
4. 所有回调函数都应妥善处理异常情况