Serial.h

Go to the documentation of this file.

 
#ifndef SERIAL_H
#define SERIAL_H
 
#define FIFO_BUF_SIZE 262144 //FIFO buffer size (default)
 
#if defined(WIN32) || defined(_WIN32) || defined(__WIN32) || defined(__WIN32__) || defined(WIN64) || defined(_WIN64) || defined(__WIN64) || defined(__WIN64__)
#ifndef OS_WIN
#define OS_WIN
#endif
#elif defined(linux) || defined(__linux) || defined(__linux__) || defined(__GNUC__) || defined(__GNUG__) || defined(unix) || defined(__unix) || defined(__unix__)
#ifndef OS_LINUX
#define OS_LINUX
#endif
#else
#error OS not supported
#endif
 
#ifdef OS_WIN
#define _WINSOCKAPI_
#include <windows.h>
#define PORT_STR "\\\\.\\COM%u"
#else 
#include <fcntl.h> // Contains file controls like O_RDWR
#include <termios.h> // Contains POSIX terminal control definitions
#include <unistd.h> // write(), read(), close()
#define sprintf_s(buf, len, ...) snprintf((buf), (len), __VA_ARGS__)
#define PORT_STR "/dev/ttyACM%u"
#endif
 
//common include (both Win and Linux)
#include <stdio.h>
#include <vector>
 
class Serial {
    private:
        #ifdef OS_WIN
        HANDLE _serialPort; 
        DCB _serialParams = { 0 };  
        COMMTIMEOUTS _serialTimeout = { 0 };  
        #else 
        int _serialPort; 
        struct termios _serialParams; 
        #endif
        bool _isInit = false; 
        unsigned int _timeout = TIMEOUT; 
    public:
        static constexpr unsigned int TIMEOUT = 10; 
 
        Serial();
 
        ~Serial();
 
        static std::vector<int> get_availableSerialPorts(unsigned int maxPortNumber); //static to be available for all
 
        bool begin(unsigned int port, unsigned int baud, unsigned int timeout);
 
        bool begin(unsigned int port, unsigned int baud);
 
        void flush();
 
        bool end();
 
        bool write(unsigned char c);
 
        size_t write(unsigned char* buf, size_t len);
 
        unsigned char read();
 
        size_t read(unsigned char* buf, size_t len);
 
        void setTimeout(unsigned int timeout);
 
        unsigned int getTimeout();
 
        operator bool() { return _isInit; }
};
#endif