Sunsynk
The Sunsynk integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] gets data from the Sunsynk cloud and shows it in Home Assistant.
Sunsynk makes hybrid solar inverters and batteries. The inverter sends its data to the Sunsynk cloud. You can see this data in the Sunsynk Connect app and on the Sunsynk Connect website. This integration reads the same data.
Prerequisites
- A Sunsynk inverter that is connected to the Sunsynk cloud with a Wi-Fi or Ethernet data logger.
- A Sunsynk Connect account. Use the same email address and password that you use in the Sunsynk Connect app.
Home Assistant can find the Sunsynk data logger on your network. The data logger has the hostname e-linter. When it is found, Home Assistant shows a Sunsynk discovery card. Select Add and enter your account details. You can also add the integration by hand.
Configuration
To add the Sunsynk hub to your Home Assistant instance, use this My button:
Manual configuration steps
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Sunsynk.
-
Follow the instructions on screen to complete the setup.
The integration adds all inverters of the account. Each inverter is a device in Home Assistant, named Inverter and the serial number, or the alias you set in Sunsynk Connect. A battery is a second device, linked to its inverter, named Battery and the serial number of the inverter. If you do not want an inverter, you can disable the device.
Supported devices
The integration supports all Sunsynk inverters that send data to the Sunsynk cloud.
Supported functionality
The integration creates the sensors below for each inverter. The sensors are read-only.
Solar
- Solar power (W): The power that the solar panels produce now.
- Solar energy today (kWh): The energy that the solar panels produced today.
- Solar energy total (kWh): The energy that the solar panels produced since installation.
Grid
- Grid power (W): The power that flows between the grid and the inverter now. The sign is the same as in the Sunsynk Connect app.
- Grid import today (kWh): The energy that came from the grid today.
- Grid import total (kWh): The energy that came from the grid since installation.
- Grid export today (kWh): The energy that went to the grid today.
- Grid export total (kWh): The energy that went to the grid since installation.
- Grid frequency (Hz): The frequency of the grid. This sensor is disabled by default.
Battery
The battery is a separate device in Home Assistant. It is linked to its inverter. The integration creates it only when the inverter reports a connected battery. If you add a battery later, reload the integration. The Sunsynk cloud reports one set of values for all battery packs of an inverter.
- Power (W): The power that flows between the battery and the inverter now. The sign is the same as in the Sunsynk Connect app.
- State of charge (%): The charge level of the battery.
- Charge today (kWh): The energy that went into the battery today.
- Charge total (kWh): The energy that went into the battery since installation.
- Discharge today (kWh): The energy that came out of the battery today.
- Discharge total (kWh): The energy that came out of the battery since installation.
- Voltage (V), Current (A) and Temperature (°C): These sensors are disabled by default.
Load
- Load power (W): The power that your home uses now.
- Load energy today (kWh): The energy that your home used today.
- Load energy total (kWh): The energy that your home used since installation.
Data updates
The integration polls the Sunsynk cloud every 5 minutes. Each inverter polls on its own. If the cloud does not answer for one inverter, only the entities of that inverter become unavailable.
The inverter sends new data to the cloud every 5 minutes, so a shorter interval does not give newer data. To read the data of one inverter now, use the homeassistant.update_entity action on one of its entities.
Actions
This integration does not provide additional actions.
Sunsynk automation examples
The sensors of this integration are useful in the energy dashboard and in automations. Here are a few ideas to get you started.
You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.
Energy dashboard
Use these sensors in the energy dashboard:
| Energy dashboard setting | Sensor |
|---|---|
| Grid consumption | Grid import total |
| Return to grid | Grid export total |
| Solar production | Solar energy total |
| Energy going into the battery | Battery: Charge total |
| Energy coming out of the battery | Battery: Discharge total |
Automation: Notify when the battery is low
Send a notification when the battery state of charge drops below 20%.
- Trigger: Numeric state: Battery: State of charge below 20
- Action: Send a notification
YAML example for a low battery notification
alias: "Notify when the battery is low"
triggers:
- trigger: numeric_state
entity_id: sensor.battery_1234567890_state_of_charge
below: 20
actions:
- action: notify.notify
data:
message: "The battery is at {{ states('sensor.battery_1234567890_state_of_charge') }}%."
Automation: Use excess solar power
Turn on a water heater when the solar panels produce more than 3 kW for 10 minutes. Turn it off again when solar power drops below 1 kW.
- Trigger: Numeric state: Solar power above 3000 for 10 minutes
- Action: Turn on the water heater switch
YAML example for using excess solar power
alias: "Use excess solar power"
triggers:
- trigger: numeric_state
entity_id: sensor.inverter_1234567890_solar_power
above: 3000
for:
minutes: 10
id: "on"
- trigger: numeric_state
entity_id: sensor.inverter_1234567890_solar_power
below: 1000
for:
minutes: 10
id: "off"
actions:
- action: "switch.turn_{{ trigger.id }}"
target:
entity_id: switch.water_heater
Known limitations
- The integration reads data only. It cannot change settings on the inverter.
- The data comes from the Sunsynk cloud. If the inverter loses its internet connection, the data does not update.
- Sunsynk limits the number of API requests. Do not use the same account in other tools that poll the API often.
Troubleshooting
The integration cannot connect
Make sure that Home Assistant has an internet connection and that Sunsynk Connect is online.
The password is no longer valid
If you change the password of your Sunsynk Connect account, the integration cannot log in and its entities become unavailable. Remove the integration and add it again with the new password.
The values do not match the Sunsynk Connect app
The integration and the app read the same data from the cloud. A small difference is possible because the integration polls every 5 minutes.
Removing the integration
This integration follows standard integration removal. No extra steps are required.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three dots
menu. Then, select Delete.