Connecting your devices


Connecting your inverter and battery

Generating an API key

An API is a set of rules that can allow software to communicate with each other. An API key, is a unique code that identifies and authenticates an application or software to interact. 

To connect your inverter and battery:

  1. Click on 'Get Started' 
  2. Select your inverter or battery brand from the list: FoxESS, GivEnergy, SolaX

Depending on the manufacturer, the process for generating an API key will differ - please follow the instructions on the app. 

This step might be easier on the desktop browser, as it can be fiddly on the phone. The link for desktop is here: app.smug.energy

Select Inverter Brand.png

After successfully connecting your system, you should see energy flows to and from the battery in your system. 

Connecting your GivEnergy inverter via API

Obtaining a GivEnergy API Token

To connect your GivEnergy system to the Smug app, you'll need to generate an API token. This token allows secure communication between your inverter or battery and the app.

An API (Application Programming Interface) lets two programs talk to each other. For example, a weather app on your phone talks to a weather service's API to get a forecast. 

The API key (or sometimes token) is a unique code that tells the Smug what your system is doing. It's how the service knows you're allowed to use it, kind of like showing your ticket at a concert. It is a very secure way of connecting between two parties.

To access your API key and connect your GivEnergy inverter:

Step 1:

Visit your GivEnergy account and log in with your credentials.

Step 2:

Once logged in, navigate to your Account Settings. On desktop, this is in the left sidebar. On mobile, you'll find it at the bottom of the screen.

Account Settings

Step 3:

At the top right of the account details page, click on Manage Account Security.

Manage Account Security

Step 4:

Under the GivEnergy API Tokens section, click Generate New Token.

Generate New Token

Step 5:

Enter a name for your token (e.g., My GivEnergy Token). This could be something memorable, or random. 

Select "No Expiry" so that the connection remains active unless manually revoked. Smug won't work unless it is set to "No Expiry".

A pop-up will show, saying that it is strongly discouraged to generate an API token without an expiry. This is completely safe to do so for Smug - all the data is handled securely. 

image (13).png

Set Token Name

Step 6:

Select the following token scopes, then click Create Token:

Token Scopes

Step 7:

Once created, copy the token and store it in a secure location. GivEnergy only allows viewing it once.

Copy Token

Step 8:

You're all set! Paste the copied API token into the Smug app to complete the setup.

Connecting FoxESS devices

Obtaining a FoxESS API Key

To connect your FoxESS system to Smug, you need follow these steps to generate and use an API key from your FoxESS account.

Step 1:

Log into your FoxESS account. 

Step 2:

Once logged in, navigate to your User Profile > API Management.

FoxESS_1.png

FoxESS_2.png

Step 3:

Click on "Generate API Key". 

Enter a name for the key (this can be anything - such as 'Smug', 'your name' etc.) 

Enter your property address.

Tick both boxes to allow:

⚠️ Save the API Key.

Once the key is generated, copy and store it somewhere safe. FoxESS does not show the full key again after this step.

⚠️ If the key is lost, it cannot be recovered. You’ll need to delete it and generate a new one.

Paste the API Key in the Smug app. 

FoxESS_3.png

Connecting SolaX devices

Connecting your SolaX inverter and battery to Smug

On your inverter, there is a 10-character registration number under the QR code on your inverter's internet dongle. 

Alternatively, it is also shown under the QR code on the small back with your inverter's instruction manual.

Once you have the 10 digit number, you can enter it in the "Dongle registration number" field in the Smug app and select "Continue"

If you need any help with your SolaX power account, you can connect them on: service.uk@solaxpower.com

Troubleshooting error when connecting to SolaX or FoxESS devices

As we are currently in beta stage, you will receive an error when trying to connect to a SolaX or FoxESS system.

This is normal, as we need to manually unblock the linking, between the cloud and Smug.

For us to unblock this, we need the following additional information:

Inverter serial number (for FoxESS) or Dongle ID (for SolaX):
Solar system size (kW): 
Battery model (e.g. EP11, TP58):
Number of batteries: 

Please email this to hello@smug.energy