@evilbunny/node-red-contrib-zigbee2mqtt 0.0.0 → 3.2.8

package/README.md

@@ -1,45 +1,64 @@
-# @evilbunny/node-red-contrib-zigbee2mqtt
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@evilbunny/node-red-contrib-zigbee2mqtt`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+# Forked
+This was forked from [andreypopov/node-red-contrib-zigbee2mqtt](https://github.com/andreypopov/node-red-contrib-zigbee2mqtt) but that repo was last updated more than 18 months ago and the dependencies were horribly out of date and wouldn't cleanly install for me.
 
-## Setup Instructions
+I've made other improvements, such as more state options to support ZigBee devices I own. [I submitted a PR](https://github.com/andreypopov/node-red-contrib-zigbee2mqtt/pull/154) for the changes but given all the unmerged PRs, I don't expect my PR will be merged.
 
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+# @evilbunny/node-red-contrib-zigbee2mqtt
+[![platform](https://img.shields.io/badge/platform-Node--RED-red?logo=nodered)](https://nodered.org)
+[![Min Node Version](https://img.shields.io/node/v/@evilbunny/node-red-contrib-zigbee2mqtt.svg)](https://nodejs.org/en/)
+[![GitHub version](https://img.shields.io/github/package-json/v/evilbunny2008/node-red-contrib-zigbee2mqtt?logo=npm)](https://www.npmjs.com/package/node-red-contrib-zigbee2mqtt)
+[![GitHub stars](https://img.shields.io/github/stars/evilbunny2008/node-red-contrib-zigbee2mqtt)](https://github.com/evilbunny2008/node-red-contrib-zigbee2mqtt/stargazers)
+[![Package Quality](https://packagequality.com/shield/@evilbunny/node-red-contrib-zigbee2mqtt.svg)](https://packagequality.com/#?package=node-red-contrib-zigbee2mqtt)
+
+[![issues](https://img.shields.io/github/issues/evilbunny2008/node-red-contrib-zigbee2mqtt?logo=github)](https://github.com/evilbunny2008/node-red-contrib-zigbee2mqtt/issues)
+![GitHub last commit](https://img.shields.io/github/last-commit/evilbunny2008/node-red-contrib-zigbee2mqtt)
+![NPM Total Downloads](https://img.shields.io/npm/dt/@evilbunny/node-red-contrib-zigbee2mqtt.svg)
+![NPM Downloads per month](https://img.shields.io/npm/dm/@evilbunny/node-red-contrib-zigbee2mqtt)
+![Repo size](https://img.shields.io/github/repo-size/evilbunny2008/node-red-contrib-zigbee2mqtt)
+
+Node-Red Nodes for Zigbee2mqtt connectivity.
+
+# Install
+You should do the following:
+```
+npm install -g node-red
+mkdir -p /opt/node-red
+useradd -d /opt/node-red -M node-red
+chown -R node-red: /opt/node-red
+su -s /bin/bash - node-red
+mkdir -p .node-red
+cd .node-red
+node-red admin init
+```
+
+Next edit the settings.js to match your server
+```nano settings.js```
+
+Finally install this module
+```
+npm install @evilbunny/node-red-contrib-zigbee2mqtt
+```
+and then you can start Node Red by doing
+```
+cd ..
+node-red
+```
+
+# Available nodes
+* zigbee2mqtt-eb-in: listen to device
+* zigbee2mqtt-eb-get: get current value of device
+* zigbee2mqtt-eb-out: send command to device
+* zigbee2mqtt-eb-bridge: logs, options, other events
+
+Extra features:
+* groups support
+* network map generation
+
+<img src="https://github.com/evilbunny2008/node-red-contrib-zigbee2mqtt/blob/main/readme/1.png?raw=true">
+<img src="https://github.com/evilbunny2008/node-red-contrib-zigbee2mqtt/blob/main/readme/2.png?raw=true">
+<img src="https://github.com/evilbunny2008/node-red-contrib-zigbee2mqtt/blob/main/readme/3.png?raw=true">
+<img src="https://github.com/evilbunny2008/node-red-contrib-zigbee2mqtt/blob/main/readme/4.png?raw=true">
+<img src="https://github.com/evilbunny2008/node-red-contrib-zigbee2mqtt/blob/main/readme/5.png?raw=true">
+
+# Support
+Developing and supporting this plugin needs time and efforts. Appreciate your support on [Patreon](https://www.patreon.com/bePatron?u=12661781). Here, you can sign up to be a member and help support my project.

package/api.html

@@ -0,0 +1,22 @@
+<script type="text/x-red" data-template-name="zigbee2mqtt-eb-api" data-hidden="true">
+</script>
+
+<script type='text/javascript'>
+    // This node has no editable properties and is never shown in the palette;
+    // it exists only so the runtime side (api.js) can register its httpAdmin
+    // routes as a normal, parseable node module.
+    RED.nodes.registerType('zigbee2mqtt-eb-api', {
+        category: '',
+        defaults: {},
+        label: function () { return 'zigbee2mqtt-eb-api'; }
+    });
+
+    $.getScript('resources/@evilbunny/node-red-contrib-zigbee2mqtt/js/multiple-select.min.js');
+    $.getScript('resources/@evilbunny/node-red-contrib-zigbee2mqtt/js/node-red-contrib-zigbee2mqtt-helpers.js');
+</script>
+
+
+
+
+
+

package/api.js

@@ -0,0 +1,176 @@
+var NODE_PATH = '/zigbee2mqtt-eb/';
+
+module.exports = function(RED) {
+    RED.httpAdmin.get(NODE_PATH + 'getDevices', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+
+        if (controller && controller.constructor.name === "ServerNode") {
+            controller.getDevices(function (items) {
+                if (items) {
+                    res.json(items);
+                } else {
+                    res.status(404).end();
+                }
+            }, true);
+        } else {
+            res.json([{},{}]);
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'restart', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            controller.restart();
+            res.json({"result":"ok"});
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'setPermitJoin', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            controller.setPermitJoin(config.permit_join==='true'?true:false);
+            res.json({"result":"ok"});
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'setLogLevel', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            controller.setLogLevel(config.log_level);
+            res.json({"result":"ok"});
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'getConfig', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            res.json(controller.bridge_info);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'renameDevice', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.renameDevice(config.ieee_address, config.newName);
+            res.json(response);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'removeDevice', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.removeDevice(config.id, config.newName);
+            res.json(response);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'renameGroup', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.renameGroup(config.id, config.newName);
+            res.json(response);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'removeGroup', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.removeGroup(config.id);
+            res.json(response);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'addGroup', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.addGroup(config.name);
+            res.json(response);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'removeDeviceFromGroup', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.removeDeviceFromGroup(config.deviceId, config.groupId);
+            res.json(response);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'addDeviceToGroup', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.addDeviceToGroup(config.deviceId, config.groupId);
+            res.json(response);
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    RED.httpAdmin.get(NODE_PATH + 'refreshMap', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            controller.refreshMap(true, config.engine).then(function(response){
+                res.json(response);
+            }).catch(error => {
+                res.status(404).end();
+            });
+        } else {
+            res.status(404).end();
+        }
+    });
+    RED.httpAdmin.get(NODE_PATH + 'showMap', function (req, res) {
+        var config = req.query;
+        var controller = RED.nodes.getNode(config.controllerID);
+        if (controller && controller.constructor.name === "ServerNode") {
+            var response = controller.map;
+            res.writeHead(200, {'Content-Type': 'image/svg+xml'});
+            res.end(response); // Send the file data to the browser.
+        } else {
+            res.status(404).end();
+        }
+    });
+
+    // This file exists purely to register the httpAdmin routes above (used by the
+    // editor's device/group pickers). It has no runtime behaviour of its own, but is
+    // registered as a real (invisible) node so that node-red-dev/other node package
+    // validators can parse it like any other node file.
+    function Zigbee2mqttApiNode(config) {
+        RED.nodes.createNode(this, config);
+    }
+    RED.nodes.registerType('zigbee2mqtt-eb-api', Zigbee2mqttApiNode, {
+        category: '' // empty category keeps it out of the palette
+    });
+}

package/examples/Basic usage.json

@@ -0,0 +1,316 @@
+[
+    {
+        "id": "123545dd506fb882",
+        "type": "zigbee2mqtt-eb-in",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "server": "183e467f17e7451d",
+        "friendly_name": "Outlet 1",
+        "device_id": "0xa4c13880d0cef5c9",
+        "state": "state",
+        "outputAtStartup": true,
+        "x": 930,
+        "y": 560,
+        "wires": [
+            [
+                "1faf0be4d4395a25"
+            ]
+        ]
+    },
+    {
+        "id": "4834aa1faa625685",
+        "type": "zigbee2mqtt-eb-bridge",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "server": "183e467f17e7451d",
+        "topic": null,
+        "x": 980,
+        "y": 160,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "b38b944ffd4e9a66",
+        "type": "zigbee2mqtt-eb-out",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "server": "183e467f17e7451d",
+        "friendly_name": "0x9035eafffe6acbed",
+        "device_id": "0x9035eafffe6acbed",
+        "command": "position",
+        "commandType": "z2m_cmd",
+        "payload": "payload",
+        "payloadType": "msg",
+        "transition": 0,
+        "x": 1460,
+        "y": 460,
+        "wires": []
+    },
+    {
+        "id": "33e8ef8026f7ecc1",
+        "type": "inject",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "10",
+        "payloadType": "num",
+        "x": 1250,
+        "y": 460,
+        "wires": [
+            [
+                "b38b944ffd4e9a66"
+            ]
+        ]
+    },
+    {
+        "id": "62a13be50b93dcc9",
+        "type": "inject",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "20",
+        "payloadType": "num",
+        "x": 1250,
+        "y": 500,
+        "wires": [
+            [
+                "b38b944ffd4e9a66"
+            ]
+        ]
+    },
+    {
+        "id": "1faf0be4d4395a25",
+        "type": "debug",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 1150,
+        "y": 560,
+        "wires": []
+    },
+    {
+        "id": "89edc10dcce1d277",
+        "type": "inject",
+        "z": "d9c248a1ac73f01a",
+        "name": "test",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "test",
+        "payload": "",
+        "payloadType": "date",
+        "x": 950,
+        "y": 360,
+        "wires": [
+            [
+                "7fdcec472ec527db"
+            ]
+        ]
+    },
+    {
+        "id": "7fdcec472ec527db",
+        "type": "zigbee2mqtt-eb-get",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "server": "183e467f17e7451d",
+        "friendly_name": "",
+        "device_id": "",
+        "state": "0",
+        "x": 1240,
+        "y": 380,
+        "wires": [
+            [
+                "8b9d391ced3e6d4c"
+            ]
+        ]
+    },
+    {
+        "id": "8b9d391ced3e6d4c",
+        "type": "debug",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 1430,
+        "y": 380,
+        "wires": []
+    },
+    {
+        "id": "01f67f868cbc9d5b",
+        "type": "inject",
+        "z": "d9c248a1ac73f01a",
+        "name": "Outlet 1",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "Outlet 1",
+        "payload": "",
+        "payloadType": "date",
+        "x": 950,
+        "y": 400,
+        "wires": [
+            [
+                "7fdcec472ec527db"
+            ]
+        ]
+    },
+    {
+        "id": "f79972418404f0bb",
+        "type": "inject",
+        "z": "d9c248a1ac73f01a",
+        "name": "zigbee2mqtt_Outlet1",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "zigbee2mqtt_Outlet1",
+        "payload": "",
+        "payloadType": "date",
+        "x": 1000,
+        "y": 440,
+        "wires": [
+            [
+                "7fdcec472ec527db"
+            ]
+        ]
+    },
+    {
+        "id": "6cd3c363497388dc",
+        "type": "inject",
+        "z": "d9c248a1ac73f01a",
+        "name": "zigbee2mqtt/Outlet 1",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "zigbee2mqtt/Outlet 1",
+        "payload": "",
+        "payloadType": "date",
+        "x": 1000,
+        "y": 320,
+        "wires": [
+            [
+                "7fdcec472ec527db"
+            ]
+        ]
+    },
+    {
+        "id": "3cb917c78bc66b0e",
+        "type": "inject",
+        "z": "d9c248a1ac73f01a",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "no device",
+        "payload": "",
+        "payloadType": "date",
+        "x": 1010,
+        "y": 220,
+        "wires": [
+            [
+                "7fdcec472ec527db"
+            ]
+        ]
+    },
+    {
+        "id": "183e467f17e7451d",
+        "type": "zigbee2mqtt-eb-server",
+        "name": "",
+        "host": "192.168.1.2",
+        "mqtt_port": "1883",
+        "mqtt_username": "",
+        "mqtt_password": "",
+        "tls": "",
+        "usetls": false,
+        "base_topic": "zigbee2mqtt"
+    }
+]

package/icons/icon.pxd/data/selection/meta

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>backingScale</key>
+	<real>1</real>
+	<key>mode</key>
+	<integer>0</integer>
+	<key>shapeSelectionFilename</key>
+	<string>shapeSelection</string>
+	<key>size</key>
+	<data>
+	NC10UHpTVFAQAAAAQGbAAAAAAABAZ2AAAAAAAA==
+	</data>
+	<key>softness</key>
+	<real>0.0</real>
+	<key>timestamp</key>
+	<real>606977233.632658</real>
+	<key>transform</key>
+	<array>
+		<real>1.4945054945054939</real>
+		<real>0.0</real>
+		<real>0.0</real>
+		<real>1.5454545454545454</real>
+		<real>-50.956043956043892</real>
+		<real>-117.27272727272721</real>
+		<real>0.0</real>
+		<real>0.0</real>
+	</array>
+	<key>version</key>
+	<integer>2</integer>
+</dict>
+</plist>