#include <mqtt_update.h>

Inheritance diagram for esphome::mqtt::MQTTUpdateComponent:

Public Member Functions
	MQTTUpdateComponent (update::UpdateEntity *update)

void	setup () override

void	dump_config () override

void	send_discovery (JsonObject root, mqtt::SendDiscoveryConfig &config) override

bool	send_initial_state () override

bool	publish_state ()

Public Member Functions inherited from esphome::mqtt::MQTTComponent
	MQTTComponent ()
	Constructs a MQTTComponent. More...

void	call_setup () override
	Override setup_ so that we can call send_discovery() when needed. More...

void	call_loop () override

void	call_dump_config () override

virtual bool	is_internal ()

void	set_qos (uint8_t qos)
	Set QOS for state messages. More...

uint8_t	get_qos () const

void	set_retain (bool retain)
	Set whether state message should be retained. More...

bool	get_retain () const

void	disable_discovery ()
	Disable discovery. Sets friendly name to "". More...

bool	is_discovery_enabled () const

void	set_custom_state_topic (const char *custom_state_topic)
	Set a custom state topic. Set to "" for default behavior. More...

void	set_custom_command_topic (const char *custom_command_topic)
	Set a custom command topic. Set to "" for default behavior. More...

void	set_command_retain (bool command_retain)
	Set whether command message should be retained. More...

float	get_setup_priority () const override
	MQTT_COMPONENT setup priority. More...

void	set_availability (std::string topic, std::string payload_available, std::string payload_not_available)
	Set the Home Assistant availability data. More...

void	disable_availability ()

void	schedule_resend_state ()
	Internal method for the MQTT client base to schedule a resend of the state on reconnect. More...

bool	publish (const std::string &topic, const std::string &payload)
	Send a MQTT message. More...

bool	publish_json (const std::string &topic, const json::json_build_t &f)
	Construct and send a JSON MQTT message. More...

void	subscribe (const std::string &topic, mqtt_callback_t callback, uint8_t qos=0)
	Subscribe to a MQTT topic. More...

void	subscribe_json (const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos=0)
	Subscribe to a MQTT topic and automatically parse JSON payload. 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 Member Functions
std::string	component_type () const override
	"update" component type. More...

const EntityBase *	get_entity () const override

Protected Member Functions inherited from esphome::mqtt::MQTTComponent
std::string	get_discovery_topic_ (const MQTTDiscoveryInfo &discovery_info) const
	Helper method to get the discovery topic for this component. More...

std::string	get_default_topic_for_ (const std::string &suffix) const
	Get this components state/command/... More...

virtual std::string	unique_id ()
	A unique ID for this MQTT component, empty for no unique id. More...

virtual std::string	friendly_name () const
	Get the friendly name of this MQTT component. More...

virtual std::string	get_icon () const
	Get the icon field of this component. More...

virtual bool	is_disabled_by_default () const
	Get whether the underlying Entity is disabled by default. More...

std::string	get_state_topic_ () const
	Get the MQTT topic that new states will be shared to. More...

std::string	get_command_topic_ () const
	Get the MQTT topic for listening to commands. More...

bool	is_connected_ () const

bool	send_discovery_ ()
	Internal method to start sending discovery info, this will call send_discovery(). More...

std::string	get_default_object_id_ () const
	Generate the Home Assistant MQTT discovery object id by automatically transforming the friendly name. More...

Protected Member Functions inherited from esphome::Component
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
update::UpdateEntity *	update_

Protected Attributes inherited from esphome::mqtt::MQTTComponent
StringRef	custom_state_topic_ {}

StringRef	custom_command_topic_ {}

std::unique_ptr< Availability >	availability_

bool	has_custom_state_topic_ {false}

bool	has_custom_command_topic_ {false}

bool	command_retain_ {false}

bool	retain_ {true}

uint8_t	qos_ {0}

bool	discovery_enabled_ {true}

bool	resend_state_ {false}

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 14 of file mqtt_update.h.

Constructor & Destructor Documentation

◆ MQTTUpdateComponent()

esphome::mqtt::MQTTUpdateComponent::MQTTUpdateComponent ( update::UpdateEntity * update )

explicit

Definition at line 16 of file mqtt_update.cpp.

Member Function Documentation

◆ component_type()

std::string esphome::mqtt::MQTTUpdateComponent::component_type ( ) const

overrideprotectedvirtual

"update" component type.

Implements esphome::mqtt::MQTTComponent.

Definition at line 55 of file mqtt_update.cpp.

◆ dump_config()

void esphome::mqtt::MQTTUpdateComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 50 of file mqtt_update.cpp.

◆ get_entity()

const EntityBase * esphome::mqtt::MQTTUpdateComponent::get_entity ( ) const

overrideprotectedvirtual

Implements esphome::mqtt::MQTTComponent.

Definition at line 56 of file mqtt_update.cpp.

◆ publish_state()

bool esphome::mqtt::MQTTUpdateComponent::publish_state ( )

Definition at line 31 of file mqtt_update.cpp.

◆ send_discovery()

void esphome::mqtt::MQTTUpdateComponent::send_discovery	(	JsonObject	root,
		mqtt::SendDiscoveryConfig &	config
	)

overridevirtual

Implements esphome::mqtt::MQTTComponent.

Definition at line 43 of file mqtt_update.cpp.

◆ send_initial_state()

bool esphome::mqtt::MQTTUpdateComponent::send_initial_state ( )

overridevirtual

Implements esphome::mqtt::MQTTComponent.

Definition at line 48 of file mqtt_update.cpp.

◆ setup()

void esphome::mqtt::MQTTUpdateComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file mqtt_update.cpp.

Field Documentation

◆ update_

update::UpdateEntity* esphome::mqtt::MQTTUpdateComponent::update_

protected

Definition at line 34 of file mqtt_update.h.

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

/opt/build/esphome/esphome/components/mqtt/mqtt_update.h
/opt/build/esphome/esphome/components/mqtt/mqtt_update.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MQTTUpdateComponent()

Member Function Documentation

◆ component_type()

◆ dump_config()

◆ get_entity()

◆ publish_state()

◆ send_discovery()

◆ send_initial_state()

◆ setup()

Field Documentation

◆ update_