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.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-matrixportal",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, matrixportal, matrix, rgb, led, feather, featherwing, shieldbreakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d3/18/f7422995db621e203b875a1e5cc7a7641ea0c9c1ca143983ce0e8f0ce2b0/adafruit_circuitpython_matrixportal-3.2.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-matrixportal/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/matrixportal/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_MatrixPortal/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MatrixPortal/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\nCircuitPython helper for Adafruit MatrixPortal M4, Adafruit RGB Matrix Shield + Metro M4 Airlift Lite,\nand Adafruit RGB Matrix FeatherWings\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>`_.\n\nUsage Example\n=============\n\n.. code:: python\n\n import time\n import board\n import terminalio\n from adafruit_matrixportal.matrixportal import MatrixPortal\n\n # --- Display setup ---\n matrixportal = MatrixPortal(status_neopixel=board.NEOPIXEL, debug=True)\n\n # Create a new label with the color and text selected\n matrixportal.add_text(\n text_font=terminalio.FONT,\n text_position=(0, (matrixportal.graphics.display.height // 2) - 1),\n scrolling=True,\n )\n\n SCROLL_DELAY = 0.03\n\n contents = [\n { 'text': 'THIS IS RED', 'color': '#cf2727'},\n { 'text': 'THIS IS BLUE', 'color': '#0846e4'},\n ]\n\n while True:\n for content in contents:\n matrixportal.set_text(content['text'])\n\n # Set the text color\n matrixportal.set_text_color(content['color'])\n\n # Scroll it\n matrixportal.scroll_text(SCROLL_DELAY)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/matrixportal/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_MatrixPortal/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper for Adafruit MatrixPortal M4, Adafruit RGB Matrix Shield + Metro M4 Airlift Lite, and Adafruit RGB Matrix FeatherWings",
"version": "3.2.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MatrixPortal"
},
"split_keywords": [
"adafruit",
" matrixportal",
" matrix",
" rgb",
" led",
" feather",
" featherwing",
" shieldbreakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c1c5d5656d3c20dac4f92c4e2002aec95c8dcb0df910fcc70ec57c04d13c811",
"md5": "c62df7095efb4d52309df114afeff4ca",
"sha256": "674a929a5b42f45bde652b6fe491e137b20c0976f7db18d8a8a61d23bded5cc5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_matrixportal-3.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c62df7095efb4d52309df114afeff4ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11900,
"upload_time": "2024-10-07T22:31:40",
"upload_time_iso_8601": "2024-10-07T22:31:40.767518Z",
"url": "https://files.pythonhosted.org/packages/6c/1c/5d5656d3c20dac4f92c4e2002aec95c8dcb0df910fcc70ec57c04d13c811/adafruit_circuitpython_matrixportal-3.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d318f7422995db621e203b875a1e5cc7a7641ea0c9c1ca143983ce0e8f0ce2b0",
"md5": "204412fc16272ee02c22ed2fce29d618",
"sha256": "e2deb8fe8aa59884e41d8950102d140043865764c7c771440b1d06076b5142bf"
},
"downloads": -1,
"filename": "adafruit_circuitpython_matrixportal-3.2.1.tar.gz",
"has_sig": false,
"md5_digest": "204412fc16272ee02c22ed2fce29d618",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30502,
"upload_time": "2024-10-07T22:31:41",
"upload_time_iso_8601": "2024-10-07T22:31:41.735947Z",
"url": "https://files.pythonhosted.org/packages/d3/18/f7422995db621e203b875a1e5cc7a7641ea0c9c1ca143983ce0e8f0ce2b0/adafruit_circuitpython_matrixportal-3.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:31:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MatrixPortal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-matrixportal"
}
JSON
