DSerial

Main class for performing serial port operations

class DSerial {

enum BlockingMode;

this(string deviceName, uint baudRate, DataBits dataBits, Parity parity, StopBits stopBits);

void setOptions(uint baudRate, DataBits dataBits, Parity parity, StopBits stopBits);

void setTimeout(uint millis);

void setBlockingMode(BlockingMode mode);

void close();

ulong read(ubyte data);

ulong read(ubyte[] data);

ulong read(ubyte* data, ulong length);

long write(ubyte[] bytes);

}

Constructors

this this(string deviceName, uint baudRate, DataBits dataBits, Parity parity, StopBits stopBits): Constructor. Creates object with default settings of 9600,8N1. Default is blocking read/write operations

Destructor

~this ~this(): Undocumented in source.

Members

Enums

BlockingMode enum BlockingMode: Set the port access mode to NonBlocking(never blocks), TimedImmediately(timer starts immediately), TimedAfterReceive(timer starts after receiving first char), Blocking(blocks forever)
DataBits enum DataBits: Number of bits per character
Parity enum Parity: Parity of the connection
StopBits enum StopBits: Number of stop bits per char transmission

Functions

close void close(): Closes the serial port
open void open(): Opens the serial port with current settings. Throws an exception if the port can't be opened
read ulong read(ubyte data): convenience function. reads a single byte
read ulong read(ubyte[] data): convenience function. Reads up to data.length bytes
read ulong read(ubyte* data, ulong length): Reads data into the bytes array. Blocks until at least one char has been read.
setBlockingMode void setBlockingMode(BlockingMode mode): set blocking mode for operations
setOptions void setOptions(uint baudRate, DataBits dataBits, Parity parity, StopBits stopBits): Set the options of the port. Is applied immediately if the port is already open
setTimeout void setTimeout(uint millis): Sets read timeout in millis. On linux only increments of 100ms are available. Timeout maximum is 255000 = 25.5secs
write long write(ubyte[] bytes): Write bytes to the serial port returns bytes written, Only supports blocking and nonblocking writes. Timed writes are unsupported.

Meta

Source

See Implementation

dserial classes

DSerial