ESPHome  2024.5.3
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
esphome::esp32_ble::ESP32BLE Class Reference

#include <ble.h>

Inheritance diagram for esphome::esp32_ble::ESP32BLE:
esphome::Component

Public Member Functions

void set_io_capability (IoCapability io_capability)
 
void enable ()
 
void disable ()
 
bool is_active ()
 
void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
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_add_service_uuid (ESPBTUUID uuid)
 
void advertising_remove_service_uuid (ESPBTUUID uuid)
 
void register_gap_event_handler (GAPEventHandler *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(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
bool is_ready ()
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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 char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

void real_gatts_event_handler_ (esp_gatts_cb_event_t event, esp_gatt_if_t gatts_if, esp_ble_gatts_cb_param_t *param)
 
void real_gattc_event_handler_ (esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param)
 
void real_gap_event_handler_ (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
 
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_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
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. More...
 
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. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

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)
 

Protected Attributes

std::vector< GAPEventHandler * > gap_event_handlers_
 
std::vector< GATTcEventHandler * > gattc_event_handlers_
 
std::vector< GATTsEventHandler * > gatts_event_handlers_
 
std::vector< BLEStatusEventHandler * > ble_status_event_handlers_
 
BLEComponentState state_ {BLE_COMPONENT_STATE_OFF}
 
Queue< BLEEventble_events_
 
BLEAdvertisingadvertising_
 
esp_ble_io_cap_t io_cap_ {ESP_IO_CAP_NONE}
 
bool enable_on_boot_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

Definition at line 75 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 76 of file ble.cpp.

◆ advertising_init_()

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

Definition at line 97 of file ble.cpp.

◆ advertising_remove_service_uuid()

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

Definition at line 82 of file ble.cpp.

◆ 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_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 204 of file ble.cpp.

◆ ble_pre_setup_()

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

Definition at line 88 of file ble.cpp.

◆ ble_setup_()

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

Definition at line 106 of file ble.cpp.

◆ disable()

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

Definition at line 48 of file ble.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 350 of file ble.cpp.

◆ enable()

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

Definition at line 41 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 308 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 334 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 320 of file ble.cpp.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 348 of file ble.cpp.

◆ is_active()

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

Definition at line 55 of file ble.cpp.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 249 of file ble.cpp.

◆ real_gap_event_handler_()

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

Definition at line 313 of file ble.cpp.

◆ real_gattc_event_handler_()

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

Definition at line 340 of file ble.cpp.

◆ real_gatts_event_handler_()

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

Definition at line 326 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 96 of file ble.h.

◆ register_gap_event_handler()

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

Definition at line 93 of file ble.h.

◆ register_gattc_event_handler()

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

Definition at line 94 of file ble.h.

◆ register_gatts_event_handler()

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

Definition at line 95 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 99 of file ble.h.

◆ set_io_capability()

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

Definition at line 77 of file ble.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 25 of file ble.cpp.

Field Documentation

◆ advertising_

BLEAdvertising* esphome::esp32_ble::ESP32BLE::advertising_
protected

Definition at line 122 of file ble.h.

◆ ble_events_

Queue<BLEEvent> esphome::esp32_ble::ESP32BLE::ble_events_
protected

Definition at line 121 of file ble.h.

◆ ble_status_event_handlers_

std::vector<BLEStatusEventHandler *> esphome::esp32_ble::ESP32BLE::ble_status_event_handlers_
protected

Definition at line 118 of file ble.h.

◆ enable_on_boot_

bool esphome::esp32_ble::ESP32BLE::enable_on_boot_
protected

Definition at line 124 of file ble.h.

◆ gap_event_handlers_

std::vector<GAPEventHandler *> esphome::esp32_ble::ESP32BLE::gap_event_handlers_
protected

Definition at line 115 of file ble.h.

◆ gattc_event_handlers_

std::vector<GATTcEventHandler *> esphome::esp32_ble::ESP32BLE::gattc_event_handlers_
protected

Definition at line 116 of file ble.h.

◆ gatts_event_handlers_

std::vector<GATTsEventHandler *> esphome::esp32_ble::ESP32BLE::gatts_event_handlers_
protected

Definition at line 117 of file ble.h.

◆ io_cap_

esp_ble_io_cap_t esphome::esp32_ble::ESP32BLE::io_cap_ {ESP_IO_CAP_NONE}
protected

Definition at line 123 of file ble.h.

◆ state_

BLEComponentState esphome::esp32_ble::ESP32BLE::state_ {BLE_COMPONENT_STATE_OFF}
protected

Definition at line 119 of file ble.h.


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