#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. More...

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

void	call_setup () override

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

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(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

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="unspecified")

void	status_set_error (const char *message="unspecified")

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 char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

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

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

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

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor More...

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor More...

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

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

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

ErrorCode	write (const uint8_t *data, size_t len, bool stop=true)
	writes an array of bytes to a device using an I2CBus More...

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

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

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

bool	read_bytes_raw (uint8_t *data, uint8_t len)

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, bool stop=true)

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, bool stop=true)

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

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)

bool	write_byte (uint8_t a_register, uint8_t data, bool stop=true)

bool	write_byte_16 (uint8_t a_register, uint16_t data)

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_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

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

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

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. More...

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. More...

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

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

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

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

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

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

Additional Inherited Members
Protected Types inherited from esphome::ina2xx_base::INA2XX
enum	State : uint8_t { State::NOT_INITIALIZED = 0x0, State::IDLE, State::DATA_COLLECTION_1, State::DATA_COLLECTION_2, State::DATA_COLLECTION_3, State::DATA_COLLECTION_4, State::DATA_COLLECTION_5, State::DATA_COLLECTION_6, State::DATA_COLLECTION_7, State::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
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

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

I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance More...

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:

/opt/build/esphome/esphome/components/ina2xx_i2c/ina2xx_i2c.h
/opt/build/esphome/esphome/components/ina2xx_i2c/ina2xx_i2c.cpp

Public Member Functions