Solar-Log
The Solarlog integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] uses the open JSON interface on Solar-Log PV monitoring systems
Supported devices
The integration should work with all Solar-Log devices.
Prerequisites
Before you can use the integration, you either need the password of the Solar-Log user or you must activate the open JSON interface on your Solar-Log device.
- To activate the JSON interface on your Solar-Log device, on the device, go to the Configuration | System | Access control menu.
- When activating the interface, a red warning triangle with security information and risks is displayed. For security reasons, it is recommended to activate password protection and use the integration with the respective password.
The solarlog integration uses the default host address “http://solar-log
If password protection for the general user is deactivated, the open JSON interface is activated by default. For security reasons, it is recommended to activate the user’s password. Please note that the open JSON interface only exposes a limited amount of data. Even if the open JSON interface has been activated, without the user’s password, only limited data is available in the integration see available sensors. For full functionality, you either need the user’s password or the user password should be deactivated (not recommended).
Configuration
To add the Solar-Log integration to your Home Assistant instance, use this My button:
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 Solar-Log.
-
Follow the instructions on screen to complete the setup.
To setup the integration you need the following information:
The name for your Solar-Log device in Home Assistant. This will also be uses as prefix for the entity names.
Check the box, if you have the password for the Solar-Log user to securely access all data.
Configuration options
The integration has no additional configuration options.
Remove integration
This integration can be removed by following these steps:
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-dot
menu. Then, select Delete.
Supported functionality
Sensors
The following sensors are available via the open JSON interface:
| name | Unit | Description |
|---|---|---|
| last_update | Time of latest data update. | |
| power_ac | W | Total output PAC from all of the inverters and meters in inverter mode. |
| power_dc | W | Total output PAC from all of the inverters. |
| voltage_ac | V | Average voltage AC from the inverter. |
| voltage_dc | V | Average voltage DC from the inverter |
| yield_day | kWh | Total yield for the day from all of the inverters |
| yield_yesterday | kWh | Total yield for the previous day from all of the inverters. |
| yield_month | kWh | Total yield for the month from all of the inverters. |
| yield_year | kWh | Total yield for the year from all of the inverters. |
| yield_total | kWh | Total yield from all of the inverters. |
| consumption_ac | kWh | Current total consumption AC from all of the consumption meters. |
| consumption_day | kWh | Total consumption for the day from all of the consumption meters. |
| consumption_yesterday | kWh | Total consumption for the previous day from all of the consumption meters. |
| consumption_month | kWh | Total consumption for the month from all of the consumption meters. |
| consumption_year | kWh | Total consumption for the year from all of the consumption meters. |
| consumption_total | kWh | Accumulated total consumption from all consumption meters. |
| installed_peak_power | W | Installed solar peak power. |
| alternator_loss | W | Altenator loss (equals to power_dc - power_ac) |
| capacity | % | Capacity (equals to power_dc / total power) |
| efficiency | % | Efficiency (equals to power_ac / power_dc) |
| power_available | W | Available power (equals to power_ac - consumption_ac) |
| usage | % | Usage (equals to consumption_ac / power_ac) |
The solarlog integration is using the solarlog_cli pypi package to get the data from your Solar-Log device. The last five sensors are not reported by your Solar-Log device directly, but are computed by the library.
Additional data
The additional data is only accessible if the user’s password is available (or password protection is deactivated). Obviously, deactivating password protection is a security risk and should only be done in specific circumstances. In any event, you do this at your own risk.
The following additional sensor becomes available:
| Name | Unit | Description |
|---|---|---|
| self_consumption_year | kWh | Annual self-consumed solar power. |
In addition, information from devices connected to the Solar-Log device becomes available. The following additional sensors become available (all values are per inverter/device):
| Name | Unit | Description |
|---|---|---|
| current_power | W | Current power provided/used by the device. |
| consumption_year | kWh | Total energy provided/used by the device. |
Additional template sensor
In case you would like to get additional calculated sensors such as the amount of excess solar power available or the energy returned to the grid, you can use the template platform.
# Example configuration.yaml entry for sensor template platform
template:
- sensor:
- name: "Solarlog return to grid"
state: "{{ states('sensor.solarlog_consumption_year') | float(0) - states('sensor.self_consumption_year') | float(0) }}"
Data updates
The integration fetches data from the device every minute.
Actions
The integration provides no additional actions.
Known limitations
The integration only provides the (limited) data exposed by means of the JSON interface. This also entails that the values for the self-consumption are rounded to full kWh.