#include <ina226.h>

Inheritance diagram for esphome::ina226::INA226Component:

Public Member Functions
void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	update () override

void	set_shunt_resistance_ohm (float shunt_resistance_ohm)

void	set_max_current_a (float max_current_a)

void	set_adc_time_voltage (AdcTime time)

void	set_adc_time_current (AdcTime time)

void	set_adc_avg_samples (AdcAvgSamples samples)

void	set_bus_voltage_sensor (sensor::Sensor *bus_voltage_sensor)

void	set_shunt_voltage_sensor (sensor::Sensor *shunt_voltage_sensor)

void	set_current_sensor (sensor::Sensor *current_sensor)

void	set_power_sensor (sensor::Sensor *power_sensor)

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
virtual void	loop ()
	This method will be called repeatedly. More...

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
int32_t	twos_complement_ (int32_t val, 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...

Protected Attributes
float	shunt_resistance_ohm_

float	max_current_a_

AdcTime	adc_time_voltage_ {AdcTime::ADC_TIME_1100US}

AdcTime	adc_time_current_ {AdcTime::ADC_TIME_1100US}

AdcAvgSamples	adc_avg_samples_ {AdcAvgSamples::ADC_AVG_SAMPLES_4}

uint32_t	calibration_lsb_

sensor::Sensor *	bus_voltage_sensor_ {nullptr}

sensor::Sensor *	shunt_voltage_sensor_ {nullptr}

sensor::Sensor *	current_sensor_ {nullptr}

sensor::Sensor *	power_sensor_ {nullptr}

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 44 of file ina226.h.

Member Function Documentation

◆ dump_config()

void esphome::ina226::INA226Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 86 of file ina226.cpp.

◆ get_setup_priority()

float esphome::ina226::INA226Component::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 106 of file ina226.cpp.

◆ set_adc_avg_samples()

void esphome::ina226::INA226Component::set_adc_avg_samples ( AdcAvgSamples samples )

inline

Definition at line 55 of file ina226.h.

◆ set_adc_time_current()

void esphome::ina226::INA226Component::set_adc_time_current ( AdcTime time )

inline

Definition at line 54 of file ina226.h.

◆ set_adc_time_voltage()

void esphome::ina226::INA226Component::set_adc_time_voltage ( AdcTime time )

inline

Definition at line 53 of file ina226.h.

◆ set_bus_voltage_sensor()

void esphome::ina226::INA226Component::set_bus_voltage_sensor ( sensor::Sensor * bus_voltage_sensor )

inline

Definition at line 57 of file ina226.h.

◆ set_current_sensor()

void esphome::ina226::INA226Component::set_current_sensor ( sensor::Sensor * current_sensor )

inline

Definition at line 59 of file ina226.h.

◆ set_max_current_a()

void esphome::ina226::INA226Component::set_max_current_a ( float max_current_a )

inline

Definition at line 52 of file ina226.h.

◆ set_power_sensor()

void esphome::ina226::INA226Component::set_power_sensor ( sensor::Sensor * power_sensor )

inline

Definition at line 60 of file ina226.h.

◆ set_shunt_resistance_ohm()

void esphome::ina226::INA226Component::set_shunt_resistance_ohm ( float shunt_resistance_ohm )

inline

Definition at line 51 of file ina226.h.

◆ set_shunt_voltage_sensor()

void esphome::ina226::INA226Component::set_shunt_voltage_sensor ( sensor::Sensor * shunt_voltage_sensor )

inline

Definition at line 58 of file ina226.h.

◆ setup()

void esphome::ina226::INA226Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 39 of file ina226.cpp.

◆ twos_complement_()

int32_t esphome::ina226::INA226Component::twos_complement_	(	int32_t	val,
		uint8_t	bits
	)

protected

Definition at line 158 of file ina226.cpp.

◆ update()

void esphome::ina226::INA226Component::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 108 of file ina226.cpp.

Field Documentation

◆ adc_avg_samples_

AdcAvgSamples esphome::ina226::INA226Component::adc_avg_samples_ {AdcAvgSamples::ADC_AVG_SAMPLES_4}

protected

Definition at line 67 of file ina226.h.

◆ adc_time_current_

AdcTime esphome::ina226::INA226Component::adc_time_current_ {AdcTime::ADC_TIME_1100US}

protected

Definition at line 66 of file ina226.h.

◆ adc_time_voltage_

AdcTime esphome::ina226::INA226Component::adc_time_voltage_ {AdcTime::ADC_TIME_1100US}

protected

Definition at line 65 of file ina226.h.

◆ bus_voltage_sensor_

sensor::Sensor* esphome::ina226::INA226Component::bus_voltage_sensor_ {nullptr}

protected

Definition at line 69 of file ina226.h.

◆ calibration_lsb_

uint32_t esphome::ina226::INA226Component::calibration_lsb_

protected

Definition at line 68 of file ina226.h.

◆ current_sensor_

sensor::Sensor* esphome::ina226::INA226Component::current_sensor_ {nullptr}

protected

Definition at line 71 of file ina226.h.

◆ max_current_a_

float esphome::ina226::INA226Component::max_current_a_

protected

Definition at line 64 of file ina226.h.

◆ power_sensor_

sensor::Sensor* esphome::ina226::INA226Component::power_sensor_ {nullptr}

protected

Definition at line 72 of file ina226.h.

◆ shunt_resistance_ohm_

float esphome::ina226::INA226Component::shunt_resistance_ohm_

protected

Definition at line 63 of file ina226.h.

◆ shunt_voltage_sensor_

sensor::Sensor* esphome::ina226::INA226Component::shunt_voltage_sensor_ {nullptr}

protected

Definition at line 70 of file ina226.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ set_adc_avg_samples()

◆ set_adc_time_current()

◆ set_adc_time_voltage()

◆ set_bus_voltage_sensor()

◆ set_current_sensor()

◆ set_max_current_a()

◆ set_power_sensor()

◆ set_shunt_resistance_ohm()

◆ set_shunt_voltage_sensor()

◆ setup()

◆ twos_complement_()

◆ update()

Field Documentation

◆ adc_avg_samples_

◆ adc_time_current_

◆ adc_time_voltage_

◆ bus_voltage_sensor_

◆ calibration_lsb_

◆ current_sensor_

◆ max_current_a_

◆ power_sensor_

◆ shunt_resistance_ohm_

◆ shunt_voltage_sensor_