flusbserial

https://pub.dev/packages/flusbserial
Admin
A cross-platform USB serial plugin for Flutter desktop apps that provides direct access to USB...
Tokens:2,635
Snippets:52
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install libusb on macOS

Source: https://pub.dev/packages/flusbserial

Installs the libusb library on macOS using Homebrew. This is a prerequisite for using the flusbserial plugin on macOS.

```bash
brew install libusb

```

--------------------------------

### Flutter USB Serial Communication Example

Source: https://pub.dev/packages/flusbserial/example

Demonstrates how to initialize the plugin, list available USB devices, connect to a specific device by vendor and product ID, configure serial port settings (baud rate, data bits, stop bits, parity), send data, read data, and close the connection. Ensure the correct vendor and product IDs are used for your target device.

```dart
import 'dart:convert';
import 'dart:typed_data';

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

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

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

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

class _MyAppState extends State<MyApp> {
  String versionString = '';
  @override
  void initState() {
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('FlUsbSerial example')),
        body: Center(
          child: Column(
            children: [
              TextButton(
                style: ButtonStyle(
                  backgroundColor: WidgetStateProperty.all(Colors.blueAccent),
                ),
                onPressed: () async {
                  UsbSerialDevice.init();
                  late UsbSerialDevice mDevice;
                  List<UsbDevice> devices = await UsbSerialDevice.listDevices();
                  for (var device in devices) {
                    if (device.vendorId == 0x10C4 &&
                        device.productId == 0xEA60) {
                      mDevice = UsbSerialDevice.createDevice(
                        device,
                        interfaceId: 0,
                      )!;
                      break;
                    }
                  }
                  UsbSerialDevice.setAutoDetachKernelDriver(true);
                  await mDevice.open();
                  await mDevice.setBaudRate(1000000);
                  await mDevice.setDataBits(UsbSerialInterface.dataBits8);
                  await mDevice.setStopBits(UsbSerialInterface.stopBits1);
                  await mDevice.setParity(UsbSerialInterface.parityNone);

                  await mDevice.write(Uint8List.fromList([11 & 0xFF]), 500);
                  await mDevice.write(Uint8List.fromList([5 & 0xFF]), 500);

                  Uint8List buffer = await mDevice.read(9, 500);
                  debugPrint('Read: $buffer');
                  String version = utf8.decode(buffer).split('\n').first;
                  debugPrint('Version String: $version');
                  setState(() {
                    versionString = version;
                  });

                  await mDevice.close();
                  UsbSerialDevice.exit();
                },
                child: Text(
                  'Get Version String',
                  style: TextStyle(color: Colors.white),
                ),
              ),
              Text(
                'Version: $versionString',
                style: TextStyle(color: Colors.black),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

```

--------------------------------

### Install Linux USB Serial Driver

Source: https://pub.dev/packages/flusbserial

Installs the libusb driver on Ubuntu/Debian or Fedora/RHEL systems. This is a prerequisite for using the flusbserial plugin on Linux.

```bash
# Ubuntu / Debian
sudo apt-get install libusb-1.0-0

# Fedora / RHEL
sudo dnf install libusb1

```

--------------------------------

### Import flusbserial in Dart Code

Source: https://pub.dev/packages/flusbserial/install

Import the flusbserial package into your Dart files to start using its functionalities.

```dart
import 'package:flusbserial/flusbserial.dart';
```

--------------------------------

### Declare flusbserial in pubspec.yaml

Source: https://pub.dev/packages/flusbserial/install

This is an example of how the flusbserial dependency will be declared in your pubspec.yaml file after running `flutter pub add`.

```yaml
dependencies:
  flusbserial: ^0.3.3
```

--------------------------------

### Configure Linux udev Rules

Source: https://pub.dev/packages/flusbserial

Creates udev rules to allow USB device access without root privileges. Replace 'xxxx' with your device's vendor and product IDs.

```bash
SUBSYSTEM=="usb|tty", ATTRS{idVendor}=="xxxx", ATTRS{idProduct}=="xxxx", MODE="666"

```

--------------------------------

### Initialize flusbserial Plugin

Source: https://pub.dev/packages/flusbserial

Initializes the flusbserial plugin. This should be called before using other plugin functionalities.

```dart
UsbSerialDevice.init();

```

--------------------------------

### Create UsbSerialDevice Instance

Source: https://pub.dev/packages/flusbserial

Creates an instance of UsbSerialDevice for a given UsbDevice. Allows specifying interface ID or device type for specific configurations.

```dart
UsbDevice? device;
...
// Auto-detect interface
UsbSerialDevice? mDevice = UsbSerialDevice.createDevice(device);

// Specific interface
UsbSerialDevice? mDevice = UsbSerialDevice.createDevice(device, interfaceId: 0);

// Specific driver (eg:- CDC ACM)
UsbSerialDevice? mDevice = UsbSerialDevice.createDevice(device, type: UsbSerialDevice.cdc);

```

--------------------------------

### Configure and Open USB Serial Device

Source: https://pub.dev/packages/flusbserial

Opens a USB serial device and configures its communication parameters such as baud rate, data bits, stop bits, and parity.

```dart
await mDevice.open();
await mDevice.setBaudRate(1000000);
await mDevice.setDataBits(UsbSerialInterface.dataBits8);
await mDevice.setStopBits(UsbSerialInterface.stopBits1);
await mDevice.setParity(UsbSerialInterface.parityNone);

```

--------------------------------

### List Available USB Serial Devices

Source: https://pub.dev/packages/flusbserial

Retrieves a list of all available USB serial devices connected to the system.

```dart
List<UsbDevice> devices = await UsbSerialDevice.listDevices();

```

--------------------------------

### Add flusbserial Dependency

Source: https://pub.dev/packages/flusbserial/install

Use this command to add the flusbserial package to your Flutter project's dependencies. This command automatically updates your pubspec.yaml file.

```bash
$ flutter pub add flusbserial
```

--------------------------------

### Reload udev Rules

Source: https://pub.dev/packages/flusbserial

Reloads the udev rules after modifying the rules file. This ensures that the new rules are applied.

```bash
sudo udevadm control --reload-rules && sudo udevadm trigger

```

--------------------------------

### Read and Write Data via USB Serial

Source: https://pub.dev/packages/flusbserial

Performs read and write operations on the USB serial device with specified timeouts and byte counts.

```dart
int bytesWritten = await mDevice.write(data, timeout);

Uint8List bytesRead = await mDevice.read(bytesToRead, timeout);

```

--------------------------------

### Add flusbserial Dependency

Source: https://pub.dev/packages/flusbserial

Adds the flusbserial package as a dependency in your Flutter project's pubspec.yaml file.

```yaml
dependencies:
    flusbserial: <latest_version>

```

--------------------------------

### Set Flow Control for USB Serial Device

Source: https://pub.dev/packages/flusbserial

Sets the flow control mode for the USB serial device. This is only supported on CP210x and CH34x devices.

```dart
await mDevice.setFlowControl(UsbSerialInterface.flowControlRtsCts);

```

--------------------------------

### Set Auto Detach Kernel Driver (Linux)

Source: https://pub.dev/packages/flusbserial

Enables or disables the auto-detach kernel driver functionality for USB serial devices on Linux. This can prevent conflicts with the system's kernel driver.

```dart
UsbSerialDevice.setAutoDetachKernelDriver(true);

```

--------------------------------

### Control DTR/RTS Lines

Source: https://pub.dev/packages/flusbserial

Changes the state of the DTR (Data Terminal Ready) and RTS (Request To Send) lines for the USB serial device.

```dart
await mDevice.setDtr(true);
await mDevice.setDtr(false);
await mDevice.setRts(true);
await mDevice.setRts(false);

```

--------------------------------

### Close USB Serial Device

Source: https://pub.dev/packages/flusbserial

Closes the connection to the USB serial device, releasing resources.

```dart
await mDevice.close();

```
Tokens:
Raw