diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/ja/feature_led_matrix.md | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/docs/ja/feature_led_matrix.md b/docs/ja/feature_led_matrix.md new file mode 100644 index 000000000..b2595f998 --- /dev/null +++ b/docs/ja/feature_led_matrix.md | |||
@@ -0,0 +1,95 @@ | |||
1 | # LED マトリックスライト | ||
2 | |||
3 | <!--- | ||
4 | original document: 0.8.141:docs/feature_led_matrix.md | ||
5 | git diff 0.8.141 HEAD -- docs/feature_led_matrix.md | cat | ||
6 | --> | ||
7 | |||
8 | この機能により、外部ドライバによって駆動される LED マトリックスを使うことができます。この機能は、バックライト制御と同じキーコードを使えるようにするため、バックライトシステムに接続します。 | ||
9 | |||
10 | RGB LED を使いたい場合は、代わりに [RGB マトリックスサブシステム](ja/feature_rgb_matrix.md) を使うべきです。 | ||
11 | |||
12 | ## ドライバ設定 | ||
13 | |||
14 | ### IS31FL3731 | ||
15 | |||
16 | I2C IS31FL3731 RGB コントローラを使ったアドレス指定可能な LED マトリックスライトのための基本的なサポートがあります:有効にするには、`rules.mk` に以下を追加します: | ||
17 | |||
18 | LED_MATRIX_ENABLE = IS31FL3731 | ||
19 | |||
20 | 1から4個の IS31FL3731 IC を使うことができます。キーボード上に存在しない IC の `LED_DRIVER_ADDR_<N>` 定義を指定しないでください。`config.h` に以下の項目を定義することができます: | ||
21 | |||
22 | | 変数 | 説明 | デフォルト | | ||
23 | |----------|-------------|---------| | ||
24 | | `ISSI_TIMEOUT` | (オプション) i2c メッセージを待つ時間 | 100 | | ||
25 | | `ISSI_PERSISTENCE` | (オプション) 失敗したメッセージをこの回数再試行する | 0 | | ||
26 | | `LED_DRIVER_COUNT` | (必須) LED ドライバ IC の数 | | | ||
27 | | `LED_DRIVER_LED_COUNT` | (必須) 全てのドライバの LED ライトの数 | | | ||
28 | | `LED_DRIVER_ADDR_1` | (必須) 最初の LED ドライバのアドレス | | | ||
29 | | `LED_DRIVER_ADDR_2` | (オプション) 2番目の LED ドライバのアドレス | | | ||
30 | | `LED_DRIVER_ADDR_3` | (オプション) 3番目の LED ドライバのアドレス | | | ||
31 | | `LED_DRIVER_ADDR_4` | (オプション) 4番目の LED ドライバのアドレス | | | ||
32 | |||
33 | 2つのドライバを使う例です。 | ||
34 | |||
35 | // これは7ビットのアドレスで、左シフトされます | ||
36 | // ビット0に0を設定すると書き込み、1を設定すると読み込みです (I2C プロトコルに従う) | ||
37 | // アドレスは配線によって変わります: | ||
38 | // 0b1110100 AD <-> GND | ||
39 | // 0b1110111 AD <-> VCC | ||
40 | // 0b1110101 AD <-> SCL | ||
41 | // 0b1110110 AD <-> SDA | ||
42 | #define LED_DRIVER_ADDR_1 0b1110100 | ||
43 | #define LED_DRIVER_ADDR_2 0b1110110 | ||
44 | |||
45 | #define LED_DRIVER_COUNT 2 | ||
46 | #define LED_DRIVER_1_LED_COUNT 25 | ||
47 | #define LED_DRIVER_2_LED_COUNT 24 | ||
48 | #define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL | ||
49 | |||
50 | 現在、2つのドライバのみがサポートされますが、4つの組み合わせ全てをサポートすることは簡単です。 | ||
51 | |||
52 | `<keyboard>.c` に全ての LED を列挙する配列を定義します: | ||
53 | |||
54 | const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { | ||
55 | /* これらの位置については IS31 マニュアルを参照してください | ||
56 | * driver | ||
57 | * | LED address | ||
58 | * | | */ | ||
59 | {0, C3_3}, | ||
60 | .... | ||
61 | } | ||
62 | |||
63 | ここで、`Cx_y` は[データシート](http://www.issi.com/WW/pdf/31FL3731.pdf)およびヘッダファイル `drivers/issi/is31fl3731-simple.h` で定義されるマトリックス内の LED の位置です。`driver` は `config.h` で定義したドライバのインデックス(`0`、`1`、`2`、`3`のいずれか)です。 | ||
64 | |||
65 | ## キーコード | ||
66 | |||
67 | 現在のところ、全ての LED マトリックスのキーコードは[バックライトシステム](ja/feature_backlight.md)と共有されます。 | ||
68 | |||
69 | ## LED マトリックス効果 | ||
70 | |||
71 | 現在のところ、LED マトリックス効果は作成されていません。 | ||
72 | |||
73 | ## カスタムレイヤー効果 | ||
74 | |||
75 | カスタムレイヤー効果は `<keyboard>.c` 内で以下を定義することで行うことができます: | ||
76 | |||
77 | void led_matrix_indicators_kb(void) { | ||
78 | led_matrix_set_index_value(index, value); | ||
79 | } | ||
80 | |||
81 | 同様の関数がキーマップ内で `led_matrix_indicators_user` として動作します。 | ||
82 | |||
83 | ## サスペンド状態 | ||
84 | |||
85 | サスペンド機能を使うには、以下を `<keyboard>.c` に追加します: | ||
86 | |||
87 | void suspend_power_down_kb(void) | ||
88 | { | ||
89 | led_matrix_set_suspend_state(true); | ||
90 | } | ||
91 | |||
92 | void suspend_wakeup_init_kb(void) | ||
93 | { | ||
94 | led_matrix_set_suspend_state(false); | ||
95 | } | ||