Flutter USB HID设备通信插件dartusbhid的使用

Flutter USB HID设备通信插件dartusbhid的使用

简介

dartusbhid 是一个用于与人类输入设备（HID）进行通信的Dart包装库，基于libusbhid。它在自己的隔离环境中运行，并支持以下功能：

• 枚举USB HID设备（支持vendorId、productId、serialNumber、releaseNumber、manufacturerString、productString、usagePage、usage、interfaceNumber）
• 读取和写入设备报告（带或不带报告ID）

计划中的功能包括读取和写入特征报告。

安装

要安装dartusbhid插件，请在终端中执行以下命令：

flutter pub add dartusbhid

使用示例

以下是完整的示例代码，展示如何使用dartusbhid插件来枚举USB HID设备并与其通信。

import 'package:dartusbhid/enumerate.dart';
import 'dart:typed_data';

void printDeviceList() async {
  // 枚举所有设备
  // 将vendorId和productId设置为0将枚举所有设备。
  final devices = await enumerateDevices(0, 0);
  print('发现的设备数量: ${devices.length}');
  
  for (final device in devices) {
    // 打印设备信息，如产品名称、供应商等
    print(device);
  }

  if (devices.isNotEmpty) {
    // 打开第一个设备
    final openDevice = await devices[0].open();

    // 读取数据（无超时：timeout: null）
    print("等待第一个HID报告");
    final receivedData = await openDevice.readReport(null);
    print("报告ID是: ${receivedData[0]}");
    print(receivedData);

    // 发送64字节的数据到设备
    var uint8list = Uint8List.fromList(List.generate(64, (index) => 0));
    uint8list[0] = 2; // 设置报告ID
    await openDevice.writeReport(uint8list);

    // 关闭设备
    await openDevice.close();
  } else {
    print("没有找到任何设备");
  }
}

void main() {
  printDeviceList();
}

开发环境设置

如果你想尝试这个示例项目，可以按照以下步骤操作：

1. 克隆仓库：

   git clone https://github.com/TobiasJacob/dartusbhid.git
   

2. 进入示例目录并运行：

   cd dartusbhid/example
   flutter run
   

从这里开始你可以开发库。发布库时，增加版本号，调整变更日志并使用以下命令发布：

cd dartusbhid
flutter analyze
flutter pub publish

示例应用完整代码

以下是来自示例项目的完整应用代码，包含UI界面以显示设备信息和交互功能。

import 'dart:io';
import 'dart:typed_data';
import 'package:dartusbhid/usb_device.dart';
import 'package:flutter/material.dart';
import 'package:dartusbhid/enumerate.dart';

void exampleComm() async {
  final devices = await enumerateDevices(22352, 1155);
  print('发现的设备数量: ${devices.length}');
  
  for (final device in devices) {
    // 打印设备信息，如产品名称、供应商等
    print(device);
  }

  if (devices.isNotEmpty) {
    final openDevice = await devices[0].open();
    // 读取数据（无超时：timeout: null）
    print("等待第一个HID报告");
    for (var i = 0; i < 100; i++) {
      final receivedData = await openDevice.readReport(null);
      print("接收的数据");
      print(receivedData);
      print("报告ID是: ${receivedData[0]}");

      // 生成64字节的列表
      var uint8list = Uint8List.fromList(List.generate(64, (index) => 0));
      uint8list[0] = 2;
      await openDevice.writeReport(uint8list);
      final echoData = await openDevice.readReport(null);
      print("回显数据");
      print(String.fromCharCodes(echoData));
      sleep(Duration(seconds: 1));
    }
    await openDevice.close();
  }
}

void main() {
  exampleComm();
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String text = "Hello world";
  USBDeviceInfo? currentDevice;
  late Future<List<USBDeviceInfo>> devices;

  [@override](/user/override)
  void initState() {
    super.initState();
    devices = getDevices();
  }

  Future<List<USBDeviceInfo>> getDevices() async {
    var devices = await enumerateDevices(0, 0);
    return devices;
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('USB HID Report explorer'),
        ),
        body: Row(
          children: [
            Container(
              padding: const EdgeInsets.all(10),
              color: Colors.lightBlue[50],
              width: 300,
              child: FutureBuilder<List<USBDeviceInfo>>(
                future: devices,
                builder: (BuildContext context, AsyncSnapshot<List<USBDeviceInfo>> snapshot) {
                  if (snapshot.connectionState == ConnectionState.waiting) {
                    return const Center(child: Text('刷新USB设备'));
                  } else {
                    if (snapshot.hasError) {
                      return Center(child: Text('错误: ${snapshot.error}'));
                    } else {
                      return ListView.separated(
                        padding: const EdgeInsets.all(8),
                        itemCount: snapshot.data!.length,
                        itemBuilder: (BuildContext context, int index) {
                          var device = snapshot.data![index];
                          return GestureDetector(
                            child: Text('${device.productString} - ${device.manufacturerString}'),
                            onTap: () {
                              setState(() {
                                currentDevice = device;
                              });
                            },
                          );
                        },
                        separatorBuilder: (context, index) => const Divider(),
                      );
                    }
                  }
                },
              ),
            ),
            Expanded(
              child: Center(
                child: Text(currentDevice?.productString ?? '请选择一个设备'),
              ),
            )
          ],
        ),
      ),
    );
  }
}