![]() |
Parola for Arduino
1.0
Text effects for Parola modular hardware
|
#include <MD_Parola.h>
Public Types | |
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 } |
Public Member Functions | |
MD_Parola (uint8_t dataPin, uint8_t clkPin, uint8_t csPin, uint8_t numDevices=1) | |
void | begin (void) |
~MD_Parola (void) | |
Methods for core object control. | |
bool | displayAnimate (void) |
void | displayClear (void) |
void | displayReset (void) |
void | displayScroll (char *pText, textPosition_t align, textEffect_t effect, uint16_t speed) |
void | displaySuspend (bool b) |
void | displayText (char *pText, textPosition_t align, uint16_t speed, uint16_t pause, textEffect_t effectIn, textEffect_t effectOut=NO_EFFECT) |
Support methods for visually adjusting the display. | |
uint8_t | getCharSpacing (void) |
bool | getInvert (void) |
uint16_t | getPause (void) |
uint16_t | getSpeed (void) |
textPosition_t | getTextAlignment (void) |
void | setCharSpacing (uint8_t cs) |
void | setIntensity (uint8_t intensity) |
void | setInvert (uint8_t invert) |
void | setPause (uint16_t pause) |
void | setSpeed (uint16_t speed) |
void | setTextAlignment (textPosition_t ta) |
void | setTextBuffer (char *pb) |
void | setTextEffect (textEffect_t effectIn, textEffect_t effectOut) |
Core object for the Parola library
Special effect specification.
Used to define the effects to be used for the entry and exit of text in the display area.
Text alignment specification.
Used to define the display text aligmnent and to specify direction for scrolling and animations. In the situation where LEFT AND RIGHT are the onty sensible options (eg, text scrolling direction), CENTER will behave the same as LEFT.
MD_Parola::MD_Parola | ( | uint8_t | dataPin, |
uint8_t | clkPin, | ||
uint8_t | csPin, | ||
uint8_t | numDevices = 1 |
||
) |
Class Constructor - arbitrary output pins.
Instantiate a new instance of the class. The parameters passed are used to connect the software to the hardware using the MD_MAX72XX class.
See documentation for the MD_MAX72XX library for detailed explanation of parameters.
dataPin | output on the Arduino where data gets shifted out. |
clkPin | output for the clock signal. |
csPin | output for selecting the device. |
numDevices | number of devices connected. Default is 1 if not supplied. |
MD_Parola::~MD_Parola | ( | void | ) |
Class Destructor.
Release allocated memory and does the necessary to clean up once the object is no longer required.
void MD_Parola::begin | ( | void | ) |
Initialise the object.
Initialise the object data. This needs to be called during setup() to initialise new data for the class that cannot be done during the object creation.
bool MD_Parola::displayAnimate | ( | void | ) |
Animate the display.
Animate the display using the currently specifed text and animation parameters. This method needs to be invoked as often as possible to ensure smooth animation. The animation is goverened by a time tick that is set by the setSpeed() method and it will pause between entry and exit using the time set by the setPause() method.
The calling program should monitor the return value for 'true' in order to either reset the animation or supply another string for display.
void MD_Parola::displayClear | ( | void | ) |
Clear the display.
Clear all the data from the current display.
void MD_Parola::displayReset | ( | void | ) |
Reset the current animation to restart.
This method is used to reset an animation back to the start of the current cycle. It is normally invoked after all the parameters for a display are set and the animation needs to be started (or restarted).
void MD_Parola::displayScroll | ( | char * | pText, |
textPosition_t | align, | ||
textEffect_t | effect, | ||
uint16_t | speed | ||
) |
Easy start for a scrolling text display.
This method is a convenient way to set up a scrolling display. All the data necessary for setup is passed through as parameters and the display animation is started.
pText | parameter suitable for the setTextBuffer() method. |
align | parameter suitable for the the setTextAlignment() method. |
effect | parameter suitable for the the setTextEffect() method. |
speed | parameter suitable for the setSpeed() method. |
void MD_Parola::displaySuspend | ( | bool | b) |
Suspend or resume display updates.
Stop the current animation at the point it is at. When pausing it leaves the display showing the current text. Resuming will restart the animation where it left off. To reset the animation back to the beginning, use the displayReset() method.
b | boolean value to suspend (true) or resume (false). |
void MD_Parola::displayText | ( | char * | pText, |
textPosition_t | align, | ||
uint16_t | speed, | ||
uint16_t | pause, | ||
textEffect_t | effectIn, | ||
textEffect_t | effectOut = NO_EFFECT |
||
) |
Easy start for a non-scrolling text display.
This method is a convenient way to set up a static text display. All the data necessary for setup is passed through as parameters and the display animation is started.
pText | parameter suitable for the setTextBuffer() method. |
align | parameter suitable for the the setTextAlignment() method. |
speed | parameter suitable for the setSpeed() method. |
pause | parameter suitable for the setPause() method. |
effectIn | parameter suitable for the setTextEffect() method. |
effectOut | parameter suitable for the setTextEffect() method. |
uint8_t MD_Parola::getCharSpacing | ( | void | ) |
Get the inter-character spacing in columns.
bool MD_Parola::getInvert | ( | void | ) |
Get the current display invert state.
See the setInvert() method.
uint16_t MD_Parola::getPause | ( | void | ) |
uint16_t MD_Parola::getSpeed | ( | void | ) |
textPosition_t MD_Parola::getTextAlignment | ( | void | ) |
Get the current text alignment specification.
void MD_Parola::setCharSpacing | ( | uint8_t | cs) |
Set the inter-character spacing in columns.
Set the number of blank columns between characters when they are displayed.
cs | space between characters in columns. |
void MD_Parola::setIntensity | ( | uint8_t | intensity) |
Set the display brightness.
Set the intensity (brightness) of the display.
intensity | the intensity to set the display (0-15). |
void MD_Parola::setInvert | ( | uint8_t | invert) |
Invert the display.
Set the display to inverted (ON LED turns OFF and vice versa).
invert | true for inverted display, false for normal display |
void MD_Parola::setPause | ( | uint16_t | pause) |
Set the pause between ENTER and EXIT animations.
Between each entry and exit, the library will pause by the number of milliseconds specified to allow the viewer to read the message. For continuous scrolling displays this should be set to the same value as the display speed.
pause | the time, in milliseconds, between animations. |
void MD_Parola::setSpeed | ( | uint16_t | speed) |
Set the animation frame speed.
The speed of the display is the 'tick' time between animation frames. The lower this time the faster the animation; set it to zero to run as fast as possible.
speed | the time, in milliseconds, between animation frames. |
void MD_Parola::setTextAlignment | ( | textPosition_t | ta) |
Set the text alignment.
Text alignment is specified as one of the values in textPosition_t.
ta | the required text alignment. |
void MD_Parola::setTextBuffer | ( | char * | pb) |
Set the pointer to the text buffer.
Sets the text buffer to be a pointer to user data. The library does not allocate any memory for the text message, rather it is the calling program that supplies a pointer to a buffer. This reduces memory requirements and offers the flexibility to keep a single buffer or rotate buffers with different messages, all under calling program control, with no livbrary limit to the size or numbers of buffers. The text placed in the buffer must be properly terminated by the NUL ('\0') character or processing will overrun the end of the message.
pb | pointer to the text buffer to be used. |
void MD_Parola::setTextEffect | ( | textEffect_t | effectIn, |
textEffect_t | effectOut | ||
) |
Set the entry and exit text effects.
The 'in' and 'out' text effects are specified using the textEffect_t enumerated type. If no effect is required, NO_EFFECT should be specified. NO_EFFECT is most useful when no exit effect is required (e.g., when DISSOLVE is used) and the entry effect is sufficient.
effectIn | the entry effect, one of the textEffect_t enumerated values. |
effectOut | the exit effect, one of the textEffect_t enumerated values. |