Skip to content

Draft: Add support for QMK keyboards using XAP

Initial commit for QMK keyboards using XAP

This MR adds support for XAP version 0.3.0, which includes controlling the mode, colors, speed, and more, but notably lacks individual LED control. This allows OpenRGB to control keyboards with xap and either RGB Matrix or RGB Light.

  • Holds/TODO:
    • Do something for underglow LEDs on an RGB Matrix keyboard
    • Add json config
      • Layout selection
      • Layer selection
      • Key label override
    • Depends on:
      • !1369
      • CI MRs - Link changes in this MR can be reverted once these are implemented.

Checklist for Accepting a Merge Request for a New Device

  • The New Device issue raised for this device is linked to this MR with a keyword Closes / Resolves / Implements
  • There is a device protocol page in the Developer Wiki or there is enough information / captures in the New Device issue to provide ongoing support.
  • The code to be merged follows the style guide and change requirements as documented in the contributing guide.
  • Meta data for the device is included in RGBController_* file
  • This device is detected and is working on Windows 10 and / or 11
  • This device is detected and is working on Linux (Please specify distribution and releases tested)
  • Logging for Info, Warnings and Errors has been added for troubleshooting purposes
Edited by Jack

Merge request reports

Loading