Functions
std::array< Adafruit_AlphaNum4, 3 >	JBWoprDevice::getDisplay ()
	Get display.

virtual void	JBWoprDevice::displaySetState (bool state)
	Set display state.

virtual void	JBWoprDevice::displayClear ()
	Clear display.

virtual void	JBWoprDevice::displayShow ()
	Force display to show current data.

virtual void	JBWoprDevice::displaySetBrightness (uint8_t val)
	Set display brightness percentage.

virtual void	JBWoprDevice::displaySetChar (uint8_t index, char chr)
	Set individual display character.

virtual void	JBWoprDevice::displayShowText (const char *text, JBTextAlignment alignment)
	Set display text.

virtual void	JBWoprDevice::displayShowText (const std::string &text, JBTextAlignment alignment)
	Set display text.

virtual void	JBWoprDevice::displayShowText (const String &text, JBTextAlignment alignment)
	Set display text.

virtual void	JBWoprDevice::displayShowText (const char *text)
	Set display text, left aligned.

virtual void	JBWoprDevice::displayShowText (const std::string &text)
	Set display text, left aligned.

virtual void	JBWoprDevice::displayShowText (const String &text)
	Set display text, left aligned.

virtual void	JBWoprDevice::displayScrollText (const char *text, uint16_t delay_ms)
	Set display scroll text.

virtual void	JBWoprDevice::displayScrollText (const String &text, uint16_t delay_ms)
	Set display scroll text.

virtual void	JBWoprDevice::displayScrollText (const std::string &text, uint16_t delay_ms)
	Set display scroll text.

virtual void	JBWoprDevice::displayScrollText (const char *text)
	Set display scroll text with a delay of 100 ms.

virtual void	JBWoprDevice::displayScrollText (const std::string &text)
	Set display scroll text with a delay of 100 ms.

virtual void	JBWoprDevice::displayScrollText (const String &text)
	Set display scroll text with a delay of 100 ms.

void	JBWoprMqttDevice::displaySetState (bool state) override
	Display set state.

void	JBWoprMqttDevice::displayClear () override
	Display clear.

void	JBWoprMqttDevice::displaySetBrightness (uint8_t val) override
	Display set brightness.

void	JBWoprMqttDevice::displayShowText (const char *text, JBTextAlignment alignment) override
	Display show text.

void	JBWoprMqttDevice::displayShowText (const std::string &text, JBTextAlignment alignment) override
	Display show text.

void	JBWoprMqttDevice::displayShowText (const String &text, JBTextAlignment alignment) override
	Display show text.

void	JBWoprMqttDevice::displayShowText (const char *text) override
	Display show text, left aligned.

void	JBWoprMqttDevice::displayShowText (const std::string &text) override
	Display show text, left aligned.

void	JBWoprMqttDevice::displayShowText (const String &text) override
	Display show text, left aligned.

void	JBWoprMqttDevice::displayScrollText (const char *text, uint16_t delay_ms) override
	Display scrolling text.

void	JBWoprMqttDevice::displayScrollText (const std::string &text, uint16_t delay_ms) override
	Display scrolling text.

void	JBWoprMqttDevice::displayScrollText (const String &text, uint16_t delay_ms) override
	Display scrolling text.

virtual void	JBWoprMqttDevice::displayScrollText (const char *text)
	Set display scroll text with a delay of 100 ms.

virtual void	JBWoprMqttDevice::displayScrollText (const std::string &text)
	Set display scroll text with a delay of 100 ms.

virtual void	JBWoprMqttDevice::displayScrollText (const String &text)
	Set display scroll text with a delay of 100 ms.

Detailed Description

Function Documentation

◆ displayClear() [1/2]

void JBWoprDevice::displayClear ( )

virtual

Clear display.

Reimplemented in JBWoprMqttDevice.

◆ displayClear() [2/2]

void JBWoprMqttDevice::displayClear ( )

overridevirtual

Display clear.

This method will clear the display and publish to to the MQTT broker.

Reimplemented from JBWoprDevice.

◆ displayScrollText() [1/12]

void JBWoprDevice::displayScrollText ( const char * text )

virtual

Set display scroll text with a delay of 100 ms.

This method will block until the text has finished scrolling. Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll

Reimplemented in JBWoprMqttDevice.

◆ displayScrollText() [2/12]

void JBWoprMqttDevice::displayScrollText ( const char * text )

virtual

Set display scroll text with a delay of 100 ms.

This method will scroll text on the display. It will also publish the text to the MQTT broker. This method will block until the text has finished scrolling.

Note: Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll

Reimplemented from JBWoprDevice.

◆ displayScrollText() [3/12]

void JBWoprDevice::displayScrollText	(	const char *	text,
		uint16_t	delay_ms
	)

virtual

Set display scroll text.

This method will block until the text has finished scrolling. Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll
delay_ms	Delay between each scroll step

Reimplemented in JBWoprMqttDevice.

◆ displayScrollText() [4/12]

void JBWoprMqttDevice::displayScrollText	(	const char *	text,
		uint16_t	delay_ms
	)

overridevirtual

Display scrolling text.

This method will scroll text on the display. It will also publish the text to the MQTT broker. This method will block until the text has finished scrolling.

Note: Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll
delay_ms	Delay between scrolls, default value is 100 ms

Reimplemented from JBWoprDevice.

◆ displayScrollText() [5/12]

void JBWoprDevice::displayScrollText ( const std::string & text )

virtual

Set display scroll text with a delay of 100 ms.

This method will block until the text has finished scrolling. Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll

Reimplemented in JBWoprMqttDevice.

◆ displayScrollText() [6/12]

void JBWoprMqttDevice::displayScrollText ( const std::string & text )

virtual

Set display scroll text with a delay of 100 ms.

This method will scroll text on the display. It will also publish the text to the MQTT broker. This method will block until the text has finished scrolling.

Note: Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll

Reimplemented from JBWoprDevice.

◆ displayScrollText() [7/12]

void JBWoprDevice::displayScrollText	(	const std::string &	text,
		uint16_t	delay_ms
	)

virtual

Set display scroll text.

This method will block until the text has finished scrolling. Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll
delay_ms	Delay between each scroll step, default 100 ms

Reimplemented in JBWoprMqttDevice.

◆ displayScrollText() [8/12]

void JBWoprMqttDevice::displayScrollText	(	const std::string &	text,
		uint16_t	delay_ms
	)

overridevirtual

Display scrolling text.

This method will scroll text on the display. It will also publish the text to the MQTT broker. This method will block until the text has finished scrolling.

Note: Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll
delay_ms	Delay between scrolls, default value is 100 ms

Reimplemented from JBWoprDevice.

◆ displayScrollText() [9/12]

void JBWoprDevice::displayScrollText ( const String & text )

virtual

Set display scroll text with a delay of 100 ms.

This method will block until the text has finished scrolling. Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll

Reimplemented in JBWoprMqttDevice.

◆ displayScrollText() [10/12]

void JBWoprMqttDevice::displayScrollText ( const String & text )

virtual

Set display scroll text with a delay of 100 ms.

This method will scroll text on the display. It will also publish the text to the MQTT broker. This method will block until the text has finished scrolling.

Note: Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll

Reimplemented from JBWoprDevice.

◆ displayScrollText() [11/12]

void JBWoprDevice::displayScrollText	(	const String &	text,
		uint16_t	delay_ms
	)

virtual

Set display scroll text.

This method will block until the text has finished scrolling. Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll
delay_ms	Delay between each scroll step, default 100 ms

Reimplemented in JBWoprMqttDevice.

◆ displayScrollText() [12/12]

void JBWoprMqttDevice::displayScrollText	(	const String &	text,
		uint16_t	delay_ms
	)

overridevirtual

Display scrolling text.

This method will scroll text on the display. It will also publish the text to the MQTT broker. This method will block until the text has finished scrolling.

Note: Use the JBWoprScrollTextDisplayEffect effect for a non blocking scroll.

Parameters

text	Text to scroll
delay_ms	Delay between scrolls, default value is 100 ms

Reimplemented from JBWoprDevice.

◆ displaySetBrightness() [1/2]

void JBWoprDevice::displaySetBrightness ( uint8_t val )

virtual

Set display brightness percentage.

Parameters

val	Brightness value, 0 - 100

Reimplemented in JBWoprMqttDevice.

◆ displaySetBrightness() [2/2]

void JBWoprMqttDevice::displaySetBrightness ( uint8_t val )

overridevirtual

Display set brightness.

This method will set the display brightness and publish the brightness to the MQTT broker.

Parameters

val	Brightness value

Reimplemented from JBWoprDevice.

◆ displaySetChar()

void JBWoprDevice::displaySetChar	(	uint8_t	index,
		char	chr
	)

virtual

Set individual display character.

Parameters

index	Character index, 0 - 11
chr	Character to display

◆ displaySetState() [1/2]

void JBWoprDevice::displaySetState ( bool state )

virtual

Set display state.

Parameters

state True to turn display on, false to turn it off

Reimplemented in JBWoprMqttDevice.

◆ displaySetState() [2/2]

void JBWoprMqttDevice::displaySetState ( bool state )

overridevirtual

Display set state.

This method will set the display state and publish to to the MQTT broker.

Parameters

state State

Reimplemented from JBWoprDevice.

◆ displayShowText() [1/12]

void JBWoprDevice::displayShowText ( const char * text )

virtual

Set display text, left aligned.

Parameters

text	Text to display

Reimplemented in JBWoprMqttDevice.

◆ displayShowText() [2/12]

void JBWoprMqttDevice::displayShowText ( const char * text )

overridevirtual

Display show text, left aligned.

This method will show text on the display. It will also publish the text to the MQTT broker.

Parameters

text	Text to show

Reimplemented from JBWoprDevice.

◆ displayShowText() [3/12]

void JBWoprDevice::displayShowText	(	const char *	text,
		JBTextAlignment	alignment
	)

virtual

Set display text.

Parameters

text	Text to display
alignment	Text alignment

Reimplemented in JBWoprMqttDevice.

◆ displayShowText() [4/12]

void JBWoprMqttDevice::displayShowText	(	const char *	text,
		JBTextAlignment	alignment
	)

overridevirtual

Display show text.

This method will show text on the display. It will also publish the text to the MQTT broker.

Parameters

text	Text to show
alignment	Text alignment, default value is LEFT

Reimplemented from JBWoprDevice.

◆ displayShowText() [5/12]

void JBWoprDevice::displayShowText ( const std::string & text )

virtual

Set display text, left aligned.

Parameters

text	Text to display

Reimplemented in JBWoprMqttDevice.

◆ displayShowText() [6/12]

void JBWoprMqttDevice::displayShowText ( const std::string & text )

overridevirtual

Display show text, left aligned.

This method will show text on the display. It will also publish the text to the MQTT broker.

Parameters

text	Text to show

Reimplemented from JBWoprDevice.

◆ displayShowText() [7/12]

void JBWoprDevice::displayShowText	(	const std::string &	text,
		JBTextAlignment	alignment
	)

virtual

Set display text.

Parameters

text	Text to display
alignment	Text alignment

Reimplemented in JBWoprMqttDevice.

◆ displayShowText() [8/12]

void JBWoprMqttDevice::displayShowText	(	const std::string &	text,
		JBTextAlignment	alignment
	)

overridevirtual

Display show text.

This method will show text on the display. It will also publish the text to the MQTT broker.

Parameters

text	Text to show
alignment	Text alignment, default value is LEFT

Reimplemented from JBWoprDevice.

◆ displayShowText() [9/12]

void JBWoprDevice::displayShowText ( const String & text )

virtual

Set display text, left aligned.

Parameters

text	Text to display

Reimplemented in JBWoprMqttDevice.

◆ displayShowText() [10/12]

void JBWoprMqttDevice::displayShowText ( const String & text )

overridevirtual

Display show text, left aligned.

This method will show text on the display. It will also publish the text to the MQTT broker.

Parameters

text	Text to show

Reimplemented from JBWoprDevice.

◆ displayShowText() [11/12]

void JBWoprDevice::displayShowText	(	const String &	text,
		JBTextAlignment	alignment
	)

virtual

Set display text.

Parameters

text	Text to display
alignment	Text alignment

Reimplemented in JBWoprMqttDevice.

◆ displayShowText() [12/12]

void JBWoprMqttDevice::displayShowText	(	const String &	text,
		JBTextAlignment	alignment
	)

overridevirtual

Display show text.

This method will show text on the display. It will also publish the text to the MQTT broker.

Parameters

text	Text to show
alignment	Text alignment, default value is LEFT

Reimplemented from JBWoprDevice.

◆ getDisplay()

std::array< Adafruit_AlphaNum4, 3 > JBWoprDevice::getDisplay ( )

Get display.

Returns: Display as an array of Adafruit_AlphaNum4 instances

Functions

Detailed Description

Function Documentation

◆ displayClear() [1/2]

◆ displayClear() [2/2]

◆ displayScrollText() [1/12]

◆ displayScrollText() [2/12]

◆ displayScrollText() [3/12]

◆ displayScrollText() [4/12]

◆ displayScrollText() [5/12]

◆ displayScrollText() [6/12]

◆ displayScrollText() [7/12]

◆ displayScrollText() [8/12]

◆ displayScrollText() [9/12]

◆ displayScrollText() [10/12]

◆ displayScrollText() [11/12]

◆ displayScrollText() [12/12]

◆ displaySetBrightness() [1/2]

◆ displaySetBrightness() [2/2]

◆ displaySetChar()

◆ displaySetState() [1/2]

◆ displaySetState() [2/2]

◆ displayShowText() [1/12]

◆ displayShowText() [2/12]

◆ displayShowText() [3/12]

◆ displayShowText() [4/12]

◆ displayShowText() [5/12]

◆ displayShowText() [6/12]

◆ displayShowText() [7/12]

◆ displayShowText() [8/12]

◆ displayShowText() [9/12]

◆ displayShowText() [10/12]

◆ displayShowText() [11/12]

◆ displayShowText() [12/12]

◆ getDisplay()