polhemus_connection.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef UTILS_POLHEMUS_CONNECTION_H
#define UTILS_POLHEMUS_CONNECTION_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../utils_global.h"
#include "fastrak_parser.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QObject>
#include <QQuaternion>
#include <QSerialPort>
#include <QSerialPortInfo>
#include <QString>
#include <QStringList>
#include <QTimer>
#include <QVector3D>
 
//=============================================================================================================
// DEFINE NAMESPACE UTILSLIB
//=============================================================================================================
 
namespace UTILSLIB
{
 
//=============================================================================================================
struct UTILSSHARED_EXPORT PolhemusSerialConfig
{
    int                       baudRate = 115200;
    FastrakParser::Units     units    = FastrakParser::Units::Inches;
    QVector3D                 hemisphere = QVector3D(0, 0, 0);
    QByteArray                streamCommand = QByteArrayLiteral("C\r");
};
 
//=============================================================================================================
class UTILSSHARED_EXPORT PolhemusConnection : public QObject
{
    Q_OBJECT
 
public:
    explicit PolhemusConnection(QObject* parent = nullptr);
    ~PolhemusConnection() override;

    bool    open(const QString& portName,
                 const PolhemusSerialConfig& cfg = PolhemusSerialConfig{});

    void    close();
 
    bool    isConnected() const;
    QString backendName() const;
 
    //=========================================================================================================
    static QStringList availablePorts();
 
    //=========================================================================================================
    static QString  autoDetectPortName();
 
signals:
    void pointReceived(int station, const QVector3D& position, const QQuaternion& orientation);

    void connectedChanged(bool isConnected);

    void errorOccurred(const QString& message);

    void penButtonPressed(int station, const QVector3D& position, const QQuaternion& orientation);
 
private slots:
    void onMockTick();
    void onSerialReadyRead();
    void onSerialError(QSerialPort::SerialPortError err);
    void onStreamPauseTimeout();
 
private:
    bool openMock();
    void closeMock();
 
    bool openSerial(const QString& portName, const PolhemusSerialConfig& cfg);
    void closeSerial();
    void drainParser();
 
    bool        m_isConnected = false;
    QString     m_backendName;
 
    // Mock backend ------------------------------------------------------------
    QTimer      m_mockTimer;
    int         m_mockSampleIdx = 0;
 
    // Serial backend ----------------------------------------------------------
    QSerialPort*    m_pSerial = nullptr;
    FastrakParser  m_parser;
 
    // Pen-button detection (stream-pause timeout) -----------------------------
    QTimer      m_streamPauseTimer;
    struct StationSample { QVector3D position; QQuaternion orientation; };
    QMap<int, StationSample> m_lastSamples;
};
 
} // namespace UTILSLIB
 
#endif // UTILS_POLHEMUS_CONNECTION_H