ESPHome  2024.5.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::template_::TemplateCover Class Reference

#include <template_cover.h>

Inheritance diagram for esphome::template_::TemplateCover:
esphome::cover::Cover esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

 TemplateCover ()
void set_state_lambda (std::function< optional< float >()> &&f)
Triggerget_open_trigger () const
Triggerget_close_trigger () const
Triggerget_stop_trigger () const
Triggerget_toggle_trigger () const
Trigger< float > * get_position_trigger () const
Trigger< float > * get_tilt_trigger () const
void set_optimistic (bool optimistic)
void set_assumed_state (bool assumed_state)
void set_tilt_lambda (std::function< optional< float >()> &&tilt_f)
void set_has_stop (bool has_stop)
void set_has_position (bool has_position)
void set_has_tilt (bool has_tilt)
void set_has_toggle (bool has_toggle)
void set_restore_mode (TemplateCoverRestoreMode restore_mode)
void setup () override
void loop () override
void dump_config () override
float get_setup_priority () const override
- Public Member Functions inherited from esphome::cover::Cover
 Cover ()
CoverCall make_call ()
 Construct a new cover call used to control the cover. More...
 ESPDEPRECATED ("open() is deprecated, use make_call().set_command_open() instead.", "2021.9") void open()
 Open the cover. More...
 ESPDEPRECATED ("close() is deprecated, use make_call().set_command_close() instead.", "2021.9") void close()
 Close the cover. More...
 ESPDEPRECATED ("stop() is deprecated, use make_call().set_command_stop().perform() instead.", "2021.9") void stop()
 Stop the cover. More...
void add_on_state_callback (std::function< void()> &&f)
void publish_state (bool save=true)
 Publish the current state of the cover. More...
bool is_fully_open () const
 Helper method to check if the cover is fully open. Equivalent to comparing .position against 1.0. More...
bool is_fully_closed () const
 Helper method to check if the cover is fully closed. Equivalent to comparing .position against 0.0. More...
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_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...
- Public Member Functions inherited from esphome::Component
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 ()
bool is_ready ()
virtual bool can_proceed ()
bool status_has_warning () const
bool status_has_error () const
void status_set_warning (const char *message="unspecified")
void status_set_error (const char *message="unspecified")
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 control (const cover::CoverCall &call) override
cover::CoverTraits get_traits () override
void stop_prev_trigger_ ()
- Protected Member Functions inherited from esphome::cover::Cover
optional< CoverRestoreStaterestore_state_ ()
- 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(uint8_t)> &&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(uint8_t)> &&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

TemplateCoverRestoreMode restore_mode_ {COVER_RESTORE}
optional< std::function< optional< float >)> > state_f_
optional< std::function< optional< float >)> > tilt_f_
bool assumed_state_ {false}
bool optimistic_ {false}
bool has_stop_ {false}
bool has_toggle_ {false}
Triggerprev_command_trigger_ {nullptr}
Trigger< float > * position_trigger_
bool has_position_ {false}
Trigger< float > * tilt_trigger_
bool has_tilt_ {false}
- Protected Attributes inherited from esphome::cover::Cover
friend CoverCall
CallbackManager< void()> state_callback_ {}
ESPPreferenceObject rtc_
- 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...
- 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}

Additional Inherited Members

- Data Fields inherited from esphome::cover::Cover
CoverOperation current_operation {COVER_OPERATION_IDLE}
 The current operation of the cover (idle, opening, closing). More...
float position
 The position of the cover from 0.0 (fully closed) to 1.0 (fully open). More...
float tilt {COVER_OPEN}
 The current tilt value of the cover from 0.0 to 1.0. More...

Detailed Description

Definition at line 16 of file template_cover.h.

Constructor & Destructor Documentation

◆ TemplateCover()

esphome::template_::TemplateCover::TemplateCover ( )

Definition at line 11 of file template_cover.cpp.

Member Function Documentation

◆ control()

void esphome::template_::TemplateCover::control ( const cover::CoverCall call)

Implements esphome::cover::Cover.

Definition at line 74 of file template_cover.cpp.

◆ dump_config()

void esphome::template_::TemplateCover::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 73 of file template_cover.cpp.

◆ get_close_trigger()

Trigger * esphome::template_::TemplateCover::get_close_trigger ( ) const

Definition at line 70 of file template_cover.cpp.

◆ get_open_trigger()

Trigger * esphome::template_::TemplateCover::get_open_trigger ( ) const

Definition at line 69 of file template_cover.cpp.

◆ get_position_trigger()

Trigger< float > * esphome::template_::TemplateCover::get_position_trigger ( ) const

Definition at line 126 of file template_cover.cpp.

◆ get_setup_priority()

float esphome::template_::TemplateCover::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 68 of file template_cover.cpp.

◆ get_stop_trigger()

Trigger * esphome::template_::TemplateCover::get_stop_trigger ( ) const

Definition at line 71 of file template_cover.cpp.

◆ get_tilt_trigger()

Trigger< float > * esphome::template_::TemplateCover::get_tilt_trigger ( ) const

Definition at line 127 of file template_cover.cpp.

◆ get_toggle_trigger()

Trigger * esphome::template_::TemplateCover::get_toggle_trigger ( ) const

Definition at line 72 of file template_cover.cpp.

◆ get_traits()

CoverTraits esphome::template_::TemplateCover::get_traits ( )

Implements esphome::cover::Cover.

Definition at line 117 of file template_cover.cpp.

◆ loop()

void esphome::template_::TemplateCover::loop ( )

Reimplemented from esphome::Component.

Definition at line 38 of file template_cover.cpp.

◆ set_assumed_state()

void esphome::template_::TemplateCover::set_assumed_state ( bool  assumed_state)

Definition at line 66 of file template_cover.cpp.

◆ set_has_position()

void esphome::template_::TemplateCover::set_has_position ( bool  has_position)

Definition at line 131 of file template_cover.cpp.

◆ set_has_stop()

void esphome::template_::TemplateCover::set_has_stop ( bool  has_stop)

Definition at line 129 of file template_cover.cpp.

◆ set_has_tilt()

void esphome::template_::TemplateCover::set_has_tilt ( bool  has_tilt)

Definition at line 132 of file template_cover.cpp.

◆ set_has_toggle()

void esphome::template_::TemplateCover::set_has_toggle ( bool  has_toggle)

Definition at line 130 of file template_cover.cpp.

◆ set_optimistic()

void esphome::template_::TemplateCover::set_optimistic ( bool  optimistic)

Definition at line 65 of file template_cover.cpp.

◆ set_restore_mode()

void esphome::template_::TemplateCover::set_restore_mode ( TemplateCoverRestoreMode  restore_mode)

Definition at line 34 of file template_cover.h.

◆ set_state_lambda()

void esphome::template_::TemplateCover::set_state_lambda ( std::function< optional< float >()> &&  f)

Definition at line 67 of file template_cover.cpp.

◆ set_tilt_lambda()

void esphome::template_::TemplateCover::set_tilt_lambda ( std::function< optional< float >()> &&  tilt_f)

Definition at line 128 of file template_cover.cpp.

◆ setup()

void esphome::template_::TemplateCover::setup ( )

Reimplemented from esphome::Component.

Definition at line 18 of file template_cover.cpp.

◆ stop_prev_trigger_()

void esphome::template_::TemplateCover::stop_prev_trigger_ ( )

Definition at line 133 of file template_cover.cpp.

Field Documentation

◆ assumed_state_

bool esphome::template_::TemplateCover::assumed_state_ {false}

Definition at line 50 of file template_cover.h.

◆ close_trigger_

Trigger* esphome::template_::TemplateCover::close_trigger_

Definition at line 53 of file template_cover.h.

◆ has_position_

bool esphome::template_::TemplateCover::has_position_ {false}

Definition at line 60 of file template_cover.h.

◆ has_stop_

bool esphome::template_::TemplateCover::has_stop_ {false}

Definition at line 54 of file template_cover.h.

◆ has_tilt_

bool esphome::template_::TemplateCover::has_tilt_ {false}

Definition at line 62 of file template_cover.h.

◆ has_toggle_

bool esphome::template_::TemplateCover::has_toggle_ {false}

Definition at line 55 of file template_cover.h.

◆ open_trigger_

Trigger* esphome::template_::TemplateCover::open_trigger_

Definition at line 52 of file template_cover.h.

◆ optimistic_

bool esphome::template_::TemplateCover::optimistic_ {false}

Definition at line 51 of file template_cover.h.

◆ position_trigger_

Trigger<float>* esphome::template_::TemplateCover::position_trigger_

Definition at line 59 of file template_cover.h.

◆ prev_command_trigger_

Trigger* esphome::template_::TemplateCover::prev_command_trigger_ {nullptr}

Definition at line 58 of file template_cover.h.

◆ restore_mode_

TemplateCoverRestoreMode esphome::template_::TemplateCover::restore_mode_ {COVER_RESTORE}

Definition at line 47 of file template_cover.h.

◆ state_f_

optional<std::function<optional<float>)> > esphome::template_::TemplateCover::state_f_

Definition at line 48 of file template_cover.h.

◆ stop_trigger_

Trigger* esphome::template_::TemplateCover::stop_trigger_

Definition at line 56 of file template_cover.h.

◆ tilt_f_

optional<std::function<optional<float>)> > esphome::template_::TemplateCover::tilt_f_

Definition at line 49 of file template_cover.h.

◆ tilt_trigger_

Trigger<float>* esphome::template_::TemplateCover::tilt_trigger_

Definition at line 61 of file template_cover.h.

◆ toggle_trigger_

Trigger* esphome::template_::TemplateCover::toggle_trigger_

Definition at line 57 of file template_cover.h.

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