[Keyboard] Add Kimiko Rev2 and update Rev1 (#553)

* Initial Kimiko rev2 support

Signed-off-by: Ex3c4Def <[email protected]>

* Add Kimiko Rev2 and update Rev1

- move oled code and font to root, that way all Rev's and keymaps can access it
- delete all user keymaps, because it can be changed in VIAL GUI
- Rev1 migrate some features to info.json

* Fix Rev2 layout

* fix encoder orientation in vial gui

* fix typo

* remove readme from vial keymap folder

* rm obsolet code from vial.json, mirror qmk code

* fix firmware build for oriaj3 keymap

* add rev1 default keymap to fix cli check

---------

Signed-off-by: Ex3c4Def <[email protected]>
Co-authored-by: Ex3c4Def <[email protected]>
Co-authored-by: Ben Roe <[email protected]>
Co-authored-by: Ben Roe <[email protected]>

keyboards/keycapsss/kimiko/keymaps/vial/glcdfont.c → keyboards/keycapsss/kimiko/glcdfont.c

@@ -1,3 +1,20 @@
+/* Copyright 2019 MechMerlin
+ * Copyright 2020 @ben_roe (keycapsss.com)
+ *
+ * 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 "progmem.h"
 
 // Corne 8x6 font

keyboards/keycapsss/kimiko/info.json

@@ -0,0 +1,9 @@
+{
+    "features": {
+        "mousekey": true,
+        "extrakey": true
+    },
+    "split": {
+        "enabled": true
+    }
+}

keyboards/keycapsss/kimiko/keymaps/oriaj3/config.h

@@ -23,7 +23,7 @@
 // #define MASTER_RIGHT
 // #define EE_HANDS
 
-#define OLED_FONT_H "keyboards/keycapsss/kimiko/keymaps/rgb_matrix/glcdfont.c"
+#define OLED_FONT_H "keyboards/keycapsss/kimiko/keymaps/oriaj3/glcdfont.c"
 // #define OLED_FONT_WIDTH 5
 // #define OLED_FONT_HEIGHT 7
 

keyboards/keycapsss/kimiko/kimiko.c

@@ -1,4 +1,4 @@
-/* Copyright 2020 @ben_roe (keycapsss.com)
+/* Copyright 2023 @BenRoe (keycapsss.com)
  *
  * 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
@@ -13,8 +13,10 @@
  * 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 "quantum.h"
 
+ #include "quantum.h"
+
+#ifdef KEYBOARD_keycapsss_kimiko_rev1
 #ifdef RGB_MATRIX_ENABLE
 
 //Thanks to Ben (keycapsss) for helpipng me to create g_led_config
@@ -75,4 +77,220 @@ led_config_t g_led_config = { {
     4, 4, 1, 1, 1, 1
 } };
 
-#endif // RGB_MATRIX_ENABLE
+#endif // RGB_MATRIX_ENABLE
+#endif // KEYBOARD_keycapsss_kimiko_rev1
+
+#ifdef KEYBOARD_keycapsss_kimiko_rev2
+enum layers {
+   _QWERTY,
+   _LOWER,
+   _RAISE,
+   _ADJUST
+};
+
+#ifdef OLED_ENABLE
+
+oled_rotation_t oled_init_kb(oled_rotation_t rotation) {
+    return OLED_ROTATION_270;
+}
+
+// NOTE: Most of the OLED code was originally written by Soundmonster for the Corne,
+// and has been copied directly from `crkbd/soundmonster/keymap.c`
+
+void render_mod_status_gui_alt(uint8_t modifiers) {
+    static const char PROGMEM gui_off_1[] = {0x85, 0x86, 0};
+    static const char PROGMEM gui_off_2[] = {0xa5, 0xa6, 0};
+    static const char PROGMEM gui_on_1[] = {0x8d, 0x8e, 0};
+    static const char PROGMEM gui_on_2[] = {0xad, 0xae, 0};
+
+    static const char PROGMEM alt_off_1[] = {0x87, 0x88, 0};
+    static const char PROGMEM alt_off_2[] = {0xa7, 0xa8, 0};
+    static const char PROGMEM alt_on_1[] = {0x8f, 0x90, 0};
+    static const char PROGMEM alt_on_2[] = {0xaf, 0xb0, 0};
+
+    // fillers between the modifier icons bleed into the icon frames
+    static const char PROGMEM off_off_1[] = {0xc5, 0};
+    static const char PROGMEM off_off_2[] = {0xc6, 0};
+    static const char PROGMEM on_off_1[] = {0xc7, 0};
+    static const char PROGMEM on_off_2[] = {0xc8, 0};
+    static const char PROGMEM off_on_1[] = {0xc9, 0};
+    static const char PROGMEM off_on_2[] = {0xca, 0};
+    static const char PROGMEM on_on_1[] = {0xcb, 0};
+    static const char PROGMEM on_on_2[] = {0xcc, 0};
+
+    if(modifiers & MOD_MASK_GUI) {
+        oled_write_P(gui_on_1, false);
+    } else {
+        oled_write_P(gui_off_1, false);
+    }
+
+    if ((modifiers & MOD_MASK_GUI) && (modifiers & MOD_MASK_ALT)) {
+        oled_write_P(on_on_1, false);
+    } else if(modifiers & MOD_MASK_GUI) {
+        oled_write_P(on_off_1, false);
+    } else if(modifiers & MOD_MASK_ALT) {
+        oled_write_P(off_on_1, false);
+    } else {
+        oled_write_P(off_off_1, false);
+    }
+
+    if(modifiers & MOD_MASK_ALT) {
+        oled_write_P(alt_on_1, false);
+    } else {
+        oled_write_P(alt_off_1, false);
+    }
+
+    if(modifiers & MOD_MASK_GUI) {
+        oled_write_P(gui_on_2, false);
+    } else {
+        oled_write_P(gui_off_2, false);
+    }
+
+    if (modifiers & MOD_MASK_GUI & MOD_MASK_ALT) {
+        oled_write_P(on_on_2, false);
+    } else if(modifiers & MOD_MASK_GUI) {
+        oled_write_P(on_off_2, false);
+    } else if(modifiers & MOD_MASK_ALT) {
+        oled_write_P(off_on_2, false);
+    } else {
+        oled_write_P(off_off_2, false);
+    }
+
+    if(modifiers & MOD_MASK_ALT) {
+        oled_write_P(alt_on_2, false);
+    } else {
+        oled_write_P(alt_off_2, false);
+    }
+}
+
+void render_mod_status_ctrl_shift(uint8_t modifiers) {
+    static const char PROGMEM ctrl_off_1[] = {0x89, 0x8a, 0};
+    static const char PROGMEM ctrl_off_2[] = {0xa9, 0xaa, 0};
+    static const char PROGMEM ctrl_on_1[] = {0x91, 0x92, 0};
+    static const char PROGMEM ctrl_on_2[] = {0xb1, 0xb2, 0};
+
+    static const char PROGMEM shift_off_1[] = {0x8b, 0x8c, 0};
+    static const char PROGMEM shift_off_2[] = {0xab, 0xac, 0};
+    static const char PROGMEM shift_on_1[] = {0xcd, 0xce, 0};
+    static const char PROGMEM shift_on_2[] = {0xcf, 0xd0, 0};
+
+    // fillers between the modifier icons bleed into the icon frames
+    static const char PROGMEM off_off_1[] = {0xc5, 0};
+    static const char PROGMEM off_off_2[] = {0xc6, 0};
+    static const char PROGMEM on_off_1[] = {0xc7, 0};
+    static const char PROGMEM on_off_2[] = {0xc8, 0};
+    static const char PROGMEM off_on_1[] = {0xc9, 0};
+    static const char PROGMEM off_on_2[] = {0xca, 0};
+    static const char PROGMEM on_on_1[] = {0xcb, 0};
+    static const char PROGMEM on_on_2[] = {0xcc, 0};
+
+    if(modifiers & MOD_MASK_CTRL) {
+        oled_write_P(ctrl_on_1, false);
+    } else {
+        oled_write_P(ctrl_off_1, false);
+    }
+
+    if ((modifiers & MOD_MASK_CTRL) && (modifiers & MOD_MASK_SHIFT)) {
+        oled_write_P(on_on_1, false);
+    } else if(modifiers & MOD_MASK_CTRL) {
+        oled_write_P(on_off_1, false);
+    } else if(modifiers & MOD_MASK_SHIFT) {
+        oled_write_P(off_on_1, false);
+    } else {
+        oled_write_P(off_off_1, false);
+    }
+
+    if(modifiers & MOD_MASK_SHIFT) {
+        oled_write_P(shift_on_1, false);
+    } else {
+        oled_write_P(shift_off_1, false);
+    }
+
+    if(modifiers & MOD_MASK_CTRL) {
+        oled_write_P(ctrl_on_2, false);
+    } else {
+        oled_write_P(ctrl_off_2, false);
+    }
+
+    if (modifiers & MOD_MASK_CTRL & MOD_MASK_SHIFT) {
+        oled_write_P(on_on_2, false);
+    } else if(modifiers & MOD_MASK_CTRL) {
+        oled_write_P(on_off_2, false);
+    } else if(modifiers & MOD_MASK_SHIFT) {
+        oled_write_P(off_on_2, false);
+    } else {
+        oled_write_P(off_off_2, false);
+    }
+
+    if(modifiers & MOD_MASK_SHIFT) {
+        oled_write_P(shift_on_2, false);
+    } else {
+        oled_write_P(shift_off_2, false);
+    }
+}
+
+
+void render_logo(void) {
+    static const char PROGMEM kimiko_logo[] = {
+        0xA0, 0xA1, 0xA2, 0xA3, 0xA4,
+        0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0};
+    oled_advance_page(false);
+    oled_advance_page(false);
+    oled_write_P(kimiko_logo, false);
+    // oled_write_P(PSTR("Kimiko"), false);
+}
+
+void render_layer_state(void) {
+	static const char PROGMEM default_layer[] = {
+		0x20, 0x94, 0x95, 0x96, 0x20,
+		0x20, 0xb4, 0xb5, 0xb6, 0x20,
+		0x20, 0xd4, 0xd5, 0xd6, 0x20, 0};
+	static const char PROGMEM raise_layer[] = {
+		0x20, 0x97, 0x98, 0x99, 0x20,
+		0x20, 0xb7, 0xb8, 0xb9, 0x20,
+		0x20, 0xd7, 0xd8, 0xd9, 0x20, 0};
+	static const char PROGMEM lower_layer[] = {
+		0x20, 0x9a, 0x9b, 0x9c, 0x20,
+		0x20, 0xba, 0xbb, 0xbc, 0x20,
+		0x20, 0xda, 0xdb, 0xdc, 0x20, 0};
+	static const char PROGMEM adjust_layer[] = {
+		0x20, 0x9d, 0x9e, 0x9f, 0x20,
+		0x20, 0xbd, 0xbe, 0xbf, 0x20,
+		0x20, 0xdd, 0xde, 0xdf, 0x20, 0};
+
+	if(layer_state_is(_ADJUST)) {
+		oled_write_P(adjust_layer, false);
+	} else if(layer_state_is(_LOWER)) {
+		oled_write_P(lower_layer, false);
+	} else if(layer_state_is(_RAISE)) {
+		oled_write_P(raise_layer, false);
+	} else {
+		oled_write_P(default_layer, false);
+	}
+}
+
+void render_status_main(void) {
+    render_logo();
+    oled_advance_page(false);
+    render_layer_state();
+    oled_advance_page(false);
+    render_mod_status_gui_alt(get_mods()|get_oneshot_mods());
+    render_mod_status_ctrl_shift(get_mods()|get_oneshot_mods());
+}
+
+bool oled_task_kb(void) {
+    if (!oled_task_user()) {
+        return false;
+    }
+
+    if (is_keyboard_master()) {
+        render_status_main();  // Renders the current keyboard state (layer, lock, caps, scroll, etc)
+    } else {
+        render_logo();
+    }
+
+    return true;
+}
+#endif // OLED_ENABLE
+#endif // keyboard keycapsss_kimiko_rev2
+

keyboards/keycapsss/kimiko/post_config.h

@@ -0,0 +1,25 @@
+/* Copyright 2019 MechMerlin
+ * Copyright 2023 @Ex3c4Def
+ * Copyright 2023 @BenRoe (keycapsss.com)
+ *
+ * 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
+
+// OLED definitions
+#ifndef OLED_FONT_H
+#   define OLED_FONT_H "keyboards/keycapsss/kimiko/glcdfont.c"
+#endif
+

keyboards/keycapsss/kimiko/readme.md

@@ -1,23 +1,59 @@
 # Kimiko
 
-<img src="https://keycapsss.com/media/image/7f/88/2b/kimiko-split-keyboard-1.jpg" width="800" />
+## Rev2
+
+A split keyboard with 4x6 vertically staggered keys and a Kyria style thumb thumb cluster.
+
+![Kimiko Rev2](https://i.imgur.com/TBP8Bcrh.jpg)
+
+- Keyboard Maintainer: [BenRoe](https://github.com/BenRoe/) [@keycapsss](https://twitter.com/keycapsss)
+- Hardware Supported: Pro Micro 5V/16Mhz and compatible
+- Hardware Availability: [Keycapsss.com](https://keycapsss.com)
+
+### Features (Rev2)
+
+- 62 Per key RGB led's (SK6812 Mini-E)
+  - RGB Matrix is enabled as default in rules.mk
+  - The effects can be configured in config.h
+- Support for 1 rotary encoder per side (two possible positions)
+- Support for 1 OLED display per side  
+  - 128x32 (SSD1306) or Nice!View are supported  
+  - With 1 OLED on each side, they have to be the same  
+  - Default configuration for 128x32 OLED  
+
+
+Make firmware .hex for this keyboard (after setting up your build environment):
+
+```bash
+qmk compile -kb keycapsss/kimiko/rev2 -km rev2
+```
+
+Use [QMK Toolbox](https://github.com/qmk/qmk_toolbox) to flash the firmware hex file to the keyboard controller.
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## Rev1
 
 A split keyboard with 4x6 vertically staggered keys and thumb keys.
 
+![Kimiko Rev1](https://i.imgur.com/md6V6Eoh.jpg)
+
+- Keyboard Maintainer: [BenRoe](https://github.com/BenRoe/) [@keycapsss](https://twitter.com/keycapsss)
+- Hardware Supported: Pro Micro 5V/16Mhz and compatible
+- Hardware Availability: [Keycapsss.com](https://keycapsss.com)
+
+### Features (Rev1)
+
 - Per key RGB led's (SK6812 Mini-E)
 - 6 underglow RGB led's per side (SK6812 Mini)
 - Support for 1 rotary encoder per side (two possible positions)
 
-* Keyboard Maintainer: [BenRoe](https://github.com/BenRoe/) [@keycapsss](https://twitter.com/keycapsss)
-* Hardware Supported: Pro Micro 5V/16Mhz and compatible
-* Hardware Availability: [keycapsss.com](https://keycapsss.com)
-
 Make firmware .hex for this keyboard (after setting up your build environment):
 
-    make keycapsss/kimiko:default
-
-Example of flashing this keyboard (or use [QMK Toolbox](https://github.com/qmk/qmk_toolbox)):
+```bash
+qmk compile -kb keycapsss/kimiko/rev1 -km default
+```
 
-    make keycapsss/kimiko:default:flash
+Use [QMK Toolbox](https://github.com/qmk/qmk_toolbox) to flash the firmware hex file to the keyboard controller.
 
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).