Represents a waveform widget. More...

#include <NextionWaveform.h>

Inheritance diagram for NextionWaveform:

Collaboration diagram for NextionWaveform:

Public Member Functions
	NextionWaveform (Nextion &nex, uint8_t page, uint8_t component, const char *name)
	Create a new widget adapter. More...

bool	addValue (uint8_t channel, uint8_t value)
	Adds a value to the waveform display. More...

bool	setChannelColour (uint8_t channel, uint32_t colour, bool refresh=true)
	Sets the colour of a channel. More...

uint32_t	getChannelColour (uint8_t channel)
	Gets the colour of a channel. More...

bool	setGridColour (uint32_t colour, bool refresh=true)
	Sets the colour of the grid lines. More...

uint32_t	getGridColour ()
	Gets the colour of the grid lines. More...

bool	setGridWidth (uint16_t width)
	Sets the width of the grid squares. More...

uint16_t	getGridWidth ()
	Gets the width of the grid squares. More...

bool	setGridHeight (uint16_t height)
	Sets the height of the grid squares. More...

uint16_t	getGridHeight ()
	Gets the height of the grid squares. More...

Public Member Functions inherited from INextionTouchable
	INextionTouchable (Nextion &nex, uint8_t page, uint8_t component, const char *name)
	Create a new widget adapter. More...

bool	processEvent (uint8_t pageID, uint8_t componentID, uint8_t eventType)
	Processes a touch event. More...

bool	attachCallback (NextionCallbackFunctionHandler::NextionFunction cb)
	Attaches a callback function to this widget. More...

bool	attachCallback (INextionCallback *obj)
	Attaches a callback handler to this widget. More...

void	detachCallback ()
	Removes the callback handler from this widget. More...

Public Member Functions inherited from INextionWidget
	INextionWidget (Nextion &nex, uint8_t page, uint8_t component, const char *name)
	Create a new widget adapter. More...

uint8_t	getPageID ()
	Gets the ID of the page this widget resides on. More...

uint8_t	getComponentID ()
	Gets the component ID of this widget. More...

bool	setNumberProperty (char *propertyName, uint32_t value)
	Sets the value of a numerical property of this widget. More...

uint32_t	getNumberProperty (char *propertyName)
	Gets the value of a numerical property of this widget. More...

bool	setStringProperty (char propertyName, char value)
	Sets the value of a string property of this widget. More...

size_t	getStringProperty (char propertyName, char value, size_t len)
	Gets the value of a string property of this widget. More...

Public Member Functions inherited from INextionColourable
	INextionColourable (Nextion &nex, uint8_t page, uint8_t component, const char *name)
	Create a new widget adapter. More...

bool	setForegroundColour (uint32_t colour, bool refresh=true)
	Sets the normal foreground colour. More...

uint32_t	getForegroundColour ()
	Gets the normal foreground colour. More...

bool	setEventForegroundColour (uint32_t colour, bool refresh=true)
	Sets the foreground colour when a touch event is active. More...

uint32_t	getEventForegroundColour ()
	Gets the foreground colour when a touch event is active. More...

bool	setBackgroundColour (uint32_t colour, bool refresh=true)
	Sets the normal background colour. More...

uint32_t	getBackgroundColour ()
	Gets the normal background colour. More...

bool	setEventBackgroundColour (uint32_t colour, bool refresh=true)
	Sets the background colour when a touch event is active. More...

uint32_t	getEventBackgroundColour ()
	Sets the background colour when a touch event is active. More...

bool	setColour (char *type, uint32_t colour, bool refresh)
	Sets a colour by its property name. More...

uint32_t	getColour (char *type)
	Gets a colour by its property name. More...

bool	afterSet (bool result, bool refresh)
	Handles refreshing the page after a colour has been changed. More...

Additional Inherited Members
Protected Member Functions inherited from INextionWidget
bool	sendCommand (char *commandStr, bool checkComplete=true)

Protected Attributes inherited from INextionWidget
Nextion &	m_nextion
	Reference to the Nextion driver.

uint8_t	m_pageID
	ID of page this widget is on.

uint8_t	m_componentID
	Component ID of this widget.

const char *	m_name
	Name of this widget.

Detailed Description

Represents a waveform widget.

Constructor & Destructor Documentation

NextionWaveform::NextionWaveform	(	Nextion &	nex,
		uint8_t	page,
		uint8_t	component,
		const char *	name
	)

Create a new widget adapter.

Parameters

nex	Reference to the Nextion driver
page	ID of page this widget is on
component	Component ID of this widget
name	Name of this widget

Member Function Documentation

bool NextionWaveform::addValue	(	uint8_t	channel,
		uint8_t	value
	)

Adds a value to the waveform display.

Parameters

channel	Channel number
value	Value

Returns: True if successful

uint32_t NextionWaveform::getChannelColour ( uint8_t channel )

Gets the colour of a channel.

Parameters

channel Channel number

Returns: Colour (may return 0 in case of error)

uint32_t NextionWaveform::getGridColour ( )

Gets the colour of the grid lines.

Returns: Colour (may return 0 in case of error)

uint16_t NextionWaveform::getGridHeight ( )

Gets the height of the grid squares.

Returns: Height (may return 0 in case of error)

uint16_t NextionWaveform::getGridWidth ( )

Gets the width of the grid squares.

Returns: Width (may return 0 in case of error)

bool NextionWaveform::setChannelColour	(	uint8_t	channel,
		uint32_t	colour,
		bool	refresh = `true`
	)

Sets the colour of a channel.

Parameters

channel	Channel number
colour	Colour
refresh	If the widget should be refreshed

Returns: True if successful

bool NextionWaveform::setGridColour	(	uint32_t	colour,
		bool	refresh = `true`
	)

Sets the colour of the grid lines.

Parameters

colour	Colour
refresh	If the widget should be refreshed

Returns: True if successful

bool NextionWaveform::setGridHeight ( uint16_t height )

Sets the height of the grid squares.

Parameters

height Height

Returns: True if successful

bool NextionWaveform::setGridWidth ( uint16_t width )

Sets the width of the grid squares.

Parameters

width Width

Returns: True if successful

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation