DisplayModule.h File Reference

#include "../../Defines.h"

Include dependency graph for DisplayModule.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	START_NEW   true
#define	KEEP_SAME   false

Functions
void	setup_displayModule ()
	for types: String, boolean .. More...
void	loop_displayModule ()
	called for the loop() of this plugin More...
void	showText_displayModule (String text)
void	addToTextMessages_displayModule (String text)
void	blankScreen_displayModule ()
	blanks the screen More...
void	wakeupScreen_displayModule ()
	wakes up the screen More...
boolean	isBlankScreen_displayModule ()
	whether screen is blank (so the button can be a wake, vs action..) More...
void	clearScreen_displayModule ()
	clears the screen More...
void	showSemanticMarker_displayModule (String semanticMarkerAddress, String title)
	displays the Semantic Marker (a super QR code) on the M5 screen (title = to display) More...
const char *	currentSemanticMarkerAddress_displayModule ()
	returns the current semantic marker (eg. guest page) More...
void	showSemanticMarkerFunc_displayModule (String semanticMarkerAddressBase, String title, const char *(*getStatusFunc)(void))
	the function to call to get the 'status', return char* More...
void	redrawSemanticMarker_displayModule (boolean startNew)
	redraws the Semantic Marker image.. More...
int	getLoopTimer_displayModule ()
	returns the loop timer (just a timer..) More...
void	resetLoopTimer_displayModule ()
	reset the loop timer .. useful for testing, More...
void	incrementScreenColor_displayModule ()
void	setScreenColor_displayModule (int screenColor)
	cache for getting the screen color 0..n. Will reset the cache as well More...
void	showOTAUpdatingMessage ()
	show an OTA message.. More...

Macro Definition Documentation

KEEP_SAME

#define KEEP_SAME   false

Definition at line 54 of file DisplayModule.h.

START_NEW

#define START_NEW   true

Definition at line 53 of file DisplayModule.h.

Function Documentation

addToTextMessages_displayModule()

void addToTextMessages_displayModule

(

String

text

)

adds messages that aren't shown unless in message window mode. NOTE: This will be a scrolling text as sometime ..

Definition at line 1884 of file DisplayModule.cpp.

Here is the caller graph for this function:

blankScreen_displayModule()

void blankScreen_displayModule

(

)

blanks the screen

Definition at line 1890 of file DisplayModule.cpp.

Here is the caller graph for this function:

clearScreen_displayModule()

void clearScreen_displayModule

(

)

clears the screen

Definition at line 1908 of file DisplayModule.cpp.

currentSemanticMarkerAddress_displayModule()

const char * currentSemanticMarkerAddress_displayModule

(

)

returns the current semantic marker (eg. guest page)

Definition at line 1920 of file DisplayModule.cpp.

Here is the caller graph for this function:

getLoopTimer_displayModule()

int getLoopTimer_displayModule

(

)

returns the loop timer (just a timer..)

Definition at line 1943 of file DisplayModule.cpp.

Here is the caller graph for this function:

incrementScreenColor_displayModule()

void incrementScreenColor_displayModule

(

)

Increment the screen color 0..n cache for getting the screen color 0..max (max provided by sender) This is implemented by incrementScreenColor_mainModule() since it knows the MAX value of colors

Definition at line 1849 of file DisplayModule.cpp.

Here is the caller graph for this function:

isBlankScreen_displayModule()

boolean isBlankScreen_displayModule

(

)

whether screen is blank (so the button can be a wake, vs action..)

Definition at line 1902 of file DisplayModule.cpp.

Here is the caller graph for this function:

loop_displayModule()

void loop_displayModule

(

)

called for the loop() of this plugin

Definition at line 1870 of file DisplayModule.cpp.

Here is the caller graph for this function:

redrawSemanticMarker_displayModule()

void redrawSemanticMarker_displayModule

(

boolean

startNew

)

redraws the Semantic Marker image..

Definition at line 1936 of file DisplayModule.cpp.

Here is the caller graph for this function:

resetLoopTimer_displayModule()

void resetLoopTimer_displayModule

(

)

reset the loop timer .. useful for testing,

Definition at line 1949 of file DisplayModule.cpp.

Here is the caller graph for this function:

setScreenColor_displayModule()

void setScreenColor_displayModule

(

int

screenColor

)

cache for getting the screen color 0..n. Will reset the cache as well

Definition at line 1856 of file DisplayModule.cpp.

Here is the caller graph for this function:

setup_displayModule()

void setup_displayModule

(

)

for types: String, boolean ..

M5 Display with SemanticMarker™

SemanticMarker™

THIS IS the setup() and loop() but using the "component" name, eg MQTTNetworking() This will perform preference initializtion as well called from the setup()

THIS IS the setup() and loop() but using the "component" name, eg MQTTNetworking() This will perform preference initializtion as well called from the setup()

Definition at line 1864 of file DisplayModule.cpp.

Here is the caller graph for this function:

showOTAUpdatingMessage()

void showOTAUpdatingMessage

(

)

show an OTA message..

Here is the caller graph for this function:

showSemanticMarker_displayModule()

void showSemanticMarker_displayModule	(	String	semanticMarkerAddress,
		String	title
	)

displays the Semantic Marker (a super QR code) on the M5 screen (title = to display)

Definition at line 1914 of file DisplayModule.cpp.

Here is the caller graph for this function:

showSemanticMarkerFunc_displayModule()

void showSemanticMarkerFunc_displayModule	(	String	semanticMarkerAddressBase,
		String	title,
		const char *(*)(void)	getStatusFunc
	)

the function to call to get the 'status', return char*

displays the Semantic Marker (a super QR code) on the M5 screen (title = to display)

Definition at line 1930 of file DisplayModule.cpp.

Here is the caller graph for this function:

showText_displayModule()

void showText_displayModule

(

String

text

)

shows a FEED (or whatever) then blanks the screen after N seconds NOTE: This will be a scrolling text as sometime ..

Definition at line 1877 of file DisplayModule.cpp.

Here is the caller graph for this function:

wakeupScreen_displayModule()

void wakeupScreen_displayModule

(

)

wakes up the screen

Definition at line 1896 of file DisplayModule.cpp.

Here is the caller graph for this function: