rtc.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//  Home Office
//  Nürnberg, Germany
//  E-Mail: sergej1@email.ua
//
//  Copyright (C) 2020 free Project SynchroTime RTC DS3231. 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 RTC_H
#define RTC_H

//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include <QObject>
#include "serialportsettings.h"

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

//------------------------------------------------------------------------------
// Enums
//------------------------------------------------------------------------------
enum class Request : quint8
{
    INFO   = 'i', 
    ADJUST = 'a', 
    CALIBR = 'c', 
    RESET  = 'r', 
    SETREG = 's', 
    STATUS = 't'  
};

enum class StatusMessages : quint8
{
    STATUS_SUCCESS = 0x00,           
    STATUS_ERROR = 0x01,             
    STATUS_INVALID_PARAMETER = 0x02, 
    STATUS_INPUT_DATA_TOLONG = 0x03, 
    STATUS_NOT_SUPPORTED = 0x04,     
    STATUS_UNKNOWN_ERROR = 0x05,     
    STATUS_DISCONNECTION = 0x06      
};

//------------------------------------------------------------------------------
// Types
//------------------------------------------------------------------------------
class QSerialPort;
class QTimer;

class RTC : public QObject
{
    Q_OBJECT

public:
    explicit RTC( const QString &portName, QObject *parent = 0 );
    explicit RTC( const Settings_t &portSettings, QObject *parent = 0 );
    ~RTC();

    // Connection check function.
    bool isConnected() const;
    bool isBusy() const;

signals:
    void getRate( const float rate );
    void getData( const QString &data );
    void portError( const QString &error );

public slots:
    // Information request slot.
    void informationRequestSlot();
    // Adjustment request slot.
    void adjustmentRequestSlot();
    // Calibration request slot.
    void calibrationRequestSlot();
    // Reset request slot.
    void resetRequestSlot();
    // Set register request slot.
    void setRegisterRequestSlot( const float newValue );
    // Status request slot.
    void statusRequestSlot();

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

private:
    // Open the serial port
    bool openSerialPort() const;
    // The connection function.
    void connectToRTC();
    // The function send a request to the RTC.
    const QByteArray sendRequest( Request request, quint8 size = 0, const quint8 *const data = nullptr );
    // Information request.
    void informationRequest();
    // Adjustment request.
    void adjustmentRequest();
    // Calibration request.
    void calibrationRequest();
    // Reset request.
    void resetRequest();
    // Set register request.
    void setRegisterRequest( const float newValue );
    // Status request.
    bool statusRequest();

    QSerialPort *m_pSerialPort;
    bool m_isConnected;
    bool m_isBusy;
    QTimer *m_pTimerCheckConnection;
    float m_correctionFactor;
};

#endif // RTC_H