Skip to content

Commit

Permalink
Modified readme(en) and add readme(jp) (#3)
Browse files Browse the repository at this point in the history
* Move .gitignore to root.

* Add images of pico-keyboard.

* Add descriptions on README.

* Modified the explain of soldering ProMicro.

* Modified slightly mistakes.
  • Loading branch information
x1- authored and kumaokobo committed Nov 19, 2019
1 parent 72c7395 commit 9749fc0
Show file tree
Hide file tree
Showing 7 changed files with 275 additions and 1 deletion.
File renamed without changes.
150 changes: 150 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
# Pico Keyboard Rev.1

Pico Keyboard は小さい手でも打鍵しやすいように設計された小型の分割キーボードです.
スイッチのフットプリントは通常のCherry MX互換より一回り小さい [Kailh Mid-Height](http://www.kailh.com/en/Products/Ks/KHS/) を使っています。

**English Manual is [here](README.md).**

<p align="center">
<img src="img/pico-keyboard.jpg" alt="Pico Keyboard image" width="400"/>
</p>


## Summary

- [必要な部品](#必要な部品)
- [組み立てガイド](#組み立てガイド)
- [ファームウェア](#ファームウェア)
- [基本書き込みコマンド](#基本書き込みコマンド)
- [初回書き込み時](#初回書き込み時)
- [JIS配列を書き込む場合](#JIS配列を書き込む場合)

## 必要な部品

| 数量 | 項目 | 備考 |
|----:|----------------------------------------------|-----------------------------------------------------|
| 2 | Pico PCB | |
| 65 | 1N4148 ダイオード | SMD ダイオードでも可. |
| 2 | PJ-320A 4極 3.5mm TRRS コネクタ | |
| 2 | 4.7 kΩ 抵抗 | 片側のPCBのみにはんだ付けします. |
| 2 | タクトスイッチ | 6mm x 6mm x 4.3mm サイズのもの. |
| 2 | Arduino Pro Micro | マイコン: ATMega32U4 |
| 1 | TRRS ケーブル | 4極のもの. (4極じゃないと正常動作しません) |
| 1 | USB micro ケーブル | 家に落ちているもので可. |
| 2 | ケース | |
| 8 | ネジ | M3 のもの |
| 8 | スペーサー | M3 のもの |
| 8 | ナット | M3 のもの (オプション) |
| 65 | [Kailh Mid-Height](http://www.kailh.com/en/Products/Ks/KHS/) | 茶・赤・青のいずれか |
| 65 | [Kailh Mid-Height](http://www.kailh.com/en/Products/Ks/KHS/) 互換 キーキャップ | 65 x 1u |


## 組み立てガイド

<p align="center">
<img src="img/pico-parts.jpg" alt="pico parts" width="600"/>
</p>


- PCBの `Mounting Surface` 側に下記をはんだ付けします:
1. 1N4148ダイオード (向きがあります. カソードが四角型の穴側にくるように差します)<br/><div><img src="img/pico-diode.jpg" alt="pico diode" width="250"/></div>
2. PJ-320Aコネクタ
3. タクトスイッチ
4. 4.7 kΩ 抵抗 (左右どちらかのPCBのみにはんだ付けします)
5. Pro Micro の ヘッダ・ピン (**Pro Micro 自身のはんだ付けはまだしません**).
- PCB に上部ケースを取り付けます.
* M3ネジ(8mm) → 上部ケース → M3ナット → PCB → スペーサー の順番に取り付けます.<br/><div><img src="img/pico-case.jpg" alt="pico case" width="250"/></div>
- スイッチを嵌めてはんだ付けします.
- Pro Micro を ヘッダ・ピンにはんだ付けします.<br/>
Pro Micro が裏向き(チップ類がPCBに向くように)になるようにはんだ付けします.<br/><div><img src="img/pico-promicro.jpg" alt="pico ProMicro" width="250"/></div>

## ファームウェア

<p align="center">
<img src="img/qmk-badge-dark.png" alt="qmk" width="200"/>
</p>

Pico Keyboard は [QMK Firmware](https://github.com/qmk/qmk_firmware) を利用しています.
QMK Firmware のインストールは [こちら](https://docs.qmk.fm/#/newbs_getting_started) をご覧ください.

### 基本書き込みコマンド

```sh
$ cd path/to/qmk_firmware
$ make pico/rev1:default:flash
```

### 初回書き込み時

初回書き込み時には、 左手・右手 両方の Pro Micro にファームを書く必要があります.

#### 1. 左手側

[pico/config.h](https://github.com/qmk/qmk_firmware/blob/master/keyboards/pico/config.h) を編集して `MASTER_LEFT` を有効にします.

```cpp
/* Select hand configuration */
#define MASTER_LEFT
// #define MASTER_RIGHT
// #define EE_HANDS
```

保存したら、 **左手側** の Pro Micro と PC をUSBケーブルで接続し、 [基本書き込みコマンド](#基本書き込みコマンド) を実行します.

```sh
$ cd path/to/qmk_firmware
$ make pico/rev1:default:flash
```

#### 2. 右手側

[pico/config.h](https://github.com/qmk/qmk_firmware/blob/master/keyboards/pico/config.h) を編集して `MASTER_RIGHT` を有効にします.

```cpp
/* Select hand configuration */
// #define MASTER_LEFT
#define MASTER_RIGHT
// #define EE_HANDS
```

保存したら、**右手側** の Pro Micro と PC をUSBケーブルで接続し、 [基本書き込みコマンド](#基本書き込みコマンド) を実行します.


#### 3. 動作確認

一度USBケーブルを外してから、 TRRSケーブルで左右をつなぎます.
マスター側の Pro Micro にUSBケーブルをつなぎ、左右ともに文字入力可能なことを確認します.  

以降、キー配列を変更した場合など再びファームを書く場合は、 TRRSケーブルをつないだままマスター側の Pro Micro に書き込みを行うことで、左右に設定が反映されるようになります.  


### JIS配列を書き込む場合

[qmk_firmware/keyboards/pico/keymaps/jis](https://github.com/qmk/qmk_firmware/blob/master/keyboards/pico/rev1/keymaps/jis/keymap.c) に JIS-like配列を置いていますが、[Qmk Firmware](https://github.com/qmk/qmk_firmware)[keycodes](https://github.com/qmk/qmk_firmware/blob/master/docs/keycodes.md) を参考にご自身の使いやすいレイアウトに変更してお使いになられると良いかもしれません.

```sh
$ cd path/to/qmk_firmware
$ make pico/rev1:jis:flash
```


## レイアウト

### デフォルト

<p align="center">
<img src="img/pico-layout.png" alt="pico rev1.0 layout"/>
</p>

[KLE Layout permalink](http://www.keyboard-layout-editor.com/##@_name=pico-keyboard&author=x1%3Cviva008%[email protected]%3E%3B&@=~%0A%0A%60&_f2:2%3B&=1%0AF1%0A!&=2%0AF2%0A%2F@&=3%0AF3%0A%23&=4%0AF4%0A$&=5%0AF5%0A%25&_x:3%3B&=6%0AF6%0A%5E&=7%0AF7%0A%2F&&=8%0AF8%0A*&=9%0AF9%0A(&=0%0AF10%0A)&=-%0AF11%0A%2F_&=%E2%86%90%0AF12%0Aback%3B&@_x:0.25%3B&=Tab&=Q&=W&=E&=R&=T&_x:3&f:3%3B&=Y%0A(&_f:3%3B&=U%0A)&_f:3%3B&=I%0A%7C&_f:3%3B&=O%0A*&_f:3%3B&=P%0A~&_f:3%3B&=%5B%0A%C2%A5%0A%7B&_f:3%3B&=%5D%0A%5C%0A%7D%3B&@_x:0.5%3B&=Ctrl&=A&=S&=D&=F&=G&_x:3&f:3%3B&=H%0A%5B&_f:3%3B&=J%0A%5D&_f:3%3B&=K%0A.&_f:3%3B&=L%0A%2F%2F&_f:3%3B&=%2F%3B%0A%60%0A%2F:&_f:3%3B&='%0A-%0A%22&=Enter%3B&@_x:0.75%3B&=Shift&=Z&=X&=C&=V&=B&_x:3&f:3%3B&=N%0A%7B&_f:3%3B&=M%0A%7D&_f:3%3B&=,%0A%0A%3C&_f:3%3B&=.%0A%0A%3E&_f:3%3B&=%2F%2F%0A%0A%3F&_f:3%3B&=%E2%86%91%0A%5E&=Shift%3B&@_x:1&f:3%3B&=Alt%0A%0A%0AEsc&=Enter&=Del&=GUI&_fa@:2&:2%3B%3B&=LANG2%0Alayer&_f:3%3B&=Space&_x:3&f:3%3B&=Space&=LANG1%0Alayer&_f:3%3B&=GUI&_f:3%3B&=Del&_f:3%3B&=%E2%86%90%0A%3C&_f:3%3B&=%E2%86%93%0A%2F_&_f:3%3B&=%E2%86%92%0A%3E)

### JIS-like 配列

<p align="center">
<img src="img/pico-jis-like-layout.png" alt="pico rev1.0 JIS layout"/>
</p>

[KLE Layout permalink](http://www.keyboard-layout-editor.com/##@_name=pico-keyboard%20JIS-like&author=x1%3Cviva008%[email protected]%3E%3B&@=Esc&_f2:2%3B&=1%0AF1%0A!&=2%0AF2%0A%22&=3%0AF3%0A%23&=4%0AF4%0A$&=5%0AF5%0A%25&_x:3%3B&=6%0AF6%0A%2F&&=7%0AF7%0A'&=8%0AF8%0A(&=9%0AF9%0A)&=0%0AF10&=-%0AF11%0A%2F=&=%E2%86%90%0AF12%0Aback%3B&@_x:0.25%3B&=Tab&=Q&=W&=E&=R&=T&_x:3&f:3%3B&=Y%0A(&_f:3%3B&=U%0A)&_f:3%3B&=I%0A%7C&_f:3%3B&=O%0A%C2%A5&_f:3%3B&=P%0A~&_f:3%3B&=%2F@%0A%0A%60&_f:3%3B&=%5E%0A%0A~%3B&@_x:0.5%3B&=Ctrl&=A&=S&=D&=F&=G&_x:3&f:3%3B&=H%0A%5B&_f:3%3B&=J%0A%5D&_f:3%3B&=K%0A.&_f:3%3B&=L%0A%2F%2F&_f:3%3B&=%2F%3B%0A%60%0A+&_f:3%3B&=%2F:%0A-%0A*&=Enter%3B&@_x:0.75%3B&=Shift&=Z&=X&=C&=V&=B&_x:3&f:3%3B&=N%0A%7B&_f:3%3B&=M%0A%7D&_f:3%3B&=,%0A%0A%3C&_f:3%3B&=.%0A%0A%3E&_f:3%3B&=%2F%2F%0A%0A%3F&_f:3%3B&=%E2%86%91%0A%2F_&=Layer%3B&@_x:1&f:3%3B&=Alt%0A%0A%0AEsc&=Enter&=Del&=GUI&_fa@:2&:2%3B%3B&=LANG2%0Alayer&_f:3%3B&=Space&_x:3&f:3%3B&=Space&=LANG1%0Alayer&_f:3%3B&=GUI&_f:3%3B&=Del&_f:3%3B&=%E2%86%90%0A%3C&_f:3%3B&=%E2%86%93&_f:3%3B&=%E2%86%92%0A%3E)



126 changes: 125 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,127 @@
# Pico Keyboard
# Pico Keyboard Rev.1

Pico Keyboard is designed for small hands.
It adopted the footprint for [Kailh Mid-Height](http://www.kailh.com/en/Products/Ks/KHS/) smaller than Cherry MX compatible switches.

**Japanese Manual is [here](README.ja.md).**

<p align="center">
<img src="img/pico-keyboard.jpg" alt="Pico Keyboard image" width="400"/>
</p>

## Summary

- [Bill of materials](#bill-of-materials)
- [Assembly guide](#assembly-guide)
- [Firmware](#firmware)
- [Basic compiling and burning command](#basic-compiling-and-burning-command)
- [First time burning](#first-time-burning)

## Bill of materials

| Qty | Item | Notes |
|----:|-----------------------------------------------|-----------------------------------------------------|
| 2 | Pico PCBs | |
| 65 | 1N4148 diodes | SMD diodes can also be used |
| 2 | PJ-320A 4 poles 3.5 mm TRRS connectors | |
| 2 | 4.7 kΩ resistors | Need to be soldered on one half only |
| 2 | Through hole momentary switch | Dimensions 6mm x 6mm x 4.3mm |
| 2 | Arduino Pro Micro | ATMega32U4 |
| 1 | TRRS cable | |
| 1 | USB micro cable | |
| 2 | Cases | |
| 8 | Screws | M3 |
| 8 | Spacers | M3 |
| 8 | Nuts | M3 |
| 65 | [Kailh Mid-Height](http://www.kailh.com/en/Products/Ks/KHS/) | Brown, Red or Blue. |
| 65 | [Kailh Mid-Height](http://www.kailh.com/en/Products/Ks/KHS/) compatible keycaps | 65x 1u keycaps |


## Assembly guide

<p align="center">
<img src="img/pico-parts.jpg" alt="pico parts" width="600"/>
</p>

### Installation steps:

- Solder components on `Mounting Surface` side:
1. Solder 1N4148 diodes. Keep the diode legs for the right hand controller installation.<br/><div><img src="img/pico-diode.jpg" alt="pico diode" width="250"/></div>
2. Solder PJ-320A connectors.
3. Solder momentary switches.
4. Solder 4.7 kΩ resistors **on one half only**.
5. Solder the Pro Micro header pins (**do not solder the Pro Micro controllers yet**).
- Install upper cases to PCBs.
* M3x8 screws → upper case → M3 nuts → PCB → spacers.<br/><div><img src="img/pico-case.jpg" alt="pico case" width="250"/></div>
- Fit switches to the upper cases and solder to the PCB.
- Solder Pro Micros to the header pins.
* Solder Pro Micro face down.<br/><div>
<img src="img/pico-promicro.jpg" alt="pico ProMicro" width="250"/></div>


## Firmware

<p align="center">
<img src="img/qmk-badge-dark.png" alt="qmk" width="200"/>
</p>

Pico keyboard uses [QMK Firmware](https://github.com/qmk/qmk_firmware) for its firmware.
Follow the QMK installation instructions [here](https://docs.qmk.fm/#/newbs_getting_started), then compile and burn the firmware as follows:

### Basic compiling and burning command

```sh
$ cd path/to/qmk_firmware
$ make pico/rev1:default:flash
```

### First time burning

You need to burn the firmware both left hand and right hand.


#### 1. Left hand side

Edit [pico/config.h](https://github.com/qmk/qmk_firmware/blob/master/keyboards/pico/config.h) and activate `MASTER_LEFT` .

```cpp
/* Select hand configuration */
#define MASTER_LEFT
// #define MASTER_RIGHT
// #define EE_HANDS
```

Save the file, then connect Pro Micro(**left hand**) and your PC by USB cable.
Compile and burn the firmware by running [Basic compiling and burning command](#basic-compiling-and-burning-command) as follows:

```sh
$ cd path/to/qmk_firmware
$ make pico/rev1:default:flash
```

#### 2. Right hand side

Edit [pico/config.h](https://github.com/qmk/qmk_firmware/blob/master/keyboards/pico/config.h) and activate `MASTER_RIGHT` .

```cpp
/* Select hand configuration */
// #define MASTER_LEFT
#define MASTER_RIGHT
// #define EE_HANDS
```

Save the file, then connect Pro Micro(**right hand**) and your PC by USB cable.
Compile and burn the firmware by running [Basic compiling and burning command](#basic-compiling-and-burning-command).

#### 3. Confirmation

Pull out the USB cable, then connect left hand and right hand by TRRS cable.
Plug in the Pro Micro (Master) the USB cable.

## Layout

<p align="center">
<img src="img/pico-layout.png" alt="pico rev1.0 layout"/>
</p>

[KLE Layout permalink](http://www.keyboard-layout-editor.com/##@_name=pico-keyboard&author=x1%3Cviva008%[email protected]%3E%3B&@=~%0A%0A%60&_f2:2%3B&=1%0AF1%0A!&=2%0AF2%0A%2F@&=3%0AF3%0A%23&=4%0AF4%0A$&=5%0AF5%0A%25&_x:3%3B&=6%0AF6%0A%5E&=7%0AF7%0A%2F&&=8%0AF8%0A*&=9%0AF9%0A(&=0%0AF10%0A)&=-%0AF11%0A%2F_&=%E2%86%90%0AF12%0Aback%3B&@_x:0.25%3B&=Tab&=Q&=W&=E&=R&=T&_x:3&f:3%3B&=Y%0A(&_f:3%3B&=U%0A)&_f:3%3B&=I%0A%7C&_f:3%3B&=O%0A*&_f:3%3B&=P%0A~&_f:3%3B&=%5B%0A%C2%A5%0A%7B&_f:3%3B&=%5D%0A%5C%0A%7D%3B&@_x:0.5%3B&=Ctrl&=A&=S&=D&=F&=G&_x:3&f:3%3B&=H%0A%5B&_f:3%3B&=J%0A%5D&_f:3%3B&=K%0A.&_f:3%3B&=L%0A%2F%2F&_f:3%3B&=%2F%3B%0A%60%0A%2F:&_f:3%3B&='%0A-%0A%22&=Enter%3B&@_x:0.75%3B&=Shift&=Z&=X&=C&=V&=B&_x:3&f:3%3B&=N%0A%7B&_f:3%3B&=M%0A%7D&_f:3%3B&=,%0A%0A%3C&_f:3%3B&=.%0A%0A%3E&_f:3%3B&=%2F%2F%0A%0A%3F&_f:3%3B&=%E2%86%91%0A%5E&=Shift%3B&@_x:1&f:3%3B&=Alt%0A%0A%0AEsc&=Enter&=Del&=GUI&_fa@:2&:2%3B%3B&=LANG2%0Alayer&_f:3%3B&=Space&_x:3&f:3%3B&=Space&=LANG1%0Alayer&_f:3%3B&=GUI&_f:3%3B&=Del&_f:3%3B&=%E2%86%90%0A%3C&_f:3%3B&=%E2%86%93%0A%2F_&_f:3%3B&=%E2%86%92%0A%3E)
Binary file added img/pico-jis-like-layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/pico-keyboard.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/pico-layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/qmk-badge-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9749fc0

Please sign in to comment.