usb_serial 0.1.1

  • Example
  • Installing
  • Versions
  • 86


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: ^0.1.1

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

import 'package:usb_serial/usb_serial.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 #

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]));

Dependencies #

This library depends on:

0.1.1 #

  • Merged pull request 1: Fix for NoSuchMethodException thrown on api level less than 21 during device enumeration.

0.1.0 #

  • Modified the USB Attached/Detach stream from Stream<String> to Stream<UsbEvent> to carry additional information about the device being added or removed.
  • Added ACTION_USB_ATTACHED and ACTION_USB_DETACHED constants to dart interface.

0.0.2 #

  • Fixed crasher when connected or disconnecting a USB device without having a sink attached.

0.0.1 #

  • Initial release, providing easy UART access to Android Flutter apps


usb_serial_example #

Demonstrates how to use the usb_serial plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  usb_serial: ^0.1.1

2. Install it

You can install packages from the command line:

with Flutter:

$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:usb_serial/usb_serial.dart';
Version Uploaded Documentation Archive
0.1.1 Jan 9, 2019 Go to the documentation of usb_serial 0.1.1 Download usb_serial 0.1.1 archive
0.1.0 Dec 19, 2018 Go to the documentation of usb_serial 0.1.0 Download usb_serial 0.1.0 archive
0.0.2 Dec 18, 2018 Go to the documentation of usb_serial 0.0.2 Download usb_serial 0.0.2 archive
0.0.1 Dec 12, 2018 Go to the documentation of usb_serial 0.0.1 Download usb_serial 0.0.1 archive
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Apr 25, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.2.0
  • pana: 0.12.14
  • Flutter: 1.4.7


Detected platforms: Flutter

References Flutter, and has no conflicting libraries.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8