@thingwala/node-red-contrib-geyserwala-connect 0.0.4 → 0.0.6

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log - Geyserwala Connect - Node-RED Plugin
+
+## [0.0.6] - 2024-01-06
+
+Fix import flows from older versions
+
+## [0.0.5] - 2023-12-20
+
+Allow for custom signals
+
+### Added
+- Custom node.
+
+## [0.0.4] - 2023-12-05
+
+Migrate to persistent latch signals, with programmable hold time
+
+### Added
+- `external-disable` signal, accepts integer of number or seconds to latch, or true (defaults to 24 hours). Zero/false will clear.
+
+### Changed
+- naming to geyserwala-connect-...
+- `external-demand` signal: accepts integer of number of seconds to latch, or true (defaults to 24 hours). Zero/false will clear.
+
+### Removed
+- `lowpower-enable`: replaced by `external-disable`.
+
+## [0.0.3] - 2023-09-01
+
+Initial development

package/examples/Victron_OS_Large_BMS_SoC.json

@@ -0,0 +1,220 @@
+[
+    {
+        "id": "ca3352fdbb2d931a",
+        "type": "tab",
+        "label": "Geyserwala - BMS SoC",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "29a73b429a4838ca",
+        "type": "victron-input-battery",
+        "z": "ca3352fdbb2d931a",
+        "service": "com.victronenergy.battery/512",
+        "path": "/Soc",
+        "serviceObj": {
+            "service": "com.victronenergy.battery/512",
+            "name": "SS4143   BMS-EX"
+        },
+        "pathObj": {
+            "path": "/Soc",
+            "type": "float",
+            "name": "State of charge (%)"
+        },
+        "name": "",
+        "onlyChanges": false,
+        "x": 190,
+        "y": 160,
+        "wires": [
+            [
+                "0399d69c01f87a48"
+            ]
+        ]
+    },
+    {
+        "id": "3d2a53f1b12d9675",
+        "type": "geyserwala-connect-external-disable",
+        "z": "ca3352fdbb2d931a",
+        "name": "External Disable",
+        "geyserwalaApi": "20dd980fafe6ca2e",
+        "x": 580,
+        "y": 240,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "562e3bc5f100a612",
+        "type": "switch",
+        "z": "ca3352fdbb2d931a",
+        "name": "90%",
+        "property": "payload",
+        "propertyType": "msg",
+        "rules": [
+            {
+                "t": "gte",
+                "v": "90",
+                "vt": "str"
+            },
+            {
+                "t": "lt",
+                "v": "90",
+                "vt": "str"
+            }
+        ],
+        "checkall": "true",
+        "repair": false,
+        "outputs": 2,
+        "x": 270,
+        "y": 240,
+        "wires": [
+            [
+                "d5a7a12a701ab13c"
+            ],
+            [
+                "d31b6ddda17ef2fc"
+            ]
+        ]
+    },
+    {
+        "id": "d31b6ddda17ef2fc",
+        "type": "change",
+        "z": "ca3352fdbb2d931a",
+        "name": "true",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "true",
+                "tot": "bool"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 410,
+        "y": 260,
+        "wires": [
+            [
+                "3d2a53f1b12d9675"
+            ]
+        ]
+    },
+    {
+        "id": "d5a7a12a701ab13c",
+        "type": "change",
+        "z": "ca3352fdbb2d931a",
+        "name": "false",
+        "rules": [
+            {
+                "t": "set",
+                "p": "payload",
+                "pt": "msg",
+                "to": "false",
+                "tot": "bool"
+            }
+        ],
+        "action": "",
+        "property": "",
+        "from": "",
+        "to": "",
+        "reg": false,
+        "x": 410,
+        "y": 220,
+        "wires": [
+            [
+                "3d2a53f1b12d9675"
+            ]
+        ]
+    },
+    {
+        "id": "0399d69c01f87a48",
+        "type": "rbe",
+        "z": "ca3352fdbb2d931a",
+        "name": "",
+        "func": "rbe",
+        "gap": "",
+        "start": "",
+        "inout": "out",
+        "septopics": true,
+        "property": "payload",
+        "topi": "topic",
+        "x": 150,
+        "y": 240,
+        "wires": [
+            [
+                "562e3bc5f100a612"
+            ]
+        ]
+    },
+    {
+        "id": "f1e662c9433dcab2",
+        "type": "inject",
+        "z": "ca3352fdbb2d931a",
+        "name": "true",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "true",
+        "payloadType": "bool",
+        "x": 410,
+        "y": 320,
+        "wires": [
+            [
+                "3d2a53f1b12d9675"
+            ]
+        ]
+    },
+    {
+        "id": "e9867b4f5d12423a",
+        "type": "inject",
+        "z": "ca3352fdbb2d931a",
+        "name": "false",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "false",
+        "payloadType": "bool",
+        "x": 410,
+        "y": 360,
+        "wires": [
+            [
+                "3d2a53f1b12d9675"
+            ]
+        ]
+    },
+    {
+        "id": "20dd980fafe6ca2e",
+        "type": "geyserwala-connect-api",
+        "name": "Geyserwala",
+        "api": "REST",
+        "mqttBroker": "",
+        "mqttTopicTemplate": "geyserwala/%prefix%/%mac%",
+        "mqttTopicMac": "",
+        "mqttTopicIp": "",
+        "mqttTopicHostname": "",
+        "restHost": "10.0.0.51",
+        "restPort": "80",
+        "restUser": "admin",
+        "restPassword": "",
+        "restPollInterval": "10"
+    }
+]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thingwala/node-red-contrib-geyserwala-connect",
-    "version": "0.0.4",
+    "version": "0.0.6",
     "description": "Node-RED nodes for the Geyserwala Connect",
     "author": "Thingwala",
     "license": "MIT",

package/src/nodes/geyserwala-api-mqtt.js

@@ -27,7 +27,7 @@ class GeyserwalaConnectorMqtt {
                 try {
                     this.subscriptions[topic](payload)
                 } catch (error) {
-                    this.RED.log.error(`{Geyserwala Connect} Handling subscription: ${error.message}`);
+                    this.RED.log.error(`{Geyserwala Connect} Handling messsage: ${error.message}`);
                 }
             });
 

package/src/nodes/geyserwala-api.html

@@ -7,7 +7,7 @@
 
             api: { value: "MQTT", requred: true },
 
-            mqttBroker: { type: "mqtt-broker" },
+            mqttBroker: { type: "mqtt-broker", required: false },
             mqttPubQos: { value: 0 },
             mqttRetain: { value: false },
             mqttTopicTemplate: { value: "geyserwala/%prefix%/%mac%" },

package/src/nodes/geyserwala-api.js

@@ -1,30 +1,32 @@
 
 module.exports = function (RED) {
-    function Node(config) {
-        RED.nodes.createNode(this, config);
+    class Node {
+        constructor (config) {
+            RED.nodes.createNode(this, config);
 
-        if (config.api == 'MQTT') {
-            const GeyserwalaConnectorMqtt = require('./geyserwala-api-mqtt');
+            if (config.api == 'MQTT') {
+                const GeyserwalaConnectorMqtt = require('./geyserwala-api-mqtt');
 
-            this.api = new GeyserwalaConnectorMqtt(RED,
-                RED.nodes.getNode(config.mqttBroker),
-                config.mqttPubQos,
-                config.mqttRetain,
-                config.mqttTopicTemplate,
-                config.mqttTopicMac,
-                config.mqttTopicIP,
-                config.mqttTopicHostname
-            );
-        } else if (config.api == "REST") {
-            const GeyserwalaConnectorRest = require('./geyserwala-api-rest');
+                this.api = new GeyserwalaConnectorMqtt(RED,
+                    RED.nodes.getNode(config.mqttBroker),
+                    config.mqttPubQos,
+                    config.mqttRetain,
+                    config.mqttTopicTemplate,
+                    config.mqttTopicMac,
+                    config.mqttTopicIP,
+                    config.mqttTopicHostname
+                );
+            } else if (config.api == "REST") {
+                const GeyserwalaConnectorRest = require('./geyserwala-api-rest');
 
-            this.api = new GeyserwalaConnectorRest(RED,
-                config.restHost,
-                config.restPort,
-                config.restUser,
-                config.restPassword,
-                config.restPollInterval,
-            )
+                this.api = new GeyserwalaConnectorRest(RED,
+                    config.restHost,
+                    config.restPort,
+                    config.restUser,
+                    config.restPassword,
+                    config.restPollInterval,
+                )
+            }
         }
     }
     RED.nodes.registerType("geyserwala-connect-api", Node);

package/src/nodes/geyserwala-nodes.html

@@ -12,50 +12,129 @@
     </div>
 </script>
 
+<script type="text/template" id="node-input-value-template">
+    <fieldset id="node-input-value">
+        <legend>Value</legend>
+        <div class="form-row">
+            <label for="node-input-valueType"><i class="fa fa-cube"></i> Type</label>
+            <select id="node-input-valueType" style="width:25%;">
+                <option value="">Undefined</option>
+                <option value="Boolean">Boolean</option>
+                <option value="Number">Number</option>
+                <option value="String">String</option>
+            </select>
+        </div>
+        <div class="form-row">
+            <label for="node-input-valueKey"><i class="fa fa-hashtag"></i> Key</label>
+            <input type="text" id="node-input-valueKey" placeholder="Key">
+        </div>
+    </fieldset>
+</script>
+
 <script type="text/javascript">
-    function addInputDialog(valueKey, nodeLabel) {
+    function addInputDialog(node) {
         var nodeInput = $("#node-input-template").clone().html();
 
-        var scriptTag = $("<script>").attr("type", "text/x-red").attr("data-template-name", `geyserwala-connect-${valueKey}`).append(nodeInput);
-        scriptTag.find('#title').text(`Geyserwala Connect : ${nodeLabel}`);
+        if (node.type === null) {
+            var nodeInputValue = $("#node-input-value-template").clone().html();
+            console.log(typeof nodeInput)
+            nodeInput += nodeInputValue
+        }
+
+        var scriptTag = $("<script>").attr("type", "text/x-red").attr("data-template-name", `geyserwala-connect-${node.key}`).append(nodeInput);
+        scriptTag.find('#title').text(`Geyserwala Connect : ${node.name}`);
         $('body').append(scriptTag.prop('outerHTML'));
     }
 
-    function registerType(valueKey, nodeLabel, icon, input) {
-        addInputDialog(valueKey, nodeLabel)
+    function _registerNode(node) {
+        addInputDialog(node)
 
-        RED.nodes.registerType(`geyserwala-connect-${valueKey}`, {
+        RED.nodes.registerType(`geyserwala-connect-${node.key}`, {
             category: 'Geyserwala Connect',
-            paletteLabel: nodeLabel,
+            paletteLabel: node.name,
             defaults: {
-                name: { value: nodeLabel },
+                name: { value: node.name },
                 geyserwalaApi: { type: "geyserwala-connect-api", required: true },
+                valueKey: { value: undefined },
+                valueType: { value: undefined },
             },
-            inputs: input ? 1 : 0,
+            inputs: node.input ? 1 : 0,
             outputs: 1,
             color: "#00A9E0",
-            icon: icon,
+            icon: node.icon,
             label: function () {
                 return this.name;
             }
         });
     }
 
+    function registerNode(key, name, type, icon, input) {
+        _registerNode({key: key, name: name, type: type, icon: icon, input: input})
+    }
+
     // Icons: https://fontawesome.com/v4/icons/
-    registerType('status', "Status", "font-awesome/fa-envelope-o", false);
-    registerType('mode', "Mode", "font-awesome/fa-info", true);
+    registerNode("status", "Status", String, "font-awesome/fa-envelope-o", false)
+    registerNode("mode", "Mode", String, "font-awesome/fa-sliders", true)
+    registerNode("tank-temp", "Tank Temp", Number, "font-awesome/fa-thermometer-half", false)
+    registerNode("element-demand", "Element Demand", Boolean, "font-awesome/fa-fire", false)
+    registerNode("external-setpoint", "External Setpoint", Number, "inject.png", true)
+    registerNode("external-demand", "External Demand", Number, "serial.png", true)
+    registerNode("external-disable", "External Disable", Number, "font-awesome/fa-stop-circle-o", true)
+    registerNode("setpoint", "Setpoint", Number, "inject.png", true)
+    registerNode("boost-demand", "Boost Demand", Boolean, "font-awesome/fa-power-off", true)
+    registerNode("collector-temp", "Collector Temp", Number, "font-awesome/fa-thermometer-half", false)
+    registerNode("pump-status", "Pump Status", Boolean, "font-awesome/fa-recycle", false)
+    registerNode("custom-io", "Custom", null, "font-awesome/fa-cogs", true)
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-status">
+    <p></p>
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-mode">
+    <p></p>
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-tank-temp">
+    <p></p>
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-element-demand">
+    <p></p>
+</script>
 
-    registerType('tank-temp', "Tank Temp", "font-awesome/fa-thermometer-half", false);
-    registerType('element-demand', "Element Demand", "font-awesome/fa-fire", false);
+<script type="text/x-red" data-help-name="geyserwala-connect-element-demand">
+    <p></p>
+</script>
 
-    registerType('external-setpoint', "External Setpoint", "inject.png", true);
-    registerType('external-demand', "External Demand", "serial.png", true);
-    registerType('external-disable', "External Disable", "font-awesome/fa-stop-circle-o", true);
+<script type="text/x-red" data-help-name="geyserwala-connect-external-setpoint">
+    <p></p>
+</script>
 
-    registerType('setpoint', "Setpoint", "inject.png", true);
-    registerType('boost-demand', "Boost Demand", "font-awesome/fa-power-off", true);
+<script type="text/x-red" data-help-name="geyserwala-connect-external-demand">
+    <p></p>
+</script>
 
-    registerType('collector-temp', "Collector Temp", "font-awesome/fa-thermometer-half", false);
-    registerType('pump-status', "Pump Status", "font-awesome/fa-recycle", false);
+<script type="text/x-red" data-help-name="geyserwala-connect-external-disable">
+    <p></p>
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-setpoint">
+    <p></p>
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-boost-demand">
+    <p></p>
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-collector-temp">
+    <p></p>
+</script>
+
+<script type="text/x-red" data-help-name="geyserwala-connect-pump-status">
+    <p></p>
+</script>
 
+<script type="text/x-red" data-help-name="geyserwala-connect-custom-io">
+    <p></p>
 </script>

package/src/nodes/geyserwala-nodes.js

@@ -1,62 +1,75 @@
 module.exports = function (RED) {
-    function createNode (valueKey, type, input) {
-        function Node(config) {
-            RED.nodes.createNode(this, config);
-
-            var geyserwalaApi = RED.nodes.getNode(config.geyserwalaApi)
-            if (!geyserwalaApi) {
-                this.error('Connector not configured')
-                return
-            }
-            this.api = geyserwalaApi.api;
-            if (!geyserwalaApi.api) {
-                this.error('Invalid Connector')
-                return
-            }
+    function _registerNode (node) {
+        class Node {
+            constructor (config) {
+                RED.nodes.createNode(this, config);
 
-            this.api.registerNode(this)
-
-            this.api.subscribe(valueKey, type, (payload) => {
-                try {
-                    this.send({ topic: valueKey, payload: payload })
-                } catch (error) {
-                    RED.log.error(`{Geyserwala Connect} Outputing: ${error.message}`);
+                var geyserwalaApi = RED.nodes.getNode(config.geyserwalaApi)
+                if (!geyserwalaApi) {
+                    this.error('Configured connector invalid')
+                    return
+                }
+                this.api = geyserwalaApi.api;
+                if (!geyserwalaApi.api) {
+                    this.error('Connector not defined')
+                    return
                 }
-            });
-            this.on('close', () => {
-                this.api.unsubscribe(valueKey);
-                this.api.unregister(this);
-            });
 
-            if (input) {
+                this.api.registerNode(this)
+
+                const valueKey = node.type ? node.key :  config.valueKey
+                const valueType = node.type ? node.type : {
+                    "": String,
+                    "Boolean": Boolean,
+                    "Number": Number,
+                    "String": String,
+                }[config.valueType]
+
+                this.api.subscribe(valueKey, valueType, (payload) => {
+                    try {
+                        this.send({ topic: valueKey, payload: payload })
+                    } catch (error) {
+                        this.error(`Receiving "${valueKey}": ${error.message}`);
+                    }
+                });
+
+                this.on('close', () => {
+                    this.api.unsubscribe(node.valueKey);
+                    this.api.unregister(this);
+                });
+
                 this.on('input', function (message) {
                     try {
                         this.api.send(valueKey, message.payload)
                     } catch (error) {
-                        RED.log.error(`{Geyserwala Connect} Sending: ${error.message}`);
+                        this.error(`Sending "${valueKey}": ${error.message}`);
                     }
                 })
+
+                this.on('close', function () {
+                    this.api.unregister(this);
+                });
             }
-            this.on('close', function () {
-                this.api.unregister(this);
-            });
         }
 
-        RED.nodes.registerType(`geyserwala-connect-${valueKey}`, Node);
+        RED.nodes.registerType(`geyserwala-connect-${node.key}`, Node);
     }
 
-    createNode('tank-temp', Number, false);
-    createNode('element-demand', Boolean, false);
-
-    createNode('external-setpoint', Number, true);
-    createNode('external-demand', Number, true);
-    createNode('external-disable', Number, true);
-
-    createNode('status', String, false);
-    createNode('mode', String, true);
-    createNode('setpoint', Number, true);
-    createNode('boost-demand', Boolean, true);
+    function registerNode(key, name, type, icon, input) {
+        _registerNode({key: key, name: name, type: type, icon: icon, input: input})
+    }
 
-    createNode('collector-temp', Number, false);
-    createNode('pump-status', Boolean, false);
+    // Icons: https://fontawesome.com/v4/icons/
+    registerNode("status", "Status", String, "font-awesome/fa-envelope-o", false)
+    registerNode("mode", "Mode", String, "font-awesome/fa-sliders", true)
+    registerNode("tank-temp", "Tank Temp", Number, "font-awesome/fa-thermometer-half", false)
+    registerNode("element-demand", "Element Demand", Boolean, "font-awesome/fa-fire", false)
+    registerNode("external-setpoint", "External Setpoint", Number, "inject.png", true)
+    registerNode("external-demand", "External Demand", Number, "serial.png", true)
+    registerNode("external-disable", "External Disable", Number, "font-awesome/fa-stop-circle-o", true)
+    registerNode("setpoint", "Setpoint", Number, "inject.png", true)
+    registerNode("boost-demand", "Boost Demand", Boolean, "font-awesome/fa-power-off", true)
+    registerNode("collector-temp", "Collector Temp", Number, "font-awesome/fa-thermometer-half", false)
+    registerNode("pump-status", "Pump Status", Boolean, "font-awesome/fa-recycle", false)
+    registerNode("custom-io", "Custom", null, "font-awesome/fa-cogs", true)
 }

package/CHANGELOG

@@ -1,19 +0,0 @@
-# Change Log - Geyserwala Connect Node-RED plugin
-
-## [0.0.4] - 2023-12-05
-
-Migrate to persistent latch signals, with programable hold time
-
-### Added
-- element-disable signal, accepts integer of number or seconds to latch, or true (defaults to 24 hours). Zero/false will clear.
-
-### Changed
-- naming to geyserwala-connect-...
-- element-enable signal: accepts integer of number of seconds to latch, or true (defaults to 24 hours). Zero/false will clear.
-
-### Removed
-- lowpower-enable: replaced by element-disable.
-
-## [0.0.3] - 2023-09-01
-
-Initial development