library/dev.mcarr.usb.abstracts/AbstractSerialPortWrapper

AbstractSerialPortWrapper

abstract class AbstractSerialPortWrapper : ISerialPortWrapper

Abstract serial port implementation.

This class abstracts away the common logic expected of any serial port implementations.

Inheritors

SerialPortWrapper

UsfaPortWrapper

Constructors

AbstractSerialPortWrapper

constructor()

Properties

defaultReadTimeout

open override var defaultReadTimeout: Long

Timeout in milliseconds after which a read operation should abort.

defaultWriteTimeout

open override 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

open suspend override fun read(numBytes: Int): ByteArray

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

Reads the specified number of bytes from the port.

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

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

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

readBytes

abstract suspend fun readBytes(buffer: ByteArray): Int

Reads data from the serial port until the provided buffer is filled.

setBaudRate

abstract fun setBaudRate(rate: Int)

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

setDefaultTimeouts

open override fun setDefaultTimeouts(readTimeout: Long, writeTimeout: Long)

Sets the values of the port read and write timeouts.

setTimeout

abstract fun setTimeout()

Sets the timeout behavior of the underlying serial port library.

use

open suspend override 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

open suspend override fun write(bytes: ByteArray): Int

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

Writes the provided bytes to the serial port.

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

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

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

writeBytes

abstract suspend fun writeBytes(buffer: ByteArray): Int

Writes the provided byte data to the serial port.