#include <mqtt_client.h>

Inheritance diagram for esphome::mqtt::MQTTMessageTrigger:

Public Member Functions
	MQTTMessageTrigger (std::string topic)

void	set_qos (uint8_t qos)

void	set_payload (const std::string &payload)

void	setup () override

void	dump_config () override

float	get_setup_priority () const override

Public Member Functions inherited from esphome::Trigger< std::string >
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...

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 Attributes
std::string	topic_

uint8_t	qos_ {0}

optional< std::string >	payload_

Protected Attributes inherited from esphome::Trigger< std::string >
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}

Additional Inherited Members
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...

Detailed Description

Definition at line 341 of file mqtt_client.h.

Constructor & Destructor Documentation

◆ MQTTMessageTrigger()

esphome::mqtt::MQTTMessageTrigger::MQTTMessageTrigger ( std::string topic )

explicit

Member Function Documentation

◆ dump_config()

void esphome::mqtt::MQTTMessageTrigger::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

◆ get_setup_priority()

float esphome::mqtt::MQTTMessageTrigger::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

◆ set_payload()

void esphome::mqtt::MQTTMessageTrigger::set_payload ( const std::string & payload )

◆ set_qos()

void esphome::mqtt::MQTTMessageTrigger::set_qos ( uint8_t qos )

◆ setup()

void esphome::mqtt::MQTTMessageTrigger::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Field Documentation

◆ payload_

optional<std::string> esphome::mqtt::MQTTMessageTrigger::payload_

protected

Definition at line 354 of file mqtt_client.h.

◆ qos_

uint8_t esphome::mqtt::MQTTMessageTrigger::qos_ {0}

protected

Definition at line 353 of file mqtt_client.h.

◆ topic_

std::string esphome::mqtt::MQTTMessageTrigger::topic_

protected

Definition at line 352 of file mqtt_client.h.

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

/opt/build/esphome/esphome/components/mqtt/mqtt_client.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MQTTMessageTrigger()

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ set_payload()

◆ set_qos()

◆ setup()

Field Documentation

◆ payload_

◆ qos_

◆ topic_