interface.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//  Home Office
//  Nürnberg, Germany
//  E-Mail: sergej1@email.ua
//
//  Copyright (C) 2020 free Project SynchroTime. All rights reserved.
//------------------------------------------------------------------------------
//  Project SynchroTime: Command-line client for adjust the exact time and
//  calibrating the RTC DS3231 module via the serial interface (UART).
//------------------------------------------------------------------------------
#ifndef INTERFACE_H
#define INTERFACE_H

//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include <QtSerialPort/QSerialPort>
#include <QtSerialPort/QSerialPortInfo>
#include <QTimer>
#include <QByteArray>
#include "base.h"

//------------------------------------------------------------------------------
// Preprocessor
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
// Enums
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
// Types
//------------------------------------------------------------------------------
// Interval for a time-out in milliseconds
#define REBOOT_WAIT 2500

class Interface : public Base
{
    Q_OBJECT
    Q_CLASSINFO("className", "Interface")

public:
    explicit Interface(QObject *parent = 0);

    // Virtual communicate Methods
    virtual qint64 writeTheData( const QByteArray & ) = 0;
    virtual bool readTheData( const quint32, const quint32 bytes = 0U ) = 0;
    virtual QIODevice *getSocket( void ) = 0;
    virtual void initSocket( void ) = 0;
    virtual bool openSocket( void ) = 0;
    virtual void closeSocket( void ) = 0;

    void setBlockSize( const quint16 size);
    quint16 getBlockSize( void ) const;
    quint32 getReceivedBytes( void ) const;
    void setTimer( QTimer *timer );
    QTimer *getTimer( void );
    void setTimeout( quint32 time );
    quint32 getTimeout( void ) const;
    QByteArray& getReceivedData( void );

signals:
    void infoMessage( const QVariant & message ) const;
    void debugMessage( const QVariant & message ) const;
    void errorMessage( const QVariant & message ) const;

private:

    QTimer *timer;

    quint32 timeout;

    quint16 blockSize;

    QByteArray receivedData;
};

class InterfaceSP : public Interface
{
    Q_OBJECT
    Q_CLASSINFO("className", "InterfaceSP")

public:
    InterfaceSP(QObject *parent = 0);
    InterfaceSP(QObject *parent, const QString & portName );
    InterfaceSP(QObject *parent, QSerialPort * port );
    ~InterfaceSP();

    // Init Method
    void init( void );

    // Init a Serial Port
    void initSerialPort( void );
    void searchAllSerialPort( void );
    bool searchSerialPort( const QString & portName );
    QStringList availableSerialPorts( void );

    // Virtual communicate Methods
    qint64 writeTheData( const QByteArray & data );
    bool readTheData( const quint32 timewait, const quint32 bytes = 0U );
    QSerialPort* getSocket( void );
    void initSocket( void );
    bool openSocket( void );
    void closeSocket( void );

    // Get methods
    QString getPortName( void ) const;
    qint32 getPortBaudRate( void ) const;
    QString getDescription( void ) const;
    QString getManufacturer( void ) const;
    QString getSerialNumber( void ) const;
    quint16 getProductIdentifier( void ) const;
    QSerialPortInfo getSerialPortInfo( void ) const;
    QSerialPort* getSerialPort( void );

private slots:
    void handleReadyRead();
    void handleTimeout();
    void handleError( QSerialPort::SerialPortError error );

private:

    QSerialPort *serialPort;

    QSerialPortInfo serialPortInfo;

    qint64 readBufferSize;

    qint64 bytesAvailable;

};

#endif // INTERFACE_H