ESPHome  2024.11.1
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::ina2xx_base::INA2XX Class Referenceabstract

#include <ina2xx_base.h>

Inheritance diagram for esphome::ina2xx_base::INA2XX:
esphome::PollingComponent esphome::Component esphome::ina2xx_i2c::INA2XXI2C esphome::ina2xx_spi::INA2XXSPI

Public Member Functions

void setup () override
 
float get_setup_priority () const override
 
void update () override
 
void loop () override
 
void dump_config () 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...
 

Protected Types

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 Member Functions

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)
 
virtual bool read_ina_register (uint8_t a_register, uint8_t *data, size_t len)=0
 
virtual bool write_ina_register (uint8_t a_register, const uint8_t *data, size_t len)=0
 
- 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_
 
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::Sensorshunt_voltage_sensor_ {nullptr}
 
sensor::Sensorbus_voltage_sensor_ {nullptr}
 
sensor::Sensordie_temperature_sensor_ {nullptr}
 
sensor::Sensorcurrent_sensor_ {nullptr}
 
sensor::Sensorpower_sensor_ {nullptr}
 
sensor::Sensorenergy_sensor_j_ {nullptr}
 
sensor::Sensorenergy_sensor_wh_ {nullptr}
 
sensor::Sensorcharge_sensor_c_ {nullptr}
 
sensor::Sensorcharge_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}
 

Detailed Description

Definition at line 114 of file ina2xx_base.h.

Member Enumeration Documentation

◆ State

enum esphome::ina2xx_base::INA2XX::State : uint8_t
strongprotected
Enumerator
NOT_INITIALIZED 
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 

Definition at line 201 of file ina2xx_base.h.

Member Function Documentation

◆ check_device_model_()

bool esphome::ina2xx_base::INA2XX::check_device_model_ ( )
protected

Definition at line 262 of file ina2xx_base.cpp.

◆ configure_adc_()

bool esphome::ina2xx_base::INA2XX::configure_adc_ ( )
protected

Definition at line 337 of file ina2xx_base.cpp.

◆ configure_adc_range_()

bool esphome::ina2xx_base::INA2XX::configure_adc_range_ ( )
protected

Definition at line 327 of file ina2xx_base.cpp.

◆ configure_shunt_()

bool esphome::ina2xx_base::INA2XX::configure_shunt_ ( )
protected

Definition at line 349 of file ina2xx_base.cpp.

◆ configure_shunt_tempco_()

bool esphome::ina2xx_base::INA2XX::configure_shunt_tempco_ ( )
protected

Definition at line 365 of file ina2xx_base.cpp.

◆ dump_config()

void esphome::ina2xx_base::INA2XX::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::ina2xx_spi::INA2XXSPI, and esphome::ina2xx_i2c::INA2XXI2C.

Definition at line 197 of file ina2xx_base.cpp.

◆ get_setup_priority()

float esphome::ina2xx_base::INA2XX::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 84 of file ina2xx_base.cpp.

◆ loop()

void esphome::ina2xx_base::INA2XX::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 95 of file ina2xx_base.cpp.

◆ read_bus_voltage_()

bool esphome::ina2xx_base::INA2XX::read_bus_voltage_ ( float &  volt_out)
protected

Definition at line 404 of file ina2xx_base.cpp.

◆ read_charge_()

bool esphome::ina2xx_base::INA2XX::read_charge_ ( double &  coulombs_out,
double &  amp_hours_out 
)
protected

Definition at line 515 of file ina2xx_base.cpp.

◆ read_current_a_()

bool esphome::ina2xx_base::INA2XX::read_current_a_ ( float &  amps_out)
protected

Definition at line 453 of file ina2xx_base.cpp.

◆ read_diagnostics_and_act_()

bool esphome::ina2xx_base::INA2XX::read_diagnostics_and_act_ ( )
protected

Definition at line 540 of file ina2xx_base.cpp.

◆ read_die_temp_c_()

bool esphome::ina2xx_base::INA2XX::read_die_temp_c_ ( float &  temp)
protected

Definition at line 428 of file ina2xx_base.cpp.

◆ read_energy_()

bool esphome::ina2xx_base::INA2XX::read_energy_ ( double &  joules_out,
double &  watt_hours_out 
)
protected

Definition at line 494 of file ina2xx_base.cpp.

◆ read_ina_register()

virtual bool esphome::ina2xx_base::INA2XX::read_ina_register ( uint8_t  a_register,
uint8_t *  data,
size_t  len 
)
protectedpure virtual

◆ read_power_w_()

bool esphome::ina2xx_base::INA2XX::read_power_w_ ( float &  power_out)
protected

Definition at line 479 of file ina2xx_base.cpp.

◆ read_shunt_voltage_mv_()

bool esphome::ina2xx_base::INA2XX::read_shunt_voltage_mv_ ( float &  volt_out)
protected

Definition at line 377 of file ina2xx_base.cpp.

◆ read_unsigned_()

bool esphome::ina2xx_base::INA2XX::read_unsigned_ ( uint8_t  reg,
uint8_t  reg_size,
uint64_t &  data_out 
)
protected

Definition at line 569 of file ina2xx_base.cpp.

◆ read_unsigned_16_()

bool esphome::ina2xx_base::INA2XX::read_unsigned_16_ ( uint8_t  reg,
uint16_t &  out 
)
protected

Definition at line 588 of file ina2xx_base.cpp.

◆ reset_config_()

bool esphome::ina2xx_base::INA2XX::reset_config_ ( )
protected

Definition at line 255 of file ina2xx_base.cpp.

◆ reset_energy_counters()

bool esphome::ina2xx_base::INA2XX::reset_energy_counters ( )

Definition at line 238 of file ina2xx_base.cpp.

◆ set_adc_avg_samples()

void esphome::ina2xx_base::INA2XX::set_adc_avg_samples ( AdcAvgSamples  samples)
inline

Definition at line 128 of file ina2xx_base.h.

◆ set_adc_range()

void esphome::ina2xx_base::INA2XX::set_adc_range ( uint8_t  range)
inline

Definition at line 124 of file ina2xx_base.h.

◆ set_adc_time_bus_voltage()

void esphome::ina2xx_base::INA2XX::set_adc_time_bus_voltage ( AdcTime  time)
inline

Definition at line 125 of file ina2xx_base.h.

◆ set_adc_time_die_temperature()

void esphome::ina2xx_base::INA2XX::set_adc_time_die_temperature ( AdcTime  time)
inline

Definition at line 127 of file ina2xx_base.h.

◆ set_adc_time_shunt_voltage()

void esphome::ina2xx_base::INA2XX::set_adc_time_shunt_voltage ( AdcTime  time)
inline

Definition at line 126 of file ina2xx_base.h.

◆ set_bus_voltage_sensor()

void esphome::ina2xx_base::INA2XX::set_bus_voltage_sensor ( sensor::Sensor sensor)
inline

Definition at line 132 of file ina2xx_base.h.

◆ set_charge_sensor_ah()

void esphome::ina2xx_base::INA2XX::set_charge_sensor_ah ( sensor::Sensor sensor)
inline

Definition at line 139 of file ina2xx_base.h.

◆ set_charge_sensor_c()

void esphome::ina2xx_base::INA2XX::set_charge_sensor_c ( sensor::Sensor sensor)
inline

Definition at line 138 of file ina2xx_base.h.

◆ set_current_sensor()

void esphome::ina2xx_base::INA2XX::set_current_sensor ( sensor::Sensor sensor)
inline

Definition at line 134 of file ina2xx_base.h.

◆ set_die_temperature_sensor()

void esphome::ina2xx_base::INA2XX::set_die_temperature_sensor ( sensor::Sensor sensor)
inline

Definition at line 133 of file ina2xx_base.h.

◆ set_energy_sensor_j()

void esphome::ina2xx_base::INA2XX::set_energy_sensor_j ( sensor::Sensor sensor)
inline

Definition at line 136 of file ina2xx_base.h.

◆ set_energy_sensor_wh()

void esphome::ina2xx_base::INA2XX::set_energy_sensor_wh ( sensor::Sensor sensor)
inline

Definition at line 137 of file ina2xx_base.h.

◆ set_max_current_a()

void esphome::ina2xx_base::INA2XX::set_max_current_a ( float  max_current_a)
inline

Definition at line 123 of file ina2xx_base.h.

◆ set_model()

void esphome::ina2xx_base::INA2XX::set_model ( INAModel  model)
inline

Definition at line 141 of file ina2xx_base.h.

◆ set_power_sensor()

void esphome::ina2xx_base::INA2XX::set_power_sensor ( sensor::Sensor sensor)
inline

Definition at line 135 of file ina2xx_base.h.

◆ set_shunt_resistance_ohm()

void esphome::ina2xx_base::INA2XX::set_shunt_resistance_ohm ( float  shunt_resistance_ohm)
inline

Definition at line 122 of file ina2xx_base.h.

◆ set_shunt_tempco()

void esphome::ina2xx_base::INA2XX::set_shunt_tempco ( uint16_t  coeff)
inline

Definition at line 129 of file ina2xx_base.h.

◆ set_shunt_voltage_sensor()

void esphome::ina2xx_base::INA2XX::set_shunt_voltage_sensor ( sensor::Sensor sensor)
inline

Definition at line 131 of file ina2xx_base.h.

◆ setup()

void esphome::ina2xx_base::INA2XX::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::ina2xx_spi::INA2XXSPI, and esphome::ina2xx_i2c::INA2XXI2C.

Definition at line 52 of file ina2xx_base.cpp.

◆ two_complement_()

int64_t esphome::ina2xx_base::INA2XX::two_complement_ ( uint64_t  value,
uint8_t  bits 
)
protected

Definition at line 596 of file ina2xx_base.cpp.

◆ update()

void esphome::ina2xx_base::INA2XX::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 86 of file ina2xx_base.cpp.

◆ write_ina_register()

virtual bool esphome::ina2xx_base::INA2XX::write_ina_register ( uint8_t  a_register,
const uint8_t *  data,
size_t  len 
)
protectedpure virtual

◆ write_unsigned_16_()

bool esphome::ina2xx_base::INA2XX::write_unsigned_16_ ( uint8_t  reg,
uint16_t  val 
)
protected

Definition at line 560 of file ina2xx_base.cpp.

Field Documentation

◆ adc_avg_samples_

AdcAvgSamples esphome::ina2xx_base::INA2XX::adc_avg_samples_ {AdcAvgSamples::ADC_AVG_SAMPLES_128}
protected

Definition at line 173 of file ina2xx_base.h.

◆ adc_range_

AdcRange esphome::ina2xx_base::INA2XX::adc_range_ {AdcRange::ADC_RANGE_0}
protected

Definition at line 169 of file ina2xx_base.h.

◆ adc_time_bus_voltage_

AdcTime esphome::ina2xx_base::INA2XX::adc_time_bus_voltage_ {AdcTime::ADC_TIME_4120US}
protected

Definition at line 170 of file ina2xx_base.h.

◆ adc_time_die_temperature_

AdcTime esphome::ina2xx_base::INA2XX::adc_time_die_temperature_ {AdcTime::ADC_TIME_4120US}
protected

Definition at line 172 of file ina2xx_base.h.

◆ adc_time_shunt_voltage_

AdcTime esphome::ina2xx_base::INA2XX::adc_time_shunt_voltage_ {AdcTime::ADC_TIME_4120US}
protected

Definition at line 171 of file ina2xx_base.h.

◆ bus_voltage_sensor_

sensor::Sensor* esphome::ina2xx_base::INA2XX::bus_voltage_sensor_ {nullptr}
protected

Definition at line 189 of file ina2xx_base.h.

◆ cfg_

struct { ... } esphome::ina2xx_base::INA2XX::cfg_

◆ charge_overflows_count_

uint32_t esphome::ina2xx_base::INA2XX::charge_overflows_count_ {0}
protected

Definition at line 183 of file ina2xx_base.h.

◆ charge_sensor_ah_

sensor::Sensor* esphome::ina2xx_base::INA2XX::charge_sensor_ah_ {nullptr}
protected

Definition at line 196 of file ina2xx_base.h.

◆ charge_sensor_c_

sensor::Sensor* esphome::ina2xx_base::INA2XX::charge_sensor_c_ {nullptr}
protected

Definition at line 195 of file ina2xx_base.h.

◆ current_lsb_

float esphome::ina2xx_base::INA2XX::current_lsb_ {0}
protected

Definition at line 180 of file ina2xx_base.h.

◆ current_lsb_scale_factor

int8_t esphome::ina2xx_base::INA2XX::current_lsb_scale_factor

Definition at line 231 of file ina2xx_base.h.

◆ current_sensor_

sensor::Sensor* esphome::ina2xx_base::INA2XX::current_sensor_ {nullptr}
protected

Definition at line 191 of file ina2xx_base.h.

◆ dev_id_

uint16_t esphome::ina2xx_base::INA2XX::dev_id_ {0}
protected

Definition at line 220 of file ina2xx_base.h.

◆ device_mismatch_

bool esphome::ina2xx_base::INA2XX::device_mismatch_ {false}
protected

Definition at line 221 of file ina2xx_base.h.

◆ die_temp_lsb

float esphome::ina2xx_base::INA2XX::die_temp_lsb

Definition at line 232 of file ina2xx_base.h.

◆ die_temperature_sensor_

sensor::Sensor* esphome::ina2xx_base::INA2XX::die_temperature_sensor_ {nullptr}
protected

Definition at line 190 of file ina2xx_base.h.

◆ energy_coeff

float esphome::ina2xx_base::INA2XX::energy_coeff

Definition at line 234 of file ina2xx_base.h.

◆ energy_overflows_count_

uint32_t esphome::ina2xx_base::INA2XX::energy_overflows_count_ {0}
protected

Definition at line 182 of file ina2xx_base.h.

◆ energy_sensor_j_

sensor::Sensor* esphome::ina2xx_base::INA2XX::energy_sensor_j_ {nullptr}
protected

Definition at line 193 of file ina2xx_base.h.

◆ energy_sensor_wh_

sensor::Sensor* esphome::ina2xx_base::INA2XX::energy_sensor_wh_ {nullptr}
protected

Definition at line 194 of file ina2xx_base.h.

◆ full_loop_is_okay_

bool esphome::ina2xx_base::INA2XX::full_loop_is_okay_ {true}
protected

Definition at line 214 of file ina2xx_base.h.

◆ ina_model_

INAModel esphome::ina2xx_base::INA2XX::ina_model_ {INAModel::INA_UNKNOWN}
protected

Definition at line 219 of file ina2xx_base.h.

◆ max_current_a_

float esphome::ina2xx_base::INA2XX::max_current_a_
protected

Definition at line 168 of file ina2xx_base.h.

◆ NOT_INITIALIZED

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

◆ power_coeff

float esphome::ina2xx_base::INA2XX::power_coeff

Definition at line 233 of file ina2xx_base.h.

◆ power_sensor_

sensor::Sensor* esphome::ina2xx_base::INA2XX::power_sensor_ {nullptr}
protected

Definition at line 192 of file ina2xx_base.h.

◆ shunt_cal_

uint16_t esphome::ina2xx_base::INA2XX::shunt_cal_ {0}
protected

Definition at line 179 of file ina2xx_base.h.

◆ shunt_cal_scale

float esphome::ina2xx_base::INA2XX::shunt_cal_scale

Definition at line 230 of file ina2xx_base.h.

◆ shunt_resistance_ohm_

float esphome::ina2xx_base::INA2XX::shunt_resistance_ohm_
protected

Definition at line 167 of file ina2xx_base.h.

◆ shunt_tempco_ppm_c_

uint16_t esphome::ina2xx_base::INA2XX::shunt_tempco_ppm_c_ {0}
protected

Definition at line 174 of file ina2xx_base.h.

◆ shunt_voltage_sensor_

sensor::Sensor* esphome::ina2xx_base::INA2XX::shunt_voltage_sensor_ {nullptr}
protected

Definition at line 188 of file ina2xx_base.h.

◆ v_shunt_lsb_range0

float esphome::ina2xx_base::INA2XX::v_shunt_lsb_range0

Definition at line 228 of file ina2xx_base.h.

◆ v_shunt_lsb_range1

float esphome::ina2xx_base::INA2XX::v_shunt_lsb_range1

Definition at line 229 of file ina2xx_base.h.

◆ vbus_lsb

float esphome::ina2xx_base::INA2XX::vbus_lsb

Definition at line 227 of file ina2xx_base.h.


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