aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md4
-rw-r--r--docs/feature_bluetooth.md7
-rw-r--r--docs/getting_started_make_guide.md4
-rw-r--r--docs/ja/config_options.md4
-rw-r--r--docs/ja/feature_bluetooth.md8
-rw-r--r--docs/ja/getting_started_make_guide.md4
6 files changed, 4 insertions, 27 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index a323741c2..f9b1cc657 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -371,10 +371,8 @@ Use these to enable or disable building certain features. The more you have enab
371 * MIDI controls 371 * MIDI controls
372* `UNICODE_ENABLE` 372* `UNICODE_ENABLE`
373 * Unicode 373 * Unicode
374* `BLUETOOTH_ENABLE`
375 * Legacy option to Enable Bluetooth with the Adafruit EZ-Key HID. See BLUETOOTH
376* `BLUETOOTH` 374* `BLUETOOTH`
377 * Current options are AdafruitEzKey, AdafruitBLE, RN42 375 * Current options are AdafruitBLE, RN42
378* `SPLIT_KEYBOARD` 376* `SPLIT_KEYBOARD`
379 * Enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common 377 * Enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common
380* `CUSTOM_MATRIX` 378* `CUSTOM_MATRIX`
diff --git a/docs/feature_bluetooth.md b/docs/feature_bluetooth.md
index 6cd5c3c6c..7b450b1ac 100644
--- a/docs/feature_bluetooth.md
+++ b/docs/feature_bluetooth.md
@@ -2,11 +2,10 @@
2 2
3## Bluetooth Known Supported Hardware 3## Bluetooth Known Supported Hardware
4 4
5Currently Bluetooth support is limited to AVR based chips. For Bluetooth 2.1, QMK has support for RN-42 modules and the Bluefruit EZ-Key, the latter of which is not produced anymore. For more recent BLE protocols, currently only the Adafruit Bluefruit SPI Friend is directly supported. BLE is needed to connect to iOS devices. Note iOS does not support mouse input. 5Currently Bluetooth support is limited to AVR based chips. For Bluetooth 2.1, QMK has support for RN-42 modules. For more recent BLE protocols, currently only the Adafruit Bluefruit SPI Friend is directly supported. BLE is needed to connect to iOS devices. Note iOS does not support mouse input.
6 6
7|Board |Bluetooth Protocol |Connection Type |rules.mk |Bluetooth Chip| 7|Board |Bluetooth Protocol |Connection Type |rules.mk |Bluetooth Chip|
8|----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------| 8|----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------|
9|[Adafruit EZ-Key HID](https://www.adafruit.com/product/1535) |Bluetooth Classic | UART |`BLUETOOTH = AdafruitEZKey` | |
10|Roving Networks RN-42 (Sparkfun Bluesmirf) |Bluetooth Classic | UART |`BLUETOOTH = RN42` | RN-42 | 9|Roving Networks RN-42 (Sparkfun Bluesmirf) |Bluetooth Classic | UART |`BLUETOOTH = RN42` | RN-42 |
11|[Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633)|Bluetooth Low Energy | SPI |`BLUETOOTH = AdafruitBLE` | nRF51822 | 10|[Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633)|Bluetooth Low Energy | SPI |`BLUETOOTH = AdafruitBLE` | nRF51822 |
12 11
@@ -24,16 +23,12 @@ Currently The only bluetooth chipset supported by QMK is the Adafruit Bluefruit
24 23
25A Bluefruit UART friend can be converted to an SPI friend, however this [requires](https://github.com/qmk/qmk_firmware/issues/2274) some reflashing and soldering directly to the MDBT40 chip. 24A Bluefruit UART friend can be converted to an SPI friend, however this [requires](https://github.com/qmk/qmk_firmware/issues/2274) some reflashing and soldering directly to the MDBT40 chip.
26 25
27## Adafruit EZ-Key hid
28This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts), but can be enabled via the Makefile. The firmware will still output characters via USB, so be aware of this when charging via a computer. It would make sense to have a switch on the Bluefruit to turn it off at will.
29
30 26
31<!-- FIXME: Document bluetooth support more completely. --> 27<!-- FIXME: Document bluetooth support more completely. -->
32## Bluetooth Rules.mk Options 28## Bluetooth Rules.mk Options
33Use only one of these 29Use only one of these
34* BLUETOOTH_ENABLE = yes (Legacy Option) 30* BLUETOOTH_ENABLE = yes (Legacy Option)
35* BLUETOOTH = RN42 31* BLUETOOTH = RN42
36* BLUETOOTH = AdafruitEZKey
37* BLUETOOTH = AdafruitBLE 32* BLUETOOTH = AdafruitBLE
38 33
39## Bluetooth Keycodes 34## Bluetooth Keycodes
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md
index df82a001f..a89dc73d0 100644
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@@ -101,10 +101,6 @@ This allows you to send Unicode characters by inputting a mnemonic corresponding
101 101
102For further details, as well as limitations, see the [Unicode page](feature_unicode.md). 102For further details, as well as limitations, see the [Unicode page](feature_unicode.md).
103 103
104`BLUETOOTH_ENABLE`
105
106This allows you to interface with a Bluefruit EZ-key to send keycodes wirelessly. It uses the D2 and D3 pins.
107
108`AUDIO_ENABLE` 104`AUDIO_ENABLE`
109 105
110This allows you output audio on the C6 pin (needs abstracting). See the [audio page](feature_audio.md) for more information. 106This allows you output audio on the C6 pin (needs abstracting). See the [audio page](feature_audio.md) for more information.
diff --git a/docs/ja/config_options.md b/docs/ja/config_options.md
index 6ba7f6f1f..2a64f2ba2 100644
--- a/docs/ja/config_options.md
+++ b/docs/ja/config_options.md
@@ -369,10 +369,8 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
369 * MIDI 制御 369 * MIDI 制御
370* `UNICODE_ENABLE` 370* `UNICODE_ENABLE`
371 * Unicode 371 * Unicode
372* `BLUETOOTH_ENABLE`
373 * Adafruit EZ-Key HID で Bluetooth を有効にするレガシーオプション。BLUETOOTH を見てください
374* `BLUETOOTH` 372* `BLUETOOTH`
375 * 現在のオプションは、AdafruitEzKey、AdafruitBLE、RN42 373 * 現在のオプションは、AdafruitBLE、RN42
376* `SPLIT_KEYBOARD` 374* `SPLIT_KEYBOARD`
377 * 分割キーボード (let's split や bakingpy のキーボードのようなデュアル MCU) のサポートを有効にし、quantum/split_common にある全ての必要なファイルをインクルードします 375 * 分割キーボード (let's split や bakingpy のキーボードのようなデュアル MCU) のサポートを有効にし、quantum/split_common にある全ての必要なファイルをインクルードします
378* `CUSTOM_MATRIX` 376* `CUSTOM_MATRIX`
diff --git a/docs/ja/feature_bluetooth.md b/docs/ja/feature_bluetooth.md
index 4443a4e3e..f7835dd54 100644
--- a/docs/ja/feature_bluetooth.md
+++ b/docs/ja/feature_bluetooth.md
@@ -7,11 +7,10 @@
7 7
8## Bluetooth の既知のサポートハードウェア 8## Bluetooth の既知のサポートハードウェア
9 9
10現在のところ Bluetooth のサポートは AVR ベースのチップに限られます。Bluetooth 2.1 については、QMK は RN-42 モジュールと、Bluefruit EZ-Key をサポートしますが、後者はもう生産されていません。より最近の BLE プロトコルについては、現在のところ Adafruit Bluefruit SPI Friend のみが直接サポートされています。iOS デバイスに接続するには、BLE が必要です。iOS はマウス入力をサポートしないことに注意してください。 10現在のところ Bluetooth のサポートは AVR ベースのチップに限られます。Bluetooth 2.1 については、QMK は RN-42 モジュールをサポートします。より最近の BLE プロトコルについては、現在のところ Adafruit Bluefruit SPI Friend のみが直接サポートされています。iOS デバイスに接続するには、BLE が必要です。iOS はマウス入力をサポートしないことに注意してください。
11 11
12| ボード | Bluetooth プロトコル | 接続タイプ | rules.mk | Bluetooth チップ | 12| ボード | Bluetooth プロトコル | 接続タイプ | rules.mk | Bluetooth チップ |
13|----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------| 13|----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------|
14| [Adafruit EZ-Key HID](https://www.adafruit.com/product/1535) | Bluetooth Classic | UART | `BLUETOOTH = AdafruitEZKey` | |
15| Roving Networks RN-42 (Sparkfun Bluesmirf) | Bluetooth Classic | UART | `BLUETOOTH = RN42` | RN-42 | 14| Roving Networks RN-42 (Sparkfun Bluesmirf) | Bluetooth Classic | UART | `BLUETOOTH = RN42` | RN-42 |
16| [Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633) | Bluetooth Low Energy | SPI | `BLUETOOTH = AdafruitBLE` | nRF51822 | 15| [Bluefruit LE SPI Friend](https://www.adafruit.com/product/2633) | Bluetooth Low Energy | SPI | `BLUETOOTH = AdafruitBLE` | nRF51822 |
17 16
@@ -29,16 +28,11 @@
29 28
30Bluefruit UART friend は SPI friend に変換することができますが、これにはMDBT40 チップへの直接の再書き込みとはんだ付けが[必要です](https://github.com/qmk/qmk_firmware/issues/2274)。 29Bluefruit UART friend は SPI friend に変換することができますが、これにはMDBT40 チップへの直接の再書き込みとはんだ付けが[必要です](https://github.com/qmk/qmk_firmware/issues/2274)。
31 30
32## Adafruit EZ-Key hid
33これには[ハードウェアの変更](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts)が必要ですが、Makefile を使って有効にすることができます。ファームウェアは引き続き USB 経由で文字を出力するため、コンピュータ経由で充電する場合は注意してください。任意にオフにするために Bluefruit 上にスイッチを持つことは理にかなっています。
34
35
36<!-- FIXME: Document bluetooth support more completely. --> 31<!-- FIXME: Document bluetooth support more completely. -->
37## Bluetooth の Rules.mk オプション 32## Bluetooth の Rules.mk オプション
38これらのうちの1つだけを使ってください 33これらのうちの1つだけを使ってください
39* BLUETOOTH_ENABLE = yes (レガシーオプション) 34* BLUETOOTH_ENABLE = yes (レガシーオプション)
40* BLUETOOTH = RN42 35* BLUETOOTH = RN42
41* BLUETOOTH = AdafruitEZKey
42* BLUETOOTH = AdafruitBLE 36* BLUETOOTH = AdafruitBLE
43 37
44## Bluetooth キーコード 38## Bluetooth キーコード
diff --git a/docs/ja/getting_started_make_guide.md b/docs/ja/getting_started_make_guide.md
index 0d39583a1..cbc824de8 100644
--- a/docs/ja/getting_started_make_guide.md
+++ b/docs/ja/getting_started_make_guide.md
@@ -106,10 +106,6 @@ make コマンド自体にもいくつかの追加オプションがあります
106 106
107詳細と制限については、[Unicode ページ](ja/feature_unicode.md) を見てください。 107詳細と制限については、[Unicode ページ](ja/feature_unicode.md) を見てください。
108 108
109`BLUETOOTH_ENABLE`
110
111これによりキーコードをワイヤレスで送信するために Bluefruit EZ-key と連動することができます。D2 と D3 ピンを使います。
112
113`AUDIO_ENABLE` 109`AUDIO_ENABLE`
114 110
115C6 ピン(抽象化が必要)でオーディオ出力できます。詳細は[オーディオページ](ja/feature_audio.md)を見てください。 111C6 ピン(抽象化が必要)でオーディオ出力できます。詳細は[オーディオページ](ja/feature_audio.md)を見てください。