Solar-Log™ WEB API
Usage Terms
You are hereby granted access to the Solar-Log™ WEB API (hereinafter referred to as
"API"). The API offers you the option to access data from active plants.
Solare Datensysteme GmbH (hereinafter referred to as "SDS") reserves the right to block
access at any time when required – in particular, but not limited to, cases of server failures,
inappropriate use of the data exported, violations of applicable laws and non-compliance of
privacy laws.
By using the API, you also agree to the General Terms and Conditions of Business that you
received with this document.
Access is restricted to authorized persons.
All access is logged. SDS reserves the right to evaluate the logged data automatically.
Too quick or too frequent use of the API may result in your access being limited or deacti-
vated temporarily or even permanently.
1
Usage
The API can be accessed from any website that contains the data sheet or the Solar-Log™
WEB graphic.
The following site contains an example of the Solar-Log™ WEB Graphic Module:
http://home.solarlog-web.de/15.html
The desired data can be accessed by including the following parameter.
Example:
http://home.solarlog-web.de/15.html/api?username=TEST&password=TEST&function=-
getBaseVars
The plant configuration is returned in the CSV format.
Example (excerpt):
--------------------------------------- >8 --------------------------------
key;value
Boot;99
AnlagenKWP;4480
time_start;0|8|8|6|6|6|6|6|7|7|7|7|8
time_end;0|17|18|20|21|21|22|22|21|20|19|17|17
sollMonth;2|6|9|11|11|13|13|12|10|6|4|3
sollYearKWP;930
AnzahlWR;4
MaxWRP_0;13600|100000|2400000|14000000
MaxWRP_1;4100|30000|700000|5000000
MaxWRP_2;13600|100000|2400000|14000000
MaxWRP_3;13600|100000|2400000|14000000
WRInfo_0;“S0-IN, 1,15000,0,Verbrauch,1,String1|String2|String3,1|0|0,0,||,9,2,0,1000,2“
WRInfo_1;“WR42MS05,1100188378,4480,0,WR 1,2,String 1|String 2|Stri
ng3,1|2|0,0,2240|2240|,1,0,0,1035,-1“
WRInfo_2;“M&T Sensor, 23,1000,0,S 3,1,String1|String2|String3,1|1|1,0,||,21,1,0,1000,-1“
WRInfo_3;“M&T Sensor-B, 12,1000,0,S 4,1,String1|String2|String3,2|1|1,0,||,21,1,0,1000,-1“
--------------------------------------- 8< --------------------------------
2
Accessing Configuration Data
Function:
getBaseVars
provides the current plant configuration in the CSV format.
Example:
/api?username=[user]&password=[pass]&function=getBaseVars
Accessing Minute Data
Function:
getMinVars
provides minute data.
Parameter:
mode
defines which data is exported.
Possible values:
inverter
provides the data for every connected inverter:
datetime, inverter id, yield, pac, pdc, udc*, temp*
(This includes meters which are defined as inverters.)
sensor
provides the data for every connected sensor:
datetime, sensor id, yield*, pac, temp module, temp outdoor*, wind speed*
meter
provides the data for every connected meter:
datetime, meter id, yield, pac
inverter_combined
provides the cumulative data for the inverters. The totals or average values for all of the con-
nected inverters are exported without listing the values from each individual inverter.
datetime, yield, pac, pdc, udc, temp*
3
sensor_combined
provides the cumulative data for all of the connected sensors:
datetime, yield*, pac, temp module, temp outdoor*, wind speed*
meter_combined
provides the cumulative data for all of the connected meters:
datetime, yield, pac
inverter_detailed
provides the detailed data for every connected inverter:
datetime, inverter id, tracker count, yield, pac, pdc, pdc1*, pdc2*, pdc3*, udc*, udc1*, udc2*,
udc3*, temp*
inverter_combined_detailed
inverter_combined and inverter_detailed combined
datetime, tracker count, yield, pac, pdc, pdc1*, pdc2*, pdc3*, udc*, udc1*, udc2*, udc3*, temp*
Similar modes can be combined with + (plus). The following combinations are possible:
inverter+sensor
inverter+sensor+meter
inverter+meter
sensor+meter
inverter_combined+sensor_combined
inverter_combined+sensor_combined+meter_combined
inverter_combined+meter_combined
sensor_combined+meter_combined
Parameter:
from**
selected data from this time on.
Possible values:
yyyy-mm-dd
yyyy-mm-dd hh:mm:ss
Alternatively, a Unix timestamp can also be used. This parameter is optional. If nothing is
entered, it is based on [today]. The output is limited to a maximum of 31 days. If more than 31
days are selected, the following error message appears:
ERR100::invalid timeframe, max allowed timeframe is 31 days
Parameter:
to**
selected data to this time.
4
Possible values:
yyyy-mm-dd
yyyy-mm-dd hh:mm:ss
Alternatively, a Unix timestamp can also be used. This parameter is optional. If nothing is
entered, it is based on [today].
The output is limited to a maximum of 31 days. If more than 31 days are selected, the follow-
ing error message appears:
ERR100::invalid timeframe, max allowed timeframe is 31 days
Parameter:
Interval**
data interval in seconds: the plant recording interval is the default value. This is usually 300
seconds (5 minutes).
This parameter allows the data to be aggregated together in a greater unit of time.
For example, if the data is exported in 5-minute intervals, projections for 10, 15, 20, 30 and 60
minutes can be made. However, if the plant has an export interval of 10 minutes, projections
for 5-minute intervals CANNOT be made.
Possible values:
300, 600, 900, 1200, 1800, 3600
Examples:
/api?username=[user]&password=[pass]&function=getMinVars&mode=inverter_com-
bined+sensor_combined
(provides the cumulative minute data from all of the inverter and sensor data for the current
day.)
/api?username=[user]&password=[pass]&function=getMinVars&mode=inverter_com-
bined+sensor_combined&from=2011-12-01+12:30:00&to=2011-12-02%2012:30:00
(provides the cumulative minute data from 12:30 on 01 December 2011 to 12:30 on 02 Decem-
ber 2011)
Accessing Daily Data
Function:
getDayVars
provides daily data.
5
Parameter:
mode
defines which data is exported.
Possible values:
inverter
provides the data for every connected inverter:
datetime, inverter id, yield, pacmax
(This includes meters which are defined as inverters.)
sensor
provides the data for every connected sensor:
datetime, sensor id, yield, pacmax
meter
provides the data for every connected meter:
datetime, meter id, yield, pac
inverter_combined
provides the cumulative data for the inverters. The totals or average values for all of the con-
nected inverters are exported without listing the values from each individual inverter:
datetime, yield, pacmax
sensor_combined
provides the detailed data for every connected sensor:
datetime, yield, pacmax
meter_combined
provides the detailed data for every connected meter:
datetime, yield, pacmax
Similar modes can be combined with + (plus).
The following combinations are possible:
inverter+sensor
inverter+sensor+meter
inverter+meter
sensor+meter
inverter_combined+sensor_combined
inverter_combined+sensor_combined+meter_combined
inverter_combined+meter_combined
sensor_combined+meter_combined
6
Parameter:
from**
selected data from this time on.
Possible values:
yyyy-mm-dd
yyyy-mm-dd hh:mm:ss
Alternatively, a Unix timestamp can also be used. This parameter is optional. If this parameter
is not included, the first data from the current year is exported.
Parameter:
to**
selected data to this time.
Possible values:
yyyy-mm-dd
yyyy-mm-dd hh:mm:ss
Alternatively, a Unix timestamp can also be used. This parameter is optional. If nothing is
entered, it is based on [today].
Examples:
/api?username=[user]&password=[pass]&function=getDayVars&mode=inverter
(provides today's daily data for all of the inverters.)
/api?username=[user]&password=[pass]&function=getDayVars&mode=inverter_com-
bined+sensor_combined
(provides the cumulative daily data from all of the inverters and sensors for the current year.)
/api?username=[user]&password=[pass]&function=getDayVars&mode=inverter_com-
bined+sensor_combined&from=2011-12-01
(provides the cumulative daily data from all of the inverters and sensors from 01 December to
today.)
The fields marked * are optional, depending on the availability of the connected device.
The parameters marked with ** are optional.
7
Fault messages
ERR1:0:invalid access data
The URL or access data was incorrect.
ERR2:0:access disabled
Your access has been disabled.
ERR3:0:function is not allowed
The requested function has not been enabled for your user.
ERR4:12:access for user „USERNAME“, solarlog „ID“ with function „FUNCTION“ is still blocked
for 12 seconds
Your access data has been limited to a defined number of access attempts for a defined
period of time due to too frequent or too quick requests. In this example, access has been
blocked for 12 seconds.
ERR5:0:unknown function
The requested function does not exist.
EN | 24.02.2014 | 1.0
