Skip to content

Latest commit

 

History

History
126 lines (80 loc) · 2.96 KB

README.md

File metadata and controls

126 lines (80 loc) · 2.96 KB
Raw

HueBLE

HueBLE logo

PyPI Status Documentation Status Black

Python module for controlling Bluetooth Philips Hue lights.

This Python module enables you to control Philips Hue Bluetooth lights directly from your computer, without the need for a Hue bridge or ZigBee dongle. It leverages the Bleak library to interact with Bluetooth Philips Hue lights.

Features

  • 💡 On/Off control
  • 🌗 Brightness control
  • 🌡️ Colour temp control
  • 🌈 XY colour control
  • ❔ Light state (power/brightness/temp/colour)
  • ⚙️ Light configuration (name)
  • 📊 Light metadata (manufacturer/model/zigbee address)
  • 🤜 Supports push & polling models
  • 🔂 Simple structure
  • 📜 Mediocre documentation
  • ✔️ More emojis than strictly necessary

Requirements

  • 🐍 Python 3.11+
  • 📶 Bleak 0.19.0+
  • 📶 bleak-retry-connector

Supported Operating Systems

  • 🐧 Linux (BlueZ)
    • Ubuntu Desktop
    • Arch (HomeAssistant OS)
  • 🏢 Windows
    • Windows 10
  • 💾 Mac OSX
    • Maybe?

Documentation

https://hueble.readthedocs.io/en/latest/

Installation

PIP

pip install HueBLE

Manual

HueBLE consists of a single file (HueBLE.py) which you can simply put in the same directory as your program. If you are using manual installation make sure the dependencies are installed as well.

pip install bleak bleak-retry-connector

Examples

Quick start example

Example code from example.py

import asyncio
from bleak import BleakScanner
import HueBLE


async def main():

    # Address of light to connect to
    address = "F6:9B:48:A4:D2:D8"

    # Obtain the BLEDevice from bleak
    device = await BleakScanner.find_device_by_address(address)

    # Initialize the light object
    light = HueBLE.HueBleLight(device)

    # Optionally we could call connect but it will be called automatically
    # on the first request to the light. You might want to call this if
    # you want to subscribe to state changes without changing the lights state.
    # await light.connect()

    # Will automatically connect to the light and turn it off
    await light.set_power(False)

    # Wait
    await asyncio.sleep(5)

    # Turn the light back on again
    await light.set_power(True)

if __name__ == "__main__":
    asyncio.run(main())

Demo program

A more fully featured demo program can be found in examples/demo.py which demonstrates all of the implemented features.