Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopxl8/badge/?version=latest
:target: https://docs.circuitpython.org/projects/neopxl8/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_neopxl8/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_neopxl8/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
PIO-driven 8-way concurrent NeoPixel driver for RP2040
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `pioasm <https://github.com/adafruit/Adafruit_CircuitPython_pioasm>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install neopxl8
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See the `Examples page <examples.html>`_ for a full example. This example shows how to set up 8 30-pixel LED strands on an Adafruit Feather Scorpio RP2040 and set them all to dim red:
.. code-block:: python
import time
import board
from adafruit_neopxl8 import NeoPxl8
# Customize for your strands here
num_strands = 8
strand_length = 30
first_led_pin = board.NEOPIXEL0
num_pixels = num_strands * strand_length
# Make the object to control the pixels
pixels = NeoPxl8(
first_led_pin,
num_pixels,
num_strands=num_strands,
)
pixels.fill(0x01_00_00)
while True:
time.sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopxl8/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_neopxl8/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-neopxl8",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,neopxl8,neopixel,rp2040,rgb,rgbw,led,animation",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/51/c0/db1d62a65bf90f6e38fb56cd24ef05c5bb28be5e8e352389bde327aea53b/adafruit-circuitpython-neopxl8-0.2.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopxl8/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/neopxl8/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_neopxl8/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_neopxl8/actions\n :alt: Build Status\n\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\nPIO-driven 8-way concurrent NeoPixel driver for RP2040\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `pioasm <https://github.com/adafruit/Adafruit_CircuitPython_pioasm>`_\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install neopxl8\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee the `Examples page <examples.html>`_ for a full example. This example shows how to set up 8 30-pixel LED strands on an Adafruit Feather Scorpio RP2040 and set them all to dim red:\n\n.. code-block:: python\n\n import time\n import board\n from adafruit_neopxl8 import NeoPxl8\n\n # Customize for your strands here\n num_strands = 8\n strand_length = 30\n first_led_pin = board.NEOPIXEL0\n\n num_pixels = num_strands * strand_length\n\n # Make the object to control the pixels\n pixels = NeoPxl8(\n first_led_pin,\n num_pixels,\n num_strands=num_strands,\n )\n\n pixels.fill(0x01_00_00)\n\n while True:\n time.sleep(1)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopxl8/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_neopxl8/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PIO-driven 8-way concurrent NeoPixel driver for RP2040",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_neopxl8"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"neopxl8",
"neopixel",
"rp2040",
"rgb",
"rgbw",
"led",
"animation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "171a427468e9027085d8920c4262e4da14e142ccc6dd7fbbfa2dc1dd1783de59",
"md5": "ea608e2d7c0b16462756d96038a22401",
"sha256": "82db68f613ce58bb89b36c5fdc2464709e727faba35d51a6a97fd82a7749fb8d"
},
"downloads": -1,
"filename": "adafruit_circuitpython_neopxl8-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea608e2d7c0b16462756d96038a22401",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6243,
"upload_time": "2023-05-26T16:24:07",
"upload_time_iso_8601": "2023-05-26T16:24:07.115097Z",
"url": "https://files.pythonhosted.org/packages/17/1a/427468e9027085d8920c4262e4da14e142ccc6dd7fbbfa2dc1dd1783de59/adafruit_circuitpython_neopxl8-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51c0db1d62a65bf90f6e38fb56cd24ef05c5bb28be5e8e352389bde327aea53b",
"md5": "f351d55d31f461c22699d98924c9849c",
"sha256": "3edcf0f7e205a1eb707475a47048e2bdd71759cd84cf1901f7d04d7b9a0c99a5"
},
"downloads": -1,
"filename": "adafruit-circuitpython-neopxl8-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "f351d55d31f461c22699d98924c9849c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28253,
"upload_time": "2023-05-26T16:24:08",
"upload_time_iso_8601": "2023-05-26T16:24:08.710172Z",
"url": "https://files.pythonhosted.org/packages/51/c0/db1d62a65bf90f6e38fb56cd24ef05c5bb28be5e8e352389bde327aea53b/adafruit-circuitpython-neopxl8-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 16:24:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_neopxl8",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-neopxl8"
}
JSON
