From 0d3debf9b92d7a9e26434b1e0bc0926c5a27ecb3 Mon Sep 17 00:00:00 2001
From: mx <mxklb@users.noreply.github.com>
Date: Tue, 21 Feb 2023 17:13:15 +0100
Subject: [PATCH] sACN/E1.31 Port Priority (#3052)

* Added E1.31 port priority handling #768

* Ignore E1.31 data when priority doesn't match #768

* Enable E1.31 priority handling for WLED_ENABLE_DMX

* Only handle e131Priority for P_E131 protocol

* Corrected comments

* Highest priority package first handling

* Removed obsolete code & comments

* Improved comments

* Reduce priority timeout to be uint8_t

* Optimized code & comments

* E1.31: Ignore non-zero start code and preview data
These are not level data, they have other purposes

* Style change cca41508 preview & ignore non-zero start code

---------

Co-authored-by: RichardTea <31507749+RichardTea@users.noreply.github.com>
---
 wled00/cfg.cpp                              |  3 +++
 wled00/data/settings_sync.htm               |  1 +
 wled00/e131.cpp                             | 12 +++++++++-
 wled00/set.cpp                              |  2 ++
 wled00/src/dependencies/e131/ESPAsyncE131.h | 26 +++++++++++++++++++++
 wled00/wled.h                               |  2 ++
 wled00/xml.cpp                              |  1 +
 7 files changed, 46 insertions(+), 1 deletion(-)

diff --git a/wled00/cfg.cpp b/wled00/cfg.cpp
index e52fb6a8..eddb7ccc 100644
--- a/wled00/cfg.cpp
+++ b/wled00/cfg.cpp
@@ -408,6 +408,8 @@ bool deserializeConfig(JsonObject doc, bool fromFS) {
   if (!DMXAddress || DMXAddress > 510) DMXAddress = 1;
   CJSON(DMXSegmentSpacing, if_live_dmx[F("dss")]);
   if (DMXSegmentSpacing > 150) DMXSegmentSpacing = 0;
+  CJSON(e131Priority, if_live_dmx[F("e131prio")]);
+  if (e131Priority > 200) e131Priority = 200;
   CJSON(DMXMode, if_live_dmx["mode"]);
 
   tdd = if_live[F("timeout")] | -1;
@@ -852,6 +854,7 @@ void serializeConfig() {
   JsonObject if_live_dmx = if_live.createNestedObject("dmx");
   if_live_dmx[F("uni")] = e131Universe;
   if_live_dmx[F("seqskip")] = e131SkipOutOfSequence;
+  if_live_dmx[F("e131prio")] = e131Priority;
   if_live_dmx[F("addr")] = DMXAddress;
   if_live_dmx[F("dss")] = DMXSegmentSpacing;
   if_live_dmx["mode"] = DMXMode;
diff --git a/wled00/data/settings_sync.htm b/wled00/data/settings_sync.htm
index a71ab31e..3f175f0b 100644
--- a/wled00/data/settings_sync.htm
+++ b/wled00/data/settings_sync.htm
@@ -149,6 +149,7 @@ Start universe: <input name="EU" type="number" min="0" max="63999" required><br>
 Skip out-of-sequence packets: <input type="checkbox" name="ES"><br>
 DMX start address: <input name="DA" type="number" min="1" max="510" required><br>
 DMX segment spacing: <input name="XX" type="number" min="0" max="150" required><br>
+E1.31 port priority: <input name="PY" type="number" min="0" max="200" required><br>
 DMX mode:
 <select name=DM>
 <option value=0>Disabled</option>
diff --git a/wled00/e131.cpp b/wled00/e131.cpp
index e4c3fabb..ababf8d8 100644
--- a/wled00/e131.cpp
+++ b/wled00/e131.cpp
@@ -70,10 +70,20 @@ void handleE131Packet(e131_packet_t* p, IPAddress clientIP, byte protocol){
     seq = p->art_sequence_number;
     mde = REALTIME_MODE_ARTNET;
   } else if (protocol == P_E131) {
+    // Ignore PREVIEW data (E1.31: 6.2.6)
+    if ((p->options & 0x80) != 0) return;
+    dmxChannels = htons(p->property_value_count) - 1;
+    // DMX level data is zero start code. Ignore everything else. (E1.11: 8.5)
+    if (dmxChannels == 0 || p->property_values[0] != 0) return;
     uni = htons(p->universe);
-    dmxChannels = htons(p->property_value_count) -1;
     e131_data = p->property_values;
     seq = p->sequence_number;
+    if (e131Priority != 0) {
+      if (p->priority < e131Priority ) return;
+      // track highest priority & skip all lower priorities
+      if (p->priority >= highPriority.get()) highPriority.set(p->priority);
+      if (p->priority < highPriority.get()) return;
+    }
   } else { //DDP
     realtimeIP = clientIP;
     handleDDPPacket(p);
diff --git a/wled00/set.cpp b/wled00/set.cpp
index 2cc77005..f1be6514 100644
--- a/wled00/set.cpp
+++ b/wled00/set.cpp
@@ -298,6 +298,8 @@ void handleSettingsSet(AsyncWebServerRequest *request, byte subPage)
     if (t >= 0  && t <= 510) DMXAddress = t;
     t = request->arg(F("XX")).toInt();
     if (t >= 0  && t <= 150) DMXSegmentSpacing = t;
+    t = request->arg(F("PY")).toInt();
+    if (t >= 0  && t <= 200) e131Priority = t;
     t = request->arg(F("DM")).toInt();
     if (t >= DMX_MODE_DISABLED && t <= DMX_MODE_PRESET) DMXMode = t;
     t = request->arg(F("ET")).toInt();
diff --git a/wled00/src/dependencies/e131/ESPAsyncE131.h b/wled00/src/dependencies/e131/ESPAsyncE131.h
index 36486a6e..3132ca6c 100644
--- a/wled00/src/dependencies/e131/ESPAsyncE131.h
+++ b/wled00/src/dependencies/e131/ESPAsyncE131.h
@@ -228,4 +228,30 @@ class ESPAsyncE131 {
     bool begin(bool multicast, uint16_t port = E131_DEFAULT_PORT, uint16_t universe = 1, uint8_t n = 1);
 };
 
+// Class to track e131 package priority
+class E131Priority {
+  private:
+    uint8_t priority;
+    time_t setupTime;
+    uint8_t seconds;
+  
+  public:
+    E131Priority(uint8_t timeout=3) { 
+      seconds = timeout;
+      set(0);
+    };
+
+    // Set priority (+ remember time)
+    void set(uint8_t prio) {
+      setupTime = time(0);
+      priority = prio;
+    }
+
+    // Get priority (+ reset & return 0 if older timeout)
+    uint8_t get() {
+      if (time(0) > setupTime + seconds) priority = 0;
+      return priority;
+    }
+};
+
 #endif  // ESPASYNCE131_H_
\ No newline at end of file
diff --git a/wled00/wled.h b/wled00/wled.h
index bda81486..3638fef8 100644
--- a/wled00/wled.h
+++ b/wled00/wled.h
@@ -390,6 +390,8 @@ WLED_GLOBAL uint16_t e131ProxyUniverse _INIT(0);                  // output this
 #endif
 WLED_GLOBAL uint16_t e131Universe _INIT(1);                       // settings for E1.31 (sACN) protocol (only DMX_MODE_MULTIPLE_* can span over consequtive universes)
 WLED_GLOBAL uint16_t e131Port _INIT(5568);                        // DMX in port. E1.31 default is 5568, Art-Net is 6454
+WLED_GLOBAL byte e131Priority _INIT(0);                           // E1.31 port priority (if != 0 priority handling is active)
+WLED_GLOBAL E131Priority highPriority _INIT(3);                   // E1.31 highest priority tracking, init = timeout in seconds
 WLED_GLOBAL byte DMXMode _INIT(DMX_MODE_MULTIPLE_RGB);            // DMX mode (s.a.)
 WLED_GLOBAL uint16_t DMXAddress _INIT(1);                         // DMX start address of fixture, a.k.a. first Channel [for E1.31 (sACN) protocol]
 WLED_GLOBAL uint16_t DMXSegmentSpacing _INIT(0);                  // Number of void/unused channels between each segments DMX channels
diff --git a/wled00/xml.cpp b/wled00/xml.cpp
index 6ef84982..d91b32ab 100644
--- a/wled00/xml.cpp
+++ b/wled00/xml.cpp
@@ -510,6 +510,7 @@ void getSettingsJS(byte subPage, char* dest)
     sappend('v',SET_F("EU"),e131Universe);
     sappend('v',SET_F("DA"),DMXAddress);
     sappend('v',SET_F("XX"),DMXSegmentSpacing);
+    sappend('v',SET_F("PY"),e131Priority);
     sappend('v',SET_F("DM"),DMXMode);
     sappend('v',SET_F("ET"),realtimeTimeoutMs);
     sappend('c',SET_F("FB"),arlsForceMaxBri);