SensESP 2.7.2
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::ButtonHandler Class Reference

Default Button Handler for SensESPApp applications. More...

#include <sensesp/system/button.h>

Inheritance diagram for sensesp::ButtonHandler:
[legend]

Public Member Functions

 ButtonHandler (int pin, String config_path="")
 
- Public Member Functions inherited from sensesp::MinimalButtonHandler
 MinimalButtonHandler (int pin, String config_path="")
 
virtual void handleEvent (AceButton *button, uint8_t event_type, uint8_t button_state) override
 
- Public Member Functions inherited from sensesp::BaseButtonHandler
 BaseButtonHandler (int pin, String config_path="")
 
virtual void start () override
 
- Public Member Functions inherited from sensesp::Configurable
 Configurable (String config_path="", String description="", int sort_order=1000)
 
virtual void get_configuration (JsonObject &configObject)
 
virtual bool set_configuration (const JsonObject &config)
 
virtual String get_config_schema ()
 
String get_description ()
 
void set_description (String description)
 Set the description of the Configurable.
 
int get_sort_order ()
 
void set_sort_order (int sort_order)
 
virtual void save_configuration ()
 
- Public Member Functions inherited from sensesp::Startable
 Startable (int priority=0)
 
const int get_start_priority ()
 
void set_start_priority (int priority)
 

Protected Member Functions

virtual void handle_long_press () override
 Handle a long button press (over 1 second).
 
- Protected Member Functions inherited from sensesp::MinimalButtonHandler
virtual void handle_button_press ()
 Handle a brief button press (less than one second).
 
virtual void handle_very_long_press ()
 Handle a very long button press (over 5 seconds).
 
- Protected Member Functions inherited from sensesp::Configurable
virtual void load_configuration ()
 

Additional Inherited Members

- Static Public Member Functions inherited from sensesp::Startable
static void start_all ()
 
- Public Attributes inherited from sensesp::Configurable
const String config_path_
 
- Protected Attributes inherited from sensesp::MinimalButtonHandler
elapsedMillis time_since_press_event
 
- Protected Attributes inherited from sensesp::BaseButtonHandler
AceButtonbutton_
 
- Protected Attributes inherited from sensesp::Configurable
String description_ = ""
 
int sort_order_ = 1000
 

Detailed Description

Default Button Handler for SensESPApp applications.

This button handler implements restart on short press, network settings reset on a long press, and factory reset on a very long press.

Definition at line 23 of file button.h.

Constructor & Destructor Documentation

◆ ButtonHandler()

sensesp::ButtonHandler::ButtonHandler ( int  pin,
String  config_path = "" 
)
inline

Definition at line 25 of file button.h.

Member Function Documentation

◆ handle_long_press()

void sensesp::ButtonHandler::handle_long_press ( )
overrideprotectedvirtual

Handle a long button press (over 1 second).

Reimplemented from sensesp::MinimalButtonHandler.

Definition at line 8 of file button.cpp.

Here is the call graph for this function:

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