INA236 HAL Based Library 1.0.1
This library is a software library that works with the INA236 current, voltage, and power monitor chip. This library provides a convenient and efficient way to access the I2C interfaces of the chip, allowing developers to easily integrate this power meter into their systems.
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions
ina236.h File Reference
#include "main.h"
#include "i2c.h"

Go to the source code of this file.

Data Structures

struct  INA236
 Class (struct) that stores variables for interacting with INA236. More...
 
union  INA236::_reg
 
struct  INA236::_reg::_config_register
 
struct  INA236::_reg::_shunt_voltage_register
 
struct  INA236::_reg::_bus_voltage_register
 
struct  INA236::_reg::_power_register
 
struct  INA236::_reg::_current_register
 
struct  INA236::_reg::_calibration_register
 
struct  INA236::_reg::_mask_enable_register
 
struct  INA236::_reg::_alert_limit_register
 
struct  INA236::_reg::_manufacture_id_register
 
struct  INA236::_reg::_devide_id_register
 

Macros

#define MAXIMUM_EXPECTED_CURRENT   5.0
 
#define CURRENT_LSB_MINIMUM   (MAXIMUM_EXPECTED_CURRENT / ((float)(1<<15)))
 
#define CURRENT_LSB   (CURRENT_LSB_MINIMUM * 1.0)
 
#define BUS_VOLTAGE_LSB   0.0016
 
#define SHUNT_VOLTAGE_81_92mv_LSB   0.0025
 
#define SHUNT_VOLTAGE_20_48mv_LSB   0.000625
 
#define POWER_LSB   (CURRENT_LSB*32)
 
#define CONFIGURATION_REGISTER   0x00
 
#define SHUNT_VOLTAGE_REGISTER   0x01
 
#define BUS_VOLTAGE_REGISTER   0x02
 
#define POWER_REGISTER   0x03
 
#define CURRENT_REGISTER   0x04
 
#define CALIBRATION_REGISTER   0x05
 
#define MASK_ENABLE_REGISTER   0x06
 
#define ALERT_LIMIT_REGISTER   0x07
 
#define MANUFACTURERID_REGISTER   0x3E
 
#define DEVICEID_REGISTER   0x3F
 

Typedefs

typedef enum ADCRange ADCRange
 
typedef enum NumSamples NumSamples
 
typedef enum ConvTime ConvTime
 
typedef enum Mode Mode
 
typedef enum INA236_Status INA236_Status
 
typedef enum AlertOn AlertOn
 
typedef enum AlertPolarity AlertPolarity
 
typedef enum AlertLatch AlertLatch
 
typedef enum AlertConvReady AlertConvReady
 
typedef enum AlertSource AlertSource
 
typedef enum ErrorType ErrorType
 
typedef struct INA236 INA236
 Class (struct) that stores variables for interacting with INA236.
 

Enumerations

enum  ADCRange { RANGE_81_92mV , RANGE_20_48mV }
 
enum  NumSamples {
  NADC_1 , NADC_4 , NADC_16 , NADC_64 ,
  NADC_128 , NADC_256 , NADC_512 , NADC_1024
}
 
enum  ConvTime {
  CTIME_140us , CTIME_204us , CTIME_332us , CTIME_588us ,
  CTIME_1100us , CTIME_2116us , CTIME_4156us , CTIME_8244us
}
 
enum  Mode {
  MODE_SHUTDOWN , MODE_SINGLESHOT_SUNT , MODE_SINGLESHOT_BUS , MODE_SINGLESHOT_BOTH_SHUNT_BUS ,
  MODE_SHUTDOWN2 , MODE_CONTINUOUS_SHUNT , MODE_CONTINUOUS_BUS , MODE_CONTINUOUS_BOTH_SHUNT_BUS
}
 
enum  INA236_Status { INA236_OK , INA236_TimeOut }
 
enum  AlertOn {
  ALERT_NONE , ALERT_SHUNT_OVER_LIMIT , ALERT_SHUNT_UNDER_LIMIT , ALERT_BUS_OVER_LIMIT ,
  ALERT_BUS_UNDER_LIMIT , ALERT_POWER_OVER_LIMIT
}
 
enum  AlertPolarity { ALERT_ACTIVE_LOW , ALERT_ACTIVE_HIGH }
 
enum  AlertLatch { ALERT_TRANSPARENT , ALERT_LATCHED }
 
enum  AlertConvReady { ALERT_CONV_DISABLE , ALERT_CONV_ENABLE }
 
enum  AlertSource { ALERT_DATA_READY , ALERT_LIMIT_REACHED }
 
enum  ErrorType { ERROR_NONE , ERROR_MEMORY , ERROR_OVF , ERROR_BOTH_MEMORY_OVF }
 

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.
 

Macro Definition Documentation

◆ ALERT_LIMIT_REGISTER

#define ALERT_LIMIT_REGISTER   0x07

◆ BUS_VOLTAGE_LSB

#define BUS_VOLTAGE_LSB   0.0016

◆ BUS_VOLTAGE_REGISTER

#define BUS_VOLTAGE_REGISTER   0x02

◆ CALIBRATION_REGISTER

#define CALIBRATION_REGISTER   0x05

◆ CONFIGURATION_REGISTER

#define CONFIGURATION_REGISTER   0x00

◆ CURRENT_LSB

#define CURRENT_LSB   (CURRENT_LSB_MINIMUM * 1.0)

◆ CURRENT_LSB_MINIMUM

#define CURRENT_LSB_MINIMUM   (MAXIMUM_EXPECTED_CURRENT / ((float)(1<<15)))

◆ CURRENT_REGISTER

#define CURRENT_REGISTER   0x04

◆ DEVICEID_REGISTER

#define DEVICEID_REGISTER   0x3F

◆ MANUFACTURERID_REGISTER

#define MANUFACTURERID_REGISTER   0x3E

◆ MASK_ENABLE_REGISTER

#define MASK_ENABLE_REGISTER   0x06

◆ MAXIMUM_EXPECTED_CURRENT

#define MAXIMUM_EXPECTED_CURRENT   5.0

◆ POWER_LSB

#define POWER_LSB   (CURRENT_LSB*32)

◆ POWER_REGISTER

#define POWER_REGISTER   0x03

◆ SHUNT_VOLTAGE_20_48mv_LSB

#define SHUNT_VOLTAGE_20_48mv_LSB   0.000625

◆ SHUNT_VOLTAGE_81_92mv_LSB

#define SHUNT_VOLTAGE_81_92mv_LSB   0.0025

◆ SHUNT_VOLTAGE_REGISTER

#define SHUNT_VOLTAGE_REGISTER   0x01

Typedef Documentation

◆ ADCRange

typedef enum ADCRange ADCRange

◆ AlertConvReady

typedef enum AlertConvReady AlertConvReady

◆ AlertLatch

typedef enum AlertLatch AlertLatch

◆ AlertOn

typedef enum AlertOn AlertOn

◆ AlertPolarity

typedef enum AlertPolarity AlertPolarity

◆ AlertSource

typedef enum AlertSource AlertSource

◆ ConvTime

typedef enum ConvTime ConvTime

◆ ErrorType

typedef enum ErrorType ErrorType

◆ INA236

typedef struct INA236 INA236

Class (struct) that stores variables for interacting with INA236.

◆ INA236_Status

typedef enum INA236_Status INA236_Status

◆ Mode

typedef enum Mode Mode

◆ NumSamples

typedef enum NumSamples NumSamples

Enumeration Type Documentation

◆ ADCRange

enum ADCRange
Enumerator
RANGE_81_92mV 
RANGE_20_48mV 

◆ AlertConvReady

enum AlertConvReady
Enumerator
ALERT_CONV_DISABLE 
ALERT_CONV_ENABLE 

◆ AlertLatch

enum AlertLatch
Enumerator
ALERT_TRANSPARENT 
ALERT_LATCHED 

◆ AlertOn

enum AlertOn
Enumerator
ALERT_NONE 
ALERT_SHUNT_OVER_LIMIT 
ALERT_SHUNT_UNDER_LIMIT 
ALERT_BUS_OVER_LIMIT 
ALERT_BUS_UNDER_LIMIT 
ALERT_POWER_OVER_LIMIT 

◆ AlertPolarity

enum AlertPolarity
Enumerator
ALERT_ACTIVE_LOW 
ALERT_ACTIVE_HIGH 

◆ AlertSource

enum AlertSource
Enumerator
ALERT_DATA_READY 
ALERT_LIMIT_REACHED 

◆ ConvTime

enum ConvTime
Enumerator
CTIME_140us 
CTIME_204us 
CTIME_332us 
CTIME_588us 
CTIME_1100us 
CTIME_2116us 
CTIME_4156us 
CTIME_8244us 

◆ ErrorType

enum ErrorType
Enumerator
ERROR_NONE 
ERROR_MEMORY 
ERROR_OVF 
ERROR_BOTH_MEMORY_OVF 

◆ INA236_Status

enum INA236_Status
Enumerator
INA236_OK 
INA236_TimeOut 

◆ Mode

enum Mode
Enumerator
MODE_SHUTDOWN 
MODE_SINGLESHOT_SUNT 
MODE_SINGLESHOT_BUS 
MODE_SINGLESHOT_BOTH_SHUNT_BUS 
MODE_SHUTDOWN2 
MODE_CONTINUOUS_SHUNT 
MODE_CONTINUOUS_BUS 
MODE_CONTINUOUS_BOTH_SHUNT_BUS 

◆ NumSamples

enum NumSamples
Enumerator
NADC_1 
NADC_4 
NADC_16 
NADC_64 
NADC_128 
NADC_256 
NADC_512 
NADC_1024 

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
selfA pointer to the INA236 object (struct)
MemAddressAddress of the register
Returns
Ths status of reading
Return values
INA236_OKin case of success
INA236_TimeOutin 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
selfA pointer to the INA236 object (struct)
MemAddressAddress of the register
Returns
Ths status of writing
Return values
INA236_OKin case of success
INA236_TimeOutin 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
selfA pointer to the INA236 object (struct)
alert_ondetermines the event that you want to assert the alert:
alert_polarityThe 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_latchDetermine the alert pin behaviour. If the latch is enabled, you have to reset the pin by calling the INA236_resetAlert() function.
alert_conv_readyShows 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_limitThis 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 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_OKin case of success
INA236_TimeOutin case of failure

◆ INA236_getADCRange()

ADCRange INA236_getADCRange ( INA236 * self)

Get the ADC full scale range of INA236.

Parameters
selfA pointer to the INA236 object (struct)
Returns
The full scale range of ADC.
Return values
RANGE_81_92mVfor 81.92 mV
RANGE_20_48mVfor 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
selfA pointer to the INA236 object (struct)
Returns
The alert source
Return values
ALERT_DATA_READYThe alert source is convertion ready
ALERT_LIMIT_REACHEDThe alert source is limit reach

◆ INA236_getBusVoltage()

float INA236_getBusVoltage ( INA236 * self)

Read the bus voltage from INA236.

Parameters
selfA 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
selfA 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
selfA 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
selfA pointer to the INA236 object (struct)
Returns
Error type
Return values
ERROR_NONENo error
ERROR_MEMORYMemory error (CRC or ECC)
ERROR_OVFMath overflow error
ERROR_BOTH_MEMORY_OVFBoth memory error (CRC or ECC) and math overflow error

◆ INA236_getManID()

uint16_t INA236_getManID ( INA236 * self)

Get the manufacturer ID.

Parameters
selfA pointer to the INA236 object (struct)
Returns
a 16bit manufacturer ID

◆ INA236_getMode()

Mode INA236_getMode ( INA236 * self)

Set the operating mode.

Parameters
selfA pointer to the INA236 object (struct)
Returns
Operating mode
Return values
MODE_SHUTDOWNshutdown mode
MODE_SINGLESHOT_SUNTonly measure the shunt voltage once
MODE_SINGLESHOT_BUSonly measure the bus voltage once
MODE_SINGLESHOT_BOTH_SHUNT_BUSmeasure the bus and shunt voltage once
MODE_CONTINUOUS_SHUNTonly measure the shunt voltage continuously
MODE_CONTINUOUS_BUSonly measure the bus voltage continuously
MODE_CONTINUOUS_BOTH_SHUNT_BUSmeasure the bus and shunt voltage continuously

◆ INA236_getNumberOfADCSamples()

NumSamples INA236_getNumberOfADCSamples ( INA236 * self)

Get the number of ADC samples to calculate the average.

Parameters
selfA 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_1for one sample (no average)
NADC_44 samples
NADC_1616 samples
NADC_6464 samples
NADC_128128 samples
NADC_256256 samples
NADC_512512 samples
NADC_10241024 samples

◆ INA236_getPower()

float INA236_getPower ( INA236 * self)

Read the power from INA236.

Parameters
selfA 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
selfA 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
selfA 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
selfA 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
selfA pointer to the INA236 object (struct)
I2C_ADDRThe I2C address of the INA236. It depends on the state of A0 pin of the chip.
hi2cA pointer to the I2C handler that is connected to INA236
ShuntResistorThe resistance of your shunt resistor (in mOhm) connected to IN+ and IN- of the INA236
adc_rangeThe full scale range of ADC. It can be one of these values:
numer_of_adc_samplesNumer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency.
vbus_conversion_timeThe conversion time of VBus measurment.
vshunt_conversion_timeThe conversion time of VShunt measurment.
modeOperating mode:
Returns
Ths status of initialization
Return values
INA236_OKin case of success
INA236_TimeOutin 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
selfA 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
selfA 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
selfA pointer to the INA236 object (struct)
Returns
Ths status of reset
Return values
INA236_OKin case of success
INA236_TimeOutin case of failure

◆ INA236_setADCRange()

INA236_Status INA236_setADCRange ( INA236 * self,
ADCRange adc_range )

Set the ADC full scale range of INA236.

Parameters
selfA pointer to the INA236 object (struct)
adc_rangeThe full scale range of ADC. It can be one of these values:
Returns
Ths status of config
Return values
INA236_OKin case of success
INA236_TimeOutin case of failure

◆ INA236_setMode()

INA236_Status INA236_setMode ( INA236 * self,
Mode mode )

Set the operating mode.

Parameters
selfA pointer to the INA236 object (struct)
modeOperating mode:
Returns
Ths status of config
Return values
INA236_OKin case of success
INA236_TimeOutin 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
selfA pointer to the INA236 object (struct)
numer_of_adc_samplesNumer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency.
Returns
Ths status of config
Return values
INA236_OKin case of success
INA236_TimeOutin case of failure

◆ INA236_setVBusConversionTime()

INA236_Status INA236_setVBusConversionTime ( INA236 * self,
ConvTime vbus_conversion_time )

Set the VBus convertion period.

Parameters
selfA pointer to the INA236 object (struct)
vbus_conversion_timeThe conversion time of VBus measurment.
Returns
Ths status of config
Return values
INA236_OKin case of success
INA236_TimeOutin case of failure

◆ INA236_setVShuntConversionTime()

INA236_Status INA236_setVShuntConversionTime ( INA236 * self,
ConvTime vshunt_conversion_time )

Set the VShunt convertion period.

Parameters
selfA pointer to the INA236 object (struct)
vshunt_conversion_timeThe conversion time of VShunt measurment.
Returns
Ths status of config
Return values
INA236_OKin case of success
INA236_TimeOutin case of failure

◆ INA236_SoftResetAll()

void INA236_SoftResetAll ( INA236 * self)

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

Parameters
selfA pointer to the INA236 object (struct)