node-red-contrib-ta-cmi-coe 1.0.0 → 1.1.1

package/coe/locales/de/config.json

@@ -2,7 +2,7 @@
     "config": {
         "label": {
             "name": "Name",
-            "localip": "Lokale IP",
+            "localip": "IP-Bereich",
             "address": "CMI Adresse",
             "coeVersion": "CoE Version"
         }

package/coe/locales/en-US/coe-input.html

@@ -2,9 +2,9 @@
     <p>Receives values from a TA CMI via CoE (CAN over Ethernet).</p>
     <h3>Configuration</h3>
     <ul>
-        <li><b>Node:</b> CAN node number (1-62, 0 = receive from any node, not recommended for production)</li>
+        <li><b>Node:</b> CAN node number (1-62, 0 = receive from any node; not recommended for production)</li>
         <li><b>Input:</b> Network input number (1-32)</li>
         <li><b>Data Type:</b> Analog (1-32) or Digital (1-32)</li>
-        <li><b>Timeout:</b> CAN-Bus timeout value in Minutes</li>
+        <li><b>Timeout:</b> CAN-Bus timeout (Value in minutes)</li>
     </ul>
 </script>

package/coe/locales/en-US/coe-input.json

@@ -2,7 +2,7 @@
     "coe-input": {
         "label": {
             "name": "Name",
-            "cmiconfig": "CMI Config",
+            "cmiconfig": "CMI",
             "nodeNumber": "Node",
             "outputNumber": "Input",
             "dataType": "Data Type",
@@ -13,7 +13,13 @@
         },
         "status": {
             "waiting": "waiting",
-            "waitingAny": "waiting (any node)"
+            "waitingAny": "waiting (any node)",
+            "open": "Open",
+            "closed": "Closed",
+            "on": "On",
+            "off": "Off",
+            "yes": "Yes",
+            "no": "No"
         }
     }
 }

package/coe/locales/en-US/coe-monitor.html

@@ -1,6 +1,5 @@
 <script type="text/html" data-help-name="coe-monitor">
-    <p>Receives and monitors CoE (CAN over Ethernet) packets from all sources.</p>
-    <p>Ideal for debugging, logging, and monitoring total CoE traffic.</p>
+    <p>Receives and monitors CoE (CAN over Ethernet) packets from all sources. Ideal for debugging, logging, and monitoring total CoE traffic.</p>
     <h3>Configuration</h3>
     <ul>
         <li>Optional: Filter packets from a specific CAN node only (0 = all)</li>

package/coe/locales/en-US/coe-monitor.json

@@ -2,7 +2,7 @@
     "coe-monitor": {
         "label": {
             "name": "Name",
-            "cmiconfig": "CMI Config",
+            "cmiconfig": "CMI",
             "filterNodeNumber": "Filter Node",
             "filterDataType": "Filter Type",
             "includeRaw": "Include Raw Data",
@@ -12,9 +12,14 @@
             "filterNodeNumber": "0 = all"
         },
         "status": {
-            "monitoring": "Monitoring...",
-            "idle": "Idle",
-            "node": "Node"
+            "monitoring": "Monitoring",
+            "node": "Node",
+            "open": "Open",
+            "closed": "Closed",
+            "on": "On",
+            "off": "Off",
+            "yes": "Yes",
+            "no": "No"
         }
     }
 }

package/coe/locales/en-US/coe-output.html

@@ -7,8 +7,14 @@
         <li><b>Data Type:</b> Analog (numeric) or Digital (boolean)</li>
         <li><b>Unit:</b> Measurement unit (analog only)</li>
     </ul>
+    <h3>Sending Conditions</h3>
+    <ul>
+        <li><b>If change >:</b> Retransmit only, if the current value has changed by more than this value (analog values)</li>
+        <li><b>Blocking Time:</b> Retransmit only, if time has passed (seconds)</li>
+        <li><b>Interval Time:</b> If value has not changed, retransmit after interval (minutes)</li>
+    </ul>
     <h3>Outputs</h3>
     <p><b>2 outputs:</b> [0] Message passthrough, [1] Debug info (Hex, Block-State, Units)</p>
-    <h3>Notes</h3>
-    <p>Values are buffered for 50ms to reduce message frequency.</p>
+    <h3>Note</h3>
+    <p>Values are buffered for 50 ms to reduce message frequency.</p>
 </script>

package/coe/locales/en-US/coe-output.json

@@ -2,17 +2,23 @@
     "coe-output": {
         "label": {
             "name": "Name",
-            "cmiconfig": "CMI Config",
+            "cmiconfig": "CMI",
             "nodeNumber": "Node",
             "outputNumber": "Output",
             "dataType": "Data Type",
-            "unit": "Unit"
+            "unit": "Unit",
+            "sendConditions": "Sending Conditions:",
+            "minChange": "If change >",
+            "blockingTime": "Blocking Time (Sec)",
+            "maxInterval": "Interval Time (Min)"
         },
         "status": {
             "noconfig": "No config",
             "queued": "queued",
-            "ready": "ready",
-            "merged": "sent (merged)"
+            "ready": "Ready",
+            "merged": "Sent",
+            "retransmit": "Resent",
+            "blocked": "Blocked"
         }
     }
 }

package/coe/locales/en-US/config.html

@@ -1,13 +1,13 @@
 <script type="text/html" data-help-name="cmiconfig">
     <p><strong>Configuration:</strong></p>
     <ul>
-        <li><b> Local IP:</b> IP Address range the UDP Port is listening on (Common values are 0.0.0.0 or 127.0.0.1)</li>
+        <li><b> IP Range:</b> IP Address range the UDP Port is listening on (Common values are 0.0.0.0 or 127.0.0.1)</li>
         <li><b> Address:</b> IP Address of TA C.M.I used for sending CoE messages</li>
     </ul>
     <p><strong>CoE Version:</strong></p>
     <ul>
-        <li><b>V1:</b> Default setting. Value range: ±32,767</li>
-        <li><b>V2:</b> Extended, requires CMI FW ≥v1.43.1. Value range: ±2,147,483,647</li>
+        <li><b>Version 1:</b> Default setting. Value range: ± 32,767</li>
+        <li><b>Version 2:</b> Extended, requires CMI FW ≥ v1.43.1. Value range: ± 2,147,483,647</li>
     </ul>
     <p>See Settings > CAN in the CMI menu.</p>
 </script>

package/coe/locales/en-US/config.json

@@ -2,7 +2,7 @@
     "config": {
         "label": {
             "name": "Name",
-            "localip": "Local IP",
+            "localip": "IP Range",
             "address": "CMI Address",
             "coeVersion": "CoE Version"
         }

package/coe/units-config.js

@@ -26,7 +26,8 @@ module.exports = function(RED) {
             localizedUnits[key] = {
                 name: lang === "de" ? unit.name_de : unit.name_en,
                 symb: lang === "de" ? unit.symb_de : unit.symb_en,
-                decimals: unit.decimals
+                decimals: unit.decimals,
+                digital: unit.digital ? true : false
             };
         });
 

package/examples/in-out.json

@@ -0,0 +1,56 @@
+[
+    {
+        "id": "mycmi",
+        "type": "cmiconfig",
+        "name": "My CMI",
+        "localip": "0.0.0.0",
+        "address": "192.168.0.100",
+        "coeVersion": 1
+    },
+    {
+        "id": "input_example",
+        "type": "coe-input",
+        "name": "Temperature Sensor",
+        "cmiconfig": "mycmi",
+        "nodeNumber": 10,
+        "outputNumber": 1,
+        "dataType": "analog",
+        "timeout": 20,
+        "x": 150,
+        "y": 100,
+        "wires": [["debug123"]]
+    },
+    {
+        "id": "debug123",
+        "type": "debug",
+        "name": "Message",
+        "x": 350,
+        "y": 100
+    },
+    {
+        "id": "inject1",
+        "type": "inject",
+        "name": "Set Target Value",
+        "payload": "22.5",
+        "payloadType": "num",
+        "repeat": "",
+        "x": 150,
+        "y": 200,
+        "wires": [["output_example"]]
+    },
+    {
+        "id": "output_example",
+        "type": "coe-output",
+        "name": "Target Value Heating",
+        "cmiconfig": "mycmi",
+        "nodeNumber": 11,
+        "outputNumber": 5,
+        "dataType": "analog",
+        "unit": 1,
+        "minChange": 1,
+        "blockingTime": 10,
+        "maxInterval": 5,
+        "x": 350,
+        "y": 200
+    }
+]

package/examples/monitor.json

@@ -0,0 +1,42 @@
+[
+    {
+        "id": "monitor_example",
+        "type": "coe-monitor",
+        "name": "CoE Monitor",
+        "cmiconfig": "mycmi",
+        "filterNodeNumber": 0,
+        "filterDataType": "all",
+        "includeRaw": false,
+        "x": 250,
+        "y": 100,
+        "wires": [
+            [
+                "monitor_debug"
+            ]
+        ]
+    },
+    {
+        "id": "monitor_debug",
+        "type": "debug",
+        "name": "Debug Monitor",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 450,
+        "y": 100,
+        "wires": []
+    },
+    {
+        "id": "mycmi",
+        "type": "cmiconfig",
+        "name": "My CMI",
+        "localip": "0.0.0.0",
+        "address": "192.168.0.100",
+        "coeVersion": 1
+    }
+]

package/lib/coe-v1.js

@@ -0,0 +1,152 @@
+/**
+ * CoE V1 Protocol Support Module
+ * 
+ * Copyright 2025 Florian Mayrhofer
+ * Licensed under the Apache License, Version 2.0
+ *
+ */ 
+
+const { getOutputsfromBlock, getBlockInfo, convertRawToValue, convertValueToRaw } = require('./utils');
+
+// CoE V1 Parse message from buffer
+function parsePacket(buffer) {
+
+    if (buffer.length !== 14) {
+        console.warn(`Received CoE packet with incorrect length of ${buffer.length} bytes (v1).`);
+        return null;
+    }
+
+    // Parse header
+    const nodeNumber = buffer.readUInt8(0);
+    const blockNumber = buffer.readUInt8(1);
+    
+    let values = [];
+    let units = [];
+    
+    if (blockNumber === 0 || blockNumber === 9) {
+        // digital
+        const bitField = buffer.readUInt16LE(2);
+        const unitId = buffer.readUInt8(11); // Block-wise unit id → byte 11
+        for (let i = 0; i < 16; i++) {
+            values.push((bitField >> i) & 1);
+            units.push(unitId);
+        }
+    } else {
+        // analog
+        for (let i = 0; i < 4; i++) {
+            const value = buffer.readInt16LE(2 + i * 2);
+            const unitId = buffer.readUInt8(10 + i);
+            
+            const convertedValue = convertRawToValue(value, unitId, 1); // V1 decimals
+            values.push(convertedValue);
+            units.push(unitId);
+        }
+    }
+    
+    const valueBlock = {
+        nodeNumber: nodeNumber,
+        blockNumber: blockNumber,
+        values: values,
+        units: units
+    };
+
+    return convertV1ToUniformFormat(valueBlock);
+}
+
+// Convert V1 data into Uniform format
+function convertV1ToUniformFormat(valueBlock) {
+    const blockNumber = valueBlock.blockNumber;
+    const dataType = (blockNumber === 0 || blockNumber === 9) ? 'digital' : 'analog';
+    const outputNumbers = getOutputsfromBlock(blockNumber, dataType);
+    
+    // Create outputs object
+    const outputs = {}; 
+    
+    for (let i = 0; i < outputNumbers.length; i++) { 
+        const outputNumber = outputNumbers[i]; 
+
+        outputs[outputNumber] = { 
+            value: valueBlock.values[i], 
+            unit: valueBlock.units[i] 
+        }; 
+    } 
+
+    return [{ nodeNumber: valueBlock.nodeNumber, blockNumber, dataType, outputs }];
+}
+
+// Create CoE Packet from values
+function createPacket(nodeNumber, dataType, outputs) {
+    let buffer;
+    const blockState = convertUniformToV1Format(dataType, outputs);
+    const blockNumber = parseInt(Object.keys(blockState)[0], 10);
+    const blockData = blockState[Object.keys(blockState)[0]];
+
+    if (dataType === 'digital') {
+        buffer = Buffer.alloc(14);
+        buffer.writeUInt8(nodeNumber, 0);
+        buffer.writeUInt8(blockNumber, 1);
+       
+        let bitField = 0;
+        for (let i = 0; i < 16; i++) {
+            if (blockData.values[i]) {
+                bitField |= (1 << i);
+            }
+        }
+        buffer.writeUInt16LE(bitField, 2);
+        buffer.fill(0, 4, buffer.length);
+        
+    } else { // analog
+        buffer = Buffer.alloc(14);
+        buffer.writeUInt8(nodeNumber, 0);
+        buffer.writeUInt8(blockNumber, 1);
+        
+        for (let i = 0; i < 4; i++) {
+            const unitId = blockData.units ? blockData.units[i] : 0;
+            const rawValue = convertValueToRaw(blockData.values[i], unitId, 1); // V1 Decimal places
+
+            if (rawValue > 32767 || rawValue < -32768) {
+                console.warn(`Value ${blockData.values[i]} exceeds V1 limits. Consider using V2.`);
+            }
+            
+            buffer.writeInt16LE(Math.max(-32768, Math.min(32767, rawValue)), 2 + i * 2);
+            buffer.writeUInt8(unitId, 10 + i);
+        }
+    }
+    
+    return buffer;
+}
+
+// Convert Uniform into V1 format
+function convertUniformToV1Format(dataType, outputs) {
+    // Group Outputs by block
+    const blockState = {};
+    
+    Object.entries(outputs).forEach(([outputKey, output]) => {
+        const isDigital = dataType === 'digital';
+        const outputNumber = parseInt(outputKey);
+        
+        // Determine block number and position
+        const block = getBlockInfo(dataType, outputNumber); 
+        const blockKey = block.number;
+        
+        if (!blockState[blockKey]) {
+            blockState[blockKey] = {
+                values: isDigital ? new Array(16).fill(undefined) : new Array(4).fill(undefined),
+                units: isDigital ? new Array(16).fill(undefined) : new Array(4).fill(undefined)
+            };
+        }
+        
+        // Convert value & insert
+        blockState[blockKey].values[block.position] = isDigital ? (output.value ? 1 : 0) : output.value;
+        
+        if (blockState[blockKey].units) {
+            blockState[blockKey].units[block.position] = output.unit;
+        }
+    });
+    return blockState;
+}
+
+module.exports = { 
+    parsePacket, 
+    createPacket
+};