Bmp581Handler.h

Go to the documentation of this file.

 
#ifndef COMPONENT_HANDLER_BMP581_HANDLER_H_
#define COMPONENT_HANDLER_BMP581_HANDLER_H_
 
#include <atomic>
#include <cstddef>
#include <cstdint>
#include <memory>
 
#include "base/BaseI2c.h"
#include "core/hf-core-drivers/external/hf-bmp581-driver/inc/bmp581.hpp"
#include "RtosMutex.h"
 
//==============================================================================
// CRTP REGISTER ADAPTER
//==============================================================================
 
class HalI2cBmp581Comm : public bmp581::BusInterface<HalI2cBmp581Comm> {
public:
    static constexpr bmp581::Interface kInterface = bmp581::Interface::I2c;
 
    explicit HalI2cBmp581Comm(BaseI2c& i2c_device) noexcept;
 
    bool WriteRegs(std::uint8_t reg, const std::uint8_t* data, std::size_t len) noexcept;
    bool ReadRegs(std::uint8_t reg, std::uint8_t* out, std::size_t len) noexcept;
    void DelayUs(std::uint32_t us) noexcept;
    bool EnsureInitialized() noexcept;
 
private:
    BaseI2c& i2c_device_;
    std::uint8_t tx_scratch_[8]{};
    std::uint8_t rx_scratch_[8]{};
    std::uint8_t reg_scratch_{0};
};
 
//==============================================================================
// HANDLER CONFIGURATION
//==============================================================================
 
struct Bmp581HandlerConfig {
    bmp581::Config config{bmp581::BarometricReferencePreset()};
    bool soft_reset_on_init{true};
    std::uint8_t device_index{0};
};
 
//==============================================================================
// HANDLER
//==============================================================================
 
class Bmp581Handler {
public:
    using DriverType = bmp581::Driver<HalI2cBmp581Comm>;
 
    explicit Bmp581Handler(BaseI2c& i2c_device,
                           const Bmp581HandlerConfig& config = Bmp581HandlerConfig{},
                           RtosMutex* bus_mutex = nullptr) noexcept;
 
    Bmp581Handler(const Bmp581Handler&) = delete;
    Bmp581Handler& operator=(const Bmp581Handler&) = delete;
    Bmp581Handler(Bmp581Handler&&) = delete;
    Bmp581Handler& operator=(Bmp581Handler&&) = delete;
 
    bool EnsureInitialized() noexcept;
 
    [[nodiscard]] bool IsPresent() const noexcept {
        return initialized_.load(std::memory_order_acquire);
    }
 
    [[nodiscard]] std::uint8_t ChipId() const noexcept { return chip_id_; }
 
    [[nodiscard]] const bmp581::EffectiveOsr& EffectiveOsr() const noexcept { return effective_; }
 
    //==========================================================================
    // Live data
    //==========================================================================
 
    bmp581::DriverResult<bool> DataReady() noexcept;
 
    bmp581::DriverResult<bmp581::Sample> ReadSample() noexcept;
 
    bmp581::DriverResult<void> Configure(const bmp581::Config& cfg) noexcept;
 
    bmp581::DriverResult<void> Reset() noexcept;
 
    struct Counters {
        std::uint32_t samples{0};
        std::uint32_t bus_errors{0};
    };
    [[nodiscard]] Counters GetCounters() const noexcept;
 
private:
    bool EnsureInitializedLocked() noexcept;
 
    Bmp581HandlerConfig config_;
    HalI2cBmp581Comm comm_;
    std::unique_ptr<DriverType> driver_;
 
    std::uint8_t chip_id_{0};
    bmp581::EffectiveOsr effective_{};
    std::atomic<bool> initialized_{false};
 
    std::atomic<std::uint32_t> samples_{0};
    std::atomic<std::uint32_t> bus_errors_{0};
 
    RtosMutex private_mutex_;
    RtosMutex* bus_mutex_;
};
 
#endif  // COMPONENT_HANDLER_BMP581_HANDLER_H_