adafruit-circuitpython-matrixportal

Introduction

CircuitPython helper for Adafruit MatrixPortal M4, Adafruit RGB Matrix Shield + Metro M4 Airlift Lite, and Adafruit RGB Matrix FeatherWings.

This library extends the CircuitPython PortalBase library - see library for additional information.

Dependencies

This driver depends on:

Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Metadata

Release files for adafruit-circuitpython-matrixportal 3.2.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-matrixportal 3.2.12
File	Size	Uploaded
adafruit_circuitpython_matrixportal-3.2.12.tar.gz	27.4 kB	Apr 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-matrixportal 3.2.12
File	Interpreter	ABI	Platform	Reset
adafruit_circuitpython_matrixportal-3.2.12-py3-none-any.whl 11.9 kB Apr 23, 2026	Python 3	none	any	Details

Total release size: 39.3 kB

Release files / adafruit_circuitpython_matrixportal-3.2.12.tar.gz

Download URL	adafruit_circuitpython_matrixportal-3.2.12.tar.gz
Size	27.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`8cb0035427aa1986efb6b061a81e12887b9d363232ddffffd5a5b58002332b98`
BLAKE2b-256 checksum How to use checksums	`7b082facd394a6a63aed66b6d1fb21c1d695060c98def80b9778c3f610704bf0`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`

Release files / adafruit_circuitpython_matrixportal-3.2.12-py3-none-any.whl

Download URL	adafruit_circuitpython_matrixportal-3.2.12-py3-none-any.whl
Size	11.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`d4b1a98cf5c7e5c82945092053960053229164047388b302ba9c55d7a2d0cbe7`
BLAKE2b-256 checksum How to use checksums	`4e7b449b5cee28f4eb762627d267fc1f093d7d89a9fdd2f4e6a964b597c36fa8`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.15`