usb_serial_fork 0.0.3
usb_serial_fork: ^0.0.3 copied to clipboard

This plugin will allow you to easily use the USB uart hardware based on FTDI or CDC (and more!) protocols.

Pub Build Status Coverage Status

usb_serial #

An Android USB Serial Flutter Plugin

This plugin allows Flutter code to interact with USB serial devices connected to your Android device. For example an FTDI or CDC based USB device.

Getting Started #

Add a dependency to your pubspec.yaml

	usb_serial_fork: ^0.0.2

include the usbserial package at the top of your dart file.

import 'package:usb_serial/usb_serial_fork.dart'

IMPORTANT app\build.gradle #

Edit android\app\build.gradle and add

    compileOptions {
        sourceCompatibility 1.8
        targetCompatibility 1.8

to the 'android' object, see build.grade from the example project for a template on how to do this. Without this you'll get a bunch or Java errors.

Optional #


		<action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />

	<meta-data android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
		android:resource="@xml/device_filter" />

to your AndroidManifest.xml

and place device_filter.xml

<?xml version="1.0" encoding="utf-8"?>
    <!-- 0x0403 / 0x6001: FTDI FT232R UART -->
    <usb-device vendor-id="1027" product-id="24577" />
    <!-- 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" />

in the res/xml directory. This will notify your app when one of the specified devices is plugged in.

Usage of Asynchronous API #

onPressed: () async {
	List<UsbDevice> devices = await UsbSerial.listDevices();

	UsbPort port;
	if (devices.length == 0) {
	port = await devices[0].create();

	bool openResult = await;
	if ( !openResult ) {
		print("Failed to open");
	await port.setDTR(true);
	await port.setRTS(true);

	port.setPortParameters(115200, UsbPort.DATABITS_8,
	  UsbPort.STOPBITS_1, UsbPort.PARITY_NONE);

	// print first result and close port.
	port.inputStream.listen((Uint8List event) {

	await port.write(Uint8List.fromList([0x10, 0x00]));

Usage of transaction API #

This API is a layer on top of the asynchronous part of the library. It provides two Stream Transformers and a Transaction helper based on the StreamQueue class.

  1. Terminated Transformer, this splits incoming data based on a configurable end of message bytes "terminator".
  2. Magic Header + Length byte, this splits incoming data based on a configurable header ( with wildcards! ) and a length byte directly following the header.

In case neither is a fit, you can use one of those Transformers to create you own that is specific to the binary format you are dealing with.

    Transaction<String> transaction = Transaction.stringTerminated(port.inputStream, Uint8List.fromList([13,10]));

    // While using transactions you can still listen to all 
    // incoming messages! (String data) {

    // you can write asynchronous messages as before!
    // BUT you can also write 'transactions'. This is a combination of a flush, write and wait for response
    // with a timeout. If no response is received within the timeout a null value is returned.
    // this sends "AB\r\n"
    var response = await transaction.transaction(p, Uint8List.fromList([65,66,13,10]), Duration(seconds: 1) );
    print("The response was $response");

Dependencies #

This library depends on:

pub points

This plugin will allow you to easily use the USB uart hardware based on FTDI or CDC (and more!) protocols.

Repository (GitHub)
View/report issues


API reference


BSD-3-Clause (LICENSE)


async, flutter


Packages that depend on usb_serial_fork