channels: document BONDCONNECT template#128
Open
chrismerck wants to merge 1 commit into
Open
Conversation
Add `BONDCONNECT` as a documented `template` value for Mate Pro channels (v4.32+). The channel relays button presses to a paired Bond Bridge or a linked Smart by Bond device via BBP, which drives the underlying device using its native protocol. Channels with this template have `type` `GX`, since the linked Bond device determines functionality. Also clarify that `template` is the authoritative selector for a channel's technology on PATCH, and replace the now-stale "Relay mode → `MS`" note with the corresponding `BONDCONNECT` → `GX` mapping. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The rendered doc is at: https://bond-api-docs.s3.amazonaws.com/merck-feat-bondconnect-template-docs-local.html |
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
2 participants
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.
Summary
Document
BONDCONNECTas a documentedtemplatevalue for Mate Pro channels (v4.32+), and clarify thattemplateis the authoritative selector for a channel's technology on PATCH.Why
The Bond Local API spec didn't name the Bond Connect technology, didn't give it a template identifier, and didn't say which field a client uses to switch a channel's technology. That left clients and firmware reaching for ad-hoc signals (
type,properties.pairing_assets_key) instead of a single, well-defined contract.What changed
channels/schemas.yaml:template— addedBONDCONNECTas a documented special value. The channel relays button presses to a paired Bond Bridge (or to a linked Smart by Bond device via BBP), which drives the underlying device using its native protocol. Available on Mate Pro (MT-1500) firmware v4.32 and later.templateis the authoritative selector for a channel's technology on PATCH.type— replaced the stale "Channels configured for Relay mode have typeMS" note with the correct mapping: channels with templateBONDCONNECThave typeGX, since the linked Bond device determines functionality.No schema-level or path-level changes; pure documentation.
Test plan
make test(OpenAPI validation)make run_localand visually confirm thetemplateandtypefield descriptions read cleanly