Skip to content

nirantak/hue-api

Repository files navigation

Hue API

Async API and CLI tools for interacting with Hue Lights

Python Tests Publish Package Python Versions Package Version

Documentation: hue-api.nirantak.com

Source: github.com/nirantak/hue-api

Installation

This is an async client to interact with the Hue Bridge API.

The minimum Python version required to run this is 3.8

Install the package using pip:

pip install hue-api

Usage

Follow this link to create a Hue API user if not already known (API reference)

Using the CLI

hue --help

# Get the version of hue-api installed
hue version

# To find your Hue Bridge IP address go to discovery.meethue.com, or run:
hue bridge discover

Using the API

from hue import Bridge, Light

# Create a light object with the light id (number), Bridge IP and user
light = Light(1, ip="your-hue-bridge-ip", user="hue-api-user")

# from an async function
async def main():
  await Bridge.discover()
  await light.power_on()

# or from a sync context
import asyncio
asyncio.run(Bridge.discover())
asyncio.run(light.power_on())

Changelog

See the file CHANGELOG.md

License

This project is licensed under the terms of the MIT license