library/dev.mcarr.usb.interfaces/ISerialPortWrapper

ISerialPortWrapper

interface ISerialPortWrapper

Interface from which any serial port implementations should inherit.

Inheritors

AbstractSerialPortWrapper

Properties

defaultReadTimeout

abstract var defaultReadTimeout: Long

Timeout in milliseconds after which a read operation should abort.

defaultWriteTimeout

abstract var defaultWriteTimeout: Long

Timeout in milliseconds after which a write operation should abort.

productId

abstract var productId: Int

PID value of the serial port, or -1 if unavailable

vendorId

abstract var vendorId: Int

VID value of the serial port, or -1 if unavailable

Functions

bytesAvailable

abstract fun bytesAvailable(): Int

Checks how many bytes are available to be read from the serial port.

abstract fun close()

Closes a connection to the serial port.

isOpen

abstract fun isOpen(): Boolean

Checks if there is an open connection to the serial port.

open

abstract fun open()

Opens a connection to the serial port.

read

abstract suspend fun read(numBytes: Int): ByteArray

abstract suspend fun read(numBytes: Int, timeout: Long): ByteArray

Reads the specified number of bytes from the port.

abstract fun read(numBytes: Int, scope: CoroutineScope): Deferred<ByteArray>

abstract fun read(numBytes: Int, timeout: Long, scope: CoroutineScope): Deferred<ByteArray>

Reads the specified number of bytes from the port in an asynchronous manner.

setBaudRate

abstract fun setBaudRate(rate: Int)

Sets the baud rate of the connection to the serial port.

setDefaultTimeouts

abstract fun setDefaultTimeouts(readTimeout: Long, writeTimeout: Long)

Sets the values of the port read and write timeouts.

use

abstract suspend fun <T> use(callback: suspend (ISerialPortWrapper) -> T): T

Opens a connection to the serial port and closes it automatically after the callback has completed.

write

abstract suspend fun write(bytes: ByteArray): Int

abstract suspend fun write(bytes: ByteArray, timeout: Long): Int

Writes the provided bytes to the serial port.

abstract fun write(bytes: ByteArray, scope: CoroutineScope): Deferred<Int>

abstract fun write(bytes: ByteArray, timeout: Long, scope: CoroutineScope): Deferred<Int>

Writes the provided bytes to the serial port in an asynchronous manner.