#include <automation.h>

Inheritance diagram for esphome::binary_sensor::MultiClickTrigger:

Public Member Functions
	MultiClickTrigger (BinarySensor *parent, std::vector< MultiClickTriggerEvent > timing)

void	setup () override

float	get_setup_priority () const override

void	set_invalid_cooldown (uint32_t invalid_cooldown)

void	cancel ()

Public Member Functions inherited from esphome::Trigger<>
void	trigger (Ts... x)
	Inform the parent automation that the event has triggered. More...

void	set_automation_parent (Automation< Ts... > *automation_parent)

void	stop_action ()
	Stop any action connected to this trigger. More...

bool	is_action_running ()
	Returns true if any action connected to this trigger is running. More...

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly. More...

virtual void	dump_config ()

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	on_state_ (bool state)

void	schedule_cooldown_ ()

void	schedule_is_valid_ (uint32_t min_length)

void	schedule_is_not_valid_ (uint32_t max_length)

void	trigger_ ()

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
BinarySensor *	parent_

std::vector< MultiClickTriggerEvent >	timing_

uint32_t	invalid_cooldown_ {1000}

optional< size_t >	at_index_ {}

bool	last_state_ {false}

bool	is_in_cooldown_ {false}

bool	is_valid_ {false}

Protected Attributes inherited from esphome::Trigger<>
Automation< Ts... > *	automation_parent_

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}

Detailed Description

Definition at line 93 of file automation.h.

Constructor & Destructor Documentation

◆ MultiClickTrigger()

esphome::binary_sensor::MultiClickTrigger::MultiClickTrigger	(	BinarySensor *	parent,
		std::vector< MultiClickTriggerEvent >	timing
	)

inlineexplicit

Definition at line 95 of file automation.h.

Member Function Documentation

◆ cancel()

void esphome::binary_sensor::MultiClickTrigger::cancel ( )

Definition at line 101 of file automation.cpp.

◆ get_setup_priority()

float esphome::binary_sensor::MultiClickTrigger::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 104 of file automation.h.

◆ on_state_()

void esphome::binary_sensor::MultiClickTrigger::on_state_ ( bool state )

protected

Definition at line 9 of file automation.cpp.

◆ schedule_cooldown_()

void esphome::binary_sensor::MultiClickTrigger::schedule_cooldown_ ( )

protected

Definition at line 70 of file automation.cpp.

◆ schedule_is_not_valid_()

void esphome::binary_sensor::MultiClickTrigger::schedule_is_not_valid_ ( uint32_t max_length )

protected

Definition at line 94 of file automation.cpp.

◆ schedule_is_valid_()

void esphome::binary_sensor::MultiClickTrigger::schedule_is_valid_ ( uint32_t min_length )

protected

Definition at line 83 of file automation.cpp.

◆ set_invalid_cooldown()

void esphome::binary_sensor::MultiClickTrigger::set_invalid_cooldown ( uint32_t invalid_cooldown )

inline

Definition at line 106 of file automation.h.

◆ setup()

void esphome::binary_sensor::MultiClickTrigger::setup ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 98 of file automation.h.

◆ trigger_()

void esphome::binary_sensor::MultiClickTrigger::trigger_ ( )

protected

Definition at line 106 of file automation.cpp.

Field Documentation

◆ at_index_

optional<size_t> esphome::binary_sensor::MultiClickTrigger::at_index_ {}

protected

Definition at line 120 of file automation.h.

◆ invalid_cooldown_

uint32_t esphome::binary_sensor::MultiClickTrigger::invalid_cooldown_ {1000}

protected

Definition at line 119 of file automation.h.

◆ is_in_cooldown_

bool esphome::binary_sensor::MultiClickTrigger::is_in_cooldown_ {false}

protected

Definition at line 122 of file automation.h.

◆ is_valid_

bool esphome::binary_sensor::MultiClickTrigger::is_valid_ {false}

protected

Definition at line 123 of file automation.h.

◆ last_state_

bool esphome::binary_sensor::MultiClickTrigger::last_state_ {false}

protected

Definition at line 121 of file automation.h.

◆ parent_

BinarySensor* esphome::binary_sensor::MultiClickTrigger::parent_

protected

Definition at line 117 of file automation.h.

◆ timing_

std::vector<MultiClickTriggerEvent> esphome::binary_sensor::MultiClickTrigger::timing_

protected

Definition at line 118 of file automation.h.

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

/opt/build/esphome/esphome/components/binary_sensor/automation.h
/opt/build/esphome/esphome/components/binary_sensor/automation.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MultiClickTrigger()

Member Function Documentation

◆ cancel()

◆ get_setup_priority()

◆ on_state_()

◆ schedule_cooldown_()

◆ schedule_is_not_valid_()

◆ schedule_is_valid_()

◆ set_invalid_cooldown()

◆ setup()

◆ trigger_()

Field Documentation

◆ at_index_

◆ invalid_cooldown_

◆ is_in_cooldown_

◆ is_valid_

◆ last_state_

◆ parent_

◆ timing_