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-08 01:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Bluetooth docs for async_register_scanner changes (#2021)

Browse Source
This commit is contained in:
J. Nick Koston 2023-12-23 00:13:48 -10:00 committed by GitHub
parent cc7363b628
commit ba9ac0c47e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/core/bluetooth/api.md
View File

@ -228,10 +228,12 @@ Integrations that provide a Bluetooth adapter should add `bluetooth` in [`depend
To register an external scanner, call the `bluetooth.async_register_scanner` API. The scanner must inherit from `BaseHaScanner`.
If the scanner needs connection slot management to avoid overloading the adapter, pass the number of connection slots as an integer value via the `connection_slots` argument.
```python
from homeassistant.components import bluetooth
cancel = bluetooth.async_register_scanner(hass, scanner, connectable=False)
cancel = bluetooth.async_register_scanner(hass, scanner, connection_slots=slots)
```
The scanner will need to feed advertisement data to the central Bluetooth manager in the form of `BluetoothServiceInfoBleak` objects. The callback needed to send the data to the central manager can be obtained with the `bluetooth.async_get_advertisement_callback` API.