jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-09 10:26:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document bluetooth.async_scanner_count (#1452)

Browse Source
This commit is contained in:
J. Nick Koston 2022-08-29 09:21:55 -05:00 committed by GitHub
parent 63ce526339
commit 39ac658f8b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/network_discovery.md
View File

@ -104,6 +104,17 @@ from homeassistant.components import bluetooth
scanner = bluetooth.async_get_scanner(hass) scanner = bluetooth.async_get_scanner(hass)
``` ```
### Determine if there is scanner running
The Bluetooth integration may be set up but has no connectable adapters or remotes. The `bluetooth.async_scanner_count` API can be used to determine if there is a scanner running that will be able to receive advertisements or generate `BLEDevice`s that can be used to connect to the device. An integration may want to raise a more helpful error during setup if there are no scanners that will generate connectable `BLEDevice` objects.
```python
from homeassistant.components import bluetooth
count = bluetooth.async_scanner_count(hass, connectable=True)
```
### Subscribing to unavailable callbacks ### Subscribing to unavailable callbacks
To get a callback when the Bluetooth stack can no longer see a device, call the `bluetooth.async_track_unavailable` API. For performance reasons, it may take up to five minutes to get a callback once the device is no longer seen. To get a callback when the Bluetooth stack can no longer see a device, call the `bluetooth.async_track_unavailable` API. For performance reasons, it may take up to five minutes to get a callback once the device is no longer seen.