iobroker.alpha-ess 0.4.0 → 1.0.0-alpha.0

package/README.md

@@ -1,4 +1,5 @@
 ![Logo](admin/alpha-ess.png)
+
 # ioBroker.alpha-ess
 
 ![Number of Installations (latest)](http://iobroker.live/badges/alpha-ess-installed.svg)
@@ -21,77 +22,120 @@ All other data points are ignored. During adapter start these data points are lo
 Basically, it is possible to change selected configuration settings using the Alpha ESS Web API. This is not implemented yet.
 
 ## Settings:
-**Username:** The username of your Alpha ESS Account\
-**Password:** The password of your Alpha ESS Account\
-**Alpha ESS System ID:** The system Identifier of your Alpha ESS equipment\
-**Interval to read realtime data:** Unit: seconds.\
-**Interval to read energy data:** Unit: minutes.\
-**Interval to read settings data:** Unit: minutes.\
-**Interval to read statistical data for the current day:** Unit: minutes.\
-**Interval to read summary data:** Unit: minutes.
+
+**Used API:** Choose between the inofficial "Closed" API and the official "Open" API (under development)
+Depending on the selected API there are different settings available.
+
+**Closed API Settings:**
+
+-   **Username:** The username of your Alpha ESS Account
+-   **Password:** The password of your Alpha ESS Account
+-   **Alpha ESS System ID:** The system Identifier of your Alpha ESS equipment
+-   **Interval to read realtime data:** Unit: seconds.
+-   **Interval to read energy data:** Unit: minutes.
+-   **Interval to read settings data:** Unit: minutes.
+-   **Interval to read statistical data for the current day:** Unit: minutes.
+-   **Interval to read summary data:** Unit: minutes.
 
 It is possible to use a demo account provided by Alpha ESS. The credentials (user name, system id) are set as default values within the adapter.
 The password is stored encrypted and must therefore be entered manually: demo
 
+**Open API Settings:**
+To be able to use the new Open API you have to register your Alpha-ESS device unter https://open.alphaess.com. Once registered, you get a developer ID and a developer key (called "Secret"). You will need these to have access to the Open API. Currently I have no information if this will be changed in the future.
+
+-   **Personal application ID:** The application ID (see above)
+-   **Personal application Secret:** The application Secret (see above)
+-   **Alpha ESS System ID:** The system Identifier of your Alpha ESS equipment
+-   **Interval to read realtime data:** Unit: seconds.
+-   **Interval to read energy data:** Unit: minutes.
+-   **Interval to read charging settings:** Unit: minutes.
+-   **Interval to read discharging settings:** Unit: minutes.
+-   **Interval to read summary data:** Unit: minutes.
+
 ## Disclaimer
+
 **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.0.0-alpha.0 (2023-04-11)
+
+-   (Gaspode) Support also the new official OpenAPI provided by Alpha-ESS
+
+### 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
+
+-   (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 
-* (Gaspode) Refactored complete implementation
-* (Gaspode) Changed the unit of settings for all intervals, except of realtime data, to minutes (Caution: settings are reset to defaults)
-* (Gaspode) Remove disabled states at adapter startup
-* (Gaspode) Removed no more supported value 'createtime' (state ID Realtime.Last_update). 
-* (Gaspode) Optimized rounding for selected values
+
+-   (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
+-   (Gaspode) Refactored complete implementation
+-   (Gaspode) Changed the unit of settings for all intervals, except of realtime data, to minutes (Caution: settings are reset to defaults)
+-   (Gaspode) Remove disabled states at adapter startup
+-   (Gaspode) Removed no more supported value 'createtime' (state ID Realtime.Last_update).
+-   (Gaspode) Optimized rounding for selected values
 
 ### 0.2.1-beta.0 (2023-01-31)
-* (Gaspode) Read selected statistical data
+
+-   (Gaspode) Read selected statistical data
 
 ### 0.2.0 (2023-01-19)
-* (Gaspode) Added states EV1_power, EV2_power, EV3_power and EV4_power to Realtime folder
+
+-   (Gaspode) Added states EV1_power, EV2_power, EV3_power and EV4_power to Realtime folder
 
 ### 0.1.0 (2023-01-15)
-* (Gaspode) First release for Latest repository
-* (Gaspode) Corrected typo in state ID Battery_SOC
-* (Gaspode) Implemented improvements as suggested in code review
+
+-   (Gaspode) First release for Latest repository
+-   (Gaspode) Corrected typo in state ID Battery_SOC
+-   (Gaspode) Implemented improvements as suggested in code review
 
 ### 0.0.6-beta.5 (2023-01-07)
-* (Gaspode) Slow down requests in case of permanent errors
+
+-   (Gaspode) Slow down requests in case of permanent errors
 
 ### 0.0.6-beta.4 (2023-01-03)
-* (Gaspode) Changed adapter type from metering to energy
+
+-   (Gaspode) Changed adapter type from metering to energy
 
 ### 0.0.6-beta.3 (2023-01-02)
-* (Gaspode) Correction for NPM
+
+-   (Gaspode) Correction for NPM
 
 ### 0.0.6-beta.2 (2023-01-02)
-* (Gaspode) Enable NPM
+
+-   (Gaspode) Enable NPM
 
 ### 0.0.5
-* (Gaspode) Use meaningful state names
-* (Gaspode) Use suitable state roles
-* (Gaspode) Added new state for Alpha ESS settings parameter 'upsReserve'
+
+-   (Gaspode) Use meaningful state names
+-   (Gaspode) Use suitable state roles
+-   (Gaspode) Added new state for Alpha ESS settings parameter 'upsReserve'
 
 ### 0.0.4
-* (Gaspode) use axios to perform Alpha ESS API calls instead of deprecated request
-* (Gaspode) New option "Update unchanged states" added
+
+-   (Gaspode) use axios to perform Alpha ESS API calls instead of deprecated request
+-   (Gaspode) New option "Update unchanged states" added
 
 ### 0.0.3
-* (Gaspode) refactored API calls, added daily energy values
+
+-   (Gaspode) refactored API calls, added daily energy values
 
 ### 0.0.2
-* (Gaspode) corrected api call for realtime data
+
+-   (Gaspode) corrected api call for realtime data
 
 ### 0.0.1
-* (Gaspode) initial release
+
+-   (Gaspode) initial release
 
 ## License
+
 MIT License
 
 Copyright (c) 2023 Gaspode <gaspode69@online.de>
@@ -112,4 +156,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/admin/i18n/de/translations.json

@@ -4,9 +4,13 @@
     "Password": "Passwort",
     "Alpha ESS System ID": "Alpha ESS-System-ID",
     "Interval to read realtime data": "Intervall zum Lesen von Echtzeitdaten [s]",
-    "Interval to read energy data": "Intervall zum Auslesen der Energiedaten [min]",
+    "Interval to read energy data": "Intervall zum Lesen von Energiedaten [min]",
     "Interval to read settings data": "Intervall zum Lesen von Einstellungsdaten [min]",
-    "Interval to read statistical data (today)": "Intervall zum Lesen statistischer Daten (heute) [min]",
-    "Interval to read summary data": "Intervall zum Lesen der Zusammenfassungsdaten [min]",
-    "Update unchanged states": "Unveränderte Zustände aktualisieren"
+    "Interval to read statistical data (today)": "Intervall zum Lesen von statistischen Daten (heute) [min]",
+    "Interval to read summary data": "Intervall zum Lesen von Zusammenfassungsdaten [min]",
+    "Update unchanged states": "Unveränderte Zustände aktualisieren",
+    "Personal APP ID": "Persönliche Application ID",
+    "Personal APP Secret": "Persönliches Application Secret",
+    "Interval to read charging settings": "Intervall zum Lesen der Ladeeinstellungen [min]",
+    "Interval to read discharging settings": "Intervall zum Lesen der Entladeeinstellungen [min]"
 }

package/admin/i18n/en/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Interval to read settings data [min]",
     "Interval to read statistical data (today)": "Interval to read statistical data (today) [min]",
     "Interval to read summary data": "Interval to read summary data [min]",
-    "Update unchanged states": "Update unchanged states"
+    "Update unchanged states": "Update unchanged states",
+	"Personal APP ID": "Personal Application ID",
+	"Personal APP Secret": "Personal Application Secret",
+	"Interval to read charging settings": "Interval to read charging settings [min]",
+	"Interval to read discharging settings": "Interval to read discharging settings [min]"
 }

package/admin/i18n/es/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Intervalo para leer los datos de configuración [min]",
     "Interval to read statistical data (today)": "Intervalo para leer datos estadísticos (hoy) [min]",
     "Interval to read summary data": "Intervalo para leer datos de resumen [min]",
-    "Update unchanged states": "Actualizar estados sin cambios"
+    "Update unchanged states": "Actualizar estados sin cambios",
+    "Personal APP ID": "ID de aplicación personal",
+    "Personal APP Secret": "Secreto de aplicación personal",
+    "Interval to read charging settings": "Intervalo para leer la configuración de carga",
+    "Interval to read discharging settings": "Intervalo para leer la configuración de descarga"
 }

package/admin/i18n/fr/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Intervalle pour lire les données de paramètres [min]",
     "Interval to read statistical data (today)": "Intervalle pour lire les données statistiques (aujourd'hui) [min]",
     "Interval to read summary data": "Intervalle pour lire les données récapitulatives [min]",
-    "Update unchanged states": "Mettre à jour les états inchangés"
+    "Update unchanged states": "Mettre à jour les états inchangés",
+    "Personal APP ID": "ID de candidature personnel",
+    "Personal APP Secret": "Secret d'application personnel",
+    "Interval to read charging settings": "Intervalle pour lire les paramètres de charge",
+    "Interval to read discharging settings": "Intervalle pour lire les paramètres de décharge"
 }

package/admin/i18n/it/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Intervallo per leggere i dati delle impostazioni [min]",
     "Interval to read statistical data (today)": "Intervallo di lettura dei dati statistici (oggi) [min]",
     "Interval to read summary data": "Intervallo di lettura dei dati di riepilogo [min]",
-    "Update unchanged states": "Aggiorna stati invariati"
+    "Update unchanged states": "Aggiorna stati invariati",
+    "Personal APP ID": "ID applicazione personale",
+    "Personal APP Secret": "Segreto dell'applicazione personale",
+    "Interval to read charging settings": "Intervallo per leggere le impostazioni di ricarica",
+    "Interval to read discharging settings": "Intervallo per leggere le impostazioni di scarica"
 }

package/admin/i18n/nl/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Interval om instellingsgegevens te lezen [min]",
     "Interval to read statistical data (today)": "Interval om statistische gegevens te lezen (vandaag) [min]",
     "Interval to read summary data": "Interval om samenvattingsgegevens te lezen [min]",
-    "Update unchanged states": "Update ongewijzigde statussen"
+    "Update unchanged states": "Update ongewijzigde statussen",
+    "Personal APP ID": "Persoonlijke applicatie-ID",
+    "Personal APP Secret": "Persoonlijk toepassingsgeheim",
+    "Interval to read charging settings": "Interval om laadinstellingen te lezen",
+    "Interval to read discharging settings": "Interval om ontlaadinstellingen te lezen"
 }

package/admin/i18n/pl/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Interwał odczytu danych ustawień [min]",
     "Interval to read statistical data (today)": "Interwał odczytu danych statystycznych (dziś) [min]",
     "Interval to read summary data": "Interwał odczytu danych podsumowujących [min]",
-    "Update unchanged states": "Zaktualizuj niezmienione stany"
+    "Update unchanged states": "Zaktualizuj niezmienione stany",
+    "Personal APP ID": "Osobisty identyfikator aplikacji",
+    "Personal APP Secret": "Tajny wniosek osobisty",
+    "Interval to read charging settings": "Interwał odczytu ustawień ładowania",
+    "Interval to read discharging settings": "Interwał odczytu ustawień rozładowania"
 }

package/admin/i18n/pt/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Intervalo para ler os dados de configuração [min]",
     "Interval to read statistical data (today)": "Intervalo para ler dados estatísticos (hoje) [min]",
     "Interval to read summary data": "Intervalo para ler os dados resumidos [min]",
-    "Update unchanged states": "Atualizar estados inalterados"
+    "Update unchanged states": "Atualizar estados inalterados",
+    "Personal APP ID": "ID de aplicativo pessoal",
+    "Personal APP Secret": "Segredo de aplicativo pessoal",
+    "Interval to read charging settings": "Intervalo para ler as configurações de carregamento",
+    "Interval to read discharging settings": "Intervalo para ler as configurações de descarga"
 }

package/admin/i18n/ru/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Интервал чтения данных настроек [мин]",
     "Interval to read statistical data (today)": "Интервал чтения статистических данных (сегодня) [мин]",
     "Interval to read summary data": "Интервал чтения сводных данных [мин]",
-    "Update unchanged states": "Обновить неизмененные состояния"
+    "Update unchanged states": "Обновить неизмененные состояния",
+    "Personal APP ID": "Идентификатор личного приложения",
+    "Personal APP Secret": "Секрет личного приложения",
+    "Interval to read charging settings": "Интервал чтения настроек зарядки",
+    "Interval to read discharging settings": "Интервал чтения настроек разрядки"
 }

package/admin/i18n/uk/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "Інтервал зчитування даних налаштувань [хв]",
     "Interval to read statistical data (today)": "Інтервал читання статистичних даних (сьогодні) [хв]",
     "Interval to read summary data": "Інтервал читання підсумкових даних [хв.]",
-    "Update unchanged states": "Оновити незмінні стани"
+    "Update unchanged states": "Оновити незмінні стани",
+    "Personal APP ID": "Персональний ID програми",
+    "Personal APP Secret": "Особистий секрет програми",
+    "Interval to read charging settings": "Інтервал зчитування параметрів заряджання",
+    "Interval to read discharging settings": "Інтервал зчитування параметрів розрядки"
 }

package/admin/i18n/zh-cn/translations.json

@@ -8,5 +8,9 @@
     "Interval to read settings data": "读取设置数据的间隔[分钟]",
     "Interval to read statistical data (today)": "读取统计数据的间隔（今天）[min]",
     "Interval to read summary data": "读取摘要数据的间隔[分钟]",
-    "Update unchanged states": "更新未改变的状态"
+    "Update unchanged states": "更新未改变的状态",
+    "Personal APP ID": "个人申请编号",
+    "Personal APP Secret": "个人申请秘诀",
+    "Interval to read charging settings": "读取充电设置的间隔",
+    "Interval to read discharging settings": "读取放电设置的间隔"
 }

package/admin/jsonConfig.json

@@ -2,17 +2,43 @@
     "i18n": true,
     "type": "panel",
     "items": {
+        "apiType": {
+            "sm": 5,
+            "type": "select",
+            "label": "Select API",
+            "newLine": true,
+            "options": [
+                { "label": "Closed API", "value": 0 },
+                { "label": "Open API", "value": 1 }
+            ]
+        },
         "username": {
             "sm": 5,
             "type": "text",
             "label": "Username",
-            "newLine": true
+            "newLine": true,
+            "hidden": "data.apiType == 1"
         },
         "password": {
             "sm": 5,
             "type": "password",
             "label": "Password",
-            "newLine": true
+            "newLine": true,
+            "hidden": "data.apiType == 1"
+        },
+        "appID": {
+            "sm": 5,
+            "type": "text",
+            "label": "Personal APP ID",
+            "newLine": true,
+            "hidden": "data.apiType == 0"
+        },
+        "appSecret": {
+            "sm": 5,
+            "type": "password",
+            "label": "Personal APP Secret",
+            "newLine": true,
+            "hidden": "data.apiType == 0"
         },
         "systemId": {
             "sm": 5,
@@ -22,58 +48,181 @@
         },
         "enableRealtimedata": {
             "type": "checkbox",
-            "newLine": true
+            "newLine": true,
+            "hidden": "data.apiType == 1"
         },
         "intervalRealtimedata": {
             "sm": 5,
             "min": 10,
             "type": "number",
             "label": "Interval to read realtime data",
-            "newLine": false
+            "newLine": false,
+            "disabled": "!data.enableRealtimedata",
+            "hidden": "data.apiType == 1"
         },
         "enableEnergydata": {
             "type": "checkbox",
-            "newLine": true
+            "newLine": true,
+            "hidden": "data.apiType == 1"
         },
         "intervalEnergydataMins": {
             "sm": 5,
             "min": 1,
             "type": "number",
             "label": "Interval to read energy data",
-            "newLine": false
+            "newLine": false,
+            "disabled": "!data.enableEnergydata",
+            "hidden": "data.apiType == 1"
         },
         "enableSettingsdata": {
             "type": "checkbox",
-            "newLine": true
+            "newLine": true,
+            "hidden": "data.apiType == 1"
+        },
+        "enableSettingsCharge": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "true"
+        },
+        "enableSettingsDisCharge": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "true"
         },
         "intervalSettingsdataMins": {
             "sm": 5,
             "min": 1,
             "type": "number",
             "label": "Interval to read settings data",
-            "newLine": false
+            "newLine": false,
+            "disabled": "!data.enableSettingsdata",
+            "hidden": "data.apiType == 1"
         },
         "enableStatisticalTodaydata": {
             "type": "checkbox",
-            "newLine": true
+            "newLine": true,
+            "hidden": "data.apiType == 1"
         },
         "intervalStatisticalTodaydataMins": {
             "sm": 5,
             "min": 1,
             "type": "number",
             "label": "Interval to read statistical data (today)",
-            "newLine": false
+            "newLine": false,
+            "disabled": "!data.enableStatisticalTodaydata",
+            "hidden": "data.apiType == 1"
         },
         "enableSummarydata": {
             "type": "checkbox",
-            "newLine": true
+            "newLine": true,
+            "hidden": "data.apiType == 1"
         },
         "intervalSummarydataMins": {
             "sm": 5,
             "min": 5,
             "type": "number",
             "label": "Interval to read summary data",
-            "newLine": false
+            "newLine": false,
+            "disabled": "!data.enableSummarydata",
+            "hidden": "data.apiType == 1"
+        },
+        "oAEnableRealtime": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "data.apiType == 0"
+        },
+        "oAIntervalRealtime": {
+            "sm": 5,
+            "min": 10,
+            "type": "number",
+            "label": "Interval to read realtime data",
+            "newLine": false,
+            "disabled": "!data.oAEnableRealtime",
+            "hidden": "data.apiType == 0"
+        },
+        "oAEnableEnergy": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "data.apiType == 0"
+        },
+        "oAIntervalEnergyMins": {
+            "sm": 5,
+            "min": 1,
+            "type": "number",
+            "label": "Interval to read energy data",
+            "newLine": false,
+            "disabled": "!data.oAEnableEnergy",
+            "hidden": "data.apiType == 0"
+        },
+        "oAEnableStatisticsToday": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "true"
+        },
+        "oAIntervalStatisticsTodayMins": {
+            "sm": 5,
+            "min": 1,
+            "type": "number",
+            "label": "Interval to read statistical data (today)",
+            "newLine": false,
+            "disabled": "!data.oAEnableStatisticsToday",
+            "hidden": "true"
+        },
+        "oAEnableSettings": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "true"
+        },
+        "oAIntervalSettingsMins": {
+            "sm": 5,
+            "min": 1,
+            "type": "number",
+            "label": "Interval to read settings data",
+            "newLine": false,
+            "disabled": "!data.oAEnableSettings",
+            "hidden": "true"
+        },
+        "oAEnableSettingsCharge": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "data.apiType == 0"
+        },
+        "oAIntervalSettingsChargeMins": {
+            "sm": 5,
+            "min": 1,
+            "type": "number",
+            "label": "Interval to read charging settings",
+            "newLine": false,
+            "disabled": "!data.oAEnableSettingsCharge",
+            "hidden": "data.apiType == 0"
+        },
+        "oAEnableSettingsDischarge": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "data.apiType == 0"
+        },
+        "oAIntervalSettingsDischargeMins": {
+            "sm": 5,
+            "min": 1,
+            "type": "number",
+            "label": "Interval to read discharging settings",
+            "newLine": false,
+            "disabled": "!data.oAEnableSettingsDischarge",
+            "hidden": "data.apiType == 0"
+        },
+        "oAEnableSummary": {
+            "type": "checkbox",
+            "newLine": true,
+            "hidden": "data.apiType == 0"
+        },
+        "oAIntervalSummaryMins": {
+            "sm": 5,
+            "min": 1,
+            "type": "number",
+            "label": "Interval to read summary data",
+            "newLine": false,
+            "disabled": "!data.oAEnableSummary",
+            "hidden": "data.apiType == 0"
         },
         "updateUnchangedStates": {
             "type": "checkbox",