Skip to content
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

[XAP] implement keyboard- and user-level xap.json #15628

Closed
tzarc opened this issue Dec 28, 2021 · 2 comments
Closed

[XAP] implement keyboard- and user-level xap.json #15628

tzarc opened this issue Dec 28, 2021 · 2 comments

Comments

@tzarc
Copy link
Member

tzarc commented Dec 28, 2021

XAP Task Info

Original Issue
Original spec document
Current XAP Definitions
Current XAP Generated Docs
Placeholder PR

Description

Any work in this area needs to be discussed with QMK Collaborators first.

Add support for keyboard-level and user-level xap.json to be provided, such that it's merged and included in the firmware.

@tzarc tzarc added enhancement help wanted xap XAP-related issues/PRs labels Dec 28, 2021
@stale
Copy link

stale bot commented Apr 16, 2022

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs.
For maintainers: Please label with bug, in progress, on hold, discussion or to do to prevent the issue from being re-flagged.

@stale stale bot added the stale Issues or pull requests that have become inactive without resolution. label Apr 16, 2022
@stale stale bot removed the stale Issues or pull requests that have become inactive without resolution. label Apr 16, 2022
@zvecr
Copy link
Member

zvecr commented May 23, 2022

Currently implemented with the following:

  • xap.hjson to match up with xap_<version>.hjson
  • user/keyboard specs can only augment the 2 "special" routes
    • this limitation protects core functionality from overrides
  • Validation does not currently handle the invalid case of type: command with routes: { ... }
    • jsonschema doesnt seem to provide the ability to validate an object based on a child keys value
  • docs/codegen will ignore user/keyboard level customisation
  • user/keyboard broadcast_messages?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

2 participants