Changing WebUI to support end-user setting display BLE advertised device name vs current model_id

docs/use/displays.md

@@ -54,6 +54,15 @@ As the display Metric setting is being defined in the WebUI part of OpenMQTTGate
 
 `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoWebUI/config -m {"displayMetric":false}`
 
+### Display name as advetised Bluetooth name or `model_id` 
+There is a build property of ForceDeviceName which forces devices when they are added in Home Assistant auto-discovery to be created with their Bluetooth advertised name isntead of their `model_id`. The default naming is `model_id` with `{"displayDeviceName":true}`. If you have enabled auto-discovery then a restart is required.
+
+This can also be adjusted in the WebUI by switching the Configure WebUI Device naming between `Model ID` (false) or `Device name` (true)
+
+This can also be changed with the runtime command.
+
+`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoWebUI/config -m {"displayDeviceName":true}`
+
 ### Rotating the display by 180 degrees
 
 This can be set with the compiler directive `-DDISPLAY_FLIP=false`.

docs/use/webui.md

@@ -28,7 +28,7 @@ Ability to change the mqtt settings, if the change is unsuccessful it will rever
 
 ## WebUI
 
-Ability to change the display of sensor to Metric or Imperial, and disable the WebUI Authentication
+Ability to change the display of sensor to Metric or Imperial, display the device name as the Bluetooth advertised device name or the model id and disable the WebUI Authentication
 
 ## Bluetooth Low Energy - BLE
 

main/TheengsCommon.h

@@ -62,6 +62,7 @@ extern bool ready_to_sleep;
 extern char mqtt_topic[];
 extern char gateway_name[];
 extern unsigned long lastDiscovery; // Time of the last discovery to trigger automaticaly to off after DiscoveryAutoOffTimer
+extern bool displayDeviceName;
 
 #if BLEDecryptor
 extern char ble_aes[];

main/User_config.h

@@ -604,6 +604,11 @@ extern ss_cnt_parameters cnt_parameters_array[];
 #  define LOG_LEVEL LOG_LEVEL_NOTICE
 #endif
 
+/*-------------------DEFINE DISPLAY NAME-------------------*/
+#ifndef DISPLAY_DEVICE_NAME
+#  define DISPLAY_DEVICE_NAME false // Set to true to force the device name to be from the name of the device and not the model
+#endif
+
 /*-------------------ESP Wifi band and tx power ---------------------*/
 //Certain sensors are sensitive to Wifi which can cause interference with their normal operation
 //For example it can cause false triggers on a PIR HC-SR501

main/config_WebContent.h

@@ -116,7 +116,7 @@ const char config_gateway_body[] = body_header "<fieldset class=\"set1\"><legend
 #endif
 const char config_logging_body[] = body_header "<fieldset class=\"set1\"><legend><span><b>OpenMQTTGateway Logging</b></span></legend><form method='get' action='lo'><p><b>Log Level</b><br><select id='lo'><option %s value='0'>Silent</option><option %s value='1'>Fatal</option><option %s value='2'>Error</option><option %s value='3'>Warning</option><option %s value='4'>Notice</option><option %s value='5'>Trace</option><option %s value='6'>Verbose</option></select></p><br><button name='save' type='submit' class='button bgrn'>Save</button></form></fieldset>" body_footer_config_menu;
 
-const char config_webui_body[] = body_header "<fieldset class=\"set1\"><legend><span><b>Configure WebUI</b></span></legend><form method='get' action='wu'><p><b>Display Metric</b><br><input id='dm' type='checkbox' %s></p><p><b>Secure WebUI</b><br><input id='sw' type='checkbox' %s></p><br><button name='save' type='submit' class='button bgrn'>Save</button></form></fieldset>" body_footer_config_menu;
+const char config_webui_body[] = body_header "<fieldset class=\"set1\"><legend><span><b>Configure WebUI</b></span></legend><form method='get' action='wu'><p><b>Display Metric</b><br><input id='dm' type='checkbox' %s></p><p><b>Device naming</b><select id='dn'><option %s value='0'>Model ID</option><option %s value='1'>Device Name</option></select></p><p><b>Secure WebUI</b><input id='sw' type='checkbox' %s></p><br><button name='save' type='submit' class='button bgrn'>Save</button></form></fieldset>" body_footer_config_menu;
 
 const char config_rf_body[] = body_header
     "<fieldset class=\"set1\">"

main/config_mqttDiscovery.h

@@ -170,6 +170,7 @@ extern char discovery_prefix[];
 #define jsonInuse       "{{ value_json.power | is_defined | float > 0 }}"
 #define jsonInuseRN8209 "{% if value_json.power > 0.02 -%} on {% else %} off {%- endif %}"
 #define jsonVoltBM2     "{% if value_json.uuid is not defined and value_json.volt is defined -%} {{value_json.volt}} {%- endif %}"
+#define jsonRSSI        "{{ value_json.rssi | is_defined }}"
 
 #define stateClassNone            ""
 #define stateClassMeasurement     "measurement"

main/gatewayBT.cpp

@@ -579,13 +579,39 @@ void XMWSDJ04MMCDiscovery(const char* mac, const char* sensorModel) {
   createDiscoveryFromList(mac, XMWSDJ04MMCsensor, XMWSDJ04MMCparametersCount, "XMWSDJ04MMC", "Xiaomi", sensorModel);
 }
 
+void xxWSD0xMMCDiscovery(const char* mac, const char* name, const char* sensorModel) {
+  Log.trace(F("xxWSD0xMMCDiscovery" CR));
+  int xxWSD0xMMCparametersCount = 5;
+  if (strcmp(sensorModel, "LYWSD03MMC/MJWSD05MMC_PVVX_DECR") != 0) xxWSD0xMMCparametersCount = 5;
+  if (strcmp(sensorModel, "LYWSD03MMC/MJWSD05MMC_PVVX_BTHOME") == 0) xxWSD0xMMCparametersCount = 7;
+  const char* xxWSD0xMMCsensor[xxWSD0xMMCparametersCount][9] = {
+      {"sensor", "Battery", mac, "battery", jsonBatt, "", "", "%", stateClassMeasurement},
+      {"sensor", "Temperature", mac, "temperature", jsonTempc, "", "", "°C", stateClassMeasurement},
+      {"sensor", "Humidity", mac, "humidity", jsonHum, "", "", "%", stateClassMeasurement},
+      {"sensor", "RSSI", mac, "signal_strength", jsonRSSI, "", "", "dB", stateClassMeasurement}
+      //component type,name,availability topic,device class,value template,payload on, payload off, unit of measurement, state class
+  };
+  if (strcmp(sensorModel, "LYWSD03MMC/MJWSD05MMC_PVVX_DECR") != 0) { // Encrypted PVVX don't have Voltage
+    const char* voltage[9] = {"sensor", "Voltage", mac, "voltage", jsonVolt, "", "", "V", stateClassMeasurement};
+    memcpy(&xxWSD0xMMCsensor[4], voltage, sizeof(voltage));
+  };
+  if (strcmp(sensorModel, "LYWSD03MMC/MJWSD05MMC_PVVX_BTHOME") == 0) {
+    const char* power[9] = {"sensor", "Power", mac, "", jsonPower, "", "", "", stateClassNone};
+    memcpy(&xxWSD0xMMCsensor[5], power, sizeof(power));
+    const char* open[9] = {"sensor", "Opening", mac, "", jsonOpen, "", "", "", stateClassNone};
+    memcpy(&xxWSD0xMMCsensor[6], open, sizeof(open));
+  };
+  createDiscoveryFromList(mac, xxWSD0xMMCsensor, xxWSD0xMMCparametersCount, name, "Xiaomi", sensorModel);
+}
+
 #  else
 void LYWSD03MMCDiscovery(const char* mac, const char* sensorModel) {}
 void MHO_C401Discovery(const char* mac, const char* sensorModel) {}
 void HHCCJCY01HHCCDiscovery(const char* mac, const char* sensorModel) {}
 void DT24Discovery(const char* mac, const char* sensorModel_id) {}
 void BM2Discovery(const char* mac, const char* sensorModel_id) {}
 void XMWSDJ04MMCDiscovery(const char* mac, const char* sensorModel_id) {}
+void xxWSD0xMMCDiscovery(const char* mac, const char* name, const char* sensorModel) {}
 #  endif
 
 /*
@@ -955,11 +981,11 @@ void launchBTDiscovery(bool overrideDiscovery) {
         Log.trace(F("properties: %s" CR), properties.c_str());
         std::string brand = decoder.getTheengAttribute(p->sensorModel_id, "brand");
         std::string model = decoder.getTheengAttribute(p->sensorModel_id, "model");
-#    if ForceDeviceName
-        if (p->name[0] != '\0') {
-          model = p->name;
+        if (displayDeviceName || ForceDeviceName) {
+          if (p->name[0] != '\0') {
+            model = p->name;
+          }
         }
-#    endif
         std::string model_id = decoder.getTheengAttribute(p->sensorModel_id, "model_id");
 
         // Check for tracker status
@@ -996,7 +1022,9 @@ void launchBTDiscovery(bool overrideDiscovery) {
                             model.c_str(), brand.c_str(), model_id.c_str(), macWOdots.c_str(), false,
                             stateClassNone);
           }
-          if (!properties.empty()) {
+          if (displayDeviceName && p->sensorModel_id >= TheengsDecoder::BLE_ID_NUM::LYWSD03MMC_ATC && p->sensorModel_id <= TheengsDecoder::BLE_ID_NUM::LYWSD03MMC_PVVX_BTHOME_2 ) {
+            xxWSD0xMMCDiscovery(macWOdots.c_str(), p->name, model_id.c_str());
+          } else if (!properties.empty()) {
             StaticJsonDocument<JSON_MSG_BUFFER> jsonBuffer;
             auto error = deserializeJson(jsonBuffer, properties);
             if (error) {
@@ -1014,7 +1042,12 @@ void launchBTDiscovery(bool overrideDiscovery) {
               Log.trace(F("Key: %s"), prop.key().c_str());
               Log.trace(F("Unit: %s"), prop.value()["unit"].as<const char*>());
               Log.trace(F("Name: %s"), prop.value()["name"].as<const char*>());
-              String entity_name = String(model_id.c_str()) + "-" + String(prop.key().c_str());
+              String entity_name = "";
+              if (displayDeviceName || ForceDeviceName) {
+                entity_name = String(model.c_str()) + "-" + String(prop.key().c_str());
+              } else {
+                entity_name = String(model_id.c_str()) + "-" + String(prop.key().c_str());
+              }
               String unique_id = macWOdots + "-" + String(prop.key().c_str());
               String value_template = "{{ value_json." + String(prop.key().c_str()) + " | is_defined }}";
               if (p->sensorModel_id == TheengsDecoder::BLE_ID_NUM::SBS1 && strcmp(prop.key().c_str(), "state") == 0) {
@@ -1423,7 +1456,7 @@ void process_bledata(JsonObject& BLEdata) {
               BTConfig.intervalActiveScan = MinTimeBtwScan;
               BTConfig.scanDuration = MinScanDuration;
               Log.notice(F("Active and continuous scanning required, parameters adapted" CR));
-              stateBTMeasures(false);
+              // stateBTMeasures(false); // Disabling as it casues a segfault
             }
           } else if (BLEdata.containsKey("cont") && BTConfig.BLEinterval != MinTimeBtwScan) {
             if (BLEdata["cont"]) {
@@ -1432,7 +1465,7 @@ void process_bledata(JsonObject& BLEdata) {
                 BTConfig.scanDuration = MinScanDuration;
               }
               Log.notice(F("Passive continuous scanning required, parameters adapted" CR));
-              stateBTMeasures(false);
+              // stateBTMeasures(false); // Disabling as it casues a segfault
             }
           }
         }

main/main.cpp

@@ -292,6 +292,7 @@ bool failSafeMode = false;
 bool ProcessLock = true; // Process lock when we want to use a critical function like OTA for example
 bool mqttSetupPending = true;
 static int cnt_index = CNT_DEFAULT_INDEX;
+bool displayDeviceName = DISPLAY_DEVICE_NAME;
 
 #ifdef ESP32
 #  include <ArduinoOTA.h>

main/mqttDiscovery.cpp

@@ -586,7 +586,11 @@ void createDiscovery(const char* sensor_type,
 
     // generate unique device name by adding the second half of the device_id only if device_name and device_id are different and we don't want to use the BLE name
     if (device_name[0]) {
-      if (strcmp(device_id, device_name) != 0 && device_id[0] && !ForceDeviceName) {
+      #if defined(ZwebUI) && defined(ESP32)  // displayDeviceName only applies when running with the WebUI and ESP32
+        if (strcmp(device_id, device_name) != 0 && device_id[0] && !displayDeviceName) {
+      #elif !ForceDeviceName  // Support ForceDeviceName for esp8266's
+        if (strcmp(device_id, device_name) != 0 && device_id[0] && !ForceDeviceName) {
+      #endif
         device["name"] = device_name + String("-") + String(device_id + 6);
       } else {
         device["name"] = device_name;

main/webUI.cpp

@@ -504,8 +504,9 @@ void handleCN() {
  * @brief /WU - Configuration Page
  * T: handleWU: uri: /wu, args: 3, method: 1
  * T: handleWU Arg: 0, dm=on - displayMetric
- * T: handleWU Arg: 1, sw=on - webUISecure
- * T: handleWU Arg: 2, save=
+ * T: handleWU Arg: 1, dn=1 - displayDeviceName 
+ * T: handleWU Arg: 2, sw=on - webUISecure
+ * T: handleWU Arg: 3, save=
  */
 void handleWU() {
   WEBUI_TRACE_LOG(F("handleWU: uri: %s, args: %d, method: %d" CR), server.uri(), server.args(), server.method());
@@ -521,6 +522,11 @@ void handleWU() {
     }
     displayMetric = server.hasArg("dm");
 
+    if (server.hasArg("dn") && server.arg("dn").toInt() != displayDeviceName) {
+      displayDeviceName = server.arg("dn").toInt();
+      update = true;
+    }
+
     if (webUISecure != server.hasArg("sw")) {
       update = true;
     }
@@ -541,7 +547,7 @@ void handleWU() {
   response += String(script);
   response += String(style);
   int logLevel = Log.getLevel();
-  snprintf(buffer, WEB_TEMPLATE_BUFFER_MAX_SIZE, config_webui_body, jsonChar, gateway_name, (displayMetric ? "checked" : ""), (webUISecure ? "checked" : ""));
+  snprintf(buffer, WEB_TEMPLATE_BUFFER_MAX_SIZE, config_webui_body, jsonChar, gateway_name, (displayMetric ? "checked" : ""), (!displayDeviceName ? "selected" : ""), (displayDeviceName ? "selected" : ""), (webUISecure ? "checked" : ""));
   response += String(buffer);
   snprintf(buffer, WEB_TEMPLATE_BUFFER_MAX_SIZE, footer, OMG_VERSION);
   response += String(buffer);
@@ -1863,6 +1869,7 @@ String stateWebUIStatus() {
   StaticJsonDocument<JSON_MSG_BUFFER> WebUIdataBuffer;
   JsonObject WebUIdata = WebUIdataBuffer.to<JsonObject>();
   WebUIdata["displayMetric"] = (bool)displayMetric;
+  WebUIdata["displayDeviceName"] = (bool)displayDeviceName;
   WebUIdata["webUISecure"] = (bool)webUISecure;
   WebUIdata["displayQueue"] = uxQueueMessagesWaiting(webUIQueue);
 
@@ -1879,6 +1886,7 @@ bool WebUIConfig_save() {
   StaticJsonDocument<JSON_MSG_BUFFER> jsonBuffer;
   JsonObject jo = jsonBuffer.to<JsonObject>();
   jo["displayMetric"] = (bool)displayMetric;
+  jo["displayDeviceName"] = (bool)displayDeviceName;
   jo["webUISecure"] = (bool)webUISecure;
   // Save config into NVS (non-volatile storage)
   String conf = "";
@@ -1912,6 +1920,7 @@ bool WebUIConfig_load() {
     }
     JsonObject jo = jsonBuffer.as<JsonObject>();
     displayMetric = jo["displayMetric"].as<bool>();
+    displayDeviceName = jo["displayDeviceName"].as<bool>();
     webUISecure = jo["webUISecure"].as<bool>();
     return true;
   } else {