MaxMatrix
Drive chained 8x8 LED dot matrix modules with MAX7219.
Loading...
Searching...
No Matches
MaxMatrix.h File Reference

The header a sketch includes: the matrix it draws on. More...

#include "Arduino.h"
#include "MaxMatrixAttributes.h"
#include "Text/Text.h"
#include "Utility/reference_wrapper.h"
#include "Command/Command.h"
#include "Font/Font.h"
#include "Matrix/Panel.h"
#include "Max7219/Chain.h"
#include "MaxMatrixConfig.h"
#include "MaxMatrixError.h"
#include "MaxMatrixStandardTypes.h"
#include "Utility/Byte.h"
#include "Utility/array.h"
#include "Utility/span.h"

Go to the source code of this file.

Classes

class  max_matrix::Matrix
 The matrix a sketch draws on: a chain of 8x8 modules, in the coordinates the viewer sees. More...
class  max_matrix::Batch
 Holds the sending back for as long as it exists, as std::lock_guard holds a mutex. More...
class  max_matrix::internal::Buffer< NumberOfModules >
 The buffer of a MatrixOf. More...
class  max_matrix::MatrixOf< NumberOfModules >
 A Matrix with the buffer for a chain of NumberOfModules modules. More...

Enumerations

enum class  max_matrix::State : uint8_t {
  kNone , kInit , kReady , kStringShift ,
  kCharShift
}
 What a Matrix is doing, as Matrix::GetState() tells it. More...

Detailed Description

The header a sketch includes: the matrix it draws on.

MaxMatrix drives a chain of 8x8 LED modules with the MAX7219. The class Matrix is the facade over the parts in the folders beside this file, one per subject: Max7219/ the transfer to the chain, Matrix/ the buffer as wired and the coordinates as the viewer sees them, Font/ the sprites of the chars, Text/ the text that stands or shifts, and Command/ the lines a control page sends over Serial, built on this class. A function here that only passes a call on takes its text from the function it calls.

Enumeration Type Documentation

◆ State

enum class max_matrix::State : uint8_t
strong

What a Matrix is doing, as Matrix::GetState() tells it.

Enumerator
kNone 

Constructed; Matrix::Init() not called yet.

kInit 

Matrix::Init() is running.

kReady 

Nothing to shift: a text or a char shifted in is complete, or stopped.

kStringShift 

A text of Matrix::SetTextWithShift() is being shifted in.

kCharShift 

A char of Matrix::SetCharWithShift() is being shifted in.