M5Unit-METER 0.0.3 git rev:c518ea3
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
m5::unit::UnitADS1113 Class Reference

ADS1113 unit. More...

#include <unit_ADS1113.hpp>

Inheritance diagram for m5::unit::UnitADS1113:
m5::unit::UnitADS111x

Public Member Functions

 UnitADS1113 (const uint8_t addr=DEFAULT_ADDRESS)
 
Configration
virtual bool writeMultiplexer (const ads111x::Mux) override
 Not support.
 
virtual bool writeGain (const ads111x::Gain) override
 Not support.
 
virtual bool writeComparatorMode (const bool) override
 Not support.
 
virtual bool writeComparatorPolarity (const bool) override
 Not support.
 
virtual bool writeLatchingComparator (const bool) override
 Not support.
 
virtual bool writeComparatorQueue (const ads111x::ComparatorQueue) override
 Not support.
 
- Public Member Functions inherited from m5::unit::UnitADS111x
 UnitADS111x (const uint8_t addr=DEFAULT_ADDRESS)
 
virtual bool begin () override
 
virtual void update (const bool force=false) override
 
bool generalReset ()
 General reset.
 
config_t config ()
 Gets the configration.
 
void config (const config_t &cfg)
 Set the configration.
 
float coefficient () const
 Coefficient value.
 
int16_t adc () const
 Oldest measured ADC.
 
bool startPeriodicMeasurement ()
 Start periodic measurement in the current settings.
 
bool startPeriodicMeasurement (const ads111x::Sampling rate, const ads111x::Mux mux, const ads111x::Gain gain, const ads111x::ComparatorQueue comp_que)
 Start periodic measurement.
 
bool stopPeriodicMeasurement ()
 Stop periodic measurement.
 
ads111x::Mux multiplexer () const
 Gets the input multiplexer.
 
ads111x::Gain gain () const
 Gets the programmable gain amplifier.
 
ads111x::Sampling samplingRate () const
 Gets the sampling rate.
 
bool comparatorMode () const
 Gets the comparator mode.
 
bool comparatorPolarity () const
 Gets the comparator polarity.
 
bool latchingComparator () const
 Gets the Latching comparator.
 
ads111x::ComparatorQueue comparatorQueue () const
 Gets the comparator queue.
 
bool writeSamplingRate (const ads111x::Sampling rate)
 Write the data rate

 
bool measureSingleshot (ads111x::Data &d, const uint32_t timeoutMillis=1000U)
 Measurement single shot.
 
bool readThreshold (int16_t &high, int16_t &low)
 Reads the threshold values.
 
bool writeThreshold (const int16_t high, const int16_t low)
 Write the threshold values.
 

Protected Member Functions

virtual bool start_periodic_measurement (const ads111x::Sampling rate, const ads111x::Mux mux, const ads111x::Gain gain, const ads111x::ComparatorQueue comp_que) override
 
- Protected Member Functions inherited from m5::unit::UnitADS111x
bool start_periodic_measurement ()
 
bool stop_periodic_measurement ()
 
bool read_adc_raw (ads111x::Data &d)
 
bool start_single_measurement ()
 
bool in_conversion ()
 
bool read_config (ads111x::Config &c)
 
bool write_config (const ads111x::Config &c)
 
void apply_interval (const ads111x::Sampling rate)
 
virtual void apply_coefficient (const ads111x::Gain gain)
 
bool write_multiplexer (const ads111x::Mux mux)
 
bool write_gain (const ads111x::Gain gain)
 
bool write_comparator_mode (const bool b)
 
bool write_comparator_polarity (const bool b)
 
bool write_latching_comparator (const bool b)
 
bool write_comparator_queue (const ads111x::ComparatorQueue c)
 
 M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER (UnitADS111x, ads111x::Data)
 

Additional Inherited Members

- Protected Attributes inherited from m5::unit::UnitADS111x
std::unique_ptr< m5::container::CircularBuffer< ads111x::Data > > _data {}
 
float _coefficient {}
 
ads111x::Config _ads_cfg {}
 
config_t _cfg {}
 

Detailed Description

ADS1113 unit.

Member Function Documentation

◆ start_periodic_measurement()

bool m5::unit::UnitADS1113::start_periodic_measurement ( const ads111x::Sampling rate,
const ads111x::Mux mux,
const ads111x::Gain gain,
const ads111x::ComparatorQueue comp_que )
overrideprotectedvirtual

Implements m5::unit::UnitADS111x.

◆ writeComparatorMode()

virtual bool m5::unit::UnitADS1113::writeComparatorMode ( const bool )
inlineoverridevirtual

Not support.

Warning
Not support

Implements m5::unit::UnitADS111x.

◆ writeComparatorPolarity()

virtual bool m5::unit::UnitADS1113::writeComparatorPolarity ( const bool )
inlineoverridevirtual

Not support.

Warning
Not support

Implements m5::unit::UnitADS111x.

◆ writeComparatorQueue()

virtual bool m5::unit::UnitADS1113::writeComparatorQueue ( const ads111x::ComparatorQueue )
inlineoverridevirtual

Not support.

Warning
Not support

Implements m5::unit::UnitADS111x.

◆ writeGain()

virtual bool m5::unit::UnitADS1113::writeGain ( const ads111x::Gain )
inlineoverridevirtual

Not support.

Warning
Not support

Implements m5::unit::UnitADS111x.

◆ writeLatchingComparator()

virtual bool m5::unit::UnitADS1113::writeLatchingComparator ( const bool )
inlineoverridevirtual

Not support.

Warning
Not support

Implements m5::unit::UnitADS111x.

◆ writeMultiplexer()

virtual bool m5::unit::UnitADS1113::writeMultiplexer ( const ads111x::Mux )
inlineoverridevirtual

Not support.

Warning
Not support

Implements m5::unit::UnitADS111x.