5.8 KiB
title, description, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_domain, ha_platforms, ha_integration_type
title | description | ha_category | ha_release | ha_iot_class | ha_config_flow | ha_codeowners | ha_domain | ha_platforms | ha_integration_type | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Solar-Log | Instructions on how to integrate Solar-Log sensors within Home Assistant. |
|
0.101 | Local Polling | true |
|
solarlog |
|
integration |
The Solarlog {% term integration %} uses the open JSON interface on Solar-Log PV monitoring systems to get details from your Solar-Log device and integrate these into your Home Assistant installation.
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 you don't specify a host. If your device isn't accessible on this address, use its IP Address instead.
{% important %} 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). {% endimportant %}
{% include integrations/config_flow.md %}
Additional template sensor
In case you would like to get additional calculated sensors such as the amount of excess solar power available, you can use the template platform.
{% raw %}
# Example configuration.yaml entry for sensor template platform
template:
- sensor:
- name: "Solarlog yield day"
state: "{{ (states('sensor.solarlog_yield_day') | float(default=0) * 1000) | round(0,default=0) }}"
{% endraw %}
Sensors
The following sensors are available via the open JSON intervace:
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) |
Additional data
{% important %} 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. {% endimportant %}
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. |
{% note %} 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. {% endnote %}