The TI INA228: 85V, 20-bit current, voltage, power, energy and charge monitor on I2C (Inter-Integrated Circuit). More...

#include <stdbool.h>
#include <stdint.h>
#include "sense_bus.h"

Data Structures
struct	ina228_cal_t
	The calibration of an INA228: shunt, maximum current, SHUNT_CAL and ADCRANGE. More...
struct	ina228_t

Macros
#define	INA228_MAKER_ID 0x5449u
#define	INA228_DIE_ID 0x228u
#define	INA228_ADDR_MIN 0x40u
#define	INA228_ADDR_MAX 0x4Fu
#define	INA228_FS_MA_LIMIT 2000000u
	The largest full scale taken, mA: every reading then fits an int32 of µA.
#define	INA228_SHUNT_CAL_ADC 4096u
	SHUNT_CAL with CURRENT_LSB at the ADC step over the shunt: 13107.2 × 10^6 × 312.5 nV (Equation 2; the shunt cancels, and the factor 4 at ADCRANGE 1 meets a step 4 times smaller).
#define	INA228_CONFIG_RST 0x8000u
	CONFIG bits, Table 7-5.
#define	INA228_CONFIG_RSTACC 0x4000u
#define	INA228_CONFIG_TEMPCOMP 0x0020u
#define	INA228_CONFIG_ADCRANGE 0x0010u
#define	INA228_DIAG_ALATCH 0x8000u
	DIAG_ALRT bits, Table 7-16.
#define	INA228_DIAG_CNVR 0x4000u
#define	INA228_DIAG_SLOWALERT 0x2000u
#define	INA228_DIAG_APOL 0x1000u
#define	INA228_DIAG_ENERGYOF 0x0800u
#define	INA228_DIAG_CHARGEOF 0x0400u
#define	INA228_DIAG_MATHOF 0x0200u
#define	INA228_DIAG_TMPOL 0x0080u
#define	INA228_DIAG_SHNTOL 0x0040u
#define	INA228_DIAG_SHNTUL 0x0020u
#define	INA228_DIAG_BUSOL 0x0010u
#define	INA228_DIAG_BUSUL 0x0008u
#define	INA228_DIAG_POL 0x0004u
#define	INA228_DIAG_CNVRF 0x0002u
#define	INA228_DIAG_MEMSTAT 0x0001u
#define	INA228_ADC_BENCH 0xF900u
	The set-up this bench runs (DESIGN §3.4): continuous, bus and shunt 540µs (code 4), temperature 50µs (code 0), averaging 1: a fresh result every 1130µs.
#define	INA228_ADC_RESET 0xFB68u
	The ADC_CONFIG reset value, FB68h (Table 7-6).

Enumerations
enum	{ INA228_CONFIG = 0x00 , INA228_ADC_CONFIG = 0x01 , INA228_SHUNT_CAL = 0x02 , INA228_SHUNT_TEMPCO = 0x03 , INA228_VSHUNT = 0x04 , INA228_VBUS = 0x05 , INA228_DIETEMP = 0x06 , INA228_CURRENT = 0x07 , INA228_POWER = 0x08 , INA228_ENERGY = 0x09 , INA228_CHARGE = 0x0A , INA228_DIAG_ALRT = 0x0B , INA228_MANUFACTURER = 0x3E , INA228_DEVICE_ID = 0x3F }
	Registers, Table 7-3. More...
enum	{ INA228_MODE_SHUTDOWN = 0x0 , INA228_MODE_CONT_BUS = 0x9 , INA228_MODE_CONT_SHUNT = 0xA , INA228_MODE_CONT_VI = 0xB , INA228_MODE_CONT_ALL = 0xF }
	ADC_CONFIG MODE, Table 7-6: 0h and 8h shut down, 1h to 7h trigger one conversion, 9h to Fh convert continuously. More...
enum	ina228_setup_err_t { INA228_SETUP_OK = 0 , INA228_SETUP_BAD_ADDR , INA228_SETUP_NO_SHUNT , INA228_SETUP_NO_MAX , INA228_SETUP_OVER_RANGE }

Functions
uint16_t	ina228_adc_config (uint8_t mode, uint8_t vbusct, uint8_t vshct, uint8_t vtct, uint8_t avg)
	ADC_CONFIG from its fields; each is masked to its width.
uint32_t	ina228_averages (uint8_t code)
	Samples averaged for an AVG code (Table 7-6).
uint32_t	ina228_cycle_us (uint16_t adc_config)
	Time from one result to the next for an ADC_CONFIG, µs: the enabled inputs' conversion times, one after another, times the averages (§7.3.4).
bool	ina228_identity_ok (uint16_t maker, uint16_t device)
	Whether MANUFACTURER_ID and DEVICE_ID name an INA228.
ina228_setup_err_t	ina228_calibrate (uint32_t shunt_uohm, uint32_t max_ma, ina228_cal_t *out)
	SHUNT_CAL and ADCRANGE for a shunt and a maximum current. `out` is filled only on INA228_SETUP_OK.
int32_t	ina228_code20 (uint32_t raw24)
	The 20-bit value in bits 23-4 of a 24-bit register (VSHUNT, VBUS, CURRENT), as raw: -2^19 to 2^19 - 1.
sense_value_t	ina228_current_ua (const ina228_cal_t *cal, int32_t code)
	CURRENT in µA; a code at either end is a clip.
sense_value_t	ina228_vshunt_nv (const ina228_cal_t *cal, int32_t code)
	VSHUNT in nV: 312.5 nV a step at ADCRANGE 0, 78.125 nV at 1 (Table 7-9); a code at either end is a clip.
int32_t	ina228_vbus_uv (int32_t code)
	VBUS in µV, 195.3125µV a step (Table 7-10).
int32_t	ina228_dietemp_mdegc (uint16_t raw)
	DIETEMP in m°C, 7.8125m°C a step (Table 7-11).
uint64_t	ina228_power_uw (const ina228_cal_t *cal, uint32_t raw24)
	POWER (24 bit, unsigned) in µW: 3.2 × CURRENT_LSB a step (Eq.
uint64_t	ina228_energy_mj (const ina228_cal_t *cal, uint64_t raw40)
	ENERGY (40 bit, unsigned) in mJ: 16 × 3.2 × CURRENT_LSB a step (Eq.
int64_t	ina228_charge_uc (const ina228_cal_t *cal, uint64_t raw40)
	CHARGE (40 bit, two's complement) in µC: CURRENT_LSB a step (Eq.
ina228_setup_err_t	ina228_init (ina228_t d, sense_bus_t bus, uint8_t addr, uint32_t shunt_uohm, uint32_t max_ma, uint16_t adc_config)
	A part at `addr` with a shunt, a maximum current and an ADC_CONFIG (INA228_ADC_BENCH for this bench).
bool	ina228_step (ina228_t *d, uint32_t now_ms)
	Every tick: probes the part when it is due – at the first call, and SENSE_RETRY_MS after it was found absent, wrong, refused or offline.
sense_state_t	ina228_state (const ina228_t *d)
	The part's state as of the last probe.
sense_err_t	ina228_read_current (ina228_t d, sense_value_t ua)
	Readings.
sense_err_t	ina228_read_vshunt (ina228_t d, sense_value_t nv)
	Read the shunt voltage.
sense_err_t	ina228_read_vbus (ina228_t d, int32_t uv)
	Read the bus voltage.
sense_err_t	ina228_read_power (ina228_t d, uint64_t uw)
	Read the power.
sense_err_t	ina228_read_dietemp (ina228_t d, int32_t mdegc)
	Read the die temperature.
sense_err_t	ina228_read_diag (ina228_t d, uint16_t diag)
	DIAG_ALRT as read; the read clears the latched flags (Table 7-16).
sense_err_t	ina228_read_energy (ina228_t d, uint64_t mj)
	Read the energy.
sense_err_t	ina228_read_charge (ina228_t d, int64_t uc)
	Read the charge.
sense_err_t	ina228_clear_totals (ina228_t *d)
	ENERGY and CHARGE to 0: CONFIG with RSTACC, then without.
sense_err_t	ina228_verify (ina228_t d, bool lost)
	ADC_CONFIG read back against the value written.

Detailed Description

The TI INA228: 85V, 20-bit current, voltage, power, energy and charge monitor on I2C (Inter-Integrated Circuit).

The register codec and a driver that talks to one part through sense_bus.h.

Written from the datasheet, TI SLYS021A (January 2021, revised May 2022). Tables and sections below are that document's.

Calibration (§8.1.2). The maximum current chooses the shunt range: ADCRANGE 1 (±40.96mV, 78.125 nV a step) when the maximum across the shunt fits it, else ADCRANGE 0 (±163.84mV, 312.5 nV a step); a maximum past 163.84mV is refused (Table 8-1).

CURRENT_LSB is the ADC (analog-to-digital converter) step over the shunt, not Equation 3 taken at the maximum (maximum / 2^19). Equation 2, SHUNT_CAL = 13107.2 × 10^6 × CURRENT_LSB × R, times 4 at ADCRANGE 1, then gives 13107.2 × 10^6 × 312.5 nV = 4096 at either range for every shunt, and with Equation 4 CURRENT = VSHUNT × 4096 / SHUNT_CAL = VSHUNT. Why:

The ADC's 20 bits bound the resolution. A finer CURRENT_LSB from a maximum below the range's top adds no information.
With Equation 3's LSB and such a maximum, CURRENT reaches the end of its 20 bits before the ADC does, and the datasheet does not say whether CURRENT then holds or wraps. Here CURRENT and VSHUNT reach their ends together, at the ADC's.

Equation 3's condition, CURRENT_LSB at least maximum / 2^19, still holds: the range is chosen so that the maximum fits it. 4096 fits SHUNT_CAL's 15-bit field (Table 7-7) whatever the shunt, so no shunt is refused for it. A shunt whose full scale at the chosen range passes INA228_FS_MA_LIMIT is refused.

The MATEK I2C-INA-BM (200 µΩ, address 0x45) at its 204.8A: ADCRANGE 1, SHUNT_CAL 4096, CURRENT_LSB 390.625µA, power 1.25mW, energy 20 mJ and charge 390.625 µC a step.

Identity (Tables 7-23, 7-24): MANUFACTURER_ID 5449h ("TI") and DEVICE_ID bits 15-4 equal to 228h, any revision in bits 3-0. Anything else, an INA238 (238xh) included, is not used and nothing is written to it.

Clipping. A CURRENT or VSHUNT reading at an end of its 20-bit range (2^19 - 1 or -2^19) is a clip, never a value. With the calibration above the two reach their ends together, at the ADC's full scale. What the ADC reports past its full scale is not stated; it is taken to stay at the end code. DIAG_ALRT.MATHOF (Table 7-16) reports an arithmetic overflow and is the caller's to read.

Set-up written at each probe: CONFIG with ADCRANGE, SHUNT_CAL, ADC_CONFIG, then CONFIG with RSTACC and CONFIG without it, and the three read back. Whether RSTACC clears itself is not stated (Table 7-5); it is written back to 0. Shunt temperature compensation stays off: the shunts' coefficients are not known.

SPDX-License-Identifier: MIT

Macro Definition Documentation

◆ INA228_ADC_BENCH

#define INA228_ADC_BENCH 0xF900u

The set-up this bench runs (DESIGN §3.4): continuous, bus and shunt 540µs (code 4), temperature 50µs (code 0), averaging 1: a fresh result every 1130µs.

540µs integrates over 4 to 26 periods of an ESC's (electronic speed controller's) 8 to 48kHz switching.

◆ INA228_ADDR_MAX

#define INA228_ADDR_MAX 0x4Fu

A1, A0 at SCL, SCL

◆ INA228_ADDR_MIN

#define INA228_ADDR_MIN 0x40u

A1, A0 at GND, GND: Table 7-2

◆ INA228_DIAG_ALATCH

#define INA228_DIAG_ALATCH 0x8000u

DIAG_ALRT bits, Table 7-16.

alert latch enable

◆ INA228_DIAG_APOL

#define INA228_DIAG_APOL 0x1000u

alert polarity

◆ INA228_DIAG_BUSOL

#define INA228_DIAG_BUSOL 0x0010u

bus voltage over-limit

◆ INA228_DIAG_BUSUL

#define INA228_DIAG_BUSUL 0x0008u

bus voltage under-limit

◆ INA228_DIAG_CHARGEOF

#define INA228_DIAG_CHARGEOF 0x0400u

CHARGE rolled over; cleared by reading CHARGE

◆ INA228_DIAG_CNVR

#define INA228_DIAG_CNVR 0x4000u

conversion-ready flag on the ALERT pin

◆ INA228_DIAG_CNVRF

#define INA228_DIAG_CNVRF 0x0002u

a conversion cycle completed

◆ INA228_DIAG_ENERGYOF

#define INA228_DIAG_ENERGYOF 0x0800u

ENERGY rolled over; cleared by reading ENERGY

◆ INA228_DIAG_MATHOF

#define INA228_DIAG_MATHOF 0x0200u

current and power may be invalid

◆ INA228_DIAG_MEMSTAT

#define INA228_DIAG_MEMSTAT 0x0001u

1: trim memory checksum good

◆ INA228_DIAG_POL

#define INA228_DIAG_POL 0x0004u

power over-limit

◆ INA228_DIAG_SHNTOL

#define INA228_DIAG_SHNTOL 0x0040u

shunt voltage over-limit

◆ INA228_DIAG_SHNTUL

#define INA228_DIAG_SHNTUL 0x0020u

shunt voltage under-limit

◆ INA228_DIAG_SLOWALERT

#define INA228_DIAG_SLOWALERT 0x2000u

alert on a slow-alert average

◆ INA228_DIAG_TMPOL

#define INA228_DIAG_TMPOL 0x0080u

temperature over-limit

◆ INA228_DIE_ID

#define INA228_DIE_ID 0x228u

DEVICE_ID bits 15-4, Table 7-24

◆ INA228_FS_MA_LIMIT

#define INA228_FS_MA_LIMIT 2000000u

The largest full scale taken, mA: every reading then fits an int32 of µA.

2000A is 81.92 µΩ at ADCRANGE 0 and 20.48 µΩ at ADCRANGE 1.

◆ INA228_MAKER_ID

#define INA228_MAKER_ID 0x5449u

Table 7-23

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

ADC_CONFIG MODE, Table 7-6: 0h and 8h shut down, 1h to 7h trigger one conversion, 9h to Fh convert continuously.

Bit 0 bus voltage, bit 1 shunt voltage, bit 2 temperature.

Enumerator
INA228_MODE_CONT_ALL	bus, shunt and temperature

◆ anonymous enum

anonymous enum

Registers, Table 7-3.

Enumerator
INA228_CONFIG	16 bit
INA228_ADC_CONFIG	16 bit
INA228_SHUNT_CAL	16 bit, 15-bit field
INA228_SHUNT_TEMPCO	16 bit
INA228_VSHUNT	24 bit, 20-bit value in 23-4
INA228_VBUS	24 bit, 20-bit value in 23-4
INA228_DIETEMP	16 bit
INA228_CURRENT	24 bit, 20-bit value in 23-4
INA228_POWER	24 bit, unsigned
INA228_ENERGY	40 bit, unsigned
INA228_CHARGE	40 bit, two's complement
INA228_DIAG_ALRT	16 bit
INA228_MANUFACTURER	16 bit, 5449h
INA228_DEVICE_ID	16 bit, 228xh

◆ ina228_setup_err_t

enum ina228_setup_err_t

Enumerator
INA228_SETUP_BAD_ADDR	outside 0x40 to 0x4F
INA228_SETUP_NO_SHUNT	a shunt of 0 µΩ
INA228_SETUP_NO_MAX	a maximum current of 0mA
INA228_SETUP_OVER_RANGE	the maximum drops more than 163.84mV across the shunt, or the range's full scale passes INA228_FS_MA_LIMIT

Function Documentation

◆ ina228_adc_config()

uint16_t ina228_adc_config	(	uint8_t	mode,
		uint8_t	vbusct,
		uint8_t	vshct,
		uint8_t	vtct,
		uint8_t	avg )

ADC_CONFIG from its fields; each is masked to its width.

Parameters

mode	Operating mode.
vbusct	Bus voltage conversion time code.
vshct	Shunt voltage conversion time code.
vtct	Temperature conversion time code.
avg	Averaging code.

Returns: The ADC_CONFIG register value.

◆ ina228_averages()

uint32_t ina228_averages ( uint8_t code )

Samples averaged for an AVG code (Table 7-6).

Parameters

code	The AVG code.

Returns: The number of samples averaged.

◆ ina228_calibrate()

ina228_setup_err_t ina228_calibrate	(	uint32_t	shunt_uohm,
		uint32_t	max_ma,
		ina228_cal_t *	out )

SHUNT_CAL and ADCRANGE for a shunt and a maximum current. out is filled only on INA228_SETUP_OK.

Parameters

shunt_uohm	Shunt resistance, in µΩ.
max_ma	Maximum current, in mA.
out	Receives the calibration.

Returns: INA228_SETUP_OK, or the reason the set-up was refused.

◆ ina228_charge_uc()

int64_t ina228_charge_uc	(	const ina228_cal_t *	cal,
		uint64_t	raw40 )

CHARGE (40 bit, two's complement) in µC: CURRENT_LSB a step (Eq.

7).

Parameters

cal	The calibration.
raw40	The 40-bit CHARGE register value.

Returns: The charge in µC.

◆ ina228_clear_totals()

sense_err_t ina228_clear_totals ( ina228_t * d )

ENERGY and CHARGE to 0: CONFIG with RSTACC, then without.

A failure of the second write leaves RSTACC set; the call is to be repeated.

Parameters

d	The driver.

Returns: SENSE_OK, or the bus error.

◆ ina228_code20()

int32_t ina228_code20 ( uint32_t raw24 )

The 20-bit value in bits 23-4 of a 24-bit register (VSHUNT, VBUS, CURRENT), as raw: -2^19 to 2^19 - 1.

Parameters

raw24 The 24-bit register value.

Returns: The signed 20-bit code.

◆ ina228_current_ua()

sense_value_t ina228_current_ua	(	const ina228_cal_t *	cal,
		int32_t	code )

CURRENT in µA; a code at either end is a clip.

Parameters

cal	The calibration.
code	The CURRENT code.

Returns: The current in µA.

◆ ina228_cycle_us()

uint32_t ina228_cycle_us ( uint16_t adc_config )

Time from one result to the next for an ADC_CONFIG, µs: the enabled inputs' conversion times, one after another, times the averages (§7.3.4).

0 for a mode that does not convert continuously.

Parameters

adc_config The ADC_CONFIG register value.

Returns: The cycle time, in µs.

◆ ina228_dietemp_mdegc()

int32_t ina228_dietemp_mdegc ( uint16_t raw )

DIETEMP in m°C, 7.8125m°C a step (Table 7-11).

Parameters

raw	The DIETEMP register value.

Returns: The die temperature in m°C.

◆ ina228_energy_mj()

uint64_t ina228_energy_mj	(	const ina228_cal_t *	cal,
		uint64_t	raw40 )

ENERGY (40 bit, unsigned) in mJ: 16 × 3.2 × CURRENT_LSB a step (Eq.

6).

Parameters

cal	The calibration.
raw40	The 40-bit ENERGY register value.

Returns: The energy in mJ.

◆ ina228_identity_ok()

bool ina228_identity_ok	(	uint16_t	maker,
		uint16_t	device )

Whether MANUFACTURER_ID and DEVICE_ID name an INA228.

Parameters

maker	The MANUFACTURER_ID register value.
device	The DEVICE_ID register value.

Returns: true when the IDs name an INA228.

◆ ina228_init()

ina228_setup_err_t ina228_init	(	ina228_t *	d,
		sense_bus_t *	bus,
		uint8_t	addr,
		uint32_t	shunt_uohm,
		uint32_t	max_ma,
		uint16_t	adc_config )

A part at addr with a shunt, a maximum current and an ADC_CONFIG (INA228_ADC_BENCH for this bench).

On anything but INA228_SETUP_OK the part is left SENSE_PART_UNSET and nothing is ever sent to it.

Parameters

d	The driver to set up.
bus	The sensor bus the part sits on.
addr	I2C address of the part.
shunt_uohm	Shunt resistance, in µΩ.
max_ma	Maximum current, in mA.
adc_config	The ADC_CONFIG register value.

Returns: INA228_SETUP_OK, or the reason the set-up was refused.

◆ ina228_power_uw()

uint64_t ina228_power_uw	(	const ina228_cal_t *	cal,
		uint32_t	raw24 )

POWER (24 bit, unsigned) in µW: 3.2 × CURRENT_LSB a step (Eq.

5).

Parameters

cal	The calibration.
raw24	The 24-bit POWER register value.

Returns: The power in µW.

◆ ina228_read_charge()

sense_err_t ina228_read_charge	(	ina228_t *	d,
		int64_t *	uc )

Read the charge.

Parameters

d	The driver.
uc	Receives the charge, in µC.

Returns: SENSE_OK, or the bus error.

◆ ina228_read_current()

sense_err_t ina228_read_current	(	ina228_t *	d,
		sense_value_t *	ua )

Readings.

Each is one transaction; on anything but SENSE_OK the output is left as it was.

Parameters

d	The driver.
ua	Receives the current, in µA.

Returns: SENSE_OK, or the bus error.

◆ ina228_read_diag()

sense_err_t ina228_read_diag	(	ina228_t *	d,
		uint16_t *	diag )

DIAG_ALRT as read; the read clears the latched flags (Table 7-16).

Parameters

d	The driver.
diag	Receives the DIAG_ALRT value.

Returns: SENSE_OK, or the bus error.

◆ ina228_read_dietemp()

sense_err_t ina228_read_dietemp	(	ina228_t *	d,
		int32_t *	mdegc )

Read the die temperature.

Parameters

d	The driver.
mdegc	Receives the die temperature, in m°C.

Returns: SENSE_OK, or the bus error.

◆ ina228_read_energy()

sense_err_t ina228_read_energy	(	ina228_t *	d,
		uint64_t *	mj )

Read the energy.

Parameters

d	The driver.
mj	Receives the energy, in mJ.

Returns: SENSE_OK, or the bus error.

◆ ina228_read_power()

sense_err_t ina228_read_power	(	ina228_t *	d,
		uint64_t *	uw )

Read the power.

Parameters

d	The driver.
uw	Receives the power, in µW.

Returns: SENSE_OK, or the bus error.

◆ ina228_read_vbus()

sense_err_t ina228_read_vbus	(	ina228_t *	d,
		int32_t *	uv )

Read the bus voltage.

Parameters

d	The driver.
uv	Receives the bus voltage, in µV.

Returns: SENSE_OK, or the bus error.

◆ ina228_read_vshunt()

sense_err_t ina228_read_vshunt	(	ina228_t *	d,
		sense_value_t *	nv )

Read the shunt voltage.

Parameters

d	The driver.
nv	Receives the shunt voltage, in nV.

Returns: SENSE_OK, or the bus error.

◆ ina228_state()

sense_state_t ina228_state ( const ina228_t * d )

The part's state as of the last probe.

Parameters

d	The driver.

Returns: The sense_state_t of the part.

◆ ina228_step()

bool ina228_step	(	ina228_t *	d,
		uint32_t	now_ms )

Every tick: probes the part when it is due – at the first call, and SENSE_RETRY_MS after it was found absent, wrong, refused or offline.

A probe is 10 transactions, 1075µs of bus time at 400kHz without the controller's own time between them. Returns whether the part is online.

Parameters

d	The driver.
now_ms	The current time, in ms.

Returns: true when the part is online.

◆ ina228_vbus_uv()

int32_t ina228_vbus_uv ( int32_t code )

VBUS in µV, 195.3125µV a step (Table 7-10).

Parameters

code	The VBUS code.

Returns: The bus voltage in µV.

◆ ina228_verify()

sense_err_t ina228_verify	(	ina228_t *	d,
		bool *	lost )

ADC_CONFIG read back against the value written.

A part that resets itself answers with INA228_ADC_RESET at either range, and CONFIG with 0, which is also what ADCRANGE 0 writes: ADC_CONFIG is the register that tells. Such a part computes CURRENT at ADCRANGE 0, a quarter of the truth for a set-up at ADCRANGE 1. Another value than the one written is read a second time at once, so one corrupted read is no reset; when both differ the part is taken offline (sense_part_lost()), lost is set and SENSE_OK returned. A read of FFFFh, the bus that no part drives, takes it offline on that read without a second. lost is false otherwise. The readings are not checked for all ones: CURRENT FFFFFFh is code -1 and taken. One transaction, two on a first mismatch other than FFFFh: 120µs of bus time each at 400kHz.

Parameters

d	The driver.
lost	Set true when the part was taken offline.

Returns: SENSE_OK, or the bus error.

◆ ina228_vshunt_nv()

sense_value_t ina228_vshunt_nv	(	const ina228_cal_t *	cal,
		int32_t	code )

VSHUNT in nV: 312.5 nV a step at ADCRANGE 0, 78.125 nV at 1 (Table 7-9); a code at either end is a clip.

Parameters

cal	The calibration.
code	The VSHUNT code.

Returns: The shunt voltage in nV.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ INA228_ADC_BENCH

◆ INA228_ADDR_MAX

◆ INA228_ADDR_MIN

◆ INA228_DIAG_ALATCH

◆ INA228_DIAG_APOL

◆ INA228_DIAG_BUSOL

◆ INA228_DIAG_BUSUL

◆ INA228_DIAG_CHARGEOF

◆ INA228_DIAG_CNVR

◆ INA228_DIAG_CNVRF

◆ INA228_DIAG_ENERGYOF

◆ INA228_DIAG_MATHOF

◆ INA228_DIAG_MEMSTAT

◆ INA228_DIAG_POL

◆ INA228_DIAG_SHNTOL

◆ INA228_DIAG_SHNTUL

◆ INA228_DIAG_SLOWALERT

◆ INA228_DIAG_TMPOL

◆ INA228_DIE_ID

◆ INA228_FS_MA_LIMIT

◆ INA228_MAKER_ID

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ ina228_setup_err_t

Function Documentation

◆ ina228_adc_config()

◆ ina228_averages()

◆ ina228_calibrate()

◆ ina228_charge_uc()

◆ ina228_clear_totals()

◆ ina228_code20()

◆ ina228_current_ua()

◆ ina228_cycle_us()

◆ ina228_dietemp_mdegc()

◆ ina228_energy_mj()

◆ ina228_identity_ok()

◆ ina228_init()

◆ ina228_power_uw()

◆ ina228_read_charge()

◆ ina228_read_current()

◆ ina228_read_diag()

◆ ina228_read_dietemp()

◆ ina228_read_energy()

◆ ina228_read_power()

◆ ina228_read_vbus()

◆ ina228_read_vshunt()

◆ ina228_state()

◆ ina228_step()

◆ ina228_vbus_uv()

◆ ina228_verify()

◆ ina228_vshunt_nv()