はじめに

Life was like a box of chocolates. You never know what you're gonna get.

KMKはCircuitPythonの上に配置されるキーボード用の実装レイヤーです。そのため、CircuitPythonをサポートするほとんどのボードと互換性があります。

最新の安定したバージョンを使用することをおすすめします。(>5.0) 使用可能やおすすめなデバイスはこちらから確認できます。

CircuitPythonの最適化バージョン（特定のボードの容量制限に対処した、プリインストールされた関連モジュールの選択が可能なバージョン）も提供しています。

なぜCircuitPythonよりKMKPythonを使用するか気になっていたら、両方を比較した実績があります。

TL;DR クイックスタートガイド

To infinity and beyond!

CircuitPythonをボードにインストールする。
マスターブランチからKMKのコピーを取得。
ファイルを展開し、KMKフォルダーとboot.pyファイルをUSBドライブのルート（CIRCUITPYと表示されることが多い）にコピーする。
同じルートディレクトリー（boot.pyと同レベル）に新規でcode.py または main.pyのファイルを作成する。中身は以下の例とする。

重要： GP0 / GP1 ピンを使用ボードに合わせて下さい！

print("Starting")

import board

from kmk.kmk_keyboard import KMKKeyboard
from kmk.keys import KC
from kmk.matrix import DiodeOrientation

keyboard = KMKKeyboard()

keyboard.col_pins = (board.GP0,)
keyboard.row_pins = (board.GP1,)
keyboard.diode_orientation = DiodeOrientation.COLUMNS

keyboard.keymap = [
    [KC.A,]
]

if __name__ == '__main__':
    keyboard.go()

ワイヤーなどでGPIO 0とGPIO 1（またはほかに指定したピン）を接続する。
"A"や"Q"(キーボードのレイアウトによって異なる)が表示されたら、完成！

とりあえず一通り動くようになったので、もっとに先へ進みたい場合

This is your last chance. After this, there is no turning back. You take the blue pill—the story ends, you wake up in your bed and believe whatever you want to believe. You take the red pill—you stay in Wonderland, and I show you how deep the rabbit hole goes. Remember: all I'm offering is the truth. Nothing more.

フルサポートされているキーボードを持っている場合

あなたのキーボードとマイコンが正式にサポートされている場合、こちらのページからkb.py と main.pyを"flash drive"のルートに落とす必要があります。より高度な手順はこちらから確認できます。

このボードに最適化されているため、 KMKPython の使用を推奨します。

Circuitpythonを使用する場合、 boot.pyも必要になります。

ほかに自作ボードなどを持っていて、カスタマイズされたKMKを導入したい場合

最初にデバイスの動作や具体的なマトリックス構成についてしっかり理解してください。 QMKチームが提供している手配線キーボード用のガイドとドキュメントを確認できます。

要旨をつかめてきたら：

こことここを見て、code.py / main.py ファイルをカスタイマイズできます。
使用可能なキーコードのリファレンスがあります。
インターナショナルは、US配列以外のキーボードにキーを追加する拡張機能で、メディアキーは・・・メディアにキーを追加する拡張機能です。

さらに先へ進むと：

シーケンス一つのアクションで複数のキーストロークを送信するために使用します。
レイヤーでタッチ一つでキーボードの全体の動きを変えることができます。
モドタップでキーの押し/長押しの動作を設定し、何回押されたかによってタップダンスを設定します。

RGBや分裂型などの機能を楽しめたい場合は、ビルトインモジュールと拡張機能を見てみてください！

私たちが提供する、いろんなユーザー事例やドキュメントからアイデアを得ることもできます。

ヘルプ/サポート

Roads? Where we're going we don't need roads.

デバッグについてのヘルプが必要な場合はこちら。

KMKについてサポートが必要な場合や、コミュニケーションをとりたい場合はこちら。このチャネルはDiscord からも見ることができます。

チャットやバグ報告などでヘルプを求める場合、可能な限り、コントローラーのREPLにfrom kmk.consts import KMK_RELEASE; print(KMK_RELEASE)を実行することによって表示されるコミットSHAを記載してください。

5.8 KiB Raw Blame History Unescape Escape