NeoNextion
Arduino library for the Nextion displays.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator
Public Member Functions | List of all members
NextionTimer Class Reference

Represents a timer. More...

#include <NextionTimer.h>

Inheritance diagram for NextionTimer:
Inheritance graph
[legend]
Collaboration diagram for NextionTimer:
Collaboration graph
[legend]

Public Member Functions

 NextionTimer (Nextion &nex, uint8_t page, uint8_t component, const char *name)
 Create a new widget adapter. More...
 
uint32_t getCycle ()
 Gets the cycle time of the timer. More...
 
bool setCycle (uint32_t cycle)
 Sets the cycle time of the timer. More...
 
bool enable ()
 Enable/start the timer. More...
 
bool disable ()
 Disable/stop the timer. 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...
 

Additional Inherited Members

- Protected Member Functions inherited from INextionWidget
bool sendCommand (char *commandStr, bool checkComplete=true)
 
- Protected Attributes inherited from INextionWidget
Nextionm_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 timer.

Constructor & Destructor Documentation

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

Create a new widget adapter.

Parameters
nexReference to the Nextion driver
pageID of page this widget is on
componentComponent ID of this widget
nameName of this widget

Member Function Documentation

bool NextionTimer::disable ( )

Disable/stop the timer.

Returns
True if successful
bool NextionTimer::enable ( )

Enable/start the timer.

Returns
True if successful
uint32_t NextionTimer::getCycle ( )

Gets the cycle time of the timer.

Returns
Time in ms (may also return 0 in case of error)
bool NextionTimer::setCycle ( uint32_t  cycle)

Sets the cycle time of the timer.

Parameters
cycleTime in ms
Returns
True if successful

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