#include <he60r.h>

Inheritance diagram for esphome::he60r::HE60rCover:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

void	set_open_duration (uint32_t duration)

void	set_close_duration (uint32_t 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...

Public Member Functions inherited from esphome::uart::UARTDevice
	UARTDevice ()=default

	UARTDevice (UARTComponent *parent)

void	set_uart_parent (UARTComponent *parent)

void	write_byte (uint8_t data)

void	write_array (const uint8_t *data, size_t len)

void	write_array (const std::vector< uint8_t > &data)

template<size_t N>
void	write_array (const std::array< uint8_t, N > &data)

void	write_str (const char *str)

bool	read_byte (uint8_t *data)

bool	peek_byte (uint8_t *data)

bool	read_array (uint8_t *data, size_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_array ()

int	available ()

void	flush ()

int	read ()

size_t	write (uint8_t data)

int	peek ()

void	check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
	Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...

Protected Member Functions
void	update_ ()

void	control (const cover::CoverCall &call) override

bool	is_at_target_ () const
	Check if the cover has reached or passed the target position. More...

void	start_direction_ (cover::CoverOperation dir)

void	endstop_reached_ (cover::CoverOperation operation)

void	recompute_position_ ()

void	set_current_operation_ (cover::CoverOperation operation)

void	process_rx_ (uint8_t data)

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
unsigned	open_duration_ {0}

unsigned	close_duration_ {0}

unsigned	toggles_needed_ {0}

cover::CoverOperation	next_direction_ {cover::COVER_OPERATION_IDLE}

cover::CoverOperation	last_command_ {cover::COVER_OPERATION_IDLE}

uint32_t	last_recompute_time_ {0}

uint32_t	start_dir_time_ {0}

float	target_position_ {0}

bool	query_seen_ {}

uint8_t	counter_ {}

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}

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {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 he60r.h.

Member Function Documentation

◆ control()

void esphome::he60r::HE60rCover::control ( const cover::CoverCall & call )

overrideprotectedvirtual

Implements esphome::cover::Cover.

Definition at line 162 of file he60r.cpp.

◆ dump_config()

void esphome::he60r::HE60rCover::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 40 of file he60r.cpp.

◆ endstop_reached_()

void esphome::he60r::HE60rCover::endstop_reached_ ( cover::CoverOperation operation )

protected

Definition at line 50 of file he60r.cpp.

◆ get_setup_priority()

float esphome::he60r::HE60rCover::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file he60r.h.

◆ get_traits()

CoverTraits esphome::he60r::HE60rCover::get_traits ( )

overridevirtual

Implements esphome::cover::Cover.

Definition at line 31 of file he60r.cpp.

◆ is_at_target_()

bool esphome::he60r::HE60rCover::is_at_target_ ( ) const

protected

Check if the cover has reached or passed the target position.

This is used only for partial open/close requests - endstops are used for full open/close.

Returns: True if the cover has reached or passed its target position. For full open/close target always return false.

Definition at line 190 of file he60r.cpp.

◆ loop()

void esphome::he60r::HE60rCover::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 152 of file he60r.cpp.

◆ process_rx_()

void esphome::he60r::HE60rCover::process_rx_ ( uint8_t data )

protected

Definition at line 75 of file he60r.cpp.

◆ recompute_position_()

void esphome::he60r::HE60rCover::recompute_position_ ( )

protected

Definition at line 232 of file he60r.cpp.

◆ set_close_duration()

void esphome::he60r::HE60rCover::set_close_duration ( uint32_t duration )

inline

Definition at line 19 of file he60r.h.

◆ set_current_operation_()

void esphome::he60r::HE60rCover::set_current_operation_ ( cover::CoverOperation operation )

protected

Definition at line 67 of file he60r.cpp.

◆ set_open_duration()

void esphome::he60r::HE60rCover::set_open_duration ( uint32_t duration )

inline

Definition at line 18 of file he60r.h.

◆ setup()

void esphome::he60r::HE60rCover::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file he60r.cpp.

◆ start_direction_()

void esphome::he60r::HE60rCover::start_direction_ ( cover::CoverOperation dir )

protected

Definition at line 207 of file he60r.cpp.

◆ update_()

void esphome::he60r::HE60rCover::update_ ( )

protected

Definition at line 127 of file he60r.cpp.

Field Documentation

◆ close_duration_

unsigned esphome::he60r::HE60rCover::close_duration_ {0}

protected

Definition at line 34 of file he60r.h.

◆ counter_

uint8_t esphome::he60r::HE60rCover::counter_ {}

protected

Definition at line 42 of file he60r.h.

◆ last_command_

cover::CoverOperation esphome::he60r::HE60rCover::last_command_ {cover::COVER_OPERATION_IDLE}

protected

Definition at line 37 of file he60r.h.

◆ last_recompute_time_

uint32_t esphome::he60r::HE60rCover::last_recompute_time_ {0}

protected

Definition at line 38 of file he60r.h.

◆ next_direction_

cover::CoverOperation esphome::he60r::HE60rCover::next_direction_ {cover::COVER_OPERATION_IDLE}

protected

Definition at line 36 of file he60r.h.

◆ open_duration_

unsigned esphome::he60r::HE60rCover::open_duration_ {0}

protected

Definition at line 33 of file he60r.h.

◆ query_seen_

bool esphome::he60r::HE60rCover::query_seen_ {}

protected

Definition at line 41 of file he60r.h.

◆ start_dir_time_

uint32_t esphome::he60r::HE60rCover::start_dir_time_ {0}

protected

Definition at line 39 of file he60r.h.

◆ target_position_

float esphome::he60r::HE60rCover::target_position_ {0}

protected

Definition at line 40 of file he60r.h.

◆ toggles_needed_

unsigned esphome::he60r::HE60rCover::toggles_needed_ {0}

protected

Definition at line 35 of file he60r.h.

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

/opt/build/esphome/esphome/components/he60r/he60r.h
/opt/build/esphome/esphome/components/he60r/he60r.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ control()

◆ dump_config()

◆ endstop_reached_()

◆ get_setup_priority()

◆ get_traits()

◆ is_at_target_()

◆ loop()

◆ process_rx_()

◆ recompute_position_()

◆ set_close_duration()

◆ set_current_operation_()

◆ set_open_duration()

◆ setup()

◆ start_direction_()

◆ update_()

Field Documentation

◆ close_duration_

◆ counter_

◆ last_command_

◆ last_recompute_time_

◆ next_direction_

◆ open_duration_

◆ query_seen_

◆ start_dir_time_

◆ target_position_

◆ toggles_needed_