#include <ade7953_base.h>

Inheritance diagram for esphome::ade7953_base::ADE7953:

Public Member Functions
void	set_irq_pin (InternalGPIOPin *irq_pin)

void	set_pga_v (uint8_t pga_v)

void	set_pga_ia (uint8_t pga_ia)

void	set_pga_ib (uint8_t pga_ib)

void	set_vgain (uint32_t vgain)

void	set_aigain (uint32_t aigain)

void	set_bigain (uint32_t bigain)

void	set_awgain (uint32_t awgain)

void	set_bwgain (uint32_t bwgain)

void	set_use_acc_energy_regs (bool use_acc_energy_regs)

void	set_voltage_sensor (sensor::Sensor *voltage_sensor)

void	set_frequency_sensor (sensor::Sensor *frequency_sensor)

void	set_power_factor_a_sensor (sensor::Sensor *power_factor_a)

void	set_power_factor_b_sensor (sensor::Sensor *power_factor_b)

void	set_current_a_sensor (sensor::Sensor *current_a_sensor)

void	set_current_b_sensor (sensor::Sensor *current_b_sensor)

void	set_apparent_power_a_sensor (sensor::Sensor *apparent_power_a)

void	set_apparent_power_b_sensor (sensor::Sensor *apparent_power_b)

void	set_active_power_a_sensor (sensor::Sensor *active_power_a_sensor)

void	set_active_power_b_sensor (sensor::Sensor *active_power_b_sensor)

void	set_reactive_power_a_sensor (sensor::Sensor *reactive_power_a)

void	set_reactive_power_b_sensor (sensor::Sensor *reactive_power_b)

void	setup () override

void	dump_config () override

void	update () override

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

virtual float	get_setup_priority () const
	priority of setup(). 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::sensor::Sensor
	Sensor ()

int8_t	get_accuracy_decimals ()
	Get the accuracy in decimals, using the manual override if set. More...

void	set_accuracy_decimals (int8_t accuracy_decimals)
	Manually set the accuracy in decimals. More...

StateClass	get_state_class ()
	Get the state class, using the manual override if set. More...

void	set_state_class (StateClass state_class)
	Manually set the state class. More...

bool	get_force_update () const
	Get whether force update mode is enabled. More...

void	set_force_update (bool force_update)
	Set force update mode. More...

void	add_filter (Filter *filter)
	Add a filter to the filter chain. Will be appended to the back. More...

void	add_filters (const std::vector< Filter *> &filters)
	Add a list of vectors to the back of the filter chain. More...

void	set_filters (const std::vector< Filter *> &filters)
	Clear the filters and replace them by filters. More...

void	clear_filters ()
	Clear the entire filter chain. More...

float	get_state () const
	Getter-syntax for .state. More...

float	get_raw_state () const
	Getter-syntax for .raw_state. More...

void	publish_state (float state)
	Publish a new state to the front-end. More...

void	add_on_state_callback (std::function< void(float)> &&callback)
	Add a callback that will be called every time a filtered value arrives. More...

void	add_on_raw_state_callback (std::function< void(float)> &&callback)
	Add a callback that will be called every time the sensor sends a raw value. More...

bool	has_state () const
	Return whether this sensor has gotten a full state (that passed through all filters) yet. More...

virtual std::string	unique_id ()
	Override this method to set the unique ID of this sensor. More...

void	internal_send_state_to_frontend (float state)

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

std::string	get_object_id () const

void	set_object_id (const char *object_id)

uint32_t	get_object_id_hash ()

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

std::string	get_icon () const

void	set_icon (const char *icon)

Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set. More...

void	set_device_class (const char *device_class)
	Manually set the device class. More...

Public Member Functions inherited from esphome::EntityBase_UnitOfMeasurement
std::string	get_unit_of_measurement ()
	Get the unit of measurement, using the manual override if set. More...

void	set_unit_of_measurement (const char *unit_of_measurement)
	Manually set the unit of measurement. More...

Protected Member Functions
virtual bool	ade_write_8 (uint16_t reg, uint8_t value)=0

virtual bool	ade_write_16 (uint16_t reg, uint16_t value)=0

virtual bool	ade_write_32 (uint16_t reg, uint32_t value)=0

virtual bool	ade_read_8 (uint16_t reg, uint8_t *value)=0

virtual bool	ade_read_16 (uint16_t reg, uint16_t *value)=0

virtual bool	ade_read_32 (uint16_t reg, uint32_t *value)=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 Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated. More...

void	calc_object_id_ ()

Protected Attributes
InternalGPIOPin *	irq_pin_ {nullptr}

bool	is_setup_ {false}

sensor::Sensor *	voltage_sensor_ {nullptr}

sensor::Sensor *	frequency_sensor_ {nullptr}

sensor::Sensor *	current_a_sensor_ {nullptr}

sensor::Sensor *	current_b_sensor_ {nullptr}

sensor::Sensor *	apparent_power_a_sensor_ {nullptr}

sensor::Sensor *	apparent_power_b_sensor_ {nullptr}

sensor::Sensor *	active_power_a_sensor_ {nullptr}

sensor::Sensor *	active_power_b_sensor_ {nullptr}

sensor::Sensor *	reactive_power_a_sensor_ {nullptr}

sensor::Sensor *	reactive_power_b_sensor_ {nullptr}

sensor::Sensor *	power_factor_a_sensor_ {nullptr}

sensor::Sensor *	power_factor_b_sensor_ {nullptr}

uint8_t	pga_v_

uint8_t	pga_ia_

uint8_t	pga_ib_

uint32_t	vgain_

uint32_t	aigain_

uint32_t	bigain_

uint32_t	awgain_

uint32_t	bwgain_

bool	use_acc_energy_regs_ {false}

uint32_t	last_update_

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::sensor::Sensor
CallbackManager< void(float)>	raw_callback_
	Storage for raw state callbacks. More...

CallbackManager< void(float)>	callback_
	Storage for filtered state callbacks. More...

Filter *	filter_list_ {nullptr}
	Store all active filters. More...

optional< int8_t >	accuracy_decimals_
	Accuracy in decimals override. More...

optional< StateClass >	state_class_ {STATE_CLASS_NONE}
	State class override. More...

bool	force_update_ {false}
	Force update mode. More...

bool	has_state_ {false}

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_

bool	has_own_name_ {false}

bool	internal_ {false}

bool	disabled_by_default_ {false}

EntityCategory	entity_category_ {ENTITY_CATEGORY_NONE}

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override. More...

Protected Attributes inherited from esphome::EntityBase_UnitOfMeasurement
const char *	unit_of_measurement_ {nullptr}
	Unit of measurement override. More...

Additional Inherited Members
Data Fields inherited from esphome::sensor::Sensor
float	state
	This member variable stores the last state that has passed through all filters. More...

float	raw_state
	This member variable stores the current raw state of the sensor, without any filters applied. More...

Detailed Description

Definition at line 39 of file ade7953_base.h.

Member Function Documentation

◆ ade_read_16()

virtual bool esphome::ade7953_base::ADE7953::ade_read_16	(	uint16_t	reg,
		uint16_t *	value
	)

protectedpure virtual

Implemented in esphome::ade7953_spi::AdE7953Spi, and esphome::ade7953_i2c::AdE7953I2c.

◆ ade_read_32()

virtual bool esphome::ade7953_base::ADE7953::ade_read_32	(	uint16_t	reg,
		uint32_t *	value
	)

protectedpure virtual

Implemented in esphome::ade7953_spi::AdE7953Spi, and esphome::ade7953_i2c::AdE7953I2c.

◆ ade_read_8()

virtual bool esphome::ade7953_base::ADE7953::ade_read_8	(	uint16_t	reg,
		uint8_t *	value
	)

protectedpure virtual

Implemented in esphome::ade7953_spi::AdE7953Spi, and esphome::ade7953_i2c::AdE7953I2c.

◆ ade_write_16()

virtual bool esphome::ade7953_base::ADE7953::ade_write_16	(	uint16_t	reg,
		uint16_t	value
	)

protectedpure virtual

Implemented in esphome::ade7953_spi::AdE7953Spi, and esphome::ade7953_i2c::AdE7953I2c.

◆ ade_write_32()

virtual bool esphome::ade7953_base::ADE7953::ade_write_32	(	uint16_t	reg,
		uint32_t	value
	)

protectedpure virtual

Implemented in esphome::ade7953_spi::AdE7953Spi, and esphome::ade7953_i2c::AdE7953I2c.

◆ ade_write_8()

virtual bool esphome::ade7953_base::ADE7953::ade_write_8	(	uint16_t	reg,
		uint8_t	value
	)

protectedpure virtual

Implemented in esphome::ade7953_spi::AdE7953Spi, and esphome::ade7953_i2c::AdE7953I2c.

◆ dump_config()

void esphome::ade7953_base::ADE7953::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::ade7953_spi::AdE7953Spi, and esphome::ade7953_i2c::AdE7953I2c.

Definition at line 47 of file ade7953_base.cpp.

◆ set_active_power_a_sensor()

void esphome::ade7953_base::ADE7953::set_active_power_a_sensor ( sensor::Sensor * active_power_a_sensor )

inline

Definition at line 69 of file ade7953_base.h.

◆ set_active_power_b_sensor()

void esphome::ade7953_base::ADE7953::set_active_power_b_sensor ( sensor::Sensor * active_power_b_sensor )

inline

Definition at line 72 of file ade7953_base.h.

◆ set_aigain()

void esphome::ade7953_base::ADE7953::set_aigain ( uint32_t aigain )

inline

Definition at line 50 of file ade7953_base.h.

◆ set_apparent_power_a_sensor()

void esphome::ade7953_base::ADE7953::set_apparent_power_a_sensor ( sensor::Sensor * apparent_power_a )

inline

Definition at line 66 of file ade7953_base.h.

◆ set_apparent_power_b_sensor()

void esphome::ade7953_base::ADE7953::set_apparent_power_b_sensor ( sensor::Sensor * apparent_power_b )

inline

Definition at line 67 of file ade7953_base.h.

◆ set_awgain()

void esphome::ade7953_base::ADE7953::set_awgain ( uint32_t awgain )

inline

Definition at line 52 of file ade7953_base.h.

◆ set_bigain()

void esphome::ade7953_base::ADE7953::set_bigain ( uint32_t bigain )

inline

Definition at line 51 of file ade7953_base.h.

◆ set_bwgain()

void esphome::ade7953_base::ADE7953::set_bwgain ( uint32_t bwgain )

inline

Definition at line 53 of file ade7953_base.h.

◆ set_current_a_sensor()

void esphome::ade7953_base::ADE7953::set_current_a_sensor ( sensor::Sensor * current_a_sensor )

inline

Definition at line 63 of file ade7953_base.h.

◆ set_current_b_sensor()

void esphome::ade7953_base::ADE7953::set_current_b_sensor ( sensor::Sensor * current_b_sensor )

inline

Definition at line 64 of file ade7953_base.h.

◆ set_frequency_sensor()

void esphome::ade7953_base::ADE7953::set_frequency_sensor ( sensor::Sensor * frequency_sensor )

inline

Definition at line 58 of file ade7953_base.h.

◆ set_irq_pin()

void esphome::ade7953_base::ADE7953::set_irq_pin ( InternalGPIOPin * irq_pin )

inline

Definition at line 41 of file ade7953_base.h.

◆ set_pga_ia()

void esphome::ade7953_base::ADE7953::set_pga_ia ( uint8_t pga_ia )

inline

Definition at line 45 of file ade7953_base.h.

◆ set_pga_ib()

void esphome::ade7953_base::ADE7953::set_pga_ib ( uint8_t pga_ib )

inline

Definition at line 46 of file ade7953_base.h.

◆ set_pga_v()

void esphome::ade7953_base::ADE7953::set_pga_v ( uint8_t pga_v )

inline

Definition at line 44 of file ade7953_base.h.

◆ set_power_factor_a_sensor()

void esphome::ade7953_base::ADE7953::set_power_factor_a_sensor ( sensor::Sensor * power_factor_a )

inline

Definition at line 60 of file ade7953_base.h.

◆ set_power_factor_b_sensor()

void esphome::ade7953_base::ADE7953::set_power_factor_b_sensor ( sensor::Sensor * power_factor_b )

inline

Definition at line 61 of file ade7953_base.h.

◆ set_reactive_power_a_sensor()

void esphome::ade7953_base::ADE7953::set_reactive_power_a_sensor ( sensor::Sensor * reactive_power_a )

inline

Definition at line 76 of file ade7953_base.h.

◆ set_reactive_power_b_sensor()

void esphome::ade7953_base::ADE7953::set_reactive_power_b_sensor ( sensor::Sensor * reactive_power_b )

inline

Definition at line 77 of file ade7953_base.h.

◆ set_use_acc_energy_regs()

void esphome::ade7953_base::ADE7953::set_use_acc_energy_regs ( bool use_acc_energy_regs )

inline

Definition at line 55 of file ade7953_base.h.

◆ set_vgain()

void esphome::ade7953_base::ADE7953::set_vgain ( uint32_t vgain )

inline

Definition at line 49 of file ade7953_base.h.

◆ set_voltage_sensor()

void esphome::ade7953_base::ADE7953::set_voltage_sensor ( sensor::Sensor * voltage_sensor )

inline

Definition at line 57 of file ade7953_base.h.

◆ setup()

void esphome::ade7953_base::ADE7953::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::ade7953_spi::AdE7953Spi.

Definition at line 14 of file ade7953_base.cpp.

◆ update()

void esphome::ade7953_base::ADE7953::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 79 of file ade7953_base.cpp.

Field Documentation

◆ active_power_a_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::active_power_a_sensor_ {nullptr}

protected

Definition at line 94 of file ade7953_base.h.

◆ active_power_b_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::active_power_b_sensor_ {nullptr}

protected

Definition at line 95 of file ade7953_base.h.

◆ aigain_

uint32_t esphome::ade7953_base::ADE7953::aigain_

protected

Definition at line 104 of file ade7953_base.h.

◆ apparent_power_a_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::apparent_power_a_sensor_ {nullptr}

protected

Definition at line 92 of file ade7953_base.h.

◆ apparent_power_b_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::apparent_power_b_sensor_ {nullptr}

protected

Definition at line 93 of file ade7953_base.h.

◆ awgain_

uint32_t esphome::ade7953_base::ADE7953::awgain_

protected

Definition at line 106 of file ade7953_base.h.

◆ bigain_

uint32_t esphome::ade7953_base::ADE7953::bigain_

protected

Definition at line 105 of file ade7953_base.h.

◆ bwgain_

uint32_t esphome::ade7953_base::ADE7953::bwgain_

protected

Definition at line 107 of file ade7953_base.h.

◆ current_a_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::current_a_sensor_ {nullptr}

protected

Definition at line 90 of file ade7953_base.h.

◆ current_b_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::current_b_sensor_ {nullptr}

protected

Definition at line 91 of file ade7953_base.h.

◆ frequency_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::frequency_sensor_ {nullptr}

protected

Definition at line 89 of file ade7953_base.h.

◆ irq_pin_

InternalGPIOPin* esphome::ade7953_base::ADE7953::irq_pin_ {nullptr}

protected

Definition at line 86 of file ade7953_base.h.

◆ is_setup_

bool esphome::ade7953_base::ADE7953::is_setup_ {false}

protected

Definition at line 87 of file ade7953_base.h.

◆ last_update_

uint32_t esphome::ade7953_base::ADE7953::last_update_

protected

Definition at line 109 of file ade7953_base.h.

◆ pga_ia_

uint8_t esphome::ade7953_base::ADE7953::pga_ia_

protected

Definition at line 101 of file ade7953_base.h.

◆ pga_ib_

uint8_t esphome::ade7953_base::ADE7953::pga_ib_

protected

Definition at line 102 of file ade7953_base.h.

◆ pga_v_

uint8_t esphome::ade7953_base::ADE7953::pga_v_

protected

Definition at line 100 of file ade7953_base.h.

◆ power_factor_a_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::power_factor_a_sensor_ {nullptr}

protected

Definition at line 98 of file ade7953_base.h.

◆ power_factor_b_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::power_factor_b_sensor_ {nullptr}

protected

Definition at line 99 of file ade7953_base.h.

◆ reactive_power_a_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::reactive_power_a_sensor_ {nullptr}

protected

Definition at line 96 of file ade7953_base.h.

◆ reactive_power_b_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::reactive_power_b_sensor_ {nullptr}

protected

Definition at line 97 of file ade7953_base.h.

◆ use_acc_energy_regs_

bool esphome::ade7953_base::ADE7953::use_acc_energy_regs_ {false}

protected

Definition at line 108 of file ade7953_base.h.

◆ vgain_

uint32_t esphome::ade7953_base::ADE7953::vgain_

protected

Definition at line 103 of file ade7953_base.h.

◆ voltage_sensor_

sensor::Sensor* esphome::ade7953_base::ADE7953::voltage_sensor_ {nullptr}

protected

Definition at line 88 of file ade7953_base.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ade_read_16()

◆ ade_read_32()

◆ ade_read_8()

◆ ade_write_16()

◆ ade_write_32()

◆ ade_write_8()

◆ dump_config()

◆ set_active_power_a_sensor()

◆ set_active_power_b_sensor()

◆ set_aigain()

◆ set_apparent_power_a_sensor()

◆ set_apparent_power_b_sensor()

◆ set_awgain()

◆ set_bigain()

◆ set_bwgain()

◆ set_current_a_sensor()

◆ set_current_b_sensor()

◆ set_frequency_sensor()

◆ set_irq_pin()

◆ set_pga_ia()

◆ set_pga_ib()

◆ set_pga_v()

◆ set_power_factor_a_sensor()

◆ set_power_factor_b_sensor()

◆ set_reactive_power_a_sensor()

◆ set_reactive_power_b_sensor()

◆ set_use_acc_energy_regs()

◆ set_vgain()

◆ set_voltage_sensor()

◆ setup()

◆ update()

Field Documentation

◆ active_power_a_sensor_

◆ active_power_b_sensor_

◆ aigain_

◆ apparent_power_a_sensor_

◆ apparent_power_b_sensor_

◆ awgain_

◆ bigain_

◆ bwgain_

◆ current_a_sensor_

◆ current_b_sensor_

◆ frequency_sensor_

◆ irq_pin_

◆ is_setup_

◆ last_update_

◆ pga_ia_

◆ pga_ib_

◆ pga_v_

◆ power_factor_a_sensor_

◆ power_factor_b_sensor_

◆ reactive_power_a_sensor_

◆ reactive_power_b_sensor_

◆ use_acc_energy_regs_

◆ vgain_

◆ voltage_sensor_