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

package/nodes/bridge.js

@@ -0,0 +1,124 @@
+const Zigbee2mqttHelper = require('../resources/Zigbee2mqttHelper.js');
+
+module.exports = function(RED) {
+
+    class Zigbee2mqttNodeBridge {
+        constructor(config) {
+
+            RED.nodes.createNode(this, config);
+
+            let node = this;
+            node.config = config;
+            node.cleanTimer = null;
+            node.is_subscribed = false;
+            node.server = RED.nodes.getNode(node.config.server);
+
+            if (node.server) {
+                node.listener_onMQTTConnect = function() { node.onMQTTConnect(); }
+                node.server.on('onMQTTConnect', node.listener_onMQTTConnect);
+
+                node.listener_onMQTTMessageBridge = function(data) { node.onMQTTMessageBridge(data); }
+                node.server.on('onMQTTMessageBridge', node.listener_onMQTTMessageBridge);
+
+                node.on('close', () => node.onClose());
+
+                if (typeof(node.server.mqtt) === 'object') {
+                    node.onMQTTConnect();
+                }
+            } else {
+                node.status({
+                    fill: "red",
+                    shape: "dot",
+                    text: "@evilbunny/node-red-contrib-zigbee2mqtt/bridge:status.no_server"
+                });
+            }
+
+            if (node.server) {
+                node.on('input', function (message_in) {
+                    node.log('Published to mqtt topic: ' + message_in.topic + ' Payload: ' + JSON.stringify(message_in.payload));
+                    node.server.mqtt.publish(message_in.topic, JSON.stringify(message_in.payload));
+                });
+
+            } else {
+                node.status({
+                    fill: "red",
+                    shape: "dot",
+                    text: "@evilbunny/node-red-contrib-zigbee2mqtt/bridge:status.no_server"
+                });
+            }
+        }
+
+        onClose() {
+            let node = this;
+            node.setNodeStatus();
+
+            //remove listeners
+            if (node.listener_onMQTTConnect) {
+                node.server.removeListener('onMQTTConnect', node.listener_onMQTTConnect);
+            }
+            if (node.listener_onMQTTMessageBridge) {
+                node.server.removeListener("onMQTTMessageBridge", node.listener_onMQTTMessageBridge);
+            }
+        }
+
+        onMQTTConnect() {
+            let node = this;
+            node.setNodeStatus();
+        }
+
+        setNodeStatus() {
+            let node = this;
+
+            if (node.server.bridge_info && node.server.bridge_info.permit_join && node.server.bridge_state) {
+                node.status({
+                    fill: "yellow",
+                    shape: "ring",
+                    text: "@evilbunny/node-red-contrib-zigbee2mqtt/bridge:status.searching"
+                });
+            } else {
+                let text = node.server.bridge_state?RED._("@evilbunny/node-red-contrib-zigbee2mqtt/bridge:status.online"):RED._("@evilbunny/node-red-contrib-zigbee2mqtt/bridge:status.offline");
+                if (node.server.bridge_info && "log_level" in node.server.bridge_info) {
+                    text += ' (log: '+node.server.bridge_info.log_level+')';
+                }
+                node.status({
+                    fill: node.server.bridge_state?"green":"red",
+                    shape: "dot",
+                    text: text
+                });
+            }
+        }
+
+        onMQTTMessageBridge(data) {
+            let node = this;
+            let payload = Zigbee2mqttHelper.isJson(data.payload)?JSON.parse(data.payload):data.payload;
+
+            if (node.server.getTopic('/bridge/state') === data.topic) {
+                node.setNodeStatus();
+            } else if (node.server.getTopic('/bridge/info') === data.topic) {
+                if (payload.permit_join != (node.status.fill === 'yellow')) {
+                    node.setNodeStatus();
+                }
+            } else if (node.server.getTopic('/bridge/event') === data.topic) {
+                node.status({
+                    fill: "yellow",
+                    shape: "ring",
+                    text: payload.type
+                });
+                clearTimeout(node.cleanTimer);
+                node.cleanTimer = setTimeout(function(){
+                    node.setNodeStatus();
+                }, 10000);
+            }
+
+            node.send({
+                payload: payload,
+                topic: data.topic
+            });
+        }
+    }
+    RED.nodes.registerType('zigbee2mqtt-eb-bridge', Zigbee2mqttNodeBridge);
+};
+
+
+
+

package/nodes/get.html

@@ -0,0 +1,106 @@
+<script type="text/x-red" data-template-name="zigbee2mqtt-eb-get">
+    <link rel="stylesheet" href="resources/@evilbunny/node-red-contrib-zigbee2mqtt/css/multiple-select.css" type="text/css" />
+    <link rel="stylesheet" href="resources/@evilbunny/node-red-contrib-zigbee2mqtt/css/common.css" type="text/css" />
+
+    <div class="form-row">
+        <label for="node-input-name" class="l-width"><i class="fa fa-bookmark"></i> <span data-i18n="label.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]placeholder.name">
+    </div>
+    <div class="form-row" style="display:none;">
+        <label for="node-input-friendly_name" class="l-width"><i class="fa fa-bookmark"></i> <span data-i18n="label.friendly_name"></span></label>
+        <input type="text" id="node-input-friendly_name" data-i18n="[placeholder]placeholder.friendly_name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server" class="l-width"><i class="fa fa-globe"></i> <span data-i18n="label.server"></span></label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-device_id" class="l-width"><i class="fa fa-crosshairs"></i> <span data-i18n="label.topic"></span></label>
+        <select id="node-input-device_id" class="s-width" multiple="multiple"></select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-state" class="l-width"><i class="fa fa-tag"></i> <span data-i18n="label.state"></span></label>
+        <select id="node-input-state" class="s-width" multiple="multiple" data-i18n="[placeholder]multiselect.complete_payload"></select>
+    </div>
+    <div class="form-row">
+        <label for="force-refresh" class="l-width"><i class="fa fa-refresh"></i> <span data-i18n="label.refresh"></span></label>
+        <a class="red-ui-button s-width" id="force-refresh" name="force-refresh"><span data-i18n="label.refresh_devices_list"></span></a>
+    </div>
+    <div class="form-row">
+        <label for='node-input-enableMultiple' class="l-width"><i class='fa fa-filter'></i> <span data-i18n="label.enable_multiple"></span></label>
+        <input type="checkbox" id="node-input-enableMultiple" style="display: inline-block; width: auto; vertical-align: top;"> <span data-i18n="label.enable_mu>
+    </div>
+
+
+
+</script>
+
+<script type='text/javascript'>
+    RED.nodes.registerType('zigbee2mqtt-eb-get', {
+        category: 'ZigBee2MQTT',
+        color: '#FDBF48',
+        defaults: {
+            name: {
+                value: ''
+            },
+            server: {
+                type: 'zigbee2mqtt-eb-server',
+                required: true
+            },
+            friendly_name: {
+                value: '',
+                required: false
+            },
+            device_id: {
+                value: null,
+                required: false
+            },
+            state: {
+                value: []
+            },
+            enableMultiple: {
+                value: false,
+                required: true
+            }
+        },
+        inputs: 1,
+        outputs: 1,
+        outputLabels: ["value"],
+        paletteLabel: 'get',
+        icon: "icon.png",
+        label: function () {
+            var label = 'z2m-get';
+
+            if (this.name) {
+                label = this.name;
+            } else if (typeof(this.friendly_name) == 'string' && this.friendly_name.length) {
+                label = this.friendly_name;
+            } else if (typeof(this.device_id) == 'string') {
+                label = this.device_id;
+            }
+
+            return label;
+        },
+        oneditprepare: function () {
+            let node = this;
+
+            setTimeout(()=>{
+                new Zigbee2MqttEditor(node, {
+                    'allow_empty': true
+                }).build();
+            }, 100); //need timeout to load server node
+        },
+        oneditsave: function () {
+            //convert array for string if single mode
+            if (!$('#node-input-enableMultiple').is(':checked')) {
+                let device_id = $('#node-input-device_id').multipleSelect('getSelects', 'value');
+                this.device_id = device_id.length ? device_id[0] : null;
+            }
+
+            // state/attribute select is now multi-select — always store as an array
+            let state = $('#node-input-state').multipleSelect('getSelects', 'value');
+            this.state = state || [];
+        }
+    });
+</script>
+

package/nodes/get.js

@@ -0,0 +1,47 @@
+module.exports = function(RED) {
+    class Zigbee2mqttNodeGet {
+        constructor(config) {
+            RED.nodes.createNode(this, config);
+
+            let node = this;
+            node.config = config;
+            node.cleanTimer = null;
+            node.last_successful_status = {};
+            node.server = RED.nodes.getNode(node.config.server);
+            node.status({});
+            if (node.server) {
+                node.on('input', function(message_in) {
+
+                    let key = node.config.device_id;
+                    if ((!key || key === 'msg.topic') && message_in.topic) {
+                        key = message_in.topic;
+                    }
+
+                    node.server.nodeSend(node, {
+                        'msg': message_in,
+                        'key': key,
+                        'state': node.config.state,
+                    });
+                });
+
+            } else {
+                node.status({
+                    fill: 'red',
+                    shape: 'dot',
+                    text: '@evilbunny/node-red-contrib-zigbee2mqtt/server:status.no_server',
+                });
+            }
+        }
+
+        setSuccessfulStatus(obj) {
+            this.status(obj);
+            this.last_successful_status = obj;
+        }
+    }
+
+    RED.nodes.registerType('zigbee2mqtt-eb-get', Zigbee2mqttNodeGet);
+};
+
+
+
+

package/nodes/in.html

@@ -0,0 +1,125 @@
+<script type="text/x-red" data-template-name="zigbee2mqtt-eb-in">
+    <link rel="stylesheet" href="resources/@evilbunny/node-red-contrib-zigbee2mqtt/css/multiple-select.css" type="text/css" />
+    <link rel="stylesheet" href="resources/@evilbunny/node-red-contrib-zigbee2mqtt/css/common.css" type="text/css" />
+
+    <div class="form-row">
+        <label for="node-input-name" class="l-width"><i class="fa fa-bookmark"></i> <span data-i18n="label.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]placeholder.name">
+    </div>
+    <div class="form-row" style="display:none;">
+        <label for="node-input-friendly_name" class="l-width"><i class="fa fa-bookmark"></i> <span data-i18n="label.friendly_name"></span></label>
+        <input type="text" id="node-input-friendly_name" data-i18n="[placeholder]placeholder.friendly_name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server" class="l-width"><i class="fa fa-globe"></i> <span data-i18n="label.server"></span></label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-device_id" class="l-width"><i class="fa fa-crosshairs"></i> <span data-i18n="label.topic"></span></label>
+        <select id="node-input-device_id" class="s-width" multiple="multiple"></select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-state" class="l-width"><i class="fa fa-tag"></i> <span data-i18n="label.state"></span></label>
+        <select id="node-input-state" class="s-width" data-i18n="[placeholder]multiselect.complete_payload"></select>
+    </div>
+    <div class="form-row">
+        <label for="force-refresh" class="l-width"><i class="fa fa-refresh"></i> <span data-i18n="label.refresh"></span></label>
+        <a class="red-ui-button s-width" id="force-refresh" name="force-refresh"><span data-i18n="label.refresh_devices_list"></span></a>
+    </div>
+    <div class="form-row">
+        <label for='node-input-enableMultiple' class="l-width"><i class='fa fa-filter'></i> <span data-i18n="label.enable_multiple"></span></label>
+        <input type="checkbox" id="node-input-enableMultiple" style="display: inline-block; width: auto; vertical-align: top;"> <span data-i18n="label.enable_multiple_help"></span></input>
+    </div>
+    <div class="form-row">
+        <label for='node-input-outputAtStartup' class="l-width"><i class='fa fa-share-square'></i> <span data-i18n="label.start_output"></span></label>
+        <input type="checkbox" id="node-input-outputAtStartup" checked="checked" style="display: inline-block; width: auto; vertical-align: top;"> <span data-i18n="label.start_output_help"></span></input>
+    </div>
+    <div class="form-row">
+        <label for='node-input-filterChanges' class="l-width"><i class='fa fa-share-square'></i> <span data-i18n="label.filter_changes"></span></label>
+        <input type="checkbox" id="node-input-filterChanges" checked="checked" style="display: inline-block; width: auto; vertical-align: top;"> <span data-i18n="label.filter_changes_help"></span></input>
+    </div>
+</script>
+
+<script type='text/javascript'>
+    RED.nodes.registerType('zigbee2mqtt-eb-in', {
+        category: 'ZigBee2MQTT',
+        color: '#FDBF48',
+        defaults: {
+            name: {
+                value: ""
+            },
+            server: {
+                type: "zigbee2mqtt-eb-server",
+                required: true
+            },
+            friendly_name: {
+                value: "",
+                required: false
+            },
+            device_id: {
+                value: null,
+                required: true
+            },
+            state: {
+                value: null
+            },
+            outputAtStartup: {
+                value: true,
+                required: true
+            },
+            filterChanges: {
+                value: false,
+                required: true
+            },
+            enableMultiple: {
+                value: false,
+                required: true
+            },
+        },
+        inputs: 0,
+        outputs: 1,
+        outputLabels: ["value"],
+        paletteLabel: 'in',
+        icon: "icon.png",
+        label: function () {
+            var label = 'z2m-input';
+
+            if (this.name) {
+                label = this.name;
+            } else if (typeof(this.friendly_name) == 'string' && this.friendly_name.length) {
+                label = this.friendly_name;
+            } else if (typeof(this.device_id) == 'string') {
+                label = this.device_id;
+            }
+
+            return label;
+        },
+        oneditprepare: function () {
+            let node = this;
+
+            setTimeout(()=>{
+                new Zigbee2MqttEditor(node).build();
+            }, 100); //need timeout to load server node
+        },
+        oneditsave: function () {
+            //convert array for string if single mode
+            if (!$('#node-input-enableMultiple').is(':checked')) {
+                let device_id = $('#node-input-device_id').multipleSelect('getSelects', 'value');
+                this.device_id = device_id.length ? device_id[0] : null;
+            }
+
+            let selectedOptions = $('#node-input-device_id option:selected');
+            if (selectedOptions) {
+                this.topic = selectedOptions.map(function () {
+                    return $(this).val();
+                });
+            } else {
+                this.topic = null;
+            }
+
+            let $property = $('#node-input-state');
+            this.state = $property.val()!=='0'?$property.val():null;
+        }
+    });
+
+</script>

package/nodes/in.js

@@ -0,0 +1,123 @@
+module.exports = function(RED) {
+    class Zigbee2mqttNodeIn {
+        constructor(config) {
+            RED.nodes.createNode(this, config);
+
+            let node = this;
+            node.config = config;
+            node.firstMsg = true;
+            node.cleanTimer = null;
+            node.server = RED.nodes.getNode(node.config.server);
+            node.last_value = null;
+            node.last_successful_status = {};
+            node.status({});
+
+            if (node.server) {
+                node.listener_onMQTTAvailability = function(data) { node.onMQTTAvailability(data); }
+                node.server.on('onMQTTAvailability', node.listener_onMQTTAvailability);
+
+                node.listener_onConnectError = function(data) { node.onConnectError(); }
+                node.server.on('onConnectError', node.listener_onConnectError);
+
+                node.listener_onMQTTMessage = function(data) { node.onMQTTMessage(data); }
+                node.server.on('onMQTTMessage', node.listener_onMQTTMessage);
+
+                node.listener_onMQTTBridgeState = function(data) { node.onMQTTBridgeState(data); }
+                node.server.on('onMQTTBridgeState', node.listener_onMQTTBridgeState);
+
+                node.on('close', () => node.onClose());
+
+            } else {
+                node.status({
+                    fill: "red",
+                    shape: "dot",
+                    text: "@evilbunny/node-red-contrib-zigbee2mqtt/in:status.no_server"
+                });
+            }
+        }
+
+        onMQTTAvailability(data) {
+            let node = this;
+
+            if (data.item && 'ieee_address' in data.item && data.item.ieee_address === node.config.device_id) {
+                node.server.nodeSend(node, {
+                    'node_send': false
+                });
+            }
+        }
+
+        onMQTTMessage(data) {
+            let node = this;
+
+            if (node.config.enableMultiple) {
+                if (data.item &&
+                    (("ieee_address" in data.item && (node.config.device_id).includes(data.item.ieee_address))
+                        ||  ("id" in data.item && (node.config.device_id).includes(data.item.id)))
+                ) {
+                    node.server.nodeSend(node, {
+                        'changed' : data
+                    });
+                }
+
+
+            } else {
+                if (data.item &&
+                    (("ieee_address" in data.item && data.item.ieee_address === node.config.device_id)
+                        ||  ("id" in data.item && parseInt(data.item.id) === parseInt(node.config.device_id)))
+                ) {
+                    node.server.nodeSend(node, {
+                        'filter':  node.config.filterChanges
+                    });
+                }
+            }
+
+        }
+
+        onMQTTBridgeState(data) {
+            let node = this;
+            if (data.payload) {
+                node.status(node.last_successful_status);
+            } else {
+                node.onConnectError();
+            }
+        }
+
+        onConnectError() {
+            this.status({
+                fill: "red",
+                shape: "dot",
+                text: "@evilbunny/node-red-contrib-zigbee2mqtt/in:status.no_connection"
+            });
+        }
+
+
+        onClose() {
+            let node = this;
+
+            if (node.listener_onMQTTAvailability) {
+                node.server.removeListener("onMQTTAvailability", node.listener_onMQTTAvailability);
+            }
+            if (node.listener_onConnectError) {
+                node.server.removeListener("onConnectError", node.listener_onConnectError);
+            }
+            if (node.listener_onMQTTMessage) {
+                node.server.removeListener("onMQTTMessage", node.listener_onMQTTMessage);
+            }
+            if (node.listener_onMQTTBridgeState) {
+                node.server.removeListener("onMQTTBridgeState", node.listener_onMQTTBridgeState);
+            }
+
+            node.onConnectError();
+        }
+
+        setSuccessfulStatus(obj) {
+            this.status(obj);
+            this.last_successful_status = obj;
+        }
+
+    }
+    RED.nodes.registerType('zigbee2mqtt-eb-in', Zigbee2mqttNodeIn);
+};
+
+
+

package/nodes/locales/en-US/bridge.html

@@ -0,0 +1,23 @@
+<script type="text/x-red" data-help-name="zigbee2mqtt-eb-bridge">
+    <p>Listens all <code>zigbee2mqtt/bridge/#</code> messages.</p>
+    <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt class="optional">Name <span class="property-type">string</span></dt><dd>Choose any name to identify your node.</dd>
+        <dt>Server <span class="property-type">object</span></dt><dd>Choose the zigbee2mqtt server instance to use.</dd>
+    </dl>
+
+    <h3>Inputs</h3>
+    <h5>Input</h5>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">string</span></dt><dd>mqtt message</dd>
+        <dt>topic<span class="property-type">string</span></dt><dd>mqtt topic</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <h5>Output</h5>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">string</span></dt><dd>mqtt message</dd>
+        <dt>topic<span class="property-type">string</span></dt><dd>mqtt topic</dd>
+    </dl>
+</script>
+

package/nodes/locales/en-US/bridge.json

@@ -0,0 +1,84 @@
+{
+    "label": {
+        "name": "Name",
+        "server": "Server",
+        "permit_join": "Permit Join",
+        "permit_join_help": "Start searching devices for 3 minutes",
+        "permit_join_cancel_help": "Stop search",
+        "log_level": "Log Level",
+        "log_level_info": "info",
+        "log_level_debug": "debug",
+        "log_level_warning": "warning",
+        "log_level_error": "error",
+        "version": "Version",
+        "restart_required": "Restart required",
+        "no_legacy_api": "No Legacy API",
+        "coordinator": "Coordinator",
+        "turn_off_legacy_api": "Should be off",
+        "restart_needed": "Restart needed",
+        "ok": "OK",
+        "advanced_output": "Output json",
+        "should_be_json": "Should be 'json'",
+        "restart_zigbee2mqtt": "Restart zigbee2mqtt",
+        "retain_disabled_error": "force_disable_retain should be FALSE",
+        "mqtt_disable_retain": "Retain mqtt",
+        "restart": "Restart",
+        "disabled": "disabled",
+        "last_seen": "Last seen",
+        "availability": "Availability",
+        "sure_restart": "Are you sure?",
+        "refresh": "Refresh",
+        "refresh_all": "Refresh all data"
+    },
+    "placeholder": {
+        "name": "Name"
+    },
+    "status": {
+        "no_server": "no server",
+        "no_device": "no device",
+        "no_value": "no value",
+        "no_connection": "no connection",
+        "searching": "looking for devices...",
+        "paired": "paired!",
+        "online": "online",
+        "offline": "offline",
+        "pairing": "pairing...",
+        "connected": "connected",
+        "failed": "failed!"
+    },
+    "tabs": {
+        "bridge": "Bridge",
+        "devices":  "Devices",
+        "groups":  "Groups",
+        "map":  "Map"
+    },
+    "devices": {
+        "ieee_addr": "ieee_address",
+        "friendly_name": "Friendly name",
+        "model": "Model",
+        "device": "Device",
+        "set": "set",
+        "remove": "remove",
+        "sure_remove": "Are you sure you want to remove device?"
+    },
+    "groups": {
+        "id": "ID",
+        "friendly_name": "Friendly name",
+        "devices": "Devices",
+        "set": "set",
+        "remove": "remove",
+        "add": "Add group",
+        "enter_group_name": "Enter group name",
+        "sure_remove": "Are you sure you want to remove group?"
+    },
+    "map": {
+        "refresh": "Refresh map",
+        "fullscreen": "Open in full screen",
+        "loading": "Loading..."
+    },
+    "tokeninput": {
+        "searching": "Searching...",
+        "type_to_search": "Type to search device",
+        "no_results": "No results"
+    }
+}

package/nodes/locales/en-US/get.html

@@ -0,0 +1,19 @@
+<script type="text/x-red" data-help-name="zigbee2mqtt-eb-get">
+    <p>Get last value of device.</p>
+    <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt class="optional">Name <span class="property-type">string</span></dt><dd>Choose any name to identify your node</dd>
+        <dt>Server <span class="property-type">object</span></dt><dd>Choose the zigbee2mqtt server instance to use</dd>
+        <dt>Device <span class="property-type">string</span></dt><dd>Select device to listen to</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <h5>Output</h5>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">string</span></dt><dd>current value</dd>
+        <dt>payload_in<span class="property-type">object</span></dt><dd>input payload</dd>
+        <dt>payload_raw<span class="property-type">object</span></dt><dd>complete payload</dd>
+        <dt>device<span class="property-type">object</span></dt><dd>device info</dd>
+    </dl>
+</script>
+