Fixes and adjustment for zerproc (#13425)

This commit is contained in:
Franck Nijhof 2020-05-13 15:10:32 +02:00 committed by GitHub
parent 1107aaa4f6
commit 1c375e34a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,25 +4,12 @@ description: Instructions for integrating Zerproc bluetooth lights within Home A
ha_category: ha_category:
- Light - Light
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: "0.111" ha_release: "0.110"
ha_domain: zerproc ha_domain: zerproc
--- ---
This integration discovers nearby Zerproc lights and adds them to Home Assistant. This integration discovers nearby Zerproc lights and adds them to Home Assistant.
## Setup
This integration requires `pybluez` to be installed. On Debian based installs, run
```bash
sudo apt install bluetooth
```
Before you get started with this integration, please note that:
- Not compatible with Windows
- Requires access to the Bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information
## Configuration ## Configuration
This integration can be configured using the integrations page in Home Assistant. This integration can be configured using the integrations page in Home Assistant.
@ -33,6 +20,18 @@ Click on the `+` sign to add an integration and search for **Zerproc**.
The integration will scan for nearby devices, and is completed if any are found. No additional configuration is required. The integration will perform a BLE scan every 60 seconds to search for new devices. The integration will scan for nearby devices, and is completed if any are found. No additional configuration is required. The integration will perform a BLE scan every 60 seconds to search for new devices.
## Additional information for Home Assistant Core on Python environments
This integration requires `pybluez` to be installed. On Debian based installs, run:
```bash
sudo apt install bluetooth
```
Before you get started with this integration, please note that:
- Requires access to the Bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information
## Rootless Setup ## Rootless Setup
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). 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).
@ -43,4 +42,4 @@ sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\``
sudo setcap 'cap_net_raw+ep' `readlink -f \`which hcitool\`` sudo setcap 'cap_net_raw+ep' `readlink -f \`which hcitool\``
``` ```
A restart of Home Assistant is required. A restart of Home Assistant Core is required.