zigbee-herdsman-converters 14.0.267 → 14.0.268

package/converters/toZigbee.js

@@ -4625,17 +4625,23 @@ const converters = {
         convertSet: async (entity, key, value, meta) => {
             const isGroup = entity.constructor.name === 'Group';
             const groupid = isGroup ? entity.groupID : 0;
-            const sceneid = value;
+            let sceneid = value;
+            let scenename = null;
+            if (typeof value === 'object') {
+                sceneid = value.ID;
+                scenename = value.name;
+            }
+
             const response = await entity.command('genScenes', 'store', {groupid, sceneid}, utils.getOptions(meta.mapped));
 
             if (isGroup) {
                 if (meta.membersState) {
                     for (const member of entity.members) {
-                        utils.saveSceneState(member, sceneid, groupid, meta.membersState[member.getDevice().ieeeAddr]);
+                        utils.saveSceneState(member, sceneid, groupid, meta.membersState[member.getDevice().ieeeAddr], scenename);
                     }
                 }
             } else if (response.status === 0) {
-                utils.saveSceneState(entity, sceneid, groupid, meta.state);
+                utils.saveSceneState(entity, sceneid, groupid, meta.state, scenename);
             } else {
                 throw new Error(`Scene add not succesfull ('${herdsman.Zcl.Status[response.status]}')`);
             }
@@ -4665,15 +4671,11 @@ const converters = {
             };
 
             const isGroup = entity.constructor.name === 'Group';
-            const metaKey = `${sceneid}_${groupid}`;
             if (isGroup) {
                 const membersState = {};
                 for (const member of entity.members) {
-                    if (member.meta.hasOwnProperty('scenes') && member.meta.scenes.hasOwnProperty(metaKey)) {
-                        membersState[member.getDevice().ieeeAddr] = addColorMode(member.meta.scenes[metaKey].state);
-
-                        let recalledState = member.meta.scenes[metaKey].state;
-
+                    let recalledState = utils.getSceneState(member, sceneid, groupid);
+                    if (recalledState) {
                         // add color_mode if saved state does not contain it
                         if (!recalledState.hasOwnProperty('color_mode')) {
                             recalledState = addColorMode(recalledState);
@@ -4688,9 +4690,8 @@ const converters = {
                 }
                 return {membersState};
             } else {
-                if (entity.meta.hasOwnProperty('scenes') && entity.meta.scenes.hasOwnProperty(metaKey)) {
-                    let recalledState = entity.meta.scenes[metaKey].state;
-
+                let recalledState = utils.getSceneState(entity, sceneid, groupid);
+                if (recalledState) {
                     // add color_mode if saved state does not contain it
                     if (!recalledState.hasOwnProperty('color_mode')) {
                         recalledState = addColorMode(recalledState);
@@ -4724,7 +4725,7 @@ const converters = {
             const isGroup = entity.constructor.name === 'Group';
             const groupid = isGroup ? entity.groupID : 0;
             const sceneid = value.ID;
-            const scenename = '';
+            const scenename = value.name;
             const transtime = value.hasOwnProperty('transition') ? value.transition : 0;
 
             const state = {};
@@ -4826,17 +4827,17 @@ const converters = {
 
             if (isGroup || (removeresp.status === 0 || removeresp.status == 133 || removeresp.status == 139)) {
                 const response = await entity.command(
-                    'genScenes', 'add', {groupid, sceneid, scenename, transtime, extensionfieldsets}, utils.getOptions(meta.mapped),
+                    'genScenes', 'add', {groupid, sceneid, scenename: '', transtime, extensionfieldsets}, utils.getOptions(meta.mapped),
                 );
 
                 if (isGroup) {
                     if (meta.membersState) {
                         for (const member of entity.members) {
-                            utils.saveSceneState(member, sceneid, groupid, state);
+                            utils.saveSceneState(member, sceneid, groupid, state, scenename);
                         }
                     }
                 } else if (response.status === 0) {
-                    utils.saveSceneState(entity, sceneid, groupid, state);
+                    utils.saveSceneState(entity, sceneid, groupid, state, scenename);
                 } else {
                     throw new Error(`Scene add not succesfull ('${herdsman.Zcl.Status[response.status]}')`);
                 }
@@ -4857,21 +4858,14 @@ const converters = {
             );
 
             const isGroup = entity.constructor.name === 'Group';
-            const metaKey = `${sceneid}_${groupid}`;
             if (isGroup) {
                 if (meta.membersState) {
                     for (const member of entity.members) {
-                        if (member.meta.scenes && member.meta.scenes.hasOwnProperty(metaKey)) {
-                            delete member.meta.scenes[metaKey];
-                            member.save();
-                        }
+                        utils.deleteSceneState(member, sceneid, groupid);
                     }
                 }
             } else if (response.status === 0) {
-                if (entity.meta.scenes && entity.meta.scenes.hasOwnProperty(metaKey)) {
-                    delete entity.meta.scenes[metaKey];
-                    entity.save();
-                }
+                utils.deleteSceneState(entity, sceneid, groupid);
             } else {
                 throw new Error(`Scene remove not succesfull ('${herdsman.Zcl.Status[response.status]}')`);
             }
@@ -4889,17 +4883,11 @@ const converters = {
             if (isGroup) {
                 if (meta.membersState) {
                     for (const member of entity.members) {
-                        if (member.meta.scenes) {
-                            member.meta.scenes = {};
-                            member.save();
-                        }
+                        utils.deleteSceneState(member);
                     }
                 }
             } else if (response.status === 0) {
-                if (entity.meta.scenes) {
-                    entity.meta.scenes = {};
-                    entity.save();
-                }
+                utils.deleteSceneState(entity);
             } else {
                 throw new Error(`Scene remove all not succesfull ('${herdsman.Zcl.Status[response.status]}')`);
             }

package/lib/utils.js

@@ -271,14 +271,37 @@ function toCamelCase(value) {
     }
 }
 
-function saveSceneState(entity, sceneID, groupID, state) {
+function saveSceneState(entity, sceneID, groupID, state, name) {
     const attributes = ['state', 'brightness', 'color', 'color_temp', 'color_mode'];
     if (!entity.meta.hasOwnProperty('scenes')) entity.meta.scenes = {};
     const metaKey = `${sceneID}_${groupID}`;
-    entity.meta.scenes[metaKey] = {state: filterObject(state, attributes)};
+    entity.meta.scenes[metaKey] = {name, state: filterObject(state, attributes)};
     entity.save();
 }
 
+function deleteSceneState(entity, sceneID=null, groupID=null) {
+    if (entity.meta.scenes) {
+        if (sceneID == null && groupID == null) {
+            entity.meta.scenes = {};
+        } else {
+            const metaKey = `${sceneID}_${groupID}`;
+            if (entity.meta.scenes.hasOwnProperty(metaKey)) {
+                delete entity.meta.scenes[metaKey];
+            }
+        }
+        entity.save();
+    }
+}
+
+function getSceneState(entity, sceneID, groupID) {
+    const metaKey = `${sceneID}_${groupID}`;
+    if (entity.meta.hasOwnProperty('scenes') && entity.meta.scenes.hasOwnProperty(metaKey)) {
+        return entity.meta.scenes[metaKey].state;
+    }
+
+    return null;
+}
+
 function getEntityOrFirstGroupMember(entity) {
     if (entity.constructor.name === 'Group') {
         return entity.members.length > 0 ? entity.members[0] : null;
@@ -381,4 +404,6 @@ module.exports = {
     toSnakeCase,
     toCamelCase,
     normalizeCelsiusVersionOfFahrenheit,
+    deleteSceneState,
+    getSceneState,
 };

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "zigbee-herdsman-converters",
-  "version": "14.0.267",
+  "version": "14.0.268",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zigbee-herdsman-converters",
-  "version": "14.0.267",
+  "version": "14.0.268",
   "description": "Collection of device converters to be used with zigbee-herdsman",
   "main": "index.js",
   "files": [