ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::zigbee::ZigbeeComponent Class Referencefinal

#include <zigbee_esp32.h>

Inheritance diagram for esphome::zigbee::ZigbeeComponent:
esphome::Component esphome::Component

Public Member Functions

void setup () override
 
void loop () override
 
void dump_config () override
 
void set_sleepy (bool sleepy)
 
void set_keep_alive (uint32_t keep_alive)
 
void set_basic_cluster (const char *model, const char *manufacturer, const char *location, const char *sw_build_id, uint8_t power_source, uint8_t app_version)
 
void add_cluster (uint8_t endpoint_id, uint16_t cluster_id, uint8_t role)
 
void create_default_cluster (uint8_t endpoint_id, uint16_t device_id)
 
bool register_device ()
 
template<typename T >
void add_attr (ZigbeeAttribute *attr, uint8_t endpoint_id, uint16_t cluster_id, uint8_t role, uint16_t attr_id, uint8_t max_size, T value)
 
template<typename T >
void add_attr (uint8_t endpoint_id, uint16_t cluster_id, uint8_t role, uint16_t attr_id, uint8_t max_size, T value)
 
void factory_reset ()
 
void report ()
 
template<typename F >
void add_on_join_callback (F &&cb)
 
template<typename F >
void add_on_start_callback (F &&cb)
 
bool is_battery_powered ()
 
bool is_started ()
 
bool is_joined ()
 
void setup () override
 
void dump_config () override
 
void add_callback (zb_uint8_t endpoint, std::function< void(zb_bufid_t bufid)> &&cb)
 
template<typename F >
void add_on_join_callback (F &&cb)
 
template<typename F >
void add_on_start_callback (F &&cb)
 
void zboss_signal_handler_esphome (zb_bufid_t bufid)
 
void after_reporting_info (zb_zcl_configure_reporting_req_t *config_rep_req, zb_zcl_attr_addr_info_t *attr_addr_info)
 
void factory_reset ()
 
void force_report ()
 
void loop () override
 
void set_sleepy (bool sleepy)
 
void add_radio_sleep_time_ms (uint32_t ms)
 
- 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)
 
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)
 

Static Public Member Functions

static bool app_signal_handler (const ezb_app_signal_t *app_signal)
 
static void esp_zigbee_alarm_bdb_commissioning (ezb_bdb_comm_mode_mask_t mode)
 

Protected Member Functions

void update_basic_cluster_ (ezb_af_ep_desc_t ep_desc)
 
template<typename T >
void add_attr_ (ZigbeeAttribute *attr, uint8_t endpoint_id, uint16_t cluster_id, uint8_t role, uint16_t attr_id, T *value_p)
 
void handle_attribute_ (ezb_zcl_message_info_t info, ezb_zcl_attribute_t attribute)
 
bool string_attr_exists_ (uint8_t endpoint_id, uint16_t cluster_id, uint8_t role, uint16_t attr_id)
 
void on_join_ (bool factory_new)
 
void on_start_ ()
 
void erase_flash_ (int area)
 
void dump_reporting_ ()
 
- 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.
 
virtual void call_setup ()
 
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_ ()
 

Static Protected Member Functions

static void zcl_device_cb (zb_bufid_t bufid)
 

Protected Attributes

bool sleepy_ {false}
 
uint32_t keep_alive_ {3000}
 
struct { 
 
   uint8_t *   model 
 
   uint8_t *   manufacturer 
 
   uint8_t *   date 
 
   uint8_t *   location 
 
   uint8_t *   sw_build_id 
 
   uint8_t   power_source 
 
   uint8_t   app_version 
 
} basic_cluster_data_ 
 
ezb_nwk_device_type_t device_role_ = EZB_NWK_DEVICE_TYPE_END_DEVICE
 
std::map< std::tuple< uint8_t, uint16_t, uint8_t, uint16_t >, ZigbeeAttribute * > attributes_
 
std::vector< AttrValue > attr_values_
 
ezb_af_device_desc_t dev_desc_ = ezb_af_create_device_desc()
 
CallbackManager< void(bool)> join_cb_ {}
 
esphome::LockFreeQueue< ZBEvent, MAX_ZB_QUEUE_SIZE > zb_events_
 
esphome::EventPool< ZBEvent, MAX_ZB_QUEUE_SIZE - 1 > zb_event_pool_
 
LazyCallbackManager< void()> start_cb_ {}
 
bool start_reported_ {false}
 
std::atomic< bool > started_ = false
 
std::atomic< bool > joined_ = false
 
std::atomic< bool > join_pending_ = false
 
std::atomic< bool > factory_new_ = false
 
std::array< std::function< void(zb_bufid_t bufid)>, ZIGBEE_ENDPOINTS_COUNT > callbacks_ {}
 
bool force_report_ {false}
 
uint32_t sleep_time_ {}
 
uint32_t sleep_remainder_ {}
 
uint32_t radio_sleep_time_ {}
 
uint32_t radio_sleep_remainder_ {}
 
- 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)
 

Detailed Description

Definition at line 69 of file zigbee_zephyr.h.

Member Function Documentation

◆ add_attr() [1/2]

template<typename T >
void esphome::zigbee::ZigbeeComponent::add_attr ( uint8_t endpoint_id,
uint16_t cluster_id,
uint8_t role,
uint16_t attr_id,
uint8_t max_size,
T value )

Definition at line 127 of file zigbee_esp32.h.

◆ add_attr() [2/2]

template<typename T >
void esphome::zigbee::ZigbeeComponent::add_attr ( ZigbeeAttribute * attr,
uint8_t endpoint_id,
uint16_t cluster_id,
uint8_t role,
uint16_t attr_id,
uint8_t max_size,
T value )

Definition at line 133 of file zigbee_esp32.h.

◆ add_attr_()

template<typename T >
void esphome::zigbee::ZigbeeComponent::add_attr_ ( ZigbeeAttribute * attr,
uint8_t endpoint_id,
uint16_t cluster_id,
uint8_t role,
uint16_t attr_id,
T * value_p )
protected

Definition at line 163 of file zigbee_esp32.h.

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

void esphome::zigbee::ZigbeeComponent::add_cluster ( uint8_t endpoint_id,
uint16_t cluster_id,
uint8_t role )

Definition at line 233 of file zigbee_esp32.cpp.

◆ add_on_join_callback() [1/2]

template<typename F >
void esphome::zigbee::ZigbeeComponent::add_on_join_callback ( F && cb)
inline

Definition at line 66 of file zigbee_esp32.h.

◆ add_on_join_callback() [2/2]

template<typename F >
void esphome::zigbee::ZigbeeComponent::add_on_join_callback ( F && cb)
inline

Definition at line 77 of file zigbee_zephyr.h.

◆ add_on_start_callback() [1/2]

template<typename F >
void esphome::zigbee::ZigbeeComponent::add_on_start_callback ( F && cb)
inline

Definition at line 67 of file zigbee_esp32.h.

◆ add_on_start_callback() [2/2]

template<typename F >
void esphome::zigbee::ZigbeeComponent::add_on_start_callback ( F && cb)
inline

Definition at line 78 of file zigbee_zephyr.h.

◆ add_radio_sleep_time_ms()

void esphome::zigbee::ZigbeeComponent::add_radio_sleep_time_ms ( uint32_t ms)

Definition at line 267 of file zigbee_zephyr.cpp.

◆ after_reporting_info()

void esphome::zigbee::ZigbeeComponent::after_reporting_info ( zb_zcl_configure_reporting_req_t * config_rep_req,
zb_zcl_attr_addr_info_t * attr_addr_info )

Definition at line 313 of file zigbee_zephyr.cpp.

◆ app_signal_handler()

bool esphome::zigbee::ZigbeeComponent::app_signal_handler ( const ezb_app_signal_t * app_signal)
static

Definition at line 69 of file zigbee_esp32.cpp.

◆ create_default_cluster()

void esphome::zigbee::ZigbeeComponent::create_default_cluster ( uint8_t endpoint_id,
uint16_t device_id )

Definition at line 221 of file zigbee_esp32.cpp.

◆ dump_config() [1/2]

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

Reimplemented from esphome::Component.

Definition at line 441 of file zigbee_esp32.cpp.

◆ dump_config() [2/2]

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

Reimplemented from esphome::Component.

◆ dump_reporting_()

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

Definition at line 299 of file zigbee_zephyr.cpp.

◆ erase_flash_()

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

Definition at line 148 of file zigbee_zephyr.cpp.

◆ esp_zigbee_alarm_bdb_commissioning()

void esphome::zigbee::ZigbeeComponent::esp_zigbee_alarm_bdb_commissioning ( ezb_bdb_comm_mode_mask_t mode)
static

Definition at line 57 of file zigbee_esp32.cpp.

◆ factory_reset() [1/2]

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

Definition at line 40 of file zigbee_esp32.cpp.

◆ factory_reset() [2/2]

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

◆ force_report()

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

Definition at line 262 of file zigbee_zephyr.cpp.

◆ handle_attribute_()

void esphome::zigbee::ZigbeeComponent::handle_attribute_ ( ezb_zcl_message_info_t info,
ezb_zcl_attribute_t attribute )
protected

Definition at line 214 of file zigbee_esp32.cpp.

◆ is_battery_powered()

bool esphome::zigbee::ZigbeeComponent::is_battery_powered ( )
inline

Definition at line 69 of file zigbee_esp32.h.

◆ is_joined()

bool esphome::zigbee::ZigbeeComponent::is_joined ( )
inline

Definition at line 76 of file zigbee_esp32.h.

◆ is_started()

bool esphome::zigbee::ZigbeeComponent::is_started ( )
inline

Definition at line 73 of file zigbee_esp32.h.

◆ loop() [1/2]

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

Reimplemented from esphome::Component.

Definition at line 405 of file zigbee_esp32.cpp.

◆ loop() [2/2]

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

Reimplemented from esphome::Component.

◆ on_join_()

void esphome::zigbee::ZigbeeComponent::on_join_ ( bool factory_new)
protected

Definition at line 133 of file zigbee_zephyr.cpp.

◆ on_start_()

void esphome::zigbee::ZigbeeComponent::on_start_ ( )
protected

Definition at line 140 of file zigbee_zephyr.cpp.

◆ register_device()

bool esphome::zigbee::ZigbeeComponent::register_device ( )

Definition at line 291 of file zigbee_esp32.cpp.

◆ report()

void esphome::zigbee::ZigbeeComponent::report ( )

Definition at line 51 of file zigbee_esp32.cpp.

◆ set_basic_cluster()

void esphome::zigbee::ZigbeeComponent::set_basic_cluster ( const char * model,
const char * manufacturer,
const char * location,
const char * sw_build_id,
uint8_t power_source,
uint8_t app_version )

Definition at line 246 of file zigbee_esp32.cpp.

◆ set_keep_alive()

void esphome::zigbee::ZigbeeComponent::set_keep_alive ( uint32_t keep_alive)
inline

Definition at line 46 of file zigbee_esp32.h.

◆ set_sleepy() [1/2]

void esphome::zigbee::ZigbeeComponent::set_sleepy ( bool sleepy)
inline

Definition at line 45 of file zigbee_esp32.h.

◆ set_sleepy() [2/2]

void esphome::zigbee::ZigbeeComponent::set_sleepy ( bool sleepy)
inline

Definition at line 84 of file zigbee_zephyr.h.

◆ setup() [1/2]

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

Reimplemented from esphome::Component.

Definition at line 322 of file zigbee_esp32.cpp.

◆ setup() [2/2]

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

Reimplemented from esphome::Component.

◆ string_attr_exists_()

bool esphome::zigbee::ZigbeeComponent::string_attr_exists_ ( uint8_t endpoint_id,
uint16_t cluster_id,
uint8_t role,
uint16_t attr_id )
protected

Definition at line 474 of file zigbee_esp32.cpp.

◆ update_basic_cluster_()

void esphome::zigbee::ZigbeeComponent::update_basic_cluster_ ( ezb_af_ep_desc_t ep_desc)
protected

Definition at line 263 of file zigbee_esp32.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 109 of file zigbee_zephyr.cpp.

Field Documentation

◆ app_version

uint8_t esphome::zigbee::ZigbeeComponent::app_version

Definition at line 88 of file zigbee_esp32.h.

◆ attr_values_

std::vector<AttrValue> esphome::zigbee::ZigbeeComponent::attr_values_
protected

Definition at line 104 of file zigbee_esp32.h.

◆ attributes_

std::map<std::tuple<uint8_t, uint16_t, uint8_t, uint16_t>, ZigbeeAttribute *> esphome::zigbee::ZigbeeComponent::attributes_
protected

Definition at line 103 of file zigbee_esp32.h.

◆ [struct]

struct { ... } esphome::zigbee::ZigbeeComponent::basic_cluster_data_

◆ callbacks_

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

Definition at line 95 of file zigbee_zephyr.h.

◆ date

uint8_t* esphome::zigbee::ZigbeeComponent::date

Definition at line 84 of file zigbee_esp32.h.

◆ dev_desc_

ezb_af_device_desc_t esphome::zigbee::ZigbeeComponent::dev_desc_ = ezb_af_create_device_desc()
protected

Definition at line 105 of file zigbee_esp32.h.

◆ device_role_

ezb_nwk_device_type_t esphome::zigbee::ZigbeeComponent::device_role_ = EZB_NWK_DEVICE_TYPE_END_DEVICE
protected

Definition at line 91 of file zigbee_esp32.h.

◆ factory_new_

std::atomic<bool> esphome::zigbee::ZigbeeComponent::factory_new_ = false
protected

Definition at line 121 of file zigbee_esp32.h.

◆ force_report_

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

Definition at line 98 of file zigbee_zephyr.h.

◆ join_cb_

CallbackManager< void(bool)> esphome::zigbee::ZigbeeComponent::join_cb_ {}
protected

Definition at line 106 of file zigbee_esp32.h.

◆ join_pending_

std::atomic<bool> esphome::zigbee::ZigbeeComponent::join_pending_ = false
protected

Definition at line 120 of file zigbee_esp32.h.

◆ joined_

std::atomic<bool> esphome::zigbee::ZigbeeComponent::joined_ = false
protected

Definition at line 119 of file zigbee_esp32.h.

◆ keep_alive_

uint32_t esphome::zigbee::ZigbeeComponent::keep_alive_ {3000}
protected

Definition at line 80 of file zigbee_esp32.h.

◆ location

uint8_t* esphome::zigbee::ZigbeeComponent::location

Definition at line 85 of file zigbee_esp32.h.

◆ manufacturer

uint8_t* esphome::zigbee::ZigbeeComponent::manufacturer

Definition at line 83 of file zigbee_esp32.h.

◆ model

uint8_t* esphome::zigbee::ZigbeeComponent::model

Definition at line 82 of file zigbee_esp32.h.

◆ power_source

uint8_t esphome::zigbee::ZigbeeComponent::power_source

Definition at line 87 of file zigbee_esp32.h.

◆ radio_sleep_remainder_

uint32_t esphome::zigbee::ZigbeeComponent::radio_sleep_remainder_ {}
protected

Definition at line 102 of file zigbee_zephyr.h.

◆ radio_sleep_time_

uint32_t esphome::zigbee::ZigbeeComponent::radio_sleep_time_ {}
protected

Definition at line 101 of file zigbee_zephyr.h.

◆ sleep_remainder_

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

Definition at line 100 of file zigbee_zephyr.h.

◆ sleep_time_

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

Definition at line 99 of file zigbee_zephyr.h.

◆ sleepy_

bool esphome::zigbee::ZigbeeComponent::sleepy_ {false}
protected

Definition at line 79 of file zigbee_esp32.h.

◆ start_cb_

LazyCallbackManager< void()> esphome::zigbee::ZigbeeComponent::start_cb_ {}
protected

Definition at line 116 of file zigbee_esp32.h.

◆ start_reported_

bool esphome::zigbee::ZigbeeComponent::start_reported_ {false}
protected

Definition at line 117 of file zigbee_esp32.h.

◆ started_

std::atomic<bool> esphome::zigbee::ZigbeeComponent::started_ = false
protected

Definition at line 118 of file zigbee_esp32.h.

◆ sw_build_id

uint8_t* esphome::zigbee::ZigbeeComponent::sw_build_id

Definition at line 86 of file zigbee_esp32.h.

◆ zb_event_pool_

esphome::EventPool<ZBEvent, MAX_ZB_QUEUE_SIZE - 1> esphome::zigbee::ZigbeeComponent::zb_event_pool_
protected

Definition at line 115 of file zigbee_esp32.h.

◆ zb_events_

esphome::LockFreeQueue<ZBEvent, MAX_ZB_QUEUE_SIZE> esphome::zigbee::ZigbeeComponent::zb_events_
protected

Definition at line 108 of file zigbee_esp32.h.


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