TrafficDataProvider.h

/***************************************************************************
 *   Copyright (C) 2021-2024 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QNetworkDatagram>
#include <QStandardPaths>
#include <QUdpSocket>
 
#include "GlobalObject.h"
#include "positioning/PositionInfoSource_Abstract.h"
#include "traffic/ConnectionInfo.h"
#include "traffic/TrafficDataSource_Abstract.h"
 
namespace Traffic {

class TrafficDataProvider : public Positioning::PositionInfoSource_Abstract {
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON
 
public:
    explicit TrafficDataProvider(QObject *parent = nullptr);
 
    // No default constructor, important for QML singleton
    explicit TrafficDataProvider() = delete;
 
    // factory function for QML singleton
    static Traffic::TrafficDataProvider* create(QQmlEngine* /*unused*/, QJSEngine* /*unused*/)
    {
        return GlobalObject::trafficDataProvider();
    }
 
 
 
    //
    // Properties
    //

    Q_PROPERTY(QList<Traffic::TrafficDataSource_Abstract*> dataSources READ dataSources NOTIFY dataSourcesChanged)
 
    
    Q_PROPERTY(Units::Distance pressureAltitude READ pressureAltitude BINDABLE bindablePressureAltitude)

    Q_PROPERTY(bool receivingHeartbeat READ receivingHeartbeat BINDABLE bindableReceivingHeartbeat NOTIFY receivingHeartbeatChanged)

    Q_PROPERTY(QList<Traffic::TrafficFactor_WithPosition*> trafficObjects READ trafficObjects CONSTANT)

    Q_PROPERTY(Traffic::TrafficFactor_DistanceOnly* trafficObjectWithoutPosition READ trafficObjectWithoutPosition CONSTANT)

    Q_PROPERTY(QString trafficReceiverRuntimeError READ trafficReceiverRuntimeError NOTIFY trafficReceiverRuntimeErrorChanged)

    Q_PROPERTY(QString trafficReceiverSelfTestError READ trafficReceiverSelfTestError NOTIFY trafficReceiverSelfTestErrorChanged)

    Q_PROPERTY(Traffic::Warning warning READ warning NOTIFY warningChanged)
 
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] QList<Traffic::TrafficDataSource_Abstract*> dataSources() const;

    [[nodiscard]] Units::Distance pressureAltitude() const {return m_pressureAltitude.value();}

    [[nodiscard]] QBindable<Units::Distance> bindablePressureAltitude() const {return &m_pressureAltitude;}

    [[nodiscard]] bool receivingHeartbeat() const
    {
        return m_receivingHeartbeat.value();
    }

    [[nodiscard]] QBindable<bool> bindableReceivingHeartbeat() const
    {
        return &m_receivingHeartbeat;
    }

    [[nodiscard]] QList<Traffic::TrafficFactor_WithPosition*> trafficObjects() const
    {
        return m_trafficObjects;
    }

    [[nodiscard]] Traffic::TrafficFactor_DistanceOnly* trafficObjectWithoutPosition() const
    {
        return m_trafficObjectWithoutPosition;
    }

    [[nodiscard]] QString trafficReceiverRuntimeError() const
    {
        return m_trafficReceiverRuntimeError;
    }

    [[nodiscard]] QString trafficReceiverSelfTestError() const
    {
        return m_trafficReceiverSelfTestError;
    }

    [[nodiscard]] Traffic::Warning warning() const
    {
        return m_Warning;
    }
 
 
 
    //
    // Methods
    //

    void addDataSource(Traffic::TrafficDataSource_Abstract* source);

    Q_INVOKABLE QString addDataSource(const Traffic::ConnectionInfo &connectionInfo);

    Q_INVOKABLE QString addDataSource_UDP(quint16 port);

    Q_INVOKABLE QString addDataSource_SerialPort(const QString& portName);

    Q_INVOKABLE QString addDataSource_TCP(const QString& host, quint16 port);

    Q_INVOKABLE void removeDataSource(Traffic::TrafficDataSource_Abstract* source);
 
signals:
    void dataSourcesChanged();

    void passwordRequest(const QString& SSID);

    void passwordStorageRequest(const QString& SSID, const QString& password);

    void receivingHeartbeatChanged();

    void trafficReceiverRuntimeErrorChanged();

    void trafficReceiverSelfTestErrorChanged();

    void warningChanged(const Traffic::Warning&);
 
public slots:
    void connectToTrafficReceiver();

    void disconnectFromTrafficReceiver();

    void setPassword(const QString& SSID, const QString &password);
 
private slots:
    // Identical to addDataSource, but handles Bluetooth Classic connections only.
    QString addDataSource_BluetoothClassic(const Traffic::ConnectionInfo &connectionInfo);
 
    // Identical to addDataSource, but handles Bluetooth Low Energy connections only.
    QString addDataSource_BluetoothLowEnergy(const Traffic::ConnectionInfo &connectionInfo);
 
    // Clear all data sources
    void clearDataSources();
 
    // Intializations that are moved out of the constructor, in order to avoid
    // nested uses of constructors in Global.
    void deferredInitialization() const;
 
    // Sends out foreflight broadcast message See
    // https://www.foreflight.com/connect/spec/
    void foreFlightBroadcast();
 
    // Load connection infos from file and create connections
    void loadConnectionInfos();
 
    // Called if one of the sources indicates a heartbeat change
    void onSourceHeartbeatChanged();
 
    // Called if one of the sources reports traffic (position unknown)
    void onTrafficFactorWithPosition(const Traffic::TrafficFactor_WithPosition& factor);
 
    // Called if one of the sources reports traffic (position known)
    void onTrafficFactorWithoutPosition(const Traffic::TrafficFactor_DistanceOnly& factor);
 
    // Called if one of the sources reports or clears an error string
    void onTrafficReceiverSelfTestError();
 
    // Called if one of the sources reports or clears an error string
    void onTrafficReceiverRuntimeError();
 
    // Resetter method
    void resetWarning();
 
    // Save connection infos to file
    void saveConnectionInfos();
 
    // Setter method
    void setWarning(const Traffic::Warning& warning);
 
private:
    //
    // Compute Methods
    //
 
    QString computeStatusString();
 
    // UDP Socket for ForeFlight Broadcast messages.
    // See https://www.foreflight.com/connect/spec/
    QNetworkDatagram foreFlightBroadcastDatagram {R"({"App":"Enroute Flight Navigation","GDL90":{"port":4000}})", QHostAddress::Broadcast, 63093};
    QUdpSocket foreFlightBroadcastSocket;
    QTimer foreFlightBroadcastTimer;
 
    // Targets
    QList<Traffic::TrafficFactor_WithPosition *> m_trafficObjects;
    QPointer<Traffic::TrafficFactor_DistanceOnly> m_trafficObjectWithoutPosition;
 
    // TrafficData Sources
    QProperty<QList<QPointer<Traffic::TrafficDataSource_Abstract>>> m_dataSources;
    QProperty<QPointer<Traffic::TrafficDataSource_Abstract>> m_currentSource;
 
    // Property cache
    Traffic::Warning m_Warning;
    QTimer m_WarningTimer;
    QString m_trafficReceiverRuntimeError;
    QString m_trafficReceiverSelfTestError;
 
    QProperty<Units::Distance> m_pressureAltitude;
    Units::Distance computePressureAltitude();
 
    // Reconnect
    QTimer reconnectionTimer;
 
    Q_OBJECT_BINDABLE_PROPERTY(Traffic::TrafficDataProvider, bool, m_receivingHeartbeat, &Traffic::TrafficDataProvider::receivingHeartbeatChanged);
 
    // Standard file name for saveConnectionInfos()
    QString stdFileName{QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) + "/connectionInfos.data"};
};
 
} // namespace Traffic