#include "ina234.h"

Functions
Status	INA234_init (INA234 self, uint8_t I2C_ADDR, I2C_HandleTypeDef hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode)
	Initialize the INA234 with the given config.

Status	INA234_alert_init (INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit)
	Initialize the alert functionality of INA234 with the given configurations.

Status	__INA234_readTwoBytes (INA234 *self, uint8_t MemAddress)
	Read two bytes (a 16bit register) from INA234 and stores in the ina234::_reg::raw_data.

Status	__INA234_writeTwoBytes (INA234 *self, uint8_t MemAddress)
	Write two bytes (a 16bit register) to INA234 from the ina234::_reg::raw_data.

Status	INA234_setADCRange (INA234 *self, ADCRange adc_range)
	Set the ADC full scale range of INA234.

Status	INA234_setNumberOfADCSamples (INA234 *self, NumSamples numer_of_adc_samples)
	Set the number of ADC samples to calculate the average.

Status	INA234_setVBusConversionTime (INA234 *self, ConvTime vbus_conversion_time)
	Set the VBus convertion period.

Status	INA234_setVShuntConversionTime (INA234 *self, ConvTime vshunt_conversion_time)
	Set the VShunt convertion period.

Status	INA234_setMode (INA234 *self, Mode mode)
	Set the operating mode.

ADCRange	INA234_getADCRange (INA234 *self)
	Get the ADC full scale range of INA234.

NumSamples	INA234_getNumberOfADCSamples (INA234 *self)
	Get the number of ADC samples to calculate the average.

ConvTime	INA234_getVBusConversionTime (INA234 *self)
	Get the VBus convertion period.

ConvTime	INA234_getVShuntConversionTime (INA234 *self)
	Get the VShunt convertion period.

Mode	INA234_getMode (INA234 *self)
	Set the operating mode.

void	INA234_SoftResetAll (INA234 *self)
	Send a reset command to all of the INA234s on the bus.

uint16_t	INA234_getManID (INA234 *self)
	Get the manufacturer ID.

uint16_t	INA234_getDevID (INA234 *self)
	Get the device ID.

void	INA234_readAll (INA234 *self)
	Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the values to the ina234 object (struct) variables. Then you can read variables: ina234::ShuntVoltage, ina234::BusVoltage, ina234::Power, and ina234::Current.

float	INA234_getCurrent (INA234 *self)
	Read the current from INA234.

float	INA234_getBusVoltage (INA234 *self)
	Read the bus voltage from INA234.

float	INA234_getShuntVoltage (INA234 *self)
	Read the shunt voltage from INA234.

float	INA234_getPower (INA234 *self)
	Read the power from INA234.

uint8_t	INA234_isDataReady (INA234 *self)
	Check if the conversion is done or not. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

AlertSource	INA234_getAlertSource (INA234 *self)
	Get the alert source. This function is usefull when you enabled both of the alert functions and data ready alert simultaneously. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

ErrorType	INA234_getErrors (INA234 *self)
	Get the error flags of INA234. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

Status	INA234_resetAlert (INA234 *self)
	Reset the alert pin. This function is useful when set the alert pin to latch mode.

Function Documentation

◆ __INA234_readTwoBytes()

Status __INA234_readTwoBytes	(	INA234 *	self,
		uint8_t	MemAddress )

Read two bytes (a 16bit register) from INA234 and stores in the ina234::_reg::raw_data.

Parameters

self	A pointer to the ina234 object (struct)
MemAddress	Address of the register

Returns: Ths status of reading

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ __INA234_writeTwoBytes()

Status __INA234_writeTwoBytes	(	INA234 *	self,
		uint8_t	MemAddress )

Write two bytes (a 16bit register) to INA234 from the ina234::_reg::raw_data.

Parameters

self	A pointer to the ina234 object (struct)
MemAddress	Address of the register

Returns: Ths status of writing

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_alert_init()

Status INA234_alert_init	(	INA234 *	self,
		AlertOn	alert_on,
		AlertPolarity	alert_polarity,
		AlertLatch	alert_latch,
		AlertConvReady	alert_conv_ready,
		float	alert_limit )

Initialize the alert functionality of INA234 with the given configurations.

Parameters

self	A pointer to the ina234 object (struct)
alert_on	determines the event that you want to assert the alert: ALERT_SHUNT_OVER_LIMIT over voltage of the shunt voltage ALERT_SHUNT_UNDER_LIMIT under voltage of the shunt voltage ALERT_BUS_OVER_LIMIT over voltage of the bus voltage ALERT_BUS_UNDER_LIMIT under voltage of the bus voltage ALERT_POWER_OVER_LIMIT over power ALERT_NONE disable the alert for events
alert_polarity	The alert polarity determines the polarity of alert assertion: ALERT_ACTIVE_LOW Alert pin goes low on alert ALERT_ACTIVE_HIGH Alert pin goes HiZ on alert (alert pin is open-drain so you have to add a pull-up resistor to get high state)
alert_latch	Determine the alert pin behaviour. If the latch is enabled, you have to reset the pin by calling the INA234_resetAlert() function. ALERT_TRANSPARENT for normal behaviour ALERT_LATCHED for latched behaviour
alert_conv_ready	Shows if you want to get alert on "conversion done"/"data ready" too or not. If enabled, you have to distinguish the alert sourece by calling INA234_getAlertSource() function. ALERT_CONV_ENABLE assert the alert pin on data ready event ALERT_CONV_DISABLE disable the data ready assertion
alert_limit	This the limit value. It automatically maps to the alert function you have chosen. The unit of this limit is related to the alert_on argument: for ALERT_SHUNT_OVER_LIMIT or ALERT_SHUNT_UNDER_LIMIT : mili Volts for ALERT_BUS_OVER_LIMIT or ALERT_BUS_UNDER_LIMIT : Volts for ALERT_POWER_OVER_LIMIT : Watt

For example if the alert_limit was 10.4 and you give ALERT_SHUNT_OVER_LIMIT for the alert_on argument, it means you will get alert if the shunt voltage reaches over the 10.4mV. If you give ALERT_BUS_OVER_LIMIT to alert_on, it means you will get alert if the bus voltage reaches the 10.4V

Returns: Ths status of initialization

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_getADCRange()

ADCRange INA234_getADCRange ( INA234 * self )

Get the ADC full scale range of INA234.

Parameters

self	A pointer to the ina234 object (struct)

Returns: The full scale range of ADC.

Return values

RANGE_81_92mV	for 81.92 mV
RANGE_20_48mV	for 20.48 mV

◆ INA234_getAlertSource()

AlertSource INA234_getAlertSource ( INA234 * self )

Get the alert source. This function is usefull when you enabled both of the alert functions and data ready alert simultaneously. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

Parameters

self	A pointer to the ina234 object (struct)

Returns: The alert source

Return values

ALERT_DATA_READY	The alert source is convertion ready
ALERT_LIMIT_REACHED	The alert source is limit reach

◆ INA234_getBusVoltage()

float INA234_getBusVoltage ( INA234 * self )

Read the bus voltage from INA234.

Parameters

self	A pointer to the ina234 object (struct)

Returns: a float value in Volts representing the bus voltage

◆ INA234_getCurrent()

float INA234_getCurrent ( INA234 * self )

Read the current from INA234.

Parameters

self	A pointer to the ina234 object (struct)

Returns: a float value in Amps representing the current

◆ INA234_getDevID()

uint16_t INA234_getDevID ( INA234 * self )

Get the device ID.

Parameters

self	A pointer to the ina234 object (struct)

Returns: a 12bit device ID

◆ INA234_getErrors()

ErrorType INA234_getErrors ( INA234 * self )

Get the error flags of INA234. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

Parameters

self	A pointer to the ina234 object (struct)

Returns: Error type

Return values

ERROR_NONE	No error
ERROR_MEMORY	Memory error (CRC or ECC)
ERROR_OVF	Math overflow error
ERROR_BOTH_MEMORY_OVF	Both memory error (CRC or ECC) and math overflow error

◆ INA234_getManID()

uint16_t INA234_getManID ( INA234 * self )

Get the manufacturer ID.

Parameters

self	A pointer to the ina234 object (struct)

Returns: a 16bit manufacturer ID

◆ INA234_getMode()

Mode INA234_getMode ( INA234 * self )

Set the operating mode.

Parameters

self	A pointer to the ina234 object (struct)

Returns: Operating mode

Return values

MODE_SHUTDOWN	shutdown mode
MODE_SINGLESHOT_SUNT	only measure the shunt voltage once
MODE_SINGLESHOT_BUS	only measure the bus voltage once
MODE_SINGLESHOT_BOTH_SHUNT_BUS	measure the bus and shunt voltage once
MODE_CONTINUOUS_SHUNT	only measure the shunt voltage continuously
MODE_CONTINUOUS_BUS	only measure the bus voltage continuously
MODE_CONTINUOUS_BOTH_SHUNT_BUS	measure the bus and shunt voltage continuously

◆ INA234_getNumberOfADCSamples()

NumSamples INA234_getNumberOfADCSamples ( INA234 * self )

Get the number of ADC samples to calculate the average.

Parameters

self	A pointer to the ina234 object (struct)

Returns: Numer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency.

Return values

NADC_1	for one sample (no average)
NADC_4	4 samples
NADC_16	16 samples
NADC_64	64 samples
NADC_128	128 samples
NADC_256	256 samples
NADC_512	512 samples
NADC_1024	1024 samples

◆ INA234_getPower()

float INA234_getPower ( INA234 * self )

Read the power from INA234.

Parameters

self	A pointer to the ina234 object (struct)

Returns: a float value in Watt representing the power

◆ INA234_getShuntVoltage()

float INA234_getShuntVoltage ( INA234 * self )

Read the shunt voltage from INA234.

Parameters

self	A pointer to the ina234 object (struct)

Returns: a float value in miliVolts representing the shunt voltage

◆ INA234_getVBusConversionTime()

ConvTime INA234_getVBusConversionTime ( INA234 * self )

Get the VBus convertion period.

Parameters

self	A pointer to the ina234 object (struct)

Returns: The conversion time of VBus measurment.

Return values

CTIME_140us
CTIME_204us
CTIME_332us
CTIME_588us
CTIME_1100us
CTIME_2116us
CTIME_4156us
CTIME_8244us

◆ INA234_getVShuntConversionTime()

ConvTime INA234_getVShuntConversionTime ( INA234 * self )

Get the VShunt convertion period.

Parameters

self	A pointer to the ina234 object (struct)

Returns: The conversion time of VShunt measurment.

Return values

CTIME_140us
CTIME_204us
CTIME_332us
CTIME_588us
CTIME_1100us
CTIME_2116us
CTIME_4156us
CTIME_8244us

◆ INA234_init()

Status INA234_init	(	INA234 *	self,
		uint8_t	I2C_ADDR,
		I2C_HandleTypeDef *	hi2c,
		float	ShuntResistor,
		ADCRange	adc_range,
		NumSamples	numer_of_adc_samples,
		ConvTime	vbus_conversion_time,
		ConvTime	vshunt_conversion_time,
		Mode	mode )

Initialize the INA234 with the given config.

Parameters

self	A pointer to the ina234 object (struct)
I2C_ADDR	The I2C address of the INA234. It depends on the state of A0 pin of the chip.
hi2c	A pointer to the I2C handler that is connected to INA234
ShuntResistor	The resistance of your shunt resistor (in mOhm) connected to IN+ and IN- of the INA234
adc_range	The full scale range of ADC. It can be one of these values: RANGE_81_92mV for 81.92 mV RANGE_20_48mV for 20.48 mV
numer_of_adc_samples	Numer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency. NADC_1 for one sample (no average) NADC_4 4 samples NADC_16 16 samples NADC_64 64 samples NADC_128 128 samples NADC_256 256 samples NADC_512 512 samples NADC_1024 1024 samples
vbus_conversion_time	The conversion time of VBus measurment. CTIME_140us CTIME_204us CTIME_332us CTIME_588us CTIME_1100us CTIME_2116us CTIME_4156us CTIME_8244us
vshunt_conversion_time	The conversion time of VShunt measurment. CTIME_140us CTIME_204us CTIME_332us CTIME_588us CTIME_1100us CTIME_2116us CTIME_4156us CTIME_8244us
mode	Operating mode: MODE_SHUTDOWN shutdown mode MODE_SINGLESHOT_SUNT only measure the shunt voltage once MODE_SINGLESHOT_BUS only measure the bus voltage once MODE_SINGLESHOT_BOTH_SHUNT_BUS measure the bus and shunt voltage once MODE_CONTINUOUS_SHUNT only measure the shunt voltage continuously MODE_CONTINUOUS_BUS only measure the bus voltage continuously MODE_CONTINUOUS_BOTH_SHUNT_BUS measure the bus and shunt voltage continuously

Returns: Ths status of initialization

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_isDataReady()

uint8_t INA234_isDataReady ( INA234 * self )

Check if the conversion is done or not. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

Parameters

self	A pointer to the ina234 object (struct)

Return values

True
False

◆ INA234_readAll()

void INA234_readAll ( INA234 * self )

Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the values to the ina234 object (struct) variables. Then you can read variables: ina234::ShuntVoltage, ina234::BusVoltage, ina234::Power, and ina234::Current.

Parameters

self	A pointer to the ina234 object (struct)

◆ INA234_resetAlert()

Status INA234_resetAlert ( INA234 * self )

Reset the alert pin. This function is useful when set the alert pin to latch mode.

Parameters

self	A pointer to the ina234 object (struct)

Returns: Ths status of reset

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_setADCRange()

Status INA234_setADCRange	(	INA234 *	self,
		ADCRange	adc_range )

Set the ADC full scale range of INA234.

Parameters

self	A pointer to the ina234 object (struct)
adc_range	The full scale range of ADC. It can be one of these values: RANGE_81_92mV for 81.92 mV RANGE_20_48mV for 20.48 mV

Returns: Ths status of config

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_setMode()

Status INA234_setMode	(	INA234 *	self,
		Mode	mode )

Set the operating mode.

Parameters

self A pointer to the ina234 object (struct)

mode

Operating mode:

MODE_SHUTDOWN shutdown mode
MODE_SINGLESHOT_SUNT only measure the shunt voltage once
MODE_SINGLESHOT_BUS only measure the bus voltage once
MODE_SINGLESHOT_BOTH_SHUNT_BUS measure the bus and shunt voltage once
MODE_CONTINUOUS_SHUNT only measure the shunt voltage continuously
MODE_CONTINUOUS_BUS only measure the bus voltage continuously
MODE_CONTINUOUS_BOTH_SHUNT_BUS measure the bus and shunt voltage continuously

Returns: Ths status of config

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_setNumberOfADCSamples()

Status INA234_setNumberOfADCSamples	(	INA234 *	self,
		NumSamples	numer_of_adc_samples )

Set the number of ADC samples to calculate the average.

Parameters

self	A pointer to the ina234 object (struct)
numer_of_adc_samples	Numer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency. NADC_1 for one sample (no average) NADC_4 4 samples NADC_16 16 samples NADC_64 64 samples NADC_128 128 samples NADC_256 256 samples NADC_512 512 samples NADC_1024 1024 samples

Returns: Ths status of config

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_setVBusConversionTime()

Status INA234_setVBusConversionTime	(	INA234 *	self,
		ConvTime	vbus_conversion_time )

Set the VBus convertion period.

Parameters

self	A pointer to the ina234 object (struct)
vbus_conversion_time	The conversion time of VBus measurment. CTIME_140us CTIME_204us CTIME_332us CTIME_588us CTIME_1100us CTIME_2116us CTIME_4156us CTIME_8244us

Returns: Ths status of config

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_setVShuntConversionTime()

Status INA234_setVShuntConversionTime	(	INA234 *	self,
		ConvTime	vshunt_conversion_time )

Set the VShunt convertion period.

Parameters

self	A pointer to the ina234 object (struct)
vshunt_conversion_time	The conversion time of VShunt measurment. CTIME_140us CTIME_204us CTIME_332us CTIME_588us CTIME_1100us CTIME_2116us CTIME_4156us CTIME_8244us

Returns: Ths status of config

Return values

STATUS_OK	in case of success
STATUS_TimeOut	in case of failure

◆ INA234_SoftResetAll()

void INA234_SoftResetAll ( INA234 * self )

Send a reset command to all of the INA234s on the bus.

Parameters

self	A pointer to the ina234 object (struct)

Functions

Function Documentation

◆ __INA234_readTwoBytes()

◆ __INA234_writeTwoBytes()

◆ INA234_alert_init()

◆ INA234_getADCRange()

◆ INA234_getAlertSource()

◆ INA234_getBusVoltage()

◆ INA234_getCurrent()

◆ INA234_getDevID()

◆ INA234_getErrors()

◆ INA234_getManID()

◆ INA234_getMode()

◆ INA234_getNumberOfADCSamples()

◆ INA234_getPower()

◆ INA234_getShuntVoltage()

◆ INA234_getVBusConversionTime()

◆ INA234_getVShuntConversionTime()

◆ INA234_init()

◆ INA234_isDataReady()

◆ INA234_readAll()

◆ INA234_resetAlert()

◆ INA234_setADCRange()

◆ INA234_setMode()

◆ INA234_setNumberOfADCSamples()

◆ INA234_setVBusConversionTime()

◆ INA234_setVShuntConversionTime()

◆ INA234_SoftResetAll()