iobroker.alpha-ess 1.3.0 → 2.0.0-beta.0

package/README.md

@@ -11,12 +11,12 @@
 
 ## alpha-ess adapter for ioBroker
 
-This adapter logs into the web API of [Alpha ESS](https://www.alphaess.com/) and retrieves information for your Alpha ESS equipment.\
-Depending on your Alpha ESS product, it is possible to get realtime data and configuration data for your equipment. Which data points are returned by the API depends on your Alpha ESS equipment.
+This adapter logs into the web API of [Alpha-ESS](https://www.alphaess.com/) and retrieves information for your Alpha-ESS equipment.\
+Depending on your Alpha-ESS product, it is possible to get realtime data and configuration data for your equipment. Which data points are returned by the API depends on your Alpha-ESS equipment.
 
-This adapter supports two APIs, the internal Alpha ESS Web API, which may be changed at any time by Alpha ESS, and the Alpha ESS Open API, which provides less functionality but is an official and documented API for Alpha ESS devices.
+This adapter uses the Alpha-ESS Open API, which is an official and documented API for Alpha-ESS devices.
 
-Staring with version 1.0.0-alpha.5, the quality attribute of each state is set accordingly to its status:
+The quality attribute of each state is set accordingly to its status:
 | Quality | meaning |
 |:--------|:--------------------------------------------------|
 |0x00 |OK and up to date |
@@ -27,55 +27,33 @@ Staring with version 1.0.0-alpha.5, the quality attribute of each state is set a
 
 ## Settings:
 
-**Used API:** Choose between the inofficial "Closed" API and the official "Open" API
-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.
+To be able to use the Alpha-ESS 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.
 How to find SN and Check code for registration is described here: https://github.com/alphaess-developer/alphacloud_open_api
 
 -   **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
+-   **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.
 -   **Interval to read wallbox data:** Unit: minutes. Caution: Currently only one Wallbox is supported.
+-   **Update unchanged states:** If this option is checked, states are changed even if the corresponding value is unchanged.
 
 ## 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.3.0 (2023-11-22)
-
--   (Gaspode) Support wallbox with Open API
--   (Gaspode) Start and stop charging of wallbox with Open API
+### 2.0.0-beta.0 (2023-12-01)
 
-### 1.3.0-beta.1 (2023-11-21)
+-   (Gaspode) Breaking Change: Removed support of Closed API
 
--   (Gaspode) Start and stop charging of wallbox with Open API
-
-### 1.3.0-beta.0 (2023-11-18)
+### 1.3.0 (2023-11-22)
 
 -   (Gaspode) Support wallbox with Open API
+-   (Gaspode) Start and stop charging of wallbox with Open API
 
 ### 1.2.1 (2023-11-11)
 
@@ -139,11 +117,11 @@ How to find SN and Check code for registration is described here: https://github
 
 -   (Gaspode) Use meaningful state names
 -   (Gaspode) Use suitable state roles
--   (Gaspode) Added new state for Alpha ESS settings parameter 'upsReserve'
+-   (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) use axios to perform Alpha-ESS API calls instead of deprecated request
 -   (Gaspode) New option "Update unchanged states" added
 
 ### 0.0.3

package/admin/jsonConfig.json

@@ -2,53 +2,17 @@
   "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 }
-      ]
-    },
-    "closedAPINotSupported": {
-      "sm": 5,
-      "type": "staticText",
-      "text": "Sorry. Closed API currently not supported!",
-      "style": {
-          "color": "red"
-      },
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 0"
-    },
-    "username": {
-      "sm": 5,
-      "type": "text",
-      "label": "Username",
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "password": {
-      "sm": 5,
-      "type": "password",
-      "label": "Password",
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
     "appID": {
       "sm": 5,
       "type": "text",
       "label": "Personal APP ID",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "appSecret": {
       "sm": 5,
       "type": "password",
       "label": "Personal APP Secret",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "systemId": {
       "sm": 5,
@@ -57,122 +21,9 @@
       "newLine": true,
       "disabled": "data.apiType == 3"
     },
-    "enableRealtimedata": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "intervalRealtimedata": {
-      "sm": 5,
-      "min": 10,
-      "type": "number",
-      "label": "Interval to read realtime data",
-      "newLine": false,
-      "disabled": "!data.enableRealtimedata",
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "enableEnergydata": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "intervalEnergydataMins": {
-      "sm": 5,
-      "min": 1,
-      "type": "number",
-      "label": "Interval to read energy data",
-      "newLine": false,
-      "disabled": "!data.enableEnergydata",
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "enableSettingsdata": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "enableSettingsCharge": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "true"
-    },
-    "intervalSettingsChargeMins": {
-      "sm": 5,
-      "min": 1,
-      "type": "number",
-      "label": "Interval to read charging settings",
-      "newLine": false,
-      "disabled": "!data.oAEnableSettingsCharge",
-      "hidden": "true"
-    },
-    "enableSettingsDisCharge": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "true"
-    },
-    "intervalSettingsDisChargeMins": {
-      "sm": 5,
-      "min": 1,
-      "type": "number",
-      "label": "Interval to read charging settings",
-      "newLine": false,
-      "disabled": "!data.oAEnableSettingsCharge",
-      "hidden": "true"
-    },
-    "intervalSettingsdataMins": {
-      "sm": 5,
-      "min": 1,
-      "type": "number",
-      "label": "Interval to read settings data",
-      "newLine": false,
-      "disabled": "!data.enableSettingsdata",
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "enableStatisticalTodaydata": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "intervalStatisticalTodaydataMins": {
-      "sm": 5,
-      "min": 1,
-      "type": "number",
-      "label": "Interval to read statistical data (today)",
-      "newLine": false,
-      "disabled": "!data.enableStatisticalTodaydata",
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "enableSummarydata": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "intervalSummarydataMins": {
-      "sm": 5,
-      "min": 5,
-      "type": "number",
-      "label": "Interval to read summary data",
-      "newLine": false,
-      "disabled": "!data.enableSummarydata",
-      "hidden": "data.apiType == 1 || data.apiType == 3"
-    },
-    "enableWallbox": {
-      "type": "checkbox",
-      "newLine": true,
-      "hidden": "true"
-    },
-    "intervalWallboxMins": {
-      "sm": 5,
-      "min": 1,
-      "type": "number",
-      "label": "Interval to read wallbox data",
-      "newLine": false,
-      "disabled": "!data.oAEnableWallbox",
-      "hidden": "true"
-    },
     "oAEnableRealtime": {
       "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "oAIntervalRealtime": {
       "sm": 5,
@@ -180,13 +31,11 @@
       "type": "number",
       "label": "Interval to read realtime data",
       "newLine": false,
-      "disabled": "!data.oAEnableRealtime",
-      "hidden": "data.apiType == 0"
+      "disabled": "!data.oAEnableRealtime"
     },
     "oAEnableEnergy": {
       "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "oAIntervalEnergyMins": {
       "sm": 5,
@@ -194,41 +43,11 @@
       "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": 5,
-      "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"
+      "disabled": "!data.oAEnableEnergy"
     },
     "oAEnableSettingsCharge": {
       "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "oAIntervalSettingsChargeMins": {
       "sm": 5,
@@ -236,13 +55,11 @@
       "type": "number",
       "label": "Interval to read charging settings",
       "newLine": false,
-      "disabled": "!data.oAEnableSettingsCharge",
-      "hidden": "data.apiType == 0"
+      "disabled": "!data.oAEnableSettingsCharge"
     },
     "oAEnableSettingsDischarge": {
       "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "oAIntervalSettingsDischargeMins": {
       "sm": 5,
@@ -250,13 +67,11 @@
       "type": "number",
       "label": "Interval to read discharging settings",
       "newLine": false,
-      "disabled": "!data.oAEnableSettingsDischarge",
-      "hidden": "data.apiType == 0"
+      "disabled": "!data.oAEnableSettingsDischarge"
     },
     "oAEnableSummary": {
       "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "oAIntervalSummaryMins": {
       "sm": 5,
@@ -264,13 +79,11 @@
       "type": "number",
       "label": "Interval to read summary data",
       "newLine": false,
-      "disabled": "!data.oAEnableSummary",
-      "hidden": "data.apiType == 0"
+      "disabled": "!data.oAEnableSummary"
     },
     "oAEnableWallbox": {
       "type": "checkbox",
-      "newLine": true,
-      "hidden": "data.apiType == 0"
+      "newLine": true
     },
     "oAIntervalWallboxMins": {
       "sm": 5,
@@ -278,8 +91,7 @@
       "type": "number",
       "label": "Interval to read wallbox data",
       "newLine": false,
-      "disabled": "!data.oAEnableWallbox",
-      "hidden": "data.apiType == 0"
+      "disabled": "!data.oAEnableWallbox"
     },
     "updateUnchangedStates": {
       "type": "checkbox",

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "alpha-ess",
-    "version": "1.3.0",
+    "version": "2.0.0-beta.0",
     "news": {
+      "2.0.0-beta.0": {
+        "en": "Breaking Change: Removed support of Closed API",
+        "de": "Breaking Change: Entfernte Unterstützung von Closed API",
+        "ru": "Перерыв изменения: Удаленная поддержка Закрытого API",
+        "pt": "Mudança de ruptura: Suporte removido da API fechada",
+        "nl": "Vertaling: Verwijderde steun van gesloten API",
+        "fr": "Changement de rupture : Soutien retiré de l'API fermée",
+        "it": "Cambiamento di rottura: Supporto rimosso delle API chiuse",
+        "es": "Cambio de ruptura: Soporte extraído de API cerrada",
+        "pl": "Zmiana: Przewiduje wsparcie API Closed",
+        "uk": "Зміна несправностей: Видалити підтримку Закритого API",
+        "zh-cn": "打破变化: B. 取消对已结束的反补贴方案的支持"
+      },
       "1.3.0": {
         "en": "Support wallbox with Open API\nStart and stop charging of wallbox with Open API",
         "de": "Wallbox Unterstützung mit Open API\nStarten und stoppen des Ladevorgangs der Wallbox mit Open API",
@@ -129,55 +142,31 @@
     ]
   },
   "encryptedNative": [
-    "password",
     "appSecret"
   ],
   "protectedNative": [
     "username",
-    "password",
     "appID",
     "appSecret"
   ],
   "native": {
-    "username": "",
-    "password": "",
-    "systemId": "",
-    "enableRealtimedata": true,
-    "intervalRealtimedata": 30,
-    "enableEnergydata": true,
-    "intervalEnergydataMins": 5,
-    "enableSettingsdata": false,
-    "enableSettingsCharge": false,
-    "intervalSettingsChargeMins": 5,
-    "enableSettingsDisCharge": false,
-    "intervalSettingsDisChargeMins": 5,
-    "intervalSettingsdataMins": 5,
-    "enableStatisticalTodaydata": false,
-    "intervalStatisticalTodaydataMins": 5,
-    "enableSummarydata": false,
-    "intervalSummarydataMins": 5,
-    "enableWallbox": false,
-    "intervalWallboxMins": 5,
-    "updateUnchangedStates": false,
+    "apiType": 1,
     "appID": "",
     "appSecret": "",
-    "apiType": 1,
+    "systemId": "",
     "oAEnableRealtime": true,
     "oAIntervalRealtime": 30,
     "oAEnableEnergy": true,
     "oAIntervalEnergyMins": 5,
-    "oAEnableSettings": false,
-    "oAIntervalSettingsMins": 5,
     "oAEnableSettingsCharge": true,
     "oAIntervalSettingsChargeMins": 5,
     "oAEnableSettingsDischarge": true,
     "oAIntervalSettingsDischargeMins": 5,
-    "oAEnableStatisticsToday": false,
-    "oAIntervalStatisticsTodayMins": 5,
     "oAEnableSummary": true,
     "oAIntervalSummaryMins": 5,
     "oAEnableWallbox": false,
-    "oAIntervalWallboxMins": 5
+    "oAIntervalWallboxMins": 5,
+    "updateUnchangedStates": false
   },
   "objects": [],
   "instanceObjects": [