Professional Documents
Culture Documents
42,0410,2012
42,0410,2012
Operating Instructions
Fronius Solar API V1 EN
System monitoring
42,0410,2012,EN 010-21082017
2
Contents
1 Introduction 5
2 General Considerations 5
2.1 Output Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2.1 Numeric Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2.2 Date/Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3.1 Querying of API version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3.2 Addressing of devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.4 Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4.1 Common Response Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.4.2 Request Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3 Realtime Requests 9
3.1 GetInverterRealtimeData request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1.2 Collection availability on Fronius Hybrid Systems . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1.3 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.1.4 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.1.5 Data Collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.1.6 Object structure of request body (Scope "Device") . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.7 Example of request body (Scope "Device") . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.8 Object structure of request body (Scope "System") . . . . . . . . . . . . . . . . . . . . . . . 12
3.1.9 Example of request body (Scope "System") . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2 GetSensorRealtimeData request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.4 Data Collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.5 Object structure of request body (DataCollection "NowSensorData") . . . . . . . . . . . . . 14
3.2.6 Example of request body (DataCollection "NowSensorData") . . . . . . . . . . . . . . . . . 14
3.2.7 Object structure of request body (DataCollection "MinMaxSensorData") . . . . . . . . . . . 15
3.2.8 Example of request body (DataCollection "MinMaxSensorData") . . . . . . . . . . . . . . . 16
3.3 GetStringRealtimeData request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3.4 Data Collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3.5 Object structure of request body (DataCollection "NowStringControlData" and "CurrentSum-
StringControlData") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.3.6 Example of request body (DataCollection "CurrentSumStringControlData") . . . . . . . . . 20
3.3.7 Object structure of request body (DataCollection "LastErrorStringControlData") . . . . . . 20
3.3.8 Example of request body (DataCollection "LastErrorStringControlData") . . . . . . . . . . . 21
3.4 GetLoggerInfo request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.4.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.4.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.4.3 Object structure of request body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.4.4 Example of request body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.5 GetLoggerLEDInfo request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.5.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.5.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.5.3 Object structure of request body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.5.4 Example of request body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.6 GetInverterInfo request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.6.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.6.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.6.3 Object structure of request body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.6.4 Example of request body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.6.5 Meaning of numerical status codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3
3.7 GetActiveDeviceInfo request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.7.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.7.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.7.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.7.4 DeviceClass not System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.7.5 DeviceClass is System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.8 GetMeterRealtimeData request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.8.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.8.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.8.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.8.4 System-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.8.5 Device-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.9 GetStorageRealtimeData request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.9.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.9.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.9.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.9.4 Details about Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.9.5 System-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3.9.6 Device-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.10 GetOhmPilotRealtimeData request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.10.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.10.2 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.10.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.10.4 System-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.10.5 Device-Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.11 GetPowerFlowRealtimeData request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.2 Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.3 URL for HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.4 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.5 Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
4 Archive Requests 52
4.1 Common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.1.1 Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.2 ChannelId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.3.1 Object Structure of response body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
4.4 Example of response body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
4.4.1 Meter data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
4.4.2 Inverter data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
4.4.3 Errors - Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
4.4.4 Events - Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
6 Changelog 59
4
1 Introduction
The Fronius Solar API is a means for third parties to obtain data from various Fronius devices (inverters, Sensor-
Cards, StringControls) in a defined format through a central facility which acts as a proxy (e.g. Fronius Datalogger
Web or Fronius Solar.web).
Currently, the only way to interact with this API is by making a HTTP request to a specific CGI. The URLs for
the particular requests and the devices supporting them are listed at the beginning of each request description.
The API is versioned, meaning that multiple versions of this API may be available on the same device. The URLs
in this document always point to the version of the API which this document describes. The highest supported
version on the device can be queried. See 2.3.1 for details.
In order to check your product for compatibility with this version of the API specification, please see the separate
document provided for this purpose.
The API divides roughly into realtime and archive requests: Realtime requests will obtain the data directly from the
devices and can therefore only be used when the devices are not in standby or unavailable in any other matter.
Archive requests will use the data stored in a central logging facility to obtain the results and are of course not
subjected to the former limitation.
2 General Considerations
2.1 Output Formats
Currently, the only output format supported is JSON, a lightweight data interchange format. It is easy to read
and write for both humans and machines and it offers some advantages over XML, like basic typing and a leaner
structure.
This means we cannot reliably specify value ranges for all requests. So it is the responsibility of the API user
to determine whether a value fits into a certain datatype in his language of choice.
What we can do is to specify whether a certain value is a floating point value (markes as "number") or an integer
value (marked as "integer"), where "integer" must not be interpreted as the datatype "int" like available in C/C++,
it just means it is a value without decimal places.
For these specifications, please refer to the sections discussing the respective request.
Examples
number 1, -2, 0, 4, 4.0, 0.001, -10.002, ....
2.2.2 Date/Time
Information on date/time is always (and can only be) represented by a string. The format for these strings inside
this API has been defined as follows.
5
• Strings which include information on both date and time are always in RFC3339 format with time zone offset
or Zulu marker.
See Section 5.6 of RFC3339
Example 1: 2011-10-20T10:23:17+02:00 (UTC+2)
Example 2: 2011-10-20T08:23:17Z (UTC)
• Strings which only include information on the date are of the format yyyy-MM-dd.
• Strings which only include information on the time are of the format hh:mm:ss.
• If no information on the time zone is given, any date/time specification is considered to be in local time of
the PV system.
2.3 Requests
Currently, the only request protocol supported is HTTP.
# URL under which the CGIs for the requests can be reached .
string BaseURL ;
6
2.4 Responses
The response will always be a valid JSON string ready to be evaluated by standard libraries.
If the response is delivered through HTTP, the Content-Type Header shall be either text/javascript or
application/json.
All JSON structures are described using Orderly JSON, a textual format for describing JSON data. Please refer
to the online documentation on Orderly for details.
Note that the definitions of some response bodies are not totally accurate, because there's no (known) way to
express nodes named after values/channels (e.g. objects which are named "PAC" or "Power"). But each descrip-
tion is accompanied by an example which should clear up any uncertainty.
The contents of the response object will vary depending on the preceding request but it always contains a common
response header and a request body.
7
" TOTAL_ENERGY " : {
" Value " : 45000 ,
"Unit" : "Wh"
},
"UAC" : {
" Value " : 232 ,
"Unit" : "V"
},
"UDC" : {
" Value " : 426 ,
"Unit" : "V"
},
" YEAR_ENERGY " : {
" Value " : 44000 ,
"Unit" : "Wh"
},
" DeviceStatus " : {
" DeviceState " : 7,
" MgmtTimerRemainingTime " : -1,
" ErrorCode " : 0,
" LEDColor " : 2,
" LEDState " : 0,
" StateToReset " : false
}
}
}
}
# Indicates if the request went OK or gives a hint about what went wrong .
# 0 means OK , any other value means something went wrong (e.g. Device not available ,
# invalid params , no data in logflash for given time , ...).
integer Code;
} Status ;
};
8
Value Status Description
0 OKAY Request successfully finished, Data are valid
1 NotImplemented The request or a part of the request is not implemented yet
2 Uninitialized Instance of APIRequest created, but not yet configured
3 Initialized Request is configured and ready to be sent
4 Running Request is currently being processed (waiting for response)
5 Timeout Response was not received within desired time
6 Argument Error Invalid arguments/combination of arguments or missing arguments
7 LNRequestError Something went wrong during sending/receiving of LN-message
8 LNRequestTimeout LN-request timed out
9 LNParseError Something went wrong during parsing of successfully received LN-message
10 ConfigIOError Something went wrong while reading settings from local config
11 NotSupported The operation/feature or whatever is not supported
12 DeviceNotAvailable The device is not available
255 UnknownError undefined runtime error
3 Realtime Requests
These requests will be provided where direct access to the realtime data of the devices is possible. This is cur-
rently the case for the Fronius Datalogger Web and the Fronius Datamanager.
In order to eliminate the need to specify each wanted value separately when making a request or querying each
value separately, so called "Data Collections" were defined.
The values in these collections are gathered from one or more Fronius Solar Net messages and supplied to the
user in a single response to a certain request.
It may be the case that more values are queried from the device than the user is interested in, but the overhead
caused by these superfluous values should be negligible compared to the advantages this strategy provides for
the user.
If a device cannot provide some values of a DataCollection (e.g. because they are not implemented on
the device) then those values are omitted from the response.
3.1.1 Availability
Platform Since version
Fronius Hybrid Not all DataCollections supported
Fronius Non Hybrid ALWAYS
9
3.1.3 URL for HTTP requests
/solar_api/v1/GetInverterRealtimeData.cgi
3.1.4 Parameters
Parameter Type Range/Values/Pattern Description
Scope String "Device" Query specific device(s)
"System" or whole system (uses collection "Cumu-
lationInverterData")
DeviceId String Solar Net: 0 …99 Only needed for Scope "Device"
Which inverter to query.
DataCollection String "CumulationInverterData" Only needed for Scope "Device"
"CommonInverterData" Selects the collection of data that should
"3PInverterData" be queried from the device.
"MinMaxInverterData" See 3.1.5 for details.
10
MinMaxInverterData Minimum- and Maximum-values of various inverter values.
Listing 6: Object structure of request body for GetInverterRealtimeData request (Scope "Device")
object {
# Unscaled value .
# value name based specific data type
<specific data type > Value ;
} __VALUE_NAME__ ;
}* Data;
};
{
"Data" : {
" DAY_ENERGY " : {
" Value " : 8000 ,
"Unit" : "Wh"
},
"FAC" : {
" Value " : 50,
"Unit" : "Hz"
},
"IAC" : {
" Value " : 14.54 ,
"Unit" : "A"
},
"IDC" : {
" Value " : 8.2 ,
"Unit" : "A"
11
},
"PAC" : {
" Value " : 3373 ,
"Unit" : "W"
},
"SAC" : {
" Value " : 3413 ,
"Unit" : "VA"
},
" TOTAL_ENERGY " : {
" Value " : 45000 ,
"Unit" : "Wh"
},
"UAC" : {
" Value " : 232 ,
"Unit" : "V"
},
"UDC" : {
" Value " : 426 ,
"Unit" : "V"
},
" YEAR_ENERGY " : {
" Value " : 44000 ,
"Unit" : "Wh"
},
" DeviceStatus " : {
" StatusCode " : 7,
" MgmtTimerRemainingTime " : -1,
" ErrorCode " : 0,
" LEDColor " : 2,
" LEDState " : 0,
" StateToReset " : false
}
}
}
Listing 8: Object structure of request body for GetInverterRealtimeData request (Scope "System")
object {
# Collection of named object (s) containing values per device and metadata .
# Members of Data object are named according to the value they represent (e.g. "PAC ").
object {
}* Values ;
} __VALUE_NAME__ ;
}* Data;
12
};
{
"Data" : {
"PAC" : {
"Unit" : "W",
" Values " : {
"0" : 4330 ,
"1" : 3721
}
},
" DAY_ENERGY " : {
"Unit" : "Wh",
" Values " : {
"0" : 6366 ,
"1" : 6000
}
},
" YEAR_ENERGY " : {
"Unit" : "Wh",
" Values " : {
"0" : 1041607 ,
"1" : 42000
}
},
" TOTAL_ENERGY " : {
"Unit" : "Wh",
" Values " : {
"0" : 3551131 ,
"1" : 43000
}
}
}
}
3.2.1 Availability
Platform Since version
Fronius Hybrid ALWAYS
Fronius Non Hybrid ALWAYS
13
3.2.3 Parameters
Parameter Type Range/Values/Pattern Description
Scope String "Device" Query specific device(s)
"System" or whole system
DeviceId String Solar Net: 0 …9 Which card to query.
DataCollection String "NowSensorData" Selects the collection of data that should
"MinMaxSensorData" be queried from the device.
See 3.2.4 for details.
MinMaxSensorData The minimum and maximum values for every time period (day, month, year, total) of every
channel.
Some channels do not have a minimum value because it would always be zero. For these channels, the minimum
value is not included.
Listing 10: Object structure of request body for GetSensorRealtimeData request (DataCollection "NowSensor-
Data")
object {
# Collection of named object (s) containing values per channel and metadata .
# Members of Data object are named according to the channel index they represent (e.g.
"0").
object {
} __CHANNEL_INDEX__ ;
}* Data;
};
Listing 11: Example of request body for GetSensorRealtimeData request (DataCollection "NowSensorData")
// GetSensorRealtimeData .cgi? Scope = Device & DeviceId =1& DataCollection = NowSensorData
{
"Data" : {
"0" : {
" Value " : -9,
"Unit" : "°C"
},
"1" : {
" Value " : 24,
"Unit" : "°C"
},
"2" : {
" Value " : 589 ,
14
"Unit" : "W/m 2"
},
"4" : {
" Value " : 0,
"Unit" : "KWh/m 2"
}
}
}
Listing 12: Object structure of request body for GetSensorRealtimeData request (DataCollection "MinMaxSen-
sorData")
object {
# Collection of named object (s) containing min/max values per channel and metadata .
# Members of Data object are named according to the channel index they represent (e.g.
"0").
object {
15
} Min;
} Year;
} __CHANNEL_INDEX__ ;
}* Data;
};
Listing 13: Example of request body for GetSensorRealtimeData request (DataCollection "MinMaxSensorData")
// GetSensorRealtimeData .cgi? Scope = Device & DeviceId =1& DataCollection = MinMaxSensorData
{
"Body" : {
"Data" : {
"0" : {
"Day" : {
"Max" : {
"Unit" : "°C",
" Value " : 66
},
"Min" : {
"Unit" : "°C",
" Value " : 46
}
},
" Month " : {
"Max" : {
"Unit" : "°C",
" Value " : 85
},
"Min" : {
"Unit" : "°C",
" Value " : 0
}
},
" SensorActive " : true ,
" Total " : {
"Max" : {
"Unit" : "°C",
" Value " : 85
},
"Min" : {
"Unit" : "°C",
" Value " : -35
}
},
"Year" : {
"Max" : {
"Unit" : "°C",
" Value " : 85
16
},
"Min" : {
"Unit" : "°C",
" Value " : 0
}
}
},
"1" : {
"Day" : {
"Max" : {
"Unit" : "°C",
" Value " : 27
},
"Min" : {
"Unit" : "°C",
" Value " : 27
}
},
" Month " : {
"Max" : {
"Unit" : "°C",
" Value " : 77
},
"Min" : {
"Unit" : "°C",
" Value " : 27
}
},
" SensorActive " : true ,
" Total " : {
"Max" : {
"Unit" : "°C",
" Value " : 187
},
"Min" : {
"Unit" : "°C",
" Value " : -35
}
},
"Year" : {
"Max" : {
"Unit" : "°C",
" Value " : 77
},
"Min" : {
"Unit" : "°C",
" Value " : 27
}
}
},
"2" : {
"Day" : {
"Max" : {
"Unit" : "W/m 2",
" Value " : 0
}
},
" Month " : {
"Max" : {
"Unit" : "W/m 2",
" Value " : 159
}
},
" SensorActive " : true ,
" Total " : {
"Max" : {
"Unit" : "W/m 2",
17
" Value " : 10036
}
},
"Year" : {
"Max" : {
"Unit" : "W/m 2",
" Value " : 159
}
}
},
"3" : {
"Day" : {
"Max" : {
"Unit" : "Hz",
" Value " : 0
}
},
" Month " : {
"Max" : {
"Unit" : "Hz",
" Value " : 0
}
},
" SensorActive " : false ,
" Total " : {
"Max" : {
"Unit" : "Hz",
" Value " : 2975
}
},
"Year" : {
"Max" : {
"Unit" : "Hz",
" Value " : 0
}
}
},
"4" : {
"Day" : {
"Max" : {
"Unit" : "Hz",
" Value " : 0
}
},
" Month " : {
"Max" : {
"Unit" : "Hz",
" Value " : 0
}
},
" SensorActive " : false ,
" Total " : {
"Max" : {
"Unit" : "Hz",
" Value " : 2982
}
},
"Year" : {
"Max" : {
"Unit" : "Hz",
" Value " : 0
}
}
},
"5" : {
"Day" : {
"Max" : {
18
"Unit" : "A",
" Value " : 0
}
},
" Month " : {
"Max" : {
"Unit" : "A",
" Value " : 0
}
},
" SensorActive " : true ,
" Total " : {
"Max" : {
"Unit" : "A",
" Value " : 36934
}
},
"Year" : {
"Max" : {
"Unit" : "A",
" Value " : 0
}
}
}
}
}
}
3.3.3 Parameters
Parameter Type Range/Values/Pattern Description
Scope String "Device" Query specific device
"System" or whole system
DeviceId String Solar Net: 0 …199 Which device to query.
DataCollection String "NowStringControlData" Selects the collection of data that
"LastErrorStringControlData" should be queried from the device.
"CurrentSumStringControlData" See 3.3.4 for details.
TimePeriod String "Day" Only needed for Collection "Cur-
"Year" rentSumStringControlData"
"Total" For which time period the current
sums should be requested.
LastErrorStringControlData Information about the last error which triggered a service message.
CurrentSumStringControlData Current sums of all channels for a selected time period (day, year or total).
19
3.3.5 Object structure of request body (DataCollection "NowStringControlData" and "CurrentSumString-
ControlData")
Listing 14: Object structure of request body for GetStringRealtimeData request (DataCollection "NowStringCon-
trolData" and "CurrentSumStringControlData")
object {
# Collection of named object (s) containing values per channel and metadata .
# Members of Data object are named according to the channel index they represent (e.g.
"0").
object {
} __CHANNEL_INDEX__ ;
}* Data;
};
Listing 15: Example of request body for GetStringRealtimeData request (DataCollection "CurrentSumStringCon-
trolData")
// GetStringRealtimeData .cgi? Scope = Device & DeviceId =1& DataCollection =
CurrentSumStringControlData & TimePeriod =Day
{
"1" : {
" Value " : 59.57 ,
"Unit" : "Ah"
},
"2" : {
" Value " : 47.98 ,
"Unit" : "Ah"
},
"3" : {
" Value " : 47.6 ,
"Unit" : "Ah"
},
"4" : {
" Value " : 36.17 ,
"Unit" : "Ah"
},
"5" : {
" Value " : 47.91 ,
"Unit" : "Ah"
}
}
Listing 16: Object structure of request body for GetStringRealtimeData request (DataCollection "LastErrorString-
ControlData")
20
object {
object {
number Value ;
} StringAverage ;
number Value ;
} Deviation ;
# Current sum
object {
number Value ;
} Sum;
} __CHANNEL_INDEX__ ;
}* Channels ;
} Data;
}
Listing 17: Example of request body for GetStringRealtimeData request (DataCollection "LastErrorStringControl-
Data")
// GetStringRealtimeData .cgi? Scope = Device & DeviceId =1& DataCollection =
LastErrorStringControlData
{
" TimeOfError " : "2012 -03 -02 T23 :50:00+01:00 ",
" StringAverage " : {
" Value " : 46.22 ,
"Unit" : "Ah"
},
" Channels " : {
21
"1" : {
" Deviation " : {
" Value " : 24.7 ,
"Unit" : "%"
},
"Sum" : {
" Value " : 57.66 ,
"Unit" : "Ah"
}
},
"2" : {
" Deviation " : {
" Value " : 0.3 ,
"Unit" : "%"
},
"Sum" : {
" Value " : 46.4 ,
"Unit" : "Ah"
}
},
"3" : {
" Deviation " : {
" Value " : -0.7,
"Unit" : "%"
},
"Sum" : {
" Value " : 45.9 ,
"Unit" : "Ah"
}
},
"4" : {
" Deviation " : {
" Value " : -24.5 ,
"Unit" : "%"
},
"Sum" : {
" Value " : 34.87 ,
"Unit" : "Ah"
}
},
"5" : {
" Deviation " : {
" Value " : 0.1 ,
"Unit" : "%"
},
"Sum" : {
" Value " : 46.29 ,
"Unit" : "Ah"
}
}
}
}
3.4.1 Availability
Platform Since version
Fronius Hybrid ALWAYS
Fronius Non Hybrid ALWAYS
22
3.4.2 URL for HTTP requests
/solar_api/v1/GetLoggerInfo.cgi
object {
} LoggerInfo ;
};
23
3.4.4 Example of request body
3.5.1 Availability
Platform Since version
Fronius Hybrid ALWAYS
Fronius Non Hybrid ALWAYS
object {
# State (" on", "off", " blinking " or " alternating ").
24
string State ;
} __LED_NAME__ ;
}* Data;
};
If information about devices currently online is needed, the GetActiveDeviceInfo request should be used. This
request also provides information about device classes other than inverters.
3.6.1 Availability
Platform Since version
Fronius Hybrid ALWAYS
Fronius Non Hybrid ALWAYS
25
3.6.3 Object structure of request body
} __INVERTER_INDEX__ ;
}* Data;
};
{
"Data" : {
"1" : {
"DT" : 192 ,
" PVPower ": 5000 ,
" CustomName ": " Southwest ",
"Show": 1,
" UniqueID ": " 123456 ",
" ErrorCode " : 0,
" StatusCode " : 7
},
"2" : {
"DT" : 192 ,
" PVPower ": 5000 ,
"Show": 0,
26
" CustomName ": " Southeast ",
" UniqueID ": " 234567 ",
" ErrorCode " : 0,
" StatusCode " : 7
}
}
3.7.1 Availability
Platform Since version
Fronius Hybrid ALWAYS
Fronius Non Hybrid ALWAYS
3.7.3 Parameters
Parameter Type Range/Values/Pattern Description
DeviceClass String "Inverter" Which kind of device class to search for
"Storage" active devices.
"Ohmpilot"2
1 2
"SensorCard"
"StringControl"
"Meter"1
27
# Device type of the device . (only for Inverter , SensorCard or StringControl ; others
have -1)
integer DT;
} __DEVICE_INDEX__ ;
}* Data;
};
Listing 26: Example of request body for GetActiveDeviceInfo request on non hybrid inverter systems
// GetActiveDeviceInfo .cgi? DeviceClass = System
{
"Body" : {
"Data" : {
" Inverter " : {
"1" : {
"DT" : 158
},
"2" : {
"DT" : 120
}
},
" SensorCard " : {
"1" : {
"DT" : 254,
" ChannelNames " : [
" Temperature ␣1",
" Temperature ␣2",
" Irradiation ",
" Digital ␣1",
" Digital ␣2",
" Current "
]
}
},
" StringControl " : {
"17" : {
"DT" : 252
}
},
" Meter " : {
"0" : {
"DT" : -1,
" Serial " : " 12345678 "
}
},
" Ohmpilot " : {
28
"0" : {
"DT" : -1,
" Serial " : " 12345678 "
}
}
}
}
}
Listing 27: Example of request body for GetActiveDeviceInfo request on hybrid inverter systems
// GetActiveDeviceInfo .cgi? DeviceClass = System
{
"Body" : {
"Data" : {
" Inverter " : {
"1" : {
"DT" : 99
}
},
" SensorCard " : {},
" StringControl " : {},
" Meter " : {
"0" : {
"DT" : -1,
" Serial " : " 12345678 "
}
},
" Storage " : {
"0" : {
"DT" : -1,
" Serial " : " 12345678 "
}
}
}
}
}
#name of DeviceClass
object {
} __DEVICE_INDEX__ ;
29
} __DEVICE_CLASS__ ;
}* Data;
};
Listing 29: Example of request body for GetActiveDeviceInfo request on Fronius Non Hybrid
{
"Body" : {
"Data" : {
" Inverter " : {
"2" : {
"DT" : 126
}
},
" SensorCard " : {
"1" : {
" ChannelNames " : [
" Temperature ␣1",
" Temperature ␣2",
" Irradiation ",
" Digital ␣1",
" Digital ␣2",
" Current "
],
"DT" : 254
}
},
" StringControl " : {
"1" : {
"DT" : 253
}
},
" Meter " : {
"1" : {
"DT" : -1,
" Serial ", " 12345678 "
},
"2" : {
"DT" : -1,
" Serial ", " 12345678 "
}
}
" Ohmpilot " : {},
" Storage " : {}
}
}
}
Listing 30: Example of request body for GetActiveDeviceInfo request on Fronius Hybrid
{
"Body" : {
"Data" : {
" Inverter " : {
"1" : {
"DT" : 99
}
},
" Meter " : {
"0" : {
"DT" : -1,
" Serial " : " 12345678 "
}
},
" Ohmpilot " : {},
30
" SensorCard " : {},
" Storage " : {
"3" : {
"DT" : -1,
" Serial " : " 12345678 "
}
},
" StringControl " : {}
}
}
}
3.8.1 Availability
Platform Since version
Fronius Hybrid ALWAYS
Fronius Non Hybrid 3.3.4-8
3.8.3 Parameters
Parameter Type Range/Values/Pattern Description
Scope String "System" Mandatory
"Device"
DeviceId String 0..65535 Mandatory on non system scope
3.8.4 System-Request
string Model ;
string Manufacturer ;
} Details ;
} * DeviceId ;
31
} Data ;
32
" Current_AC_Phase_2 " : 0.012 ,
" Current_AC_Phase_3 " : 0.022 ,
" Voltage_AC_Phase_1 " : 232.7 ,
" Voltage_AC_Phase_2 " : 107.9 ,
" Voltage_AC_Phase_3 " : 107.9 ,
" Voltage_AC_PhaseToPhase_12 " : 301.5 ,
" Voltage_AC_PhaseToPhase_23 " : 186.9 ,
" Voltage_AC_PhaseToPhase_31 " : 301.5 ,
" Frequency_Phase_Average " : 50,
" PowerApparent_S_Sum " : 236 ,
" PowerFactor_Sum " : 0.99 ,
" PowerFactor_Phase_1 " : 0.99 ,
" PowerFactor_Phase_2 " : 1,
" PowerFactor_Phase_3 " : 1,
" EnergyReal_WAC_Sum_Produced " : 0,
" EnergyReal_WAC_Sum_Consumed " : 10439 ,
" EnergyReactive_VArAC_Sum_Produced " : 7490 ,
" EnergyReactive_VArAC_Sum_Consumed " : 6110 ,
" EnergyReal_WAC_Plus_Absolute " : 0,
" EnergyReal_WAC_Minus_Absolute " : 10439
}
}
}
}
3.8.5 Device-Request
object {
string Serial ;
string Model ;
string Manufacturer ;
} Details ;
} Data ;
33
" PowerReactive_Q_Phase_2 " : 163.32 ,
" PowerReactive_Q_Phase_3 " : 162.99 ,
" Current_AC_Phase_1 " : 1.418 ,
" Current_AC_Phase_2 " : 1.502 ,
" Current_AC_Phase_3 " : 1.438 ,
" Voltage_AC_Phase_1 " : 233.8 ,
" Voltage_AC_Phase_2 " : 235.5 ,
" Voltage_AC_Phase_3 " : 235 ,
" Voltage_AC_PhaseToPhase_12 " : 406.4 ,
" Voltage_AC_PhaseToPhase_23 " : 407.5 ,
" Voltage_AC_PhaseToPhase_31 " : 406,
" Frequency_Phase_Average " : 50,
" PowerApparent_S_Sum " : 971 ,
" PowerFactor_Sum " : 0.86 ,
" PowerFactor_Phase_1 " : 0.83 ,
" PowerFactor_Phase_2 " : 0.87 ,
" PowerFactor_Phase_3 " : 0.86 ,
" EnergyReal_WAC_Sum_Produced " : 34474 ,
" EnergyReal_WAC_Sum_Consumed " : 1365 ,
" EnergyReactive_VArAC_Sum_Produced " : 4020 ,
" EnergyReactive_VArAC_Sum_Consumed " : 207380 ,
" EnergyReal_WAC_Plus_Absolute " : 1365 ,
" EnergyReal_WAC_Minus_Absolute " : 34474
}
}
}
3.9.1 Availability
Platform Since version
Fronius Hybrid 1.1.2-13
Fronius Non Hybrid NOT AVAILABLE
3.9.3 Parameters
Parameter Type Range/Values/Pattern Description
Scope String "System" Mandatory
"Device"
DeviceId String 0..65535 Mandatory on non system scope
34
35
3.9.4 Details about Channels
Previuos and current state of a battery cell. One Byte printed in hexadecimal.
0xYX (Y: Current status, X: Previous status) Meaning of numerical status codes:
Status value Description
016 RESERVED
116 Pre Charge
216 Initial
316 Normal Charge
416 Charge Terminate
516 Normal Discharge
616 Over Voltage
716 Over Discharge
816 RESERVED
916 Over Temp Charge
A16 Over Current Charge
B16 Over Temp Discharge
C16 Over Current Discharge
D16 Cell Unbalance
E16 Charge Suspend
F16 RESERVED
36
3.9.5 System-Request
object {
object {
object {
# serial number of Fronius Solar Battery
string Serial ;
string Model ;
string Manufacturer ;
} Details ;
} Controller ;
array {
object {
string Serial ;
string Model ;
string Manufacturer ;
} Details ;
} * Modules ;
} * DeviceId ;
} Data ;
37
},
" StateOfCharge_Relative " : 4,
" Voltage_DC " : 370.4 ,
" Current_DC " : 0,
" Voltage_DC_Maximum_Cell " : 2.959 ,
" Voltage_DC_Minimum_Cell " : 2.822 ,
" Temperature_Cell " : 25.6 ,
" DesignedCapacity " : 9600
},
" Modules " : [
{
" Details " : {
" Serial " : " S0120028626 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Current_DC " : -0.02 ,
" Voltage_DC " : 46.621 ,
" Temperature_Cell " : 26.3 ,
" Temperature_Cell_Maximum " : 26.9 ,
" Temperature_Cell_Minimum " : 26,
" Voltage_DC_Maximum_Cell " : 2.951 ,
" Voltage_DC_Minimum_Cell " : 2.866 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028389 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 4,
" Current_DC " : -0.02 ,
" Voltage_DC " : 45.866 ,
" Temperature_Cell " : 26.1 ,
" Temperature_Cell_Maximum " : 26.7 ,
" Temperature_Cell_Minimum " : 25.9 ,
" Voltage_DC_Maximum_Cell " : 2.894 ,
" Voltage_DC_Minimum_Cell " : 2.822 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028446 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Current_DC " : -0.02 ,
" Voltage_DC " : 46.478 ,
" Temperature_Cell " : 26.1 ,
" Temperature_Cell_Maximum " : 26.6 ,
" Temperature_Cell_Minimum " : 25.8 ,
" Voltage_DC_Maximum_Cell " : 2.937 ,
" Voltage_DC_Minimum_Cell " : 2.883 ,
" CycleCount_BatteryCell " : 8,
38
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028435 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Current_DC " : -0.02 ,
" Voltage_DC " : 46.47 ,
" Temperature_Cell " : 25.8 ,
" Temperature_Cell_Maximum " : 26.5 ,
" Temperature_Cell_Minimum " : 25.5 ,
" Voltage_DC_Maximum_Cell " : 2.938 ,
" Voltage_DC_Minimum_Cell " : 2.88 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028479 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Current_DC " : -0.02 ,
" Voltage_DC " : 46.49 ,
" Temperature_Cell " : 25.6 ,
" Temperature_Cell_Maximum " : 26.3 ,
" Temperature_Cell_Minimum " : 25.2 ,
" Voltage_DC_Maximum_Cell " : 2.94 ,
" Voltage_DC_Minimum_Cell " : 2.877 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S012002885B ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Current_DC " : -0.02 ,
" Voltage_DC " : 46.252 ,
" Temperature_Cell " : 25.3 ,
" Temperature_Cell_Maximum " : 26,
" Temperature_Cell_Minimum " : 25,
" Voltage_DC_Maximum_Cell " : 2.959 ,
" Voltage_DC_Minimum_Cell " : 2.847 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S012002884A ",
" Model " : " P49929080N ",
39
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Current_DC " : -0.02 ,
" Voltage_DC " : 46.116 ,
" Temperature_Cell " : 25.1 ,
" Temperature_Cell_Maximum " : 25.8 ,
" Temperature_Cell_Minimum " : 24.9 ,
" Voltage_DC_Maximum_Cell " : 2.899 ,
" Voltage_DC_Minimum_Cell " : 2.867 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S012002857A ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436505153 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Current_DC " : -0.02 ,
" Voltage_DC " : 46.211 ,
" Temperature_Cell " : 24.6 ,
" Temperature_Cell_Maximum " : 25.1 ,
" Temperature_Cell_Minimum " : 24.2 ,
" Voltage_DC_Maximum_Cell " : 2.912 ,
" Voltage_DC_Minimum_Cell " : 2.865 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
}
]
}
}
}
}
3.9.6 Device-Request
object {
object {
# serial number of Fronius Solar Battery
string Serial ;
string Model ;
string Manufacturer ;
} Details ;
} Controller ;
array {
40
object {
string Serial ;
string Model ;
string Manufacturer ;
} Details ;
} * Modules ;
} Data ;
41
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028389 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436507345 ,
" Enable " : 1,
" StateOfCharge_Relative " : 4,
" Voltage_DC " : 45.649 ,
" Current_DC " : -0.02 ,
" Temperature_Cell " : 26.1 ,
" Voltage_DC_Maximum_Cell " : 2.882 ,
" Voltage_DC_Minimum_Cell " : 2.806 ,
" Temperature_Cell_Maximum " : 26.7 ,
" Temperature_Cell_Minimum " : 25.9 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028446 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436507345 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Voltage_DC " : 46.292 ,
" Current_DC " : -0.02 ,
" Temperature_Cell " : 26,
" Voltage_DC_Maximum_Cell " : 2.928 ,
" Voltage_DC_Minimum_Cell " : 2.87 ,
" Temperature_Cell_Maximum " : 26.6 ,
" Temperature_Cell_Minimum " : 25.8 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028435 ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436507345 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Voltage_DC " : 46.281 ,
" Current_DC " : -0.02 ,
" Temperature_Cell " : 25.8 ,
" Voltage_DC_Maximum_Cell " : 2.927 ,
" Voltage_DC_Minimum_Cell " : 2.866 ,
" Temperature_Cell_Maximum " : 26.4 ,
" Temperature_Cell_Minimum " : 25.5 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S0120028479 ",
42
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436507345 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Voltage_DC " : 46.31 ,
" Current_DC " : -0.02 ,
" Temperature_Cell " : 25.5 ,
" Voltage_DC_Maximum_Cell " : 2.931 ,
" Voltage_DC_Minimum_Cell " : 2.864 ,
" Temperature_Cell_Maximum " : 26.3 ,
" Temperature_Cell_Minimum " : 25.2 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S012002885B ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436507345 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Voltage_DC " : 46.055 ,
" Current_DC " : -0.03 ,
" Temperature_Cell " : 25.2 ,
" Voltage_DC_Maximum_Cell " : 2.95 ,
" Voltage_DC_Minimum_Cell " : 2.832 ,
" Temperature_Cell_Maximum " : 26,
" Temperature_Cell_Minimum " : 25,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S012002884A ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436507345 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Voltage_DC " : 45.907 ,
" Current_DC " : -0.02 ,
" Temperature_Cell " : 25,
" Voltage_DC_Maximum_Cell " : 2.887 ,
" Voltage_DC_Minimum_Cell " : 2.853 ,
" Temperature_Cell_Maximum " : 25.7 ,
" Temperature_Cell_Minimum " : 24.9 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
},
{
" Details " : {
" Serial " : " S012002857A ",
" Model " : " P49929080N ",
" Manufacturer " : "Sony"
},
" TimeStamp " : 1436507345 ,
" Enable " : 1,
" StateOfCharge_Relative " : 5,
" Voltage_DC " : 46.003 ,
43
" Current_DC " : -0.02 ,
" Temperature_Cell " : 24.5 ,
" Voltage_DC_Maximum_Cell " : 2.9,
" Voltage_DC_Minimum_Cell " : 2.851 ,
" Temperature_Cell_Maximum " : 25.1 ,
" Temperature_Cell_Minimum " : 24.2 ,
" CycleCount_BatteryCell " : 8,
" Status_BatteryCell " : 50,
" DesignedCapacity " : 1200
}
]
}
}
}
3.10.1 Availability
Platform Since version
Fronius Hybrid 1.6.1-4
Fronius Non Hybrid 3.8.1-4
3.10.3 Parameters
Parameter Type Range/Values/Pattern Description
Scope String "System" Mandatory
"Device"
DeviceId String 0..65535 Mandatory on non system scope
3.10.4 System-Request
Listing 39: Object structure of response body for GetOhmPilotRealtimeData System request
# object with detailed informations about all OhmPilots ,
object {
object {
object {
# serial number of device
string Serial ;
# software version
string Software ;
# hardware version
string Hardware ;
} Details ;
44
# total consumed energy [Wh]
number EnergyReal_WAC_Sum_Consumed ;
# CodeOfState Values :
# 0 ... up and running
# 1 ... keep minimum temperature
# 2 ... legionella protection
# 3 ... critical fault
# 4 ... fault
# 5 ... boost mode
number CodeOfState ;
} * OhmPilot ;
} Data ;
3.10.5 Device-Request
Listing 41: Object structure of response body for GetOhmPilotRealtimeData Device request
# object with detailed informations about one OhmPilot ,
45
object {
object {
# serial number of device
string Serial ;
# software version
string Software ;
# hardware version
string Hardware ;
} Details ;
# CodeOfState Values :
# 0 ... up and running
# 1 ... keep minimum temperature
# 2 ... legionella protection
# 3 ... critical fault
# 4 ... fault
# 5 ... boost mode
number CodeOfState ;
} Data ;
46
},
" Status " : {
"Code" : 0,
" Reason " : "",
" UserMessage " : ""
},
" Timestamp " : "2017 -06 -01 T08 :37:21+02:00 "
}
}
3.11.1 Availability
Platform Since version
Fronius Hybrid 1.2.1-X
Fronius Non Hybrid 3.3.9-X
3.11.2 Version
This request is only a gateway to internal generated data containers. Please take care about the "Version" field
in the response.
Version Changes
10 added smartloads/ohmpilot
added Version field
Please note, for performance reasons the URL extension is different to other solar api requests.
3.11.4 Parameters
There are no parameters. Only one type of query exists.
3.11.5 Request
# mandatory field
# implemented since Fronius Non Hybrid version 3.8.1 -1
# Fronius Hybrid version 1.6.1 -1
# describes the available fields for this request ( PowerFlowVersion )
unsigned integer Version ;
object {
# mandatory field
# "produce -only", " meter ", "vague - meter ", " bidirectional " or "ac - coupled "
string Mode;
47
# optional field , supported since Fronius Hybrid version 1.3.1 -0
# not available on Fronius Non Hybrid
# field is available if configured ( false ) or active (true)
# if not available , mandatory config is not set
boolean BackupMode ;
# mandatory field
#this value is null if no meter is enabled ( + from grid , - to grid )
number P_Grid ;
# mandatory field
#this value is null if no meter is enabled ( + generator , - consumer )
number P_Load ;
# mandatory field
#this value is null if no battery is active ( + charge , - discharge )
number P_Akku ;
# mandatory field
#this value is null if inverter is not running ( + production ( default ) )
number P_PV;
# mandatory field
# available since Fronius Hybrid version 1.3.1 -1
# available since Fronius Non Hybrid version 3.7.1 -2
# current relative self consumption in %, null if no smart meter is connected
number rel_SelfConsumption ;
# mandatory field
# available since Fronius Hybrid version 1.3.1 -1
# available since Fronius Non Hybrid version 3.7.1 -2
# current relative autonomy in %, null if no smart meter is connected
number rel_Autonomy ;
# optional field
# "load", "grid" or " unknown " ( during backup power )
string Meter_Location ;
# optional field
# implemented since Fronius Non Hybrid version 3.4.1 -7
# Energy [Wh] this day , null if no inverter is connected
number E_Day ;
# optional field
# implemented since Fronius Non Hybrid version 3.4.1 -7
# Energy [Wh] this year , null if no inverter is connected
number E_Year ;
# optional field
# implemented since Fronius Non Hybrid version 3.4.1 -7
# Energy [Wh] ever since , null if no inverter is connected
number E_Total ;
} Site;
object {
object {
# mandatory field
# device type of inverter
integer DT;
# mandatory field
# current power in Watt , null if not running
integer P;
48
# optional field
# current state of charge in % ( 0 - 100% )
integer SOC;
# optional field
# " disabled ", " normal ", " service ", " charge boost ",
# " nearly depleted ", " suspended ", " calibrate ",
# "grid support ", " deplete recovery ", "non operable ( voltage )",
# "non operable ( temperature )", " preheating " or " startup "
string Battery_Mode ;
# optional field
# implemented since Fronius Non Hybrid version 3.7.1 -1
# Fronius Hybrid version 1.3.1 -1
# Energy [Wh] this day , null if no inverter is connected
number E_Day ;
# optional field
# implemented since Fronius Non Hybrid version 3.7.1 -1
# Fronius Hybrid version 1.3.1 -1
# Energy [Wh] this year , null if no inverter is connected
number E_Year ;
# optional field
# implemented since Fronius Non Hybrid version 3.7.1 -1
# Fronius Hybrid version 1.3.1 -1
# Energy [Wh] ever since , null if no inverter is connected
number E_Total ;
} Inverters ;
# optional field
# implemented since Fronius Non Hybrid version 3.8.1 -1
# Fronius Hybrid version 1.6.1 -1
# PowerFlowVersion 10
object {
# optional field
# implemented since PowerFlowVersion 10
object {
# optional field
# implemented since PowerFlowVersion 10
object {
# mandatory field
# implemented since PowerFlowVersion 10
# current power consumption in Watt
number P_AC_Total ;
# mandatory field
# implemented since PowerFlowVersion 10
# operating state " normal ", "min - temperature ", " legionella - protection ",
# " fault ", " warning " or "boost "
string State ;
# mandatory field
# implemented since PowerFlowVersion 10
# temperature of storage / tank in degree Celsius
number Temperature ;
} ComponentId ;
} Ohmpilots ;
49
} Smartloads ;
} Data ;
Listing 44: Example of response body for GetPowerFlowRealtimeData on Fronius Hybrid System
{
"Head" : {
" RequestArguments " : {},
" Status " : {
"Code" : 0,
" Reason " : "",
" UserMessage " : ""
},
" Timestamp " : "2015 -08 -12 T07 :15:28+02:00 "
},
"Body" : {
"Data" : {
"Site" : {
"Mode" : " bidirectional ",
" BackupMode " : true ,
" P_Grid " : -316.92 ,
" P_Load " : -18.08 ,
" P_Akku " : -61.78 ,
"P_PV" : 449.8 ,
" E_Day " : 17844 ,
" E_Year " : 1325177.9 ,
" E_Total " : 2874459.8 ,
" Meter_Location " : "grid"
},
" Inverters " : {
"1" : {
"DT" : 99,
"P" : 335,
"SOC" : 99,
" Battery_Mode " : " normal ",
"E_Day " : 17844 ,
" E_Year " : 1325177.9 ,
" E_Total " : 2874459.8
}
}
}
}
}
Listing 45: Example of response body for GetPowerFlowRealtimeData on Fronius Non Hybrid System
{
"Head" : {
" RequestArguments " : {},
" Status " : {
"Code" : 0,
" Reason " : "",
" UserMessage " : ""
},
" Timestamp " : "2015 -08 -12 T07 :15:28+02:00 "
},
"Body" : {
"Data" : {
"Site" : {
"Mode" : "produce -only",
" P_Grid " : null ,
" P_Load " : null ,
" P_Akku " : null ,
"P_PV" : 449.8
},
50
" Inverters " : {
"1" : {
"DT" : 99,
"P" : 250,
},
"80" : {
"DT" : 99,
"P" : 200,
}
}
}
}
}
Listing 46: Example of response body for GetPowerFlowRealtimeData on a new Fronius Non Hybrid System
including an OhmPilot
{
"Body" : {
"Data" : {
" Inverters " : {
"1" : {
"DT" : 126 ,
" E_Day " : 1057.0999755859375 ,
" E_Total " : 9416980 ,
" E_Year " : 66495.1015625 ,
"P" : 146
}
},
"Site" : {
" E_Day " : 1057.0999755859375 ,
" E_Total " : 9416980 ,
" E_Year " : 66495.1015625 ,
" Meter_Location " : "grid",
"Mode" : " meter ",
" P_Akku " : null ,
" P_Grid " : 64.86999855004251 ,
" P_Load " : -210.86999855004251 ,
"P_PV" : 146 ,
" rel_Autonomy " : 69.236971121499806 ,
" rel_SelfConsumption " : 100
},
" Smartloads " : {
" Ohmpilots " : {
" 720896 " : {
" P_AC_Total " : 91,
" State " : " normal ",
" Temperature " : 35.800000533461571
}
}
},
" Version " : "10"
}
},
"Head" : {
" RequestArguments " : {},
" Status " : {
"Code" : 0,
" Reason " : "",
" UserMessage " : ""
},
" Timestamp " : "2017 -02 -14 T07 :08:45+01:00 "
}
}
51
4 Archive Requests
4.1 Common
Archive requests shall be provided whenever access to historic device-data is possible and it makes sense to
provide such a request.
Of course, the Datalogger Web can only provide what is stored in its internal memory and has not been overwritten
by newer data yet. It can loose data, due to capacity reason. The number of days stored dependence on the
number of connected units to log. This limitation of is not present for Solar.web, provided that the Datalogger has
reliably uploaded the data.
Different from what is specified within the previously released drafts, there is only one CGI to access all historic
data. This CGI contains detailed, summed, error and events queries.
4.1.1 Availability
Platform Since version
Fronius Hybrid 1.1.2-16
Fronius Non Hybrid 3.3.4-5
4.2 ChannelId
Each channel is handled and requested by name. Most of the channels are recorded in constant cyclic intervals
which can be set between 5 and 30 minutes. Only Digital_P owerM anagementRelay_Out_1, InverterErrors,
InverterEvents and Hybrid_Operating_State are event triggered and may occure every time.
4.3 Parameters
Scope String "Device" Query specific device(s) or whole system.
"System" Mandatory
SeriesType String "DailySum" Resolution of the data-series. Optional
"Detail" (default)
HumanReadable BoolString "True" (default) Unset/Set readable output. Optional
"False"
StartDate DateString "21.5.[20]14" Mandatory
"5/21/[20]14" supplying only the date will be interpreted as
"[20]14-5-21" local time
"2011-10-
20T10:09:14+02:00"
EndDate DateString "21.5.[20]14" Mandatory
"5/21/[20]14"
"[20]14-5-21"
"2011-10-
20T10:09:14Z"
Channel String available channels from table 3. Mandatory, multiple times
DeviceClass String "Inverter" Which kind of device will be queried. Manda-
"SensorCard" tory and accepted only if Scope is not "Sys-
"StringControl" tem"
DeviceClass "Meter" since DM 3.7.4-6 HM 1.3.1-1
"Storage" since DM 3.7.4-6 HM 1.3.1-1
"OhmPilot" since DM 3.8.1-4 HM 1.6.1-4
DeviceId String Solar Net: 0 …199 Only needed for Scope "Device"
Which device to query.
This parameter can be given more than once,
thus specifying a list of devices to query.
52
Table 3: Available channels
Name Unit
TimeSpanInSec sec
Digital_PowerManagementRelay_Out_1 1
EnergyReal_WAC_Sum_Produced Wh
InverterEvents struct
InverterErrors struct
Current_DC_String_1 1A
Current_DC_String_2 1A
Voltage_DC_String_1 1V
Voltage_DC_String_2 1V
Temperature_Powerstage deg C
Voltage_AC_Phase_1 1V
Voltage_AC_Phase_2 1V
Voltage_AC_Phase_3 1V
Current_AC_Phase_1 1A
Current_AC_Phase_2 1A
Current_AC_Phase_3 1A
PowerReal_PAC_Sum 1W
EnergyReal_WAC_Minus_Absolute 1Wh
EnergyReal_WAC_Plus_Absolute 1Wh
Meter_Location_Current 1
Temperature_Channel_1 1
Temperature_Channel_2 1
Digital_Channel_1 1
Digital_Channel_2 1
Radiation 1
Digital_PowerManagementRelay_Out_1 1
Hybrid_Operating_State 1
# Object representing data - series of one device (may contain more than one channel ).
object {
# Starting date of the series (i.e. date of the first value in Values )
# yyyy -MM -ddThh -mm -ss%z "2017 -05 -20 T00 :00:00+02:00"
string Start ;
# Starting date of the series (i.e. date of the first value in Values )
# yyyy -MM -ddThh -mm -ss%z "2017 -05 -20 T23 :59:59+02:00"
string End;
# Collection of objects representing one channel , each object containing values and
metadata .
# Objects are named after the Channel they represent (e.g. " Power ").
53
object {
# Unscaled values , offset between datapoints can be deduced through " SeriesType "
# ATTENTION : Unavailable datapoints are included but have value null
# NOTE: the data records are listed in alphabetical order
# example : "3600" : 10.11 .... offset is 3600 sec and value is 10.11
number * __OFFSET_IN_SECONDS__ ;
} __CHANNEL_NAME__ ;
}* Data;
}* __DEVICE_ID__ ;
} Data;
};
54
"300" : 111815 ,
/* Logpoint missing here */
" 48900 " : 112008 ,
" 49200 " : 112068 ,
" 49500 " : 112072
}
},
" EnergyReal_WAC_Minus_Absolute " : {
" _comment " : " channelId =167837960 ",
"Unit" : "Wh",
" Values " : {
"1" : 46446 ,
"300" : 46446 ,
/* Logpoint missing here */
" 48900 " : 48084 ,
" 49200 " : 48084 ,
" 49500 " : 48087
}
},
" Meter_Location_Current " : {
" _comment " : " channelId =117050390 ",
"Unit" : "1",
" Values " : {
"1" : 0,
"300" : 0,
/* Logpoint missing here */
" 49500 " : 0,
" 49800 " : 0,
" 50100 " : 0
}
}
}
},
" inverter \/1" : {
" NodeType " : 97,
" DeviceType " : 99,
" Start " : "2015 -06 -01 T00 :00:00+02:00 ",
"End" : "2015 -06 -01 T23 :59:59+02:00 ",
"Data" : {
" TimeSpanInSec " : {
" _comment " : " channelId =65549 ",
"Unit" : "sec",
" Values " : {
"0" : 299,
"300" : 300,
/* Logpoint missing here */
" 48900 " : 238,
" 49200 " : 298,
" 49500 " : 300
}
}
}
}
}
}
}
55
{
"Head" : {
" RequestArguments " : {
" Scope " : " System ",
" StartDate " : "2015 -06 -01 T00 :00:00+02:00 ",
" EndDate " : "2015 -06 -01 T23 :59:59+02:00 ",
" Channel " : [ " EnergyReal_WAC_Sum_Produced " ] ,
" SeriesType " : " Detail ",
" HumanReadable " : "True"
},
" Status " : {
"Code" : 0,
" Reason " : "",
" UserMessage " : "",
" ErrorDetail " : {
" Nodes " : []
}
},
" Timestamp " : "2015 -06 -01 T14 :11:53+02:00 "
},
"Body" : {
"Data" : {
" inverter \/0" : {
" NodeType " : 97,
" DeviceType " : 113,
" Start " : "2015 -06 -01 T00 :00:00+02:00 ",
"End" : "2015 -06 -01 T23 :59:59+02:00 ",
"Data" : {
" EnergyReal_WAC_Sum_Produced " : {
" _comment " : " channelId =67830024 ",
"Unit" : "Wh",
" Values " : {
"0": 3244 ,
"300": 3423 ,
/* Logpoint missing here */
"900": 4324 ,
"1200": 5443 ,
"1500": 6567
}
}
}
},
" inverter \/3": {
" NodeType " : 157,
" DeviceType " : 113,
" Start " : "2015 -06 -01 T00 :00:00+02:00 ",
"End" : "2015 -06 -01 T23 :59:59+02:00 ",
"Data": {
" EnergyReal_WAC_Sum_Produced ": {
"Unit" : "Wh",
" Values ": {
"0": 2324 ,
"300": 4365 ,
"600": 4376 ,
"900": 5466 ,
"1200": 5465 ,
"1500": 5446
}
}
}
}
}
}
}
56
4.4.3 Errors - Structure
57
4.4.4 Events - Structure
58
}
}
}
}
Table 4: Shows mapping between Fronius device status and SunSpec Inverter-Model states
6 Changelog
Document Version 10
• note that all inverters (even invisible configured) are reportet at PowerFlow and Inverter request
• fixed description about availability of rel_Autonomy and rel_SelfConsumption at PowerFlow request
• fixed missing description of BatteryStandby at PowerFlow request
• improved and fixed GetArchiveData descriptions and examples
Document Version 9
59
cgi Field old description fixed description
GetAPIVersion.cgi APIVersion number unsigned integer
GetInverterInfo.cgi Body.Data.<>... number integer
...ErrorCode
...StatusCode
Body.Data.<>.Show number unsigned integer
GetInverterRealtimeData.cgi Body.Data... unsigned int unsigned number
...DAY_ENERGY
...YEAR_ENERGY
...TOTAL_ENERGY
3. Can multiple clients send requests to the API at the same time?
Yes, but the requests may take longer to complete.
4. Can I use this API at the same time as other services of the Datalogger Web / DataManager?
Yes. The datalogging, Solar.access/Solar.web connection, Webinterface, this API or any other service can
be used independently from the others.
5. Can the API calls be password protected?
No. The API is always accessible without authentication, regardless of the user or admin password set on
the Webinterface.
60
6. The API reports more inverters than I have, why is that?
This may be the case when the inverter number of an inverter is changed while the Fronius Datalogger Web
/ Fronius Datamanager is running. The logger then detects a new device but keeps the same device with
the previous inverter number in the system for 24 hours. This is due to the fact that the datalogger is caching
the devices for a certain time even if they are not present on the bus (e.g. to be able to display energy values
during the night when the inverters are offline).
Those ghost devices will disappear 24 hours after the have been last seen by the datalogger. Alternatively,
a reboot of the datalogger also clears the device cache and repopulates it with the currently present devices.
61
Fronius Worldwide - www.fronius.com/addresses
Under http://www.fronius.com/addresses you will find all addresses of our sales branches and partner firms!
62