adafruit-circuitpython-pixie


Nameadafruit-circuitpython-pixie JSON
Version 1.2.16 PyPI version JSON
download
home_page
SummaryCircuitPython library for Pixie chainable 3W smart LED.
upload_time2023-12-09 17:32:04
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit pixie smart led breakout hardware micropython circuitpython
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pixie/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/pixie/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_Pixie/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_Pixie/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

.. A driver for Pixie - 3W Chainable Smart LED Pixel

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

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-pixie/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-pixie

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-pixie

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-pixie

Usage Example
=============

.. code-block:: python

    import time
    import board
    from rainbowio import colorwheel
    import adafruit_pixie
    import busio

    uart = busio.UART(board.TX, rx=None, baudrate=115200)

    num_pixies = 2  # Change this to the number of Pixies LEDs you have.
    pixies = adafruit_pixie.Pixie(uart, num_pixies, brightness=0.2, auto_write=False)


    while True:
    for i in range(255):
        for pixie in range(num_pixies):
            pixies[pixie] = colorwheel(i)
        pixies.show()

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pixie/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_pixie/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-pixie",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,pixie,smart,led,breakout,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/1c/c4/038168f15022f4dc607215d636a49a2c5bec74b87f40a7e1a492e1c896a6/adafruit-circuitpython-pixie-1.2.16.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pixie/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/pixie/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_Pixie/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_Pixie/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\n.. A driver for Pixie - 3W Chainable Smart LED Pixel\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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-pixie/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-pixie\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-pixie\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-pixie\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import time\n    import board\n    from rainbowio import colorwheel\n    import adafruit_pixie\n    import busio\n\n    uart = busio.UART(board.TX, rx=None, baudrate=115200)\n\n    num_pixies = 2  # Change this to the number of Pixies LEDs you have.\n    pixies = adafruit_pixie.Pixie(uart, num_pixies, brightness=0.2, auto_write=False)\n\n\n    while True:\n    for i in range(255):\n        for pixie in range(num_pixies):\n            pixies[pixie] = colorwheel(i)\n        pixies.show()\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pixie/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_pixie/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for Pixie chainable 3W smart LED.",
    "version": "1.2.16",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Pixie"
    },
    "split_keywords": [
        "adafruit",
        "pixie",
        "smart",
        "led",
        "breakout",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "56fcf4d388da58f625bed4c09538ee234a8129743c289b5e120142b79d30c98f",
                "md5": "64d3af17da5c0d493e9dcfd575584521",
                "sha256": "b6c55ec23f2ac5eae8d1222f4b1a0d607cff02ce2f436fb42446c9a015848381"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pixie-1.2.16-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64d3af17da5c0d493e9dcfd575584521",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5222,
            "upload_time": "2023-12-09T17:32:01",
            "upload_time_iso_8601": "2023-12-09T17:32:01.906491Z",
            "url": "https://files.pythonhosted.org/packages/56/fc/f4d388da58f625bed4c09538ee234a8129743c289b5e120142b79d30c98f/adafruit_circuitpython_pixie-1.2.16-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1cc4038168f15022f4dc607215d636a49a2c5bec74b87f40a7e1a492e1c896a6",
                "md5": "d497bf2963a43b6c56da23c0a5c9c190",
                "sha256": "c8bc53c0ed2da116b987f8303a21e37773a4ca5ec7e6b49822f9f7d7a5d77ea7"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-pixie-1.2.16.tar.gz",
            "has_sig": false,
            "md5_digest": "d497bf2963a43b6c56da23c0a5c9c190",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26376,
            "upload_time": "2023-12-09T17:32:04",
            "upload_time_iso_8601": "2023-12-09T17:32:04.487109Z",
            "url": "https://files.pythonhosted.org/packages/1c/c4/038168f15022f4dc607215d636a49a2c5bec74b87f40a7e1a492e1c896a6/adafruit-circuitpython-pixie-1.2.16.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:32:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_Pixie",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-pixie"
}
        
Elapsed time: 0.34951s