Merge pull request #6

renaming montex "v2" to "v1rgb"
peepeetee · May 2, 2022 · d7f1213 · d7f1213
2 parents 8e22e5f + 1a3c749
commit d7f1213
Show file tree

Hide file tree

Showing 19 changed files with 353 additions and 356 deletions.
diff --git a/keyboards/idobao/montex/v1rgb/config.h b/keyboards/idobao/montex/v1rgb/config.h
@@ -0,0 +1,95 @@
+// Copyright 2022 peepeetee (@peepeetee)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0x6964  // "id"
+#define PRODUCT_ID      0x0127
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    IDOBAO
+#define PRODUCT         Montex RGB
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 5
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ */
+#define MATRIX_ROW_PINS { D4, D6, D7, B4, B5, C6 }
+#define MATRIX_COL_PINS { D5, D3, D2, D1, D0 }
+
+#define DIODE_DIRECTION ROW2COL
+
+#define RGB_DI_PIN B1
+
+#if defined(RGB_DI_PIN) && defined(RGB_MATRIX_ENABLE)
+
+    // The number of LEDs connected
+    #define DRIVER_LED_TOTAL 31
+
+    #define RGB_MATRIX_KEYPRESSES // reacts to keypresses
+    #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 180 // Limit to vendor-recommended value
+
+    // RGB Matrix Animation modes. Explicitly enabled
+    // For full list of effects, see:
+    // https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
+    /* *** Items disabled are visually unappealing in a 5x6 key matrix *** */
+    #define ENABLE_RGB_MATRIX_SOLID_COLOR
+    #define ENABLE_RGB_MATRIX_ALPHAS_MODS
+    #define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+    #define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+    #define ENABLE_RGB_MATRIX_BREATHING
+    // #define ENABLE_RGB_MATRIX_BAND_SAT
+    // #define ENABLE_RGB_MATRIX_BAND_VAL
+    // #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+    // #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+    // #define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+    // #define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+    #define ENABLE_RGB_MATRIX_CYCLE_ALL
+    #define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+    #define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
+    // #define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+    #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
+    // #define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+    #define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
+    #define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+    // #define ENABLE_RGB_MATRIX_DUAL_BEACON
+    #define ENABLE_RGB_MATRIX_RAINBOW_BEACON
+    // #define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+    #define ENABLE_RGB_MATRIX_RAINDROPS
+    #define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+    #define ENABLE_RGB_MATRIX_HUE_BREATHING
+    #define ENABLE_RGB_MATRIX_HUE_PENDULUM
+    #define ENABLE_RGB_MATRIX_HUE_WAVE
+    #define ENABLE_RGB_MATRIX_PIXEL_RAIN
+    #define ENABLE_RGB_MATRIX_PIXEL_FLOW
+    #define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
+
+    // enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
+    // #define ENABLE_RGB_MATRIX_TYPING_HEATMAP
+    // #define ENABLE_RGB_MATRIX_DIGITAL_RAIN
+
+    // enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
+    // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+    #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+    // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+    // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+    // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+    // #define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+    #define ENABLE_RGB_MATRIX_SPLASH
+    // #define ENABLE_RGB_MATRIX_MULTISPLASH
+    #define ENABLE_RGB_MATRIX_SOLID_SPLASH
+    // #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
+#endif
diff --git a/keyboards/idobao/montex/v2/info.json → keyboards/idobao/montex/v1rgb/info.json b/keyboards/idobao/montex/v2/info.json → keyboards/idobao/montex/v1rgb/info.json
@@ -1,7 +1,5 @@
 {
-    "keyboard_name": "A201",
-    "url": "",
-    "maintainer": "qmk",
+    "keyboard_name": "IDOBAO MONTEX RGB",
     "layouts": {
         "LAYOUT": {
             "layout": [
@@ -35,5 +33,4 @@
             ]
         }
     }
-    ,"meta": "https://noroadsleft.github.io/kbf_qmk_converter/"
 }
diff --git a/keyboards/idobao/montex/v1rgb/keymaps/default/keymap.c b/keyboards/idobao/montex/v1rgb/keymaps/default/keymap.c
@@ -0,0 +1,54 @@
+// Copyright 2022 peepeetee (@peepeetee)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /*
+     * ┌───┌───┬───┬───┬───┐
+     * │Esc│Tab│ F1│Cal│Bsp│
+     * ├───┼───┼───┼───┼───┤
+     * │Ctr│Num│ / │ * │ - │
+     * ├───┼───┼───┼───┼───┤
+     * │Gui│ 7 │ 8 │ 9 │   │
+     * ├───┼───┼───┼───┤ + │
+     * │Alt│ 4 │ 5 │ 6 │   │
+     * ├───┼───┼───┼───┼───┤
+     * │Shi│ 1 │ 2 │ 3 │   │
+     * ├───┼───┴───┼───┤Ent│
+     * │MO1│ 0     │ . │   │
+     * └───┴───────┴───┴───┘
+     */
+    [0] = LAYOUT(
+        KC_GESC,   KC_TAB,   KC_F1,   KC_CALC, KC_BSPC,
+        KC_LCTRL,  KC_NLCK,  KC_PSLS, KC_PAST, KC_PMNS,
+        KC_LGUI,   KC_P7,    KC_P8,   KC_P9,   KC_PPLS,
+        KC_LALT,   KC_P4,    KC_P5,   KC_P6,
+        KC_LSHIFT, KC_P1,    KC_P2,   KC_P3,   KC_PENT,
+        MO(1),     KC_P0,             KC_PDOT
+    ),
+
+    /*
+     * ┌───┌───┐───┬───┬───┐
+     * │Rst│TOG│MOD│PSc│SLk│
+     * ├───┼───┘───┼───┼───┤
+     * │Hu+│   │Sp-│Sp+│Br-│
+     * ├───┼───┼───┼───┼───┤
+     * │Hu-│Hom│ ↑ │PgU│   │
+     * ├───┼───┼───┼───┤Br+│
+     * │St+│ ← │   │ → │   │
+     * ├───┼───┼───┼───┤───┤
+     * │St-│End│ ↓ │PgD│   │
+     * ├───┼───┴───┼───┤Ent│
+     * │mo1│Insert │Del│   │
+     * └───┴───────┴───┘───┘
+     */
+    [1] = LAYOUT(
+        RESET,   RGB_TOG, RGB_MOD, KC_PSCR, KC_SLCK,
+        RGB_HUI, XXXXXXX, RGB_SPD, RGB_SPI, RGB_VAD,
+        RGB_HUD, KC_HOME, KC_UP,   KC_PGUP, RGB_VAI,
+        RGB_SAI, KC_LEFT, XXXXXXX, KC_RGHT,
+        RGB_SAD, KC_END,  KC_DOWN, KC_PGDN, KC_ENT,
+        _______, KC_INS,           KC_DEL
+    )
+};
diff --git a/keyboards/idobao/montex/v1rgb/keymaps/default/readme.md b/keyboards/idobao/montex/v1rgb/keymaps/default/readme.md
@@ -0,0 +1,3 @@
+# The default keymap for RGB Version
+
+![](https://idobao.github.io/kle/idobao-id27-v2.png)
diff --git a/keyboards/idobao/montex/v1rgb/keymaps/via/config.h b/keyboards/idobao/montex/v1rgb/keymaps/via/config.h
@@ -0,0 +1,8 @@
+// Copyright 2022 peepeetee (@peepeetee)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#if defined(RGB_MATRIX_ENABLE)
+    #define VIA_QMK_RGBLIGHT_ENABLE
+#endif
diff --git a/keyboards/idobao/montex/v1rgb/keymaps/via/keymap.c b/keyboards/idobao/montex/v1rgb/keymaps/via/keymap.c
@@ -0,0 +1,94 @@
+// Copyright 2022 peepeetee (@peepeetee)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+enum montex_layers {
+  _BASE,
+  _FN,
+  _EMPTY2, // Just to initialize dynamic layers in VIA
+  _EMPTY3
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /*
+     * ┌───┌───┬───┬───┬───┐
+     * │Esc│Tab│ F1│Cal│Bsp│
+     * ├───┼───┼───┼───┼───┤
+     * │Ctr│Num│ / │ * │ - │
+     * ├───┼───┼───┼───┼───┤
+     * │Gui│ 7 │ 8 │ 9 │   │
+     * ├───┼───┼───┼───┤ + │
+     * │Alt│ 4 │ 5 │ 6 │   │
+     * ├───┼───┼───┼───┼───┤
+     * │Shi│ 1 │ 2 │ 3 │   │
+     * ├───┼───┴───┼───┤Ent│
+     * │MO1│ 0     │ . │   │
+     * └───┴───────┴───┴───┘
+     */
+    [_BASE] = LAYOUT(
+        KC_GESC,   KC_TAB,   KC_F1,   KC_CALC, KC_BSPC,
+        KC_LCTRL,  KC_NLCK,  KC_PSLS, KC_PAST, KC_PMNS,
+        KC_LGUI,   KC_P7,    KC_P8,   KC_P9,   KC_PPLS,
+        KC_LALT,   KC_P4,    KC_P5,   KC_P6,
+        KC_LSHIFT, KC_P1,    KC_P2,   KC_P3,   KC_PENT,
+        MO(1),     KC_P0,             KC_PDOT
+    ),
+
+    /*
+     * ┌───┌───┐───┬───┬───┐
+     * │Rst│TOG│MOD│PSs│SLk│
+     * ├───┼───┘───┼───┼───┤
+     * │Hu+│   │Sp-│Sp+│Br-│
+     * ├───┼───┼───┼───┼───┤
+     * │Hu-│Hom│ ↑ │PgU│   │
+     * ├───┼───┼───┼───┤Br+│
+     * │St+│ ← │   │ → │   │
+     * ├───┼───┼───┼───┤───┤
+     * │St-│End│ ↓ │PgD│   │
+     * ├───┼───┴───┼───┤Ent│
+     * │mo1│Insert │Del│   │
+     * └───┴───────┴───┘───┘
+     */
+    [_FN] = LAYOUT(
+        RESET,   RGB_TOG, RGB_MOD, KC_PSCR, KC_SLCK,
+        RGB_HUI, XXXXXXX, RGB_SPD, RGB_SPI, RGB_VAD,
+        RGB_HUD, KC_HOME, KC_UP,   KC_PGUP, RGB_VAI,
+        RGB_SAI, KC_LEFT, XXXXXXX, KC_RGHT,
+        RGB_SAD, KC_END,  KC_DOWN, KC_PGDN, KC_ENT,
+        _______, KC_INS,           KC_DEL
+    ),
+
+    /*
+     * ┌───┌───┐───┬───┬───┐
+     * │   │   │   │   │   │
+     * ├───┼───┘───┼───┼───┤
+     * │   │   │   │   │   │
+     * ├───┼───┼───┼───┼───┤
+     * │   │   │   │   │   │
+     * ├───┼───┼───┼───┤   │
+     * │   │   │   │   │   │
+     * ├───┼───┼───┼───┤───┤
+     * │   │   │   │   │   │
+     * ├───┼───┴───┼───┤   │
+     * │   │       │   │   │
+     * └───┴───────┴───┘───┘
+     */
+    [_EMPTY2] = LAYOUT(
+        _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______,
+        _______, _______, _______, _______,
+        _______, _______, _______, _______, _______,
+        _______, _______,           _______
+    ),
+
+    [_EMPTY3] = LAYOUT(
+        _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______,
+        _______, _______, _______, _______,
+        _______, _______, _______, _______, _______,
+        _______, _______,           _______
+    )
+};
diff --git a/keyboards/idobao/montex/v1rgb/keymaps/via/readme.md b/keyboards/idobao/montex/v1rgb/keymaps/via/readme.md
@@ -0,0 +1,3 @@
+# The VIA keymap for RGB Version
+
+![](https://idobao.github.io/kle/idobao-id27-v2.png)
diff --git a/...rds/idobao/montex/v2/keymaps/via/rules.mk → .../idobao/montex/v1rgb/keymaps/via/rules.mk b/...rds/idobao/montex/v2/keymaps/via/rules.mk → .../idobao/montex/v1rgb/keymaps/via/rules.mk
@@ -1 +1,2 @@
 VIA_ENABLE = yes
+LTO_ENABLE = yes
diff --git a/keyboards/idobao/montex/v1rgb/readme.md b/keyboards/idobao/montex/v1rgb/readme.md
@@ -0,0 +1,30 @@
+# IDOBAO MONTEX RGB
+
+![MONTEX RGB](https://idobao.github.io/assets/img/idobao-id27.png)
+
+A hotswap RGB numpad from IDOBAO.
+
+* Keyboard Maintainer:
+  - [peepeetee](https://github.com/peepeetee)
+  - [vinorodrigues](https://github.com/vinorodrigues)
+  - [willi-on-fire](https://github.com/willi-on-fire)
+* Hardware Supported: IDOBAO MONTEX RGB
+* Hardware Availability: [Drop](https://drop.com/buy/idobao-montex-numpad-hotswappable-kit), [AliExpress](https://www.aliexpress.com/item/1005003885788698.html) & [IDOBAO.net](https://idobao.net/collections/20-layout/products/idobao-montex-pad-hot-swappable-keyboard-kit-%E7%9A%84%E5%89%AF%E6%9C%AC)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make idobao/montex/v1rgb:default
+
+Flashing example for this keyboard:
+
+    make idobao/montex/v1rgb:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or [Esc]) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
diff --git a/keyboards/idobao/montex/v2/rules.mk → keyboards/idobao/montex/v1rgb/rules.mk b/keyboards/idobao/montex/v2/rules.mk → keyboards/idobao/montex/v1rgb/rules.mk
@@ -15,11 +15,5 @@ COMMAND_ENABLE = no         # Commands for debug and configuration
 NKRO_ENABLE = no            # Enable N-Key Rollover
 BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
-BLUETOOTH_ENABLE = no       # Enable Bluetooth
-AUDIO_ENABLE = no           # Audio output
 RGB_MATRIX_ENABLE = yes
 RGB_MATRIX_DRIVER = WS2812
-LTO_ENABLE = yes
-
-# generated by KBFirmware JSON to QMK Parser
-# https://noroadsleft.github.io/kbf_qmk_converter/
diff --git a/keyboards/idobao/montex/v1rgb/v1rgb.c b/keyboards/idobao/montex/v1rgb/v1rgb.c
@@ -0,0 +1,58 @@
+// Copyright 2022 peepeetee (@peepeetee)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "v1rgb.h"
+
+#ifdef RGB_MATRIX_ENABLE
+
+/* WS2812 indices always start at 0
+ * underglow = 0-3
+ * note: starting point of 4 and jump from 6 to 7
+ * ┌───┌───┐───┬───┬───┐
+ * │ 6 │ 5 │ 4 │30 │29 │
+ * ├───┼───┘───┼───┼───┤
+ * │24 │25 │26 │27 │28 │
+ * ├───┼───┼───┼───┼───┤
+ * │23 │22 │21 │20 │19 │
+ * ├───┼───┼───┼───┤   │
+ * │15 │16 │17 │18 │   │
+ * ├───┼───┼───┼───┤───┤
+ * │14 │13 │12 │11 │10 │
+ * ├───┼───┴───┼───┤   │
+ * │ 7 │   8   │ 9 │   │
+ * └───┴───────┴───┘───┘
+ */
+
+led_config_t g_led_config = { {
+    // Key Matrix to LED Index
+    { 6,  5,  4,  30, 29},
+    { 24, 25, 26, 27, 28},
+    { 23, 22, 21, 20, 19},
+    { 15, 16, 17, 18, NO_LED},
+    { 14, 13, 12, 11, NO_LED},
+    { 7,  8,  9,  10, NO_LED}
+}, {
+    // LED Index to Physical Position
+    /* underglow: because this is under the kb, you want the colors on the edge (corners) of the acrylic plate */
+    { 224,0  }, { 224,64},  {   0,64 }, {  0,0   },              // 0-3 (underglow)
+    /* per-key: origins generated from https://xelus.netlify.app/guides/KLE_to_RGB_parser */
+    { 112,0  }, {  56,0  }, {   0,0  }, /* ---- */  /* ---- */   // 4-6 (top row middle to left)
+    {   0,64 }, {  84,64 }, { 168,64 },                          // 7-9 (jump to bottom left)
+    { 224,58 }, { 168,41 }, { 112,41 }, {  56,41 }, {   0,41 },  // 10-14 (flow Z pattern upwards...)
+    {   0,29 }, {  56,29 }, { 112,29 }, { 168,29 },              // 15-18
+    { 224,35 }, { 168,29 }, { 112,29 }, {  56,29 }, {   0,29 },  // 19-23
+    {   0,17 }, {  56,17 }, { 112,17 }, { 168,17 }, { 224,17 },  // 24-28
+    /* ---- */  /* ---- */  /* ---- */  { 224,0  }, { 168,0  }   // 29-30 (end at top)
+}, {
+    // LED Index to Flag
+    2, 2, 2, 2,     // 0 1 2 3 (underglow)
+    1, 1, 1,        // 4 5 6
+    4, 4, 4, 4,     // 7 - 10
+    4, 4, 4, 4,     //11 - 14
+    4, 4, 4, 4,     //15 - 18
+    4, 4, 4, 4, 4,  //19 - 23
+    4, 4, 4, 4, 4,  //24 - 28
+    1, 1            //29 30
+} };
+
+#endif