Flutter串口通信插件embedded_serialport的使用

embedded_serialport简介

embedded_serialport 是一个用于串口通信的Flutter包，它使用Dart FFI（Foreign Function Interface）与Rust和C共享库进行交互。这个包提供了简单的API来列出可用的串口，并执行读写操作。你可以参考这篇文章 Building a Flutter application for serial port communication with embedded system 和 示例演示视频 Demo Video 来了解更多。

平台支持

• Linux

功能特性

• 列出可用的串口
• 打开并配置串口
• 从串口读取数据和向串口写入数据
• 设置串口通信超时时间

安装

要安装 embedded_serialport，可以使用以下命令：

flutter pub add embedded_serialport

依赖项

对于GNU/Linux系统，需要安装 pkg-config 和 libudev 头文件：

安装 pkg-config

• Ubuntu: sudo apt install pkg-config
• Fedora: sudo dnf install pkgconf-pkg-config

安装 libudev (除非禁用默认的 libudev 特性)

• Ubuntu: sudo apt install libudev-dev
• Fedora: sudo dnf install systemd-devel

检查权限

确保你的用户属于 dialout 组或等效组：

sudo usermod -aG dialout $USER

然后注销并重新登录。否则，你会收到 SerialErrorCode.serialErrorOpen 错误。

准备Linux应用程序以供分发

要构建Flutter应用程序作为发布版本，请运行以下命令：

flutter build linux --release

之后，进入 build/linux/release/bundle/ 目录并使用以下命令运行应用程序：

./projectname

这将自动复制一个名为 librust_serialport.so 的文件到 lib 文件夹中，该文件负责库在应用程序中的工作。

使用方法

在Dart代码中导入该包：

import 'package:embedded_serialport/embedded_serialport.dart';

示例1：列出所有可用的串口

import 'package:embedded_serialport/embedded_serialport.dart';

void main() {
  List<String> ports = Serial.getPorts();
  print(ports);
  for (int i = 0; i < ports.length; i++) {
    print(ports[i]);
  }
}

示例2：与串行设备通信

import 'package:embedded_serialport/embedded_serialport.dart';

void main() {
  List<String> ports = Serial.getPorts();

  var s = Serial(ports.first, Baudrate.b115200);
  s.timeout(2);

  try {
    s.writeString('led,0');
    var event = s.read(20);
    print(event.toString());
    s.writeString('led');
    var eventt = s.read(20);
    print(eventt.toString());
  } finally {
    s.dispose();
  }
}

示例3：完整的Flutter应用示例

import 'package:flutter/material.dart';
import 'package:embedded_serialport/embedded_serialport.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Serial Port Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const SerialPortPage(),
    );
  }
}

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

  @override
  // ignore: library_private_types_in_public_api
  _SerialPortPageState createState() => _SerialPortPageState();
}

class _SerialPortPageState extends State<SerialPortPage> {
  late Serial _serial;
  List<String> _ports = [];
  String _output = "";

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

  void _initializeSerialPort() {
    _ports = Serial.getPorts();
    if (_ports.isNotEmpty) {
      _serial = Serial(_ports.first, Baudrate.b115200);
      _serial.timeout(2);
    }
  }

  void _writeString(String command) async {
    _serial.writeString(command);
    await Future.delayed(const Duration(milliseconds: 100));
    var event = _serial.read(0);
    setState(() {
      _output += "Hardware says -> ${event.toString()}\n";
    });
  }

  void _disposeSerialPort() {
    _serial.dispose();
  }

  @override
  void dispose() {
    _disposeSerialPort();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Serial Port Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text('Available Ports: ${_ports.join(", ")}'),
            const SizedBox(height: 20),
            ElevatedButton(
              onPressed: () => _writeString('on'),
              child: const Text('Send "on"'),
            ),
            const SizedBox(height: 20),
            ElevatedButton(
              onPressed: () => _writeString('off'),
              child: const Text('Send "off"'),
            ),
            const SizedBox(height: 20),
            Expanded(
              child: SingleChildScrollView(
                child: Text(_output),
              ),
            ),
          ],
        ),
      ),
    );
  }
}

API说明

Serial 类

静态方法

• List<String> getPorts()：返回可用串口列表。

构造函数

• Serial(String port, Baudrate baudrate)：创建一个新的Serial实例，指定端口和波特率。

方法

• void timeout(int seconds)：设置读写操作的超时时间。
• void writeString(String data)：向串口写入字符串。
• Uint8List read(int length)：从串口读取指定数量的字节。
• void dispose()：关闭串口并释放资源。

Baudrate 枚举

常见的波特率枚举值包括：

• Baudrate.b9600
• Baudrate.b19200
• Baudrate.b38400
• Baudrate.b57600
• Baudrate.b115200
• 更多…

作者

• Zacchaeus Oluwole
  • LinkedIn: https://www.linkedin.com/in/zacchaeus-oluwole/
  • X: https://x.com/ZTechPlus
  • Email: zacchaeusoluwole@gmail.com
  • Github: https://github.com/Zacchaeus-Oluwole

致谢

• Peter Sauer https://flutterdev.at/dart_periphery/