Python
Need help with Adafruit_CircuitPython_NeoPixel?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
adafruit

Description

CircuitPython drivers for neopixels.

149 Stars 55 Forks MIT License 134 Commits 1 Opened issues

Services available

Need anything else?

Adafruit CircuitPython NeoPixel

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopixel/badge/?version=latest :target: https://circuitpython.readthedocs.io/projects/neopixel/en/latest/ :alt: Documentation Status

.. image :: https://img.shields.io/discord/327254708534116352.svg :target: https://adafru.it/discord :alt: Discord

.. image:: https://github.com/adafruit/AdafruitCircuitPythonNeoPixel/workflows/Build%20CI/badge.svg :target: https://github.com/adafruit/AdafruitCircuitPythonNeoPixel/actions/ :alt: Build Status

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 
    _

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading

the Adafruit library and driver bundle 
_.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally

from
PyPI 
_. 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 .env
source .env/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 
_ and
Metro M0 Express 
_.

.. 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 
. It turns off ``autowrite
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)

Contributing

Contributions are welcome! Please read our

Code of Conduct
_ before contributing to help this project stay welcoming.

Documentation

For information on building library documentation, please check out

this guide 
_.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.