docs/feature_bluetooth.md

   1 # Bluetooth
   2
   3 ## Bluetooth Known Supported Hardware
   4
   5 Currently Bluetooth support is limited to AVR based chips. For Bluetooth 2.1 Qmk has support for RN-42 HID Firmware and Bluefruit EZ Key the later 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.
   6
   7 |Board                                                           |Bluetooth Protocol          |Connection Type |Rules.mk                   |Bluetooth Chip|
   8 |----------------------------------------------------------------|----------------------------|----------------|---------------------------|--------------|
   9 |[Adafruit EzKey HID]("https://www.adafruit.com/product/1535")   |Bluetooth Classic           | UART           | BLUETOOTH = AdafruitEZKey |              |
  10 |Rover 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   | nRF5182      |
  12
  13 Not Supported Yet but possible:
  14 * [Bluefruit LE UART Friend](https://www.adafruit.com/product/2479). [Possible tmk implementation found in](https://github.com/tmk/tmk_keyboard/issues/514)
  15 * HC-05 boards flashed with RN-42 firmware. They apparently both use the CSR BC417 Chip. Flashing it with RN-42 firmware gives it HID capability.
  16 * [Sparkfun Bluetooth mate](https://www.sparkfun.com/products/14839)
  17 * HM-13 based boards
  18
  19 ### Adafruit BLE SPI Friend
  20 Currently The only bluetooth chipset supported by QMK is the Adafruit Bluefruit SPI Friend. It's a Nordic nRF5182 based chip running Adafruit's custom firmware. Data is transmitted via Adafruit's SDEP over Hardware SPI. The [Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) is supported as it's an AVR mcu connected via SPI to the Nordic BLE chip with Adafruit firmware. If Building a custom board with the SPI friend it would be easiest to just use the pin selection that the 32u4 feather uses but you can change the pins in the config.h options with the following defines:
  21 * #define AdafruitBleResetPin D4
  22 * #define AdafruitBleCSPin    B4
  23 * #define AdafruitBleIRQPin   E6
  24
  25 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.
  26
  27 ## Adafruit EZ-Key hid
  28 This 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
  31 <!-- FIXME: Document bluetooth support more completely. -->
  32 ## Bluetooth Rules.mk Options
  33 Use only one of these
  34 * BLUETOOTH_ENABLE = yes (Legacy Option)
  35 * BLUETOOTH = RN42
  36 * BLUETOOTH = AdafruitEZKey
  37 * BLUETOOTH = AdafruitBLE
  38
  39 ## Bluetooth Keycodes
  40
  41 This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both.
  42
  43 |Name      |Description                                   |
  44 |----------|----------------------------------------------|
  45 |`OUT_AUTO`|Automatically switch between USB and Bluetooth|
  46 |`OUT_USB` |USB only                                      |
  47 |`OUT_BT`  |Bluetooth only                                |