Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Cem Aksoylar <[email protected]>
  • Loading branch information
Nick-Munnich and caksoylar authored Sep 3, 2024
1 parent df17dab commit ab77156
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/docs/troubleshooting/hardware-issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,24 +148,24 @@ Once you have done so, you will need to adjust the `kscan` of your keyboard slig

```dts
&kscan0 {
input-gpios
= <&pro_micro 7 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&pro_micro 6 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&pro_micro 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
input-gpios
= <&pro_micro 7 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&pro_micro 6 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&pro_micro 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
;
};
};
```

could have the pin `pro_micro 6` replaced with `gpio0 8`.
could have the pin `&pro_micro 6` (D6 in the [Pro Micro pinout](../development/hardware-integration/new-shield.mdx#shield-overlays)) replaced with `&gpio0 8` (P0.08 for nRF MCUs).

```dts title="<my_keyboard>.overlay"
&kscan0 {
input-gpios
= <&pro_micro 7 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&gpio0 8 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&pro_micro 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
input-gpios
= <&pro_micro 7 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&gpio0 8 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&pro_micro 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
;
};
};
```

You can then build and flash using your config as usual.
Expand All @@ -178,22 +178,22 @@ If the affected pin is not in your `kscan`, you will want to copy over and overw

Under ideal conditions, a Bluetooth connection can be stable at even a 100 meter distance. However, there are many things which can affect the effective range of the antenna. In no particular order, the most common issues you will encounter are:

- Solid material near an antenna or between the two communicating antennas (Metal is _particularly_ bad)
- Solid material near an antenna or between the two communicating antennas (metal is _particularly_ bad)
- Interference from other nearby 2.4GHz connections
- The antenna makes use of malfunctioning hardware such as a [faulty oscillator](connection-issues.mdx#mitigating-a-faulty-oscillator)
- Not enough [power being provided to the antenna](connection-issues.mdx#unreliableweak-connection)
- A missing external antenna
- A missing external antenna for motherboard-integrated or PCIe wireless adapters
- Interference from [USB 3 devices](https://www.bluetoothandusb3.com/the-explanation)

It is expected that your antenna will have some interference - hence why most household devices using Bluetooth have an effective range of 5-10 meters.
It is expected that your antenna will have some interference -- hence why most household devices using Bluetooth have an effective range of 5-10 meters.

### Identifying & Resolving Issues

Troubleshooting antenna issues can only really be done via trial and error.

A good initial approach is:

1. Make sure you have firmware flashed to your device that has BLE enabled, with at least one Bluetooth profile free.
1. Make sure you have firmware flashed to your device that has BLE enabled, with at least one [Bluetooth profile](../features/bluetooth.md#profiles) free and no uncleared profiles previously paired to the host device.
2. Select the free profile.
3. Remove as many physical objects between your ZMK device and a host device as possible.
4. Switch off as many other nearby wireless devices as possible.
Expand Down

0 comments on commit ab77156

Please sign in to comment.