USB Host Serial API¶

Communicate with USB serial devices (requires USB OTG support and Android 3.1+).

USB Serial Methods)¶

usbHostSerialOpen()¶

Open a connection to a USB serial device.

usbHostSerialOpen(device, baudRate=9600)

Parameters: - device (str): USB device path or identifier - baudRate (int): Baud rate (default: 9600)

Returns: True if opened successfully

usbHostSerialClose()¶

Close the USB serial connection.

usbHostSerialClose()

usbHostSerialRead()¶

Read data from USB serial.

usbHostSerialRead(bufferSize=1024)

Parameters: - bufferSize (int): Maximum bytes to read (default: 1024)

Returns: String read data

usbHostSerialWrite()¶

Write data to USB serial.

usbHostSerialWrite(data)

Parameters: - data (str): String data to write

usbHostSerialAvailable()¶

Check if data is available to read.

usbHostSerialAvailable()

Returns: Number of bytes available

Configuration Methods)¶

usbHostSerialSetBaudRate()¶

Set the baud rate.

usbHostSerialSetBaudRate(baudRate)

Parameters: - baudRate (int): Baud rate

usbHostSerialSetDataBits()¶

Set data bits (5, 6, 7, or 8).

usbHostSerialSetDataBits(dataBits)

Parameters: - dataBits (int): Data bits (5-8)

usbHostSerialSetStopBits()¶

Set stop bits (1, 1.5, or 2).

usbHostSerialSetStopBits(stopBits)

Parameters: - stopBits (float): Stop bits (1, 1.5, or 2)

usbHostSerialSetParity()¶

Set parity (none, odd, even, mark, space).

usbHostSerialSetParity(parity)

Parameters: - parity (str): Parity mode ('none', 'odd', 'even', 'mark', 'space')

usbHostSerialSetFlowControl()¶

Set flow control (none, hardware, software).

usbHostSerialSetFlowControl(flowControl)

Parameters: - flowControl (str): Flow control mode ('none', 'hardware', 'software')

usbHostSerialReadHex()¶

Read data as hex string.

usbHostSerialReadHex(bufferSize=1024)

Parameters: - bufferSize (int): Maximum bytes to read

Returns: Hex string

usbHostSerialWriteHex()¶

Write data from hex string.

usbHostSerialWriteHex(hexString)

Parameters: - hexString (str): Hex string to write

Usage Example¶

import androidhelper

droid = androidhelper.Android()

# Open USB serial connection
if droid.usbHostSerialOpen("/dev/bus/usb/001/001", 115200).result:
    print("USB serial opened")

    # Write data
    droid.usbHostSerialWrite("AT\r")

    # Read response
    response = droid.usbHostSerialRead(1024).result
    print(f"Response: {response}")

    # Or use hex
    droid.usbHostSerialWriteHex("41540D0A")  # "AT\r\n"

    # Close connection
    droid.usbHostSerialClose()

Note: USB serial requires: - Android 3.1+ (API 12) - USB OTG cable/adapter - USB host mode support on device - Compatible serial device