|
ESPHome 2026.2.3
|
#include <ina2xx_base.h>
Public Member Functions | |
| void | setup () 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_reset_on_boot (bool reset) |
| 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 | |
| virtual float | get_setup_priority () const |
| priority of setup(). | |
| 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. | |
| bool | is_idle () const |
| Check if this component is idle. | |
| virtual void | mark_failed () |
| Mark this component as failed. | |
| ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message) | |
| void | mark_failed (const LogString *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 () |
| ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message) | |
| void | status_set_error (const LogString *message) |
| void | status_clear_warning () |
| void | status_clear_error () |
| void | status_momentary_warning (const char *name, uint32_t length=5000) |
| Set warning status flag and automatically clear it after a timeout. | |
| void | status_momentary_error (const char *name, uint32_t length=5000) |
| Set error status flag and automatically clear it after a timeout. | |
| 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) |
Protected Types | |
| 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 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 &s_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 &_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_component_state_ (uint8_t state) |
| Helper to set component state (clears state bits and sets new state) | |
| void | set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f) |
| Set an interval function with a numeric ID (zero heap allocation). | |
| void | set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f) |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| bool | cancel_interval (uint32_t id) |
| bool | cancel_interval (InternalSchedulerID id) |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name |
| ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id | |
| ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time | |
| ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std | ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name) |
| ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id) | |
| void | set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f) |
| Set a timeout function with a numeric ID (zero heap allocation). | |
| void | set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f) |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| bool | cancel_timeout (uint32_t id) |
| bool | cancel_timeout (InternalSchedulerID id) |
| void | defer (std::function< void()> &&f) |
| Defer a callback to the next loop() call. | |
| void | defer (uint32_t id, std::function< void()> &&f) |
| Defer a callback with a numeric ID (zero heap allocation) | |
| bool | cancel_defer (uint32_t id) |
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} | |
| bool | reset_on_boot_ {true} | |
| 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 | ||
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi | set_interval )(const char *name, uint32_t interval, std::function< void()> &&f) | |
| Set an interval function with a unique name. | ||
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo | cancel_interval )(const char *name) | |
| Cancel an interval function. | ||
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t | initial_wait_time | |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t | max_attempts | |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f | |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) | |
| uint32_t | initial_wait_time | |
| uint32_t uint8_t | max_attempts | |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f | |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) | |
| uint8_t | max_attempts | |
| uint8_t std::function< RetryResult(uint8_t)> && | f | |
| uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) | |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi | set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f) | |
| Set a timeout function with a unique name. | ||
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo | cancel_timeout )(const char *name) | |
| Cancel a timeout function. | ||
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi | defer )(const char *name, std::function< void()> &&f) | |
| Defer a callback to the next loop() call. | ||
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo | cancel_defer )(const char *name) | |
| Cancel a defer callback using the specified name, name must not be empty. | ||
| 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. | ||
Definition at line 114 of file ina2xx_base.h.
|
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 202 of file ina2xx_base.h.
|
protected |
Definition at line 267 of file ina2xx_base.cpp.
|
protected |
Definition at line 342 of file ina2xx_base.cpp.
|
protected |
Definition at line 332 of file ina2xx_base.cpp.
|
protected |
Definition at line 354 of file ina2xx_base.cpp.
|
protected |
Definition at line 372 of file ina2xx_base.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Reimplemented in esphome::ina2xx_i2c::INA2XXI2C, and esphome::ina2xx_spi::INA2XXSPI.
Definition at line 193 of file ina2xx_base.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 91 of file ina2xx_base.cpp.
|
protected |
Definition at line 411 of file ina2xx_base.cpp.
|
protected |
Definition at line 522 of file ina2xx_base.cpp.
|
protected |
Definition at line 460 of file ina2xx_base.cpp.
|
protected |
Definition at line 547 of file ina2xx_base.cpp.
|
protected |
Definition at line 435 of file ina2xx_base.cpp.
|
protected |
Definition at line 501 of file ina2xx_base.cpp.
|
protectedpure virtual |
Implemented in esphome::ina2xx_i2c::INA2XXI2C, and esphome::ina2xx_spi::INA2XXSPI.
|
protected |
Definition at line 486 of file ina2xx_base.cpp.
|
protected |
Definition at line 384 of file ina2xx_base.cpp.
|
protected |
Definition at line 576 of file ina2xx_base.cpp.
|
protected |
Definition at line 595 of file ina2xx_base.cpp.
|
protected |
Definition at line 255 of file ina2xx_base.cpp.
| bool esphome::ina2xx_base::INA2XX::reset_energy_counters | ( | ) |
Definition at line 238 of file ina2xx_base.cpp.
|
inline |
Definition at line 127 of file ina2xx_base.h.
|
inline |
Definition at line 123 of file ina2xx_base.h.
|
inline |
Definition at line 124 of file ina2xx_base.h.
|
inline |
Definition at line 126 of file ina2xx_base.h.
|
inline |
Definition at line 125 of file ina2xx_base.h.
|
inline |
Definition at line 132 of file ina2xx_base.h.
|
inline |
Definition at line 139 of file ina2xx_base.h.
|
inline |
Definition at line 138 of file ina2xx_base.h.
|
inline |
Definition at line 134 of file ina2xx_base.h.
|
inline |
Definition at line 133 of file ina2xx_base.h.
|
inline |
Definition at line 136 of file ina2xx_base.h.
|
inline |
Definition at line 137 of file ina2xx_base.h.
|
inline |
Definition at line 122 of file ina2xx_base.h.
|
inline |
Definition at line 141 of file ina2xx_base.h.
|
inline |
Definition at line 135 of file ina2xx_base.h.
|
inline |
Definition at line 129 of file ina2xx_base.h.
|
inline |
Definition at line 121 of file ina2xx_base.h.
|
inline |
Definition at line 128 of file ina2xx_base.h.
|
inline |
Definition at line 131 of file ina2xx_base.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Reimplemented in esphome::ina2xx_i2c::INA2XXI2C, and esphome::ina2xx_spi::INA2XXSPI.
Definition at line 52 of file ina2xx_base.cpp.
|
protected |
Definition at line 603 of file ina2xx_base.cpp.
|
overridevirtual |
Implements esphome::PollingComponent.
Definition at line 82 of file ina2xx_base.cpp.
|
protectedpure virtual |
Implemented in esphome::ina2xx_i2c::INA2XXI2C, and esphome::ina2xx_spi::INA2XXSPI.
|
protected |
Definition at line 567 of file ina2xx_base.cpp.
|
protected |
Definition at line 173 of file ina2xx_base.h.
|
protected |
Definition at line 169 of file ina2xx_base.h.
|
protected |
Definition at line 170 of file ina2xx_base.h.
|
protected |
Definition at line 172 of file ina2xx_base.h.
|
protected |
Definition at line 171 of file ina2xx_base.h.
|
protected |
Definition at line 190 of file ina2xx_base.h.
| struct { ... } esphome::ina2xx_base::INA2XX::cfg_ |
|
protected |
Definition at line 184 of file ina2xx_base.h.
|
protected |
Definition at line 197 of file ina2xx_base.h.
|
protected |
Definition at line 196 of file ina2xx_base.h.
|
protected |
Definition at line 181 of file ina2xx_base.h.
| int8_t esphome::ina2xx_base::INA2XX::current_lsb_scale_factor |
Definition at line 232 of file ina2xx_base.h.
|
protected |
Definition at line 192 of file ina2xx_base.h.
|
protected |
Definition at line 221 of file ina2xx_base.h.
|
protected |
Definition at line 222 of file ina2xx_base.h.
| float esphome::ina2xx_base::INA2XX::die_temp_lsb |
Definition at line 233 of file ina2xx_base.h.
|
protected |
Definition at line 191 of file ina2xx_base.h.
| float esphome::ina2xx_base::INA2XX::energy_coeff |
Definition at line 235 of file ina2xx_base.h.
|
protected |
Definition at line 183 of file ina2xx_base.h.
|
protected |
Definition at line 194 of file ina2xx_base.h.
|
protected |
Definition at line 195 of file ina2xx_base.h.
|
protected |
Definition at line 215 of file ina2xx_base.h.
|
protected |
Definition at line 220 of file ina2xx_base.h.
|
protected |
Definition at line 168 of file ina2xx_base.h.
|
protected |
| float esphome::ina2xx_base::INA2XX::power_coeff |
Definition at line 234 of file ina2xx_base.h.
|
protected |
Definition at line 193 of file ina2xx_base.h.
|
protected |
Definition at line 175 of file ina2xx_base.h.
|
protected |
Definition at line 180 of file ina2xx_base.h.
| float esphome::ina2xx_base::INA2XX::shunt_cal_scale |
Definition at line 231 of file ina2xx_base.h.
|
protected |
Definition at line 167 of file ina2xx_base.h.
|
protected |
Definition at line 174 of file ina2xx_base.h.
|
protected |
Definition at line 189 of file ina2xx_base.h.
| float esphome::ina2xx_base::INA2XX::v_shunt_lsb_range0 |
Definition at line 229 of file ina2xx_base.h.
| float esphome::ina2xx_base::INA2XX::v_shunt_lsb_range1 |
Definition at line 230 of file ina2xx_base.h.
| float esphome::ina2xx_base::INA2XX::vbus_lsb |
Definition at line 228 of file ina2xx_base.h.