Browse Source

[Keyboard] Add IDOBAO ID87 (#10577)

* Add IDOBAO ID87.

* Layout changes.

 * Updated rules.mk
 * Implemented capslock led.
 * Updated readme to new version.
 * Fixed the info.info.json for the new layout.
 * Updated RGB number config.h.
 * Update rules.mk to try and line up nicely.

* Fix via keymap.keymap.c

* Fix all the auto-created labels.

 * Update keymaps again.

* Add additional RGB commands.

* Update keyboards/id87/info.json

Format update.

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/id87/readme.md

Remove quotations.

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/id87/readme.md

Change Flash to Flashing

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/id87/rules.mk

Alignment Fix

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/id87/info.json

Remove qmk_converter link meta.

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
AnthonyL 4 years ago
parent
commit
c4d87f3073

+ 66 - 0
keyboards/id87/config.h

@@ -0,0 +1,66 @@
+/*
+Copyright 2020 Tybera
+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
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0x6964   // "id"
+#define PRODUCT_ID      0x0087
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    IDOBAO
+#define PRODUCT         IDOBAO ID87
+
+/* key matrix size */
+#define MATRIX_ROWS 11
+#define MATRIX_COLS 9
+
+/*
+ * 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 { E6, B0, B1, B2, B3, B7, F7, F6, F5, F4, F1 }
+
+#define MATRIX_COL_PINS { D0, D1, D2, D3, D5, D4, D6, D7, B4 }
+//#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION ROW2COL
+
+#define BACKLIGHT_PIN B6
+#ifdef BACKLIGHT_PIN
+#define BACKLIGHT_LEVELS 3
+#endif
+
+#define CAPS_LOCK_LED_PIN C7
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+#define RGB_DI_PIN E2
+#ifdef RGB_DI_PIN
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 22 /* 16 Bottom 6 top*/
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#endif

+ 32 - 0
keyboards/id87/id87.c

@@ -0,0 +1,32 @@
+/*
+Copyright 2020 Tybera
+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 "id87.h"
+
+void matrix_init_kb(void) {
+    led_init_ports();
+    matrix_init_user();
+}
+
+void led_init_ports(void) {
+    setPinOutput(CAPS_LOCK_LED_PIN);
+}
+
+bool led_update_kb(led_t led_state) {
+    bool res = led_update_user(led_state);
+    if (res) {
+        writePin(CAPS_LOCK_LED_PIN, led_state.caps_lock);
+    }
+    return res;
+}

+ 40 - 0
keyboards/id87/id87.h

@@ -0,0 +1,40 @@
+/*
+Copyright 2020 Tybera
+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
+
+#include "quantum.h"
+
+#define LAYOUT_tkl_ansi( \
+    K00,      K02, K03, K04, K05,   K06, K07, K08, K68,    K67, K65, K64, K63,  K66, K62, K61,  \
+    K10, K11, K12, K13, K14, K15, K16, K17, K18, K78, K70, K77, K75, K73,       K76, K72, K71,  \
+    K20,   K21, K22, K23, K24, K25, K26, K27, K28, K88, K87, K85, K84, K83,     K86, K82, K81,  \
+    K30,    K31, K32, K33, K34, K35, K36, K37, K38, K98, K97, K95, K93,                         \
+    K40,       K42, K43, K44, K45, K46, K47, K48, KA8, KA7, KA5, KA4,                K92,       \
+    K50,  K51,  K52,              K56,                K58,  K57,  K54,  K53,    KA6, KA2, KA1   \
+) { \
+    { K00,   KC_NO, K02,   K03,   K04,   K05,   K06,   K07,   K08   }, \
+    { K10,   K11,   K12,   K13,   K14,   K15,   K16,   K17,   K18   }, \
+    { K20,   K21,   K22,   K23,   K24,   K25,   K26,   K27,   K28   }, \
+    { K30,   K31,   K32,   K33,   K34,   K35,   K36,   K37,   K38   }, \
+    { K40,   KC_NO, K42,   K43,   K44,   K45,   K46,   K47,   K48   }, \
+    { K50,   K51,   K52,   K53,   K54,   KC_NO, K56,   K57,   K58   }, \
+    { KC_NO, K61,   K62,   K63,   K64,   K65,   K66,   K67,   K68   }, \
+    { K70,   K71,   K72,   K73,   KC_NO, K75,   K76,   K77,   K78   }, \
+    { KC_NO, K81,   K82,   K83,   K84,   K85,   K86,   K87,   K88   }, \
+    { KC_NO, KC_NO, K92,   K93,   KC_NO, K95,   KC_NO, K97,   K98   }, \
+    { KC_NO, KA1,   KA2,   KC_NO, KA4,   KA5,   KA6,   KA7,   KA8   }, \
+}
+
+

+ 100 - 0
keyboards/id87/info.json

@@ -0,0 +1,100 @@
+{
+    "keyboard_name": "ID87", 
+    "url": "https://www.idobao.net/products/idobao-id87-80-hot-swappable-mechanical-keyboard-kit", 
+    "maintainer": "qmk", 
+    "width": 18.25, 
+    "height": 6.5, 
+    "layouts": {
+        "LAYOUT_tkl_ansi": {
+            "layout": [
+                {"label":"Esc", "x":0, "y":0},
+                {"label":"F1", "x":2, "y":0},
+                {"label":"F2", "x":3, "y":0},
+                {"label":"F3", "x":4, "y":0},
+                {"label":"F4", "x":5, "y":0},
+                {"label":"F5", "x":6.5, "y":0},
+                {"label":"F6", "x":7.5, "y":0},
+                {"label":"F7", "x":8.5, "y":0},
+                {"label":"F8", "x":9.5, "y":0},
+                {"label":"F9", "x":11, "y":0},
+                {"label":"F10", "x":12, "y":0},
+                {"label":"F11", "x":13, "y":0},
+                {"label":"F12", "x":14, "y":0},
+                {"label":"PrtSc", "x":15.25, "y":0},
+                {"label":"Scroll Lock", "x":16.25, "y":0},
+                {"label":"Pause", "x":17.25, "y":0},
+                {"label":"~", "x":0, "y":1.5},
+                {"label":"1", "x":1, "y":1.5},
+                {"label":"2", "x":2, "y":1.5},
+                {"label":"3", "x":3, "y":1.5},
+                {"label":"4", "x":4, "y":1.5},
+                {"label":"5", "x":5, "y":1.5},
+                {"label":"6", "x":6, "y":1.5},
+                {"label":"7", "x":7, "y":1.5},
+                {"label":"8", "x":8, "y":1.5},
+                {"label":"9", "x":9, "y":1.5},
+                {"label":"0", "x":10, "y":1.5},
+                {"label":"-", "x":11, "y":1.5},
+                {"label":"=", "x":12, "y":1.5},
+                {"label":"Backspace", "x":13, "y":1.5, "w":2},
+                {"label":"Insert", "x":15.25, "y":1.5},
+                {"label":"Home", "x":16.25, "y":1.5},
+                {"label":"PgUp", "x":17.25, "y":1.5},
+                {"label":"Tab", "x":0, "y":2.5, "w":1.5},
+                {"label":"Q", "x":1.5, "y":2.5},
+                {"label":"W", "x":2.5, "y":2.5},
+                {"label":"E", "x":3.5, "y":2.5},
+                {"label":"R", "x":4.5, "y":2.5},
+                {"label":"T", "x":5.5, "y":2.5},
+                {"label":"Y", "x":6.5, "y":2.5},
+                {"label":"U", "x":7.5, "y":2.5},
+                {"label":"I", "x":8.5, "y":2.5},
+                {"label":"O", "x":9.5, "y":2.5},
+                {"label":"P", "x":10.5, "y":2.5},
+                {"label":"[", "x":11.5, "y":2.5},
+                {"label":"]", "x":12.5, "y":2.5},
+                {"label":"\\", "x":13.5, "y":2.5, "w":1.5},
+                {"label":"Delete", "x":15.25, "y":2.5},
+                {"label":"End", "x":16.25, "y":2.5},
+                {"label":"PgDn", "x":17.25, "y":2.5},
+                {"label":"Caps Lock", "x":0, "y":3.5, "w":1.75},
+                {"label":"A", "x":1.75, "y":3.5},
+                {"label":"S", "x":2.75, "y":3.5},
+                {"label":"D", "x":3.75, "y":3.5},
+                {"label":"F", "x":4.75, "y":3.5},
+                {"label":"G", "x":5.75, "y":3.5},
+                {"label":"H", "x":6.75, "y":3.5},
+                {"label":"J", "x":7.75, "y":3.5},
+                {"label":"K", "x":8.75, "y":3.5},
+                {"label":"L", "x":9.75, "y":3.5},
+                {"label":";", "x":10.75, "y":3.5},
+                {"label":"'", "x":11.75, "y":3.5},
+                {"label":"Enter", "x":12.75, "y":3.5, "w":2.25},
+                {"label":"Shift", "x":0, "y":4.5, "w":2.25},
+                {"label":"Z", "x":2.25, "y":4.5},
+                {"label":"X", "x":3.25, "y":4.5},
+                {"label":"C", "x":4.25, "y":4.5},
+                {"label":"V", "x":5.25, "y":4.5},
+                {"label":"B", "x":6.25, "y":4.5},
+                {"label":"N", "x":7.25, "y":4.5},
+                {"label":"M", "x":8.25, "y":4.5},
+                {"label":",", "x":9.25, "y":4.5},
+                {"label":".", "x":10.25, "y":4.5},
+                {"label":"/", "x":11.25, "y":4.5},
+                {"label":"Shift", "x":12.25, "y":4.5, "w":2.75},
+                {"label":"Up", "x":16.25, "y":4.5},
+                {"label":"Ctrl", "x":0, "y":5.5, "w":1.25},
+                {"label":"Win", "x":1.25, "y":5.5, "w":1.25},
+                {"label":"Alt", "x":2.5, "y":5.5, "w":1.25},
+                {"label":"Space", "x":3.75, "y":5.5, "w":6.25},
+                {"label":"Alt", "x":10, "y":5.5, "w":1.25},
+                {"label":"Win", "x":11.25, "y":5.5, "w":1.25},
+                {"label":"LT(1, KC_APP)", "x":12.5, "y":5.5, "w":1.25},
+                {"label":"Ctrl", "x":13.75, "y":5.5, "w":1.25},
+                {"label":"Left", "x":15.25, "y":5.5},
+                {"label":"Down", "x":16.25, "y":5.5},
+                {"label":"Right", "x":17.25, "y":5.5}
+            ]
+        }
+    }
+}

+ 35 - 0
keyboards/id87/keymaps/default/keymap.c

@@ -0,0 +1,35 @@
+/*
+Copyright 2020 Tybera
+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
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT_tkl_ansi(
+        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_PSCR, KC_SLCK, KC_PAUS,
+        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_INS,  KC_HOME, KC_PGUP,
+        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_DEL,  KC_END,  KC_PGDN,
+        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_UP,
+        KC_LCTL,   KC_LGUI,   KC_LALT,                       KC_SPC,                              KC_RALT,   KC_RGUI,   LT(1, KC_APP),     KC_RCTL,      KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [1] = LAYOUT_tkl_ansi(
+        RESET,            _______, _______, _______, _______,     _______, _______, _______, _______,      _______, _______, _______, _______,   _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,            _______, RGB_HUI, _______,
+        _______,     BL_TOGG, RGB_TOG, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,        RGB_VAI, RGB_SAI, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, NK_TOGG, _______, _______, _______, _______, _______,                            BL_INC,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,   _______,      BL_INC,  BL_DEC, RGB_MOD
+    ),
+
+};

+ 1 - 0
keyboards/id87/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap for id87

+ 50 - 0
keyboards/id87/keymaps/via/keymap.c

@@ -0,0 +1,50 @@
+/*
+Copyright 2020 Tybera
+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
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+	[0] = LAYOUT_tkl_ansi(
+        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_PSCR, KC_SLCK, KC_PAUS,
+        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_INS,  KC_HOME, KC_PGUP,
+        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_DEL,  KC_END,  KC_PGDN,
+        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_UP,
+        KC_LCTL,   KC_LGUI,   KC_LALT,                       KC_SPC,                              KC_RALT,   KC_RGUI,   LT(1, KC_APP),     KC_RCTL,      KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [1] = LAYOUT_tkl_ansi(
+        RESET,            _______, _______, _______, _______,     _______, _______, _______, _______,      _______, _______, _______, _______,   _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,            _______, RGB_HUI, _______,
+        _______,     BL_TOGG, RGB_TOG, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,        RGB_VAI, RGB_SAI, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, NK_TOGG, _______, _______, _______, _______, _______,                            BL_INC,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,   _______,      BL_INC,  BL_DEC, RGB_MOD
+    ),
+	[2] = LAYOUT_tkl_ansi(
+        _______,            _______, _______, _______, _______,     _______, _______, _______, _______,      _______, _______, _______, _______,   _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,            _______, _______, _______,
+        _______,     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,        _______, _______, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                            _______,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,   _______,      _______,  _______, _______
+                ),
+	[3] = LAYOUT_tkl_ansi(
+                _______,            _______, _______, _______, _______,     _______, _______, _______, _______,      _______, _______, _______, _______,   _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,            _______, _______, _______,
+        _______,     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,        _______, _______, _______,
+        _______,       _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,            _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                            _______,
+        _______,   _______,   _______,                      _______,                              _______,   _______,   _______,   _______,      _______,  _______, _______
+                ),
+};

+ 2 - 0
keyboards/id87/keymaps/via/rules.mk

@@ -0,0 +1,2 @@
+LTO_ENABLE = yes
+VIA_ENABLE = yes

+ 19 - 0
keyboards/id87/readme.md

@@ -0,0 +1,19 @@
+# IDOBAO ID87
+
+![ID87](https://cdn.shopify.com/s/files/1/0382/1348/4675/products/6601EE887B14D36DE54CA137F0E383AE_1024x1024.jpg)
+
+A TKL hotswap board from IDOBAO.
+
+* Keyboard Maintainer: Tybera
+* Hardware Supported: IDOBAO ID87, atmega32u4
+* Hardware Availability: [Idobao](https://www.idobao.net/products/idobao-id87-80-hot-swappable-mechanical-keyboard-kit)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make id87:default
+
+Flashing example for this keyboard:
+
+    make id87: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).

+ 24 - 0
keyboards/id87/rules.mk

@@ -0,0 +1,24 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+
+LAYOUTS = tkl_ansi