qmk/qmk_firmware

[XAP] finalise firmware-side binding generation

Open

#15,621 opened on Dec 28, 2021

View on GitHub
 (0 comments) (0 reactions) (1 assignee)C (43,867 forks)batch import
enhancementhelp wantedin progressxap

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

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, and in this case primarily with @tzarc due to their prior work in this area.

Initial bindings for the firmware side of the XAP protocol are already implemented under quantum/xap/ in the xap branch of qmk/qmk_firmware.

Need to extend this to all scenarios defined by the protocol definitions in data/xap/, ensuring that any cases where items aren't enabled are removed from compilation via the preprocessor.

Contributor guide

Research direction
Examine the existing XAP bindings in quantum/xap/ and protocol definitions in data/xap/ on the xap branch. Identify missing scenarios and implement them, ensuring appropriate preprocessor guards for disabled items.
Tech stack
c
Domain
embedded iot
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Cembedded systemsQMK firmware
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30