Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-pixelmap/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pixelmap/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_PixelMap/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PixelMap/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython library for mapping multiple neopixels to behave as one for the purposes of setting colors or showing animations.
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>`_.
* `NeoPixel Products <https://www.adafruit.com/category/168>`_
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-pixelmap/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-pixelmap
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-pixelmap
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-pixelmap
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_pixelmap
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
import neopixel
import time
from adafruit_pixelmap import PixelMap, horizontal_strip_gridmap, vertical_strip_gridmap
# Update to match the pin connected to your NeoPixels
pixel_pin = board.NEOPIXEL
# Update to match the number of NeoPixels you have connected
pixel_num = 32
pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.1, auto_write=True)
pixel_wing_vertical = PixelMap.vertical_lines(
pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
)
pixel_wing_horizontal = PixelMap.horizontal_lines(
pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
)
for row in range(len(pixel_wing_horizontal)):
pixels.fill(0x00000)
pixel_wing_horizontal[row] = 0x00ff00
time.sleep(0.3)
for row in range(len(pixel_wing_vertical)):
pixels.fill(0x00000)
pixel_wing_vertical[row] = 0xff00ff
time.sleep(0.3)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pixelmap/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_PixelMap/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-pixelmap",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, pixelmap, led, neopixel, lights, rgb, animation, led_animation",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/89/ed/72848a79e774d47859407ed1b49696b87aed80124eba3365121cedf8a7cf/adafruit_circuitpython_pixelmap-1.0.10.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-pixelmap/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/pixelmap/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PixelMap/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_PixelMap/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython library for mapping multiple neopixels to behave as one for the purposes of setting colors or showing animations.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n* `NeoPixel Products <https://www.adafruit.com/category/168>`_\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-pixelmap/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-pixelmap\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-pixelmap\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 .env/bin/activate\n pip3 install adafruit-circuitpython-pixelmap\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_pixelmap\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import neopixel\n import time\n from adafruit_pixelmap import PixelMap, horizontal_strip_gridmap, vertical_strip_gridmap\n\n # Update to match the pin connected to your NeoPixels\n pixel_pin = board.NEOPIXEL\n\n # Update to match the number of NeoPixels you have connected\n pixel_num = 32\n\n pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.1, auto_write=True)\n\n pixel_wing_vertical = PixelMap.vertical_lines(\n pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)\n )\n pixel_wing_horizontal = PixelMap.horizontal_lines(\n pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)\n )\n\n for row in range(len(pixel_wing_horizontal)):\n pixels.fill(0x00000)\n pixel_wing_horizontal[row] = 0x00ff00\n time.sleep(0.3)\n\n for row in range(len(pixel_wing_vertical)):\n pixels.fill(0x00000)\n pixel_wing_vertical[row] = 0xff00ff\n time.sleep(0.3)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pixelmap/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_PixelMap/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for mapping multiple neopixels to behave as one for the purposes of setting colors or showing animations.",
"version": "1.0.10",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PixelMap"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" pixelmap",
" led",
" neopixel",
" lights",
" rgb",
" animation",
" led_animation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e87ced61a8000fc1efb2d31fca1435488dfe0902d52c68fae9d4369bf90cea00",
"md5": "3fcfdeb752ea129134b5cab11e6b6f11",
"sha256": "dcdec78044dbc065ec0eca2f254281a6b3890c67ba719e44811f9a0b464a35f4"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pixelmap-1.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fcfdeb752ea129134b5cab11e6b6f11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6526,
"upload_time": "2025-10-20T20:44:06",
"upload_time_iso_8601": "2025-10-20T20:44:06.812898Z",
"url": "https://files.pythonhosted.org/packages/e8/7c/ed61a8000fc1efb2d31fca1435488dfe0902d52c68fae9d4369bf90cea00/adafruit_circuitpython_pixelmap-1.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "89ed72848a79e774d47859407ed1b49696b87aed80124eba3365121cedf8a7cf",
"md5": "f6000ed41d410750c613734508a17795",
"sha256": "d681c9480c7ce5ca6b792d7777ba98d72d9c9e5d73ebc7825f0786aaef31a733"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pixelmap-1.0.10.tar.gz",
"has_sig": false,
"md5_digest": "f6000ed41d410750c613734508a17795",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24823,
"upload_time": "2025-10-20T20:44:08",
"upload_time_iso_8601": "2025-10-20T20:44:08.381678Z",
"url": "https://files.pythonhosted.org/packages/89/ed/72848a79e774d47859407ed1b49696b87aed80124eba3365121cedf8a7cf/adafruit_circuitpython_pixelmap-1.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 20:44:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_PixelMap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-pixelmap"
}
JSON
