Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (preserving history) (view source)

Revision as of 17:07, 3 August 2020

297 bytes added ,  17:07, 3 August 2020
m
→‎Section: Solar: Merged the two separate table into a single table, instead of separate table for MX only parameters
m (→‎Section: Solar: Merged the two separate table into a single table, instead of separate table for MX only parameters)
(17 intermediate revisions by the same user not shown)
Line 1,331: Line 1,331:
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|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.
|-
|-
|ImetWaitTime=200
|ImetWaitTime=200
|This parameter (attribute=value) if you need to change it from its '''default of 200 ms''' is added directly to the file, it does not appear on a configuration screen.  
|This parameter (attribute=value) if you need to change it from its '''default of 200 ms''' is added directly to the file, it does not appear on a configuration screen.  
Specifies the time in milliseconds that Cumulus allows for a response from an Instromet station. If you are having problems with reading from an Instromet station, try inserting this line into the ''Station'' section using a value of 500. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.
Specifies the time in milliseconds that Cumulus allows for a response from an Instromet station. If you are having problems with reading from an Instromet station, try inserting this line into the ''Station'' section using a value of 500. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus MX stopped. Only Cumulus MX.
|-
|ImetBaudRate=19200
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to manually set this value in Cumulus.ini before running the program.
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|-
|-
|SyncDavisClock=0  
|SyncDavisClock=0  
Line 1,348: Line 1,356:
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations. For a wet bulb sensor, Cumulus will output the temperature it shows, but not calculate the humidity.
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations. For a wet bulb sensor, Cumulus will output the temperature it shows, but not calculate the humidity.
(Note this attribute appears in [[#Davis_family_specific|Davis family]], [[#Oregon_Scientific_specific:|Oregon Scientific specific]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above with different usage explanations).
(Note this attribute appears in [[#Davis_family_specific|Davis family]], [[#Oregon_Scientific_specific:|Oregon Scientific specific]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above with different usage explanations).
|-
|colspan="2" style="background:lightblue;"| Only Cumulus MX: edit in Station Settings
|-
|ImetBaudRate=19200
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to manually set this value in Cumulus.ini before running the program.
|}
|}


Line 1,369: Line 1,371:
|style="background:lightgray;"|[Offsets]  
|style="background:lightgray;"|[Offsets]  
|style="background:lightgray;"|Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors
|style="background:lightgray;"|Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors
|-
|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
|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
|-
|-
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
Line 1,377: Line 1,385:
|TempMult=1  
|TempMult=1  
|First order multiplier by which measured outdoor Temperature is to be corrected (default=1).
|First order multiplier by which measured outdoor Temperature is to be corrected (default=1).
For formula see next item.
For formula see read-only item.
|-
|TempMult2=0.0
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default multiplier is 0.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
|-
|-
|HumMult=1  
|HumMult=1  
Line 1,741: Line 1,745:


=== Section: MySQL ===
=== Section: MySQL ===
Not applicable to Cumulus 1.
[[File:Badge vMx.png]]Only applicable to Cumulus MX.
Cumulus MX uses Cumulus.ini to store the MySQL configuration details.
Cumulus MX uses Cumulus.ini to store the MySQL configuration details.
All details are input on '''The MySQL settings screen'''. Here are the default settings. See [[Cumulus MX]] page for examples of what can be selected.
All details are input on '''The MySQL settings screen'''. Here are the default settings. See [[Cumulus MX]] page for examples of what can be selected.
Line 1,766: Line 1,776:
CustomMySqlMinutesIntervalIndex=6</pre>
CustomMySqlMinutesIntervalIndex=6</pre>


=== Section: Display ===


{{Version badge 1}}Set the majority of these parameters using Configuration menu and [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|either ''Display'' or ''Colours'' screens]] as seen on link and indicated below.  The exception is "TwelveHourClock", that parameter is set by clicking on the displayed time.


[[File:Badge vMx.png]]The only settings used in this section by Cumulus MX are "NumWindRosePoints" and those for extras.


 
{| class="wikitable" border="1"
 
=== Section: Display ===
 
{{Version badge 1}}Set the majority of these parameters using Configuration menu and [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|either ''Display'' or ''Colours'' screens]] as seen on link and indicated below.  The exception is "TwelveHourClock", that parameter is set by clicking on the displayed time.
 
[[File:Badge vMx.png]]The only settings used in this section by Cumulus MX are "NumWindRosePoints" and those for extras.
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
!style="width:150px" | Parameter Line Entry
Line 2,034: Line 2,039:
=== Section: Solar ===
=== Section: Solar ===


[[File:Badge vMx.png]] Available from version 3.0.0 only.
{{Version badge 1}}Set mostly in '''solar block''' at foot of ''Station Settings'' screen in Configuration menu.
 
[[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
|-
|-
|style="background:lightgray;"|[Solar]
|colspan="2" style="background:lightblue;"| Both Cumulus flavours
|style="background:lightgray;"|Section name - the following parameters relate to the solar configuration.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|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%.
|-
|-
|SolarCalc=1
|RStransfactor=0.8
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|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.
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.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
|-
|-
|BrasTurbidity=2.0
|SolarMinimum=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|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.
*2.0 (default) = Perfect clear sky
|-
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
|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.
|-
|colspan="2" style="background:lightblue;"| [[File:Badge vMx.png]] Available from MX version 3.0.0 only
|-
|SolarCalc=1
|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.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
|-
|BrasTurbidity=2.0
|The value is set in the MX user interface when the solar calculation method is set.
*2.0 (default) = Perfect clear sky
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
|}


=== Section: Graphs ===
=== Section: Graphs ===
Line 2,353: Line 2,376:


=== Section: Alarms ===
=== Section: Alarms ===
For MX, there is a default path "\CumulusMX\interface\sounds". '''Edit''' on '''Settings''' tab, '''Alarms''' screen.


{{Version badge 1}}Set these using the '''Edit''' menu, ''Alarms'' screen.
[[File:Badge vMx.png]]For MX, there is a default path "\CumulusMX\interface\sounds". '''Edit''' on '''Settings''' tab, '''Alarms''' screen.
 
{{Version badge 1}}Set these using the '''Edit''' menu, ''Alarms'' screen. The default path and file is '''\Cumulus\alert.wav''' for all the file parameters.  (Previously this article incorrectly showed "C:\Program Files\Cumulus\alert.wav" for some, but that has been removed now this applies to MX as well)
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,377: Line 2,401:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|LowTempAlarmSoundFile=C:\Cumulus\alert.wav
|LowTempAlarmSoundFile=
|Path and file name of sound file for Low Temperature alarm
|Path and file name of sound file for Low Temperature alarm
|-
|-
Line 2,393: Line 2,417:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighTempAlarmSoundFile=C:\Cumulus\alert.wav
|HighTempAlarmSoundFile=  
|Path and file name of sound file for High Temperature alarm
|Path and file name of sound file for High Temperature alarm
|-
|-
Line 2,407: Line 2,431:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|LowPressAlarmSoundFile=C:\Cumulus\alert.wav
|LowPressAlarmSoundFile=
|Path and file name for sound file to play for Low Pressure Alarm
|Path and file name for sound file to play for Low Pressure Alarm
|-
|-
Line 2,423: Line 2,447:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighPressAlarmSoundFile=C:\Cumulus\alert.wav
|HighPressAlarmSoundFile=  
|Path and file name for the sound file used for the High Pressure Alarm
|Path and file name for the sound file used for the High Pressure Alarm
|-
|-
Line 2,439: Line 2,463:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighRainTodayAlarmSoundFile=C:\Cumulus\alert.wav
|HighRainTodayAlarmSoundFile=
|Path and file name for the sound file used for the High Rain Today Alarm
|Path and file name for the sound file used for the High Rain Today Alarm
|-
|-
Line 2,455: Line 2,479:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighRainRateAlarmSoundFile=C:\Cumulus\alert.wav
|HighRainRateAlarmSoundFile=  
|Path and file name for the sound file used for the High Rain Rate Alarm
|Path and file name for the sound file used for the High Rain Rate Alarm
|-
|-
Line 2,471: Line 2,495:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighGustAlarmSoundFile=C:\Cumulus\alert.wav
|HighGustAlarmSoundFile=
|Path and file name for the sound file used for the High Gust Alarm
|Path and file name for the sound file used for the High Gust Alarm
|-
|-
Line 2,487: Line 2,511:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighWindAlarmSoundFile=C:\Cumulus\alert.wav
|HighWindAlarmSoundFile=  
|Path and file name for the sound file used for the High Wind Alarm
|Path and file name for the sound file used for the High Wind Alarm
|-
|-
Line 2,500: Line 2,524:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|SensorAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|SensorAlarmSoundFile=
|Path and file name for the sound file used for the Sensor Contact lost Alarm
|Path and file name for the sound file used for the Sensor Contact lost Alarm
|-
|-
Line 2,516: Line 2,540:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|TempChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|TempChangeAlarmSoundFile=
|Path and file name for the sound file used for the Temperature Change Alarm
|Path and file name for the sound file used for the Temperature Change Alarm
|-
|-
Line 2,532: Line 2,556:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|PressChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|PressChangeAlarmSoundFile=
|Path and file name for the sound file used for the Pressure Change Alarm
|Path and file name for the sound file used for the Pressure Change Alarm
|}
|}
Line 2,847: Line 2,871:
==== Section: xAP ====
==== Section: xAP ====


{{Version badge 1}Set in the Internet Configuration Screen sites/Options tab
{{Version badge 1}}Set in the Internet Configuration Screen sites/Options tab


[[File:Badge vMx.png]]It is in Cumulus.ini for MX, but nobody has told me whether it can be edited within the Admin interface.
[[File:Badge vMx.png]]It is in Cumulus.ini for MX, but nobody has told me whether it can be edited within the Admin interface.
Line 2,872: Line 2,896:


==== Section: WeatherCloud ====
==== Section: WeatherCloud ====
Not available in Cumulus 1


[[File:Badge vMx.png]] Only available from version 3.0.0
[[File:Badge vMx.png]] Only available from version 3.0.0
Line 2,886: Line 2,912:
|-
|-
|Wid=
|Wid=
|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 Weathercloud ID value is set.
The value is set in the MX user interface when the Weathercloud ID value is set.
|-
|-
|Key=
|Key=
|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 your Weathercloud API Key value is set.
The value is set in the MX user interface when your Weathercloud API Key value is set.
|-
|-
|Enabled=0
|Enabled=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|This parameter controls whether data is sent to WeatherCloud
*0 = Disable sending of data (default)
*0 (default) = Disable sending of data
*1 = Enable sending of data
*1 = Enable sending of data
|-
|-
|SendUV=0
|SendUV=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 Include UV value is set.
The value is set in the MX user interface when the Include UV value is set.
*0 = Do not send UV data (default)
*0 = Do not send UV data (default)
*1 = Send UV data
*1 = Send UV data
|-
|-
|SendSR=0
|SendSR=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 Include Solar Radiation value is set.
The value is set in the MX user interface when the Include Solar Radiation value is set.
*0 = Do not send Solar data (default)
*0 = Do not send Solar data (default)
*1 = Send Solar data
*1 = Send Solar data
|}
|}


==== Section: WLL ====


 
Not available in Cumulus 1
 
==== Section: WLL ====


[[File:Badge vMx.png]] Only available from version 3.0.0
[[File:Badge vMx.png]] Only available from version 3.0.0
Line 2,975: Line 2,996:


==== Section: Windy ====
==== Section: Windy ====
Not available in Cumulus 1


[[File:Badge vMx.png]] Only available from version 3.0.0 build 3049 onwards. Edit all parameters in the '''Internet settings''' screen, ''Windy.com'' section.
[[File:Badge vMx.png]] Only available from version 3.0.0 build 3049 onwards. Edit all parameters in the '''Internet settings''' screen, ''Windy.com'' section.
Line 3,008: Line 3,031:


=== Section: NOAA ===
=== Section: NOAA ===
All these can be set in the NOAA Setup Screen in Configuration 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).


'''Please note:''' because this section of Cumulus.ini uses [[Webtags#Time.2FDate_.27format.27_Parameter|date format]] parameters, it is not directly exchangeable between Cumulus 1 and Cumulus MX. You will need to update this section using 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).
 
'''Please note:''' because this section of Cumulus.ini uses [[Webtags#Time.2FDate_.27format.27_Parameter|date format]] parameters, you are advised to read [[Webtags#The_format_used_for_naming_reports]].
 
The settings that you use for Cumulus 1 may not be the same as settings you use for MX.  If for Cumulus 1, you used capital "M" to represent month it will work for MX too. If for Cumulus 1 you used "NOAAMO'mmyy'.txt" and you then move to MX at any version from version 3.3.0 onwards, it will automatically change your setting to "NOAAMO'MMyy'.txt" (which works on both Cumulus MX and, if you then revert, also on Cumulus 1).
 
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 3,088: Line 3,120:
|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.
|}
|}


Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/6993...7012"

Navigation menu