Base class for all buttons. More...
#include <button.h>
Public Member Functions | |
| void | press () |
| Press this button. More... | |
| void | add_on_press_callback (std::function< void()> &&callback) |
| Set callback for state changes. More... | |
 Public Member Functions inherited from esphome::EntityBase | |
| const StringRef & | get_name () const |
| void | set_name (const char *name) |
| bool | has_own_name () const |
| std::string | get_object_id () const |
| void | set_object_id (const char *object_id) |
| uint32_t | get_object_id_hash () |
| bool | is_internal () const |
| void | set_internal (bool internal) |
| bool | is_disabled_by_default () const |
| void | set_disabled_by_default (bool disabled_by_default) |
| EntityCategory | get_entity_category () const |
| void | set_entity_category (EntityCategory entity_category) |
| std::string | get_icon () const |
| void | set_icon (const char *icon) |
| Public Member Functions inherited from esphome::EntityBase_DeviceClass | |
| std::string | get_device_class () |
| Get the device class, using the manual override if set. More... | |
| void | set_device_class (const char *device_class) |
| Manually set the device class. More... | |
Protected Member Functions | |
| virtual void | press_action ()=0 |
| You should implement this virtual method if you want to create your own button. More... | |
| Protected Member Functions inherited from esphome::EntityBase | |
| virtual uint32_t | hash_base () |
| The hash_base() function has been deprecated. More... | |
| void | calc_object_id_ () |
Protected Attributes | |
| CallbackManager< void()> | press_callback_ {} |
| Protected Attributes inherited from esphome::EntityBase | |
| StringRef | name_ |
| const char * | object_id_c_str_ {nullptr} |
| const char * | icon_c_str_ {nullptr} |
| uint32_t | object_id_hash_ |
| bool | has_own_name_ {false} |
| bool | internal_ {false} |
| bool | disabled_by_default_ {false} |
| EntityCategory | entity_category_ {ENTITY_CATEGORY_NONE} |
| Protected Attributes inherited from esphome::EntityBase_DeviceClass | |
| const char * | device_class_ {nullptr} |
| Device class override. More... | |
Detailed Description
Base class for all buttons.
A button is just a momentary switch that does not have a state, only a trigger.
Member Function Documentation
◆ add_on_press_callback()
| void esphome::button::Button::add_on_press_callback | ( | std::function< void()> && | callback | ) |
Set callback for state changes.
- Parameters
-
callback The void() callback.
Definition at line 14 of file button.cpp.
◆ press()
| void esphome::button::Button::press | ( | ) |
Press this button.
This is called by the front-end.
For implementing buttons, please override press_action.
Definition at line 9 of file button.cpp.
◆ press_action()
|
protectedpure virtual |
You should implement this virtual method if you want to create your own button.
Implemented in esphome::wake_on_lan::WakeOnLanButton, esphome::output::OutputButton, esphome::safe_mode::SafeModeButton, esphome::copy::CopyButton, esphome::factory_reset::FactoryResetButton, esphome::ld2410::QueryButton, esphome::ld2410::ResetButton, esphome::ld2410::RestartButton, esphome::restart::RestartButton, esphome::shutdown::ShutdownButton, and esphome::template_::TemplateButton.
Field Documentation
◆ press_callback_
|
protected |
The documentation for this class was generated from the following files:
- /opt/build/esphome/esphome/components/button/button.h
- /opt/build/esphome/esphome/components/button/button.cpp
