https://github.com/mackee/unkokeyboard
技術書典7で頒布した、かっこいいうんこキーボードのリポジトリです。
https://github.com/mackee/unkokeyboard
Last synced: about 1 year ago
JSON representation
技術書典7で頒布した、かっこいいうんこキーボードのリポジトリです。
- Host: GitHub
- URL: https://github.com/mackee/unkokeyboard
- Owner: mackee
- Created: 2019-09-21T15:14:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-29T13:53:08.000Z (over 6 years ago)
- Last Synced: 2025-03-29T13:09:59.905Z (about 1 year ago)
- Language: C++
- Size: 263 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cool Poop Keyboard
The Cool Poop Keyboard is a too-small keyboard.

This keyboard has only 4 keys and 4 full-color LEDs.
It uses an ATTiny84 with [micronucleus](https://github.com/micronucleus/mirconucleus) firmware.
This product made for distributing at [The Techbook fest 7th](https://techbookfest.org/event/tbf07).
Following japanese text is a build guide for customer.
# かっこいいうんこキーボード
この文章は技術書典7などで頒布した「かっこいいうんこキーボード」の取扱説明書です。
## この文章で知れること
- 「かっこいいうんこキーボード」の組み立て方
- 「かっこいいうんこキーボード」のファームウェアのカスタマイズ方法
## 組み立て方
### 部品

|名前|数|備考|
|:---|:---|---|
|PCB|1枚||
|プレート|1枚||
|キースイッチ|4個|赤 or 白 or 茶が4個入っています|
|キーキャップ|4個||
|スペーサー|4個||
### 組み立て
1. PCBにスペーサーを取り付ける。

2. プレートを取り付けて、裏返す。

3. キースイッチを付ける。

4. キーキャップを付けて完成。

## ファームウェアのカスタマイズ方法
### 必要なもの
- [PlatformIO](https://platformio.org/)
- Windowsの場合は[Digisparkのドライバー](https://github.com/digistump/DigistumpArduino/releases/download/1.6.7/Digistump.Drivers.zip)のインストールが必要です
- また、`make`および`patch`が使える環境が必要です
### ファームウェアの書き込み手順
#### 1. このリポジトリのダウンロード
`git clone`やzipファイルのdownload linkからこのリポジトリのソースコードをダウンロードします。
#### 2. 書き込み環境のセットアップ
`make`コマンドを実行できるCLI環境で1でダウンロードし、展開したディレクトリに移動します。そして、そのディレクトリで以下のコマンドを実行します。
```console
$ make init
```
途中にコンパイルエラーが出ますが、その後にコンパイルエラーを解消するためのパッチが自動で適用されます。
#### 3. ファームウェアの書き込み
以下のコマンドで、「かっこいいうんこキーボード」へのファームウェアの書き込みが実行されます。
```console
$ make upload
```
`> Please plug in the device ...` というメッセージが表示された、「かっこいいうんこキーボード」をUSBケーブルで接続してください。もし、接続したまま実行した場合は、一度抜いてからもう一度挿してください。
`>> Micronucleus done. Thank you!` というメッセージが表示されたら成功です。
### キーのカスタマイズ
キー配置の情報は、`src/Keyboard.ino`に記述されています。
それぞれのキーを`A`, `B`, `C`, `D`に変更する場合は、
```diff
--- a/src/Keyboard.ino
+++ b/src/Keyboard.ino
@@ -8,7 +8,7 @@ WS2812 LED(NEOPIXELS_NUM);
cRGB value;
uint8_t keys[] = {9, 8, 7, 3};
-byte keymaps[] = {KEY_U, KEY_N, KEY_K, KEY_O};
+byte keymaps[] = {KEY_A, KEY_B, KEY_C, KEY_D};
void setup() {
LED.setOutput(NEOPIXEL_PIN);
```
というように変更し、保存した後に`make upload`を実行して書き込みます。