AtFinder Class Reference

Class to monitor input stream for EXRAIL SCREEN commands Format: <@ screen row "Text"> More...

#include <AtFinder.h>

Collaboration diagram for AtFinder:

Static Public Member Functions
static void	setup (uint8_t maxTextLength, CallbackInterface *callback)
	Setup the AtFinder parser.
static void	processInputChar (char hot)
	Call this as often as possible with a streaming input (eg. Serial.read())
static void	cleanUp ()
	Clean up memory allocations used by AtFinder.
static void	setLogger (Logger *logger)
	Set the logger instance to use for diagnostic logging.

Static Private Attributes
static uint8_t	_maxTextLength = 0
static char *	_text = nullptr
static CallbackInterface *	_callback = nullptr
static Logger *	_logger = nullptr

Detailed Description

Class to monitor input stream for EXRAIL SCREEN commands Format: <@ screen row "Text">

Member Function Documentation

cleanUp()

void AtFinder::cleanUp ( )

static

Clean up memory allocations used by AtFinder.

Here is the caller graph for this function:

processInputChar()

void AtFinder::processInputChar ( char  hot )

static

Call this as often as possible with a streaming input (eg. Serial.read())

Parameters

hot	The next character to process in the stream

Here is the call graph for this function:

Here is the caller graph for this function:

setLogger()

void AtFinder::setLogger ( Logger *  logger )

static

Set the logger instance to use for diagnostic logging.

Parameters

logger

Pointer to the Logger instance to use

Here is the caller graph for this function:

setup()

void AtFinder::setup ( uint8_t  maxTextLength, CallbackInterface *  callback  )

static

Setup the AtFinder parser.

Parameters

maxTextLength	Maximum length of text the parser will accept
callback	Parser will call this function and provide display ID, row number, and a char array of text

Here is the caller graph for this function:

Member Data Documentation

_callback

CallbackInterface * AtFinder::_callback = nullptr

staticprivate

_logger

Logger * AtFinder::_logger = nullptr

staticprivate

_maxTextLength

uint8_t AtFinder::_maxTextLength = 0

staticprivate

_text

char * AtFinder::_text = nullptr

staticprivate

---

The documentation for this class was generated from the following files:

• /home/runner/work/EX-Display/EX-Display/AtFinder.h
• /home/runner/work/EX-Display/EX-Display/AtFinder.cpp