docs: add guide for capturing BLE data to support new devices#526
Draft
bluetoothbot wants to merge 1 commit into
Draft
docs: add guide for capturing BLE data to support new devices#526bluetoothbot wants to merge 1 commit into
bluetoothbot wants to merge 1 commit into
Conversation
9f7be4b to
2b65694
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A contributor guide (
docs/adding-device-support.md) explaining how to capturethe raw Bluetooth data the library needs to add a new device or feature, linked
from the README.
Why
A steady stream of device-support issues stalls for one reason: nobody has
captured the raw advertisement/GATT bytes the parser needs. There was no
documented self-serve path for non-coders to contribute that data, so the same
"how/what do I capture?" gets re-explained per issue (or never). This turns the
recurring blocker into a single referenceable page.
How
adv_parser.pyactually dispatches on: the SwitchBot serviceUUIDs + model byte, and the manufacturer-data company IDs (
2409/741/89).BleakScannersnippet, and Android HCIsnoop logs for connection-level command features.
parse_advertisement_data()to verify recognition.(Feature Request: night light control for ceiling light / pro #490, [bug] Cannot see or remove password in Switchbot App if added to Keypad with
add_password. #447, Support for Switchbot Keypad Touch #439, Switchbot Meter Pro time synchronisation #416, Feature request: Bot schedules #345) to the exact capture each needs.Testing
Docs-only — no code paths changed. Verified the referenced symbols
(
SUPPORTED_TYPES, service UUIDs, company IDs,parse_advertisement_datasignature) against the current source.
Autonomous PR by Kōan, on behalf of @bdraco / the OpenHome team (nick@openhomefoundation.org).
Quality Report
Changes: 2 files changed, 135 insertions(+)
Code scan: 4 issue(s) found
docs/adding-device-support.md:62— debug print statementdocs/adding-device-support.md:64— debug print statementdocs/adding-device-support.md:65— debug print statementdocs/adding-device-support.md:82— debug print statementTests: passed (1300 passed)
Branch hygiene: clean
Generated by Kōan