Child pages
  • Solargis API User Guide

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter name in FTP data deliveryRequiredValue typeValue unitDefault valueValue RangeDescriptionWS request equivalent (XPath)
pvInstalledPowerYesfloatkWp positive floatsTotal installed power of the PV system in kilowatts-peak (kWp). The total PV system rating consists of a summation of the panel ratings measured in STC./dataDeliveryRequest/site/system/@installedPower
dateStartupNostring   String formatted as "yyyy-mm-dd" (example 2015-01-01). Start up date of PV system (resp. unpacking of modules). This parameter is used for calculation of degradation (or aging) of modules. If omitted, degradation is not taken into account./dataDeliveryRequest/site/system/@dateStartup
pvInstallationTypeYesstring  
  • FREE_STANDING
  • ROOF_MOUNTED
  • BUILDING_INTEGRATED
This property of the PV system helps to estimate how modules are ventilated. For sloped roof with PV modules on rails tilted at the same angle as the roof choose 'ROOF_MOUNTED' value. For PV modules incorporated into building facade choose 'BUILDING_INTEGRATED' value. This option is considered as the worst ventilated. As the best ventilated option is considered free standing installation. This typically means stand-alone installation on tilted racks anchored into the ground. Also choose this option if a PV system is installed on a flat roof (similar to stand-alone installation). The string value is in this case ''FREE_STANDING'./dataDeliveryRequest/site/system/@installationType
pvTrackerRotMinNostringpair of degrees-180,180
 Parameter is a pair of limiting rotation angles for OneAxisVertical, OneAxisInclined, OneAxisHorizontalNS and TwoAxisAstronomical (its vertical axis) mounting geometries. If the tracker is purely theoretical (no limits) the default value of "-180,180" is used.

/dataDeliveryRequest/site/geometry/@rotationLimitEast,

/dataDeliveryRequest/site/geometry/@rotationLimitWest

pvTrackerRot2Min

Nostringpair of degrees-90,90
 Parameter is a pair of limiting tilt angles for TwoAxisAstronomical (its horizontal axis) and OneAxisHorizontalEW trackers. Because of technical realizations of variable tilt often a linear actuator is used. Inclination angle seldom varies beyond 0 to 90, more often, it has smaller range e.g. "10,80". If the tracker is purely theoretical (no limits) the default value of "-90 to 90" should be used. Selecting tilt limits of "45,45" turns TwoAxisAstronomical tracker to the OneAxisVertical tracker tilted to 45 degree.

/dataDeliveryRequest/site/geometry/@tiltLimitMin,

/dataDeliveryRequest/site/geometry/@tiltLimitMax

pvTrackerBackTrackNostring FALSETRUE or FALSEDefault value "FALSE" corresponds to a standalone tracker without neighbors (best possible) moving within specified rotation limits (pvTrackerRotMin or/and pvTrackerRot2Min). Implemented for all trackers./dataDeliveryRequest/site/geometry/@backTracking
pvFieldSelfShadingNostring FALSETRUE or FALSEThe parameter affects FixedOneAngle geometry, then OneAxisHorizontalNS and OneAxisInclined type of trackers with pvTrackerBackTrack=FALSE. When pvTrackerBackTrack=TRUE, the parameter does not make sense as self-shading is avoided. No other options are implemented. It is used to determine the impact of self (inter-row) shading on PV power production. When set to TRUE, the effect of self-shading is taken into account in calculation, otherwise the geometry is assumed without neighbors (best possible)./dataDeliveryRequest/site/system/@selfShading
pvFieldColumnSpacingRelativeNofloat no spacing = isolated module
 The parameter has effect only in case of tracking system when pvTrackerBackTrack is TRUE. It specifies the ratio between distance between the equivalent table legs and table width. Affected are trackers TwoAxisAstronomical, OneAxisVertical, OneAxisInclined, OneAxisHorizontalNS.

dataDeliveryRequest/site/system/topology/@relativeSpacing

with dataDeliveryRequest/site/system/topology/@xsi:type="TopologyColumn"

pvFieldRowSpacingRelativeNofloat no spacing = isolated module

In case of trackers the parameter has effect only when pvTrackerBackTrack is True. It specifies the ratio between distance between the equivalent table legs and table width. Affected are FixedOneAngle systems and TwoAxisAstronomical tracker. According to image below, pvFieldRowSpacingRelative = x3 / x2

/dataDeliveryRequest/site/system/topology/@relativeSpacing

with dataDeliveryRequest/site/system/topology/@xsi:type="TopologyRow"

pvFieldTerrainSlopeNofloatdegree00, 90Slope of terrain, applied only when calculating self-shading effect of PV system with FixedOneAngle geometry. Defined in the same way as the parameter "tilt"./dataDeliveryRequest/site/terrain/@tilt
pvFieldTerrainAzimuthNofloatdegree1800,360Azimuth of sloped terrain, applied only when calculating self-shading effect of PV system with FixedOneAngle geometry. Defined in the same way as the parameter "azimuth"./dataDeliveryRequest/site/terrain/@azimuth
pvFieldTopologyTypeNostring 
  • UNPROPORTIONAL_1 for CSI
  • PROPORTIONAL for all other module technologies
  • PROPORTIONAL
  • UNPROPORTIONAL_1
  • UNPROPORTIONAL_2
  • UNPROPORTIONAL_3

This parameter estimates a loss of PV system output when modules are self-shaded. The effect depends on wiring interconnection within a module. Shading influence ranges from 0% (no influence) to 100% (full influence) and is mapped to categories:

  • PROPORTIONAL = 20%
  • UNPROPORTIONAL_1 = 40%
  • UNPROPORTIONAL_2 = 60%
  • UNPROPORTIONAL_3 = 80%

When parameter is missing at all, the self-shading influence is estimated to 5 %.

/dataDeliveryRequest/site/system/topology/@type
pvModuleTechnologyYesstring  
  • CSI
  • ASI
  • CDTE
  • CIS
Enumerated codes for materials used in PV modules. Use 'CSI' for crystalline silicon, 'ASI' for amorphous silicon, 'CDTE' for cadmium telluride, 'CIS' for copper indium selenide. For the estimate of module surface reflectance we use an approach described here./dataDeliveryRequest/site/system/module/@type
pvModuleDegradationNofloatpercent0.50, 100Estimated annual degradation of rated output power of PV modules. This parameter is only considered if "dateStartup" parameter is set./dataDeliveryRequest/site/system/module/degradation
pvModuleDegradationFirstYearNofloatpercent0.80, 100Estimated annual degradation of rated output power of PV modules in the first year of operation. If this parameter is not set, but "pvModuleDegradation" is present, the value of "pvModuleDegradation" will be used, otherwise default value 0.8% is considered. This parameter is only considered if "dateStartup" parameter is set./dataDeliveryRequest/site/system/module/degradationFirstYear
pvModuleSurfaceReflectanceNofloat 0.160, 1Empirical dimensionless coefficient, which is used to estimate PV power loss due to angular reflectivity of PV module surface. This parameter includes not only optical properties of covering glass, but also glass coating and dirt. Typical values for commercially available PV modules are 0.16 - 0.17 for clean surfaces, 0.20 for moderate dirty and 0.27 for dirty surface./dataDeliveryRequest/site/system/module/surfaceReflectance
pvModuleTempNOCTNofloatdegree Celsius

according to "pvModuleTechnology":

  • CSI=46°C
  • ASI=44°C
  • CDTE=45°C
  • CIS=47°C
 Normal operating cell temperature. Float value of the temperature in degrees Celsius of a free standing PV module exposed to irradiance of 800 W/m2 and ambient air temperature of 20°C and wind speed is 1 m/s. The value is given by manufacturer and only for ventilated free standing PV system./dataDeliveryRequest/site/system/module/nominalOperatingCellTemp
pvModuleTempCoeffPmaxNofloatpercent per degree Celsius

according to "pvModuleTechnology":

  • CSI=-0.438%/°C
  • ASI=-0.18%/°C
  • CDTE=-0.297%/°C
  • CIS=-0.36%/°C
 Negative percent float value representing the change in PV panel output power for temperatures other than 25°C (decrease of output power with raising temperature). This property is given at STC by manufacturer./dataDeliveryRequest/site/system/module/PmaxCoeff
pvInverterEffConstantNofloatpercent97.50, 100Value of inverter's efficency known as Euro or CEC (California Energy Commission) efficiency. This value is a calculated weighted efficiency given by manufacturer. It gives a simplified picture about an inverter, in fact non-linear performance. Valid range of this value is practically 70%-100%. For better results, it is recommended to provide inverter efficiency curve (by using parameter "")./dataDeliveryRequest/site/system/inverter/efficiency/@percent
pvInverterEffCurveDataPairsNostringkW/percent pairs  Efficiency of inverter is of non-linear nature, so it can be described as simplified curve defined as list of data points. Data point on the curve is defined by coordinates, where the x coordinate is absolute float value of input power in kilowatts (kW) and y coordinate is percent float value of the corresponding inverter's efficiency (%). This parameter accepts string value of this pattern: 'x1:y1 x2:y2 x3:y3 xn:yn'. A dot should be used as decimal separator, white space as a point delimiter and colon as x:y delimiter. We assume the last point determines the maximum input power of the inverter (with corresponding efficiency). Example efficiency curve of an inverter with the maximum input power of 3 kW is '0:85.6 0.5:96.2 1:98 1.5:97 2:97 2.5:96 3.0:96'. It is assumed, that one efficiency curve is valid for all inverters of the PV system (their powers are summed)./dataDeliveryRequest/site/system/inverter/efficiency/@dataPairs
pvInverterLimitationACPowerNofloatkW

Maximum AC power when inverter limits (clips) AC output. Clipping refers to the situation where the AC power output of an inverter is limited due to the peak rating of the inverter (the parameter value in kw), even though additional power may still be available from the solar modules. If you have power factor (PF) and AC limit in kVA available, use this formula: PF * AC_limit_kVA = kW, which is the value of this parameter./dataDeliveryRequest/site/system/inverter/limitationACPower
pvLossesDCOtherNofloatpercent5.40, 100Estimated integration of specific other DC losses (see pvLossesDCMismatch, pvLossesDCCables and pvLossesDCPollutionSnow parameters) into one number. Maximum simplification for DC losses./dataDeliveryRequest/site/system/losses/@dc
pvLossesDCMismatchNofloatpercent1.00, 100Share of estimated mismatch losses within the value of pvLossesDCOther parameter./dataDeliveryRequest/site/system/losses/dcLosses/@mismatch
pvLossesDCCablesNofloatpercent2.00, 100Share of estimated cabling losses within the value of pvLossesDCOther parameter./dataDeliveryRequest/site/system/losses/dcLosses/@cables
pvLossesDCPollutionSnowMonthNostringformatted list of float percent  Distribution of the pvLossesDCPollutionSnow value into 12 average months. Example: "5.0,2.0,2.0,2.0,0.0,0.0,0.0,0.0,0.0,2.0,5.0,8.0". Value of the parameter must consist of 12 percent float values delimited with comma. If this parameter has a value, it takes precedence over pvLossesDCPollutionSnow parameter./dataDeliveryRequest/site/system/losses/dcLosses/@monthlySnowPollution
pvLossesDCPollutionSnowNofloatpercent2.50, 100Share of estimated dirt and snow losses within the value of pvLossesDCOther parameter./dataDeliveryRequest/site/system/losses/dcLosses/@snowPollution
pvLossesACNofloatpercent1.50, 100Estimated integration of specific AC losses (see pvLossesACCable and pvLossesACTransformer parameters) into one number. Maximum simplification for AC losses./dataDeliveryRequest/site/system/losses/@ac
pvLossesACCableNofloatpercent0.50, 100Share of estimated cabling losses within the value of pvLossesAC parameter./dataDeliveryRequest/site/system/losses/acLosses/@cables
pvLossesACTransformerNofloatpercent1.00, 100Share of estimated transformer losses within the value of pvLossesAC parameter./dataDeliveryRequest/site/system/losses/acLosses/@transformer
pvInverterLimitationACPowerNofloatkW

Clipping refers to the situation where the AC power output of an inverter is limited due to the peak rating of the inverter (the parameter value in kw), even though additional power may still be available from the solar modules. If you have power factor (PF) and AC limit in kVA available, use this formula: PF * AC_limit_kVA = kW, which is the value of this parameter.

...