Flutter USB串口通信插件flutter_usb_serial的使用

Flutter USB串口通信插件flutter_usb_serial的使用

Getting Started

在Windows平台上，CH340芯片可以直接视为串口使用。在Android平台上，它被视为USB设备。

Windows平台使用的插件：serial_port_win32 Android平台使用的插件：usb_serial

dependencies:
  serial_port_win32: ^0.5.2
  usb_serial: ^0.3.0

usb_serial 包的基本方法包括：

abstract class UsbSerial {
  /// 初始化
  create();

  /// 打开串口
  Future<bool> open();

  /// 关闭串口
  Future<bool> close();

  /// 写入字节列表
  Future<void> write(Uint8List data) async {}

  /// 写入字符串
  Future<void> writeString(String data) async {}

  /// 设置读数监听
  void readByteOnListen(Function(Uint8List value) onData);

  /// 串口状态
  bool isOpen();

  /// 设置参数
  Future<void> setPortParameters() async {}

  /// 获取可用串口
  Future<List<String>> getAvailablePorts();
}

使用案例

以下是一个完整的示例代码，展示了如何在Android平台上使用 flutter_usb_serial 插件进行串口通信。

import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:typed_data';
import 'package:flutter/services.dart';
import 'package:usb_serial/usb_serial.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  UsbSerial? _usbSerial;
  String receive = '';

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 平台消息异步处理，因此我们在异步方法中初始化
  Future<void> initPlatformState() async {
    _usbSerial = UsbSerialFactory().create();
    await _usbSerial?.create();

    debugPrint('Available ports: ${await _usbSerial?.getAvailablePorts()}');

    if (_usbSerial != null) {
      await _usbSerial?.open();
      _usbSerial?.readByteOnListen((value) {
        String str = utf8.decode(value);
        print(str);
        setState(() {
          receive = str;
        });
      });

      // 写入数据
      _usbSerial?.writeString("Hello, USB Serial!");
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('USB Serial Example'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('Receive: $receive'),
            ],
          ),
        ),
      ),
    );
  }

  @override
  void dispose() {
    if (_usbSerial != null) {
      _usbSerial?.close();
    }
    super.dispose();
  }
}

Android平台权限申请

在AndroidManifest.xml文件中添加以下内容以请求USB设备权限：

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.usb_serial_example">

    <application
        ...
        <activity
            android:name=".MainActivity"
            ...>
            <intent-filter>
                <action android:name="android.intent.action.MAIN"/>
                <category android:name="android.intent.category.LAUNCHER"/>
            </intent-filter>
            <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>

创建一个名为 device_filter.xml 的文件，并将其放在 res/xml 目录下。如果目录不存在，请先创建该目录。文件内容如下：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <!-- 0x0403 / 0x6001: FTDI FT232R UART -->
    <usb-device vendor-id="1027" product-id="24577" />
    <usb-device vendor-id="6790" product-id="29987" />

    <!-- 0x0403 / 0x6015: FTDI FT231X -->
    <usb-device vendor-id="1027" product-id="24597" />

    <!-- 0x2341 / Arduino -->
    <usb-device vendor-id="9025" />

    <!-- 0x16C0 / 0x0483: Teensyduino  -->
    <usb-device vendor-id="5824" product-id="1155" />

    <!-- 0x10C4 / 0xEA60: CP210x UART Bridge -->
    <usb-device vendor-id="4292" product-id="60000" />

    <!-- 0x067B / 0x2303: Prolific PL2303 -->
    <usb-device vendor-id="1659" product-id="8963" />

    <!-- 0x1366 / 0x0105: Segger JLink -->
    <usb-device vendor-id="4966" product-id="261" />

    <!-- 0x1366 / 0x0105: CH340 JLink -->
    <usb-device vendor-id="1A86" product-id="7523" />
</resources>