hueify 0.6.0

Async Python client for the Philips Hue API with real-time event streaming

Hueify

Hueify is an async-first Python library for Philips Hue. It lets you control lights, rooms, zones and scenes using the same names you see in the Hue app, with state kept fresh via serversent events. It also ships an MCP server for LLM tools.

pip install hueify

---

CLI

Hueify ships a command-line interface for controlling lights, rooms, and zones directly from your terminal. Requires the cli extra:

pip install hueify[cli]

Onboarding

Run the interactive setup wizard to auto-discover your bridge and register an app key:

hueify setup

The wizard will:

1. Scan your network for a Hue Bridge
2. Prompt you to press the link button on the bridge
3. Register an app key and save it in your user config file

Hue Bridge Setup

Found bridge at 192.168.1.10

Press the link button on your Hue Bridge, then hit Enter.

Setup complete!

Credentials saved to C:\Users\you\AppData\Roaming\hueify\config.toml

After setup, the CLI and Python API can read those credentials automatically. You can still use HUE_BRIDGE_IP / HUE_APP_KEY or CLI flags to override the saved config.

CLI commands

hueify lights list
hueify lights on "Desk lamp"
hueify lights off "Desk lamp"
hueify lights brightness "Desk lamp" 75
hueify lights temperature "Desk lamp" 30

hueify rooms list
hueify rooms on "Living Room"
hueify rooms brightness "Living Room" 40
hueify rooms activate-scene "Living Room" "Relax"

hueify zones list
hueify zones on "Downstairs"

Pass --bridge-ip and --app-key as flags to override the saved config or environment variables for a single invocation.

---

Usage

All interaction goes through the Hueify async context manager. It connects to the bridge, populates the cache from the REST API, and subscribes to SSE events so state is always current without polling.

import asyncio
from hueify import Hueify


async def main() -> None:
    async with Hueify() as hue:
        # lights, rooms, zones are namespaces on the hue object
        await hue.rooms.turn_on("Living Room")


asyncio.run(main())

Credentials are read from CLI setup config by default. Environment variables (HUE_BRIDGE_IP, HUE_APP_KEY) and explicit constructor arguments override that config:

async with Hueify(bridge_ip="192.168.1.10", app_key="your-app-key") as hue:
    ...

---

Lights

async with Hueify() as hue:
    await hue.lights.turn_on("Desk lamp")
    await hue.lights.turn_off("Desk lamp")

    await hue.lights.set_brightness("Desk lamp", 75)
    await hue.lights.increase_brightness("Desk lamp", 10)
    await hue.lights.decrease_brightness("Desk lamp", 10)

    await hue.lights.set_color_temperature("Desk lamp", 30)

    brightness = hue.lights.get_brightness("Desk lamp")
    print("Brightness:", brightness)

---

Rooms

async with Hueify() as hue:
    print(hue.rooms.names)  # list of all room names

    await hue.rooms.turn_on("Living Room")
    await hue.rooms.set_brightness("Living Room", 40)
    await hue.rooms.increase_brightness("Living Room", 20)
    await hue.rooms.set_color_temperature("Living Room", 35)

    await hue.rooms.activate_scene("Living Room", "Relax")

    active = hue.rooms.get_active_scene("Living Room")
    print("Active scene:", active.name if active else None)

    scenes = hue.rooms.scene_names("Living Room")
    print("Available scenes:", scenes)

---

Zones

Zones work identically to rooms:

async with Hueify() as hue:
    print(hue.zones.names)

    await hue.zones.turn_on("Downstairs")
    await hue.zones.set_brightness("Downstairs", 60)
    await hue.zones.activate_scene("Downstairs", "Focus")

---

Scenes

hue.scenes provides bridge-wide access to all scenes, independent of rooms or zones:

async with Hueify() as hue:
    print(hue.scenes.names)

    await hue.scenes.activate("Relax")

    scene = hue.scenes.from_name("Relax")
    print(scene.name, scene.id)

To list or activate scenes scoped to a specific room or zone, use hue.rooms.scene_names() and hue.rooms.activate_scene() instead.

---

Error handling

All not-found errors raise ResourceNotFoundException with the resource type, the lookup name, and a list of fuzzy-matched suggestions:

from hueify import Hueify, ResourceNotFoundException

async with Hueify() as hue:
    try:
        await hue.rooms.turn_on("Livng Room")  # typo
    except ResourceNotFoundException as e:
        print(e)
        # room 'Livng Room' not found. Did you mean: 'Living Room'?

---

Real-time events via Server-Sent Events

Hueify subscribes to the Hue Bridge's SSE stream inside __aenter__. State changes made outside your script — via the Hue app, a physical switch, or another client — are applied to the cache automatically. No polling required.

You can also react to changes directly by subscribing to typed event classes:

from hueify.sse.views import LightEvent

async with Hueify() as hue:
    @hue.on(LightEvent)
    async def on_light(event: LightEvent) -> None:
        light = hue.lights.from_id(event.id)
        print(light)  # Light(name='Desk', id=..., on=True, brightness=75.0%)

    await asyncio.Event().wait()

Supported event types include LightEvent, GroupedLightEvent, SceneEvent, MotionEvent, ButtonEvent, TemperatureEvent, and more — see the Events guide for the full list.

---

MCP server

Hueify includes a Model Context Protocol server that exposes lights, rooms, and zones to compatible LLM tools. Requires the mcp extra:

pip install hueify[mcp]

The server uses the same Hueify context manager internally. Integration with a specific MCP host is not covered here.

---

License

MIT