First draft of dual-boot pairing guide

This commit is contained in:
tominabox1 2020-12-28 17:51:57 -06:00
parent 2233f457b2
commit acb3f44000

View file

@ -73,3 +73,51 @@ CONFIG_BT_CTLR_TX_PWR_PLUS_8=y
```
For the `nRF52840`, the value `PLUS_8` can be set to any multiple of four between `MINUS_20` and `PLUS_8`. The default value for this config is `0`, but if you are having connection issues it is recommended to set it to `PLUS_8` because the power consumption difference is negligible. For more information on changing the transmit power of your BLE device, please refer to [the Zephyr docs.](https://docs.zephyrproject.org/latest/reference/kconfig/CONFIG_BT_CTLR_TX_PWR_PLUS_8.html)
### MacOS/Windows Dual Booting
If you are utiizing Apple's BootCamp feature or running a hackintosh that allows you to easily dual-boot your system between macOS and Windows, you will find that you can only use your bluetooth devices on one OS or the other without re-pairing. This is because ZMK stores the host address and keys in the profiles only one time. This means that a host can only pair with exactly one ZMK profile.
The workaround for this limitation is as follows:
1. First, boot into Windows and pair your device. This creates the registry entry we will need to edit later on.
1. Reboot into macOS
1. In macOS, clear the profile on your keyboard and pair with your computer.
1. Once paired, old Option + Control + Shift and click on the bluetooth icon in your menubar. Take note of the "Address" of your computer's bluetooth device (`65-FD-3B-1A-DB-48` here), as well as the address of the connected device (`E6-24-54-08-BC-A3` here).
1. Now open the terminal app (Applications/Utilities/Terminal.app) and paste the following command and enter your root password.
#### macOS High Sierra (10.13) and newer
```
sudo defaults read /private/var/root/Library/Preferences/com.apple.bluetoothd.plist
```
#### macOS Sierra (10.12) and older
```
sudo defaults read /private/var/root/Library/Preferences/blued.plist
```
This will print the contents of the bluetooth plist file containing the pairing keys for your bluetooth devices.
1. Look for the section that starts with `SMPDistributionKeys =`. Below this, find your host's bluetooth address (`65-FD-3B-1A-DB-48` in this example) and then look for the address of your keyboard (`6-24-54-08-BC-A3` in this example).
1. Under your keyboard address, find the value labeled LocalLTK (in the screenshot above it is `0x8968239e350b2cb7df16d8f47c774e2c`). Copy this value into a text file that you can access from Windows, this is the value we will need to enter into the registry later on.
1. Reboot into Windows
1. Once logged in, turn off bluetooth.
1. Grab a piece of software called psexec (google) and copy the .exe to the desktop. This will allow us to easily open Regedit with elevated privelages.
1. Open the Start Menu, type `cmd` and hit control + shift + enter to launch an elevated command prompt.
1. Enter the following, one at a time:
```
cd Desktop
psexec -s -i regedit
```
Regedit will launch. Be careful in here as certain registry edits can cause your system to become unstable or unbootable! Edit only the entry shown in this guide.
1. Navigate in the registry to this key
```HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\BTHPORT\Parameters\Keys\```
1. Inside "Keys", select the address of your host bluetooth device. It should be the same as it was in macOS (`65-FD-3B-1A-DB-48` in this example).
1. Below that, find the address that matches your keyboard's from macOS (`6-24-54-08-BC-A3` in this example).
1. Under that, there should be a registry entry called "LTK". Double click on this entry to modify it. Regedit will pop up a hex editing window. Delete the contents to start with a blank value. Refer to the LocalLTK value you saved from macOS and enter it into this dialog box, omitting the "0x" at the beginning. Regedit will automatically advance you through the hex pairs. When you're done the window should look something like this:
1. Select OK, exit Regedit, and reboot into Windows.
1. Once rebooted, turn bluetooth back on, and make sure your keyboard is on the same profile you had selected in macOS. Your keyboard should connect and start working!
1. Finally reboot into macOS and verify that your keyboard still works on the same profile here as well.
If your board still does not work in one OS or the other, start over at the beginning with a clean pairing in each OS.