Skip to content

README.md

Latest commit

 

History

History
56 lines (39 loc) · 3.12 KB

README.md

File metadata and controls

56 lines (39 loc) · 3.12 KB

RGBMatrixEmulator Samples

Samples in this directory have been adapted from rpi-rgb-led-matrix Python samples.

License

Files in this directory are derivatives of original work and are distributed with original license. See samples/LICENSE.

Installing Samples

Installation of RGBMatrixEmulator from PyPi does not include sample files. After installing the emulator according to the README, you should clone this repository instead:

SSH:

git clone git@github.com:ty-porter/RGBMatrixEmulator.git

HTTPS:

git clone https://github.com/ty-porter/RGBMatrixEmulator.git

Usage

Navigate to the samples directory:

cd samples

Run individual samples with valid RGBMatrixEmulator options. See the chart below for a description of each sample with additional required arguments.

Samples

Below is a list of all samples included for RGBMatrixEmulator. Unless otherwise specified, the syntax for running the command is simply python NAME_OF_SCRIPT, plus any optional arguments you choose to use.

Sample images (sample/images) and fonts (sample/fonts) are included for use with the samples below. In normal use cases these are already included with the project you are emulating if installing the emulator into an existing script. If you're developing a script from scratch, you will need to provide your own.

Name Arguments Description
gif-viewer GIF path (positional, required) Draws an animated gif, resizing it to fit the matrix
graphics A simple graphics routine for drawing text, lines, and circles
grayscale_block A graphics routine for grayscale colors
image-draw Draws an image using PIL and slides it across the display
image-scroller -i / --image Scrolls an image from a file. Defaults to samples/images/runtext.ppm unless optional arguments included
image-viewer Image path (positional, required) Draws a static image from a file
pulsing-brightness Example of manipulating pixel brightness
pulsing-colors Example of manipulating pixel color
race-clock A simple countdown timer (such as for a race). Note: This sample is degenerate for RGBME. See Known Issues for details.
rotating-block-generator Draws a rotating multicolored block
runtext See command help text (-h) Scrolls configurable text.
samplebase DO NOT USE DIRECTLY. Base class for driver setup, argument parsing, etc.
simple-square A simple graphics drawing routine
still-viewer -i / --image Draws a still image from a file. Defaults to samples/images/runtext.ppm unless optional arguments included. Does not support image fetching from URL (unlike upstream sample).