diff options
Diffstat (limited to 'docs/feature_bluetooth.md')
-rw-r--r-- | docs/feature_bluetooth.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/feature_bluetooth.md b/docs/feature_bluetooth.md index 08e5f24ac..1b6a825e7 100644 --- a/docs/feature_bluetooth.md +++ b/docs/feature_bluetooth.md | |||
@@ -4,10 +4,10 @@ | |||
4 | 4 | ||
5 | Currently 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. | 5 | Currently 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 | |Roving Networks RN-42 (Sparkfun Bluesmirf) |Bluetooth Classic | UART |`BLUETOOTH = RN42` | RN-42 | | 9 | |Roving Networks RN-42 (Sparkfun Bluesmirf) |Bluetooth Classic |UART |`BLUETOOTH_DRIVER = RN42` |RN-42 | |
10 | |[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_DRIVER = AdafruitBLE`|nRF51822 | |
11 | 11 | ||
12 | Not Supported Yet but possible: | 12 | Not Supported Yet but possible: |
13 | * [Bluefruit LE UART Friend](https://www.adafruit.com/product/2479). [Possible tmk implementation found in](https://github.com/tmk/tmk_keyboard/issues/514) | 13 | * [Bluefruit LE UART Friend](https://www.adafruit.com/product/2479). [Possible tmk implementation found in](https://github.com/tmk/tmk_keyboard/issues/514) |
@@ -23,16 +23,17 @@ Currently The only bluetooth chipset supported by QMK is the Adafruit Bluefruit | |||
23 | 23 | ||
24 | A 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. | 24 | A 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. |
25 | 25 | ||
26 | |||
27 | <!-- FIXME: Document bluetooth support more completely. --> | 26 | <!-- FIXME: Document bluetooth support more completely. --> |
28 | ## Bluetooth Rules.mk Options | 27 | ## Bluetooth Rules.mk Options |
29 | 28 | ||
30 | The currently supported Bluetooth chipsets do not support [N-Key Rollover (NKRO)](reference_glossary.md#n-key-rollover-nkro), so `rules.mk` must contain `NKRO_ENABLE = no`. | 29 | The currently supported Bluetooth chipsets do not support [N-Key Rollover (NKRO)](reference_glossary.md#n-key-rollover-nkro), so `rules.mk` must contain `NKRO_ENABLE = no`. |
31 | 30 | ||
32 | Use only one of these to enable Bluetooth: | 31 | Add the following to your `rules.mk`: |
33 | * BLUETOOTH_ENABLE = yes (Legacy Option) | 32 | |
34 | * BLUETOOTH = RN42 | 33 | ```make |
35 | * BLUETOOTH = AdafruitBLE | 34 | BLUETOOTH_ENABLE = yes |
35 | BLUETOOTH_DRIVER = AdafruitBLE # or RN42 | ||
36 | ``` | ||
36 | 37 | ||
37 | ## Bluetooth Keycodes | 38 | ## Bluetooth Keycodes |
38 | 39 | ||