#include <ble.h>

Inheritance diagram for esphome::esp32_ble::ESP32BLE:

Public Member Functions
void	set_io_capability (IoCapability io_capability)

void	set_advertising_cycle_time (uint32_t advertising_cycle_time)

uint32_t	get_advertising_cycle_time () const

void	enable ()

void	disable ()

bool	is_active ()

void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

void	set_name (const std::string &name)

void	advertising_start ()

void	advertising_set_service_data (const std::vector< uint8_t > &data)

void	advertising_set_manufacturer_data (const std::vector< uint8_t > &data)

void	advertising_set_appearance (uint16_t appearance)

void	advertising_set_service_data_and_name (std::span< const uint8_t > data, bool include_name)

void	advertising_add_service_uuid (ESPBTUUID uuid)

void	advertising_remove_service_uuid (ESPBTUUID uuid)

void	advertising_register_raw_advertisement_callback (std::function< void(bool)> &&callback)

void	register_gap_event_handler (GAPEventHandler *handler)

void	register_gap_scan_event_handler (GAPScanEventHandler *handler)

void	register_gattc_event_handler (GATTcEventHandler *handler)

void	register_gatts_event_handler (GATTsEventHandler *handler)

void	register_ble_status_event_handler (BLEStatusEventHandler *handler)

void	set_enable_on_boot (bool enable_on_boot)

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
bool	ble_setup_ ()

bool	ble_dismantle_ ()

bool	ble_pre_setup_ ()

void	advertising_init_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Static Protected Member Functions
static void	gatts_event_handler (esp_gatts_cb_event_t event, esp_gatt_if_t gatts_if, esp_ble_gatts_cb_param_t *param)

static void	gattc_event_handler (esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param)

static void	gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)

Additional Inherited Members
Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Detailed Description

Definition at line 99 of file ble.h.

Member Function Documentation

◆ advertising_add_service_uuid()

void esphome::esp32_ble::ESP32BLE::advertising_add_service_uuid ( ESPBTUUID uuid )

Definition at line 103 of file ble.cpp.

◆ advertising_init_()

void esphome::esp32_ble::ESP32BLE::advertising_init_ ( )

protected

Definition at line 126 of file ble.cpp.

◆ advertising_register_raw_advertisement_callback()

void esphome::esp32_ble::ESP32BLE::advertising_register_raw_advertisement_callback ( std::function< void(bool)> && callback )

Definition at line 98 of file ble.cpp.

◆ advertising_remove_service_uuid()

void esphome::esp32_ble::ESP32BLE::advertising_remove_service_uuid ( ESPBTUUID uuid )

Definition at line 109 of file ble.cpp.

◆ advertising_set_appearance()

void esphome::esp32_ble::ESP32BLE::advertising_set_appearance ( uint16_t appearance )

inline

Definition at line 121 of file ble.h.

◆ advertising_set_manufacturer_data()

void esphome::esp32_ble::ESP32BLE::advertising_set_manufacturer_data ( const std::vector< uint8_t > & data )

Definition at line 70 of file ble.cpp.

◆ advertising_set_service_data()

void esphome::esp32_ble::ESP32BLE::advertising_set_service_data ( const std::vector< uint8_t > & data )

Definition at line 64 of file ble.cpp.

◆ advertising_set_service_data_and_name()

void esphome::esp32_ble::ESP32BLE::advertising_set_service_data_and_name	(	std::span< const uint8_t >	data,
		bool	include_name )

Definition at line 76 of file ble.cpp.

◆ advertising_start()

void esphome::esp32_ble::ESP32BLE::advertising_start ( )

Definition at line 57 of file ble.cpp.

◆ ble_dismantle_()

bool esphome::esp32_ble::ESP32BLE::ble_dismantle_ ( )

protected

Definition at line 249 of file ble.cpp.

◆ ble_pre_setup_()

bool esphome::esp32_ble::ESP32BLE::ble_pre_setup_ ( )

protected

Definition at line 116 of file ble.cpp.

◆ ble_setup_()

bool esphome::esp32_ble::ESP32BLE::ble_setup_ ( )

protected

Definition at line 137 of file ble.cpp.

◆ disable()

void esphome::esp32_ble::ESP32BLE::disable ( )

Definition at line 47 of file ble.cpp.

◆ dump_config()

void esphome::esp32_ble::ESP32BLE::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 543 of file ble.cpp.

◆ enable()

void esphome::esp32_ble::ESP32BLE::enable ( )

Definition at line 40 of file ble.cpp.

◆ gap_event_handler()

void esphome::esp32_ble::ESP32BLE::gap_event_handler	(	esp_gap_ble_cb_event_t	event,
		esp_ble_gap_cb_param_t *	param )

staticprotected

Definition at line 489 of file ble.cpp.

◆ gattc_event_handler()

void esphome::esp32_ble::ESP32BLE::gattc_event_handler	(	esp_gattc_cb_event_t	event,
		esp_gatt_if_t	gattc_if,
		esp_ble_gattc_cb_param_t *	param )

staticprotected

Definition at line 535 of file ble.cpp.

◆ gatts_event_handler()

void esphome::esp32_ble::ESP32BLE::gatts_event_handler	(	esp_gatts_cb_event_t	event,
		esp_gatt_if_t	gatts_if,
		esp_ble_gatts_cb_param_t *	param )

staticprotected

Definition at line 528 of file ble.cpp.

◆ get_advertising_cycle_time()

uint32_t esphome::esp32_ble::ESP32BLE::get_advertising_cycle_time ( ) const

inline

Definition at line 106 of file ble.h.

◆ get_setup_priority()

float esphome::esp32_ble::ESP32BLE::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 541 of file ble.cpp.

◆ is_active()

bool esphome::esp32_ble::ESP32BLE::is_active ( )

Definition at line 54 of file ble.cpp.

◆ loop()

void esphome::esp32_ble::ESP32BLE::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 294 of file ble.cpp.

◆ register_ble_status_event_handler()

void esphome::esp32_ble::ESP32BLE::register_ble_status_event_handler ( BLEStatusEventHandler * handler )

inline

Definition at line 138 of file ble.h.

◆ register_gap_event_handler()

void esphome::esp32_ble::ESP32BLE::register_gap_event_handler ( GAPEventHandler * handler )

inline

Definition at line 128 of file ble.h.

◆ register_gap_scan_event_handler()

void esphome::esp32_ble::ESP32BLE::register_gap_scan_event_handler ( GAPScanEventHandler * handler )

inline

Definition at line 129 of file ble.h.

◆ register_gattc_event_handler()

void esphome::esp32_ble::ESP32BLE::register_gattc_event_handler ( GATTcEventHandler * handler )

inline

Definition at line 133 of file ble.h.

◆ register_gatts_event_handler()

void esphome::esp32_ble::ESP32BLE::register_gatts_event_handler ( GATTsEventHandler * handler )

inline

Definition at line 136 of file ble.h.

◆ set_advertising_cycle_time()

void esphome::esp32_ble::ESP32BLE::set_advertising_cycle_time ( uint32_t advertising_cycle_time )

inline

Definition at line 103 of file ble.h.

◆ set_enable_on_boot()

void esphome::esp32_ble::ESP32BLE::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 141 of file ble.h.

◆ set_io_capability()

void esphome::esp32_ble::ESP32BLE::set_io_capability ( IoCapability io_capability )

inline

Definition at line 101 of file ble.h.

◆ set_name()

void esphome::esp32_ble::ESP32BLE::set_name ( const std::string & name )

inline

Definition at line 115 of file ble.h.

◆ setup()

void esphome::esp32_ble::ESP32BLE::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file ble.cpp.

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

esphome/components/esp32_ble/ble.h
esphome/components/esp32_ble/ble.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ advertising_add_service_uuid()

◆ advertising_init_()

◆ advertising_register_raw_advertisement_callback()

◆ advertising_remove_service_uuid()

◆ advertising_set_appearance()

◆ advertising_set_manufacturer_data()

◆ advertising_set_service_data()

◆ advertising_set_service_data_and_name()

◆ advertising_start()

◆ ble_dismantle_()

◆ ble_pre_setup_()

◆ ble_setup_()

◆ disable()

◆ dump_config()

◆ enable()

◆ gap_event_handler()

◆ gattc_event_handler()

◆ gatts_event_handler()

◆ get_advertising_cycle_time()

◆ get_setup_priority()

◆ is_active()

◆ loop()

◆ register_ble_status_event_handler()

◆ register_gap_event_handler()

◆ register_gap_scan_event_handler()

◆ register_gattc_event_handler()

◆ register_gatts_event_handler()

◆ set_advertising_cycle_time()

◆ set_enable_on_boot()

◆ set_io_capability()

◆ set_name()

◆ setup()