Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
(5 intermediate revisions by the same user not shown)
Line 1,374: Line 1,374:
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX.
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX.
|-
|-
|TempMult2=0.0  
|TempMult2=1.0  
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default second order multiplier is 1.0.
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default second order multiplier is 1.0.
"Second order" multiplier by which measured outdoor Temperature is to be corrected, this means that the logged reading can be (TempMult2 X measured-temp X measured_temp) + (TempMult X measured_temp) + TempOffset
"Second order" multiplier by which measured outdoor Temperature is to be corrected, this means that the logged reading can be (TempMult2 X measured-temp X measured_temp) + (TempMult X measured_temp) + TempOffset
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Only MX (build 3045 onwards).
|-
|HumMult2=1.0
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default second order multiplier is 1.0.
"Second order" multiplier by which measured outdoor Humidity is to be corrected, this means that the logged reading can be (HumMult2 X measured_hum X measured_hum) + (HumMult X measured_hum) + HumOffset
|-
|-
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|-
|-
|TempOffset=Offset_Value  
|TempOffset=Offset_Value  
|Default 'Offset_Value' is 0 in this parameter, used for quadratic formula shown below
|Default 'Offset_Value' is 0 in this parameter, used for quadratic formula shown for read-only parameter
|-
|-
|TempMult=1  
|TempMult=1  
Line 1,388: Line 1,394:
|-
|-
|HumMult=1  
|HumMult=1  
|Multiplier by which measured Humidity is to be corrected (default=1). See formula in next row
|Multiplier by which measured Humidity is to be corrected (default=1). See formula in read-only parameter
|-
|-
|HumOffset=Offset_Value  
|HumOffset=Offset_Value  
|Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus Humidity = measured_Humidity X Humidity_multiplier + 'Offset_Value'
|Default 'Offset_Value' is 0 in this parameter used for formula in MX read-only parameter above
|-
|-
|WetBulbMult=1
|WetBulbMult=1
Line 1,483: Line 1,489:
|-
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|-
|Logging=0
|Determines whether enhanced "debugging" logging takes place where Cumulus 1 or MX makes a detailed record of each action that takes place.
*0 (default) = Cumulus 1 or MX will not add debug logging.
*1 = For '''debug''' logging when Cumulus 1 or MX (re-)starts, add ''Logging=1'' to the station section of Cumulus.ini while Cumulus is stopped.
[[File:Badge vMx.png]] In MX only, it can also be set in the admin interface internet settings screen. Note that if set on the admin interface, it only remains set while Cumulus continues to run, and resets to default off when MX re-starts. For MX, if you want debugging output every time it runs, then add "-debug" parameter as explained at [[Cumulus_MX#Parameter_for_adding_debugging|Parameter_for_adding_debugging]]
|-
|-
|DailyProgram=  
|DailyProgram=  
Line 2,039: Line 2,038:
=== Section: Solar ===
=== Section: Solar ===


Not applicable to Cumulus 1.
{{Version badge 1}}Set mostly in '''solar block''' at foot of ''Station Settings'' screen in Configuration menu.


[[File:Badge vMx.png]] Available from version 3.0.0 only.
[[File:Badge vMx.png]]Set in '''Solar''' section quite a long way down on ''Station settings'' page in Settings menu


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
!style="width:150px" | Parameter Line Entry
!style="width:800px" | Function  
!style="width:600px" | Function  
|-
|style="background:lightgray;"|[Solar]
|style="background:lightgray;"|Section Name - the following parameters are set as described above
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours
|-
|SunThreshold=75
|If you have a solar sensor: Cumulus tries to determine whether the sun is shining by determining whether the current solar radiation value is above a certain percentage of the current theoretical maximum. The value you supply here is used as that percentage. The default value is 75%.
|-
|RStransfactor=0.8
|Cumulus uses the Ryan-Stolzenbach formula to determine the current theoretical maximum solar radiation at your location at the current moment in time. This formula has a factor to allow for the transmission of the radiation through the atmosphere; the default is 0.80.
|-
|SolarMinimum=0
|This setting allows you to specify a minimum solar radiation value which needs to be reached before it can be considered to be sunny. Note that this setting does not replace the calculation using the current theoretical maximum, it specifies an additional condition which has to be met. This setting therefore allows you to cater for the periods at the beginning and end of the day when the theoretical maximum is very low.
|-
|LuxToWM2=0.0079
|Edit cumulus.ini to add this parameter if you have a Fine Offset station with a solar detector. These supply 'Lux' values rather than 'W/m2' values that Davis stations supply. Cumulus attempts to convert from Lux to W/m2 using the supplied multiplication factor. You can add this parameter if you want to use a value other than the default of 0.0079, which is the generally accepted standard conversion factor for sunlight.
|-
|-
|style="background:lightgray;"|[Solar]
|UseBlakeLarsen=0
|style="background:lightgray;"|Section name - the following parameters relate to the solar configuration.
| Called B/l on screen. Set this to 1 if you have a Blake-Larsen Sun Recorder, and you want Cumulus to get today's sunshine hours from it. You need to configure the Blake-Larsen software to put the SRsunshine.dat file into the Cumulus data folder so that Cumulus can read it.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|colspan="2" style="background:lightblue;"| [[File:Badge vMx.png]] Available from MX version 3.0.0 only
|-
|-
|SolarCalc=1
|SolarCalc=1
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when the solar calculation method is set.
The value is set in the MX user interface when the solar calculation method is set.
*0 (default) = Ryan-Stolzenbach calculation, which uses the RStransfactor entry to tune the output.
*0 (default) = Ryan-Stolzenbach calculation, which uses the RStransfactor entry to tune the output.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
|-
|-
|BrasTurbidity=2.0
|BrasTurbidity=2.0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when the solar calculation method is set.
*2.0 (default) = Perfect clear sky
*2.0 (default) = Perfect clear sky
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
Line 3,015: Line 3,030:


=== Section: NOAA ===
=== Section: NOAA ===
All these can be set in the NOAA Setup Screen in Configuration menu.   
 
{{Version badge 1}}All these can be set in the '''NOAA Setup Screen''' in Configuration menu.   
 
[[File:Badge vMx.png]]Set these setting on the '''NOAA Settings''' page within Settings menu.


You might select to close Cumulus, and edit the 'NOAATempNorm[Jan-Dec]' and 'NOAARainNorm[Jan-Dec]' parameters by using a external editor to manipulate into required format, copy, and paste, the values from another source (as there are a lot of figures to type in).
You might select to close Cumulus, and edit the 'NOAATempNorm[Jan-Dec]' and 'NOAARainNorm[Jan-Dec]' parameters by using a external editor to manipulate into required format, copy, and paste, the values from another source (as there are a lot of figures to type in).
Line 3,101: Line 3,119:
|NOAARainNorm[Jan-Dec]=-1000
|NOAARainNorm[Jan-Dec]=-1000
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|}
=== Section: Solar ===
Set mostly in solar block at foot of Station Settings screen.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Solar]
|style="background:lightgray;"|Section Name - the following parameters are set from the Solar Setup dialog in Cumulus
|-
|SunThreshold=75
|If you have a solar sensor: Cumulus tries to determine whether the sun is shining by determining whether the current solar radiation value is above a certain percentage of the current theoretical maximum. The value you supply here is used as that percentage. The default value is 75%.
|-
|RStransfactor=0.8
|Cumulus uses the Ryan-Stolzenbach formula to determine the current theoretical maximum solar radiation at your location at the current moment in time. This formula has a factor to allow for the transmission of the radiation through the atmosphere; the default is 0.80.
|-
|SolarMinimum=0
|This setting allows you to specify a minimum solar radiation value which needs to be reached before it can be considered to be sunny. Note that this setting does not replace the calculation using the current theoretical maximum, it specifies an additional condition which has to be met. This setting therefore allows you to cater for the periods at the beginning and end of the day when the theoretical maximum is very low.
|-
|LuxToWM2=0.0079
|Edit cumulus.ini to add this parameter if you have a Fine Offset station with a solar detector. These supply 'Lux' values rather than 'W/m2' values that Davis stations supply. Cumulus attempts to convert from Lux to W/m2 using the supplied multiplication factor. You can add this parameter if you want to use a value other than the default of 0.0079, which is the generally accepted standard conversion factor for sunlight.
|-
|UseBlakeLarsen=0
| Called B/l on screen. Set this to 1 if you have a Blake-Larsen Sun Recorder, and you want Cumulus to get today's sunshine hours from it. You need to configure the Blake-Larsen software to put the SRsunshine.dat file into the Cumulus data folder so that Cumulus can read it.
|}
|}


5,838

edits

Navigation menu