#include <bk72xx_ble.h>

Inheritance diagram for esphome::bk72xx_ble::BK72xxBLE:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

void	enable ()
	Bring up the BDK BLE stack (one-time; the BDK has no teardown path).

bool	is_active () const

void	set_enable_on_boot (bool enable_on_boot)

void	get_mac_lsb_first (uint8_t out[MAC_ADDRESS_SIZE]) const
	Controller BLE address, least-significant octet first (BLE convention).

void	register_scan_listener (BLEScanListener *listener)
	Register a consumer for scan reports (delivered on the main task via loop()).

ScanOpResult	scan_start (uint16_t interval, uint16_t window, bool active)
	Request a scan (interval/window in 0.625 ms BLE units); enables the stack first if needed.

void	scan_stop ()
	Request the scanner stopped and the activity released; steps that cannot run yet are completed from loop().

bool	flush_pending_stop (uint32_t timeout_ms)
	Drive a requested stop until the radio is observed idle, bounded by timeout_ms (for OTA).

ScanOpResult	last_scan_result () const
	Last reconciliation outcome; on FAILED the consumer's retry policy owns recovery.

void	enqueue_scan_report (const uint8_t mac, int8_t rssi, uint8_t addr_type, uint8_t evt_type, const uint8_t data, uint16_t data_len)
	Internal: buffer one controller report (BDK notice callback, BLE task context — bounded copy under the scheduler lock, nothing else).

Public Member Functions inherited from esphome::Component
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)

Protected Member Functions
void	resolve_mac_ ()

ScanOpResult	advance_ ()

ScanOpResult	advance_stop_ (BdkActivityState state, bool ready)

ScanOpResult	advance_start_ (BdkActivityState state, bool ready)

bool	teardown_stuck_ (uint32_t now)

void	reset_teardown_episode_ ()

void	release_activity_ (BdkActivityState state)

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

Protected Attributes
StaticVector< BLEScanListener *, BK72XX_BLE_SCAN_LISTENER_COUNT >	scan_listeners_

esphome::LockFreeQueue< BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE >	report_queue_

esphome::EventPool< BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE - 1 >	report_pool_

uint32_t	last_advance_ms_ {0}

uint32_t	pending_since_ms_ {0}

uint32_t	teardown_since_ms_ {0}

uint32_t	teardown_stuck_log_ms_ {0}

int	last_release_err_ {0}

ScanParams	requested_ {}

ScanParams	applied_ {}

uint8_t	ble_mac_ [MAC_ADDRESS_SIZE] {0}

uint8_t	scan_activity_idx_ {INVALID_ACTIVITY_IDX}

bool	scan_wanted_ {false}

bool	release_warned_ {false}

bool	restarting_ {false}

bool	enable_on_boot_ {false}

ScanOpResult	last_result_ {ScanOpResult::SETTLED}

BLEComponentState	state_ {BLEComponentState::STATE_OFF}

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 72 of file bk72xx_ble.h.

Member Function Documentation

◆ advance_()

ScanOpResult esphome::bk72xx_ble::BK72xxBLE::advance_ ( )

protected

Definition at line 387 of file bk72xx_ble.cpp.

◆ advance_start_()

ScanOpResult esphome::bk72xx_ble::BK72xxBLE::advance_start_	(	BdkActivityState	state,
		bool	ready )

protected

Definition at line 461 of file bk72xx_ble.cpp.

◆ advance_stop_()

ScanOpResult esphome::bk72xx_ble::BK72xxBLE::advance_stop_	(	BdkActivityState	state,
		bool	ready )

protected

Definition at line 440 of file bk72xx_ble.cpp.

◆ dump_config()

void esphome::bk72xx_ble::BK72xxBLE::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 242 of file bk72xx_ble.cpp.

◆ enable()

void esphome::bk72xx_ble::BK72xxBLE::enable ( )

Bring up the BDK BLE stack (one-time; the BDK has no teardown path).

Definition at line 155 of file bk72xx_ble.cpp.

◆ enqueue_scan_report()

void esphome::bk72xx_ble::BK72xxBLE::enqueue_scan_report	(	const uint8_t *	mac,
		int8_t	rssi,
		uint8_t	addr_type,
		uint8_t	evt_type,
		const uint8_t *	data,
		uint16_t	data_len )

Internal: buffer one controller report (BDK notice callback, BLE task context — bounded copy under the scheduler lock, nothing else).

Definition at line 115 of file bk72xx_ble.cpp.

◆ flush_pending_stop()

bool esphome::bk72xx_ble::BK72xxBLE::flush_pending_stop ( uint32_t timeout_ms )

Drive a requested stop until the radio is observed idle, bounded by timeout_ms (for OTA).

Returns false if it still has not settled.

Definition at line 328 of file bk72xx_ble.cpp.

◆ get_mac_lsb_first()

void esphome::bk72xx_ble::BK72xxBLE::get_mac_lsb_first ( uint8_t out[MAC_ADDRESS_SIZE] ) const

Controller BLE address, least-significant octet first (BLE convention).

Definition at line 237 of file bk72xx_ble.cpp.

◆ get_setup_priority()

float esphome::bk72xx_ble::BK72xxBLE::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 153 of file bk72xx_ble.cpp.

◆ is_active()

bool esphome::bk72xx_ble::BK72xxBLE::is_active ( ) const

inline

Definition at line 81 of file bk72xx_ble.h.

◆ last_scan_result()

ScanOpResult esphome::bk72xx_ble::BK72xxBLE::last_scan_result ( ) const

inline

Last reconciliation outcome; on FAILED the consumer's retry policy owns recovery.

Definition at line 107 of file bk72xx_ble.h.

◆ loop()

void esphome::bk72xx_ble::BK72xxBLE::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 192 of file bk72xx_ble.cpp.

◆ register_scan_listener()

void esphome::bk72xx_ble::BK72xxBLE::register_scan_listener ( BLEScanListener * listener )

inline

Register a consumer for scan reports (delivered on the main task via loop()).

Storage is codegen-sized: the consumer's codegen requests a slot via request_scan_listener_slot(), which emits BK72XX_BLE_SCAN_LISTENER_COUNT.

Definition at line 92 of file bk72xx_ble.h.

◆ release_activity_()

void esphome::bk72xx_ble::BK72xxBLE::release_activity_ ( BdkActivityState state )

protected

Definition at line 343 of file bk72xx_ble.cpp.

◆ reset_teardown_episode_()

void esphome::bk72xx_ble::BK72xxBLE::reset_teardown_episode_ ( )

protected

Definition at line 296 of file bk72xx_ble.cpp.

◆ resolve_mac_()

void esphome::bk72xx_ble::BK72xxBLE::resolve_mac_ ( )

protected

Definition at line 257 of file bk72xx_ble.cpp.

◆ scan_start()

ScanOpResult esphome::bk72xx_ble::BK72xxBLE::scan_start	(	uint16_t	interval,
		uint16_t	window,
		bool	active )

Request a scan (interval/window in 0.625 ms BLE units); enables the stack first if needed.

PENDING until the scan is observed running — loop() keeps advancing, call again to learn the outcome.

Definition at line 302 of file bk72xx_ble.cpp.

◆ scan_stop()

void esphome::bk72xx_ble::BK72xxBLE::scan_stop ( )

Request the scanner stopped and the activity released; steps that cannot run yet are completed from loop().

Definition at line 318 of file bk72xx_ble.cpp.

◆ set_enable_on_boot()

void esphome::bk72xx_ble::BK72xxBLE::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 83 of file bk72xx_ble.h.

◆ setup()

void esphome::bk72xx_ble::BK72xxBLE::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 138 of file bk72xx_ble.cpp.

◆ teardown_stuck_()

bool esphome::bk72xx_ble::BK72xxBLE::teardown_stuck_ ( uint32_t now )

protected

Definition at line 364 of file bk72xx_ble.cpp.

Field Documentation

◆ applied_

ScanParams esphome::bk72xx_ble::BK72xxBLE::applied_ {}

protected

Definition at line 143 of file bk72xx_ble.h.

◆ ble_mac_

uint8_t esphome::bk72xx_ble::BK72xxBLE::ble_mac_[MAC_ADDRESS_SIZE] {0}

protected

Definition at line 144 of file bk72xx_ble.h.

◆ enable_on_boot_

bool esphome::bk72xx_ble::BK72xxBLE::enable_on_boot_ {false}

protected

Definition at line 149 of file bk72xx_ble.h.

◆ last_advance_ms_

uint32_t esphome::bk72xx_ble::BK72xxBLE::last_advance_ms_ {0}

protected

Definition at line 137 of file bk72xx_ble.h.

◆ last_release_err_

int esphome::bk72xx_ble::BK72xxBLE::last_release_err_ {0}

protected

Definition at line 141 of file bk72xx_ble.h.

◆ last_result_

ScanOpResult esphome::bk72xx_ble::BK72xxBLE::last_result_ {ScanOpResult::SETTLED}

protected

Definition at line 152 of file bk72xx_ble.h.

◆ pending_since_ms_

uint32_t esphome::bk72xx_ble::BK72xxBLE::pending_since_ms_ {0}

protected

Definition at line 138 of file bk72xx_ble.h.

◆ release_warned_

bool esphome::bk72xx_ble::BK72xxBLE::release_warned_ {false}

protected

Definition at line 147 of file bk72xx_ble.h.

◆ report_pool_

esphome::EventPool<BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE - 1> esphome::bk72xx_ble::BK72xxBLE::report_pool_

protected

Definition at line 135 of file bk72xx_ble.h.

◆ report_queue_

esphome::LockFreeQueue<BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE> esphome::bk72xx_ble::BK72xxBLE::report_queue_

protected

Definition at line 131 of file bk72xx_ble.h.

◆ requested_

ScanParams esphome::bk72xx_ble::BK72xxBLE::requested_ {}

protected

Definition at line 142 of file bk72xx_ble.h.

◆ restarting_

bool esphome::bk72xx_ble::BK72xxBLE::restarting_ {false}

protected

Definition at line 148 of file bk72xx_ble.h.

◆ scan_activity_idx_

uint8_t esphome::bk72xx_ble::BK72xxBLE::scan_activity_idx_ {INVALID_ACTIVITY_IDX}

protected

Definition at line 145 of file bk72xx_ble.h.

◆ scan_listeners_

StaticVector<BLEScanListener *, BK72XX_BLE_SCAN_LISTENER_COUNT> esphome::bk72xx_ble::BK72xxBLE::scan_listeners_

protected

Definition at line 126 of file bk72xx_ble.h.

◆ scan_wanted_

bool esphome::bk72xx_ble::BK72xxBLE::scan_wanted_ {false}

protected

Definition at line 146 of file bk72xx_ble.h.

◆ state_

BLEComponentState esphome::bk72xx_ble::BK72xxBLE::state_ {BLEComponentState::STATE_OFF}

protected

Definition at line 153 of file bk72xx_ble.h.

◆ teardown_since_ms_

uint32_t esphome::bk72xx_ble::BK72xxBLE::teardown_since_ms_ {0}

protected

Definition at line 139 of file bk72xx_ble.h.

◆ teardown_stuck_log_ms_

uint32_t esphome::bk72xx_ble::BK72xxBLE::teardown_stuck_log_ms_ {0}

protected

Definition at line 140 of file bk72xx_ble.h.

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

esphome/components/bk72xx_ble/bk72xx_ble.h
esphome/components/bk72xx_ble/bk72xx_ble.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ advance_()

◆ advance_start_()

◆ advance_stop_()

◆ dump_config()

◆ enable()

◆ enqueue_scan_report()

◆ flush_pending_stop()

◆ get_mac_lsb_first()

◆ get_setup_priority()

◆ is_active()

◆ last_scan_result()

◆ loop()

◆ register_scan_listener()

◆ release_activity_()

◆ reset_teardown_episode_()

◆ resolve_mac_()

◆ scan_start()

◆ scan_stop()

◆ set_enable_on_boot()

◆ setup()

◆ teardown_stuck_()

Field Documentation

◆ applied_

◆ ble_mac_

◆ enable_on_boot_

◆ last_advance_ms_

◆ last_release_err_

◆ last_result_

◆ pending_since_ms_

◆ release_warned_

◆ report_pool_

◆ report_queue_

◆ requested_

◆ restarting_

◆ scan_activity_idx_

◆ scan_listeners_

◆ scan_wanted_

◆ state_

◆ teardown_since_ms_

◆ teardown_stuck_log_ms_