ESPHome  2023.3.1
Public Member Functions | Protected Attributes
esphome::ina219::INA219Component Class Reference

#include <ina219.h>

Inheritance diagram for esphome::ina219::INA219Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

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_max_voltage_v (float max_voltage_v)
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...
- 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 ()
bool is_ready ()
virtual bool can_proceed ()
bool status_has_warning ()
bool status_has_error ()
void status_set_warning ()
void status_set_error ()
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
void set_i2c_address (uint8_t address)
void set_i2c_bus (I2CBus *bus)
I2CRegister reg (uint8_t a_register)
ErrorCode read (uint8_t *data, size_t len)
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
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 Attributes

float shunt_resistance_ohm_
float max_current_a_
float max_voltage_v_
uint32_t calibration_lsb_
sensor::Sensorbus_voltage_sensor_ {nullptr}
sensor::Sensorshunt_voltage_sensor_ {nullptr}
sensor::Sensorcurrent_sensor_ {nullptr}
sensor::Sensorpower_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}
I2CBusbus_ {nullptr}

Additional Inherited Members

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

Detailed Description

Definition at line 10 of file ina219.h.

Member Function Documentation

◆ dump_config()

void esphome::ina219::INA219Component::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 132 of file ina219.cpp.

◆ get_setup_priority()

float esphome::ina219::INA219Component::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 148 of file ina219.cpp.

◆ set_bus_voltage_sensor()

void esphome::ina219::INA219Component::set_bus_voltage_sensor ( sensor::Sensor bus_voltage_sensor)

Definition at line 20 of file ina219.h.

◆ set_current_sensor()

void esphome::ina219::INA219Component::set_current_sensor ( sensor::Sensor current_sensor)

Definition at line 22 of file ina219.h.

◆ set_max_current_a()

void esphome::ina219::INA219Component::set_max_current_a ( float  max_current_a)

Definition at line 18 of file ina219.h.

◆ set_max_voltage_v()

void esphome::ina219::INA219Component::set_max_voltage_v ( float  max_voltage_v)

Definition at line 19 of file ina219.h.

◆ set_power_sensor()

void esphome::ina219::INA219Component::set_power_sensor ( sensor::Sensor power_sensor)

Definition at line 23 of file ina219.h.

◆ set_shunt_resistance_ohm()

void esphome::ina219::INA219Component::set_shunt_resistance_ohm ( float  shunt_resistance_ohm)

Definition at line 17 of file ina219.h.

◆ set_shunt_voltage_sensor()

void esphome::ina219::INA219Component::set_shunt_voltage_sensor ( sensor::Sensor shunt_voltage_sensor)

Definition at line 21 of file ina219.h.

◆ setup()

void esphome::ina219::INA219Component::setup ( )

Reimplemented from esphome::Component.

Definition at line 36 of file ina219.cpp.

◆ update()

void esphome::ina219::INA219Component::update ( )

Implements esphome::PollingComponent.

Definition at line 150 of file ina219.cpp.

Field Documentation

◆ bus_voltage_sensor_

sensor::Sensor* esphome::ina219::INA219Component::bus_voltage_sensor_ {nullptr}

Definition at line 30 of file ina219.h.

◆ calibration_lsb_

uint32_t esphome::ina219::INA219Component::calibration_lsb_

Definition at line 29 of file ina219.h.

◆ current_sensor_

sensor::Sensor* esphome::ina219::INA219Component::current_sensor_ {nullptr}

Definition at line 32 of file ina219.h.

◆ max_current_a_

float esphome::ina219::INA219Component::max_current_a_

Definition at line 27 of file ina219.h.

◆ max_voltage_v_

float esphome::ina219::INA219Component::max_voltage_v_

Definition at line 28 of file ina219.h.

◆ power_sensor_

sensor::Sensor* esphome::ina219::INA219Component::power_sensor_ {nullptr}

Definition at line 33 of file ina219.h.

◆ shunt_resistance_ohm_

float esphome::ina219::INA219Component::shunt_resistance_ohm_

Definition at line 26 of file ina219.h.

◆ shunt_voltage_sensor_

sensor::Sensor* esphome::ina219::INA219Component::shunt_voltage_sensor_ {nullptr}

Definition at line 31 of file ina219.h.

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