Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #154

Merged
merged 4 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monitor your energy generation, storage, and usage data using the official Open
In November 2023, AlphaESS introduced a new web API for their own web client and developers were officially encouraged to migrate to using the AlphaESS Open API published at [https://open.alphaess.com/](https://open.alphaess.com/). This component has been updated to use that Open API. Anyone wanting to use this component in Home Assistant will first need to register their own inverter with the AlphaESS Open API developer portal.

1. Navigate to [https://open.alphaess.com/](https://open.alphaess.com/) and chose the option to register an account.
2. Once registered and logged in follow the instructions from [https://github.com/alphaess-developer/alphacloud_open_api](https://github.com/alphaess-developer/alphacloud_open_api) to find your inverter SN and CheckCode
2. Once registered and logged in follow the instructions in your inverters manual to find your inverter SN and CheckCode, See example [here](https://imgur.com/a/Xm5t1s0)
3. Add your inverter to the developer portal using your SN and CheckCode

## Modifying existing installs to use the new OpenAPI
Expand Down Expand Up @@ -66,6 +66,18 @@ A error will be placed in the logs

The current charge config, discharge config and charging range will only update once the API is re-called (can be up to 1 min)

## Issues with registering systems to the AlphaESS OpenAPI

There has been a few issues regarding registering systems to the AlphaESS OpenAPI. The following are some of the issues that have been reported and how to resolve them.

### Issue: Unable to register system to AlphaESS OpenAPI (not receiving verification code)

If you are unable to register your system to the AlphaESS OpenAPI because you are not receiving the verification code, you can try the following steps to resolve the issue:
1. Access the current postman collection library for the AlphaESS OpenAPI [here](https://www.postman.com/poshy163/alphaess/collection/tsy43t1/alphaess-open-api?action=share&creator=11219653) (you will need to fork the collection)
2. Clicking on the root of the list of API calls (should be called AlphaESS Open API) and then click on the variables tab fill in systemSN and CheckCode into the initial and current value fields,
3. Click on the getVerificationCode GET API call followed by the send button to send the request. You should receive a verification code either in the response body or by email.


## Services

This project allows you to use the following services in Home Assistant:<br>
Expand Down Expand Up @@ -107,6 +119,7 @@ data:
- dp2start = Discharging Period 2 Start Time <br>
- dp2end = Discharging Period 2 End Time <br>


example:
```yaml
service: alphaess.setbatterydischarge
Expand Down
2 changes: 1 addition & 1 deletion custom_components/alphaess/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"requirements": [
"alphaessopenapi==0.0.11"
],
"version": "0.5.6.1"
"version": "0.5.7"
}


2 changes: 1 addition & 1 deletion custom_components/alphaess/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"config": {
"step": {
"user": {
"description": "Enter your AppID amd AppSecret from the AlphaESS OpenAPI developer portal",
"description": "Enter your AppID amd AppSecret from the AlphaESS OpenAPI developer portal \n \n If you have any issues with the OpenAPI, read a list of potential fixes [here](https://github.com/CharlesGillanders/homeassistant-alphaESS?tab=readme-ov-file#issues-with-registering-systems-to-the-alphaess-openapi)",
"data": {
"AppID": "AppID",
"AppSecret": "AppSecret"
Expand Down
Loading