kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

prettier formating

Browse source
This commit is contained in:
tominabox1 2020-12-29 12:23:58 -06:00
parent 60c8ee88e5
commit a001fb75a2
1 changed files with 26 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
docs/docs/troubleshooting.md
View file

@ -2,6 +2,7 @@
title: Troubleshooting
sidebar_title: Troubleshooting
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@ -78,19 +79,20 @@ For the `nRF52840`, the value `PLUS_8` can be set to any multiple of four betwee
### 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.
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. In macOS, clear the profile on your keyboard and pair with your computer.
1. Once paired, hold 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).
| ![BT Contextual Menu](../docs/assets/troubleshooting/dualboot/bt_addresses.png) |
| :-----------------------------------------------------------------------------: |
| Bluetooth Context Menu |
| ![BT Contextual Menu](../docs/assets/troubleshooting/dualboot/bt_addresses.png) |
| :-----------------------------------------------------------------------------: |
| Bluetooth Context Menu |
1. Now open the terminal app (Applications/Utilities/Terminal.app) and paste the following command and enter your root password.
1. Now open the terminal app (Applications/Utilities/Terminal.app) and paste the following command and enter your root password.
<Tabs
defaultValue="high_sierra"
@ -98,7 +100,7 @@ The workaround for this limitation is as follows:
{label: 'macOS High Sierra 10.13 and newer', value: 'high_sierra'},
{label: 'macOS Sierra 10.12 and older', value: 'sierra'},
]}>
<TabItem value="high_sierra">
<TabItem value="high_sierra">
```
sudo defaults read /private/var/root/Library/Preferences/com.apple.bluetoothd.plist
@ -118,25 +120,25 @@ The workaround for this limitation is as follows:
| ![BT Plist](../docs/assets/troubleshooting/dualboot/plist.png) |
| :------------------------------------------------------------: |
| Bluetooth .plist |
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 (`E6-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:
| Bluetooth .plist |
```
cd c:\Users\<username>\Desktop
psexec -s -i regedit
```
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 (`E6-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:
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.
```
cd c:\Users\<username>\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\
```
@ -156,6 +158,6 @@ The workaround for this limitation is as follows:
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.
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.
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.