#include <ina2xx_i2c.h>

Inheritance diagram for esphome::ina2xx_i2c::INA2XXI2C:

Public Member Functions
void	setup () override

void	dump_config () override

Public Member Functions inherited from esphome::ina2xx_base::INA2XX
float	get_setup_priority () const override

void	update () override

void	loop () override

void	set_shunt_resistance_ohm (float shunt_resistance_ohm)

void	set_max_current_a (float max_current_a)

void	set_adc_range (uint8_t range)

void	set_adc_time_bus_voltage (AdcTime time)

void	set_adc_time_shunt_voltage (AdcTime time)

void	set_adc_time_die_temperature (AdcTime time)

void	set_adc_avg_samples (AdcAvgSamples samples)

void	set_shunt_tempco (uint16_t coeff)

void	set_shunt_voltage_sensor (sensor::Sensor *sensor)

void	set_bus_voltage_sensor (sensor::Sensor *sensor)

void	set_die_temperature_sensor (sensor::Sensor *sensor)

void	set_current_sensor (sensor::Sensor *sensor)

void	set_power_sensor (sensor::Sensor *sensor)

void	set_energy_sensor_j (sensor::Sensor *sensor)

void	set_energy_sensor_wh (sensor::Sensor *sensor)

void	set_charge_sensor_c (sensor::Sensor *sensor)

void	set_charge_sensor_ah (sensor::Sensor *sensor)

void	set_model (INAModel model)

bool	reset_energy_counters ()

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::i2c::I2CDevice
	I2CDevice ()=default
	we use the C++ default constructor

void	set_i2c_address (uint8_t address)
	We store the address of the device on the bus.

uint8_t	get_i2c_address () const
	Returns the I2C address of the object.

void	set_i2c_bus (I2CBus *bus)
	we store the pointer to the I2CBus to use

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor

ErrorCode	read (uint8_t *data, size_t len) const
	reads an array of bytes from the device using an I2CBus

ErrorCode	read_register (uint8_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	read_register16 (uint16_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	write (const uint8_t *data, size_t len) const
	writes an array of bytes to a device using an I2CBus

ErrorCode	write_read (const uint8_t write_data, size_t write_len, uint8_t read_data, size_t read_len) const
	writes an array of bytes to a device, then reads an array, as a single transaction

ErrorCode	write_register (uint8_t a_register, const uint8_t *data, size_t len) const
	writes an array of bytes to a specific register in the I²C device

ErrorCode	write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
	write an array of bytes to a specific register in the I²C device

bool	read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
	Compat APIs All methods below have been added for compatibility reasons.

bool	read_bytes_raw (uint8_t *data, uint8_t len) const

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes (uint8_t a_register)

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes_raw ()

bool	read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)

bool	read_byte (uint8_t a_register, uint8_t *data)

optional< uint8_t >	read_byte (uint8_t a_register)

bool	read_byte_16 (uint8_t a_register, uint16_t *data)

bool	write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len) const

bool	write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const

template<size_t N>
bool	write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)

bool	write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len) const

bool	write_byte (uint8_t a_register, uint8_t data) const

bool	write_byte_16 (uint8_t a_register, uint16_t data) const

	ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register(uint8_t a_register

	ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register16(uint16_t a_register

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write(const uint8_t *data

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register(uint8_t a_register

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register16(uint16_t a_register

Protected Member Functions
bool	read_ina_register (uint8_t reg, uint8_t *data, size_t len) override

bool	write_ina_register (uint8_t reg, const uint8_t *data, size_t len) override

Protected Member Functions inherited from esphome::ina2xx_base::INA2XX
bool	reset_config_ ()

bool	check_device_model_ ()

bool	configure_adc_ ()

bool	configure_shunt_ ()

bool	configure_shunt_tempco_ ()

bool	configure_adc_range_ ()

bool	read_shunt_voltage_mv_ (float &volt_out)

bool	read_bus_voltage_ (float &volt_out)

bool	read_die_temp_c_ (float &temp)

bool	read_current_a_ (float &amps_out)

bool	read_power_w_ (float &power_out)

bool	read_energy_ (double &joules_out, double &watt_hours_out)

bool	read_charge_ (double &coulombs_out, double &amp_hours_out)

bool	read_diagnostics_and_act_ ()

bool	read_unsigned_ (uint8_t reg, uint8_t reg_size, uint64_t &data_out)

bool	read_unsigned_16_ (uint8_t reg, uint16_t &out)

bool	write_unsigned_16_ (uint8_t reg, uint16_t val)

int64_t	two_complement_ (uint64_t value, uint8_t bits)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Additional Inherited Members
Data Fields inherited from esphome::ina2xx_base::INA2XX
Data Fields inherited from esphome::i2c::I2CDevice
uint8_t *	data

uint8_t size_t	len

uint8_t size_t bool	stop

size_t	len

size_t bool stop	const { return this->write(data, len)

const uint8_t *	data

const uint8_t size_t	len

const uint8_t size_t bool stop	const

Protected Types inherited from esphome::ina2xx_base::INA2XX
enum class	State : uint8_t { NOT_INITIALIZED = 0x0 , IDLE , DATA_COLLECTION_1 , DATA_COLLECTION_2 , DATA_COLLECTION_3 , DATA_COLLECTION_4 , DATA_COLLECTION_5 , DATA_COLLECTION_6 , DATA_COLLECTION_7 , DATA_COLLECTION_8 }

Protected Attributes inherited from esphome::ina2xx_base::INA2XX
float	shunt_resistance_ohm_

float	max_current_a_

AdcRange	adc_range_ {AdcRange::ADC_RANGE_0}

AdcTime	adc_time_bus_voltage_ {AdcTime::ADC_TIME_4120US}

AdcTime	adc_time_shunt_voltage_ {AdcTime::ADC_TIME_4120US}

AdcTime	adc_time_die_temperature_ {AdcTime::ADC_TIME_4120US}

AdcAvgSamples	adc_avg_samples_ {AdcAvgSamples::ADC_AVG_SAMPLES_128}

uint16_t	shunt_tempco_ppm_c_ {0}

uint16_t	shunt_cal_ {0}

float	current_lsb_ {0}

uint32_t	energy_overflows_count_ {0}

uint32_t	charge_overflows_count_ {0}

sensor::Sensor *	shunt_voltage_sensor_ {nullptr}

sensor::Sensor *	bus_voltage_sensor_ {nullptr}

sensor::Sensor *	die_temperature_sensor_ {nullptr}

sensor::Sensor *	current_sensor_ {nullptr}

sensor::Sensor *	power_sensor_ {nullptr}

sensor::Sensor *	energy_sensor_j_ {nullptr}

sensor::Sensor *	energy_sensor_wh_ {nullptr}

sensor::Sensor *	charge_sensor_c_ {nullptr}

sensor::Sensor *	charge_sensor_ah_ {nullptr}

enum esphome::ina2xx_base::INA2XX::State	NOT_INITIALIZED

bool	full_loop_is_okay_ {true}

INAModel	ina_model_ {INAModel::INA_UNKNOWN}

uint16_t	dev_id_ {0}

bool	device_mismatch_ {false}

struct {

float vbus_lsb

float v_shunt_lsb_range0

float v_shunt_lsb_range1

float shunt_cal_scale

int8_t current_lsb_scale_factor

float die_temp_lsb

float power_coeff

float energy_coeff

}	cfg_

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t	address_ {0x00}
	store the address of the device on the bus

I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance

Detailed Description

Definition at line 10 of file ina2xx_i2c.h.

Member Function Documentation

◆ dump_config()

void esphome::ina2xx_i2c::INA2XXI2C::dump_config ( )

overridevirtual

Reimplemented from esphome::ina2xx_base::INA2XX.

Definition at line 18 of file ina2xx_i2c.cpp.

◆ read_ina_register()

bool esphome::ina2xx_i2c::INA2XXI2C::read_ina_register	(	uint8_t	reg,
		uint8_t *	data,
		size_t	len )

overrideprotectedvirtual

Implements esphome::ina2xx_base::INA2XX.

Definition at line 23 of file ina2xx_i2c.cpp.

◆ setup()

void esphome::ina2xx_i2c::INA2XXI2C::setup ( )

overridevirtual

Reimplemented from esphome::ina2xx_base::INA2XX.

Definition at line 9 of file ina2xx_i2c.cpp.

◆ write_ina_register()

bool esphome::ina2xx_i2c::INA2XXI2C::write_ina_register	(	uint8_t	reg,
		const uint8_t *	data,
		size_t	len )

overrideprotectedvirtual

Implements esphome::ina2xx_base::INA2XX.

Definition at line 31 of file ina2xx_i2c.cpp.

The documentation for this class was generated from the following files:

esphome/components/ina2xx_i2c/ina2xx_i2c.h
esphome/components/ina2xx_i2c/ina2xx_i2c.cpp

Public Member Functions