Update bluetooth le tracker docs to reflect the bluetooth integration must be functional for the integration to work (#23734)

This commit is contained in:
J. Nick Koston 2022-08-21 09:42:18 -10:00 committed by GitHub
parent ee2cb92df6
commit 5485532693
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -17,7 +17,7 @@ Devices discovered are stored with 'BLE_' as the prefix for device mac addresses
## Setup
This platform requires pybluez to be installed, which is already the case if you're using Home Assistant OS, Supervised or Container. For Home Assistant Core installs see below on the required steps.
This integration requires the [Bluetooth](/integrations/bluetooth) integration to be enabled and functional.
## Configuration
@ -58,30 +58,3 @@ Some BTLE devices (e.g., fitness trackers) are only visible to the devices that
Enabling the battery tracking might slightly decrease the duration of the battery, but since this is only done at most once a day, this shouldn't be noticeable. Not all devices offer battery status information; if the information is not available, the integration will only try once at startup.
For additional configuration variables check the [Device tracker page](/integrations/device_tracker/).
{% details "Notes for Home Assistant Core Installations" %}
On Debian based Home Assistant Core installations, run:
```bash
sudo apt install bluetooth
```
Before you get started with this platform, please note that:
- This platform is incompatible with Windows
- This platform requires access to the Bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information
### Rootless Setup on Core installs
Normally accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 and hcitool the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](https://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
```bash
sudo apt-get install libcap2-bin
sudo setcap 'cap_net_raw,cap_net_admin+eip' $(readlink -f $(which python3))
sudo setcap 'cap_net_raw+ep' $(readlink -f $(which hcitool))
```
A restart of Home Assistant is required.
{% enddetails %}