#include <OSAPI/Serial/Serial.h>
....
Serial* serial = Serial::MakeSerial();
serial->SetupParams(9600,e_NoParity,8,1,e_ProtNone,0,"/dev/ttyS0");
serial->Open();
if(serial->PutBytes("test",4,1000)==4)
  CDPMessage("PutBytes succeeded!");
else
  CDPMessage("PutBytes failed!");
serial->Close();
delete serial;

#include <OSAPI/Serial/Serial.h>
...
Serial* serial = Serial::MakeSerial();
...

serial->Configure(parentConfigurationElement);
serial->Open();
if(serial->PutBytes("test",4,1000)==4)
  CDPMessage("PutBytes succeeded!");
else
  CDPMessage("PutBytes failed!");
serial->Close();
delete serial;

Member Function Documentation

[protected] Serial::Serial()

Constructor. Protected, code should use MakeSerial() to get an instance of the correct serial class.

[virtual] Serial::~Serial()

Destroys the instance of Serial. The destructor is virtual.

[pure virtual] void Serial::ClearDTR()

Clear the DTR pin.

[pure virtual] void Serial::ClearRTS()

Clear the RTS pin.

[pure virtual] void Serial::Close()

Closes the port.

[virtual] void Serial::Configure(XMLElementEx *nodeConfig)

Configures itself from nodeConfig. Assumes nodeConfig is an XMLElementEx that contains the following child elements.

<BaudRate></BaudRate>
<Parity></Parity>
<StopBits></StopBits>
<Protocol></Protocol>
<MultiDrop></MultiDrop>
<ComPort Name=""></ComPort>

See also Baudrate, Parity, Data bits, Stop bits, Protocol, and MultiDrop.

unsigned int Serial::GetBaudRate()

Return the baudrate.

[pure virtual] bool Serial::GetByte(unsigned char *pByte, unsigned int lTimeout)

Reads a single character into the caller-supplied pByte.

Returns after the character has been received, or after a timeout (whichever occurs first). lTimeout value is in milliseconds.

As GetByte() is a blocking call, do not call it from a Process() function. See CDPComponent and OSAPIThread for more information about component threads.

[pure virtual] int Serial::GetBytes(unsigned char *pBuf, int nBytes, unsigned int lTimeout)

Reads a string of length nBytes into the caller-supplied buffer pBuf.

Returns after all the characters have been received, or after a timeout (whichever occurs first). lTimeout value is in milliseconds.

If a timeout occurs the function returns 0.

As GetBytes() is a blocking call, do not call it from a Process() function. See CDPComponent and OSAPIThread for more information about component threads.

[virtual] double Serial::GetClockFrequencyMHz()

Return the ClockFrequency in MHz

unsigned char Serial::GetDataBits()

Return Databits.

[pure virtual] unsigned int Serial::GetInfinite()

Returns the timeout value for "infinite".

char Serial::GetParity()

Returns the Parity as a char: eEvenParity: 'E' eOddParity: 'O' eMarkParity: 'M' eSpaceParity: 'S' everything else: 'N'

unsigned char Serial::GetStopBits()

Return Stopbits.

[pure virtual] unsigned int Serial::GetZeroTimeout()

Returns the smallest possible timeout value.

[static] Serial *Serial::MakeSerial()

Creates a serial object for the current target platform.

[virtual protected] void Serial::MultiDrop_Control_Duplex(void)

MultiDrop_Control_Duplex.

• If MultiDrop == 1: ClearDTR
• If MultiDrop == 2: SetDTR

[virtual protected] void Serial::MultiDrop_Receive_Enable(void)

Call and SetRTS() if multidrop.

[virtual protected] void Serial::MultiDrop_Transmit_Enable(void)

Call ClearRTS() if multidrop.

[pure virtual] bool Serial::Open()

Opens the serial port.

See also SetupParams() and Configure().

[pure virtual] bool Serial::PutByte(const unsigned char *pByte, unsigned int lTimeout)

Sends a single character.

Returns after the character has been sent, or after a timeout (whichever occurs first). lTimeout value is in milliseconds.

As PutByte() is a blocking call, do not call it from a Process() function. See CDPComponent and OSAPIThread for more information about component threads.

[pure virtual] int Serial::PutBytes(const unsigned char *pBuf, int nBytes, unsigned int lTimeout)

Sends a string from the caller-supplied buffer pBuf that is nBytes in size.

Returns after *all* the characters have been sent, or after a timeout (whichever occurs first). lTimeout value is in milliseconds.

As PutBytes() is a blocking call, do not call it from a Process() function. See CDPComponent and OSAPIThread for more information about component threads.

void Serial::SetBaud(unsigned int nBaudRate)

Change the baudrate (must be set before Open()).

[virtual] void Serial::SetClockFrequencyMHz(double dFrequencyMHz)

Set the clockfrequency in MHz. Should be called before Open().

Note that if the serial host uses a non-standard ClockFrequencyMHz, it must be specified in the configuration, or set by calling this function prior to Open().

[pure virtual] void Serial::SetDTR()

Set the DTR pin.

[pure virtual] void Serial::SetRTS()

Set the RTS pin.

[pure virtual] void Serial::SetupParams(unsigned int nBaudRate, ParityModes eParity, int nDataBits, int nStopBits, ProtocolModes eProtocol, int nMultiDrop, std::string strPortName)

Parameter setup.

See also Baudrate, Parity, Data bits, Stop bits, Protocol, and MultiDrop.

[protected] const Serial &Serial::operator=(const Serial &right)

Assignment operator. Not implemented (only declared to prevent use).