Difference between revisions of "Unit Serial"

From Ultibo.org
Jump to: navigation, search
Line 44: Line 44:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 59: Line 59:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 71: Line 71:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 83: Line 83:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 95: Line 95:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 107: Line 107:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 119: Line 119:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 158: Line 158:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 170: Line 170:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 182: Line 182:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 194: Line 194:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 206: Line 206:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 218: Line 218:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 230: Line 230:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 245: Line 245:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 257: Line 257:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 269: Line 269:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 284: Line 284:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 326: Line 326:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 359: Line 359:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 371: Line 371:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 383: Line 383:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 395: Line 395:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 443: Line 443:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 455: Line 455:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 467: Line 467:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 479: Line 479:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 491: Line 491:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 503: Line 503:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 518: Line 518:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 530: Line 530:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 554: Line 554:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 566: Line 566:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}
Line 578: Line 578:
 
|-
 
|-
 
! '''Note'''
 
! '''Note'''
−
| To be documented
+
| None documented
 
|-
 
|-
 
|}
 
|}

Revision as of 05:47, 27 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

[Expand] 
procedure SerialInit;
Description: Initialize the Serial unit and Serial device table


Serial functions

[Expand] 
function SerialDeviceOpen(Serial:PSerialDevice; BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;
Description: To be documented


[Expand] 
function SerialDeviceClose(Serial:PSerialDevice):LongWord;
Description: To be documented


[Expand] 
function SerialDeviceRead(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: To be documented


[Expand] 
function SerialDeviceWrite(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: To be documented


[Expand] 
function SerialDeviceStatus(Serial:PSerialDevice):LongWord;
Description: To be documented


[Expand] 
function SerialDeviceProperties(Serial:PSerialDevice; Properties:PSerialProperties):LongWord;
Description: To be documented


[Expand] 
function SerialDeviceCreate:PSerialDevice;
Description: Create a new Serial entry


[Expand] 
function SerialDeviceCreateEx(Size:LongWord):PSerialDevice;
Description: Create a new Serial entry


[Expand] 
function SerialDeviceDestroy(Serial:PSerialDevice):LongWord;
Description: Destroy an existing Serial entry


[Expand] 
function SerialDeviceRegister(Serial:PSerialDevice):LongWord;
Description: Register a new Serial in the Serial table


[Expand] 
function SerialDeviceFind(SerialId:LongWord):PSerialDevice;
Description: To be documented


[Expand] 
function SerialDeviceFindByName(const Name:String):PSerialDevice; inline;
Description: To be documented


[Expand] 
function SerialDeviceFindByDescription(const Description:String):PSerialDevice; inline;
Description: To be documented


[Expand] 
function SerialDeviceEnumerate(Callback:TSerialEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function SerialDeviceNotification(Serial:PSerialDevice; Callback:TSerialNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Serial logging functions

[Expand] 
function SerialLoggingStart(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingStop(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented


RTL serial functions

[Expand] 
function SysSerialAvailable:Boolean;
Description: Check if a Serial device is available


[Expand] 
function SysSerialOpen(BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;
Description: Open the default Serial device ready for sending and receiving


[Expand] 
function SysSerialClose:LongWord;
Description: Close the default Serial device and terminate sending and receiving


[Expand] 
function SysSerialWrite(Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to the default Serial device


Serial helper functions

[Expand] 
function SerialGetCount:LongWord; inline;
Description: Get the current Serial count


[Expand] 
function SerialDeviceGetDefault:PSerialDevice; inline;
Description: Get the current default Serial device


[Expand] 
function SerialDeviceSetDefault(Serial:PSerialDevice):LongWord;
Description: Set the current default Serial device


[Expand] 
function SerialDeviceCheck(Serial:PSerialDevice):PSerialDevice;
Description: Check if the supplied Serial is in the Serial table


[Expand] 
function SerialBufferReadComplete(Buffer:PSerialBuffer; Removed:LongWord):Boolean;
Description: Update the buffer to reflect the number of bytes removed when reading


[Expand] 
function SerialBufferWriteStart(Buffer:PSerialBuffer; var Available:LongWord):Pointer;
Description: Return a pointer to the next write to the buffer and the number of bytes that can be written


[Expand] 
function SerialBufferWriteComplete(Buffer:PSerialBuffer; Added:LongWord):Boolean;
Description: Update the buffer to reflect the number of bytes added when writing


[Expand] 
procedure SerialLog(Level:LongWord; Serial:PSerialDevice; const AText:String);
Description: To be documented


[Expand] 
procedure SerialLogInfo(Serial:PSerialDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure SerialLogError(Serial:PSerialDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure SerialLogDebug(Serial:PSerialDevice; const AText:String); inline;
Description: To be documented


[Expand] 
function SerialParityToString(Parity:LongWord):String;
Description: To be documented


[Expand] 
function SerialFlowControlToString(Flow:LongWord):String;
Description: To be documented


Serial logging helper functions

[Expand] 
function SerialLoggingDeviceAdd(Serial:PSerialDevice):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingDeviceRemove(Serial:PSerialDevice):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingDeviceParameters(Serial:PSerialDevice; const Parameters:String; var BaudRate,Parity,DataBits,StopBits:LongWord):LongWord;
Description: Break down the serial parameters value into component parts of baud rate, parity, data bits and stop bits


[Expand] 
function SerialLoggingFirstWord(var Value:String;const Delimiter:String):String;
Description: To be documented


[Expand] 
function SerialLoggingDeviceEnum(Serial:PSerialDevice; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function SerialLoggingDeviceNotify(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Serial&oldid=1012"