Skip to content

Commit

Permalink
added OpenRGB support based upon https://github.com/Kasper24/QMK-OpenRGB
Browse files Browse the repository at this point in the history
  • Loading branch information
@tagno25
tagno25 committed Mar 18, 2024
1 parent 9388622 commit 1e95192
Show file tree
Hide file tree
Showing 10 changed files with 684 additions and 3 deletions.
108 changes: 108 additions & 0 deletions keyboards/framework/ansi/keymaps/openrgb/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
// Copyright 2022 Framework Computer
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H
#include "framework.h"

enum _layers {
_BASE,
_FN,
_FN_LOCK,
_FM
};


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/*
* ┌─────┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬────┐
* 14 keys │ESC │Mut│vDn│vUp│Prv│Ply│Nxt│bDn│bUp│Scn│Air│Prt│App│Del │
* ├───┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┤
* 14 keys │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │Backsp│
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬────┤
* 14 keys │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴────┤
* 13 keys │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ Enter │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───────┤
* 12 keys │ Shift │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift │
* ├────┬───┼───┼───┼───┴───┴───┴───┴───┼───┼───┼───┴┬───┬────┤
* │ │ │ │ │ │ │ │ │↑ │ │
* 11 keys │Ctrl│FN │GUI│Alt│ │Alt│Ctl│ ← ├───┤ → │
* │ │ │ │ │ │ │ │ │ ↓│ │
* └────┴───┴───┴───┴───────────────────┴───┴───┴────┴───┴────┘
* 78 total
*/
[_BASE] = LAYOUT(
KC_ESC, KC_MUTE, KC_VOLD, KC_VOLU, KC_MPRV, KC_MPLY, KC_MNXT, KC_BRID, KC_BRIU, KC_SCRN, KC_AIRP, KC_PSCR, KC_MSEL, KC_DEL,
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
KC_LCTL, MO(_FN), KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, KC_LEFT, KC_UP, KC_DOWN, KC_RGHT
),
/*
* Function layer
* ┌─────┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬────┐
* 14 keys │FN lk│F1 │F2 │F3 │F4 │F5 │F6 │F7 │F8 │F9 │F10│F11│F12│Ins │
* ├───┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┤
* 14 keys │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬────┤
* 14 keys │ │ │RGB│Nxt│Hue│Sat│Spd│Brt│ │ │Pau│ │ │ │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴────┤
* 13 keys │ │ │SRq│Prv│Hue│Sat│Spd│Brt│ScL│ │ │ │ │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───────┤
* 12 keys │ │ │ │ │ │ │Brk│ │ │ │ │ │
* ├────┬───┼───┼───┼───┴───┴───┴───┴───┼───┼───┼───┴┬───┬────┤
* │ │ │ │ │ │ │ │ │PgU│ │
* 11 keys │ │ │ │ │ Toggle Backlight │ │ │Home├───┤End │
* │ │ │ │ │ │ │ │ │PgD│ │
* └────┴───┴───┴───┴───────────────────┴───┴───┴────┴───┴────┘
* 78 total
*/
[_FN] = LAYOUT(
FN_LOCK, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_INS,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_SAI, RGB_SPI, RGB_VAI, _______, _______, KC_PAUS, _______, _______, _______,
_______, _______, KC_SYRQ, RGB_RMOD,RGB_HUD, RGB_SAD, RGB_SPD, RGB_VAD, KC_SCRL, _______, _______, _______, _______,
_______, _______, _______, BL_BRTG, _______, KC_BRK, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, BL_STEP, _______, _______, KC_HOME, KC_PGUP, KC_PGDN, KC_END
),
// Function lock layer
// Everything on F-row locked to function layer, except ESC and DEL
[_FN_LOCK] = LAYOUT(
_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, MO(_FM), _______, _______, _______, _______, _______, _______, _______, _______, _______
),
// Locked+temporary FN (back to base plus extra keys)
[_FM] = LAYOUT(
FN_LOCK, KC_MUTE, KC_VOLD, KC_VOLU, KC_MPRV, KC_MPLY, KC_MNXT, KC_BRID, KC_BRIU, KC_SCRN, KC_AIRP, KC_PSCR, KC_MSEL, KC_INS,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_SAI, RGB_SPI, RGB_VAI, _______, _______, KC_PAUS, _______, _______, _______,
_______, _______, KC_SYRQ, RGB_RMOD,RGB_HUD, RGB_SAD, RGB_SPD, RGB_VAD, KC_SCRL, _______, _______, _______, _______,
_______, _______, _______, BL_BRTG, _______, KC_BRK, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, BL_STEP, _______, _______, KC_HOME, KC_PGUP, KC_PGDN, KC_END
),
};

// Make sure to keep FN Lock even after reset
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
case FN_LOCK:
if (record->event.pressed) {
if (layer_state_is(_FN)) {
set_single_persistent_default_layer(_FN_LOCK);
}
if (layer_state_is(_FM)) {
set_single_persistent_default_layer(_BASE);
}
}
return false;
break;
default:
break;
}
return true;
}
3 changes: 3 additions & 0 deletions keyboards/framework/ansi/keymaps/openrgb/rules.mk
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
VIA_ENABLE = no
OPENRGB_ENABLE = yes
RGB_MATRIX_KEYREACTIVE_ENABLED = yes
104 changes: 104 additions & 0 deletions keyboards/framework/macropad/keymaps/openrgb/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
// Copyright 2022 Framework Computer
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H
#include "factory.h"

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/*
* ┌────┬────┬────┬────┐
* 4 keys │Esc │Calc│ = │ <- │
* ├────┼────┼────┼────┤
* 4 keys │ Num│ / │ * │ - │
* ├────┼────┼────┼────┤
* 3 keys │ 7 │ 8 │ 9 │ + │
* ├────┼────┼────┼────┤
* 4 keys │ 4 │ 5 │ 6 │ + │
* ├────┼────┼────┼────┤
* 3 keys │ 1 │ 2 │ 3 │Entr│
* ├────┼────┼────┼────┤
* 3 keys │ 0 │ 0 │ . │Entr│
* └────┴────┴────┴────┴
* 21 total
*/
[_NUMLOCK] = LAYOUT(
KC_ESC, KC_CALC, KC_EQL, KC_BSPC,
KC_NUM, KC_PSLS, KC_PAST, KC_PMNS,
KC_P7, KC_P8, KC_P9, KC_PPLS,
KC_P4, KC_P5, KC_P6, KC_PPLS,
KC_P1, KC_P2, KC_P3, KC_PENT,
KC_P0, KC_P0, KC_PDOT, KC_PENT
),
/*
* ┌───────┬───────┬───────┬───────┐
* 4 keys │ RGB │ RGB + │ RGB + │ RGB + │
* │Toggle │ Speed │ Hue │ Sat │
* ├───────┼───────┼───────┼───────┤
* 4 keys │Numlock│ RGB - │ RGB - │ RGB - │
* │ │ Speed │ Hue │ Sat │
* ├───────┼───────┼───────┼───────┤
* 4 keys │ Home │ ↑ │ Page │RGB Nxt│
* │ │ │ Up │Effect │
* ├───────┼───────┼───────┼───────┤
* 4 keys │ ← │ │ → │RGB Prv│
* │ │ │ │Effect │
* ├───────┼───────┼───────┼───────┤
* 4 keys │ End │ ↓ │ Page │ BL │
* │ │ │ Down │ Step │
* ├───────┼───────┼───────┼───────┤
* 4 keys │ Insert│ Insert│ Delete│ BL │
* │ │ │ │ Step │
* └───────┴───────┴───────┴───────┘
* 24 total
*/
[_FN] = LAYOUT(
RGB_TOG, RGB_SPI, RGB_HUI, RGB_SAI,
_______, RGB_SPD, RGB_HUD, RGB_SAD,
_______, _______, _______, RGB_MOD,
_______, _______, _______, RGB_RMOD,
_______, _______, _______, BL_STEP,
_______, _______, _______, BL_STEP
),
/* Alphabet
* ┌────┬────┬────┬────┐
* 4 keys │ A │ B │ C │ D │
* ├────┼────┼────┼────┤
* 4 keys │ E │ F │ G │ H │
* ├────┼────┼────┼────┤
* 4 keys │ I │ J │ K │ L │
* ├────┼────┼────┼────┤
* 4 keys │ M │ N │ O │ P │
* ├────┼────┼────┼────┤
* 4 keys │ Q │ R │ S │ T │
* ├────┼────┼────┼────┤
* 4 keys │ U │ V │ W │ X │
* └────┴────┴────┴────┘
* 24 total
*/
[_FACTORY] = LAYOUT(
KC_A, KC_B, KC_C, KC_D,
KC_E, KC_F, KC_G, KC_H,
KC_I, KC_J, KC_K, KC_L,
KC_M, KC_N, KC_O, KC_P,
KC_Q, KC_R, KC_S, KC_T,
KC_U, KC_V, KC_W, KC_X
),
};

bool led_update_user(led_t led_state) {
// Change layer if numlock state changes, either triggered by OS or
// by numlock key on this keyboard
if (led_state.num_lock) {
layer_off(_FN);
} else {
layer_on(_FN);
}
return true;
}

void enable_factory_mode(bool enable) {
if (enable)
layer_on(_FACTORY);
else
layer_off(_FACTORY);
}
3 changes: 3 additions & 0 deletions keyboards/framework/macropad/keymaps/openrgb/rules.mk
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
VIA_ENABLE = no
OPENRGB_ENABLE = yes
RGB_MATRIX_KEYREACTIVE_ENABLED = yes
Loading

0 comments on commit 1e95192

Please sign in to comment.