Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 4.2 KB

README.md

File metadata and controls

78 lines (61 loc) · 4.2 KB
Raw

Home Assistant Bluetooth

CI Status Test coverage percentage

Poetry black pre-commit

PyPI Version Supported Python versions License

Home Assistant Bluetooth Models and Helpers

Usage

This library is for accessing Home Assistant Bluetooth models. Libraries use these models to receive and parse Bluetooth advertisement data.

@dataclasses.dataclass
class BluetoothServiceInfo(BaseServiceInfo):
    """Prepared info from bluetooth entries."""

    name: str
    address: str
    rssi: int
    manufacturer_data: dict[int, bytes]
    service_data: dict[str, bytes]
    service_uuids: list[str]
    source: str

The data used to populate BluetoothServiceInfo comes from bleak's BLEDevice and AdvertisementData, except for the source field, which comes from Home Assistant and represents the source of the data.

In the future, Home Assistant may support remote Bluetooth transceivers, which may use the source field to determine which device is closest.

Installation

Install this via pip (or your favourite package manager):

pip install home-assistant-bluetooth

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

This package was created with Cookiecutter and the browniebroke/cookiecutter-pypackage project template.