#include <pzem6l24.h>

Inheritance diagram for esphome::pzem6l24::PZEM6L24:

Public Member Functions
SUB_SENSOR(voltage_a) SUB_SENSOR(voltage_b) SUB_SENSOR(voltage_c) SUB_SENSOR(current_a) SUB_SENSOR(current_b) SUB_SENSOR(current_c) SUB_SENSOR(active_power_a) SUB_SENSOR(active_power_b) SUB_SENSOR(active_power_c) SUB_SENSOR(reactive_power_a) SUB_SENSOR(reactive_power_b) SUB_SENSOR(reactive_power_c) SUB_SENSOR(apparent_power_a) SUB_SENSOR(apparent_power_b) SUB_SENSOR(apparent_power_c) SUB_SENSOR(power_factor_a) SUB_SENSOR(power_factor_b) SUB_SENSOR(power_factor_c) SUB_SENSOR(active_energy_a) SUB_SENSOR(active_energy_b) SUB_SENSOR(active_energy_c) SUB_SENSOR(reactive_energy_a) SUB_SENSOR(reactive_energy_b) SUB_SENSOR(reactive_energy_c) SUB_SENSOR(apparent_energy_a) SUB_SENSOR(apparent_energy_b) SUB_SENSOR(apparent_energy_c) SUB_SENSOR(frequency) SUB_SENSOR(total_active_power) SUB_SENSOR(total_reactive_power) SUB_SENSOR(total_apparent_power) SUB_SENSOR(total_power_factor) SUB_SENSOR(total_active_energy) SUB_SENSOR(total_reactive_energy) SUB_SENSOR(total_apparent_energy) public void	update () override

void	on_response (std::span< const uint8_t > request_pdu, std::span< const uint8_t > response_pdu) override

void	on_error (std::span< const uint8_t > request_pdu, modbus::ExceptionCode exception_code) override

bool	on_no_response (std::span< const uint8_t > request_pdu) override

void	on_not_sent (std::span< const uint8_t > request_pdu) override

void	dump_config () 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.

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 void	setup ()
	Where the component's initialization should happen.

virtual void	loop ()
	This method will be called repeatedly.

virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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.

void	mark_failed ()
	Mark this component as failed.

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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Public Member Functions inherited from esphome::modbus::ModbusClientDevice
	ModbusClientDevice ()=default

	ModbusClientDevice (ModbusClientHub *parent, uint8_t address)

virtual	~ModbusClientDevice ()

	ModbusClientDevice (const ModbusClientDevice &)=delete

ModbusClientDevice &	operator= (const ModbusClientDevice &)=delete

	ModbusClientDevice (ModbusClientDevice &&)=delete

ModbusClientDevice &	operator= (ModbusClientDevice &&)=delete

void	set_parent (ModbusClientHub *parent)

void	set_address (uint8_t address)

virtual void	on_sent (std::span< const uint8_t > request_pdu)
	Called when this device's frame is actually written to the wire.

virtual void	on_response (uint8_t address, std::span< const uint8_t > request_pdu, std::span< const uint8_t > response_pdu)
	Overloads of the hooks above with the device address of the request first, taken from the request frame, so it stays correct after set_address().

virtual void	on_error (uint8_t address, std::span< const uint8_t > request_pdu, ExceptionCode exception_code)

virtual void	on_not_sent (uint8_t address, std::span< const uint8_t > request_pdu)

virtual void	on_sent (uint8_t address, std::span< const uint8_t > request_pdu)

virtual bool	on_no_response (uint8_t address, std::span< const uint8_t > request_pdu)

	ESPDEPRECATED ("Override on_not_sent() instead. Removed in 2027.2.0", "2026.8.0") virtual void on_modbus_not_sent()

	ESPDEPRECATED ("Override on_no_response() instead. Removed in 2027.2.0", "2026.8.0") virtual bool on_modbus_no_response()

virtual void	on_read_registers (EntityType entity_type, uint16_t start_address, std::span< const uint16_t > registers, ResponseStatus status)
	High-level typed response callbacks, fired by the default on_response()/on_error() with arguments parsed from the request and response PDUs.

virtual void	on_read_holding_registers (uint16_t start_address, std::span< const uint16_t > registers, ResponseStatus status)

virtual void	on_read_input_registers (uint16_t start_address, std::span< const uint16_t > registers, ResponseStatus status)

virtual void	on_read_bits (EntityType entity_type, uint16_t start_address, PackedBits bits, ResponseStatus status)
	Coil/discrete-input reads are delivered as a PackedBits view (bit 0 = the bit at start_address, bits.size() = the count requested).

virtual void	on_read_coils (uint16_t start_address, PackedBits bits, ResponseStatus status)

virtual void	on_read_discrete_inputs (uint16_t start_address, PackedBits bits, ResponseStatus status)

virtual void	on_write_single_register (uint16_t address, uint16_t value, ResponseStatus status)
	Write acknowledgements.

virtual void	on_write_single_coil (uint16_t address, bool value, ResponseStatus status)

virtual void	on_write_multiple_registers (uint16_t start_address, std::span< const uint16_t > registers, ResponseStatus status)

virtual void	on_write_multiple_coils (uint16_t start_address, PackedBits bits, ResponseStatus status)

virtual void	on_custom_response (std::span< const uint8_t > request_pdu, std::span< const uint8_t > response_pdu, ResponseStatus status)
	Catch-all for custom function codes and anything that is not a standard-conformant transaction (see dispatch_response_()); on failure the response is empty and the exception code is in status.

	ESPDEPRECATED ("Use the typed read_/write_ helpers or queue_pdu() instead. Removed in 2027.2.0", "2026.8.0") void send(uint8_t function

Protected Member Functions
void	publish_ (const uint8_t *data)

void	request_failed_ (std::span< const uint8_t > request_pdu)

void	read_failed_ ()

void	read_finished_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

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 (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

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 (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

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 (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
uint8_t	reads_outstanding_ {0}

uint8_t	consecutive_failures_ {0}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

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 Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Additional Inherited Members
Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Data Fields inherited from esphome::modbus::ModbusClientDevice
uint16_t	start_address

uint16_t uint16_t	number_of_entities

uint16_t uint16_t uint8_t	payload_len = 0

uint16_t uint16_t uint8_t const uint8_t *	payload

ModbusClientHub *	parent_ {nullptr}

uint8_t	address_ {0}

bool	custom_response_warned_ {false}

Detailed Description

Definition at line 38 of file pzem6l24.h.

Member Function Documentation

◆ dump_config()

void esphome::pzem6l24::PZEM6L24::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 265 of file pzem6l24.cpp.

◆ on_error()

void esphome::pzem6l24::PZEM6L24::on_error	(	std::span< const uint8_t >	request_pdu,
		modbus::ExceptionCode	exception_code )

overridevirtual

Reimplemented from esphome::modbus::ModbusClientDevice.

Definition at line 140 of file pzem6l24.cpp.

◆ on_no_response()

bool esphome::pzem6l24::PZEM6L24::on_no_response ( std::span< const uint8_t > request_pdu )

overridevirtual

Reimplemented from esphome::modbus::ModbusClientDevice.

Definition at line 144 of file pzem6l24.cpp.

◆ on_not_sent()

void esphome::pzem6l24::PZEM6L24::on_not_sent ( std::span< const uint8_t > request_pdu )

overridevirtual

Reimplemented from esphome::modbus::ModbusClientDevice.

Definition at line 149 of file pzem6l24.cpp.

◆ on_response()

void esphome::pzem6l24::PZEM6L24::on_response	(	std::span< const uint8_t >	request_pdu,
		std::span< const uint8_t >	response_pdu )

overridevirtual

Reimplemented from esphome::modbus::ModbusClientDevice.

Definition at line 124 of file pzem6l24.cpp.

◆ publish_()

void esphome::pzem6l24::PZEM6L24::publish_ ( const uint8_t * data )

protected

Definition at line 164 of file pzem6l24.cpp.

◆ read_failed_()

void esphome::pzem6l24::PZEM6L24::read_failed_ ( )

protected

Definition at line 309 of file pzem6l24.cpp.

◆ read_finished_()

void esphome::pzem6l24::PZEM6L24::read_finished_ ( )

protected

Definition at line 321 of file pzem6l24.cpp.

◆ request_failed_()

void esphome::pzem6l24::PZEM6L24::request_failed_ ( std::span< const uint8_t > request_pdu )

protected

Definition at line 153 of file pzem6l24.cpp.

◆ update()

void esphome::pzem6l24::PZEM6L24::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 255 of file pzem6l24.cpp.

Field Documentation

◆ consecutive_failures_

uint8_t esphome::pzem6l24::PZEM6L24::consecutive_failures_ {0}

protected

Definition at line 44 of file pzem6l24.h.

◆ reads_outstanding_

uint8_t esphome::pzem6l24::PZEM6L24::reads_outstanding_ {0}

protected

Definition at line 42 of file pzem6l24.h.

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

esphome/components/pzem6l24/pzem6l24.h
esphome/components/pzem6l24/pzem6l24.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ on_error()

◆ on_no_response()

◆ on_not_sent()

◆ on_response()

◆ publish_()

◆ read_failed_()

◆ read_finished_()

◆ request_failed_()

◆ update()

Field Documentation

◆ consecutive_failures_

◆ reads_outstanding_