Skip to content

Commit 289be5b

Browse files
committed
Clarify FoxESS credential setup
1 parent 57528e8 commit 289be5b

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,35 @@ compatible periods and warns if later periods cannot fit within that limit.
7878

7979
- Your Octopus account number (`A-...`) and API key (`sk_live_...`) from
8080
[Octopus API Access](https://octopus.energy/dashboard/new/accounts/personal-details/api-access).
81-
- Your FoxESS inverter serial number and API token from **User Profile → API
82-
Management** on the [FoxCloud V1 website](https://www.foxesscloud.com/login).
81+
- Your FoxESS inverter serial number and API token from the
82+
[FoxESSCloud V1 website](https://www.foxesscloud.com/login), as described
83+
below.
8384
- For optional Live WS telemetry, your FoxCloud web login details.
8485

85-
> FoxESS API tokens are created on the V1 website, not in the V2 website or
86-
> mobile app.
86+
### Get your FoxESS API token and inverter serial number
87+
88+
Sign in to the [FoxESSCloud V1 website](https://www.foxesscloud.com/login).
89+
90+
To generate the API token:
91+
92+
1. Select the user profile icon in the top-right corner.
93+
2. Select **User Profile**.
94+
3. Select **API Management** in the left-hand panel.
95+
4. Open the **Private Token** tab and select **Generate API key**.
96+
5. Copy the generated key and enter it as the **FoxESS API Token** in this app.
97+
98+
Store the key securely when it is generated. FoxESSCloud will not display the
99+
complete key again, and you should not share it publicly.
100+
101+
To find the inverter serial number:
102+
103+
1. Return to the main FoxESSCloud V1 dashboard.
104+
2. In the left-hand menu, open **Device → Inverter**.
105+
3. Copy the value shown in the **Inverter SN** column and enter it as the
106+
**FoxESS Inverter Serial Number** in this app.
107+
108+
> FoxESS API tokens are generated on the V1 website, not on the V2 website or
109+
> in the mobile app.
87110
88111
## Raspberry Pi OS edition
89112

0 commit comments

Comments
 (0)