Skip to content

Commit 1e97d74

Browse files
authored
Improve Growatt Server documentation for bronze tier compliance (#41668)
1 parent 3acc279 commit 1e97d74

File tree

1 file changed

+57
-7
lines changed

1 file changed

+57
-7
lines changed

source/_integrations/growatt_server.markdown

Lines changed: 57 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,35 @@ ha_codeowners:
1717
- '@johanzander'
1818
---
1919

20-
The Growatt integration allows you to retrieve data from Growatt inverters. During setup, you can choose from various regional endpoint servers:
20+
The Growatt integration enables you to retrieve data from Growatt inverters. During setup, you can choose from various regional endpoint servers:
2121

22-
- For users in China: https://openapi-cn.growatt.com/
23-
- For users in North America: https://openapi-us.growatt.com/
24-
- For users in other regions: https://openapi.growatt.com/
25-
- SMTEN server: http://server.smten.com/
22+
- For users in China:
23+
24+
```text
25+
https://openapi-cn.growatt.com/
26+
```
27+
28+
- For users in North America:
29+
30+
```text
31+
https://openapi-us.growatt.com/
32+
```
33+
34+
- For users in other regions:
35+
36+
```text
37+
https://openapi.growatt.com/
38+
```
39+
40+
- SMTEN server:
41+
42+
```text
43+
http://server.smten.com/
44+
```
2645

2746
Selecting the appropriate server for your region improves the reliability and performance of data collection.
2847

29-
Once integrated, the sensor logs into your Growatt account and retrieves your plants. If you have multiple plants, you can select which one to integrate. The integration then retrieves the inverters associated with the selected plant and generates sensors for these inverters, as well as overall plant sensors.
48+
Once configured, the integration connects to your Growatt account. If you have multiple plants, you can select which one to integrate. It will then create entities for your plant and inverters, allowing you to monitor energy production and control settings in Home Assistant.
3049

3150
## Authentication
3251

@@ -44,7 +63,7 @@ To obtain an API token for your Growatt account:
4463
3. Generate or retrieve your API token.
4564
4. Use this token during the integration setup in Home Assistant.
4665

47-
Using an API token is recommended for MIN/TLX inverters as it uses the official Growatt V1 API, which offers better stability, support and feature growth.
66+
Using an API token is recommended for MIN/TLX inverters as it uses the official Growatt API, which offers better stability, support and feature growth.
4867

4968
## Prerequisites
5069

@@ -53,6 +72,15 @@ Using an API token is recommended for MIN/TLX inverters as it uses the official
5372

5473
{% include integrations/config_flow.md %}
5574

75+
## Known limitations
76+
77+
### Rate limiting with username/password authentication
78+
79+
The classic API (username/password authentication) has strict rate limits that can result in your account being locked out for up to 24 hours if exceeded. To avoid this issue:
80+
81+
- **For MIN/TLX inverter users**: Use API token authentication instead, which uses the official Growatt V1 API that does not have this limitation.
82+
- **For all other users**: Avoid all unnecessary integration reloads, as a reload triggers re-login via Growatt classic API.
83+
5684
## Inverter controls
5785

5886
When using API token authentication with MIN/TLX inverters, the integration provides additional control entities:
@@ -76,3 +104,25 @@ These controls directly modify your inverter's operational settings. Only change
76104

77105
- **AC charge**
78106
- **Description**: Enable or disable AC charging
107+
108+
## Troubleshooting
109+
110+
### Account locked or authentication failing
111+
112+
If you're experiencing authentication failures or account lockouts:
113+
114+
1. **Accept new terms and conditions**: Open the ShinePhone mobile app and log in with your Growatt account. You may need to accept updated terms and conditions before the integration can access your account successfully.
115+
116+
2. **Account locked due to rate limiting**: If you're using username/password authentication and your account has been locked due to rate limiting:
117+
- Wait for the lockout period to expire (up to 24 hours).
118+
- Consider switching to API token authentication if you have a MIN/TLX inverter.
119+
- Avoid frequent integration reloads, which can trigger rate limits.
120+
121+
3. **Prevent lockouts during Home Assistant restarts**:
122+
- If you experience frequent lockouts, temporarily disable the integration before restarting Home Assistant.
123+
- To disable: Go to {% my integrations title="**Settings** > **Devices & services**" %}, select the Growatt integration, click the three dots {% icon "mdi:dots-vertical" %} menu, and select **Disable**.
124+
- Re-enable after Home Assistant has fully restarted.
125+
126+
## Removing the integration
127+
128+
{% include integrations/remove_device_service.md %}

0 commit comments

Comments
 (0)