Add dynamic board names using custom VIA values - #430
Merged
Conversation
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.
Summary
Adds support for dynamically selecting the displayed board name using a value returned through the existing VIA custom-value channel.
This allows multiple hardware variants sharing the same VID/PID and definition to display different names without requiring changes to QMK core.
Definition format
Existing static names remain supported:
{ "name": "Existing Board" }Definitions can now provide multiple names and a custom-value command:
{ "name": { "options": [ "Default Board", "Alternate Board", "Special Edition" ], "content": ["id_board_variant", 0, 200] } }The
contenttuple uses the existing custom-control format:The board returns a zero-based index corresponding to an entry in
options.Behavior
unhandled, or outside the available range.
debug views, and design views.
Diagnostics
Custom-menu commands now carry their semantic command names through the HID queue.
This distinguishes overlapping protocol command IDs correctly:
CUSTOM_MENU_GET_VALUE.BACKLIGHT_CONFIG_GET_VALUE.This changes diagnostic labels only; command bytes and response validation
remain unchanged.
Dependencies
@the-via/readerto1.14.2.via-keyboardsto share reader1.14.2.bun.lockandpackage-lock.json.Compatibility
Verification
bun install --frozen-lockfilebun run buildgit diff --check