[Build] Add short compressed build description (#3262)

src/src/Helpers/ESPEasy_Build_Description.cpp

@@ -0,0 +1,90 @@
+#include "../Helpers/ESPEasy_Build_Description.h"
+
+#include "../Globals/CPlugins.h"
+#include "../Globals/NPlugins.h"
+#include "../Globals/Plugins.h"
+
+xPluginEnumerator::xPluginEnumerator() {}
+
+void xPluginEnumerator::setSize(unsigned int maxID) {
+  const unsigned int wordSize = (maxID / 16) + 1;
+
+  if (_bitmap.size() < wordSize) {
+    _bitmap.resize(wordSize, 0);
+  }
+}
+
+void xPluginEnumerator::add(unsigned int ID) {
+  setSize(ID);
+  unsigned int wordIndex = ID / 16;
+  unsigned int bitIndex  = 15 - (ID % 16);
+
+  bitSet(_bitmap[wordIndex], bitIndex);
+}
+
+String xPluginEnumerator::getString(char separator) const {
+  String result;
+
+  result.reserve(_bitmap.size() * 5); // 4 HEX characters per 16 bit value + separator
+  size_t zeroCount = 0;
+
+  for (size_t i = 0; i < _bitmap.size(); ++i) {
+    if (_bitmap[i] == 0) {
+      ++zeroCount;
+    } else if (zeroCount > 0) {
+      result   += '(';
+      result   += zeroCount;
+      result   += ')';
+      result   += separator;
+      zeroCount = 0;
+    }
+
+    if (zeroCount == 0) {
+      result += String(_bitmap[i], HEX);
+      result += separator;
+    }
+  }
+  return result;
+}
+
+String CreateBuildDescription(char separator) {
+  String result;
+
+  {
+    result += 'T';
+    xPluginEnumerator  cplugins;
+    const unsigned int size = CPLUGIN_MAX;
+    cplugins.setSize(size);
+
+    for (size_t i = 0; i < size; ++i) {
+      cplugins.add(ProtocolIndex_to_CPlugin_id[i]);
+    }
+    result += cplugins.getString(separator);
+  }
+  {
+    result += 'P';
+    xPluginEnumerator  plugins;
+    const unsigned int size = PLUGIN_MAX;
+    plugins.setSize(size);
+
+    for (size_t i = 0; i < size; ++i) {
+      plugins.add(DeviceIndex_to_Plugin_id[i]);
+    }
+    result += plugins.getString(separator);
+  }
+  {
+    // FIXME TD-er: Right now we don't have a notifierindex to ID vector
+
+    /*
+       result += 'N';
+       xPluginEnumerator plugins;
+       const unsigned int size = DeviceIndex_to_Plugin_id.size();
+       plugins.setSize(size);
+       for (size_t i = 0; i < size; ++i) {
+        plugins.add(DeviceIndex_to_Plugin_id[i]);
+       }
+       result += plugins.getString(separator);
+     */
+  }
+  return result;
+}

src/src/Helpers/ESPEasy_Build_Description.h

@@ -0,0 +1,26 @@
+#ifndef HELPERS_ESPEASY_BUILD_DESCRIPTION_H
+#define HELPERS_ESPEASY_BUILD_DESCRIPTION_H
+
+#include <Arduino.h>
+#include <vector>
+
+struct xPluginEnumerator {
+public:
+
+  xPluginEnumerator();
+
+  void   setSize(unsigned int maxID);
+
+  void   add(unsigned int ID);
+
+  String getString(char separator) const;
+
+private:
+
+  std::vector<uint16_t>_bitmap;
+};
+
+String CreateBuildDescription(char separator);
+
+
+#endif // HELPERS_ESPEASY_BUILD_DESCRIPTION_H

src/src/Helpers/StringProvider.cpp

@@ -28,6 +28,7 @@
 #include "../Globals/WiFi_AP_Candidates.h"
 
 #include "../Helpers/Convert.h"
+#include "../Helpers/ESPEasy_Build_Description.h"
 #include "../Helpers/ESPEasy_Storage.h"
 #include "../Helpers/Memory.h"
 #include "../Helpers/Misc.h"
@@ -175,6 +176,7 @@ const __FlashStringHelper * getLabel(LabelType::Enum label) {
     case LabelType::BUILD_TIME:             return F("Build Time");
     case LabelType::BINARY_FILENAME:        return F("Binary Filename");
     case LabelType::BUILD_PLATFORM:         return F("Build Platform");
+    case LabelType::BUILD_DESCRIPTION:      return F("Build Description");
     case LabelType::GIT_HEAD:               return F("Git HEAD");
 
     case LabelType::I2C_BUS_STATE:          return F("I2C Bus State");
@@ -443,6 +445,7 @@ String getValue(LabelType::Enum label) {
     case LabelType::BUILD_TIME:             return String(get_build_date()) + ' ' + get_build_time();
     case LabelType::BINARY_FILENAME:        return get_binary_filename();
     case LabelType::BUILD_PLATFORM:         return get_build_platform();
+    case LabelType::BUILD_DESCRIPTION:      return CreateBuildDescription(':');
     case LabelType::GIT_HEAD:               return get_git_head();
     case LabelType::I2C_BUS_STATE:          return toString(I2C_state);
     case LabelType::I2C_BUS_CLEARED_COUNT:  return String(I2C_bus_cleared_count);

src/src/Helpers/StringProvider.h

@@ -129,6 +129,7 @@ struct LabelType {
     BUILD_TIME,
     BINARY_FILENAME,
     BUILD_PLATFORM,
+    BUILD_DESCRIPTION,
     GIT_HEAD,
 
 

src/src/WebServer/SysInfoPage.cpp

@@ -162,6 +162,7 @@ void handle_sysinfo_json() {
   json_prop(F("build_time"),     get_build_time());
   json_prop(F("filename"),       getValue(LabelType::BINARY_FILENAME));
   json_prop(F("build_platform"), getValue(LabelType::BUILD_PLATFORM));
+  json_prop(F("build_description"), getValue(LabelType::BUILD_DESCRIPTION));
   json_prop(F("git_head"),       getValue(LabelType::GIT_HEAD));
   json_close();
 
@@ -515,6 +516,7 @@ void handle_sysinfo_Firmware() {
   addRowLabelValue_copy(LabelType::BUILD_TIME);
   addRowLabelValue_copy(LabelType::BINARY_FILENAME);
   addRowLabelValue_copy(LabelType::BUILD_PLATFORM);
+  addRowLabelValue_copy(LabelType::BUILD_DESCRIPTION);
   addRowLabelValue_copy(LabelType::GIT_HEAD);
 }