Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lifx/badge/?version=latest
:target: https://docs.circuitpython.org/projects/lifx/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_lifx/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_lifx
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
Control `LIFX devices <https://www.lifx.com>`_ over the internet using CircuitPython.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython Connection Manager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_
* `Adafruit CircuitPython Requests <https://github.com/adafruit/Adafruit_CircuitPython_Requests/>`_
You'll also need a library to communicate with an ESP32 as a coprocessor using a WiFiManager object. This library supports connecting an ESP32 using either SPI or UART.
* SPI: `Adafruit CircuitPython ESP32SPI <https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI>`_
* UART: `Adafruit CircuitPython ESP_ATcontrol <https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol>`_
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-lifx/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-lifx
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-lifx
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-lifx
Usage Example
=============
Initialize the LIFX API Client with a WiFiManager object and a
`LIFX Personal Access token <https://cloud.lifx.com/settings>`_:
.. code-block:: python
lifx = adafruit_lifx.LIFX(wifi, lifx_token)
Set a `LIFX selector <https://api.developer.lifx.com/docs/selectors>`_ label to identify the LIFX device to communicate with.
.. code-block:: python
lifx_light = 'label:Lamp'
List all connected LIFX devices:
.. code-block:: python
lights = lifx.list_lights()
Toggle the state of a LIFX device:
.. code-block:: python
lifx.toggle_light(lifx_light)
Set the brightness of a LIFX device to 50%:
.. code-block:: python
lifx.set_brightness(lifx_light, 0.5)
Set the color of a LIFX device to blue and the brightness to 100%:
.. code-block:: python
lifx.set_color(lifx_light, 'on', 'blue', brightness=1.0)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/lifx/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_lifx/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-lifx",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, lifx",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/b0/95/3ae9e08549e696268019f7207b3792ffdd1a2e45c5816734b038917e7d4c/adafruit_circuitpython_lifx-2.0.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lifx/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/lifx/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_lifx/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_lifx\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\nControl `LIFX devices <https://www.lifx.com>`_ over the internet using CircuitPython.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit CircuitPython Connection Manager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_\n* `Adafruit CircuitPython Requests <https://github.com/adafruit/Adafruit_CircuitPython_Requests/>`_\n\nYou'll also need a library to communicate with an ESP32 as a coprocessor using a WiFiManager object. This library supports connecting an ESP32 using either SPI or UART.\n\n* SPI: `Adafruit CircuitPython ESP32SPI <https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI>`_\n\n* UART: `Adafruit CircuitPython ESP_ATcontrol <https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol>`_\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-lifx/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-lifx\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-lifx\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-lifx\n\nUsage Example\n=============\n\nInitialize the LIFX API Client with a WiFiManager object and a\n`LIFX Personal Access token <https://cloud.lifx.com/settings>`_:\n\n.. code-block:: python\n\n lifx = adafruit_lifx.LIFX(wifi, lifx_token)\n\nSet a `LIFX selector <https://api.developer.lifx.com/docs/selectors>`_ label to identify the LIFX device to communicate with.\n\n.. code-block:: python\n\n lifx_light = 'label:Lamp'\n\nList all connected LIFX devices:\n\n.. code-block:: python\n\n lights = lifx.list_lights()\n\nToggle the state of a LIFX device:\n\n.. code-block:: python\n\n lifx.toggle_light(lifx_light)\n\nSet the brightness of a LIFX device to 50%:\n\n.. code-block:: python\n\n lifx.set_brightness(lifx_light, 0.5)\n\nSet the color of a LIFX device to blue and the brightness to 100%:\n\n.. code-block:: python\n\n lifx.set_color(lifx_light, 'on', 'blue', brightness=1.0)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/lifx/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_lifx/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "LIFX Smart Lighting API Helper",
"version": "2.0.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_lifx"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" lifx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb7fb1c21d7ab91cdafe32d6b9a8e43c4a90d9dc004dbd7d1d9632da22d1febb",
"md5": "68974628c0db302daaebc493df21c5fe",
"sha256": "3b3db5a298fc605c6921591845406e8d8c099e9f444acdab439214ec0c7765a0"
},
"downloads": -1,
"filename": "adafruit_circuitpython_lifx-2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68974628c0db302daaebc493df21c5fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5696,
"upload_time": "2024-10-07T22:31:28",
"upload_time_iso_8601": "2024-10-07T22:31:28.064897Z",
"url": "https://files.pythonhosted.org/packages/eb/7f/b1c21d7ab91cdafe32d6b9a8e43c4a90d9dc004dbd7d1d9632da22d1febb/adafruit_circuitpython_lifx-2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0953ae9e08549e696268019f7207b3792ffdd1a2e45c5816734b038917e7d4c",
"md5": "fd5160dfd7ea477574eaee3fdc20256a",
"sha256": "1de0edcc832fd9609c98719cb2196029d3cade2da88a8e44c388634311aa7f65"
},
"downloads": -1,
"filename": "adafruit_circuitpython_lifx-2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "fd5160dfd7ea477574eaee3fdc20256a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27221,
"upload_time": "2024-10-07T22:31:28",
"upload_time_iso_8601": "2024-10-07T22:31:28.901995Z",
"url": "https://files.pythonhosted.org/packages/b0/95/3ae9e08549e696268019f7207b3792ffdd1a2e45c5816734b038917e7d4c/adafruit_circuitpython_lifx-2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:31:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_lifx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-lifx"
}
JSON
