adafruit-circuitpython-pixelmap


Nameadafruit-circuitpython-pixelmap JSON
Version 1.0.5 PyPI version JSON
download
home_pageNone
SummaryCircuitPython library for mapping multiple neopixels to behave as one for the purposes of setting colors or showing animations.
upload_time2024-10-07 22:32:17
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython pixelmap led neopixel lights rgb animation led_animation
VCS
bugtrack_url
requirements Adafruit-Blinka
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-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/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

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/fa/f6f52f8c4646387b19bcc2ce8e13e3d688f6e4211b69ef49875be9aabe39/adafruit_circuitpython_pixelmap-1.0.5.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-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/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\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.5",
    "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": "",
            "digests": {
                "blake2b_256": "03164dd79228291c9018886f4306e8cbda104ec415956b90e84e51b72ceb7e8e",
                "md5": "7d68bc3122ccc920e58a59342886b26d",
                "sha256": "3811f5e05e43196a69c26d7db6fee3f746b488f88c8bbfee0bfc0e67be70ddbe"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pixelmap-1.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7d68bc3122ccc920e58a59342886b26d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6499,
            "upload_time": "2024-10-07T22:32:16",
            "upload_time_iso_8601": "2024-10-07T22:32:16.008317Z",
            "url": "https://files.pythonhosted.org/packages/03/16/4dd79228291c9018886f4306e8cbda104ec415956b90e84e51b72ceb7e8e/adafruit_circuitpython_pixelmap-1.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "89faf6f52f8c4646387b19bcc2ce8e13e3d688f6e4211b69ef49875be9aabe39",
                "md5": "16765b253777170a2d70b63bcc636d59",
                "sha256": "d297ad7223dbef50b33ae743e713877b35b7c7355302649e01f74aa07a301b29"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pixelmap-1.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "16765b253777170a2d70b63bcc636d59",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27988,
            "upload_time": "2024-10-07T22:32:17",
            "upload_time_iso_8601": "2024-10-07T22:32:17.696984Z",
            "url": "https://files.pythonhosted.org/packages/89/fa/f6f52f8c4646387b19bcc2ce8e13e3d688f6e4211b69ef49875be9aabe39/adafruit_circuitpython_pixelmap-1.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:32:17",
    "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"
}
        
Elapsed time: 0.34988s