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

ha config to basename, analog/dallas allow single/nested with ha

Browse Source
This commit is contained in:
MichaelDvP
2022-09-23 21:54:13 +02:00
parent 081c11c503
commit f1bb183017
4 changed files with 93 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/analogsensor.cpp
View File

@@ -26,9 +26,11 @@ uuid::log::Logger AnalogSensor::logger_{F_(analogsensor), uuid::log::Facility::D
void AnalogSensor::start() { void AnalogSensor::start() {
reload(); // fetch the list of sensors from our customization service reload(); // fetch the list of sensors from our customization service
if (analog_enabled_) { if (!analog_enabled_) {
analogSetAttenuation(ADC_2_5db); // for all channels 1.5V return;
} }
analogSetAttenuation(ADC_2_5db); // for all channels 1.5V
LOG_INFO(F("Starting Analog sensor service")); LOG_INFO(F("Starting Analog sensor service"));
@@ -354,7 +356,7 @@ void AnalogSensor::remove_ha_topic(const uint8_t gpio) const {
LOG_DEBUG(F("Removing HA config for analog sensor GPIO %d"), gpio); LOG_DEBUG(F("Removing HA config for analog sensor GPIO %d"), gpio);
#endif #endif
char topic[Mqtt::MQTT_TOPIC_MAX_SIZE]; char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
snprintf(topic, sizeof(topic), "sensor/%s/analogsensor_%d/config", Mqtt::base().c_str(), gpio); snprintf(topic, sizeof(topic), "sensor/%s/analogsensor_%d/config", Mqtt::basename().c_str(), gpio);
Mqtt::publish_ha(topic); Mqtt::publish_ha(topic);
} }
@@ -376,8 +378,7 @@ void AnalogSensor::publish_values(const bool force) {
for (auto & sensor : sensors_) { for (auto & sensor : sensors_) {
if (sensor.type() != AnalogType::NOTUSED) { if (sensor.type() != AnalogType::NOTUSED) {
if (Mqtt::is_nested() || Mqtt::ha_enabled()) { if (Mqtt::is_nested()) {
// nested
char s[10]; char s[10];
JsonObject dataSensor = doc.createNestedObject(Helpers::smallitoa(s, sensor.gpio())); JsonObject dataSensor = doc.createNestedObject(Helpers::smallitoa(s, sensor.gpio()));
dataSensor["name"] = sensor.name(); dataSensor["name"] = sensor.name();
@@ -395,6 +396,10 @@ void AnalogSensor::publish_values(const bool force) {
dataSensor["value"] = (uint8_t)sensor.value(); // convert to char for 1 or 0 dataSensor["value"] = (uint8_t)sensor.value(); // convert to char for 1 or 0
break; break;
} }
} else {
// not nested
doc[sensor.name()] = sensor.value();
}
// create HA config // create HA config
if (Mqtt::ha_enabled() && (!sensor.ha_registered || force)) { if (Mqtt::ha_enabled() && (!sensor.ha_registered || force)) {
@@ -407,10 +412,14 @@ void AnalogSensor::publish_values(const bool force) {
config["stat_t"] = stat_t; config["stat_t"] = stat_t;
char str[50]; char str[50];
if (Mqtt::is_nested()) {
snprintf(str, sizeof(str), "{{value_json['%d'].value}}", sensor.gpio()); snprintf(str, sizeof(str), "{{value_json['%d'].value}}", sensor.gpio());
} else {
snprintf(str, sizeof(str), "{{value_json['%s']}", sensor.name().c_str());
}
config["val_tpl"] = str; config["val_tpl"] = str;
snprintf(str, sizeof(str), "analog_sensor_%s", sensor.name().c_str()); snprintf(str, sizeof(str), "%s_analog_sensor_%s", Mqtt::basename().c_str(), sensor.name().c_str());
config["object_id"] = str; config["object_id"] = str;
snprintf(str, sizeof(str), "%s", sensor.name().c_str()); snprintf(str, sizeof(str), "%s", sensor.name().c_str());
@@ -428,18 +437,12 @@ void AnalogSensor::publish_values(const bool force) {
ids.add("ems-esp"); ids.add("ems-esp");
char topic[Mqtt::MQTT_TOPIC_MAX_SIZE]; char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
snprintf(topic, sizeof(topic), "sensor/%s/analogsensor_%d/config", Mqtt::base().c_str(), sensor.gpio()); snprintf(topic, sizeof(topic), "sensor/%s/analogsensor_%d/config", Mqtt::basename().c_str(), sensor.gpio());
Mqtt::publish_ha(topic, config.as<JsonObject>()); Mqtt::publish_ha(topic, config.as<JsonObject>());
sensor.ha_registered = true; sensor.ha_registered = true;
} }
} else {
// not nested
doc[sensor.name()] = sensor.value();
}
} }
} }

12
src/dallassensor.cpp
View File

@@ -447,7 +447,7 @@ void DallasSensor::remove_ha_topic(const std::string & id) {
std::string sensorid = id; std::string sensorid = id;
std::replace(sensorid.begin(), sensorid.end(), '-', '_'); std::replace(sensorid.begin(), sensorid.end(), '-', '_');
char topic[Mqtt::MQTT_TOPIC_MAX_SIZE]; char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
snprintf(topic, sizeof(topic), "sensor/%s/dallassensor_%s/config", Mqtt::base().c_str(), sensorid.c_str()); snprintf(topic, sizeof(topic), "sensor/%s/dallassensor_%s/config", Mqtt::basename().c_str(), sensorid.c_str());
Mqtt::publish_ha(topic); Mqtt::publish_ha(topic);
} }
@@ -469,7 +469,7 @@ void DallasSensor::publish_values(const bool force) {
for (auto & sensor : sensors_) { for (auto & sensor : sensors_) {
bool has_value = Helpers::hasValue(sensor.temperature_c); bool has_value = Helpers::hasValue(sensor.temperature_c);
if (Mqtt::is_nested() || Mqtt::ha_enabled()) { if (Mqtt::is_nested()) {
JsonObject dataSensor = doc.createNestedObject(sensor.id()); JsonObject dataSensor = doc.createNestedObject(sensor.id());
dataSensor["name"] = sensor.name(); dataSensor["name"] = sensor.name();
if (has_value) { if (has_value) {
@@ -495,10 +495,14 @@ void DallasSensor::publish_values(const bool force) {
config["unit_of_meas"] = EMSdevice::uom_to_string(DeviceValueUOM::DEGREES); config["unit_of_meas"] = EMSdevice::uom_to_string(DeviceValueUOM::DEGREES);
char str[50]; char str[50];
if (Mqtt::is_nested()) {
snprintf(str, sizeof(str), "{{value_json['%s'].temp}}", sensor.id().c_str()); snprintf(str, sizeof(str), "{{value_json['%s'].temp}}", sensor.id().c_str());
} else {
snprintf(str, sizeof(str), "{{value_json['%s']}}", sensor.name().c_str());
}
config["val_tpl"] = str; config["val_tpl"] = str;
snprintf(str, sizeof(str), "temperature_sensor_%s", sensor.name().c_str()); snprintf(str, sizeof(str), "%s_temperature_sensor_%s", Mqtt::basename().c_str(), sensor.name().c_str());
config["object_id"] = str; config["object_id"] = str;
snprintf(str, sizeof(str), "%s", sensor.name().c_str()); snprintf(str, sizeof(str), "%s", sensor.name().c_str());
@@ -516,7 +520,7 @@ void DallasSensor::publish_values(const bool force) {
std::string sensorid = sensor.id(); std::string sensorid = sensor.id();
std::replace(sensorid.begin(), sensorid.end(), '-', '_'); std::replace(sensorid.begin(), sensorid.end(), '-', '_');
snprintf(topic, sizeof(topic), "sensor/%s/dallassensor_%s/config", Mqtt::base().c_str(), sensorid.c_str()); snprintf(topic, sizeof(topic), "sensor/%s/dallassensor_%s/config", Mqtt::basename().c_str(), sensorid.c_str());
Mqtt::publish_ha(topic, config.as<JsonObject>()); Mqtt::publish_ha(topic, config.as<JsonObject>());

58
src/mqtt.cpp
View File

@@ -26,8 +26,8 @@ namespace emsesp {
AsyncMqttClient * Mqtt::mqttClient_; AsyncMqttClient * Mqtt::mqttClient_;
// static parameters we make global // static parameters we make global
std::string Mqtt::system_hostname_; // copy from System::hostname()
std::string Mqtt::mqtt_base_; std::string Mqtt::mqtt_base_;
std::string Mqtt::mqtt_basename_;
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_;
@@ -213,7 +213,7 @@ void Mqtt::show_mqtt(uuid::console::Shell & shell) {
// prefix base, only if it's not a discovery topic // prefix base, only if it's not a discovery topic
if (content->topic.compare(0, discovery_prefix().size(), discovery_prefix()) == 0) { if (content->topic.compare(0, discovery_prefix().size(), discovery_prefix()) == 0) {
snprintf(topic, sizeof(topic), "%s/%s", Mqtt::base().c_str(), content->topic.c_str()); snprintf(topic, sizeof(topic), "%s/%s", mqtt_base_.c_str(), content->topic.c_str());
} else { } else {
snprintf(topic, sizeof(topic), "%s", content->topic.c_str()); snprintf(topic, sizeof(topic), "%s", content->topic.c_str());
} }
@@ -422,8 +422,9 @@ void Mqtt::load_settings() {
publish_time_sensor_ = mqttSettings.publish_time_sensor * 1000; publish_time_sensor_ = mqttSettings.publish_time_sensor * 1000;
}); });
// get a local copy of the system hostname // create basename from base
system_hostname_ = EMSESP::system_.hostname(); mqtt_basename_ = mqtt_base_;
std::replace(mqtt_basename_.begin(), mqtt_basename_.end(), '/', '_');
} }
void Mqtt::start() { void Mqtt::start() {
@@ -580,13 +581,13 @@ void Mqtt::on_connect() {
publish(F_(info), doc.as<JsonObject>()); // topic called "info" publish(F_(info), doc.as<JsonObject>()); // topic called "info"
if (ha_enabled_) { if (ha_enabled_) {
LOG_INFO(F("start removing topics %s/+/%s/#"), discovery_prefix_.c_str(), system_hostname_.c_str()); LOG_INFO(F("start removing topics %s/+/%s/#"), discovery_prefix_.c_str(), mqtt_basename_.c_str());
queue_unsubscribe_message(discovery_prefix_ + "/climate/" + system_hostname_ + "/#"); queue_unsubscribe_message(discovery_prefix_ + "/climate/" + mqtt_basename_ + "/#");
queue_unsubscribe_message(discovery_prefix_ + "/sensor/" + system_hostname_ + "/#"); queue_unsubscribe_message(discovery_prefix_ + "/sensor/" + mqtt_basename_ + "/#");
queue_unsubscribe_message(discovery_prefix_ + "/binary_sensor/" + system_hostname_ + "/#"); queue_unsubscribe_message(discovery_prefix_ + "/binary_sensor/" + mqtt_basename_ + "/#");
queue_unsubscribe_message(discovery_prefix_ + "/number/" + system_hostname_ + "/#"); queue_unsubscribe_message(discovery_prefix_ + "/number/" + mqtt_basename_ + "/#");
queue_unsubscribe_message(discovery_prefix_ + "/select/" + system_hostname_ + "/#"); queue_unsubscribe_message(discovery_prefix_ + "/select/" + mqtt_basename_ + "/#");
queue_unsubscribe_message(discovery_prefix_ + "/switch/" + system_hostname_ + "/#"); queue_unsubscribe_message(discovery_prefix_ + "/switch/" + 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);
@@ -595,12 +596,12 @@ void Mqtt::on_connect() {
// In line 272 they are removed. If HA is enabled the subscriptions are removed. // In line 272 they are removed. If HA is enabled the subscriptions are removed.
// As described in the doc (https://emsesp.github.io/docs/#/Troubleshooting?id=home-assistant): // As described in the doc (https://emsesp.github.io/docs/#/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_ + "/climate/" + system_hostname_ + "/#"); queue_subscribe_message(discovery_prefix_ + "/climate/" + mqtt_basename_ + "/#");
queue_subscribe_message(discovery_prefix_ + "/sensor/" + system_hostname_ + "/#"); queue_subscribe_message(discovery_prefix_ + "/sensor/" + mqtt_basename_ + "/#");
queue_subscribe_message(discovery_prefix_ + "/binary_sensor/" + system_hostname_ + "/#"); queue_subscribe_message(discovery_prefix_ + "/binary_sensor/" + mqtt_basename_ + "/#");
queue_subscribe_message(discovery_prefix_ + "/number/" + system_hostname_ + "/#"); queue_subscribe_message(discovery_prefix_ + "/number/" + mqtt_basename_ + "/#");
queue_subscribe_message(discovery_prefix_ + "/select/" + system_hostname_ + "/#"); queue_subscribe_message(discovery_prefix_ + "/select/" + mqtt_basename_ + "/#");
queue_subscribe_message(discovery_prefix_ + "/switch/" + system_hostname_ + "/#"); queue_subscribe_message(discovery_prefix_ + "/switch/" + mqtt_basename_ + "/#");
} }
// send initial MQTT messages for some of our services // send initial MQTT messages for some of our services
@@ -649,7 +650,7 @@ void Mqtt::ha_status() {
ids.add("ems-esp"); ids.add("ems-esp");
char topic[MQTT_TOPIC_MAX_SIZE]; char topic[MQTT_TOPIC_MAX_SIZE];
snprintf(topic, sizeof(topic), "sensor/%s/system/config", system_hostname_.c_str()); snprintf(topic, sizeof(topic), "sensor/%s/system/config", mqtt_basename_.c_str());
Mqtt::publish_ha(topic, doc.as<JsonObject>()); // publish the config payload with retain flag Mqtt::publish_ha(topic, doc.as<JsonObject>()); // publish the config payload with retain flag
// create the sensors - must match the MQTT payload keys // create the sensors - must match the MQTT payload keys
@@ -1017,28 +1018,28 @@ void Mqtt::publish_ha_sensor_config(uint8_t type,
case DeviceValueType::ULONG: case DeviceValueType::ULONG:
// number - https://www.home-assistant.io/integrations/number.mqtt // number - https://www.home-assistant.io/integrations/number.mqtt
// https://developers.home-assistant.io/docs/core/entity/number // https://developers.home-assistant.io/docs/core/entity/number
snprintf(topic, sizeof(topic), "number/%s/%s/config", system_hostname_.c_str(), uniq); snprintf(topic, sizeof(topic), "number/%s/%s/config", mqtt_basename_.c_str(), uniq);
break; break;
case DeviceValueType::BOOL: case DeviceValueType::BOOL:
// switch - https://www.home-assistant.io/integrations/switch.mqtt // switch - https://www.home-assistant.io/integrations/switch.mqtt
snprintf(topic, sizeof(topic), "switch/%s/%s/config", system_hostname_.c_str(), uniq); snprintf(topic, sizeof(topic), "switch/%s/%s/config", mqtt_basename_.c_str(), uniq);
break; break;
case DeviceValueType::ENUM: case DeviceValueType::ENUM:
// select - https://www.home-assistant.io/integrations/select.mqtt // select - https://www.home-assistant.io/integrations/select.mqtt
snprintf(topic, sizeof(topic), "select/%s/%s/config", system_hostname_.c_str(), uniq); snprintf(topic, sizeof(topic), "select/%s/%s/config", mqtt_basename_.c_str(), uniq);
break; break;
default: default:
// plain old sensor // plain old sensor
snprintf(topic, sizeof(topic), "sensor/%s/%s/config", system_hostname_.c_str(), uniq); snprintf(topic, sizeof(topic), "sensor/%s/%s/config", mqtt_basename_.c_str(), uniq);
break; break;
} }
} else { } else {
// plain old read only device entity // plain old read only device entity
if (type == DeviceValueType::BOOL) { if (type == DeviceValueType::BOOL) {
snprintf(topic, sizeof(topic), "binary_sensor/%s/%s/config", system_hostname_.c_str(), uniq); // binary sensor snprintf(topic, sizeof(topic), "binary_sensor/%s/%s/config", mqtt_basename_.c_str(), uniq); // binary sensor
} else { } else {
use_ha_sensor = true; use_ha_sensor = true;
snprintf(topic, sizeof(topic), "sensor/%s/%s/config", system_hostname_.c_str(), uniq); // normal HA sensor, not a boolean one snprintf(topic, sizeof(topic), "sensor/%s/%s/config", mqtt_basename_.c_str(), uniq); // normal HA sensor, not a boolean one
} }
} }
@@ -1126,9 +1127,10 @@ void Mqtt::publish_ha_sensor_config(uint8_t type,
// entity id is generated from the name, see https://www.home-assistant.io/docs/mqtt/discovery/#use-object_id-to-influence-the-entity-id // entity id is generated from the name, see https://www.home-assistant.io/docs/mqtt/discovery/#use-object_id-to-influence-the-entity-id
// so we override it to make it unique using entity_id // so we override it to make it unique using entity_id
// See https://github.com/emsesp/EMS-ESP32/issues/596 // See https://github.com/emsesp/EMS-ESP32/issues/596
// "<hostname>_<device>_<tag> <name>" // "<basename>_<device>_<tag> <name>"
// with basename a single instance with "/" replaced by "_"
char object_id[130]; char object_id[130];
snprintf(object_id, sizeof(object_id), "%s_%s_%s", system_hostname_.c_str(), device_name, ha_name); snprintf(object_id, sizeof(object_id), "%s_%s_%s", mqtt_basename_.c_str(), device_name, ha_name);
doc["object_id"] = object_id; doc["object_id"] = object_id;
// value template // value template
@@ -1265,7 +1267,7 @@ void Mqtt::publish_ha_climate_config(uint8_t tag, bool has_roomtemp, bool remove
char min_s[10]; char min_s[10];
char max_s[10]; char max_s[10];
snprintf(topic, sizeof(topic), "climate/%s/thermostat_hc%d/config", Mqtt::base().c_str(), hc_num); snprintf(topic, sizeof(topic), "climate/%s/thermostat_hc%d/config", mqtt_basename_.c_str(), hc_num);
if (remove) { if (remove) {
publish_ha(topic); // publish empty payload with retain flag publish_ha(topic); // publish empty payload with retain flag
return; return;
@@ -1305,7 +1307,7 @@ void Mqtt::publish_ha_climate_config(uint8_t tag, bool has_roomtemp, bool remove
StaticJsonDocument<EMSESP_JSON_SIZE_HA_CONFIG> doc; StaticJsonDocument<EMSESP_JSON_SIZE_HA_CONFIG> doc;
doc["~"] = base(); doc["~"] = mqtt_base_;
doc["object_id"] = id_s; doc["object_id"] = id_s;
doc["name"] = name_s; doc["name"] = name_s;
doc["uniq_id"] = uniq_id_s; doc["uniq_id"] = uniq_id_s;

7
src/mqtt.h
View File

@@ -142,6 +142,10 @@ class Mqtt {
return mqtt_base_; return mqtt_base_;
} }
static std::string basename() {
return mqtt_basename_;
}
// 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()) {
@@ -286,9 +290,8 @@ class Mqtt {
static bool ha_climate_reset_; static bool ha_climate_reset_;
// settings, copied over // settings, copied over
static std::string system_hostname_;
static std::string mqtt_base_; static std::string mqtt_base_;
static std::string mqtt_basename_;
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_;