Skip to content

Commit 6f88dd2

Browse files
Gaspode69Gaspode69
committed
Support Open API provided by Alpha-ESS
1 parent ab282df commit 6f88dd2

15 files changed

Lines changed: 1983 additions & 1024 deletions

‎README.md‎

Lines changed: 78 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
![Logo](admin/alpha-ess.png)
2+
23
# ioBroker.alpha-ess
34

45
![Number of Installations (latest)](http://iobroker.live/badges/alpha-ess-installed.svg)
@@ -21,81 +22,121 @@ All other data points are ignored. During adapter start these data points are lo
2122
Basically, it is possible to change selected configuration settings using the Alpha ESS Web API. This is not implemented yet.
2223

2324
## Settings:
24-
**Username:** The username of your Alpha ESS Account\
25-
**Password:** The password of your Alpha ESS Account\
26-
**Alpha ESS System ID:** The system Identifier of your Alpha ESS equipment\
27-
**Interval to read realtime data:** Unit: seconds.\
28-
**Interval to read energy data:** Unit: minutes.\
29-
**Interval to read settings data:** Unit: minutes.\
30-
**Interval to read statistical data for the current day:** Unit: minutes.\
31-
**Interval to read summary data:** Unit: minutes.
25+
26+
**Used API:** Choose between the inofficial "Closed" API and the official "Open" API (under development)
27+
Depending on the selected API there are different settings available.
28+
29+
**Closed API Settings:**
30+
31+
- **Username:** The username of your Alpha ESS Account
32+
- **Password:** The password of your Alpha ESS Account
33+
- **Alpha ESS System ID:** The system Identifier of your Alpha ESS equipment
34+
- **Interval to read realtime data:** Unit: seconds.
35+
- **Interval to read energy data:** Unit: minutes.
36+
- **Interval to read settings data:** Unit: minutes.
37+
- **Interval to read statistical data for the current day:** Unit: minutes.
38+
- **Interval to read summary data:** Unit: minutes.
3239

3340
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.
3441
The password is stored encrypted and must therefore be entered manually: demo
3542

43+
**Open API Settings:**
44+
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.
45+
46+
- **Personal application ID:** The application ID (see above)
47+
- **Personal application Secret:** The application Secret (see above)
48+
- **Alpha ESS System ID:** The system Identifier of your Alpha ESS equipment
49+
- **Interval to read realtime data:** Unit: seconds.
50+
- **Interval to read energy data:** Unit: minutes.
51+
- **Interval to read charging settings:** Unit: minutes.
52+
- **Interval to read discharging settings:** Unit: minutes.
53+
- **Interval to read summary data:** Unit: minutes.
54+
3655
## Disclaimer
56+
3757
**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.**
3858

3959
## Changelog
60+
61+
### **WORK IN PROGRESS**
62+
63+
- (Gaspode) Support also the new official OpenAPI provided by Alpha-ESS
64+
4065
### 0.5.0 (2023-03-05)
41-
* (Gaspode) Remove no more supported states at startup automatically
42-
* (Gaspode) Prepared data migration for future versions
66+
67+
- (Gaspode) Remove no more supported states at startup automatically
68+
- (Gaspode) Prepared data migration for future versions
4369

4470
### 0.4.0 (2023-02-16)
45-
* (Gaspode) Optimized deletion of group states
46-
* (Gaspode) Added new Realtime state for pmeter_dc
71+
72+
- (Gaspode) Optimized deletion of group states
73+
- (Gaspode) Added new Realtime state for pmeter_dc
4774

4875
### 0.3.0 (2023-02-11)
49-
* (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.
50-
* (Gaspode) Added Summary data
51-
* (Gaspode) Refactored complete implementation
52-
* (Gaspode) Changed the unit of settings for all intervals, except of realtime data, to minutes (Caution: settings are reset to defaults)
53-
* (Gaspode) Remove disabled states at adapter startup
54-
* (Gaspode) Removed no more supported value 'createtime' (state ID Realtime.Last_update).
55-
* (Gaspode) Optimized rounding for selected values
76+
77+
- (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.
78+
- (Gaspode) Added Summary data
79+
- (Gaspode) Refactored complete implementation
80+
- (Gaspode) Changed the unit of settings for all intervals, except of realtime data, to minutes (Caution: settings are reset to defaults)
81+
- (Gaspode) Remove disabled states at adapter startup
82+
- (Gaspode) Removed no more supported value 'createtime' (state ID Realtime.Last_update).
83+
- (Gaspode) Optimized rounding for selected values
5684

5785
### 0.2.1-beta.0 (2023-01-31)
58-
* (Gaspode) Read selected statistical data
86+
87+
- (Gaspode) Read selected statistical data
5988

6089
### 0.2.0 (2023-01-19)
61-
* (Gaspode) Added states EV1_power, EV2_power, EV3_power and EV4_power to Realtime folder
90+
91+
- (Gaspode) Added states EV1_power, EV2_power, EV3_power and EV4_power to Realtime folder
6292

6393
### 0.1.0 (2023-01-15)
64-
* (Gaspode) First release for Latest repository
65-
* (Gaspode) Corrected typo in state ID Battery_SOC
66-
* (Gaspode) Implemented improvements as suggested in code review
94+
95+
- (Gaspode) First release for Latest repository
96+
- (Gaspode) Corrected typo in state ID Battery_SOC
97+
- (Gaspode) Implemented improvements as suggested in code review
6798

6899
### 0.0.6-beta.5 (2023-01-07)
69-
* (Gaspode) Slow down requests in case of permanent errors
100+
101+
- (Gaspode) Slow down requests in case of permanent errors
70102

71103
### 0.0.6-beta.4 (2023-01-03)
72-
* (Gaspode) Changed adapter type from metering to energy
104+
105+
- (Gaspode) Changed adapter type from metering to energy
73106

74107
### 0.0.6-beta.3 (2023-01-02)
75-
* (Gaspode) Correction for NPM
108+
109+
- (Gaspode) Correction for NPM
76110

77111
### 0.0.6-beta.2 (2023-01-02)
78-
* (Gaspode) Enable NPM
112+
113+
- (Gaspode) Enable NPM
79114

80115
### 0.0.5
81-
* (Gaspode) Use meaningful state names
82-
* (Gaspode) Use suitable state roles
83-
* (Gaspode) Added new state for Alpha ESS settings parameter 'upsReserve'
116+
117+
- (Gaspode) Use meaningful state names
118+
- (Gaspode) Use suitable state roles
119+
- (Gaspode) Added new state for Alpha ESS settings parameter 'upsReserve'
84120

85121
### 0.0.4
86-
* (Gaspode) use axios to perform Alpha ESS API calls instead of deprecated request
87-
* (Gaspode) New option "Update unchanged states" added
122+
123+
- (Gaspode) use axios to perform Alpha ESS API calls instead of deprecated request
124+
- (Gaspode) New option "Update unchanged states" added
88125

89126
### 0.0.3
90-
* (Gaspode) refactored API calls, added daily energy values
127+
128+
- (Gaspode) refactored API calls, added daily energy values
91129

92130
### 0.0.2
93-
* (Gaspode) corrected api call for realtime data
131+
132+
- (Gaspode) corrected api call for realtime data
94133

95134
### 0.0.1
96-
* (Gaspode) initial release
135+
136+
- (Gaspode) initial release
97137

98138
## License
139+
99140
MIT License
100141

101142
Copyright (c) 2023 Gaspode <gaspode69@online.de>
@@ -116,4 +157,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
116157
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
117158
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
118159
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
119-
SOFTWARE.
160+
SOFTWARE.

‎admin/i18n/de/translations.json‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44
"Password": "Passwort",
55
"Alpha ESS System ID": "Alpha ESS-System-ID",
66
"Interval to read realtime data": "Intervall zum Lesen von Echtzeitdaten [s]",
7-
"Interval to read energy data": "Intervall zum Auslesen der Energiedaten [min]",
7+
"Interval to read energy data": "Intervall zum Lesen von Energiedaten [min]",
88
"Interval to read settings data": "Intervall zum Lesen von Einstellungsdaten [min]",
9-
"Interval to read statistical data (today)": "Intervall zum Lesen statistischer Daten (heute) [min]",
10-
"Interval to read summary data": "Intervall zum Lesen der Zusammenfassungsdaten [min]",
11-
"Update unchanged states": "Unveränderte Zustände aktualisieren"
9+
"Interval to read statistical data (today)": "Intervall zum Lesen von statistischen Daten (heute) [min]",
10+
"Interval to read summary data": "Intervall zum Lesen von Zusammenfassungsdaten [min]",
11+
"Update unchanged states": "Unveränderte Zustände aktualisieren",
12+
"Personal APP ID": "Persönliche Application ID",
13+
"Personal APP Secret": "Persönliches Application Secret",
14+
"Interval to read charging settings": "Intervall zum Lesen der Ladeeinstellungen [min]",
15+
"Interval to read discharging settings": "Intervall zum Lesen der Entladeeinstellungen [min]"
1216
}

‎admin/i18n/en/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Interval to read settings data [min]",
99
"Interval to read statistical data (today)": "Interval to read statistical data (today) [min]",
1010
"Interval to read summary data": "Interval to read summary data [min]",
11-
"Update unchanged states": "Update unchanged states"
11+
"Update unchanged states": "Update unchanged states",
12+
"Personal APP ID": "Personal Application ID",
13+
"Personal APP Secret": "Personal Application Secret",
14+
"Interval to read charging settings": "Interval to read charging settings [min]",
15+
"Interval to read discharging settings": "Interval to read discharging settings [min]"
1216
}

‎admin/i18n/es/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Intervalo para leer los datos de configuración [min]",
99
"Interval to read statistical data (today)": "Intervalo para leer datos estadísticos (hoy) [min]",
1010
"Interval to read summary data": "Intervalo para leer datos de resumen [min]",
11-
"Update unchanged states": "Actualizar estados sin cambios"
11+
"Update unchanged states": "Actualizar estados sin cambios",
12+
"Personal APP ID": "ID de aplicación personal",
13+
"Personal APP Secret": "Secreto de aplicación personal",
14+
"Interval to read charging settings": "Intervalo para leer la configuración de carga",
15+
"Interval to read discharging settings": "Intervalo para leer la configuración de descarga"
1216
}

‎admin/i18n/fr/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Intervalle pour lire les données de paramètres [min]",
99
"Interval to read statistical data (today)": "Intervalle pour lire les données statistiques (aujourd'hui) [min]",
1010
"Interval to read summary data": "Intervalle pour lire les données récapitulatives [min]",
11-
"Update unchanged states": "Mettre à jour les états inchangés"
11+
"Update unchanged states": "Mettre à jour les états inchangés",
12+
"Personal APP ID": "ID de candidature personnel",
13+
"Personal APP Secret": "Secret d'application personnel",
14+
"Interval to read charging settings": "Intervalle pour lire les paramètres de charge",
15+
"Interval to read discharging settings": "Intervalle pour lire les paramètres de décharge"
1216
}

‎admin/i18n/it/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Intervallo per leggere i dati delle impostazioni [min]",
99
"Interval to read statistical data (today)": "Intervallo di lettura dei dati statistici (oggi) [min]",
1010
"Interval to read summary data": "Intervallo di lettura dei dati di riepilogo [min]",
11-
"Update unchanged states": "Aggiorna stati invariati"
11+
"Update unchanged states": "Aggiorna stati invariati",
12+
"Personal APP ID": "ID applicazione personale",
13+
"Personal APP Secret": "Segreto dell'applicazione personale",
14+
"Interval to read charging settings": "Intervallo per leggere le impostazioni di ricarica",
15+
"Interval to read discharging settings": "Intervallo per leggere le impostazioni di scarica"
1216
}

‎admin/i18n/nl/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Interval om instellingsgegevens te lezen [min]",
99
"Interval to read statistical data (today)": "Interval om statistische gegevens te lezen (vandaag) [min]",
1010
"Interval to read summary data": "Interval om samenvattingsgegevens te lezen [min]",
11-
"Update unchanged states": "Update ongewijzigde statussen"
11+
"Update unchanged states": "Update ongewijzigde statussen",
12+
"Personal APP ID": "Persoonlijke applicatie-ID",
13+
"Personal APP Secret": "Persoonlijk toepassingsgeheim",
14+
"Interval to read charging settings": "Interval om laadinstellingen te lezen",
15+
"Interval to read discharging settings": "Interval om ontlaadinstellingen te lezen"
1216
}

‎admin/i18n/pl/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Interwał odczytu danych ustawień [min]",
99
"Interval to read statistical data (today)": "Interwał odczytu danych statystycznych (dziś) [min]",
1010
"Interval to read summary data": "Interwał odczytu danych podsumowujących [min]",
11-
"Update unchanged states": "Zaktualizuj niezmienione stany"
11+
"Update unchanged states": "Zaktualizuj niezmienione stany",
12+
"Personal APP ID": "Osobisty identyfikator aplikacji",
13+
"Personal APP Secret": "Tajny wniosek osobisty",
14+
"Interval to read charging settings": "Interwał odczytu ustawień ładowania",
15+
"Interval to read discharging settings": "Interwał odczytu ustawień rozładowania"
1216
}

‎admin/i18n/pt/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Intervalo para ler os dados de configuração [min]",
99
"Interval to read statistical data (today)": "Intervalo para ler dados estatísticos (hoje) [min]",
1010
"Interval to read summary data": "Intervalo para ler os dados resumidos [min]",
11-
"Update unchanged states": "Atualizar estados inalterados"
11+
"Update unchanged states": "Atualizar estados inalterados",
12+
"Personal APP ID": "ID de aplicativo pessoal",
13+
"Personal APP Secret": "Segredo de aplicativo pessoal",
14+
"Interval to read charging settings": "Intervalo para ler as configurações de carregamento",
15+
"Interval to read discharging settings": "Intervalo para ler as configurações de descarga"
1216
}

‎admin/i18n/ru/translations.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88
"Interval to read settings data": "Интервал чтения данных настроек [мин]",
99
"Interval to read statistical data (today)": "Интервал чтения статистических данных (сегодня) [мин]",
1010
"Interval to read summary data": "Интервал чтения сводных данных [мин]",
11-
"Update unchanged states": "Обновить неизмененные состояния"
11+
"Update unchanged states": "Обновить неизмененные состояния",
12+
"Personal APP ID": "Идентификатор личного приложения",
13+
"Personal APP Secret": "Секрет личного приложения",
14+
"Interval to read charging settings": "Интервал чтения настроек зарядки",
15+
"Interval to read discharging settings": "Интервал чтения настроек разрядки"
1216
}

0 commit comments

Comments
 (0)