自作キーボードの始め方

## はじめに
- 同僚のN氏が自作キーボードに興味を持っていたので~~沼に沈めようと~~自分の知っていることを共有しようと思いました
- せっかくなのでQiitaに書いていきます
- 入門用としてキットの利用を前提とします
- 基板から自作する猛者もいますがここでは取り扱いません
- ファームは[QMK Firmware](https://qmk.fm/)を使います

## キットを選ぶ
- 最初はキットを買って組み立てるのが簡単だと思います
- 大きく分けて左右分離型と一体型があります
  - HelixとPlanckの画像です どちらもかっこいいですね
![YKB0002-1.jpg](https://qiita-image-store.s3.amazonaws.com/0/3507/6e3fce7f-e415-8791-18e2-ec18829deba4.jpeg)
![AI7B7284_copy_20171109124321.jpg](https://qiita-image-store.s3.amazonaws.com/0/3507/9f904e94-71be-c683-1e8f-70c20e4ccbd5.jpeg)


- QMK Firmwareに対応しているプロダクトを選んだほうが良いです（だいたい対応していると思います）
  - https://github.com/qmk/qmk_firmware/tree/master/keyboards
- キットはいっぱいあるので有名なやつ、日本で作られているやつを一部書いておきます

### 左右分離型
- Let's Split（レツプリ）
  - 有名なやつです、日本語の作ってみた系の情報が多いです
- Helix
  - 日本製です
- Mint60
  - 日本製です、全部入りで組み立てればすぐに使えるみたいです

### 一体型
- Planck
  - マイコンが基板に実装されているのでPro Microは別途購入不要です

## パーツを揃える
- キットによっては全部揃っていると思いますが不足しているパーツがあれば揃えましょう

### だいたい必要なパーツと道具（キットにあるものも含めてます）
- 分離型は左右で2つ必要なパーツがあります
- 必要なパーツはキットにより異なりますのでキットのパーツリストを確認してください

|   パーツ                |    購入場所   |   備考     |
|:-----------------|:-----------------|:------------------|
| PCB(基板) | キット販売サイト | |
| ダイオード | キット販売サイト、[TALP](https://talpkeyboard.stores.jp/)など | |
| TRRSジャック(3.5mm4極) | 秋葉原（千石電商、マルツなど） | 分離型のみ必要、Amazonでもあまり見かけません キット販売サイトにあれば買っといたほうが良いです |
| TRRSケーブル(3.5mm4極) | 秋葉原（千石電商、マルツなど） | 分離型のみ必要、Amazonでもあまり見かけません キット販売サイトにあれば買っといたほうが良いです |
| タクトスイッチ | Amazon、秋葉原（電子部品売ってる店ならどこでも） | 小さめのものが良いと思います |
| Arduino Pro Micro(互換品含む) | Amazon、[TALP](https://talpkeyboard.stores.jp/)、秋葉原（千石電商、秋月電子通商、マルツ、Aitendoなど） | 互換品が安くて良いと思います |
| プレート/ケース | キット販売サイト | 売ってなければレーザーカッターでアクリルなどを切るか、3Dプリンタで出力 |
| キースイッチ | Amazon, [TALP](https://talpkeyboard.stores.jp/)など | CHERRY MXかGateronで好みの押し心地のものを選ぶと良いと思います [これ](http://amzn.asia/d/hi5R7Rw)があると便利です |
| キーキャップ | Amazon, [TALP](https://talpkeyboard.stores.jp/)など | 国内にあまり選択肢がありません、海外だと高くなりがち、、 |
| キーキャップ引き抜き工具 | Amazon | なんでもいいと思います 例えば[これ](http://amzn.asia/d/8Hg4dWm) |
| はんだ　| Amazon、秋葉原（電子部品売ってる店ならどこでも） | 電子工作用ならなんでもいいと思います |
| はんだごて　| Amazon、秋葉原（電子部品売ってる店ならどこでも） | 電子工作用ならなんでもいいと思います |
| はんだごてクリーナー　| Amazon、秋葉原（電子部品売ってる店ならどこでも） | 電子工作用ならなんでもいいと思います |
| はんだ吸い取り線　| Amazon or 秋葉原（電子部品売ってる店ならどこでも） | 電子工作用ならなんでもいいと思います |
| ヘルピングハンズ　| Amazon or 秋葉原（電子部品売ってる店ならどこでも）| 電子工作用ならなんでもいいと思います |
| ニッパー　| Amazon or 秋葉原（電子部品売ってる店ならどこでも）| 電子工作用ならなんでもいいと思います |
| ピンセット　| Amazon or 秋葉原（電子部品売ってる店ならどこでも）| 電子工作用ならなんでもいいと思います |

## 組み立て
- キットの組み立て方を調べてはんだ付けをしていきます
- ソフトウェアと違ってハードウェアはやり直しが難しいので組み立て手順をしっかりと頭に入れてミスの無いようにやりましょう
- 完全にはんだ付けする前に仮止めしてみて干渉がないか確認すると良いかもしれません
- 順番や組み付け向きを間違えたりすると取り外すときにパーツを破壊することになったりします

## ファーム書き込み
- USBを繋げてマイコンにファームを書き込みます
- OSSの[QMK Firmware](https://github.com/qmk/qmk_firmware)を使います
- 以下はMacからレツプリ用のファームを書き込むコマンドの例です
- ここまで出来ればキーボードが使えるようになります

```bash
brew install avrdude
brew tap osx-cross/avr
brew install avr-gcc

# qmk_firmwareのダウンロード
git clone https://github.com/qmk/qmk_firmware.git
cd qmk_firmware
# lets_split部分はプロダクト名、hexwire部分はキーマップ名になります
make lets_split:hexwire
# レツプリはリセットボタン押すが必要ありました
make lets_split:hexwire:avrdude
```
- QMK FirmwareはC言語で書かれておりKeymapなどはカスタマイズできます
- 以下はレツプリのキーマップのコードです
- コメントのおかげで読みやすいですね

```c:qmk_firmware/keyboards/lets_split/keymaps/default/keymap.c
#include QMK_KEYBOARD_H

extern keymap_config_t keymap_config;

// Each layer gets a name for readability, which is then used in the keymap matrix below.
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
// Layer names don't all need to be of the same length, obviously, and you can also skip them
// entirely and just use numbers.
#define _QWERTY 0
#define _COLEMAK 1
#define _DVORAK 2
#define _LOWER 3
#define _RAISE 4
#define _ADJUST 16

enum custom_keycodes {
  QWERTY = SAFE_RANGE,
  COLEMAK,
  DVORAK,
  LOWER,
  RAISE,
  ADJUST,
};

// Fillers to make layering more clear
#define _______ KC_TRNS
#define XXXXXXX KC_NO

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Qwerty
 * ,-----------------------------------------------------------------------------------.
 * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |Adjust| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 * `-----------------------------------------------------------------------------------'
 */
[_QWERTY] = LAYOUT_ortho_4x12(
   KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC, \
   KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, \
   KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
   ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT  \
),

/* Colemak
 * ,-----------------------------------------------------------------------------------.
 * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  '   |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
 * `-----------------------------------------------------------------------------------'
 */
[_COLEMAK] = LAYOUT_ortho_4x12( \
  KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC, \
  KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT, \
  KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
  ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
),

/* Dvorak
 * ,-----------------------------------------------------------------------------------.
 * | Tab  |   '  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
 * `-----------------------------------------------------------------------------------'
 */
[_DVORAK] = LAYOUT_ortho_4x12( \
  KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC, \
  KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH, \
  KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT , \
  ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
),

/* Lower
 * ,-----------------------------------------------------------------------------------.
 * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |      |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 * `-----------------------------------------------------------------------------------'
 */
[_LOWER] = LAYOUT_ortho_4x12( \
  KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL, \
  KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, \
  _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______, \
  _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
),

/* Raise
 * ,-----------------------------------------------------------------------------------.
 * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |      |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 * `-----------------------------------------------------------------------------------'
 */
[_RAISE] = LAYOUT_ortho_4x12( \
  KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL, \
  KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, \
  _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, _______, _______, _______, \
  _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
),

/* Adjust (Lower + Raise)
 * ,-----------------------------------------------------------------------------------.
 * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
 * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|      |      |
 * |------+------+------+------+------+------|------+------+------+------+------+------|
 * |      |      |      |      |      |      |      |      |      |      |      |      |
 * |------+------+------+------+------+------+------+------+------+------+------+------|
 * |      |      |      |      |      |             |      |      |      |      |      |
 * `-----------------------------------------------------------------------------------'
 */
[_ADJUST] =  LAYOUT_ortho_4x12( \
  _______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL, \
  _______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  _______, _______, \
  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
)


};

#ifdef AUDIO_ENABLE
float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
#endif

void persistent_default_layer_set(uint16_t default_layer) {
  eeconfig_update_default_layer(default_layer);
  default_layer_set(default_layer);
}

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  switch (keycode) {
    case QWERTY:
      if (record->event.pressed) {
        #ifdef AUDIO_ENABLE
          PLAY_SONG(tone_qwerty);
        #endif
        persistent_default_layer_set(1UL<<_QWERTY);
      }
      return false;
      break;
    case COLEMAK:
      if (record->event.pressed) {
        #ifdef AUDIO_ENABLE
          PLAY_SONG(tone_colemak);
        #endif
        persistent_default_layer_set(1UL<<_COLEMAK);
      }
      return false;
      break;
    case DVORAK:
      if (record->event.pressed) {
        #ifdef AUDIO_ENABLE
          PLAY_SONG(tone_dvorak);
        #endif
        persistent_default_layer_set(1UL<<_DVORAK);
      }
      return false;
      break;
    case LOWER:
      if (record->event.pressed) {
        layer_on(_LOWER);
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      } else {
        layer_off(_LOWER);
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      }
      return false;
      break;
    case RAISE:
      if (record->event.pressed) {
        layer_on(_RAISE);
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      } else {
        layer_off(_RAISE);
        update_tri_layer(_LOWER, _RAISE, _ADJUST);
      }
      return false;
      break;
    case ADJUST:
      if (record->event.pressed) {
        layer_on(_ADJUST);
      } else {
        layer_off(_ADJUST);
      }
      return false;
      break;
  }
  return true;
}
```

## おわりに
- Realforceを買ってしまい自作キーボード熱が冷めてしまっていたのですが、この記事を書いている過程でまた自作してきたくなってきました
- たしかPlanckのキットが余っていたので組み立ててみようと思います
- 3Dモデリングも勉強中なのでケースを3Dプリンタで出力してみるのも面白そうです