ESPHome  2022.11.3
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::ble_client::BLEClient Class Reference

#include <ble_client.h>

Inheritance diagram for esphome::ble_client::BLEClient:
esphome::esp32_ble_client::BLEClientBase esphome::esp32_ble_tracker::ESPBTClient esphome::Component esphome::esp32_ble_tracker::ESPBTDeviceListener

Public Member Functions

void setup () override
 
void dump_config () override
 
void loop () override
 
bool gattc_event_handler (esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override
 
void gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override
 
bool parse_device (const espbt::ESPBTDevice &device) override
 
void set_enabled (bool enabled)
 
void register_ble_node (BLEClientNode *node)
 
void set_state (espbt::ClientState state) override
 
- Public Member Functions inherited from esphome::esp32_ble_client::BLEClientBase
void setup () override
 
void loop () override
 
float get_setup_priority () const override
 
bool parse_device (const espbt::ESPBTDevice &device) override
 
void on_scan_end () override
 
bool gattc_event_handler (esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override
 
void gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override
 
void connect () override
 
void disconnect ()
 
bool connected ()
 
void set_address (uint64_t address)
 
std::string address_str () const
 
BLEServiceget_service (espbt::ESPBTUUID uuid)
 
BLEServiceget_service (uint16_t uuid)
 
BLECharacteristicget_characteristic (espbt::ESPBTUUID service, espbt::ESPBTUUID chr)
 
BLECharacteristicget_characteristic (uint16_t service, uint16_t chr)
 
BLECharacteristicget_characteristic (uint16_t handle)
 
BLEDescriptorget_descriptor (espbt::ESPBTUUID service, espbt::ESPBTUUID chr, espbt::ESPBTUUID descr)
 
BLEDescriptorget_descriptor (uint16_t service, uint16_t chr, uint16_t descr)
 
BLEDescriptorget_descriptor (uint16_t handle)
 
BLEDescriptorget_config_descriptor (uint16_t handle)
 
float parse_char_value (uint8_t *value, uint16_t length)
 
int get_gattc_if () const
 
uint8_t * get_remote_bda ()
 
esp_ble_addr_type_t get_remote_addr_type () const
 
uint16_t get_conn_id () const
 
uint64_t get_address () const
 
uint8_t get_connection_index () const
 
- Public Member Functions inherited from esphome::esp32_ble_tracker::ESPBTClient
ClientState state () const
 
- Public Member Functions inherited from esphome::esp32_ble_tracker::ESPBTDeviceListener
void set_parent (ESP32BLETracker *parent)
 
- 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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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...
 

Data Fields

bool enabled
 
- Data Fields inherited from esphome::esp32_ble_tracker::ESPBTClient
int app_id
 

Protected Member Functions

bool all_nodes_established_ ()
 
- 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()> &&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()> &&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...
 

Protected Attributes

std::vector< BLEClientNode * > nodes_
 
- Protected Attributes inherited from esphome::esp32_ble_client::BLEClientBase
int gattc_if_
 
esp_bd_addr_t remote_bda_
 
esp_ble_addr_type_t remote_addr_type_
 
uint16_t conn_id_ {0xFFFF}
 
uint64_t address_ {0}
 
std::string address_str_ {}
 
uint8_t connection_index_
 
uint16_t mtu_ {23}
 
std::vector< BLEService * > services_
 
- Protected Attributes inherited from esphome::esp32_ble_tracker::ESPBTClient
ClientState state_
 
- Protected Attributes inherited from esphome::esp32_ble_tracker::ESPBTDeviceListener
ESP32BLETrackerparent_ {nullptr}
 
- 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 47 of file ble_client.h.

Member Function Documentation

◆ all_nodes_established_()

bool esphome::ble_client::BLEClient::all_nodes_established_ ( )
protected

Definition at line 82 of file ble_client.cpp.

◆ dump_config()

void esphome::ble_client::BLEClient::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file ble_client.cpp.

◆ gap_event_handler()

void esphome::ble_client::BLEClient::gap_event_handler ( esp_gap_ble_cb_event_t  event,
esp_ble_gap_cb_param_t *  param 
)
overridevirtual

Implements esphome::esp32_ble_tracker::ESPBTClient.

Definition at line 69 of file ble_client.cpp.

◆ gattc_event_handler()

bool esphome::ble_client::BLEClient::gattc_event_handler ( esp_gattc_cb_event_t  event,
esp_gatt_if_t  gattc_if,
esp_ble_gattc_cb_param_t *  param 
)
overridevirtual

Implements esphome::esp32_ble_tracker::ESPBTClient.

Definition at line 50 of file ble_client.cpp.

◆ loop()

void esphome::ble_client::BLEClient::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file ble_client.cpp.

◆ parse_device()

bool esphome::ble_client::BLEClient::parse_device ( const espbt::ESPBTDevice device)
overridevirtual

Implements esphome::esp32_ble_tracker::ESPBTDeviceListener.

Definition at line 31 of file ble_client.cpp.

◆ register_ble_node()

void esphome::ble_client::BLEClient::register_ble_node ( BLEClientNode node)
inline

Definition at line 61 of file ble_client.h.

◆ set_enabled()

void esphome::ble_client::BLEClient::set_enabled ( bool  enabled)

Definition at line 37 of file ble_client.cpp.

◆ set_state()

void esphome::ble_client::BLEClient::set_state ( espbt::ClientState  state)
overridevirtual

Reimplemented from esphome::esp32_ble_tracker::ESPBTClient.

Definition at line 76 of file ble_client.cpp.

◆ setup()

void esphome::ble_client::BLEClient::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file ble_client.cpp.

Field Documentation

◆ enabled

bool esphome::ble_client::BLEClient::enabled

Definition at line 67 of file ble_client.h.

◆ nodes_

std::vector<BLEClientNode *> esphome::ble_client::BLEClient::nodes_
protected

Definition at line 74 of file ble_client.h.


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