#include <ln882h_ble.h>

Inheritance diagram for esphome::ln882h_ble::LN882HBLE:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

void	enable ()
	Bring up the LN882H BLE stack (one-time; the SDK 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[6]) const
	Controller BLE address in the SDK's ln_bd_addr_t order: least-significant octet first (the BLE/HCI convention).

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

void	scan_start (uint16_t interval, uint16_t window, bool active)
	Start the controller scan.

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

BLEScanReport *	allocate_scan_report ()
	Internal, SDK rw-task event-callback context: allocate a pool slot for a scan report.

void	push_scan_report (BLEScanReport *report)
	Internal: hand a filled slot to the main-task queue (cannot fail — the pool is sized to the queue capacity).

void	count_rejected_report ()
	Internal, rw-task context: count a report rejected by the legacy-only filter, so a wrong assumption about the stack's report encoding shows up in verbose logs instead of as a scanner that silently reports nothing.

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

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 *, LN882H_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_

std::atomic< uint16_t >	rejected_reports_ {0}

uint8_t	ble_mac_ [MAC_ADDRESS_SIZE] {0}

BLEComponentState	state_ {BLEComponentState::STATE_OFF}

bool	enable_on_boot_ {false}

bool	scanning_ {false}

bool	reject_diagnosis_done_ {false}

uint32_t	rejected_before_delivery_ {0}

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 ln882h_ble.h.

Member Function Documentation

◆ allocate_scan_report()

BLEScanReport * esphome::ln882h_ble::LN882HBLE::allocate_scan_report ( )

Internal, SDK rw-task event-callback context: allocate a pool slot for a scan report.

Returns nullptr (and counts the drop) when the queue is full; the callback fills the slot in place — no intermediate copy.

Definition at line 251 of file ln882h_ble.cpp.

◆ count_rejected_report()

void esphome::ln882h_ble::LN882HBLE::count_rejected_report ( )

inline

Internal, rw-task context: count a report rejected by the legacy-only filter, so a wrong assumption about the stack's report encoding shows up in verbose logs instead of as a scanner that silently reports nothing.

Definition at line 116 of file ln882h_ble.h.

◆ dump_config()

void esphome::ln882h_ble::LN882HBLE::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 375 of file ln882h_ble.cpp.

◆ enable()

void esphome::ln882h_ble::LN882HBLE::enable ( )

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

Requires setup() to have run: rw_init() is handed the address resolved there. Blocks ~120 ms across the SDK's settle points, so calling it from loop() (enable_on_boot: false) trips the loop-blocking warning once.

Definition at line 285 of file ln882h_ble.cpp.

◆ get_mac_lsb_first()

void esphome::ln882h_ble::LN882HBLE::get_mac_lsb_first ( uint8_t out[6] ) const

Controller BLE address in the SDK's ln_bd_addr_t order: least-significant octet first (the BLE/HCI convention).

Reverse for printable form — the byte order is in the name so platform analogs cannot be confused (the bk72xx sibling exposes the same accessor).

Definition at line 373 of file ln882h_ble.cpp.

◆ get_setup_priority()

float esphome::ln882h_ble::LN882HBLE::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 283 of file ln882h_ble.cpp.

◆ is_active()

bool esphome::ln882h_ble::LN882HBLE::is_active ( ) const

inline

Definition at line 81 of file ln882h_ble.h.

◆ loop()

void esphome::ln882h_ble::LN882HBLE::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 330 of file ln882h_ble.cpp.

◆ push_scan_report()

void esphome::ln882h_ble::LN882HBLE::push_scan_report ( BLEScanReport * report )

Internal: hand a filled slot to the main-task queue (cannot fail — the pool is sized to the queue capacity).

Definition at line 261 of file ln882h_ble.cpp.

◆ register_scan_listener()

void esphome::ln882h_ble::LN882HBLE::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 LN882H_BLE_SCAN_LISTENER_COUNT.

Definition at line 95 of file ln882h_ble.h.

◆ resolve_mac_()

void esphome::ln882h_ble::LN882HBLE::resolve_mac_ ( )

protected

Definition at line 388 of file ln882h_ble.cpp.

◆ scan_start()

void esphome::ln882h_ble::LN882HBLE::scan_start	(	uint16_t	interval,
		uint16_t	window,
		bool	active )

Start the controller scan.

Interval/window are in BLE units (0.625 ms); active enables scan requests on the 1M PHY. Enables the stack first if needed. Scans the legacy 1M PHY only (extended/coded PHY advertisements exceed the legacy 62-byte framing consumers are sized for).

Definition at line 431 of file ln882h_ble.cpp.

◆ scan_stop()

void esphome::ln882h_ble::LN882HBLE::scan_stop ( )

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

Definition at line 462 of file ln882h_ble.cpp.

◆ set_enable_on_boot()

void esphome::ln882h_ble::LN882HBLE::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 83 of file ln882h_ble.h.

◆ setup()

void esphome::ln882h_ble::LN882HBLE::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 270 of file ln882h_ble.cpp.

Field Documentation

◆ ble_mac_

uint8_t esphome::ln882h_ble::LN882HBLE::ble_mac_[MAC_ADDRESS_SIZE] {0}

protected

Definition at line 141 of file ln882h_ble.h.

◆ enable_on_boot_

bool esphome::ln882h_ble::LN882HBLE::enable_on_boot_ {false}

protected

Definition at line 143 of file ln882h_ble.h.

◆ reject_diagnosis_done_

bool esphome::ln882h_ble::LN882HBLE::reject_diagnosis_done_ {false}

protected

Definition at line 147 of file ln882h_ble.h.

◆ rejected_before_delivery_

uint32_t esphome::ln882h_ble::LN882HBLE::rejected_before_delivery_ {0}

protected

Definition at line 148 of file ln882h_ble.h.

◆ rejected_reports_

std::atomic<uint16_t> esphome::ln882h_ble::LN882HBLE::rejected_reports_ {0}

protected

Definition at line 140 of file ln882h_ble.h.

◆ report_pool_

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

protected

Definition at line 137 of file ln882h_ble.h.

◆ report_queue_

esphome::LockFreeQueue<BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE> esphome::ln882h_ble::LN882HBLE::report_queue_

protected

Definition at line 133 of file ln882h_ble.h.

◆ scan_listeners_

StaticVector<BLEScanListener *, LN882H_BLE_SCAN_LISTENER_COUNT> esphome::ln882h_ble::LN882HBLE::scan_listeners_

protected

Definition at line 124 of file ln882h_ble.h.

◆ scanning_

bool esphome::ln882h_ble::LN882HBLE::scanning_ {false}

protected

Definition at line 144 of file ln882h_ble.h.

◆ state_

BLEComponentState esphome::ln882h_ble::LN882HBLE::state_ {BLEComponentState::STATE_OFF}

protected

Definition at line 142 of file ln882h_ble.h.

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

esphome/components/ln882h_ble/ln882h_ble.h
esphome/components/ln882h_ble/ln882h_ble.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ allocate_scan_report()

◆ count_rejected_report()

◆ dump_config()

◆ enable()

◆ get_mac_lsb_first()

◆ get_setup_priority()

◆ is_active()

◆ loop()

◆ push_scan_report()

◆ register_scan_listener()

◆ resolve_mac_()

◆ scan_start()

◆ scan_stop()

◆ set_enable_on_boot()

◆ setup()

Field Documentation

◆ ble_mac_

◆ enable_on_boot_

◆ reject_diagnosis_done_

◆ rejected_before_delivery_

◆ rejected_reports_

◆ report_pool_

◆ report_queue_

◆ scan_listeners_

◆ scanning_

◆ state_