unit_ADS1100.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_ANADIG_UNIT_ADS1100_HPP
#define M5_UNIT_ANADIG_UNIT_ADS1100_HPP
#include "unit_ADS11xx.hpp"
 
namespace m5 {
namespace unit {
namespace ads1100 {
enum class Sampling : uint8_t {
    Rate128,  
    Rate32,   
    Rate16,   
    Rate8     
};
 
using PGA  = m5::unit::ads11xx::PGA;
using Data = m5::unit::ads11xx::Data;
 
}  // namespace ads1100
 
class UnitADS1100 : public UnitADS11XX {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitADS1100, 0x48);
 
public:
    struct config_t {
        bool start_periodic{true};
        ads1100::Sampling sampling_rate{ads1100::Sampling::Rate32};
        ads1100::PGA pga{ads1100::PGA::Gain1};
        float vdd{3300.f};
        float factor{0.25f};
    };
 
    explicit UnitADS1100(const float vdd = 3300.f, const float factor = 0.25f, const uint8_t addr = DEFAULT_ADDRESS)
        : UnitADS11XX(addr)
    {
        _cfg.vdd    = vdd;
        _cfg.factor = _factor = factor;
    }
    virtual ~UnitADS1100()
    {
    }
 
    virtual bool begin() override;
 
 
    inline config_t config()
    {
        return _cfg;
    }
    inline void config(const config_t& cfg)
    {
        _cfg = cfg;
    }
 
 
    bool readSamplingRate(ads1100::Sampling& rate);
    bool writeSamplingRate(const ads1100::Sampling rate);
 
 
    inline bool startPeriodicMeasurement(const ads1100::Sampling rate, const ads1100::PGA pga)
    {
        return start_periodic_measurement(rate, pga);
    }
    inline bool startPeriodicMeasurement()
    {
        return UnitADS11XX::startPeriodicMeasurement();
    }
    inline bool stopPeriodicMeasurement()
    {
        return UnitADS11XX::stopPeriodicMeasurement();
    }
 
 
    bool measureSingleshot(ads1100::Data& data, const ads1100::Sampling rate, const ads1100::PGA pga);
    inline bool measureSingleshot(ads1100::Data& data)
    {
        return UnitADS11XX::measure_singleshot(data);
    }
 
    virtual bool generalReset() override;
 
protected:
    bool start_periodic_measurement(const ads1100::Sampling rate, const ads1100::PGA pga);
    virtual bool read_if_ready_in_periodic(uint8_t v[2]) override;
    virtual uint32_t get_interval(const uint8_t rate) override;
 
private:
    config_t _cfg{};
};
 
}  // namespace unit
}  // namespace m5
#endif