changes: major changes to the way deltas are flattened

Author: sbender9

README.md

@@ -21,24 +21,25 @@ See the examples folder for some sample usage.
 
 ## signalk-on-delta
 
-Input that sends messages for every delta the server receives
+Input that sends messages for every delta the server receives. Optionally flatten the deltas (see signalk-flatten-delta below)
 
 ## signalk-subscribe
 
-Input that sends messages for every delta from the given path
+Input that sends messages for every delta from the configured path. Optionally flatten the deltas (see signalk-flatten-delta below)
 
 ## signalk-flatten-delta
 
 Function that flatten deltas from signalk-on-delta.
 
-The output payload with be have path, value, source and context:
+The output payload will be the value and the topic will be the path, The payload will also include context, $source, and source.
 
 ```
 {
-  "path":"navigation.speedOverGround",
-  "value":2.45,
-  "source":{"label":"actisense","type":"NMEA2000","pgn":129026,"src":"3",
-  "context": "vessels.self"
+  "topic": "navigation.speedOverGround",
+  "payload": 2.45,
+  "source": {"label":"actisense","type":"NMEA2000","pgn":129026,"src":"3"},
+  "context": "vessels.self",
+  "$source": "actisense.3"
 }
 ```
 

examples/adjust-depth.json

@@ -1 +1 @@
-[{"id":"8bdea88.abe9658","type":"tab","label":"Flow 1","disabled":false,"info":""},{"id":"dfa58004.e5628","type":"signalk-on-delta","z":"8bdea88.abe9658","name":"","x":100,"y":60,"wires":[["14c76be4.78a604"]]},{"id":"14c76be4.78a604","type":"signalk-flatten-delta","z":"8bdea88.abe9658","name":"","x":240,"y":120,"wires":[["e311e40f.fad3b8"]]},{"id":"e311e40f.fad3b8","type":"switch","z":"8bdea88.abe9658","name":"if vessels.self","property":"payload.context","propertyType":"msg","rules":[{"t":"eq","v":"vessels.self","vt":"str"}],"checkall":"true","repair":false,"outputs":1,"x":370,"y":180,"wires":[["fdeb876e.0b0c6"]]},{"id":"fdeb876e.0b0c6","type":"switch","z":"8bdea88.abe9658","name":"if  depth.belowSurface","property":"payload.path","propertyType":"msg","rules":[{"t":"eq","v":"environment.depth.belowSurface","vt":"str"}],"checkall":"true","repair":false,"outputs":1,"x":540,"y":240,"wires":[["ca4ac3ec.4bba3"]]},{"id":"ca4ac3ec.4bba3","type":"change","z":"8bdea88.abe9658","name":"Add 1.0","rules":[{"t":"set","p":"payload","pt":"msg","to":"{ \"path\": payload.path, \"value\": payload.value +  1.0}","tot":"jsonata"}],"action":"","property":"","from":"","to":"","reg":false,"x":600,"y":320,"wires":[["e1a68487.819c28"]]},{"id":"e1a68487.819c28","type":"signalk-send-pathvalue","z":"8bdea88.abe9658","name":"","x":620,"y":420,"wires":[]}]
+[{"id":"8bdea88.abe9658","type":"tab","label":"Flow 1","disabled":false,"info":""},{"id":"ca4ac3ec.4bba3","type":"change","z":"8bdea88.abe9658","name":"Add 1.0","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload +  1.0","tot":"jsonata"}],"action":"","property":"","from":"","to":"","reg":false,"x":420,"y":60,"wires":[["e1a68487.819c28"]]},{"id":"e1a68487.819c28","type":"signalk-send-pathvalue","z":"8bdea88.abe9658","name":"","x":630,"y":60,"wires":[]},{"id":"298fb1f.153a74e","type":"signalk-subscribe","z":"8bdea88.abe9658","name":"environment.depth.belowSurface","flatten":true,"context":"vessels.self","path":"environment.depth.belowSurface","period":1000,"x":170,"y":60,"wires":[["ca4ac3ec.4bba3"]]}]

examples/high-wind-speed-alarm.json

@@ -1 +1 @@
-[{"id":"38336563.2cc8e2","type":"tab","label":"Flow 2","disabled":false,"info":""},{"id":"131f22b7.c357fd","type":"signalk-on-delta","z":"38336563.2cc8e2","name":"","x":120,"y":140,"wires":[["15b745ec.13bfca"]]},{"id":"d212f3ad.6ac1b","type":"switch","z":"38336563.2cc8e2","name":"if wind speed","property":"payload.path","propertyType":"msg","rules":[{"t":"eq","v":"environment.wind.speedApparent","vt":"str"}],"checkall":"true","repair":false,"outputs":1,"x":550,"y":140,"wires":[["2d45410c.6ca7ae"]]},{"id":"2d45410c.6ca7ae","type":"switch","z":"38336563.2cc8e2","name":"","property":"payload.value","propertyType":"msg","rules":[{"t":"gt","v":"5.14","vt":"str"},{"t":"lte","v":"5.14","vt":"str"}],"checkall":"true","repair":false,"outputs":2,"x":470,"y":320,"wires":[["a5b5aa6.69c9258"],["14796038.fb8e78"]]},{"id":"15b745ec.13bfca","type":"signalk-flatten-delta","z":"38336563.2cc8e2","name":"","x":340,"y":140,"wires":[["d212f3ad.6ac1b"]]},{"id":"a5b5aa6.69c9258","type":"signalk-send-notification","z":"38336563.2cc8e2","name":"send alarm","path":"highWindSpeed","state":"alarm","message":"The wind speed is over 10 knots","visual":true,"sound":true,"x":650,"y":280,"wires":[]},{"id":"14796038.fb8e78","type":"signalk-send-notification","z":"38336563.2cc8e2","name":"clear alarm","path":"highWindSpeed","state":"normal","message":"The wind speed is normal","visual":true,"sound":true,"x":650,"y":380,"wires":[]}]
+[{"id":"38336563.2cc8e2","type":"tab","label":"Flow 2","disabled":false,"info":""},{"id":"2d45410c.6ca7ae","type":"switch","z":"38336563.2cc8e2","name":"if over 5.14","property":"payload","propertyType":"msg","rules":[{"t":"gt","v":"5.14","vt":"str"},{"t":"lte","v":"5.14","vt":"str"}],"checkall":"true","repair":false,"outputs":2,"x":430,"y":100,"wires":[["a5b5aa6.69c9258"],["14796038.fb8e78"]]},{"id":"a5b5aa6.69c9258","type":"signalk-send-notification","z":"38336563.2cc8e2","name":"send alarm","path":"highWindSpeed","state":"alarm","message":"The wind speed is over 10 knots","visual":true,"sound":true,"x":630,"y":60,"wires":[]},{"id":"14796038.fb8e78","type":"signalk-send-notification","z":"38336563.2cc8e2","name":"clear alarm","path":"highWindSpeed","state":"normal","message":"The wind speed is normal","visual":true,"sound":true,"x":630,"y":160,"wires":[]},{"id":"ef25bd1f.baa4b","type":"signalk-subscribe","z":"38336563.2cc8e2","name":"environment.wind.speedApparent","flatten":true,"context":"vessels.self","path":"environment.wind.speedApparent","period":"5000","x":180,"y":100,"wires":[["2d45410c.6ca7ae"]]}]

package.json

@@ -10,6 +10,7 @@
   "license": "Apache-2.0",
   "node-red": {
     "nodes": {
+      "signalk-subscribe": "signalk-subscribe.js",
       "signalk-on-delta": "signalk-on-delta.js",
       "signalk-notification-": "signalk-notification.js",
       "signalk-flatten-delta": "signalk-flatten-delta.js",
@@ -18,8 +19,7 @@
       "signalk-send-put": "signalk-send-put.js",
       "signalk-send-notification": "signalk-send-notification.js",
       "signalk-send-nmea2000": "signalk-send-nmea2000.js",
-      "signalk-send-nmea0183": "signalk-send-nmea0183.js",
-      "signalk-subscribe": "signalk-subscribe.js"
+      "signalk-send-nmea0183": "signalk-send-nmea0183.js"
     }
   }
 }

screens/adjust-depth.jpeg

@@ -24,14 +24,15 @@
 <script type="text/x-red" data-help-name="signalk-flatten-delta">
   <p>Function that flatten deltas from signalk-on-delta.</p>
 
-  <p>The output payload with be have path, value, source and context:</p>
+  <p>The output payload will be the value and the topic will be the path, The payload will also include context, $source, and source. </p>
 
 <pre><code class="javascript">
-{
-  "path":"navigation.speedOverGround",
-  "value":2.45,
-  "source":{"label":"actisense","type":"NMEA2000","pgn":129026,"src":"3",
-  "context": "vessels.self"
-}
+  {
+    "topic": "navigation.speedOverGround",
+    "payload": 2.45,
+    "source": {"label":"actisense","type":"NMEA2000","pgn":129026,"src":"3"},
+    "context": "vessels.self",
+    "$source": "actisense.3"
+  }
 </code></pre>
 </script>

screens/high-wind-speed-alarm.jpeg

@@ -10,10 +10,13 @@ module.exports = function(RED) {
         delta.updates.forEach(update => {
           if ( update.values ) {
             update.values.forEach(pathValue => {
-              pathValue.$source = update.$source
-              pathValue.source = update.source
-              pathValue.context = delta.context
-              node.send({ payload: pathValue, topic: pathValue.path})
+              node.send({
+                $source: update.$source,
+                source: update.source,
+                context: delta.context,
+                payload: pathValue.value,
+                topic: pathValue.path
+              })
             })
           }
         })

signalk-flatten-delta.html

@@ -3,7 +3,9 @@
         category: 'input',
         color: '#ffcc01',
         defaults: {
-            name: {value:""}
+          name: {value:""},
+          context: {value: "vessels.self"},
+          flatten: {value: true},
         },
         inputs:0,
         outputs:1,
@@ -15,10 +17,18 @@
 </script>
 
 <script type="text/x-red" data-template-name="signalk-on-delta">
-    <div class="form-row">
+  <div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
-    </div>
+  </div>
+  <div class="form-row">
+        <label for="node-input-context"><i class="icon-tag"></i> Context</label>
+        <input type="text" id="node-input-context" placeholder="Context">
+  </div>
+  <div class="form-row">
+        <label for="node-input-flatten"><i class="icon-tag"></i> Flatten</label>
+        <input type="checkbox" id="node-input-flatten" placeholder="Flatten">
+  </div>
 </script>
 
 <script type="text/x-red" data-help-name="signalk-on-delta">

signalk-flatten-delta.js

@@ -9,20 +9,41 @@ module.exports = function(RED) {
 
     function on_delta(delta) {
       if ( delta.updates ) {
-        var copy = JSON.parse(JSON.stringify(delta))
-        copy.updates = []
-        delta.updates.forEach(update => {
-          if ( update.values &&
-               (!update.$source || !update.$source.startsWith('signalk-node-red') )) {
-            copy.updates.push(update)
+        if ( delta.context === config.context ||
+             (config.context === 'vessels.self' &&
+              delta.context == app.selfContext) ) {
+          if ( typeof config.flatten === 'undefined' || !config.flatten ) {
+            var copy = JSON.parse(JSON.stringify(delta))
+            copy.updates = []
+            delta.updates.forEach(update => {
+              if ( update.values &&
+                   (!update.$source || !update.$source.startsWith('signalk-node-red') )) {
+                copy.updates.push(update)
+              }
+            })
+            
+            if ( copy.updates.length > 0 ) {
+              if ( copy.context == app.selfContext ) {
+                copy.context = 'vessels.self'
+              }
+              node.send({ payload: copy })
+            }
+          } else {
+            delta.updates.forEach(update => {
+              if ( update.values &&
+                   (!update.$source || !update.$source.startsWith('signalk-node-red') )) {
+                update.values.forEach(pathValue => {
+                  node.send({
+                    $source: update.$source,
+                    source: update.source,
+                    context: delta.context == app.selfContext ? 'vessels.self' : delta.context,
+                    payload: pathValue.value,
+                    topic: pathValue.path
+                  })
+              })
+              }
+            })
           }
-        })
-
-        if ( copy.updates.length > 0 ) {
-          if ( copy.context == app.selfContext ) {
-            copy.context = 'vessels.self'
-          }
-          node.send({ payload: copy })
         }
       }
     }

signalk-on-delta.html

@@ -12,7 +12,10 @@ module.exports = function(RED) {
         updates: [
           {
             values: [
-              msg.payload
+              {
+                value: msg.payload,
+                path: msg.topic
+              }
             ]
           }
         ]

signalk-on-delta.js

@@ -4,6 +4,7 @@
         color: '#ffcc01',
         defaults: {
           name: {value:""},
+          flatten: {value: true},
           context: {value:"vessels.self"},
           path: {value:""},
           period: {value: 1000}
@@ -22,6 +23,10 @@
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
   </div>
+  <div class="form-row">
+        <label for="node-input-flatten"><i class="icon-tag"></i> Flatten</label>
+        <input type="checkbox" id="node-input-flatten" placeholder="Flatten">
+  </div>
   <div class="form-row">
         <label for="node-input-context"><i class="icon-tag"></i> Context</label>
         <input type="text" id="node-input-context" placeholder="Context">

signalk-send-pathvalue.js

@@ -25,20 +25,37 @@ module.exports = function(RED) {
 
     function on_delta(delta) {
       if ( delta.updates ) {
-        var copy = JSON.parse(JSON.stringify(delta))
-        copy.updates = []
-        delta.updates.forEach(update => {
-          if ( update.values &&
-               (!update.$source || !update.$source.startsWith('signalk-node-red') )) {
-            copy.updates.push(update)
+        if ( typeof config.flatten === 'undefined' || !config.flatten ) {
+          var copy = JSON.parse(JSON.stringify(delta))
+          copy.updates = []
+          delta.updates.forEach(update => {
+            if ( update.values &&
+                 (!update.$source || !update.$source.startsWith('signalk-node-red') )) {
+              copy.updates.push(update)
+            }
+          })
+          
+          if ( copy.updates.length > 0 ) {
+            if ( copy.context == app.selfContext ) {
+              copy.context = 'vessels.self'
+            }
+            node.send({ payload: copy })
           }
-        })
-
-        if ( copy.updates.length > 0 ) {
-          if ( copy.context == app.selfContext ) {
-            copy.context = 'vessels.self'
-          }
-          node.send({ payload: copy })
+        } else {
+          delta.updates.forEach(update => {
+            if ( update.values &&
+                 (!update.$source || !update.$source.startsWith('signalk-node-red') )) {
+              update.values.forEach(pathValue => {
+                node.send({
+                  $source: update.$source,
+                  source: update.source,
+                  context: delta.context == app.selfContext ? 'vessels.self' : delta.context,
+                  payload: pathValue.value,
+                  topic: pathValue.path
+                })
+              })
+            }
+          })
         }
       }
     }