#include <ble_server.h>

Inheritance diagram for esphome::esp32_ble_server::BLEServer:

Data Structures
struct	CallbackEntry

struct	ServiceEntry

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

bool	can_proceed () override

bool	is_running ()

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

BLEService *	create_service (ESPBTUUID uuid, bool advertise=false, uint16_t num_handles=15)

void	remove_service (ESPBTUUID uuid, uint8_t inst_id=0)

BLEService *	get_service (ESPBTUUID uuid, uint8_t inst_id=0)

void	enqueue_start_service (BLEService *service)

void	set_device_information_service (BLEService *service)

esp_gatt_if_t	get_gatts_if ()

uint32_t	get_connected_client_count ()

const uint16_t *	get_clients () const

uint8_t	get_client_count () const

void	gatts_event_handler (esp_gatts_cb_event_t event, esp_gatt_if_t gatts_if, esp_ble_gatts_cb_param_t *param) override

void	ble_before_disabled_event_handler () override

void	on_connect (std::function< void(uint16_t)> &&callback)

void	on_disconnect (std::function< void(uint16_t)> &&callback)

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.

bool	is_idle () const
	Check if this component is idle.

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

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)

Public Member Functions inherited from esphome::esp32_ble::GATTsEventHandler
Public Member Functions inherited from esphome::esp32_ble::BLEStatusEventHandler
Public Member Functions inherited from esphome::Parented< ESP32BLE >
	Parented ()

	Parented (ESP32BLE *parent)

ESP32BLE *	get_parent () const
	Get the parent of this object.

void	set_parent (ESP32BLE *parent)
	Set the parent of this object.

Protected Types
enum class	CallbackType : uint8_t { ON_CONNECT , ON_DISCONNECT }

enum	State : uint8_t { INIT = 0x00 , REGISTERING , STARTING_SERVICE , RUNNING }

Protected Member Functions
void	restart_advertising_ ()

int8_t	find_client_index_ (uint16_t conn_id) const

void	add_client_ (uint16_t conn_id)

void	remove_client_ (uint16_t conn_id)

void	dispatch_callbacks_ (CallbackType type, uint16_t conn_id)

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.

Protected Attributes
std::vector< CallbackEntry >	callbacks_

std::vector< uint8_t >	manufacturer_data_ {}

esp_gatt_if_t	gatts_if_ {0}

bool	registered_ {false}

uint16_t	clients_ [USE_ESP32_BLE_MAX_CONNECTIONS] {}

uint8_t	client_count_ {0}

std::vector< ServiceEntry >	services_ {}

std::vector< BLEService * >	services_to_start_ {}

BLEService *	device_information_service_ {}

enum esphome::esp32_ble_server::BLEServer::State	INIT

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.

Protected Attributes inherited from esphome::Parented< ESP32BLE >
ESP32BLE *	parent_

Detailed Description

Definition at line 27 of file ble_server.h.

Member Enumeration Documentation

◆ CallbackType

enum class esphome::esp32_ble_server::BLEServer::CallbackType : uint8_t

strongprotected

Enumerator
ON_CONNECT
ON_DISCONNECT

Definition at line 67 of file ble_server.h.

◆ State

enum esphome::esp32_ble_server::BLEServer::State : uint8_t

protected

Enumerator
INIT
REGISTERING
STARTING_SERVICE
RUNNING

Definition at line 102 of file ble_server.h.

Member Function Documentation

◆ add_client_()

void esphome::esp32_ble_server::BLEServer::add_client_ ( uint16_t conn_id )

protected

Definition at line 198 of file ble_server.cpp.

◆ ble_before_disabled_event_handler()

void esphome::esp32_ble_server::BLEServer::ble_before_disabled_event_handler ( )

overridevirtual

Implements esphome::esp32_ble::BLEStatusEventHandler.

Definition at line 219 of file ble_server.cpp.

◆ can_proceed()

bool esphome::esp32_ble_server::BLEServer::can_proceed ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 100 of file ble_server.cpp.

◆ create_service()

BLEService * esphome::esp32_ble_server::BLEServer::create_service	(	ESPBTUUID	uuid,
		bool	advertise = false,
		uint16_t	num_handles = 15 )

Definition at line 108 of file ble_server.cpp.

◆ dispatch_callbacks_()

void esphome::esp32_ble_server::BLEServer::dispatch_callbacks_	(	CallbackType	type,
		uint16_t	conn_id )

protected

Definition at line 152 of file ble_server.cpp.

◆ dump_config()

void esphome::esp32_ble_server::BLEServer::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 232 of file ble_server.cpp.

◆ enqueue_start_service()

void esphome::esp32_ble_server::BLEServer::enqueue_start_service ( BLEService * service )

inline

Definition at line 45 of file ble_server.h.

◆ find_client_index_()

int8_t esphome::esp32_ble_server::BLEServer::find_client_index_ ( uint16_t conn_id ) const

protected

Definition at line 190 of file ble_server.cpp.

◆ gatts_event_handler()

void esphome::esp32_ble_server::BLEServer::gatts_event_handler	(	esp_gatts_cb_event_t	event,
		esp_gatt_if_t	gatts_if,
		esp_ble_gatts_cb_param_t *	param )

overridevirtual

Implements esphome::esp32_ble::GATTsEventHandler.

Definition at line 160 of file ble_server.cpp.

◆ get_client_count()

uint8_t esphome::esp32_ble_server::BLEServer::get_client_count ( ) const

inline

Definition at line 51 of file ble_server.h.

◆ get_clients()

const uint16_t * esphome::esp32_ble_server::BLEServer::get_clients ( ) const

inline

Definition at line 50 of file ble_server.h.

◆ get_connected_client_count()

uint32_t esphome::esp32_ble_server::BLEServer::get_connected_client_count ( )

inline

Definition at line 49 of file ble_server.h.

◆ get_gatts_if()

esp_gatt_if_t esphome::esp32_ble_server::BLEServer::get_gatts_if ( )

inline

Definition at line 48 of file ble_server.h.

◆ get_service()

BLEService * esphome::esp32_ble_server::BLEServer::get_service	(	ESPBTUUID	uuid,
		uint8_t	inst_id = 0 )

Definition at line 143 of file ble_server.cpp.

◆ get_setup_priority()

float esphome::esp32_ble_server::BLEServer::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 230 of file ble_server.cpp.

◆ is_running()

bool esphome::esp32_ble_server::BLEServer::is_running ( )

Definition at line 98 of file ble_server.cpp.

◆ loop()

void esphome::esp32_ble_server::BLEServer::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file ble_server.cpp.

◆ on_connect()

void esphome::esp32_ble_server::BLEServer::on_connect ( std::function< void(uint16_t)> && callback )

inline

Definition at line 59 of file ble_server.h.

◆ on_disconnect()

void esphome::esp32_ble_server::BLEServer::on_disconnect ( std::function< void(uint16_t)> && callback )

inline

Definition at line 62 of file ble_server.h.

◆ remove_client_()

void esphome::esp32_ble_server::BLEServer::remove_client_ ( uint16_t conn_id )

protected

Definition at line 211 of file ble_server.cpp.

◆ remove_service()

void esphome::esp32_ble_server::BLEServer::remove_service	(	ESPBTUUID	uuid,
		uint8_t	inst_id = 0 )

Definition at line 130 of file ble_server.cpp.

◆ restart_advertising_()

void esphome::esp32_ble_server::BLEServer::restart_advertising_ ( )

protected

Definition at line 102 of file ble_server.cpp.

◆ set_device_information_service()

void esphome::esp32_ble_server::BLEServer::set_device_information_service ( BLEService * service )

inline

Definition at line 46 of file ble_server.h.

◆ set_manufacturer_data()

void esphome::esp32_ble_server::BLEServer::set_manufacturer_data ( const std::vector< uint8_t > & data )

inline

Definition at line 37 of file ble_server.h.

◆ setup()

void esphome::esp32_ble_server::BLEServer::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 24 of file ble_server.cpp.

Field Documentation

◆ callbacks_

std::vector<CallbackEntry> esphome::esp32_ble_server::BLEServer::callbacks_

protected

Definition at line 90 of file ble_server.h.

◆ client_count_

uint8_t esphome::esp32_ble_server::BLEServer::client_count_ {0}

protected

Definition at line 97 of file ble_server.h.

◆ clients_

uint16_t esphome::esp32_ble_server::BLEServer::clients_[USE_ESP32_BLE_MAX_CONNECTIONS] {}

protected

Definition at line 96 of file ble_server.h.

◆ device_information_service_

BLEService* esphome::esp32_ble_server::BLEServer::device_information_service_ {}

protected

Definition at line 100 of file ble_server.h.

◆ gatts_if_

esp_gatt_if_t esphome::esp32_ble_server::BLEServer::gatts_if_ {0}

protected

Definition at line 93 of file ble_server.h.

◆ INIT

enum esphome::esp32_ble_server::BLEServer::State esphome::esp32_ble_server::BLEServer::INIT

protected

◆ manufacturer_data_

std::vector<uint8_t> esphome::esp32_ble_server::BLEServer::manufacturer_data_ {}

protected

Definition at line 92 of file ble_server.h.

◆ registered_

bool esphome::esp32_ble_server::BLEServer::registered_ {false}

protected

Definition at line 94 of file ble_server.h.

◆ services_

std::vector<ServiceEntry> esphome::esp32_ble_server::BLEServer::services_ {}

protected

Definition at line 98 of file ble_server.h.

◆ services_to_start_

std::vector<BLEService *> esphome::esp32_ble_server::BLEServer::services_to_start_ {}

protected

Definition at line 99 of file ble_server.h.

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

esphome/components/esp32_ble_server/ble_server.h
esphome/components/esp32_ble_server/ble_server.cpp

Data Structures

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ CallbackType

◆ State

Member Function Documentation

◆ add_client_()

◆ ble_before_disabled_event_handler()

◆ can_proceed()

◆ create_service()

◆ dispatch_callbacks_()

◆ dump_config()

◆ enqueue_start_service()

◆ find_client_index_()

◆ gatts_event_handler()

◆ get_client_count()

◆ get_clients()

◆ get_connected_client_count()

◆ get_gatts_if()

◆ get_service()

◆ get_setup_priority()

◆ is_running()

◆ loop()

◆ on_connect()

◆ on_disconnect()

◆ remove_client_()

◆ remove_service()

◆ restart_advertising_()

◆ set_device_information_service()

◆ set_manufacturer_data()

◆ setup()

Field Documentation

◆ callbacks_

◆ client_count_

◆ clients_

◆ device_information_service_

◆ gatts_if_

◆ INIT

◆ manufacturer_data_

◆ registered_

◆ services_

◆ services_to_start_