unit_SPA06.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_ENV_UNIT_SPA06_HPP
#define M5_UNIT_ENV_UNIT_SPA06_HPP
 
#include <M5UnitComponent.hpp>
#include <m5_utility/container/circular_buffer.hpp>
#include <memory>
#include "unit_SPA06_data.hpp"
 
namespace m5 {
namespace unit {
 
class UnitSPA06 : public Component, public PeriodicMeasurementAdapter<UnitSPA06, spa06::Data> {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitSPA06, 0x76);
 
public:
    struct config_t {
        bool start_periodic{true};
        spa06::Oversampling pressure_oversampling{spa06::Oversampling::X16};
        spa06::Oversampling temperature_oversampling{spa06::Oversampling::X1};
        spa06::Rate rate{spa06::Rate::Rate16};
        spa06::Mode mode{spa06::Mode::PressureAndTemperature};
    };
 
    explicit UnitSPA06(const uint8_t addr = DEFAULT_ADDRESS);
    virtual ~UnitSPA06()
    {
    }
 
    virtual bool begin() override;
    virtual void update(const bool force = false) override;
 
    config_t config() const
    {
        return _cfg;
    }
    void config(const config_t& cfg)
    {
        _cfg = cfg;
    }
 
    bool softReset();
 
 
    bool startPeriodicMeasurement(const spa06::Mode mode, const spa06::Oversampling pressure_oversampling,
                                  const spa06::Oversampling temperature_oversampling, const spa06::Rate rate);
    bool startPeriodicMeasurement();
    bool stopPeriodicMeasurement();
 
    float pressure() const;
    float temperature() const;
    float altitude(const float sea_level_pa = 101325.0f) const;
    float relativeAltitude() const;
    void setAltitudeReference();
    [[deprecated("Use setAltitudeReference() instead")]] void setReference()
    {
        setAltitudeReference();
    }
 
 
    bool measureSingleshot(spa06::Data& d, const spa06::Oversampling pressure_oversampling = spa06::Oversampling::X16,
                           const spa06::Oversampling temperature_oversampling = spa06::Oversampling::X1);
 
 
    bool readOversampling(spa06::Oversampling& pressure_oversampling, spa06::Oversampling& temperature_oversampling);
    bool writeOversampling(const spa06::Oversampling pressure_oversampling,
                           const spa06::Oversampling temperature_oversampling);
    bool writeOversamplingPressure(const spa06::Oversampling pressure_oversampling);
    bool writeOversamplingTemperature(const spa06::Oversampling temperature_oversampling);
    bool readRate(spa06::Rate& rate);
    bool writeRate(const spa06::Rate rate);
 
protected:
    bool start_periodic_measurement(const spa06::Mode mode, const spa06::Oversampling pressure_oversampling,
                                    const spa06::Oversampling temperature_oversampling, const spa06::Rate rate);
    bool start_periodic_measurement();
    bool seed_temperature();
    bool stop_periodic_measurement();
    bool read_measurement(spa06::Data& d);
    bool measure_singleshot(spa06::Data& d);
    bool read_coefficients();
 
    M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER(UnitSPA06, spa06::Data);
 
private:
    config_t _cfg{};
    spa06::coeffs_t _coeffs{};
    float _kp{};  // Set by start_periodic_measurement() before any compensation
    float _kt{};
    int32_t _seed_tmp_raw{};  // Temperature seeded once for pressure compensation in Mode::Pressure
    uint8_t _tmp_ext{};       // MEAS_CFG TMP_EXT bit (0 or 0x08) matched to TMP_COEF_SRCE, OR'd into mode writes
    float _altitude_reference_pa{101325.0f};
    uint32_t _pushed{}, _consumed{};
    std::unique_ptr<m5::container::CircularBuffer<spa06::Data>> _data{};
};
 
namespace spa06 {
constexpr uint32_t DEFAULT_STORED_SIZE{4};
 
namespace command {
constexpr uint8_t REG_PSR_B2{0x00};    // burst start: PSR(3) + TMP(3) = 6 bytes
constexpr uint8_t REG_TMP_B2{0x03};    // TMP(3) start (0x03..0x05)
constexpr uint8_t REG_PRS_CFG{0x06};   // PM_RATE[7:4] PM_PRC[3:0]
constexpr uint8_t REG_TMP_CFG{0x07};   // TMP_RATE[7:4] TM_PRC[3:0]
constexpr uint8_t REG_MEAS_CFG{0x08};  // bit7 COEF_RDY, bit6 SENSOR_RDY, bit5 TMP_RDY, bit4 PRS_RDY
constexpr uint8_t REG_CFG_REG{0x09};   // bit3 TMP_SHIFT_EN, bit2 PRS_SHIFT_EN
constexpr uint8_t REG_RESET{0x0C};
constexpr uint8_t REG_ID{0x0D};
constexpr uint8_t REG_COEF{0x10};       // 0x10..0x24 (21 bytes)
constexpr uint8_t REG_COEF_SRCE{0x28};  // bit7 TMP_COEF_SRCE (0 internal / 1 external temperature sensor)
}  // namespace command
}  // namespace spa06
 
}  // namespace unit
}  // namespace m5
#endif