#include <rp2040_ble.h>

Inheritance diagram for esphome::rp2040_ble::RP2040BLE:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

void	enable ()

void	disable ()

bool	is_active () const

void	set_enable_on_boot (bool enable_on_boot)

void	get_mac_msb_first (uint8_t out[MAC_ADDRESS_SIZE]) const
	Controller BLE address in printable (MSB-first) order, as gap_local_bd_addr() delivers it — note BLEScanReport::mac is the opposite (LSB-first) order, hence the explicit names.

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

bool	scan_start (uint16_t interval, uint16_t window, bool active)
	Start a controller scan; active sends scan requests and receives scan responses as separate reports.

void	scan_stop ()
	Stop the controller scan (no-op when not scanning).

void	inhibit_scan ()
	Pause the physical scan for the duration of a GATT connect attempt (initiating and scanning contend for the radio).

void	release_scan_inhibit ()

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	enqueue_scan_report_ (const uint8_t mac_lsb_first, int8_t rssi, uint8_t addr_type, uint8_t adv_event_type, const uint8_t data, uint16_t data_len)
	Buffer one controller report (BTstack packet handler, CYW43 async-context IRQ — bounded copy into the lock-free queue, nothing else).

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	packet_handler (uint8_t type, uint16_t channel, uint8_t *packet, uint16_t size)

Protected Attributes
StaticVector< BLEScanListener *, RP2040_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_

btstack_packet_callback_registration_t	hci_event_callback_registration_ {}

btstack_packet_callback_registration_t	sm_event_callback_registration_ {}

uint8_t	ble_mac_ [MAC_ADDRESS_SIZE] {0}

BLEComponentState	state_ {BLEComponentState::STATE_OFF}

bool	enable_on_boot_ {true}

bool	btstack_initialized_ {false}

bool	active_logged_ {false}

uint16_t	scan_interval_ {0}

uint16_t	scan_window_ {0}

uint8_t	scan_inhibit_count_ {0}

bool	scan_active_mode_ {false}

bool	scan_desired_ {false}

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 62 of file rp2040_ble.h.

Member Function Documentation

◆ disable()

void esphome::rp2040_ble::RP2040BLE::disable ( )

Definition at line 85 of file rp2040_ble.cpp.

◆ dump_config()

void esphome::rp2040_ble::RP2040BLE::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 150 of file rp2040_ble.cpp.

◆ enable()

void esphome::rp2040_ble::RP2040BLE::enable ( )

Definition at line 43 of file rp2040_ble.cpp.

◆ enqueue_scan_report_()

void esphome::rp2040_ble::RP2040BLE::enqueue_scan_report_	(	const uint8_t *	mac_lsb_first,
		int8_t	rssi,
		uint8_t	addr_type,
		uint8_t	adv_event_type,
		const uint8_t *	data,
		uint16_t	data_len )

protected

Buffer one controller report (BTstack packet handler, CYW43 async-context IRQ — bounded copy into the lock-free queue, nothing else).

Definition at line 202 of file rp2040_ble.cpp.

◆ get_mac_msb_first()

void esphome::rp2040_ble::RP2040BLE::get_mac_msb_first ( uint8_t out[MAC_ADDRESS_SIZE] ) const

Controller BLE address in printable (MSB-first) order, as gap_local_bd_addr() delivers it — note BLEScanReport::mac is the opposite (LSB-first) order, hence the explicit names.

All zeros until the stack reports ACTIVE (BTstack reads the address from the controller during power-up).

Definition at line 221 of file rp2040_ble.cpp.

◆ get_setup_priority()

float esphome::rp2040_ble::RP2040BLE::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 158 of file rp2040_ble.cpp.

◆ inhibit_scan()

void esphome::rp2040_ble::RP2040BLE::inhibit_scan ( )

Pause the physical scan for the duration of a GATT connect attempt (initiating and scanning contend for the radio).

The desired scan state set through scan_start()/scan_stop() is remembered and reconciled by release_scan_inhibit(). Holders must guarantee the release on every abort path (the GATT engine reclaims via its connect timeout).

Definition at line 264 of file rp2040_ble.cpp.

◆ is_active()

bool esphome::rp2040_ble::RP2040BLE::is_active ( ) const

inline

Definition at line 71 of file rp2040_ble.h.

◆ loop()

void esphome::rp2040_ble::RP2040BLE::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 102 of file rp2040_ble.cpp.

◆ packet_handler()

void esphome::rp2040_ble::RP2040BLE::packet_handler	(	uint8_t	type,
		uint16_t	channel,
		uint8_t *	packet,
		uint16_t	size )

staticprotected

Definition at line 160 of file rp2040_ble.cpp.

◆ register_scan_listener()

void esphome::rp2040_ble::RP2040BLE::register_scan_listener ( BLEScanListener * listener )

inline

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

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

Definition at line 86 of file rp2040_ble.h.

◆ release_scan_inhibit()

void esphome::rp2040_ble::RP2040BLE::release_scan_inhibit ( )

Definition at line 274 of file rp2040_ble.cpp.

◆ scan_start()

bool esphome::rp2040_ble::RP2040BLE::scan_start	(	uint16_t	interval,
		uint16_t	window,
		bool	active )

Start a controller scan; active sends scan requests and receives scan responses as separate reports.

Interval/window are in BLE units (0.625 ms). Returns false until the stack is ACTIVE (callers retry — the tracker's rate-limited retry loop); powering the stack on stays with the user (enable_on_boot or an explicit enable() call). The controller keeps no scan state across power cycles: a disable()/enable() cycle ends the scan, and the caller must call scan_start() again once the stack is back to ACTIVE (the tracker's loop() reconciliation does exactly that). While a GATT connect attempt has the scan inhibited, the desired scan is remembered and started physically when the inhibit is released.

Definition at line 225 of file rp2040_ble.cpp.

◆ scan_stop()

void esphome::rp2040_ble::RP2040BLE::scan_stop ( )

Stop the controller scan (no-op when not scanning).

Definition at line 252 of file rp2040_ble.cpp.

◆ set_enable_on_boot()

void esphome::rp2040_ble::RP2040BLE::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 73 of file rp2040_ble.h.

◆ setup()

void esphome::rp2040_ble::RP2040BLE::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 19 of file rp2040_ble.cpp.

Field Documentation

◆ active_logged_

bool esphome::rp2040_ble::RP2040BLE::active_logged_ {false}

protected

Definition at line 142 of file rp2040_ble.h.

◆ ble_mac_

uint8_t esphome::rp2040_ble::RP2040BLE::ble_mac_[MAC_ADDRESS_SIZE] {0}

protected

Definition at line 138 of file rp2040_ble.h.

◆ btstack_initialized_

bool esphome::rp2040_ble::RP2040BLE::btstack_initialized_ {false}

protected

Definition at line 141 of file rp2040_ble.h.

◆ enable_on_boot_

bool esphome::rp2040_ble::RP2040BLE::enable_on_boot_ {true}

protected

Definition at line 140 of file rp2040_ble.h.

◆ hci_event_callback_registration_

btstack_packet_callback_registration_t esphome::rp2040_ble::RP2040BLE::hci_event_callback_registration_ {}

protected

Definition at line 135 of file rp2040_ble.h.

◆ report_pool_

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

protected

Definition at line 133 of file rp2040_ble.h.

◆ report_queue_

esphome::LockFreeQueue<BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE> esphome::rp2040_ble::RP2040BLE::report_queue_

protected

Definition at line 129 of file rp2040_ble.h.

◆ scan_active_mode_

bool esphome::rp2040_ble::RP2040BLE::scan_active_mode_ {false}

protected

Definition at line 150 of file rp2040_ble.h.

◆ scan_desired_

bool esphome::rp2040_ble::RP2040BLE::scan_desired_ {false}

protected

Definition at line 151 of file rp2040_ble.h.

◆ scan_inhibit_count_

uint8_t esphome::rp2040_ble::RP2040BLE::scan_inhibit_count_ {0}

protected

Definition at line 149 of file rp2040_ble.h.

◆ scan_interval_

uint16_t esphome::rp2040_ble::RP2040BLE::scan_interval_ {0}

protected

Definition at line 147 of file rp2040_ble.h.

◆ scan_listeners_

StaticVector<BLEScanListener *, RP2040_BLE_SCAN_LISTENER_COUNT> esphome::rp2040_ble::RP2040BLE::scan_listeners_

protected

Definition at line 124 of file rp2040_ble.h.

◆ scan_window_

uint16_t esphome::rp2040_ble::RP2040BLE::scan_window_ {0}

protected

Definition at line 148 of file rp2040_ble.h.

◆ sm_event_callback_registration_

btstack_packet_callback_registration_t esphome::rp2040_ble::RP2040BLE::sm_event_callback_registration_ {}

protected

Definition at line 136 of file rp2040_ble.h.

◆ state_

BLEComponentState esphome::rp2040_ble::RP2040BLE::state_ {BLEComponentState::STATE_OFF}

protected

Definition at line 139 of file rp2040_ble.h.

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

esphome/components/rp2040_ble/rp2040_ble.h
esphome/components/rp2040_ble/rp2040_ble.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ disable()

◆ dump_config()

◆ enable()

◆ enqueue_scan_report_()

◆ get_mac_msb_first()

◆ get_setup_priority()

◆ inhibit_scan()

◆ is_active()

◆ loop()

◆ packet_handler()

◆ register_scan_listener()

◆ release_scan_inhibit()

◆ scan_start()

◆ scan_stop()

◆ set_enable_on_boot()

◆ setup()

Field Documentation

◆ active_logged_

◆ ble_mac_

◆ btstack_initialized_

◆ enable_on_boot_

◆ hci_event_callback_registration_

◆ report_pool_

◆ report_queue_

◆ scan_active_mode_

◆ scan_desired_

◆ scan_inhibit_count_

◆ scan_interval_

◆ scan_listeners_

◆ scan_window_

◆ sm_event_callback_registration_

◆ state_