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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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 secrets.py file:
.. code-block:: python
username = secrets['hue_username']
bridge_ip = secrets['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": "",
"name": "adafruit-circuitpython-hue",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,hue,philips,bulb,light,bridge",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/f6/3b/23cd9c3e7f086555217db4781b9ba17d0c6cf6c4e8690ce009d9419ff88b/adafruit-circuitpython-hue-1.2.6.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/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\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 secrets.py file:\n\n.. code-block:: python\n\n username = secrets['hue_username']\n bridge_ip = secrets['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": "1.2.6",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Hue"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"hue",
"philips",
"bulb",
"light",
"bridge"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25d683a18822ddb008e358b763cda0c23aa199ca989fd532a79156d32732499b",
"md5": "61428f566484c781cb2dc38c4774f117",
"sha256": "f1695c68c0e4f64047500e6a774883aeac37a6927e22582567c11c8159560995"
},
"downloads": -1,
"filename": "adafruit_circuitpython_hue-1.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61428f566484c781cb2dc38c4774f117",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6306,
"upload_time": "2023-12-09T17:45:11",
"upload_time_iso_8601": "2023-12-09T17:45:11.126362Z",
"url": "https://files.pythonhosted.org/packages/25/d6/83a18822ddb008e358b763cda0c23aa199ca989fd532a79156d32732499b/adafruit_circuitpython_hue-1.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f63b23cd9c3e7f086555217db4781b9ba17d0c6cf6c4e8690ce009d9419ff88b",
"md5": "52400b96197963324d30a2b9ffbe718a",
"sha256": "e169d1c99071431d25429edc70e654ccf64ba823efbbdfc1f1a57fd5f2426f66"
},
"downloads": -1,
"filename": "adafruit-circuitpython-hue-1.2.6.tar.gz",
"has_sig": false,
"md5_digest": "52400b96197963324d30a2b9ffbe718a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27917,
"upload_time": "2023-12-09T17:45:13",
"upload_time_iso_8601": "2023-12-09T17:45:13.383461Z",
"url": "https://files.pythonhosted.org/packages/f6/3b/23cd9c3e7f086555217db4781b9ba17d0c6cf6c4e8690ce009d9419ff88b/adafruit-circuitpython-hue-1.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:45:13",
"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": [],
"lcname": "adafruit-circuitpython-hue"
}
JSON
