From 218ca9178dc1b6dcdab9b6f6071ea88da6c333a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Fri, 22 Oct 2021 14:36:05 +0200 Subject: [PATCH] Add some clarification to Fronius integration docs (#18888) Co-authored-by: Franck Nijhof Co-authored-by: Matthias Alphart --- source/_integrations/fronius.markdown | 29 +++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/source/_integrations/fronius.markdown b/source/_integrations/fronius.markdown index f115d5af5f3..3c837bbd1fa 100644 --- a/source/_integrations/fronius.markdown +++ b/source/_integrations/fronius.markdown @@ -13,7 +13,11 @@ ha_platforms: - sensor --- -The `fronius` sensor polls a [Fronius](https://www.fronius.com/) solar inverter, battery system or smart meter and present the values as sensors in Home Assistant. +The `fronius` sensor polls a [Fronius](https://www.fronius.com/) solar inverter, battery system or smart meter and presents the values as sensors in Home Assistant. Data is gathered directly from a Fronius device connected to your local network, this integration doesn't access the cloud. + +## 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. ## Configuration @@ -22,7 +26,7 @@ To enable this sensor, add the following lines to your `configuration.yaml` file ```yaml sensor: - platform: fronius - resource: FRONIUS_URL + resource: FRONIUS_URL_OR_IP monitored_conditions: - sensor_type: logger_info - sensor_type: inverter @@ -33,7 +37,7 @@ sensor: {% configuration %} resource: - description: "The URL of the Fronius device (e.g., `http://192.0.2.0` or `http://fronius.local`)" + description: "The hostname or IP address of the Fronius device (e.g., `192.0.2.0` or `http://fronius.local`)" required: true type: string monitored_conditions: @@ -51,7 +55,7 @@ monitored_conditions: type: string default: "device" device: - description: "The id of the device to poll" + description: "The ID of the device to poll" required: false default: "\"1\" for inverters and \"0\" for other devices such as storages in compliance with Fronius Specs" {% endconfiguration %} @@ -102,6 +106,19 @@ 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. +## Finding out devices IDs + +To find out the device ID of the inverter visit the URL: +`http://FRONIUS_IP/solar_api/v1/GetPowerFlowRealtimeData.fcgi` +In the returned JSON, under the key Body > Data > Inverters you should see your inverters listed with IDs starting from 1. + +To find out the device ID of the meter visit the URL: +`http://FRONIUS_IP/solar_api/v1/GetMeterRealtimeData.cgi?Scope=System` +In the returned JSON, under the key Body > Data you should see your meters listed with IDs starting from 0. + +To find out which API version your system runs, visit the URL: +`http://FRONIUS_IP/solar_api/GetAPIVersion.cgi` + ## Examples When including more of the components that one Fronius device offers, @@ -121,3 +138,7 @@ sensor: device: 0 - sensor_type: power_flow ``` + +## Note + +Fronius often provides firmware updates for the datamanager interfaces and the devices in their system, it's recommended to check and apply them regularly. This integration relies on functionality present in rather recent firmware.