mqtt base, serviceCode ~H

CHANGELOG_LATEST.md

@@ -10,5 +10,8 @@
 - split `show values` in smaller packages (edited)
 - extended length of IP/hostname from 32 to 48 chars (#676)
 - check flowsensor for `tap_water_active`
+- serviceCode `~H` instead of nonacii 3-dashes
+- mqtt `base` instead of hostname
+- mqtt max. topic length fixed to 128
 
 ### Removed

interface/src/mqtt/MqttSettingsForm.tsx

@@ -6,7 +6,7 @@ import SaveIcon from '@material-ui/icons/Save';
 import MenuItem from '@material-ui/core/MenuItem';
 
 import { RestFormProps, FormActions, FormButton, BlockFormControlLabel, PasswordValidator } from '../components';
-import { isIP, isHostname, or } from '../validators';
+import { isIP, isHostname, or, isPath } from '../validators';
 
 import { MqttSettings } from './types';
 
@@ -16,6 +16,7 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
 
   componentDidMount() {
     ValidatorForm.addValidationRule('isIPOrHostname', or(isIP, isHostname));
+    ValidatorForm.addValidationRule('isPath', isPath);
   }
 
   render() {
@@ -43,6 +44,17 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
           onChange={handleValueChange('host')}
           margin="normal"
         />
+        <TextValidator
+          validators={['required', 'isPath']}
+          errorMessages={['Base is required', 'Not a valid path']}
+          name="base"
+          label="Base"
+          fullWidth
+          variant="outlined"
+          value={data.base}
+          onChange={handleValueChange('base')}
+          margin="normal"
+        />
         <TextValidator
           validators={['required', 'isNumber', 'minNumber:0', 'maxNumber:65535']}
           errorMessages={['Port is required', "Must be a number", "Must be greater than 0 ", "Max value is 65535"]}
@@ -94,18 +106,6 @@ class MqttSettingsForm extends React.Component<MqttSettingsFormProps> {
           onChange={handleValueChange('keep_alive')}
           margin="normal"
         />
-        <TextValidator
-          validators={['required', 'isNumber', 'minNumber:1', 'maxNumber:65535']}
-          errorMessages={['Max topic length is required', "Must be a number", "Must be greater than 0", "Max value is 65535"]}
-          name="max_topic_length"
-          label="Max Topic Length"
-          fullWidth
-          variant="outlined"
-          value={data.max_topic_length}
-          type="number"
-          onChange={handleValueChange('max_topic_length')}
-          margin="normal"
-        />
         <SelectValidator name="mqtt_format"
           label="Format"
           value={data.mqtt_format}

interface/src/mqtt/types.ts

@@ -20,13 +20,13 @@ export interface MqttStatus {
 export interface MqttSettings {
   enabled: boolean;
   host: string;
+  base: string;
   port: number;
   username: string;
   password: string;
   client_id: string;
   keep_alive: number;
   clean_session: boolean;
-  max_topic_length: number;
   publish_time_boiler: number;
   publish_time_thermostat: number;
   publish_time_solar: number;

interface/src/project/EMSESPSettingsController.tsx

@@ -265,7 +265,7 @@ function EMSESPSettingsControllerForm(props: EMSESPSettingsControllerFormProps)
                         value="trace_raw"
                     />
                 }
-                label="Trace ems-telegrams in raw format"
+                label="Trace EMS telegrams in raw format"
             />
 
             <br></br>

interface/src/system/SystemStatusForm.tsx

@@ -63,6 +63,7 @@ class SystemStatusForm extends Component<SystemStatusFormProps, SystemStatusForm
           </ListItemAvatar>
           <ListItemText primary="System Uptime" secondary={data.uptime} />
         </ListItem>
+        <Divider variant="inset" component="li" />
         <ListItem >
           <ListItemAvatar>
             <Avatar>
@@ -94,6 +95,7 @@ class SystemStatusForm extends Component<SystemStatusFormProps, SystemStatusForm
               </ListItem>
             </Fragment>)
         }
+        <Divider variant="inset" component="li" />
         <ListItem>
           <ListItemAvatar>
             <Avatar>

interface/src/validators/index.ts

@@ -2,3 +2,4 @@ export { default as isHostname } from './isHostname';
 export { default as isIP } from './isIP';
 export { default as optional } from './optional';
 export { default as or } from './or';
+export { default as isPath } from './isPath';

interface/src/validators/isPath.ts

@@ -0,0 +1,6 @@
+const pathLengthRegex = /^[^.]{0,108}$/
+const pathPatternRegex = /^([a-zA-Z0-9_][a-zA-Z0-9/_-]*[a-zA-Z0-9_])$/
+
+export default function isPath(path: string) {
+  return pathLengthRegex.test(path) && pathPatternRegex.test(path);
+}

lib/framework/MqttSettingsService.cpp

@@ -163,7 +163,7 @@ void MqttSettingsService::configureMqtt() {
         _mqttClient.setClientId(retainCstr(_state.clientId.c_str(), &_retainedClientId));
         _mqttClient.setKeepAlive(_state.keepAlive);
         _mqttClient.setCleanSession(_state.cleanSession);
-        _mqttClient.setMaxTopicLength(_state.maxTopicLength);
+        _mqttClient.setMaxTopicLength(FACTORY_MQTT_MAX_TOPIC_LENGTH);
         _mqttClient.connect();
     }
 
@@ -173,13 +173,14 @@ void MqttSettingsService::configureMqtt() {
 void MqttSettings::read(MqttSettings & settings, JsonObject & root) {
     root["enabled"]          = settings.enabled;
     root["host"]             = settings.host;
+    root["base"]             = settings.base;
     root["port"]             = settings.port;
     root["username"]         = settings.username;
     root["password"]         = settings.password;
     root["client_id"]        = settings.clientId;
     root["keep_alive"]       = settings.keepAlive;
     root["clean_session"]    = settings.cleanSession;
-    root["max_topic_length"] = settings.maxTopicLength;
+    // root["max_topic_length"] = settings.maxTopicLength;
 
     // added by proddy for EMS-ESP
     root["publish_time_boiler"]     = settings.publish_time_boiler;
@@ -198,13 +199,14 @@ StateUpdateResult MqttSettings::update(JsonObject & root, MqttSettings & setting
 
     newSettings.enabled        = root["enabled"] | FACTORY_MQTT_ENABLED;
     newSettings.host           = root["host"] | FACTORY_MQTT_HOST;
+    newSettings.base           = root["base"] | FACTORY_MQTT_BASE;
     newSettings.port           = root["port"] | FACTORY_MQTT_PORT;
     newSettings.username       = root["username"] | FACTORY_MQTT_USERNAME;
     newSettings.password       = root["password"] | FACTORY_MQTT_PASSWORD;
     newSettings.clientId       = root["client_id"] | FACTORY_MQTT_CLIENT_ID;
     newSettings.keepAlive      = root["keep_alive"] | FACTORY_MQTT_KEEP_ALIVE;
     newSettings.cleanSession   = root["clean_session"] | FACTORY_MQTT_CLEAN_SESSION;
-    newSettings.maxTopicLength = root["max_topic_length"] | FACTORY_MQTT_MAX_TOPIC_LENGTH;
+    // newSettings.maxTopicLength = root["max_topic_length"] | FACTORY_MQTT_MAX_TOPIC_LENGTH;
 
     newSettings.publish_time_boiler     = root["publish_time_boiler"] | EMSESP_DEFAULT_PUBLISH_TIME;
     newSettings.publish_time_thermostat = root["publish_time_thermostat"] | EMSESP_DEFAULT_PUBLISH_TIME;
@@ -219,15 +221,12 @@ StateUpdateResult MqttSettings::update(JsonObject & root, MqttSettings & setting
     if (newSettings.mqtt_qos != settings.mqtt_qos) {
         emsesp::EMSESP::mqtt_.set_qos(newSettings.mqtt_qos);
     }
-
     if (newSettings.mqtt_format != settings.mqtt_format) {
         emsesp::EMSESP::mqtt_.set_format(newSettings.mqtt_format);
     }
-
     if (newSettings.mqtt_retain != settings.mqtt_retain) {
         emsesp::EMSESP::mqtt_.set_retain(newSettings.mqtt_retain);
     }
-
     if (newSettings.publish_time_boiler != settings.publish_time_boiler) {
         emsesp::EMSESP::mqtt_.set_publish_time_boiler(newSettings.publish_time_boiler);
     }

lib/framework/MqttSettingsService.h

@@ -25,6 +25,10 @@
 #define FACTORY_MQTT_HOST "test.mosquitto.org"
 #endif
 
+#ifndef FACTORY_MQTT_BASE
+#define FACTORY_MQTT_BASE "ems-esp"
+#endif
+
 #ifndef FACTORY_MQTT_PORT
 #define FACTORY_MQTT_PORT 1883
 #endif
@@ -70,6 +74,7 @@ class MqttSettings {
     // host and port - if enabled
     bool     enabled;
     String   host;
+    String   base;
     uint16_t port;
 
     // username and password
@@ -82,7 +87,7 @@ class MqttSettings {
     // connection settings
     uint16_t keepAlive;
     bool     cleanSession;
-    uint16_t maxTopicLength;
+    // uint16_t maxTopicLength;
 
     // proddy EMS-ESP specific
     uint16_t publish_time_boiler;

src/dallassensor.cpp

@@ -125,14 +125,18 @@ void DallasSensor::loop() {
                                 sensors_.back().read          = true;
                                 changed_                      = true;
                             }
+                        } else {
+                            sensorfails_++;
                         }
                         break;
 
                     default:
+                        sensorfails_++;
                         LOG_ERROR(F("Unknown dallas sensor %s"), Sensor(addr).to_string().c_str());
                         break;
                     }
                 } else {
+                    sensorfails_++;
                     LOG_ERROR(F("Invalid dallas sensor %s"), Sensor(addr).to_string().c_str());
                 }
             } else {
@@ -344,8 +348,8 @@ void DallasSensor::publish_values(const bool force) {
                 StaticJsonDocument<EMSESP_MAX_JSON_SIZE_MEDIUM> config;
                 config["dev_cla"] = FJSON("temperature");
 
-                char stat_t[50];
-                snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/dallassensor_data"), System::hostname().c_str());
+                char stat_t[128];
+                snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/dallassensor_data"), Mqtt::base().c_str());
                 config["stat_t"] = stat_t;
 
                 config["unit_of_meas"] = FJSON("°C");

src/dallassensor.h

@@ -64,6 +64,10 @@ class DallasSensor {
 
     const std::vector<Sensor> sensors() const;
 
+    uint32_t fails() {
+      return sensorfails_;
+    }
+
   private:
     static constexpr uint8_t MAX_SENSORS = 20;
 
@@ -111,11 +115,12 @@ class DallasSensor {
 
     bool registered_ha_[MAX_SENSORS];
 
-    int8_t  scancnt_     = -3;
-    uint8_t firstscan_   = 0;
-    uint8_t dallas_gpio_ = 0;
-    bool    parasite_    = false;
-    bool    changed_     = false;
+    int8_t  scancnt_      = -3;
+    uint8_t firstscan_    = 0;
+    uint8_t dallas_gpio_  = 0;
+    bool    parasite_     = false;
+    bool    changed_      = false;
+    uint32_t sensorfails_ = 0;
 };
 
 } // namespace emsesp

src/devices/boiler.cpp

@@ -95,8 +95,8 @@ void Boiler::register_mqtt_ha_config() {
     doc["uniq_id"] = FJSON("boiler");
     doc["ic"]      = FJSON("mdi:home-thermometer-outline");
 
-    char stat_t[50];
-    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/boiler_data"), System::hostname().c_str());
+    char stat_t[128];
+    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/boiler_data"), Mqtt::base().c_str());
     doc["stat_t"] = stat_t;
 
     doc["val_tpl"] = FJSON("{{value_json.serviceCode}}");
@@ -704,7 +704,11 @@ bool Boiler::export_values_main(JsonObject & json, const bool textformat) {
 
     // Service Code & Service Code Number
     if (Helpers::hasValue(serviceCodeNumber_)) {
-        json["serviceCode"]       = serviceCode_;
+        if (serviceCode_[0] == 0xF0) {
+            json["serviceCode"] = FJSON("~H");
+        } else {
+            json["serviceCode"] = serviceCode_;
+        }
         json["serviceCodeNumber"] = serviceCodeNumber_;
     }
 

src/devices/heatpump.cpp

@@ -87,8 +87,8 @@ void Heatpump::register_mqtt_ha_config() {
     doc["uniq_id"] = F_(heatpump);
     doc["ic"]      = F_(iconheatpump);
 
-    char stat_t[50];
-    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/heatpump_data"), System::hostname().c_str());
+    char stat_t[128];
+    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/heatpump_data"), Mqtt::base().c_str());
     doc["stat_t"] = stat_t;
 
     doc["val_tpl"] = FJSON("{{value_json.airHumidity}}");

src/devices/mixer.cpp

@@ -146,8 +146,8 @@ void Mixer::register_mqtt_ha_config() {
 
     doc["ic"] = FJSON("mdi:home-thermometer-outline");
 
-    char stat_t[50];
-    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/mixer_data"), System::hostname().c_str());
+    char stat_t[128];
+    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/mixer_data"), Mqtt::base().c_str());
     doc["stat_t"] = stat_t;
 
     doc["val_tpl"] = FJSON("{{value_json.type}}"); // HA needs a single value. We take the type which is wwc or hc

src/devices/solar.cpp

@@ -121,8 +121,8 @@ void Solar::register_mqtt_ha_config() {
     doc["uniq_id"] = F_(solar);
     doc["ic"]      = F_(iconthermostat);
 
-    char stat_t[50];
-    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/solar_data"), System::hostname().c_str());
+    char stat_t[128];
+    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/solar_data"), Mqtt::base().c_str());
     doc["stat_t"] = stat_t;
 
     doc["val_tpl"] = FJSON("{{value_json.solarPump}}");

src/devices/switch.cpp

@@ -113,8 +113,8 @@ void Switch::register_mqtt_ha_config() {
 
     doc["ic"] = FJSON("mdi:home-thermometer-outline");
 
-    char stat_t[50];
-    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/switch_data"), System::hostname().c_str());
+    char stat_t[128];
+    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/switch_data"), Mqtt::base().c_str());
     doc["stat_t"] = stat_t;
 
     doc["val_tpl"] = FJSON("{{value_json.type}}"); // HA needs a single value. We take the type which is wwc or hc

src/devices/thermostat.cpp

@@ -847,8 +847,8 @@ void Thermostat::register_mqtt_ha_config() {
     doc["uniq_id"] = FJSON("thermostat");
     doc["ic"]      = FJSON("mdi:home-thermometer-outline");
 
-    char stat_t[50];
-    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/thermostat_data"), System::hostname().c_str());
+    char stat_t[128];
+    snprintf_P(stat_t, sizeof(stat_t), PSTR("%s/thermostat_data"), Mqtt::base().c_str());
     doc["stat_t"] = stat_t;
 
     doc["name"]    = FJSON("Thermostat Status");
@@ -912,7 +912,7 @@ void Thermostat::register_mqtt_ha_config(uint8_t hc_num) {
     doc["uniq_id"]     = str2;
     doc["mode_cmd_t"]  = str3;
     doc["temp_cmd_t"]  = str3;
-    doc["~"]           = System::hostname(); // ems-esp
+    doc["~"]           = Mqtt::base(); // ems-esp
     doc["mode_stat_t"] = FJSON("~/thermostat_data");
     doc["temp_stat_t"] = FJSON("~/thermostat_data");
     doc["curr_temp_t"] = FJSON("~/thermostat_data");

src/emsesp.h

@@ -123,6 +123,9 @@ class EMSESP {
     static bool have_sensors() {
         return (!(dallassensor_.sensors().empty()));
     }
+    static uint32_t sensor_fails() {
+        return dallassensor_.fails();
+    }
 
     enum Watch : uint8_t { WATCH_OFF, WATCH_ON, WATCH_RAW, WATCH_UNKNOWN };
     static void     watch_id(uint16_t id);
@@ -139,6 +142,7 @@ class EMSESP {
     static uint8_t watch() {
         return watch_;
     }
+
     static void set_read_id(uint16_t id) {
         read_id_ = id;
     }