Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopixel_spi/badge/?version=latest
:target: https://docs.circuitpython.org/projects/neopixel_spi/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_NeoPixel_SPI/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel_SPI/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
SPI driven CircuitPython driver for NeoPixels.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Pixelbuf <https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf>`_
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>`_.
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-neopixel_spi/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-neopixel-spi
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-neopixel-spi
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-neopixel-spi
Usage Example
=============
.. code-block:: python
import board
import neopixel_spi
pixels = neopixel_spi.NeoPixel_SPI(board.SPI(), 10)
pixels.fill(0xff0000)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopixel_spi/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_NeoPixel_SPI/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-neopixel-spi",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,neopixel_spi,neopixel",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/98/a0/d1ae227f3c4954afeb5966307b4311ebfcbb9d824811299839ae78482138/adafruit-circuitpython-neopixel-spi-1.0.7.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopixel_spi/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/neopixel_spi/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_NeoPixel_SPI/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel_SPI/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\nSPI driven CircuitPython driver for NeoPixels.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Pixelbuf <https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf>`_\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>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-neopixel_spi/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-neopixel-spi\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-neopixel-spi\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-neopixel-spi\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import neopixel_spi\n\n pixels = neopixel_spi.NeoPixel_SPI(board.SPI(), 10)\n pixels.fill(0xff0000)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopixel_spi/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_NeoPixel_SPI/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SPI driven CircuitPython driver for neopixels.",
"version": "1.0.7",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel_SPI"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"neopixel_spi",
"neopixel"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a54d8770274389a93f8f089cbeb76f6250c9f0a4846be3cd1f407bca56892ccc",
"md5": "b1513f9be848a884043688e18c3cf71c",
"sha256": "9677f8374033c3a8e22a631838b585b17164b18dac18dd84cc307026e4d0e110"
},
"downloads": -1,
"filename": "adafruit_circuitpython_neopixel_spi-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1513f9be848a884043688e18c3cf71c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5513,
"upload_time": "2023-05-26T16:25:08",
"upload_time_iso_8601": "2023-05-26T16:25:08.761421Z",
"url": "https://files.pythonhosted.org/packages/a5/4d/8770274389a93f8f089cbeb76f6250c9f0a4846be3cd1f407bca56892ccc/adafruit_circuitpython_neopixel_spi-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98a0d1ae227f3c4954afeb5966307b4311ebfcbb9d824811299839ae78482138",
"md5": "2ac406594f381a4d1ff357296fb2a187",
"sha256": "e7f41f092ff6ad20a6c21395f1bf17b92395adb003f3ff56b550f83d93385a2f"
},
"downloads": -1,
"filename": "adafruit-circuitpython-neopixel-spi-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "2ac406594f381a4d1ff357296fb2a187",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26460,
"upload_time": "2023-05-26T16:25:11",
"upload_time_iso_8601": "2023-05-26T16:25:11.312626Z",
"url": "https://files.pythonhosted.org/packages/98/a0/d1ae227f3c4954afeb5966307b4311ebfcbb9d824811299839ae78482138/adafruit-circuitpython-neopixel-spi-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 16:25:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_NeoPixel_SPI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-neopixel-spi"
}
JSON
