#include <zigbee_zephyr.h>

Inheritance diagram for esphome::zigbee::ZigbeeComponent:

Public Member Functions
void	setup () override

void	dump_config () override

void	add_callback (zb_uint8_t endpoint, std::function< void(zb_bufid_t bufid)> &&cb)

void	add_join_callback (std::function< void()> &&cb)

void	zboss_signal_handler_esphome (zb_bufid_t bufid)

void	factory_reset ()

Trigger *	get_join_trigger ()

void	force_report ()

void	loop () override

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 Member Functions
void	on_join_ ()

void	erase_flash_ (int area)

void	dump_reporting_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

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)

Static Protected Member Functions
static void	zcl_device_cb (zb_bufid_t bufid)

Protected Attributes
std::array< std::function< void(zb_bufid_t bufid)>, ZIGBEE_ENDPOINTS_COUNT >	callbacks_ {}

CallbackManager< void()>	join_cb_

Trigger	join_trigger_

bool	force_report_ {false}

uint32_t	sleep_time_ {}

uint32_t	sleep_remainder_ {}

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.

Detailed Description

Definition at line 69 of file zigbee_zephyr.h.

Member Function Documentation

◆ add_callback()

void esphome::zigbee::ZigbeeComponent::add_callback	(	zb_uint8_t	endpoint,
		std::function< void(zb_bufid_t bufid)> &&	cb )

inline

Definition at line 73 of file zigbee_zephyr.h.

◆ add_join_callback()

void esphome::zigbee::ZigbeeComponent::add_join_callback ( std::function< void()> && cb )

inline

Definition at line 77 of file zigbee_zephyr.h.

◆ dump_config()

void esphome::zigbee::ZigbeeComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 211 of file zigbee_zephyr.cpp.

◆ dump_reporting_()

void esphome::zigbee::ZigbeeComponent::dump_reporting_ ( )

protected

Definition at line 258 of file zigbee_zephyr.cpp.

◆ erase_flash_()

void esphome::zigbee::ZigbeeComponent::erase_flash_ ( int area )

protected

Definition at line 139 of file zigbee_zephyr.cpp.

◆ factory_reset()

void esphome::zigbee::ZigbeeComponent::factory_reset ( )

Definition at line 253 of file zigbee_zephyr.cpp.

◆ force_report()

void esphome::zigbee::ZigbeeComponent::force_report ( )

Definition at line 244 of file zigbee_zephyr.cpp.

◆ get_join_trigger()

Trigger * esphome::zigbee::ZigbeeComponent::get_join_trigger ( )

inline

Definition at line 80 of file zigbee_zephyr.h.

◆ loop()

void esphome::zigbee::ZigbeeComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 246 of file zigbee_zephyr.cpp.

◆ on_join_()

void esphome::zigbee::ZigbeeComponent::on_join_ ( )

protected

Definition at line 130 of file zigbee_zephyr.cpp.

◆ setup()

void esphome::zigbee::ZigbeeComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 147 of file zigbee_zephyr.cpp.

◆ zboss_signal_handler_esphome()

void esphome::zigbee::ZigbeeComponent::zboss_signal_handler_esphome ( zb_bufid_t bufid )

Definition at line 24 of file zigbee_zephyr.cpp.

◆ zcl_device_cb()

void esphome::zigbee::ZigbeeComponent::zcl_device_cb ( zb_bufid_t bufid )

staticprotected

Definition at line 106 of file zigbee_zephyr.cpp.

Field Documentation

◆ callbacks_

std::array<std::function<void(zb_bufid_t bufid)>, ZIGBEE_ENDPOINTS_COUNT> esphome::zigbee::ZigbeeComponent::callbacks_ {}

protected

Definition at line 91 of file zigbee_zephyr.h.

◆ force_report_

bool esphome::zigbee::ZigbeeComponent::force_report_ {false}

protected

Definition at line 94 of file zigbee_zephyr.h.

◆ join_cb_

CallbackManager<void()> esphome::zigbee::ZigbeeComponent::join_cb_

protected

Definition at line 92 of file zigbee_zephyr.h.

◆ join_trigger_

Trigger esphome::zigbee::ZigbeeComponent::join_trigger_

protected

Definition at line 93 of file zigbee_zephyr.h.

◆ sleep_remainder_

uint32_t esphome::zigbee::ZigbeeComponent::sleep_remainder_ {}

protected

Definition at line 96 of file zigbee_zephyr.h.

◆ sleep_time_

uint32_t esphome::zigbee::ZigbeeComponent::sleep_time_ {}

protected

Definition at line 95 of file zigbee_zephyr.h.

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

esphome/components/zigbee/zigbee_zephyr.h
esphome/components/zigbee/zigbee_zephyr.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_callback()

◆ add_join_callback()

◆ dump_config()

◆ dump_reporting_()

◆ erase_flash_()

◆ factory_reset()

◆ force_report()

◆ get_join_trigger()

◆ loop()

◆ on_join_()

◆ setup()

◆ zboss_signal_handler_esphome()

◆ zcl_device_cb()

Field Documentation

◆ callbacks_

◆ force_report_

◆ join_cb_

◆ join_trigger_

◆ sleep_remainder_

◆ sleep_time_