#include <tormatic_cover.h>

Inheritance diagram for esphome::tormatic::Tormatic:

Public Member Functions
void	setup () override

void	loop () override

void	update () 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)

void	publish_state (bool save=true, uint32_t ratelimit=0)

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::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...

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms. More...

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object. More...

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor. More...

void	start_poller ()

void	stop_poller ()

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	recalibrate_duration_ (GateStatus s)

void	recompute_position_ ()

void	control_position_ (float target)

void	stop_at_target_ ()

template<typename T >
void	send_message_ (MessageType t, T r)

template<typename T >
optional< T >	read_data_ ()

void	drain_rx_ (uint16_t n=0)

void	request_gate_status_ ()

optional< GateStatus >	read_gate_status_ ()

void	send_gate_command_ (GateStatus s)

void	handle_gate_status_ (GateStatus s)

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_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
uint32_t	seq_tx_ {0}

GateStatus	current_status_ {PAUSED}

uint32_t	open_duration_ {0}

uint32_t	close_duration_ {0}

uint32_t	last_publish_time_ {0}

uint32_t	last_recompute_time_ {0}

uint32_t	direction_start_time_ {0}

GateStatus	next_command_ {OPENED}

optional< float >	target_position_ {}

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::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

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 13 of file tormatic_cover.h.

Member Function Documentation

◆ control()

void esphome::tormatic::Tormatic::control ( const cover::CoverCall & call )

overrideprotectedvirtual

Implements esphome::cover::Cover.

Definition at line 61 of file tormatic_cover.cpp.

◆ control_position_()

void esphome::tormatic::Tormatic::control_position_ ( float target )

protected

Definition at line 193 of file tormatic_cover.cpp.

◆ drain_rx_()

void esphome::tormatic::Tormatic::drain_rx_ ( uint16_t n = 0 )

protected

Definition at line 341 of file tormatic_cover.cpp.

◆ dump_config()

void esphome::tormatic::Tormatic::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file tormatic_cover.cpp.

◆ get_setup_priority()

float esphome::tormatic::Tormatic::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 19 of file tormatic_cover.h.

◆ get_traits()

cover::CoverTraits esphome::tormatic::Tormatic::get_traits ( )

overridevirtual

Implements esphome::cover::Cover.

Definition at line 25 of file tormatic_cover.cpp.

◆ handle_gate_status_()

void esphome::tormatic::Tormatic::handle_gate_status_ ( GateStatus s )

protected

Definition at line 132 of file tormatic_cover.cpp.

◆ loop()

void esphome::tormatic::Tormatic::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 48 of file tormatic_cover.cpp.

◆ publish_state()

void esphome::tormatic::Tormatic::publish_state	(	bool	save = `true`,
		uint32_t	ratelimit = `0`
	)

Definition at line 76 of file tormatic_cover.cpp.

◆ read_data_()

template<typename T >

optional< T > esphome::tormatic::Tormatic::read_data_ ( )

protected

Definition at line 325 of file tormatic_cover.cpp.

◆ read_gate_status_()

optional< GateStatus > esphome::tormatic::Tormatic::read_gate_status_ ( )

protected

Definition at line 251 of file tormatic_cover.cpp.

◆ recalibrate_duration_()

void esphome::tormatic::Tormatic::recalibrate_duration_ ( GateStatus s )

protected

Definition at line 88 of file tormatic_cover.cpp.

◆ recompute_position_()

void esphome::tormatic::Tormatic::recompute_position_ ( )

protected

Definition at line 168 of file tormatic_cover.cpp.

◆ request_gate_status_()

void esphome::tormatic::Tormatic::request_gate_status_ ( )

protected

Definition at line 302 of file tormatic_cover.cpp.

◆ send_gate_command_()

void esphome::tormatic::Tormatic::send_gate_command_ ( GateStatus s )

protected

Definition at line 309 of file tormatic_cover.cpp.

◆ send_message_()

template<typename T >

void esphome::tormatic::Tormatic::send_message_	(	MessageType	t,
		T	r
	)

protected

Definition at line 315 of file tormatic_cover.cpp.

◆ set_close_duration()

void esphome::tormatic::Tormatic::set_close_duration ( uint32_t duration )

inline

Definition at line 22 of file tormatic_cover.h.

◆ set_open_duration()

void esphome::tormatic::Tormatic::set_open_duration ( uint32_t duration )

inline

Definition at line 21 of file tormatic_cover.h.

◆ setup()

void esphome::tormatic::Tormatic::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 14 of file tormatic_cover.cpp.

◆ stop_at_target_()

void esphome::tormatic::Tormatic::stop_at_target_ ( )

protected

Definition at line 229 of file tormatic_cover.cpp.

◆ update()

void esphome::tormatic::Tormatic::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 46 of file tormatic_cover.cpp.

Field Documentation

◆ close_duration_

uint32_t esphome::tormatic::Tormatic::close_duration_ {0}

protected

Definition at line 51 of file tormatic_cover.h.

◆ current_status_

GateStatus esphome::tormatic::Tormatic::current_status_ {PAUSED}

protected

Definition at line 48 of file tormatic_cover.h.

◆ direction_start_time_

uint32_t esphome::tormatic::Tormatic::direction_start_time_ {0}

protected

Definition at line 54 of file tormatic_cover.h.

◆ last_publish_time_

uint32_t esphome::tormatic::Tormatic::last_publish_time_ {0}

protected

Definition at line 52 of file tormatic_cover.h.

◆ last_recompute_time_

uint32_t esphome::tormatic::Tormatic::last_recompute_time_ {0}

protected

Definition at line 53 of file tormatic_cover.h.

◆ next_command_

GateStatus esphome::tormatic::Tormatic::next_command_ {OPENED}

protected

Definition at line 55 of file tormatic_cover.h.

◆ open_duration_

uint32_t esphome::tormatic::Tormatic::open_duration_ {0}

protected

Definition at line 50 of file tormatic_cover.h.

◆ seq_tx_

uint32_t esphome::tormatic::Tormatic::seq_tx_ {0}

protected

Definition at line 46 of file tormatic_cover.h.

◆ target_position_

optional<float> esphome::tormatic::Tormatic::target_position_ {}

protected

Definition at line 56 of file tormatic_cover.h.

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

/opt/build/esphome/esphome/components/tormatic/tormatic_cover.h
/opt/build/esphome/esphome/components/tormatic/tormatic_cover.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ control()

◆ control_position_()

◆ drain_rx_()

◆ dump_config()

◆ get_setup_priority()

◆ get_traits()

◆ handle_gate_status_()

◆ loop()

◆ publish_state()

◆ read_data_()

◆ read_gate_status_()

◆ recalibrate_duration_()

◆ recompute_position_()

◆ request_gate_status_()

◆ send_gate_command_()

◆ send_message_()

◆ set_close_duration()

◆ set_open_duration()

◆ setup()

◆ stop_at_target_()

◆ update()

Field Documentation

◆ close_duration_

◆ current_status_

◆ direction_start_time_

◆ last_publish_time_

◆ last_recompute_time_

◆ next_command_

◆ open_duration_

◆ seq_tx_

◆ target_position_