Adafruit CircuitPython NeoPixel
===============================
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopixel/badge/?version=latest
:target: https://docs.circuitpython.org/projects/neopixel/en/latest/
:alt: Documentation Status
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/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
Higher level NeoPixel driver that presents the strip as a sequence. This is a
supercharged version of the original MicroPython driver. Its now more like a
normal Python sequence and features slice support, ``repr`` and ``len`` support.
Colors are stored as tuples by default. However, you can also use int hex syntax
to set values similar to colors on the web. For example, ``0x100000`` (``#100000``
on the web) is equivalent to ``(0x10, 0, 0)``.
.. note:: The int hex API represents the brightness of the white pixel when
present by setting the RGB channels to identical values. For example, full
white is 0xffffff but is actually (0, 0, 0, 0xff) in the tuple syntax. Setting
a pixel value with an int will use the white pixel if the RGB channels are
identical. For full, independent, control of each color component use the
tuple syntax.
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-neopixel/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-neopixel
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-neopixel
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
Usage Example
=============
This example demonstrates the library with the single built-in NeoPixel on the
`Feather M0 Express <https://www.adafruit.com/product/3403>`_ and
`Metro M0 Express <https://www.adafruit.com/product/3505>`_.
.. code-block:: python
import board
import neopixel
pixels = neopixel.NeoPixel(board.NEOPIXEL, 1)
pixels[0] = (10, 0, 0)
This example demonstrates the library with the ten built-in NeoPixels on the
`Circuit Playground Express <https://www.adafruit.com/product/3333>`_. It turns
off ``auto_write`` so that all pixels are updated at once when the ``show``
method is called.
.. code-block:: python
import board
import neopixel
pixels = neopixel.NeoPixel(board.NEOPIXEL, 10, auto_write=False)
pixels[0] = (10, 0, 0)
pixels[9] = (0, 10, 0)
pixels.show()
This example demonstrates using a single NeoPixel tied to a GPIO pin and with
a ``pixel_order`` to specify the color channel order. Note that ``bpp`` does not
need to be specified as it is computed from the supplied ``pixel_order``.
.. code-block:: python
import board
import neopixel
pixel = neopixel.NeoPixel(board.D0, 1, pixel_order=neopixel.RGBW)
pixel[0] = (30, 0, 20, 10)
Setup for sudo-less usage on Raspberry Pi boards
================================================
1. Enable both SPI and Serial port hardware (Serial interface). Do it by ``raspi-config`` tool or manually by adding
::
dtparam=spi=on
enable_uart=1
to the ``/boot/config.txt``
2. Reboot the Pi to apply the changes - the hardware setup takes place during boot.
3. Connect LED's DIN to ``GPIO10`` (physical pin 19)
When initializing the ``NeoPixel`` object **always** do it with ``board.D10`` (GPIO10)
.. code-block:: python
import board
import neopixel
DATA_PIN = board.D10
pixel = neopixel.NeoPixel(DATA_PIN, ...)
Now you can execute the code using ``python`` without ``sudo``
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopixel/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/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-neopixel",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,neopixel,rgb,rgbw,led,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ce/85/f396283caeb925e6bff883f9c2078ac3f204ed9d5be63565fc223037541f/adafruit-circuitpython-neopixel-6.3.9.tar.gz",
"platform": null,
"description": "\nAdafruit CircuitPython NeoPixel\n===============================\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopixel/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/neopixel/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/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\nHigher level NeoPixel driver that presents the strip as a sequence. This is a\nsupercharged version of the original MicroPython driver. Its now more like a\nnormal Python sequence and features slice support, ``repr`` and ``len`` support.\n\nColors are stored as tuples by default. However, you can also use int hex syntax\nto set values similar to colors on the web. For example, ``0x100000`` (``#100000``\non the web) is equivalent to ``(0x10, 0, 0)``.\n\n.. note:: The int hex API represents the brightness of the white pixel when\n present by setting the RGB channels to identical values. For example, full\n white is 0xffffff but is actually (0, 0, 0, 0xff) in the tuple syntax. Setting\n a pixel value with an int will use the white pixel if the RGB channels are\n identical. For full, independent, control of each color component use the\n tuple syntax.\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====================\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/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-neopixel\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\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\n\nUsage Example\n=============\n\nThis example demonstrates the library with the single built-in NeoPixel on the\n`Feather M0 Express <https://www.adafruit.com/product/3403>`_ and\n`Metro M0 Express <https://www.adafruit.com/product/3505>`_.\n\n.. code-block:: python\n\n import board\n import neopixel\n\n pixels = neopixel.NeoPixel(board.NEOPIXEL, 1)\n pixels[0] = (10, 0, 0)\n\nThis example demonstrates the library with the ten built-in NeoPixels on the\n`Circuit Playground Express <https://www.adafruit.com/product/3333>`_. It turns\noff ``auto_write`` so that all pixels are updated at once when the ``show``\nmethod is called.\n\n.. code-block:: python\n\n import board\n import neopixel\n\n pixels = neopixel.NeoPixel(board.NEOPIXEL, 10, auto_write=False)\n pixels[0] = (10, 0, 0)\n pixels[9] = (0, 10, 0)\n pixels.show()\n\nThis example demonstrates using a single NeoPixel tied to a GPIO pin and with\na ``pixel_order`` to specify the color channel order. Note that ``bpp`` does not\nneed to be specified as it is computed from the supplied ``pixel_order``.\n\n.. code-block:: python\n\n import board\n import neopixel\n\n pixel = neopixel.NeoPixel(board.D0, 1, pixel_order=neopixel.RGBW)\n pixel[0] = (30, 0, 20, 10)\n\nSetup for sudo-less usage on Raspberry Pi boards\n================================================\n1. Enable both SPI and Serial port hardware (Serial interface). Do it by ``raspi-config`` tool or manually by adding\n\n ::\n\n dtparam=spi=on\n enable_uart=1\n\n to the ``/boot/config.txt``\n\n2. Reboot the Pi to apply the changes - the hardware setup takes place during boot.\n3. Connect LED's DIN to ``GPIO10`` (physical pin 19)\n\nWhen initializing the ``NeoPixel`` object **always** do it with ``board.D10`` (GPIO10)\n\n.. code-block:: python\n\n import board\n import neopixel\n\n DATA_PIN = board.D10\n pixel = neopixel.NeoPixel(DATA_PIN, ...)\n\nNow you can execute the code using ``python`` without ``sudo``\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopixel/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/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for NeoPixel LEDs.",
"version": "6.3.9",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel"
},
"split_keywords": [
"adafruit",
"neopixel",
"rgb",
"rgbw",
"led",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0839193692b0731f0ee0fe26aa5a7191a6c0e66ad6aa37dd2b013239db0c6928",
"md5": "2713f70bee274232c7ea34f09aaa915f",
"sha256": "f08bfd9e0b463b2efc7847029e9fa4608240267416c7440e81157d71a4cb6d0c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_neopixel-6.3.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2713f70bee274232c7ea34f09aaa915f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6417,
"upload_time": "2023-05-26T16:05:47",
"upload_time_iso_8601": "2023-05-26T16:05:47.908502Z",
"url": "https://files.pythonhosted.org/packages/08/39/193692b0731f0ee0fe26aa5a7191a6c0e66ad6aa37dd2b013239db0c6928/adafruit_circuitpython_neopixel-6.3.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce85f396283caeb925e6bff883f9c2078ac3f204ed9d5be63565fc223037541f",
"md5": "6bc913d68eb6f75b4920c6d1dedddd96",
"sha256": "a0f483d594a3cdd347b7f03fcd75b000dc74326d1b5f5e61ba800518996ae91b"
},
"downloads": -1,
"filename": "adafruit-circuitpython-neopixel-6.3.9.tar.gz",
"has_sig": false,
"md5_digest": "6bc913d68eb6f75b4920c6d1dedddd96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28529,
"upload_time": "2023-05-26T16:05:49",
"upload_time_iso_8601": "2023-05-26T16:05:49.345182Z",
"url": "https://files.pythonhosted.org/packages/ce/85/f396283caeb925e6bff883f9c2078ac3f204ed9d5be63565fc223037541f/adafruit-circuitpython-neopixel-6.3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 16:05:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_NeoPixel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-neopixel"
}
JSON
