ESPHome  2022.9.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::current_based::CurrentBasedCover Class Reference

#include <current_based_cover.h>

Inheritance diagram for esphome::current_based::CurrentBasedCover:
esphome::cover::Cover esphome::Component esphome::EntityBase

Public Member Functions

void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
Triggerget_stop_trigger () const
 
Triggerget_open_trigger () const
 
void set_open_sensor (sensor::Sensor *open_sensor)
 
void set_open_moving_current_threshold (float open_moving_current_threshold)
 
void set_open_obstacle_current_threshold (float open_obstacle_current_threshold)
 
void set_open_duration (uint32_t open_duration)
 
Triggerget_close_trigger () const
 
void set_close_sensor (sensor::Sensor *close_sensor)
 
void set_close_moving_current_threshold (float close_moving_current_threshold)
 
void set_close_obstacle_current_threshold (float close_obstacle_current_threshold)
 
void set_close_duration (uint32_t close_duration)
 
void set_max_duration (uint32_t max_duration)
 
void set_obstacle_rollback (float obstacle_rollback)
 
void set_malfunction_detection (bool malfunction_detection)
 
void set_start_sensing_delay (uint32_t start_sensing_delay)
 
Triggerget_malfunction_trigger () const
 
cover::CoverTraits get_traits () override
 
- Public Member Functions inherited from esphome::cover::Cover
 Cover ()
 
 Cover (const std::string &name)
 
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() 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...
 
void set_device_class (const std::string &device_class)
 
std::string get_device_class ()
 
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
 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
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 control (const cover::CoverCall &call) override
 
void stop_prev_trigger_ ()
 
bool is_at_target_ () const
 
bool is_opening_ () const
 
bool is_opening_blocked_ () const
 
bool is_closing_ () const
 
bool is_closing_blocked_ () const
 
bool is_initial_delay_finished_ () const
 
void direction_idle_ (float new_position=FLT_MAX)
 
void start_direction_ (cover::CoverOperation dir)
 
void recompute_position_ ()
 
- Protected Member Functions inherited from esphome::cover::Cover
virtual std::string device_class ()
 Override this to set the default device class. More...
 
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()> &&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

Triggerstop_trigger_ {new Trigger<>()}
 
sensor::Sensoropen_sensor_ {nullptr}
 
Triggeropen_trigger_ {new Trigger<>()}
 
float open_moving_current_threshold_
 
float open_obstacle_current_threshold_ {FLT_MAX}
 
uint32_t open_duration_
 
sensor::Sensorclose_sensor_ {nullptr}
 
Triggerclose_trigger_ {new Trigger<>()}
 
float close_moving_current_threshold_
 
float close_obstacle_current_threshold_ {FLT_MAX}
 
uint32_t close_duration_
 
uint32_t max_duration_ {UINT32_MAX}
 
bool malfunction_detection_ {true}
 
Triggermalfunction_trigger_ {new Trigger<>()}
 
uint32_t start_sensing_delay_
 
float obstacle_rollback_
 
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}
 
- Protected Attributes inherited from esphome::cover::Cover
friend CoverCall
 
CallbackManager< void()> state_callback_ {}
 
optional< std::string > device_class_override_ {}
 
ESPPreferenceObject rtc_
 
- 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}
 

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 12 of file current_based_cover.h.

Member Function Documentation

◆ control()

void esphome::current_based::CurrentBasedCover::control ( const cover::CoverCall call)
overrideprotectedvirtual

Implements esphome::cover::Cover.

Definition at line 19 of file current_based_cover.cpp.

◆ direction_idle_()

void esphome::current_based::CurrentBasedCover::direction_idle_ ( float  new_position = FLT_MAX)
protected

Definition at line 110 of file current_based_cover.cpp.

◆ dump_config()

void esphome::current_based::CurrentBasedCover::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 118 of file current_based_cover.cpp.

◆ get_close_trigger()

Trigger* esphome::current_based::CurrentBasedCover::get_close_trigger ( ) const
inline

Definition at line 31 of file current_based_cover.h.

◆ get_malfunction_trigger()

Trigger* esphome::current_based::CurrentBasedCover::get_malfunction_trigger ( ) const
inline

Definition at line 47 of file current_based_cover.h.

◆ get_open_trigger()

Trigger* esphome::current_based::CurrentBasedCover::get_open_trigger ( ) const
inline

Definition at line 21 of file current_based_cover.h.

◆ get_setup_priority()

float esphome::current_based::CurrentBasedCover::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 140 of file current_based_cover.cpp.

◆ get_stop_trigger()

Trigger* esphome::current_based::CurrentBasedCover::get_stop_trigger ( ) const
inline

Definition at line 19 of file current_based_cover.h.

◆ get_traits()

CoverTraits esphome::current_based::CurrentBasedCover::get_traits ( )
overridevirtual

Implements esphome::cover::Cover.

Definition at line 13 of file current_based_cover.cpp.

◆ is_at_target_()

bool esphome::current_based::CurrentBasedCover::is_at_target_ ( ) const
protected

Definition at line 173 of file current_based_cover.cpp.

◆ is_closing_()

bool esphome::current_based::CurrentBasedCover::is_closing_ ( ) const
protected

Definition at line 159 of file current_based_cover.cpp.

◆ is_closing_blocked_()

bool esphome::current_based::CurrentBasedCover::is_closing_blocked_ ( ) const
protected

Definition at line 163 of file current_based_cover.cpp.

◆ is_initial_delay_finished_()

bool esphome::current_based::CurrentBasedCover::is_initial_delay_finished_ ( ) const
protected

Definition at line 169 of file current_based_cover.cpp.

◆ is_opening_()

bool esphome::current_based::CurrentBasedCover::is_opening_ ( ) const
protected

Definition at line 148 of file current_based_cover.cpp.

◆ is_opening_blocked_()

bool esphome::current_based::CurrentBasedCover::is_opening_blocked_ ( ) const
protected

Definition at line 152 of file current_based_cover.cpp.

◆ loop()

void esphome::current_based::CurrentBasedCover::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 43 of file current_based_cover.cpp.

◆ recompute_position_()

void esphome::current_based::CurrentBasedCover::recompute_position_ ( )
protected

Definition at line 224 of file current_based_cover.cpp.

◆ set_close_duration()

void esphome::current_based::CurrentBasedCover::set_close_duration ( uint32_t  close_duration)
inline

Definition at line 39 of file current_based_cover.h.

◆ set_close_moving_current_threshold()

void esphome::current_based::CurrentBasedCover::set_close_moving_current_threshold ( float  close_moving_current_threshold)
inline

Definition at line 33 of file current_based_cover.h.

◆ set_close_obstacle_current_threshold()

void esphome::current_based::CurrentBasedCover::set_close_obstacle_current_threshold ( float  close_obstacle_current_threshold)
inline

Definition at line 36 of file current_based_cover.h.

◆ set_close_sensor()

void esphome::current_based::CurrentBasedCover::set_close_sensor ( sensor::Sensor close_sensor)
inline

Definition at line 32 of file current_based_cover.h.

◆ set_malfunction_detection()

void esphome::current_based::CurrentBasedCover::set_malfunction_detection ( bool  malfunction_detection)
inline

Definition at line 44 of file current_based_cover.h.

◆ set_max_duration()

void esphome::current_based::CurrentBasedCover::set_max_duration ( uint32_t  max_duration)
inline

Definition at line 41 of file current_based_cover.h.

◆ set_obstacle_rollback()

void esphome::current_based::CurrentBasedCover::set_obstacle_rollback ( float  obstacle_rollback)
inline

Definition at line 42 of file current_based_cover.h.

◆ set_open_duration()

void esphome::current_based::CurrentBasedCover::set_open_duration ( uint32_t  open_duration)
inline

Definition at line 29 of file current_based_cover.h.

◆ set_open_moving_current_threshold()

void esphome::current_based::CurrentBasedCover::set_open_moving_current_threshold ( float  open_moving_current_threshold)
inline

Definition at line 23 of file current_based_cover.h.

◆ set_open_obstacle_current_threshold()

void esphome::current_based::CurrentBasedCover::set_open_obstacle_current_threshold ( float  open_obstacle_current_threshold)
inline

Definition at line 26 of file current_based_cover.h.

◆ set_open_sensor()

void esphome::current_based::CurrentBasedCover::set_open_sensor ( sensor::Sensor open_sensor)
inline

Definition at line 22 of file current_based_cover.h.

◆ set_start_sensing_delay()

void esphome::current_based::CurrentBasedCover::set_start_sensing_delay ( uint32_t  start_sensing_delay)
inline

Definition at line 45 of file current_based_cover.h.

◆ setup()

void esphome::current_based::CurrentBasedCover::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 34 of file current_based_cover.cpp.

◆ start_direction_()

void esphome::current_based::CurrentBasedCover::start_direction_ ( cover::CoverOperation  dir)
protected

Definition at line 194 of file current_based_cover.cpp.

◆ stop_prev_trigger_()

void esphome::current_based::CurrentBasedCover::stop_prev_trigger_ ( )
protected

Definition at line 141 of file current_based_cover.cpp.

Field Documentation

◆ close_duration_

uint32_t esphome::current_based::CurrentBasedCover::close_duration_
protected

Definition at line 79 of file current_based_cover.h.

◆ close_moving_current_threshold_

float esphome::current_based::CurrentBasedCover::close_moving_current_threshold_
protected

Definition at line 77 of file current_based_cover.h.

◆ close_obstacle_current_threshold_

float esphome::current_based::CurrentBasedCover::close_obstacle_current_threshold_ {FLT_MAX}
protected

Definition at line 78 of file current_based_cover.h.

◆ close_sensor_

sensor::Sensor* esphome::current_based::CurrentBasedCover::close_sensor_ {nullptr}
protected

Definition at line 75 of file current_based_cover.h.

◆ close_trigger_

Trigger* esphome::current_based::CurrentBasedCover::close_trigger_ {new Trigger<>()}
protected

Definition at line 76 of file current_based_cover.h.

◆ last_publish_time_

uint32_t esphome::current_based::CurrentBasedCover::last_publish_time_ {0}
protected

Definition at line 90 of file current_based_cover.h.

◆ last_recompute_time_

uint32_t esphome::current_based::CurrentBasedCover::last_recompute_time_ {0}
protected

Definition at line 88 of file current_based_cover.h.

◆ malfunction_detection_

bool esphome::current_based::CurrentBasedCover::malfunction_detection_ {true}
protected

Definition at line 82 of file current_based_cover.h.

◆ malfunction_trigger_

Trigger* esphome::current_based::CurrentBasedCover::malfunction_trigger_ {new Trigger<>()}
protected

Definition at line 83 of file current_based_cover.h.

◆ max_duration_

uint32_t esphome::current_based::CurrentBasedCover::max_duration_ {UINT32_MAX}
protected

Definition at line 81 of file current_based_cover.h.

◆ obstacle_rollback_

float esphome::current_based::CurrentBasedCover::obstacle_rollback_
protected

Definition at line 85 of file current_based_cover.h.

◆ open_duration_

uint32_t esphome::current_based::CurrentBasedCover::open_duration_
protected

Definition at line 73 of file current_based_cover.h.

◆ open_moving_current_threshold_

float esphome::current_based::CurrentBasedCover::open_moving_current_threshold_
protected

Definition at line 71 of file current_based_cover.h.

◆ open_obstacle_current_threshold_

float esphome::current_based::CurrentBasedCover::open_obstacle_current_threshold_ {FLT_MAX}
protected

Definition at line 72 of file current_based_cover.h.

◆ open_sensor_

sensor::Sensor* esphome::current_based::CurrentBasedCover::open_sensor_ {nullptr}
protected

Definition at line 69 of file current_based_cover.h.

◆ open_trigger_

Trigger* esphome::current_based::CurrentBasedCover::open_trigger_ {new Trigger<>()}
protected

Definition at line 70 of file current_based_cover.h.

◆ prev_command_trigger_

Trigger* esphome::current_based::CurrentBasedCover::prev_command_trigger_ {nullptr}
protected

Definition at line 87 of file current_based_cover.h.

◆ start_dir_time_

uint32_t esphome::current_based::CurrentBasedCover::start_dir_time_ {0}
protected

Definition at line 89 of file current_based_cover.h.

◆ start_sensing_delay_

uint32_t esphome::current_based::CurrentBasedCover::start_sensing_delay_
protected

Definition at line 84 of file current_based_cover.h.

◆ stop_trigger_

Trigger* esphome::current_based::CurrentBasedCover::stop_trigger_ {new Trigger<>()}
protected

Definition at line 67 of file current_based_cover.h.

◆ target_position_

float esphome::current_based::CurrentBasedCover::target_position_ {0}
protected

Definition at line 91 of file current_based_cover.h.


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