Ergodox EZを使う

去年末、GDG九州のオーガナイザーの松岡さんがブログにこんなのを上げてた。
[今年買ってよかったものトップ５ 2016](https://firespeed.org/diary.php?diary=kenz-1878)

これを見て僕もErgodoxが欲しくなったのですぐに注文。
infinityはすぐに手に入らないのと、組み立てるのが面倒だったので、組み立て済みのEZの方にした。
今までHHKBの墨の無刻印を使っていたので、[ErgoDox EZ Bundle with Blank Keycaps](https://ergodox-ez.com/collections/frontpage/products/ergodox-ez-bundle-with-blank-keycaps)にした。
KeyswitchesはGateron Red。色々調べているとRedが無難そうだったので。

2週間くらいで来るとメールに書いてあり、ちょうど2週間たった一昨日(13日)に届いた。

使い始めて2日経ったが、なんていうか、つらい。
このつらさを一人でも多くの人に共有したいのと、キーマップの変更時に使用するファイルのパスが前と変わっていたので、その説明をしようと思う。

# Ergodoxはすばらしい！
ってみんないうけど、使い始めが地獄のようにつらい。
HHKBの無刻印を使っていたので、英字配列しか使わないし、無刻印でもある程度は分かると思っていたが、jの真下にm(普通はnとmが斜め下にある)があるような配置になっていて、とにかく押し間違える。
HHKBを使い始めた時でも、ここまでひどくなかったので、この独特のキー配置に慣れる必要がある。

ただ、幸いなことに、いくら四苦八苦しても、肩はこらない。
あと、僕の場合、今までyを左人差し指で押していたようで、ある意味つらいが、正しく矯正される。

# キーがいっぱいあって使い放題！
全然使わなかったり、指が届かなかったり、ミスリードみたいなキーマップになっていたりするだけで。
以下のような感じ。やっぱつらい。

* 親指のキーが6個ずつあるが、外側の4つのキーに全く指が届かない。
* 長押しでキーの役割が変わったりする機能が微妙にシビアで、意図しない動きをしたりする。
* z長押しでCtrlになるとか、Undoどうするんだってなる。別のキーにもCtrlは割り当てられてるけど。長押しで。
* Enterのつもりで、右端の上から3番目のキーを押すと、シングルクォーテーション。
* Tabのつもりで、左端の上から2番目のキーを押すと、Del。
* 間違って押したDelをUndoしようと、z長押ししてて、違う違うとCtrl探したら、親指の届かないところにあって、のコンボでつらい。

あと、Hyperキーとかあるけど、僕は使わないし。

しかし、キーマップを簡単に自由に書き換えることが出来るので、これらの問題はほぼ解消することが出来る。

# キーマップを書き換える
僕の環境はいつも通り、Windows。
書き換えるツール自体はWindowsで使えるが、コンパイル環境を構築するのが面倒そうだったので、コンパイルにはVMを使用した。Dockerでもいいと思う。

|対象|OS|
|:--|:--|
|PC|Windows10 x64|
|コンパイル用(VM)|Ubuntu 14.04 x64|

## 書き換え用ツールの取得
下記からWindows用のツールが取得できる。
「Teensy Loader Program」をクリックするとダウンロードが始まる。
https://www.pjrc.com/teensy/loader_win10.html

## コンパイル環境構築
Ubuntu(VM)で以下コマンドを実行する。
まずはコンパイルで使用するライブラリの取得。

```
sudo apt-get install avr-libc
sudo apt-get install dfu-programmer
```

適当なワークディレクトリに移動し、ソースを取得する。

```
git clone https://github.com/jackhumbert/qmk_firmware.git
```

qmk_firmware/keyboards/ergodox/keymaps/default 以下にあるkeymap.cを編集していくが、自分用にコピーしたものを編集するようにする。
そのため、defaultディレクトリを任意の名前でコピーする。とりあえず、「default_mykey」とする。

```
cd qmk_firmware/keyboards/ergodox/keymaps/
cp -r default default_mykey
```

## キーマップの編集
[keycode.h](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/common/keycode.h)に定義されているものを当てはめていく。
僕が参考にしたのは以下。

* [Ergodox EZ を使ってみよう](http://qiita.com/kei_s/items/40a896d1a1c70f2961e0)  
パスが変わってて、keymap.cは[ここ](https://github.com/kei-s/qmk_firmware/blob/my-layout/keyboards/ergodox/keymaps/osx_ja/keymap.c)
* [[ErgoDox Ez]一例としてのHHKBに慣れ親しんだ人間のkeymap.c](http://qiita.com/ngsw/items/b86ba0e305bd1dbbcf8f)

僕のkeymap.cは最後に記載している。

## コンパイル
qmk_firmware/keyboards/ergodox/ ディレクトリに移動し、コンパイルする。
「make KEYMAP=(自分のkeymap.cが格納されたディレクトリ名)」を実行する。
さっきは「default_mykey」と名付けたので、以下のようになる。

```
cd qmk_firmware/keyboards/ergodox/
make KEYMAP=default_mykey
```

qmk_firmware ディレクトリに、「ergodox_ez_default_mykey.hex」というHexファイルが作成される。

## 書き換え
書き換え用ツール(teensy.exe)を起動する。
メニューから下記を選択し、Hexファイルを書き換え用ツールに読み込ませる。
`File > Open HEX File`

Autoボタンを押下する。これでErgodoxのリセットボタンを押下すると、自動的に書き込みが始まるようになる。

右上(LEDの横)にある小さな穴の下にErgodoxのリセットボタンがある。
ErgodoxをPCにつなぎ、リセットボタンを針などで押下する。
これで書き込みが開始され、書き換えることが出来る。

## 僕のkeymap.c
僕のkeymap.cは以下のようにした。

親指の大きいキーは積極的に取り入れるようにした。通常は親指はあまり使わないので、無理のない位置なら、有効に活用する方が理にかなっていると思ったので。
また逆に、以前から1を押そうとしてESCを押下したり、BSを押下しようとしてDelを押下したりしていたので、押しにくい位置に配置してみた。

長押しでキーの役割が変わる機能は、ややこしいのでほぼ廃止した。
CtrlとShiftは単独で機能しないボタンなので、長押しでそれらに切り替わるのはありかなとは思うが、どれがどれだか覚えにくいので。

レイヤー2のRESETは、リセットボタンに該当する。リセットボタンが押しにくい位置にあるので、これがあると後の書き換えが楽になる。

「Shift and click」のコメントは、編集時に足りているか確認するように追加したもの。

色々考えながらカスタマイズするのは楽しい。
まだ慣れていないので、つらい面もあるが、結構楽しめてるように思う。

```c:keymap.c
#include "ergodox.h"
#include "debug.h"
#include "action_layer.h"
#include "version.h"

#define BASE 0 // default layer
#define SYMB 1 // symbols
#define MDIA 2 // media keys

enum custom_keycodes {
  PLACEHOLDER = SAFE_RANGE, // can always be here
  EPRM,
  VRSN,
  RGB_SLD
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Keymap 0: Basic layer
 *
 * ,--------------------------------------------------.           ,--------------------------------------------------.
 * |   =    |   1  |   2  |   3  |   4  |   5  | LEFT |           | RIGHT|   6  |   7  |   8  |   9  |   0  |   -    |
 * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 * |   `    |   Q  |   W  |   E  |   R  |   T  |  Up  |           |  L1  |   Y  |   U  |   I  |   O  |   P  |   \    |
 * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 * | LCtrl  |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |' /Ctrl |
 * |--------+------+------+------+------+------| Down |           |  L2  |------+------+------+------+------+--------|
 * | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
 * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 *   | Alt  |      |      | Meh  |Hyper |                                       | Left |Right |   [  |   ]  | Alt  |
 *   `----------------------------------'                                       `----------------------------------'
 *                                        ,-------------.       ,-------------.
 *                                        | App  | LGui |       | Del  | Esc  |
 *                                 ,------|------|------|       |------+--------+------.
 *                                 |      |      | Home |       | PgUp |        |      |
 *                                 | Space|Backsp|------|       |------|  Tab   |Enter |
 *                                 |      |ace   | End  |       | PgDn |        |      |
 *                                 `--------------------'       `----------------------'
 *
 * Shift and click
 * ,--------------------------------------------------.           ,--------------------------------------------------.
 * |   +    |   !  |   @  |   #  |   $  |   %  |      |           |      |   ^  |   &  |   *  |   (  |   )  |   _    |
 * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 * |   ~    |      |      |      |      |      |      |           |      |      |      |      |      |      |   |    |
 * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 * |        |      |      |      |      |      |------|           |------|      |      |      |      |   :  |   "    |
 * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 * |        |      |      |      |      |      |      |           |      |      |      |   <  |   >  |   ?  |        |
 * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 *   |      |      |      |      |      |                                       |      |      |   {  |   }  |      |
 *   `----------------------------------'                                       `----------------------------------'
 */
// If it accepts an argument (i.e, is a function), it doesn't need KC_.
// Otherwise, it needs KC_*
[BASE] = KEYMAP(  // layer 0 : default
        // left hand
        KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,   KC_5,   KC_LEFT,
        KC_GRV,  KC_Q,    KC_W,    KC_E,    KC_R,   KC_T,   KC_UP,
        KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,   KC_G,
        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,   KC_B,   KC_DOWN,
        KC_LALT, KC_TRNS, KC_TRNS, MEH_T(KC_NO), ALL_T(KC_NO),
                                              ALT_T(KC_APP),  KC_LGUI,
                                                              KC_HOME,
                                               KC_SPC,KC_BSPC,KC_END,
        // right hand
        KC_RGHT,  KC_6,   KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,
        TG(SYMB), KC_Y,   KC_U,    KC_I,    KC_O,    KC_P,    KC_BSLS,
                  KC_H,   KC_J,    KC_K,    KC_L,    KC_SCLN, CTL_T(KC_QUOT),
        TG(MDIA), KC_N,   KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
                          KC_LEFT, KC_RGHT, KC_LBRC, KC_RBRC, KC_RALT,
        KC_DELT, KC_ESC,
        KC_PGUP,
        KC_PGDN, KC_TAB, KC_ENT
    ),
/* Keymap 1: Symbol Layer
 *
 * ,---------------------------------------------------.           ,--------------------------------------------------.
 * |Version  |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
 * |---------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
 * |         |      |      |  Up  |      |      |      |           |      |   Up |   7  |   8  |   9  |   *  |   F12  |
 * |---------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 * |         |      | Left | Down |Right |      |------|           |------| Down |   4  |   5  |   6  |   +  |        |
 * |---------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 * |         |      |      |      |      |      |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
 * `---------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 *   | EPRM  |      |      |      |      |                                       |      |    . |   0  |   =  |      |
 *   `-----------------------------------'                                       `----------------------------------'
 *                                        ,-------------.       ,-------------.
 *                                        |      |      |       |      |      |
 *                                 ,------|------|------|       |------+------+------.
 *                                 |      |      |      |       |      |      |      |
 *                                 |      |      |------|       |------|      |      |
 *                                 |      |      |      |       |      |      |      |
 *                                 `--------------------'       `--------------------'
 */
// SYMBOLS
[SYMB] = KEYMAP(
       // left hand
       VRSN,   KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_TRNS,
       KC_TRNS,KC_TRNS,KC_TRNS,KC_UP,  KC_TRNS,KC_TRNS,KC_TRNS,
       KC_TRNS,KC_TRNS,KC_LEFT,KC_DOWN,KC_RGHT,KC_TRNS,
       KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
          EPRM,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
                                       KC_TRNS,KC_TRNS,
                                               KC_TRNS,
                               KC_TRNS,KC_TRNS,KC_TRNS,
       // right hand
       KC_TRNS, KC_F6,   KC_F7,  KC_F8,   KC_F9,   KC_F10,  KC_F11,
       KC_TRNS, KC_UP,   KC_7,   KC_8,    KC_9,    KC_ASTR, KC_F12,
                KC_DOWN, KC_4,   KC_5,    KC_6,    KC_PLUS, KC_TRNS,
       KC_TRNS, KC_AMPR, KC_1,   KC_2,    KC_3,    KC_BSLS, KC_TRNS,
                         KC_TRNS,KC_DOT,  KC_0,    KC_EQL,  KC_TRNS,
       KC_TRNS, KC_TRNS,
       KC_TRNS,
       KC_TRNS, KC_TRNS, KC_TRNS
),
/* Keymap 2: Media and mouse keys
 *
 * ,--------------------------------------------------.           ,--------------------------------------------------.
 * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |  PrSc  |
 * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 * |        |      | Lclk | MsUp | Rclk |      | WhUp |           |      |      |      |      |      |      |        |
 * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 * |RESET   |      |MsLeft|MsDown|MsRght|      |------|           |------|      |      |      |      |      |  Play  |
 * |--------+------+------+------+------+------|WhDown|           |      |------+------+------+------+------+--------|
 * |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
 * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 *   |      |      |      |      |      |                                       |VolUp |VolDn | Mute |      |      |
 *   `----------------------------------'                                       `----------------------------------'
 *                                        ,-------------.       ,-------------.
 *                                        |      |      |       |      |      |
 *                                 ,------|------|------|       |------+------+------.
 *                                 |      |      |      |       |      |Brwser|Brwser|
 *                                 |      |      |------|       |------|Back  |Forward|
 *                                 |      |      |      |       |      |      |      |
 *                                 `--------------------'       `--------------------'
 */
// MEDIA AND MOUSE
[MDIA] = KEYMAP(
       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
       KC_TRNS, KC_TRNS, KC_BTN1, KC_MS_U, KC_BTN2, KC_TRNS, KC_WH_U,
       RESET  , KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_WH_D,
       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
                                           KC_TRNS, KC_TRNS,
                                                    KC_TRNS,
                                  KC_TRNS, KC_TRNS, KC_TRNS,
    // right hand
       KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PSCR,
       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_MPLY,
       KC_TRNS,  KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS,
                          KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
       KC_TRNS, KC_TRNS,
       KC_TRNS,
       KC_TRNS, KC_WBAK, KC_WFWD
),
};

const uint16_t PROGMEM fn_actions[] = {
    [1] = ACTION_LAYER_TAP_TOGGLE(SYMB)                // FN1 - Momentary Layer 1 (Symbols)
};

const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
{
  // MACRODOWN only works in this function
      switch(id) {
        case 0:
        if (record->event.pressed) {
          SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
        }
        break;
        case 1:
        if (record->event.pressed) { // For resetting EEPROM
          eeconfig_init();
        }
        break;
      }
    return MACRO_NONE;
};

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  switch (keycode) {
    // dynamically generate these.
    case EPRM:
      if (record->event.pressed) {
        eeconfig_init();
      }
      return false;
      break;
    case VRSN:
      if (record->event.pressed) {
        SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
      }
      return false;
      break;
    case RGB_SLD:
      if (record->event.pressed) {
        #ifdef RGBLIGHT_ENABLE
          rgblight_mode(1);
        #endif
      }
      return false;
      break;
  }
  return true;
}

// Runs just one time when the keyboard initializes.
void matrix_init_user(void) {

};


// Runs constantly in the background, in a loop.
void matrix_scan_user(void) {

    uint8_t layer = biton32(layer_state);

    ergodox_board_led_off();
    ergodox_right_led_1_off();
    ergodox_right_led_2_off();
    ergodox_right_led_3_off();
    switch (layer) {
      // TODO: Make this relevant to the ErgoDox EZ.
        case 1:
            ergodox_right_led_1_on();
            break;
        case 2:
            ergodox_right_led_2_on();
            break;
        default:
            // none
            break;
    }

};
```