SerialTxRx.h

Go to the documentation of this file.

#ifndef SERIALTXRX_H
#define SERIALTXRX_H

#include <string>
#include <forward_list>
//specific to access Windows resources
#include <windows.h>

#include "SerialTxRxErrorMSG.h"

#if defined(_DEBUG)
#define DBGRPT(format, ...) printf(format,##__VA_ARGS__);
#else
#define DBGRPT(format, ...)
#endif

using namespace std;

#define DEFAULTBAUDRATE 9600
#define MAXBUFFERSIZE 2052
//@cond DUMMY
#define START1 160  //0xA0  //OSP messages from/to receiver are preceded by the synchro
#define START2 162  //0xA2  //sequence of two bytes with values START1, START2
#define END1 176    //0XB0  //OSP messages from/to receiver are followed by the end
#define END2 179    //0XB3  //sequence of two bytes with values END1, END2
#define LF  0x0A            //ASCII Line Feed
#define CR  0x0D            //ASCII Carriage Return
#define DOLAR   0x24        //ASCII Dolar sign
#define CHK 0x2A            //ASCII * (chacksum start: two ASCII hex follow with XOR of chars between $ and *)


class CBRrate {
friend class SerialTxRx;
    int baudR;
    DWORD DCBbaud;
    CBRrate(int, DWORD);
};
//@endcond 

class SerialTxRx {
//@cond DUMMY
    friend class CBRrate;
//@endcond 
    HANDLE hSerial;     //the Windows handle for the serial port
    forward_list<CBRrate> CBRrateLst;
    string baudRate;    //the baud rate used
    string portName;    //the port name (like COM35)

    void addCBRrate(int rate, DWORD CBRrt);
    DWORD getCBRrate(int);
    int getBaudRate(DWORD);
    bool synchOSPmsg(int patience = 500);   //skip bytes until start of OSP message is reached
    bool synchNMEAmsg(int patience);    //skip bytes until start of NMEA message is reached

public:
    unsigned char paylenBuff[2];        
    unsigned char payBuff[MAXBUFFERSIZE];   
    unsigned int payloadLen;        

    SerialTxRx(void);
    ~SerialTxRx(void);
    void openPort(string portName);     //open the serial port with the name given
    void setPortParams(int baudRate, int timeout = 1);  //set port params in the current open port
    void getPortParams(int& baudRate, int& timeout, bool& rawMode); //get port params in the current open port
    int readOSPmsg(int patience = MAXBUFFERSIZE*2); //read a OSP message from the serial port
    int readNMEAmsg(int patience = MAXBUFFERSIZE);  //read a NMEA message from the serial port
    void writeOSPcmd(int mid, string cmdArgs, int base = 16);   //generate and send a OSPMessage object containing a command to the receiver
    void writeNMEAcmd(int mid, string cmdArgs); //generate and send a NMEA message object containing a command to the receiver
    void closePort();               //close the currently open serial port
    void sleepTime(int ms);         //sleep for the milliseconds stated before resuming execution
};
#endif