Package com.zebra.commoniolib

Class CdcAcmSerialDriver.CdcAcmSerialPort

java.lang.Object

com.zebra.commoniolib.CommonUsbSerialPort

com.zebra.commoniolib.CdcAcmSerialDriver.CdcAcmSerialPort

All Implemented Interfaces:

UsbSerialPort, Closeable, AutoCloseable

Enclosing class:

CdcAcmSerialDriver

public class CdcAcmSerialDriver.CdcAcmSerialPort
extends CommonUsbSerialPort

Nested Class Summary

Nested classes/interfaces inherited from interface com.zebra.commoniolib.UsbSerialPort

UsbSerialPort.ControlLine

Field Summary

Fields inherited from class com.zebra.commoniolib.CommonUsbSerialPort

mConnection, mDevice, mPortNumber, mReadEndpoint, mUsbRequest, mWriteBuffer, mWriteBufferLock, mWriteEndpoint

Fields inherited from interface com.zebra.commoniolib.UsbSerialPort

DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8, FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN, FLOWCONTROL_XONXOFF_OUT, PARITY_EVEN, PARITY_MARK, PARITY_NONE, PARITY_ODD, PARITY_SPACE, STOPBITS_1, STOPBITS_1_5, STOPBITS_2

Constructor Summary

Constructors

Constructor	Description
CdcAcmSerialPort(android.hardware.usb.UsbDevice device, int portNumber)

Method Summary

Modifier and Type	Method	Description
protected void	closeInt()
boolean	getCD()	Gets the CD (Carrier Detect) bit from the underlying UART.
EnumSet<UsbSerialPort.ControlLine>	getControlLines()	Gets all control line values from the underlying UART, if supported.
boolean	getCTS()	Gets the CTS (Clear To Send) bit from the underlying UART.
UsbSerialDriver	getDriver()	Returns the driver used by this port.
boolean	getDSR()	Gets the DSR (Data Set Ready) bit from the underlying UART.
boolean	getDTR()	Gets the DTR (Data Terminal Ready) bit from the underlying UART.
boolean	getRI()	Gets the RI (Ring Indicator) bit from the underlying UART.
boolean	getRTS()	Gets the RTS (Request To Send) bit from the underlying UART.
EnumSet<UsbSerialPort.ControlLine>	getSupportedControlLines()	Gets all control line supported flags.
protected void	openInt(android.hardware.usb.UsbDeviceConnection connection)
void	setDTR(boolean value)	Sets the DTR (Data Terminal Ready) bit on the underlying UART, if supported.
void	setParameters(int baudRate, int dataBits, int stopBits, int parity)	Sets various serial port parameters.
void	setRTS(boolean value)	Sets the RTS (Request To Send) bit on the underlying UART, if supported.

Methods inherited from class com.zebra.commoniolib.CommonUsbSerialPort

close, getDevice, getPortNumber, getSerial, isOpen, open, purgeHwBuffers, read, readFilter, setWriteBufferSize, toString, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CdcAcmSerialPort

public CdcAcmSerialPort(android.hardware.usb.UsbDevice device,
 int portNumber)

Method Details

getDriver

public UsbSerialDriver getDriver()

Description copied from interface: UsbSerialPort

Returns the driver used by this port.

openInt

protected void openInt(android.hardware.usb.UsbDeviceConnection connection)
                throws IOException

Specified by:

openInt in class CommonUsbSerialPort

Throws:

IOException

closeInt

protected void closeInt()

Specified by:

closeInt in class CommonUsbSerialPort

setParameters

public void setParameters(int baudRate,
 int dataBits,
 int stopBits,
 int parity)
                   throws IOException

Description copied from interface: UsbSerialPort

Sets various serial port parameters.

Specified by:

setParameters in interface UsbSerialPort

Specified by:

setParameters in class CommonUsbSerialPort

Parameters:

baudRate - baud rate as an integer, for example 115200.

dataBits - one of UsbSerialPort.DATABITS_5, UsbSerialPort.DATABITS_6, UsbSerialPort.DATABITS_7, or UsbSerialPort.DATABITS_8.

stopBits - one of UsbSerialPort.STOPBITS_1, UsbSerialPort.STOPBITS_1_5, or UsbSerialPort.STOPBITS_2.

parity - one of UsbSerialPort.PARITY_NONE, UsbSerialPort.PARITY_ODD, UsbSerialPort.PARITY_EVEN, UsbSerialPort.PARITY_MARK, or UsbSerialPort.PARITY_SPACE.

Throws:

IOException - on error setting the port parameters

getCD

public boolean getCD()
              throws IOException

Description copied from interface: UsbSerialPort

Gets the CD (Carrier Detect) bit from the underlying UART.

Specified by:

getCD in interface UsbSerialPort

Specified by:

getCD in class CommonUsbSerialPort

Returns:

the current state, or false if not supported.

Throws:

IOException - if an error occurred during reading

getCTS

public boolean getCTS()
               throws IOException

Description copied from interface: UsbSerialPort

Gets the CTS (Clear To Send) bit from the underlying UART.

Specified by:

getCTS in interface UsbSerialPort

Specified by:

getCTS in class CommonUsbSerialPort

Returns:

the current state, or false if not supported.

Throws:

IOException - if an error occurred during reading

getDSR

public boolean getDSR()
               throws IOException

Description copied from interface: UsbSerialPort

Gets the DSR (Data Set Ready) bit from the underlying UART.

Specified by:

getDSR in interface UsbSerialPort

Specified by:

getDSR in class CommonUsbSerialPort

Returns:

the current state, or false if not supported.

Throws:

IOException - if an error occurred during reading

getDTR

public boolean getDTR()
               throws IOException

Description copied from interface: UsbSerialPort

Gets the DTR (Data Terminal Ready) bit from the underlying UART.

Specified by:

getDTR in interface UsbSerialPort

Specified by:

getDTR in class CommonUsbSerialPort

Returns:

the current state, or false if not supported.

Throws:

IOException - if an error occurred during reading

setDTR

public void setDTR(boolean value)
            throws IOException

Description copied from interface: UsbSerialPort

Sets the DTR (Data Terminal Ready) bit on the underlying UART, if supported.

Specified by:

setDTR in interface UsbSerialPort

Specified by:

setDTR in class CommonUsbSerialPort

Parameters:

value - the value to set

Throws:

IOException - if an error occurred during writing

getRI

public boolean getRI()
              throws IOException

Description copied from interface: UsbSerialPort

Gets the RI (Ring Indicator) bit from the underlying UART.

Specified by:

getRI in interface UsbSerialPort

Specified by:

getRI in class CommonUsbSerialPort

Returns:

the current state, or false if not supported.

Throws:

IOException - if an error occurred during reading

getRTS

public boolean getRTS()
               throws IOException

Description copied from interface: UsbSerialPort

Gets the RTS (Request To Send) bit from the underlying UART.

Specified by:

getRTS in interface UsbSerialPort

Specified by:

getRTS in class CommonUsbSerialPort

Returns:

the current state, or false if not supported.

Throws:

IOException - if an error occurred during reading

setRTS

public void setRTS(boolean value)
            throws IOException

Description copied from interface: UsbSerialPort

Sets the RTS (Request To Send) bit on the underlying UART, if supported.

Specified by:

setRTS in interface UsbSerialPort

Specified by:

setRTS in class CommonUsbSerialPort

Parameters:

value - the value to set

Throws:

IOException - if an error occurred during writing

getControlLines

public EnumSet<UsbSerialPort.ControlLine> getControlLines()
                                                   throws IOException

Description copied from interface: UsbSerialPort

Gets all control line values from the underlying UART, if supported. Requires less USB calls than calling getRTS() + ... + getRI() individually.

Specified by:

getControlLines in interface UsbSerialPort

Specified by:

getControlLines in class CommonUsbSerialPort

Returns:

EnumSet.contains(...) is true if set, else false

Throws:

IOException

getSupportedControlLines

public EnumSet<UsbSerialPort.ControlLine> getSupportedControlLines()
                                                            throws IOException

Description copied from interface: UsbSerialPort

Gets all control line supported flags.

Specified by:

getSupportedControlLines in interface UsbSerialPort

Specified by:

getSupportedControlLines in class CommonUsbSerialPort

Returns:

EnumSet.contains(...) is true if supported, else false

Throws:

IOException