serialib.h

Go to the documentation of this file.

 
#ifndef SERIALIB_H
#define SERIALIB_H
 
// Used for TimeOut operations
#include <sys/time.h>
// Include for windows
#if defined(_WIN32) || defined(_WIN64)
// Accessing to the serial port under Windows
#include <windows.h>
#endif
 
// Include for Linux
#ifdef __linux__
#include <stdlib.h>
#include <string.h>
#include <sys/shm.h>
#include <sys/types.h>
#include <termios.h>
 
#include <iostream>
// File control definitions
#include <fcntl.h>
#include <sys/ioctl.h>
#include <unistd.h>
#endif

#define UNUSED(x) (void) (x)

class serialib {
   public:
    //_____________________________________
    // ::: Constructors and destructors :::
 
    // Constructor of the class
    serialib();
 
    // Destructor
    ~serialib();
 
    //_________________________________________
    // ::: Configuration and initialization :::
 
    // Open a device
    char openDevice(const char* Device, const unsigned int Bauds);
 
    // Close the current device
    void closeDevice();
 
    //___________________________________________
    // ::: Read/Write operation on characters :::
 
    // Write a char
    char writeChar(char);
 
    // Read a char (with timeout)
    char readChar(char* pByte, const unsigned int timeOut_ms = 0);
 
    //________________________________________
    // ::: Read/Write operation on strings :::
 
    // Write a string
    char writeString(const char* String);
 
    // Read a string (with timeout)
    int readString(char* receivedString, char finalChar, unsigned int maxNbBytes,
                   const unsigned int timeOut_ms = 0);
 
    // _____________________________________
    // ::: Read/Write operation on bytes :::
 
    // Write an array of bytes
    char writeBytes(const void* Buffer, const unsigned int NbBytes);
 
    // Read an array of byte (with timeout)
    int readBytes(void* buffer, unsigned int maxNbBytes, const unsigned int timeOut_ms = 0,
                  unsigned int sleepDuration_us = 100);
 
    // _________________________
    // ::: Special operation :::
 
    // Empty the received buffer
    char flushReceiver();
 
    // Return the number of bytes in the received buffer
    int available();
 
    // _________________________
    // ::: Access to IO bits :::
 
    // Set CTR status (Data Terminal Ready, pin 4)
    bool DTR(bool status);
    bool setDTR();
    bool clearDTR();
 
    // Set RTS status (Request To Send, pin 7)
    bool RTS(bool status);
    bool setRTS();
    bool clearRTS();
 
    // Get RI status (Ring Indicator, pin 9)
    bool isRI();
 
    // Get DCD status (Data Carrier Detect, pin 1)
    bool isDCD();
 
    // Get CTS status (Clear To Send, pin 8)
    bool isCTS();
 
    // Get DSR status (Data Set Ready, pin 9)
    bool isDSR();
 
    // Get RTS status (Request To Send, pin 7)
    bool isRTS();
 
    // Get CTR status (Data Terminal Ready, pin 4)
    bool isDTR();
 
   private:
    // Read a string (no timeout)
    int readStringNoTimeOut(char* String, char FinalChar, unsigned int MaxNbBytes);
 
    // Current DTR and RTS state (can't be read on WIndows)
    bool currentStateRTS;
    bool currentStateDTR;
 
#if defined(_WIN32) || defined(_WIN64)
    // Handle on serial device
    HANDLE hSerial;
    // For setting serial port timeouts
    COMMTIMEOUTS timeouts;
#endif
#ifdef __linux__
    int fd;
#endif
};

// Class timeOut
class timeOut {
   public:
    // Constructor
    timeOut();
 
    // Init the timer
    void initTimer();
 
    // Return the elapsed time since initialization
    unsigned long int elapsedTime_ms();
 
   private:
    // Used to store the previous time (for computing timeout)
    struct timeval previousTime;
};
 
#endif  // serialib_H