Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-hue/badge/?version=latest
:target: https://docs.circuitpython.org/projects/hue/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Hue/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Hue/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython helper library for Philips Hue Lights.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython SimpleIO <https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO>`_
* `Adafruit CircuitPython ESP32SPI <https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-hue/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-hue
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-hue
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-hue
Usage Example
=============
Load bridge username and IP Address from settings.toml file:
.. code-block:: python
username = os.getenv("hue_username")
bridge_ip = os.getenv("bridge_ip")
my_bridge = Bridge(wifi, bridge_ip, username)
Enumerate all lights on the bridge
.. code-block:: python
lights = my_bridge.get_lights()
Turn on a light
.. code-block:: python
my_bridge.set_light(1, on=True)
Turn off a light
.. code-block:: python
my_bridge.set_light(1, on=False)
Set a light to the color yellow (RGB)
.. code-block:: python
color = my_bridge.rgb_to_hsb([255, 255, 0])
my_bridge.set_light(1, hue=int(color[0]), sat=int(color[1]), bri=int(color[2]))
Set a group of lights to a predefined scene
.. code-block:: python
my_bridge.set_group(1, scene='AB34EF5')
Set a group of lights to a predefined color
.. code-block:: python
my_bridge.set_group(1, color)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/hue/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Hue/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-hue",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, hue, philips, bulb, light, bridge",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/27/46/91db5da81c9244cb4b068bb823ee667da15e322ff25d32851723447a9ba0/adafruit_circuitpython_hue-2.0.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-hue/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/hue/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Hue/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Hue/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython helper library for Philips Hue Lights.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit CircuitPython SimpleIO <https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO>`_\n* `Adafruit CircuitPython ESP32SPI <https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-hue/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-hue\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-hue\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-hue\n\nUsage Example\n=============\n\nLoad bridge username and IP Address from settings.toml file:\n\n.. code-block:: python\n\n username = os.getenv(\"hue_username\")\n bridge_ip = os.getenv(\"bridge_ip\")\n my_bridge = Bridge(wifi, bridge_ip, username)\n\nEnumerate all lights on the bridge\n\n.. code-block:: python\n\n lights = my_bridge.get_lights()\n\nTurn on a light\n\n.. code-block:: python\n\n my_bridge.set_light(1, on=True)\n\nTurn off a light\n\n.. code-block:: python\n\n my_bridge.set_light(1, on=False)\n\nSet a light to the color yellow (RGB)\n\n.. code-block:: python\n\n color = my_bridge.rgb_to_hsb([255, 255, 0])\n my_bridge.set_light(1, hue=int(color[0]), sat=int(color[1]), bri=int(color[2]))\n\nSet a group of lights to a predefined scene\n\n.. code-block:: python\n\n my_bridge.set_group(1, scene='AB34EF5')\n\nSet a group of lights to a predefined color\n\n.. code-block:: python\n\n my_bridge.set_group(1, color)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/hue/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_Hue/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for the Philips Hue",
"version": "2.0.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Hue"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" hue",
" philips",
" bulb",
" light",
" bridge"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0ddf951d5842c56dd6cd198bc125d01f9c9302337cd0788e471fbe8e9c6dd2c1",
"md5": "7614473325d8fbd708351252ae0a52ae",
"sha256": "54b9bfd2ba0f79abb086fd1d512499534590e4a0bcd29c7f444d870df063989b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_hue-2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7614473325d8fbd708351252ae0a52ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6395,
"upload_time": "2025-10-20T20:45:30",
"upload_time_iso_8601": "2025-10-20T20:45:30.421877Z",
"url": "https://files.pythonhosted.org/packages/0d/df/951d5842c56dd6cd198bc125d01f9c9302337cd0788e471fbe8e9c6dd2c1/adafruit_circuitpython_hue-2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "274691db5da81c9244cb4b068bb823ee667da15e322ff25d32851723447a9ba0",
"md5": "430962a82d46529bd63b56dd850adc61",
"sha256": "fee33c06a9407965b6b0199e901f236b8624279722b3e1fae4aa09cfbe5e8e2a"
},
"downloads": -1,
"filename": "adafruit_circuitpython_hue-2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "430962a82d46529bd63b56dd850adc61",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24749,
"upload_time": "2025-10-20T20:45:31",
"upload_time_iso_8601": "2025-10-20T20:45:31.218317Z",
"url": "https://files.pythonhosted.org/packages/27/46/91db5da81c9244cb4b068bb823ee667da15e322ff25d32851723447a9ba0/adafruit_circuitpython_hue-2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 20:45:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Hue",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-simpleio",
"specs": []
},
{
"name": "adafruit-circuitpython-esp32spi",
"specs": []
},
{
"name": "adafruit-circuitpython-typing",
"specs": []
}
],
"lcname": "adafruit-circuitpython-hue"
}
JSON
