ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::output::OutputButton Class Reference

#include <output_button.h>

Inheritance diagram for esphome::output::OutputButton:
esphome::button::Button esphome::Component esphome::EntityBase

Public Member Functions

void dump_config () override
void set_output (BinaryOutput *output)
void set_duration (uint32_t duration)
- Public Member Functions inherited from esphome::button::Button
 Button ()
 Button (const std::string &name)
void press ()
 Press this button. More...
void add_on_press_callback (std::function< void()> &&callback)
 Set callback for state changes. More...
void set_device_class (const std::string &device_class)
 Set the Home Assistant device class (see button::device_class). More...
std::string get_device_class ()
 Get the device class for this button. More...
- Public Member Functions inherited from esphome::EntityBase
 EntityBase ()
 EntityBase (std::string name)
const std::string & get_name () const
void set_name (const std::string &name)
const std::string & get_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)
const std::string & get_icon () const
void set_icon (const std::string &name)
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
virtual void loop ()
 This method will be called repeatedly. More...
virtual float get_setup_priority () const
 priority of setup(). More...
float get_actual_setup_priority () const
void set_setup_priority (float priority)
virtual float get_loop_priority () const
 priority of loop(). More...
void call ()
virtual void on_shutdown ()
virtual void on_safe_shutdown ()
uint32_t get_component_state () const
virtual void mark_failed ()
 Mark this component as failed. More...
bool is_failed ()
virtual bool can_proceed ()
bool status_has_warning ()
bool status_has_error ()
void status_set_warning ()
void status_set_error ()
void status_clear_warning ()
void status_clear_error ()
void status_momentary_warning (const std::string &name, uint32_t length=5000)
void status_momentary_error (const std::string &name, uint32_t length=5000)
bool has_overridden_loop () const
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...

Protected Member Functions

void press_action () override
- 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 Member Functions inherited from esphome::Component
virtual void call_loop ()
virtual void call_setup ()
virtual void call_dump_config ()
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
void set_interval (uint32_t interval, std::function< void()> &&f)
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
void set_timeout (uint32_t timeout, std::function< void()> &&f)
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes

uint32_t duration_
- Protected Attributes inherited from esphome::button::Button
CallbackManager< void()> press_callback_ {}
std::string device_class_ {}
- Protected Attributes inherited from esphome::EntityBase
std::string name_
std::string object_id_
std::string icon_
uint32_t object_id_hash_
bool internal_ {false}
bool disabled_by_default_ {false}
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
float setup_priority_override_ {NAN}
const char * component_source_ {nullptr}

Detailed Description

Definition at line 10 of file output_button.h.

Member Function Documentation

◆ dump_config()

void esphome::output::OutputButton::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 9 of file output_button.cpp.

◆ press_action()

void esphome::output::OutputButton::press_action ( )

Implements esphome::button::Button.

Definition at line 13 of file output_button.cpp.

◆ set_duration()

void esphome::output::OutputButton::set_duration ( uint32_t  duration)

Definition at line 15 of file output_button.h.

◆ set_output()

void esphome::output::OutputButton::set_output ( BinaryOutput output)

Definition at line 14 of file output_button.h.

Field Documentation

◆ duration_

uint32_t esphome::output::OutputButton::duration_

Definition at line 21 of file output_button.h.

◆ output_

output::BinaryOutput* esphome::output::OutputButton::output_

Definition at line 20 of file output_button.h.

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