Operating
Instructions
Fronius Push Service
Fronius Push Service
Bedienungsanleitung
DE
Operating Instructions
EN
42,0410,2152 006-02082022
Inhaltsverzeichnis
Bedienungsanleitung 4
Allgemeines 4
Übersicht 5
Details 7
Allgemeines 7
Protokolle 7
Formate 7
SunSpec Datalogger v1.0b - inverter float model 9
SunSpec Datalogger v1.2 - meter model 10
SolarAPI v1 - CurrentData - Inverter 11
SolarAPI v1 - CurrentData - SensorCard 13
SolarAPI v1 - CurrentData - StringControl 14
SolarAPI v1 - CurrentData - Meter 15
SolarAPI v1 - CurrentData - Storages 17
SolarAPI v1 - CurrentData - Powerflow 20
SolarAPI v1 - Logdata - Data 21
SolarAPI v1 - Logdata - Errors and Events 23
Datamanager IO States 25
Demo Content 27
Intervalle 28
Anwendungs-Schnittstelle 29
DE
3
Bedienungsanleitung
Allgemeines Mit Hilfe der Funktion Push Service können Aktuell- und Log-Daten des Wech-
selrichters in unterschiedlichen Formaten oder mit unterschiedlichen Protokollen auf einen externen Server exportiert werden. Voraussetzung dafür ist ein Fronius Datamanager oder Fronius Datamanager 2.0.
Formate definieren, wie die Informationen gesendet werden.
Protokolle definieren die Art der Datenübertragung.
Werksseitig sind keine Jobs vorgegeben.
Mit dieser Funktion können max. 10 Jobs installiert werden. Für jeden einzelnen
Job können unterschiedliche Protokolle, Formate oder externe Server verwendet
werden.
Die Funktion Push Service ist auf der Website des Fronius Datamanagers im
Menü Einstellungen zu finden:
4
Übersicht
(1) (2)
(3)
(4)(5)
(6)
(7)
(8)
(9)
DE
(1) Schaltfläche Übernehmen / Speichern
speichert die Konfiguration und startet einen sofortigen Testlauf aller installierten und aktivierten Funktionen
(2) Schaltfläche Abbrechen / Eingaben verwerfen
verwirft sämtliche Änderungen und lädt die ursprüngliche Konfiguration
(3) Schaltfläche Hinzufügen
Klicken der Schaltfläche fügt einen neuen Push Service Job hinzu. Der
neue Job wird durch Klicken der Schaltfläche ‘Übernehmen / Speichern‘
(1) gespeichert.
(4) Status
zeigt den aktuellen Stand des jeweiligen Push Service Jobs an;
Bei einem Fehler können detaillierte Informationen angezeigt werden, indem der Mauszeiger über den Ursachen-Text gebracht wird. Die Detailinformationen werden nur in Englisch angezeigt.
(5) Angezeigter Name des Push Service Jobs
Der Name identifiziert den Push Service Job und darf nur einmal vorkommen.
(6) Bereich zur Eingabe der allgemeinen Daten:
Bezeichnung (Name des Push Service Jobs)
Dateiformat
Protokolltype (FTP upload / HTTP POST)
Intervall
Aktivierungsstatus
5
(7) Bereich zur Eingabe der Zieldaten:
Server Port
Upload Dateiname
Anmeldung (Benutzer / Passwort)
(8) Bereich zur Eingabe der Proxy-Daten:
Server Port
Benutzer
Passwort
(9) Schaltfläche Löschen
Klicken der Schaltfläche löscht den ausgewählten Push Service Job
Sind mehrere Push Service Jobs installiert, kann immer nur ein Job geöffnet und
verändert werden:
Liste mit mehreren Push Service Jobs, ein Job ist geöffnet und kann verändert werden; bei einem anderen Job wird eine Fehlerbeschreibung angezeigt, wenn der Mauszeiger über den Ursachen-Text gebracht wird.
6
Details
Allgemeines Die Kommunikation mit dem Fronius Push Service kann aktuell nur durch das Er-
stellen einer HTTP-Anfrage an eine bestimmte URL erfolgen.
DE
User Interface auf der Web-Seite des Fronius Datamanagers
Protokolle Aktuell werden die Protokolle HTTP-POST und FTP-Upload (passiv oder aktiv)
unterstützt.
Proxy
Die volle Proxy-Unterstützung (mit oder ohne Referenzen) wurde implementiert.
Ausnahme: Verwendung von Zertifikaten
Login-Authentifizierung
Unterstützt werden folgende Authentifizierungen:
Basic
-
Digest
-
Das Fronius Push Service überprüft automatisch, welche Authentifikation auszuwählen ist.
Formate Aktuell werden folgende Formate unterstützt:
7
SunSpec Datalogger v1.0b - inverter float model
-
SunSpec Datalogger v1.2 - meter model
-
SolarAPI v1 - CurrentData - Inverter
-
SolarAPI v1 - CurrentData - SensorCard
-
SolarAPI v1 - CurrentData - StringControl
-
SolarAPI v1 - CurrentData - Meter
-
SolarAPI v1 - Logdata - Data
-
SolarAPI v1 - Logdata - Erors and Events
-
Datamanager IO States
-
Demo Content
-
8
SunSpec Data-
*
*
logger v1.0b - inverter float model
XML basierendes Datenpaket
SunSpec Modelle 1 und (111, 112 oder 113)
weitere Informationen unter:
http://sunspec.org
Beispiel für exportierte Inhalte
DE
* Die Geräte-Seriennummern (SN) werden bei Fronius Symo, Primo und Galvo
erst ab Seriennummer 2713xxxx angezeigt. Bei älteren Geräten wird der Produktmatrix-Code (PMC) des Recerbo angezeigt.
9
SunSpec Datalogger v1.2 - meter model
XML basierendes Datenpaket
SunSpec Modelle 1 und 213
weitere Informationen unter:
http://sunspec.org
Beispiel für exportierte Inhalte
10
SolarAPI v1 CurrentData Inverter
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
DE
11
12
SolarAPI v1 CurrentData SensorCard
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
DE
13
SolarAPI v1 CurrentData StringControl
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
14
SolarAPI v1 CurrentData Meter
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
DE
15
16
SolarAPI v1 CurrentData Storages
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
DE
17
18
DE
19
SolarAPI v1 CurrentData -
Powerflow
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
20
SolarAPI v1 Logdata - Data
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
Enthält alle gesammelten Daten für den aktuellen Tag.
Wird dieses Format für weniger als tägliches Intervall verwendet, werden die Daten am externen Server verdoppelt. Wird das Intervall auf eine Woche eingestellt, werden Log-Daten-Anfragen für eine Woche erzeugt.
Das kleinstmögliche Intervall ist eine Stunde!
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
DE
21
22
SolarAPI v1 Logdata - Errors
and Events
JSON basierendes Datenpaket, ähnlich einer Web-Anfrage
Enthält alle gesammelten Fehler und Ereignisse für den aktuellen Tag.
Wird dieses Format für weniger als tägliches Intervall verwendet, werden die Daten am externen Server verdoppelt. Wird das Intervall auf eine Woche eingestellt, werden Log-Daten-Anfragen für eine Woche erzeugt.
Das kleinstmögliche Intervall sind 30 Minuten!
weitere Informationen unter:
http://www.fronius.com/de/solarenergie/produkte
Anlagen-Monitoring, Offene Schnittstellen, Fronius Solar API (JSON)
Beispiel für exportierte Inhalte
DE
23
24
Datamanager IO
States
JSON basierendes Datenpaket
Aktuell sind Richtung, Type und Funktionen programmiert. Weitere Änderungen
können innerhalb folgender Grenzen erfolgen:
Type: Digital, Analog
Richtung: in, out
get (erhalten): true, false
set (einstellen): true, false
Funktion: Digital_PowerControl_Feedback_Out_1
Digital_PowerManagementRelay_Out_1
Digital_PowerControl_In_1 - 8.
(unzählige, nicht vorausberechenbare Anwendungsfälle)
Beispiel für exportierte Inhalte
DE
25
26
Demo Content Dummy-Inhalt, wird zur Überprüfung von Verbindungseinstellungen verwendet,
ohne persönliche Inhalte wie Seriennummer oder Aktuelldaten zu übermitteln.
Beispiel für exportierte Inhalte
DE
27
Intervalle Bei werksseitiger Einstellung beginnt der Push Service um Mitternacht (00:00 h)
mit dem Datenexport und wiederholt dies entsprechend den festgelegten Einstellungen.
Bei Anwender-spezifischen Konfigurationen führt der Push Service sofort alle installierten und aktivierten Jobs einmal aus, um Richtigkeit und Funktionalität
überprüfen zu können. Danach arbeitet der Push Service wieder mit dem werksseitig eingestellten Export-Intervall.
Beispiel:
Falls ein Job auf ein Ein-Stunden-Intervall eingestellt ist, wird dieser alle 60 Minuten ausgeführt, beginnend um Mitternacht.
Die Anwendung einer neuen Konfiguration um beispielsweise 06:45 h lässt das
Push Service um 06:45 h einen Test durchführen. Danach arbeitet der Push Service wieder mit dem ursprünglichen Export-Intervall, folglich wird der nächste
Job um 07:00 h ausgeführt.
Intervalle
10 Sekunden
-
1 Minute
-
5 Minuten
-
10 Minuten
-
15 Minuten
-
30 Minuten
-
1 Stunde
-
2 Stunden
-
4 Stunden
-
12 Stunden
-
1 Tag (jeden Tag um 23:50 h / 11:50 pm)
-
1 Woche (jeden Sonntag um 23:50 h / 11:50 pm)
-
WICHTIG! Für die letzten zwei Optionen muss der Nachtmodus des Wechselrichters aktiviert sein, um eine Datenübertragung zu gewährleisten.
28
AnwendungsSchnittstelle
Die Anwendungs-Schnittstelle des Fronius Push Service bietet Drittanbietern eine Möglichkeit, Daten vom Fronius Push Service zu beziehen.
Die Anwendungs-Schnittstelle ist nicht für Anwender-Interaktionen ausgelegt.
Aktueller Status
Der aktuelle Status kann durch das Ausführen einer HTTP-Get-Anfrage abgefragt werden:
http:// *** /status/pushservice/
*** Hostname oder IP-Adresse Ihres Fronius Datamanagers
Beispiel für Antworten
DE
Diese Anfrage enthält eine Liste aller installierten Push Service Jobs und deren
Status. Jeder Status kann unterschiedliche optionale Attribute enthalten, die
den Status im Detail beschreiben. Der Name eines jeden Jobs muss einmalig sein
und dient zur Identifikation. Da der Name multilingual ist, wird dieser als HTMLNummernstrang dargestellt.
Beispiel:
Die HTML-Nummer ist kodiert zu
html num
ber
Status Beispiel eines JSON-Knotens innerhalb des
Service-Feldes
{
STR_PSHS_ERR_UNKNOWN
“Name“: “<???>“,
“State“: “STR_PSHS_UNKNOWN“
}
29
Status Beispiel eines JSON-Knotens innerhalb des
Service-Feldes
{
STR_PSHS_UNKNOWN
STR_PSHS_DISABLED
STR_PSHS_FAILED
Reason ist ein nicht übersetzter Term
STR_PSHS_UNTESTED
STR_PSHS_OK
“Name“: “<???>“,
“State“: “STR_PSHS_UNKNOWN“
}
{
“Name“: “<???>“,
“State“: “STR_PSHS_DISABLED“
}
{
“Name“: “<???>“,
“State“: “STR_PSHS_DISABLED“,
“Reason“: “text“
}
{
“Name“: “<???>“,
“State“: “STR_PSHS_UNTESTED“
}
{
“Name“: “<???>“,
“State“: “STR_PSHS_OK“,
“Span“: 26
}
Span ist die Zeit in Sekunden seit dem letz-
ten erfolgreichen Upload
30
Contents
Operating Instructions 32
General 32
Overview 33
Details 35
General 35
Protocols 35
Formats 35
SunSpec Datalogger v1.0b - inverter float model 37
SunSpec Datalogger v1.2 - meter model 38
SolarAPI v1 - CurrentData - Inverter 39
SolarAPI v1 - CurrentData - SensorCard 41
SolarAPI v1 - CurrentData - StringControl 42
SolarAPI v1 - CurrentData - Meter 43
SolarAPI v1 - CurrentData - Storages 45
SolarAPI v1 - CurrentData - Powerflow 48
SolarAPI v1 - Logdata - Data 49
SolarAPI v1 - Logdata - Errors and Events 51
Datamanager IO States 53
Demo Content 55
Intervals 56
Application interface 57
EN
31
Operating Instructions
General Using the push service, current and log data of the inverter can be exported to an
external server in different formats or using different protocols.The prerequisite
for this is a Fronius Datamanager or Fronius Datamanager 2.0.
Formats define how the information is sent.
Protocols define the type of data transfer.
There are no pre-installed jobs.
Up to 10 jobs can be installed using this function. Each job may use different
protocols, formats or external servers.
The Push Service function can be found on the Fronius Datamanager website in
the Settings menu:
32
Overview
(1) (2)
(3)
(4)(5)
(6)
(7)
(8)
(9)
EN
(1) "Apply/Save" button
Saves the configuration and starts an immediate test run of all the installed and enabled services
(2) "Cancel/Discard entry" button
Discards any changes and reloads the original configuration
(3) "Add" button
Click this button to add a new push service job. The new job is saved by
clicking the "Apply/Save" button (1).
(4) State
Displays the current status of the respective push service job.
In the event of an error, detailed information can be displayed by hovering
the cursor above the cause text. The detailed information is only displayed
in English.
(5) Displayed name of the push service job
The name identifies the push service job and must be unique.
(6) Area for entering general data:
Name (name of the push service job)
Data format
Protocol type (FTP upload/HTTP POST)
Interval
Activation status
33
(7) Area for entering destination data:
Server port
Upload file name
Login (user/password)
(8) Area for entering proxy data:
Server port
User
Password
(9) "Delete" button
Click this button to delete the selected push service job
Only one job can be opened and edited at any given time, regardless of how many
push service jobs have been installed:
34
List of multiple push service jobs. One job has been opened and can be edited; for all other jobs, an
error message will be displayed if the cursor is hovered over the cause text.
Details
General At present the only way to communicate with the Fronius push service is to make
an HTTP request to a specific URL.
EN
User interface on the Fronius Datamanager web page
Protocols The HTTP POST and FTP upload (passive or active) protocols are currently sup-
ported.
Proxy
Full proxy support (with or without references) has been implemented.
Exception: use of certificates
Login authentication
The following authentications are supported:
Basic
-
Digest
-
The Fronius push service automatically checks which authentication should be
selected.
Formats The following formats are currently supported:
35
SunSpec Datalogger v1.0b - inverter float model
-
SunSpec Datalogger v1.2 - meter model
-
SolarAPI v1 - CurrentData - Inverter
-
SolarAPI v1 - CurrentData - SensorCard
-
SolarAPI v1 - CurrentData - StringControl
-
SolarAPI v1 - CurrentData - Meter
-
SolarAPI v1 - Logdata - Data
-
SolarAPI v1 - Logdata - Errors and Events
-
Datamanager IO States
-
Demo Content
-
36
SunSpec Data-
*
*
logger v1.0b - inverter float model
XML-based data package
SunSpec Models 1 and (111, 112 or 113)
For more information see:
http://sunspec.org
Example of pushed content
EN
* The device serial numbers (SN) are only displayed for Fronius Symo, Primo and
Galvo from serial number 2713xxxx. For older devices, the product matrix code
(PMC) of the Recerbo is displayed.
37
SunSpec Datalogger v1.2 - meter model
XML-based data package
SunSpec Models 1 and 213
For more information see:
http://sunspec.org
Example of pushed content
38
SolarAPI v1 CurrentData Inverter
JSON-based data package, similar to a web request
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
EN
39
40
SolarAPI v1 CurrentData SensorCard
JSON-based data package, similar to a web request
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
EN
41
SolarAPI v1 CurrentData StringControl
JSON-based data package, similar to a web request
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
42
SolarAPI v1 CurrentData Meter
JSON-based data package, similar to a web request
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
EN
43
44
SolarAPI v1 CurrentData Storages
JSON-based data package, similar to a web request
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
EN
45
46
EN
47
SolarAPI v1 CurrentData -
Powerflow
JSON-based data package, similar to a web request
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
48
SolarAPI v1 Logdata - Data
JSON-based data package, similar to a web request
Contains all the collated data for the current day.
Data will be duplicated on the external server if this format is used for an interval
more frequent than daily. If the interval is set to one week, log data requests for
one week are generated.
The smallest possible interval is one hour.
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
EN
49
50
SolarAPI v1 Logdata - Errors
and Events
JSON-based data package, similar to a web request
Contains all the collated errors and events for the current day.
Data will be duplicated on the external server if this format is used for an interval
more frequent than daily. If the interval is set to one week, log data requests for
one week are generated.
The smallest possible interval is 30 minutes.
For more information go to:
http://www.fronius.com/en/photovoltaics/products
System Monitoring, Open Interfaces, Fronius Solar API (JSON)
Example of pushed content
EN
51
52
Datamanager IO
States
JSON-based data package
The direction, type and functions are currently programmed. Other changes can
be made within the following limits:
Type: Digital, Analog
Direction: in, out
get: true, false
set: true, false
Function: Digital_PowerControl_Feedback_Out_1
Digital_PowerManagementRelay_Out_1
Digital_PowerControl_In_1 - 8.
(countless, unpredictable use cases)
Example of pushed content
EN
53
54
Demo Content Dummy content is used to check the connection settings without having to send
private data such as serial numbers or current data.
Example of pushed content
EN
55
Intervals According to the default configuration, the push service will start the data ex-
port at midnight (00:00 am) and repeat it as per the defined settings.
Where user-specific configurations are applied, the push service immediately
executes all installed and enabled jobs in order to check accuracy and functionality. The push service will then revert to operating at the default export interval.
Example:
If a job is set to a one hour interval, then this will performed every 60 minutes
starting at midnight.
If a new configuration is applied at 6:45 am, the push service will carry out a test
run at 6:45 am. From this point on the push service will return to its original export interval; the next job will thus be carried out at 7:00 am.
Intervals
10 seconds
-
1 minute
-
5 minutes
-
10 minutes
-
15 minutes
-
30 minutes
-
1 hour
-
2 hours
-
4 hours
-
12 hours
-
1 day (every day at 23:50 / 11:50 pm)
-
1 week (every Sunday at 23:50 / 11:50 pm)
-
IMPORTANT! Night mode must be enabled on the inverter to ensure a reliable
data transfer for the last two options.
56
Application interface
The Fronius push service application interface is a means for third parties to obtain data from the Fronius push service.
It is not designed for user interaction.
Current state
EN
The current state can be requested be performing an HTTP get request:
http:// *** /status/pushservice/
*** host name or IP address of your Fronius Datamanager
Example responses
This request contains a list of all the installed push service jobs and their respective states. Each state can have different attributes that describe the state in detail. The name of each job must be unique for identification purposes. As the name is multilingual, it is written as an HTML number string.
Example:
The HTML number is encoded to
html num
ber
State Example of a JSON node within a service
field
{
STR_PSHS_ERR_UNKNOWN
"Name": "<???>",
"State": "STR_PSHS_UNKNOWN"
}
57
State Example of a JSON node within a service
field
{
STR_PSHS_UNKNOWN
STR_PSHS_DISABLED
STR_PSHS_FAILED
Reason is a non-localised term
STR_PSHS_UNTESTED
STR_PSHS_OK
"Name": "<???>",
"State": "STR_PSHS_UNKNOWN"
}
{
"Name": "<???>",
"State": "STR_PSHS_DISABLED"
}
{
"Name": "<???>",
"State": "STR_PSHS_DISABLED",
"Reason": "text"
}
{
"Name": "<???>",
"State": "STR_PSHS_UNTESTED"
}
{
"Name": "<???>",
"State": "STR_PSHS_OK",
"Span": 26
}
Span is the time in seconds since the last
successful upload
58
EN
59
-
-
Loading...