qmk/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-10-01 14:29:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

Migrate other usages of :id=...

Browse Source
This commit is contained in:
Nick Brassel
2023-05-01 17:46:18 +10:00
parent 6d53f61608
commit e28bc93a0c
66 changed files with 323 additions and 323 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ja/feature_backlight.md
+15 -15
View File
@@ -1,4 +1,4 @@
# バックライト :id=backlighting
# バックライト {#backlighting}
<!---
original document: 0.14.14:docs/feature_backlight.md
@@ -17,7 +17,7 @@ MCU は、GPIO ピンにはそんなに電流を供給できません。MCU か
BACKLIGHT_ENABLE = yes
```
## キーコード :id=keycodes
## キーコード {#keycodes}
有効にすると、以下のキーコードを使ってバックライトレベルを変更することができます。
@@ -31,7 +31,7 @@ BACKLIGHT_ENABLE = yes
| `BL_DEC` | バックライトレベルを下げる |
| `BL_BRTG` | バックライトの明滅動作を切り替える |
## 関数群 :id=functions
## 関数群 {#functions}
次の関数を使って、カスタムコードでバックライトを変更することができます:
@@ -55,7 +55,7 @@ BACKLIGHT_ENABLE = yes
| `breathing_enable()` | バックライトの明滅動作をオンにする |
| `breathing_disable()` | バックライトの明滅動作をオフにする |
## 設定 :id=configuration
## 設定 {#configuration}
どのドライバを使うかを選択するには、以下を使って `rules.mk` を設定します:
@@ -81,14 +81,14 @@ BACKLIGHT_DRIVER = software
独自のキーボードを設計しているわけではない限り、通常は `BACKLIGHT_PIN` または `BACKLIGHT_ON_STATE` を変更する必要はありません。
### バックライトオン状態 :id=backlight-on-state
### バックライトオン状態 {#backlight-on-state}
ほとんどのバックライトの回路は N チャンネルの MOSFET あるいは NPN トランジスタによって駆動されます。これは、トランジスタを *オン* にして LED を点灯させるには、ゲートまたはベースに接続されているバックライトピンを *high* に駆動する必要があることを意味します。
ただし、P チャンネルの MOSFET あるいは PNP トランジスタが使われる場合があります。この場合、トランジスタがオンの時、ピンは代わりに *low* で駆動されます。
この機能は `BACKLIGHT_ON_STATE` を定義することでキーボードレベルで設定されます。
### AVR ドライバ :id=avr-driver
### AVR ドライバ {#avr-driver}
`pwm` ドライバはデフォルトで設定されますが、`rules.mk` 内での同等の設定は以下の通りです:
@@ -96,7 +96,7 @@ BACKLIGHT_DRIVER = software
BACKLIGHT_DRIVER = pwm
```
#### 注意事項 :id=avr-caveats
#### 注意事項 {#avr-caveats}
AVR ボードでは、QMK はどのドライバを使うかを以下の表に従って自動的に決定します:
@@ -126,7 +126,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
両方のタイマーがオーディオのために使われている場合、バックライト PWM はハードウェアタイマを使うことができず、代わりにマトリックススキャンの間に引き起こされます。この場合、PWM の計算は十分なタイミングの精度で呼ばれない可能性があるため、バックライトの明滅はサポートされず、バックライトもちらつくかもしれません。
#### ハードウェア PWM 実装 :id=hardware-pwm-implementation
#### ハードウェア PWM 実装 {#hardware-pwm-implementation}
バックライト用にサポートされているピンを使う場合、QMK は PWM 信号を出力するように設定されたハードウェアタイマを使います。タイマーは 0 にリセットする前に `ICRx` (デフォルトでは `0xFFFF`) までカウントします。
希望の輝度が計算され、`OCRxx` レジスタに格納されます。カウンタがこの値まで達すると、バックライトピンは low になり、カウンタがリセットされると再び high になります。
@@ -135,7 +135,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
明滅動作の効果はカウンタがリセットされる(秒間あたりおよそ244回)たびに呼び出される `TIMER1_OVF_vect` の割り込みハンドラを登録することで可能になります。
このハンドラで、増分カウンタの値が事前に計算された輝度曲線にマップされます。明滅動作をオフにするには、割り込みを単純に禁止し、輝度を EEPROM に格納されているレベルに再設定します。
#### タイマー支援 PWM 実装 :id=timer-assisted-implementation
#### タイマー支援 PWM 実装 {#timer-assisted-implementation}
`BACKLIGHT_PIN` がハードウェアバックライトピンに設定されていない場合、QMK はソフトウェア割り込みを引き起こすように設定されているハードウェアタイマを使います。タイマーは 0 にリセットする前に `ICRx` (デフォルトでは `0xFFFF`) までカウントします。
0 に再設定すると、CPU は LED をオンにする OVF (オーバーフロー)割り込みを発火し、デューティサイクルを開始します。
@@ -144,7 +144,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
明滅の効果はハードウェア PWM 実装と同じです。
### ARM ドライバ :id=arm-configuration
### ARM ドライバ {#arm-configuration}
まだ初期段階ですが、ARM バックライトサポートは最終的に AVR と同等の機能を持つことを目指しています。`pwm` ドライバはデフォルトで設定されますが、`rules.mk` 内での同等の設定は以下の通りです:
@@ -152,7 +152,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
BACKLIGHT_DRIVER = pwm
```
#### ChibiOS の設定 :id=arm-configuration
#### ChibiOS の設定 {#arm-configuration}
以下の `#define` は ARM ベースのキーボードにのみ適用されます:
@@ -164,11 +164,11 @@ BACKLIGHT_DRIVER = pwm
これらの値を決定するには、特定の MCU の ST データシートを参照してください。独自のキーボードを設計しているわけではない場合、通常はこれらを変更する必要はありません。
#### 注意事項 :id=arm-caveats
#### 注意事項 {#arm-caveats}
現在のところ、ハードウェア PWM のみがサポートされ、タイマー支援はなく、自動設定は提供されません。
### ソフトウェア PWM ドライバ :id=software-pwm-driver
### ソフトウェア PWM ドライバ {#software-pwm-driver}
このモードでは、他のキーボードのタスクを実行中に PWM は「エミュレート」されます。追加のプラットフォーム設定なしで最大のハードウェア互換性を提供します。トレードオフは、キーボードが忙しい時にバックライトが揺れる可能性があることです。有効にするには、`rules.mk` に以下を追加します:
@@ -176,7 +176,7 @@ BACKLIGHT_DRIVER = pwm
BACKLIGHT_DRIVER = software
```
#### 複数のバックライトピン :id=multiple-backlight-pins
#### 複数のバックライトピン {#multiple-backlight-pins}
ほとんどのキーボードは、全てのバックライト LED を制御するたった1つのバックライトピンを持ちます (特にバックライトがハードウェア PWM ピンに接続されている場合)。
ソフトウェア PWM では、複数のバックライトピンを定義することができます。これらのピンは PWM デューティサイクル時に同時にオンおよびオフになります。
@@ -189,7 +189,7 @@ BACKLIGHT_DRIVER = software
#define BACKLIGHT_PINS { F5, B2 }
```
### カスタムドライバ :id=custom-driver
### カスタムドライバ {#custom-driver}
上記ドライバのいずれもキーボードに適用されていない場合(例えば、バックライトを制御するのに別の IC を使用している場合)、QMK が提供しているこの簡単な API を使ってカスタムバックライトドライバを実装することができます。有効にするには、`rules.mk` に以下を追加します: