node-red-contrib-universal-mqtt-switch 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 gparduino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# node-red-contrib-universal-mqtt-switch
+
+A robust, "set-and-forget" Node-RED subflow for controlling nearly any MQTT-enabled switch. Perfect for mixing old Shelly Gen 1 hardware with newer OpenBeken or Tasmota devices in **Dashboard 2.0**.
+
+## Why use this?
+MQTT devices are notorious for having inconsistent topic structures. This node abstracts that away:
+- **Input:** Accepts simple `true`/`false` booleans.
+- **Output:** Sends the correct string (`on`/`off`) or integer (`1`/`0`) based on your config.
+- **Feedback:** Converts device responses back into booleans for UI switches.
+- **Safety:** Built-in 5-minute watchdog warns you via node status if the device drops off the network.
+
+## Installation
+Run the following command in your Node-RED user directory (typically `~/.node-red`):
+
+```bash
+npm install node-red-contrib-universal-mqtt-switch
+
+## Getting Started
+1. **Drag** the 'Universal MQTT Switch' node onto your workspace.
+2. **Double-click** to configure.
+3. **Select your Broker** from the dropdown (or create a new one).
+4. **Enter your topics** (Tip: Copy/Paste exactly from your device's web UI).
+5. **Connect** a Dashboard 2.0 Switch to the input and output.
+
+REMEMBER: if you wire a Dashboard 2.0 Switch to this node - to prevent command loops wire the first output of this node to the input of your Dashboard 2.0 Switch to keep its state synchronized, but ENSURE the Dashboard Switch node does pass input messages to its output (that checkbox is off by default usually and should stay that way.)
+
+### Payload Compatibility Guide
+| Device Type | Use Strings Setting | Expected MQTT Payload |
+| :--- | :--- | :--- |
+| **Shelly (Gen 1)** | Checked (True) | `"on"` / `"off"` |
+| **Tasmota** | Checked (True) | `"ON"` / `"OFF"` |
+| **OpenBeken** | Unchecked (False) | `1` / `0` |
+| **Home Assistant** | Unchecked (False) | `1` / `0` |

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "node-red-contrib-universal-mqtt-switch",
+  "version": "1.1.0",
+  "description": "A universal MQTT switch subflow for Shelly, OpenBeken, and legacy devices",
+  "main": "universal-switch.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "node-red",
+    "mqtt",
+    "shelly",
+    "openbeken",
+    "home-automation"
+  ],
+  "node-red": {
+    "nodes": {
+      "universal-switch": "universal-switch.js"
+    }
+  },
+  "author": "gparduino",
+  "license": "MIT",
+  "engines": {
+    "node": ">=12.0.0"
+  }
+}

package/universal-switch.js

@@ -0,0 +1,15 @@
+module.exports = function(RED) {
+    const fs = require("fs");
+    const path = require("path");
+    
+    try {
+        // Load the subflow JSON file
+        const subflowPath = path.join(__dirname, "universal_MQTT_switch.json");
+        const subflowData = JSON.parse(fs.readFileSync(subflowPath, "utf8"));
+        
+        // Register the FULL array so Node-RED sees the subflow AND its internal nodes
+        RED.nodes.registerSubflow(subflowData); 
+    } catch (err) {
+        RED.log.error("Failed to load Universal MQTT Switch subflow: " + err.message);
+    }
+};

package/universal_MQTT_switch.json

@@ -0,0 +1,279 @@
+[
+    {
+        "id": "ed07e87722270aef",
+        "type": "subflow",
+        "name": "Universal MQTT Switch",
+        "info": "Generic handler for Shelly, OpenBeken, and legacy MQTT devices.",
+        "category": "",
+        "in": [
+            {
+                "x": 60,
+                "y": 80,
+                "wires": [
+                    {
+                        "id": "87c2ee5bfb812754"
+                    }
+                ]
+            }
+        ],
+        "out": [
+            {
+                "x": 950,
+                "y": 60,
+                "wires": [
+                    {
+                        "id": "87c2ee5bfb812754",
+                        "port": 0
+                    }
+                ]
+            }
+        ],
+        "env": [
+            {
+                "name": "CMD_TOPIC",
+                "type": "str",
+                "value": "",
+                "ui": {
+                    "label": {
+                        "en-US": "Command Topic (Set)"
+                    },
+                    "type": "input",
+                    "opts": {
+                        "types": [
+                            "str",
+                            "num",
+                            "bool",
+                            "json",
+                            "bin",
+                            "env",
+                            "conf-types"
+                        ]
+                    }
+                }
+            },
+            {
+                "name": "STATE_TOPIC",
+                "type": "str",
+                "value": "",
+                "ui": {
+                    "label": {
+                        "en-US": "State Topic (Get)"
+                    },
+                    "type": "input",
+                    "opts": {
+                        "types": [
+                            "str",
+                            "num",
+                            "bool",
+                            "json",
+                            "bin",
+                            "env",
+                            "conf-types"
+                        ]
+                    }
+                }
+            },
+            {
+                "name": "AVAIL_TOPIC",
+                "type": "str",
+                "value": "",
+                "ui": {
+                    "label": {
+                        "en-US": "Availability Topic"
+                    },
+                    "type": "input",
+                    "opts": {
+                        "types": [
+                            "str",
+                            "num",
+                            "bool",
+                            "json",
+                            "bin",
+                            "env",
+                            "conf-types"
+                        ]
+                    }
+                }
+            },
+            {
+                "name": "USE_STRINGS",
+                "type": "bool",
+                "value": "true",
+                "ui": {
+                    "label": {
+                        "en-US": "Use 'on/off' strings (Shelly style)"
+                    },
+                    "type": "checkbox"
+                }
+            },
+            {
+                "name": "CONFIG_NODE",
+                "type": "mqtt-broker",
+                "value": "",
+                "ui": {
+                    "label": {
+                        "en-US": "Broker"
+                    },
+                    "type": "conf-types"
+                }
+            }
+        ],
+        "meta": {
+            "module": "node-red-contrib-universal-mqtt",
+            "type": "universal-switch",
+            "version": "1.1.0",
+            "author": "gparduino",
+            "desc": "Support for Shelly, OpenBeken, and others",
+            "license": "MIT"
+        },
+        "color": "#C0DEED",
+        "icon": "node-red/light.svg",
+        "status": {
+            "x": 950,
+            "y": 140,
+            "wires": [
+                {
+                    "id": "87c2ee5bfb812754",
+                    "port": 2
+                }
+            ]
+        }
+    },
+    {
+        "id": "87c2ee5bfb812754",
+        "type": "function",
+        "z": "ed07e87722270aef",
+        "name": "Logic Engine",
+        "func": "const cmdTopic = env.get(\"CMD_TOPIC\");\nconst stateTopic = env.get(\"STATE_TOPIC\");\nconst availTopic = env.get(\"AVAIL_TOPIC\");\nconst useStrings = env.get(\"USE_STRINGS\");\n\n// 1. WATCHDOG\nif (msg.topic === \"watchdog\") {\n    const s = { fill: \"red\", shape: \"ring\", text: \"Offline (Timeout)\" };\n    node.status(s);\n    return [null, null, { payload: s }];\n}\n\n// 2. INCOMING MQTT\nif (msg.topic === availTopic) {\n    const isOnline = (msg.payload === \"online\" || msg.payload === \"1\" || msg.payload === 1 || msg.payload === true);\n    const s = { fill: isOnline ? \"yellow\" : \"red\", shape: isOnline ? \"dot\" : \"ring\", text: isOnline ? \"Online\" : \"Offline\" };\n    node.status(s);\n    return [null, null, { payload: s }];\n}\n\nif (msg.topic === stateTopic) {\n    const isOn = (msg.payload === \"on\" || msg.payload == 1 || msg.payload === \"1\" || msg.payload === true);\n    const s = { fill: isOn ? \"green\" : \"grey\", shape: \"dot\", text: isOn ? \"On\" : \"Off\" };\n    node.status(s);\n    return [{ payload: isOn }, null, { payload: s }];\n}\n\n// 3. UI COMMAND (Input from Dashboard)\nif (msg.topic !== stateTopic && msg.topic !== availTopic) {\n    const isTrue = (msg.payload === true || msg.payload === \"on\" || msg.payload === \"1\" || msg.payload === 1);\n    let outPayload;\n    \n    if (useStrings) {\n        outPayload = isTrue ? \"on\" : \"off\";\n    } else {\n        outPayload = isTrue ? 1 : 0;\n    }\n    \n    return [null, { topic: cmdTopic, payload: outPayload }, null];\n}\n\nreturn null;",
+        "outputs": 3,
+        "x": 720,
+        "y": 80,
+        "wires": [
+            [],
+            [
+                "928a0fc426a549af"
+            ],
+            []
+        ]
+    },
+    {
+        "id": "af111b31d258147f",
+        "type": "mqtt in",
+        "z": "ed07e87722270aef",
+        "name": "Listen",
+        "topic": "",
+        "qos": "2",
+        "datatype": "auto-detect",
+        "broker": "${CONFIG_NODE}",
+        "nl": false,
+        "rap": false,
+        "inputs": 1,
+        "x": 190,
+        "y": 200,
+        "wires": [
+            [
+                "12ee9dea65533d9b",
+                "87c2ee5bfb812754"
+            ]
+        ]
+    },
+    {
+        "id": "12ee9dea65533d9b",
+        "type": "trigger",
+        "z": "ed07e87722270aef",
+        "name": "Watchdog",
+        "op1": "",
+        "op2": "Offline",
+        "op1type": "nul",
+        "op2type": "str",
+        "duration": "5",
+        "extend": true,
+        "units": "min",
+        "reset": "",
+        "bytopic": "all",
+        "topic": "topic",
+        "outputs": 1,
+        "x": 410,
+        "y": 260,
+        "wires": [
+            [
+                "c78da593ddcb06fe"
+            ]
+        ]
+    },
+    {
+        "id": "c78da593ddcb06fe",
+        "type": "change",
+        "z": "ed07e87722270aef",
+        "name": "Set Topic",
+        "rules": [
+            {
+                "t": "set",
+                "p": "topic",
+                "pt": "msg",
+                "to": "watchdog",
+                "tot": "str"
+            }
+        ],
+        "x": 570,
+        "y": 260,
+        "wires": [
+            [
+                "87c2ee5bfb812754"
+            ]
+        ]
+    },
+    {
+        "id": "928a0fc426a549af",
+        "type": "mqtt out",
+        "z": "ed07e87722270aef",
+        "name": "",
+        "topic": "",
+        "qos": "",
+        "retain": "",
+        "broker": "${CONFIG_NODE}",
+        "x": 940,
+        "y": 200,
+        "wires": []
+    },
+    {
+        "id": "2f171e57d4be7d5f",
+        "type": "inject",
+        "z": "ed07e87722270aef",
+        "name": "Init",
+        "props": [
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": true,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 100,
+        "y": 140,
+        "wires": [
+            [
+                "1b4b4c486cf45ebb"
+            ]
+        ]
+    },
+    {
+        "id": "1b4b4c486cf45ebb",
+        "type": "function",
+        "z": "ed07e87722270aef",
+        "name": "Sub Manager",
+        "func": "const state = env.get(\"STATE_TOPIC\");\nconst avail = env.get(\"AVAIL_TOPIC\");\n\n// Return multiple subscriptions as an array of messages or handle sequentially\nnode.send({ topic: state, action: \"subscribe\" });\nnode.send({ topic: avail, action: \"subscribe\" });\nreturn null;",
+        "outputs": 1,
+        "x": 300,
+        "y": 140,
+        "wires": [
+            [
+                "af111b31d258147f"
+            ]
+        ]
+    }
+]