Skip to main content

Async API and CLI tools for interacting with Hue Lights

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hue-api-0.4.8.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

hue_api-0.4.8-py2.py3-none-any.whl (12.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file hue-api-0.4.8.tar.gz.

File metadata

  • Download URL: hue-api-0.4.8.tar.gz
  • Upload date:
  • Size: 35.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for hue-api-0.4.8.tar.gz
Algorithm Hash digest
SHA256 5a574da59eae20e460682e01876ffa3cedd6c71fe0bbcd0dd6d0489e11f6a3e9
MD5 25423a9c4b212f36e6f7d67d3354bf01
BLAKE2b-256 a40ba5d9c0cdc8c93b780161d3202184008a909eb4e69a514fa69b20442eb868

See more details on using hashes here.

File details

Details for the file hue_api-0.4.8-py2.py3-none-any.whl.

File metadata

  • Download URL: hue_api-0.4.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for hue_api-0.4.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2c18a267752fcbad35d816d47c8c3e5580b5318654996b50a79a5806d7544305
MD5 a3c1a1c30c78e9290d0eb84d8d5cc8ef
BLAKE2b-256 072cd2d3bc3311c0518934a3cc721abd05af517aee72519a766372ce8f2ef1eb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page