138 lines
4.1 KiB
Text
138 lines
4.1 KiB
Text
Metadata-Version: 2.1
|
|
Name: adafruit-circuitpython-pixelbuf
|
|
Version: 2.0.4
|
|
Summary: A pure Python implementation of adafruit_pixelbuf for smaller boards.
|
|
Author-email: Adafruit Industries <circuitpython@adafruit.com>
|
|
License: MIT
|
|
Project-URL: Homepage, https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf.git
|
|
Keywords: adafruit,blinka,circuitpython,micropython,pixelbuf,neopixel,dotstar,leds
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Topic :: Software Development :: Libraries
|
|
Classifier: Topic :: Software Development :: Embedded Systems
|
|
Classifier: Topic :: System :: Hardware
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Programming Language :: Python :: 3
|
|
Description-Content-Type: text/x-rst
|
|
License-File: LICENSE
|
|
Requires-Dist: Adafruit-Blinka
|
|
Provides-Extra: optional
|
|
|
|
Introduction
|
|
============
|
|
|
|
|
|
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pixelbuf/badge/?version=latest
|
|
:target: https://docs.circuitpython.org/projects/pixelbuf/en/latest/
|
|
:alt: Documentation Status
|
|
|
|
|
|
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
|
|
:target: https://adafru.it/discord
|
|
:alt: Discord
|
|
|
|
|
|
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf/workflows/Build%20CI/badge.svg
|
|
:target: https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf/actions
|
|
:alt: Build Status
|
|
|
|
|
|
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
:target: https://github.com/psf/black
|
|
:alt: Code Style: Black
|
|
|
|
A pure Python implementation of adafruit_pixelbuf for smaller boards.
|
|
|
|
|
|
Dependencies
|
|
=============
|
|
This driver depends on:
|
|
|
|
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
|
|
|
|
Please ensure all dependencies are available on the CircuitPython filesystem.
|
|
This is easily achieved by downloading
|
|
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
|
|
or individual libraries can be installed using
|
|
`circup <https://github.com/adafruit/circup>`_.
|
|
|
|
|
|
Installing from PyPI
|
|
=====================
|
|
|
|
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
|
|
PyPI <https://pypi.org/project/adafruit-circuitpython-pixelbuf/>`_.
|
|
To install for current user:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip3 install adafruit-circuitpython-pixelbuf
|
|
|
|
To install system-wide (this may be required in some cases):
|
|
|
|
.. code-block:: shell
|
|
|
|
sudo pip3 install adafruit-circuitpython-pixelbuf
|
|
|
|
To install in a virtual environment in your current project:
|
|
|
|
.. code-block:: shell
|
|
|
|
mkdir project-name && cd project-name
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
pip3 install adafruit-circuitpython-pixelbuf
|
|
|
|
|
|
Installing to a Connected CircuitPython Device with Circup
|
|
==========================================================
|
|
|
|
Make sure that you have ``circup`` installed in your Python environment.
|
|
Install it with the following command if necessary:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip3 install circup
|
|
|
|
With ``circup`` installed and your CircuitPython device connected use the
|
|
following command to install:
|
|
|
|
.. code-block:: shell
|
|
|
|
circup install adafruit_pixelbuf
|
|
|
|
Or the following command to update an existing version:
|
|
|
|
.. code-block:: shell
|
|
|
|
circup update
|
|
|
|
Usage Example
|
|
=============
|
|
|
|
This example tests that pixelbuf works.
|
|
|
|
.. code-block:: python
|
|
|
|
class TestBuf(adafruit_pixelbuf.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 <https://docs.circuitpython.org/projects/pixelbuf/en/latest/>`_.
|
|
|
|
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
|
|
|
|
Contributing
|
|
============
|
|
|
|
Contributions are welcome! Please read our `Code of Conduct
|
|
<https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf/blob/HEAD/CODE_OF_CONDUCT.md>`_
|
|
before contributing to help this project stay welcoming.
|