iobroker.alpha-ess 0.3.0 → 0.5.0

package/README.md

@@ -37,6 +37,14 @@ The password is stored encrypted and must therefore be entered manually: demo
 **All product and company names or logos are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them or any associated subsidiaries! This personal project is maintained in spare time and has no business goal.**
 
 ## Changelog
+### 0.5.0 (2023-03-05)
+* (Gaspode) Remove no more supported states at startup automatically
+* (Gaspode) Prepared data migration for future versions
+
+### 0.4.0 (2023-02-16)
+* (Gaspode) Optimized deletion of group states
+* (Gaspode) Added new Realtime state for pmeter_dc
+
 ### 0.3.0 (2023-02-11)
 * (Gaspode) Rearranged statistical data and added more values. Many thanks to [Thorsten](https://github.com/ThorstenBoettler) for his valuable contribution in testing the early alpha versions of this release and providing informative suggestions and recommendations for new data points.
 * (Gaspode) Added Summary data 

package/io-package.json

@@ -1,8 +1,34 @@
 {
   "common": {
     "name": "alpha-ess",
-    "version": "0.3.0",
+    "version": "0.5.0",
     "news": {
+      "0.5.0": {
+        "en": "Remove no more supported states at startup automatically\nPrepared data migration for future versions",
+        "de": "Entfernen Sie keine unterstützten Zustände beim Start automatisch\nVorbereitete Datenmigration für zukünftige Versionen",
+        "ru": "Удалить больше не поддерживаемых состояний при запуске автоматически\nПодготовленная миграция данных для будущих версий",
+        "pt": "Remover estados não mais suportados na inicialização automaticamente\nMigração de dados preparada para versões futuras",
+        "nl": "Verwijder geen ondersteunende staten bij start-up automatisch\nVertaling:",
+        "fr": "Enlever plus d'états supportés au démarrage automatiquement\nMigration de données préparée pour les versions futures",
+        "it": "Non rimuovere più stati supportati all'avvio automaticamente\nMigrazione dei dati preparata per le versioni future",
+        "es": "Eliminar no más estados compatibles en el inicio automáticamente\nMigración de datos preparada para futuras versiones",
+        "pl": "Remove nie będzie więcej wspieranych państw\nWstępna migracja danych do przyszłych wersji",
+        "uk": "Видаліть не більше підтримуваних держав при запуску автоматично\nПідготовка міграції даних для майбутніх версій",
+        "zh-cn": "自动取消不再支持的开办国家\n今后版本的准备数据迁移"
+      },
+      "0.4.0": {
+        "en": "Optimized deletion of group states\nAdded new Realtime state for pmeter_dc",
+        "de": "Optimiertes Löschen von Gruppenzuständen\nNeuer Realtime-Zustand für pmeter_dc hinzugefügt",
+        "ru": "Оптимизированное удаление групповых государств\nДобавлено новое состояние в режиме реального времени для pmeter_dc",
+        "pt": "Eliminação otimizada de estados de grupo\nAdicionado novo estado em tempo real para pmeter_dc",
+        "nl": "Optimaal deletie van de groepsstaat\nVoegde nieuwe Realtime staat toe voor begraafplaats",
+        "fr": "Suppression optimisée des états de groupe\nAjout d'un nouvel état en temps réel pour pmeter_dc",
+        "it": "Eliminazione ottimizzata degli stati di gruppo\nAggiunto nuovo stato in tempo reale per pmeter_dc",
+        "es": "Eliminación optimizada de estados de grupo\nNuevo estado en tiempo real añadido para pmeter_dc",
+        "pl": "Ostateczne delecje grupowych stanów\nNowy stan rzeczywisty",
+        "uk": "Оптимальне видалення групових станів\nДодано новий стан в режимі реального часу для pmeter_dc",
+        "zh-cn": "删除集团国家\n添加新实时状态"
+      },
       "0.3.0": {
         "en": "Rearranged statistical data and added more values. Many thanks to [Thorsten](https://github.com/ThorstenBoettler) for his valuable contribution in testing the early alpha versions of this release and providing informative suggestions and recommendations for new data points.\nAdded Summary data \nRefactored complete implementation\nChanged the unit of settings for all intervals, except of realtime data, to minutes (Caution: settings are reset to defaults)\nRemove disabled states at adapter startup\nRemoved no more supported value 'createtime' (state ID Realtime.Last_update). \nOptimized rounding for selected values",
         "de": "Rearrangierte statistische Daten und fügte weitere Werte hinzu. Vielen Dank an [Thorsten](https://github.com/ThorstenBoettler) für seinen wertvollen Beitrag bei der Prüfung der frühen Alpha-Versionen dieser Veröffentlichung und Bereitstellung informativer Vorschläge und Empfehlungen für neue Datenpunkte.\nZusammenfassung Daten\nRefactored complete Implementation\nÄnderte die Einheit der Einstellungen für alle Intervalle, mit Ausnahme von Echtzeitdaten, in Minuten (Vorsicht: Einstellungen werden auf Standardeinstellungen zurückgesetzt)\nEntfernen von deaktivierten Zuständen bei Adapter-Start\nKeine unterstützte Wert-Erstellung entfernt (state ID Realtime.Last_update).\nOptimierte Rundung für ausgewählte Werte",
@@ -67,32 +93,6 @@
         "pl": "Zmniejszenie żądań dotyczących trwałych błędów",
         "uk": "Повільні запити у разі постійних помилок",
         "zh-cn": "长期错误请求下降"
-      },
-      "0.0.6-beta.4": {
-        "en": "Changed adapter type from metering to energy",
-        "de": "Geänderter Adaptertyp von der Dosierung bis zur Energie",
-        "ru": "Измененный тип адаптера от измерения до энергии",
-        "pt": "Tipo de adaptador alterado de medição para energia",
-        "nl": "Veranderde adapter type van meting naar energie",
-        "fr": "Type d'adaptateur modifié de mesure à énergie",
-        "it": "Tipo di adattatore modificato dalla misurazione all'energia",
-        "es": "Tipo de adaptador cambiado de medición a energía",
-        "pl": "Zmienił adapter typu z metrowania do energii",
-        "uk": "Змінений тип адаптера від вимірювальної енергії",
-        "zh-cn": "能源参数的变量"
-      },
-      "0.0.6-beta.3": {
-        "en": "Correction for NPM",
-        "de": "Korrektur für NPM",
-        "ru": "Коррекция для NPM",
-        "pt": "Correção para NPM",
-        "nl": "Correctie voor NPM",
-        "fr": "Correction pour les mécanismes nationaux de prévention",
-        "it": "Correzione per NPM",
-        "es": "Corrección para el mecanismo nacional de prevención",
-        "pl": "Poprawka dla NPM",
-        "uk": "Корекція для NPM",
-        "zh-cn": "国家防范机制的纠正"
       }
     },
     "titleLang": {

package/main.js

@@ -107,6 +107,15 @@ class AlphaEss extends utils.Adapter {
                     , unit: 'W'
                     , dayIndex: false
                 }
+                , {
+                    alphaAttrName: 'pmeter_dc'
+                    , role: 'value.power'
+                    , id: 'PV_meter_power'
+                    , name: 'PV meter power'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                }
                 , {
                     alphaAttrName: 'preal_l1'
                     , role: 'value.power'
@@ -617,6 +626,9 @@ class AlphaEss extends utils.Adapter {
             RefreshToken: ''
         };
 
+        this.setObjectNormalAsync = this.setObjectNotExistsAsync.bind(this);
+        this.setObjectMigrationAsync = this.setObjectAsync.bind(this);
+
         this.createdStates = [];
 
         this.errorCount = 0;
@@ -649,24 +661,42 @@ class AlphaEss extends utils.Adapter {
             this.log.debug('config updateUnchangedStates:            ' + this.config.updateUnchangedStates);
             this.wrongCredentials = false;
 
+            await this.setObjectNotExistsAsync('info.version', {
+                type: 'state',
+                common: {
+                    name: 'Adapter Version'
+                    , type: 'string'
+                    , role: 'value'
+                    , read: true
+                    , write: false
+                },
+                native: {},
+            });
+
+            if (await this.isMigrationNecessary()) {
+                this.log.info('States will be migrated.');
+            }
+
             await this.resetAuth();
 
             if (this.config.password && this.config.username && this.config.systemId) {
 
                 for (const gidx of Object.keys(this.stateInfoList)) {
-                    const group = this.stateInfoList[gidx];
-                    if (this.config[group.enabledName]) {
-                        await group.fnct(group.Group);
+                    const groupInfo = this.stateInfoList[gidx];
+                    if (this.config[groupInfo.enabledName]) {
+                        await groupInfo.fnct(groupInfo.Group);
                     }
                     else {
-                        this.log.info(group.Group + ' data disabled! Adapter won\'t fetch ' + group.Group + ' data. According states deleted.');
-                        await this.deleteStatesForGroup(group.Group);
+                        this.log.info(groupInfo.Group + ' data disabled! Adapter won\'t fetch ' + groupInfo.Group + ' data. According states deleted.');
+                        await this.delObjectAsync(groupInfo.Group, { recursive: true });
                     }
                 }
             }
             else {
                 this.log.error('No username, password and/or system ID set! Adapter won\'t fetch any data.');
             }
+
+            await this.setStateAsync('info.version', this.version, true);
         }
         catch (e) {
             this.log.error('onReady Exception occurred: ' + e);
@@ -700,41 +730,15 @@ class AlphaEss extends utils.Adapter {
     onStateChange(id, state) {
         if (state) {
             // The state was changed
-            this.log.info(`state ${id} changed: ${state.val} (ack = ${state.ack})`);
+            this.log.debug(`state ${id} changed: ${state.val} (ack = ${state.ack})`);
         } else {
             // The state was deleted
-            this.log.info(`state ${id} deleted`);
+            this.log.debug(`state ${id} deleted`);
         }
     }
 
     /**
-     * Delete all states for a given group (async, so it can be used in a Promise)
-     * @param {string} group
-     */
-    async deleteStatesForGroupAsync(group) {
-        const states = await this.getStatesAsync(group + '.*');
-        for (const id in states) {
-            this.log.info(id + ': ' + JSON.stringify(states[id]));
-            await this.delObjectAsync(id);
-        }
-    }
-
-    /**
-     * Delete all states for a given group
-     * @param {string} group
-     */
-    deleteStatesForGroup(group) {
-        return new Promise((resolve) => {
-            this.deleteStatesForGroupAsync(group).then(() => {
-                resolve(true);
-            }).catch(e => {
-                this.log.warn('Error: ' + e + '. Deletion of group ' + group + ' failed!');
-                resolve(false);
-            });
-        });
-    }
-
-    /** Stop a timer for a given group
+     * Stop a timer for a given group
      *
      * @param {string} group
      */
@@ -978,21 +982,71 @@ class AlphaEss extends utils.Adapter {
         }
     }
 
+    /**
+     * Answer if the states shall be migrated, i.e. overwritten.
+     * This is called a view times at startup only.
+     */
+    async isMigrationNecessary() {
+        const oldVersionState = await this.getStateAsync('info.version');
+        if (oldVersionState) {
+            const oldVersion = '' + oldVersionState.val;
+            const vParts = oldVersion.split('.');
+            if (vParts.length >= 3) {
+                const major = Number.parseInt(vParts[0]);
+                const minor = Number.parseInt(vParts[1]);
+                if (major == 0 && minor > 4 || major > 0) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
     /**
      * Create states when called the first time, update state values in each call
-     * @param {string} groupName
+     * @param {string} group
      * @param {{ [s: string]: any; }} data
      */
-    async createAndUpdateStates(groupName, data) {
+    async createAndUpdateStates(group, data) {
         try {
             if (data) {
                 const idx = new Date().getDate() - 1;
 
-                for (const [alphaAttrName, rawValue] of Object.entries(data)) {
-                    const stateInfo = this.getStateInfo(groupName, alphaAttrName);
-                    if (stateInfo) {
-                        if (!this.createdStates[groupName]) {
-                            await this.setObjectNotExistsAsync(groupName + '.' + this.osn(stateInfo.id), {
+                if (!this.createdStates[group]) {
+
+                    // Delete no longer supported states for this group
+                    const gidx = this.stateInfoList.findIndex(i => i.Group == group);
+                    if (gidx >= 0) {
+                        const groupStateList = this.stateInfoList[gidx].states;
+                        const states = await this.getStatesAsync(group + '.*');
+                        for (const sid in states) {
+                            const parts = sid.split('.');
+                            const id = parts[parts.length - 1];
+                            if (groupStateList.findIndex(i => i.id == id) == -1) {
+                                this.log.info('State ' + group + '.' + id + ' removed, no longer supported.');
+                                await this.delObjectAsync(group + '.' + id);
+                            }
+                        }
+                    }
+
+                    const setObjectFunc = await this.isMigrationNecessary() ? this.setObjectMigrationAsync : this.setObjectNormalAsync;
+
+                    // Create the folder for this group
+                    await setObjectFunc(group, {
+                        type: 'folder',
+                        common: {
+                            name: group
+                            , read: true
+                            , write: false
+                        },
+                        native: {}
+                    });
+
+                    // Create all states for received elements
+                    for (const [alphaAttrName, rawValue] of Object.entries(data)) {
+                        const stateInfo = this.getStateInfo(group, alphaAttrName);
+                        if (stateInfo) {
+                            await setObjectFunc(group + '.' + this.osn(stateInfo.id), {
                                 type: 'state',
                                 common: {
                                     name: stateInfo.name + ' [' + stateInfo.alphaAttrName + ']'
@@ -1007,6 +1061,18 @@ class AlphaEss extends utils.Adapter {
                                 native: {},
                             });
                         }
+                        else {
+                            this.log.debug('Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue);
+                        }
+                    }
+                    this.log.info('Initialized states for : ' + group);
+                    this.createdStates[group] = true;
+                }
+
+                // Set values for received states
+                for (const [alphaAttrName, rawValue] of Object.entries(data)) {
+                    const stateInfo = this.getStateInfo(group, alphaAttrName);
+                    if (stateInfo) {
                         let value = '';
                         if (stateInfo.dayIndex) {
                             value = rawValue[idx];
@@ -1014,7 +1080,7 @@ class AlphaEss extends utils.Adapter {
                         else {
                             value = rawValue;
                         }
-                        this.log.silly(groupName + '.' + this.osn(stateInfo.id) + ':' + value);
+                        this.log.silly(group + '.' + this.osn(stateInfo.id) + ':' + value);
                         let tvalue;
                         switch (stateInfo.type) {
                             case 'number':
@@ -1040,25 +1106,15 @@ class AlphaEss extends utils.Adapter {
                             default:
                                 tvalue = value;
                         }
-
                         if (this.config.updateUnchangedStates) {
-                            await this.setStateAsync(groupName + '.' + this.osn(stateInfo.id), tvalue, true);
+                            await this.setStateAsync(group + '.' + this.osn(stateInfo.id), tvalue, true);
                         }
                         else {
-                            await this.setStateChangedAsync(groupName + '.' + this.osn(stateInfo.id), tvalue, true);
-                        }
-                        this.log.debug('Received object ' + groupName + '.' + this.osn(stateInfo.alphaAttrName) + ' with value ' + rawValue);
-                    }
-                    else {
-                        if (!this.createdStates[groupName]) {
-                            this.log.info('Skipped object ' + groupName + '.' + alphaAttrName + ' with value ' + rawValue);
+                            await this.setStateChangedAsync(group + '.' + this.osn(stateInfo.id), tvalue, true);
                         }
+                        this.log.debug('Received object ' + group + '.' + this.osn(stateInfo.alphaAttrName) + ' with value ' + rawValue);
                     }
                 }
-                if (!this.createdStates[groupName]) {
-                    this.log.info('Created states for : ' + groupName);
-                    this.createdStates[groupName] = true;
-                }
             }
         }
         catch (e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.alpha-ess",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Read and write data from and to Alpha ESS systems.",
   "author": {
     "name": "Gaspode",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@iobroker/adapter-core": "^2.6.7",
-    "axios": "^1.3.0"
+    "axios": "^1.3.4"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.5.9",
@@ -33,13 +33,13 @@
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.11.18",
+    "@types/node": "^18.14.2",
     "@types/proxyquire": "^1.3.28",
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.9",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.33.0",
+    "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.1",
     "mocha": "^10.2.0",