m5::unit::UnitINA226_1A Class Reference

UnitINA226_1A unit. More...

#include <unit_INA226.hpp>

Inheritance diagram for m5::unit::UnitINA226_1A:

Public Member Functions
	UnitINA226_1A (const float curLSB=0.0f)
Public Member Functions inherited from m5::unit::UnitINA226
virtual bool	begin () override
virtual void	update (const bool force=false) override
bool	readAlertOccurred (bool &alert)
	Read the alert occurred?
bool	powerDown ()
	Power down.
bool	softReset (const bool all=false)
	Software reset.
config_t	config ()
	Gets the configration.
void	config (const config_t &cfg)
	Set the configration.
float	shuntResistor () const
	Gets the maximum current (A)
float	maximumCurrent () const
	Gets the maximum current (A)
float	currentLSB () const
	Gets the current LSB.
float	shuntVoltage () const
	Oldest shunt voltage (mV)
float	voltage () const
	Oldest Bus voltage (mV)
float	power () const
	Oldest power (mW)
float	current () const
	Oldest current (mA)
bool	startPeriodicMeasurement (const bool current=true, const bool voltage=true, const bool power=true)
	Start periodic measurement in the current settings.
bool	startPeriodicMeasurement (const ina226::Sampling rate, const ina226::ConversionTime sct, const ina226::ConversionTime bct, const bool current=true, const bool voltage=true, const bool power=true)
	Start periodic measurement.
bool	stopPeriodicMeasurement ()
	Stop periodic measurement.
bool	measureSingleshot (ina226::Data &data, const bool current=true, const bool voltage=true, const bool power=true)
	Measurement single shot.
bool	measureSingleshot (ina226::Data &data, const ina226::Sampling rate, const ina226::ConversionTime sct, const ina226::ConversionTime bct, const bool current=true, const bool voltage=true, const bool power=true)
	Measurement single shot.
bool	readMode (ina226::Mode &mode)
	Read the operation mode.
bool	readSamplingRate (ina226::Sampling &rate)
	Read the sampling rate.
bool	writeSamplingRate (const ina226::Sampling rate)
	Write the sampling rate.
bool	readBusVoltageConversionTime (ina226::ConversionTime &ct)
	Read the convsrsion time of Bus voltage.
bool	writeBusVoltageConversionTime (const ina226::ConversionTime ct)
	Write the convsrsion time of Bus voltage @paramct Conversion time.
bool	readShuntVoltageConversionTime (ina226::ConversionTime &ct)
	Read the convsrsion time of Shunt voltage.
bool	writeShuntVoltageConversionTime (const ina226::ConversionTime ct)
	Write the convsrsion time of Shunt voltage @paramct Conversion time.
bool	readCalibration (uint16_t &cal)
	Read the calibration value.
bool	writeCalibration (const uint16_t cal)
	Write the calibration value.
bool	readAlert (ina226::Alert &type)
	Read the alert type.
bool	writeAlert (const ina226::Alert type, const uint16_t limit, const bool latch=true)
	Write the alert type and limit value.
bool	readAlertLimit (uint16_t &limit)
	Read the alerm limit value.
bool	writeAlertLimit (const uint16_t limit)
	Write the alerm limit value.

Additional Inherited Members
Protected Member Functions inherited from m5::unit::UnitINA226
	UnitINA226 (const float shuntRes, const float maxCurA, const float curLSB, const uint8_t addr=DEFAULT_ADDRESS)
	Constructor.
bool	start_periodic_measurement (const bool current, const bool voltage, const bool power)
bool	start_periodic_measurement (const ina226::Sampling rate, const ina226::ConversionTime sct, const ina226::ConversionTime bct, const bool current, const bool voltage, const bool power)
bool	stop_periodic_measurement ()
bool	write_mode (const ina226::Mode mode)
bool	read_configuration (uint16_t &v)
bool	write_configuration (const uint16_t v)
bool	read_mask (uint16_t &m)
bool	write_mask (const uint16_t m)
bool	is_data_ready ()
bool	read_measurement (ina226::Data &d)
	M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER (UnitINA226, ina226::Data)

Detailed Description

UnitINA226_1A unit.

Constructor & Destructor Documentation

UnitINA226_1A()

m5::unit::UnitINA226_1A::UnitINA226_1A ( const float curLSB = 0.0f )

inlineexplicit

Parameters

curLSB

currentLSB (calculated and set internally if zero)