qmk/qmk_firmware

[XAP] add binding for dynamic macros

Open

#16,797 opened on Apr 4, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)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.

Add support for routes to expose a dynamic macro subsystem, matching VIA/VIAL capabilities.

  • Potentially its own route and not coupled to #15629.
  • Potentially unify dynamic_keymap_macros and dynamic_macros?
  • Decouple dynamic_keymap_macros from dynamic_keymap?
  • Ensure feature parity with send_string (inc SS_DELAY_CODE)?

Contributor guide

Research direction
Study the existing dynamic macro implementation (dynamic macro.h) and XAP route definitions. Understand how VIA/VIAL implements similar functionality. Then discuss with maintainers before implementation.
Tech stack
c
Domain
api
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.
3-5 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.
Clear
Prerequisites
CGitQMK firmware basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40