Tutorial¶

This tutorial will walk you through the basics of using PixelMaestro. By the end, you will have learned how to create and animate a 10x10 grid of LEDs.

Core Concepts¶

Let’s start by explaining the two most important components in PixelMaestro: Sections and Maestros.

What’s a Section?¶

A Section is a virtual reproduction of an LED grid stored entirely in memory. This virtual grid is called a framebuffer, and each virtual LED is called a Pixel. Sections are designed to make it easy for you to modify and interact with the framebuffer. Sections are also responsible for managing components that interact with the framebuffer, such as Animations and Canvases.

What’s a Maestro?¶

A Maestro manages all other PixelMaestro components, particularly Sections and Shows. They also store global parameters, such as the refresh rate. Maestros are essential for timing: they ensure that all components are continuously kept up-to-date and synchronized.

Most importantly, a Maestro directly manages Sections. A Maestro can manage one or more Sections, but a Section can only be assigned to one Maestro. Because of this, you should use a single Maestro to manage all of your Sections.

Using PixelMaestro¶

There are four steps to using PixelMaestro in your app:

Initialize a new Maestro and any Sections that it will manage.
Configure the Maestro and Section(s). This might include adding Animations, drawing Canvases, enabling Shows, etc.
Run the Maestro’s update() method in a continuous loop and provide it with the application’s current runtime in milliseconds.
Copy the contents of the Section's framebuffer to the output device. The exact implementation will vary depending on the type of device you’re outputting to.

Sample Sketch¶

Here is an example sample Arduino sketch created using PlatformIO. It creates a Section containing a 10x10 grid and starts a blinking animation using a pre-defined color palette.

#include <Arduino.h>
#include <PixelMaestro/animation/blinkanimation.h>
#include <PixelMaestro/colorpresets.h>
#include <PixelMaestro/core/colors.h>
#include <PixelMaestro/core/maestro.h>

using namespace PixelMaestro;

/*
 * Create a Maestro with a single 10x10 Section.
 */
Maestro maestro(10, 10, 1);

void setup () {
    Section* section = maestro.get_section(0);

    /*
     * Create and configure a Blink Animation.
     * The ColorPresets class provides several pre-built colors and palettes.
     * We'll decrease the Animation's cycle time (making it blink every second) and disable fading.
     */
    Animation& animation = section->set_animation(AnimationType::Blink);
    animation.set_palette(ColorPresets:Rainbow_Palette);
    animation.set_timer(500);
    animation.set_fade(false);
}

void loop() {
    /*
     * Update the Maestro. This refreshes every component including the Section and its Animation.
     * update() is non-blocking, so you can run other actions in the loop.
     */
    if (maestro.update(millis())) {
        // Step through the grid and retrieve each pixel's color.
        for (unsigned char y = 0; y < maestro.get_section(0)->get_dimensions().y; y++) {
            for (unsigned char x = 0; x < maestro.get_section(0)->get_dimensions().x; x++) {
                Colors::RGB pixel_color = maestro.get_pixel_color(0, x, y);
                // Here you would add code to send pixel_color to the corresponding LED.
            }
        }
    }
}