#include <zigbee_esp32.h>

Inheritance diagram for esphome::zigbee::ZigbeeComponent:

Public Member Functions
	ZigbeeComponent ()

void	setup () override

void	loop () override

void	dump_config () override

void	set_basic_cluster (const char model, const char manufacturer, uint8_t power_source)

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

template<typename F >
void	add_on_join_callback (F &&cb)

bool	is_battery_powered ()

bool	is_started ()

bool	is_connected ()

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)

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)

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

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

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)

Data Fields
std::atomic< bool >	started = false

std::atomic< bool >	joined = false

std::atomic< bool >	factory_new = false

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	on_join_ (bool factory_new)

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.

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
struct {

uint8_t * model

uint8_t * manufacturer

uint8_t * date

uint8_t power_source

}	basic_cluster_data_

bool	connected_ = false

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_

ezb_af_device_desc_t	dev_desc_

CallbackManager< void(bool)>	join_cb_ {}

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_ {}

bool	sleepy_ {}

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_

Detailed Description

Definition at line 69 of file zigbee_zephyr.h.

Constructor & Destructor Documentation

◆ ZigbeeComponent()

esphome::zigbee::ZigbeeComponent::ZigbeeComponent ( )

Definition at line 236 of file zigbee_esp32.cpp.

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 98 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 104 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 122 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 161 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 63 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.

◆ 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 292 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 50 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 144 of file zigbee_esp32.cpp.

◆ dump_config() [1/2]

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 313 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 278 of file zigbee_zephyr.cpp.

◆ erase_flash_()

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

protected

Definition at line 141 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 39 of file zigbee_esp32.cpp.

◆ factory_reset() [1/2]

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

inline

Definition at line 57 of file zigbee_esp32.h.

◆ factory_reset() [2/2]

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

◆ force_report()

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

Definition at line 252 of file zigbee_zephyr.cpp.

◆ is_battery_powered()

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

inline

Definition at line 65 of file zigbee_esp32.h.

◆ is_connected()

bool esphome::zigbee::ZigbeeComponent::is_connected ( )

inline

Definition at line 67 of file zigbee_esp32.h.

◆ is_started()

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

inline

Definition at line 66 of file zigbee_esp32.h.

◆ loop() [1/2]

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 305 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.

◆ register_device()

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

Definition at line 205 of file zigbee_esp32.cpp.

◆ set_basic_cluster()

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

Definition at line 174 of file zigbee_esp32.cpp.

◆ set_sleepy()

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

inline

Definition at line 83 of file zigbee_zephyr.h.

◆ setup() [1/2]

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 266 of file zigbee_esp32.cpp.

◆ setup() [2/2]

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

overridevirtual

Reimplemented from esphome::Component.

◆ update_basic_cluster_()

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

protected

Definition at line 187 of file zigbee_esp32.cpp.

◆ zboss_signal_handler_esphome()

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

Definition at line 25 of file zigbee_zephyr.cpp.

◆ zcl_device_cb()

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

staticprotected

Definition at line 107 of file zigbee_zephyr.cpp.

Field Documentation

◆ attributes_

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

protected

Definition at line 92 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 92 of file zigbee_zephyr.h.

◆ connected_

bool esphome::zigbee::ZigbeeComponent::connected_ = false

protected

Definition at line 79 of file zigbee_esp32.h.

◆ date

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

Definition at line 76 of file zigbee_esp32.h.

◆ dev_desc_

ezb_af_device_desc_t esphome::zigbee::ZigbeeComponent::dev_desc_

protected

Definition at line 93 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 81 of file zigbee_esp32.h.

◆ factory_new

std::atomic<bool> esphome::zigbee::ZigbeeComponent::factory_new = false

Definition at line 70 of file zigbee_esp32.h.

◆ force_report_

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

protected

Definition at line 94 of file zigbee_zephyr.h.

◆ join_cb_

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

protected

Definition at line 94 of file zigbee_esp32.h.

◆ joined

std::atomic<bool> esphome::zigbee::ZigbeeComponent::joined = false

Definition at line 69 of file zigbee_esp32.h.

◆ manufacturer

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

Definition at line 75 of file zigbee_esp32.h.

◆ model

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

Definition at line 74 of file zigbee_esp32.h.

◆ power_source

uint8_t esphome::zigbee::ZigbeeComponent::power_source

Definition at line 77 of file zigbee_esp32.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.

◆ sleepy_

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

protected

Definition at line 97 of file zigbee_zephyr.h.

◆ started

std::atomic<bool> esphome::zigbee::ZigbeeComponent::started = false

Definition at line 68 of file zigbee_esp32.h.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZigbeeComponent()

Member Function Documentation

◆ add_attr() [1/2]

◆ add_attr() [2/2]

◆ add_attr_()

◆ add_callback()

◆ add_cluster()

◆ add_on_join_callback() [1/2]

◆ add_on_join_callback() [2/2]

◆ after_reporting_info()

◆ app_signal_handler()

◆ create_default_cluster()

◆ dump_config() [1/2]

◆ dump_config() [2/2]

◆ dump_reporting_()

◆ erase_flash_()

◆ esp_zigbee_alarm_bdb_commissioning()

◆ factory_reset() [1/2]

◆ factory_reset() [2/2]

◆ force_report()

◆ is_battery_powered()

◆ is_connected()

◆ is_started()

◆ loop() [1/2]

◆ loop() [2/2]

◆ on_join_()

◆ register_device()

◆ set_basic_cluster()

◆ set_sleepy()

◆ setup() [1/2]

◆ setup() [2/2]

◆ update_basic_cluster_()

◆ zboss_signal_handler_esphome()

◆ zcl_device_cb()

Field Documentation

◆ attributes_

◆ [struct]

◆ callbacks_

◆ connected_

◆ date

◆ dev_desc_

◆ device_role_

◆ factory_new

◆ force_report_

◆ join_cb_

◆ joined

◆ manufacturer

◆ model

◆ power_source

◆ sleep_remainder_

◆ sleep_time_

◆ sleepy_

◆ started