Which library do I use for SmartMatrix?

queenidog · August 2, 2021, 2:10pm

In the example program Feature Demo for SmartMatrix, I included the library SmartMatrix
#include <SmartMatrix.h>
but when I compile, the pragma message displays this:
pragma message “SmartMatrix Library version 4.000.002”

I have BOTH libraries in the libraries folder, so which do I use? Should I delete the SmartMatrix library?

I was getting confused since I was making changes to SmartMatrix library and wondering why the changes were not being shown when I compiled (getting “not declared” errors.

Louis · August 2, 2021, 3:29pm

SmartMatrix Library 4.x is the latest, most likely you should be using SmartMatrix Library 4 and not the outdated SmartMatrix Library 3. You can keep both in your libraries folder if you want, but if you don’t need SmartMatrix Library 3, it’s probably better to delete it to avoid confusion.

Some more notes:

github.com

pixelmatix/SmartMatrix/blob/master/MIGRATION.md#migrating-from-smartmatrix-3x-to-smartmatrix-40

# Migrating from SmartMatrix 3.x to SmartMatrix 4.0
There are some minor changes needed to migrate a SmartMatrix 3.x sketch to SmartMatrix 4.0:

- Change `#include <SmartMatrix3.h>` to `#include <SmartMatrix.h>` or alternately change to `#include <SmartMatrix4.h>`

The way you select your hardware type has changed:

- If you're using a bare Teensy 3 (no latch circuit), or SmartMatrix Shield V1-V3, now you need to add `#include <MatrixHardware_Teensy3_ShieldV1toV3.h>` before `#include <SmartMatrix.h>`
- If you're using a SmartLED Shield for Teensy 3 (V4), or you added an external latch circuit, you need to add `#include <MatrixHardware_Teensy3_ShieldV4.h>` before `#include <SmartMatrix.h>`
- If you see `#include <SmartLEDShieldV4.h>` at the top of your sketch, remove that and replace with `#include <MatrixHardware_Teensy3_ShieldV4.h>`
- If you had to modify SmartMatrix Library to customize pinout or other hardware changes, you may be able to make those changes with a custom MatrixHardware header file inside your sketch now.  Copy the MatrixHardware header file closest to your custom hardware from the library /src/ folder, give it a custom name inside your sketch folder and include it before `#include <SmartMatrix.h>`

SmartMatrix Library 3.x and 4.x can coexist in the Arduino Libraries Folder:

- Add the two libraries in unique folders, e.g. "SmartMatrix3" and "SmartMatrix4" (you'll need to download from GitHub and not use Arduino Library Manager for at least one of the libraries)
- Use `#include <SmartMatrix3.h>` to include SmartMatrix 3.x in your sketch, and `#include <SmartMatrix.h>` or or `#include <SmartMatrix4.h>` to include SmartMatrix 4.x in your sketch

# Migrating from SmartMatrix 2.x to SmartMatrix 3.0
SmartMatrix 3.0 has separated out the single SmartMatrix class into a core class for refreshing the display, and separate layer classes for storing data.  The library is not backwards compatible with sketches created for SmartMatrix 2.x, but by following this document it should be relatively easy to update your sketches to get access to the new features.  You can have SmartMatrix3 installed in parallel with an existing SmartMatrix_32x32 or SmartMatrix_16x32 library without conflicts.

This file has been truncated. show original