Parola for Arduino  2.0
Text effects for Parola modular hardware
 All Classes Files Functions Enumerations Enumerator Macros Pages
MD_Parola.h File Reference

Main header file for the MD_Parola library. More...

#include <Arduino.h>
#include <MD_MAX72xx.h>
Include dependency graph for MD_Parola.h:
This graph shows which files directly or indirectly include this file:

Classes

class  MD_PZone
 
class  MD_Parola
 

Macros

#define ARRAY_SIZE(x)   (sizeof(x)/sizeof(x[0]))
 Generic macro for obtaining number of elements of an array.
 

Enumerations

enum  textPosition_t { LEFT, CENTER, RIGHT }
 
enum  textEffect_t {
  NO_EFFECT, PRINT, SLICE, WIPE,
  WIPE_CURSOR, OPENING, OPENING_CURSOR, CLOSING,
  CLOSING_CURSOR, BLINDS, DISSOLVE, SCROLL_UP,
  SCROLL_DOWN, SCROLL_LEFT, SCROLL_RIGHT, SCROLL_UP_LEFT,
  SCROLL_UP_RIGHT, SCROLL_DOWN_LEFT, SCROLL_DOWN_RIGHT, SCAN_HORIZ,
  SCAN_VERT, GROW_UP, GROW_DOWN
}
 

Detailed Description

Main header file for the MD_Parola library.

Enumeration Type Documentation

Special effect enumerated type specification.

Used to define the effects to be used for the entry and exit of text in the display area.

Enumerator
NO_EFFECT 

Used as a place filler, executes no operation.

PRINT 

Text just appears (printed)

SLICE 

Text enters and exits a slice (column) at a time from the right.

WIPE 

Text appears/disappears one column at a time, looks like it is wiped on and off.

WIPE_CURSOR 

WIPE with a light bar ahead of the change.

OPENING 

Appear and disappear from the center of the display, towards the ends.

OPENING_CURSOR 

OPENING with light bars ahead of the change.

CLOSING 

Appear and disappear from the ends of the display, towards the middle.

CLOSING_CURSOR 

CLOSING with light bars ahead of the change.

BLINDS 

Text is replaced behind vertical blinds.

DISSOLVE 

Text dissolves from one display to another.

SCROLL_UP 

Text scrolls up through the display.

SCROLL_DOWN 

Text scrolls down through the display.

SCROLL_LEFT 

Text scrolls right to left on the display.

SCROLL_RIGHT 

Text scrolls left to right on the display.

SCROLL_UP_LEFT 

Text moves in/out in a diagonal path up and left (North East)

SCROLL_UP_RIGHT 

Text moves in/out in a diagonal path up and right (North West)

SCROLL_DOWN_LEFT 

Text moves in/out in a diagonal path down and left (South East)

SCROLL_DOWN_RIGHT 

Text moves in/out in a diagonal path down and right (North West)

SCAN_HORIZ 

Scan one column at a time then appears/disappear at end.

SCAN_VERT 

Scan one row at a time then appears/disappear at end.

GROW_UP 

Text grows from the bottom up and shrinks from the top down.

GROW_DOWN 

Text grows from the top down and and shrinks from the bottom up.

Text alignment enumerated type specification.

Used to define the display text alignment and to specify direction for scrolling and animations. In the situation where LEFT AND RIGHT are the only sensible options (eg, text scrolling direction), CENTER will behave the same as LEFT.

Enumerator
LEFT 

The leftmost column for the first character will be on the left side of the display.

CENTER 

The text will be placed with equal number of blank display columns either side.

RIGHT 

The rightmost column of the last character will be on the right side of the display.