README.rst

Introduction

SPI driven CircuitPython driver for NeoPixels.

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Bus Device
• Pypixelbuf

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:

pip3 install adafruit-circuitpython-neopixel-spi

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-neopixel-spi

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-neopixel-spi

Usage Example

import board
import neopixel_spi

pixels = neopixel_spi.NeoPixel_SPI(board.SPI(), 10)
pixels.fill(0xff0000)

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.