aboutsummaryrefslogtreecommitdiff
path: root/docs/ja
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja')
-rw-r--r--docs/ja/api_development_environment.md8
-rw-r--r--docs/ja/api_development_overview.md49
-rw-r--r--docs/ja/api_docs.md73
-rw-r--r--docs/ja/api_overview.md20
-rw-r--r--docs/ja/config_options.md8
-rw-r--r--docs/ja/faq_build.md2
-rw-r--r--docs/ja/faq_general.md2
-rw-r--r--docs/ja/faq_keymap.md2
-rw-r--r--docs/ja/feature_bluetooth.md8
-rw-r--r--docs/ja/feature_split_keyboard.md15
-rw-r--r--docs/ja/getting_started_make_guide.md4
-rw-r--r--docs/ja/how_a_matrix_works.md2
-rw-r--r--docs/ja/quantum_keycodes.md20
-rw-r--r--docs/ja/ref_functions.md122
-rw-r--r--docs/ja/reference_configurator_support.md202
-rw-r--r--docs/ja/reference_glossary.md173
-rw-r--r--docs/ja/reference_info_json.md78
-rw-r--r--docs/ja/reference_keymap_extras.md88
-rw-r--r--docs/ja/serial_driver.md75
-rw-r--r--docs/ja/support.md22
-rw-r--r--docs/ja/syllabus.md75
-rw-r--r--docs/ja/tap_hold.md195
-rw-r--r--docs/ja/translating.md60
-rw-r--r--docs/ja/understanding_qmk.md195
24 files changed, 1470 insertions, 28 deletions
diff --git a/docs/ja/api_development_environment.md b/docs/ja/api_development_environment.md
new file mode 100644
index 000000000..8dce1ba2f
--- /dev/null
+++ b/docs/ja/api_development_environment.md
@@ -0,0 +1,8 @@
1# 開発環境のセットアップ
2
3<!---
4 original document: 0.9.50:docs/api_development_environment.md
5 git diff 0.9.50 HEAD -- docs/api_development_environment.md | cat
6-->
7
8開発環境をセットアップするには、[qmk_web_stack](https://github.com/qmk/qmk_web_stack) に行ってください。
diff --git a/docs/ja/api_development_overview.md b/docs/ja/api_development_overview.md
new file mode 100644
index 000000000..0612507b4
--- /dev/null
+++ b/docs/ja/api_development_overview.md
@@ -0,0 +1,49 @@
1# QMK コンパイラ開発ガイド
2
3<!---
4 original document: 0.9.50:docs/api_development_overview.md
5 git diff 0.9.50 HEAD -- docs/api_development_overview.md | cat
6-->
7
8このページでは、開発者に QMK コンパイラを紹介しようと思います。コードを読まなければならないような核心となる詳細に立ち入って調べることはしません。ここで得られるものは、コードを読んで理解を深めるためのフレームワークです。
9
10# 概要
11
12QMK Compile API は、いくつかの可動部分からできています:
13
14![構造図](https://raw.githubusercontent.com/qmk/qmk_api/master/docs/architecture.svg)
15
16API クライアントは API サービスと排他的にやりとりをします。ここでジョブをサブミットし、状態を調べ、結果をダウンロードします。API サービスはコンパイルジョブを [Redis Queue](https://python-rq.org) に挿入し、それらのジョブの結果について RQ と S3 の両方を調べます。
17
18ワーカーは RQ から新しいコンパイルジョブを取り出し、ソースとバイナリを S3 互換のストレージエンジンにアップロードします。
19
20# ワーカー
21
22QMK コンパイラワーカーは実際のビルド作業に責任を持ちます。ワーカーは RQ からジョブを取り出し、ジョブを完了するためにいくつかの事を行います:
23
24* 新しい qmk_firmware のチェックアウトを作成する
25* 指定されたレイヤーとキーボードメタデータを使って `keymap.c` をビルドする
26* ファームウェアをビルドする
27* ソースのコピーを zip 形式で圧縮する
28* ファームウェア、ソースの zip ファイル、メタデータファイルを S3 にアップロードする
29* ジョブの状態を RQ に送信する
30
31# API サービス
32
33API サービスは比較的単純な Flask アプリケーションです。理解しておくべきことが幾つかあります。
34
35## @app.route('/v1/compile', methods=['POST'])
36
37これは API の主なエントリーポイントです。クライアントとのやりとりはここから開始されます。クライアントはキーボードを表す JSON ドキュメントを POST し、API はコンパイルジョブをサブミットする前にいくらかの(とても)基本的な検証を行います。
38
39## @app.route('/v1/compile/&lt;string:job_id&gt;', methods=['GET'])
40
41これは最もよく呼ばれるエンドポイントです。ジョブの詳細が redis から利用可能であればそれを取り出し、そうでなければ S3 からキャッシュされたジョブの詳細を取り出します。
42
43## @app.route('/v1/compile/&lt;string:job_id&gt;/download', methods=['GET'])
44
45このメソッドによりユーザはコンパイルされたファームウェアファイルをダウンロードすることができます。
46
47## @app.route('/v1/compile/&lt;string:job_id&gt;/source', methods=['GET'])
48
49このメソッドによりユーザはファームウェアのソースをダウンロードすることができます。
diff --git a/docs/ja/api_docs.md b/docs/ja/api_docs.md
new file mode 100644
index 000000000..b483c045e
--- /dev/null
+++ b/docs/ja/api_docs.md
@@ -0,0 +1,73 @@
1# QMK API
2
3<!---
4 original document: 0.9.50:docs/api_docs.md
5 git diff 0.9.50 HEAD -- docs/api_docs.md | cat
6-->
7
8このページは QMK API の使い方を説明します。もしあなたがアプリケーション開発者であれば、全ての [QMK](https://qmk.fm) キーボードのファームウェアをコンパイルするために、この API を使うことができます。
9
10## 概要
11
12このサービスは、カスタムキーマップをコンパイルするための非同期 API です。API に 何らかの JSON を POST し、定期的に状態をチェックし、ファームウェアのコンパイルが完了していれば、結果のファームウェアと(もし希望すれば)そのファームウェアのソースコードをダウンロードすることができます。
13
14#### JSON ペイロードの例:
15
16```json
17{
18 "keyboard": "clueboard/66/rev2",
19 "keymap": "my_awesome_keymap",
20 "layout": "LAYOUT_all",
21 "layers": [
22 ["KC_GRV","KC_1","KC_2","KC_3","KC_4","KC_5","KC_6","KC_7","KC_8","KC_9","KC_0","KC_MINS","KC_EQL","KC_GRV","KC_BSPC","KC_PGUP","KC_TAB","KC_Q","KC_W","KC_E","KC_R","KC_T","KC_Y","KC_U","KC_I","KC_O","KC_P","KC_LBRC","KC_RBRC","KC_BSLS","KC_PGDN","KC_CAPS","KC_A","KC_S","KC_D","KC_F","KC_G","KC_H","KC_J","KC_K","KC_L","KC_SCLN","KC_QUOT","KC_NUHS","KC_ENT","KC_LSFT","KC_NUBS","KC_Z","KC_X","KC_C","KC_V","KC_B","KC_N","KC_M","KC_COMM","KC_DOT","KC_SLSH","KC_RO","KC_RSFT","KC_UP","KC_LCTL","KC_LGUI","KC_LALT","KC_MHEN","KC_SPC","KC_SPC","KC_HENK","KC_RALT","KC_RCTL","MO(1)","KC_LEFT","KC_DOWN","KC_RIGHT"],
23 ["KC_ESC","KC_F1","KC_F2","KC_F3","KC_F4","KC_F5","KC_F6","KC_F7","KC_F8","KC_F9","KC_F10","KC_F11","KC_F12","KC_TRNS","KC_DEL","BL_STEP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","_______","KC_TRNS","KC_PSCR","KC_SLCK","KC_PAUS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PGUP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_LEFT","KC_PGDN","KC_RGHT"],
24 ["KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","RESET","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_TRNS","KC_TRNS","KC_TRNS"]
25 ]
26}
27```
28
29ご覧のとおり、ペイロードにはファームウェアを作成および生成するために必要なキーボードの全ての側面を記述します。各レイヤーは QMK キーコードの1つのリストで、キーボードの `LAYOUT` マクロと同じ長さです。もしキーボードが複数の `LAYOUT` マクロをサポートする場合、どのマクロを使うかを指定することができます。
30
31## コンパイルジョブのサブミット
32
33キーマップをファームウェアにコンパイルするには、単純に JSON を `/v1/compile` エンドポイントに POST します。以下の例では、JSON ペイロードを `json_data` という名前のファイルに配置しています。
34
35```
36$ curl -H "Content-Type: application/json" -X POST -d "$(< json_data)" http://api.qmk.fm/v1/compile
37{
38 "enqueued": true,
39 "job_id": "ea1514b3-bdfc-4a7b-9b5c-08752684f7f6"
40}
41```
42
43## 状態のチェック
44
45キーマップをサブミットした後で、簡単な HTTP GET 呼び出しを使って状態をチェックすることができます:
46
47```
48$ curl http://api.qmk.fm/v1/compile/ea1514b3-bdfc-4a7b-9b5c-08752684f7f6
49{
50 "created_at": "Sat, 19 Aug 2017 21:39:12 GMT",
51 "enqueued_at": "Sat, 19 Aug 2017 21:39:12 GMT",
52 "id": "f5f9b992-73b4-479b-8236-df1deb37c163",
53 "status": "running",
54 "result": null
55}
56```
57
58これは、ジョブをキューに入れることに成功し、現在実行中であることを示しています。5つの状態がありえます:
59
60* **failed**: なんらかの理由でコンパイルサービスが失敗しました。
61* **finished**: コンパイルが完了し、結果を見るには `result` をチェックする必要があります。
62* **queued**: キーマップはコンパイルサーバが利用可能になるのを待っています。
63* **running**: コンパイルが進行中で、まもなく完了するはずです。
64* **unknown**: 深刻なエラーが発生し、[バグを報告](https://github.com/qmk/qmk_compiler/issues)する必要があります。
65
66## 完了した結果を検証
67
68コンパイルジョブが完了したら、`result` キーをチェックします。このキーの値は幾つかの情報を含むハッシュです:
69
70* `firmware_binary_url`: 書き込み可能なファームウェアの URL のリスト
71* `firmware_keymap_url`: `keymap.c` の URL のリスト
72* `firmware_source_url`: ファームウェアの完全なソースコードの URL のリスト
73* `output`: このコンパイルジョブの stdout と stderr。エラーはここで見つけることができます。
diff --git a/docs/ja/api_overview.md b/docs/ja/api_overview.md
new file mode 100644
index 000000000..18b8eae10
--- /dev/null
+++ b/docs/ja/api_overview.md
@@ -0,0 +1,20 @@
1# QMK API
2
3<!---
4 original document: 0.9.50:docs/api_overview.md
5 git diff 0.9.50 HEAD -- docs/api_overview.md | cat
6-->
7
8QMK API は、Web と GUI ツールが [QMK](http://qmk.fm/) によってサポートされるキーボード用の任意のキーマップをコンパイルするために使うことができる、非同期 API を提供します。標準のキーマップテンプレートは、C コードのサポートを必要としない全ての QMK キーコードをサポートします。キーボードのメンテナは独自のカスタムテンプレートを提供して、より多くの機能を実現することができます。
9
10## アプリケーション開発者
11
12もしあなたがアプリケーションでこの API を使うことに興味があるアプリケーション開発者であれば、[API の使用](ja/api_docs.md) に行くべきです。
13
14## キーボードのメンテナ
15
16もし QMK Compiler API でのあなたのキーボードのサポートを強化したい場合は、[キーボードサポート](ja/reference_configurator_support.md) の節に行くべきです。
17
18## バックエンド開発者
19
20もし API 自体に取り組むことに興味がある場合は、[開発環境](ja/api_development_environment.md)のセットアップから始め、それから [API のハッキング](ja/api_development_overview.md) を調べるべきです。
diff --git a/docs/ja/config_options.md b/docs/ja/config_options.md
index b4cf3c888..2a64f2ba2 100644
--- a/docs/ja/config_options.md
+++ b/docs/ja/config_options.md
@@ -322,11 +322,9 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
322 ``` 322 ```
323* `LAYOUTS` 323* `LAYOUTS`
324 * このキーボードがサポートする[レイアウト](ja/feature_layouts.md)のリスト 324 * このキーボードがサポートする[レイアウト](ja/feature_layouts.md)のリスト
325* `LINK_TIME_OPTIMIZATION_ENABLE` 325* `LTO_ENABLE`
326 * キーボードをコンパイルする時に、Link Time Optimization (LTO) を有効にします。これは処理に時間が掛かりますが、コンパイルされたサイズを大幅に減らします (そして、ファームウェアが小さいため、追加の時間は分からないくらいです)。 326 * キーボードをコンパイルする時に、Link Time Optimization (LTO) を有効にします。これは処理に時間が掛かりますが、コンパイルされたサイズを大幅に減らします (そして、ファームウェアが小さいため、追加の時間は分からないくらいです)。
327ただし、LTO が有効な場合、古い TMK のマクロと関数の機能が壊れるため、自動的にこれらの機能を無効にします。これは `NO_ACTION_MACRO` と `NO_ACTION_FUNCTION` を自動的に定義することで行われます。(メモ: これは QMK の [マクロ](ja/feature_macros.md) と [レイヤー](ja/feature_layers.md) には影響を与えません。) 327ただし、LTO が有効な場合、古い TMK のマクロと関数の機能が壊れるため、自動的にこれらの機能を無効にします。これは `NO_ACTION_MACRO` と `NO_ACTION_FUNCTION` を自動的に定義することで行われます。(メモ: これは QMK の [マクロ](ja/feature_macros.md) と [レイヤー](ja/feature_layers.md) には影響を与えません。)
328* `LTO_ENABLE`
329 * LINK_TIME_OPTIMIZATION_ENABLE と同じ意味です。`LINK_TIME_OPTIMIZATION_ENABLE` の代わりに `LTO_ENABLE` を使うことができます。
330 328
331## AVR MCU オプション 329## AVR MCU オプション
332* `MCU = atmega32u4` 330* `MCU = atmega32u4`
@@ -371,10 +369,8 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
371 * MIDI 制御 369 * MIDI 制御
372* `UNICODE_ENABLE` 370* `UNICODE_ENABLE`
373 * Unicode 371 * Unicode
374* `BLUETOOTH_ENABLE`
375 * Adafruit EZ-Key HID で Bluetooth を有効にするレガシーオプション。BLUETOOTH を見てください
376* `BLUETOOTH` 372* `BLUETOOTH`
377 * 現在のオプションは、AdafruitEzKey、AdafruitBLE、RN42 373 * 現在のオプションは、AdafruitBLE、RN42
378* `SPLIT_KEYBOARD` 374* `SPLIT_KEYBOARD`
379 * 分割キーボード (let's split や bakingpy のキーボードのようなデュアル MCU) のサポートを有効にし、quantum/split_common にある全ての必要なファイルをインクルードします 375 * 分割キーボード (let's split や bakingpy のキーボードのようなデュアル MCU) のサポートを有効にし、quantum/split_common にある全ての必要なファイルをインクルードします
380* `CUSTOM_MATRIX` 376* `CUSTOM_MATRIX`
diff --git a/docs/ja/faq_build.md b/docs/ja/faq_build.md
index 97e1bd8cf..62c36f249 100644
--- a/docs/ja/faq_build.md
+++ b/docs/ja/faq_build.md
@@ -145,4 +145,4 @@ ARM ベースのチップ上での EEPROM の動作によって、保存され
145[Planck rev6 reset EEPROM](https://cdn.discordapp.com/attachments/473506116718952450/539284620861243409/planck_rev6_default.bin) を使って eeprom のリセットを強制することができます。このイメージを書き込んだ後で、通常のファームウェアを書き込むと、キーボードが_通常_ の動作順序に復元されます。 145[Planck rev6 reset EEPROM](https://cdn.discordapp.com/attachments/473506116718952450/539284620861243409/planck_rev6_default.bin) を使って eeprom のリセットを強制することができます。このイメージを書き込んだ後で、通常のファームウェアを書き込むと、キーボードが_通常_ の動作順序に復元されます。
146[Preonic rev3 reset EEPROM](https://cdn.discordapp.com/attachments/473506116718952450/537849497313738762/preonic_rev3_default.bin) 146[Preonic rev3 reset EEPROM](https://cdn.discordapp.com/attachments/473506116718952450/537849497313738762/preonic_rev3_default.bin)
147 147
148いずれかの形式でブートマジックが有効になっている場合は、これも実行できるはずです (実行方法の詳細については、[ブートマジックドキュメント](feature_bootmagic.md)とキーボード情報を見てください)。 148いずれかの形式でブートマジックが有効になっている場合は、これも実行できるはずです (実行方法の詳細については、[ブートマジックドキュメント](ja/feature_bootmagic.md)とキーボード情報を見てください)。
diff --git a/docs/ja/faq_general.md b/docs/ja/faq_general.md
index a365e380b..83d1a557b 100644
--- a/docs/ja/faq_general.md
+++ b/docs/ja/faq_general.md
@@ -51,7 +51,7 @@ OK、問題ありません。[GitHub で issue を開く](https://github.com/qmk
51 51
52TMK は [Jun Wako](https://github.com/tmk) によって設計され実装されました。QMK は [Jack Humbert](https://github.com/jackhumbert) の Planck 用 TMK のフォークとして始まりました。しばらくして、Jack のフォークは TMK からかなり分岐し、2015年に Jack はフォークを QMK に名前を変えることにしました。 52TMK は [Jun Wako](https://github.com/tmk) によって設計され実装されました。QMK は [Jack Humbert](https://github.com/jackhumbert) の Planck 用 TMK のフォークとして始まりました。しばらくして、Jack のフォークは TMK からかなり分岐し、2015年に Jack はフォークを QMK に名前を変えることにしました。
53 53
54技術的な観点から、QMK は幾つかの新しい機能を追加した TMK に基づいています。最も注目すべきことは、QMK は利用可能なキーコードの数を増やし、`S()`、`LCTL()` および `MO()` などの高度な機能を実装するためにこれらを使っています。[キーコード](keycodes.md)でこれらのキーコードの完全なリストを見ることができます。 54技術的な観点から、QMK は幾つかの新しい機能を追加した TMK に基づいています。最も注目すべきことは、QMK は利用可能なキーコードの数を増やし、`S()`、`LCTL()` および `MO()` などの高度な機能を実装するためにこれらを使っています。[キーコード](ja/keycodes.md)でこれらのキーコードの完全なリストを見ることができます。
55 55
56プロジェクトとコミュニティの管理の観点から、TMK は公式にサポートされている全てのキーボードを自分で管理しており、コミュニティのサポートも少し受けています。他のキーボード用に別個のコミュニティが維持するフォークが存在するか、作成できます。デフォルトでは少数のキーマップのみが提供されるため、ユーザは一般的にお互いにキーマップを共有しません。QMK は集中管理されたリポジトリを介して、キーボードとキーマップの両方を共有することを奨励しており、品質基準に準拠する全てのプルリクエストを受け付けます。これらはほとんどコミュニティで管理されますが、必要な場合は QMK チームも支援します。 56プロジェクトとコミュニティの管理の観点から、TMK は公式にサポートされている全てのキーボードを自分で管理しており、コミュニティのサポートも少し受けています。他のキーボード用に別個のコミュニティが維持するフォークが存在するか、作成できます。デフォルトでは少数のキーマップのみが提供されるため、ユーザは一般的にお互いにキーマップを共有しません。QMK は集中管理されたリポジトリを介して、キーボードとキーマップの両方を共有することを奨励しており、品質基準に準拠する全てのプルリクエストを受け付けます。これらはほとんどコミュニティで管理されますが、必要な場合は QMK チームも支援します。
57 57
diff --git a/docs/ja/faq_keymap.md b/docs/ja/faq_keymap.md
index 2726e1872..311ebe0e4 100644
--- a/docs/ja/faq_keymap.md
+++ b/docs/ja/faq_keymap.md
@@ -128,7 +128,7 @@ https://github.com/tekezo/Karabiner/issues/403
128 128
129## 単一のキーでの Esc と<code>&#96;</code> 129## 単一のキーでの Esc と<code>&#96;</code>
130 130
131[Grave Escape](feature_grave_esc.md) 機能を見てください。 131[Grave Escape](ja/feature_grave_esc.md) 機能を見てください。
132 132
133## Mac OSX での Eject 133## Mac OSX での Eject
134`KC_EJCT` キーコードは OSX で動作します。https://github.com/tmk/tmk_keyboard/issues/250 134`KC_EJCT` キーコードは OSX で動作します。https://github.com/tmk/tmk_keyboard/issues/250
diff --git a/docs/ja/feature_bluetooth.md b/docs/ja/feature_bluetooth.md
index 4443a4e3e..f7835dd54 100644
--- a/docs/ja/feature_bluetooth.md
+++ b/docs/ja/feature_bluetooth.md
@@ -7,11 +7,10 @@
7 7
8## Bluetooth の既知のサポートハードウェア 8## Bluetooth の既知のサポートハードウェア
9 9
10現在のところ Bluetooth のサポートは AVR ベースのチップに限られます。Bluetooth 2.1 については、QMK は RN-42 モジュールと、Bluefruit EZ-Key をサポートしますが、後者はもう生産されていません。より最近の BLE プロトコルについては、現在のところ Adafruit Bluefruit SPI Friend のみが直接サポートされています。iOS デバイスに接続するには、BLE が必要です。iOS はマウス入力をサポートしないことに注意してください。 10現在のところ Bluetooth のサポートは AVR ベースのチップに限られます。Bluetooth 2.1 については、QMK は RN-42 モジュールをサポートします。より最近の BLE プロトコルについては、現在のところ Adafruit Bluefruit SPI Friend のみが直接サポートされています。iOS デバイスに接続するには、BLE が必要です。iOS はマウス入力をサポートしないことに注意してください。
11 11
12| ボード | Bluetooth プロトコル | 接続タイプ | rules.mk | Bluetooth チップ | 12| ボード | Bluetooth プロトコル | 接続タイプ | rules.mk | Bluetooth チップ |
13|----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------| 13|----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------|
14| [Adafruit EZ-Key HID](https://www.adafruit.com/product/1535) | Bluetooth Classic | UART | `BLUETOOTH = AdafruitEZKey` | |
15| Roving Networks RN-42 (Sparkfun Bluesmirf) | Bluetooth Classic | UART | `BLUETOOTH = RN42` | RN-42 | 14| Roving Networks RN-42 (Sparkfun Bluesmirf) | Bluetooth Classic | UART | `BLUETOOTH = RN42` | RN-42 |
16| [Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633) | Bluetooth Low Energy | SPI | `BLUETOOTH = AdafruitBLE` | nRF51822 | 15| [Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633) | Bluetooth Low Energy | SPI | `BLUETOOTH = AdafruitBLE` | nRF51822 |
17 16
@@ -29,16 +28,11 @@
29 28
30Bluefruit UART friend は SPI friend に変換することができますが、これにはMDBT40 チップへの直接の再書き込みとはんだ付けが[必要です](https://github.com/qmk/qmk_firmware/issues/2274)。 29Bluefruit UART friend は SPI friend に変換することができますが、これにはMDBT40 チップへの直接の再書き込みとはんだ付けが[必要です](https://github.com/qmk/qmk_firmware/issues/2274)。
31 30
32## Adafruit EZ-Key hid
33これには[ハードウェアの変更](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts)が必要ですが、Makefile を使って有効にすることができます。ファームウェアは引き続き USB 経由で文字を出力するため、コンピュータ経由で充電する場合は注意してください。任意にオフにするために Bluefruit 上にスイッチを持つことは理にかなっています。
34
35
36<!-- FIXME: Document bluetooth support more completely. --> 31<!-- FIXME: Document bluetooth support more completely. -->
37## Bluetooth の Rules.mk オプション 32## Bluetooth の Rules.mk オプション
38これらのうちの1つだけを使ってください 33これらのうちの1つだけを使ってください
39* BLUETOOTH_ENABLE = yes (レガシーオプション) 34* BLUETOOTH_ENABLE = yes (レガシーオプション)
40* BLUETOOTH = RN42 35* BLUETOOTH = RN42
41* BLUETOOTH = AdafruitEZKey
42* BLUETOOTH = AdafruitBLE 36* BLUETOOTH = AdafruitBLE
43 37
44## Bluetooth キーコード 38## Bluetooth キーコード
diff --git a/docs/ja/feature_split_keyboard.md b/docs/ja/feature_split_keyboard.md
index 74b62310f..3bdf96d1c 100644
--- a/docs/ja/feature_split_keyboard.md
+++ b/docs/ja/feature_split_keyboard.md
@@ -1,8 +1,8 @@
1# 分割キーボード 1# 分割キーボード
2 2
3<!--- 3<!---
4 original document:0.9.43:docs/feature_split_keyboard.md 4 original document:0.10.8:docs/feature_split_keyboard.md
5 git diff 0.9.43 HEAD -- docs/feature_split_keyboard.md | cat 5 git diff 0.10.8 HEAD -- docs/feature_split_keyboard.md | cat
6--> 6-->
7 7
8QMK ファームウェアリポジトリの多くのキーボードは、"分割"キーボードです。それらは2つのコントローラを使います — 1つは USB に接続し、もう1つは TRRS または同様のケーブルを介してシリアルまたは I<sup>2</sup>C 接続で接続します。 8QMK ファームウェアリポジトリの多くのキーボードは、"分割"キーボードです。それらは2つのコントローラを使います — 1つは USB に接続し、もう1つは TRRS または同様のケーブルを介してシリアルまたは I<sup>2</sup>C 接続で接続します。
@@ -20,12 +20,12 @@ QMK ファームウェアには、任意のキーボードで使用可能な一
20 20
21| Transport | AVR | ARM | 21| Transport | AVR | ARM |
22|------------------------------|--------------------|--------------------| 22|------------------------------|--------------------|--------------------|
23| ['serial'](serial_driver.md) | :heavy_check_mark: | :white_check_mark: <sup>1</sup> | 23| ['serial'](ja/serial_driver.md) | :heavy_check_mark: | :white_check_mark: <sup>1</sup> |
24| I2C | :heavy_check_mark: | | 24| I2C | :heavy_check_mark: | |
25 25
26注意: 26注意:
27 27
281. ハードウェアとソフトウェアの両方の制限は、[ドライバーのドキュメント](serial_driver.md)の中で説明されます。 281. ハードウェアとソフトウェアの両方の制限は、[ドライバーのドキュメント](ja/serial_driver.md)の中で説明されます。
29 29
30## ハードウェア設定 30## ハードウェア設定
31 31
@@ -53,11 +53,12 @@ QMK ファームウェアには、任意のキーボードで使用可能な一
53 53
54### シリアル配線 54### シリアル配線
55 55
562つの Pro Micro 間で GND、Vcc、D0 (別名 PDO あるいは pin 3) を TRS/TRRS ケーブルの3本のワイヤで接続します。 562つの Pro Micro 間で GND、Vcc、D0/D1/D2/D3 (別名 PD0/PD1/PD2/PD3) を TRS/TRRS ケーブルの3本のワイヤで接続します。
57 57
58?> ここで使われるピンは実際には以下の `SOFT_SERIAL_PIN` によって設定されることに注意してください。 58?> ここで使われるピンは実際には以下の `SOFT_SERIAL_PIN` によって設定されることに注意してください。
59 59
60![シリアル配線](https://i.imgur.com/C3D1GAQ.png) 60<img alt="sk-pd0-connection-mono" src="https://user-images.githubusercontent.com/2170248/92296488-28e9ad80-ef70-11ea-98be-c40cb48a0319.JPG" width="48%"/>
61<img alt="sk-pd2-connection-mono" src="https://user-images.githubusercontent.com/2170248/92296490-2d15cb00-ef70-11ea-801f-5ace313013e6.JPG" width="48%"/>
61 62
62### I<sup>2</sup>C 配線 63### I<sup>2</sup>C 配線
63 64
@@ -65,7 +66,7 @@ QMK ファームウェアには、任意のキーボードで使用可能な一
65 66
66プルアップ抵抗はキーボードの左右どちら側にも配置することができます。もし各側を単独で使いたい場合は、4つの抵抗を使い、両側にプルアップ抵抗を配置することもできます。 67プルアップ抵抗はキーボードの左右どちら側にも配置することができます。もし各側を単独で使いたい場合は、4つの抵抗を使い、両側にプルアップ抵抗を配置することもできます。
67 68
68![I2C 配線](https://i.imgur.com/Hbzhc6E.png) 69<img alt="sk-i2c-connection-mono" src="https://user-images.githubusercontent.com/2170248/92297182-92b98580-ef77-11ea-9d7d-d6033914af43.JPG" width="50%"/>
69 70
70## ファームウェア設定 71## ファームウェア設定
71 72
diff --git a/docs/ja/getting_started_make_guide.md b/docs/ja/getting_started_make_guide.md
index 0d39583a1..cbc824de8 100644
--- a/docs/ja/getting_started_make_guide.md
+++ b/docs/ja/getting_started_make_guide.md
@@ -106,10 +106,6 @@ make コマンド自体にもいくつかの追加オプションがあります
106 106
107詳細と制限については、[Unicode ページ](ja/feature_unicode.md) を見てください。 107詳細と制限については、[Unicode ページ](ja/feature_unicode.md) を見てください。
108 108
109`BLUETOOTH_ENABLE`
110
111これによりキーコードをワイヤレスで送信するために Bluefruit EZ-key と連動することができます。D2 と D3 ピンを使います。
112
113`AUDIO_ENABLE` 109`AUDIO_ENABLE`
114 110
115C6 ピン(抽象化が必要)でオーディオ出力できます。詳細は[オーディオページ](ja/feature_audio.md)を見てください。 111C6 ピン(抽象化が必要)でオーディオ出力できます。詳細は[オーディオページ](ja/feature_audio.md)を見てください。
diff --git a/docs/ja/how_a_matrix_works.md b/docs/ja/how_a_matrix_works.md
index ff4fbb115..b6ded186b 100644
--- a/docs/ja/how_a_matrix_works.md
+++ b/docs/ja/how_a_matrix_works.md
@@ -101,4 +101,4 @@
101- [Deskthority の記事](https://deskthority.net/wiki/Keyboard_matrix) 101- [Deskthority の記事](https://deskthority.net/wiki/Keyboard_matrix)
102- [Dave Dribin による Keyboard Matrix Help (2000)](https://www.dribin.org/dave/keyboard/one_html/) 102- [Dave Dribin による Keyboard Matrix Help (2000)](https://www.dribin.org/dave/keyboard/one_html/)
103- [PCBheaven による How Key Matrices Works](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) (アニメーションの例) 103- [PCBheaven による How Key Matrices Works](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) (アニメーションの例)
104- [キーボードの仕組み - QMK ドキュメント](how_keyboards_work.md) 104- [キーボードの仕組み - QMK ドキュメント](ja/how_keyboards_work.md)
diff --git a/docs/ja/quantum_keycodes.md b/docs/ja/quantum_keycodes.md
new file mode 100644
index 000000000..ffcc49446
--- /dev/null
+++ b/docs/ja/quantum_keycodes.md
@@ -0,0 +1,20 @@
1# Quantum キーコード
2
3<!---
4 original document: 0.9.55:docs/quantum_keycodes.md
5 git diff 0.9.55 HEAD -- docs/quantum_keycodes.md | cat
6-->
7
8Quantum キーコードにより、カスタムアクションを定義することなく、基本的なものが提供するものより簡単にキーマップをカスタマイズすることができます。
9
10quantum 内の全てのキーコードは `0x0000` と `0xFFFF` の間の数値です。`keymap.c` の中では、関数やその他の特別な場合があるように見えますが、最終的には C プリプロセッサによってそれらは単一の4バイト整数に変換されます。QMK は標準的なキーコードのために `0x0000` から `0x00FF` を予約しています。これらは、`KC_A`、`KC_1` および `KC_LCTL` のようなキーコードで、USB HID 仕様で定義された基本的なキーです。
11
12このページでは、高度な quantum 機能を実装するために使われる `0x00FF` と `0xFFFF` の間のキーコードを説明します。独自のカスタムキーコードを定義する場合は、それらもこの範囲に配置されます。
13
14## QMK キーコード :id=qmk-keycodes
15
16| キー | エイリアス | 説明 |
17|----------------|------------|--------------------------------------------------------|
18| `RESET` | | 書き込みのために、キーボードを bootloader モードにする |
19| `DEBUG` | | デバッグモードの切り替え |
20| `EEPROM_RESET` | `EEP_RST` | キーボードの EEPROM (永続化メモリ) を再初期化する |
diff --git a/docs/ja/ref_functions.md b/docs/ja/ref_functions.md
new file mode 100644
index 000000000..e9c45fdec
--- /dev/null
+++ b/docs/ja/ref_functions.md
@@ -0,0 +1,122 @@
1# キーボードをより良くするための便利なコア関数のリスト
2
3<!---
4 original document: 0.9.47:docs/ref_functions.md
5 git diff 0.9.47 HEAD -- docs/ref_functions.md | cat
6-->
7
8QMK には、信じられないほど便利な、またはあなたが望んでいた機能を少し追加する、隠された関数がたくさんあります。特定の機能に固有の関数はそれぞれの機能のページにあるため、ここには含まれていません。
9
10## (OLKB) トライレイヤー :id=olkb-tri-layers
11
12目的に応じて、実際に使うことができる別個の関数があります。
13
14### `update_tri_layer(x, y, z)`
15
16最初は `update_tri_layer(x, y, z)` 関数です。この関数はレイヤー `x` と `y` の両方がオンになっているかどうかを調べます。両方ともオンの場合は、レイヤー `z` がオンになります。それ以外の場合、`x` と `y` の両方がオンではない(一方のみがオン、またはどちらもオンでない)場合は、レイヤー `z` をオフにします。
17
18この関数は、この機能を持つ特定のキーを作成したいが、他のレイヤーのキーコードではそうしたくない場合に便利です。
19
20#### 例
21
22```c
23bool process_record_user(uint16_t keycode, keyrecord_t *record) {
24 switch (keycode) {
25 case LOWER:
26 if (record->event.pressed) {
27 layer_on(_LOWER);
28 update_tri_layer(_LOWER, _RAISE, _ADJUST);
29 } else {
30 layer_off(_LOWER);
31 update_tri_layer(_LOWER, _RAISE, _ADJUST);
32 }
33 return false;
34 case RAISE:
35 if (record->event.pressed) {
36 layer_on(_RAISE);
37 update_tri_layer(_LOWER, _RAISE, _ADJUST);
38 } else {
39 layer_off(_RAISE);
40 update_tri_layer(_LOWER, _RAISE, _ADJUST);
41 }
42 return false;
43 }
44 return true;
45}
46```
47
48### `update_tri_layer_state(state, x, y, z)`
49もう1つの関数は `update_tri_layer_state(state, x, y, z)` です。この関数は [`layer_state_set_*` 関数](ja/custom_quantum_functions.md#layer-change-code)から呼び出されることを意図しています。これは、キーコードを使ってレイヤーを変更するたびに、これがチェックされることを意味します。したがって、`LT(layer, kc)` を使ってレイヤーを変更すると、同じレイヤーチェックが引き起こされます。
50
51このメソッドの注意点は、`x` および `y` レイヤーをオンにしないと、`z` レイヤーにアクセスできないことです。レイヤー `z` のみをアクティブにしようとすると、このコードが実行され、使用前にレイヤー `z` がオフになるからです。
52
53#### 例
54
55```c
56layer_state_t layer_state_set_user(layer_state_t state) {
57 return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
58}
59```
60
61あるいは、すぐに値を「返す」必要はありません。複数のトライレイヤーを追加、あるいは追加の効果を追加する場合に便利です。
62
63```c
64layer_state_t layer_state_set_user(layer_state_t state) {
65 state = update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
66 state = update_tri_layer_state(state, _RAISE, _SYMB, _SPECIAL);
67 return state;
68}
69```
70
71## 永続的なデフォルトレイヤーの設定
72
73デフォルトレイヤーを設定して、キーボードを取り外しても保持されるようにしたいですか？そうであれば、これがそのための関数です。
74
75これを使うには、`set_single_persistent_default_layer(layer)` を使います。レイヤーに名前が定義されている場合は、代わりにそれを使うことができます (_QWERTY、_DVORAK、_COLEMAK など)。
76
77これは、デフォルトレイヤーを設定し、永続設定が更新され、もし [オーディオ](ja/feature_audio.md) がキーボードで有効でデフォルトレイヤーの音が設定されている場合は、曲を再生します。
78
79デフォルトレイヤーの音を設定するには、以下のように `config.h` ファイルに定義する必要があります。
80
81```c
82#define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
83 SONG(COLEMAK_SOUND), \
84 SONG(DVORAK_SOUND) \
85 }
86```
87
88
89?> [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) に使用できる多くの定義済みの曲があります。
90
91## キーボードのリセット
92
93使用できる `RESET` quantum キーコードがあります。ただし、キーを個別に押すのではなくマクロの一部としてリセットしたい場合は、そうすることができます。
94
95そのためには、`reset_keyboard()` を関数またはマクロに追加すると、ブートローダがリセットされます。
96
97## EEPROM (永続ストレージ)の消去
98
99オーディオ、RGB アンダーグロー、バックライト、キーの動作に問題がある場合は、EEPROM (永続的な設定のストレージ)をリセットすることができます。ブートマジックはこれを行う方法の1つですが、有効になっていない場合はカスタムマクロを使って行うことができます。
100
101EEPROM を消去するには、関数またはマクロから `eeconfig_init()` を実行し、ほとんどの設定をデフォルトにリセットします。
102
103## タップランダムキー
104
105ランダムな文字をホストコンピュータに送信する場合は、`tap_random_base64()` 関数を使うことができます。これは[疑似乱数的に](https://en.wikipedia.org/wiki/Pseudorandom_number_generator)0から63の数字を選択し、その選択に基づいてキー押下を送信します。(0–25 は `A`–`Z`、26–51 は `a`–`z`、52–61 は `0`–`9`、62 は `+`、63 は `/`)。
106
107?> 言うまでもないですが、これはランダムに Base64 キーあるいはパスワードを生成する暗号的に安全な方法では _ありません_。
108
109## ソフトウェアタイマー
110
111タイマーを開始し、時間固有のイベントの値を読み取ることができます。以下は例です:
112
113```c
114static uint16_t key_timer;
115key_timer = timer_read();
116
117if (timer_elapsed(key_timer) < 100) {
118 // 経過時間が 100ms 未満の場合に何かを行う
119} else {
120 // 経過時間が 100ms 以上の場合に何かを行う
121}
122```
diff --git a/docs/ja/reference_configurator_support.md b/docs/ja/reference_configurator_support.md
new file mode 100644
index 000000000..0151731e9
--- /dev/null
+++ b/docs/ja/reference_configurator_support.md
@@ -0,0 +1,202 @@
1# QMK Configurator でのキーボードのサポート
2
3<!---
4 original document: 0.9.46:docs/reference_configurator_support.md
5 git diff 0.9.46 HEAD -- docs/reference_configurator_support.md | cat
6-->
7
8このページは [QMK Configurator](https://config.qmk.fm/) でキーボードを適切にサポートする方法について説明します。
9
10
11## Configurator がキーボードを理解する方法
12
13Configurator がキーボードをどのように理解するかを理解するには、最初にレイアウトマクロを理解する必要があります。この演習では、17キーのテンキー PCB を想定します。これを `numpad` と呼びます。
14
15```
16|---------------|
17|NLk| / | * | - |
18|---+---+---+---|
19|7 |8 |9 | + |
20|---+---+---| |
21|4 |5 |6 | |
22|---+---+---+---|
23|1 |2 |3 |Ent|
24|-------+---| |
25|0 | . | |
26|---------------|
27```
28
29?> レイアウトマクロの詳細については、[QMK の理解: マトリックススキャン](ja/understanding_qmk.md?id=matrix-scanning) と [QMK の理解: マトリックスから物理レイアウトへのマップ](ja/understanding_qmk.md?id=matrix-to-physical-layout-map) を見てください。
30
31Configurator の API はキーボードの `.h` ファイルを `qmk_firmware/keyboards/<keyboard>/<keyboard>.h` から読み取ります。numpad の場合、このファイルは `qmk_firmware/keyboards/numpad/numpad.h` です:
32
33```c
34#pragma once
35
36#define LAYOUT( \
37 k00, k01, k02, k03, \
38 k10, k11, k12, k13, \
39 k20, k21, k22, \
40 k30, k31, k32, k33, \
41 k40, k42 \
42 ) { \
43 { k00, k01, k02, k03 }, \
44 { k10, k11, k12, k13 }, \
45 { k20, k21, k22, KC_NO }, \
46 { k30, k31, k32, k33 }, \
47 { k40, KC_NO, k42, KC_NO } \
48}
49```
50
51QMK は `KC_NO` を使って、スイッチマトリックス内のスイッチがない場所を指定します。デバッグが必要な場合に、このセクションを読みやすくするために、`XXX`、`___`、`____` を略記として使うこともあります。通常は `.h` ファイルの先頭近くで定義されます:
52
53```c
54#pragma once
55
56#define XXX KC_NO
57
58#define LAYOUT( \
59 k00, k01, k02, k03, \
60 k10, k11, k12, k13, \
61 k20, k21, k22, \
62 k30, k31, k32, k33, \
63 k40, k42 \
64 ) { \
65 { k00, k01, k02, k03 }, \
66 { k10, k11, k12, k13 }, \
67 { k20, k21, k22, XXX }, \
68 { k30, k31, k32, k33 }, \
69 { k40, XXX, k42, XXX } \
70}
71```
72
73!> この使用方法はキーマップマクロと異なります。キーマップマクロはほとんど常に`KC_NO`については`XXXXXXX` (7つの大文字の X) を、`KC_TRNS` については `_______` (7つのアンダースコア)を使います。
74
75!> ユーザの混乱を防ぐために、`KC_NO` を使うことをお勧めします。
76
77レイアウトマクロは、キーボードに17個のキーがあり、4列それぞれが5行に配置されていることを Configurator に伝えます。スイッチの位置は、0から始まる `k<row><column>` という名前が付けられています。キーマップからキーコードを受け取る上部セクションと、マトリックス内の各キーの位置を指定する下部セクションとが一致する限り、名前自体は実際には問題ではありません。
78
79物理的なキーボードに似た形でキーボードを表示するには、それぞれのキーの物理的な位置とサイズをスイッチマトリックスに結びつけることを Configurator に伝える JSON ファイルを作成する必要があります。
80
81## JSON ファイルのビルド
82
83JSON ファイルをビルドする最も簡単な方法は、[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/) ("KLE") でレイアウトを作成することです。この Raw Data を QMK tool に入れて、Configurator が読み出して使用する JSON ファイルに変換します。KLE は numpad レイアウトをデフォルトで開くため、Getting Started の説明を削除し、残りを使います。
84
85レイアウトが望み通りのものになったら、KLE の Raw Data タブに移動し、内容をコピーします:
86
87```
88["Num Lock","/","*","-"],
89["7\nHome","8\n↑","9\nPgUp",{h:2},"+"],
90["4\n←","5","6\n→"],
91["1\nEnd","2\n↓","3\nPgDn",{h:2},"Enter"],
92[{w:2},"0\nIns",".\nDel"]
93```
94
95このデータを JSON に変換するには、[QMK KLE-JSON Converter](https://qmk.fm/converter/) に移動し、Raw Data を Input フィールド に貼り付け、Convert ボタンをクリックします。しばらくすると、JSON データが Output フィールドに表示されます。内容を新しいテキストドキュメントにコピーし、ドキュメントに `info.json` という名前を付け、`numpad.h` を含む同じフォルダに保存します。
96
97`keyboard_name` オブジェクトを使ってキーボードの名前を設定します。説明のために、各キーのオブジェクトを各行に配置します。これはファイルを人間が読みやすいものにするためのもので、Configurator の機能には影響しません。
98
99```json
100{
101 "keyboard_name": "Numpad",
102 "url": "",
103 "maintainer": "qmk",
104 "tags": {
105 "form_factor": "numpad"
106 },
107 "width": 4,
108 "height": 5,
109 "layouts": {
110 "LAYOUT": {
111 "layout": [
112 {"label":"Num Lock", "x":0, "y":0},
113 {"label":"/", "x":1, "y":0},
114 {"label":"*", "x":2, "y":0},
115 {"label":"-", "x":3, "y":0},
116 {"label":"7", "x":0, "y":1},
117 {"label":"8", "x":1, "y":1},
118 {"label":"9", "x":2, "y":1},
119 {"label":"+", "x":3, "y":1, "h":2},
120 {"label":"4", "x":0, "y":2},
121 {"label":"5", "x":1, "y":2},
122 {"label":"6", "x":2, "y":2},
123 {"label":"1", "x":0, "y":3},
124 {"label":"2", "x":1, "y":3},
125 {"label":"3", "x":2, "y":3},
126 {"label":"Enter", "x":3, "y":3, "h":2},
127 {"label":"0", "x":0, "y":4, "w":2},
128 {"label":".", "x":2, "y":4}
129 ]
130 }
131 }
132}
133```
134
135`layouts` オブジェクトにはキーボードの物理レイアウトを表すデータが含まれます。このオブジェクトには `LAYOUT` という名前のオブジェクトがあり、このオブジェクト名は `numpad.h` のレイアウトマクロの名前と一致する必要があります。`LAYOUT` オブジェクト自体には `layout` という名前のオブジェクトがあります。このオブジェクトにはキーボードの物理キーごとに 1つの JSON オブジェクトが以下の形式で含まれています:
136
137```
138 キーの名前。Configurator では表示されません。
139 |
140 | キーボードの左端からのキー単位での
141 | | キーの X 軸の位置。
142 | |
143 | | キーボードの上端(奥側)からのキー単位での
144 | | | キーの Y 軸位置。
145 ↓ ↓ ↓
146{"label":"Num Lock", "x":0, "y":0},
147```
148
149一部のオブジェクトには、それぞれキーの幅と高さを表す `"w"` 属性キーと `"h"` 属性キーがあります。
150
151?> `info.json` ファイルの詳細については、[`info.json` 形式](ja/reference_info_json.md) を参照してください。
152
153
154## Configurator がキーをプログラムする方法
155
156Configurator の API は、指定されたレイアウトマクロと JSON ファイルを使って、特定のキーに関連付けられた各ビジュアルオブジェクトを順番に持つキーボードのビジュアル表現を作成します:
157
158| レイアウトマクロのキー | 使用される JSON オブジェクト |
159:---: | :----
160| k00 | {"label":"Num Lock", "x":0, "y":0} |
161| k01 | {"label":"/", "x":1, "y":0} |
162| k02 | {"label":"*", "x":2, "y":0} |
163| k03 | {"label":"-", "x":3, "y":0} |
164| k10 | {"label":"7", "x":0, "y":1} |
165| k11 | {"label":"8", "x":1, "y":1} |
166| k12 | {"label":"9", "x":2, "y":1} |
167| k13 | {"label":"+", "x":3, "y":1, "h":2} |
168| k20 | {"label":"4", "x":0, "y":2} |
169| k21 | {"label":"5", "x":1, "y":2} |
170| k22 | {"label":"6", "x":2, "y":2} |
171| k30 | {"label":"1", "x":0, "y":3} |
172| k31 | {"label":"2", "x":1, "y":3} |
173| k32 | {"label":"3", "x":2, "y":3} |
174| k33 | {"label":"Enter", "x":3, "y":3, "h":2} |
175| k40 | {"label":"0", "x":0, "y":4, "w":2} |
176| k42 | {"label":".", "x":2, "y":4} |
177
178ユーザが Configurator で左上のキーを選択し、Num Lock を割り当てると、Configurator は最初のキーとして `KC_NLCK` を持つキーマップを作成し、同様にキーマップが作成されます。`label` キーは使われません; それらは `info.json` ファイルをデバッグする時に特定のキーを識別するためのユーザの参照のためだけのものです。
179
180
181## 問題と危険
182
183現在のところ、Configurator はキーの回転または ISO Enter などの長方形ではないキーをサポートしません。さらに、"行"から垂直方向にずれているキー、&mdash; 顕著な例として [TKC1800](https://github.com/qmk/qmk_firmware/tree/4ac48a61a66206beaf2fdd5f2939d8bbedd0004c/keyboards/tkc1800/) のような1800レイアウト上の矢印キー &mdash; は、 `info.json` ファイルの提供者によって調整されていない場合は、KLE-to-JSON コンバータを混乱させます。
184
185### 回避策
186
187#### 長方形ではないキー
188
189ISO Enter キーについては、QMK custom は幅 1.25u、高さ 2u の長方形のキーとして表示し、右端が英数字キーブロックの右端に揃うように配置されます。
190
191![](https://i.imgur.com/JKngtTw.png)
192*QMK Configurator によって描画される標準 ISO レイアウトの60%キーボード。*
193
194#### 垂直方向にずれたキー
195
196垂直方向にずれたキーについては、ずれていないかのように KLE で配置し、変換された JSON ファイルで必要に応じて Y 値を編集します。
197
198![](https://i.imgur.com/fmDvDzR.png)
199*矢印キーに適用される垂直方向のずれのない、Keyboard Layout Editor で描画された1800レイアウトのキーボード。*
200
201![](https://i.imgur.com/8beYMBR.png)
202*キーボードの JSON ファイルで矢印キーを垂直方向にずらすために必要な変更を示す、Unix の diff ファイル。*
diff --git a/docs/ja/reference_glossary.md b/docs/ja/reference_glossary.md
new file mode 100644
index 000000000..19791206f
--- /dev/null
+++ b/docs/ja/reference_glossary.md
@@ -0,0 +1,173 @@
1# QMK 用語集
2
3<!---
4 original document: 0.9.46:docs/reference_glossary.md
5 git diff 0.9.46 HEAD -- docs/reference_glossary.md | cat
6-->
7
8## ARM
9Atmel、Cypress、Kinetis、NXP、ST、TI など多くの企業が生産する 32 ビット MCU のライン。
10
11## AVR
12[Atmel](http://www.microchip.com/) が生産する 8 ビット MCU のライン。AVR は TMK がサポートしていた元のプラットフォームでした。
13
14## AZERTY
15標準的な Français (フランス) キーボードレイアウト。キーボードの最初の6つのキーから命名されました。
16
17## バックライト
18キーボードのライトの総称。バックライトが一般的ですが、それだけではなく、キーキャップあるいはスイッチを通して光る LED の配列。
19
20## Bluetooth
21短距離のピアツーピア無線プロトコル。キーボード用のもっとも一般的なワイヤレスプロトコル。
22
23## ブートローダ
24MCU の保護領域に書き込まれる特別なプログラムで、MCU が独自のファームウェアを通常は USB 経由でアップグレードできるようにします。
25
26## ブートマジック
27よくあるキーの交換あるいは無効化など、様々なキーボードの挙動の変更をその場で実行できる機能。
28
29## C
30システムコードに適した低レベルプログラミング言語。QMK のほとんどのコードは C で書かれています。
31
32## Colemak
33人気が出始めている代替キーボードレイアウト。
34
35## コンパイル
36人間が読めるコードを MCU が実行できるマシンコードに変換するプロセス。
37
38## Dvorak
391930年代に Dr. August Dvorak によって開発された代替キーボードレイアウト。Dvorak Simplified Keyboard の短縮形。
40
41## 動的マクロ
42キーボードに記録されたマクロで、キーボードのプラグを抜くか、コンピュータを再起動すると失われます。
43
44* [動的マクロドキュメント](ja/feature_dynamic_macros.md)
45
46## Eclipse
47多くの C 開発者に人気のある IDE。
48
49* [Eclipse セットアップ手順](ja/other_eclipse.md)
50
51## ファームウェア
52MCU を制御するソフトウェア
53
54## git
55コマンドラインで使用されるバージョン管理ソフトウェア
56
57## GitHub
58QMK プロジェクトのほとんどをホストする Web サイト。git、課題管理、および QMK の実行に役立つその他の機能を統合して提供します。
59
60## ISP
61インシステムプログラミング。外部ハードウェアと JTAG ピンを使って AVR チップをプログラミングする方法。
62
63## hid_listen
64キーボードからデバッグメッセージを受信するためのインタフェース。[QMK Flasher](https://github.com/qmk/qmk_flasher) あるいは [PJRC の hid_listen](https://www.pjrc.com/teensy/hid_listen.html) を使ってこれらのメッセージを見ることができます。
65
66## キーコード
67特定のキーを表す2バイトの数値。`0x00`-`0xFF` は[基本キーコード](ja/keycodes_basic.md)に使われ、`0x100`-`0xFFFF` は [Quantum キーコード](ja/quantum_keycodes.md) に使われます。
68
69## キーダウン
70キーが押された時に発生し、キーが放される前に完了するイベント。
71
72## キーアップ
73キーが放された時に発生するイベント。
74
75## キーマップ
76物理的なキーボードレイアウトにマップされたキーコードの配列。キーの押下およびリリース時に処理されます。
77
78## レイヤー
791つのキーが複数の目的を果たすために使われる抽象化。最上位のアクティブなレイヤーが優先されます。
80
81## リーダーキー
82リーダーキーに続けて1, 2 あるいは3つのキーをタップすることで、キーの押下あるいは他の quantum 機能をアクティブにする機能。
83
84* [リーダーキードキュメント](ja/feature_leader_key.md)
85
86## LED
87発光ダイオード。キーボードの表示に使われる最も一般的なデバイス。
88
89## Make
90全てのソースファイルをコンパイルするために使われるソフトウェアパッケージ。キーボードファームウェアをコンパイルするために、様々なオプションを指定して `make` を実行します。
91
92## マトリックス
93MCU がより少ないピン数でキー押下を検出できるようにする列と行の配線パターン。マトリックスには多くの場合、NKRO を可能にするためのダイオードが組み込まれています。
94
95## マクロ
96単一のキーのみを押した後で、複数のキー押下イベント (HID レポート) を送信できる機能。
97
98* [マクロドキュメント](ja/feature_macros.md)
99
100## MCU
101マイクロコントロールユニット。キーボードを動かすプロセッサ。
102
103## モディファイア
104別のキーを入力する間押したままにして、そのキーのアクションを変更するキー。例として、Ctrl、Alt および Shift があります。
105(訳注：モディファイヤ、モディファイヤキー、修飾キーなど、訳語が統一されていませんが同じものです)
106
107## マウスキー
108キーボードからマウスカーソルを制御し、クリックできる機能。
109
110* [マウスキードキュメント](ja/feature_mouse_keys.md)
111
112## N キーロールオーバー (NKRO)
113一度に任意の数のキーの押下を送信できるキーボードに当てはまる用語。
114
115## ワンショットモディファイア
116別のキーが放されるまで押されているかのように機能するモディファイア。キーを押している間に mod を押し続けるのではなく、mod を押してからキーを押すことができます。スティッキーキーまたはデッドキーとも呼びます。
117
118## ProMicro
119低コストの AVR 開発ボード。このデバイスのクローンは ebay で非常に安価(5ドル未満)に見つかることがありますが、多くの場合 pro micro の書き込みに苦労します。
120
121## プルリクエスト
122QMK にコードを送信するリクエスト。全てのユーザが個人のキーマップのプルリクエストを送信することを推奨します。
123
124## QWERTY
125標準の英語キーボードレイアウト。多くの場合、他の言語の標準レイアウトへのショートカット。キーボードの最初の6文字から命名されました。
126
127## QWERTZ
128標準的な Deutsche (ドイツ語) キーボードレイアウト。キーボードの最初の6文字から命名されました。
129
130## ロールオーバー
131キーが既に押されている間にキーを押すことを指す用語。似たものに 2KRO、6KRO、NKRO が含まれます。
132
133## スキャンコード
134単一のキーを表す USB 経由の HID レポートの一部として送信される1バイトの数値。これらの値は、[USB-IF](http://www.usb.org/) が発行する [HID Usage Tables](https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf) に記載されています。
135
136## スペースカデットシフト
137左または右 shift を1回以上タップすることで、様々なタイプの括弧を入力できる特別な shift キーのセット。
138
139* [スペースカデットシフトドキュメント](ja/feature_space_cadet_shift.md)
140
141## タップ
142キーを押して放す。状況によってはキーダウンイベントとキーアップイベントを区別する必要がありますが、タップは常に両方を一度に指します。
143
144## タップダンス
145押す回数に基づいて、同じキーに複数のキーコードを割り当てることができる機能。
146
147* [タップダンスドキュメント](ja/feature_tap_dance.md)
148
149## Teensy
150手配線での組み立てによく用いられる低コストの AVR 開発ボード。halfkay ブートローダによって書き込みが非常に簡単になるために、数ドル高いにもかかわらず teensy がしばしば選択されます。
151
152## アンダーライト
153キーボードの下側を照らす LED の総称。これらの LED は通常 PCB の底面からキーボードが置かれている表面に向けて照らします。
154
155## ユニコード
156大規模なコンピュータの世界では、ユニコードは任意の言語で文字を表現するためのエンコード方式のセットです。QMK に関しては、様々な OS スキームを使ってスキャンコードの代わりにユニコードコードポイントを送信することを意味します。
157
158* [ユニコードドキュメント](ja/feature_unicode.md)
159
160## 単体テスト
161QMK に対して自動テストを実行するためのフレームワーク。単体テストは、変更が何も壊さないことを確信するのに役立ちます。
162
163* [単体テストドキュメント](ja/unit_testing.md)
164
165## USB
166ユニバーサルシリアルバス。キーボード用の最も一般的な有線インタフェース。
167
168## USB ホスト (あるいは単にホスト)
169USB ホストは、あなたのコンピュータ、またはキーボードが差し込まれているデバイスのことです。
170
171# 探している用語が見つかりませんでしたか？
172
173質問についての [issue を開いて](https://github.com/qmk/qmk_firmware/issues) 、質問した用語についてここに追加することができます。さらに良いのは、定義についてのプルリクエストを開くことです。:)
diff --git a/docs/ja/reference_info_json.md b/docs/ja/reference_info_json.md
new file mode 100644
index 000000000..0fa1f9d3f
--- /dev/null
+++ b/docs/ja/reference_info_json.md
@@ -0,0 +1,78 @@
1# `info.json`
2
3<!---
4 original document: 0.9.46:docs/reference_info_json.md
5 git diff 0.9.46 HEAD -- docs/reference_info_json.md | cat
6-->
7
8このファイルは [QMK API](https://github.com/qmk/qmk_api) によって使われます。このファイルは [QMK Configurator](https://config.qmk.fm/) がキーボードの画像を表示するために必要な情報を含んでいます。ここにメタデータを設定することもできます。
9
10このメタデータを指定するために、`qmk_firmware/keyboards/<name>` の下の全てのレベルで `info.json` を作成することができます。これらのファイルは結合され、より具体的なファイルがそうではないファイルのキーを上書きします。つまり、メタデータ情報を複製する必要はありません。例えば、`qmk_firmware/keyboards/clueboard/info.json` は `manufacturer` および `maintainer` を指定し、`qmk_firmware/keyboards/clueboard/66/info.json` は Clueboard 66% についてのより具体的な情報を指定します。
11
12## `info.json` の形式
13
14`info.json` ファイルは設定可能な以下のキーを持つ JSON 形式の辞書です。全てを設定する必要はなく、キーボードに適用するキーだけを設定します。
15
16* `keyboard_name`
17 * キーボードを説明する自由形式のテキスト文字列。
18 * 例: `Clueboard 66%`
19* `url`
20 * キーボードの製品ページ、[QMK.fm/keyboards](https://qmk.fm/keyboards) のページ、あるいはキーボードに関する情報を説明する他のページの URL。
21* `maintainer`
22 * メンテナの GitHub のユーザ名、あるいはコミュニティが管理するキーボードの場合は `qmk`
23* `width`
24 * キー単位でのキーボードの幅
25* `height`
26 * キー単位でのキーボードの高さ
27* `layouts`
28 * 物理的なレイアウト表現。詳細は以下のセクションを見てください。
29
30### レイアウトの形式
31
32`info.json` ファイル内の辞書の `layouts` 部分は、幾つかの入れ子になった辞書を含みます。外側のレイヤーは QMK レイアウトマクロで構成されます。例えば、`LAYOUT_ansi` あるいは `LAYOUT_iso`。各レイアウトマクロ内には、`width`、 `height`、`key_count` のキーがあります。これらは自明でなければなりません。
33
34* `width`
35 * オプション: キー単位でのレイアウトの幅
36* `height`
37 * オプション: キー単位でのレイアウトの高さ
38* `key_count`
39 * オプション: このレイアウトのキーの数
40* `layout`
41 * 物理レイアウトを説明するキー辞書のリスト。詳細は次のセクションを見てください。
42
43### キー辞書形式
44
45レイアウトの各キー辞書は、キーの物理プロパティを記述します。<http://keyboard-layout-editor.com> の Raw Code に精通している場合、多くの概念が同じであることが分かります。可能な限り同じキー名とレイアウトの選択を再利用しますが、keyboard-layout-editor とは異なって各キーはステートレスで、前のキーからプロパティを継承しません。
46
47全てのキーの位置と回転は、キーボードの左上と、各キーの左上を基準にして指定されます。
48
49* `x`
50 * **必須**: 水平軸でのキーの絶対位置(キー単位)。
51* `y`
52 * **必須**: 垂直軸でのキーの絶対位置(キー単位)。
53* `w`
54 * キー単位でのキーの幅。`ks` が指定された場合は無視されます。デフォルト: `1`
55* `h`
56 * キー単位でのキーの高さ。`ks` が指定された場合は無視されます。デフォルト: `1`
57* `r`
58 * キーを回転させる時計回りの角度。
59* `rx`
60 * キーを回転させる点の水平軸における絶対位置。デフォルト: `x`
61* `ry`
62 * キーを回転させる点の垂直軸における絶対位置。デフォルト: `y`
63* `ks`
64 * キー形状: キー単位で頂点を列挙することでポリゴンを定義します。
65 * **重要**: これらはキーの左上からの相対位置で、絶対位置ではありません。
66 * ISO Enter の例: `[ [0,0], [1.5,0], [1.5,2], [0.25,2], [0.25,1], [0,1], [0,0] ]`
67* `label`
68 * マトリックス内のこの位置につける名前。
69 * これは通常 PCB 上でこの位置にシルクスクリーン印刷されるものと同じ名前でなければなりません。
70
71## メタデータはどのように公開されますか？
72
73このメタデータは主に2つの方法で使われます:
74
75* Web ベースの configurator が動的に UI を生成できるようにする。
76* 新しい `make keyboard:keymap:qmk` ターゲットをサポートする。これは、このメタデータをファームウェアにバンドルして QMK Toolbox をよりスマートにします。
77
78Configurator の作成者は、JSON API の使用に関する詳細について、[QMK Compiler](https://docs.api.qmk.fm/using-the-api) ドキュメントを参照することができます。
diff --git a/docs/ja/reference_keymap_extras.md b/docs/ja/reference_keymap_extras.md
new file mode 100644
index 000000000..e8104e5f3
--- /dev/null
+++ b/docs/ja/reference_keymap_extras.md
@@ -0,0 +1,88 @@
1# 言語固有のキーコード
2
3<!---
4 original document: 0.9.55:docs/reference_keymap_extras.md
5 git diff 0.9.55 HEAD -- docs/reference_keymap_extras.md | cat
6-->
7
8キーボードは多くの言語をサポートすることができます。ただし、それらはキーを押したことで生成される実際の文字を送信しません - 代わりに数字のコードを送信します。USB HID の仕様ではそれらは "usages" と呼ばれますが、キーボードの文脈では「スキャンコード」あるいは「キーコード」と呼ばれることが多いです。
9HID Keyboard/Keypad usage ページでは 256 未満の usage が定義されており、それらの一部は現在のオペレーティングシステムでは機能しません。では、この言語のサポートはどのようにして実現されるのでしょうか？
10
11簡単に言うと、オペレーティングシステムはユーザが設定したキーボードレイアウトに基づいて受け取った usage を適切な文字にマップします。例えば、スウェーデン人がキーボードの `å` という文字が刻印されたキーを押すと、キーボードは *実際には* `[` のキーコードを送信します。
12
13明らかにこれは混乱する可能性があるため、QMK は多くのキーボードレイアウトのために言語固有のキーコードのエイリアスを提供します。これらはそれだけでは何もしません - さらに OS の設定で対応するキーボードレイアウトを設定する必要があります。それらをキーマップのキーキャップラベルと考えてください。
14
15これらを使うには、`keymap.c` で対応する [ヘッダファイル](https://github.com/qmk/qmk_firmware/tree/master/quantum/keymap_extras) を `#include` し、それらで定義されているキーコードを `KC_` プリフィクスの代わりに追加します:
16
17| レイアウト | ヘッダファイル |
18|-----------------------------|----------------------------------|
19| Canadian Multilingual (CSA) | `keymap_canadian_multilingual.h` |
20| Croatian | `keymap_croatian.h` |
21| Czech | `keymap_czech.h` |
22| Danish | `keymap_danish.h` |
23| Dutch (Belgium) | `keymap_belgian.h` |
24| English (Ireland) | `keymap_irish.h` |
25| English (UK) | `keymap_uk.h` |
26| English (US International) | `keymap_us_international.h` |
27| Estonian | `keymap_estonian.h` |
28| Finnish | `keymap_finnish.h` |
29| French | `keymap_french.h` |
30| French (AFNOR) | `keymap_french_afnor.h` |
31| French (BÉPO) | `keymap_bepo.h` |
32| French (Belgium) | `keymap_belgian.h` |
33| French (Switzerland) | `keymap_fr_ch.h` |
34| French (macOS, ISO) | `keymap_french_osx.h` |
35| German | `keymap_german.h` |
36| German (Switzerland) | `keymap_german_ch.h` |
37| German (macOS) | `keymap_german_osx.h` |
38| German (Neo2)* | `keymap_neo2.h` |
39| Greek* | `keymap_greek.h` |
40| Hebrew* | `keymap_hebrew.h` |
41| Hungarian | `keymap_hungarian.h` |
42| Icelandic | `keymap_icelandic.h` |
43| Italian | `keymap_italian.h` |
44| Italian (macOS, ANSI) | `keymap_italian_osx_ansi.h` |
45| Italian (macOS, ISO) | `keymap_italian_osx_iso.h` |
46| Japanese | `keymap_jp.h` |
47| Korean | `keymap_korean.h` |
48| Latvian | `keymap_latvian.h` |
49| Lithuanian (ĄŽERTY) | `keymap_lithuanian_azerty.h` |
50| Lithuanian (QWERTY) | `keymap_lithuanian_qwerty.h` |
51| Norwegian | `keymap_norwegian.h` |
52| Polish | `keymap_polish.h` |
53| Portuguese | `keymap_portuguese.h` |
54| Portuguese (Brazil) | `keymap_br_abnt2.h` |
55| Romanian | `keymap_romanian.h` |
56| Russian* | `keymap_russian.h` |
57| Serbian* | `keymap_serbian.h` |
58| Serbian (Latin) | `keymap_serbian_latin.h` |
59| Slovak | `keymap_slovak.h` |
60| Slovenian | `keymap_slovenian.h` |
61| Spanish | `keymap_spanish.h` |
62| Spanish (Dvorak) | `keymap_spanish_dvorak.h` |
63| Swedish | `keymap_swedish.h` |
64| Turkish (F) | `keymap_turkish_f.h` |
65| Turkish (Q) | `keymap_turkish_q.h` |
66
67言語固有でないものもありますが、QWERTY レイアウトを使っていない場合に役立ちます:
68
69| レイアウト | ヘッダファイル |
70|---------------------|--------------------------|
71| Colemak | `keymap_colemak.h` |
72| Dvorak | `keymap_dvorak.h` |
73| Dvorak (French) | `keymap_dvorak_fr.h` |
74| Dvorak (Programmer) | `keymap_dvp.h` |
75| Norman | `keymap_norman.h` |
76| Plover* | `keymap_plover.h` |
77| Plover (Dvorak)* | `keymap_plover_dvorak.h` |
78| Steno* | `keymap_steno.h` |
79| Workman | `keymap_workman.h` |
80| Workman (ZXCVM) | `keymap_workman_zxcvm.h` |
81
82## Sendstring サポート
83
84デフォルトでは、`SEND_STRING()` は US ANSI キーボードレイアウトが設定されたと見なします。別のレイアウトを使っている場合は、キーマップで(上記のように)`#include "sendstring_*.h"` して、ASCII 文字をキーコードにマッピングするために使われるルックアップテーブルを上書きすることができます。
85
86ここで注意すべき重要な点は、`SEND_STRING()` は [ASCII 文字](https://en.wikipedia.org/wiki/ASCII#Character_set) でのみ機能するということです。これは、ユニコード文字を含む文字列を渡すことができないことを意味します - 残念ながら、これには希望のレイアウトに存在する可能性のあるアクセント付き文字が含まれています。
87多くのレイアウトでは、Grave または Tilde などの特定の文字を[デッドキー](https://en.wikipedia.org/wiki/Dead_key)としてのみ使えるようにしています。そのため、デッドキーが次の文字と潜在的に結合されることを防ぐためには、送信したい文字列の中のデッドキーのすぐ後にスペースを追加する必要があります。
88ラテン語由来のアルファベットを使わない(例えば、ギリシャ語やロシア語のような)他のレイアウトには、Sendstring ヘッダーがありません。従って ASCII 文字セットのほとんどを入力する方法がありません。これらは上記で `*` でマークされています。
diff --git a/docs/ja/serial_driver.md b/docs/ja/serial_driver.md
new file mode 100644
index 000000000..72071f4f7
--- /dev/null
+++ b/docs/ja/serial_driver.md
@@ -0,0 +1,75 @@
1# 'シリアル' ドライバ
2
3<!---
4 original document: 0.9.51:docs/serial_drive.md
5 git diff 0.9.51 HEAD -- docs/serial_drive.md | cat
6-->
7
8このドライバは[分割キーボード](ja/feature_split_keyboard.md) 機能に使います。
9
10?> この文章でのシリアルは、UART/USART/RS485/RS232 規格の実装ではなく、**一度に1ビットの情報を送信するもの**として読まれるべきです。
11
12このカテゴリの全てのドライバには以下の特徴があります:
13* 1本の線上でデータと信号を提供
14* シングルマスタ、シングルスレーブに限定
15
16## サポートされるドライバの種類
17
18| | AVR | ARM |
19|-------------------|--------------------|--------------------|
20| bit bang | :heavy_check_mark: | :heavy_check_mark: |
21| USART Half-duplex | | :heavy_check_mark: |
22
23## ドライバ設定
24
25### Bitbang
26デフォルトのドライバ。設定がない場合はこのドライバが想定されます。設定するには、以下を rules.mk に追加します:
27
28```make
29SERIAL_DRIVER = bitbang
30```
31
32config.h を介してドライバを設定します:
33```c
34#define SOFT_SERIAL_PIN D0 // または D1, D2, D3, E6
35#define SELECT_SOFT_SERIAL_SPEED 1 // または 0, 2, 3, 4, 5
36 // 0: 約 189kbps (実験目的のみ)
37 // 1: 約 137kbps (デフォルト)
38 // 2: 約 75kbps
39 // 3: 約 39kbps
40 // 4: 約 26kbps
41 // 5: 約 20kbps
42```
43
44#### ARM
45
46!> bitbang ドライバは bitbang WS2812 ドライバと接続の問題があります
47
48上記の一般的なオプションに加えて、halconf.h で `PAL_USE_CALLBACKS` 機能もオンにする必要があります。
49
50### USART Half-duplex
51通信が USART ハードウェアデバイスに送信される STM32 ボードが対象です。これにより高速で正確なタイミングを提供できることが利点です。このドライバの `SOFT_SERIAL_PIN` は、設定された USART TX ピンです。**TX ピンに適切なプルアップ抵抗が必要です**。設定するには、以下を rules.mk に追加します:
52
53```make
54SERIAL_DRIVER = usart
55```
56
57config.h を介してハードウェアを設定します:
58```c
59#define SOFT_SERIAL_PIN B6 // USART TX ピン
60#define SELECT_SOFT_SERIAL_SPEED 1 // または 0, 2, 3, 4, 5
61 // 0: 約 460800 ボー
62 // 1: 約 230400 ボー (デフォルト)
63 // 2: 約 115200 ボー
64 // 3: 約 57600 ボー
65 // 4: 約 38400 ボー
66 // 5: 約 19200 ボー
67#define SERIAL_USART_DRIVER SD1 // TX ピンの USART ドライバ。デフォルトは SD1
68#define SERIAL_USART_TX_PAL_MODE 7 // 「代替機能」 ピン。MCU の適切な値については、それぞれのデータシートを見てください。デフォルトは 7
69```
70
71また、ChibiOS `SERIAL` 機能を有効にする必要があります:
72* キーボードの halconf.h: `#define HAL_USE_SERIAL TRUE`
73* キーボードの mcuconf.h: `#define STM32_SERIAL_USE_USARTn TRUE` (ここで、'n' は MCU で選択した USART のペリフェラル番号と一致)
74
75必要な構成は、`UART` 周辺機器ではなく、`SERIAL` 周辺機器であることに注意してください。
diff --git a/docs/ja/support.md b/docs/ja/support.md
new file mode 100644
index 000000000..01c2d41d1
--- /dev/null
+++ b/docs/ja/support.md
@@ -0,0 +1,22 @@
1# 助けを得る
2
3<!---
4 original document: 0.9.51:docs/support.md
5 git diff 0.9.51 HEAD -- docs/support.md | cat
6-->
7
8QMK に関して助けを得るための多くのリソースがあります。
9
10コミュニティスペースに参加する前に[行動規範](https://qmk.fm/coc/)を読んでください。
11
12## リアルタイムチャット
13
14何かについて助けが必要な場合は、迅速なサポートを受けるための最良の場所は、[Discord Server](https://discord.gg/Uq7gcHh) です。通常は誰かがオンラインで、非常に助けになる多くの人がいます。
15
16## OLKB Subreddit
17
18公式の QMK フォーラムは [reddit.com](https://reddit.com) の [/r/olkb](https://reddit.com/r/olkb) です。
19
20## GitHub Issues
21
22[GitHub で issue](https://github.com/qmk/qmk_firmware/issues) を開くことができます。issue は長期的な議論あるいはデバッグを必要とする場合は、特に便利です。
diff --git a/docs/ja/syllabus.md b/docs/ja/syllabus.md
new file mode 100644
index 000000000..14e743ee9
--- /dev/null
+++ b/docs/ja/syllabus.md
@@ -0,0 +1,75 @@
1# QMK シラバス
2
3<!---
4 original document: 0.9.51:docs/syllabus.md
5 git diff 0.9.51 HEAD -- docs/syllabus.md | cat
6-->
7
8このページは最初に基本を紹介し、そして、QMK に習熟するために必要な全ての概念を理解するように導くことで、QMK の知識を構築するのに役立ちます。
9
10# 初級トピック
11
12他に何も読んでいない場合は、このセクションのドキュメントを読んでください。[QMK 初心者ガイド](ja/newbs.md)を読み終わると、基本的なキーマップを作成し、それをコンパイルし、キーボードに書き込みできるようになっているはずです。残りのドキュメントはこれらの基本的な知識を具体的に肉付けします。
13
14* **QMK Tools の使い方を学ぶ**
15 * [QMK 初心者ガイド](ja/newbs.md)
16 * [CLI](ja/cli.md)
17 * [Git](ja/newbs_git_best_practices.md)
18* **キーマップについて学ぶ**
19 * [レイヤー](ja/feature_layers.md)
20 * [キーコード](ja/keycodes.md)
21 * 使用できるキーコードの完全なリスト。中級または上級トピックにある知識が必要な場合もあることに注意してください。
22* **IDE の設定** - オプション
23 * [Eclipse](ja/other_eclipse.md)
24 * [VS Code](ja/other_vscode.md)
25
26# 中級トピック
27
28これらのトピックでは、QMK がサポートする幾つかの機能について掘り下げます。これらのドキュメントを全て読む必要はありませんが、これらの一部をスキップすると、上級トピックのセクションの一部のドキュメントが意味をなさなくなるかもしれません。
29
30* **機能の設定方法を学ぶ**
31 <!-- * Configuration Overview FIXME(skullydazed/anyone): write this document -->
32 * [オーディオ](ja/feature_audio.md)
33 * 電飾
34 * [バックライト](ja/feature_backlight.md)
35 * [LED マトリックス](ja/feature_led_matrix.md)
36 * [RGB ライト](ja/feature_rgblight.md)
37 * [RGB マトリックス](ja/feature_rgb_matrix.md)
38 * [タップホールド設定](ja/tap_hold.md)
39* **キーマップについてさらに学ぶ**
40 * [キーマップ](ja/keymap.md)
41 * [カスタム関数とキーコード](ja/custom_quantum_functions.md)
42 * マクロ
43 * [動的マクロ](ja/feature_dynamic_macros.md)
44 * [コンパイル済みのマクロ](ja/feature_macros.md)
45 * [タップダンス](ja/feature_tap_dance.md)
46 * [コンボ](ja/feature_combo.md)
47 * [ユーザスペース](ja/feature_userspace.md)
48
49# 上級トピック
50
51以下の全ては多くの基礎知識を必要とします。高度な機能を使ってキーマップを作成できることに加えて、`config.h` と `rules.mk` の両方を使ってキーボードのオプションを設定することに慣れている必要があります。
52
53* **QMK 内のキーボードの保守**
54 * [キーボードの手配線](ja/hand_wire.md)
55 * [キーボードガイドライン](ja/hardware_keyboard_guidelines.md)
56 * [info.json リファレンス](ja/reference_info_json.md)
57 * [デバウンス API](ja/feature_debounce_type.md)
58* **高度な機能**
59 * [ユニコード](ja/feature_unicode.md)
60 * [API](ja/api_overview.md)
61 * [ブートマジック](ja/feature_bootmagic.md)
62* **ハードウェア**
63 * [キーボードがどのように動作するか](ja/how_keyboards_work.md)
64 * [キーボードマトリックスの仕組み](ja/how_a_matrix_works.md)
65 * [分割キーボード](ja/feature_split_keyboard.md)
66 * [速記](ja/feature_stenography.md)
67 * [ポインティングデバイス](ja/feature_pointing_device.md)
68* **コア開発**
69 * [コーディング規約](ja/coding_conventions_c.md)
70 * [互換性のあるマイクロコントローラ](ja/compatible_microcontrollers.md)
71 * [カスタムマトリックス](ja/custom_matrix.md)
72 * [QMK を理解する](ja/understanding_qmk.md)
73* **CLI 開発**
74 * [コーディング規約](ja/coding_conventions_python.md)
75 * [CLI 開発の概要](ja/cli_development.md)
diff --git a/docs/ja/tap_hold.md b/docs/ja/tap_hold.md
new file mode 100644
index 000000000..a0f089762
--- /dev/null
+++ b/docs/ja/tap_hold.md
@@ -0,0 +1,195 @@
1# タップホールド設定オプション
2
3<!---
4 original document: 0.9.51:docs/tap_hold.md
5 git diff 0.9.51 HEAD -- docs/tap_hold.md | cat
6-->
7
8タップホールドオプションは素晴らしいものですが、問題が無いわけではありません。デフォルト設定を適切なものにしようとしましたが、一部の人にとってまだ問題を引き起こすかもしれません。
9
10次のオプションによりタップホールドキーの挙動を変更することができます。
11
12## タッピング時間
13
14以下の機能の全ての核心は、タッピング時間の設定です。これにより、何をタップとし、何をホールドとするかが決まります。これが自然に感じられるぴったりのタイミングは、キーボードごと、スイッチごと、あるいはキーごとに異ることもありえます。
15
16`config.h` に以下の設定を追加することで、この時間を全体的に設定することができます:
17
18```c
19#define TAPPING_TERM 200
20```
21
22この設定はミリ秒で定義され、デフォルトは 200ms です。これは大多数の人にとっての適切な平均値です。
23
24この機能をより細かく制御するために、以下を `config.h` に追加することができます:
25```c
26#define TAPPING_TERM_PER_KEY
27```
28
29そして、以下の関数をキーマップに追加します:
30
31```c
32uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record) {
33 switch (keycode) {
34 case SFT_T(KC_SPC):
35 return TAPPING_TERM + 1250;
36 case LT(1, KC_GRV):
37 return 130;
38 default:
39 return TAPPING_TERM;
40 }
41}
42```
43
44
45## 許容ホールド
46
47[PR#1359](https://github.com/qmk/qmk_firmware/pull/1359/) 以降、新しい `config.h` オプションがあります:
48
49```c
50#define PERMISSIVE_HOLD
51```
52
53これは高速なタイピストや高い `TAPPING_TERM` 設定に対して、タップとホールドキー(モッドタップのような)の動作を向上させます。
54
55モッドタップキーを押し、他のキーをタップ(押して放す)して、モッドタップキーを放すという動作の全てをタッピング時間内に行うと、両方のキーの「タッピング」機能が出力されます。
56
57例えば:
58
59- `SFT_T(KC_A)` を押す
60- `KC_X` を押す
61- `KC_X` を放す
62- `SFT_T(KC_A)` を放す
63
64通常、これら全てを `TAPPING_TERM` (デフォルト: 200ms) 内で行うと、ファームウェアとホストシステムによって `ax` として登録されます。許容ホールドを有効にすると、別のキーがタップされた場合にモッドタップキーを修飾キーと見なすように処理を変更し、 `X` (`SHIFT`+`x`) と登録されます。
65
66?> `モッドタップ割り込みの無視`を有効にしている場合、これにより両方の動きが変更されます。通常のキーには、最初のキーが最初に放された場合、あるいは両方のキーが `TAPPING_TERM` より長くホールドされた場合に、修飾キーが追加されます。
67
68この機能をより細かく制御するために、以下を `config.h` に追加することができます:
69
70```c
71#define PERMISSIVE_HOLD_PER_KEY
72```
73
74そして、以下の関数をキーマップに追加します:
75
76```c
77bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) {
78 switch (keycode) {
79 case LT(1, KC_BSPC):
80 return true;
81 default:
82 return false;
83 }
84}
85```
86
87## モッドタップ割り込みの無視
88
89この設定を有効にするには、これを `config.h` に追加してください:
90
91```c
92#define IGNORE_MOD_TAP_INTERRUPT
93```
94
95許容ホールドと同様に、これは高速なタイピストのためのファームウェアの処理方法を変更します。モッドタップキーを押し、他のキーを押し、モッドタップキーを放し、通常のキーを放すと、通常は両方のキーの「タッピング」機能が出力されます。これはローリングコンボキーには望ましくないかもしれません。
96
97`モッドタップ割り込みの無視`を設定するには、両方のキーを `TAPPING_TERM` の間ホールドすると、(その修飾キーの)ホールド機能を実行する必要があります。
98
99例えば:
100
101- `SFT_T(KC_A)` を押す
102- `KC_X` を押す
103- `SFT_T(KC_A)` を放す
104- `KC_X` を放す
105
106通常、これは `X` (`SHIFT`+`x`) を送信します。`モッドタップ割り込みの無視` を有効にすると、ホールドアクションを登録するには、両方のキーを `TAPPING_TERM` の間ホールドする必要があります。この場合、素早いタップは `ax` を送信しますが、両方をホールドすると、`X` (`SHIFT`+`x`) を出力します。
107
108
109?> __注意__: これはモディファイアにのみ関係し、レイヤー切り替えキーには関係しません。
110
111?> `許容ホールド`を有効にすると、これは両方がどのように動作するかを変更します。通常のキーには、最初のキーが最初に放された場合、あるいは両方のキーが `TAPPING_TERM` より長くホールドされた場合に、修飾キーが追加されます。
112
113この機能をより細かく制御するために、以下を `config.h` に追加することができます:
114
115```c
116#define IGNORE_MOD_TAP_INTERRUPT_PER_KEY
117```
118
119そして、以下の関数をキーマップに追加します:
120
121```c
122bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record) {
123 switch (keycode) {
124 case SFT_T(KC_SPC):
125 return true;
126 default:
127 return false;
128 }
129}
130```
131
132## タッピング強制ホールド
133
134`タッピング強制ホールド` を有効にするには、以下を `config.h` に追加します:
135
136```c
137#define TAPPING_FORCE_HOLD
138```
139
140タップの後でユーザがキーをホールドすると、これは修飾キーをホールドするかわりにタップされたキーを繰り返します。これにより、タップされたキーのために自動繰り返しを使うことができます。
141
142例:
143
144- SFT_T(KC_A) を押す
145- SFT_T(KC_A) を放す
146- SFT_T(KC_A) を押す
147- タッピング時間より長く待ちます...
148- SFT_T(KC_A) を放す
149
150デフォルトの設定では、最初に放したときに `a` が送信され、2回目の押下で `a` が送信され、コンピュータに自動リピート機能を作動させることができます。
151
152`TAPPING_FORCE_HOLD` を使うと、2回目の押下は Shift として解釈され、それをタップして使った後ですぐに修飾キーとして使うことができます。
153
154!> `TAPPING_FORCE_HOLD` はタッピングトグル(`TT` レイヤーキーコード、ワンショットタッピングトグルなど)を使うものをすべて破壊します。
155
156この機能をより細かく制御するために、以下を `config.h` に追加することができます:
157
158```c
159#define TAPPING_FORCE_HOLD_PER_KEY
160```
161
162そして、以下の関数をキーマップに追加します:
163
164```c
165bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record) {
166 switch (keycode) {
167 case LT(1, KC_BSPC):
168 return true;
169 default:
170 return false;
171 }
172}
173```
174
175## レトロタッピング
176
177`レトロタッピング`を有効にするには、以下を `config.h` に追加してください:
178
179```c
180#define RETRO_TAPPING
181```
182
183他のキーを押さずにデュアルファンクションキーを押して放しても何も起こりません。レトロタッピングを有効にすると、他のキーを押さずにキーを放すと、元のキーコードがタッピング時間外であっても送信されます。
184
185例えば、他のキーを押すことなく `LT(2, KC_SPACE)` を押したり放したりしても何も起こりません。これを有効にすると、代わりに `KC_SPACE` を送信します。
186
187## キー別の関数にキーレコードを含めるのはなぜですか？
188
189「キー別」の関数全てにキーレコードを含んでいることに気付いたかもしれません。そしてなぜそうしたのか不思議に思っているかもしれません。
190
191まぁ、それは単純に本当にカスタマイズのためです。ただし、具体的には、それはキーボードの配線方法によって異なります。例えば、各行が実際にキーボードのマトリックスの1行を使っている場合、キーコード全体をチェックする代わりに、`if (record->event.row == 3)` を使うほうが簡単かもしれません。これは、ホームキー行でタップホールドタイプのキーを使っている人にとって特に便利です。そのため、通常のタイピングを妨げないように微調整することができるのではないでしょうか。
192
193## `*_kb` や `*_user` 関数が無いのはなぜですか？
194
195QMK にある他の多くの関数とは異なり、quantum あるいはキーボードレベルの関数を持つ必要はありません (または理由さえありません)。ここではユーザレベルの関数だけが有用なため、そのようにマークする必要はありません。
diff --git a/docs/ja/translating.md b/docs/ja/translating.md
new file mode 100644
index 000000000..f7a273308
--- /dev/null
+++ b/docs/ja/translating.md
@@ -0,0 +1,60 @@
1# QMK ドキュメントを翻訳する
2
3<!---
4 original document: 0.9.51:docs/translating.md
5 git diff 0.9.51 HEAD -- docs/translating.md | cat
6-->
7
8ルートフォルダ (`docs/`) にある全てのファイルは英語でなければなりません - 他の全ての言語は、ISO 639-1 言語コードと、それに続く`-`と関連する国コードのサブフォルダにある必要があります。[一般的なもののリストはここで見つかります](https://www.andiamo.co.uk/resources/iso-language-codes/)。このフォルダが存在しない場合、作成することができます。翻訳された各ファイルは英語バージョンと同じ名前でなければなりません。そうすることで、正常にフォールバックできます。
9
10`_summary.md` ファイルはこのフォルダの中に存在し、各ファイルへのリンクのリスト、翻訳された名前、言語フォルダに続くリンクが含まれている必要があります。
11
12```markdown
13 * [QMK简介](zh-cn/getting_started_introduction.md)
14```
15
16他の docs ページへの全てのリンクにも、言語のフォルダが前に付いている必要があります。もしリンクがページの特定の部分(例えば、特定の見出し)への場合、以下のように見出しに英語の ID を使う必要があります:
17
18```markdown
19[建立你的环境](zh-cn/newbs-getting-started.md#set-up-your-environment)
20
21## 建立你的环境 :id=set-up-your-environment
22```
23
24新しい言語の翻訳が完了したら、以下のファイルも修正する必要があります:
25
26* [`docs/_langs.md`](https://github.com/qmk/qmk_firmware/blob/master/docs/_langs.md)
27各行は、[GitHub emoji shortcode](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#country-flag) の形式で国フラグと、それに続く言語で表される名前を含む必要があります。
28
29 ```markdown
30 - [:cn: 中文](/zh-cn/)
31 ```
32
33* [`docs/index.html`](https://github.com/qmk/qmk_firmware/blob/master/docs/index.html)
34`placeholder` と `noData` の両方のオブジェクトは、文字列で言語フォルダの辞書エントリが必要です:
35
36 ```js
37 '/zh-cn/': '没有结果!',
38 ```
39
40 サイドバーの「QMK ファームウェア」の見出しリンクを設定するために、`nameLink` オブジェクトも以下のように追加される必要があります:
41
42 ```js
43 '/zh-cn/': '/#/zh-cn/',
44 ```
45
46 また、`fallbackLanguages` リストに言語フォルダを追加して、404 ではなく英語に適切にフォールバックするようにしてください:
47
48 ```js
49 fallbackLanguages: [
50 // ...
51 'zh-cn',
52 // ...
53 ],
54 ```
55
56## 翻訳のプレビュー
57
58ドキュメントのローカルインスタンスをセットアップする方法については、[ドキュメントのプレビュー](ja/contributing.md#previewing-the-documentation)を見てください - 右上の "Translations" メニューから新しい言語を選択することができるはずです。
59
60作業に満足したら、遠慮なくプルリクエストを開いてください！
diff --git a/docs/ja/understanding_qmk.md b/docs/ja/understanding_qmk.md
new file mode 100644
index 000000000..74b37398f
--- /dev/null
+++ b/docs/ja/understanding_qmk.md
@@ -0,0 +1,195 @@
1# QMK のコードの理解
2
3<!---
4 original document: 0.9.55:docs/understanding_qmk.md
5 git diff 0.9.55 HEAD -- docs/understanding_qmk.md | cat
6-->
7
8このドキュメントでは、QMK ファームウェアがどのように機能するかを非常に高いレベルから説明しようとしています。基本的なプログラミングの概念を理解していることを前提としていますが、(実例を示す必要がある場合を除き) C に精通していることを前提にはしていません。以下のドキュメントの基本的な知識があることを前提としています。
9
10* [入門](ja/getting_started_introduction.md)
11* [キーボードがどのように動作するか](ja/how_keyboards_work.md)
12* [FAQ](ja/faq.md)
13
14## スタートアップ
15
16QMK は他のコンピュータプログラムと何ら変わりないと考えることができます。開始され、タスクを実行し、そして終了します。プログラムのエントリーポイントは、他の C プログラムと同様に、`main()` 関数です。ただし、QMK を初めて触る人は、`main()` 関数が複数の場所に現れるため、混乱するかもしれません。また、どれを見ればよいか分かりにくいかもしれません。
17
18複数ある理由は、QMK は様々なプラットフォームをサポートするからです。最も一般的なプラットフォームは `lufa` です。これは atmega32u4 のような AVR プロセッサ上で実行されます。また、`chibios` および `vusb` もサポートします。
19
20ここでは AVR プロセッサに焦点を当てます。これは `lufa` プラットフォームを使います。`main()` 関数は [tmk_core/protocol/lufa/lufa.c](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/protocol/lufa/lufa.c#L1028) にあります。関数にざっと目を通すと、(ホストへの USB も含めて)設定された全てのハードウェアが初期化され、プログラムのコア部分が [`while(1)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/protocol/lufa/lufa.c#L1069) で開始されることが分かります。これが[メインループ](#the-main-loop)です。
21
22## メインループ
23
24コードのこの部分は、同じ命令セットを永久にループ処理するため、「メインループ」と呼ばれます。ここはキーボードに必要なことを実行させる関数を QMK が呼び出す場所です。一見、多くの機能を持つように見えるかもしれませんが、大抵の場合、コードは `#define` によって無効にされます。
25
26```
27 keyboard_task();
28```
29
30ここで、全てのキーボードの固有の機能が実行されます。`keyboard_task()` のソースコードは [tmk_core/common/keyboard.c](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/common/keyboard.c#L216) にあり、マトリックスの変化を検知し、LED の状態をオンオフする責任があります。
31
32`keyboard_task()` に以下を処理するコードがあります:
33
34* [マトリックスのスキャン](#matrix-scanning)
35* マウスの処理
36* シリアルリンク
37* ビジュアライザ
38* キーボードの状態の LED (Caps Lock, Num Lock, Scroll Lock)
39
40#### マトリックスのスキャン
41
42マトリックスのスキャンはキーボードファームウェアのコアの機能です。これは今どのキーが押されているかを検知するプロセスであり、キーボードはこの機能を1秒間に何度も何度も実行します。ファームウェアの CPU 時間の 99% はマトリックスのスキャンに費やされていると言っても過言ではありません。
43
44実際のマトリックスの検知には様々な方法がありますが、それはこのドキュメントの対象外です。マトリックスのスキャンをブラックボックスとして扱っても問題ありません。マトリックスの現在の状態を求めると、以下のようなデータ構造を取得します:
45
46
47```
48{
49 {0,0,0,0},
50 {0,0,0,0},
51 {0,0,0,0},
52 {0,0,0,0},
53 {0,0,0,0}
54}
55```
56
57これは 4行x5列のテンキー(訳注: 5行x4列の間違いと思われます)のマトリックスを表す直接的な表現のデータ構造です。キーが押されると、マトリックス内のそのキーの位置が、 `0` ではなく `1` として返されます。
58
59マトリックスのスキャンは1秒間に何度も実行されます。正確なレートは様々ですが、知覚できるような遅延を避けるために、秒間に少なくとも10回実行します。
60
61##### マトリックスから物理的なレイアウトへのマップ
62
63キーボード上の各スイッチの状態が分かると、それをキーコードへマップする必要があります。QMK ではキーコードへのマップは C マクロを使うことで行われ、C マクロにより物理的なレイアウトの定義はキーコードの定義から分離されています。(訳注：「キーコードの定義」は「キーコードのマトリクス配列による定義」と思われる)
64
65キーボードレベルで、キーボードのマトリックスを物理キーにマップする C マクロ (一般的には、`LAYOUT()` という名前)を定義します。マトリックスにスイッチがない場所がある場合、このマクロを使って KC_NO を事前に埋め込むことができ、キーマップの定義を扱いやすくすることができます。以下は、テンキー用の `LAYOUT()` マクロです:
66
67```c
68#define LAYOUT( \
69 k00, k01, k02, k03, \
70 k10, k11, k12, k13, \
71 k20, k21, k22, \
72 k30, k31, k32, k33, \
73 k40, k42 \
74) { \
75 { k00, k01, k02, k03, }, \
76 { k10, k11, k12, k13, }, \
77 { k20, k21, k22, KC_NO, }, \
78 { k30, k31, k32, k33, }, \
79 { k40, KC_NO, k42, KC_NO } \
80}
81```
82
83`LAYOUT()` マクロの2つ目のブロックが、上記のマトリックススキャン配列とどのように一致しているかに注目してください。このマクロはマトリックスのスキャン配列をキーコードにマップするものです。ただし、17キーのテンキーを見ると、マトリックスにはスイッチが置けるが、キーが大きいために実際にはスイッチが無い箇所が3つあることが分かります。これらのスペースに `KC_NO` を設定したので、キーマップ定義には必要ありません。
84
85このマクロを使って、少し変わったマトリックスのレイアウト、例えば [Clueboard rev 2](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/keyboards/clueboard/66/rev2/rev2.h) を扱うこともできます。その説明はこのドキュメントの範囲外です。
86
87##### キーコードの割り当て
88
89キーマップレべルでは、上記の `LAYOUT()` マクロを使って、物理的な場所からマトリックスの場所にマッピングします。以下のようになります:
90
91```
92const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
93[0] = LAYOUT(
94 KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS, \
95 KC_P7, KC_P8, KC_P9, KC_PPLS, \
96 KC_P4, KC_P5, KC_P6, \
97 KC_P1, KC_P2, KC_P3, KC_PENT, \
98 KC_P0, KC_PDOT)
99}
100```
101
102これら全ての引数が、前のセクションの `LAYOUT()` マクロの前半とどのように一致しているかについて注目してください。このようにして、キーコードを取得して、それを前述のマトリックススキャンにマップします。
103
104##### 状態変更の検知
105
106上記のマトリックススキャンはある時点のマトリックスの状態を伝えますが、コンピュータは変更のみを知りたいだけで、現在の状態を気にしません。QMK は最後のマトリックススキャンの結果を格納し、このマトリックスから結果を比較して、いつキーが押されたか放されたかを決定します。
107
108例を見てみましょう。キーボードスキャンループの途中に移動して、前のスキャンが以下のようになっていることがわかったとします:
109
110```
111{
112 {0,0,0,0},
113 {0,0,0,0},
114 {0,0,0,0},
115 {0,0,0,0},
116 {0,0,0,0}
117}
118```
119
120現在のスキャンが完了すると、以下のように見えるとします:
121
122```
123{
124 {1,0,0,0},
125 {0,0,0,0},
126 {0,0,0,0},
127 {0,0,0,0},
128 {0,0,0,0}
129}
130```
131
132キーマップと比較すると、押されたキーが KC_NLCK であることが分かります。ここから、`process_record` 関数群を呼び出します。
133
134<!-- FIXME: Magic happens between here and process_record -->
135
136##### Process Record
137
138`process_record()` 関数自体は一見簡単に見えますが、その内部は QMK の様々なレベルで機能を上書きするためのゲートウェイが隠されています。キーボード/キーマップレベルの機能について調べる必要があるときは、以下に列挙した一連のイベントを手引帳として使います。`rules.mk` またはほかの場所で設定されたオプションに応じて、最終的なファームウェアに以下の関数のサブセットのみが含まれます。
139
140* [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/common/action.c#L172)
141 * [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L206)
142 * [このレコードをキーコードにマップする](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L226)
143 * [`void velocikey_accelerate(void)`](https://github.com/qmk/qmk_firmware/blob/c1c5922aae7b60b7c7d13d3769350eed9dda17ab/quantum/velocikey.c#L27)
144 * [`void preprocess_tap_dance(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_tap_dance.c#L119)
145 * [`bool process_key_lock(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_key_lock.c#L62)
146 * [`bool process_clicky(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_clicky.c#L79)
147 * [`bool process_haptic(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/2cee371bf125a6ec541dd7c5a809573facc7c456/drivers/haptic/haptic.c#L216)
148 * [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/keyboards/clueboard/card/card.c#L20)
149 * [`bool process_record_user(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/keyboards/clueboard/card/keymaps/default/keymap.c#L58)
150 * [`bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/rgb_matrix.c#L139)
151 * [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_midi.c#L81)
152 * [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_audio.c#L19)
153 * [`bool process_steno(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_steno.c#L160)
154 * [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_music.c#L114)
155 * [`bool process_tap_dance(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_tap_dance.c#L141)
156 * [`bool process_unicode_common(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_unicode_common.c#L169) は、以下のいずれかを呼び出します:
157 * [`bool process_unicode(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_unicode.c#L20)
158 * [`bool process_unicodemap(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_unicodemap.c#L46)
159 * [`bool process_ucis(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_ucis.c#L95)
160 * [`bool process_leader(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_leader.c#L51)
161 * [`bool process_combo(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_combo.c#L115)
162 * [`bool process_printer(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_printer.c#L77)
163 * [`bool process_auto_shift(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_auto_shift.c#L94)
164 * [`bool process_terminal(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_terminal.c#L264)
165 * [Quantum 固有のキーコードを識別して処理する](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L291)
166
167この一連のイベントの中の任意のステップで (`process_record_kb()` のような)関数は `false` を返して、以降の処理を停止することができます。
168
169この呼び出しの後で、`post_process_record()` が呼ばれます。これはキーコードが通常処理された後に実行する必要がある追加のクリーンアップを処理するために使うことができます。
170
171* [`void post_process_record(keyrecord_t *record)`]()
172 * [`void post_process_record_quantum(keyrecord_t *record)`]()
173 * [このレコードをキーコードにマップする]()
174 * [`void post_process_clicky(uint16_t keycode, keyrecord_t *record)`]()
175 * [`void post_process_record_kb(uint16_t keycode, keyrecord_t *record)`]()
176 * [`void post_process_record_user(uint16_t keycode, keyrecord_t *record)`]()
177
178<!--
179#### Mouse Handling
180
181FIXME: This needs to be written
182
183#### Serial Link(s)
184
185FIXME: This needs to be written
186
187#### Visualizer
188
189FIXME: This needs to be written
190
191#### Keyboard state LEDs (Caps Lock, Num Lock, Scroll Lock)
192
193FIXME: This needs to be written
194
195-->
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-19 01:13:58 +0000