forked from mirrors/qmk_firmware
Deploying to gh-pages from master @ b7a346600c
🚀
This commit is contained in:
parent
b324126b16
commit
cae8a4d621
3 changed files with 88 additions and 78 deletions
|
@ -1,8 +1,8 @@
|
||||||
# QMK シラバス
|
# QMK シラバス
|
||||||
|
|
||||||
<!---
|
<!---
|
||||||
original document: 0.9.51:docs/syllabus.md
|
original document: 0.14.22:docs/syllabus.md
|
||||||
git diff 0.9.51 HEAD -- docs/syllabus.md | cat
|
git diff 0.14.22 HEAD -- docs/syllabus.md | cat
|
||||||
-->
|
-->
|
||||||
|
|
||||||
このページは最初に基本を紹介し、そして、QMK に習熟するために必要な全ての概念を理解するように導くことで、QMK の知識を構築するのに役立ちます。
|
このページは最初に基本を紹介し、そして、QMK に習熟するために必要な全ての概念を理解するように導くことで、QMK の知識を構築するのに役立ちます。
|
||||||
|
@ -45,6 +45,7 @@
|
||||||
* [タップダンス](ja/feature_tap_dance.md)
|
* [タップダンス](ja/feature_tap_dance.md)
|
||||||
* [コンボ](ja/feature_combo.md)
|
* [コンボ](ja/feature_combo.md)
|
||||||
* [ユーザスペース](ja/feature_userspace.md)
|
* [ユーザスペース](ja/feature_userspace.md)
|
||||||
|
* [キーオーバーライド](ja/feature_key_overrides.md)
|
||||||
|
|
||||||
# 上級トピック
|
# 上級トピック
|
||||||
|
|
||||||
|
@ -58,7 +59,7 @@
|
||||||
* **高度な機能**
|
* **高度な機能**
|
||||||
* [ユニコード](ja/feature_unicode.md)
|
* [ユニコード](ja/feature_unicode.md)
|
||||||
* [API](ja/api_overview.md)
|
* [API](ja/api_overview.md)
|
||||||
* [ブートマジック](ja/feature_bootmagic.md)
|
* [ブートマジックライト](ja/feature_bootmagic.md)
|
||||||
* **ハードウェア**
|
* **ハードウェア**
|
||||||
* [キーボードがどのように動作するか](ja/how_keyboards_work.md)
|
* [キーボードがどのように動作するか](ja/how_keyboards_work.md)
|
||||||
* [キーボードマトリックスの仕組み](ja/how_a_matrix_works.md)
|
* [キーボードマトリックスの仕組み](ja/how_a_matrix_works.md)
|
||||||
|
|
|
@ -1,15 +1,15 @@
|
||||||
# QMK のコードの理解
|
# QMK のコードの理解
|
||||||
|
|
||||||
<!---
|
<!---
|
||||||
original document: 0.13.15:docs/understanding_qmk.md
|
original document: 0.14.22:docs/understanding_qmk.md
|
||||||
git diff 0.13.15 HEAD -- docs/understanding_qmk.md | cat
|
git diff 0.14.22 HEAD -- docs/understanding_qmk.md | cat
|
||||||
-->
|
-->
|
||||||
|
|
||||||
このドキュメントでは、QMK ファームウェアがどのように機能するかを非常に高いレベルから説明しようとしています。基本的なプログラミングの概念を理解していることを前提としていますが、(実例を示す必要がある場合を除き) C に精通していることを前提にはしていません。以下のドキュメントの基本的な知識があることを前提としています。
|
このドキュメントでは、QMK ファームウェアがどのように機能するかを非常に高いレベルから説明しようとしています。基本的なプログラミングの概念を理解していることを前提としていますが、(実例を示す必要がある場合を除き) C に精通していることを前提にはしていません。以下のドキュメントの基本的な知識があることを前提としています。
|
||||||
|
|
||||||
* [入門](ja/getting_started_introduction.md)
|
* [入門](ja/getting_started_introduction.md)
|
||||||
* [キーボードがどのように動作するか](ja/how_keyboards_work.md)
|
* [キーボードがどのように動作するか](ja/how_keyboards_work.md)
|
||||||
* [FAQ](ja/faq.md)
|
* [FAQ](ja/faq_general.md)
|
||||||
|
|
||||||
## スタートアップ
|
## スタートアップ
|
||||||
|
|
||||||
|
@ -138,41 +138,42 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||||
`process_record()` 関数自体は一見簡単に見えますが、その内部は QMK の様々なレベルで機能を上書きするためのゲートウェイが隠されています。キーボード/キーマップレベルの機能について調べる必要があるときは、以下に列挙した一連のイベントを手引帳として使います。`rules.mk` またはほかの場所で設定されたオプションに応じて、最終的なファームウェアに以下の関数のサブセットのみが含まれます。
|
`process_record()` 関数自体は一見簡単に見えますが、その内部は QMK の様々なレベルで機能を上書きするためのゲートウェイが隠されています。キーボード/キーマップレベルの機能について調べる必要があるときは、以下に列挙した一連のイベントを手引帳として使います。`rules.mk` またはほかの場所で設定されたオプションに応じて、最終的なファームウェアに以下の関数のサブセットのみが含まれます。
|
||||||
|
|
||||||
* [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/common/action.c#L172)
|
* [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/common/action.c#L172)
|
||||||
* [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L206)
|
* [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L206)
|
||||||
* [このレコードをキーコードにマップする](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L226)
|
* [このレコードをキーコードにマップする](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L226)
|
||||||
* [`void velocikey_accelerate(void)`](https://github.com/qmk/qmk_firmware/blob/c1c5922aae7b60b7c7d13d3769350eed9dda17ab/quantum/velocikey.c#L27)
|
* [`void velocikey_accelerate(void)`](https://github.com/qmk/qmk_firmware/blob/c1c5922aae7b60b7c7d13d3769350eed9dda17ab/quantum/velocikey.c#L27)
|
||||||
* [`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)
|
* [`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)
|
||||||
* [`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)
|
* [`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)
|
||||||
* [`bool process_clicky(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_clicky.c#L79)
|
* [`bool process_clicky(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_clicky.c#L79)
|
||||||
* [`bool process_haptic(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/2cee371bf125a6ec541dd7c5a809573facc7c456/drivers/haptic/haptic.c#L216)
|
* [`bool process_haptic(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/2cee371bf125a6ec541dd7c5a809573facc7c456/drivers/haptic/haptic.c#L216)
|
||||||
* [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/keyboards/clueboard/card/card.c#L20)
|
* [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/keyboards/clueboard/card/card.c#L20)
|
||||||
* [`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)
|
* [`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)
|
||||||
* [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_midi.c#L81)
|
* [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_midi.c#L81)
|
||||||
* [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_audio.c#L19)
|
* [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_audio.c#L19)
|
||||||
* [`bool process_steno(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_steno.c#L160)
|
* [`bool process_steno(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_steno.c#L160)
|
||||||
* [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_music.c#L114)
|
* [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_music.c#L114)
|
||||||
* [`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)
|
* [`bool process_key_override(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/5a1b857dea45a17698f6baa7dd1b7a7ea907fb0a/quantum/process_keycode/process_key_override.c#L397)
|
||||||
* [`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) は、以下のいずれかを呼び出します:
|
* [`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)
|
||||||
* [`bool process_unicode(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_unicode.c#L20)
|
* [`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) は、以下のいずれかを呼び出します:
|
||||||
* [`bool process_unicodemap(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_unicodemap.c#L46)
|
* [`bool process_unicode(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_unicode.c#L20)
|
||||||
* [`bool process_ucis(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_ucis.c#L95)
|
* [`bool process_unicodemap(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_unicodemap.c#L46)
|
||||||
* [`bool process_leader(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_leader.c#L51)
|
* [`bool process_ucis(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_ucis.c#L95)
|
||||||
* [`bool process_combo(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_combo.c#L115)
|
* [`bool process_leader(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_leader.c#L51)
|
||||||
* [`bool process_printer(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_printer.c#L77)
|
* [`bool process_combo(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_combo.c#L115)
|
||||||
* [`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)
|
* [`bool process_printer(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_printer.c#L77)
|
||||||
* [`bool process_terminal(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_terminal.c#L264)
|
* [`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)
|
||||||
* [Quantum 固有のキーコードを識別して処理する](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L291)
|
* [`bool process_terminal(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/process_keycode/process_terminal.c#L264)
|
||||||
|
* [Quantum 固有のキーコードを識別して処理する](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/quantum/quantum.c#L291)
|
||||||
|
|
||||||
この一連のイベントの中の任意のステップで (`process_record_kb()` のような)関数は `false` を返して、以降の処理を停止することができます。
|
この一連のイベントの中の任意のステップで (`process_record_kb()` のような)関数は `false` を返して、以降の処理を停止することができます。
|
||||||
|
|
||||||
この呼び出しの後で、`post_process_record()` が呼ばれます。これはキーコードが通常処理された後に実行する必要がある追加のクリーンアップを処理するために使うことができます。
|
この呼び出しの後で、`post_process_record()` が呼ばれます。これはキーコードが通常処理された後に実行する必要がある追加のクリーンアップを処理するために使うことができます。
|
||||||
|
|
||||||
* [`void post_process_record(keyrecord_t *record)`]()
|
* [`void post_process_record(keyrecord_t *record)`]()
|
||||||
* [`void post_process_record_quantum(keyrecord_t *record)`]()
|
* [`void post_process_record_quantum(keyrecord_t *record)`]()
|
||||||
* [このレコードをキーコードにマップする]()
|
* [このレコードをキーコードにマップする]()
|
||||||
* [`void post_process_clicky(uint16_t keycode, keyrecord_t *record)`]()
|
* [`void post_process_clicky(uint16_t keycode, keyrecord_t *record)`]()
|
||||||
* [`void post_process_record_kb(uint16_t keycode, keyrecord_t *record)`]()
|
* [`void post_process_record_kb(uint16_t keycode, keyrecord_t *record)`]()
|
||||||
* [`void post_process_record_user(uint16_t keycode, keyrecord_t *record)`]()
|
* [`void post_process_record_user(uint16_t keycode, keyrecord_t *record)`]()
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
#### Mouse Handling
|
#### Mouse Handling
|
||||||
|
|
|
@ -9,33 +9,39 @@ You can create `info.json` files at every level under `qmk_firmware/keyboards/<n
|
||||||
The `info.json` file is a JSON formatted dictionary with the following keys available to be set. You do not have to set all of them, merely the keys that apply to your keyboard.
|
The `info.json` file is a JSON formatted dictionary with the following keys available to be set. You do not have to set all of them, merely the keys that apply to your keyboard.
|
||||||
|
|
||||||
* `keyboard_name`
|
* `keyboard_name`
|
||||||
* A free-form text string describing the keyboard.
|
* A free-form text string describing the keyboard.
|
||||||
* Example: `Clueboard 66%`
|
* Example: `Clueboard 66%`
|
||||||
|
* `manufacturer`
|
||||||
|
* A free-form text string describing the keyboard's manufacturer.
|
||||||
|
* Example: `Clueboard`
|
||||||
* `url`
|
* `url`
|
||||||
* A URL to the keyboard's product page, [QMK.fm/keyboards](https://qmk.fm/keyboards) page, or other page describing information about the keyboard.
|
* A URL to the keyboard's product page, [QMK.fm/keyboards](https://qmk.fm/keyboards) page, or other page describing information about the keyboard.
|
||||||
|
* Example: `https://clueboard.co`
|
||||||
* `maintainer`
|
* `maintainer`
|
||||||
* GitHub username of the maintainer, or `qmk` for community maintained boards
|
* GitHub username of the maintainer, or `qmk` for community maintained boards.
|
||||||
|
* Example: `skullydazed`
|
||||||
* `debounce`
|
* `debounce`
|
||||||
* How many milliseconds (ms) to wait for debounce to happen. (Default: 5)
|
* The amount of time in milliseconds to wait for debounce to happen.
|
||||||
|
* Default: `5`
|
||||||
* `diode_direction`
|
* `diode_direction`
|
||||||
* The direction diodes face. See [`DIRECT_PINS` in the hardware configuration](https://docs.qmk.fm/#/config_options?id=hardware-options) for more details.
|
* The direction diodes face. See [`DIRECT_PINS` in the hardware configuration](https://docs.qmk.fm/#/config_options?id=hardware-options) for more details.
|
||||||
* `layout_aliases`
|
* `layout_aliases`
|
||||||
* A dictionary containing layout aliases. The key is the alias and the value is a layout in `layouts` it maps to.
|
* A dictionary containing layout aliases. The key is the alias and the value is a layout in `layouts` it maps to.
|
||||||
* `layouts`
|
* `layouts`
|
||||||
* Physical Layout representations. See the [Layout Format](#layout_format) section for more detail.
|
* Physical Layout representations. See the [Layout Format](#layout_format) section for more detail.
|
||||||
* `matrix_pins`
|
* `matrix_pins`
|
||||||
* Configure the pins corresponding to columns and rows, or direct pins. See [Matrix Pins](#matrix_pins) for more detail.
|
* Configure the pins corresponding to columns and rows, or direct pins. See the [Matrix Pins](#matrix_pins) section for more detail.
|
||||||
* `rgblight`
|
* `rgblight`
|
||||||
* Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb_lighting) section for more detail.
|
* Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb_lighting) section for more detail.
|
||||||
* `usb`
|
* `usb`
|
||||||
* Configure USB VID, PID, and other parameters. See [USB](#USB) for more detail.
|
* Configure USB VID, PID, and other parameters. See the [USB](#USB) section for more detail.
|
||||||
|
|
||||||
### Layout Format
|
### Layout Format
|
||||||
|
|
||||||
Within our `info.json` file the `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout macros, for example `LAYOUT_ansi` or `LAYOUT_iso`.
|
Within our `info.json` file the `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout macros, for example `LAYOUT_ansi` or `LAYOUT_iso`.
|
||||||
|
|
||||||
* `layout`
|
* `layout`
|
||||||
* A list of Key Dictionaries describing the physical layout. See the next section for more details.
|
* A list of Key Dictionaries describing the physical layout. See the next section for more details.
|
||||||
|
|
||||||
### Key Dictionary Format
|
### Key Dictionary Format
|
||||||
|
|
||||||
|
@ -44,18 +50,20 @@ Each Key Dictionary in a layout describes the physical properties of a key. If y
|
||||||
All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
|
All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
|
||||||
|
|
||||||
* `x`
|
* `x`
|
||||||
* **Required**: The absolute position of the key in the horizontal axis, in Key Units.
|
* **Required**. The absolute position of the key in the horizontal axis, in Key Units.
|
||||||
* `y`
|
* `y`
|
||||||
* **Required**: The absolute position of the key in the vertical axis, in Key Units.
|
* **Required**. The absolute position of the key in the vertical axis, in Key Units.
|
||||||
* `w`
|
* `w`
|
||||||
* The width of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
|
* The width of the key, in Key Units.
|
||||||
|
* Default: `1`
|
||||||
* `h`
|
* `h`
|
||||||
* The height of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
|
* The height of the key, in Key Units.
|
||||||
|
* Default: `1`
|
||||||
* `label`
|
* `label`
|
||||||
* What to name this position in the matrix.
|
* What to name this position in the matrix. This should usually correspond to the keycode for the first layer of the default keymap.
|
||||||
* This should usually correspond to the keycode for the first layer of the default keymap.
|
|
||||||
* `matrix`
|
* `matrix`
|
||||||
* A 2 item list describing the row and column location for this key.
|
* A two item list describing the row and column location for this key.
|
||||||
|
* Example: `[0, 4]`
|
||||||
|
|
||||||
### Matrix Pins
|
### Matrix Pins
|
||||||
|
|
||||||
|
@ -69,11 +77,11 @@ Example:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"diode_direction": "COL2ROW",
|
"diode_direction": "COL2ROW",
|
||||||
"matrix_pins": {
|
"matrix_pins": {
|
||||||
"cols": ["F4", "E6", "B1", "D2"],
|
"cols": ["F4", "E6", "B1", "D2"],
|
||||||
"rows": ["B0", "D3", "D5", "D4", "D6"]
|
"rows": ["B0", "D3", "D5", "D4", "D6"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -144,23 +152,23 @@ Example:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### RGB Light Animations
|
#### RGBLight Animations
|
||||||
|
|
||||||
The following animations can be enabled:
|
The following animations can be enabled:
|
||||||
|
|
||||||
| Key | Description |
|
|Key |Description |
|
||||||
|-----|-------------|
|
|-----------------|--------------------------------------|
|
||||||
| `all` | Enable all additional animation modes. |
|
|`all` |Enable all additional animation modes.|
|
||||||
| `alternating` | Enable alternating animation mode. |
|
|`alternating` |Enable alternating animation mode. |
|
||||||
| `breathing` | Enable breathing animation mode. |
|
|`breathing` |Enable breathing animation mode. |
|
||||||
| `christmas` | Enable christmas animation mode. |
|
|`christmas` |Enable christmas animation mode. |
|
||||||
| `knight` | Enable knight animation mode. |
|
|`knight` |Enable knight animation mode. |
|
||||||
| `rainbow_mood` | Enable rainbow mood animation mode. |
|
|`rainbow_mood` |Enable rainbow mood animation mode. |
|
||||||
| `rainbow_swirl` | Enable rainbow swirl animation mode. |
|
|`rainbow_swirl` |Enable rainbow swirl animation mode. |
|
||||||
| `rgb_test` | Enable RGB test animation mode. |
|
|`rgb_test` |Enable RGB test animation mode. |
|
||||||
| `snake` | Enable snake animation mode. |
|
|`snake` |Enable snake animation mode. |
|
||||||
| `static_gradient` | Enable static gradient mode. |
|
|`static_gradient`|Enable static gradient mode. |
|
||||||
| `twinkle` | Enable twinkle animation mode. |
|
|`twinkle` |Enable twinkle animation mode. |
|
||||||
|
|
||||||
### USB
|
### USB
|
||||||
|
|
||||||
|
@ -170,10 +178,10 @@ Example:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"usb": {
|
"usb": {
|
||||||
"vid": "0xC1ED",
|
"vid": "0xC1ED",
|
||||||
"pid": "0x23B0",
|
"pid": "0x23B0",
|
||||||
"device_ver": "0x0001"
|
"device_ver": "0x0001"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in a new issue