ESPHome 2026.8.0-dev
Loading...
Searching...
No Matches
esphome::bk72xx_ble::BK72xxBLE Class Referencefinal

#include <bk72xx_ble.h>

Inheritance diagram for esphome::bk72xx_ble::BK72xxBLE:
esphome::Component

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[6]) 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()).
 
bool scan_start (uint16_t interval, uint16_t window)
 Start the controller scan.
 
void scan_stop ()
 Stop the controller scan (no-op when not scanning).
 
void enqueue_scan_report (const uint8_t *mac, int8_t rssi, uint8_t addr_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_ ()
 
- 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

std::vector< BLEScanListener * > scan_listeners_
 
esphome::LockFreeQueue< BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE > report_queue_
 
esphome::EventPool< BLEScanReport, MAX_SCAN_REPORT_QUEUE_SIZE - 1 > report_pool_
 
uint8_t ble_mac_ [6] {0}
 
uint8_t scan_actv_idx_ {0xFF}
 
BLEComponentState state_ {BLEComponentState::STATE_OFF}
 
bool enable_on_boot_ {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 49 of file bk72xx_ble.h.

Member Function Documentation

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 199 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 138 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,
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 102 of file bk72xx_ble.cpp.

◆ get_mac_lsb_first()

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

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

Definition at line 194 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 136 of file bk72xx_ble.cpp.

◆ is_active()

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

Definition at line 58 of file bk72xx_ble.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 175 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()).

Definition at line 66 of file bk72xx_ble.h.

◆ resolve_mac_()

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

Definition at line 214 of file bk72xx_ble.cpp.

◆ scan_start()

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

Start the controller scan.

Interval/window are in BLE units (0.625 ms). Enables the stack first if needed. Returns false on controller failure.

Definition at line 252 of file bk72xx_ble.cpp.

◆ scan_stop()

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

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

Definition at line 282 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 60 of file bk72xx_ble.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 124 of file bk72xx_ble.cpp.

Field Documentation

◆ ble_mac_

uint8_t esphome::bk72xx_ble::BK72xxBLE::ble_mac_[6] {0}
protected

Definition at line 90 of file bk72xx_ble.h.

◆ enable_on_boot_

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

Definition at line 93 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 89 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 85 of file bk72xx_ble.h.

◆ scan_actv_idx_

uint8_t esphome::bk72xx_ble::BK72xxBLE::scan_actv_idx_ {0xFF}
protected

Definition at line 91 of file bk72xx_ble.h.

◆ scan_listeners_

std::vector<BLEScanListener *> esphome::bk72xx_ble::BK72xxBLE::scan_listeners_
protected

Definition at line 81 of file bk72xx_ble.h.

◆ state_

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

Definition at line 92 of file bk72xx_ble.h.


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