ESPHome
2025.4.0
|
#include <mqtt_climate.h>
Public Member Functions | |
MQTTClimateComponent (climate::Climate *device) | |
void | send_discovery (JsonObject root, mqtt::SendDiscoveryConfig &config) override |
bool | send_initial_state () override |
std::string | component_type () const override |
void | setup () override |
MQTT_COMPONENT_CUSTOM_TOPIC (current_temperature, state) MQTT_COMPONENT_CUSTOM_TOPIC(current_humidity | |
state | MQTT_COMPONENT_CUSTOM_TOPIC (mode, state) MQTT_COMPONENT_CUSTOM_TOPIC(mode |
state command | MQTT_COMPONENT_CUSTOM_TOPIC (target_temperature, state) MQTT_COMPONENT_CUSTOM_TOPIC(target_temperature |
state command command | MQTT_COMPONENT_CUSTOM_TOPIC (target_temperature_low, state) MQTT_COMPONENT_CUSTOM_TOPIC(target_temperature_low |
state command command command | MQTT_COMPONENT_CUSTOM_TOPIC (target_temperature_high, state) MQTT_COMPONENT_CUSTOM_TOPIC(target_temperature_high |
state command command command command | MQTT_COMPONENT_CUSTOM_TOPIC (target_humidity, state) MQTT_COMPONENT_CUSTOM_TOPIC(target_humidity |
state command command command command command | MQTT_COMPONENT_CUSTOM_TOPIC (away, state) MQTT_COMPONENT_CUSTOM_TOPIC(away |
state command command command command command command | MQTT_COMPONENT_CUSTOM_TOPIC (action, state) MQTT_COMPONENT_CUSTOM_TOPIC(fan_mode |
state command command command command command command state | MQTT_COMPONENT_CUSTOM_TOPIC (fan_mode, command) MQTT_COMPONENT_CUSTOM_TOPIC(swing_mode |
state command command command command command command state state | MQTT_COMPONENT_CUSTOM_TOPIC (swing_mode, command) MQTT_COMPONENT_CUSTOM_TOPIC(preset |
state command command command command command command state state state MQTT_COMPONENT_CUSTOM_TOPIC(preset, command) protected bool | publish_state_ () |
![]() | |
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_subscribe_qos (uint8_t qos) |
Set the QOS for subscribe messages (used in discovery). More... | |
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... | |
![]() | |
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... | |
void | mark_failed (const char *message) |
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... | |
Data Fields | |
climate::Climate * | device_ |
Additional Inherited Members | |
![]() | |
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 const EntityBase * | get_entity () const =0 |
Gets the Entity served by this MQTT component. 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... | |
![]() | |
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... | |
![]() | |
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} |
uint8_t | subscribe_qos_ {0} |
bool | discovery_enabled_ {true} |
bool | resend_state_ {false} |
![]() | |
uint32_t | component_state_ {0x0000} |
State of this component. More... | |
float | setup_priority_override_ {NAN} |
const char * | component_source_ {nullptr} |
std::string | error_message_ {} |
Definition at line 14 of file mqtt_climate.h.
esphome::mqtt::MQTTClimateComponent::MQTTClimateComponent | ( | climate::Climate * | device | ) |
Definition at line 252 of file mqtt_climate.cpp.
|
overridevirtual |
Implements esphome::mqtt::MQTTComponent.
Definition at line 254 of file mqtt_climate.cpp.
esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | current_temperature | , |
state | |||
) |
state command esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | target_temperature | , |
state | |||
) |
state command command esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | target_temperature_low | , |
state | |||
) |
state command command command esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | target_temperature_high | , |
state | |||
) |
state command command command command esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | target_humidity | , |
state | |||
) |
state command command command command command esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | away | , |
state | |||
) |
state command command command command command command esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | action | , |
state | |||
) |
state command command command command command command state esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | fan_mode | , |
command | |||
) |
state command command command command command command state state esphome::mqtt::MQTTClimateComponent::MQTT_COMPONENT_CUSTOM_TOPIC | ( | swing_mode | , |
command | |||
) |
bool esphome::mqtt::MQTTClimateComponent::publish_state_ | ( | ) |
Definition at line 257 of file mqtt_climate.cpp.
|
overridevirtual |
Implements esphome::mqtt::MQTTComponent.
Definition at line 16 of file mqtt_climate.cpp.
|
overridevirtual |
Implements esphome::mqtt::MQTTComponent.
Definition at line 253 of file mqtt_climate.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 167 of file mqtt_climate.cpp.
climate::Climate* esphome::mqtt::MQTTClimateComponent::device_ |
Definition at line 49 of file mqtt_climate.h.