-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Update docs for max_connections move to esp32_ble component #5445
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the documentation to reflect a breaking change that moves the max_connections
parameter from esp32_ble_tracker
to esp32_ble
. The change is necessary because the connection limit is shared between both BLE client and server components, making the base esp32_ble
component the correct location for this configuration.
- Documents the new location of
max_connections
in theesp32_ble
component with comprehensive details - Marks the parameter as deprecated in
esp32_ble_tracker
with migration instructions - Updates references in
bluetooth_proxy
to point to the correct component
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
content/components/esp32_ble.md | Adds comprehensive documentation for max_connections parameter with technical details and usage guidelines |
content/components/esp32_ble_tracker.md | Marks max_connections as deprecated and provides migration instructions |
content/components/bluetooth_proxy.md | Updates component reference from esp32_ble_tracker to esp32_ble for connection validation |
Co-authored-by: Copilot <[email protected]>
Description:
This PR updates the documentation to reflect the breaking change in esphome/esphome#11006, which moves
max_connections
fromesp32_ble_tracker
toesp32_ble
.Why this breaking change was necessary:
max_connections
is a shared limit: The ESP-IDFCONFIG_BT_ACL_CONNECTIONS
setting controls the total number of BLE connections across both client and server, not just the tracker/client sideesp32_ble
: The base component that both client (esp32_ble_tracker
) and server (esp32_ble_server
) depend onmax_connections
inesp32_ble_tracker
must move it toesp32_ble
before ESPHome 2026.10.0, or their configurations will fail. Temporary backward compatibility is provided with a deprecation warning until that release.Changes Made
content/components/esp32_ble.md
max_connections
documentation with:CONFIG_BT_ACL_CONNECTIONS
,CONFIG_BTDM_CTRL_BLE_MAX_CONN
)max_connections: 3
content/components/esp32_ble_tracker.md
max_connections
as DEPRECATED with clear migration instructionesp32_ble
componentcontent/components/bluetooth_proxy.md
esp32_ble_tracker
toesp32_ble
for the connection limitmax_connections
validationExample Configuration
New (correct) location shown in updated docs:
Related issue (if applicable): Documents the architectural change from esphome/esphome#11006
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
next
because this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
current
because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rst
when creating new documents for new components or cookbook.