Welcome to bleak-esphome documentation!

bleak-esphome

CI Status Documentation Status Test coverage percentage CodSpeed Badge

Poetry black pre-commit

PyPI Version Supported Python versions License


Documentation: https://bleak-esphome.readthedocs.io

Source Code: https://github.com/bluetooth-devices/bleak-esphome


A Bleak backend that proxies Bluetooth Low Energy through an ESP32 running ESPHome with the Bluetooth Proxy component. It lets any Python application — Home Assistant, an add-on, or a stand-alone script — discover and connect to BLE peripherals using a remote ESP32 as the adapter. The Bluetooth Proxy firmware itself lives in the ESPHome project; this library is the host-side client. See the architecture docs for how the pieces fit together.

Installation

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

pip install bleak-esphome

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 Copier and the browniebroke/pypackage-template project template.