diff options
Diffstat (limited to 'docs/ja')
| -rw-r--r-- | docs/ja/feature_command.md | 56 | ||||
| -rw-r--r-- | docs/ja/feature_dynamic_macros.md | 71 | ||||
| -rw-r--r-- | docs/ja/feature_encoders.md | 81 | ||||
| -rw-r--r-- | docs/ja/feature_grave_esc.md | 37 | ||||
| -rw-r--r-- | docs/ja/feature_hd44780.md | 62 |
5 files changed, 307 insertions, 0 deletions
diff --git a/docs/ja/feature_command.md b/docs/ja/feature_command.md new file mode 100644 index 0000000000..f8b7e89294 --- /dev/null +++ b/docs/ja/feature_command.md @@ -0,0 +1,56 @@ +# コマンド + +<!--- + original document: 0.8.94:docs/feature_command.md + git diff 0.8.94 HEAD -- docs/feature_command.md | cat +--> + +コマンド(旧称:マジック)は、ファームウェアを書き込んだり、[ブートマジック](ja/feature_bootmagic.md)を使うためにプラグを抜いたりすることなくキーボードの挙動を変更する方法です。この機能と[ブートマジックキーコード](feature_bootmagic.md#keycodes)には多くの重複があります。可能な限り、コマンドでは無くブートマジックキーコードの機能を使うことをお勧めします。 + +一部のキーボードではコマンドがデフォルトで無効になっています。その場合、`rules.mk` 内で明示的に有効にする必要があります: + +```make +COMMAND_ENABLE = yes +``` + +## 使用法 + +コマンドを使うには、`IS_COMMAND()` マクロで定義されたキーの組み合わせを押し続けます。デフォルトでは、これは「左Shift + 右Shift」です。次に、目的のコマンドに対応するキーを押します。例えば、現在の QMK バージョンを QMK Toolbox コンソールに出力するには、「左Shift + 右Shift + `V`」を押します。 + +## 設定 + +コマンドのためのキーの割り当てを変更したい場合は、キーボードあるいはキーマップレベルのどちらかで、`config.h` にこれらを `#define` します。ここで割り当てる全てのキーコードは `KC_` 接頭辞を省略する必要があります。 + +| 定義 | デフォルト | 説明 | +|------------------------------------|--------------------------------|------------------------------------------------| +| `IS_COMMAND()` | `(get_mods() == MOD_MASK_SHIFT)` | コマンドをアクティブにするキーの組み合わせ | +| `MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` | `true` | ファンクション行を使ってデフォルトレイヤーを設定 | +| `MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` | `true` | 数字キーでデフォルトレイヤーを設定 | +| `MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM` | `false` | `MAGIC_KEY_LAYER0..9` を使ってデフォルトレイヤーを設定 | +| `MAGIC_KEY_DEBUG` | `D` | シリアルを介するデバッグの切り替え | +| `MAGIC_KEY_DEBUG_MATRIX` | `X` | キーマトリックスのデバッグの切り替え | +| `MAGIC_KEY_DEBUG_KBD` | `K` | キーボードのデバッグの切り替え | +| `MAGIC_KEY_DEBUG_MOUSE` | `M` | マウスのデバッグの切り替え | +| `MAGIC_KEY_CONSOLE` | `C` | コマンドコンソールを有効にする | +| `MAGIC_KEY_VERSION` | `V` | コンソールに実行中の QMK バージョンを出力 | +| `MAGIC_KEY_STATUS` | `S` | コンソールに現在のキーボードの状態を出力 | +| `MAGIC_KEY_HELP` | `H` | コンソールにコマンドのヘルプを出力 | +| `MAGIC_KEY_HELP_ALT` | `SLASH` | コンソールにコマンドのヘルプを出力 (代替) | +| `MAGIC_KEY_LAYER0` | `0` | レイヤー 0 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER0_ALT` | `GRAVE` | レイヤー 0 をデフォルトレイヤーにする (代替) | +| `MAGIC_KEY_LAYER1` | `1` | レイヤー 1 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER2` | `2` | レイヤー 2 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER3` | `3` | レイヤー 3 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER4` | `4` | レイヤー 4 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER5` | `5` | レイヤー 5 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER6` | `6` | レイヤー 6 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER7` | `7` | レイヤー 7 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER8` | `8` | レイヤー 8 をデフォルトレイヤーにする | +| `MAGIC_KEY_LAYER9` | `9` | レイヤー 9 をデフォルトレイヤーにする | +| `MAGIC_KEY_BOOTLOADER` | `B` | ブートローダにジャンプする | +| `MAGIC_KEY_BOOTLOADER_ALT` | `ESC` | ブートローダにジャンプする (代替) | +| `MAGIC_KEY_LOCK` | `CAPS` | 何も入力できないようにキーボードをロック | +| `MAGIC_KEY_EEPROM` | `E` | 保存された EEPROM 設定をコンソールに出力 | +| `MAGIC_KEY_EEPROM_CLEAR` | `BSPACE` | EEPROM をクリア | +| `MAGIC_KEY_NKRO` | `N` | N キーロールオーバー (NKRO) の有効・無効を切り替え | +| `MAGIC_KEY_SLEEP_LED` | `Z` | コンピュータがスリープの時に LED を切り替え | diff --git a/docs/ja/feature_dynamic_macros.md b/docs/ja/feature_dynamic_macros.md new file mode 100644 index 0000000000..ab8ec37137 --- /dev/null +++ b/docs/ja/feature_dynamic_macros.md @@ -0,0 +1,71 @@ +# 動的マクロ: ランタイムでのマクロの記録および再生 + +<!--- + original document: 0.8.123:docs/feature_dynamic_macros.md + git diff 0.8.123 HEAD -- docs/feature_dynamic_macros.md | cat +--> + +QMK はその場で作られた一時的なマクロをサポートします。これらを動的マクロと呼びます。それらはユーザがキーボードから定義し、キーボードのプラグを抜くか再起動すると失われます。 + +1つまたは2つのマクロに合計128のキー押下を保存できます。RAM をより多く使用してサイズを増やすことができます。 + +有効にするには、最初に `rules.mk` に `DYNAMIC_MACRO_ENABLE = yes` を記述します。そして、以下のキーをキーマップに追加します: + +| キー | Alias | 説明 | +|------------------|----------|---------------------------------------------------| +| `DYN_REC_START1` | `DM_REC1` | マクロ 1 の記録を開始します | +| `DYN_REC_START2` | `DM_REC2` | マクロ 2 の記録を開始します | +| `DYN_MACRO_PLAY1` | `DM_PLY1` | マクロ 1 を再生します | +| `DYN_MACRO_PLAY2` | `DM_PLY2` | マクロ 2 を再生します | +| `DYN_REC_STOP` | `DM_RSTP` | 現在記録中のマクロの記録を終了します。 | + +これが必要な全てです。 + +マクロの記録を開始するには、`DYN_REC_START1` または `DYN_REC_START2` のどちらかを押します。 + +記録を終了するには、`DYN_REC_STOP` レイヤーボタンを押します。 + +マクロを再生するには、`DYN_MACRO_PLAY1` あるいは `DYN_MACRO_PLAY2` のどちらかを押します。 + +マクロの一部としてマクロを再生することができます。マクロ 1 を記録中にマクロ 2 を再生、またはその逆も問題ありません。ただし、再帰的なマクロ、つまりマクロ 1 を再生するマクロ 1 は作成しないでください。もしそうしてキーボードが反応しなくなった場合は、キーボードを取り外し再び接続します。これを完全に無効にするには、`config.h` ファイルで `DYNAMIC_MACRO_NO_NESTING` を定義します。 + +?> 動的マクロの内部の詳細については、`process_dynamic_macro.h` および `process_dynamic_macro.c` ファイルのコメントを読んでください。 + +## カスタマイズ + +ある程度のカスタマイズを可能にするオプションがいくつか追加されています。 + +| 定義 | デフォルト | 説明 | +|----------------------------|----------------|-----------------------------------------------------------------------------------------------------------------| +| `DYNAMIC_MACRO_SIZE` | 128 | 動的マクロが使用できるメモリ量を設定します。これは限られたリソースであり、コントローラに依存します。 | +| `DYNAMIC_MACRO_USER_CALL` | *定義なし* | これを定義すると、ユーザの `keymap.c` ファイルを使ってマクロが起動されます。 | +| `DYNAMIC_MACRO_NO_NESTING` | *定義なし* | これを定義すると、別のマクロからマクロを呼び出す(入れ子になったマクロ)機能を無効にします。 | + + +記録中にキーを押すたびに LED が点滅し始めた場合は、マクロバッファにマクロを入れるスペースがもう無いことを意味します。マクロを入れるには、他のマクロ(それらは同じバッファを共有します)を短くするか、`config.h` に `DYNAMIC_MACRO_SIZE` 定義を追加することでバッファを増やします(デフォルト値: 128; ヘッダ内のコメントを読んでください)。 + + +### DYNAMIC_MACRO_USER_CALL + +以前のバージョンの動的マクロをお使いの方へ: 専用の `DYN_REC_STOP` キーを使わずに動的マクロキーへのアクセスに使われるレイヤーモディファイアのみを使って、マクロの記録を終了することもまだ可能です。この動作に戻したい場合は、`#define DYNAMIC_MACRO_USER_CALL` を `config.h` に追加し、以下のスニペットを `process_record_user()` 関数の先頭に記述します: + +```c + uint16_t macro_kc = (keycode == MO(_DYN) ? DYN_REC_STOP : keycode); + + if (!process_record_dynamic_macro(macro_kc, record)) { + return false; + } +``` + +### ユーザフック + +カスタム機能とフィードバックオプションを動的マクロ機能に追加するために使うことができるフックが幾つかあります。これによりある程度のカスタマイズが可能になります。 + +direction がどのマクロであるかを示すことに注意してください。`1` がマクロ 1、`-1` がマクロ 2、0 がマクロ無しです。 + +* `dynamic_macro_record_start_user(void)` - マクロの記録を開始する時に起動されます。 +* `dynamic_macro_play_user(int8_t direction)` - マクロを再生する時に起動されます。 +* `dynamic_macro_record_key_user(int8_t direction, keyrecord_t *record)` - マクロの記録中に各キー押下で起動されます。 +* `dynamic_macro_record_end_user(int8_t direction)` - マクロの記録を停止した時に起動されます。 + +さらに、動的マクロ機能が有効な場合にバックライトを点滅させるために `dynamic_macro_led_blink()` を呼び出すことができます。 diff --git a/docs/ja/feature_encoders.md b/docs/ja/feature_encoders.md new file mode 100644 index 0000000000..7f8922652d --- /dev/null +++ b/docs/ja/feature_encoders.md @@ -0,0 +1,81 @@ +# エンコーダ + +<!--- + original document: 0.8.123:docs/feature_encoders.md + git diff 0.8.123 HEAD -- docs/feature_encoders.md | cat +--> + +以下を `rules.mk` に追加することで基本的なエンコーダがサポートされます: + +```make +ENCODER_ENABLE = yes +``` + +さらに、以下を `config.h` に追加します: + +```c +#define ENCODERS_PAD_A { B12 } +#define ENCODERS_PAD_B { B13 } +``` + +各 PAD_A/B 変数は配列を定義するため、複数のエンコーダを定義することができます。例えば: + +```c +#define ENCODERS_PAD_A { encoder1a, encoder2a } +#define ENCODERS_PAD_B { encoder1b, encoder2b } +``` + +エンコーダの時計回りの方向が間違っている場合は、A と B のパッド定義を交換することができます。define を使って逆にすることもできます: + +```c +#define ENCODER_DIRECTION_FLIP +``` + +さらに、解像度を同じファイルで指定することができます (デフォルトかつお勧めは4): + +```c +#define ENCODER_RESOLUTION 4 +``` + +## 分割キーボード + +分割キーボードのそれぞれの側のエンコーダに異なるピン配列を使っている場合、右側のピン配列を以下のように定義することができます: + +```c +#define ENCODERS_PAD_A_RIGHT { encoder1a, encoder2a } +#define ENCODERS_PAD_B_RIGHT { encoder1b, encoder2b } +``` + +## コールバック + +コールバック関数を `<keyboard>.c` に記述することができます: + +```c +void encoder_update_kb(uint8_t index, bool clockwise) { + encoder_update_user(index, clockwise); +} +``` + +あるいは `keymap.c` に記述することもできます: + +```c +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { /* First encoder */ + if (clockwise) { + tap_code(KC_PGDN); + } else { + tap_code(KC_PGUP); + } + } else if (index == 1) { /* Second encoder */ + if (clockwise) { + tap_code(KC_DOWN); + } else { + tap_code(KC_UP); + } + } +} +``` + +## ハードウェア + +エンコーダの A と B の線は MCU に直接配線し、C/common 線はグランドに配線する必要があります。 diff --git a/docs/ja/feature_grave_esc.md b/docs/ja/feature_grave_esc.md new file mode 100644 index 0000000000..8c6680d74d --- /dev/null +++ b/docs/ja/feature_grave_esc.md @@ -0,0 +1,37 @@ +# グレイブエスケープ + +<!--- + original document: 0.8.123:docs/feature_grave_esc.md + git diff 0.8.123 HEAD -- docs/feature_grave_esc.md | cat +--> + +60% キーボード、またはファンクションキー行の無い他のレイアウトを使っている場合、専用の Escape キーが無いことに気付くでしょう。グレイブエスケープは grave キー (<code>`</code> および `~`) を Escape と共有することができる機能です。 + +## 使用法 + +キーマップ内の `KC_GRAVE` キー (通常は`1` キーの左)を `KC_GESC` に置き換えます。ほとんどの場合、このキーは押された時に `KC_ESC` を出力します。ただし、Shift あるいは GUI を押したままにすると、代わりに `KC_GRV` を出力します。 + +## OS に見えるもの + +メアリーがキーボードで GESC を押すと、OS には KC_ESC 文字が見えます。メアリーが Shift を押しながら GESC を押すと、`~` または Shift された時はバッククォートを出力します。彼女が GUI/CMD/WIN を押したままにすると、1つの <code>`</code> 文字を出力します。 + +## キーコード + +| キー | エイリアス | 説明 | +|---------|-----------|------------------------------------------------------------------| +| `KC_GESC` | `GRAVE_ESC` | 押された場合に Escape。Shift あるいは GUI が押されたままの場合は <code>`</code> | + +### 注意事項 + +macOS では、Command+<code>`</code> はデフォルトで "次のウィンドウを操作対象にする" にマップされます。つまりバッククォートを出力しません。さらに、ショートカットがキーボード環境設定で変更された場合でも、ターミナルは常にこのショートカットを認識してウィンドウを切り替えます。 + +## 設定 + +グレイブエスケープが壊す可能性のあるキーの組み合わせが幾つかあります。その中には、Windows では Control+Shift+Escape、macOSでは Command+Option+Escape があります。これを回避するには、`config.h` で以下のオプションを `#define` することができます: + +| 定義 | 説明 | +|--------------------------|-----------------------------------------| +| `GRAVE_ESC_ALT_OVERRIDE` | Alt が押された場合、常に Escape を送信する | +| `GRAVE_ESC_CTRL_OVERRIDE` | Control が押された場合、常に Escape を送信する | +| `GRAVE_ESC_GUI_OVERRIDE` | GUI が押された場合、常に Escape を送信する | +| `GRAVE_ESC_SHIFT_OVERRIDE` | Shift が押された場合、常に Escape を送信する | diff --git a/docs/ja/feature_hd44780.md b/docs/ja/feature_hd44780.md new file mode 100644 index 0000000000..5258632536 --- /dev/null +++ b/docs/ja/feature_hd44780.md @@ -0,0 +1,62 @@ +# HD44780 LCD ディスプレイ + +<!--- + original document: 0.8.123:docs/feature_hd44780.md + git diff 0.8.123 HEAD -- docs/feature_hd44780.md | cat +--> + +これは Peter Fleury の LCD ライブラリの統合です。このページは基本について説明します。[詳細なドキュメントについてはこのページをご覧ください](http://homepage.hispeed.ch/peterfleury/doxygen/avr-gcc-libraries/group__pfleury__lcd.html) (訳注）原文のリンク先のページは、サービスの終了に伴って削除されています。移行先は (http://www.peterfleury.epizy.com/doxygen/avr-gcc-libraries/group__pfleury__lcd.html) と思われます。 + +HD44780 ディスプレイのサポートを有効にするには、キーボードの `rules.mk` の `HD44780_ENABLE` フラグを yes に設定します。 + +## 設定 + +ディスプレイで使用されるピンとディスプレイの行と列の数を、キーボードの `config.h` に設定する必要があります。 + + +HD44780 のラベルが付いたセクションのコメントを外し、必要に応じてパラメータを変更します。 +```` +/* + * HD44780 LCD ディスプレイ設定 + */ + +#define LCD_LINES 2 //< ディスプレイの表示行数 +#define LCD_DISP_LENGTH 16 //< ディスプレイの行ごとの表示文字数 +#define LCD_IO_MODE 1 //< 0: メモリマップモード 1: IO ポートモード +#if LCD_IO_MODE +#define LCD_PORT PORTB //< LCD 行のためのポート +#define LCD_DATA0_PORT LCD_PORT //< 4ビットデータビット 0 のポート +#define LCD_DATA1_PORT LCD_PORT //< 4ビットデータビット 1 のポート +#define LCD_DATA2_PORT LCD_PORT //< 4ビットデータビット 2 のポート +#define LCD_DATA3_PORT LCD_PORT //< 4ビットデータビット 3 のポート +#define LCD_DATA0_PIN 4 //< 4ビットデータビット 0 のピン +#define LCD_DATA1_PIN 5 //< 4ビットデータビット 1 のピン +#define LCD_DATA2_PIN 6 //< 4ビットデータビット 2 のピン +#define LCD_DATA3_PIN 7 //< 4ビットデータビット 3 のピン +#define LCD_RS_PORT LCD_PORT //< RS 線のためのポート +#define LCD_RS_PIN 3 //< RS 線のためのピン +#define LCD_RW_PORT LCD_PORT //< RW 線のためのポート +#define LCD_RW_PIN 2 //< RW 線のためのピン +#define LCD_E_PORT LCD_PORT //< Enable 線のためのポート +#define LCD_E_PIN 1 //< Enable 線のためのピン +#endif +```` + +他のプロパティを設定する必要がある場合は、それらを `quantum/hd44780.h` からコピーし、`config.h` に設定することができます。（訳注）`quantum/hd44780.h` は `drivers/avr/hd44780.h` の間違いではないかと思われます。 + +## 使用法 + +ディスプレイを初期化するには、以下のパラメータのうちの1つを使って `lcd_init()` を呼び出します: +```` +LCD_DISP_OFF : ディスプレイオフ +LCD_DISP_ON : ディスプレイオン、カーソルオフ +LCD_DISP_ON_CURSOR : ディスプレイオン、カーソルオン +LCD_DISP_ON_CURSOR_BLINK : ディスプレイオン、点滅カーソル +```` +これはキーボードの `matrix_init_kb` またはキーマップの `matrix_init_user` で行うのが最適です。 +使用前にディスプレイをクリアすることをお勧めします。 +そのためには、`lcd_clrsrc()` を呼びます。 + +ディスプレイに何かを表示するには、最初に `lcd_gotoxy(column, line)` を呼びます。最初の行の先頭に移動するには、`lcd_gotoxy(0, 0)` を呼び出し、その後 `lcd_puts("example string")` を使って文字列を出力します。 + +ディスプレイを制御することができる、より多くのメソッドがあります。[詳細なドキュメントについてはリンクされたページをご覧ください](http://homepage.hispeed.ch/peterfleury/doxygen/avr-gcc-libraries/group__pfleury__lcd.html) (訳注）原文のリンク先のページは、サービスの終了に伴って削除されています。移行先は (http://www.peterfleury.epizy.com/doxygen/avr-gcc-libraries/group__pfleury__lcd.html) と思われます。 |