github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-08-24 07:06:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tighten new comments to repo style

Browse Source
This commit is contained in:
J. Nick Koston
2026-08-09 09:19:32 -05:00
parent 6957e2ef15
commit 22af86a65b
2 changed files with 19 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/components/bluetooth_connection/bluetooth_connection_bluedroid.cpp
+12 -21
View File
@@ -36,8 +36,8 @@ using esp32_ble_tracker::ConnectionType;
static constexpr uint16_t UNSET_CONN_ID = 0xFFFF;
// Wire default before any MTU exchange (Bluetooth spec ATT_MTU minimum).
static constexpr uint16_t DEFAULT_ATT_MTU = 23;
// Sanity bound for one characteristic's descriptor enumeration: real devices
// carry a handful; a stack that never reports end-of-range must not hang.
// Bounds one characteristic's descriptor walk against a stack that never
// reports end-of-range.
static constexpr uint16_t MAX_DESCRIPTORS_PER_CHARACTERISTIC = 64;
// ---- tracker surface ----
@@ -98,9 +98,8 @@ void BluedroidGattClient::dump_config() {
// ---- contract ops ----
int BluedroidGattClient::connect(uint64_t address, uint8_t addr_type) {
// Refuse anything but a fully idle slot. Clobbering DISCONNECTING with
// DISCOVERED would let the tracker open a new link while the old one is
// still closing - the stale CLOSE_EVT then tears the new attempt down.
// Only from idle: clobbering DISCONNECTING would open a new link the
// stale CLOSE_EVT then tears down.
if (this->state_() != ClientState::IDLE) {
ESP_LOGW(TAG, "[%d] Connect rejected, slot busy", this->connection_index_);
return ESP_GATT_BUSY;
@@ -241,9 +240,7 @@ void BluedroidGattClient::release_services() {
#ifdef USE_BLE_GATT_SERVICE_TABLE
this->free_service_table_();
#endif
// Always mark released: the flag terminates any in-flight service stream
// (with or without the NVS cache) so a partial list is never sent as
// authoritative.
// Always set: terminates any in-flight stream on every cache config.
this->services_released_ = true;
#ifndef CONFIG_BT_GATTC_CACHE_NVS_FLASH
esp_ble_gattc_cache_clean(this->remote_bda_);
@@ -481,8 +478,7 @@ void BluedroidGattClient::handle_search_cmpl_() {
auto secondary_status = esp_ble_gattc_get_attr_count(this->gattc_if_, this->conn_id_, ESP_GATT_DB_SECONDARY_SERVICE,
0x0001, 0xFFFF, 0, &secondary);
if (primary_status != ESP_GATT_OK || secondary_status != ESP_GATT_OK) {
// A failed count must not become an authoritative empty database - V3
// clients cache the streamed result permanently.
// A failed count must not become an authoritative empty database.
auto status = primary_status != ESP_GATT_OK ? primary_status : secondary_status;
this->log_gattc_warning_("esp_ble_gattc_get_attr_count", status);
this->listener_->on_service_discovery_done(status);
@@ -495,9 +491,8 @@ void BluedroidGattClient::handle_search_cmpl_() {
#ifdef USE_BLUETOOTH_PROXY
void BluedroidGattClient::stream_service_batch(BluetoothConnection &conn) {
if (this->services_released_) {
// The database was released under the stream (peer dropped mid-stream):
// park without services-done so a V3 client can never cache the partial
// list as authoritative; its own timeout drives the retry.
// Released under the stream: park without services-done so a partial
// list is never cached as authoritative.
conn.send_service_ = DONE_SENDING_SERVICES;
return;
}
@@ -680,12 +675,10 @@ void BluedroidGattClient::handle_open_evt_(esp_ble_gattc_cb_param_t *param) {
// suppressed by seen_mtu_ (HA tolerates a post-connect MTU of 23 here,
// matching the previous esp32 behavior).
this->seen_mtu_ = true;
// Wire parity with the old class: no MTU exchange happened yet, and HA
// has always been handed the default 23 on the cached path.
// Cached path never exchanged an MTU; HA has always seen the default.
this->report_connection_state_(true, DEFAULT_ATT_MTU, 0);
if (this->state_() != ClientState::DISCONNECTING) {
// Settled: only the disconnect safety net needs the loop, and
// set_disconnecting_() re-enables it.
// Settled; set_disconnecting_() re-enables the loop for the net.
this->disable_loop();
}
}
@@ -752,8 +745,7 @@ bool BluedroidGattClient::handle_gattc_event_(esp_gattc_cb_event_t event, esp_ga
}
if (!this->seen_mtu_) {
this->seen_mtu_ = true;
// The connected report waited for the MTU so HA never sees 23; the
// value is forwarded rather than stored (the consumer keeps it).
// The connected report waited for the MTU; forwarded, not stored.
this->report_connection_state_(true,
param->cfg_mtu.status == ESP_GATT_OK ? param->cfg_mtu.mtu : DEFAULT_ATT_MTU, 0);
}
@@ -782,8 +774,7 @@ bool BluedroidGattClient::handle_gattc_event_(esp_gattc_cb_event_t event, esp_ga
this->set_state_(ClientState::ESTABLISHED);
this->handle_search_cmpl_();
if (this->state_() != ClientState::DISCONNECTING) {
// Settled (see the V3_WITH_CACHE arm in handle_open_evt_). A failed
// count reports an error and starts a teardown that needs the loop.
// Settled; a failed count started a teardown that needs the loop.
this->disable_loop();
}
break;
esphome/components/bluetooth_connection/bluetooth_connection_bluedroid.h
+7 -17
View File
@@ -64,12 +64,8 @@ class BluedroidGattClient final : public esp32_ble_tracker::ESPBTClient, public
int notify_characteristic(uint16_t handle, bool enable);
int pair();
int update_connection_params(uint16_t min_interval, uint16_t max_interval, uint16_t latency, uint16_t timeout);
// Materialized on demand from Bluedroid's cached database for direct
// consumers that resolve handles by UUID. The streaming consumer (the
// proxy wrapper) never calls this - it uses stream_service_batch - so the
// materializer only compiles when codegen declares a direct consumer
// (USE_BLE_GATT_SERVICE_TABLE) and proxy-only builds keep the old
// footprint; a direct consumer's peak is bounded by its one known device.
// On-demand table for direct consumers; the proxy streams instead, so the
// materializer compiles only under USE_BLE_GATT_SERVICE_TABLE.
#ifdef USE_BLE_GATT_SERVICE_TABLE
ble_device_base::GattServiceTable get_service_table();
#else
@@ -115,10 +111,8 @@ class BluedroidGattClient final : public esp32_ble_tracker::ESPBTClient, public
// Group 1: pointers / composed objects
ble_device_base::GattClientListener *listener_{nullptr};
#ifdef USE_BLE_GATT_SERVICE_TABLE
// One exact-size block carved into the table's three arrays; owned here,
// freed by release_services(). Null when no table is materialized. The
// GattServiceTable view is rebuilt from this pointer and the counts on
// each (cold) get_service_table() call instead of being cached.
// One exact-size block carved into the three arrays; the view is rebuilt
// per (cold) call instead of cached.
uint8_t *table_storage_{nullptr};
#endif
// Group 2: 4-byte types
@@ -137,17 +131,13 @@ class BluedroidGattClient final : public esp32_ble_tracker::ESPBTClient, public
#endif
// Group 5: 1-byte types
// esp_gatt_if_t is a uint8_t; the narrow type lands the object on the
// 48-byte boundary (an int cost 3 bytes of field plus per-slot padding).
esp_gatt_if_t gattc_if_{ESP_GATT_IF_NONE};
esp_gatt_if_t gattc_if_{ESP_GATT_IF_NONE}; // uint8_t width keeps the object at 48 bytes
// Stored narrow (the enum is 4 bytes); widened at the esp_ble_gattc_open call.
uint8_t remote_addr_type_{0};
esp32_ble_tracker::ConnectionType connection_type_{esp32_ble_tracker::ConnectionType::V3_WITHOUT_CACHE};
uint8_t connection_index_;
// Set by every release_services(): terminates an in-flight service stream
// (a partial list must never be sent as authoritative) and, when the cache
// was cleaned, marks the database unsafe to walk (Bluedroid asserts rather
// than erroring).
// Terminates an in-flight stream (never send a partial list as authoritative)
// and marks a cleaned cache unsafe to walk (Bluedroid asserts).
bool services_released_{false};
// The connected report waits for the MTU exchange; OPEN_EVT alone would
// hand HA the default 23.