Noiasca Liquid Crystal
A light weight LCD Library to print UTF-8 and special characters easily.
Public Member Functions | List of all members
MyBuffer< T > Class Template Reference

a class for the buffer More...

#include <NoiascaMove.h>

Inherits Print.

Public Member Functions

void clear ()
 clear the internal buffer
 
void clearCanvas (const char c=' ')
 delete the defined scroll on LCD More...
 
void setInterval (uint16_t interval)
 set interval of movement
 
void setLeaveChars (byte chars)
 set the characters to be left on the display More...
 
void setMoveStartPos (byte pos)
 set the start position for the scrolling More...
 
void setMoveKeep (bool value=true)
 keep or delete internal buffer More...
 
void setScrollLeft ()
 Set mode to Scroll the internal buffer to left. More...
 
void setShiftLeft ()
 Set mode to Shift the internal buffer to left. More...
 
void update (uint32_t currentMillis=millis())
 update the display line More...
 

Detailed Description

template<class T>
class MyBuffer< T >

a class for the buffer

to receive characters into a buffer if called with a "print" and send characters to a LCD object

Member Function Documentation

◆ clearCanvas()

template<class T >
void MyBuffer< T >::clearCanvas ( const char  c = ' ')
inline

delete the defined scroll on LCD

deletes the defined scroll area on the LCD

Parameters
ca character which should be used to "delete", default = ' ' (blank)

◆ setLeaveChars()

template<class T >
void MyBuffer< T >::setLeaveChars ( byte  chars)
inline

set the characters to be left on the display

Set the remaining characters on the display when the scrolling has finished.

Parameters
charsthe characters to be left on the display (0 or available colums, i.e. 16)

◆ setMoveStartPos()

template<class T >
void MyBuffer< T >::setMoveStartPos ( byte  pos)
inline

set the start position for the scrolling

Set the position of the first character to be scrolled on the display.

Parameters
posthe display position (0 or last position e.g. 15)

◆ setMoveKeep()

template<class T >
void MyBuffer< T >::setMoveKeep ( bool  value = true)
inline

keep or delete internal buffer

Set the position of the first character to be scrolled on the display.

Parameters
valuetrue will keep the internal buffer, false will delete characters which are shifted out to the left

◆ setScrollLeft()

template<class T >
void MyBuffer< T >::setScrollLeft ( )
inline

Set mode to Scroll the internal buffer to left.

Scroll the internal buffer endless from right to left. This helper functio ensures that the user sets alls parameters correct.

◆ setShiftLeft()

template<class T >
void MyBuffer< T >::setShiftLeft ( )
inline

Set mode to Shift the internal buffer to left.

Output wider than the display size will be shifted character by character until the last character was shown on the display This helper functio ensures that the user sets alls parameters correct.

◆ update()

template<class T >
void MyBuffer< T >::update ( uint32_t  currentMillis = millis())
inline

update the display line

Should be called in your loop over and over again. Will call the internal move function to make the scrolling/shifting visible.