# LED BLE

<p align="center">
  <a href="https://github.com/bluetooth-devices/led-ble/actions?query=workflow%3ACI">
    <img src="https://img.shields.io/github/workflow/status/bluetooth-devices/led-ble/CI/main?label=CI&logo=github&style=flat-square" alt="CI Status" >
  </a>
  <a href="https://led-ble.readthedocs.io">
    <img src="https://img.shields.io/readthedocs/led-ble.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
  </a>
  <a href="https://codecov.io/gh/bluetooth-devices/led-ble">
    <img src="https://img.shields.io/codecov/c/github/bluetooth-devices/led-ble.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
  </a>
</p>
<p align="center">
  <a href="https://python-poetry.org/">
    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64, " alt="Poetry">
  </a>
  <a href="https://github.com/ambv/black">
    <img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
  </a>
  <a href="https://github.com/pre-commit/pre-commit">
    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
  </a>
</p>
<p align="center">
  <a href="https://pypi.org/project/led-ble/">
    <img src="https://img.shields.io/pypi/v/led-ble.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
  </a>
  <img src="https://img.shields.io/pypi/pyversions/led-ble.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
  <img src="https://img.shields.io/pypi/l/led-ble.svg?style=flat-square" alt="License">
</p>

Control a wide range of LED BLE devices

## What this library is

This library controls generic, unbranded Bluetooth LE LED controllers and
bulbs that share the same family of protocols. These devices are sold under
many names and typically advertise names such as `Triones:`, `LEDBLE-`,
`LEDBlue-`, `QHM-`, and `Dream~`.

## What this library is not

This library is not a universal driver for every Bluetooth LE light.
Brand-specific ecosystems such as Govee use their own protocols and span
hundreds of models with complex, per-model options. Supporting them here
would mean maintaining what is effectively a separate driver inside this
one, so they should live in their own dedicated libraries. The same applies
to devices that speak an entirely different protocol, such as yeelight-bt
or ALLOYSEED lights.

## Installation

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

`pip install led-ble`

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- markdownlint-disable -->
<!-- markdownlint-enable -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-end -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Credits

This package was created with
[Cookiecutter](https://github.com/audreyr/cookiecutter) and the
[browniebroke/cookiecutter-pypackage](https://github.com/browniebroke/cookiecutter-pypackage)
project template.
