From f6636cf581d0a2269826d3f6628c3146b0b50b1c Mon Sep 17 00:00:00 2001 From: Naoki Katahira Date: Mon, 6 May 2019 16:06:14 +0900 Subject: [PATCH] update buildguide --- Pro/Doc/buildguide_jp.md | 68 ++++++++++++++++++++++++++++------------ 1 file changed, 48 insertions(+), 20 deletions(-) diff --git a/Pro/Doc/buildguide_jp.md b/Pro/Doc/buildguide_jp.md index 544a88e..6b1a286 100644 --- a/Pro/Doc/buildguide_jp.md +++ b/Pro/Doc/buildguide_jp.md @@ -3,22 +3,22 @@ ## 必要部品 -| パーツ名 | 個数 | 備考 | -|--------|-------|-------| +| パーツ名 | 個数 | 備考 | 写真 | +|--------|-------|-------|-------| |Lily58 PCB | 2枚 || |Lily58 ケース|1セット4枚|| -|[ProMicro](https://yushakobo.jp/shop/promicro-spring-pinheader/)|2個|はんだ付けの回数が減り、破損しやすいコネクタのためProMicroの交換が可能になる別売の[スプリングピンヘッダ(コンスルー)](https://yushakobo.jp/shop/a01mc-00/)の使用を推奨(遊舎工房での販売品にはコンスルーが付属しています)| -|キースイッチ(CherryMX,kailh choc)|58個|MXスイッチとchocスイッチはどちらかの排他利用| -|[スイッチソケット](https://yushakobo.jp/shop/)|58個|キースイッチの取り付けに必要| -|キーキャップ|58個|1.5Uの部分は1Uでも可| -|ダイオード 1N4148W|58個|| -|タクトスイッチ|2個|| -|TRRSジャック|2個|| -|M2 スペーサー |10個,4個|Choc:4mm,MX:7mm| -|M2 ネジ|28個|| -|TRRSケーブル|1本|AUXケーブルとも呼ばれている3.5mmオーディオ用のケーブル(4極ケーブルを推奨)| -|MicroUSBケーブル|1本|Pro Micro側のコネクタの耐久性が低いためマグネット式を推奨| -|OLEDモジュール(オプション)|2個|| +|[ProMicro](https://yushakobo.jp/shop/promicro-spring-pinheader/)|2個|はんだ付けの回数が減り、破損しやすいコネクタのためProMicroの交換が可能になる別売の[スプリングピンヘッダ(コンスルー)](https://yushakobo.jp/shop/a01mc-00/)の使用を推奨(遊舎工房での販売品にはコンスルーが付属しています)|| +|キースイッチ(CherryMX,kailh choc)|58個|MXスイッチとchocスイッチはどちらかの排他利用|| +|[スイッチソケット](https://yushakobo.jp/shop/)|58個|キースイッチの取り付けに必要|| +|キーキャップ|58個|1.5Uの部分は1Uでも可|| +|ダイオード 1N4148W|58個||| +|タクトスイッチ|2個||| +|TRRSジャック|2個||| +|M2 スペーサー |10個,4個|Choc:4mm,MX:7mm|| +|M2 ネジ|28個||| +|TRRSケーブル|1本|AUXケーブルとも呼ばれている3.5mmオーディオ用のケーブル(4極ケーブルを推奨)|| +|MicroUSBケーブル|1本|Pro Micro側のコネクタの耐久性が低いためマグネット式を推奨|| +|OLEDモジュール|2個||| ## はじめに Pro版はカラーバリエーションがあり、このビルドガイドの写真ではBlack版での実装をしていますがWhite版でも実装方法は全く変わらないため色を置き換えて進めてください。カラーや発売時期によって多少写真とは違うバーツが使われていることがございますが動作には差はありません。 @@ -59,6 +59,7 @@ PCBのダイオードの片方のパッドに予備はんだ(基板にはんだ ダイオードと同じようにソケットのパッドの片方に予備はんだをし、ソケットを載せ、ピンセットや手で抑えながらはんだ付けをします。(手で抑える場合は火傷にご注意ください。) 写真はMXソケットのためChocソケットは下側に取り付けをしてください。 +![socket](https://user-images.githubusercontent.com/6285554/57197682-3de1b580-6fa5-11e9-90b1-fca894e1e7d2.png) 力がかかる部品のため、両方をしっかりとはんだ付けをし、浮きがないか確認をします。 ![2019-01-26 14 38 04](https://user-images.githubusercontent.com/6285554/51967230-2250a580-24b2-11e9-94ce-591746c49f50.jpg) @@ -71,15 +72,17 @@ PCBのダイオードの片方のパッドに予備はんだ(基板にはんだ ![2019-01-26 14 43 23](https://user-images.githubusercontent.com/6285554/51967628-2cbf6f00-24b3-11e9-96e6-8f003c53d57b.jpg) -## OLEDを取り付ける(オプション) -(OLEDを取り付ける方のみ行ってください) +## OLEDを取り付ける 表面のProMicro部にある4つのジャンパ端子をはんだ付けし、ジャンパします。 OLED用のコネクタを取り付けします。コネクタ内部にはんだが流れ込みやすいため、多くのはんだを流し込まないようにしてください。 ![unadjustednonraw_thumb_2db2](https://user-images.githubusercontent.com/6285554/53293031-d45c6280-380f-11e9-8f1c-1c167b27cfd3.jpg) +OLEDピンをソケットに差し込み、その上にOLEDモジュールを載せ、4箇所はんだ付けをします。 + ## Pro Microを取り付ける - +ProMicroの袋に同封しているピンヘッダは使用しません。遊舎工房にて購入されたキットの場合スプリングピンヘッダが同梱されているのでそちらを使用します。 +![IMG_2662](https://user-images.githubusercontent.com/6285554/57210525-f5171480-7017-11e9-9d92-3a345d53db94.jpg) スプリングピンヘッダ(コンスルー)で取り付ける際はHelixのビルドガイドに記載されている方法に従ってはんだ付けをしてからLily58のPCBに取り付けを行ってください。[Helixビルドガイド](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_jp.md#pro-micro) **PCBの線で囲まれている列を確認して**PCBに差し込みます。左右で差し込む場所が異なるため注意してください。 @@ -92,6 +95,8 @@ OLED用のコネクタを取り付けします。コネクタ内部にはんだ ネジを基板の裏側から差込み、スペーサーを上から取り付けると取り付けやすいです。 ![2019-01-26 15 02 38](https://user-images.githubusercontent.com/6285554/51967859-c0913b00-24b3-11e9-966c-f3621ed398e5.jpg) +最初につけた裏表識別用のマスキングテープはここで剥がしまします。 + ## キースイッチを取り付ける 位置合わせのためトッププレートスペーサーを取り付けします。(MX:7mm Choc:4mm) ![2019-01-26 14 56 05](https://user-images.githubusercontent.com/6285554/51967395-912dfe80-24b2-11e9-9cc7-b4520063f36c.jpg) @@ -117,10 +122,10 @@ ProMicro上部用のアクリルの保護紙を剥がし、取り付けます。 ![2019-01-26 15 21 15](https://user-images.githubusercontent.com/6285554/51967842-b8d19680-24b3-11e9-8402-85180ce10403.jpg) ## キーマップの書き込み -キーマップを書き込むために準備が必要です。導入されていることを前提に記述しております。[qmk公式のページなどを参考に導入して下さい。](https://docs.qmk.fm/#/getting_started_build_tools) +キーマップを書き込むために準備が必要です。導入されていることを前提に記述しております。[qmk公式のページなどを参考に導入して下さい。](https://docs.qmk.fm/#/getting_started_build_tools) (WIndows:MSYS2 Mac,Linux系:avrdude) -QMK Toolboxを使用すれば環境構築の必要が無く、GUIで書き込みが行うことができます。(キーマップの変更はできません) -[qmk/qmk_toolbox](https://github.com/qmk/qmk_toolbox/releases) +QMK Toolboxを使用すれば環境構築の必要が無く、GUIで書き込みが行うことができます。(カスタマイズする場合は上記の書き込み環境を構築することを推奨します) +[qmk/qmk_toolbox](https://github.com/qmk/qmk_toolbox/releases) Lily58のデフォルトキーマップを書き込むにはqmk_firmwareのフォルダ階層で以下を実行します @@ -159,5 +164,28 @@ A.キースイッチの差し込み、ソケット又はダイオードのはん 問題のダイオードの向きを確認してください。間違っていた場合は外してはんだ付けし直してください。 はんだ付けが足りない場合は再度はんだ付けを行ってください。 +### Q."@"や"["などで入力した記号と違う記号が入力される(Windows等) +OS上でキーボードの認識がJISキーボードとして認識されているためLily58(USキーボード扱い)で入力した際に別の記号が入力されてしまいます。 +OSのキーボード設定でLily58をUSキーボードとして設定してください。切り替え後、日本語入力への切り替えがUSキーボード用の切り替えキーになり、JISキーボードとは異なりますのでご注意ください(キーマップなどでカスタマイズ可能)。 + + **困った場合などはお気軽にDiscordサーバー([Self-Made Keyboards in Japan](https://discordapp.com/invite/NM7XtDW))の「#Lily58」チャンネルもしくはTwitter:@F_YUUCHIにメッセージをお送りください** +## キーマップ変更をする +自作キーボードは上記で使用したqmk firmwareを使用して動作をしています。 +qmk firmwareはカスタマイズ性が非常に高く、キーマップを編集するだけでも非常に高機能にカスタマイズすることができます。 +### keymap.cを編集してカスタマイズする +キーマップをカスタマイズする場合はqmk_firmware/keyboards/lily58/keymaps/defaultのフォルダを任意の名前でコピーします。 +内部にあるkeymap.cを適宜変更をします。 +キーコードは以下の[qmkの公式ドキュメント](https://docs.qmk.fm/#/keycodes)等を参考にしてください。 + +キーマップ変更後は + + sudo make lily58:(任意のフォルダ名):avrdude + +で書き込みを行います。エラーが出る場合は確認をしてください。 + +### QMK Configuratorを使用してカスタマイズする方法(非推奨) +[QMK Configurator](https://config.qmk.fm/#/lily58/rev1/LAYOUT)を使用するとkeymap.cファイルを編集せずにブラウザ上でオリジナルのキーマップを作成可能です。 +作成後ダウンロードしたjsonファイルをQMK Toolboxに読み込み、書き込みを行います。 +