Keymap: Add Koba's keymap for Ergo42. (#3965)

* Keymap: Add Koba's keymap for Ergo42.

* Fix: Remove unnecessary #define.

* Fix: Rename readme files to lowercase.

keyboards/ergo42/keymaps/koba/config.h

@@ -0,0 +1,33 @@
+/*
+This is the c configuration file for the keymap
+
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+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
+
+/* Use I2C or Serial, not both */
+
+#define USE_SERIAL
+// #define USE_I2C
+
+/* Select hand configuration */
+
+#define MASTER_LEFT
+// #define MASTER_RIGHT
+// #define EE_HANDS
+

keyboards/ergo42/keymaps/koba/keymap.c

@@ -0,0 +1,128 @@
+/* Copyright 2018 Daisuke Kobayashi
+ *
+ * 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_jp.h"
+
+enum {
+  _WIN,
+  _MACOS,
+  _LOWER,
+  _RAISE,
+  _FUNC
+};
+
+#define KC_KNA  KC_LANG1
+#define KC_EISU KC_LANG2
+#define LOWER   MO(_LOWER)
+#define RAISE   MO(_RAISE)
+#define FN      MO(_FUNC)
+#define WIN     DF(_WIN)
+#define MACOS   DF(_MACOS)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  /* WIN
+   * ,------------------------------------------------.   ,------------------------------------------------.
+   * | Esc  | Tab  |   Q  |   W  |   E  |   R  |   T  |   |   Y  |   U  |   I  |   O  |   P  |  @ ` | Bksp |
+   * |------+------+------+------+------+------+------|   |-------------+------+------+------+------+------|
+   * | Del  | Ctrl |   A  |   S  |   D  |   F  |   G  |   |   H  |   J  |   K  |   L  |  ; + |  ; * |Enter |
+   * |------+------+------+------+------+------+------|   |------|------+------+------+------+------+------|
+   * | H/Z  |Shift |   Z  |   X  |   C  |   V  |   B  |   |   N  |   M  |  , < |  . > |  / ? |  Up  |Shift |
+   * |------+------+------+------+------+------+------|   |------+------+------+------+------+------+------|
+   * |  Fn  | Ctrl | Win  | Alt  | Mhen |LOWER |Space |   |Space |RAISE | Henk | Menu | Left | Down |Right |
+   * `------------------------------------------------'   `------------------------------------------------'
+   */
+  [_WIN] = LAYOUT( \
+    KC_ESC,  KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,     KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    JP_AT,   KC_BSPC, \
+    KC_DELT, KC_RCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,     KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, JP_COLN, KC_ENT,  \
+    KC_ZKHK, KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,     KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_UP,   KC_RSFT, \
+    FN,      KC_LCTL, KC_LGUI, KC_LALT, KC_MHEN, LOWER,   KC_SPC,   KC_SPC,  RAISE,   KC_HENK, KC_APP,  KC_LEFT, KC_DOWN, KC_RGHT  \
+  ),
+
+  /* MACOS
+   * ,------------------------------------------------.   ,------------------------------------------------.
+   * | Esc  | Tab  |   Q  |   W  |   E  |   R  |   T  |   |   Y  |   U  |   I  |   O  |   P  |  @ ` | Bksp |
+   * |------+------+------+------+------+------+------|   |-------------+------+------+------+------+------|
+   * | Del  | Ctrl |   A  |   S  |   D  |   F  |   G  |   |   H  |   J  |   K  |   L  |  ; + |  ; * |Enter |
+   * |------+------+------+------+------+------+------|   |------|------+------+------+------+------+------|
+   * | Caps |Shift |   Z  |   X  |   C  |   V  |   B  |   |   N  |   M  |  , < |  . > |  / ? |  Up  |Shift |
+   * |------+------+------+------+------+------+------|   |------+------+------+------+------+------+------|
+   * |  Fn  | Ctrl | Opt  | Cmd  | Eisu |LOWER |Space |   |Space |RAISE | Kana | Cmd  | Left | Down |Right |
+   * `------------------------------------------------'   `------------------------------------------------'
+   */
+  [_MACOS] = LAYOUT( \
+    KC_ESC,  KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,     KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    JP_AT,   KC_BSPC, \
+    KC_DELT, KC_RCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,     KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, JP_COLN, KC_ENT,  \
+    KC_CAPS, KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,     KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_UP,   KC_RSFT, \
+    FN,      KC_LCTL, KC_LALT, KC_LGUI, KC_EISU, LOWER,   KC_SPC,   KC_SPC,  RAISE,   KC_KNA,  KC_RGUI, KC_LEFT, KC_DOWN, KC_RGHT  \
+  ),
+
+  /* LOWER
+   * ,------------------------------------------------.   ,------------------------------------------------.
+   * |      |      |   !  |   "  |   #  |   $  |   %  |   |   &  |   '  |   (  |   )  |      |   =  |      |
+   * |------+------+------+------+------+------+------|   |-------------+------+------+------+------+------|
+   * |      |      | XXXX | XXXX | XXXX |   {  |   (  |   |   )  |   }  | XXXX |   ~  |   |  |   _  |      |
+   * |------+------+------+------+------+------+------|   |------|------+------+------+------+------+------|
+   * |      |      | XXXX | XXXX | XXXX | XXXX | XXXX |   | XXXX | XXXX | XXXX | XXXX | XXXX | PgUp |      |
+   * |------+------+------+------+------+------+------|   |------+------+------+------+------+------+------|
+   * |      |      |      |      |      |      |      |   |      |      |      |      | Home | PgDn | End  |
+   * `------------------------------------------------'   `------------------------------------------------'
+   */
+  [_LOWER] = LAYOUT( \
+    _______, _______, S(KC_1), S(KC_2), S(KC_3), S(KC_4), S(KC_5),  S(KC_6), S(KC_7), S(KC_8), S(KC_9), S(KC_0), JP_EQL,  _______, \
+    _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, JP_LCBR, JP_LPRN,  JP_RPRN, JP_RCBR, XXXXXXX, JP_TILD, JP_PIPE, JP_UNDS, _______, \
+    _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PGUP, _______, \
+    _______, _______, _______, _______, _______, _______, _______,  _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_END   \
+  ),
+
+  /* RAISE
+   * ,------------------------------------------------.   ,------------------------------------------------.
+   * |      |      |   1  |   2  |   3  |   4  |   5  |   |   6  |   7  |   8  |   9  |   0  |   -  |      |
+   * |------+------+------+------+------+------+------|   |-------------+------+------+------+------+------|
+   * |      |      | F11  | F12  | XXXX |   [  |   (  |   |   )  |   ]  | XXXX |   ^  |   \  |   \  |      |
+   * |------+------+------+------+------+------+------|   |------|------+------+------+------+------+------|
+   * |      |      |  F1  |  F2  |  F3  |  F4  |  F5  |   |  F6  |  F7  |  F8  |  F9  | F10  |      |      |
+   * |------+------+------+------+------+------+------|   |------+------+------+------+------+------+------|
+   * |      |      |      |      |      |      |      |   |      |      |      |      |      |      |      |
+   * `------------------------------------------------'   `------------------------------------------------'
+   */
+  [_RAISE] = LAYOUT( \
+    _______, _______, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,     KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, _______, \
+    _______, _______, KC_F11,  KC_F12,  XXXXXXX, JP_LBRC, JP_LPRN,  JP_RPRN, JP_RBRC, XXXXXXX, JP_CIRC, KC_JYEN, KC_RO,   _______, \
+    _______, _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,    KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  _______, _______, \
+    _______, _______, _______, _______, _______, _______, _______,  _______, _______, _______, _______, _______, _______, _______  \
+  ),
+
+  /* FUNC
+   * ,------------------------------------------------.   ,------------------------------------------------.
+   * |Reset |      | XXXX | XXXX | XXXX | XXXX | XXXX |   |PrtSc |SLock |Pause | XXXX | XXXX | XXXX |      |
+   * |------+------+------+------+------+------+------|   |-------------+------+------+------+------+------|
+   * |      |      | XXXX | XXXX | XXXX | XXXX | >Win |   | Ins  | XXXX | XXXX | XXXX | XXXX | XXXX |      |
+   * |------+------+------+------+------+------+------|   |------|------+------+------+------+------+------|
+   * |      |      | XXXX | XXXX | XXXX | XXXX | >Mac |   | XXXX | XXXX | XXXX | XXXX | XXXX | Vol+ |      |
+   * |------+------+------+------+------+------+------|   |------+------+------+------+------+------+------|
+   * |      |      |      |      |      |      |      |   |      |      |      |      |      | Vol- | Play |
+   * `------------------------------------------------'   `------------------------------------------------'
+   */
+  [_FUNC] = LAYOUT( \
+    RESET,   _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,  KC_PSCR, KC_SLCK, KC_PAUS, XXXXXXX, XXXXXXX, XXXXXXX, _______, \
+    _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, WIN,      KC_INS,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, \
+    _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, MACOS,    XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_VOLU, _______, \
+    _______, _______, _______, _______, _______, _______, _______,  _______, _______, _______, _______, XXXXXXX, KC_VOLD, KC_MPLY  \
+  )
+};
+

keyboards/ergo42/keymaps/koba/readme.md

@@ -0,0 +1,57 @@
+# Keymap for Ergo42
+
+## About
+
+This keymap is for Ergo42.
+
+- JIS layout.
+- Independent Windows layout/MacOS layout layers.
+- Bottom row keys arranged like a standard keyboard.
+- Arrow keys are designed in the inverted-T.
+
+## Layout
+
+![keyboard-layout](https://user-images.githubusercontent.com/1042121/45888288-aa35ed00-bdf8-11e8-8741-71fe9a0fadc6.png)
+
+## Windows mode/MacOS mode
+
+|mode        |key         |
+|------------|------------|
+|Windows mode|Function + g|
+|MacOS mode  |Function + b|
+
+When switching mode, the following keys switches.
+
+|Windows        |MacOS       |
+|---------------|------------|
+|Alt            |Command(GUI)|
+|Windows(GUI)   |Option(Alt) |
+|Menu(App)      |Command(GUI)|
+|Muhenkan       |Eisu        |
+|Henkan         |Kana        |
+|Hankaku/Zenkaku|Caps        |
+
+## Layers
+
+|No.|Name    |Description                |
+|---|--------|---------------------------|
+| 4 |Function|Mode switch, Media         |
+| 3 |Raise   |Number, Function           |
+| 2 |Lower   |Symbol, Home/End, PgUp/PgDn|
+| 1 |MacOS   |MacOS layout               |
+| 0 |Windows |Windows layout             |
+
+When power is turn on, No.0 Windows layer becomes enabled.
+
+## Windows/MacOS layers
+
+Standard layers for Windows mode/MacOS mode.
+
+## Raise/Lower layers
+
+Layer enabled during pressing Raise or Lower key.
+
+## Function layer
+
+Layer enabled during pressing Function key.
+

keyboards/ergo42/keymaps/koba/readme_ja.md

@@ -0,0 +1,62 @@
+# Keymap for Ergo42
+
+## 概要
+
+Ergo42 用キーマップです。
+
+- JIS 配列
+- 独立した Windows 配列/MacOS 配列レイヤー
+- 普通のキーボード配列に似せた最下段キー
+- 逆 T 字 (凸型) 配列の矢印キー
+
+## レイアウト
+
+![keyboard-layout](https://user-images.githubusercontent.com/1042121/45888288-aa35ed00-bdf8-11e8-8741-71fe9a0fadc6.png)
+
+## Windows モード/MacOS モード
+
+|モード        |キー        |
+|--------------|------------|
+|Windows モード|Function + g|
+|MacOS モード  |Function + b|
+
+モードを切り替えることで下記のキーが切り替わります。
+
+|Windows     |MacOS       |
+|------------|------------|
+|Alt         |Command(GUI)|
+|Windows(GUI)|Option(Alt) |
+|Menu(App)   |Command(GUI)|
+|無変換      |英数        |
+|変換        |かな        |
+|半角/全角   |Caps        |
+
+## レイヤー
+
+|No.|名称    |内容                      |
+|---|--------|--------------------------|
+| 4 |Function|モード切替, メディア      |
+| 3 |Raise   |数字, ファンクションキー  |
+| 2 |Lower   |記号, Home/End, PgUp/PgDn |
+| 1 |MacOS   |MacOS 配列                |
+| 0 |Windows |Windows 配列              |
+
+電源 ON により No.0 の Windows レイヤーが有効になります。
+
+## Windows/MacOS レイヤー
+
+Windows モード/MacOS モードの標準レイヤー。
+
+## Raise/Lower レイヤー
+
+Raise キーまたは Lower キーを押している間だけ有効になるレイヤー。
+
+普通のキーボードの最上段キー (数字/記号) に加えて、標準レイヤーに入らなかった記号キーが3つ (`[{`, `]}`, `\_`) 入っています。  
+括弧キー `[{`, `]}` は `(`, `)` を加えて、左右対称に配置しました。
+
+## Function レイヤー
+
+Function キーを押している間だけ有効になるレイヤー。
+
+Windows モード/MacOS モードの切り替え、メディア系の操作、標準レイヤーに入らなかった機能キーのレイヤーです。
+