SerialCom

is responsable for the serial communication between PC-application and the Arduino Uno More...

#include <SerialCom.h>

Public Member Functions
void	write (char *message)
	Sends a message(command) to the Arduino Uno. More...
void	readString ()
	Reads the serial port for incomming messages. More...
bool	newMessageAvailable ()
	Shows if a new message is recieved from the Serial input. More...
string *	getLastMessage ()
	Returns last message. More...

Static Public Member Functions
static SerialCom *	initialize (string portName, long baudeRate, int dataSize, char parityType, float nStopBits)
	Creates a object if there isn't one already. More...

Private Member Functions
	SerialCom (string portName, long baudeRate, int dataSize, char parityType, float nStopBits)
	Constructor. More...
void	publishError (string message)
	shows a error message on the console More...
void	publishSucces (string message)
	shows a succes message on the console More...

Private Attributes
ceSerial	serial
	Object which holds the ceSerial communication class.
string	line
	string of all characters in the serial message
string	lastMessage
	last serial message
bool	newMessage
	new message available flag

Static Private Attributes
static SerialCom *	instance = 0
	pointer to the current used instance

Detailed Description

is responsable for the serial communication between PC-application and the Arduino Uno

Constructor & Destructor Documentation

SerialCom()

SerialCom::SerialCom ( string  portName, long  baudeRate, int  dataSize, char  parityType, float  nStopBits  )

private

Constructor.

Parameters

portName	name of the COM-port
baudeRate	baudeRate of the COM-port
dataSize	size of the data
parityType	paraity type
nStopBits	number of stop bits

                                                                                                   {
    string port = "\\\\.\\"+portName;
    serial = ceSerial(port, baudeRate, dataSize, parityType, nStopBits);
 
    int opend = serial.Open();
    switch (opend)
    {
    case 1:  publishError("ERROR: No COM-port found named " + portName);    break;
    case 2:  publishError("ERROR: Unable to clear serial buffer");          break;
    case 3:  publishError("ERROR: Unable to open COM-port");                break;
    case 4:  publishError("ERROR: Unable to set COM-port settings");        break;
    case 5:  publishError("ERROR: Unable to open COM-port");                break;
    case 6:  publishError("ERROR: Error creating read overlapped event");   break;
    case 7:  publishError("ERROR: Error creating write overlapped event");  break;
    case 8:  publishError("ERROR: Error getting time-outs");                break;
    case 9:  publishError("ERROR: Error setting time-outs");                break;
    case 0:  publishSucces("OK: Opend " + portName);                        break;
    default: publishError("ERROR: An unspecified error occured");           break;
    }
 
    if (opend != 0)
        serial.Close();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

publishError()

void SerialCom::publishError ( string  message )

private

shows a error message on the console

Also sets the message as lastMessage

Parameters

message

string containing the message

{
    lastMessage = message;
    std::cerr << lastMessage << std::endl;
    newMessage = true;
}

Here is the caller graph for this function:

publishSucces()

void SerialCom::publishSucces ( string  message )

private

shows a succes message on the console

Also sets the message as lastMessage

Parameters

message

string containing the message

{
    lastMessage = message;
    std::cout << lastMessage << std::endl;
    newMessage = true;
}

Here is the caller graph for this function:

initialize()

SerialCom * SerialCom::initialize ( string  portName, long  baudeRate, int  dataSize, char  parityType, float  nStopBits  )

static

Creates a object if there isn't one already.

Note

only one instance can excist because there can only be communicated with one Arduino Uno

Parameters

portName	name of the COM-port
baudeRate	baude rate of the COM-port
dataSize	size of the data
parityType	parity type
nStopBits	number of stop bits

Returns

: SerialCom: Pointer to object instance

{
    if (instance == 0) {
        instance = new SerialCom(portName, baudeRate, dataSize, parityType, nStopBits);
    }
 
    return instance;
}

Here is the call graph for this function:

Here is the caller graph for this function:

write()

void SerialCom::write

(

char *

message

)

Sends a message(command) to the Arduino Uno.

Won't send a message if the COM-port isn't opened.

Parameters

message

command to be send

{
    if (serial.IsOpened()) {
        if (!serial.Write(message))
            publishError("ERROR: A write error occured");
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

readString()

void SerialCom::readString

(

)

Reads the serial port for incomming messages.

If ther isn't a character the readstring will break, so it's non-blocking.
When the character is a line feed(LF) the serial message will be pushed on to the deque.

                           {
 
    bool succes = false;
    char ch = 0;
    do
    {
        ch = serial.ReadChar(succes);
        if (succes) {
            if ((ch >= 0) && (ch != 10) && (ch != 13))
                line += ch;
            if (ch == '\n') {
                lastMessage = line;
                newMessage = true;
                line = "";
            }
        }
    } while ((ch != '\n') && (succes==true));
    
}

Here is the caller graph for this function:

newMessageAvailable()

bool SerialCom::newMessageAvailable

(

)

Shows if a new message is recieved from the Serial input.

Returns

bool: new message available flag

{
    if (newMessage) {
        newMessage = false;
        return true;
    }
    return false;
}

Here is the caller graph for this function:

getLastMessage()

std::string * SerialCom::getLastMessage

(

)

Returns last message.

Returns

string: last serial message

{
    return &lastMessage;
}

Here is the caller graph for this function: