Adafruit CircuitPython NeoPixel¶
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,
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,
on the web) is equivalent to
(0x10, 0, 0).
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.
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
import board import neopixel pixels = neopixel.NeoPixel(board.NEOPIXEL, 1) pixels = (10, 0, 0)
This example demonstrates the library with the ten built-in NeoPixels on the
Circuit Playground Express. It turns
auto_write so that all pixels are updated at once when the
method is called.
import board import neopixel pixels = neopixel.NeoPixel(board.NEOPIXEL, 10, auto_write=False) pixels = (10, 0, 0) pixels = (0, 10, 0) pixels.show()
This example demonstrates using a single NeoPixel tied to a GPIO pin and with
pixel_order to specify the color channel order. Note that
bpp does not
need to be specified as it is computed from the supplied
import board import neopixel pixel = neopixel.NeoPixel(board.D0, 1, pixel_order=neopixel.RGBW) pixel = (30, 0, 20, 10)
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
To build this library locally you’ll need to install the circuitpython-build-tools package.
python3 -m venv .env source .env/bin/activate pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
Then run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-neopixel --library_location .
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .env source .env/bin/activate pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
cd docs sphinx-build -E -W -b html . _build/html
This will output the documentation to
docs/_build/html. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.