SerialPort.hpp

Go to the documentation of this file.

#ifndef IV_SRC_COMMS_SERIAL_SERIALPORT_HPP_
#define IV_SRC_COMMS_SERIAL_SERIALPORT_HPP_
 
#include "comms/serial/structs.hpp"
 
#include <mutex>
#include <vector>
 
namespace iv::comms::serial
{
 
using size_t = uint64_t;
 
class SerialPort
{
public:
    SerialPort() = delete;
    explicit SerialPort(const iv::model::comms::serial::PortSettings &settings);
    SerialPort(const std::string &portName, iv::model::comms::serial::eBaudRate baudRate,
               iv::model::comms::serial::eDataBits dataBits, iv::model::comms::serial::eParity parity,
               iv::model::comms::serial::eStopBits stopBits, iv::model::comms::serial::eFlowControl flowControl,
               const iv::comms::serial::Timeout &timeout);
    SerialPort(const SerialPort &other) = delete;
    SerialPort(SerialPort &&other) noexcept = delete;
    ~SerialPort();
 
    SerialPort &operator=(const SerialPort &other) = delete;
    SerialPort &operator=(SerialPort &&other) noexcept = delete;
 
    [[nodiscard]] uint64_t available() const;
    void close();
    void open();
 
    iv::comms::serial::size_t read(uint8_t *buffer, iv::comms::serial::size_t size) const;
    iv::comms::serial::size_t read(std::vector<uint8_t> &buffer, iv::comms::serial::size_t size = 1) const;
    iv::comms::serial::size_t read(std::string &buffer, iv::comms::serial::size_t size = 1) const;
    [[nodiscard]] std::string read(iv::comms::serial::size_t size = 1) const;
    size_t readLine(std::string &buffer, iv::comms::serial::size_t size = 65536, const std::string &eol = "\n") const;
    [[nodiscard]] std::string readLine(iv::comms::serial::size_t size = 65536, const std::string &eol = "\n") const;
    [[nodiscard]] std::vector<std::string> readLines(iv::comms::serial::size_t size = 65536,
                                                     const std::string &eol = "\n") const;
 
    iv::comms::serial::size_t write(const uint8_t *data, iv::comms::serial::size_t size) const;
    [[nodiscard]] iv::comms::serial::size_t write(const std::vector<uint8_t> &data) const;
    [[nodiscard]] iv::comms::serial::size_t write(const std::vector<std::byte> &data) const;
    [[nodiscard]] iv::comms::serial::size_t write(const std::string &data) const;
 
    [[nodiscard]] bool waitReadable(uint32_t timeout) const;
 
    void waitByteTimes(iv::comms::serial::size_t count) const;
 
    void flush() const;
 
    void flushInput() const;
 
    void flushOutput() const;
 
    void sendBreak(uint32_t duration) const;
 
    void setPort(const std::string &port);
    void setBaudRate(iv::model::comms::serial::eBaudRate baudRate);
    void setByteSize(iv::model::comms::serial::eDataBits byteSize);
    void setParity(iv::model::comms::serial::eParity parity);
    void setStopBits(iv::model::comms::serial::eStopBits stopBits);
    void setFlowControl(iv::model::comms::serial::eFlowControl flowControl);
    void setTimeout(const iv::comms::serial::Timeout &timeout);
    void setTimeout(uint32_t interByteTimeout, uint32_t readTimeoutConstant, uint32_t readTimeoutMultiplier,
                    uint32_t writeTimeoutConstant, uint32_t writeTimeoutMultiplier);
    void setBreak(bool level = true) const;
 
    void setRTS(bool level = true) const;
 
    void setDTR(bool level = true) const;
 
    [[nodiscard]] bool waitForChange() const;
    [[nodiscard]] std::string getPort() const;
    [[nodiscard]] iv::model::comms::serial::eBaudRate getBaudRate() const;
    [[nodiscard]] iv::model::comms::serial::eDataBits getByteSize() const;
    [[nodiscard]] iv::model::comms::serial::eParity getParity() const;
    [[nodiscard]] iv::model::comms::serial::eStopBits getStopBits() const;
    [[nodiscard]] iv::model::comms::serial::eFlowControl getFlowControl() const;
    [[nodiscard]] iv::comms::serial::Timeout getTimeout() const;
    [[nodiscard]] bool getCTS() const;
    [[nodiscard]] bool getDSR() const;
    [[nodiscard]] bool getRI() const;
    [[nodiscard]] bool getCD() const;
    [[nodiscard]] bool isOpen() const;
 
private:
    iv::comms::serial::size_t _read(uint8_t *buffer, iv::comms::serial::size_t size) const;
    iv::comms::serial::size_t _write(const uint8_t *data, iv::comms::serial::size_t size) const;
 
    void reconfigurePort() const;
    static timespec timespecFromMs(const uint32_t &millis);
    void readLock();
    void readUnlock();
    void writeLock();
    void writeUnlock();
 
    std::string m_port;
    int32_t m_fd;
 
    bool m_isOpen;
    bool m_xOnXOff;
    bool m_rtsCts;
 
    iv::comms::serial::Timeout m_timeout;
    iv::model::comms::serial::PortSettings m_settings;
 
    uint32_t byteTimeNs;// Nanoseconds to transmit/receive a single byte
 
    std::mutex m_readMutex;
    std::mutex m_writeMutex;
};
 
}// namespace iv::comms::serial
 
#endif//IV_SRC_COMMS_SERIAL_SERIALPORT_HPP_