@evilbunny/node-red-contrib-zigbee2mqtt 3.2.6 → 3.2.9

package/README.md

@@ -5,15 +5,15 @@ I've made other improvements, such as more state options to support ZigBee devic
 
 # @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/node-red-contrib-zigbee2mqtt.svg)](https://nodejs.org/en/)
+[![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/node-red-contrib-zigbee2mqtt.svg)](https://packagequality.com/#?package=node-red-contrib-zigbee2mqtt)
+[![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/node-red-contrib-zigbee2mqtt.svg)
-![NPM Downloads per month](https://img.shields.io/npm/dm/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.

package/nodes/server.js

@@ -464,19 +464,49 @@ module.exports = function(RED) {
             }
 
             let useProperty = null;
-            if (node.config.state && node.config.state !== '0') {
-                if (item.homekit && node.config.state.split("homekit_").join('') in item.homekit) {
-                    payload = item.homekit[node.config.state.split("homekit_").join('')];
-                    useProperty = node.config.state.split("homekit_").join('');
-                } else if (payload_all && node.config.state in payload_all) {
-                    payload = text = payload_all[node.config.state];
-                    useProperty = node.config.state;
-                } else {
-                    //state was not found in payload (button case)
+            // normalize config.state: supports the new array format, and legacy single-string configs
+            let stateList = node.config.state;
+            if (typeof stateList === 'string') {
+                stateList = (stateList && stateList !== '0') ? [stateList] : [];
+            }
+            if (!Array.isArray(stateList)) {
+                stateList = [];
+            }
+
+            if (stateList.length) {
+                let collected = {};
+                let foundAny = false;
+
+                for (let prop of stateList) {
+                    let homekitKey = prop.split("homekit_").join('');
+                    if (item.homekit && homekitKey in item.homekit) {
+                        collected[prop] = item.homekit[homekitKey];
+                        useProperty = homekitKey;
+                        foundAny = true;
+                    } else if (payload_all && prop in payload_all) {
+                        collected[prop] = payload_all[prop];
+                        useProperty = prop;
+                        foundAny = true;
+                    }
+                    // if a requested property isn't present on this message, it's just skipped
+                    // (e.g. a button event won't carry every sensor property)
+                }
+
+                if (!foundAny) {
+                    //none of the requested properties were found in payload (button case)
                     //payload: { last_seen: '2022-07-27T15:25:22+03:00', linkquality: 36 }
                     //payload: { action: 'single', last_seen: '2022-07-27T15:25:22+03:00', linkquality: 36 }
                     return;
                 }
+
+                if (stateList.length === 1) {
+                    // preserve existing behaviour: a single selected property outputs its raw value
+                    payload = text = collected[stateList[0]];
+                } else {
+                    // multiple selected properties: output an object containing just those keys
+                    payload = collected;
+                    useProperty = null; // unit-suffix below only makes sense for a single property
+                }
             } else {
                 payload = payload_all;
             }

package/package.json

@@ -5,7 +5,7 @@
   },
   "name": "@evilbunny/node-red-contrib-zigbee2mqtt",
   "description": "Fork of Zigbee2mqtt connectivity nodes for node-red",
-  "version": "3.2.6",
+  "version": "3.2.9",
   "publishConfig": {
     "access": "public"
   },

package/resources/js/{zigbee2mqtt-helpers.js → node-red-contrib-zigbee2mqtt-helpers.js}

@@ -74,10 +74,10 @@ class Zigbee2MqttEditor {
             dropWidth: 320,
             width: 320,
             filter: true,
-            formatAllSelected:function(){return RED._("@evilbunny/zigbee2mqtt/server:editor.select_device")}
+            formatAllSelected:function(){return RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.select_device")}
         };
         if (that.config.allow_empty && !that.isMultiple()) {
-            params.formatAllSelected = function(){return RED._("@evilbunny/zigbee2mqtt/server:editor.msg_topic")};
+            params.formatAllSelected = function(){return RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.msg_topic")};
         }
 
         that.getDeviceIdInput().children().remove();
@@ -97,7 +97,7 @@ class Zigbee2MqttEditor {
             return (a.friendly_name || '').localeCompare(b.friendly_name || '', undefined, {sensitivity: 'base'});
         });
         if (groups.length) {
-            html = $('<optgroup/>', {label: RED._("@evilbunny/zigbee2mqtt/server:editor.groups")});
+            html = $('<optgroup/>', {label: RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.groups")});
             html.appendTo(that.getDeviceIdInput());
             $.each(groups, function(index, value) {
                 let text = '';
@@ -115,7 +115,7 @@ class Zigbee2MqttEditor {
             return (a.friendly_name || '').localeCompare(b.friendly_name || '', undefined, {sensitivity: 'base'});
         });
         if (devices.length) {
-            html = $('<optgroup/>', {label: RED._("@evilbunny/zigbee2mqtt/server:editor.devices")});
+            html = $('<optgroup/>', {label: RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.devices")});
             html.appendTo(that.getDeviceIdInput());
             $.each(devices, function(index, value) {
                 var model = '';
@@ -148,16 +148,15 @@ class Zigbee2MqttEditor {
             numberDisplayed: 1,
             dropWidth: 320,
             width: 320,
-            single: !(typeof $(this).attr('multiple') !== typeof undefined && $(this).attr('multiple') !== false)
+            single: false, // always allow selecting multiple attributes; no selection = complete payload
+            placeholder: RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.complete_payload")
         }).multipleSelect('disable');
 
-        that.getDevicePropertyInput().html('<option value="0">'+ RED._("@evilbunny/zigbee2mqtt/server:editor.complete_payload")+'</option>');
-
         let html = '';
         let device = that.getDevice();
 
         if (device && 'definition' in device && device.definition && 'exposes' in device.definition) {
-            html = $('<optgroup/>', {label: RED._("@evilbunny/zigbee2mqtt/server:editor.zigbee2mqtt")});
+            html = $('<optgroup/>', {label: RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.zigbee2mqtt")});
             html.appendTo(that.getDevicePropertyInput());
 
             $.each(device.definition.exposes, function(index, value) {
@@ -179,7 +178,7 @@ class Zigbee2MqttEditor {
         }
 
         if (device && 'homekit' in device && device.homekit && Object.keys(device.homekit).length) {
-            html = $('<optgroup/>', {label: RED._("@evilbunny/zigbee2mqtt/server:editor.homekit")});
+            html = $('<optgroup/>', {label: RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.homekit")});
             html.appendTo(that.getDevicePropertyInput());
 
             $.each(device.homekit, function (index, value) {
@@ -187,11 +186,22 @@ class Zigbee2MqttEditor {
             });
         }
         that.getDevicePropertyInput().multipleSelect('enable');
-        if (that.getDevicePropertyInput().find('option[value='+that.property+']').length) {
-            that.getDevicePropertyInput().val(that.property);
-        } else {
-            that.getDevicePropertyInput().val(that.getDevicePropertyInput().find('option').eq(0).attr('value'));
+
+        // restore previously-selected properties (supports legacy single-string values too)
+        let selected = that.property;
+        if (typeof selected === 'string') {
+            selected = selected && selected !== '0' ? [selected] : [];
         }
+        if (!Array.isArray(selected)) {
+            selected = [];
+        }
+        // drop any selections that no longer exist as options for this device
+        selected = selected.filter(function(value) {
+            return that.getDevicePropertyInput().find('option[value="' + value + '"]').length > 0;
+        });
+        that.property = selected;
+        that.getDevicePropertyInput().multipleSelect('setSelects', selected);
+
         that.getDevicePropertyInput().multipleSelect('refresh');
     }
 
@@ -218,7 +228,7 @@ class Zigbee2MqttEditor {
         // console.log('BUILD buildDeviceOptionsInput');
         let device = that.getDevice();
         let options = [];
-        options.push({'value': 'nothing', 'label': RED._("@evilbunny/zigbee2mqtt/server:editor.nothing"), options:['']});
+        options.push({'value': 'nothing', 'label': RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.nothing"), options:['']});
         options.push('msg');
         options.push('json');
         if (device && 'definition' in device && device.definition && 'options' in device.definition) {
@@ -401,7 +411,7 @@ class Zigbee2MqttEditor {
             if (!that.device_id) {
                 that.device_id = [];
             }
-            that.getDeviceFriendlyNameInput().val(that.device_id.length + ' ' + RED._("@evilbunny/zigbee2mqtt/server:editor.selected"));
+            that.getDeviceFriendlyNameInput().val(that.device_id.length + ' ' + RED._("@evilbunny/node-red-contrib-zigbee2mqtt/server:editor.selected"));
         } else if (that.device_id && that.device_id.length) {
             if (typeof(that.device_id) == 'object') {
                 that.device_id = that.device_id[0]; //get the first device