This adapter logs into the web API of Alpha ESS 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 on official and documented API to Alpha ESS devices.
Currently this adapter creates a state with a hopefully self explaining name for each suppoerted data point.
All other data points are ignored. During adapter start these data points are logged as debug message.
Staring with version 1.0.0-alpha.5, the quality attribute of each state is set accordingly to its status:
| Quality | meaning |
|---|---|
| 0x00 | OK and up to date |
| 0x01 | value not updated due to unknown reason, see log |
| 0x02 | problem with online connection for this data point |
| 0x12 | adapter disconnected or stopped |
| 0x44 | API returned error or internal error, see log |
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.
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.
- (Gaspode) Support also the new official OpenAPI provided by Alpha-ESS
- (Gaspode) Set state quality accordingly to status of data
- (Gaspode) Writing charging and discharging settings implemented for 'Closed API' and OpenAPI
- (Gaspode) Remove no more supported states at startup automatically
- (Gaspode) Optimized deletion of group states
- (Gaspode) Added new Realtime state for pmeter_dc
- (Gaspode) Read selected statistical data
- (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) Added states EV1_power, EV2_power, EV3_power and EV4_power to Realtime folder
- (Gaspode) First release for Latest repository
- (Gaspode) Corrected typo in state ID Battery_SOC
- (Gaspode) Implemented improvements as suggested in code review
- (Gaspode) Slow down requests in case of permanent errors
- (Gaspode) Changed adapter type from metering to energy
- (Gaspode) Correction for NPM
- (Gaspode) Enable NPM
- (Gaspode) Use meaningful state names
- (Gaspode) Use suitable state roles
- (Gaspode) Added new state for Alpha ESS settings parameter 'upsReserve'
- (Gaspode) use axios to perform Alpha ESS API calls instead of deprecated request
- (Gaspode) New option "Update unchanged states" added
- (Gaspode) refactored API calls, added daily energy values
- (Gaspode) corrected api call for realtime data
- (Gaspode) initial release
MIT License
Copyright (c) 2023 Gaspode gaspode69@online.de
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.