diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/breaking_changes.md | 14 | ||||
| -rw-r--r-- | docs/ja/feature_haptic_feedback.md | 19 | ||||
| -rw-r--r-- | docs/ja/hardware_keyboard_guidelines.md | 23 | ||||
| -rw-r--r-- | docs/ja/tap_hold.md | 30 |
4 files changed, 67 insertions, 19 deletions
diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md index 2ad8b5a14d..a1a56bd457 100644 --- a/docs/breaking_changes.md +++ b/docs/breaking_changes.md @@ -56,7 +56,7 @@ This happens immediately after the previous `develop` branch is merged. * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'` * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>` * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing - * [ ] `git push origin develop` + * [ ] `git push upstream develop` * [ ] `git push --tags` ## 4 Weeks Before Merge @@ -86,17 +86,21 @@ This happens immediately after the previous `develop` branch is merged. * `qmk_firmware` git commands * [ ] `git checkout develop` * [ ] `git pull --ff-only` - * [ ] `git rebase origin/master` * [ ] Edit `readme.md` * [ ] Remove the notes about `develop` * [ ] Roll up the ChangeLog into one file. * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'` - * [ ] `git push origin develop` + * [ ] `git push upstream develop` * GitHub Actions * [ ] Create a PR for `develop` * [ ] Make sure travis comes back clean - * [ ] Merge `develop` PR + * [ ] **Turn off 'Automatically delete head branches' for the repository** -- confirm with @qmk/directors that it is done before continuing +* `qmk_firmware` git commands + * [ ] `git checkout master` + * [ ] `git pull --ff-only` + * [ ] `git merge --no-ff develop` + * [ ] `git push upstream master` ## Post-merge operations -* (Optional) [update ChibiOS + ChibiOS-Contrib on `develop`](chibios_upgrade_instructions.md)
\ No newline at end of file +* (Optional) [update ChibiOS + ChibiOS-Contrib on `develop`](chibios_upgrade_instructions.md) diff --git a/docs/ja/feature_haptic_feedback.md b/docs/ja/feature_haptic_feedback.md index b9b4267014..1580797253 100644 --- a/docs/ja/feature_haptic_feedback.md +++ b/docs/ja/feature_haptic_feedback.md @@ -1,8 +1,8 @@ # 触覚フィードバック <!--- - original document: 0.8.123:docs/feature_haptic_feedback.md - git diff 0.8.123 HEAD -- docs/feature_haptic_feedback.md | cat + original document: 0.12.41:docs/feature_haptic_feedback.md + git diff 0.12.41 HEAD -- docs/feature_haptic_feedback.md | cat --> ## 触覚フィードバック の rules.mk オプション @@ -31,7 +31,7 @@ | `HPT_TOG` | 触覚フィードバックのオン/オフを切り替え | | `HPT_RST` | 触覚フィードバック設定をデフォルトに戻す | | `HPT_FBK` | キー押下またはリリースまたはその両方でフィードバックを切り替え | -| `HPT_BUZ` | ソレノイドの振動のオン/オフを切り替え | +| `HPT_BUZ` | ソレノイドのブザー音のオン/オフを切り替え | | `HPT_MODI` | 次の DRV2605L 波形に移動 | | `HPT_MODD` | 前の DRV2605L 波形に移動 | | `HPT_CONT` | 連続触覚モードのオン/オフを切り替え | @@ -44,7 +44,7 @@ ほとんどの MCU はソレノイドのコイルを駆動するために必要な電流を供給できないため、最初に MOSFET を介してソレノイドを駆動する回路を構築する必要があります。 -[Adafruit が提供する配線図](https://playground.arduino.cc/uploads/Learning/solenoid_driver.pdf) +[Adafruit が提供する配線図](https://cdn-shop.adafruit.com/product-files/412/412_solenoid_driver.pdf) | 設定 | デフォルト | 説明 | @@ -53,8 +53,15 @@ | `SOLENOID_DEFAULT_DWELL` | `12` ms | ソレノイドのデフォルトの滞留時間を設定する。 | | `SOLENOID_MIN_DWELL` | `4` ms | 滞留時間の下限を設定する。 | | `SOLENOID_MAX_DWELL` | `100` ms | 滞留時間の上限を設定する。 | - -?> 滞留時間とは、「プランジャー」が作動したままになる時間です。滞留時間により、ソレノイドの音が変わります。 +| `SOLENOID_DWELL_STEP_SIZE` | `1` ms | `HPT_DWL*` キーコードが送信される時に使われるステップサイズ | +| `SOLENOID_DEFAULT_BUZZ` | `0` (無効) | HPT_RST では、この値が "1" の場合、ブザー音が "on" に設定されます | +| `SOLENOID_BUZZ_ACTUATED` | `SOLENOID_MIN_DWELL` | ソレノイドがブザー音モードの場合の動作時間 | +| `SOLENOID_BUZZ_NONACTUATED` | `SOLENOID_MIN_DWELL` | ソレノイドがブザー音モードの場合の非動作時間 | + +* ソレノイドのブザー音がオフの場合、滞留時間は「プランジャー」が作動したままになる時間です。滞留時間により、ソレノイドの音が変わります。 +* ソレノイドのブザー音がオンの場合、滞留時間は振動の長さを設定しますが、`SOLENOID_BUZZ_ACTUATED` と `SOLENOID_BUZZ_NONACTUATED` はブザー音の間の(非)動作時間を設定します。 +* 現在の実装では、上記の時間設定のいずれについても、設定の精度はキーボードがマトリックスをスキャンできる速度によって影響を受ける可能性があります。 + したがって、キーボードのスキャンルーチンが遅い場合は、`SOLENOID_DWELL_STEP_SIZE` をキーボードのスキャンに掛かる時間よりもわずかに小さい値に設定することをお勧めします。 ブートローダ実行中に一部のピンが給電されているかもしれず (例えば、STM32F303 チップ上の A13)、そうすると書き込みプロセスの間ずっとソレノイドがオン状態になることに注意してください。これはソレノイドを加熱し損傷を与えるかもしれません。ソレノイドが接続されているピンがブートローダ/DFU 実行中にソレノイドをオンにしていることが分かった場合は、他のピンを選択してください。 diff --git a/docs/ja/hardware_keyboard_guidelines.md b/docs/ja/hardware_keyboard_guidelines.md index faf0217765..8a9127abc9 100644 --- a/docs/ja/hardware_keyboard_guidelines.md +++ b/docs/ja/hardware_keyboard_guidelines.md @@ -2,12 +2,31 @@ <!--- grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh - original document: 0.10.33:docs/hardware_keyboard_guidelines.md - git diff 0.10.33 HEAD -- docs/hardware_keyboard_guidelines.md | cat + original document: 0.12.41:docs/hardware_keyboard_guidelines.md + git diff 0.12.41 HEAD -- docs/hardware_keyboard_guidelines.md | cat --> QMK は開始以来、コミュニティにおけるキーボードの作成や保守に貢献しているあなたのような人たちのおかげで飛躍的に成長しました。私たちが成長するにつれて、うまくやるためのいくつかのパターンを発見しました。他の人たちがあなたの苦労の恩恵を受けやすくするため、それにあわせてもらえるようお願いします。 +## QMK Lint を使う + +キーボードの問題をチェックできるツール、`qmk lint` を提供しています。キーボードとキーマップで作業をしている間は、頻繁に使うことをお勧めします。 + +チェックに合格した例: + +``` +$ qmk lint -kb rominronin/katana60/rev2 +Ψ Lint check passed! +``` + +チェックに失敗した例: + +``` +$ qmk lint -kb clueboard/66/rev3 +☒ Missing keyboards/clueboard/66/rev3/readme.md +☒ Lint check failed! +``` + ## あなたのキーボード/プロジェクトの名前を決める キーボードの名前は全て小文字で、アルファベット、数字、アンダースコア(`_`)のみで構成されています。アンダースコア(`_`)で始めてはいけません。スラッシュ(`/`)はサブフォルダの区切り文字として使用されます。 diff --git a/docs/ja/tap_hold.md b/docs/ja/tap_hold.md index bf23ae4ab0..07242821a9 100644 --- a/docs/ja/tap_hold.md +++ b/docs/ja/tap_hold.md @@ -1,8 +1,8 @@ # タップホールド設定オプション <!--- - original document: 0.10.33:docs/tap_hold.md - git diff 0.10.33 HEAD -- docs/tap_hold.md | cat + original document: 0.12.41:docs/tap_hold.md + git diff 0.12.41 HEAD -- docs/tap_hold.md | cat --> タップホールドオプションは素晴らしいものですが、問題が無いわけではありません。デフォルト設定を適切なものにしようとしましたが、一部の人にとってまだ問題を引き起こすかもしれません。 @@ -92,7 +92,7 @@ bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) { #define IGNORE_MOD_TAP_INTERRUPT ``` -許容ホールドと同様に、これは高速なタイピストのためのファームウェアの処理方法を変更します。モッドタップキーを押し、他のキーを押し、モッドタップキーを放し、通常のキーを放すと、通常は両方のキーのタッピング機能が出力されます。これはローリングコンボキーには望ましくないかもしれません。 +許容ホールドと同様に、これは高速なタイピストのためのファームウェアの処理方法を変更します。モッドタップキーを押し、他のキーを押し、モッドタップキーを放し、通常のキーを放すと、`TAPPING_TERM` 内で押された場合でも、通常はモッドと通常のキーが出力されます。これは、ローリングコンボキーや、頻繁に使用するキー(例えば、`RCTL_T(KC_QUOT)`)にモッドタップを使う高速なタイピストには望ましくない場合があります。 `モッドタップ割り込みの無視`を設定するには、両方のキーを `TAPPING_TERM` の間ホールドすると、(その修飾キーの)ホールド機能を実行する必要があります。 @@ -103,7 +103,7 @@ bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) { - `SFT_T(KC_A)` を放す - `KC_X` を放す -通常、これは `X` (`SHIFT`+`x`) を送信します。`モッドタップ割り込みの無視` を有効にすると、ホールドアクションを登録するには、両方のキーを `TAPPING_TERM` の間ホールドする必要があります。この場合、素早いタップは `ax` を送信しますが、両方をホールドすると、`X` (`SHIFT`+`x`) を出力します。 +通常、これは大文字の `X` (`SHIFT`+`x`)、またはモッド + キーを送信します。`モッドタップ割り込みの無視` を有効にすると、ホールドアクションを登録するには、両方のキーを `TAPPING_TERM` の間ホールドする必要があります。この場合、素早いタップは `ax` を送信しますが、両方をホールドすると、大文字の `X` (`SHIFT`+`x`) を出力します。 ?> __注意__: これはモディファイアにのみ関係し、レイヤー切り替えキーには関係しません。 @@ -137,8 +137,7 @@ bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record) { #define TAPPING_FORCE_HOLD ``` -タップの後でユーザがキーをホールドすると、ホールド機能がアクティブになるのではなく、デフォルトでタッピング機能が繰り返されます。これにより、デュアルロールキーのタッピング機能を自動繰り返しする機能を維持することができます。 -`TAPPING_FORCE_HOLD` は、デュアルロールキーをタップした後ホールドした場合、ユーザがホールド機能をアクティブにする機能を削除します。 +タップの後でユーザがキーをホールドすると、ホールド機能がアクティブになるのではなく、デフォルトでタッピング機能が繰り返されます。これにより、デュアルロールキーのタッピング機能を自動繰り返しする機能を維持することができます。`TAPPING_FORCE_HOLD` は、デュアルロールキーをタップした後ホールドした場合、ユーザがホールド機能をアクティブにする機能を削除します。 例: @@ -185,6 +184,25 @@ bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record) { 例えば、他のキーを押すことなく `LT(2, KC_SPACE)` を押したり放したりしても何も起こりません。これを有効にすると、代わりに `KC_SPACE` を送信します。 +この機能をより細かく制御するために、以下を `config.h` に追加することができます: + +```c +#define RETRO_TAPPING_PER_KEY +``` + +そして、以下の関数をキーマップに追加します: + +```c +bool get_retro_tapping(uint16_t keycode, keyrecord_t *record) { + switch (keycode) { + case LT(2, KC_SPACE): + return true; + default: + return false; + } +} +``` + ## キー別の関数にキーレコードを含めるのはなぜですか？ 「キー別」の関数全てにキーレコードを含んでいることに気付いたかもしれません。そしてなぜそうしたのか不思議に思っているかもしれません。 |