ESPHome  2024.7.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::time_based::TimeBasedCover Class Reference

#include <time_based_cover.h>

Inheritance diagram for esphome::time_based::TimeBasedCover:
esphome::cover::Cover esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
Triggerget_open_trigger () const
 
Triggerget_close_trigger () const
 
Triggerget_stop_trigger () const
 
void set_open_duration (uint32_t open_duration)
 
void set_close_duration (uint32_t close_duration)
 
cover::CoverTraits get_traits () override
 
void set_has_built_in_endstop (bool value)
 
void set_manual_control (bool value)
 
void set_assumed_state (bool value)
 
cover::CoverOperation get_last_operation () const
 
- 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().perform() instead.", "2021.9") void open()
 Open the cover. More...
 
 ESPDEPRECATED ("close() is deprecated, use make_call().set_command_close().perform() 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 () const
 
bool is_ready () const
 
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
 
void stop_prev_trigger_ ()
 
bool is_at_target_ () const
 
void start_direction_ (cover::CoverOperation dir)
 
void recompute_position_ ()
 
- 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

Triggeropen_trigger_ {new Trigger<>()}
 
uint32_t open_duration_
 
Triggerclose_trigger_ {new Trigger<>()}
 
uint32_t close_duration_
 
Triggerstop_trigger_ {new Trigger<>()}
 
Triggerprev_command_trigger_ {nullptr}
 
uint32_t last_recompute_time_ {0}
 
uint32_t start_dir_time_ {0}
 
uint32_t last_publish_time_ {0}
 
float target_position_ {0}
 
bool has_built_in_endstop_ {false}
 
bool manual_control_ {false}
 
bool assumed_state_ {false}
 
cover::CoverOperation last_operation_ {cover::COVER_OPERATION_OPENING}
 
- 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 10 of file time_based_cover.h.

Member Function Documentation

◆ control()

void esphome::time_based::TimeBasedCover::control ( const cover::CoverCall call)
overrideprotectedvirtual

Implements esphome::cover::Cover.

Definition at line 60 of file time_based_cover.cpp.

◆ dump_config()

void esphome::time_based::TimeBasedCover::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file time_based_cover.cpp.

◆ get_close_trigger()

Trigger* esphome::time_based::TimeBasedCover::get_close_trigger ( ) const
inline

Definition at line 18 of file time_based_cover.h.

◆ get_last_operation()

cover::CoverOperation esphome::time_based::TimeBasedCover::get_last_operation ( ) const
inline

Definition at line 26 of file time_based_cover.h.

◆ get_open_trigger()

Trigger* esphome::time_based::TimeBasedCover::get_open_trigger ( ) const
inline

Definition at line 17 of file time_based_cover.h.

◆ get_setup_priority()

float esphome::time_based::TimeBasedCover::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 51 of file time_based_cover.cpp.

◆ get_stop_trigger()

Trigger* esphome::time_based::TimeBasedCover::get_stop_trigger ( ) const
inline

Definition at line 19 of file time_based_cover.h.

◆ get_traits()

CoverTraits esphome::time_based::TimeBasedCover::get_traits ( )
overridevirtual

Implements esphome::cover::Cover.

Definition at line 52 of file time_based_cover.cpp.

◆ is_at_target_()

bool esphome::time_based::TimeBasedCover::is_at_target_ ( ) const
protected

Definition at line 113 of file time_based_cover.cpp.

◆ loop()

void esphome::time_based::TimeBasedCover::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 25 of file time_based_cover.cpp.

◆ recompute_position_()

void esphome::time_based::TimeBasedCover::recompute_position_ ( )
protected

Definition at line 156 of file time_based_cover.cpp.

◆ set_assumed_state()

void esphome::time_based::TimeBasedCover::set_assumed_state ( bool  value)
inline

Definition at line 25 of file time_based_cover.h.

◆ set_close_duration()

void esphome::time_based::TimeBasedCover::set_close_duration ( uint32_t  close_duration)
inline

Definition at line 21 of file time_based_cover.h.

◆ set_has_built_in_endstop()

void esphome::time_based::TimeBasedCover::set_has_built_in_endstop ( bool  value)
inline

Definition at line 23 of file time_based_cover.h.

◆ set_manual_control()

void esphome::time_based::TimeBasedCover::set_manual_control ( bool  value)
inline

Definition at line 24 of file time_based_cover.h.

◆ set_open_duration()

void esphome::time_based::TimeBasedCover::set_open_duration ( uint32_t  open_duration)
inline

Definition at line 20 of file time_based_cover.h.

◆ setup()

void esphome::time_based::TimeBasedCover::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file time_based_cover.cpp.

◆ start_direction_()

void esphome::time_based::TimeBasedCover::start_direction_ ( cover::CoverOperation  dir)
protected

Definition at line 124 of file time_based_cover.cpp.

◆ stop_prev_trigger_()

void esphome::time_based::TimeBasedCover::stop_prev_trigger_ ( )
protected

Definition at line 107 of file time_based_cover.cpp.

Field Documentation

◆ assumed_state_

bool esphome::time_based::TimeBasedCover::assumed_state_ {false}
protected

Definition at line 50 of file time_based_cover.h.

◆ close_duration_

uint32_t esphome::time_based::TimeBasedCover::close_duration_
protected

Definition at line 40 of file time_based_cover.h.

◆ close_trigger_

Trigger* esphome::time_based::TimeBasedCover::close_trigger_ {new Trigger<>()}
protected

Definition at line 39 of file time_based_cover.h.

◆ has_built_in_endstop_

bool esphome::time_based::TimeBasedCover::has_built_in_endstop_ {false}
protected

Definition at line 48 of file time_based_cover.h.

◆ last_operation_

cover::CoverOperation esphome::time_based::TimeBasedCover::last_operation_ {cover::COVER_OPERATION_OPENING}
protected

Definition at line 51 of file time_based_cover.h.

◆ last_publish_time_

uint32_t esphome::time_based::TimeBasedCover::last_publish_time_ {0}
protected

Definition at line 46 of file time_based_cover.h.

◆ last_recompute_time_

uint32_t esphome::time_based::TimeBasedCover::last_recompute_time_ {0}
protected

Definition at line 44 of file time_based_cover.h.

◆ manual_control_

bool esphome::time_based::TimeBasedCover::manual_control_ {false}
protected

Definition at line 49 of file time_based_cover.h.

◆ open_duration_

uint32_t esphome::time_based::TimeBasedCover::open_duration_
protected

Definition at line 38 of file time_based_cover.h.

◆ open_trigger_

Trigger* esphome::time_based::TimeBasedCover::open_trigger_ {new Trigger<>()}
protected

Definition at line 37 of file time_based_cover.h.

◆ prev_command_trigger_

Trigger* esphome::time_based::TimeBasedCover::prev_command_trigger_ {nullptr}
protected

Definition at line 43 of file time_based_cover.h.

◆ start_dir_time_

uint32_t esphome::time_based::TimeBasedCover::start_dir_time_ {0}
protected

Definition at line 45 of file time_based_cover.h.

◆ stop_trigger_

Trigger* esphome::time_based::TimeBasedCover::stop_trigger_ {new Trigger<>()}
protected

Definition at line 41 of file time_based_cover.h.

◆ target_position_

float esphome::time_based::TimeBasedCover::target_position_ {0}
protected

Definition at line 47 of file time_based_cover.h.


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