DEPRECATED - This library has been copied and renamed

The new version of this library is https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf. This old version has been archived and will not be maintained. The import name was adafruit_pypixelbuf, and is now:

import adafruit_pixelbuf

On many boards, there is a native implementation of adafruit_pixelbuf, and this Python version is not needed.

Introduction

Pure python implementation of _pixelbuf for smaller boards.

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:

pip3 install adafruit-circuitpython-pypixelbuf

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

sudo pip3 install adafruit-circuitpython-pypixelbuf

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-pypixelbuf

Usage Example

This example tests that pypixelbuf works.

class TestBuf(adafruit_pypixelbuf.PixelBuf):
    called = False

    def show(self):
        self.called = True


buffer = TestBuf(20, bytearray(20 * 3), "RGB", 1.0, auto_write=True)
buffer[0] = (1, 2, 3)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.