Package selection guidance compiled from public package information, community data, and project usage.
The usb_serial package enables Flutter applications to communicate with USB UART devices on Android using FTDI, CDC, and other protocols. It provides a straightforward interface for reading from and writing to USB serial ports, making it ideal for connecting to hardware peripherals like sensors, microcontrollers, and industrial devices. The plugin leverages native Android USB APIs and is designed for developers building apps that require direct hardware interaction via USB.
Use cases
Connecting to USB-to-serial adapters
Reading data from microcontrollers
Controlling industrial hardware
Integrating with IoT devices
Developing custom hardware interfaces
Key features
Supports FTDI and CDC protocols
Simple read/write API
Android-only platform support
Native USB communication
Open-source implementation
Suitable for
IoT application developers
Hardware integrators
Embedded system engineers
Android app developers working with USB
Prototyping with USB-connected devices
Considerations
Limited to Android platform
Requires USB OTG support
Needs proper device permissions
May require additional hardware drivers
Not compatible with iOS
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
Looking for maintainer
I'm looking for a new maintainer for this project, please indicate your interest here: https://github.com/altera2015/usbserial/issues/121
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
dependencies:
usb_serial: ^0.5.0
include the usbserial package at the top of your dart file.
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 = awaitUsbSerial.listDevices();
print(devices);
UsbPort port;
if (devices.length == 0) {
return;
}
port = await devices[0].create();
bool openResult = await port.open();
if ( !openResult ) {
print("Failed to open");
return;
}
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) {
print(event);
port.close();
});
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.
Terminated Transformer, this splits incoming data based on a configurable end of message bytes "terminator".
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!
transaction.stream.listen( (String data) {
print(data);
});
// you can write asynchronous messages as before!
p.write(Uint8List.fromList([65,66,13,10]));
// 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");
Upgrading from pre-0.3.0
In version 0.3.0 a resource bug was fixed (issue #35) which required signature
changes.
Transformer Class changes
The Transformer classes previously inherited directly from StreamTransformer, this class
however has no dispose method. So a new abstract class was added to include dispose and
called by Transaction.dispose().
If you are using the static factory methods you should not have to make any changes to your
code. Only if you created your own Transformer/Transactions.