Skip to content

Latest commit

 

History

History
601 lines (383 loc) · 33.2 KB

buildguide_jp.md

File metadata and controls

601 lines (383 loc) · 33.2 KB

Build Guide for Keyball46

こちらは Keyball46 のビルドガイドになります。

01

【目次】

1.部品確認

キットが届きましたらキット同梱品がすべて入っていたかご確認ください。

1-1.キット同梱品

名前 備考
PCB(左右) 1組
トップPCBプレート(左右) 1組
ボトムアクリルプレート(左右) 1組
ProMicro保護プレート(左右) 1組
トラックボール保持ケース白(上下) 1組
Φ2 セラミックボール 1個 (予備用)
トラックボール読取り基板 1枚
L字コンスルーピン(7ピン) 1個
トラックボール読取りIC 1個
読取りIC用レンズ 1個
平頭ネジ M1.7 2本
小頭ネジ M1.7 2本
TRRSジャック 2個
タクトスイッチ 2個
ダイオード(チップタイプ) 52個+ リードタイプにも対応(オプション)
Kailh PCBソケット 50個
OLEDモジュール 2枚
4連ピンヘッダ 2つ
4連ピンソケット 2つ
スペーサー M2 7mm 15本 Keyball46 Cherry MX版のみ
スペーサー M2 4mm 15本 Keyball46 chocロープロファイル版のみ
スペーサー M2 9mm 5本
ネジ M2 3.5mm 38本+
クッションゴム 8個

02

1-2.組立前にお客様自身で準備いただく部品

名前 備考
ProMicro 2個 安価なものやUSB Type-C対応のもの等選べます
キースイッチ 46個 CherryMX互換のもの
直径34mmトラックボール 1個 動作確認で使用します
TRS(3極)ケーブル 1本 TRRS(4極)ケーブルでも可
Micro USBケーブル 1本 ご購入いただいたProMicroに対応するもの
スペーサー M2 長さ4mm(オプション) 4本 親指キーのみをロープロファイルにする場合にご準備ください(Keyball46ロープロファイルキットをご購入の場合はキットに含まれます)

03

1-3.組立後でも取り付けられる部品とオプション

名前 備考
キーキャップ 46個 1u 45個、1.25u 1個
YS-SK6812MINI-E 14個 アンダーグロー用 ※SK6812MINIは使用できません

04

2.準備

2-1.必要な工具

Keyball46の組み立てには下記の工具が必要です。

名前
はんだごて(LEDを実装する場合は温度調整可能なもの)
はんだ(LEDを実装する場合は低融点のものが有効)
ニッパー
0番+精密ドライバー
ピンセット

05

2-2.ファームウェア

Keyball46を動作させるには、ご購入いただいたProMicroへのファームウェアの書き込みが必要です。 すでにビルド済みのファームウェアがダウンロードできますので、ProMicroへの書き込みソフト『QMK Toolbox』だけ準備できればKeyball46を使用できます。QMK Toolboxについては Corneのファームウェア の記事に簡潔にまとめられていますのでリンク先前半の説明を読んでQMK Toolboxを準備しておいてください。

書き込みについてはこの後の3-6章でテスト用のファームウェアの書き込み、10章で製品版ファームウェアの書き込みについて詳しく説明しています。

3.実装

ここからはんだ付け作業に入ります。
PCBはリバーシブルになっているので、最初にどちらを左手用/右手用にするか決めます。

赤丸で示した、PCBが欠けている部分にトラックボールがつきます。
右手親指でトラックボールを操作するなら下写真のような配置になります。

20

左手でトラックボールを操作する場合は下写真のような配置です。

21

本ビルドガイドでは右手にトラックボールをつける仕様で説明します。
下記のようにPCBを置き、ミス防止のため表面にマスキングテープを貼ります。

22

3-1.はんだ付けの前に

半田ごての”こて先”は竹槍の先端のような形状のものだと平面にはんだを乗せたり、余分なはんだを”すくい取る”事が出来るので使いやすいです。

27

3-2.ダイオードの取り付け

それではダイオードを順にはんだ付けしていきます。
ダイオードはすべて【裏面】にはんだ付けします。

ダイオードのシルクマークは下写真の矢印のようなマークで、左右合計で48個あります。
ダイオードには極性がありますので、正しい向きで取り付けてください。向きは部品上の直線とシルクマークの矢印の先についている直線が一致する方向です。

下写真をよく見て向きを確認してください。
同一基板上のダイオードの向きは90度回転して配置されているダイオードを除き、すべて同じ向きで配置されています。半田付けを進める中で回りのダイオードと同じ向きになっているか確認しながら行ってください。

25

キットには含まれませんが、リードタイプのダイオードも取付けられるように設計されています。(ただしロープロファイル(choc)仕様で組み立てる場合、トッププレートと干渉するためリードタイプは使用できません)

表面実装タイプのダイオードは、慣れてくると早く作業ができますが、ピンセットで挟んだ状態で基板上に静止させる必要があり、確かに難易度が高いです。どちらでもお好みのタイプをご使用ください。

リードタイプを使用する場合、極性は下記のように部品に記された帯マークとシルクマークの直線が同じ向きを向くように付けます。

26

それでは半田付け開始です。まず、ダイオード用パッドの片側にはんだを盛ります。

28

ピンセットでダイオードを掴み、事前に盛ったはんだを溶かしながらダイオードを固定します。

30

基板を180度回転させてダイオードの反対側の足へもはんだを流します。 最後に両方の足をこて先で触り、ダイオードが脱落しなければ両足とも半田付けされています。

31

リードタイプのダイオードを使用する場合には、シルクの一つ外側のスルーホールに足を通します。

32

リードタイプのはんだ付けは表面から行います。

33

はんだ付けしたら余計な足をカットします。
表面にはんだの盛り上がりが残るため、ロープロファイル(choc)仕様で組み立てる場合にはリードタイプは使用できません。
また親指キーのみロープロファイルにする場合には、親指キーだけは表面実装タイプをはんだ付けしてください。

34

右手基板には24個のダイオードを取り付けます。

37

左手基板へも同様に作業します。こちらも24個取り付けます。
私もよく取付忘れや片側だけはんだ付けされていなかったということがありますので、数を数えてご確認ください。

38

3-3.ジャンパのはんだ付け

OLEDモジュールとトラックボールセンサを動作させるためにジャンパをショートさせる必要があります。 j ジャンパ 【裏面のみ】 に行います。
"Back Side Only"の表示があり、右手基板には計【8個】あります。
パッドをこて先で温めてはんだを溶かすとブリッジできます。

40

はんだの鮮度が落ちると表面張力が落ちてうまくブリッジできません。
一度はんだを払ってしまい、はんだやフラックスを足してやり直してください。

41

左手基板もジャンパするのは【裏面のみ】です。
【4個】ジャンパします。
左手基板にはこの4個以外にもジャンパパッドがありますが、これらは現状使用しませんのではんだ付けの必要はありません。

42

3-4.4連ピンソケット・TRRSソケット・タクトスイッチ

下記写真の部品をのはんだ付けします。
すべて【表面】に取付けます。

51

部品が浮いてしまうのが心配であれば、マスキングテープで固定してはんだ付けします。

52

53

3-5.ProMicroのはんだ付け

ProMicroは下記写真のコンスルーピンを使用してはんだ付けすることで、交換が可能になります(ProMicroに同梱されている12Pピンヘッダは使用しません)。コンスルーピンには取付け方向がありますので写真をよく見て作業してください。

60

まずコンスルーピンを右手基板に差し込みます。

61

差し込んだコンスルーピンにProMicroを挿入します。
この状態でProMicro側のみはんだ付けします。

63

基板に差し込んだ状態ではんだ付けすることで、コンスルーピンが斜めに取り付けられてしまうことを防げます。

64

左手基板も同様にはんだ付けします。

65

左右両方の基板に標準でOLEDが搭載できます(OLEDモジュールの袋に同梱されている4Pピンヘッダは使用しませんので破棄してください)。
4連ピンソケットに4連ピンヘッダを挿入してOLEDモジュールを載せます。

70

4ピンのうちのひとつだけをはんだ付けします。
そのはんだを溶かしながらOLEDモジュールを上から押して浮かないようにします。またProMicroと並行になるように調整すると見栄えが良くなります。

71

位置が決まったら残り3ピンをはんだ付けします。左右共同様に半田付けします。

72

3-6.ProMicroの書き込みと動作確認

それではまずテスト用のファームウェアをProMicroに書き込みましょう。

テスト用ファームウェアは動作確認しやすいようにキーマップが簡潔なのと、RGB LEDが赤→緑→青と順に点灯するため、はんだ不良を発見しやすいです。 今回はLEDはんだ付けを見送っている場合など、テスト用ファームウェアが必要無いと思われる方は10章の正規のファームウェアをここで書き込んでも構いません。

Keyball46のファームウェアは、トラックボールを右手と左手のどちらに載せたかで種類が分かれます。下記の適切な方のリンクからhexファイルもしくはzipファイルをダウンロードして、QMK Toolboxを使用して書き込んでください。QMK Toolboxについては Corneのファームウェア の記事を参照してください。

※必ず左右両方のPro Microに同じhexファイルを書き込んでください。

  • トラックボールを右手側につけた方はこちらのkeyball_keyball46_test.hexを書き込みます
  • トラックボールを左手側につけた方はこちらのkeyball_keyball46_test_Left.hexを書き込みます
  • Keyball46関連の全hexファイルを一括でダウンロードするためには、こちらをダウンロード後に解凍し、該当するhexファイルをご使用ください

Pro Microへの書き込みが完了したら下写真のようにキースイッチのパッドをピンセットでショートして動作確認します。
早い段階で動作確認をすることで問題の切り分けが楽になります。

75

テキストエディタに文字が入力されることを確認します。
※この段階では、"N"キーもしくは"B"キーが反応しないことがあります。これはトラックボールセンサーの有無で左右判定していることが原因ですので、Keyball46が完成すれば直ります。"N"キーや"B"キーが反応しないことは気にせずに次の工程に進んでください。
Keyball46が完成したら、USBケーブルはトラックボールを取り付けた側に接続して使用します。そうしないとトラックボールが機能しません。 最新のファームウェアでは左右どちらにUSBケーブルを接続してもトラックボールが機能します!

76

3-7.アンダーグロー用LED(オプション)のはんだ付け

LED(YS-SK6812MINI-E)はオプションになります。左右で計14個取り付け可能です。
ただしLEDは非常に熱に弱く、こて先温度を220度~280度に調整して行ってください。
こて先温度が低いためパッドに熱が伝わらずテンプラしやすいです。
LED無しでもキーボードは使用できますし、難易度が高いのでまずはLEDなしで完成させることをおすすめします。後からでもLEDを追加できます。

YS-SK6812MINI-Eの4ピンのうち切り欠きがある足と、マーキングされているパッドを合わせます。

80

下写真のような状態ではんだ付けします。
一度に4ピンすべてのはんだ付けをすると部品の温度が上がり壊れやすいので、2ピンづつくらいで時間をあけてはんだ付けしてください。

81

はんだ付けが完了したら点灯を確認します。
LEDは直列に配線されているので、途中までしか点灯しない場合はそのLEDとその両隣のLEDのはんだ付けや、LEDを交換して修正してください。
7つすべて点灯すると下写真のようになります。

また、青丸部のようにはんだカスが基板や別のパッドについた場合、こて先の温度が低いと除去しにくいので、気にせず作業を進め、こて先温度を上げた後で撫でれば簡単に除去できます。

82

3-8.キーソケットのはんだ付け

キーソケットをシルクマークと形状が合うようにセットしてはんだ付けします。
シルクからはみ出すようであれば方向が違います。

85

青丸で示すように事前にソケットようパッドにはんだを盛っておきます。

86

ソケットをはめて上からピンセットで抑えて端子の横からはんだを少し載せたこて先を当てると、はんだが溶けてソケットが沈み込みます。
経験上、この方法が一番テンプラ(接続不良)しにくいです。

基板を180度回転させて反対側の端子も同様にはんだ付けします。

87

すべてのキー、もしくは親指キーのみをロープロファイル仕様(kailh choc)にて組み立てる場合、ロープロファイルパターン側にchoc用ソケットを半田付けして下さい。このロープロソケットにも向きがあります。 下記写真にて方向を確認してください。黒い樹脂部分が八角形に近くなっている端子がスイッチの真ん中付近にくる方向が正解です。ロープロファイルソケット(kailh choc)を使用する場合は下写真のようになります。

88

左右合わせて46個のソケットをはんだ付けして完了です。

89

4.ボール読み取り基板の組み立て

下写真の基板(以下、ボール基板)とセンサーを準備します。 ※センサーや基板の品質確認のため、はんだ付け済の基板が届く場合があります。その時にはこの工程は飛ばして、5-2章のL字コンスルーはんだ付けに進んでください。

90

4-1.センサーのはんだ付け

センサーICはボール基板の部品が実装されていない裏面から差し込みます。
ICの1ピンを示すくぼみと基板のパッドマークを合わせます。

91

ICを裏から見るとこのような方向です。部品が実装されている表面から全ピンをはんだ付けしてください。

92

ピンセットを使って保護シール【2枚】をはがします。

93

次にセンサーレンズを取り付けます。レンズには方向があります。方向が違うとレンズの細いピン2本が折れてしまう恐れがあるため方向をしっかりとご確認ください。
レンズ手前に下写真矢印のような突起があり、これが上側にくるように取り付けます。

95

レンズとICの方向が合えば、レンズのピン2本がICに無理なく差し込めるはずです。ゆっくりと差し込んでください。

94

4-2.L字コンスルーのはんだ付け

次にL字コンスルーピンを右手基板【表面】に取付けます。
L字コンスルーにも方向があり、下写真と同じように取り付けてください。
ピンがU字型になっていない方をはんだ付けします。

96

部品が浮かないようにマスキングテープを貼ってはんだ付けしてください。

97

5.左手側の左右判定ジャンパーをはんだ付け

Keyball46の標準ファームウェアには左右自動判定機能がついています。判定のために【左手側の基板だけ】に1個所ジャンパーをはんだ付けします。

左手側基板を裏から見ると下写真赤丸部に[SW]というシルクがあります。これをお手持ちのリード線端材か銅線、使用せずに余ったピンヘッダのピンを一本ペンチで引き抜いたものなどでジャンパーしてください。

140

左利き用で組み立てている場合も【左手側の基板だけ】にジャンパーします。左手仕様の場合は下写真赤丸部に[SW]があります。(基板の生産ロットにより少し[SW]の位置や傾きが違う場合があります)

141

ロープロファイル(kailh choc)仕様で組み立てる場合、基板の表面にはんだがはみ出すとトッププレートと干渉してしまいます。
リード線でジャンパーする場合、下写真のようにあらかじめ足を短く切っておきます。 142

それを下写真のようにスルーホールにはめて裏面からはんだ付けすれば表面にはんだが飛び出しにくくなります。飛び出ている場合には表面からはんだをすくい取ってください。 143

以上ではんだ付け作業は完了です。

余談ですがはんだごての電気を落とす前に、こて先にたっっぷりとはんだを付けておきましょう。次回使用するときにこのはんだを落とせば、ピカピカのこて先で作業を再開できますよ!

100

6.トッププレートのカット(オプション)

Keyball46は親指キーのみロープロファイルにすることが可能です。
そのためにはミシン目をカットします。
高さを変える必要がない場合は切り取る必要はありません。

切り取るには大き目のニッパでミシン目に傷をつけます。

101

カッターで少しづつ切り込みを増やしていくと切り離すことができます。

102

左右両方とも切り離すことができました。

103

150番くらいのやすりでバリを取ります。

104

7.組み立て

7-1.保護プレートの取り付け

ミドル基板にProMicro保護プレートを取り付けます。 まず9mmスペーサをねじ止めします。

110

アクリル保護プレートをねじ止めします。右手はスペーサ3つ、左手はスペーサ2つで固定します。

111

7-2.トッププレートの組み立て

トッププレートの【裏面】に7mmスペーサ(ロープロファイル仕様なら4mmスペーサ)をねじ止めします。

112

トッププレートの四隅にキースイッチをはめ込みます。こうするとプレート同士の位置決め精度が上がります。

113

トッププレートとミドルプレートのねじ穴を合わせ、キースイッチの端子がしっかりキーソケットに入ることを確認しながらプレート同士を重ねます。

114

7-3.ボトムプレートの組み立て

裏面からアクリルボトムプレートを重ねてねじ止めします。ねじは左右とも7本です。

115

8.トラックボール取り付け

8-1.ボール読み取り基板差し込み

組み立てたトラックボール読み取り基板を7ピンコンスルーへ差し込みます。わかりやすいように斜めにしていますが、基板は垂直にして差し込みます。

120

ボール基板が垂直に立ちました。

121

8-2.トラックボールケースの組み立て

トラックボールケースには事前にセラミックボール3個が固定されています。万が一セラミックボールが脱落している場合にはお手数ですが予備のセラミックボールを適当なボンドで固定してください。
セラミックボールの予備は今後ボールを紛失した時のために保管しておいてください。

122

ケース下の穴へ、ケース上のピン2本が挿入できます。
上下からゆっくり力を入れて結合します。(ぴったりと結合しなくてもこの後のねじ絞めでくっつきますので大丈夫です。)

123

M1.7のトルクスねじをつけます。キットにはねじ頭が【小さいねじ】と【平らなねじ】が同梱されていますが、そのうちの【頭の小さいねじ】を使用します。

124

ケース裏から見て、この2個所をねじ止めします。締め付けすぎにご注意ください。

125

8-3.トラックボールケース装着

完成したケースを本体に取付けます。ケース裏側のセンサー収納部にボール基板が入ります。
矢印で示すボール基板がケース中央くらいにくるようにしながら、上からゆっくりとはめます。引っ掛かりがある場合、無理に押し込まず、一度引き抜いて再度入れ直してください。

126

それほど力を入れなくても最後まで入るはずです。

127

本体裏から確認するとメイン基板とボール基板の間に、矢印で示すような隙間が出来ている場合があります。

128

その時は、軽~くケース手前(指マークの方向)から押します。力を入れすぎるとL字コンスルーが破損する可能性があるので、軽く押してください。
下写真のように隙間がなくなれば、青丸部のねじ穴が合うと思います。

129

キットに同梱のM1.7トルクスねじの【頭が平らなねじ】2本を本体裏から絞めます。この時ボール保持ケースが回転しないように指で抑えながらねじを絞めてください。

130

9.総仕上げ

完成間近です!お好みのキースイッチをはめ込んでいきます。

131

最後に34mmトラックボールをケースに押し込んで完成です!
お疲れ様でした。

132

10.正規ファームウェアの書き込み

それでは最後に正規のファームウェアをProMicroに書き込みましょう。Keyball46はRemapに対応していますのでビルド環境がなくてもキーマップの変更が可能です。Remapの使用方法については自キ温泉ガイドのサリチル酸の記事に詳しく掲載されています。

テストファームウェア書き込みの章にも書きましたが、Keyball46のファームウェアは、トラックボールを右手と左手のどちらに載せたかで種類が分かれます。下記の適切な方のリンクからzipファイルをダウンロードしてください。

  • トラックボールを右手側につけた方はこちらのkeyball_keyball46_via.hexを書き込みます
  • トラックボールを左手側につけた方はこちらのkeyball_keyball46_via_Left.hexを書き込みます
  • Keyball46関連の全hexファイルを一括でダウンロードするためには、こちらをダウンロード後に解凍し、該当するhexファイルをご使用ください

書き込みは3-6章でも書いた通り、QMK Toolboxを使用して書き込んでください。

■ご自身でファームウェアをビルドする場合
Keyball46の最新ファームウェアはGithubのリポジトリにて公開しています。このkeyballフォルダをお手持ちのQMK_Firmware/keyboardsへコピーして自由にキーマップ等を編集してmakeしてください。

11.Keyballの使い方♪

  • トラックボールはレイヤー3に切り替わっている間は上下左右スクロールに変わります
  • Remapに対応していますので、簡単にキーマップの確認・変更・書込みが可能です
  • USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
  • Keyballシリーズ用に特別に用意されたキーコードがレイヤー3に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。

詳しくは キーコード一覧 を参照してください。

以上でKeyball46のビルドガイドは終了です。 Keyball46についてのご質問や不具合等についてはGithubのリポジトリ、Yowkees/keyballのDiscussionsへご投稿ください。なるべく早くご回答させていただきます。

―あとがき―
Keyball46の回路設計者は、トラックボール付きキーボード!に加えてRGB LEDにOLED、VIAにも対応したいし、今後タッチパッドや1Uトラックボールを拡張できるようにしたいと、実に盛りだくさんなキーボードキットを設計してしまいました。ProMicroの容量制限やトラックボール動作等に不安があったファームウェアを、KoRoN@香り屋様をはじめ多くの方のご協力により大幅に改善・安定化できました。また左右自動判別機能やトラックボール情報の左右間通信等、将来的にできたらという技術まで確立できたことで、左右両方にトラックボールを搭載することも可能となってきました。この場をお借りしてお礼申し上げます。本当にありがとうございました @Yowkees