#include <endstop_cover.h>

Inheritance diagram for esphome::endstop::EndstopCover:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

Trigger *	get_open_trigger () const

Trigger *	get_close_trigger () const

Trigger *	get_stop_trigger () const

void	set_open_endstop (binary_sensor::BinarySensor *open_endstop)

void	set_close_endstop (binary_sensor::BinarySensor *close_endstop)

void	set_open_duration (uint32_t open_duration)

void	set_close_duration (uint32_t close_duration)

void	set_max_duration (uint32_t max_duration)

cover::CoverTraits	get_traits () 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().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 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...

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_open_ () const

bool	is_closed_ () const

bool	is_at_target_ () const

void	start_direction_ (cover::CoverOperation dir)

void	recompute_position_ ()

Protected Member Functions inherited from esphome::cover::Cover
optional< CoverRestoreState >	restore_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
binary_sensor::BinarySensor *	open_endstop_

binary_sensor::BinarySensor *	close_endstop_

Trigger *	open_trigger_ {new Trigger<>()}

uint32_t	open_duration_

Trigger *	close_trigger_ {new Trigger<>()}

uint32_t	close_duration_

Trigger *	stop_trigger_ {new Trigger<>()}

uint32_t	max_duration_ {UINT32_MAX}

Trigger *	prev_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}

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 11 of file endstop_cover.h.

Member Function Documentation

◆ control()

void esphome::endstop::EndstopCover::control ( const cover::CoverCall & call )

overrideprotectedvirtual

Implements esphome::cover::Cover.

Definition at line 20 of file endstop_cover.cpp.

◆ dump_config()

void esphome::endstop::EndstopCover::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 104 of file endstop_cover.cpp.

◆ get_close_trigger()

Trigger* esphome::endstop::EndstopCover::get_close_trigger ( ) const

inline

Definition at line 19 of file endstop_cover.h.

◆ get_open_trigger()

Trigger* esphome::endstop::EndstopCover::get_open_trigger ( ) const

inline

Definition at line 18 of file endstop_cover.h.

◆ get_setup_priority()

float esphome::endstop::EndstopCover::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 111 of file endstop_cover.cpp.

◆ get_stop_trigger()

Trigger* esphome::endstop::EndstopCover::get_stop_trigger ( ) const

inline

Definition at line 20 of file endstop_cover.h.

◆ get_traits()

CoverTraits esphome::endstop::EndstopCover::get_traits ( )

overridevirtual

Implements esphome::cover::Cover.

Definition at line 12 of file endstop_cover.cpp.

◆ is_at_target_()

bool esphome::endstop::EndstopCover::is_at_target_ ( ) const

protected

Definition at line 118 of file endstop_cover.cpp.

◆ is_closed_()

bool esphome::endstop::EndstopCover::is_closed_ ( ) const

inlineprotected

Definition at line 33 of file endstop_cover.h.

◆ is_open_()

bool esphome::endstop::EndstopCover::is_open_ ( ) const

inlineprotected

Definition at line 32 of file endstop_cover.h.

◆ loop()

void esphome::endstop::EndstopCover::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file endstop_cover.cpp.

◆ recompute_position_()

void esphome::endstop::EndstopCover::recompute_position_ ( )

protected

Definition at line 165 of file endstop_cover.cpp.

◆ set_close_duration()

void esphome::endstop::EndstopCover::set_close_duration ( uint32_t close_duration )

inline

Definition at line 24 of file endstop_cover.h.

◆ set_close_endstop()

void esphome::endstop::EndstopCover::set_close_endstop ( binary_sensor::BinarySensor * close_endstop )

inline

Definition at line 22 of file endstop_cover.h.

◆ set_max_duration()

void esphome::endstop::EndstopCover::set_max_duration ( uint32_t max_duration )

inline

Definition at line 25 of file endstop_cover.h.

◆ set_open_duration()

void esphome::endstop::EndstopCover::set_open_duration ( uint32_t open_duration )

inline

Definition at line 23 of file endstop_cover.h.

◆ set_open_endstop()

void esphome::endstop::EndstopCover::set_open_endstop ( binary_sensor::BinarySensor * open_endstop )

inline

Definition at line 21 of file endstop_cover.h.

◆ setup()

void esphome::endstop::EndstopCover::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 50 of file endstop_cover.cpp.

◆ start_direction_()

void esphome::endstop::EndstopCover::start_direction_ ( cover::CoverOperation dir )

protected

Definition at line 133 of file endstop_cover.cpp.

◆ stop_prev_trigger_()

void esphome::endstop::EndstopCover::stop_prev_trigger_ ( )

protected

Definition at line 112 of file endstop_cover.cpp.

Field Documentation

◆ close_duration_

uint32_t esphome::endstop::EndstopCover::close_duration_

protected

Definition at line 45 of file endstop_cover.h.

◆ close_endstop_

binary_sensor::BinarySensor* esphome::endstop::EndstopCover::close_endstop_

protected

Definition at line 41 of file endstop_cover.h.

◆ close_trigger_

Trigger* esphome::endstop::EndstopCover::close_trigger_ {new Trigger<>()}

protected

Definition at line 44 of file endstop_cover.h.

◆ last_operation_

cover::CoverOperation esphome::endstop::EndstopCover::last_operation_ {cover::COVER_OPERATION_OPENING}

protected

Definition at line 54 of file endstop_cover.h.

◆ last_publish_time_

uint32_t esphome::endstop::EndstopCover::last_publish_time_ {0}

protected

Definition at line 52 of file endstop_cover.h.

◆ last_recompute_time_

uint32_t esphome::endstop::EndstopCover::last_recompute_time_ {0}

protected

Definition at line 50 of file endstop_cover.h.

◆ max_duration_

uint32_t esphome::endstop::EndstopCover::max_duration_ {UINT32_MAX}

protected

Definition at line 47 of file endstop_cover.h.

◆ open_duration_

uint32_t esphome::endstop::EndstopCover::open_duration_

protected

Definition at line 43 of file endstop_cover.h.

◆ open_endstop_

binary_sensor::BinarySensor* esphome::endstop::EndstopCover::open_endstop_

protected

Definition at line 40 of file endstop_cover.h.

◆ open_trigger_

Trigger* esphome::endstop::EndstopCover::open_trigger_ {new Trigger<>()}

protected

Definition at line 42 of file endstop_cover.h.

◆ prev_command_trigger_

Trigger* esphome::endstop::EndstopCover::prev_command_trigger_ {nullptr}

protected

Definition at line 49 of file endstop_cover.h.

◆ start_dir_time_

uint32_t esphome::endstop::EndstopCover::start_dir_time_ {0}

protected

Definition at line 51 of file endstop_cover.h.

◆ stop_trigger_

Trigger* esphome::endstop::EndstopCover::stop_trigger_ {new Trigger<>()}

protected

Definition at line 46 of file endstop_cover.h.

◆ target_position_

float esphome::endstop::EndstopCover::target_position_ {0}

protected

Definition at line 53 of file endstop_cover.h.

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

/opt/build/esphome/esphome/components/endstop/endstop_cover.h
/opt/build/esphome/esphome/components/endstop/endstop_cover.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ control()

◆ dump_config()

◆ get_close_trigger()

◆ get_open_trigger()

◆ get_setup_priority()

◆ get_stop_trigger()

◆ get_traits()

◆ is_at_target_()

◆ is_closed_()

◆ is_open_()

◆ loop()

◆ recompute_position_()

◆ set_close_duration()

◆ set_close_endstop()

◆ set_max_duration()

◆ set_open_duration()

◆ set_open_endstop()

◆ setup()

◆ start_direction_()

◆ stop_prev_trigger_()

Field Documentation

◆ close_duration_

◆ close_endstop_

◆ close_trigger_

◆ last_operation_

◆ last_publish_time_

◆ last_recompute_time_

◆ max_duration_

◆ open_duration_

◆ open_endstop_

◆ open_trigger_

◆ prev_command_trigger_

◆ start_dir_time_

◆ stop_trigger_

◆ target_position_