/Adafruit_CircuitPython_Pypixelbuf

Pure python implementation of _pixelbuf for smaller boards

Primary LanguagePythonOtherNOASSERTION

Introduction

Documentation Status Discord Build Status

Pure python implementation of _pixelbuf for smaller boards.

Dependencies

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.

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)

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.