Ensure no other clients connected before stopping scan #4379
Conversation
This will prevent stopping scan when more than one client is connected (like when looking for logs) and only one disconnects.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant API
participant BLE Tracker
User->>API: Initiate BLE Scan
API->>BLE Tracker: Start Scan
BLE Tracker-->>API: Scan in Progress
User->>API: Stop BLE Scan
API->>BLE Tracker: Check Connection
alt API Connected
API-->>User: Cannot Stop Scan (API Connected)
else API Not Connected
API->>BLE Tracker: Stop Scan
BLE Tracker-->>API: Scan Stopped
API-->>User: Scan Stopped
end
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
components/esp32_ble_tracker.rst (1)
288-293: Consider adding a comment to explain the condition's purpose.To improve maintainability, consider adding a comment explaining why this condition is necessary, particularly for single-core systems.
Add this comment above the condition:
on_client_disconnected: + # Only stop the scan if no other clients are connected + # This prevents scan interruption during multi-client scenarios - if: condition: - not: api.connected: then: - esp32_ble_tracker.stop_scan:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- components/esp32_ble_tracker.rst (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/esp32_ble_tracker.rst (1)
Pattern
**: - Do not generate or add any sequence diagrams
🔇 Additional comments (1)
components/esp32_ble_tracker.rst (1)
288-293: LGTM! The condition effectively prevents premature scan stoppage.The added condition ensures the BLE scan only stops when there are no API clients connected, which correctly addresses the issue described in the PR objectives where the scan would stop prematurely when one client disconnects while others remain connected.
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
Description:
Fix suggested code for single core systems.
This will prevent stopping scan when more than one client is connected (like when looking for logs) and only one disconnects.
Related issue (if applicable): N/A
Pull request in esphome with YAML changes (if applicable): N/A
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/index.rstwhen creating new documents for new components or cookbook.