Improves MarkDown standards conformity
This commit is contained in:
hoijui
@@ -1,7 +1,9 @@
|
||||
# Build Guide
|
||||
|
||||
## Parts
|
||||
|
||||
### Required
|
||||
|
||||
| Item | Count | Remark |
|
||||
|:-|:-|:-|
|
||||
| PCB | 2 | |
|
||||
@@ -13,12 +15,13 @@
|
||||
| Diode | 42 | You need SMD for low profile. |
|
||||
| Key Switch | 42 | |
|
||||
| Key Cap | 42 | 1u x 40, 1.5u x 2 |
|
||||
| Spacer M2 7.5mm | 10 | use 3mm for low profile |
|
||||
| Spacer M2 7.5mm | 10 | use 3mm for low profile |
|
||||
| Spacer M2 9mm or 11mm | 4 | |
|
||||
| Screw M2 4mm | 28 | |
|
||||
| Rubber foot | 10 | |
|
||||
|
||||
### Optional
|
||||
|
||||
| Item | Count | Remark |
|
||||
|:-|:-|:-|
|
||||
| OLED Module | 1 or 2 | |
|
||||
@@ -30,6 +33,7 @@
|
||||
|
||||
|
||||
## Preparation
|
||||
|
||||
If you build the firmware yourself, it will take some time to set up the environment, so it's best to start at the beginning. \
|
||||
For more information, please see https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md.
|
||||
|
||||
@@ -84,12 +88,13 @@ LEDs are connected in the order of the number on the picture above. If it turns
|
||||
__Note__ that the default Crkbd firmware has __LEDs turned off__, so you'll have to turn them on before you can test (see the firmware section for instructions how).
|
||||
|
||||
### Jumpers for OLED modules (optional)
|
||||
|
||||
To use OLED modules, short circuit the jumper patterns.
|
||||
__Only short circuit the front side__
|
||||
|
||||
|
||||
|
||||
### TRRS socket, reset switch, OLED header sockets.
|
||||
### TRRS socket, reset switch, OLED header sockets
|
||||
|
||||
Install TRRS sockets and reset switches as in the picture.
|
||||
For OLEDs, also implement pin sockets.
|
||||
@@ -107,6 +112,7 @@ The ProMicro is then installed __in the set of holes that has a white frame on t
|
||||
The picture is the right hand side, but it's the same for the left hand side - pins into the through holes in the white frame as seen from the frontside, placing the ProMicro with its backside up.
|
||||
|
||||
### OLED Module
|
||||
|
||||
Implement pin header onto the OLED modules, then insert them into the pin sockets.
|
||||
|
||||
|
||||
@@ -114,28 +120,27 @@ Implement pin header onto the OLED modules, then insert them into the pin socket
|
||||
Adjust the height of the spacer accordingly to the height of pin header.
|
||||
Most common pin header/socket and 11mm spacers are used in the picture.
|
||||
|
||||
|
||||
### Use socket to Mount ProMicro
|
||||
|
||||
With using sockets for mounting ProMicro, you can replace it easily when it breaks. Two methods are introduced here.
|
||||
|
||||
|
||||
#### Using Spring Loaded Header
|
||||
|
||||
Refer to [Helix Buildguide](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
|
||||
|
||||
ProMicro kit with spring loaded headers is available at Yusha-Kobo
|
||||
|
||||
https://yushakobo.jp/shop/promicro-spring-pinheader/
|
||||
<https://yushakobo.jp/shop/promicro-spring-pinheader/>
|
||||
|
||||
Using OLEDs available at Yusha-Kobo which come with low profile header, together with and 9mm spacers, you can build them think and gap-less.
|
||||
|
||||
|
||||
|
||||
#### Using Pin Sockets
|
||||
|
||||
Low profile pin sockets are available from Akizuki Denshi etc. Requires some work.
|
||||
|
||||
http://akizukidenshi.com/catalog/g/gC-03138/
|
||||
<http://akizukidenshi.com/catalog/g/gC-03138/>
|
||||
|
||||
Install a couple of 12x1 pin sockets on a breadboard.
|
||||
|
||||
@@ -155,12 +160,10 @@ Spring loaded headers can make the height lower.
|
||||
|
||||
|
||||
|
||||
|
||||
Comparing pin-headers in the picture. Headers come with OLED available at Yusha-Kobo are lower.
|
||||
|
||||
|
||||
|
||||
|
||||
### Testing
|
||||
It is recommended to test the ProMicro and OLED modules before installing keyswitches because rework would be difficult after that.
|
||||
|
||||
@@ -177,31 +180,34 @@ If you have mounted LEDs, also make sure all of them are turned on. As note befo
|
||||
|
||||
|
||||
### Keyswitches and Top Plate
|
||||
|
||||
Sandwich top-plate with PCB and key-switches.
|
||||
|
||||
|
||||
|
||||
|
||||
### Bottom Plate
|
||||
|
||||
Use 3mm spacers for low-profile,
|
||||
Attach bottom plate to the PCB using 7.5mm (3mm for low-profile) spacers.
|
||||
Then attach six rubber feet.
|
||||
|
||||
|
||||
|
||||
|
||||
### Keycaps
|
||||
|
||||
Lastly install keycaps.
|
||||
|
||||
|
||||
|
||||
|
||||
## Firmware
|
||||
|
||||
See below to flash the firmware to the ProMicro. \
|
||||
https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md
|
||||
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
|
||||
|
||||
### Turning LEDS on
|
||||
|
||||
To turn the LEDs on, you have to edit the `rules.mk` file. If you use the default layout, it can be found here `keyboards/crkbd/keymaps/default/rules.mk`. Add the following line to the top of the file:
|
||||
|
||||
```
|
||||
RGBLIGHT_ENABLE = yes
|
||||
```
|
||||
@@ -209,25 +215,31 @@ RGBLIGHT_ENABLE = yes
|
||||
Compile and flash to both sides and all LEDs should turn on and __glow red__ if you have soldered everything correctly. If you run the default firmware and the LEDs turn a differrent color, the data to the LEDs is probably corrupted somewhere along the way. Check the LED before the first one turning a different color using the troubleshooting guide below.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Here are some tips and tricks on how to troubleshot a board that is not working.
|
||||
|
||||
### No LEDs turn on
|
||||
|
||||
There are a number of things that might be wrong. First of all, make sure you have __turned on LED lighting in the firmware__. If that is the case, then chances are there might be a problem with the first LED. Try the suggestions in the next section.
|
||||
|
||||
### Some LEDs not turning on
|
||||
|
||||
If some LEDs aren't turning on, check the first LED not turning on __or__ the one before it.
|
||||
|
||||
|
||||
|
||||
Here are some things to try out:
|
||||
|
||||
- Make sure the LED is soldered correctly. Check the pads to see if it looks like they have a proper connection.
|
||||
- Check the LED orientation. Use the pictures above the see the correct orientation. Since the first LED is soldered with its back against the PCB, you might have to determinewhat the orientation should look like from the front using LEDs 7-27 (just double check that they are oriented correctly first).
|
||||
- If both of the above looks good, chances are the LED was damaged during soldering. Either replace it directly or use the diod mode of a multimeter to test the connectivity. One way to do this is by simply comparing to some of the other LEDs you have soldered. Choose two of the LED's pads (out of the four available) and compare the reading to that of some of the other LEDs (taking care to measure the same pads with the same needles of your multimeter). Work your way through all combinations of pads and needles. If the differ, you either have a broken LED or bad connectivity. Or simply desolder the LED directly, might be quicker. :)
|
||||
|
||||
### A full row/column of keys not working
|
||||
|
||||
If a full row or column of keys is not working, then the culprit is most likely the connection between the PCB and the ProMicro. Check your soldering and make sure there's a proper connection and that you have soldered the ProMicro in the right set of holes. If soldering looks okay, then your ProMicro might be damaged. You can exclude the possibility of problems with the PCB, paths and diodes by short circuiting the pins on the ProMicro directly using a bit of wire. Connecting one row pin with one column pin should result in the corresponding key. Some PCBs have silkscreen print indicating which pin is which row or column, to make this process easier.
|
||||
|
||||
### Random key(s) not working
|
||||
|
||||
If it is not a full row or column of keys that are not working, the issue is most likely that there's no connection between the key and the ProMicro. There are multiple places where the connection can get interupted:
|
||||
|
||||
- between keyswitch and PCB (if you have installed the switches)
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
# Build Guide
|
||||
|
||||
## 部品
|
||||
|
||||
### 必須
|
||||
|
||||
| 名前 | 数 | 備考 |
|
||||
|:-|:-|:-|
|
||||
| PCB | 2枚 | |
|
||||
@@ -19,6 +21,7 @@
|
||||
| クッションゴム | 10個 | |
|
||||
|
||||
### オプション
|
||||
|
||||
| 名前 | 数 | 備考 |
|
||||
|:-|:-|:-|
|
||||
| OLEDモジュール | 1 ~ 2枚 | |
|
||||
@@ -30,15 +33,17 @@
|
||||
|
||||
|
||||
## 事前準備
|
||||
|
||||
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
|
||||
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
|
||||
詳しくは <https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md> を参照してください。
|
||||
|
||||
## 実装
|
||||
|
||||
PCBはリバーシブルになっているので、最初にどちらを左用/右用にするか決めます。
|
||||
|
||||
### ダイオード
|
||||
__ロープロファイルのキースイッチを使わない場合__
|
||||
|
||||
#### ロープロファイルのキースイッチを使わない場合
|
||||
|
||||
写真の位置にダイオードを実装します。
|
||||
どちらの面に実装するかは好みですが、Undergrow LEDを実装する場合は、干渉をさけるため表面に実装することをおすすめします。
|
||||
@@ -52,7 +57,7 @@ __ロープロファイルのキースイッチを使わない場合__
|
||||
|
||||
|
||||
|
||||
__ロープロファイルのキースイッチを使う場合__
|
||||
#### ロープロファイルのキースイッチを使う場合
|
||||
|
||||
ロープロファイルスイッチを利用する場合は、表面実装タイプのダイオードを利用し、必ず __裏面に実装してください__ 。表面に実装してしまうとトッププレートがダイオードと干渉してしまいます。
|
||||
|
||||
@@ -75,6 +80,7 @@ __ロープロファイルのキースイッチを使う場合__
|
||||
LEDの点灯チェックを行う場合は、上記写真の番号どおりにつながっているため、途中までしか点灯しない場合は点灯しないLEDか、その一つ手前のLEDの実装ミスの可能性が高いので確認してみてください。
|
||||
|
||||
### OLEDモジュールのためのジャンパ(オプション)
|
||||
|
||||
OLEDモジュールを利用する場合は下記のようにジャンパします。
|
||||
なお __表面のみジャンパしてください__ 。
|
||||
|
||||
@@ -88,12 +94,14 @@ OLEDモジュールを利用する場合は下記のようにジャンパしま
|
||||
|
||||
|
||||
### ProMicro
|
||||
|
||||
ピンヘッダを白い枠に当てはめるように実装し、そこにProMicroの裏面を上にして実装します。
|
||||
なお下記の写真は右手用ですが、左手用も同様に白枠にピンヘッダを実装し、ProMicroの裏面を上にして実装します。
|
||||
|
||||
|
||||
|
||||
### OLEDモジュール
|
||||
|
||||
OLEDモジュールにピンヘッダを実装し、ピンソケットに差し込みます。
|
||||
|
||||
|
||||
@@ -107,23 +115,25 @@ ProMicroをソケット化をすることでProMicroが故障してしまった
|
||||
2パターンのソケット化を紹介します。
|
||||
|
||||
#### スプリングヘッダを利用したソケット化
|
||||
|
||||
ソケット化を可能とする特殊なピンヘッダを利用する方法です。
|
||||
利用方法はHelixのビルドガイドを参考にしてください。
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_jp.md#pro-micro
|
||||
<https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_jp.md#pro-micro>
|
||||
|
||||
スプリングヘッダとProMicroのセットは遊舎工房にて購入することが可能です。
|
||||
|
||||
https://yushakobo.jp/shop/promicro-spring-pinheader/
|
||||
<https://yushakobo.jp/shop/promicro-spring-pinheader/>
|
||||
|
||||
同じく遊舎工房で購入可能なOLEDについてくるピンヘッダを利用すると以下のように隙間なくきれいに収まります。また9mmのスペーサーを利用することができるのでより薄い仕上がりとなります。
|
||||
|
||||
|
||||
|
||||
#### ピンソケットを利用したソケット化
|
||||
|
||||
秋月電子等で購入可能な背の低いピンソケットを利用した方法です。
|
||||
多少の工作が必要となります。
|
||||
|
||||
http://akizukidenshi.com/catalog/g/gC-03138/
|
||||
<http://akizukidenshi.com/catalog/g/gC-03138/>
|
||||
|
||||
12個連結ピンソケット2つ用意し、ブレッドボード等に固定します。
|
||||
|
||||
@@ -148,8 +158,8 @@ ProMicroに付属しているピンヘッダProMicroを挟むようにして上
|
||||
|
||||
|
||||
|
||||
|
||||
### 動作確認
|
||||
|
||||
キースイッチを付けると何か問題があった場合に修正が難しくなるため、ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。
|
||||
|
||||
動作確認をする場合は先に下記の「ファームウェア」の章を参考にしてcrkbd用のファームウェアをProMicroに入れてください。
|
||||
@@ -163,23 +173,27 @@ LEDを実装した場合はすべて点灯することを確認します。
|
||||
|
||||
|
||||
### キースイッチおよびトッププレート
|
||||
|
||||
キースイッチとPCBの間にトッププレートを挟んで表面に実装します。
|
||||
|
||||
|
||||
|
||||
### ボトムプレート
|
||||
|
||||
ロープロの場合は4.5mmのスペーサー、それ以外は7.5mmのスペーサーを取り付けたあとにボトムプレートを取り付けます。
|
||||
またクッションゴムを6つ付けます。
|
||||
|
||||
|
||||
|
||||
### キーキャップ
|
||||
|
||||
最後にキーキャップを付けて実装は完了です。
|
||||
|
||||
|
||||
|
||||
## ファームウェア
|
||||
|
||||
下記を参照しファームウェアをProMicroに書き込みます。\
|
||||
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
|
||||
<https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md>
|
||||
|
||||
以上で完成です。
|
||||
|
||||
Reference in New Issue
Block a user