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:27, 19 November 2019

8,883 bytes added ,  17:27, 19 November 2019
→‎Section: Graphs
m (→‎Section: FTP Site: adding new parameters made available from v1.9.3 (previously missing here), making all consistent especially with regard to how set from configuration menu)
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category: Configuration_Files]]
[[Category: Configuration_Files]]
= Initial Configurations =
= Initial Configurations =
The main cumulus.ini [[:Category:Configuration Files| configuration file]] is located in the directory in which you installed Cumulus.exe. It is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up.  Cumulus re-writes the contents of the application configuration screens to the file when it shuts down.
The main configuration file is ''Cumulus.ini'' and located in the directory in which you installed Cumulus.exe. If you renamed the executable file to say ''Cumulus1.exe'', then this main configuration file takes that name i.e. ''Cumulus1.ini''.  '''For Cumulus MX''', both file-names must start with a capital letter, and all the characters used within the configuration file must be within ASCII range.


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 '''re-writes''' the contents of the application configuration screens to the file when it ''shuts down'', so you will see the file shows as 'modified date' the last time that Cumulus was shut down.  


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 various external websites.
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.
 
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.
 
If you are using an old 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.
[[Category:Configuration Files]]
 
= Upgrading to New Build =
Installing a new build of Cumulus (whatever version) over the existing installation does not affect this settings file. No build of Cumulus contains a 'Cumulus.ini' file. If Cumulus software detects a 'Cumulus.ini' when it starts, it looks in that for settings; if it does not find the file, then Cumulus will expect you to tell it some settings, others have defaults. See Cumulus Help, release announcement, and other provided documentation for more.


If you are using an old version, then checking the release information may be advisable to identify the sections applicable to your build and the parameters allowed within those sections may be a subset of those listed below.
= 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.
Line 22: Line 29:


== Beta builds ==
== Beta builds ==
If you are using a beta build, there may be changes to the information shown below with additional sections and/or additional parameters (attribute=value) under test.  Brief details of such changes will be given in the support forum annoucement for the relevant build. New sections and/or attributes and/or values for beta versions of Cumulus are not listed here until the version becomes 'live' however there is a [[Cumul.ini_(Beta)|page]] that details the additional parameters available in the Beta version once they have become established, but for details of beta tests see  [http://sandaysoft.com/forum/viewforum.php?f=2 the forum].
'''CURRENTLY CUMULUS MX specific parameters are listed on [[Cumulus.ini (Beta)|Cumulus.ini(Beta)]] page.'''
 
If you are using a beta build, there may be changes to the information shown below with additional sections and/or additional parameters (attribute=value) under test.  Brief details of such changes will be given in the support forum announcement for the relevant build. New sections and/or attributes and/or values for beta versions of Cumulus are not listed here until the version becomes 'live' however there is a [[Cumulus.ini_(Beta)|page]] that details the additional parameters available in the Beta version once they have become established, but for details of beta tests see  [https://cumulus.hosiene.co.uk/viewforum.php?f=2 the forum].


= Editing the file =
= Editing the file =


== Initialisation ==
== Initialisation ==
When Cumulus is run for the very first time, the ''Station settings'' screen within the '''Configuration''' menu is displayed, so that the basic minimum settings can be entered into Cumulus.ini. Should you accidentally delete Cumulus.ini this would happen again, so it is always best to take a backup of the complete Cumulus directory and sub-directories so nothing is lost in such a situration.   
When Cumulus 1.x.y is run for the very first time, the ''Station settings'' screen within the '''Configuration''' menu is displayed, so that the basic minimum settings can be entered into a 'Cumulus.ini' that it will then create. Should you accidentally delete Cumulus.ini this would happen again, so it is always best to take a backup of the complete Cumulus directory and sub-directories so nothing is lost in such a situation.   


See [[Setup]] for further advice, noting in particular that some settings (such as units, date/time formats) should stay unchanged.
See [[Setup]] for further advice, noting in particular that some settings (such as units, date/time formats) should stay unchanged.
== Settings controlled by application ==
== Settings controlled by application ==
Many configuration parameter lines are changed from the various application edit, view, or configuration screens, and so making any amendments using those screens should ensure your replacement values are acceptable. You should never edit these parameter lines directly in the file ''while Cumulus is running'', as when Cumulus shuts down it will replace your amendments to these parameters with the contents of the relevant application Edit/View/Configuration screens.
Many configuration parameter lines are changed from the various application edit, view, or configuration screens, and so making any amendments using those screens should ensure your replacement values are acceptable. You should never edit these parameter lines directly in the file ''while Cumulus is running'', as when Cumulus shuts down it will replace your amendments to these parameters with the contents of the relevant application Edit/View/Configuration screens.
Line 46: Line 56:
== Introduction ==
== Introduction ==
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.
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.
The section called "[FTP site]" should obey that use of capitals and lower-case.


== Section: Station ==
== Section: Station ==
Line 132: Line 143:
|-
|-
|AvgBearingMinutes=N
|AvgBearingMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, with this parameter N is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing. Without it, the default = 10. See next parameter for behavoir when calm.
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, with this parameter N is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing. Without it, the default sampling time = 10 minutes. Note the max number of wind samples stored by Cumulus is 720, so the maximum effective value for N for Fine Offset stations that are read every 10 seconds is 120 (2 hours) while for Davis stations that are sampled every 2 to 3 seconds the maximum effective value is only about 30 (minutes).
See next parameter for behavoir when calm.
|-
|-
|UseZeroBearing=0  
|UseZeroBearing=0  
|Set this in the Station Configuration Screen Settings block.
|Set this in the Station Configuration Screen Settings block.
*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
*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  
Line 151: Line 163:
|-
|-
|UseWindChillCutOff=1
|UseWindChillCutOff=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Purpose is to disable 'calculate [[Wind chill]] only if temperature less than 10°C rule'.
|This 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 value is assumed.  Purpose is to disable 'calculate [[Wind chill]] only if temperature less than 10°C rule'.
*0 = Disabled, Cumulus will use wind speed to determine the wind chill ignoring the temperature criterion
*0 = Disabled, Cumulus will use any wind speed of 3 mph or more, to modify the temperature, and determine the wind chill ignoring the temperature criterion
*1 = Enabled (default), Cumulus will use both temperature and wind speed criterions to determine if wind chill applies.
*1 = Enabled (default), Cumulus will use both 10°C temperature and 3  mph wind speed criterions to determine if wind chill applies.
Note if your station is a type that supplies wind chill to Cumulus; that ''CalculatedWC=1'' is needed for this setting to have any effect [i.e. you need to set Cumulus (see parameter directly above) to calculate the wind chill as this setting cannot change how your weather station calculates wind chill].
Note if your station is a type that supplies wind chill to Cumulus; that ''CalculatedWC=1'' is needed for this setting to have any effect [i.e. you need to set Cumulus (see parameter directly above) to calculate the wind chill as this setting cannot change how your weather station calculates wind chill].
|-
|-
|ChillHourThreshold=45
|ChillHourThreshold=45
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The temperature threshold is specified in the units that you use in Cumulus (see [[Heat/cold_degree_days_and_Chill_hours]]).  The default is 45 degrees Fahrenheit (or just over 7 degrees Celsius) if the parameter has not been included.
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The temperature threshold is specified in the units that you use in Cumulus (see [[Heat/cold_degree_days_and_Chill_hours]]).  The default is exactly 45 degrees Fahrenheit (or exactly 7 degrees Celsius depending on which units you use) if the parameter has not been included.
|-
|-
|ChillHourSeasonStart=10
|ChillHourSeasonStart=10
Line 173: Line 185:
|-
|-
|SnowDepthHour=9
|SnowDepthHour=9
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line needs to be added in the [Station] section of the Cumulus.ini, it is the [[Weather_Diary|Snow lying/falling]] roll over time (time when yesterday's values in log.xml are forgotten) - Allowed values are 0 to 23 and represent the time to the nearest hour that snow depth measurements are taken.
|This 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 value is assumed.  This line needs to be added in the [Station] section of the Cumulus.ini, it is the [[Weather_Diary|Snow lying/falling]] roll over time (time when yesterday's values in log.xml are forgotten) - Allowed values are 0 to 23 and represent the time to the nearest hour that snow depth measurements are taken.
*0 = midnight (default)
*0 = midnight (default)
*9 = 9am,
*9 = 9am,
Line 209: Line 221:
|-
|-
|UseDataLogger=1
|UseDataLogger=1
|Selected in the Station Configuration Screen Settings block.
|Cumulus 1.x.y: Selected in the Station Configuration Screen Settings block.
 
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 250: Line 264:
|-
|-
|CreateWxnowTxt=0
|CreateWxnowTxt=0
|This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on a configuration screen.
|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= turn off creation of wxnow.txt file (stored in main Cumulus folder)
*0= turn off creation of wxnow.txt file (stored in main Cumulus folder)
*1= (default) create wxnow.txt file (an alternative way to get data to CWOP/APRS)
*1= (default) create wxnow.txt file (an alternative way to get data to CWOP/APRS)
|-
|-
|ListWebTags=0
|ListWebTags=0
|This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on a configuration screen.
|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 Cumulus can recognise)
Line 273: Line 287:
|-
|-
|RainDayThreshold=-1
|RainDayThreshold=-1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The threshold value which the daily rainfall has to equal or exceed for the day to be considered a 'rain day'. Default -1 = 0.2mm or 0.01in. Value is entered in your current [[Rain_measurement]] units.
|This 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 value is assumed.  The threshold value which the daily rainfall has to equal or exceed for the day to be considered a 'rain day'. Default -1 = 0.2mm or 0.01in. Value is entered in your current [[Rain_measurement]] units.
|-
|-
|NoFlashWetDryDayRecords=1
|NoFlashWetDryDayRecords=1
Line 294: Line 308:
|-
|-
|FCPressureThreshold=0.1
|FCPressureThreshold=0.1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. It specifies the threshold (in mb per hour averaged over 3-hour period) for a pressure change to count as rising or falling rather than steady when determining the Zambretti forecast. The default is 0.1 mb/hr averaged over the previous three hours.
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. It specifies the threshold (in mb per hour averaged over 3-hour period) for a pressure change to count as rising or falling rather than steady when determining the Zambretti forecast. The default is 0.1 mb/hr averaged over the previous three hours.  If the parameter is not included in the file, the default value is assumed.
|-
|-
|FCpressinMB=1  
|FCpressinMB=1  
Line 313: Line 327:
|-
|-
|RTdisconnectcount=N
|RTdisconnectcount=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. By default, the 'realtime' ftp connection stays connected. You can make it disconnect periodically by adding an Option to periodically disconnect the realtime FTP connection, the theory being that it will not get stuck if the server dies, and will keep trying to reconnect.  
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. By default, the 'realtime' ftp connection stays connected. If the parameter is not included in the file, the default value is assumed.  You can make it disconnect periodically by adding an Option to periodically disconnect the realtime FTP connection, the theory being that it will not get stuck if the server dies, and will keep trying to reconnect.  
N must be a positive integer. For example set N to '60'; it represents the number of realtime ftp uploads between disconnections - so 60 would give an hour if 1 minute realtime interval selected.
N must be a positive integer. For example set N to '60'; it represents the number of realtime ftp uploads between disconnections - so 60 would give an hour if 1 minute realtime interval selected.
|-
|-
Line 319: Line 333:
|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) 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
|-
|-
|ListWebTags=1
|SpecialLog=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Add this entry to make Cumulus create (each time it is restarted) a file called webtags.txt that contains an unsorted list of all the webtags that Cumulus supports
|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
 
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
|-
|-
|ErrorLogSpikeRemoval=0
|ErrorLogSpikeRemoval=0
Line 332: Line 350:
|-
|-
|NoSensorCheck=1
|NoSensorCheck=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  
|This 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 value is assumed. 
The option (for 'incomplete' stations) to disable the sensor check described in this [http://wiki.sandaysoft.com/a/FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads FAQ]
The option (for 'incomplete' stations) to disable the sensor check described in this [https://cumuluswiki.wxforum.net/a/FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads FAQ]
*0 = Sensor check enabled (default)
*0 = Sensor check enabled (default)
*1 = Sensor check disabled
*1 = Sensor check disabled
Line 339: Line 357:


==== 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. It handles fetching data from the console, and does all kinds of useful things like converting the data into the units you require.
"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.
 
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.
* '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.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 367: Line 394:
|SyncDavisClock=0  
|SyncDavisClock=0  
|Set this in the Station Configuration Screen '''Settings''' block where called '''Synchronize station clock'''.
|Set this in the Station Configuration Screen '''Settings''' block where called '''Synchronize station clock'''.
When set, at Cumulus start-up and at 04:00 each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC  
When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
*0 = Disabled, default (as deselected on the Station Configuration Screen)
*0 = Disabled, default (as deselected on the Station Configuration Screen)
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
Line 403: Line 430:
|-
|-
|VP2PeriodicDisconnectInterval=0
|VP2PeriodicDisconnectInterval=0
|Set this in the Station Configuration Screen '''Settings''' block with the ''Discon period'' value. Causes Cumulus to disconnect for the specified number of seconds, once a minute, on the minute (or as close as possible) to allow the Weatherlink IP to connect to the Davis Weatherlink site. Set it to zero to disable, if you are not using the Weatherlink site.
|Set this in the Station Configuration Screen '''Settings''' block with the ''Discon period'' value.
When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.
 
Set it to zero to disable, if you are not using the Weatherlink site.
|-
|-
|DavisCalcAltPress=1
|DavisCalcAltPress=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Davis stations calculate Sea Level Pressure from Station Pressure using a formula based on several parameters such as temperature, humidity, etc, rather than just using altitude as most other stations. CWOP require 'Altimeter Pressure' to be uploaded, i.e. a value calculated simply using altitude.
Davis stations calculate Sea Level Pressure from Station Pressure using a formula based on several parameters such as temperature, humidity, etc, rather than just using altitude as most other stations. CWOP require 'Altimeter Pressure' to be uploaded, i.e. a value calculated simply using altitude. The station does not provide this value directly, nor the station pressure, so Cumulus 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.  
 
'''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.  


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 418: Line 451:
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
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 439: Line 472:
*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.


|-
|EWdisablecheckinit=0
|Add this line to cumulus.ini [Station] section if application gets stuck when Cumulus starts up connected to a Fine Offset (clone) station (added Cumulus version 1.9.2, build 1011).
*0 = Disabled, default, it checks the first two bytes of the Fine Offset station's memory.
*1 = Ignores part of memory (see [[FAQ#When_I_start_Cumulus.2C_I_get_the_error_message_.22The_station_is_not_initialised.22]])
|-
|EWduplicatecheck=0
|Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.
Introduced in version 1.8.5 (b.630) to deal with certain bytes being given the same value in first and second line.  For example one problem is that "55 AA" repeats at the start of the second line of data. Those bytes are only supposed to appear at the start of the first line (or so I am told).
*0 = Disabled, default, Cumulus accepts all bytes from the Fine Offset station's memory.
*1 = Ignores part of memory (see [http://sandaysoft.com/forum/viewtopic.php?f=13&t=393 this forum thread]).
|-
|-
|SyncFOReads=0
|SyncFOReads=0
|This is set in the settings frame on the Station settings screen off the configuration menu.
|This is set in the settings frame on the Station settings screen off the configuration menu.
A Fine Offset station will be writing to its memory every 48 or 60 seconds (depending on model); Cumulus can attempt once a day to identify when this update of memory occurs, and thereafter try not to read the memory at update time, by using what is called a synchronisation mode of operation. See next parameter.
*0 = Synchronisation disabled, default (Cumulus reads the memory without taking into account when memory is being updated)
*0 = Synchronisation disabled, default (Cumulus reads the memory without taking into account when memory is being updated)
*1 = Re-synchronizes once each day, to avoid reading memory at time of memory update
*1 = Re-synchronizes once each day, to avoid reading memory at time of memory update
A Fine Offset station will be writing to its memory every 48 or 60 seconds (depending on model); Cumulus can attempt once a day to identify when this update of memory occurs, and thereafter try not to read the memory at update time, by using what is called a synchronisation mode of operation. See next parameter.
|-
|-
|FOReadAvoidPeriod=3
|FOReadAvoidPeriod=3
|Add this line to cumulus.ini [Station] section if you wish to change the default, this parameter used to fine-tune the previous parameter.
|Add this line to cumulus.ini [Station] section if you wish to change the default, this parameter used to fine-tune the previous parameter.


*3 = default value
Sets the interval (in seconds) during each 48 (or 60 for some models) second of station logging period when Cumulus will avoid reading the station data to try and minimise lock ups. If the clock drifts more than this value in 24 hours, then Cumulus may cause the station to lock up when reading the data. The actual station clock drift gets logged to the diags file when the re-synchronise (see last parameter) takes place, this will give an idea of whether it would be useful to adjust this setting.
Sets the interval (in seconds) during each 48 (or 60 for some models) second of station logging period when Cumulus will avoid reading the station data to try and minimise lock ups. If the clock drifts more than this value in 24 hours, then Cumulus may cause the station to lock up when reading the data. The actual station clock drift gets logged to the diags file when the re-synchronise (see last parameter) takes place, this will give an idea of whether it would be useful to adjust this setting.
*3 = default value
 
|-
|-
|ReportLostSensorContact=0
|ReportLostSensorContact=0
|Add this line to cumulus.ini [Station] section
|Add this line to cumulus.ini [Station] section
Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b.1070)
*0 = reporting off
*0 = reporting off
*1 = reporting on (default)
*1 = reporting on (default)
Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b.1070)


|-
|-
|EWpressureoffset=x.y
|EWdisablecheckinit=0
|Add this line to cumulus.ini [Station] section
|Add this line to cumulus.ini [Station] section if application gets stuck when Cumulus starts up connected to a Fine Offset (clone) station (added Cumulus version 1.9.2, build 1011).
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 what offset to use, by using an external text editor to insert this parameter where x.y is the difference between your station (absolute) and sea-level (relative) pressures, in mb or hPa.
*0 = Disabled, default, it checks the first two bytes of the Fine Offset station's memory.
*1 = Ignores part of memory (see [[FAQ#When_I_start_Cumulus.2C_I_get_the_error_message_.22The_station_is_not_initialised.22]]).
 
 
|-
|-
|EWminpressureMB=900
|EWduplicatecheck=0
|Add this line to cumulus.ini [Station] section
|Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.
Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
Introduced in version 1.8.5 (b.630) to deal with certain bytes being given the same value in first and second line.
*0 = Disabled, default, Cumulus accepts all bytes from the Fine Offset station's memory.
*1 = Ignores part of memory (see [https://cumulus.hosiene.co.uk/viewtopic.php?f=13&t=393 this forum thread]).
For example one problem is that "55 AA" repeats at the start of the second line of data. Those bytes are only supposed to appear at the start of the first line (or so I am told).
 
|-
|-
|EWmaxpressureMB=1200
|EWpressureoffset=x.y
|Add this line to cumulus.ini [Station] section
|Add this line to cumulus.ini [Station] section
Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars)
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].
 
|}
|}


'''Spike Removal'''
==== Spike Removal ====
*The 7 spike removal parameters listed below are adjusted in the frame at the bottom of the ''Calibration'' screen, off '''Configuration''' menu, they have a prefix of EW because they were introduced for dealing with problems seen in the Fine Offset family; the corrections are only applied when Cumulus is reading directly from the station at a very frequent interval, spike removal does not apply when Cumulus is re-started and is transferring observations from the station logger to the Cumulus monthly log.
* 7 of the 10 spike removal parameters listed below are adjusted in the frame at the bottom of the ''Calibration'' screen, off '''Configuration''' menu, they have a prefix of EW because they were introduced for dealing with problems seen in the Fine Offset family; the corrections are only applied when Cumulus is reading directly from the station at a very frequent interval, spike removal does not apply when Cumulus is re-started and is transferring observations from the station logger to the Cumulus monthly log.
*The other 3 spike removal parameters have to be entered directly in cumulus.ini, none of these ones can be set on the 'calibration' screen.
*As Cumulus does not check station type before applying any of these settings, ensure for Davis stations (these do not have spike problems) the spike removal filters are set to the defaults shown below.
*As Cumulus does not check station type before applying any of these settings, ensure for Davis stations (these do not have spike problems) the spike removal filters are set to the defaults shown below.
*However, spike removal correction may be implemented for La Crosse stations, they do have problems with their PC interface, using the same EW filter settings listed below.
*However, spike removal correction may be implemented for La Crosse stations, they can have problems with their PC interface, using the same EW filter settings listed below.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 494: Line 529:
|style="background:lightgray;"|[Station]  
|style="background:lightgray;"|[Station]  
|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.
|-
|EWMaxRainTipDiff=30
|Add this line to cumulus.ini [Station] section
Cumulus (1 and MX) has a configurable threshold for the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips.
Default=30 tips, as each tip represents 0.3mm this is equivalent to 9 mm or just over a third of an inch in 48 seconds.
This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>.
|-
|-
|EWmaxHourlyRain=999
|EWmaxHourlyRain=999
Line 500: Line 541:
Any ''changes in calculated value'', between one calculation and the next, greater than the value specified here will be ignored by Cumulus when it calculates the hourly rain total.
Any ''changes in calculated value'', between one calculation and the next, greater than the value specified here will be ignored by Cumulus when it calculates the hourly rain total.
Cumulus ignores this parameter if the weather station directly supplies this figure to Cumulus. '''999''' is the default indicating no spike removal required.
Cumulus ignores this parameter if the weather station directly supplies this figure to Cumulus. '''999''' is the default indicating no spike removal required.
|-
|-
|EWmaxRainRate=999
|EWmaxRainRate=999
Line 505: Line 547:
A rain rate 'spike removal' filter, ''changes in calculated value'', between one calculation and the next, greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus when it calculates the rain rate.
A rain rate 'spike removal' filter, ''changes in calculated value'', between one calculation and the next, greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus when it calculates the rain rate.
Cumulus ignores this parameter for other makes of weather station (they supply a rain rate to Cumulus). The default value of '''999''' also effectively makes Cumulus ignore spike removal.
Cumulus ignores this parameter for other makes of weather station (they supply a rain rate to Cumulus). The default value of '''999''' also effectively makes Cumulus ignore spike removal.
|-
|-
|EWgustdiff=999.0
|EWgustdiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A wind gust 'spike removal' filter, ''changes in calculated value'' between one calculation and the next, greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus.
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A wind gust 'spike removal' filter, ''changes in calculated value'' between one calculation and the next, greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus.
|-
|-
|EWwinddiff=999.0
|EWwinddiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.. A wind speed  'spike removal' filter, ''changes in calculated value'' between one calculation and the next greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.. A wind speed  'spike removal' filter, ''changes in calculated value'' between one calculation and the next greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus
|-
|-
|EWpressurediff=999.0
|EWpressurediff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A pressure change 'spike removal' filter, ''changes in read value'', from one reading to the next, off any station greater than the value (always mb) specified here (with a default of '''999.0''') will be ignored by Cumulus
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A pressure change 'spike removal' filter, ''changes in read value'', from one reading to the next, off any station greater than the value (always mb) specified here (with a default of '''999.0''') will be ignored by Cumulus
|-
|-
|EWTempdiff=999.0
|EWminpressureMB=900
|Add this line to cumulus.ini [Station] section
Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
 
|-
|EWmaxpressureMB=1200
|Add this line to cumulus.ini [Station] section
Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars).
 
|-
|EWTempdiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A temperature change 'spike removal' filter.
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A temperature change 'spike removal' filter.
Replace default of 999.0 with the maximum difference in degrees Celsius (the units Cumulus uses for all calculations regardless of what you select for display) you are prepared to accept between successive data readings
Replace default of 999.0 with the maximum difference in degrees Celsius (the units Cumulus uses for all calculations regardless of what you select for display) you are prepared to accept between successive data readings.
 
|-
|-
|EWhumiditydiff=999.0
|EWhumiditydiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A humidity change 'spike removal' filter, ''changes in read value'' from any station greater than the value (as %) specified here (with a default of '''999.0''') will be ignored by Cumulus
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A humidity change 'spike removal' filter, ''changes in read value'' from any station greater than the value (as %) specified here (with a default of '''999.0''') will be ignored by Cumulus.
 
|}
|}


Line 537: Line 595:
|This parameter is entered in the Station Configuration Screen Settings block.
|This parameter is entered in the Station Configuration Screen Settings block.
*0= Default, meaning not applicable  
*0= Default, meaning not applicable  
*n= any integer representing Easyweather version 6.2, or earlier, logging interval in minutes  (used for reading single latest observations from [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather]] software output).
*n= any positive decimal value representing Easyweather version 6.2, or earlier, logging interval in minutes  (used for reading single latest observations from [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather]] software output). Note to specify seconds, use decimal minutes, e.g. 30 seconds = 0.5
'''Note:''' If you have not set Station '''Type''' to 4,  then Cumulus ignores this parameter, i.e. it only applies if Cumulus needs to know how often to read a new record from the easyweather.dat file.
'''Note:''' If you have not set Station '''Type''' to 4,  then Cumulus ignores this parameter, i.e. it only applies if Cumulus needs to know how often to read a new record from the easyweather.dat file.
|-
|-
Line 583: Line 641:


==== La Crosse specific: ====
==== La Crosse specific: ====
'''NOT AVAILABLE IN CUMULUS MX - at time of writing "RestartIfDataStops" is not available'''
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 603: Line 662:
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|This line needs to be added in the [Station] section of the Cumulus.ini. Option to restart Cumulus if data from La Crosse stations stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
|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.
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled
*1 = Enabled
|-
|-
|ReportDataStoppedErrors=0
|ReportDataStoppedErrors=0
|This line needs to be added in the [Station] section of the Cumulus.ini. Option to turn off reporting of 'data stopped' errors to the Cumulus error log (may be needed with La Crosse stations)
|This line needs to be added in the [Station] section of the Cumulus.ini.  
Option to turn off reporting of 'data stopped' errors to the Cumulus error log (may be needed with La Crosse stations)
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled
*1 = Enabled
|}
|}
The spike removal parameter listed in the Fine Offset section above, may be used with La Crosse stations.
The spike removal parameter listed in the Fine Offset section above, may also be used with La Crosse stations.


==== Hydreon specific: ====
==== Hydreon specific: ====
Line 660: Line 721:
|SyncDavisClock=0  
|SyncDavisClock=0  
|Set this in the Station Configuration Screen Settings block where called '''Synchronize station clock'''. Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
|Set this in the Station Configuration Screen Settings block where called '''Synchronize station clock'''. Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
When set, at Cumulus start-up and at 04:00 each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC  
When set, at Cumulus start-up and at 04:00 each day, Cumulus will set the Instromet clock to within a minute of the same time as the PC  
*0 = Disabled, default as deselected on the Station Configuration Screen
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time!
|-
|-
|LogExtraSensors=0
|LogExtraSensors=0
|This is set in the settings frame on the Station settings screen off the configuration menu by the '''Extra Sensors''' selection.  
|This is set in the settings frame on the Station settings screen off the configuration menu by the '''Extra Sensors''' selection. If you have 'extra sensors' selected, the wet bulb reading will be used as an extra temperature sensor. Otherwise it is used as 'wet bulb' and the humidity will be calculated from that and the dry bulb sensor.  
*0=Disabled (default)
*0=Disabled (default)- . For a wet bulb sensor, Cumulus will output the humidity, not the temperature shown by the wet bulb.
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations.
*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).
|}
|}
Line 735: Line 796:
|style="background:lightgray;"|Section Name - the following parameters relate to your website
|style="background:lightgray;"|Section Name - the following parameters relate to your website
|-
|-
|ForumURL=<nowiki>http://sandaysoft.com/forum/</nowiki>  
|ForumURL=<nowiki>https://cumulus.hosiene.co.uk/</nowiki>  
|A website forum URL
|A website forum URL
|-
|-
Line 742: Line 803:
|}
|}


== Section: FTP Site ==
== Section: FTP site ==
See individual entries for how to edit these parameters.
NOTE: The word site should be in lower case as shown in left-hand column heading and above.
 
See individual entries for how to modify these parameters (either select on a screen, or edit file directly). Where the modification can be done on a screen, the Cumulus Help screens (e.g. Configuration: Internet) will explain the selection.
 
This Wiki discusses the most basic of these settings on [[Simple_Website_setup|this page]] and discusses the more complex ones in [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|this section]].
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 757: Line 822:
|-
|-
|DailyParams=
|DailyParams=
|Selected in the '''Params''' box alongside the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'DailyProgram' used to specify any parameters to be passed to that command.
|Selected in the '''Params''' box alongside the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  
*default - none
*default - none
The corresponding 'parameters' for 'DailyProgram' used to specify any parameters to be passed to that command.
|-
|-
|Host=  
|Host=  
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site. You probably used it with an external FTP program when you followed the instructions in the Cumulus ''Help'', '''Readme.txt''' or [[Simple_Website_setup]].
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site. You probably used it with an external FTP program when you followed the instructions in the Cumulus ''Help'', '''Readme.txt''', or [[Simple_Website_setup]].
''Leave blank if you are not using ftp, but simply creating the output files on your pc with a Copy instruction.''
''If you host your web site yourself, then "'''Host=localhost'''" might be appropriate''.
 
''Leave blank, "'''Host='''", if you are not using ftp'', but simply creating the output files on your pc with a Copy instruction.
|-
|-
|Port=21  
|Port=21  
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block. Port used for FTP upload, default =21
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.
Port used for FTP upload, default as shown is the normal port.
|-
|-
|Username=  
|Username=  
|Select your web site FTP login Username in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block
|Select your web site FTP log-in Username in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block
|-
|-
|Password=  
|Password=  
Line 856: Line 925:
|EnableRealtime=0  
|EnableRealtime=0  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime''.
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime''.
The [[realtime.txt]] file contains various weather parameters and is used by the CumulusRealtime.swf (shock wave flash) real time wind gauges (as on the supplied 'gauges' web page for Cumulus 1). This parameter controls when it is created.
*0 = Disabled (default)
*0 = Disabled (default)
** - If you do not have ''Auto Update'' option set (top of Web Settings block), the ''realtime.txt'' file is not created/updated.
** - If you do not have ''Auto Update'' option set (top of Web Settings block), the ''realtime.txt'' file is not created/updated.
Line 864: Line 932:
** - Other parameters need to be set for more actions.
** - Other parameters need to be set for more actions.
** - If you have the ''RealtimeFTPEnabled'' option set, and a suitable ''RealtimeInterval'' configured, (for both of these see below) Cumulus will upload the file to your web site, after the number of seconds specified by '''RealtimeInterval''' (see that parameter below) since any previous upload.  
** - If you have the ''RealtimeFTPEnabled'' option set, and a suitable ''RealtimeInterval'' configured, (for both of these see below) Cumulus will upload the file to your web site, after the number of seconds specified by '''RealtimeInterval''' (see that parameter below) since any previous upload.  
The [[realtime.txt]] file contains various weather parameters and is used by the CumulusRealtime.swf (shock wave flash) real time wind gauges (as on the supplied 'gauges' web page for Cumulus 1.x.x). This parameter controls when it is created.
|-
|-
|RealtimeFTPEnabled=0
|RealtimeFTPEnabled=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime FTP''.
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime FTP''.
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled, Cumulus will establish an FTP connection to your web site, so that the realtime.txt file, and any other files you specify, can be uploaded when realtime processing takes place. The 'EnableRealtime' setting must be set to 1 for this setting to have any effect.
*1 = Enabled, Cumulus will establish an FTP connection to your web site, so that the realtime.txt file, and any other files you specify, can be uploaded when realtime processing takes place.
The 'EnableRealtime' setting must be set to 1 for this setting to have any effect.
|-
|-
|RealtimeTxtFTP=0
|RealtimeTxtFTP=0
Line 916: Line 986:
*0 = Standard Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*0 = Standard Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*1 = Default from build 1093, Standard Cumulus Web Templates are processed into '''charset=utf-8''' web pages
*1 = Default from build 1093, Standard Cumulus Web Templates are processed into '''charset=utf-8''' web pages
See [[FAQ#What_character_encoding_does_Cumulus_use_for_the_web_pages_it_generates.3F|here]] for related FAQ or [[Customised_templates#Coding_standard_and_character_encoding_for_Customised_Templates_using_the_same_names_as_Standard_Cumulus_Templates|this section]] for more information.
|-
|-
|ExtraUTF[0-9]=0  
|ExtraUTF[0-9]=0  
Line 931: Line 1,002:
*0 = not binary (if pure ASCII characters)
*0 = not binary (if pure ASCII characters)
*1 = Binary (e.g. images)
*1 = Binary (e.g. images)
In general, setting to one is safest, but the default is zero.
|-
|-
|ExtraBinary[10-99]=0  
|ExtraBinary[10-99]=0  
Line 938: Line 1,010:
|-
|-
|ExtraRealtime[0-9]=0  
|ExtraRealtime[0-9]=0  
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Realtime?'' column of the table on the  ''Files'' Tab screen. If you select this for any files, you will also need to select the Realtime options (see Cumulus Help, or [[Simple_Website_setup#Configuration|another Wiki page]]).
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Realtime?'' column of the table on the  ''Files'' Tab screen.
*0 = Disabled, (default) file uploaded as part of normal upload
*0 = Disabled, (default) file uploaded as part of normal upload
*1 = Enabled, file uploaded during Realtime upload
*1 = Enabled, file uploaded during Realtime upload
If you select this for any files, you will also need to select the  ''RealtimeFTPEnabled=1'' option, which in turns means you have to set ''EnableRealtime=1'' option (see Cumulus Help, or [[Simple_Website_setup#Configuration|this Wiki page]]).
|-
|-
|ExtraRealtime[10-99]=0  
|ExtraRealtime[10-99]=0  
|Set in this config file only. If you select this for any files, you will also need to select the Realtime option.
|Set in this config file only.
*0 = Disabled, alternate file #10 through #99 uploaded as part of normal upload
*0 = Disabled, alternate file #10 through #99 uploaded as part of normal upload
*1 = Enabled, alternate file #10 through #99 uploaded during Realtime upload
*1 = Enabled, alternate file #10 through #99 uploaded during Realtime upload
If you select this for any files, you will also need to select the ''RealtimeFTPEnabled=1'' option, which in turns means you have to set ''EnableRealtime=1'' option.
|-
|-
|ExtraFTP[0-9]=1  
|ExtraFTP[0-9]=1  
Line 955: Line 1,029:
|ExtraFTP[10-99]=1  
|ExtraFTP[10-99]=1  
|Set in this config file only.
|Set in this config file only.
*0 = Disabled, alternate file #10 through #99 copied to the location specified in the Remote Filename box.
*0 = Disabled, alternate file #10 through #99 ''copied'' to the location specified in the Remote Filename box.
*1 = Enabled, alternate file #10 through #99 uploaded by FTP
*1 = Enabled, alternate file #10 through #99 ''uploaded by FTP'' to the location specified in the Remote Filename box.
 
(Copying is appropriate if you have a local web server on your computer or network, FTP needed if your server is hosted elsewhere)
|-
|FTPlogging=0
|Set (Cumulus 1) by selecting ''FTP Logging'' in '''Configuration''' menu, or by adding this line to 'FTP site' section of Cumulus.ini.
*0 (default) = Cumulus will not store messages from FTP server.
*1 = Cumulus will update a file called ''ftplog.txt'' in the same folder as the Cumulus executable by showing the messages sent to, and responses from, the FTP server.
|-
|-
|MaxFTPconnectRetries=3
|MaxFTPconnectRetries=3
|Set in this config file only. Allow configurable max FTP connect retries (default is retry up to 3 times)
|Set in this config file only.
 
Allow configurable max FTP connect retries (default is retry up to 3 times).
|}
|}


== Section: Display ==
== Section: Display ==
Set 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.
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"
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 994: Line 1,080:
*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
|-
|ShowCurrentConditions=0
|Set in the Display Configuration Screen General block
*0 = Disabled, (default)
*1 = Enabled, a box labelled 'Current:' appears at bottom of Cumulus main screen. See [[Webtags_as_boolean_operators_in_HTML#Current_Weather_Conditions]] for possible use of this information, and [[Currentconditions.txt]] for the effect when the contents of the box on main screen changes.
|-
|-
|FontColour=4227327  
|FontColour=4227327  
Line 1,019: Line 1,100:
*0 = 24Hr clock mode
*0 = 24Hr clock mode
*1 - 12 Hr am/pm clock mode
*1 - 12 Hr am/pm clock mode
|-
|DisplaySolarData=0
|Set by ''Display solar/extra data'' item in the Display Configuration Screen ''General'' block.
*0 = Disabled (default)
*1 = Enabled, adds an extra panel to the main screen below the recent extremes panel - EITHER
**Panel displays ''Temp'', ''Dew pt'' and ''Hum'' (this [[FAQ#How_does_Cumulus_deal_with_extra_sensors.3F|extra sensor data]],  can be populated from Oregon WMR-928 stations, see next 3 parameters) OR
**Panel displays ''Evapotranspiration (ET)'', ''Ultraviolet (UV)'' and ''Solar radiation'' if station '''Type''' is Vantage Pro and solar data is available
|-
|-
|WMR928Channel1Caption=Extra channel 1  
|WMR928Channel1Caption=Extra channel 1  
Line 1,037: Line 1,111:
|-
|-
|SnowUnitText=cm  
|SnowUnitText=cm  
|Set in the Display Configuration Screen General block. Snow measurement unit. Default is cm. Can be any unit (or other text) you like, remember all snow depth observations must be entered as an integer (without any decimal part)!
|Set in ''Snow units'' box in the Display Configuration Screen ''General'' block. Default is cm.
 
This allows you to set the text that appears with the snow depth in the weather diary. Note that there is no significance attached to this and the effect is purely cosmetic; the snow depth is effectively unitless and you can supply any text you wish, remember all snow depth observations must be entered as an integer (without any decimal part)!
|-
|-
|DisplayCloudBase=0  
|DisplayCloudBase=0  
Line 1,048: Line 1,124:
*0 = Disabled (default) [[Heat_index]] displayed on main screen. The heat index is calculated only if the actual temperature in the shade (not in direct sunlight) is above 27 °C (80 °F), so normal temperature shown here for cooler temperatures.
*0 = Disabled (default) [[Heat_index]] displayed on main screen. The heat index is calculated only if the actual temperature in the shade (not in direct sunlight) is above 27 °C (80 °F), so normal temperature shown here for cooler temperatures.
*1 = Enabled, calculated [[Humidex]] value to be displayed on the main screen instead of Heat Index. (Note that Cumulus displays degrees C or F for Humidex, whereas strictly speaking it is unitless. This is for the convenience of those who use Fahrenheit but would still prefer to see Humidex displayed, where it might be confusing to show the unconverted value.)
*1 = Enabled, calculated [[Humidex]] value to be displayed on the main screen instead of Heat Index. (Note that Cumulus displays degrees C or F for Humidex, whereas strictly speaking it is unitless. This is for the convenience of those who use Fahrenheit but would still prefer to see Humidex displayed, where it might be confusing to show the unconverted value.)
|-
|DisplaySolarData=0
|Set by ''Display solar/extra data'' item in the Display Configuration Screen ''General'' block.
*0 = Disabled (default)
*1 = Enabled, adds an extra panel to the main screen below the recent extremes panel - EITHER
**Panel displays ''Temp'', ''Dew pt'' and ''Hum'' (this [[FAQ#How_does_Cumulus_deal_with_extra_sensors.3F|extra sensor data]],  can be populated from Oregon WMR-928 stations, see next 3 parameters) OR
**Panel displays ''Evapotranspiration (ET)'', ''Ultraviolet (UV)'' and ''Solar radiation'' if station '''Type''' is Vantage Pro and solar data is available
|-
|DisplayStormRain=0
|Set by ''Display 'Storm Rain' '' item in the Display Configuration Screen ''General'' block.
*0 = Disabled, (default)
*1 = Enabled, adds an extra output to the main screen to show what Davis stations report as Storm Rain
|-
|ShowCurrentConditions=0
|Set in the Display Configuration Screen General block
*0 = Disabled, (default)
*1 = Enabled, a box labelled 'Current:' appears at bottom of Cumulus main screen. See [[Webtags_as_boolean_operators_in_HTML#Current_Weather_Conditions]] for possible use of this information, and [[Currentconditions.txt]] for the effect when the contents of the box on main screen changes.
|-
|-
|LegendSymbolWidth=3
|LegendSymbolWidth=3
Line 1,062: Line 1,155:
|-
|-
|WindGaugeAnimated=1
|WindGaugeAnimated=1
|Set in the Display Configuration Screen.  Animate the Wind Gauge pointer movement
|Set by ''Wind gauge animated'' item in the Display Configuration Screen ''General'' block.  Animate the Wind Gauge pointer movement
*0 = Disabled,
*0 = Disabled,
*1 = Enabled (default)
*1 = Enabled (default)
Line 1,146: Line 1,239:
|-
|-
|TransparentGauges=0
|TransparentGauges=0
|Set on the colour setting screen in the Configuration menu. The square backgrounds of the three wind gauges on the Cumulus main screen
|Set by ''Transparent gauge backgrounds'' item in the Display Configuration Screen ''General'' block.  
 
The square backgrounds of the three wind gauges on the Cumulus main screen
*0= same colour as the main window background (default)
*0= same colour as the main window background (default)
*1= the images will be processed to make the background colour transparent.
*1= the images will be processed to make the background colour transparent.
|-
|TransparentGraphs=0
|Set by ''Transparent graph backgrounds'' item in the Display Configuration Screen ''General'' block.
This only works if the graphs are defined to have a solid colour as background (gradient is not selected on ''colours'' configuration screen).
*0= Cumulus 1.x.x graphs colour is defined in ''graphs'' block on Colours Configuration screen (default)
*1= the graph images that Cumulus 1.x.x creates for upload to a web site will be processed to make the background colour transparent.
|-
|-
|LogFTPErrors=1
|LogFTPErrors=1
Line 1,207: Line 1,309:
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.
Set the SAG colours and axis position by using '''View''' menu and ''Select-A-Graph'' option, the settings for different observations are at the foot of the screen.
Set the SAG colours and axis position by using '''View''' menu and ''Select-A-Graph'' option, the settings for different observations are at the foot of the screen.
The only settings used in this section by Cumulus MX are "ChartMaxDays" and "GraphHours"
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,969: Line 2,073:
== 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).
'''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.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,075: Line 2,181:


== Section: MainForm ==
== Section: MainForm ==
This is an optional section if you have set 'Save main window position' on Display settings screen.
 
This section appears in the main cumulus.ini (found in same directory as cumulus.exe) where it stores the position of the main Cumulus screen on your monitor. Cumulus updates this section of the main cumulus.ini on closing, after you move the screen around on your monitor.  An equivalent section also appears in a shorter cumulus.ini stored in the reports sub-directory where it stores the position of your last saved NOAA screen.
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"
{| class="wikitable" border="1"
|-
|-
Line 2,083: Line 2,193:
|-
|-
|style="background:lightgray;"|[MainForm]  
|style="background:lightgray;"|[MainForm]  
|style="background:lightgray;"|Section name - the following parameters relate to the Cumulus screen position.
|style="background:lightgray;"|Section name - the following parameters relate to the Cumulus or NOAA screen position.
|-
|-
|Left=100
|Left=100
|The last saved Cumulus main screen position, in pixels from the left-hand edge of the screen.
|The last saved Cumulus main or NOAA screen position, in pixels from the left-hand edge of the screen.
|-
|-
|Top=50
|Top=50
|The last saved Cumulus main screen position, in pixels from the top edge of the screen
|The last saved Cumulus main or NOAA screen position, in pixels from the top edge of the screen
|}
|}
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/3706...4564"

Navigation menu