Skip to content

feat: Migrate RGB underglow keycodes to UG_* with QMK build compat shim #924

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.

Sign up for GitHub

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

Merged
yoichiro merged 1 commit into from
Apr 22, 2026
Merged

feat: Migrate RGB underglow keycodes to UG_* with QMK build compat shim #924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 108 additions & 0 deletions src/services/hid/KeycodeInfoList.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
import { describe, expect, it } from 'vitest';
import { keyInfoList } from './KeycodeInfoList';

describe('keyInfoList', () => {
describe('UG_* keyword aliases for RGB/Underglow keycodes', () => {
const expected: Array<{ code: number; ugAlias: string }> = [
{ code: 0x7820, ugAlias: 'ug_togg' },
{ code: 0x7821, ugAlias: 'ug_next' },
{ code: 0x7822, ugAlias: 'ug_prev' },
{ code: 0x7823, ugAlias: 'ug_hueu' },
{ code: 0x7824, ugAlias: 'ug_hued' },
{ code: 0x7825, ugAlias: 'ug_satu' },
{ code: 0x7826, ugAlias: 'ug_satd' },
{ code: 0x7827, ugAlias: 'ug_valu' },
{ code: 0x7828, ugAlias: 'ug_vald' },
{ code: 0x7829, ugAlias: 'ug_spdu' },
{ code: 0x782a, ugAlias: 'ug_spdd' },
];

expected.forEach(({ code, ugAlias }) => {
it(`code 0x${code.toString(16)} carries '${ugAlias}' as a keyword`, () => {
const entry = keyInfoList.find(
(info) => info.keycodeInfo.code === code
);
expect(
entry,
`keyInfoList must have entry for 0x${code.toString(16)}`
).toBeDefined();
expect(entry!.keycodeInfo.keywords).toContain(ugAlias);
});
});

it('keeps the lowercase UG_* keyword so Autocomplete matches lowercased user input', () => {
const entry = keyInfoList.find(
(info) => info.keycodeInfo.code === 0x7820
);
expect(entry).toBeDefined();
// The filterOptions in AutocompleteKeys lowercases the user's input but
// not the stored keywords; keeping the alias lowercase is what makes
// search work for "UG_TOGG", "ug_togg", and partial prefixes like "ug".
const hasLowercaseAlias = entry!.keycodeInfo.keywords.some(
(kwd) => kwd === kwd.toLowerCase() && kwd.startsWith('ug_')
);
expect(hasLowercaseAlias).toBe(true);
});
});

describe('canonical UG_* names and labels for underglow keycodes', () => {
const expected: Array<{
code: number;
long: string;
short: string;
label: string;
}> = [
{ code: 0x7820, long: 'UG_TOGG', short: 'UG_TOGG', label: 'UG Toggle' },
{ code: 0x7821, long: 'UG_NEXT', short: 'UG_NEXT', label: 'UG Mode +' },
{ code: 0x7822, long: 'UG_PREV', short: 'UG_PREV', label: 'UG Mode -' },
{ code: 0x7823, long: 'UG_HUEU', short: 'UG_HUEU', label: 'UG HUE +' },
{ code: 0x7824, long: 'UG_HUED', short: 'UG_HUED', label: 'UG HUE -' },
{ code: 0x7825, long: 'UG_SATU', short: 'UG_SATU', label: 'UG SAT +' },
{ code: 0x7826, long: 'UG_SATD', short: 'UG_SATD', label: 'UG SAT -' },
{
code: 0x7827,
long: 'UG_VALU',
short: 'UG_VALU',
label: 'UG Bright +',
},
{
code: 0x7828,
long: 'UG_VALD',
short: 'UG_VALD',
label: 'UG Bright -',
},
{
code: 0x7829,
long: 'UG_SPDU',
short: 'UG_SPDU',
label: 'UG Effect Speed +',
},
{
code: 0x782a,
long: 'UG_SPDD',
short: 'UG_SPDD',
label: 'UG Effect Speed -',
},
];

expected.forEach(({ code, long, short, label }) => {
it(`code 0x${code.toString(16)} has canonical UG_* name and UG-prefixed label`, () => {
const entry = keyInfoList.find(
(info) => info.keycodeInfo.code === code
);
expect(entry).toBeDefined();
expect(entry!.keycodeInfo.name.long).toBe(long);
expect(entry!.keycodeInfo.name.short).toBe(short);
expect(entry!.keycodeInfo.label).toBe(label);
});
});

it('retains legacy RGB_* as a lowercase keyword for backward search', () => {
const entry = keyInfoList.find(
(info) => info.keycodeInfo.code === 0x7820
);
expect(entry).toBeDefined();
expect(entry!.keycodeInfo.keywords).toContain('rgb_tog');
});
});
});
88 changes: 44 additions & 44 deletions src/services/hid/KeycodeInfoList.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6507,132 +6507,132 @@ export const keyInfoList: KeyInfo[] = [
desc: 'Toggle RGB lighting on or off',
keycodeInfo: {
code: 0x7820, // 30752 0b111100000100000
label: 'RGB Toggle',
label: 'UG Toggle',
name: {
long: 'RGB_TOG',
short: 'RGB_TOG',
long: 'UG_TOGG',
short: 'UG_TOGG',
},
keywords: ['Rgb Tog'],
keywords: ['Ug Togg', 'ug_togg', 'rgb_tog'],
},
},
{
desc: 'Cycle through modes, reverse direction when Shift is held',
keycodeInfo: {
code: 0x7821, // 30753 0b111100000100001
label: 'RGB Mode +',
label: 'UG Mode +',
name: {
long: 'RGB_MODE_FORWARD',
short: 'RGB_MOD',
long: 'UG_NEXT',
short: 'UG_NEXT',
},
keywords: ['Rgb Mode Forward'],
keywords: ['Ug Next', 'ug_next', 'rgb_mode_forward', 'rgb_mod'],
},
},
{
desc: 'Cycle through modes in reverse, forward direction when Shift is held',
keycodeInfo: {
code: 0x7822, // 30754 0b111100000100010
label: 'RGB Mode -',
label: 'UG Mode -',
name: {
long: 'RGB_MODE_REVERSE',
short: 'RGB_RMOD',
long: 'UG_PREV',
short: 'UG_PREV',
},
keywords: ['Rgb Mode Reverse'],
keywords: ['Ug Prev', 'ug_prev', 'rgb_mode_reverse', 'rgb_rmod'],
},
},
{
desc: 'Increase hue, decrease hue when Shift is held',
keycodeInfo: {
code: 0x7823, // 30755 0b111100000100011
label: 'RGB HUE +',
label: 'UG HUE +',
name: {
long: 'RGB_HUI',
short: 'RGB_HUI',
long: 'UG_HUEU',
short: 'UG_HUEU',
},
keywords: ['Rgb Hui'],
keywords: ['Ug Hueu', 'ug_hueu', 'rgb_hui'],
},
},
{
desc: 'Decrease hue, increase hue when Shift is held',
keycodeInfo: {
code: 0x7824, // 30756 0b111100000100100
label: 'RGB HUE -',
label: 'UG HUE -',
name: {
long: 'RGB_HUD',
short: 'RGB_HUD',
long: 'UG_HUED',
short: 'UG_HUED',
},
keywords: ['Rgb Hud'],
keywords: ['Ug Hued', 'ug_hued', 'rgb_hud'],
},
},
{
desc: 'Increase saturation, decrease saturation when Shift is held',
keycodeInfo: {
code: 0x7825, // 30757 0b111100000100101
label: 'RGB SAT +',
label: 'UG SAT +',
name: {
long: 'RGB_SAI',
short: 'RGB_SAI',
long: 'UG_SATU',
short: 'UG_SATU',
},
keywords: ['Rgb Sai'],
keywords: ['Ug Satu', 'ug_satu', 'rgb_sai'],
},
},
{
desc: 'Decrease saturation, increase saturation when Shift is held',
keycodeInfo: {
code: 0x7826, // 30758 0b111100000100110
label: 'RGB SAT -',
label: 'UG SAT -',
name: {
long: 'RGB_SAD',
short: 'RGB_SAD',
long: 'UG_SATD',
short: 'UG_SATD',
},
keywords: ['Rgb Sad'],
keywords: ['Ug Satd', 'ug_satd', 'rgb_sad'],
},
},
{
desc: 'Increase value (brightness), decrease value when Shift is held',
keycodeInfo: {
code: 0x7827, // 30759 0b111100000100111
label: 'RGB Bright +',
label: 'UG Bright +',
name: {
long: 'RGB_VAI',
short: 'RGB_VAI',
long: 'UG_VALU',
short: 'UG_VALU',
},
keywords: ['Rgb Vai'],
keywords: ['Ug Valu', 'ug_valu', 'rgb_vai'],
},
},
{
desc: 'Decrease value (brightness), increase value when Shift is held',
keycodeInfo: {
code: 0x7828, // 30760 0b111100000101000
label: 'RGB Bright -',
label: 'UG Bright -',
name: {
long: 'RGB_VAD',
short: 'RGB_VAD',
long: 'UG_VALD',
short: 'UG_VALD',
},
keywords: ['Rgb Vad'],
keywords: ['Ug Vald', 'ug_vald', 'rgb_vad'],
},
},
{
desc: 'Increase effect speed (does not support eeprom yet), decrease speed when Shift is held',
keycodeInfo: {
code: 0x7829, // 30761 0b111100000101001
label: 'RGB Effect Speed +',
label: 'UG Effect Speed +',
name: {
long: 'RGB_SPI',
short: 'RGB_SPI',
long: 'UG_SPDU',
short: 'UG_SPDU',
},
keywords: ['Rgb Spi'],
keywords: ['Ug Spdu', 'ug_spdu', 'rgb_spi'],
},
},
{
desc: 'Decrease effect speed (does not support eeprom yet), increase speed when Shift is held',
keycodeInfo: {
code: 0x782a, // 30762 0b111100000101010
label: 'RGB Effect Speed -',
label: 'UG Effect Speed -',
name: {
long: 'RGB_SPD',
short: 'RGB_SPD',
long: 'UG_SPDD',
short: 'UG_SPDD',
},
keywords: ['Rgb Spd'],
keywords: ['Ug Spdd', 'ug_spdd', 'rgb_spd'],
},
},
{
Expand Down
Loading
Loading