Fdo2Handler.h

Go to the documentation of this file.

 
#ifndef COMPONENT_HANDLER_FDO2_HANDLER_H_
#define COMPONENT_HANDLER_FDO2_HANDLER_H_
 
#include <atomic>
#include <cstddef>
#include <cstdint>
#include <memory>
 
#include "RtosMutex.h"
#include "base/BaseUart.h"
 
#include "core/hf-core-drivers/external/hf-fdo2-driver/inc/fdo2.hpp"
 
//==============================================================================
// CRTP UART ADAPTER FOR BaseUart
//==============================================================================
 
class HalUartFdo2Comm : public fdo2::UartInterface<HalUartFdo2Comm> {
public:
    explicit HalUartFdo2Comm(BaseUart& uart) noexcept : uart_(uart) {}
 
    void write(const std::uint8_t* data, std::size_t length) noexcept;
    std::size_t read(std::uint8_t* out, std::size_t max,
                     std::uint32_t timeout_ms) noexcept;
    void flush_rx() noexcept;
    void delay_ms_impl(std::uint32_t ms) noexcept;
 
private:
    BaseUart& uart_;
    std::uint8_t line_[128]{};
    std::size_t line_len_{0};
};
 
//==============================================================================
// HANDLER CONFIGURATION
//==============================================================================
 
struct Fdo2HandlerConfig {
    std::uint32_t line_timeout_ms{300};
    std::uint32_t measure_timeout_ms{300};
    std::uint8_t  device_index{0};
};
 
//==============================================================================
// HANDLER
//==============================================================================
 
class Fdo2Handler {
public:
    using DriverType = fdo2::Driver<HalUartFdo2Comm>;
 
    explicit Fdo2Handler(BaseUart& uart,
                         const Fdo2HandlerConfig& config = Fdo2HandlerConfig{},
                         RtosMutex* bus_mutex = nullptr) noexcept;
 
    Fdo2Handler(const Fdo2Handler&)            = delete;
    Fdo2Handler& operator=(const Fdo2Handler&) = delete;
    Fdo2Handler(Fdo2Handler&&)                 = delete;
    Fdo2Handler& operator=(Fdo2Handler&&)      = delete;
 
    bool EnsureInitialized() noexcept;
 
    [[nodiscard]] bool IsPresent() const noexcept {
        return initialized_.load(std::memory_order_acquire);
    }
 
    [[nodiscard]] const fdo2::VersionInfo& Identity() const noexcept {
        return identity_;
    }
 
    //==========================================================================
    // Live measurement
    //==========================================================================
 
    fdo2::DriverResult<fdo2::MoxyReading> MeasureMoxy() noexcept;
 
    fdo2::DriverResult<fdo2::MrawReading> MeasureMraw() noexcept;
 
    fdo2::DriverResult<fdo2::VersionInfo> ReadVersion() noexcept;
 
    fdo2::DriverResult<std::uint64_t>     ReadUniqueId() noexcept;
 
private:
    bool EnsureInitializedLocked() noexcept;
 
    Fdo2HandlerConfig          config_;
    HalUartFdo2Comm            comm_;
    std::unique_ptr<DriverType> driver_;
 
    fdo2::VersionInfo          identity_{};
 
    std::atomic<bool>          initialized_{false};
 
    RtosMutex                  private_mutex_;
    RtosMutex*                 bus_mutex_;
};
 
#endif  // COMPONENT_HANDLER_FDO2_HANDLER_H_