andry/EMS-ESP32
1
0
Fork 0
mirror of https://github.com/emsesp/EMS-ESP32.git synced 2025-12-07 00:09:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

MQTT Command Topic with slashes #2571

Browse Source
This commit is contained in:
proddy
2025-06-01 12:40:42 +02:00
parent d04c882590
commit 4b39ab76ab
2 changed files with 27 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
src/core/mqtt.cpp
View File

@@ -26,7 +26,7 @@ MqttClient * Mqtt::mqttClient_;
// static parameters we make global // static parameters we make global
std::string Mqtt::mqtt_base_; std::string Mqtt::mqtt_base_;
std::string Mqtt::mqtt_basename_; std::string Mqtt::mqtt_basename_; // base name for MQTT topics with / replaced with _. Used for uniq_id in HA
uint8_t Mqtt::mqtt_qos_; uint8_t Mqtt::mqtt_qos_;
bool Mqtt::mqtt_retain_; bool Mqtt::mqtt_retain_;
uint32_t Mqtt::publish_time_boiler_; uint32_t Mqtt::publish_time_boiler_;
@@ -359,10 +359,8 @@ void Mqtt::load_settings() {
publish_time_heartbeat_ = mqttSettings.publish_time_heartbeat * 1000; publish_time_heartbeat_ = mqttSettings.publish_time_heartbeat * 1000;
}); });
// create basename from the mqtt base // create unique ID from the mqtt base replacing all / with underscores, in case it's a path
// and replacing all / with underscores, in case it's a path basename(mqtt_base_);
mqtt_basename_ = mqtt_base_;
std::replace(mqtt_basename_.begin(), mqtt_basename_.end(), '/', '_');
} }
// start mqtt // start mqtt
@@ -494,7 +492,7 @@ void Mqtt::on_connect() {
load_settings(); // reload MQTT settings - in case they have changes load_settings(); // reload MQTT settings - in case they have changes
if (ha_enabled_) { if (ha_enabled_) {
queue_unsubscribe_message(discovery_prefix_ + "/+/" + mqtt_basename_ + "/#"); queue_unsubscribe_message(discovery_prefix_ + "/+/" + Mqtt::basename() + "/#");
EMSESP::reset_mqtt_ha(); // re-create all HA devices if there are any EMSESP::reset_mqtt_ha(); // re-create all HA devices if there are any
ha_status(); // create the EMS-ESP device in HA, which is MQTT retained ha_status(); // create the EMS-ESP device in HA, which is MQTT retained
ha_climate_reset(true); ha_climate_reset(true);
@@ -504,7 +502,7 @@ void Mqtt::on_connect() {
// If HA is enabled the subscriptions are removed. // If HA is enabled the subscriptions are removed.
// As described in the doc (https://docs.emsesp.org/Troubleshooting?id=home-assistant): // As described in the doc (https://docs.emsesp.org/Troubleshooting?id=home-assistant):
// disable HA, wait 5 minutes (to allow the broker to send all), than reenable HA again. // disable HA, wait 5 minutes (to allow the broker to send all), than reenable HA again.
queue_subscribe_message(discovery_prefix_ + "/+/" + mqtt_basename_ + "/#"); queue_subscribe_message(discovery_prefix_ + "/+/" + Mqtt::basename() + "/#");
} }
// send initial MQTT messages for some of our services // send initial MQTT messages for some of our services
@@ -556,7 +554,7 @@ void Mqtt::ha_status() {
ids.add(Mqtt::basename()); ids.add(Mqtt::basename());
char topic[MQTT_TOPIC_MAX_SIZE]; char topic[MQTT_TOPIC_MAX_SIZE];
snprintf(topic, sizeof(topic), "binary_sensor/%s/system_status/config", mqtt_basename_.c_str()); snprintf(topic, sizeof(topic), "binary_sensor/%s/system_status/config", Mqtt::basename().c_str());
Mqtt::queue_ha(topic, doc.as<JsonObject>()); // publish the config payload with retain flag Mqtt::queue_ha(topic, doc.as<JsonObject>()); // publish the config payload with retain flag
// create the HA sensors - must match the MQTT payload keys in the heartbeat topic // create the HA sensors - must match the MQTT payload keys in the heartbeat topic
@@ -733,7 +731,7 @@ bool Mqtt::queue_remove_topic(const char * topic) {
} }
} }
// queue a Home Assistant config topic and payload, with retain flag off. // queue a Home Assistant config topic and payload, with retain flag set
bool Mqtt::queue_ha(const char * topic, const JsonObjectConst payload) { bool Mqtt::queue_ha(const char * topic, const JsonObjectConst payload) {
if (!enabled()) { if (!enabled()) {
return false; return false;
@@ -861,7 +859,7 @@ bool Mqtt::publish_ha_sensor_config(uint8_t type, // EMSdev
// create the uniq_d based on the entity format // create the uniq_d based on the entity format
if (Mqtt::entity_format() == entityFormat::MULTI_SHORT) { if (Mqtt::entity_format() == entityFormat::MULTI_SHORT) {
// base name + shortname // base name + shortname
snprintf(uniq_id, sizeof(uniq_id), "%s_%s_%s", mqtt_basename_.c_str(), device_name, entity_with_tag); snprintf(uniq_id, sizeof(uniq_id), "%s_%s_%s", Mqtt::basename().c_str(), device_name, entity_with_tag);
} else if (Mqtt::entity_format() == entityFormat::SINGLE_SHORT) { } else if (Mqtt::entity_format() == entityFormat::SINGLE_SHORT) {
// shortname only (=default) // shortname only (=default)
snprintf(uniq_id, sizeof(uniq_id), "%s_%s", device_name, entity_with_tag); snprintf(uniq_id, sizeof(uniq_id), "%s_%s", device_name, entity_with_tag);
@@ -895,15 +893,15 @@ bool Mqtt::publish_ha_sensor_config(uint8_t type, // EMSdev
snprintf(entity_with_tag, sizeof(entity_with_tag), "%sww", dhw_old[i]); snprintf(entity_with_tag, sizeof(entity_with_tag), "%sww", dhw_old[i]);
} }
} }
snprintf(uniq_id, sizeof(uniq_id), "%s_%s_%s", mqtt_basename_.c_str(), device_name, entity_with_tag); snprintf(uniq_id, sizeof(uniq_id), "%s_%s_%s", Mqtt::basename().c_str(), device_name, entity_with_tag);
} else if (has_tag && device_type == EMSdevice::DeviceType::WATER && tag >= DeviceValue::DeviceValueTAG::TAG_DHW3) { } else if (has_tag && device_type == EMSdevice::DeviceType::WATER && tag >= DeviceValue::DeviceValueTAG::TAG_DHW3) {
snprintf(entity_with_tag, sizeof(entity_with_tag), "wwc%d_%s", tag - DeviceValue::DeviceValueTAG::TAG_DHW1 + 1, entity); snprintf(entity_with_tag, sizeof(entity_with_tag), "wwc%d_%s", tag - DeviceValue::DeviceValueTAG::TAG_DHW1 + 1, entity);
snprintf(uniq_id, sizeof(uniq_id), "%s_solar_%s", mqtt_basename_.c_str(), entity_with_tag); snprintf(uniq_id, sizeof(uniq_id), "%s_solar_%s", Mqtt::basename().c_str(), entity_with_tag);
} else if (has_tag && device_type == EMSdevice::DeviceType::WATER && tag >= DeviceValue::DeviceValueTAG::TAG_DHW1) { } else if (has_tag && device_type == EMSdevice::DeviceType::WATER && tag >= DeviceValue::DeviceValueTAG::TAG_DHW1) {
snprintf(entity_with_tag, sizeof(entity_with_tag), "wwc%d_%s", tag - DeviceValue::DeviceValueTAG::TAG_DHW1 + 1, entity); snprintf(entity_with_tag, sizeof(entity_with_tag), "wwc%d_%s", tag - DeviceValue::DeviceValueTAG::TAG_DHW1 + 1, entity);
snprintf(uniq_id, sizeof(uniq_id), "%s_mixer_%s", mqtt_basename_.c_str(), entity_with_tag); snprintf(uniq_id, sizeof(uniq_id), "%s_mixer_%s", Mqtt::basename().c_str(), entity_with_tag);
} else { } else {
snprintf(uniq_id, sizeof(uniq_id), "%s_%s_%s", mqtt_basename_.c_str(), device_name, entity_with_tag); snprintf(uniq_id, sizeof(uniq_id), "%s_%s_%s", Mqtt::basename().c_str(), device_name, entity_with_tag);
} }
} else { } else {
// entity_format is 0, the old v3.4 style // entity_format is 0, the old v3.4 style
@@ -936,7 +934,7 @@ bool Mqtt::publish_ha_sensor_config(uint8_t type, // EMSdev
// build a config topic that will be prefix onto a HA type (e.g. number, switch) // build a config topic that will be prefix onto a HA type (e.g. number, switch)
char config_topic[70]; char config_topic[70];
snprintf(config_topic, sizeof(config_topic), "%s/%s_%s/config", mqtt_basename_.c_str(), device_name, entity_with_tag); snprintf(config_topic, sizeof(config_topic), "%s/%s_%s/config", Mqtt::base().c_str(), device_name, entity_with_tag);
// create the topic // create the topic
// depending on the type and whether the device entity is writable (i.e. a command) // depending on the type and whether the device entity is writable (i.e. a command)
@@ -1012,9 +1010,9 @@ bool Mqtt::publish_ha_sensor_config(uint8_t type, // EMSdev
char command_topic[MQTT_TOPIC_MAX_SIZE]; char command_topic[MQTT_TOPIC_MAX_SIZE];
// add command topic // add command topic
if (tag >= DeviceValueTAG::TAG_HC1) { if (tag >= DeviceValueTAG::TAG_HC1) {
snprintf(command_topic, sizeof(command_topic), "%s/%s/%s/%s", mqtt_basename_.c_str(), device_name, EMSdevice::tag_to_mqtt(tag), entity); snprintf(command_topic, sizeof(command_topic), "%s/%s/%s/%s", Mqtt::base().c_str(), device_name, EMSdevice::tag_to_mqtt(tag), entity);
} else { } else {
snprintf(command_topic, sizeof(command_topic), "%s/%s/%s", mqtt_basename_.c_str(), device_name, entity); snprintf(command_topic, sizeof(command_topic), "%s/%s/%s", Mqtt::base().c_str(), device_name, entity);
} }
doc["cmd_t"] = command_topic; doc["cmd_t"] = command_topic;
@@ -1344,6 +1342,10 @@ bool Mqtt::publish_ha_climate_config(const int8_t tag, const bool has_roomtemp,
doc["temp_step"] = "0.5"; doc["temp_step"] = "0.5";
doc["mode_cmd_t"] = mode_cmd_s; doc["mode_cmd_t"] = mode_cmd_s;
// add hvac_action - https://github.com/emsesp/EMS-ESP32/discussions/2562
doc["action_topic"] = "~/boiler_data";
doc["action_template"] = "{% if value_json.heatingactive=='on'%}heating{%else%}idle{%endif%}";
// the HA climate component only responds to auto, heat and off // the HA climate component only responds to auto, heat and off
JsonArray modes = doc["modes"].to<JsonArray>(); JsonArray modes = doc["modes"].to<JsonArray>();

9
src/core/mqtt.h
View File

@@ -144,6 +144,13 @@ class Mqtt {
return mqtt_basename_; return mqtt_basename_;
} }
// create basename from the mqtt base
// and replacing all / with underscores, in case it's a path
static void basename(const std::string & base) {
mqtt_basename_ = base;
std::replace(mqtt_basename_.begin(), mqtt_basename_.end(), '/', '_');
}
// returns the discovery MQTT topic prefix and adds a / // returns the discovery MQTT topic prefix and adds a /
static std::string discovery_prefix() { static std::string discovery_prefix() {
if (discovery_prefix_.empty()) { if (discovery_prefix_.empty()) {
@@ -299,7 +306,7 @@ class Mqtt {
// settings, copied over // settings, copied over
static std::string mqtt_base_; static std::string mqtt_base_;
static std::string mqtt_basename_; static std::string mqtt_basename_; // base name for MQTT topics with / replaced with _
static uint8_t mqtt_qos_; static uint8_t mqtt_qos_;
static bool mqtt_retain_; static bool mqtt_retain_;
static uint32_t publish_time_; static uint32_t publish_time_;