add option to send whole universe or changes only

Author: mutec

src/sacn/locales/de/sacn-in.json

@@ -7,7 +7,10 @@
       "mode_htp": "HTP",
       "mode_ltp": "LTP",
       "port": "Port",
-      "universe": "Universum"
+      "universe": "Universum",
+      "output": "Ausgabe",
+      "output_full": "Vollständiges Universum",
+      "output_changes": "Änderungen"
     }
   }
 }

src/sacn/locales/en-US/sacn-in.json

@@ -7,7 +7,10 @@
       "mode_htp": "HTP",
       "mode_ltp": "LTP",
       "port": "port",
-      "universe": "universe"
+      "universe": "universe",
+      "output": "output",
+      "output_full": "whole universe",
+      "output_changes": "changes"
     }
   }
 }

src/sacn/sacn-in.html

@@ -20,11 +20,18 @@
   <div class="form-row">
     <label for="node-input-mode"><i class="fa fa-compress"></i> <span data-i18n="sacn-in.label.mode"></span></label>
     <select id="node-input-mode" style="width:70%;">
-      <option value="direct" selected data-i18n="sacn-in.label.mode_direct"></option>
+      <option value="passthrough" selected data-i18n="sacn-in.label.mode_direct"></option>
       <option value="htp" data-i18n="sacn-in.label.mode_htp"></option>
       <option value="ltp" data-i18n="sacn-in.label.mode_ltp"></option>
     </select>
   </div>
+  <div class="form-row">
+      <label for="node-input-output"><i class="fa fa-compress"></i> <span data-i18n="sacn-in.label.output"></span></label>
+      <select id="node-input-output" style="width:70%;">
+          <option value="full" selected data-i18n="sacn-in.label.output_full"></option>
+          <option value="changes" data-i18n="sacn-in.label.output_changes"></option>
+      </select>
+  </div>
   <div class="form-row">
     <label for="node-input-interface"
       ><i class="fa fa-plug"></i> <span data-i18n="sacn-in.label.interface"></span
@@ -62,6 +69,10 @@
         value: "htp",
         required: true,
       },
+      output: {
+        value: "full",
+        required: true,
+      },
       outputs: {
         value: 1,
       },

src/sacn/sacn-in.js

@@ -8,6 +8,7 @@ interface SacnInOptions extends NodeDef {
   interface?: string;
   port?: number;
   mode: "htp" | "ltp" | "passthrough";
+  output: "full" | "changes";
 }
 
 export interface SacnInMessage extends NodeMessage {
@@ -29,6 +30,10 @@ const nodeInit: NodeInitializer = (RED): void => {
   function SacnInNodeConstructor(this: Node, config: SacnInOptions): void {
     RED.nodes.createNode(this, config);
 
+    // initialize universe data
+    let data: Map<number, DMXValues> | undefined = new Map();
+
+    // parse options for receiver instance
     const options: Receiver.Props | MergingReceiver.Props = {
       universes: [config.universe],
       reuseAddr: config.reuseAddress !== undefined ? config.reuseAddress : true,
@@ -40,26 +45,69 @@ const nodeInit: NodeInitializer = (RED): void => {
       options.port = config.port;
     }
 
+    // internal functions
+    const getNulledUniverse = (): DMXValues => {
+      const universe: DMXValues = {};
+
+      for (let ch = 1; ch <= 512; ch++) {
+        universe[ch] = 0;
+      }
+
+      return universe;
+    };
+
+    const getReference = (universe: number): DMXValues => {
+      if (config.output === "changes") {
+        return {} as DMXValues;
+      }
+
+      return data?.get(universe) ?? getNulledUniverse();
+    };
+
+    const parsePayload = (payload: DMXValues, universe: number): DMXValues => {
+      const processedPayload: DMXValues = getReference(universe);
+
+      Object.keys(payload).forEach((key) => {
+        const ch = parseInt(key, 10);
+        processedPayload[ch + 1] = payload[ch];
+      });
+
+      if (config.output !== "changes") {
+        data?.set(universe, processedPayload);
+      }
+
+      return processedPayload;
+    };
+
+    // init sacn receiver
     let sACN: Receiver;
-    if (config.mode === "passthrough") {
-      sACN = new Receiver(options);
-    } else if (config.mode === "ltp" || config.mode === "htp") {
-      (options as MergingReceiver.Props).mode = config.mode.toUpperCase() as "HTP" | "LTP";
-      sACN = new MergingReceiver(options);
-    } else {
-      throw new Error("[node-red-sacn] None or invalid mode selected.");
+    switch (config.mode) {
+      case "passthrough":
+        sACN = new Receiver(options);
+        break;
+      case "htp":
+      case "ltp":
+        (options as MergingReceiver.Props).mode = config.mode.toUpperCase() as "HTP" | "LTP";
+        sACN = new MergingReceiver(options);
+        break;
+      default:
+        throw new Error("[node-red-sacn] None or invalid mode selected.");
     }
 
+    // run cleanup when node is closed
     this.on("close", () => {
       // close all connections; terminate the receiver
       sACN.close();
+
+      data = new Map();
     });
 
+    // handle sacn packets
     if (config.mode === "passthrough") {
       sACN.on("packet", (packet) => {
         this.send({
           universe: packet.universe,
-          payload: incrementPayload(packet.payload),
+          payload: parsePayload(packet.payload, packet.universe),
           sequence: packet.sequence,
           source: packet.sourceAddress,
           priority: packet.priority,
@@ -72,7 +120,7 @@ const nodeInit: NodeInitializer = (RED): void => {
           // @ts-expect-error // TODO https://github.com/k-yle/sACN/pull/63
           universe: data.universe,
           // @ts-expect-error // TODO https://github.com/k-yle/sACN/pull/63
-          payload: incrementPayload(data.payload),
+          payload: parsePayload(data.payload, data.universe),
         } as SacnInMessage);
       });
     } else if (config.mode === "htp") {
@@ -82,23 +130,12 @@ const nodeInit: NodeInitializer = (RED): void => {
           // @ts-expect-error // TODO https://github.com/k-yle/sACN/pull/63
           universe: data.universe,
           // @ts-expect-error // TODO https://github.com/k-yle/sACN/pull/63
-          payload: incrementPayload(data.payload),
+          payload: parsePayload(data.payload, data.universe),
         } as SacnInMessage);
       });
     }
   }
 
-  function incrementPayload(payload: DMXValues): DMXValues {
-    const result: DMXValues = {};
-
-    Object.keys(payload).forEach((key) => {
-      const ch = parseInt(key, 10);
-      result[ch + 1] = payload[ch];
-    });
-
-    return result;
-  }
-
   RED.nodes.registerType("sacn_in", SacnInNodeConstructor);
 };