iobroker.alpha-ess 1.1.1 → 1.2.0-beta.0

package/README.md

@@ -27,8 +27,6 @@ Staring with version 1.0.0-alpha.5, the quality attribute of each state is set a
 
 ## Settings:
 
-<span style="color:red">CAUTION: Currently only Open API is supported because the Closed API was changed by Apha-ESS and cannot be used by third party applications at the moment.</span>
-
 **Used API:** Choose between the inofficial "Closed" API and the official "Open" API
 Depending on the selected API there are different settings available.
 
@@ -65,6 +63,10 @@ How to find SN and Check code for registration is described here: https://github
 **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
+### 1.2.0-beta.0 (2023-11-10)
+
+-   (Gaspode) Added additional realtime attributes for OpenAPI
+
 ### 1.1.1 (2023-11-04)
 
 -   (Gaspode) Closed API adapted to latest Alpha-ESS changes and enabled again

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "alpha-ess",
-    "version": "1.1.1",
+    "version": "1.2.0-beta.0",
     "news": {
+      "1.2.0-beta.0": {
+        "en": "Added additional realtime attributes for OpenAPI",
+        "de": "Zusätzliche Echtzeit-Attribute für OpenAPI hinzugefügt",
+        "ru": "Добавлены дополнительные атрибуты в реальном времени для OpenAPI",
+        "pt": "Adicionado atributos em tempo real adicionais para OpenAPI",
+        "nl": "Toegevoegd aanvullingen voor OpenAPI",
+        "fr": "Ajout d'autres attributs en temps réel pour OpenAPI",
+        "it": "Aggiunto attributi in tempo reale aggiuntivi per OpenAPI",
+        "es": "Atributos adicionales en tiempo real para OpenAPI",
+        "pl": "Dodać dodatkowe atrybuty dla OpenAPI",
+        "uk": "Додано додаткові атрибути в режимі реального часу для OpenAPI",
+        "zh-cn": "增加开放协会实时归属"
+      },
       "1.1.1": {
         "en": "Closed API adapted to latest Alpha-ESS changes and enabled again",
         "de": "Closed API angepasst an neueste Alpha-ESS-Änderungen und wieder aktiviert",
@@ -80,19 +93,6 @@
         "pl": "Zmienił odstępy dla OpenAPI zgodnie z nowymi specjami Alpha-ESS\nUstalono jakość państwa zgodnie z statusem danych",
         "uk": "Змінено дозволені інтервали для OpenAPI відповідно до нових специфікацій Альфа-ESS\nВстановити якість держави відповідно до стану даних",
         "zh-cn": "根据Alpha-ESS的新投机,修改后允许有时间开放性倾向。\n相应地确定数据状况的国家质量"
-      },
-      "1.0.0-alpha.4": {
-        "en": "Writing settings implemented for 'Closed API'",
-        "de": "Schreiben von Settings für 'Closed API' implementiert",
-        "ru": "Настройки написания, реализованные для 'Closed API'",
-        "pt": "Definições de escrita implementadas para ' API fechada'",
-        "nl": "Schrijf instellingen voor 'Closed API'",
-        "fr": "Paramètres de rédaction mis en œuvre pour 'API perdue'",
-        "it": "Impostazioni di scrittura implementate per 'Closed API'",
-        "es": "Configuración de escritura implementada para 'Closed API'",
-        "pl": "Scenariusze zaimplementowali \"zniszczone\" API",
-        "uk": "Написання параметрів, реалізованих для \"Closed API\"",
-        "zh-cn": "A. 落实的封闭环境"
       }
     },
     "titleLang": {

package/main.js

@@ -46,6 +46,51 @@ class OpenAPI {
                     , type: 'number'
                     , unit: 'W'
                 },
+                {
+                    alphaAttrName: 'ppv1'
+                    , role: 'value.power'
+                    , id: 'PV_power_string_1'
+                    , name: 'PV power string 1'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'ppv2'
+                    , role: 'value.power'
+                    , id: 'PV_power_string_2'
+                    , name: 'PV power string 2'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'ppv3'
+                    , role: 'value.power'
+                    , id: 'PV_power_string_3'
+                    , name: 'PV power string 3'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'ppv4'
+                    , role: 'value.power'
+                    , id: 'PV_power_string_4'
+                    , name: 'PV power string 4'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'pmeterDc'
+                    , role: 'value.power'
+                    , id: 'PV_power_meter'
+                    , name: 'PV power meter'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
                 {
                     alphaAttrName: 'pload'
                     , role: 'value.power'
@@ -62,6 +107,30 @@ class OpenAPI {
                     , type: 'number'
                     , unit: '%'
                 },
+                {
+                    alphaAttrName: 'pmeterL1'
+                    , role: 'value.power'
+                    , id: 'Grid_power_L1'
+                    , name: 'Grid power L1'
+                    , type: 'number'
+                    , unit: 'W'
+                },
+                {
+                    alphaAttrName: 'pmeterL2'
+                    , role: 'value.power'
+                    , id: 'Grid_power_L2'
+                    , name: 'Grid power L2'
+                    , type: 'number'
+                    , unit: 'W'
+                },
+                {
+                    alphaAttrName: 'pmeterL3'
+                    , role: 'value.power'
+                    , id: 'Grid_power_L3'
+                    , name: 'Grid power L3'
+                    , type: 'number'
+                    , unit: 'W'
+                },
                 {
                     alphaAttrName: 'pgrid'
                     , role: 'value.power'
@@ -81,10 +150,73 @@ class OpenAPI {
                 {
                     alphaAttrName: 'pev'
                     , role: 'value.power'
-                    , id: 'Charging_pile_total'
-                    , name: 'Charging pile (Wallbox) total'
+                    , id: 'Charging_pile_power_total'
+                    , name: 'Charging pile (Wallbox) power total'
+                    , type: 'number'
+                    , unit: 'W'
+                },
+                {
+                    alphaAttrName: 'prealL1'
+                    , role: 'value.power'
+                    , id: 'Inverter_power_L1'
+                    , name: 'Inverter power L1'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'prealL2'
+                    , role: 'value.power'
+                    , id: 'Inverter_power_L2'
+                    , name: 'Inverter power L2'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'prealL3'
+                    , role: 'value.power'
+                    , id: 'Inverter_power_L3'
+                    , name: 'Inverter power L3'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'ev1Power'
+                    , role: 'value.power'
+                    , id: 'Charging_pile_power_1'
+                    , name: 'Charging pile (Wallbox) power 1'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'ev2Power'
+                    , role: 'value.power'
+                    , id: 'Charging_pile_power_2'
+                    , name: 'Charging pile (Wallbox) power 2'
                     , type: 'number'
                     , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'ev3Power'
+                    , role: 'value.power'
+                    , id: 'Charging_pile_power_3'
+                    , name: 'Charging pile (Wallbox) power 3'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
+                },
+                {
+                    alphaAttrName: 'ev4Power'
+                    , role: 'value.power'
+                    , id: 'Charging_pile_power_4'
+                    , name: 'Charging pile (Wallbox) power 4'
+                    , type: 'number'
+                    , unit: 'W'
+                    , dayIndex: false
                 }]
         },
         {
@@ -2289,34 +2421,15 @@ class AlphaEss extends utils.Adapter {
                     // Create all states for received elements
                     for (const [alphaAttrName, rawValue] of Object.entries(data)) {
                         const stateInfo = this.getStateInfoByAlphaAttrName(group, alphaAttrName);
-                        if (stateInfo) {
-                            // The type checker has a problem with type: stateInfo.type. I have no clue why.
-                            // All possible types are correct and valid. To get rid of the type checker error, we check for valid types:
-                            if (stateInfo.type == 'string' || stateInfo.type == 'boolean' || stateInfo.type == 'number') {
-                                await setObjectFunc(group + '.' + this.osn(stateInfo.id), {
-                                    type: 'state',
-                                    common: {
-                                        name: stateInfo.name + ' [' + stateInfo.alphaAttrName + ']'
-                                        , type: stateInfo.type
-                                        , role: stateInfo.role
-                                        , read: true
-                                        , write: stateInfo.writeable ? stateInfo.writeable : false
-                                        , unit: stateInfo.unit === '{money_type}' ? data['money_type'] : stateInfo.unit === '{moneyType}' ? data['moneyType'] : stateInfo.unit
-                                        , desc: stateInfo.alphaAttrName
-                                    },
-                                    native: {},
-                                });
-                                if (stateInfo.writeable) {
-                                    await this.subscribeStatesAsync(`${group}.${stateInfo.id}`);
-                                    this.log.debug(`Subscribed State: ${group}.${stateInfo.id}`);
-                                }
-                            }
-                            else {
-                                this.log.error('Internal error: Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue + ' because of invalid type definition!');
-                            }
+                        if (typeof data[alphaAttrName] !== 'object') {
+                            this.createStateForAttribute(group, data, rawValue, alphaAttrName, stateInfo, setObjectFunc);
                         }
                         else {
-                            this.log.debug('Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue);
+                            // Look for subvalues:
+                            for (const [alphaAttrName2, rawValue2] of Object.entries(data[alphaAttrName])) {
+                                const stateInfo2 = this.getStateInfoByAlphaAttrName(group, alphaAttrName2);
+                                this.createStateForAttribute(group, data[alphaAttrName], rawValue2, alphaAttrName2, stateInfo2, setObjectFunc);
+                            }
                         }
                     }
                     this.log.info('Initialized states for : ' + group);
@@ -2326,48 +2439,15 @@ class AlphaEss extends utils.Adapter {
                 // Set values for received states
                 for (const [alphaAttrName, rawValue] of Object.entries(data)) {
                     const stateInfo = this.getStateInfoByAlphaAttrName(group, alphaAttrName);
-                    if (stateInfo) {
-                        let value = '';
-                        if (stateInfo.dayIndex) {
-                            value = rawValue[idx];
-                        }
-                        else {
-                            value = rawValue;
-                        }
-                        this.log.silly(group + '.' + this.osn(stateInfo.id) + ':' + value);
-                        let tvalue;
-                        switch (stateInfo.type) {
-                            case 'number':
-                                tvalue = Number.parseFloat(value);
-                                if (stateInfo.factor) {
-                                    tvalue *= stateInfo.factor;
-                                }
-                                if (stateInfo.round) {
-                                    tvalue = (Math.round(tvalue * (10 ** stateInfo.round))) / (10 ** stateInfo.round);
-                                }
-                                break;
-                            case 'boolean':
-                                if (value.toString().toLowerCase() === 'true') {
-                                    tvalue = true;
-                                }
-                                else if (value.toString().toLowerCase() === 'false') {
-                                    tvalue = false;
-                                }
-                                else {
-                                    tvalue = Number.parseInt(value) != 0;
-                                }
-                                break;
-                            default:
-                                tvalue = value;
-                        }
-                        if (this.config.updateUnchangedStates) {
-                            await this.setStateAsync(group + '.' + this.osn(stateInfo.id), { val: tvalue, q: 0 }, true);
-                        }
-                        else {
-                            await this.setStateChangedAsync(group + '.' + this.osn(stateInfo.id), { val: tvalue, q: 0 }, true);
+                    if (typeof data[alphaAttrName] !== 'object') {
+                        this.setValueForAttribute(group, rawValue, stateInfo, idx);
+                    }
+                    else {
+                        // Look for subvalues:
+                        for (const [alphaAttrName2, rawValue2] of Object.entries(data[alphaAttrName])) {
+                            const stateInfo2 = this.getStateInfoByAlphaAttrName(group, alphaAttrName2);
+                            this.setValueForAttribute(group, rawValue2, stateInfo2, idx);
                         }
-                        stateInfo.lastUpdateTs = Date.now();
-                        this.log.debug('Received object ' + group + '.' + this.osn(stateInfo.alphaAttrName) + ' with value ' + rawValue);
                     }
                 }
             }
@@ -2377,6 +2457,101 @@ class AlphaEss extends utils.Adapter {
         }
     }
 
+    /**
+     *
+     * create the state for the received element
+     * @param {string} group
+     * @param {{[x: string]: any;}} data
+     * @param {string} rawValue
+     * @param {string} alphaAttrName
+     */
+    async createStateForAttribute(group, data, rawValue, alphaAttrName, stateInfo, setObjectFunc) {
+        if (stateInfo) {
+            // The type checker has a problem with type: stateInfo.type. I have no clue why.
+            // All possible types are correct and valid. To get rid of the type checker error, we check for valid types:
+            if (stateInfo.type == 'string' || stateInfo.type == 'boolean' || stateInfo.type == 'number') {
+                await setObjectFunc(group + '.' + this.osn(stateInfo.id), {
+                    type: 'state',
+                    common: {
+                        name: stateInfo.name + ' [' + stateInfo.alphaAttrName + ']'
+                        , type: stateInfo.type
+                        , role: stateInfo.role
+                        , read: true
+                        , write: stateInfo.writeable ? stateInfo.writeable : false
+                        , unit: stateInfo.unit === '{money_type}' ? data['money_type'] : stateInfo.unit === '{moneyType}' ? data['moneyType'] : stateInfo.unit
+                        , desc: stateInfo.alphaAttrName
+                    },
+                    native: {},
+                });
+                if (stateInfo.writeable) {
+                    await this.subscribeStatesAsync(`${group}.${stateInfo.id}`);
+                    this.log.debug(`Subscribed State: ${group}.${stateInfo.id}`);
+                }
+            }
+            else {
+                this.log.error('Internal error: Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue + ' because of invalid type definition!');
+            }
+        }
+        else {
+            if (alphaAttrName == 'sysSn' || alphaAttrName == 'theDate') {
+                this.log.debug('Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue);
+            }
+            else {
+                this.log.warn('Skipped object ' + group + '.' + alphaAttrName + ' with value ' + rawValue);
+            }
+        }
+    }
+
+    /**
+     * @param {string} group
+     * @param {string} rawValue
+     */
+    async setValueForAttribute(group, rawValue, stateInfo, idx) {
+        if (stateInfo) {
+            let value = '';
+            if (stateInfo.dayIndex) {
+                value = rawValue[idx];
+            }
+            else {
+                value = rawValue;
+            }
+            this.log.silly(group + '.' + this.osn(stateInfo.id) + ':' + value);
+            let tvalue;
+            switch (stateInfo.type) {
+                case 'number':
+                    tvalue = Number.parseFloat(value);
+                    if (stateInfo.factor) {
+                        tvalue *= stateInfo.factor;
+                    }
+                    if (stateInfo.round) {
+                        tvalue = (Math.round(tvalue * (10 ** stateInfo.round))) / (10 ** stateInfo.round);
+                    }
+                    break;
+                case 'boolean':
+                    if (value.toString().toLowerCase() === 'true') {
+                        tvalue = true;
+                    }
+                    else if (value.toString().toLowerCase() === 'false') {
+                        tvalue = false;
+                    }
+                    else {
+                        tvalue = Number.parseInt(value) != 0;
+                    }
+                    break;
+                default:
+                    tvalue = value;
+            }
+            if (this.config.updateUnchangedStates) {
+                await this.setStateAsync(group + '.' + this.osn(stateInfo.id), { val: tvalue, q: 0 }, true);
+            }
+            else {
+                await this.setStateChangedAsync(group + '.' + this.osn(stateInfo.id), { val: tvalue, q: 0 }, true);
+            }
+            stateInfo.lastUpdateTs = Date.now();
+            this.log.debug('Received object ' + group + '.' + this.osn(stateInfo.alphaAttrName) + ' with value ' + rawValue);
+        }
+    }
+
     /**
      * Answer the state description object for a given group and alpha-ess attribute name
      * @param {string} Group

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.alpha-ess",
-  "version": "1.1.1",
+  "version": "1.2.0-beta.0",
   "description": "Read and write data from and to Alpha ESS systems.",
   "author": {
     "name": "Gaspode",