Merge pull request #4001 from tonhuisman/bugfix/p037-event-generation-overloads-esp

[P037] Fix event generation bug, add event-limit options

Author: TD-er

docs/source/Plugin/P037.rst

@@ -41,6 +41,8 @@ The options that can be included or excluded are:
 
 * Apply mappings
 
+* To replace by comma in event
+
 Initial setup after adding the plugin:
 
 .. image:: P037_DeviceSetup_Initial.png
@@ -179,6 +181,20 @@ Option: Generate events for accepted topics
 
 When this option is disabled it has the backward-compatible behavior of discarding that message as invalid.
 
+Option: Limit events being generated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* **Deduplicate events**: Receiving many MQTT messages, especially in JSON format, can cause a lot of events to be generated. To somewhat limit the system-load, caused by the amount of events, new events can be de-duplicated while still in the event queue, meaning that an event that is already queued, will *not* be inserted in the queue, but discarded.
+
+* **Max. # events in event queue**: As a protection against event-overflow this configures a check for the queue-length, so if more than the selected number of events is still in the queue, new events will be discarded until some events are processed, and the remaining is less than this count. When set to 0 this check is disabled.
+
+Option: Modify separater character in events
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* **To replace by comma in event**: Select a character that is to be replaced by a comma, before it is put into the event-queue. There is a limited set of characters that can be replaced, to avoid ending up with malformed events.
+
+This can be used to 'transform' the content of a JSON message so the used separator is a comma, for easier use in rules.
+
 Topic Subscriptions
 -------------------
 

docs/source/Plugin/P037_DeviceSetup_Filters.png

@@ -254,12 +254,7 @@ boolean Plugin_050(uint8_t function, struct EventStruct *event, String& string)
 
     case PLUGIN_EXIT:
     {
-      P050_data_struct *P050_data = static_cast<P050_data_struct *>(getPluginTaskData(event->TaskIndex));
-
-      if (nullptr != P050_data) {
-        delete P050_data; // call destructor
-        success = true;
-      }
+      success = true;
       break;
     }
 

docs/source/Plugin/P037_DeviceSetup_Initial.png

@@ -406,15 +406,7 @@ boolean Plugin_099(uint8_t function, struct EventStruct *event, String& string)
 
     case PLUGIN_EXIT:
     {
-      P099_data_struct *P099_data = static_cast<P099_data_struct *>(getPluginTaskData(event->TaskIndex));
-
-      if (nullptr == P099_data) {
-        return success;
-      }
-      clearPluginTaskData(event->TaskIndex);
-      P099_data = nullptr;
       success = true;
-
       break;
     }
 

docs/source/Plugin/P037_DeviceSetup_JSON.png

@@ -302,7 +302,6 @@ boolean Plugin_108(uint8_t function, struct EventStruct *event, String& string)
     }
 
     case PLUGIN_EXIT: {
-//       clearPluginTaskData(event->TaskIndex); // DF - not present in P085
       success = true;
       break;
     }

docs/source/Plugin/P037_DeviceSetup_Mappings.png

@@ -4,36 +4,47 @@
 
 EventQueueStruct::EventQueueStruct() {}
 
-void EventQueueStruct::add(const String& event)
+void EventQueueStruct::add(const String& event, bool deduplicate)
 {
   #ifdef USE_SECOND_HEAP
   HeapSelectIram ephemeral;
-  #endif
+  #endif // ifdef USE_SECOND_HEAP
 
-  _eventQueue.push_back(event);
+  if (!deduplicate || !isDuplicate(event)) {
+    _eventQueue.push_back(event);
+  }
 }
 
-void EventQueueStruct::add(const __FlashStringHelper * event)
+void EventQueueStruct::add(const __FlashStringHelper *event, bool deduplicate)
 {
   #ifdef USE_SECOND_HEAP
   HeapSelectIram ephemeral;
-  #endif
+  #endif // ifdef USE_SECOND_HEAP
+
   // Wrap in String() constructor to make sure it is using the 2nd heap allocator if present.
-  _eventQueue.push_back(String(event));
+  if (!deduplicate || !isDuplicate(event)) {
+    _eventQueue.push_back(String(event));
+  }
 }
 
-void EventQueueStruct::addMove(String&& event)
+void EventQueueStruct::addMove(String&& event, bool deduplicate)
 {
-  if (!event.length()) return;
+  if (!event.length()) { return; }
   #ifdef USE_SECOND_HEAP
   HeapSelectIram ephemeral;
+
   if (!mmu_is_iram(&(event[0]))) {
     // Wrap in String constructor to make sure it is stored in the 2nd heap.
-    _eventQueue.push_back(String(event));
+    if (!deduplicate || !isDuplicate(event)) {
+      _eventQueue.push_back(String(event));
+    }
     return;
   }
-  #endif
-  _eventQueue.emplace_back(std::move(event));
+  #endif // ifdef USE_SECOND_HEAP
+
+  if (!deduplicate || !isDuplicate(event)) {
+    _eventQueue.emplace_back(std::move(event));
+  }
 }
 
 bool EventQueueStruct::getNext(String& event)
@@ -48,9 +59,9 @@ bool EventQueueStruct::getNext(String& event)
     HeapSelectDram ephemeral;
     event = std::move(String(_eventQueue.front()));
   }
-  #else
+  #else // ifdef USE_SECOND_HEAP
   event = std::move(_eventQueue.front());
-  #endif
+  #endif // ifdef USE_SECOND_HEAP
   _eventQueue.pop_front();
   return true;
 }
@@ -63,4 +74,8 @@ void EventQueueStruct::clear()
 bool EventQueueStruct::isEmpty() const
 {
   return _eventQueue.empty();
-}
+}
+
+bool EventQueueStruct::isDuplicate(const String& event) {
+  return std::find(_eventQueue.begin(), _eventQueue.end(), event) != _eventQueue.end();
+}