Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (preserving history) (view source)

Revision as of 08:25, 26 March 2020

4,141 bytes added ,  08:25, 26 March 2020
m
→‎Section: Station: Made clear what also applies to MX and what does not
mNo edit summary
m (→‎Section: Station: Made clear what also applies to MX and what does not)
(39 intermediate revisions by the same user not shown)
Line 2: Line 2:
{{TOCright}}
{{TOCright}}
= Introduction =
= Introduction =
*'''Cumulus.ini''' is a text file containing initialization parameters used by the Cumulus 1.x.x, or Cumulus MX, application.
*It is '''only read''' when Cumulus (of either flavour) starts up. When Cumulus (either flavour) is run for very first time, the file does not exist, as it is not included in the download (of either flavour).  For MX only, if the file does exist as MX starts, a backup is taken so if you subsequently change any settings you can go back to how it was before you made those changes.
*Cumulus (1 or 2 or MX) creates a new version of this file when it ''shuts down'', if this is the first run of the software this will create the file for first time.
*The file shows as 'modified date' the last time that Cumulus was shut down, the file will contain the contents of the application's configuration screens and also any parameters that were in any previous copy of the file that cannot be configured within Cumulus.
*Note this Cumulus save action may change the order, or add lines, compared to any file that you manually edited.
*For Cumulus MX only, a back up copy of Cumulus.ini is stored at end of each day (together with some of the log files).
*If you do need to edit the file, close Cumulus first to ensure you are working on latest contents, and your edit cannot conflict with any edit Cumulus may be making. When Cumulus restarts it will read the file again and see any edits you have made.
The parameters listed can change the look of Cumulus, can hold basic information about your location, can amend the way Cumulus interfaces with your weather station, can hold the settings used to interface with your website, and with various external websites.
Later on this page there is a table showing parameters that may be in the configuration file, the default value for each attribute is mentioned, and it is made clear whether that parameter can be set through the settings screen in the software or must be manually added to the file. The list was created for Cumulus 1.x.y, and all of it applies to the final formal release. The majority of the parameters are also used by Cumulus MX, which can edit in its settings screens some that Cumulus 1 cannot edit. There are also extra parameters that only apply to MX, plus some extra values available for some attributes like weather station make.
If you are using an older Cumulus 1 version, then ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below as available in latest release of Cumulus 1.
Similarly, the parameters available may vary between different versions/builds of MX, again ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below.
== Creating Configuration File ==
== Creating Configuration File ==
When you download Cumulus 1 or MX, ''there is no configuration file included in the download''. So when you first use the software, either flavour of Cumulus, you will need to enter some settings, and that will lead to creation of the main configuration file.  How to enter these minimum settings will be described next.
When you download Cumulus 1 or MX, ''there is no configuration file included in the download''. So when you first use the software, either flavour of Cumulus, you will need to enter some settings, and that will lead to creation of the main configuration file.  How to enter these minimum settings will be described next.
Line 17: Line 34:
#If you start Cumulus MX without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this: [[File:MX first start.PNG]]
#If you start Cumulus MX without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this: [[File:MX first start.PNG]]
#As you can see, it is running, but it does not know what station type, so it cannot connect to it, and will not do anything more.
#As you can see, it is running, but it does not know what station type, so it cannot connect to it, and will not do anything more.
#Open the user interface, and select the station settings if necessary: [[File:MX station settings.png]]
#Open the user interface, and select the station settings if necessary: [[File:MX_station_settings.png|800px|center]]
#At the very minimum, you must select a station type and units (as shown in image above)
#At the very minimum, you must select a station type and units (as shown in image here)
#Optionally, move down the page, entering more settings, or move to other settings pages accessed from the menu seen in the image
#Optionally, move down the page, entering more settings, or move to other settings pages accessed from the menu seen in the image
# Optionally create a [[Strings.ini]] file (look up the cross reference if you want to do this now, but you can leave it to later) where you can tailor a number of texts that Cumulus produces.
# Optionally create a [[Strings.ini]] file (look up the cross reference if you want to do this now, but you can leave it to later) where you can tailor a number of texts that Cumulus produces.
Line 26: Line 43:
== Swapping from Cumulus 1 to MX ==
== Swapping from Cumulus 1 to MX ==
If you swap from Cumulus 1 to MX, your Cumulus 1 configuration files can be read by MX provided the initial letter of the file name is a capital 'C' and the other letters are in lower case. Once it has been processed by MX, the ex Cumulus 1 main configuration file will gain a lot of new entries.
If you swap from Cumulus 1 to MX, your Cumulus 1 configuration files can be read by MX provided the initial letter of the file name is a capital 'C' and the other letters are in lower case. Once it has been processed by MX, the ex Cumulus 1 main configuration file will gain a lot of new entries.
== Minimum Content of "Cumulus.ini" ==
The minimum content of the main configuration file is an entry for every setting that can be defined in the software (whichever flavour you are using, there are more options in MX).
== Configuration File names ==
== Configuration File names ==
=== Cumulus MX ===
=== Cumulus MX ===
Don't rename the CumulusMX.exe file name as it must use that mixture of upper and lower case.  The main configuration file is always called ''Cumulus.ini'' (it must start with a capital 'C') and is located in the directory in which you installed CumulusMX.exe.  All the characters used within the configuration file must be within ASCII range.
Don't rename the '''CumulusMX.exe''' file name as it must use that mixture of upper and lower case.  The main configuration file is always called ''Cumulus.ini'' (it must start with a capital 'C') and is located in the directory in which you installed CumulusMX.exe.  All the characters used within the configuration file must be within ASCII range. No other "Cumulus.ini" files are required. Most of the sections are same in both flavours of Cumulus, but MX does not use [MainForm].
 
  Additional configuration files, also called Cumulus.ini, can be created by Cumulus 1 to store the position of the main screen and the NOAA parameter editing screen. As downloaded, the Cumulus 1 executable is called '''cumulus.exe''' and all in lowecase. If you renamed that executable file to say ''Cumulus1.exe'' it will still work, but the main configuration file then takes that name (i.e. ''Cumulus1.ini'') in the same folder lacking one section, although another configuration file will be created called ''Cumulus.ini'' in that folder, this second one will have the one missing section.  The default name "cumulus.exe" results in only one '''cumulus.ini''' (all lower case) in that folder, containing all sections.
 
'''For Cumulus MX''', both file-names must start with a capital letter, and a If you renamed your executable file, you may still find a "cumulus.ini" file created by Cumulus 1 containing a [[#Section:_MainForm|single section]] to record when Cumulus closes where you positioned your Cumulus main screen so next you start Cumulus 1 its main screen can start in same position. For example I have mine on a second screen, and it stays there!  A second ''Cumulus.ini'' may be stored in the reports sub-directory, this only contains a [[#Section:_MainForm|single section]] and relates to the screen used for NOAA reports.
 
It is a text file containing initialization parameters used by the Cumulus 1.x.x, or Cumulus MX, application; and is read '''only''' when Cumulus starts up.  Cumulus (1 or 2 or MX) creates a new version of this file when it ''shuts down'', so you will see the file shows as 'modified date' the last time that Cumulus was shut down, the file that it creates includes the contents of the application's configuration screens and any parameters that were in the previous file that cannot be configured within Cumulus. Note this may change the order, or add lines, compared to any file that you manually edited.
For Cumulus MX only, a back up copy of Cumulus.ini is stored at end of each day (together with some of the log files). If you do need to edit the file, close Cumulus first to ensure you are working on latest file. When Cumulus restarts it will read the file again and see any edits you have made.


=== Cumulus 1 ===
As downloaded, the Cumulus 1 executable is called '''cumulus.exe''' and all in lowercase. The configuration file that it creates on first use will take the name of the executable file (keeping to the same case) and add the extension '''.ini''' (instead of .exe) and will be stored in same folder as the executable, it will contain all sections.


The parameters listed can change the look of Cumulus, hold basic information about your location, amend the way Cumulus interfaces with your weather station, and hold the settings used to interface with your website, and with various external websites. The list below was created for Cumulus 1.x.y, and all of it applies to the final formal release; '''for MX''' (like any beta) please refer to announcements or the separate page referenced below for any variations. In particular, MX has extended the range of settings for some items and added new items (see [[Cumulus.ini_(Beta)|here for details]].
If you renamed that executable file to say ''Cumulus1.exe'' it will still work in the same way so the main configuration file then takes that name (i.e. ''Cumulus1.ini'') in the same folder but this file will be lacking one section, and another configuration file will be created called ''Cumulus.ini'' in that folder, this second one will have the one missing section.


If you are using an older Cumulus 1 version, then ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below as available in latest release.
An additional configuration file, also called Cumulus.ini, can be created by Cumulus 1 to store the position of the NOAA parameter editing screen, this will be created the first time you edit NOAA parameters and will be stored in the "Reports" folder this only contains a [[#Section:_MainForm|single section]] and relates to the screen used for NOAA reports.
[[Category:Configuration Files]]


= Upgrading to New Build =
= Upgrading to New Build =
Line 49: Line 58:


= File Structure =
= File Structure =
The main file consists of a number of sections, each with a heading delimited by '[ ]', (although the order in the file may be different to that in this article).  Parameter lines are in the form 'attribute=value' and grouped by those sections.
The main file consists of a number of sections, each with a heading delimited by '[ ]', (although the order in the file may be different to that in this article).  Parameter lines are in the form 'attribute=value' and grouped by those sections. Those attributes can be listed in any order, Cumulus software will always add new attributes to the end of the section. If you are manually adding attributes, it may be best if you sort the attributes so they appear in alphabetical order and thus ensure you do not duplicate attribute names with different values.


Some [[#Sections_dealing_with_interfaces_to_external_sites|sections]] relate to the external websites that Cumulus can optionally supply with updates.  These are set by configuration screens and the whole sections will always be present. If you do not use those external services their parameters will be set to the defaults.
Some [[#Sections_dealing_with_interfaces_to_external_sites|sections]] relate to the external websites that Cumulus can optionally supply with updates.  These are set by configuration screens and the whole sections will always be present. If you do not use those external services their parameters will be set to the defaults.
Line 57: Line 66:


== Completeness of this list ==
== Completeness of this list ==
'''Please note that this list is not updated by the developers when they change the software to react to a new attribute, therefore there is no guarantee that all attributes available appear in this documentation.'''
If you spot a parameter that is missing from this list (check you are looking in the right section, and under the correct sub-heading where a section is sub-divided for ease of using this article), then please add it to this Wiki article. None of the authors who have contributed so far can claim completeness.  Sometimes a search on the forum for something else reveals a mention of an additional parameter that can be added to the file but has not been previously added to this list.
If you spot a parameter that is missing from this list (check you are looking in the right section, and under the correct sub-heading where a section is sub-divided for ease of using this article), then please add it to this Wiki article. None of the authors who have contributed so far can claim completeness.  Sometimes a search on the forum for something else reveals a mention of an additional parameter that can be added to the file but has not been previously added to this list.


Line 83: Line 94:
''You can edit them in the file with Cumulus stopped'', but beware of selecting invalid values for these parameters, generally it is safer to use the application to edit them (unless you are importing values from another setup), and Cumulus will read the new values when it is next restarted.
''You can edit them in the file with Cumulus stopped'', but beware of selecting invalid values for these parameters, generally it is safer to use the application to edit them (unless you are importing values from another setup), and Cumulus will read the new values when it is next restarted.
== Settings independent of application ==
== Settings independent of application ==
Some configuration settings can only be applied by editing this file to insert a new parameter line; they do not appear anywhere in the configuration screens. Cumulus does not write these values back out to the file on shut down, so they do not appear with default values - in other words, you need to ''add'' them if you want to set them. Make sure you place these additional parameters in the correct section as listed below.
Some configuration settings can only be applied by editing this file to insert a new parameter line; they do not appear anywhere in the configuration screens. When Cumulus is creating a configuration file it does not write any parameters that are not in its settings screens, so they do not appear with default values - in other words, you need to ''add'' them if you want to set them. Make sure you place these additional parameters in the correct section as listed below.
=== Editing outside Cumulus ===
=== Editing outside Cumulus ===
*If you are using Cumulus 1, it is best to take a copy of the existing cumulus.ini file before you make any changes (either by using application screens or by editing the file), so you can return to the original if necessary. MX automatically takes back ups, so you can return to an earlier version if necessary
*If you are using Cumulus 1, it is best to take a copy of the existing cumulus.ini file before you make any changes (either by using application screens or by editing the file), so you can return to the original if necessary. MX automatically takes back ups, so you can return to an earlier version if necessary
Line 91: Line 102:


= File Contents =
= File Contents =
== Introduction ==
The section called "[FTP site]" should obey that use of capitals and lower-case. Other sections should be named as shown.
The entries shown in the 'parameter line entry' column include the default value from the configuration screen where applicable, a typical example value where appropriate, or just the attribute and an equals sign where there is no typical value.
== Minimum Content of "Cumulus.ini" ==
The section called "[FTP site]" should obey that use of capitals and lower-case.
The minimum content of the main configuration file is an entry for every setting that can be defined in the software (whichever flavour you are using, there are more options in MX).
 
== Default and Example Values ==
The entries shown in the 'parameter line entry' column include the default value from the configuration screen where applicable, a typical example value where appropriate, or just the attribute and an equals sign where there is no default nor typical value.
 
== Section by Section ==
 
=== Section: MainForm ===
 
This section applies to [[File:Badge v1.png]]Cumulus 1 only.
 
There are two actions that will create this section in a file that is always called ''Cumulus.ini'' stored in different locations according to the creating action:
*If you edit NOAA parameters then One file with this section is stored in the reports sub-directory and it stores the position of your last saved NOAA screen.
*If you have set 'Save main window position' on Display settings screen, this section appears in the Cumulus.ini file found in same directory as cumulus.exe, and it stores the position of the main Cumulus screen on your monitor.  


== Section: Station ==
See individual parameters for specific instructions on setting them. In many cases this is by using Station Configuration Screen, but if the parameter line does not exist in your file, then insert it using a file editor as per instructions above. Note difference between Cumulus 1 (here) and Cumulus MX [[Cumulus.ini_(Beta)|(here)]].
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 102: Line 124:
!style="width:600px" | Function  
!style="width:600px" | Function  
|-
|-
|style="background:lightgray;"|[Station]  
|style="background:lightgray;"|[MainForm]  
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the Cumulus or NOAA screen position.
|-
|Left=100
|The last saved Cumulus main or NOAA screen position, in pixels from the left-hand edge of the screen.
|-
|-
|Type= -1  
|Top=50
|Station Type as set by the checked radio box in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]], Station Type block.  For details of [[Supported_Devices]] click that link.
|The last saved Cumulus main or NOAA screen position, in pixels from the top edge of the screen
*-1= default value, indicates a selection from those below must be made
|}
 
=== Section: Station ===
See individual parameters for specific instructions on setting them. In many cases this is by using Station Configuration Screen, but if the parameter line does not exist in your file, then insert it using a file editor as per instructions above.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|Type= -1  
|Station Type as set by the checked radio box in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]], Station Type block.  For details of [[Supported_Devices]] click that link.
*-1= default value, indicates a selection from those below must be made
*0=Vantage Pro station
*0=Vantage Pro station
*1=Vantage Pro2 station
*1=Vantage Pro2 station
Line 122: Line 161:
*9=[[WMR100-200_Protocol|WMR200]]
*9=[[WMR100-200_Protocol|WMR200]]
*10=Instromet (with optional extra solar sensors or without)
*10=Instromet (with optional extra solar sensors or without)
Additional values available in MX - see [[Cumulus.ini_(Beta)#Section:_Station|(here)]].
|-
|-
|Model="your Model description"  
|Model="your Model description"  
|The weather station model description - you choose what text appears for this on (from version 1.9.x) 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
|The weather station model description that you want output by the web tag <#stationtype>
{{Version badge 1}} - you choose what text appears for this on (from version 1.9.x) 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
[[File:Badge vMx.png]] - this does not appear in the station settings, stop MX, and add it directly into Cumulus.ini within this [Station] section.
|-
|-
|Port=0  
|Port=0  
|Selected in the Station Configuration Screen Settings block. Com port in your computer which is connected to your weather station if connected via a serial port.  Defaults to port 0.
|{{Version badge 1}}Selected in the Station Configuration Screen Settings block. Com port in your computer which is connected to your weather station if connected via a serial port.  Defaults to port 0.
[[File:Badge vMx.png]] This parameter is ignored by MX, it uses a different parameter - see [[Cumulus.ini_(Beta)#Section:_Station|(here)]].  
|-
|-
|Latitude=0  
|Latitude=0  
|You are advised ''not'' to directly edit this parameter in the file, but to type Latitude (unsigned) Degrees, Minutes, Seconds and select 'N' or 'S' in the Station Configuration Screen Location block. Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
|You are advised ''not'' to directly edit this parameter in the file, but to enter the settings via the screen provide in software where you type Latitude (unsigned) Degrees, Minutes, Seconds and select 'N' or 'S'.
{{Version badge 1}}Do this  in the Station Configuration Screen Location block.  
[[File:Badge vMx.png]] Exactly same entries, enter using station settings by expanding location section.
Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
|-
|-
|Longitude=0  
|Longitude=0  
|You are advised ''not'' to directly edit this parameter in the file, but to type Longitude (unsigned) Degrees, Minutes, Seconds and select 'E' or 'W' in the Station Configuration Screen Location block. Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
|You are advised ''not'' to directly edit this parameter in the file, but to type Longitude (unsigned) Degrees, Minutes, Seconds and select 'E' or 'W'.
The place to do this is as described for Latitude depending on Cumulus flavour.
Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
|-
|-
|LatTxt=  
|LatTxt=  
|You are advised ''not'' to directly edit this parameter in the file, but to type Latitude Degrees, Minutes, Seconds in the Station Configuration Screen Location block. Latitude in text string format of hemisphere D, M and S. HTML ampersand codes are used for spaces and unit characters.
|You are advised ''not'' to directly edit this parameter in the file, it contains Latitude in text string format of hemisphere D, M and S. HTML ampersand codes are used for spaces and unit characters.
|-
|-
|LonTxt=  
|LonTxt=  
|Longitude in text string format of hemisphere degrees, minutes and seconds. HTML ampersand codes are used for spaces and DMS characters.
|You are advised ''not'' to directly edit this parameter in the file, it contains Longitude in text string format of hemisphere degrees, minutes and seconds. HTML ampersand codes are used for spaces and DMS characters.
|-
|-
|Altitude=0  
|Altitude=0  
|your station altitude (default is zero) as entered in the Station Configuration Screen Location block.  See Cumulus Help for that screen. See next parameter to choose unit.
|your station altitude (default is zero) as entered in same place as other parameters.  See Cumulus Help for that screen. See next parameter to choose unit.
|-
|-
|AltitudeInFeet=1  
|AltitudeInFeet=1  
|Altitude measurement unit for value in previous parameter is set in the Station Configuration Screen Location block.
|Altitude measurement unit for value in previous parameter.
*0 = metres Above Sea Level
*0 = metres Above Sea Level
*1 = feet ASL
*1 = feet ASL
Line 164: Line 213:
|-
|-
|Wind10MinAverage=0  
|Wind10MinAverage=0  
|Selected in the Station Configuration Screen Settings block.
|Selected on same screen as other parameters.
*0 = Disabled (default), Cumulus will display the value supplied by the station. This is a 10 minute average for Davis stations, but an average over a shorter period for Oregon Scientific and Fine Offset stations, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*0 = Disabled (default), Cumulus will display the value supplied by the station. This is a 10 minute average for Davis stations, but an average over a shorter period for Oregon Scientific and Fine Offset stations, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*1 = Enabled, Cumulus will calculate and display a N-minute average wind speed where N is defined by the previous parameter if present, otherwise defaults to 10, the international standard duration used to calculate average wind speeds.
*1 = Enabled, Cumulus will calculate and display a N-minute average wind speed where N is defined by the previous parameter if present, otherwise defaults to 10, the international standard duration used to calculate average wind speeds.
|-
|-
|UseSpeedForAvgCalc=0
|UseSpeedForAvgCalc=0
|Selected in the Station Configuration Screen Settings block.
|Selected on same screen as other parameters.
*0 = Disabled (default), Cumulus will display the average wind speed value supplied by the station, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*0 = Disabled (default), Cumulus will display the average wind speed value supplied by the station, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*1 = Enabled,  Cumulus will use the longer-term 'speed' values in the average speed calculation. The preceding 'Wind10MinAverage' option must be enabled for this parameter to have any effect.
*1 = Enabled,  Cumulus will use the longer-term 'speed' values in the average speed calculation. The preceding 'Wind10MinAverage' option must be enabled for this parameter to have any effect.
Line 175: Line 224:
|-
|-
|RoundWindSpeed=0
|RoundWindSpeed=0
|Selected in the Station Configuration Screen Settings block.
|Selected on same screen as other parameters.
*0 = Disabled (default), Cumulus will display the wind speed value to the precision used by the station.
*0 = Disabled (default), Cumulus will display the wind speed value to the precision used by the station.
*1 = Enabled, this setting causes wind speeds to be rounded to the nearest integer.
*1 = Enabled, this setting causes wind speeds to be rounded to the nearest integer.
Line 184: Line 233:
|-
|-
|UseZeroBearing=0  
|UseZeroBearing=0  
|Set this in the Station Configuration Screen Settings block.
|Selected on same screen as other parameters.
*0 = Disabled, Cumulus displays the current bearing read from the station (i.e. the last direction the wind was blowing from before it became calm). Note that the average wind bearing will always display zero bearing if there has been no wind for the last N minutes (where N is defined by previous parameter if present but defaults to 10), as the average bearing takes wind speed into account.
*0 = Disabled, Cumulus displays the current bearing read from the station (i.e. the last direction the wind was blowing from before it became calm). Note that the average wind bearing will always display zero bearing if there has been no wind for the last N minutes (where N is defined by previous parameter if present but defaults to 10), as the average bearing takes wind speed into account.
*1 = Enabled, Cumulus display a bearing of zero (and '---' for the compass point) when the wind is calm (note when not calm, bearing is 360 for true North)
*1 = Enabled, Cumulus display a bearing of zero (and '---' for the compass point) when the wind is calm (note when not calm, bearing is 360 for true North)
|-
|-
|CalculatedDP=0  
|CalculatedDP=0  
|Selected in the Station Configuration Screen Settings block.
|Selected on same screen as other parameters.
*0 = Disabled, Cumulus will display the dew point value supplied by the station.
*0 = Disabled, Cumulus will display the dew point value supplied by the station.
*1 =  Enabled, Cumulus will calculate the dew point instead. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
*1 =  Enabled, Cumulus will calculate the dew point instead. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
|-
|-
|CalculatedWC=0  
|CalculatedWC=0  
|Selected in the Station Configuration Screen Settings block.
|Selected on same screen as other parameters.
*0 = Disabled
*0 = Disabled
*1 = Enabled, Cumulus will calculate the wind chill instead of using the value supplied by the station. You should set this if you have specified any calibration values for wind and/or temperature, so that Cumulus can also apply those adjustments to the wind chill.
*1 = Enabled, Cumulus will calculate the wind chill instead of using the value supplied by the station. You should set this if you have specified any calibration values for wind and/or temperature, so that Cumulus can also apply those adjustments to the wind chill.
Line 212: Line 261:
|-
|-
|RolloverHour=0  
|RolloverHour=0  
|Log roll over time as selected on the Station Configuration Screen
|Log roll over time as selected on the same screen as other parameters
*0 = midnight
*0 = midnight
*9 = 9am/10am
*9 = 9am/10am
|-
|-
|Use10amInSummer=1  
|Use10amInSummer=1  
|Daylight saving correction for 9am roll over
|Daylight saving correction for 9am roll over, Selected on same screen as other parameters.
*0 = Use 9am in summer (use 10am not checked on Station Configuration Screen)
*0 = Use 9am in summer (use 10am not checked on Station Configuration Screen)
*1 = Use 10am in summer selected on Station Configuration Screen
*1 = Use 10am in summer selected on Station Configuration Screen
Line 229: Line 278:
|-
|-
|WarnMultiple=0  
|WarnMultiple=0  
|Set as 'Stop 2nd instance' in the Station Configuration Screen Program Settings block.  Controls behavoir for Multiple Instances of Cumulus running on PC. Requires a Cumulus restart if value toggled, before new behavoir will take effect.
|Set as 'Stop 2nd instance' in the Station Configuration Screen Program Settings block.  Controls behaviour for Multiple Instances of Cumulus running on PC. Requires a Cumulus restart if value toggled, before new behaviour will take effect.
*0 = Disabled, (default) Multiple instances allowed.
*0 = Disabled, (default) Multiple instances allowed.
*1 = Enabled, prevents multiple instances of Cumulus from running.
*1 = Enabled, prevents multiple instances of Cumulus from running.
Not available in earliest builds of any Cumulus flavour.
|-
|-
|ConfirmClose=0  
|ConfirmClose=0  
|Selected in the Station Configuration Screen Program Settings block. Toggles Confirmation you wish to close Cumulus application after telling it to close
|{{Version badge 1}}Selected in the Station Configuration Screen Program Settings block. Toggles Confirmation you wish to close Cumulus application after telling it to close
*0 = Disabled, application will close immediately
*0 = Disabled, application will close immediately
*1 = Enabled, application will prompt for confirmation that you wish to close it (do not use this if you might suspend/standby/hibernate your computer)
*1 = Enabled, application will prompt for confirmation that you wish to close it (do not use this if you might suspend/standby/hibernate your computer)
Ignored by MX.
|-
|-
|CloseOnSuspend=1  
|CloseOnSuspend=1  
|If this is selected, in the Station Configuration Screen Program Settings block, Cumulus will close if you suspend/standby/hibernate your computer.  You should not select the previous parameter 'ConfirmClose' if you use this option.
|{{Version badge 1}}If this is selected, in the Station Configuration Screen Program Settings block, Cumulus will close if you suspend/standby/hibernate your computer.  You should not select the previous parameter 'ConfirmClose' if you use this option.
*0 = Disabled, application will not close if you suspend/standby/hibernate your computer (it is highly recommended you close Cumulus manually before your computer is put into suspend/standby/hibernate state)   
*0 = Disabled, application will not close if you suspend/standby/hibernate your computer (it is highly recommended you close Cumulus manually before your computer is put into suspend/standby/hibernate state)   
*1 = Enabled, application will close on suspend/standby/hibernate of your computer (recommended if your computer can go into any of these states when left alone)
*1 = Enabled, application will close on suspend/standby/hibernate of your computer (recommended if your computer can go into any of these states when left alone)
Ignored by MX
|-
|-
|DataLogInterval=2  
|DataLogInterval=2  
|Selected in the Station Configuration Screen [[Cumulus_Screenshots#Station|Data log interval]] block on the right hand side and defines frequency of logged information in the [[Monthly_log_files]] and, when applicable, in [[Extra_Sensor_Files]].
|Selected in the Station Configuration Screen [[Cumulus_Screenshots#Station|Data log interval]] block on the right hand side and defines frequency for Cumulus to log weather readings and derived figures in the [[Monthly_log_files]] and, when applicable, in [[Extra_Sensor_Files]].
*0 = 1 min
*0 = 1 min
*1 = 5 mins
*1 = 5 mins
Line 251: Line 303:
*4 = 20 mins
*4 = 20 mins
*5 = 30 mins
*5 = 30 mins
Notes:  
Notes:
*For a Davis station set to match your station logging interval. (Otherwise you may activate the 'feature' in the Davis stations where they send the entire contents of the data logger when Cumulus asks for the data since it was last running). See Readme.txt.
*Some weather station types do not have an in-built logger, so Cumulus cannot read any archive data from them, and they don't have a station console logging interval, to determine what this Cumulus logging interval should be.
*For some station Types, Cumulus only reads latest readings while it is running, and missing station readings are not captured if Cumulus is restarted.
*For a Davis station MUST set Cumulus logging interval to match your station console logging interval. (Otherwise you may activate the 'feature' in the Davis stations where they send the entire contents of the data logger when Cumulus asks for the data since it was last running). See Readme.txt. For other station types, normally set so matches station console logging interval, but this is not mandatory.
*For other makes as ''Cumulus on restarting is able (see next parameter) to read logged data from your station'' you can choose to match Cumulus and station logging intervals, then the frequency of logged information will be same regardless of whether Cumulus is running continuously or restarted (this improves accuracy of any averages calculated).
*For other makes as ''Cumulus on restarting is able (see next parameter) to read logged data from your station'' you can choose to match Cumulus and station logging intervals, then the frequency of logged information will be same regardless of whether Cumulus is running continuously or restarted (this improves accuracy of any averages calculated).
*Some Cumulus users set this Cumulus logging interval to be one of the two shorter times so they retain the maximum measurement detail in case of any need to correct rogue measurements, but have set their station logging interval at a longer time so that the station does not overwrite the memory locations over the longest period they might be away.  In this case, the frequency of logged information will change between the periods Cumulus is running and the catch-up readings from station logger when it is restarted.
*Some Cumulus users set this Cumulus logging interval to be one of the two shorter times so they retain the maximum measurement detail in case of any need to correct rogue measurements, but have set their station logging interval at a longer time so that the station does not overwrite the memory locations over the longest period they might be away.  In this case, the frequency of logged information will change between the periods Cumulus is running and the catch-up readings from station logger when it is restarted, and all averages calculated will be less accurate if Cumulus is not running all the time.
|-
|-
|UseDataLogger=1
|UseDataLogger=1
|Cumulus 1.x.y: Selected in the Station Configuration Screen Settings block.
|{{Version badge 1}}Cumulus 1.x.y: Selected in the Station Configuration Screen Settings block.
 
[[File:Badge vMx.png]]Cumulus MX: This parameter (attribute=value) is added directly to the file in the [Station] section if you want to change the default, it does not appear on the settings screen.
Cumulus MX: This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on the settings screen.
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
Line 270: Line 321:
*2 = km/h
*2 = km/h
*3 = kts
*3 = kts
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. dm/s for Fine Offset) and so the values are converted to any of the 4 listed during processing
These are the labels that Cumulus applies on its screens and web pages, most weather stations can only output in one unit (e.g. dm/s for Fine Offset). If that is not the unit selected here, Cumulus will ensure the values are converted to that selected from the 4 listed during processing.
|-
|-
|PressureUnit=0  
|PressureUnit=0  
Line 277: Line 328:
*1 = hPa
*1 = hPa
*2 = in
*2 = in
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. hPa for Fine Offset) and so the values are converted to any of the 3 listed during processing
These are the labels that Cumulus applies on its screens and web pages, most weather stations can only output in one unit (e.g. hPa for Fine Offset). If that is not the unit selected here, Cumulus will ensure the values are converted to that selected from the 3 listed during processing
|-
|-
|RainUnit=0  
|RainUnit=0  
Line 283: Line 334:
*0 = mm
*0 = mm
*1 = in
*1 = in
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. dm for Fine Offset) and so the values are converted to either of the 2 listed during processing
These are the labels that Cumulus applies on its screens and web pages, most weather stations can only output in one unit (e.g. dm for Fine Offset). If that is not the unit selected here, Cumulus will ensure the values are converted to either of the 2 listed during processing
|-
|-
|TempUnit=0  
|TempUnit=0  
Line 289: Line 340:
*0 = Celsius
*0 = Celsius
*1 = Fahrenheit
*1 = Fahrenheit
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. for Fine Offset a positive integer (a 12 bit value) that uses 0 at -40 degrees Celsius/Fahrenheit and 500 at 10 degrees Celsius/50 degrees Fahrenheit; i.e. you get the actual temperature in Celsius by subtracting 400 and dividing by 10) and so the values are converted to either of the 2 listed during processing
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. for Fine Offset a positive integer (a 12 bit value) that uses 0 at -40 degrees Celsius/Fahrenheit and 500 at 10 degrees Celsius/50 degrees Fahrenheit; i.e. you get the actual temperature in Celsius by subtracting 400 and dividing by 10). If that is not the unit selected here, Cumulus will ensure the values are converted to either of the 2 listed during processing
|-
|-
|LocName=  
|LocName=  
|Location Name (as entered on the Station settings screen within '''Configuration''' menu) - used for title of tab in browser and main heading on each standard web page
|A '''Name''' for the location (as entered on the same screen as other parameters) - used for title of tab in browser and main heading on each standard web page
|-
|-
|LocDesc=  
|LocDesc=  
|Location Description (as entered on the Station settings Screen within '''Configuration''' menu) - inserted after 'Welcome to ' on 'Now' web page.
|A '''Description''' for the location (as entered on the same screen as other parameters) - inserted after 'Welcome to ' on 'Now' web page.
|-
|-
|StartDate=13/08/2009  
|StartDate=13/08/2009  
|This parameter is automatically inserted into cumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application. See [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|This parameter is automatically inserted into Cumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application (whichever flavour). See [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|-
|-
|CreateWxnowTxt=0
|CreateWxnowTxt=0
Line 308: Line 359:
|This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on a configuration screen. If the parameter is not included in the file, the default value is assumed.
|This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on a configuration screen. If the parameter is not included in the file, the default value is assumed.
*0= (default) turn off creation of WebTags.txt file (stored in main Cumulus folder)
*0= (default) turn off creation of WebTags.txt file (stored in main Cumulus folder)
*1= create WebTags.txt file when Cumulus is restarted (contains an unordered list of all the web tags Cumulus can recognise)
*1= create WebTags.txt file when Cumulus is restarted (contains an unordered list of all the web tags your Cumulus build will recognise and process)
|-
|-
|LastLoggerDownload=13/08/2008 12:48:52  
|LastLoggerDownload=13/08/2008 12:48:52  
|The date/time of the last down load from your weather station '''(note: no longer used, so only present if you used an earlier Cumulus version)'''; see [[Webtags#Miscellaneous|
|The date/time of the last down load from your weather station '''(note: no longer used, so only present if you used an early Cumulus 1 version)'''; Later Cumulus 1 builds and all 2 and MX builds use [[today.ini] to track date/time. This date/time (regardless of whether this parameter is present) is available on your website by using [[Webtags#Miscellaneous|
<#LastDataReadT>]] for similar functionality
<#LastDataReadT>]]
|-
|-
|RainSeasonStart=1
|RainSeasonStart=1
|Selected in the Station Configuration Screen Settings block. The month (1 to 12) of the year that is used as the start of the annual 'rain season'. Default = 1 meaning January.
|Selected in the same settings page as other parameters. The month (1 to 12) of the year that is used as the start of the annual 'rain season'. Default = 1 meaning January.
|-
|-
|YTD[[FAQ#My_monthly_and.2For_annual_rainfall_totals_are_wrong|rain]]=0  
|YTD[[FAQ#My_monthly_and.2For_annual_rainfall_totals_are_wrong|rain]]=0  
|Selected in the Station Configuration Screen Settings block. Year to date correction if starting part way through rainfall year (see previous parameter). Value is entered in your current [[Rain_measurement]] units. Default is 0.
|Selected in the same settings page as other parameters. Year to date correction if starting part way through rainfall year (see previous parameter). Value is entered in your current [[Rain_measurement]] units. Default is 0.
|-
|-
|YTDrainyear=0  
|YTDrainyear=0  
|Selected in the Station Configuration Screen Settings block. The year for which the previous parameter (YTDrain) is to be applied. Default is 0 meaning not applied to any year.
|Selected in the same settings page as other parameters. The year for which the previous parameter (YTDrain) is to be applied. Default is 0 meaning not applied to any year. Note if you selected a month other than January in "RainSeasonStart" parameter,  you will need to change this "YTDrainyear" when the calendar year changes during your first 'rain season' and change it to 0 when you reach the same "RainSeasonStart" month and start your second 'rain season'.
|-
|-
|RainDayThreshold=-1
|RainDayThreshold=-1
Line 330: Line 381:
|-
|-
|UseCumulusForecast=0  
|UseCumulusForecast=0  
|From the Station Configuration Screen Forecast block, if selected Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, or as an alternative to the one supplied by your station.  See the [[Forecast webtag]] for more information.  See next parameter for interval between forecast updates.
|Selected in the same settings page as other parameters, if selected Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, or as an alternative to the one supplied by your station.  See the [[Forecast webtag]] for more information.  See next parameter for interval between forecast updates.
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled
*1 = Enabled
|-
|-
|HourlyForecast=0
|HourlyForecast=0
|From the Station Configuration Screen Forecast block 'update hourly' parameter, applies only if Cumulus is set (see previous parameter) to generate a forecast (see [[FAQ#My_forecast_says_.22Not_available.22]]),
|Selected in the same settings page as other parameters, applies only if Cumulus is set (see previous parameter) to generate a forecast (see [[FAQ#My_forecast_says_.22Not_available.22]]),
*0 = Disabled, (default) Cumulus will use Zambretti Forecaster every time it updates the web pages.
*0 = Disabled, (default) Cumulus will use Zambretti Forecaster every time it updates the web pages.
*1 = Enabled, this setting causes the forecast to be updated only once an hour (on the hour).  
*1 = Enabled, this setting causes the forecast to be updated only once an hour (on the hour).  
|-
|-
|UseCumulusPresstrendstr=0  
|UseCumulusPresstrendstr=0  
|Set in the Station Configuration Screen Settings block. If selected Cumulus will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast. Note that some stations do not supply this anyway, so setting this has no effect (Cumulus always generates the names for those stations).  
|Selected in the same settings page as other parameters.   If selected Cumulus will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast. Note that some stations do not supply this anyway, so setting this has no effect (Cumulus always generates the names for those stations).  
*0 = Disabled
*0 = Disabled
*1 = Enabled
*1 = Enabled
Line 348: Line 399:
|-
|-
|FCpressinMB=1  
|FCpressinMB=1  
|Forecast pressure unit as selected  in the '''Forecast''' block in the bottom right of ''Station'' settings screen off '''Configuration''' menu. The units you use here are not related to the units you use for pressure (PressureUnit=x parameter earlier) in Cumulus; the option is given here simply as a convenience for the next two parameters.
|Selected in the same settings page as other parameters. The units you use here are not related to the units you use for pressure (PressureUnit=x parameter earlier) in Cumulus; the option is given here simply as a convenience for the next two parameters.
*0 = inches of mercury
*0 = inches of mercury
*1 = mb
*1 = mb
|-
|-
|FClowpress=950  
|FClowpress=950  
|Low Pressure extreme limit (in units specified by previous parameter) as entered in the '''Forecast''' block in the bottom right of ''Station'' settings screen off '''Configuration''' menu, using either millibars or inches of mercury.  Default is 950mb
|Low Pressure extreme limit (in units specified by previous parameter). Selected in the same settings page as other parameters in the '''Forecast''' area, using either millibars or inches of mercury.  Default is 950mb
|-
|-
|FChighpress=1050  
|FChighpress=1050  
|High Pressure extreme limit as entered in the same Forecast block as last 2 parameters. Default is 1050mb
|High Pressure extreme limit as entered in the same Forecast area as last 2 parameters. Default is 1050mb
|-
|-
|CloudBaseInFeet=1  
|CloudBaseInFeet=1  
|Cloud base measurement unit as selected in the display screen within configuration menu
|Cloud base measurement unit as selected in same screen as other parameters
*0 = metres
*0 = metres
*1 = feet (default)
*1 = feet (default)
Line 368: Line 419:
|-
|-
|Logging=1
|Logging=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Add to cumulus.ini [Station] section to have Cumulus start with [[debug]] logging on
|This parameter (attribute=value) determines if when you next start Cumulus it will send enhanced information to the [[debug]] file. Set it to 1  to enable this.
Debugging can also be switched on while you are running Cumulus of any flavour. By default, enhanced debugging will stop when you exit Cumulus and the value will be reset to 0.
|-
|-
|SpecialLog=1
|SpecialLog=1
|This optional parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default of no special log is assumed.  Add this entry to start updating a file called 'speciallog.txt' in the data folder with the following fields:
|This optional parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default of no special log is assumed.  Add this entry to start updating a file called 'speciallog.txt' in the data folder with the following fields:


date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dewpoint,outside temp,outside humidity,outside dewpoint
date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dew point,outside temp,outside humidity,outside dew point


See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
Line 394: Line 446:


==== Davis family specific: ====
==== Davis family specific: ====
"The DLL" is a Windows Dynamic Link Library supplied by Davis for third parties to use when writing software for Davis stations.
{{Version badge 1}}These settings apply to Cumulus 1.9.x, check with release notes for your version and previous versions to see all settings applicable to any earlier version you use. '''Some''' of the settings below apply to Cumulus MX too, but check the MX support forum to check if individual ones do or do not apply.
It handles fetching data from the console, and does all kinds of useful things like converting the data into the units you require.
 
These settings apply to Cumulus 1.9.x, check with release notes for your version and previous versions to see all settings applicable to any earlier version you use.
 
'''ADDITIONAL CUMULUS MX parameters - see [[Cumulus.ini_%28Beta%29#Davis_family_specific:|beta page here]]'''. Some of the settings below apply to Cumulus MX too, but check the MX support forum.
* For example 'Port=' is specific to Cumulus 1.
* For example 'Port=' is specific to Cumulus 1.
* 'DavisRainCollectorModel' is not available to Cumulus MX users as that does not use the DLL interface.  
* 'DavisRainCollectorModel' is not available to Cumulus MX users as that does not use the DLL interface.  
* At time of writing "RestartIfDataStops" is not available to MX users.
* At time of writing "RestartIfDataStops" is not available to MX users.
"The DLL" is a Windows Dynamic Link Library supplied by Davis for third parties to use when writing software for Davis stations. It handles fetching data from the console, and does all kinds of useful things like converting the data into the units you require.
'''ADDITIONAL CUMULUS MX parameters - see [[Cumulus.ini_%28Beta%29#Davis_family_specific:|beta page here]]'''.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 422: Line 474:
*4 = 'other' inch
*4 = 'other' inch
*5 = 'other' mm
*5 = 'other' mm
Davis have not documented what calculations the DLL does for options 4 and 5.  If this line is not included in '''cumulus.ini''' the DLL will use whatever type the station tells it to use
{{Version badge 1}}Davis have not documented what calculations the DLL does for options 4 and 5.  If this line is not included in '''cumulus.ini''' the DLL will use whatever type the station tells it to use
|-
|-
|ForceVPBarUpdate=0  
|ForceVPBarUpdate=0  
Line 448: Line 500:
|-
|-
|Port=0
|Port=0
|Set this in the Station Configuration Screen '''Serial Port''' block.
|{{Version badge 1}}Set this in the Station Configuration Screen '''Serial Port''' block.
Identifies COM Port used if Davis type is serial. Default is 0.
Identifies COM Port used if Davis type is serial. Default is 0.
|-
|-
Line 477: Line 529:
'''Note for MX''', use of the LOOP2 (see [[Cumulus.ini_(Beta)#Section:_Station| here]]) means s.l.p. can be obtained from the Davis station.
'''Note for MX''', use of the LOOP2 (see [[Cumulus.ini_(Beta)#Section:_Station| here]]) means s.l.p. can be obtained from the Davis station.


'''The following note applies to Cumulus 1.x.x:''' The station does not provide this value directly, nor the station pressure, so Cumulus 1.x.x has to read some extra data once a minute in order to do the calculation. This can take several seconds, so it means that a 'normal' data reading may be missed.  
{{Version badge 1}}'''The following note applies to Cumulus 1.x.x:''' The station does not provide this value directly, nor the station pressure, so Cumulus 1.x.x has to read some extra data once a minute in order to do the calculation. This can take several seconds, so it means that a 'normal' data reading may be missed.  


If you don't use CWOP, or you are happy for Cumulus to send Sea-Level pressure to CWOP (the difference is small unless you are at high altitude), set this value to 0.
If you don't use CWOP, or you are happy for Cumulus to send Sea-Level pressure to CWOP (the difference is small unless you are at high altitude), set this value to 0.
Line 488: Line 540:
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
|{{Version badge 1}}This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
Cumulus 1 attempts to restart itself if it has had no data from the station for 60 seconds. Davis stations can use this option explained in the [[#La_Crosse_specific:|La Crosse]] table if Cumulus sometimes fails to read information from the logger. As it says in the help, it may not fix the connection problem, but at least it stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
Cumulus 1 attempts to restart itself if it has had no data from the station for 60 seconds. Davis stations can use this option explained in the [[#La_Crosse_specific:|La Crosse]] table if Cumulus sometimes fails to read information from the logger. As it says in the help, it may not fix the connection problem, but at least it stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
|}
|}
Line 505: Line 557:
|-
|-
|RestartIfUnplugged=0  
|RestartIfUnplugged=0  
|This is set in the settings frame on the Station settings screen off the configuration menu.
|{{Version badge 1}}This is set in the settings frame on the Station settings screen off the configuration menu.
*0 = Disabled, default i.e. deselected on the Station Configuration Screen
*0 = Disabled, default i.e. deselected on the Station Configuration Screen
*1 = Enabled, Cumulus will restart if it detects that a Fine Offset station is unplugged. '''Note:''' Unless the station has been manually plugged in again, a Cumulus restart has no benefit; normally the station should be checked to be plugged in before Cumulus is ever started and the station then left plugged in.
*1 = Enabled, Cumulus will restart if it detects that a Fine Offset station is unplugged. '''Note:''' Unless the station has been manually plugged in again, a Cumulus restart has no benefit; normally the station should be checked to be plugged in before Cumulus is ever started and the station then left plugged in.
Line 550: Line 602:
Got a pressure problem with a Fine Offset station when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero?
Got a pressure problem with a Fine Offset station when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero?


Tell Cumulus 1.?.? (''not yet coded in MX'') what offset to use, by using an external text editor to insert this parameter where x.y is your pressure offset in  in mb or hPa [i.e. your station (absolute) pressure subtracted from the sea-level (relative) pressure].
Tell Cumulus what offset to use, by using an external text editor to insert this parameter where x.y is your pressure offset in  in mb or hPa [i.e. your station (absolute) pressure subtracted from the sea-level (relative) pressure].


|}
|}
Line 618: Line 670:
|}
|}


 
==== Reading File instead of weather station  ====
'''Requiring Cumulus to read Easyweather.dat instead of a station directly perhaps for Stations not recognised by Cumulus'''
{{Version badge 1}}'''Requiring Cumulus to read Easyweather.dat instead of a station directly perhaps for Stations not recognised by Cumulus'''
*Stations not recognised by Cumulus ''may'' be set to create an [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather_Format]] file. For these the first two (or three) parameters below are mandatory.
*Stations not recognised by Cumulus ''may'' be set to create an [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather_Format]] file. For these the first two (or three) parameters below are mandatory.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 699: Line 751:
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|This line needs to be added in the [Station] section of the Cumulus.ini.  
|{{Version badge 1}}This line needs to be added in the [Station] section of the Cumulus.ini.  
Option for Cumulus 1, it attempts to restart itself if it has had no data from a La Crosse station for 60 seconds i.e. if data from station stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
Option for Cumulus 1, it attempts to restart itself if it has had no data from a La Crosse station for 60 seconds i.e. if data from station stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
*0 = Disabled (default)
*0 = Disabled (default)
Line 769: Line 821:
|}
|}


== Section: Offsets ==
=== Section: Offsets ===
Set most of these parameters using the '''Configuration''' menu and ''Calibration'' screen, the exception is 'TempMult2'.
Set most of these parameters using the '''Configuration''' menu and ''Calibration'' screen, the exception is 'TempMult2'.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 823: Line 875:
|}
|}


== Section: Web Site ==
=== Section: Web Site ===
All parameters edited in the Internet Configuration screen ''Sites/Options tab'' Web Site block.
All parameters edited in the Internet Configuration screen ''Sites/Options tab'' Web Site block.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 840: Line 892:
|}
|}


== Section: FTP site ==
=== Section: FTP site ===
NOTE: The word site should be in lower case as shown in left-hand column heading and above.
NOTE: The word site should be in lower case as shown in left-hand column heading and above.


Line 1,082: Line 1,134:
|}
|}


== Section: Display ==
=== Section: Display ===
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.
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.


The only setting used in this section by Cumulus MX is "NumWindRosePoints"
The only settings used in this section by Cumulus MX are "NumWindRosePoints" and those for extras.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,096: Line 1,148:
|-
|-
|Heading=My Weather  
|Heading=My Weather  
|Title Heading on the Main Screen. Set in the Display Configuration Screen General block
|{{Version badge 1}}Title Heading on the Main Screen. Set in the Display Configuration Screen General block
|-
|-
|SavePosition=0
|SavePosition=0
|Set in the Display Configuration Screen General block.
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*0= default, the main window will be displayed in the middle of the main or only monitor connected to your pc
*0= default, the main window will be displayed in the middle of the main or only monitor connected to your pc
*1= the current position of the main window will be saved to [[Cumulus.ini#Section:_MainForm]] when Cumulus closes, and the window will open again at that position the next time Cumulus starts.
*1= the current position of the main window will be saved to [[Cumulus.ini#Section:_MainForm]] when Cumulus closes, and the window will open again at that position the next time Cumulus starts.
|-
|-
|StartMinimised=0
|StartMinimised=0
|Set in the Display Configuration Screen General block.
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*0= default, the main window will be displayed on the main or only monitor connected to your pc
*0= default, the main window will be displayed on the main or only monitor connected to your pc
*1= If set to 1, Cumulus will start with the main window minimised, either to the system tray or the task bar, depending on the 'MinimizeToTray' setting (see next parameter).
*1= If set to 1, Cumulus will start with the main window minimised, either to the system tray or the task bar, depending on the 'MinimizeToTray' setting (see next parameter).
|-
|-
|MinimizeToTray=0  
|MinimizeToTray=0  
|Set in the Display Configuration Screen General block
|{{Version badge 1}}Set in the Display Configuration Screen General block
*0 = Disabled (default), Cumulus will minimise to the task bar  
*0 = Disabled (default), Cumulus will minimise to the task bar  
*1 = Enabled, causes Cumulus to appear as an icon in the system tray when it is minimized. The icon will flash if a record is broken or an error occurs. Double click on the icon to restore the main window (or right click on the icon and use the pop-up menu).
*1 = Enabled, causes Cumulus to appear as an icon in the system tray when it is minimized. The icon will flash if a record is broken or an error occurs. Double click on the icon to restore the main window (or right click on the icon and use the pop-up menu).
|-
|-
|ForecastCentred=0  
|ForecastCentred=0  
|Set in the Display Configuration Screen General block.
|{{Version badge 1}}|Set in the Display Configuration Screen General block.
*0 = Disabled, (default) Forecast appears left justified on main screen below sun and moon details
*0 = Disabled, (default) Forecast appears left justified on main screen below sun and moon details
*1 = Enabled, Forecast appears centred horizonatally on main screen below sun and moon details
*1 = Enabled, Forecast appears centred horizonatally on main screen below sun and moon details
|-
|-
|FontColour=4227327  
|FontColour=4227327  
|Set on the colour setting screen in the Configuration menu.  Decimal code for the screen font color
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the screen font color
|-
|-
|BackColour=12632256  
|BackColour=12632256  
|Set on the colour setting screen in the Configuration menu.  Decimal code for the application background color
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the application background color
|-
|-
|HeadingColour=10485760  
|HeadingColour=10485760  
|Set on the colour setting screen in the Configuration menu.  Decimal code for the screen heading color
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the screen heading color
|-
|-
|ClockDigitColour=4227327
|ClockDigitColour=4227327
Line 1,131: Line 1,183:
|-
|-
|ClockColour=16777201  
|ClockColour=16777201  
|Set on the colour setting screen in the Configuration menu.  Decimal code for the main screen clock background color
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the main screen clock background color
|-
|-
|TwelveHourClock=0  
|TwelveHourClock=0  
|Set by left click on clock on main screen
|{{Version badge 1}}Set by left click on clock on main screen
*0 = 24Hr clock mode
*0 = 24Hr clock mode
*1 - 12 Hr am/pm clock mode
*1 - 12 Hr am/pm clock mode
Line 1,342: Line 1,394:
|}
|}


== Section: Graphs ==
=== Section: Graphs ===
Set many of these parameters using '''Configuration''' menu and either ''Display'' (Graphs block) or ''Colours'' screens.
Set many of these parameters using '''Configuration''' menu and either ''Display'' (Graphs block) or ''Colours'' screens.
Set the colours of the data lines on graphs/charts and Select whether to plot particular data by using '''View''' menu and ''Graphs'' option, then right click over the relevant graph.
Set the colours of the data lines on graphs/charts and Select whether to plot particular data by using '''View''' menu and ''Graphs'' option, then right click over the relevant graph.
Line 1,594: Line 1,646:
|SAGuvindexaxis=L
|SAGuvindexaxis=L
|
|
|-
|-
|SAG3D=0
|SAG3D=0
|
|
|-
|-
|SAGgradientback=0
|SAGgradientback=0
|
|
|-
|-
|SAGleftgrid=1
|SAGleftgrid=1
|
|
|-
|-
|SAGrightgrid=1
|SAGrightgrid=1
|
|
|}
|}
 
=== Section: Alarms ===
For MX, there is a default path "\CumulusMX\interface\sounds". Edit on '''Settings''' tab, '''Alarms''' screen.


== Section: Alarms ==
{{Version badge 1}}Set these using the '''Edit''' menu, ''Alarms'' screen.
Set these using the '''Edit''' menu, ''Alarms'' screen.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,790: Line 1,844:
|}
|}


== Sections dealing with interfaces to external sites ==
=== Sections dealing with interfaces to external sites ===


=== Section: WUnderground ===
==== Section: WUnderground ====
Set in the Internet Configuration Screen sites/Options tab
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,902: Line 1,956:
|}
|}


=== Section: [[Twitter.txt|Twitter]] ===
==== Section: [[Twitter.txt|Twitter]] ====
Set in the Internet Configuration Screen sites/Options tab
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,933: Line 1,987:
|}
|}


===Section: PWSweather ===
==== Section: PWSweather ====
Set in the Internet Configuration Screen sites/Options tab
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,973: Line 2,027:
|}
|}


=== Section: APRS ===
==== Section: APRS ====
Set in the Internet Configuration Screen sites/Options tab
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,010: Line 2,064:
|}
|}


=== Section: WOW ===
==== Section: WOW ====
Set in the Internet Configuration Screen sites/Options tab
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,048: Line 2,102:
|}
|}


=== Section: Weatherbug ===
==== Section: Weatherbug ====
Set in the Internet Configuration Screen sites/Options tab
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,086: Line 2,140:
|}
|}


=== Section: xAP ===
==== Section: xAP ====
Set in the Internet Configuration Screen sites/Options tab
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,108: Line 2,162:
|}
|}


== 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).
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).


Line 2,191: Line 2,245:
|}
|}


== Section: Solar ==
=== Section: Solar ===
Set mostly in solar block at foot of Station Settings screen of Configuration menu.
Set mostly in solar block at foot of Station Settings screen of Configuration menu.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,215: Line 2,269:
|UseBlakeLarsen=0
|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.
| 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.
|}
== Section: MainForm ==
This section will appear in a file that is always called ''Cumulus.ini'', but may be found in two locations.  It applies to [[File:Badge v1.png]]Cumulus 1.
*One file with this section is stored in the reports sub-directory where it stores the position of your last saved NOAA screen.
*If you have set 'Save main window position' on Display settings screen, this section appears in the Cumulus.ini file found in same directory as cumulus.exe, where it stores the position of the main Cumulus screen on your monitor.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[MainForm]
|style="background:lightgray;"|Section name - the following parameters relate to the Cumulus or NOAA screen position.
|-
|Left=100
|The last saved Cumulus main or NOAA screen position, in pixels from the left-hand edge of the screen.
|-
|Top=50
|The last saved Cumulus main or NOAA screen position, in pixels from the top edge of the screen
|}
|}
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/4952...4993"

Navigation menu