GPSReceiverDetector.h

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <chrono>
#include <cstdint>
#include <functional>
#include <optional>
#include <span>
#include <vector>
 
#include <QtCore/QLatin1StringView>
#include <QtCore/QString>
 
#include "GPSFamilyProtocol.h"
#include "GPSProtocolRuntime.h"
#include "GPSStreamDemux.h"
 
class GPSReceiverSignatures final : private GPSStreamDemux::Handler
{
public:
    struct Match
    {
        const GPSReceiverFamily* family = nullptr;
        QLatin1StringView evidence{};
    };
 
    explicit GPSReceiverSignatures(std::span<const GPSReceiverFamily* const> families);
 
    void push(std::span<const uint8_t> bytes);
 
    void reset();
 
    [[nodiscard]] const std::optional<Match>& match() const { return _match; }
 
    [[nodiscard]] bool framedTraffic() const { return _framedTraffic; }
 
private:
    void frame(const GPSFrame& frame) override;
 
    std::span<const GPSReceiverFamily* const> _families;
    GPSStreamDemux _demux;
    std::optional<Match> _match;
    bool _framedTraffic = false;
};
 
struct GPSReceiverDetection
{
    const GPSReceiverFamily* family = nullptr;
    unsigned baud = 0;
    QString evidence;
    GPSProtocolError error = GPSProtocolError::None;
    QString errorDetail;
 
    [[nodiscard]] bool found() const { return family != nullptr; }
};
 
class GPSReceiverDetector
{
public:
    static constexpr std::chrono::milliseconds LISTEN_WINDOW{1000};
    static constexpr std::chrono::milliseconds TIMEOUT{45000};
    static constexpr std::array<unsigned, 8> BAUD_PRIORITY{115200, 38400, 460800, 9600, 230400, 921600, 57600, 19200};
 
    GPSReceiverDetector(std::span<const GPSReceiverFamily* const> families, GPSRuntimeIO io,
                        std::function<void(const GPSConfigurationEvidence&)> commandFinished = {});
 
    Q_DISABLE_COPY(GPSReceiverDetector)
 
    
    [[nodiscard]] static std::vector<unsigned> baudCandidates(std::span<const GPSReceiverFamily* const> families);
 
    [[nodiscard]] GPSReceiverDetection detect(unsigned baud = 0);
 
private:
    enum class Listen : uint8_t
    {
        Identified,
        Quiet,
        Failed,
    };
 
    Listen _listen(unsigned baud, uint64_t untilUs, GPSReceiverDetection& result);
    bool _stopped(GPSReceiverDetection& result) const;
    GPSReceiverDetection _identified(const GPSReceiverFamily& family, unsigned baud, QString evidence) const;
 
    std::span<const GPSReceiverFamily* const> _families;
    GPSReceiverSignatures _signatures;
    GPSRuntimeIO _io;
    std::function<void(const GPSConfigurationEvidence&)> _commandFinished;
};