unit_MAX30100.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_HEART_UNIT_MAX30100_HPP
#define M5_UNIT_HEART_UNIT_MAX30100_HPP
 
#include <M5UnitComponent.hpp>
#include <m5_utility/stl/extension.hpp>
#include <m5_utility/container/circular_buffer.hpp>
#include <limits>  // NaN
 
namespace m5 {
namespace unit {
namespace max30100 {
enum class Mode : uint8_t {
    None,           
    HROnly = 0x02,  
    SpO2,           
};
 
enum class Sampling : uint8_t {
    Rate50,    
    Rate100,   
    Rate167,   
    Rate200,   
    Rate400,   
    Rate600,   
    Rate800,   
    Rate1000,  
};
 
enum class LEDPulse : uint8_t {
    Width200,   
    Width400,   
    Width800,   
    Width1600,  
};
 
enum class LED : uint8_t {
    Current0_0,   
    Current4_4,   
    Current7_6,   
    Current11_0,  
    Current14_2,  
    Current17_4,  
    Current20_8,  
    Current24_0,  
    Current27_1,  
    Current30_6,  
    Current33_8,  
    Current37_0,  
    Current40_2,  
    Current43_6,  
    Current46_8,  
    Current50_0,  
};
 
constexpr uint8_t MAX_FIFO_DEPTH{16};  
 
struct Data {
    std::array<uint8_t, 4> raw{};  // [0...1]:IR [2...3]:Red
    inline uint16_t ir() const
    {
        return m5::types::big_uint16_t(raw[0], raw[1]).get();
    }
    inline uint16_t red() const
    {
        return m5::types::big_uint16_t(raw[2], raw[3]).get();
    }
};
 
struct TemperatureData {
    std::array<uint8_t, 2> raw{0xFF, 0xFF};  // [0]:integer [1]:fraction
    inline float temperature() const
    {
        return celsius();
    }
    inline float celsius() const
    {
        return (raw[0] != 0xFF) ? (int8_t)raw[0] + raw[1] * 0.0625f : std::numeric_limits<float>::quiet_NaN();
    }
    inline float fahrenheit() const
    {
        return celsius() * 9.0f / 5.0f + 32.f;
    }
};
 
namespace command {
// STATUS
constexpr uint8_t READ_INTERRUPT_STATUS{0x00};
constexpr uint8_t INTERRUPT_ENABLE{0x01};
// FIFO
constexpr uint8_t FIFO_WRITE_POINTER{0x02};
constexpr uint8_t FIFO_OVERFLOW_COUNTER{0x03};
constexpr uint8_t FIFO_READ_POINTER{0x04};
constexpr uint8_t FIFO_DATA_REGISTER{0x05};
// CONFIGURATION
constexpr uint8_t MODE_CONFIGURATION{0x06};
constexpr uint8_t SPO2_CONFIGURATION{0x07};
constexpr uint8_t LED_CONFIGURATION{0x09};
// TEMPERATURE
constexpr uint8_t TEMP_INTEGER{0x16};
constexpr uint8_t TEMP_FRACTION{0x17};
// PART ID
constexpr uint8_t READ_REVISION_ID{0xFE};
constexpr uint8_t READ_PART_ID{0xFF};
 
}  // namespace command
 
struct SpO2Configuration;
 
}  // namespace max30100
 
class UnitMAX30100 : public Component, public PeriodicMeasurementAdapter<UnitMAX30100, max30100::Data> {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitMAX30100, 0x57);
 
public:
    struct config_t {
        bool start_periodic{true};
        max30100::Mode mode{max30100::Mode::SpO2};
        max30100::Sampling rate{max30100::Sampling::Rate100};
        max30100::LEDPulse width{max30100::LEDPulse::Width1600};
        m5::unit::max30100::LED ir_current{max30100::LED::Current27_1};
        bool high_resolution{true};
        m5::unit::max30100::LED red_current{max30100::LED::Current27_1};
    };
 
    explicit UnitMAX30100(const uint8_t addr = DEFAULT_ADDRESS)
        : Component(addr), _data{new m5::container::CircularBuffer<max30100::Data>(max30100::MAX_FIFO_DEPTH)}
    {
        auto ccfg        = component_config();
        ccfg.clock       = 400 * 1000U;
        ccfg.stored_size = max30100::MAX_FIFO_DEPTH;
        component_config(ccfg);
    }
    virtual ~UnitMAX30100()
    {
    }
 
    virtual bool begin() override;
    virtual void update(const bool force = false) override;
 
 
    inline config_t config()
    {
        return _cfg;
    }
    inline void config(const config_t& cfg)
    {
        _cfg = cfg;
    }
 
    inline uint16_t ir() const
    {
        return !empty() ? oldest().ir() : 0;
    }
    inline uint16_t red() const
    {
        return !empty() ? oldest().red() : 0;
    }
    inline uint8_t retrived() const
    {
        return _retrived;
    }
    inline uint8_t overflow() const
    {
        return _overflow;
    }
 
    uint32_t caluculateSamplingRate();
 
 
    inline bool startPeriodicMeasurement()
    {
        return PeriodicMeasurementAdapter<UnitMAX30100, max30100::Data>::startPeriodicMeasurement();
    }
    inline bool startPeriodicMeasurement(const max30100::Mode mode, const max30100::Sampling rate,
                                         const max30100::LEDPulse width, const max30100::LED ir_current,
                                         const bool high_resolution      = false,
                                         const max30100::LED red_current = max30100::LED::Current0_0)
    {
        return PeriodicMeasurementAdapter<UnitMAX30100, max30100::Data>::startPeriodicMeasurement(
            mode, rate, width, ir_current, high_resolution, red_current);
    }
    inline bool stopPeriodicMeasurement()
    {
        return PeriodicMeasurementAdapter<UnitMAX30100, max30100::Data>::stopPeriodicMeasurement();
    }
 
 
    bool readMode(max30100::Mode& mode);
    bool writeMode(const max30100::Mode mode);
    bool readShutdownControl(bool& shdn);
    bool writeShutdownControl(const bool shdn);
 
 
    bool readSpO2Configuration(bool& resolution, max30100::Sampling& rate, max30100::LEDPulse& width);
    bool writeSpO2Configuration(const bool resolution, const max30100::Sampling rate, const max30100::LEDPulse width);
 
    inline bool readSpO2HighResolution(bool& enabled)
    {
        max30100::Sampling rate{};
        max30100::LEDPulse width{};
        return readSpO2Configuration(enabled, rate, width);
    }
    bool writeSpO2HighResolution(const bool enabled);
    inline bool writeSpO2HighResolutionEnable()
    {
        return writeSpO2HighResolution(true);
    }
    inline bool writeSpO2HighResolutionDisable()
    {
        return writeSpO2HighResolution(false);
    }
    inline bool readSpO2SamplingRate(max30100::Sampling& rate)
    {
        bool enabled{};
        max30100::LEDPulse width{};
        return readSpO2Configuration(enabled, rate, width);
    }
    bool writeSpO2SamplingRate(const max30100::Sampling rate);
    inline bool readSpO2LEDPulseWidth(max30100::LEDPulse& width)
    {
        bool enabled{};
        max30100::Sampling rate{};
        return readSpO2Configuration(enabled, rate, width);
    }
    bool writeSpO2LEDPulseWidth(const max30100::LEDPulse width);
 
    // @warning and only the IR LED is used to capture optical data and determine the heart rate
 
    bool readLEDCurrent(max30100::LED& ir_current, max30100::LED& red_current);
    bool writeLEDCurrent(const max30100::LED ir_current, const max30100::LED red_current);
 
 
    bool measureTemperatureSingleshot(max30100::TemperatureData& td);
 
    inline bool readFIFOReadPointer(uint8_t& rptr)
    {
        rptr = 0xFF;
        return read_register8(max30100::command::FIFO_READ_POINTER, rptr);
    }
    inline bool writeFIFOReadPointer(const uint8_t rptr)
    {
        return writeRegister8(max30100::command::FIFO_READ_POINTER, rptr);
    }
    inline bool readFIFOWritePointer(uint8_t& wptr)
    {
        wptr = 0xFF;
        return read_register8(max30100::command::FIFO_WRITE_POINTER, wptr);
    }
    inline bool writeFIFOWritePointer(const uint8_t wptr)
    {
        return writeRegister8(max30100::command::FIFO_WRITE_POINTER, wptr);
    }
    inline bool readFIFOOverflowCounter(uint8_t& cnt)
    {
        cnt = 0xFF;
        return read_register8(max30100::command::FIFO_OVERFLOW_COUNTER, cnt);
    }
    inline bool writeFIFOOverflowCounter(const uint8_t cnt)
    {
        return writeRegister8(max30100::command::FIFO_OVERFLOW_COUNTER, cnt);
    }
    bool resetFIFO();
 
    bool reset();
 
    bool readRevisionID(uint8_t& rev);
 
protected:
    bool read_register(const uint8_t reg, uint8_t* buf, const size_t len);
    bool read_register8(const uint8_t reg, uint8_t& v);
 
    bool start_periodic_measurement();
    bool start_periodic_measurement(const max30100::Mode mode, const max30100::Sampling rate,
                                    const max30100::LEDPulse width, const max30100::LED ir_current,
                                    const bool resolution, const max30100::LED red_current);
    bool stop_periodic_measurement();
 
    bool read_FIFO();
    bool read_measurement_temperature(max30100::TemperatureData& td);
 
    bool write_spo2_configuration(const max30100::SpO2Configuration& sc);
 
    M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER(UnitMAX30100, max30100::Data);
 
protected:
    max30100::Mode _mode{max30100::Mode::None};
    uint8_t _retrived{}, _overflow{};
    std::unique_ptr<m5::container::CircularBuffer<max30100::Data>> _data{};
 
    config_t _cfg{};
};
 
}  // namespace unit
}  // namespace m5
 
#endif