Add build guide
This commit is contained in:
foostan
parent
88cb91d7ec
commit
9a420a60cb
159
doc/buildguide_jp.md
Normal file
159
doc/buildguide_jp.md
Normal file
@ -0,0 +1,159 @@
|
|||||||
|
# Build Guide
|
||||||
|
|
||||||
|
## 部品
|
||||||
|
### 必須
|
||||||
|
| 名前 | 数 | 備考 |
|
||||||
|
|:-|:-|:-|
|
||||||
|
| PCB | 2枚 | |
|
||||||
|
| プレート | 2セット | |
|
||||||
|
| ProMicro | 2枚 | |
|
||||||
|
| TRRSジャック | 2個 | |
|
||||||
|
| TRS(3極)ケーブル | 1本 | TRRS(4極)ケーブルでも可 |
|
||||||
|
| タクトスイッチ | 2個 | |
|
||||||
|
| ダイオード | 42本 | ロープロの場合は表面実装のみ可 |
|
||||||
|
| キースイッチ | 42個 | |
|
||||||
|
| キーキャップ | 42個 | 1u 40個、1.5u 2個 |
|
||||||
|
| スペーサー M2 6mm | 10本 | ロープロの場合は 3mm |
|
||||||
|
| スペーサー M2 8mm or 10mm | 4本 | |
|
||||||
|
| ネジ M2 | 28本 | |
|
||||||
|
| クッションゴム | 10個 | |
|
||||||
|
|
||||||
|
### オプション
|
||||||
|
| 名前 | 数 | 備考 |
|
||||||
|
|:-|:-|:-|
|
||||||
|
| OLEDモジュール | 1~2枚 | |
|
||||||
|
| ピンヘッダ 4連 | 2つ | OLEDモジュールを使用する場合 |
|
||||||
|
| ピンソケット4連 | 2つ | OLEDモジュールを使用する場合 |
|
||||||
|
| SK6812MINI | 54個 | 上向き実装 42個、下向き実装 12個 |
|
||||||
|
| シリアルLEDテープ | 2本 | SK6812MINI との併用は想定していません |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 実装
|
||||||
|
|
||||||
|
PCBはリバーシブルになっているので、最初にどちらを左用/右用にするか決めます。
|
||||||
|
|
||||||
|
### ダイオード
|
||||||
|
__ロープロファイルのキースイッチを使う場合__
|
||||||
|
|
||||||
|
ロープロファイルスイッチを利用する場合は、表面実装タイプのダイオードを利用し、必ず __裏面に実装してください__ 。表面に実装してしまうとトッププレートがダイオードと干渉してしまいます。
|
||||||
|
|
||||||
|
__ロープロファイルのキースイッチを使わない場合__
|
||||||
|
|
||||||
|
写真の位置にダイオードを実装します。
|
||||||
|
どちらの面に実装するかは好みですが、Undergrow LEDを実装する場合は、干渉をさけるため表面に実装することをおすすめします。
|
||||||
|
なお、ロープロファイルのキースイッチを使う場合と同様に表面実装タイプを利用しても問題ありません。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
ダイオードには向きがあるので注意してください。
|
||||||
|
|
||||||
|
<- 実装前 | 実装後 ->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### LED(オプション)
|
||||||
|
|
||||||
|
キースイッチ裏のLED(7~27)は表面側が光るように実装し、その他(1~6)は裏面側が光るようにします。
|
||||||
|
下記がLEDを実装する位置です。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
下記のように __裏面から各LEDを実装します__ 。○印を基準としLEDの向きに注意して実装してください。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
1~6のLEDは側面のわずかに出ているパターン(写真上のピンク色)とPCBのパターン(写真上の青色)をはんだ付けします。
|
||||||
|
フラックスを塗った上で少量のはんだを半田ごてで取ってパターンの境目に押し付けるとうまくいきます。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
LEDの点灯チェックを行う場合は、上記写真の番号どおりにつながっているため、途中までしか点灯しない場合は点灯しないLEDか、その一つ手前のLEDの実装ミスの可能性が高いので確認してみてください。
|
||||||
|
|
||||||
|
### OLEDモジュールのためのジャンパ(オプション)
|
||||||
|
OLEDモジュールを利用する場合は下記のようにジャンパします。
|
||||||
|
なお __表面のみジャンパしてください__ 。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### TRRSジャック、リセットスイッチ、OLEDピンソケット(オプション)
|
||||||
|
|
||||||
|
下記の写真通りにTRRSジャック、リセットスイッチを実装します。
|
||||||
|
またOLEDモジュールを使用する場合は、ピンソケットを実装します。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### ProMicro
|
||||||
|
ピンヘッダを白い枠に当てはめるように実装し、そこにProMicroの裏面を上にして実装します。
|
||||||
|
なお下記の写真は右手用ですが、左手用も同様に白枠にピンヘッダを実装し、ProMicroの裏面を上にして実装します。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### OLEDモジュール
|
||||||
|
OLEDモジュールにピンヘッダを実装し、ピンソケットに差し込みます。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
ピンソケットとピンヘッダの高さによって利用するスペーサーの高さを調節してください。
|
||||||
|
写真では電子部品店で入手可能な一般的なピンソケットとピンヘッダと8mmのスペーサーを利用した例となります。
|
||||||
|
|
||||||
|
### 動作確認
|
||||||
|
キースイッチを付けると何か問題があった場合に修正が難しくなるため、ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。
|
||||||
|
|
||||||
|
動作確認をする場合は先に下記の「ファームウェア」の章を参考にしてcrkbd用のファームウェアをProMicroに入れてください。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
デフォルトのキーマップを適用するとOLEDに押したキーに関する情報が表示されます。ピンセット等でスイッチ部分をショートさせることで動作確認ができます。
|
||||||
|
|
||||||
|
LEDを実装した場合はすべて点灯することを確認します。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### キースイッチおよびトッププレート
|
||||||
|
キースイッチとPCBの間にトッププレートを挟んで表面に実装します。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### ボトムプレート
|
||||||
|
ロープロの場合は3mmのスペーサー、それ以外は6mmのスペーサーを取り付けたあとにボトムプレートを取り付けます。
|
||||||
|
またクッションゴムを6つ付けます。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### キーキャップ
|
||||||
|
最後にキーキャップを付けて実装は完了です。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## ファームウェア
|
||||||
|
https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
|
||||||
|
|
||||||
|
環境ができましたら、下記コマンドで Let's Split 用にファームウェアをビルドします。
|
||||||
|
|
||||||
|
```
|
||||||
|
make crkbd:default
|
||||||
|
```
|
||||||
|
|
||||||
|
ビルドが完了したら下記コマンドを実行します。
|
||||||
|
|
||||||
|
```
|
||||||
|
make crkbd:default:avrdude
|
||||||
|
```
|
||||||
|
|
||||||
|
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
|
||||||
|
この間にリセットスイッチを __2回__ 押すとファームウェアの書き込みが完了します。
|
||||||
|
|
||||||
|
```
|
||||||
|
<省略>
|
||||||
|
|
||||||
|
Checking file size of crkbd_rev1_default.hex [OK]
|
||||||
|
* File size is fine - 27328/28672
|
||||||
|
Copying crkbd_rev1_default.hex to qmk_firmware folder [OK]
|
||||||
|
Detecting USB port, reset your controller now........
|
||||||
|
```
|
||||||
|
|
||||||
|
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
|
||||||
|
|
||||||
|
以上で完成です。
|
||||||
Loading…
Reference in New Issue
Block a user