[Keymap] Add keymap for the Keychron Q1 ISO layout (qmk#14853)

* Add keymap for the Keychron Q1 ISO layout

- The rightest key column is: Ins, Home, PgUp, PgDn, which differs from the default.
- RGB lighting turns off when the computer sleeps
- Caps Lock and alpha keys turn red to indicate when Caps Lock is on
- When the Fn layer is active, RGB lighting turns off for keys that are not assigned

* Update keyboards/keychron/q1/rev_0102/keymaps/kubahorak/rgb_matrix_user.c

Suggestion from review

Co-authored-by: Drashna Jaelre <[email protected]>

Co-authored-by: Drashna Jaelre <[email protected]>

keyboards/keychron/q1/rev_0102/keymaps/kubahorak/README.md

@@ -0,0 +1,16 @@
+# kubahorak's Keychron Q1 keymap
+
+This ISO layout got heavily inspired by gtg465x's ANSI keymap (rev_0100).
+
+Features:
+- The rightest key column is: Ins, Home, PgUp, PgDn, which differs from the default.
+- RGB lighting turns off when the computer sleeps
+- Caps Lock and alpha keys turn red to indicate when Caps Lock is on
+- When the Fn layer is active, RGB lighting turns off for keys that are not assigned
+
+## Changelog
+
+### 2021-10-17 - 1.0.0
+
+- Initial release
+

keyboards/keychron/q1/rev_0102/keymaps/kubahorak/config.h

@@ -0,0 +1,25 @@
+/* Copyright 2021 Jakub Horak (@kubahorak)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#ifdef RGB_MATRIX_ENABLE
+/* from rev_0100/keymaps/gtg465x */
+#    define RGB_DISABLE_WHEN_USB_SUSPENDED
+#    define CAPS_LOCK_INDICATOR_COLOR RGB_RED
+#    define CAPS_LOCK_INDICATOR_LIGHT_ALPHAS
+#    define FN_LAYER_TRANSPARENT_KEYS_OFF
+#endif

keyboards/keychron/q1/rev_0102/keymaps/kubahorak/keymap.c

@@ -0,0 +1,66 @@
+/* Copyright 2021 Jakub Horak (@kubahorak)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include QMK_KEYBOARD_H
+#include "keymap_user.h"
+#ifdef RGB_MATRIX_ENABLE
+#    include "rgb_matrix_user.h"
+#endif
+
+// clang-format off
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+	[0] = LAYOUT_iso_83(
+            KC_ESC,    KC_BRID,   KC_BRIU,   KC_F3,    KC_F4,     RGB_VAD,   RGB_VAI,   KC_MPRV,   KC_MPLY,   KC_MNXT,   KC_MUTE,   KC_VOLD,   KC_VOLU,   KC_DEL,    KC_INS,
+            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_HOME,
+            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_PGUP,
+            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_NUHS,   KC_ENT,    KC_PGDN,
+            KC_LSFT,   KC_NUBS,   KC_Z,      KC_X,     KC_C,      KC_V,      KC_B,      KC_N,      KC_M,      KC_COMM,   KC_DOT,    KC_SLSH,   KC_RSFT,   KC_UP,
+            KC_LCTL,   KC_LALT,   KC_LGUI,   KC_SPC,   KC_RGUI,   MO(1),     KC_RCTL,   KC_LEFT,   KC_DOWN,   KC_RGHT
+            ),
+	[1] = LAYOUT_iso_83(
+            KC_TRNS,   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_TRNS,   KC_TRNS,
+            KC_TRNS,   KC_TRNS,    KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_P7,     KC_P8,     KC_P9,     KC_PSLS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
+            RGB_TOG,   RGB_MOD,    RGB_VAI,   RGB_HUI,   RGB_SAI,   RGB_SPI,   KC_TRNS,   KC_P4,     KC_P5,     KC_P6,     KC_PAST,   KC_TRNS,   KC_TRNS,   KC_TRNS,
+            KC_TRNS,   RGB_RMOD,   RGB_VAD,   RGB_HUD,   RGB_SAD,   RGB_SPD,   KC_TRNS,   KC_P1,     KC_P2,     KC_P3,     KC_PMNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
+            KC_TRNS,   KC_TRNS,    KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_P0,     KC_PDOT,   KC_PENT,   KC_PPLS,   KC_TRNS,   KC_TRNS,
+            KC_TRNS,   KC_TRNS,    KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS
+            ),
+    [2] = LAYOUT_iso_83(
+            KC_ESC,    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_DEL,    KC_INS,
+            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_HOME,
+            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_PGUP,
+            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_NUHS,   KC_ENT,    KC_PGDN,
+            KC_LSFT,   KC_NUBS,   KC_Z,      KC_X,     KC_C,      KC_V,    KC_B,      KC_N,      KC_M,      KC_COMM,   KC_DOT,    KC_SLSH,   KC_RSFT,   KC_UP,
+            KC_LCTL,   KC_LGUI,   KC_LALT,   KC_SPC,   KC_RALT,   MO(3),   KC_RCTL,   KC_LEFT,   KC_DOWN,   KC_RGHT
+            ),
+	[3] = LAYOUT_iso_83(
+            KC_TRNS,   KC_BRID,    KC_BRIU,   LGUI(KC_TAB),   LGUI(KC_E),   RGB_VAD,   RGB_VAI,   KC_MPRV,   KC_MPLY,   KC_MNXT,   KC_MUTE,   KC_VOLD,   KC_VOLU,   KC_TRNS,   KC_TRNS,
+            KC_TRNS,   KC_TRNS,    KC_TRNS,   KC_TRNS,        KC_TRNS,      KC_TRNS,   KC_TRNS,   KC_P7,     KC_P8,     KC_P9,     KC_PSLS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
+            RGB_TOG,   RGB_MOD,    RGB_VAI,   RGB_HUI,        RGB_SAI,      RGB_SPI,   KC_TRNS,   KC_P4,     KC_P5,     KC_P6,     KC_PAST,   KC_TRNS,   KC_TRNS,   KC_TRNS,
+            KC_TRNS,   RGB_RMOD,   RGB_VAD,   RGB_HUD,        RGB_SAD,      RGB_SPD,   KC_TRNS,   KC_P1,     KC_P2,     KC_P3,     KC_PMNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
+            KC_TRNS,   KC_TRNS,    KC_TRNS,   KC_TRNS,        KC_TRNS,      KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_P0,     KC_PDOT,   KC_PENT,   KC_PPLS,   KC_TRNS,   KC_TRNS,
+            KC_TRNS,   KC_TRNS,    KC_TRNS,   KC_TRNS,        KC_TRNS,      KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS
+            )
+};
+
+// clang-format on
+
+void matrix_init_user(void) {
+#ifdef RGB_MATRIX_ENABLE
+    rgb_matrix_init_user();
+#endif
+}

keyboards/keychron/q1/rev_0102/keymaps/kubahorak/keymap_user.h

@@ -0,0 +1,28 @@
+/* Copyright 2021 @ Grayson Carr
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+// clang-format off
+
+enum layers {
+    MAC_BASE,
+    MAC_FN,
+    WIN_BASE,
+    WIN_FN
+};
+
+// clang-format on

keyboards/keychron/q1/rev_0102/keymaps/kubahorak/rgb_matrix_user.c

@@ -0,0 +1,75 @@
+/* Copyright 2021 @ Grayson Carr
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include QMK_KEYBOARD_H
+#include "rgb_matrix_user.h"
+#include "keymap_user.h"
+
+keypos_t led_index_key_position[DRIVER_LED_TOTAL];
+
+void rgb_matrix_init_user(void) {
+    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+        for (uint8_t col = 0; col < MATRIX_COLS; col++) {
+            uint8_t led_index = g_led_config.matrix_co[row][col];
+            if (led_index != NO_LED) {
+                led_index_key_position[led_index] = (keypos_t){.row = row, .col = col};
+            }
+        }
+    }
+}
+
+void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+    uint8_t current_layer = get_highest_layer(layer_state);
+    switch (current_layer) {
+        case MAC_BASE:
+        case WIN_BASE:
+#ifdef CAPS_LOCK_INDICATOR_COLOR
+            if (host_keyboard_led_state().caps_lock) {
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_caps_lock_indicator, CAPS_LOCK_INDICATOR_COLOR);
+            }
+#endif
+            break;
+        case MAC_FN:
+        case WIN_FN:
+#ifdef FN_LAYER_TRANSPARENT_KEYS_OFF
+            rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_transparent, RGB_OFF);
+#endif
+            break;
+    }
+}
+
+void rgb_matrix_set_color_by_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue) {
+    for (uint8_t i = led_min; i < led_max; i++) {
+        uint16_t keycode = keymap_key_to_keycode(layer, led_index_key_position[i]);
+        if ((*is_keycode)(keycode)) {
+            rgb_matrix_set_color(i, red, green, blue);
+        }
+    }
+}
+
+bool is_caps_lock_indicator(uint16_t keycode) {
+    switch (keycode) {
+#ifdef CAPS_LOCK_INDICATOR_LIGHT_ALPHAS
+    case KC_A ... KC_Z:
+#endif
+    case KC_CAPS:
+        return true;
+    default:
+        return false;
+    }
+}
+
+bool is_transparent(uint16_t keycode) { return keycode == KC_TRNS; }

keyboards/keychron/q1/rev_0102/keymaps/kubahorak/rgb_matrix_user.h

@@ -0,0 +1,24 @@
+/* Copyright 2021 @ Grayson Carr
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+void rgb_matrix_init_user(void);
+
+void rgb_matrix_set_color_by_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue);
+
+bool is_caps_lock_indicator(uint16_t keycode);
+bool is_transparent(uint16_t keycode);

keyboards/keychron/q1/rev_0102/keymaps/kubahorak/rules.mk

@@ -0,0 +1,6 @@
+VIA_ENABLE = yes
+MOUSEKEY_ENABLE = no
+
+ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
+    SRC += rgb_matrix_user.c
+endif