Metadata-Version: 2.1
Name: adafruit-circuitpython-matrixportal
Version: 3.0.10
Summary: CircuitPython helper for Adafruit MatrixPortal M4, Adafruit RGB Matrix Shield + Metro M4 Airlift Lite, and Adafruit RGB Matrix FeatherWings
Author-email: Adafruit Industries <circuitpython@adafruit.com>
License: MIT
Project-URL: Homepage, https://github.com/adafruit/Adafruit_CircuitPython_MatrixPortal
Keywords: adafruit,matrixportal,matrix,rgb,led,feather,featherwing,shieldbreakout,hardware,micropython,circuitpython
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
Provides-Extra: optional
License-File: LICENSE

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-matrixportal/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/matrixportal/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_MatrixPortal/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_MatrixPortal/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 helper for Adafruit MatrixPortal M4, Adafruit RGB Matrix Shield + Metro M4 Airlift Lite,
and Adafruit RGB Matrix FeatherWings


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>`_.

Usage Example
=============

.. code:: python

    import time
    import board
    import terminalio
    from adafruit_matrixportal.matrixportal import MatrixPortal

    # --- Display setup ---
    matrixportal = MatrixPortal(status_neopixel=board.NEOPIXEL, debug=True)

    # Create a new label with the color and text selected
    matrixportal.add_text(
        text_font=terminalio.FONT,
        text_position=(0, (matrixportal.graphics.display.height // 2) - 1),
        scrolling=True,
    )

    SCROLL_DELAY = 0.03

    contents = [
        { 'text': 'THIS IS RED',  'color': '#cf2727'},
        { 'text': 'THIS IS BLUE', 'color': '#0846e4'},
    ]

    while True:
        for content in contents:
            matrixportal.set_text(content['text'])

            # Set the text color
            matrixportal.set_text_color(content['color'])

            # Scroll it
            matrixportal.scroll_text(SCROLL_DELAY)

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/matrixportal/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_MatrixPortal/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
