ESPHome  2024.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ade7880::ADE7880 Class Reference

#include <ade7880.h>

Inheritance diagram for esphome::ade7880::ADE7880:
esphome::i2c::I2CDevice esphome::PollingComponent esphome::Component

Public Member Functions

void set_irq0_pin (InternalGPIOPin *pin)
 
void set_irq1_pin (InternalGPIOPin *pin)
 
void set_reset_pin (InternalGPIOPin *pin)
 
void set_frequency (float frequency)
 
void set_channel_n (NeutralChannel *channel)
 
void set_channel_a (PowerChannel *channel)
 
void set_channel_b (PowerChannel *channel)
 
void set_channel_c (PowerChannel *channel)
 
void setup () override
 
void loop () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
- 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)
 
- 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 Member Functions

void calibrate_s10zp_reading_ (uint16_t a_register, int16_t calibration)
 
void calibrate_s24zpse_reading_ (uint16_t a_register, int32_t calibration)
 
void init_device_ ()
 
template<typename F >
void update_sensor_from_s24zp_register16_ (sensor::Sensor *sensor, uint16_t a_register, F &&f)
 
template<typename F >
void update_sensor_from_s16_register16_ (sensor::Sensor *sensor, uint16_t a_register, F &&f)
 
template<typename F >
void update_sensor_from_s32_register16_ (sensor::Sensor *sensor, uint16_t a_register, F &&f)
 
void reset_device_ ()
 
uint8_t read_u8_register16_ (uint16_t a_register)
 
int16_t read_s16_register16_ (uint16_t a_register)
 
uint16_t read_u16_register16_ (uint16_t a_register)
 
int32_t read_s24zp_register16_ (uint16_t a_register)
 
int32_t read_s32_register16_ (uint16_t a_register)
 
uint32_t read_u32_register16_ (uint16_t a_register)
 
void write_u8_register16_ (uint16_t a_register, uint8_t value)
 
void write_s10zp_register16_ (uint16_t a_register, int16_t value)
 
void write_u16_register16_ (uint16_t a_register, uint16_t value)
 
void write_s24zpse_register16_ (uint16_t a_register, int32_t value)
 
void write_s32_register16_ (uint16_t a_register, int32_t value)
 
void write_u32_register16_ (uint16_t a_register, uint32_t value)
 
- 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

ADE7880Store store_ {}
 
InternalGPIOPinirq0_pin_ {nullptr}
 
InternalGPIOPinirq1_pin_ {nullptr}
 
InternalGPIOPinreset_pin_ {nullptr}
 
float frequency_
 
NeutralChannelchannel_n_ {nullptr}
 
PowerChannelchannel_a_ {nullptr}
 
PowerChannelchannel_b_ {nullptr}
 
PowerChannelchannel_c_ {nullptr}
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 
- 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 69 of file ade7880.h.

Member Function Documentation

◆ calibrate_s10zp_reading_()

void esphome::ade7880::ADE7880::calibrate_s10zp_reading_ ( uint16_t  a_register,
int16_t  calibration 
)
protected

Definition at line 230 of file ade7880.cpp.

◆ calibrate_s24zpse_reading_()

void esphome::ade7880::ADE7880::calibrate_s24zpse_reading_ ( uint16_t  a_register,
int32_t  calibration 
)
protected

Definition at line 238 of file ade7880.cpp.

◆ dump_config()

void esphome::ade7880::ADE7880::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 164 of file ade7880.cpp.

◆ get_setup_priority()

float esphome::ade7880::ADE7880::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 88 of file ade7880.h.

◆ init_device_()

void esphome::ade7880::ADE7880::init_device_ ( )
protected

Definition at line 246 of file ade7880.cpp.

◆ loop()

void esphome::ade7880::ADE7880::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 57 of file ade7880.cpp.

◆ read_s16_register16_()

int16_t esphome::ade7880::ADE7880::read_s16_register16_ ( uint16_t  a_register)
protected

Definition at line 39 of file ade7880_i2c.cpp.

◆ read_s24zp_register16_()

int32_t esphome::ade7880::ADE7880::read_s24zp_register16_ ( uint16_t  a_register)
protected

Definition at line 51 of file ade7880_i2c.cpp.

◆ read_s32_register16_()

int32_t esphome::ade7880::ADE7880::read_s32_register16_ ( uint16_t  a_register)
protected

Definition at line 58 of file ade7880_i2c.cpp.

◆ read_u16_register16_()

uint16_t esphome::ade7880::ADE7880::read_u16_register16_ ( uint16_t  a_register)
protected

Definition at line 45 of file ade7880_i2c.cpp.

◆ read_u32_register16_()

uint32_t esphome::ade7880::ADE7880::read_u32_register16_ ( uint16_t  a_register)
protected

Definition at line 64 of file ade7880_i2c.cpp.

◆ read_u8_register16_()

uint8_t esphome::ade7880::ADE7880::read_u8_register16_ ( uint16_t  a_register)
protected

Definition at line 33 of file ade7880_i2c.cpp.

◆ reset_device_()

void esphome::ade7880::ADE7880::reset_device_ ( )
protected

Definition at line 290 of file ade7880.cpp.

◆ set_channel_a()

void esphome::ade7880::ADE7880::set_channel_a ( PowerChannel channel)
inline

Definition at line 76 of file ade7880.h.

◆ set_channel_b()

void esphome::ade7880::ADE7880::set_channel_b ( PowerChannel channel)
inline

Definition at line 77 of file ade7880.h.

◆ set_channel_c()

void esphome::ade7880::ADE7880::set_channel_c ( PowerChannel channel)
inline

Definition at line 78 of file ade7880.h.

◆ set_channel_n()

void esphome::ade7880::ADE7880::set_channel_n ( NeutralChannel channel)
inline

Definition at line 75 of file ade7880.h.

◆ set_frequency()

void esphome::ade7880::ADE7880::set_frequency ( float  frequency)
inline

Definition at line 74 of file ade7880.h.

◆ set_irq0_pin()

void esphome::ade7880::ADE7880::set_irq0_pin ( InternalGPIOPin pin)
inline

Definition at line 71 of file ade7880.h.

◆ set_irq1_pin()

void esphome::ade7880::ADE7880::set_irq1_pin ( InternalGPIOPin pin)
inline

Definition at line 72 of file ade7880.h.

◆ set_reset_pin()

void esphome::ade7880::ADE7880::set_reset_pin ( InternalGPIOPin pin)
inline

Definition at line 73 of file ade7880.h.

◆ setup()

void esphome::ade7880::ADE7880::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file ade7880.cpp.

◆ update()

void esphome::ade7880::ADE7880::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 101 of file ade7880.cpp.

◆ update_sensor_from_s16_register16_()

template<typename F >
void esphome::ade7880::ADE7880::update_sensor_from_s16_register16_ ( sensor::Sensor sensor,
uint16_t  a_register,
F &&  f 
)
protected

Definition at line 82 of file ade7880.cpp.

◆ update_sensor_from_s24zp_register16_()

template<typename F >
void esphome::ade7880::ADE7880::update_sensor_from_s24zp_register16_ ( sensor::Sensor sensor,
uint16_t  a_register,
F &&  f 
)
protected

Definition at line 72 of file ade7880.cpp.

◆ update_sensor_from_s32_register16_()

template<typename F >
void esphome::ade7880::ADE7880::update_sensor_from_s32_register16_ ( sensor::Sensor sensor,
uint16_t  a_register,
F &&  f 
)
protected

Definition at line 92 of file ade7880.cpp.

◆ write_s10zp_register16_()

void esphome::ade7880::ADE7880::write_s10zp_register16_ ( uint16_t  a_register,
int16_t  value 
)
protected

Definition at line 74 of file ade7880_i2c.cpp.

◆ write_s24zpse_register16_()

void esphome::ade7880::ADE7880::write_s24zpse_register16_ ( uint16_t  a_register,
int32_t  value 
)
protected

Definition at line 84 of file ade7880_i2c.cpp.

◆ write_s32_register16_()

void esphome::ade7880::ADE7880::write_s32_register16_ ( uint16_t  a_register,
int32_t  value 
)
protected

Definition at line 90 of file ade7880_i2c.cpp.

◆ write_u16_register16_()

void esphome::ade7880::ADE7880::write_u16_register16_ ( uint16_t  a_register,
uint16_t  value 
)
protected

Definition at line 79 of file ade7880_i2c.cpp.

◆ write_u32_register16_()

void esphome::ade7880::ADE7880::write_u32_register16_ ( uint16_t  a_register,
uint32_t  value 
)
protected

Definition at line 95 of file ade7880_i2c.cpp.

◆ write_u8_register16_()

void esphome::ade7880::ADE7880::write_u8_register16_ ( uint16_t  a_register,
uint8_t  value 
)
protected

Definition at line 70 of file ade7880_i2c.cpp.

Field Documentation

◆ channel_a_

PowerChannel* esphome::ade7880::ADE7880::channel_a_ {nullptr}
protected

Definition at line 97 of file ade7880.h.

◆ channel_b_

PowerChannel* esphome::ade7880::ADE7880::channel_b_ {nullptr}
protected

Definition at line 98 of file ade7880.h.

◆ channel_c_

PowerChannel* esphome::ade7880::ADE7880::channel_c_ {nullptr}
protected

Definition at line 99 of file ade7880.h.

◆ channel_n_

NeutralChannel* esphome::ade7880::ADE7880::channel_n_ {nullptr}
protected

Definition at line 96 of file ade7880.h.

◆ frequency_

float esphome::ade7880::ADE7880::frequency_
protected

Definition at line 95 of file ade7880.h.

◆ irq0_pin_

InternalGPIOPin* esphome::ade7880::ADE7880::irq0_pin_ {nullptr}
protected

Definition at line 92 of file ade7880.h.

◆ irq1_pin_

InternalGPIOPin* esphome::ade7880::ADE7880::irq1_pin_ {nullptr}
protected

Definition at line 93 of file ade7880.h.

◆ reset_pin_

InternalGPIOPin* esphome::ade7880::ADE7880::reset_pin_ {nullptr}
protected

Definition at line 94 of file ade7880.h.

◆ store_

ADE7880Store esphome::ade7880::ADE7880::store_ {}
protected

Definition at line 91 of file ade7880.h.


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