ina236.c File Reference

#include "ina236.h"

Functions
INA236_Status	INA236_init (INA236 *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 INA236 with the given config.
INA236_Status	INA236_alert_init (INA236 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit)
	Initialize the alert functionality of INA236 with the given configurations.
INA236_Status	__INA236_readTwoBytes (INA236 *self, uint8_t MemAddress)
	Read two bytes (a 16bit register) from INA236 and stores in the INA236::_reg::raw_data.
INA236_Status	__INA236_writeTwoBytes (INA236 *self, uint8_t MemAddress)
	Write two bytes (a 16bit register) to INA236 from the INA236::_reg::raw_data.
INA236_Status	INA236_setADCRange (INA236 *self, ADCRange adc_range)
	Set the ADC full scale range of INA236.
INA236_Status	INA236_setNumberOfADCSamples (INA236 *self, NumSamples numer_of_adc_samples)
	Set the number of ADC samples to calculate the average.
INA236_Status	INA236_setVBusConversionTime (INA236 *self, ConvTime vbus_conversion_time)
	Set the VBus convertion period.
INA236_Status	INA236_setVShuntConversionTime (INA236 *self, ConvTime vshunt_conversion_time)
	Set the VShunt convertion period.
INA236_Status	INA236_setMode (INA236 *self, Mode mode)
	Set the operating mode.
ADCRange	INA236_getADCRange (INA236 *self)
	Get the ADC full scale range of INA236.
NumSamples	INA236_getNumberOfADCSamples (INA236 *self)
	Get the number of ADC samples to calculate the average.
ConvTime	INA236_getVBusConversionTime (INA236 *self)
	Get the VBus convertion period.
ConvTime	INA236_getVShuntConversionTime (INA236 *self)
	Get the VShunt convertion period.
Mode	INA236_getMode (INA236 *self)
	Set the operating mode.
void	INA236_SoftResetAll (INA236 *self)
	Send a reset command to all of the INA236s on the bus.
uint16_t	INA236_getManID (INA236 *self)
	Get the manufacturer ID.
uint16_t	INA236_getDevID (INA236 *self)
	Get the device ID.
void	INA236_readAll (INA236 *self)
	Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the values to the INA236 object (struct) variables. Then you can read variables: INA236::ShuntVoltage, INA236::BusVoltage, INA236::Power, and INA236::Current.
float	INA236_getCurrent (INA236 *self)
	Read the current from INA236.
float	INA236_getBusVoltage (INA236 *self)
	Read the bus voltage from INA236.
float	INA236_getShuntVoltage (INA236 *self)
	Read the shunt voltage from INA236.
float	INA236_getPower (INA236 *self)
	Read the power from INA236.
uint8_t	INA236_isDataReady (INA236 *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 INA236_resetAlert() function.
AlertSource	INA236_getAlertSource (INA236 *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 INA236_resetAlert() function.
ErrorType	INA236_getErrors (INA236 *self)
	Get the error flags of INA236. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA236_resetAlert() function.
INA236_Status	INA236_resetAlert (INA236 *self)
	Reset the alert pin. This function is useful when set the alert pin to latch mode.

Function Documentation

__INA236_readTwoBytes()

INA236_Status __INA236_readTwoBytes	(	INA236 *	self,
		uint8_t	MemAddress )

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

Parameters

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

Returns

Ths status of reading

Return values

INA236_OK	in case of success
INA236_TimeOut	in case of failure

__INA236_writeTwoBytes()

INA236_Status __INA236_writeTwoBytes	(	INA236 *	self,
		uint8_t	MemAddress )

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

Parameters

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

Returns

Ths status of writing

Return values

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_alert_init()

INA236_Status INA236_alert_init	(	INA236 *	self,
		AlertOn	alert_on,
		AlertPolarity	alert_polarity,
		AlertLatch	alert_latch,
		AlertConvReady	alert_conv_ready,
		float	alert_limit )

Initialize the alert functionality of INA236 with the given configurations.

Parameters

self	A pointer to the INA236 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 INA236_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 INA236_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

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_getADCRange()

ADCRange INA236_getADCRange

(

INA236 *

self

)

Get the ADC full scale range of INA236.

Parameters

self	A pointer to the INA236 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

INA236_getAlertSource()

AlertSource INA236_getAlertSource

(

INA236 *

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 INA236_resetAlert() function.

Parameters

self	A pointer to the INA236 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

INA236_getBusVoltage()

float INA236_getBusVoltage

(

INA236 *

self

)

Read the bus voltage from INA236.

Parameters

self	A pointer to the INA236 object (struct)

Returns

a float value in Volts representing the bus voltage

INA236_getCurrent()

float INA236_getCurrent

(

INA236 *

self

)

Read the current from INA236.

Parameters

self	A pointer to the INA236 object (struct)

Returns

a float value in Amps representing the current

INA236_getDevID()

uint16_t INA236_getDevID

(

INA236 *

self

)

Get the device ID.

Parameters

self	A pointer to the INA236 object (struct)

Returns

a 12bit device ID

INA236_getErrors()

ErrorType INA236_getErrors

(

INA236 *

self

)

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

Parameters

self	A pointer to the INA236 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

INA236_getManID()

uint16_t INA236_getManID

(

INA236 *

self

)

Get the manufacturer ID.

Parameters

self	A pointer to the INA236 object (struct)

Returns

a 16bit manufacturer ID

INA236_getMode()

Mode INA236_getMode

(

INA236 *

self

)

Set the operating mode.

Parameters

self	A pointer to the INA236 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

INA236_getNumberOfADCSamples()

NumSamples INA236_getNumberOfADCSamples

(

INA236 *

self

)

Get the number of ADC samples to calculate the average.

Parameters

self	A pointer to the INA236 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

INA236_getPower()

float INA236_getPower

(

INA236 *

self

)

Read the power from INA236.

Parameters

self	A pointer to the INA236 object (struct)

Returns

a float value in Watt representing the power

INA236_getShuntVoltage()

float INA236_getShuntVoltage

(

INA236 *

self

)

Read the shunt voltage from INA236.

Parameters

self	A pointer to the INA236 object (struct)

Returns

a float value in miliVolts representing the shunt voltage

INA236_getVBusConversionTime()

ConvTime INA236_getVBusConversionTime

(

INA236 *

self

)

Get the VBus convertion period.

Parameters

self	A pointer to the INA236 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

INA236_getVShuntConversionTime()

ConvTime INA236_getVShuntConversionTime

(

INA236 *

self

)

Get the VShunt convertion period.

Parameters

self	A pointer to the INA236 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

INA236_init()

INA236_Status INA236_init	(	INA236 *	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 INA236 with the given config.

Parameters

self	A pointer to the INA236 object (struct)
I2C_ADDR	The I2C address of the INA236. It depends on the state of A0 pin of the chip.
hi2c	A pointer to the I2C handler that is connected to INA236
ShuntResistor	The resistance of your shunt resistor (in mOhm) connected to IN+ and IN- of the INA236
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

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_isDataReady()

uint8_t INA236_isDataReady

(

INA236 *

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 INA236_resetAlert() function.

Parameters

self	A pointer to the INA236 object (struct)

Return values

True
False

INA236_readAll()

void INA236_readAll

(

INA236 *

self

)

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

Parameters

self	A pointer to the INA236 object (struct)

INA236_resetAlert()

INA236_Status INA236_resetAlert

(

INA236 *

self

)

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

Parameters

self	A pointer to the INA236 object (struct)

Returns

Ths status of reset

Return values

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_setADCRange()

INA236_Status INA236_setADCRange	(	INA236 *	self,
		ADCRange	adc_range )

Set the ADC full scale range of INA236.

Parameters

self	A pointer to the INA236 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

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_setMode()

INA236_Status INA236_setMode	(	INA236 *	self,
		Mode	mode )

Set the operating mode.

Parameters

self

A pointer to the INA236 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

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_setNumberOfADCSamples()

INA236_Status INA236_setNumberOfADCSamples	(	INA236 *	self,
		NumSamples	numer_of_adc_samples )

Set the number of ADC samples to calculate the average.

Parameters

self	A pointer to the INA236 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

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_setVBusConversionTime()

INA236_Status INA236_setVBusConversionTime	(	INA236 *	self,
		ConvTime	vbus_conversion_time )

Set the VBus convertion period.

Parameters

self	A pointer to the INA236 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

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_setVShuntConversionTime()

INA236_Status INA236_setVShuntConversionTime	(	INA236 *	self,
		ConvTime	vshunt_conversion_time )

Set the VShunt convertion period.

Parameters

self	A pointer to the INA236 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

INA236_OK	in case of success
INA236_TimeOut	in case of failure

INA236_SoftResetAll()

void INA236_SoftResetAll

(

INA236 *

self

)

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

Parameters

self	A pointer to the INA236 object (struct)