Difference between revisions of "Unit Serial"

Revision as of 04:21, 2 September 2016

Return to Unit Reference

Description

Serial devices represent a communication device that can be both read and written and has a set of common properties and capabilities. The underlying device may be an actual UART or it may be some other form of device such as a USB to Serial converter. As long as the device can implement the common capabilities then it can be accessed as a serial device without regard to the actual implementation.

Each serial device returns a set of properties that describe the capabilities of the device and includes a set of flags that indicate what features are supported.

Reads from and writes to serial devices are buffered so that varying data transfer rates can be accomodated and both reads and writes allow for non blocking so that a caller can avoid waiting for received data to be available or the device to be ready to transmit.

This unit also implements the serial logging device which can be configured via parameters in the GlobalConfig unit or from the command line.

Constants

To be documented

Type definitions

To be documented

Public variables

To be documented

Function declarations

Initialization functions

procedure SerialInit;

Serial functions

function SerialDeviceOpen(Serial:PSerialDevice; BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;

function SerialDeviceClose(Serial:PSerialDevice):LongWord;

function SerialDeviceRead(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

function SerialDeviceWrite(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

function SerialDeviceStatus(Serial:PSerialDevice):LongWord;

function SerialDeviceProperties(Serial:PSerialDevice; Properties:PSerialProperties):LongWord;

function SerialDeviceCreate:PSerialDevice;

function SerialDeviceCreateEx(Size:LongWord):PSerialDevice;

function SerialDeviceDestroy(Serial:PSerialDevice):LongWord;

function SerialDeviceRegister(Serial:PSerialDevice):LongWord;

Return to Unit Reference