Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pixel-framebuf/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pixel_framebuf/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_Pixel_Framebuf/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Pixel_Framebuf/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
Neopixel and Dotstar Framebuffer Helper
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit LED Animation <https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation>`_
* `Adafruit framebuf <https://github.com/adafruit/Adafruit_CircuitPython_framebuf>`_
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>`_.
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-pixel_framebuf/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-pixel-framebuf
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-pixel-framebuf
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-pixel-framebuf
Usage Example
=============
.. code-block:: python
"""
This example runs on an Adafruit NeoPixel Feather
"""
import board
import neopixel
from adafruit_pixel_framebuf import PixelFramebuffer
pixel_pin = board.D6
pixel_width = 8
pixel_height = 4
pixels = neopixel.NeoPixel(
pixel_pin,
pixel_width * pixel_height,
brightness=0.1,
auto_write=False,
)
pixel_framebuf = PixelFramebuffer(
pixels,
pixel_width,
pixel_height,
alternating=False,
)
pixel_framebuf.fill(0x000088)
pixel_framebuf.pixel(5, 1, 0xFFFF00)
pixel_framebuf.line(0, 0, pixel_width - 1, pixel_height - 1, 0x00FF00)
pixel_framebuf.display()
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pixel_framebuf/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_Pixel_Framebuf/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-pixel-framebuf",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,pixel_framebuf,neopixel,framebuf,framebuffer,dotstar,matrix,animation,led,ws2812,ap102",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/6a/e6/bebe6ec11d6ff5d598c872df6fe17b293d60e5b6b9d3619acea7cf9733d0/adafruit-circuitpython-pixel-framebuf-1.1.13.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pixel-framebuf/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/pixel_framebuf/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Pixel_Framebuf/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Pixel_Framebuf/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nNeopixel and Dotstar Framebuffer Helper\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit LED Animation <https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation>`_\n* `Adafruit framebuf <https://github.com/adafruit/Adafruit_CircuitPython_framebuf>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-pixel_framebuf/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-pixel-framebuf\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-pixel-framebuf\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-pixel-framebuf\n\nUsage Example\n=============\n\n.. code-block:: python\n\n \"\"\"\n This example runs on an Adafruit NeoPixel Feather\n \"\"\"\n import board\n import neopixel\n from adafruit_pixel_framebuf import PixelFramebuffer\n\n pixel_pin = board.D6\n pixel_width = 8\n pixel_height = 4\n\n pixels = neopixel.NeoPixel(\n pixel_pin,\n pixel_width * pixel_height,\n brightness=0.1,\n auto_write=False,\n )\n\n pixel_framebuf = PixelFramebuffer(\n pixels,\n pixel_width,\n pixel_height,\n alternating=False,\n )\n\n pixel_framebuf.fill(0x000088)\n pixel_framebuf.pixel(5, 1, 0xFFFF00)\n pixel_framebuf.line(0, 0, pixel_width - 1, pixel_height - 1, 0x00FF00)\n pixel_framebuf.display()\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pixel_framebuf/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_Pixel_Framebuf/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Neopixel and Dotstar Framebuffer Helper",
"version": "1.1.13",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Pixel_Framebuf"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"pixel_framebuf",
"neopixel",
"framebuf",
"framebuffer",
"dotstar",
"matrix",
"animation",
"led",
"ws2812",
"ap102"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "069e4b3c10d2c614cea7e54aff44e3f53ab7c42ec95d2cbe2359f33a643da624",
"md5": "126f41ae9f7050d671a1720a25f402ee",
"sha256": "3e16aa22acf3b134d96f9b55387ab09d0a46942405c5ad80e3bc444b56779883"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pixel_framebuf-1.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "126f41ae9f7050d671a1720a25f402ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5422,
"upload_time": "2023-12-09T17:46:30",
"upload_time_iso_8601": "2023-12-09T17:46:30.834796Z",
"url": "https://files.pythonhosted.org/packages/06/9e/4b3c10d2c614cea7e54aff44e3f53ab7c42ec95d2cbe2359f33a643da624/adafruit_circuitpython_pixel_framebuf-1.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ae6bebe6ec11d6ff5d598c872df6fe17b293d60e5b6b9d3619acea7cf9733d0",
"md5": "85903594f1bfc6f61752a1f830f41b18",
"sha256": "0e295d61ebd35bec130e8047309c17342fc4679485d267745c4f702185f845aa"
},
"downloads": -1,
"filename": "adafruit-circuitpython-pixel-framebuf-1.1.13.tar.gz",
"has_sig": false,
"md5_digest": "85903594f1bfc6f61752a1f830f41b18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31023,
"upload_time": "2023-12-09T17:46:31",
"upload_time_iso_8601": "2023-12-09T17:46:31.858309Z",
"url": "https://files.pythonhosted.org/packages/6a/e6/bebe6ec11d6ff5d598c872df6fe17b293d60e5b6b9d3619acea7cf9733d0/adafruit-circuitpython-pixel-framebuf-1.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:46:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Pixel_Framebuf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-pixel-framebuf"
}
JSON
