ESPHome  2023.3.1
ble_client_base.h
Go to the documentation of this file.
1 #pragma once
2 
3 #ifdef USE_ESP32
4 
7 
8 #include "ble_service.h"
9 
10 #include <array>
11 #include <string>
12 #include <vector>
13 
14 #include <esp_bt_defs.h>
15 #include <esp_gap_ble_api.h>
16 #include <esp_gatt_common_api.h>
17 #include <esp_gattc_api.h>
18 
19 namespace esphome {
20 namespace esp32_ble_client {
21 
23 
24 class BLEClientBase : public espbt::ESPBTClient, public Component {
25  public:
26  void setup() override;
27  void loop() override;
28  float get_setup_priority() const override;
29 
30  bool parse_device(const espbt::ESPBTDevice &device) override;
31  void on_scan_end() override {}
32  bool gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
33  esp_ble_gattc_cb_param_t *param) override;
34  void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override;
35  void connect() override;
36  esp_err_t pair();
37  void disconnect();
38  void release_services();
39 
40  bool connected() { return this->state_ == espbt::ClientState::ESTABLISHED; }
41 
42  void set_address(uint64_t address) {
43  this->address_ = address;
44  if (address == 0) {
45  memset(this->remote_bda_, 0, sizeof(this->remote_bda_));
46  this->address_str_ = "";
47  } else {
48  this->address_str_ = str_snprintf("%02X:%02X:%02X:%02X:%02X:%02X", 17, (uint8_t)(this->address_ >> 40) & 0xff,
49  (uint8_t)(this->address_ >> 32) & 0xff, (uint8_t)(this->address_ >> 24) & 0xff,
50  (uint8_t)(this->address_ >> 16) & 0xff, (uint8_t)(this->address_ >> 8) & 0xff,
51  (uint8_t)(this->address_ >> 0) & 0xff);
52  }
53  }
54  std::string address_str() const { return this->address_str_; }
55 
57  BLEService *get_service(uint16_t uuid);
59  BLECharacteristic *get_characteristic(uint16_t service, uint16_t chr);
60  BLECharacteristic *get_characteristic(uint16_t handle);
62  BLEDescriptor *get_descriptor(uint16_t service, uint16_t chr, uint16_t descr);
63  BLEDescriptor *get_descriptor(uint16_t handle);
64  // Get the configuration descriptor for the given characteristic handle.
65  BLEDescriptor *get_config_descriptor(uint16_t handle);
66 
67  float parse_char_value(uint8_t *value, uint16_t length);
68 
69  int get_gattc_if() const { return this->gattc_if_; }
70  uint8_t *get_remote_bda() { return this->remote_bda_; }
71  esp_ble_addr_type_t get_remote_addr_type() const { return this->remote_addr_type_; }
72  void set_remote_addr_type(esp_ble_addr_type_t address_type) { this->remote_addr_type_ = address_type; }
73  uint16_t get_conn_id() const { return this->conn_id_; }
74  uint64_t get_address() const { return this->address_; }
75  bool is_paired() const { return this->paired_; }
76 
77  uint8_t get_connection_index() const { return this->connection_index_; }
78 
80 
81  protected:
82  int gattc_if_;
83  esp_bd_addr_t remote_bda_;
84  esp_ble_addr_type_t remote_addr_type_;
85  uint16_t conn_id_{0xFFFF};
86  uint64_t address_{0};
87  std::string address_str_{};
89  int16_t service_count_{0};
90  uint16_t mtu_{23};
91  bool paired_{false};
92  espbt::ConnectionType connection_type_{espbt::ConnectionType::V1};
93 
94  std::vector<BLEService *> services_;
95 };
96 
97 } // namespace esp32_ble_client
98 } // namespace esphome
99 
100 #endif // USE_ESP32
BLEDescriptor * get_descriptor(espbt::ESPBTUUID service, espbt::ESPBTUUID chr, espbt::ESPBTUUID descr)
BLEService * get_service(espbt::ESPBTUUID uuid)
std::vector< BLEService * > services_
BLEDescriptor * get_config_descriptor(uint16_t handle)
void set_remote_addr_type(esp_ble_addr_type_t address_type)
virtual void set_connection_type(espbt::ConnectionType ct)
esp_ble_addr_type_t get_remote_addr_type() const
void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override
BLECharacteristic * get_characteristic(espbt::ESPBTUUID service, espbt::ESPBTUUID chr)
Definition: a4988.cpp:4
bool parse_device(const espbt::ESPBTDevice &device) 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
float parse_char_value(uint8_t *value, uint16_t length)
std::string str_snprintf(const char *fmt, size_t len,...)
Definition: helpers.cpp:174