Update Fronius documentation to include new entity naming style (#23362)

This commit is contained in:
Matthias Alphart 2022-07-12 16:16:11 +02:00 committed by GitHub
parent 6dcb9c3d10
commit 6af844a42a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -18,12 +18,12 @@ ha_dhcp: true
ha_integration_type: integration ha_integration_type: integration
--- ---
The `fronius` integration polls a [Fronius](https://www.fronius.com/) solar inverter or datalogger to allow you to get details from your Fronius SolarNet setup and integrate it in your Home Assistant installation. The Fronius integration polls a [Fronius](https://www.fronius.com/) solar inverter or datalogger for details of a Fronius SolarNet setup and integrate it in your Home Assistant installation.
## Prerequisites ## Prerequisites
You will need to either set a static IP on the Fronius device or assign a static DHCP lease for it, or alternatively access it through the local DNS name if your network is properly configured for this. You should either set a static IP or assign a static DHCP lease for the Fronius device, or alternatively access it through the local DNS name if your network is configured accordingly.
For Gen24 devices (delivered with Firmware >= 1.14.1) make sure to activate the "Solar API" in the inverters web interface. For Gen24 devices (delivered with Firmware >= 1.14.1) make sure to activate "Solar API" in the inverters web interface.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
@ -33,71 +33,68 @@ Each device adds a set of sensors to Home Assistant.
- SolarNet device - SolarNet device
- `logger_info` - Logger information
General information about the Fronius Datalogger. Not available on "Gen24" devices. Updated every hour. General information about the Fronius Datalogger. Not available on "Gen24" devices. Updated every hour.
- The serial number and software and hardware platforms - Serial number, software and hardware platforms
- The current price of energy consumed from the grid ("cash factor") - Current price of energy consumed and returned to grid and the CO₂ factor as set in the Dataloggers settings
- The current price of energy returned to the grid ("delivery factor")
- `power_flow` - Power flow
Cumulative data such as the energy produced in the current day or year and overall produced energy. Updated every 10 seconds. Cumulative data of the SolarNet system. Updated every 10 seconds.
Also, live values such as:
- Power fed to the grid (if positive) or taken from the grid (if negative). - Energy produced on the current day, year and total produced energy
- Power load as a generator (if positive) or consumer (if negative). - Power fed to the grid (if positive) or consumed from the grid (if negative)
- Battery charging power (if positive) or discharging power (if negative) and information about backup or standby mode. - Power load as a generator (if positive) or consumer (if negative)
- Photovoltaic production. - Battery charging power (if positive) or discharging power (if negative) and information about backup or standby mode
- Current relative self-consumption of produced energy. - Photovoltaic production
- Current relative autonomy. - Current relative self-consumption of produced energy
- Current relative autonomy
- `inverter` - Inverter
Cumulative data such as the energy produced in the current day or year and overall produced energy. Updated every minute. Energy produced on the current day, year and total produced energy, power, current, voltage, frequency and status for an individual inverter. Updated every minute.
Also, live values about AC/DC power, current, voltage and frequency.
- `meter` - Meter
Detailed information about power, current and voltage, if supported split among the phases. Updated every minute. Detailed information about power, current and voltage, if supported split among the phases. Updated every minute.
- `ohmpilot` - Ohmpilot
Detailed information about energy, power, and temperature of your Ohmpilots. Updated every minute. Detailed information about energy, power, and temperature of your Ohmpilots. Updated every minute.
- `storage` - Storage
Detailed information about current, voltage, state, cycle count, capacity and more about installed batteries. Updated every minute. Detailed information about current, voltage, state, cycle count, capacity and more about installed batteries. Updated every minute.
Note that some data (like photovoltaic production) is only provided by the Fronius device when non-zero. Note that some data (like photovoltaic production) is only provided by the Fronius device when non-zero.
The corresponding sensors are added to Home Assistant as entities as soon as they are available. When the integration is added at night, there might be no sensors added providing photovoltaic related data. Entities will be added on sunrise, when the Fronius devices begin to provide more data.
This means for example that when Home Assistant is started at night, there might be no sensor providing photovoltaic related data.
This does not need to be problematic as the values will be added on sunrise, when the Fronius devices begins providing the needed data. When an endpoint is not responding correctly the update interval will increase to 10 minutes (3 minutes for power flow) until valid data is received again. This reduces the amount of requests to Fronius devices using night mode (shutdown when no PV power is produced).
When a device is not responding correctly the update interval will increase to 10 minutes (3 minutes for power flow) until valid data is received again.
## Energy dashboard ## Energy dashboard
- For `Solar production`: - For _"Solar production"_:
- If no battery is connected to an inverter: Add each inverters `Energy total` entity. - If no battery is connected to an inverter: Add each inverters `Energy total` entity.
- If a battery is connected to an inverter: Use [Riemann sum](/integrations/integration/) over `Power photovoltaics` entity (from power_flow endpoint found in your `SolarNet` device) - If a battery is connected to an inverter: Use [Riemann sum](/integrations/integration/) over `Power photovoltaics` entity (from your `SolarNet` device).
- `Battery systems` aren't supported directly. Use [Template](/integrations/template) to split and invert negative values of `Power battery` entity (from power_flow) for charging power (W) and positive values for discharging power (W). Then use [Riemann sum](/integrations/integration/) to integrate each into energy values (kWh). - _"Battery systems"_ aren't supported directly. Use [Template](/integrations/template) to split and invert negative values of `Power battery` entity (from `SolarNet` device) for charging power (W) and positive values for discharging power (W). Then use [Riemann sum](/integrations/integration/) to integrate each into energy values (kWh).
- For `Devices` use the Ohmpilots `Energy consumed` entity. - For _"Devices"_ use the Ohmpilots `Energy consumed` entity.
The energy meter integrated with Fronius devices can be installed (and configured) in two different installation positions: _"feed in path"_ (`meter_location` = 0) or _"consumption path"_ (`meter_location` = 1). In the first case, the meter provides all data you need but, in the second case, it doesn't so you need to calculate some of them by using helpers. The energy meter integrated with Fronius devices can be installed (and configured) in two different installation positions: _"feed in path"_ (`Meter location` = 0) or _"consumption path"_ (`Meter location` = 1).
### Feed in path meter ### Feed in path meter
Recommended energy dashboard configuration for meter location in feed in path: Recommended energy dashboard configuration for meter location in feed in path:
- For `Grid consumption` use the meters `Energy real consumed` entity. - For _"Grid consumption"_ use the meters `Energy real consumed` entity.
- For `Return to grid` use the meters `Energy real produced` entity. - For _"Return to grid"_ use the meters `Energy real produced` entity.
### Consumption path meter ### Consumption path meter
Recommended energy dashboard configuration for meter location in consumption path: Recommended energy dashboard configuration for meter location in consumption path:
- The "Power Grid" entity provided by the Fronius API is positive on import and negative on export. Split it up into import- and export-power entities by using helpers with templates `max(states(sensor.power_grid) | float, 0)` and `max(0 - states(sensor.power_grid) | float, 0)`. - The `Power grid` entity provided by the Fronius API is positive on import and negative on export. Split it up into import- and export-power entities by using helpers with templates `max(states(sensor.solarnet_power_grid) | float, 0)` and `max(0 - states(sensor.solarnet_power_grid) | float, 0)`.
- Then use [Riemann sum](/integrations/integration/) to integrate these import-/export-power entities into energy values (kWh). - Then use [Riemann sum](/integrations/integration/) to integrate these import-/export-power entities into energy values (kWh).
- Use these energy entities for `Grid consumption` and `Return to grid` in the energy dashboard configuration. - Use these energy entities for `Grid consumption` and `Return to grid` in the energy dashboard configuration.