WeightI2C unit. More...

#include <unit_WeightI2C.hpp>

Inheritance diagram for m5::unit::UnitWeightI2C:

Classes
struct	config_t
	Settings for begin. More...

Public Member Functions
	UnitWeightI2C (const uint8_t addr=DEFAULT_ADDRESS)

virtual bool	begin () override
	Initialize the unit and apply the current configuration.

virtual void	update (const bool force=false) override
	Update the cached periodic measurement data.

bool	resetOffset ()
	Reset offset.

bool	readRawADC (int32_t &value)
	Read the Raw ADC.

Settings for begin
config_t	config ()
	Gets the configuration.

void	config (const config_t &cfg)
	Set the configuration.

Measurement data by periodic
Warning Float mode uses `weight()`, Int mode uses `iweight()`
float	weight () const
	Oldest measured weight (float)

int32_t	iweight () const
	Oldest measured weight (integer)

Periodic measurement
bool	startPeriodicMeasurement (const weighti2c::Mode mode, const uint32_t interval=80)
	Start periodic measurement.

bool	stopPeriodicMeasurement ()
	Stop periodic measurement.

Single shot measurement
bool	measureSingleshot (weighti2c::Data &data, const weighti2c::Mode mode)
	Measurement single shot.

bool	measureSingleshot (char *buf)
	Measurement single shot return as string.

Setting gap to calibration
bool	readGap (float &gap)
	Read the gap value.

bool	writeGap (const float gap, const uint32_t duration=100)
	Write the gap value.

Filter
bool	isEnabledLPFilter (bool &enabled)
	Is enabled the Low-Pass Filter?

bool	enableLPFilter (const bool enable)
	Enable the Low-Pass Filter.

bool	readAvgFilterLevel (uint8_t &level)
	Read the Averaging Filter level.

bool	writeAvgFilterLevel (const uint8_t level)
	Write the Averaging Filter level.

bool	readEmaFilterAlpha (uint8_t &alpha)
	Read the Exponential Moving Average Filter alpha.

bool	writeEmaFilterAlpha (const uint8_t alpha)
	Write the Exponential Moving Average Filter alpha.

I2C Address
Warning Changing the I2C address can disconnect the unit until the host uses the new address
bool	readI2CAddress (uint8_t &i2c_address)
	Read the I2C address.

bool	changeI2CAddress (const uint8_t i2c_address)
	Change unit I2C address.

Protected Member Functions
bool	read_register (const uint8_t reg, uint8_t *buf, const size_t len)

bool	read_register8 (const uint8_t reg, uint8_t &val)

bool	start_periodic_measurement (const weighti2c::Mode mode, const uint32_t interval)

bool	stop_periodic_measurement ()

bool	read_measurement (weighti2c::Data &d, const weighti2c::Mode m)

	M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER (UnitWeightI2C, weighti2c::Data)

Protected Attributes
weighti2c::Mode	_mode {}

std::unique_ptr< m5::container::CircularBuffer< weighti2c::Data > >	_data {}

config_t	_cfg {}

Detailed Description

WeightI2C unit.

Member Function Documentation

◆ begin()

bool m5::unit::UnitWeightI2C::begin ( )

overridevirtual

Initialize the unit and apply the current configuration.

Returns: True if successful

◆ changeI2CAddress()

bool m5::unit::UnitWeightI2C::changeI2CAddress ( const uint8_t i2c_address )

Change unit I2C address.

Parameters

i2c_address I2C address

Returns: True if successful

◆ enableLPFilter()

bool m5::unit::UnitWeightI2C::enableLPFilter ( const bool enable )

Enable the Low-Pass Filter.

Parameters

enable True:enable False:disable

Returns: True if successful

◆ isEnabledLPFilter()

bool m5::unit::UnitWeightI2C::isEnabledLPFilter ( bool & enabled )

Is enabled the Low-Pass Filter?

Parameters

[out] enabled True if enabled

Returns: True if successful

◆ iweight()

int32_t m5::unit::UnitWeightI2C::iweight ( ) const

inline

Oldest measured weight (integer)

Warning: Valid only when periodic measurement uses Int mode. Use weight() for Float mode.

◆ measureSingleshot() [1/2]

bool m5::unit::UnitWeightI2C::measureSingleshot ( char * buf )

Measurement single shot return as string.

Parameters

[out] buf string buffer

Returns: True if successful

Warning: Buffer length must be at least 16 bytes; Returns an error while periodic measurement is running

◆ measureSingleshot() [2/2]

bool m5::unit::UnitWeightI2C::measureSingleshot	(	weighti2c::Data &	data,
		const weighti2c::Mode	mode )

Measurement single shot.

Parameters

[out]	data	Measured data
	mode	Measurement mode

Warning: Returns an error while periodic measurement is running

◆ readAvgFilterLevel()

bool m5::unit::UnitWeightI2C::readAvgFilterLevel ( uint8_t & level )

Read the Averaging Filter level.

Parameters

[out] level value

Returns: True if successful

◆ readEmaFilterAlpha()

bool m5::unit::UnitWeightI2C::readEmaFilterAlpha ( uint8_t & alpha )

Read the Exponential Moving Average Filter alpha.

Parameters

[out] alpha value

Returns: True if successful

◆ readGap()

bool m5::unit::UnitWeightI2C::readGap ( float & gap )

Read the gap value.

Parameters

[out] gap Calibration gap value in device-defined weight units

Returns: True if successful

◆ readI2CAddress()

bool m5::unit::UnitWeightI2C::readI2CAddress ( uint8_t & i2c_address )

Read the I2C address.

Parameters

[out] i2c_address I2C address

Returns: True if successful

◆ readRawADC()

bool m5::unit::UnitWeightI2C::readRawADC ( int32_t & value )

Read the Raw ADC.

Parameters

[out] value Raw ADC

Returns: True if successful

◆ resetOffset()

bool m5::unit::UnitWeightI2C::resetOffset ( )

Reset offset.

Returns: True if successful

◆ startPeriodicMeasurement()

bool m5::unit::UnitWeightI2C::startPeriodicMeasurement	(	const weighti2c::Mode	mode,
		const uint32_t	interval = 80 )

inline

Start periodic measurement.

Parameters

mode	Measurement mode
interval	Measurement interval

Returns: True if successful

◆ stopPeriodicMeasurement()

bool m5::unit::UnitWeightI2C::stopPeriodicMeasurement ( )

inline

Stop periodic measurement.

Returns: True if successful

◆ update()

void m5::unit::UnitWeightI2C::update ( const bool force = false )

overridevirtual

Update the cached periodic measurement data.

Parameters

force Force the update even when the normal timing check would skip it

Reimplemented in m5::unit::UnitMiniScales.

◆ weight()

float m5::unit::UnitWeightI2C::weight ( ) const

inline

Oldest measured weight (float)

Warning: Valid only when periodic measurement uses Float mode. Use iweight() for Int mode.

◆ writeAvgFilterLevel()

bool m5::unit::UnitWeightI2C::writeAvgFilterLevel ( const uint8_t level )

Write the Averaging Filter level.

Parameters

level value

Returns: True if successful

Warning: Valid values range from 0 to 50

◆ writeEmaFilterAlpha()

bool m5::unit::UnitWeightI2C::writeEmaFilterAlpha ( const uint8_t alpha )

Write the Exponential Moving Average Filter alpha.

Parameters

alpha value

Returns: True if successful

Warning: Valid values range from 0 to 99

◆ writeGap()

bool m5::unit::UnitWeightI2C::writeGap	(	const float	gap,
		const uint32_t	duration = 100 )

Write the gap value.

Parameters

gap	Calibration gap value in device-defined weight units
duration	Max command duration(ms)

Returns: True if successful

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ begin()

◆ changeI2CAddress()

◆ enableLPFilter()

◆ isEnabledLPFilter()

◆ iweight()

◆ measureSingleshot() [1/2]

◆ measureSingleshot() [2/2]

◆ readAvgFilterLevel()

◆ readEmaFilterAlpha()

◆ readGap()

◆ readI2CAddress()

◆ readRawADC()

◆ resetOffset()

◆ startPeriodicMeasurement()

◆ stopPeriodicMeasurement()

◆ update()

◆ weight()

◆ writeAvgFilterLevel()

◆ writeEmaFilterAlpha()

◆ writeGap()