Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (preserving history) (view source)

Revision as of 09:54, 7 August 2020

29,249 bytes added ,  09:54, 7 August 2020
m
→‎Section: Offsets
m (Text replacement - "cumuluswiki.wxforum.net" to "cumuluswiki.org")
(109 intermediate revisions by 2 users not shown)
Line 350: Line 350:


== 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, and a number will be ignored.
 
If you are '''running MX on Windows''', filenames are not case sensitive, so MX will recognise "Cumulus.ini" or "cumulus.ini". But although Cumulus 1 might recognise "Cumulus1.ini" or anything else other than "Cumulus.ini". MX only recognises "Cumulus.ini".
 
If you are planning on '''running MX on another device''', filenames are case sensitive, and your Cumulus 1 configuration file must be called "Cumulus.ini" with an initial capital followed by lower case, so it might need to be renamed.  
 
Once it has been processed by MX, the ex Cumulus 1 main configuration file will gain a lot of new entries, and a number will be ignored.
 
=== Parameters changed ===
 
Replace: '''IncludeSTDImages=1''' (Cumulus 1) by ''IncludeGraphDataFiles=1'' (Cumulus MX) in [FTP site]
 
Replace: '''Port=n'''  (Cumulus 1) where n is a number, by ''ComportName=COMn'' (Cumulus MX on Windows) where the value is a string where n is same number, or replace by '''ComportName=/dev/ttyUSB0''' (CumulusMX on unix device) where the actual device name might need to be different if you have multiple USB ports.
 
=== Parameters added ===
 
This depends upon which version of MX you install when you move from Cumulus 1, please see all release announcements for details.


== Configuration File names ==
== Configuration File names ==
=== Cumulus MX ===
=== Configuration file created when first installing 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. No other "Cumulus.ini" files are required. Most of the sections are same in both flavours of Cumulus, but MX does not use [MainForm].
 
For those who are not swapping from Cumulus 1, their first use of MX will create a file called ''Cumulus.ini'' found in the same directory as CumulusMX.exe.
 
The file will contain an entry for every setting in the admin interface. Each entry will be a parameter in format '''attribute=value''' and the values will be as per defaults except for those which you have edited when first setting up MX.
 
These parameters are known as read-write parameters because they can be altered with the settings pages.  Later I will explain read-only parameters, as the name suggests these are entries in the configuration file that have been added directly to that file while MX is not running, and MX can only read these, it cannot update them.


=== Cumulus 1 ===
=== 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.


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.   
As downloaded at most versions, the Cumulus 1 executable is called '''cumulus.exe''' and all in lowercase (there were a few releases where it started with a capital letter). The configuration file that Cumulus 1 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.
 
If when you installed Cumulus 1, you had renamed that executable file to say ''Cumulus1.exe'' before you tried to run it, then Cumulus will still start, but it will create a new main configuration file based on that name (i.e. ''Cumulus1.ini'') in the same folder. It will also create another configuration file called ''Cumulus.ini'' in that folder.  You will see all but one section in the first file, and the final section in the second file.  But if you were running Cumulus 1 before this, you may be missing some of your settings because of the configuration now being split.   


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


= Upgrading to New Build =
= 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.
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.


Line 382: Line 404:


== Beta builds ==
== Beta builds ==
There are no beta builds of either Cumulus 1 or Cumulus MX. Although much of the content is identical (and shown below), there are differences between this configuration file for Cumulus 1 as shown here and for MX, the differences for MX are given [[Cumulus.ini_(Beta)|in this article]].


When there is 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', but for details of beta tests see  [https://cumulus.hosiene.co.uk/viewforum.php?f=2 the forum].  
When beta builds of Cumulus 1 were made by Steve Loft, they could be downloaded by anybody, and if there were any differences for the configuration file in that beta they would be listed in the [[Cumulus.ini_(Beta)|Cumulus.ini Beta article]], because some people might decide to use last stable release. When that beta ended, and only the stable release was available, any details from the beta page would be transferred into this article.
 
Now that Cumulus 1 is no longer under development, it will not have any beta builds.
 
Steve Loft kept MX in beta while he was developing it. This page continued to show what applied to Cumulus 1, and what applied to MX was placed in the [[Cumulus.ini_(Beta)|Cumulus.ini Beta article]].
 
After Mark Crossley took over development of MX he ended that beta. All information that was on the beta page was moved into this article that now covers both Cumulus 1 and MX in one place.


'''CURRENTLY CUMULUS MX specific parameters are listed on [[Cumulus.ini (Beta)|another]] page.'''
When Mark is producing a new major version of MX he typically issues it in beta to a restricted number of users by email, he does not make any beta release public.  For this reason, it is not anticipated there is going to be any use of the [[Cumulus.ini_(Beta)|Cumulus.ini Beta article]] while Cumulus 3 (MX) continues to develop, although of course a Cumulus 4 is in development and we wait to see what might happen when that is ready for a public release.


= Editing the file =
= Editing the file =


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


For Cumulus MX, again when it is run for first time, unless it has been given a Cumulus.ini file created for Cumulus 1, you will need to set some settings. However, Cumulus MX does save a back up automatically at the end of each day.  
See [[Setup]] for detailed advice, on how to choose the settings when you first run Cumulus (1 or MX).
 
Note in particular, that some settings (such as units, date/time formats) must be got right first time. If you do change those later, it is a lot of work because you will need to edit all the other files that Cumulus creates to reflect those changes.
 
=== Initialisation by Cumulus 1 ===
 
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. 
 
=== Initialisation by MX ===
 
For Cumulus MX, if it has been given a '''Cumulus.ini''' file created for Cumulus 1, then apart from a couple of parameters already mentioned, MX has all the settings it needs.
 
However, if Cumulus MX is being run for the first time and it does not inherit a file, it needs some settings before it can do anything.  The difference is that MX just hangs, unless you look at the Terminal output or the file it creates in [[MXDiags]], you won't know it is waiting for settings. You need to start up the admin interface and go into the various settings pages yourself to select what MX needs to continue to work. You then need to stop MX so it stores those settings and can use them next time it starts. Although some settings can take effect while MX is running, others only take on their new values when MX is restarted.


See [[Setup]] for further advice, noting in particular that some settings (such as units, date/time formats) should stay unchanged, because if you do change those you will need to edit all the other files that Cumulus creates to reflect those changes.
Should you accidentally delete Cumulus.ini, or should you close MX badly so it does not manage to correctly save the entire contents of Cumulus.ini, MX has an advantage in that it saves Cumulus.ini into the backup folder every time it restarts and every time it does a rollover.


== Settings controlled by application ==
== Read-write 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.




''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 ==
 
== Read-only 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. 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.
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 at each rollover (and when it is started), so you can easily return to an earlier version if necessary
*If your system is configured to use a comma for a decimal separator, then you should use a comma in any decimal values that you set in this file.
*If your system is configured to use a comma for a decimal separator, then you should use a comma in any decimal values that you set in this file.
*You should use a simple text editor (not a rich text editor nor word processor) to edit this file as only letters, numerical digits, decimal separators and the equals symbol are allowed in any parameter. If you use a spreadsheet program to make use of the manipulation it offers, ensure it is set to output in pure text.
*You should use a simple text editor (not a rich text editor nor word processor) to edit this file as only letters, numerical digits, decimal separators and the equals symbol are allowed in any parameter. If you use a spreadsheet program to make use of the manipulation it offers, ensure it is set to output in pure text.
*The parameter lines (attribute=value) can be in any order, but must be in the correct section. You might find it helpful to sort the attributes within a section into alphabetical order, to ''ensure you have no duplicates'' and to make it easier to find the particular parameter line you may wish to edit in the future.
*The parameter lines (attribute=value) can be in any order, but must be in the correct section. You might find it helpful to sort the attributes within a section into alphabetical order, to ''ensure you have no duplicates'' (that would stop Cumulus working), and to make it easier to find the particular parameter line you may wish to edit in the future.
**When Cumulus (1 or MX) is closed, it appears to recreate the file, but it preserves the order in the file it read when it was started, as all the parameters are held internally in the sequence they are read.


= File Contents =
= File Contents =
Line 425: Line 469:


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:
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 edit NOAA parameters then  
*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.  
**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.
**Note if you renamed your  "cumulus.exe" to say "Cumulus1.exe", then the main form section is still in cumulus.ini file, but all other settings will be in a "Cumulus1.ini" file.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 444: Line 491:


=== Section: Station ===
=== 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.  
 
The read-only parameters must be entered directly into the configuration file. Stop Cumulus before editing this file using any plain text editor, not a word processor
 
{{Version badge 1}}The read-write parameters are set using '''Station Configuration Screen''' in Cumulus 1 (C1).
 
[[File:Badge vMx.png]] The read-write parameters are set using the '''Station Settings''' page in MX.
 
 
See individual parameters for specific instructions on setting them. The defaults are shown in left hand column, but be aware that some might have different defaults in C1 and MX, and that this article was first created when only Cumulus 1 was available.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 451: Line 507:
|-
|-
|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 all weather stations.
|-
|StartDate=13/08/2009
|This parameter is different to all the others. It is not read-write as you cannot edit it in Cumulus (1 or MX). Unlike other read-only parameters it 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).
This date can be included in a template file, using the tag '''<#recordsbegandate>'''. The tag appears twice in the '''recordT.htm''' template that is provided with Cumulus (1 and MX) and there is a suggestion about changing that at [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|AvgBearingMinutes=N
|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).  
|-
|-
|Type= -1  
|UseWindChillCutOff=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.
|If you have not asked Cumulus to calculate wind chill, this parameter is irrelevant as it cannot affect how your weather station calculates wind chill.
*-1= default value, indicates a selection from those below must be made
*0=Vantage Pro station
*1=Vantage Pro2 station
*2=WMR-928 station
*3=WM-918 station
For Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection, if your model is not listed, try WM-918 if your station has wired connections, and WMR-928 if it is wireless.


*4=Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
If you have asked Cumulus to calculate wind chill ('''CalculatedWC=1'''), regardless of whether you have a weather station that can supply it, then Cumulus will by default only modify the outside temperature if both wind speed and temperature criteria are met. This parameter must be added to the file if you want to disable 'calculate Wind chill only if temperature less than 10°C rule'.
'''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.
*5=Fine Offset/Watson/MyDEL/Nevada, etc (without solar measurement sensors (with or without solar recharging))
*6=WS2300 (For all La Crosse WS23xx models)
*7=Fine Offset/Watson/MyDel etc with Solar Sensors
*8=[[WMR100-200_Protocol|WMR100]]
*9=[[WMR100-200_Protocol|WMR200]]
*10=Instromet (with optional extra solar sensors or without)


'''Additional values available in MX''' - see [[Cumulus.ini_(Beta)#Section:_Station|(here)]].
*  0 = Disabled, Cumulus will use any wind speed of 3 mph or more, to modify the temperature, and determine the wind chill, and Cumulus will ignore the temperature criterion
*    1 = Enabled (default), Cumulus will use both 10°C temperature and 3 mph wind speed criteria to determine if wind chill applies. Outside the criteria,the wind chill field will simply duplicate the outside temperature field.
|-
|-
|Model="your Model description"
|ChillHourThreshold=45  '''Fahrenheit only i.e. USA'''
|The weather station model description that you want output by the web tag &lt;#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.
ChillHourThreshold=7 '''Celsius users'''
|The temperature threshold for the calculation of [[Heat/cold_degree_days_and_Chill_hours|Chill Hours]] is specified in the units that you use in Cumulus.
If the parameter is not included in the file, the default varies depending on the units you use.
*As shown the default is exactly 45 degrees Fahrenheit if Fahrenheit is used.
*The default is exactly 7 degrees Celsius, (note that is not exactly 45<sup>o</sup>F) if you have selected Celcius.
*You can put in any value you want, with a decimal place if required
*Some people have put in the freezing-point temperature (0<sup>o</sup>C and they relabel "chill hours" to "frost hours"
|-
|ChillHourSeasonStart=10
|The season start figure is the calendar month number (1=January to 12= December). The default if this parameter is not specified is October (month 10). On the first day of the month specified here, Cumulus resets the cumulative chill hours that it reports to zero.
|-
|SnowDepthHour=9
|If this parameter is not included in the file, then any snow entries in the [[Weather Diary]] for a particular date will continue to be used {{Version badge 1}} in output by Cumulus 1 until 9am the next morning, when entries for the current date will apply. [[File:Badge vMx.png]]The default for MX is not stated anywhere, but might be the standard rollover time (https://cumulus.hosiene.co.uk/viewtopic.php?f=37&t=17919).
*Allowed values are the integers 0 to 23
*The time is constant year round, in UK "a day of snow" could (before climate change) happen in April despite that being after swapping to summer (daylight saving) time.
#What you enter here is independent of any settings for rollover time
#For meteorological reporting, snow is reported on midnight to midnight days, although snow depth is measured and reported at 9am.
|-
|-
|Port=0  
|CreateWxnowTxt=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.
|If the parameter is not included in the file, the default value is assumed.


[[File:Badge vMx.png]] This parameter is ignored by MX, it uses a different parameter - see [[Cumulus.ini_(Beta)#Section:_Station|(here)]].
    0= turn off creation of '''wxnow.tx'''t file (stored in main Cumulus folder)
    1= (default) create '''wxnow.txt''' file (an alternative way to get data to CWOP/APRS)
|-
|-
|RecordSetTimeoutHrs=24
|ListWebTags=0
|[[File:Badge vMx.png]]Available in MX version 3.5.1 onwards only, allows the time from when a record is set to when it is cleared to be varied. The web tags: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet,LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet,HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighhHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet will all return 1 from when relevant record is set for the period of time set here (default 24 hours) and then reset to 0.
|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)
    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)
|-
|-
|Latitude=0
|RainDayThreshold=-1
|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'.
|If this parameter is not included in the file, the default is '''-1''' and that represents 0.2 mm or 0.01 inches.
{{Version badge 1}}Do this  in the Station Configuration Screen Location block.  
#The parameter specifies the threshold value which the daily rainfall has to equal or exceed for the day to be considered a 'rain day'.
[[File:Badge vMx.png]] Exactly same entries, enter using station settings by expanding location section.
#Value is entered in your current [[Rain_measurement]] units.
Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
|-
|-
|Longitude=0
|NoFlashWetDryDayRecords=1
|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'.
| * When set to 1 (default) stops new Longest Wet/Dry Period records being 'flashed' in Cumulus 1
The place to do this is as described for Latitude depending on Cumulus flavour.
* Set to 0 if you are happy to have the record light on your Cumulus 1 main screen flash for each rainfall update
Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
 
[[File:Badge vMx.png]]It is not clear if MX reads this parameter, as it does not show this record on the admin interface dashboard
|-
|-
|LatTxt=  
|FCPressureThreshold=0.1
|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.
|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.
|-
|-
|LonTxt=  
|RTdisconnectcount=infinite
|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.
|{{Version badge 1}}By default, the 'realtime' ftp connection stays connected. But you can add '''RTdisconnectcount=N''' to force a disconnection after N realtime ftp uploads. For example, if you set '''RealtimeInterval=60''' there will be 60 seconds between each update and '''RTdisconnectcount=60''' would force a disconnection each hour.
 
[[File:Badge vMx.png]]There have been changes to FTP handling in MX releases, and it is not clear if this parameter is used by MX
|-
|-
|Altitude=0  
|ErrorLogSpikeRemoval=0  
|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.
|This is read-only below version 3.7.0. Because it is now a read-write parameter, please see its entry in next section of this table
|-
|-
|AltitudeInFeet=1  
|UVdecimals=0
|Altitude measurement unit for value in previous parameter.
|{{Version badge 1}}(added 1.9.3 build 1038) [[File:Badge vMx.png]] applies at all versions
*0 = metres Above Sea Level
 
*1 = feet ASL
UV values are now displayed and logged as whole numbers by default. You can change this by adding this entry specifying the number of decimal places:
* 0 = Integer Values (default)
* n = Number of decimal places e.g. 1
|-
|-
|PeakGustMinutes=N
|NoSensorCheck=0
|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.
|By default, Cumulus will stop working if after 6 attempts it cannot read all the standard readings from a weather station:
*With this parameter, N is the number of minutes over which Cumulus calculates its highest wind gust.
#temperature
*Without this parameter, the default of 10 minutes, the international standard duration, is used.
#humidity
*If you select 60, then Cumulus would calculate rolling 60-minute highest wind gust speeds.
#wind speed
*To be in line with met stations in Cz, select 30.
#pressure
This parameter allows disabling of that sensor check:
*   0 = Sensor check enabled (default)
*   1 = Sensor check disabled
|-
|-
|AvgSpeedMinutes=N
|SpecialLog=0
|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, if you have set the next parameter so that Cumulus does its own calculation of average wind speed.
|[File:Badge vMx.png]] Not available in MX
*With this parameter, N is the number of minutes over which Cumulus calculates its average speed, if you have Cumulus set to do this with the next parameter enabled.
 
*Without it, the default of 10 minutes, the international standard duration, is used if Cumulus is set to calculate average wind speeds.  
{{Version badge 1}}In Cumulus 1 there is an option of whether to record temperature and humidity (both indoor and outside values) in a log:
*If you selected 60, then Cumulus would calculate rolling 60-minute average wind speeds.  
* 0 (default) = no special log
*To be in line with ASOS stations in USA, select 2.
* 1 = 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 dew point,outside temp,outside humidity,outside dew point
 
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
|-
|-
|Wind10MinAverage=0
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings, for Cumulus 1 edit in Station Configuration Screen
|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]].
*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
|Type= -1
|Selected on same screen as other parameters.
|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.
*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= default value, before a selection from those below is made. In Cumulus 1, this causes the configuration screen to be shown so that you start set up. In MX a message appears in the terminal (Windows command) screen saying that station type not known (see [[#Cumulus_MX|#Cumulus_MX section]] above.
*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.
*0=Vantage Pro station
Note that there isn't really any point enabling this option for Davis stations, as their 'longer-term speed' is a 10 minute average anyway; neither for La Crosse stations, as they only supply one wind speed anyway.
*1=Vantage Pro2 station
|-
 
|RoundWindSpeed=0
Following added from version 1.7.0:
|Selected on same screen as other parameters.
*2=WMR-928 station
*0 = Disabled (default), Cumulus will display the wind speed value to the precision used by the station.
*3=WM-918 station
*1 = Enabled, this setting causes wind speeds to be rounded to the nearest integer.
For Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection, if your model is not listed, try WM-918 if your station has wired connections, and WMR-928 if it is wireless.
 
Added in version 1.7.12:
*4=Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
'''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.  
 
Added in version 1.8.0:
*5=Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] (without solar measurement sensors (with or without solar recharging))
 
Added in version 1.8.3:
*6=WS2300 (For all La Crosse WS23xx models)
 
Added in version 1.9.1:
*7=Fine Offset/Watson/MyDel etc with Solar Sensors as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]].
 
Added in version 1.9.2:
*8=[[WMR100-200_Protocol|WMR100]]
*9=[[WMR100-200_Protocol|WMR200]]
*10=Instromet (with optional extra solar sensors or without)
 
[[File:Badge vMx.png]]'''Additional values available in MX only:'''
 
Added in version 3.0.0:
*11=Davis WLL
 
Added in version 3.2.0:
*12=Ecowitt GW1000 and Froggit DP1500 (and any equivalents)
|-
|-
|AvgBearingMinutes=N
|Model="your Model description"
|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).
|The weather station model description that you want output by the web tag &lt;#stationtype>
See next parameter for behavoir when calm.
{{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.
|-
|-
|CalculatedDP=0
|RecordSetTimeoutHrs=24
|Selected on same screen as other parameters.
|[[File:Badge vMx.png]]Available in MX version 3.5.1 onwards only, allows the time from when a record is set to when it is cleared to be varied. The web tags: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet,LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet,HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighhHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet will all return 1 from when relevant record is set for the period of time set here (default 24 hours) and then reset to 0.
*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.
|-
|-
|CalculatedWC=0  
|Latitude=0  
|Selected on same screen as other parameters.
|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'.
*0 = Disabled
{{Version badge 1}}Do this  in the Station Configuration Screen Location block.
*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.
[[File:Badge vMx.png]] Exactly same entries, enter using station settings by expanding location section.
Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
|-
|-
|UseWindChillCutOff=1
|Longitude=0
|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&#176;C rule'.
|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'.
*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
The place to do this is as described for Latitude depending on Cumulus flavour.
*1 = Enabled (default), Cumulus will use both 10&#176;C temperature and 3  mph wind speed criterions to determine if wind chill applies.
Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
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
|LatTxt=  
|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.
|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.
|-
|-
|ChillHourSeasonStart=10
|LonTxt=  
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The season start figure is the calendar month number (1=January to 12= December).  The default if this parameter is not specified is October (month 10).
|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.
|-
|-
|RolloverHour=0  
|Altitude=0  
|Log roll over time as selected on the same screen as other parameters
|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.
*0 = midnight
*9 = 9am/10am
|-
|-
|Use10amInSummer=1  
|AltitudeInFeet=1  
|Daylight saving correction for 9am roll over, Selected on same screen as other parameters.
|Altitude measurement unit for value in previous parameter.
*0 = Use 9am in summer (use 10am not checked on Station Configuration Screen)
*0 = metres Above Sea Level
*1 = Use 10am in summer selected on Station Configuration Screen
*1 = feet ASL
|-
|-
|SnowDepthHour=9
|PeakGustMinutes=N
|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.
|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.
*0 = midnight (default)
*With this parameter, N is the number of minutes over which Cumulus calculates its highest wind gust.  
*9 = 9am,
*Without this parameter, the default of 10 minutes, the international standard duration, is used.  
*13 = 1pm etc.
*If you select 60, then Cumulus would calculate rolling 60-minute highest wind gust speeds.
Note this time is independent of your rollover time selections in the two preceding parameters.
*To be in line with met stations in Cz, select 30.
|-
|-
|WarnMultiple=0
|AvgSpeedMinutes=N
|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.
|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, if you have set the next parameter so that Cumulus does its own calculation of average wind speed.  
*0 = Disabled, (default) Multiple instances allowed.
*With this parameter, N is the number of minutes over which Cumulus calculates its average speed, if you have Cumulus set to do this with the next parameter enabled.  
*1 = Enabled, prevents multiple instances of Cumulus from running.
*Without it, the default of 10 minutes, the international standard duration, is used if Cumulus is set to calculate average wind speeds.  
Not available in earliest builds of any Cumulus flavour.
*If you selected 60, then Cumulus would calculate rolling 60-minute average wind speeds.  
*To be in line with ASOS stations in USA, select 2.
|-
|-
|ConfirmClose=0  
|Wind10MinAverage=0  
|{{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
|Selected on same screen as other parameters.
*0 = Disabled, application will close immediately
*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, 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, 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.
Ignored by MX.
|-
|-
|CloseOnSuspend=1
|UseSpeedForAvgCalc=0
|{{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.
|Selected on same screen as other parameters.
*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 (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, 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, 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.
Ignored by MX
Note that there isn't really any point enabling this option for Davis stations, as their 'longer-term speed' is a 10 minute average anyway; neither for La Crosse stations, as they only supply one wind speed anyway.
|-
|-
|DataLogInterval=2
|RoundWindSpeed=0
|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]].
|Selected on same screen as other parameters.
*0 = 1 min
*0 = Disabled (default), Cumulus will display the wind speed value to the precision used by the station.
*1 = 5 mins
*1 = Enabled, this setting causes wind speeds to be rounded to the nearest integer.
*2 = 10 mins (default)
*3 = 15 mins
*4 = 20 mins
*5 = 30 mins
Notes:
*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 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).
*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
|UseZeroBearing=0
|{{Version badge 1}}Cumulus 1.x.y: Selected in the Station Configuration Screen Settings block.
|Selected on same screen as other parameters. Intended for weather stations that do not supply a wind bearing, so Cumulus has to calculate it from reported compass direction.
[[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.
*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, 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, 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 (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.
|-
|-
|WindUnit=0  
|CalculatedDP=0  
|[[Wind_measurement#Wind_Speed|Wind speed measurement unit]] used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
|Selected on same screen as other parameters.
*0 = m/s
*0 = Disabled, Cumulus will display the dew point value supplied by the station.
*1 = mph
*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.
*2 = km/h
*3 = kts
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  
|CalculatedWC=0  
|[[Pressure_Measurement]] unit used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
|Selected on same screen as other parameters. Available only from version 1.8.3
*0 = mb
*0 = Disabled
*1 = hPa
*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.
*2 = in
Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
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  
|RolloverHour=0  
|[[Rain_measurement]] unit used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
|Log roll over time as selected on the same screen as other parameters
*0 = mm
*0 = midnight
*1 = in
*9 = 9am/10am
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
|Use10amInSummer=1
|[[Temperature_(and_humidity)_measurement#Temperature_Scales|Temperature measurement unit]] used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
|Daylight saving correction for 9am roll over, Selected on same screen as other parameters.
*0 = Celsius
*0 = Use 9am in summer (use 10am not checked on Station Configuration Screen)
*1 = Fahrenheit
*1 = Use 10am in summer selected on Station Configuration Screen
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=  
|WarnMultiple=0
|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
|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.
*1 = Enabled, prevents multiple instances of Cumulus from running.
Not available in earliest builds of any Cumulus flavour.
|-
|-
|LocDesc=  
|ConfirmClose=0
|A '''Description''' for the location (as entered on the same screen as other parameters) - inserted after 'Welcome to ' on 'Now' web page.
|{{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
*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)
[[File:Badge vMx.png]]Ignored by MX.
|-
|-
|StartDate=13/08/2009
|CloseOnSuspend=1
|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]]
|{{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) 
*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
|-
|-
|CreateWxnowTxt=0
|DataLogInterval=2
|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.
|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 [[Standard_log_files]] and, when applicable, in [[Extra_Sensor_Files]].
*0= turn off creation of wxnow.txt file (stored in main Cumulus folder)
*0 = 1 min
*1= (default) create wxnow.txt file (an alternative way to get data to CWOP/APRS)
*1 = 5 mins
*2 = 10 mins (default)
*3 = 15 mins
*4 = 20 mins
*5 = 30 mins
Notes:
*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 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).
*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.
|-
|-
|ListWebTags=0
|UseDataLogger=1
|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.
|{{Version badge 1}}Cumulus 1.x.y: Selected in the Station Configuration Screen Settings block.
*0= (default) turn off creation of WebTags.txt file (stored in main Cumulus folder)
[[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.
*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)
*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.
|-
|WindUnit=0
|[[Wind_measurement#Wind_Speed|Wind speed measurement unit]] used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
*0 = m/s
*1 = mph
*2 = km/h ("kph" prior to version 1.8.3)
*3 = kts
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
|[[Pressure_Measurement]] unit used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
*0 = mb
*1 = hPa
*2 = in
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
|[[Rain_measurement]] unit used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
*0 = mm
*1 = in
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
|[[Temperature_(and_humidity)_measurement#Temperature_Scales|Temperature measurement unit]] used by Cumulus (as selected in the Units block of Station settings screen within '''Configuration''' menu)
*0 = Celsius
*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). If that is not the unit selected here, Cumulus will ensure the values are converted to either of the 2 listed during processing
|-
|LocName=
|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=
|A '''Description''' for the location (as entered on the same screen as other parameters) - inserted after 'Welcome to ' on 'Now' web page.
|-
|-
|LastLoggerDownload=13/08/2008 12:48:52  
|LastLoggerDownload=13/08/2008 12:48:52  
Line 682: Line 821:
|YTDrainyear=0  
|YTDrainyear=0  
|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'.
|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
|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
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  When set to 1 stops new Longest Wet/Dry Period records being 'flashed'
|-
|-
|UseCumulusForecast=0  
|UseCumulusForecast=0  
Line 703: Line 836:
*0 = Disabled
*0 = Disabled
*1 = Enabled
*1 = Enabled
|-
|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.  If the parameter is not included in the file, the default value is assumed.
|-
|-
|FCpressinMB=1  
|FCpressinMB=1  
Line 719: Line 849:
|-
|-
|CloudBaseInFeet=1  
|CloudBaseInFeet=1  
|Cloud base measurement unit as selected in same screen as other parameters
|Cloud base measurement unit as selected in same screen [[Cumulus_Screenshots#Display_as_at_version_1.8.8|(here from version_1.8.8)]] as other parameters. In MX you cannot change the default without adding this directly into file with MX stopped.
*0 = metres
*0 = metres
*1 = feet (default)
*1 = feet (default)
|-
|-
|RTdisconnectcount=N
|DataLogging=0
|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.  
|This parameter (attribute=value) determines if when you next start Cumulus it will send enhanced information to the [[debug]] file. It appears on a configuration screen in Cumulus 1 and in the station settings options section in MX. With Cumulus stopped, you can edit the setting in the file and the new setting will apply when Cumulus is next started and it sets a local value by reading the configuration file. Debugging can also be switched on while you are running Cumulus of any flavour, the new setting of enhanced debugging will stop when you exit Cumulus as you only edit the value held locally (you don't edit the configuration file).
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.
*0 = default of normal output
*1 = Set it to 1 to enable the enhanced output to the log that aids debugging if there is a problem.
 
The parameter is ignored for MX prior to build 3018 but available in all Cumulus 1 builds.
|-
|ErrorLogSpikeRemoval=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen on C1 or MX prior to v3.7.0. ??C1 keeps the number of messages in the error log window to a maximum of 256?
 
[[File:Badge vMx.png]] From version 3.7.0 the default for new installs is now 1. It can be set from the calibration settings screen. It controls the logging of both data spikes and data limits being exceeded. Recommended to be turned on.
|-
|-
|Logging=1
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|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
|Port=0
|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:
|{{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.
 
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]
[[File:Badge vMx.png]] This parameter is ignored by MX, best to remove it, MX uses a Comport parameter instead, see [[#Parameters_changed|#Parameters_changed section]] above.
|-
|-
|ErrorLogSpikeRemoval=0
|colspan="2" style="background:lightblue;"| Cumulus MX only
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. ??keeps the number of messages in the error log window to a maximum of 256?
|-
|-
|UVdecimals=0
|RecordSetTimeoutHrs=24
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
|[[File:Badge vMx.png]] From version 3.5.1, Cumulus MX  will set new records (available in [[Webtags#Extreme_Records|Extreme Records Web Tags]]) from the time of the record until a timeout value (default 24 hours). You can change the default timeout by adding this parameter, and changing the default '24' to the number of hours that suit you.  
UV values are now displayed and logged as whole numbers by default. You can change this by adding this entry specifying the number of decimal places. (added 1.9.3 build 1038)
 
*0 = Integer Values (default)
This parameter is not available in any earlier versions.
*n = Number of decimal places e.g. 1
|-
|-
|NoSensorCheck=1
|Logging=0
|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 parameter can be edited in the file or in station settings or by use of a parameter when starting MX. It controls whether MX stores extra diagnostic information about its interaction with the weather station.
The option (for 'incomplete' stations) to disable the sensor check described in this [https://cumuluswiki.org/a/FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads FAQ]
*0 = Sensor check enabled (default)
*1 = Sensor check disabled
|}
|}


==== Davis family specific: ====
==== Davis family specific: ====
{{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.
* 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.


"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.
{{Version badge 1}}Support for Davis Vantage pro 2 was introduced at version 1.6.0. Prior to 1.9.x, not all parameter settings listed were available, check with release notes for your version and previous versions to see all settings applicable to any earlier version you use. "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.
 
[[File:Badge vMx.png]] Please note that MX specific parameter settings appear after Cumulus 1 specific ones, but the many that are same for both flavours appear at start of table.


   
   
'''ADDITIONAL CUMULUS MX parameters - see [[Cumulus.ini_%28Beta%29#Davis_family_specific:|beta page here]]'''.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 773: Line 898:
|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.
|-
|-
|DavisRainCollectorModel=X
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. (Available from Build 1096 of version 1.9.4)
Option to specify rain collector model for Davis stations for situations where the Davis DLL is unable to read it from station, and your rain figures in Cumulus are incorrect as a result (can happen when using Virtual VP, for example).
Value X is an integer from 0 to 5 with the following meanings:
*0 = 0.1 inch
*1 = 0.01 inch
*2 = 0.2 mm
*3 = 1 mm
*4 = 'other' inch
*5 = 'other' mm
{{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  
|VP2SleepInterval=500
|This read-only parameter is the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds. The default if the parameter has not been added manually to the file is 500 ms; if you suspect that data is being missed, you could add this parameeter, manually reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions. See note in ''readme.txt'' about VP2SleepInterval - in v1.9.3 release it is around line 50. Related FAQ: [[FAQ#My_Davis_station_shows_a_higher_maximum_wind_speed_than_Cumulus]]
|-
|VPClosedownTime=x
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. x is the number of seconds after the start of the re-connect attempts that you want the program to close itself (added v.1.8.5 b.726).
|-
|DavisCalcAltPress=1
|This read-only 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.
 
[[File:Badge vMx.png]]'''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.
 
{{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.
Cumulus will then use the Sea-Level Pressure value instead of the Cumulus calculated Altimeter Pressure.
*0 = Disabled
*1 = Enabled (default)
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|-
|ForceVPBarUpdate=0  
|Set this in the Station Configuration Screen '''Settings''' block. Select to force the Vantage Pro (and Pro2) barometer to update once a minute instead of the default 15 minutes. Note that you may not need this, more recent stations already update every minute
|Set this in the Station Configuration Screen '''Settings''' block. Select to force the Vantage Pro (and Pro2) barometer to update once a minute instead of the default 15 minutes. Note that you may not need this, more recent stations already update every minute
*0 = Disabled
*0 = Disabled
Line 797: Line 932:
|-
|-
|ClockSettingHour=4
|ClockSettingHour=4
|Configuration file only setting, controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
|Configuration file read-only setting, controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*4 = 04:00 (default value)
*4 = 04:00 (default value)
*0-23 = 00:00 to 23:00
*0-23 = 00:00 to 23:00
Line 806: Line 941:
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
*2 = TCP/IP (see later parameters to specify ports)
*2 = TCP/IP (see later parameters to specify ports)
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP..
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
|-
|Port=0
|{{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.
|-
|-
|VP2TCPPort=22222  
|VP2TCPPort=22222  
Line 819: Line 950:
|Set this in the Station Configuration Screen  '''Davis TCP/IP Settings''' block.
|Set this in the Station Configuration Screen  '''Davis TCP/IP Settings''' block.
Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
|-
|VP2SleepInterval=500
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
This is the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds. The default is 500 ms; if you suspect that data is being missed, you could try reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions. See note in ''readme.txt'' about VP2SleepInterval - in v1.9.3 release it is around line 50. Related FAQ: [[FAQ#My_Davis_station_shows_a_higher_maximum_wind_speed_than_Cumulus]]
|-
|VPClosedownTime=x
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. x is the number of seconds after the start of the re-connect attempts that you want the program to close itself (added v.1.8.5 b.726).
|-
|-
|VP2PeriodicDisconnectInterval=0
|VP2PeriodicDisconnectInterval=0
Line 833: Line 957:
Set it to zero to disable, if you are not using the Weatherlink site.
Set it to zero to disable, if you are not using the Weatherlink site.
|-
|-
|DavisCalcAltPress=1
|LogExtraSensors=0
|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.
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
 
|-
'''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.
|colspan="2" style="background:lightblue;"|{{Version badge 1}}  Cumulus 1 only: edit in Station Configuration Screen or file as indicated
 
|-
{{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.
|DavisRainCollectorModel=X
 
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. (Available from Build 1096 of version 1.9.4)
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.
Option to specify rain collector model for Davis stations '''for situations where the Davis DLL is unable to read it from station''' (what it reads from station is default if this parameter is not present), and your rain figures in Cumulus are incorrect as a result (can happen when using Virtual VP, for example).
Cumulus will then use the Sea-Level Pressure value instead of the Cumulus calculated Altimeter Pressure.
Value X is an integer from 0 to 5 with the following meanings:
*0 = Disabled
*0 = 0.1 inch
*1 = Enabled (default)
*1 = 0.01 inch
*2 = 0.2 mm
*3 = 1 mm
*4 = 'other' inch
*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
|-
|-
|LogExtraSensors=0
|Port=0
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
|{{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.
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|{{Version badge 1}}This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
|[[File:Badge vMx.png]]This parameter is not available in MX.
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.
|}
 
====Introduced for problems with Fine Offset family:====
*These parameters were introduced for Cumulus to cope with Fine Offset stations and their clones, but a few of the parameters below may be found to be useful more widely.
*Some parameters are set on screens, other attributes do not appear in the '''cumulus.ini''' file unless they are added using an external editor, but the values still have a recommended default value as explained below.


{| class="wikitable" border="1"
{{Version badge 1}}This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
*0 (default) = Cumulus will just stop logging, and processing data, if it has had no data from the Davis station for 60 seconds. As it says in the Cumulus 1 help, use of this parameter may not fix a connection problem. With this default setting a connection problem stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
*1 = 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. Again, this may not fix the problem, but this setting does force Cumulus to have another attempt after making a new connection on start up.
|-
|-
!style="width:150px" | Parameter Line Entry
|Port=0
!style="width:600px" | Function
|{{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.
|-
|-
|style="background:lightgray;"|[Station]
|colspan="2" style="background:lightblue;"| Only available in Cumulus MX: edit in Station Settings or if read-only directly in file
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|RestartIfUnplugged=0
|UseDavisLoop2=1
|{{Version badge 1}}This is set in the settings frame on the Station settings screen off the configuration menu.
|{{Version badge 1}} Not applicable.
*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.
[[File:Badge vMx.png]]This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
*1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default.
 
The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
 
*0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.


Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.
|-
|DavisIPResponseTime=500
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger .  Default is 500ms, see Cumulus MX forum where times up to 2000ms are suggested.
|-
|ForceVPBarUpdate=0
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Added in build 3042 (January 2017). Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|-
|-
|SyncFOReads=0
|DavisIncrementPressureDP=0
|This is set in the settings frame on the Station settings screen off the configuration menu.
|[[File:Badge vMx.png]](from version 3.0.0 build 3042) A Cumulus.ini setting to turn off the 'extra' decimal place in pressure values on Davis stations. To limit the pressure to 1 decimal for mb/hPa and 2 for inHg, add this to the [Station] section
*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
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
|VPrainGaugeType=0
|Add this line to cumulus.ini [Station] section if you wish to change the default, this parameter used to fine-tune the previous parameter.
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The default is to assume that people using MM units to display rain in Cumulus have a Metric Rain Adapter fitted to their rain gauge so it tips for every 0.2mm, and those selecting inches as their unit have the unmodified 0.01" rain gauge. This parameter over-rides that assumption, but note that conversion rounding errors will then occur.


*3 = default value
Specifies the units selected on your Vantage Pro Rain Gauge.  Set to 0 for a 0.2mm gauge and 1 for a 0.01" gauge.
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.


NOTE: This setting supersedes the setting "DavisRainCollectorModel" used in Cumulus 1
|-
|-
|ReportLostSensorContact=0
|DataLogging=0
|Add this line to cumulus.ini [Station] section
|[[File:Badge vMx.png]]Set in options section of station settings page. Default is 0, change to 1 for more detailed Davis logging.
*0 = reporting off
*1 = reporting on (default)
*0 (default) = Cumulus MX will not add extra logging.
Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b.1070)
*1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large. (Build 3018 onwards).
 
I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards).|-
|-
|-
|UseZeroBearing=0
|AutoUpdateIpAddress=1
|Selected on same screen as other parameters. Intended for weather stations that do not supply a wind bearing, so Cumulus has to calculate it from reported compass direction.
|[[File:Badge vMx.png]](read-only, you cannot edit this on station settings screen, you must type it directly into file) default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
*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)
|-
|-
|EWdisablecheckinit=0  
|ZeroConfig
|[[File:Badge vMx.png]]set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|}
 
====Introduced for problems with Fine Offset family:====
*These parameters were introduced for Cumulus 1 to cope with Fine Offset stations and their clones, but a few of the parameters below may be found to be useful more widely.
*Some parameters are set on screens, other attributes do not appear in the '''cumulus.ini''' file unless they are added using an external editor, but the values still have a recommended default value as explained below.
*Apart from the 2 synchronising parameters, none apply to MX.
 
{| 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.
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|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.
*2 Minimum value
*3 = default value
Sets the interval (in seconds) during each 48 (or 60 for some models in Cumulus 1) 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.
 
Applicable to both Cumulus 1 and MX. MX applies both 48 and 60 second avoidances regardless of model.
|-
|ReportLostSensorContact=0
|Add this line to cumulus.ini [Station] section
*0 = reporting off
*1 = reporting on (default)
Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b.1070)
|-
|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).
|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.  
*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]]).
*1 = Ignores part of memory (see [[FAQ#When_I_start_Cumulus.2C_I_get_the_error_message_.22The_station_is_not_initialised.22]]).


Not applicable to MX.
|-
|-
|EWduplicatecheck=0
|EWduplicatecheck=0
Line 910: Line 1,079:
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).
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).


Not applicable to MX
|-
|-
|EWpressureoffset=x.y
|EWpressureoffset=x.y
Line 915: Line 1,085:
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 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]. Applies to Cumulus 1 and MX.
|-
|RestartIfUnplugged=0
|{{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
*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.


|}
Not applicable to MX
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|-
|SyncFOReads=0
|Cumulus 1 and MX
*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
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.
|}


==== Spike Removal ====
==== Spike Removal ====
Line 984: Line 1,168:


==== Reading File instead of weather station  ====
==== Reading File instead of weather station  ====
{{Version badge 1}}'''Requiring Cumulus to read Easyweather.dat instead of a station directly perhaps for Stations not recognised by Cumulus'''
 
 
{{Version badge 1}}Functionality added from version 1.7.12 (when Fine Offset could not be interrogated via USB): '''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 1,016: Line 1,202:


==== Oregon Scientific specific: ====
==== Oregon Scientific specific: ====
{{Version badge 1}}Support for Oregon stations was removed in version 1.6.0, missing from all subsequent 1.6.x versions, and restored from version 1.7.0. Some parameters are set on a configuration screen (as identified in individual entries), others have to be entered directly in this file.
[[File:Badge vMx.png]] The same parameters are available in MX in all versions, where they are set in a Cumulus 1 screen, they are set on the station settings page in MX, where they are set in this file for Cumulus 1, they are still set in file for MX.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,034: Line 1,225:
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors.
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors.
(Note this attribute appears in [[#Davis_family_specific|Davis family]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above and in [[#Instromet_station_specific:|Instromet station specific:]] table below with different usage explanations).
(Note this attribute appears in [[#Davis_family_specific|Davis family]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above and in [[#Instromet_station_specific:|Instromet station specific:]] table below with different usage explanations).
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|-
|WMR928TempChannel=N
|WMR928TempChannel=N
Line 1,051: Line 1,244:
|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.
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|-
|WS2300Sync=1
|WS2300Sync=1
Line 1,106: Line 1,301:
Note that you must have one RG-11 set to "It's raining" mode and the other to "tipping bucket" mode. Cumulus does not validate this.
Note that you must have one RG-11 set to "It's raining" mode and the other to "tipping bucket" mode. Cumulus does not validate this.
|}
|}
====Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific ====
[[File:Badge vMx.png]] This section only applies to MX. Note that the section in the file is called '''[GW1000]''', but as indicated above it applies to equivalent models.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[GW1000]
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|IPAddress=
|There is no default value, stores the IP address of your GW1000 WiFi logger, set via the station settings page.
|}


==== Instromet station specific: ====
==== Instromet station specific: ====
Line 1,116: Line 1,330:
|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.
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX.
|-
|-
|ImetWaitTime=200
|ImetWaitTime=200
|This parameter (attribute=value) if you need to change it from its '''default of 200 ms''' is added directly to the file, it does not appear on a configuration screen.  
|This parameter (attribute=value) if you need to change it from its '''default of 200 ms''' is added directly to the file, it does not appear on a configuration screen.  
Specifies the time in milliseconds that Cumulus allows for a response from an Instromet station. If you are having problems with reading from an Instromet station, try inserting this line into the ''Station'' section using a value of 500. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.
Specifies the time in milliseconds that Cumulus allows for a response from an Instromet station. If you are having problems with reading from an Instromet station, try inserting this line into the ''Station'' section using a value of 500. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus MX stopped. Only Cumulus MX.
|-
|ImetBaudRate=19200
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to manually set this value in Cumulus.ini before running the program.
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|-
|-
|SyncDavisClock=0  
|SyncDavisClock=0  
Line 1,134: Line 1,358:
|}
|}


=== Section: Offsets ===
Set most of these parameters in Cumulus 1 (available from version  1.8.1 onwards) using the '''Configuration''' menu and ''Calibration'' screen, the exception is 'TempMult2'.
Set these parameters in MX under the '''Settings''' tab using the '''Calibration''' screen, again excluding second order multipliers.


=== Section: Offsets ===
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 1,144: Line 1,371:
|style="background:lightgray;"|[Offsets]  
|style="background:lightgray;"|[Offsets]  
|style="background:lightgray;"|Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors
|style="background:lightgray;"|Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX.
|-
|TempMult2=1.0
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default second order multiplier is 1.0.
"Second order" multiplier by which measured outdoor Temperature is to be corrected, this means that the logged reading can be (TempMult2 X measured-temp X measured_temp) + (TempMult X measured_temp) + TempOffset
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Only MX (build 3045 onwards).
|-
|HumMult2=1.0
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default second order multiplier is 1.0.
"Second order" multiplier by which measured outdoor Humidity is to be corrected, this means that the logged reading can be (HumMult2 X measured_hum X measured_hum) + (HumMult X measured_hum) + HumOffset
|-
|-
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|-
|PressOffset=Offset_Value
|Default 'Offset_Value' is 0 in this parameter, used for formula: Cumulus pressure = Measured Pressure + 'Offset_Value'
|-
|-
|TempOffset=Offset_Value  
|TempOffset=Offset_Value  
|Default 'Offset_Value' is 0 in this parameter, used for quadratic formula shown below
|Default 'Offset_Value' is 0 in this parameter, used for quadratic formula shown for read-only parameter
|-
|-
|TempMult=1  
|TempMult=1  
|First order multiplier by which measured outdoor Temperature is to be corrected (default=1).
|First order multiplier by which measured outdoor Temperature is to be corrected (default=1).
For formula see next item.
For formula see read-only item.
|-
|-
|TempMult2=0.0
|HumMult=1
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default multiplier is 0.0.
|Multiplier by which measured Humidity is to be corrected (default=1). See formula in read-only parameter
"Second order" multiplier by which measured outdoor Temperature is to be corrected, this means that the logged reading can be (TempMult2 * measured-temp * measured_temp) + (TempMult * measured_temp) + TempOffset
|-
|-
|HumOffset=Offset_Value  
|HumOffset=Offset_Value  
|Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus Humidity = Measured Humidity + 'Offset_Value'
|Default 'Offset_Value' is 0 in this parameter used for formula in MX read-only parameter above
|-
|WetBulbMult=1
|First order multiplier by which measured Wet Bulb Temperature is to be corrected (default=1). See formula in next row
|-
|WetBulbOffset=0
|Default 'Offset_Value' is 0 in this parameter, used for formula: Cumulus wet bulb temperature = measured_wet_bulb X wet_bulb_multiplier + 'Offset_Value'
|-
|-
|WindDirOffset=Offset_Value  
|WindDirOffset=Offset_Value  
Line 1,178: Line 1,419:
|Multiplier by which measured [[Wind_measurement#Wind_Speed|Wind Gust]] Speed is to be corrected (default=1).
|Multiplier by which measured [[Wind_measurement#Wind_Speed|Wind Gust]] Speed is to be corrected (default=1).
|-
|-
|HumMult=1
|PressOffset=Offset_Value
|Multiplier by which measured Humidity is to be corrected (default=1).
|Default 'Offset_Value' is 0 in this parameter, used for formula: Cumulus pressure = Measured Pressure + 'Offset_Value'
|-
|-
|RainMult=1  
|RainMult=1  
|Multiplier by which measured Rainfall (and therefore rainfall rate too) is to be corrected (default=1).
|Multiplier by which measured Rainfall (and therefore rainfall rate too) is to be corrected (default=1).
|-
|UVMult=1
|Multiplier by which measured UV to be corrected (default=1). see formula in next row
|-
|-
|UVOffset=Offset_Value
|UVOffset=Offset_Value
|Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus UV level = Measured UV level + 'Offset_Value'
|Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus UV level = Measured_UV_level X UV_multiplier + 'Offset_Value'
|-
|colspan="3" style="background:lightblue;"| Cumulus 1 only
|-
|-
|UVMult=1
|DavisCalcAltPressOffset=Offset_Value
|Multiplier by which measured UV to be corrected (default=1).
|Default 'Offset_Value' is 0 in this Davis Altitude parameter, used for formula: Cumulus altimeter pressure = Calculated Altimeter Pressure + 'Offset_Value'
 
The calculated altimeter pressure (from build 792) uses
<pre>k1 := 0.190284; // discrepency with calculated k1 probably because Smithsonian used less precise gas constant and gravity values
k2 := 8.4184960528E-5; // (standardLapseRate / standardTempK) * (Power(standardSLP, k1)
Result := Power(Power(absolute_pressureHPa - 0.3, k1) + (k2 * elevationM), 1/k1);</pre>
 
Sea level pressure is strictly calculated from actual pressure making compensation for temperature and humidity variation with height and most stations supply a SLP, but in Cumulus terms where a station supplies absolute pressure only, a standard offset is used to correct that to sea level pressure. Altimeter pressure as used for reporting to APRS/CWOP, does not make this compensation for temperature and humidity, it assumes standard atmosphere, purely a compensation for altitude, so the above calculation is used, then this offset is used by Cumulus to re-calculate altimeter pressure.
|-
|-
|colspan="3" style="background:lightblue;"| Cumulus MX only
|colspan="3" style="background:lightblue;"| Cumulus MX only
Line 1,195: Line 1,448:
|Cumulus MX only from version 3.2: First order multiplier by which measured Pressure (in above formula) is to be corrected (default=1).
|Cumulus MX only from version 3.2: First order multiplier by which measured Pressure (in above formula) is to be corrected (default=1).
|-
|-
|
|SolarMult=1.0
|Solar multiplier
|Solar multiplier
|-
|-
|
|SolarOffset=0.0
| Solar offset
| Solar offset
|}
|}
Line 1,222: Line 1,475:


=== Section: FTP site ===
=== Section: FTP site ===
NOTE: The word site should be in lower case as shown in left-hand column heading and above.
[[File:Badge vMx.png]]NOTE: For MX, 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.
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]].
This Wiki discusses the most basic of these settings on [[Simple_Website_setup|simple web site set up 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 of Customised templates]].
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function  
!style="width:900px" | Function  
|-
|-
|style="background:lightgray;"|[FTP site]  
|style="background:lightgray;"|[FTP site]  
Line 1,238: Line 1,491:
|-
|-
|DailyProgram=  
|DailyProgram=  
|Selected in the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
|In Cumulus 1, set in the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
*default - none
*default - none
|-
|-
|DailyParams=
|DailyParams=
|Selected in the '''Params''' box alongside the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  
|In Cumulus 1, set 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.
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]].
|In Cumulus 1, set 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]].
''If you host your web site yourself, then "'''Host=localhost'''" might be appropriate''.
''If you host your web site yourself, then "'''Host=localhost'''" might be appropriate''.


Line 1,253: Line 1,506:
|-
|-
|Port=21  
|Port=21  
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.
|In Cumulus 1, set 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.
Port used for FTP upload, default as shown is the normal port.
|-
|-
|Username=  
|Username=  
|Select your web site FTP log-in Username in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block
|In Cumulus 1, set your web site FTP log-in Username in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block
|-
|-
|Password=  
|Password=  
Line 1,263: Line 1,516:
|-
|-
|Directory=  
|Directory=  
|Selected in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  Directory (including path) on your server to which FTP will upload the files.  
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in web site block.  Directory (including path) on your server to which FTP will upload the files.  
*value is left Blank, default, the root position specified by ftp server (see Host above)  
*value is left Blank, default, the root position specified by ftp server (see Host above)  
*A path from the starting point as the position specified by ftp server (see Host above)
*A path from the starting point as the position specified by ftp server (see Host above)
|-
|-
|IncludeSTD=1  
|IncludeSTD=1  
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Include Standard Files'' at the top of  ''Files'' Tab screen
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu by the ''Include Standard Files'' at the top of  ''Files'' Tab screen
*0 = Disabled
*0 = Disabled
*1 = Enabled, (default) the standard web files provided with Cumulus will be processed and uploaded at each automatic or manual web update to the FTP root or any 'Directory' you have specified (see above).
*1 = Enabled, (default) the standard web files provided with Cumulus will be processed and uploaded at each automatic or manual web update to the FTP root or any 'Directory' you have specified (see above).
|-
|-
|AutoUpdate=0  
|AutoUpdate=0  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Auto Update''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Auto Update''.
*0 = Disabled, an upload will only occur if ''Web upload'' is selected manually either from the '''File''' menu or the right click menu if Cumulus is minimised.
*0 = Disabled, an upload will only occur if ''Web upload'' is selected manually either from the '''File''' menu or the right click menu if Cumulus is minimised.
*1 = Enabled, Cumulus will automatically upload your processed web pages to your web site at regular intervals (as specified by the 'Update ''Interval'' ' - see below) using FTP to the directory as specified in 'Directory' (see above).
*1 = Enabled, Cumulus will automatically upload your processed web pages to your web site at regular intervals (as specified by the 'Update ''Interval'' ' - see below) using FTP to the directory as specified in 'Directory' (see above).
|-
|-
|ActiveFTP=0
|FTPlogging=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use active FTP mode''.
|Set (Cumulus 1) by selecting ''FTP Logging'' in '''Configuration''' menu, or by adding this line to 'FTP site' section of Cumulus.ini.
*0 = Disabled (default)
*0 (default) = Cumulus will not store messages from FTP server.
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
*1 = Cumulus will show the messages sent to, and responses from, the FTP server.
 
{{Version badge 1}} Cumulus 1 stores this output in [[ftplog.txt]].
 
[[File:Badge vMx.png]] MX stores this output in the same [[ftplog.txt] file. However as MX allows use of alternative secure protocols instead of standard FTP, remember this file is designed for standard non-secure protocol transfers, so for secure transfers some useful information may be in standard [[MXDiags]] file.
|-
|MaxFTPconnectRetries=3
|Set in this config file only.
 
Allow configurable max FTP connect retries (default is retry up to 3 times).
|-
|ActiveFTP=0
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use active FTP mode''.
*0 = Disabled (default)
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
|-
|-
|FTPRename=0
|FTPRename=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use FTP rename''.
|In Cumulus 1 (available from version 1.8.1), set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use FTP rename''.
*0 = Disabled (default), no name change after uploading onto the server
*0 = Disabled (default), no name change after uploading onto the server
*1 = Enabled,  the new update is loaded using temporary names, files are renamed on the sever afterwards
*1 = Enabled,  the new update is loaded using temporary names, files are renamed on the sever afterwards
|-
|-
|DeleteBeforeUpload=0  
|DeleteBeforeUpload=0  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Delete before upload''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Delete before upload''.
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled, files are deleted from sever before the new update is loaded
*1 = Enabled, files are deleted from sever before the new update is loaded
|-
|-
|UpdateInterval=15  
|UpdateInterval=15  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab in '''Interval''' box.  The interval in minutes at which you wish Standard (not real-time) updates (either FTP to your website, or copy to a local directory on your pc) to automatically occur.  Default 15 minutes.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab in '''Interval''' box.  The interval in minutes at which you wish Standard (not real-time) updates (either FTP to your website, or copy to a local directory on your pc) to automatically occur.  Default 15 minutes.
|-
|-
|ExternalProgram=
|ExternalProgram=
|Selected in the '''Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'normal' web update interval, after all of the other processing has been performed.
|In Cumulus 1, set in the '''Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'normal' web update interval, after all of the other processing has been performed.
|-
|-
|ExternalParams=
|ExternalParams=
Line 1,302: Line 1,569:
|-
|-
|EnableRealtime=0  
|EnableRealtime=0  
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime''.
*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 1,313: Line 1,580:
|-
|-
|RealtimeFTPEnabled=0
|RealtimeFTPEnabled=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime FTP''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime FTP''.
*0 = Disabled (default), without FTP it is only possible to upload files at the realtime interval if the required remote location is on same device as that running Cumulus.
*0 = Disabled (default), without FTP it is only possible to upload files at the realtime interval if the required remote location is on same device as that running Cumulus.
*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.
*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.
Line 1,320: Line 1,587:
|-
|-
|RealtimeTxtFTP=0
|RealtimeTxtFTP=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime.txt FTP''.
|In Cumulus 1, set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime.txt FTP''.
When set to 1 Cumulus will upload the [[realtime.txt]] to your web site during realtime processing. The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.
When set to 1 Cumulus will upload the [[realtime.txt]] to your web site during realtime processing. The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.
|-
|-
Line 1,333: Line 1,600:
|-
|-
|RealtimeProgram=
|RealtimeProgram=
|Selected in the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'realtime' web update interval, after all of the processing has been performed.
|In Cumulus 1, set in the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'realtime' web update interval, after all of the processing has been performed.
|-
|-
|RealtimeParams=
|RealtimeParams=
|Selected in the '''Params''' box alongside the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'RealtimeProgram' used to specify any parameters to be passed to that command.
|In Cumulus 1, set in the '''Params''' box alongside the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'RealtimeProgram' used to specify any parameters to be passed to that command.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|colspan="2" style="background:lightblue;"| Cumulus 1 only
Line 1,345: Line 1,612:
*1 = Enabled,(default) the standard image files generated by Cumulus 1 (moon, graphs, etc)  will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
*1 = Enabled,(default) the standard image files generated by Cumulus 1 (moon, graphs, etc)  will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|-
|Logging=0
|ResizeGraphs=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|Set in the ''Internet'' option of '''Configuration''' menu in Web graphs block.  
Note that if set on the user interface, it only remains set while Cumulus continues to run (in Cumulus 1 and MX, it defaults to off on restart).  
*0 = Disabled (default) Cumulus uploads the default 750 x 300 pixel graphs.
*0 (default) = Cumulus 1 or MX will not add debug logging.
*1 = Cumulus resizes the large graph images when creating them for upload to your web site. Specify the required height and width in the corresponding boxes of same Web graphs block (see below for related parameters). Note that the images are simply scaled to the new size; there will be some loss of quality.  
*1 = For '''debug''' logging when Cumulus 1 or MX (re-)starts, add ''Logging=1'' to the station section of Cumulus.ini while Cumulus is stopped.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only - Internet Settings screen
|GraphHeight=300
|Graph height, default is 300 (pixels) - see previous parameter
|-
|-
|RealtimeGaugesTxtFTP=0
|GraphWidth=750
|This parameter controls whether the file needed for the steel series Gauges plot is updated by FTP at the realtime interval
|Graph width, default is 750 (pixels) - see ResizeGraphs parameter
*0 (default) = the file is only uploaded at the standard interval
*1 = the file is uploaded by FTP at the real time interval
|-
|-
|DisableEPSV=0
|ImageFolder=
|(Add this directly to the Cumulus.ini file with Cumulus stopped, it is not available on the Internet Settings page) The default is 0, change to 1 to Disable the Extended Passive FTP-mode.
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Copy Images to folder'' at the bottom of  ''Files'' Tab screen.
*value is blank (default) no action
*Path and file name in LOCAL folder to which the generated image files are also copied after each upload, either at manual web update and the 'normal' automatic interval, or the 'real time' interval, depending on next parameter.  Used if you want backups of generated images. See Cumulus Help.
|-
|-
|IncludeMoonImage=1
|ImageCopyRealtime=0
|[[File:Badge vMx.png]] Cumulus MX (from version 3.5.0) uploads only one image (moon), control whether it is uploaded in the Internet Settings screen.
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Realtime?'' at the bottom of  ''Files'' Tab screen.  
*0 = Disabled
*0 = (default) the generated image files are copied at each manual web update and automatically in 'normal' interval
*1 = Enabled,(default) the standard image file generated by Cumulus MX (moon only) will be uploaded at first (after MX is started) automatic web update to a sub-folder of the 'Directory' you specified called by the name specified in [[#Graphs|[Graphs] section]], and uploaded again each hour on the hour showing any change in the phase in the preceding hour. You can choose which sub-folder (default 'images') in the MX internet settings page
*1 = the generated image files are copied in 'real time' interval.  
|-
|IncludeSolarChart=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Solar'' at the top of  ''Files'' Tab screen.
*0 = Disabled (default)
*1 = Enabled, the optional solar graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|-
|ComportName=/dev/ttyUSB0
|IncludeUVChart=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.  
|Set in the ''Internet'' option of '''Configuration''' menu by the ''UV'' at the top of  ''Files'' Tab screen.
You can set the serial port name in the MX user interface, but if for some reason you want to do it by editing Cumulus.ini, note that the item in MX is called ComportName (which is a string, for the full device name, e.g. COM1 or /dev/ttyUSB0) rather than 'Port' which is just an integer
*0 = Disabled (default)
*1 = Enabled, the optional UV graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|-
|DisableFtpsExplicit=0
|IncludeSunshineChart=0
|(Add to Cumulus.ini file, no option in station settings screen) Default 0 use Explicit FTPS; Change to 1 to use Implicit mode
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Sunshine'' at the top of  ''Files'' Tab screen.
*0 = Disabled (default)
*1 = Enabled, the optional sunshine graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|-
|colspan="3" style="background:lightblue;"| Cumulus MX only - Extra Web Files screen
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|-
|-
|ExtraLocalxx=
|ExtraLocalxx=
|Where 'xx' varies between 0 and 99; used to specify path to local file that is to be optionally processes by Cumulus, to be copied or FTPed to another location at interval indicated
|Where 'xx' varies between 0 and 99; used to specify path to local file that is to be optionally processed by Cumulus, then to be copied or FTPed to another location at interval indicated
You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) on its own to represent the name of the standard log file that is currently being used.
 
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
 
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface. From build 3087, MX also allows you to use "<currentextralogfile>" to specify the name of the extra sensor log files being currently used.
|-
|-
|ExtraRemotexx=
|ExtraRemotexx=
|Where 'xx' varies between 0 and 99; used to specify path to remote file that is created by Cumulus, by being copied or FTPed from local location set above at interval indicated below
|Where 'xx' varies between 0 and 99; used to specify path to remote file that is created by Cumulus, by being copied or FTPed from local location set above at interval indicated below.
You can use "<currentlogfile>" (all versions of Cumulus 1 or MX) on its own to represent the name of the standard log file that is currently being used, or as part of another file specifier if you want a different destination file to be used each month (so those for previous months are not overwritten).
 
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
 
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface. From build 3087, MX also allows you to use "<currentextralogfile>" to specify the name of the extra sensor log files being currently used.
|-
|-
|ExtraProcessxx=0
|ExtraProcessxx=0
|Where 'xx' varies between 0 and 99; used to specify if file named in ExtraLocal parameter is a template containing web tags and needs to be processed by Cumulus before it is copied or FTPed to remote location
|Where 'xx' varies between 0 and 99; used to specify if file named in ExtraLocal parameter is a template containing web tags and needs to be processed by Cumulus before it is copied or FTPed to remote location
*0 (default) = no processing required as local file does not contain web tags
*0 (default) = no processing required as local file does not contain web tags
*1 = file contains web tags and needs to be processed
*1 = file contains web tags and needs to be processed  
 
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
 
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|-
|ExtraBinaryxx=0
|ExtraBinaryxx=0
|Where 'xx' varies between 0 and 99; The format of the file named in Extra Local
|Where 'xx' varies between 0 and 99; The format of the file named in Extra Local
*0 (default) = File to be treated as being in ASCII or UTF format (another option later allows you to choose between these)  
*0 (default) = File to be treated as being [[Webtags#Encoding|encoded]] in ISO-8859-1 or UTF-8 format (another option later allows you to choose between these). use this to transfer any file that can be viewed in a text editor, such as log files, web pages, javaScript files, and PHP scripts.
*1 = file to be treated as being in binary format
*1 = file to be treated as being in binary format. Use this to transfer images, executable files, and other files that cannot be read with a text editor.
 
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
 
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|-
|ExtraRealtimexx=0
|ExtraFTPxx=1
|Where 'xx' varies between 0 and 99; if the file named in ExtraLocal is to be uploaded at realtime interval (requires that interval to be enabled, and if FTP is to be used required FTP to be enabled at that interval (see earlier for those options in Cumulus 1 and MX section).
|Where 'xx' varies between 0 and 99; whether the file upload is to use File Transfer process
*0 (default) = Not to be uploaded at real-time interval
*0= File named in ExtraLocal is to be uploaded by copying from local to remote location (used when web server is on same machine or network as local files)
*1 = to be uploaded at realtime interval, end of day interval must be set to 0.
*1 (default) = File named in ExtraLocal is to be uploaded by FTP (will work whether web server is on same local network or on some remote host)
 
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
 
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|ExtraUTFxx= 0
|Where 'xx' varies between 0 and 99; whether the file is to treated as in UTF-8 (a format that supports a wider range of characters and therefore more languages than alternative). Note that the "binary" option mentioned earlier overrides this setting if that is set to 1.
*0 (default) = File to be treated as being [[Webtags#Encoding|encoded]] in ISO-8859-1
*1 (recommended)= File to be treated as being [[Webtags#Encoding|encoded]] in UTF-8 format
 
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
 
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|ExtraRealtimexx=0
|Where 'xx' varies between 0 and 99; if the file named in ExtraLocal is to be uploaded at realtime interval (requires that interval to be enabled, and if FTP is to be used required FTP to be enabled at that interval (see earlier for those options in Cumulus 1 and MX section).
*0 (default) = Not to be uploaded at real-time interval
*1 = to be uploaded at real-time interval, For MX only note that end of day interval must be set to 0.
 
{{Version badge 1}}For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
 
[[File:Badge vMx.png]]All of 0 to 99 are added using "Extra web files" screens in the settings menu of the admin interface.
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only - Internet Settings screen
|-
|-
|ExtraEODxx=0
|ExtraEODxx=0
|Where 'xx' varies between 0 and 99; if the file named in ExtraLocal is to be uploaded after end of meteorological day
|[[File:Badge vMx.png]]. Only available in MX. Where 'xx' varies between 0 and 99; if the file named in ExtraLocal is to be uploaded after end of meteorological day
*0 (default) = Not to be uploaded at end of day
*0 (default) = Not to be uploaded at end of day
*1 = to be uploaded at end of day, the realtime interval must be set to 0.
*1 = to be uploaded at end of day, the realtime interval must be set to 0.
Line 1,403: Line 1,720:
|colspan="2"| If both the above 2 parameters are set to 0, the upload will be at standard uploading interval
|colspan="2"| If both the above 2 parameters are set to 0, the upload will be at standard uploading interval
|-
|-
|ExtraFTPxx=1
|RealtimeGaugesTxtFTP=0
|Where 'xx' varies between 0 and 99; whether the file upload is to use File Transfer process
|[[File:Badge vMx.png]]This parameter controls whether the file needed for the steel series Gauges plot is updated by FTP at the real-time interval
*0= File named in ExtraLocal is to be uploaded by copying from local to remote location (used when web server is on same machine as local files)
*0 (default) = the file is only uploaded at the standard interval
*1 (default) = File named in ExtraLocal is to be uploaded by FTP (will work whether web server is on same machine or on some remote host)
*1 = the file is uploaded by FTP at the real time interval
|-
|-
|ExtraUTFxx= 0
|DisableEPSV=0
|Where 'xx' varies between 0 and 99; whether the file is to treated as in UTF (a format that supports a wider range of characters and therefore more languages than ASCII)
|[[File:Badge vMx.png]](Add this directly to the Cumulus.ini file with Cumulus stopped, it is not available on the MX Internet Settings page) The default is 0, change to 1 to Disable the Extended Passive FTP-mode.
|-
|-
|colspan="3" style="background:lightblue;"| Cumulus 1 only
|IncludeMoonImage=1
|[[File:Badge vMx.png]] Cumulus MX (from version 3.5.0) uploads only one image (moon), control whether it is uploaded in the MX Internet Settings screen.
*0 = Disabled
*1 = Enabled,(default) the standard image file generated by Cumulus MX (moon only) will be uploaded at first (after MX is started) automatic web update to a sub-folder of the 'Directory' you specified called by the name specified in [[#Graphs|[Graphs] section]], and uploaded again each hour on the hour showing any change in the phase in the preceding hour. You can choose which sub-folder (default 'images') in the MX internet settings page
|-
|-
|ResizeGraphs=0
|ComportName=/dev/ttyUSB0
|Set in the ''Internet'' option of '''Configuration''' menu in Web graphs block.  
|[[File:Badge vMx.png]]This parameter (attribute=value) can be added directly to the file with MX stopped, but it is best to set the serial port name in the MX admin interface.
*0 = Disabled (default) Cumulus uploads the default 750 x 300 pixel graphs.
 
*1 = Cumulus resizes the large graph images when creating them for upload to your web site. Specify the required height and width in the corresponding boxes of same Web graphs block (see below for related parameters). Note that the images are simply scaled to the new size; there will be some loss of quality.
If you have moved from Cumulus 1 to MX, and for some reason you want to edit Cumulus.ini, note that the item called ComportName has to be added for MX and that it is a string, for the full device name, e.g. COM1 or /dev/ttyUSB0; while the Cumulus 1 'Port' parameter which is just an integer is no longer needed and should be deleted from the file.
|-
|-
|GraphHeight=300
|DisableFtpsExplicit=0
|Graph height, default is 300 (pixels) - see previous parameter
|[[File:Badge vMx.png]](Add to Cumulus.ini file, no option in station settings screen) Default 0 use Explicit FTPS; Change to 1 to use Implicit mode
|-
|-
|GraphWidth=750
|}
|Graph width, default is 750 (pixels) - see ResizeGraphs parameter
 
=== Section: MySQL ===
 
Not applicable to Cumulus 1.
 
[[File:Badge vMx.png]]Only applicable to Cumulus MX.
 
 
Cumulus MX uses Cumulus.ini to store the MySQL configuration details.
All details are input on '''The MySQL settings screen'''. Here are the default settings. See [[Cumulus MX]] page for examples of what can be selected.
<pre>
[MySQL]
Host=127.0.0.1
Port=3306
User=
Pass=
Database=database
MonthlyMySqlEnabled=0
RealtimeMySqlEnabled=0
DayfileMySqlEnabled=0
MonthlyTable=Monthly
DayfileTable=Dayfile
RealtimeTable=Realtime
RealtimeRetention=
CustomMySqlSecondsCommandString=
CustomMySqlMinutesCommandString=
CustomMySqlRolloverCommandString=
CustomMySqlSecondsEnabled=0
CustomMySqlMinutesEnabled=0
CustomMySqlRolloverEnabled=0
CustomMySqlSecondsInterval=10
CustomMySqlMinutesIntervalIndex=6</pre>
 
=== Section: Display ===
 
{{Version badge 1}}Set the majority of these parameters using Configuration menu and [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|either ''Display'' or ''Colours'' screens]] as seen on link and indicated below.  The exception is "TwelveHourClock", that parameter is set by clicking on the displayed time.
 
[[File:Badge vMx.png]]The only settings used in this section by Cumulus MX are "NumWindRosePoints" and those for extras.
 
{| class="wikitable" border="1"
|-
|-
|ImageFolder=
!style="width:150px" | Parameter Line Entry
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Copy Images to folder'' at the bottom of  ''Files'' Tab screen.
!style="width:600px" | Function
*value is blank (default) no action
*Path and file name in LOCAL folder to which the generated image files are also copied after each upload, either at manual web update and the 'normal' automatic interval, or the 'real time' interval, depending on next parameter.  Used if you want backups of generated images. See Cumulus Help.
|-
|-
|ImageCopyRealtime=0
|style="background:lightgray;"|[Display]
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Realtime?'' at the bottom of  ''Files'' Tab screen.
|style="background:lightgray;"|Section heading - the following parameters affect how the main screen looks.
*0 = (default) the generated image files are copied at each manual web update and automatically in 'normal' interval
*1 = the generated image files are copied in 'real time' interval.  
|-
|-
|IncludeSolarChart=0
|Heading=My Weather
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Solar'' at the top of  ''Files'' Tab screen.
|{{Version badge 1}}Title Heading on the Main Screen. Set in the Display Configuration Screen General block
*0 = Disabled (default)
*1 = Enabled, the optional solar graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|-
|IncludeUVChart=0
|SavePosition=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''UV'' at the top of  ''Files'' Tab screen.
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*0 = Disabled (default)
*0= default, each time Cumulus 1 starts the main window will be displayed in the middle of the main, or only, monitor connected to your pc
*1 = Enabled, the optional UV graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
*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. This will place it on any monitor connected to your PC.
|-
|-
|IncludeSunshineChart=0
|StartMinimised=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Sunshine'' at the top of  ''Files'' Tab screen.
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*0 = Disabled (default)
*0= default, the main window will be displayed on the main or only monitor connected to your pc
*1 = Enabled, the optional sunshine graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.  
*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).
|-
|-
|ExtraLocal[0-9]=
|MinimizeToTray=0  
|Set in the ''Internet'' option of '''Configuration''' menu by an entry in the ''Local'' column of the table on the  ''Files'' Tab screen.
|{{Version badge 1}}Set in the Display Configuration Screen General block
*value is blank (default)
*0 = Disabled (default), Cumulus will minimise to the task bar
*Path and file name on local computer for alternate files #0 through #9. See cumulus '''Help''' for details of how to specify reading current monthly log here.
*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).
|-
|-
|ExtraLocal[10-99]=  
|ForecastCentred=0
|Path and file name on local computer for alternate file #10 through #99. These additional files can only be selected by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
|{{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
*1 = Enabled, Forecast appears centred horizontally on main screen below sun and moon details
|-
|-
|ExtraRemote[0-9]=  
|FontColour=4227327
|Set in the ''Internet'' option of '''Configuration''' menu by an entry in the ''Local'' column of the table on the ''Files'' Tab screen.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the screen font color
*value is blank (default)
*Path and file name on web server for alternate files #0 through #9. Set in Internet Configuration Screen Files tab. See cumulus Help for details of how to specify creating current monthly log here.
|-
|-
|ExtraRemote[10-99]=  
|BackColour=12632256
|Path and file name on web server for alternate file #10 through #99. These additional paths/files can only be selected by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the application background color
|-
|-
|ExtraProcess[0-9]=0
|HeadingColour=10485760
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Process?'' column of the table on the ''Files'' Tab screen.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the screen heading color
*0 = Disabled, (default) extra file will not pass through the cumulus 'tag processor'.
*1 = Enabled, extra file will be passed through the 'tag processor' in Cumulus, in the same way that the standard Cumulus web pages are. This allows to you to create your own web pages into which Cumulus will insert the various weather parameters. See the "Web tags" section of the help file for a list of the tags which you can use. Cumulus will create a temporary file to hold the processed version of your file and then upload that.
|-
|-
|ExtraProcess[10-99]=0
|ClockDigitColour=4227327
|Set in this config file only, they cannot be entered on any Configuration screen.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the figures on clock in top right corner of main screen
*0 = Disabled, alternate file #10 through #99 will not pass through the cumulus 'tag processor'.
*1 = Enabled, alternate file #10 through #99 will be passed through the 'tag processor' in Cumulus, in the same way that the standard Cumulus web pages are. This allows to you to create your own web pages into which Cumulus will insert the various weather parameters. See the "Web tags" section of the help file for a list of the tags which you can use. Cumulus will create a temporary file to hold the processed version of your file and then upload that
|-
|-
|UTF8encode=1
|ClockColour=16777201
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as '''UTF-8 encode''' from build 1093.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the main screen clock background color
*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
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  
|TwelveHourClock=0  
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''UTF-8?'' column of the table on the  ''Files'' Tab screen from build 1093.
|{{Version badge 1}}Set by left click on clock on main screen
*0 = Default, Customised/extra Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*0 = 24Hr clock mode
*1 = Customised/extra Cumulus Web Templates are processed into '''charset=utf-8''' web pages
*1 - 12 Hr am/pm clock mode
|-
|-
|ExtraUTF[10-99]=0
|WMR928Channel1Caption=Extra channel 1
|Set in this config file only.
|Set in the Display Configuration Screen ''WMR928 extra channel captions'' block. Note that the extra channel data for WMR928 stations is only displayed on the main screen if ''Display solar/extra data'' is Set in the Display Configuration Screen General block (see previous parameter). This parameter defines the caption to be used when Cumulus reads observations from the extra sensor.
*0 = Default from build 1093, Customised Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*1 = Customised Cumulus Web Templates are processed into '''charset=utf-8''' web pages from build 1093
|-
|-
|ExtraBinary[0-9]=0
|WMR928Channel2Caption=Extra channel 2
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Binary?'' column of the table on the  ''Files'' Tab screen.
|See previous parameter.
*0 = not binary (if pure ASCII characters)
*1 = Binary (e.g. images)
In general, setting to one is safest, but the default is zero.
|-
|-
|ExtraBinary[10-99]=0
|WMR928Channel3Caption=Extra channel 3
|Set in this config file only.
|See 'WMR928Channel1Caption=Extra channel 1' parameter
*0 = alternate file #10 through #99 is not binary (is pure ASCII characters)
*1 = alternate file #10 through #99 is Binary (e.g. images)
|-
|-
|ExtraRealtime[0-9]=0
|SnowUnitText=cm
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Realtime?'' column of the table on the ''Files'' Tab screen.
|Set in ''Snow units'' box in the Display Configuration Screen ''General'' block. Default is cm.
*0 = Disabled, (default) file uploaded as part of normal upload
 
*1 = Enabled, file uploaded during Realtime upload
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)!
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  
|DisplayCloudBase=0  
|Set in this config file only.
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*0 = Disabled, alternate file #10 through #99 uploaded as part of normal upload
*0 = Disabled, (default)
*1 = Enabled, alternate file #10 through #99 uploaded during Realtime upload
*1 = Enabled, the calculated cloud base is displayed on the main screen. The calculation is a simple one; 1000 feet for every 4.5 degrees Fahrenheit difference between the temperature and the dew point.
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
|DisplayHumidex=0  
|Set in Internet Configuration Screen Files tab.
|{{Version badge 1}}Set in the Display Configuration Screen General block
*0 = Disabled, File copied to the location specified in the Remote Filename box.
*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, (default) File uploaded  by FTP
*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.)
Not intended for standard Cumulus web pages (tick box at top of screen, missing files will be ignored), nor for NOAA reports (FTF for them set up in '''NOAA Setup''' within Configuration menu).
|-
|-
|ExtraFTP[10-99]=1
|DisplaySolarData=0
|Set in this config file only.
|{{Version badge 1}}Set by ''Display solar/extra data'' item in the Display Configuration Screen ''General'' block.
*0 = Disabled, alternate file #10 through #99 ''copied'' to the location specified in the Remote Filename box.
*0 = Disabled (default)
*1 = Enabled, alternate file #10 through #99 ''uploaded by FTP'' to the location specified in the Remote Filename box.
*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
(Copying is appropriate if you have a local web server on your computer or network, FTP needed if your server is hosted elsewhere)
**Panel displays ''Evapotranspiration (ET)'', ''Ultraviolet (UV)'' and ''Solar radiation'' if station '''Type''' is Vantage Pro and solar data is available
|-
|-
|FTPlogging=0
|DisplayStormRain=0
|Set (Cumulus 1) by selecting ''FTP Logging'' in '''Configuration''' menu, or by adding this line to 'FTP site' section of Cumulus.ini.
|{{Version badge 1}}Set by ''Display 'Storm Rain' '' item in the Display Configuration Screen ''General'' block.
*0 (default) = Cumulus will not store messages from FTP server.
*0 = Disabled, (default)
*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.
*1 = Enabled, adds an extra output to the main screen to show what Davis stations report as Storm Rain
|-
|-
|MaxFTPconnectRetries=3
|ShowCurrentConditions=0
|Set in this config file only.
|Set in the Display Configuration Screen General block
 
*0 = Disabled, (default)
Allow configurable max FTP connect retries (default is retry up to 3 times).
*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.
|}
 
=== Section: Display ===
{{Version badge 1}}Set the majority of these parameters using Configuration menu and [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|either ''Display'' or ''Colours'' screens]] as seen on link and indicated below.  The exception is "TwelveHourClock", that parameter is set by clicking on the displayed time.
 
[[File:Badge vMx.png]]The only settings used in this section by Cumulus MX are "NumWindRosePoints" and those for extras.
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
|LegendSymbolWidth=3
!style="width:600px" | Function
|{{Version badge 1}}Set in the Display Configuration Screen Graph block. The width of the plot lines in graph legends
|-
|-
|style="background:lightgray;"|[Display]
|ChartLineWidth=2
|style="background:lightgray;"|Section heading - the following parameters affect how the main screen looks.
|{{Version badge 1}}Set in the Display Configuration Screen Graph block. The width of the plot lines in the graph body
|-
|-
|Heading=My Weather
|WindGaugeRange=50
|{{Version badge 1}}Title Heading on the Main Screen. Set in the Display Configuration Screen General block
|{{Version badge 1}}Set in the Display Configuration Screen General block. Value represents the default full scale deflection of the top of the 3 wind plots in the wind speed units you have selected. Default value is 50 in that unit.
|-
|-
|SavePosition=0
|WindGaugeArcColour=16773091
|{{Version badge 1}}Set in the Display Configuration Screen General block.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
*0= default, each time Cumulus 1 starts 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. This will place it on any monitor connected to your PC.
|-
|-
|StartMinimised=0
|WindGaugeAnimated=1
|{{Version badge 1}}Set in the Display Configuration Screen General block.
|{{Version badge 1}}Set by ''Wind gauge animated'' item in the Display Configuration Screen ''General'' block. Animate the Wind Gauge pointer movement
*0= default, the main window will be displayed on the main or only monitor connected to your pc
*0 = Disabled,
*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 = Enabled (default)
|-
|-
|MinimizeToTray=0
|WindGaugeAnimationFactor=2
|{{Version badge 1}}Set in the Display Configuration Screen General block
|{{Version badge 1}}Set in the Display Configuration Screen. This sets the speed of the wind gauge animation. Lower values correspond to a faster animation speed. Be careful not to set the animation too slow, particularly with stations which update frequently (e.g. Davis) as the animation will never catch up, and will use significant CPU time.
*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).
|-
|-
|ForecastCentred=0
|WindGaugeTickColour=9841920
|{{Version badge 1}}Set in the Display Configuration Screen General block.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
*0 = Disabled, (default) Forecast appears left justified on main screen below sun and moon details
*1 = Enabled, Forecast appears centred horizontally on main screen below sun and moon details
|-
|-
|FontColour=4227327
|WindGaugeFontColour=9841920
|{{Version badge 1}}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 upper of the 3 wind plots
|-
|-
|BackColour=12632256
|WindGaugeInnerCircleColour=16765615
|{{Version badge 1}}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 upper of the 3 wind plots
|-
|-
|HeadingColour=10485760
|WindGaugeNeedleColour=128
|{{Version badge 1}}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 upper of the 3 wind plots
|-
|-
|ClockDigitColour=4227327
|WindGaugeInnerCentreColourFrom=16765615
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the figures on clock in top right corner of main screen
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|-
|-
|ClockColour=16777201
|WindGaugeInnerCentreColourTo=16765615
|{{Version badge 1}}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 upper of the 3 wind plots
|-
|-
|TwelveHourClock=0
|WindGaugeOuterCentreColourFrom=16765357
|{{Version badge 1}}Set by left click on clock on main screen
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
*0 = 24Hr clock mode
*1 - 12 Hr am/pm clock mode
|-
|-
|WMR928Channel1Caption=Extra channel 1
|WindGaugeOuterCentreColourTo=16711680
|Set in the Display Configuration Screen ''WMR928 extra channel captions'' block. Note that the extra channel data for WMR928 stations is only displayed on the main screen if ''Display solar/extra data'' is Set in the Display Configuration Screen General block (see previous parameter). This parameter defines the caption to be used when Cumulus reads observations from the extra sensor.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeOuterCircleColour=16765615
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|-
|WMR928Channel2Caption=Extra channel 2
|WindGaugeOuterRimColour=9470064
|See previous parameter.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|-
|WMR928Channel3Caption=Extra channel 3
|WindGaugeAverageSectorColour=32768
|See 'WMR928Channel1Caption=Extra channel 1' parameter
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|-
|-
|SnowUnitText=cm
|WindGaugePeakSectorColour=33023
|Set in ''Snow units'' box in the Display Configuration Screen ''General'' block.  Default is cm.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
 
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
|WindGaugeNeedleShineColourFrom=1049273
|{{Version badge 1}}Set in the Display Configuration Screen General block.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
*0 = Disabled, (default)
*1 = Enabled, the calculated cloud base is displayed on the main screen. The calculation is a simple one; 1000 feet for every 4.5 degrees Fahrenheit difference between the temperature and the dew point.
|-
|-
|DisplayHumidex=0
|WindGaugeNeedleShineColourTo=328090
|{{Version badge 1}}Set in the Display Configuration Screen General block
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
*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.)
|-
|-
|DisplaySolarData=0
|CompassColour=12632256
|{{Version badge 1}}Set by ''Display solar/extra data'' item in the Display Configuration Screen ''General'' block.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
*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
|CompassTickColour=16711680
|{{Version badge 1}}Set by ''Display 'Storm Rain' '' item in the Display Configuration Screen ''General'' block.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
*0 = Disabled, (default)
*1 = Enabled, adds an extra output to the main screen to show what Davis stations report as Storm Rain
|-
|-
|ShowCurrentConditions=0
|CompassLabelColour=16777215
|Set in the Display Configuration Screen General block
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
*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
|CompassBearingColour=0
|{{Version badge 1}}Set in the Display Configuration Screen Graph block. The width of the plot lines in graph legends
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|-
|ChartLineWidth=2
|CompassCurrentPointerColour=255
|{{Version badge 1}}Set in the Display Configuration Screen Graph block. The width of the plot lines in the graph body
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|-
|WindGaugeRange=50
|CompassAveragePointerColour=16711680
|{{Version badge 1}}Set in the Display Configuration Screen General block. Value represents the default full scale deflection of the top of the 3 wind plots in the wind speed units you have selected. Default value is 50 in that unit.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|-
|WindGaugeArcColour=16773091
|WindRoseColour=8388608
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the wind rose shading that represents duration and intensity of wind in different directions
|-
|-
|WindGaugeAnimated=1
|WindRoseLabelColour=0
|{{Version badge 1}}Set by ''Wind gauge animated'' item in the Display Configuration Screen ''General'' block.  Animate the Wind Gauge pointer movement
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the wind rose compass points
*0 = Disabled,
*1 = Enabled (default)
|-
|-
|WindGaugeAnimationFactor=2
|WindRoseAxesColour=8388608
|{{Version badge 1}}Set in the Display Configuration Screen. This sets the speed of the wind gauge animation. Lower values correspond to a faster animation speed. Be careful not to set the animation too slow, particularly with stations which update frequently (e.g. Davis) as the animation will never catch up, and will use significant CPU time.
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the circle and radii of lower of the 3 wind plots
|-
|-
|WindGaugeTickColour=9841920
|WindRoseTransparency=50
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.
|-
|-
|WindGaugeFontColour=9841920
|NumWindRosePoints=16
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|Set in the Display Configuration Screen Graphs block
The number of points to plot on the Wind Rose diagram (choose 8 for Fine Offset stations)
|-
|-
|WindGaugeInnerCircleColour=16765615
|TransparentGauges=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}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)
*1= the images will be processed to make the background colour transparent.
|-
|-
|WindGaugeNeedleColour=128
|TransparentGraphs=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}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.
|-
|-
|WindGaugeInnerCentreColourFrom=16765615
|LogFTPErrors=1
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|Set in the Display Configuration Screen General block
*1= (default), the FTP errors will be logged to the Cumulus Error Dialog display
*0= to suppress the logging of FTP errors.
|-
|-
|WindGaugeInnerCentreColourTo=16765615
|DigitBackground=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the colour to be used for background to displayed observations on main screen
|-
|-
|WindGaugeOuterCentreColourFrom=16765357
|LabelColour=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the Parameter labels on main screen - default black. Note alarm conditions can change label colour (see next 2 parameters).
|-
|-
|WindGaugeOuterCentreColourTo=16711680
|AlarmColour=255
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the Parameter labels on main screen - default red - when an alarm is set for that parameter
|-
|-
|WindGaugeOuterCircleColour=16765615
|PastAlarmColour=16711680
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the Parameter labels on main screen - default blue - when an alarm is cleared for that parameter
|-
|-
|WindGaugeOuterRimColour=9470064
|PanelHeadingFontColour=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the heading at the top of each panel with observations
|-
|-
|WindGaugeAverageSectorColour=32768
|PanelLineColour=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the heading at the top of each panel with observations
|-
|-
|WindGaugePeakSectorColour=33023
|PanelBorderColour=8421504
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the edging of each panel with observations
|-
|-
|WindGaugeNeedleShineColourFrom=1049273
|PanelGradientColourFrom=16777215
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the panel background
|-
|-
|WindGaugeNeedleShineColourTo=328090
|PanelGradientColourTo=13226453
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the upper of the 3 wind plots
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the panel background
|-
|-
|CompassColour=12632256
|DisplayBeaufortDesc=1
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|{{Version badge 1}}Set in the Display Configuration Screen General block
*1 (default), the Beaufort description of the current average wind speed will appear in the header of the wind panel on the main screen.
*0, it will instead appear as a 'tool tip' for the wind panel.
|-
|-
|CompassTickColour=16711680
|DisplayBarometerTrendText=1
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|{{Version badge 1}}Set in the Display Configuration Screen General block
*1 (default), the description of the current barometer trend will appear in the header of the barometer panel on the main screen.  
*0, it will instead appear as a 'tool tip' for the barometer panel.
|-
|-
|CompassLabelColour=16777215
|UpdateAtStartup=1
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|{{Version badge 1}}|Set in the Display Configuration Screen General block
*1 (default), the display will be updated as data is downloaded and processed from the station's logger. This increases the time taken to process the data.
*0, it makes the download faster as display is onlyn updated when catch up completed; this may be significant if there is a lot of data to download.
|-
|-
|CompassBearingColour=0
|IndependentGraphsWindow=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|{{Version badge 1}}Set in the Display Configuration Screen Graphs block
*0 = Disabled (default)
*1 = Enabled
|}
 
=== Section: Solar ===
 
{{Version badge 1}}Set mostly in '''solar block''' at foot of ''Station Settings'' screen in Configuration menu.
 
[[File:Badge vMx.png]]Set in '''Solar''' section quite a long way down on ''Station settings'' page in Settings menu
 
{| class="wikitable" border="1"
|-
|-
|CompassCurrentPointerColour=255
!style="width:150px" | Parameter Line Entry
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the middle of the 3 wind plots
!style="width:600px" | Function
|-
|-
|CompassAveragePointerColour=16711680
|style="background:lightgray;"|[Solar]
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the middle of the 3 wind plots
|style="background:lightgray;"|Section Name - the following parameters are set as described above
|-
|-
|WindRoseColour=8388608
|colspan="2" style="background:lightblue;"| Both Cumulus flavours
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the wind rose shading that represents duration and intensity of wind in different directions
|-
|-
|WindRoseLabelColour=0
|SunThreshold=75
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the wind rose compass points
|If you have a solar sensor: Cumulus tries to determine whether the sun is shining by determining whether the current solar radiation value is above a certain percentage of the current theoretical maximum. The value you supply here is used as that percentage. The default value is 75%.
|-
|-
|WindRoseAxesColour=8388608
|RStransfactor=0.8
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the circle and radii of lower of the 3 wind plots
|Cumulus uses the Ryan-Stolzenbach formula to determine the current theoretical maximum solar radiation at your location at the current moment in time. This formula has a factor to allow for the transmission of the radiation through the atmosphere; the default is 0.80.
|-
|-
|WindRoseTransparency=50
|SolarMinimum=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.
|This setting allows you to specify a minimum solar radiation value which needs to be reached before it can be considered to be sunny. Note that this setting does not replace the calculation using the current theoretical maximum, it specifies an additional condition which has to be met. This setting therefore allows you to cater for the periods at the beginning and end of the day when the theoretical maximum is very low.
|-
|-
|NumWindRosePoints=16
|LuxToWM2=0.0079
|Set in the Display Configuration Screen Graphs block
|Edit cumulus.ini to add this parameter if you have a Fine Offset station with a solar detector. These supply 'Lux' values rather than 'W/m2' values that Davis stations supply. Cumulus attempts to convert from Lux to W/m2 using the supplied multiplication factor. You can add this parameter if you want to use a value other than the default of 0.0079, which is the generally accepted standard conversion factor for sunlight.
The number of points to plot on the Wind Rose diagram (choose 8 for Fine Offset stations)
|-
|-
|TransparentGauges=0
|UseBlakeLarsen=0
|{{Version badge 1}}Set by ''Transparent gauge backgrounds'' item in the Display Configuration Screen ''General'' block.  
| 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.
 
The square backgrounds of the three wind gauges on the Cumulus main screen
*0= same colour as the main window background (default)
*1= the images will be processed to make the background colour transparent.
|-
|-
|TransparentGraphs=0
|colspan="2" style="background:lightblue;"| [[File:Badge vMx.png]] Available from MX version 3.0.0 only
|{{Version badge 1}}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
|SolarCalc=1
|Set in the Display Configuration Screen General block
|The value is set in the MX user interface when the solar calculation method is set.
*1= (default), the FTP errors will be logged to the Cumulus Error Dialog display
*0 (default) = Ryan-Stolzenbach calculation, which uses the RStransfactor entry to tune the output.
*0= to suppress the logging of FTP errors.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
|-
|-
|DigitBackground=0
|BrasTurbidity=2.0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the colour to be used for background to displayed observations on main screen
|The value is set in the MX user interface when the solar calculation method is set.
*2.0 (default) = Perfect clear sky
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
|}
 
=== Section: Graphs ===
 
For individual settings, check whether they apply to Cumulus 1 only, MX only, or to both flavours.
 
{{Version badge 1}}In Cumulus 1, in '''Configuration''' menu, select either ''Display'' (Graphs block) or ''Colours'' screens for most options. Set the colours of the data lines on graphs/charts. 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.
 
[[File:Badge vMx.png]] All settings in this table are controlled in the '''Graphs''' section at the bottom of the '''Station Settings''' page.
{| class="wikitable" border="1"
|-
|-
|LabelColour=0
!style="width:150px" | Parameter Line Entry
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the Parameter labels on main screen - default black. Note alarm conditions can change label colour (see next 2 parameters).
!style="width:800px" | Function
|-
|-
|AlarmColour=255
|style="background:lightgray;"|[Graphs]
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the Parameter labels on main screen - default red - when an alarm is set for that parameter
|style="background:lightgray;"|Section Name - the following parameters relate to your graph settings
|-
|-
|PastAlarmColour=16711680
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the Parameter labels on main screen - default blue - when an alarm is cleared for that parameter
|-
|-
|PanelHeadingFontColour=0
|GraphHours=12
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the heading at the top of each panel with observations
|The number of hours data to be displayed in temperature (outdoor, heat index, wind chill, dewpoint and apparent temperature), humidity, rainfall rate, rainfall, pressure, solar radiation, UV index, wind speed and wind direction graphs.
You can enter any multiple of 12 from the Display Settings Screen, and you can also edit cumulus.ini and set this item to any other value. But note that setting it to a non-standard value is unsupported (i.e. if it causes problems, I probably won't fix them) and if you change any display settings, the value will get reset to a supported value (so you'll need to edit cumulus.ini again).
|-
|-
|PanelLineColour=0
|ChartMaxDays=7
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.  Decimal code for the heading at the top of each panel with observations
|How many days of values to plot on the daily min/average/max temperature, daily sunshine, and daily rain charts (default=7)
|-
|-
|PanelBorderColour=8421504
|TempVisible=1
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the edging of each panel with observations
|Select whether to plot the outside air temperature on the temperature graph. MX from v3.7.0
*0 = Disabled
*1 = Enabled
|-
|-
|PanelGradientColourFrom=16777215
|HIVisible=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the panel background
|Select whether to plot the heat index on the temperature graph. MX from v3.7.0
*0 = Disabled
*1 = Enabled
|-
|-
|PanelGradientColourTo=13226453
|DPVisible=1
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the panel background
|Select whether to plot the dewpoint values on the temperature graph. MX from v3.7.0
*0 = Disabled
*1 = Enabled
|-
|-
|DisplayBeaufortDesc=1
|WCVisible=1
|{{Version badge 1}}Set in the Display Configuration Screen General block
|Select whether to plot the wind chill values on the temperature graph. MX from v3.7.0
*1 (default), the Beaufort description of the current average wind speed will appear in the header of the wind panel on the main screen.
*0 = Disabled
*0, it will instead appear as a 'tool tip' for the wind panel.
*1 = Enabled
|-
|-
|DisplayBarometerTrendText=1
|AppTempVisible=1
|{{Version badge 1}}Set in the Display Configuration Screen General block
|Select whether to plot the apparent temperature values on the temperature graph. MX from v3.7.0
*1 (default), the description of the current barometer trend will appear in the header of the barometer panel on the main screen.  
*0 = Disabled
*0, it will instead appear as a 'tool tip' for the barometer panel.
*1 = Enabled
|-
|-
|UpdateAtStartup=1
|InHumVisible=1
|{{Version badge 1}}|Set in the Display Configuration Screen General block
|Select whether to plot the indoor humidity values on the humidity graph. MX from v3.7.0
*1 (default), the display will be updated as data is downloaded and processed from the station's logger. This increases the time taken to process the data.
*0 = Disabled
*0, it makes the download faster as display is onlyn updated when catch up completed; this may be significant if there is a lot of data to download.
*1 = Enabled
|-
|-
|IndependentGraphsWindow=0
|OutHumVisible=1
|{{Version badge 1}}Set in the Display Configuration Screen Graphs block
|Select whether to plot the outdoor humidity values on the humidity graph. MX from v3.7.0
*0 = Disabled (default)
*0 = Disabled
*1 = Enabled
*1 = Enabled
|}
|-
 
=== Section: Graphs ===
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 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 both Cumulus 1 and Cumulus MX are the first 2 - "ChartMaxDays" and "GraphHours.
 
The next few are only used by Cumulus MX, then the remainder are Cumulus 1 only.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Graphs]
|style="background:lightgray;"|Section Name - the following parameters relate to your graph settings
|-
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|-
|GraphHours=12
|The number of hours data to be displayed in temperature (outdoor, heat index, wind chill, dewpoint and apparent temperature), humidity, rainfall rate, rainfall, pressure, solar radiation, UV index, wind speed and wind direction graphs.
You can enter any multiple of 12 from the Display Settings Screen, and you can also edit cumulus.ini and set this item to any other value. But note that setting it to a non-standard value is unsupported (i.e. if it causes problems, I probably won't fix them) and if you change any display settings, the value will get reset to a supported value (so you'll need to edit cumulus.ini again).
|-
|ChartMaxDays=7
|How many days of values to plot on the daily min/average/max temperature, daily sunshine, and daily rain charts (default=7)
|-
|colspan="3" style="background:lightblue;"| Cumulus MX only
|colspan="3" style="background:lightblue;"| Cumulus MX only
|-
|-
Line 1,836: Line 2,151:
|MoonImageFtpDest=images/moon.png
|MoonImageFtpDest=images/moon.png
|This setting is selected in the internet settings screen, it specifies the path to where the image  (see [[#[FTP site]|[FTP site] section]] for how to control uploading of generated image) is to be stored relative to the directory specified for uploads  (see [[#[FTP site]|[FTP site] section]]) earlier on the settings page.
|This setting is selected in the internet settings screen, it specifies the path to where the image  (see [[#[FTP site]|[FTP site] section]] for how to control uploading of generated image) is to be stored relative to the directory specified for uploads  (see [[#[FTP site]|[FTP site] section]]) earlier on the settings page.
|-
|InTempVisible=1
|Select whether to plot the inside air temperature on the temperature graph.
*0 = Disabled
*1 = Enabled
|-
|HumidexVisible=1
|Select whether to plot the humidex on the temperature graph.
*0 = Disabled
*1 = Enabled
|-
|-
|colspan="3" style="background:lightblue;"| Cumulus 1 only
|colspan="3" style="background:lightblue;"| Cumulus 1 only
Line 1,914: Line 2,239:
|Draw a horizontal line on the temperature graph at 0°C/32°F
|Draw a horizontal line on the temperature graph at 0°C/32°F
|-
|-
|TempVisible=1
|GraphGradientEnabled=0
|Select whether to plot the outside air temperature on the temperature graph
|Use gradient shading on the graph background
*0 = Disabled
*0 = Disabled
*1 = Enabled
*1 = Enabled
|-
|-
|HIVisible=0
|GradientStart=12632256
|Select whether to plot the heat index on the temperature graph
*0 = Disabled
*1 = Enabled
|-
|DPVisible=1
|Select whether to plot the dewpoint values on the temperature graph
*0 = Disabled
*1 = Enabled
|-
|WCVisible=1
|Select whether to plot the wind chill values on the temperature graph
*0 = Disabled
*1 = Enabled
|-
|AppTempVisible=1
|Select whether to plot the apparent temperature values on the temperature graph
*0 = Disabled
*1 = Enabled
|-
|InHumVisible=1
|Select whether to plot the indoor humidity values on the humidity graph
*0 = Disabled
*1 = Enabled
|-
|OutHumVisible=1
|Select whether to plot the outdoor humidity values on the humidity graph
*0 = Disabled
*1 = Enabled
|-
|GraphGradientEnabled=0
|Use gradient shading on the graph background
*0 = Disabled
*1 = Enabled
|-
|GradientStart=12632256
|
|
|-
|-
Line 2,085: Line 2,375:


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


{{Version badge 1}}Set these using the '''Edit''' menu, ''Alarms'' screen.
[[File:Badge vMx.png]]For MX, there is a default path "\CumulusMX\interface\sounds". '''Edit''' on '''Settings''' tab, '''Alarms''' screen.
 
{{Version badge 1}}Set these using the '''Edit''' menu, ''Alarms'' screen. The default path and file is '''\Cumulus\alert.wav''' for all the file parameters.  (Previously this article incorrectly showed "C:\Program Files\Cumulus\alert.wav" for some, but that has been removed now this applies to MX as well)
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,109: Line 2,400:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|LowTempAlarmSoundFile=C:\Cumulus\alert.wav
|LowTempAlarmSoundFile=
|Path and file name of sound file for Low Temperature alarm
|Path and file name of sound file for Low Temperature alarm
|-
|-
Line 2,125: Line 2,416:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighTempAlarmSoundFile=C:\Cumulus\alert.wav
|HighTempAlarmSoundFile=  
|Path and file name of sound file for High Temperature alarm
|Path and file name of sound file for High Temperature alarm
|-
|-
Line 2,139: Line 2,430:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|LowPressAlarmSoundFile=C:\Cumulus\alert.wav
|LowPressAlarmSoundFile=
|Path and file name for sound file to play for Low Pressure Alarm
|Path and file name for sound file to play for Low Pressure Alarm
|-
|-
Line 2,155: Line 2,446:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighPressAlarmSoundFile=C:\Cumulus\alert.wav
|HighPressAlarmSoundFile=  
|Path and file name for the sound file used for the High Pressure Alarm
|Path and file name for the sound file used for the High Pressure Alarm
|-
|-
Line 2,171: Line 2,462:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighRainTodayAlarmSoundFile=C:\Cumulus\alert.wav
|HighRainTodayAlarmSoundFile=
|Path and file name for the sound file used for the High Rain Today Alarm
|Path and file name for the sound file used for the High Rain Today Alarm
|-
|-
Line 2,187: Line 2,478:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighRainRateAlarmSoundFile=C:\Cumulus\alert.wav
|HighRainRateAlarmSoundFile=  
|Path and file name for the sound file used for the High Rain Rate Alarm
|Path and file name for the sound file used for the High Rain Rate Alarm
|-
|-
Line 2,203: Line 2,494:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighGustAlarmSoundFile=C:\Cumulus\alert.wav
|HighGustAlarmSoundFile=
|Path and file name for the sound file used for the High Gust Alarm
|Path and file name for the sound file used for the High Gust Alarm
|-
|-
Line 2,219: Line 2,510:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighWindAlarmSoundFile=C:\Cumulus\alert.wav
|HighWindAlarmSoundFile=  
|Path and file name for the sound file used for the High Wind Alarm
|Path and file name for the sound file used for the High Wind Alarm
|-
|-
Line 2,232: Line 2,523:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|SensorAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|SensorAlarmSoundFile=
|Path and file name for the sound file used for the Sensor Contact lost Alarm
|Path and file name for the sound file used for the Sensor Contact lost Alarm
|-
|-
Line 2,248: Line 2,539:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|TempChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|TempChangeAlarmSoundFile=
|Path and file name for the sound file used for the Temperature Change Alarm
|Path and file name for the sound file used for the Temperature Change Alarm
|-
|-
Line 2,264: Line 2,555:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|PressChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|PressChangeAlarmSoundFile=
|Path and file name for the sound file used for the Pressure Change Alarm
|Path and file name for the sound file used for the Pressure Change Alarm
|}
|}
Line 2,271: Line 2,562:


==== Section: WUnderground ====
==== Section: WUnderground ====
Set in the Internet Configuration Screen sites/Options tab
 
Available from version 1.1 (17 Feb 2004)
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,279: Line 2,572:
|style="background:lightgray;"|[Wunderground]  
|style="background:lightgray;"|[Wunderground]  
|style="background:lightgray;"|Section Name - Parameters for your [http://www.wunderground.com/ Weather Underground] site
|style="background:lightgray;"|Section Name - Parameters for your [http://www.wunderground.com/ Weather Underground] site
|-
|colspan="2" style="background:lightblue;"| Set in the Internet Configuration Screen sites/Options tab
|-
|-
|ID=  
|ID=  
Line 2,318: Line 2,613:
*0 = Disabled
*0 = Disabled
*1 = Enabled (default)
*1 = Enabled (default)
|}
Set by editing this section of cumulus.ini with Cumulus stopped (from build 1095)
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|-
|style="background:lightgray;"|[Wunderground]
|colspan="2" style="background:lightblue;"| Set by editing this section of cumulus.ini with Cumulus stopped (from build 1095)
|style="background:lightgray;"|Section Name - Parameters for your [http://www.wunderground.com/ Weather Underground] site
|-
|-
|SendSoilTemp1=0  
|SendSoilTemp1=0  
Line 2,412: Line 2,699:


==== Section: PWSweather ====
==== Section: PWSweather ====
Set in the Internet Configuration Screen sites/Options tab
 
Support for PWS Weather/WeatherForYou/HAMweather was added in version 1.7.16 1st September 2008
 
For Cumuus 1, set in the Internet Configuration Screen sites/Options tab. For MX set on internet settings page.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,489: Line 2,780:


==== Section: WOW ====
==== Section: WOW ====
Set in the Internet Configuration Screen sites/Options tab
 
Added in version 1.9.2. For cumulus 1 set in the Internet Configuration Screen sites/Options tab.
 
For MX set in internet settings page.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,508: Line 2,803:
|-
|-
|Interval=15
|Interval=15
|Time in mimutes between uploads to the WOW server
|Time in minutes between uploads to the WOW server
|-
|-
|SendUV=0
|SendUV=0
Line 2,527: Line 2,822:


==== Section: Weatherbug ====
==== Section: Weatherbug ====
Set in the Internet Configuration Screen sites/Options tab
 
'''The weatherbug upload service ceased''' in 2017.
 
This functionality was added in version 1.9.2. For cumulus 1 these parameters were set in the Internet Configuration Screen sites/Options tab.
 
For MX these parameters were set on internet settings page. Removed as from version 3.7.0.
 
The notes below are therefore only included for historical reasons to help people understand entries in '''old''' Cumulus.ini files but '''these settings are ignored'''.
 
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,546: Line 2,850:
|-
|-
|Interval=15
|Interval=15
|Time in mimutes between uploads to the Weatherbug server
|Time in minutes between uploads to the Weatherbug server
|-
|-
|SendUV=0
|SendUV=0
Line 2,565: Line 2,869:


==== Section: xAP ====
==== Section: xAP ====
Set in the Internet Configuration Screen sites/Options tab
 
{{Version badge 1}}Set in the Internet Configuration Screen sites/Options tab
 
[[File:Badge vMx.png]]It is in Cumulus.ini for MX, but nobody has told me whether it can be edited within the Admin interface.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,572: Line 2,880:
|-
|-
|style="background:lightgray;"|[xAP]  
|style="background:lightgray;"|[xAP]  
|style="background:lightgray;"|Section Name - the following parameters are used if you have enabled xAP in the Station Configuration xAP Settings block
|style="background:lightgray;"|Section Name
|-
|-
|Enabled=0  
|Enabled=0  
Line 2,586: Line 2,894:
|}
|}


=== Section: NOAA ===
==== Section: WeatherCloud ====
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).
 
Not available in Cumulus 1
 
[[File:Badge vMx.png]] Only available from version 3.0.0


'''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,595: Line 2,905:
!style="width:600px" | Function  
!style="width:600px" | Function  
|-
|-
|style="background:lightgray;"|[NOAA]
|style="background:lightgray;"|[WeatherCloud]  
|style="background:lightgray;"|Section Name - the following parameters are set from the NOAA Setup dialog in Cumulus
|style="background:lightgray;"|Section name - the following parameters relate to the Weathercloud configuration.
|-
|-
|Name=
|colspan="2" style="background:lightblue;"| Cumulus MX only
|Your NOAA Station name
|-
|-
|City=
|Wid=
|NOAA location city
|The value is set in the MX user interface when the Weathercloud ID value is set.
|-
|-
|State=
|Key=
|NOAA location state/county/province or the equivalent in your nation
|The value is set in the MX user interface when your Weathercloud API Key value is set.
|-
|-
|12hourformat=0
|Enabled=0
|Use 12 or 24 hour time format in the reports
|This parameter controls whether data is sent to WeatherCloud
*0 = 24 hour format (default)
*0 (default) = Disable sending of data
*1 = 12 hour format
*1 = Enable sending of data
|-
|-
|HeatingThreshold=65
|SendUV=0
|The base temperature which is to be used to calculate heating demand as [[Heat/cold degree days and Chill hours | heating degree days]]. The default is 65 degrees if you use Fahrenheit scale or 18.3 degrees if you use Celsius. The value you type on the NOAA Setup Screen is entered in the units that you have selected for temperature. Degree days are calculated on a minute-by-minute basis and the totals for each day are stored in dayfile.txt. Changes to the threshold values cannot therefore apply retrospectively. But, if the dayfile.txt entry doesn't have the degree days in it, then it uses the day's average temperature to produce a 'simplified' heating or cooling degree days figure (but obviously never both at the same time) and in that case it does use the current threshold settings.
|The value is set in the MX user interface when the Include UV value is set.
*0 = Do not send UV data (default)
*1 = Send UV data
|-
|-
|CoolingThreshold=65
|SendSR=0
|The base temperature which is to be used to calculate chilling demand as [[Heat/cold degree days and Chill hours | cooling degree days]]. The default is 65 degrees if you use Fahrenheit scale or 18.3 degrees if you use Celsius. The value you type on the NOAA Setup Screen is entered in the units that you have selected for temperature. Degree days are calculated on a minute-by-minute basis and the totals for each day are stored in dayfile.txt. Changes to the threshold values cannot therefore apply retrospectively. But, if the dayfile.txt entry doesn't have the degree days in it, then it uses the day's average temperature to produce a 'simplified' heating or cooling degree days figure (but obviously never both at the same time) and in that case it does use the current threshold settings.
|The value is set in the MX user interface when the Include Solar Radiation value is set.
*0 = Do not send Solar data (default)
*1 = Send Solar data
|}
 
==== Section: WLL ====
 
Not available in Cumulus 1
 
[[File:Badge vMx.png]] Only available from version 3.0.0
 
{| class="wikitable" border="1"
|-
|-
|MaxTempComp1=27
!style="width:150px" | Parameter Line Entry
|The value used in the reports for the counts of days with max temperatures above the specified temperature.
!style="width:600px" | Function
|-
|-
|MaxTempComp2=27
|style="background:lightgray;"|[WLL]
|The value used in the reports for the counts of days with max temperatures below the specified temperature.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|MinTempComp1=0
|colspan="2" style="background:lightblue;"| Cumulus MX only
|The value used in the reports for the counts of days with min temperatures below the specified temperature.
|-
|PrimaryRainTxId=1
|Default value = 1, which transmitter do you want to use as your primary rain sensor, set via the station configuration screen.
|-
|PrimaryTempHumTxId=1
|Default value = 1, which transmitter do you want to use as your primary temp/hum sensor, set via the station configuration screen.
|-
|PrimaryWindTxId=1
|Default value = 1, which transmitter do you want to use as your primary wind sensor, set via the station configuration screen.
|-
|PrimarySolarTxId=1
|Default value = 1, which transmitter do you want to use as your primary solar sensor, set via the station configuration screen.
|-
|PrimaryUVTxId=1
|Default value = 1, which transmitter do you want to use as your primary rain sensor, set via the station configuration screen.
|-
|ExtraSoilTempTxId[1 to 4]=0
|Default value = 0, which transmitter do you want to use as your soil temperature sensor [1-4], set via the station configuration screen.
|-
|ExtraSoilTempIdx[1 to 4]=0
|Default value = 1 to 4, which sensor number on the transmitter do you want to use as your soil temperature sensor [1-4], set via the station configuration screen.
|-
|ExtraSoilMoistureTxId[1 to 4]=0
|Default value = 0, which transmitter do you want to use as your soil moisture sensor [1-4], set via the station configuration screen.
|-
|ExtraSoilMoistureIdx[1 to 4]=0
|Default value = 1 to 4, which sensor number on the transmitter do you want to use as your soil moisture sensor [1-4], set via the station configuration screen.
|-
|-
|MinTempComp2=-18
|ExtraLeafTxId[1 to 2]=0
|The value used in the reports for the counts of days with min temperatures below the specified temperature.
|Default value = 0, which transmitter do you want to use as your leaf wetness sensor [1-2], set via the station configuration screen.
|-
|-
|RainComp1=0.2
|ExtraLeafIdx[1 to 2]=0
|The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount.
|Default value = 1 to 2, which sensor number on the transmitter do you want to use as your soil moisture sensor [1-2], set via the station configuration screen.
|-
|-
|RainComp2=2
|ExtraTempTxId[1 to 8]=0
|The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount.
|Default value = 0, which transmitter do you want to use as your extra temperature sensor [1-8], set via the station configuration screen.
|-
|-
|RainComp3=20
|ExtraHumOnTx[1 to 8]=0
|The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount.
|Default value = 0, does the temperature sensor transmitter [1-8] also have a humidity sensor, set via the station configuration screen.
|-
|-
|AutoSave=0
|BroadcastDuration=300
|If set, when Cumulus does the end of day reset, it will auto create NOAA-style reports for the month and year corresponding to the day which has just ended.
|Default value = 300, how long the WLL device is requested to broadcast for before timing out. Only set via the ini file, there should be no need to change this.
|-
|-
|NOAAUseUTF8=0
|BroadcastPort=22222
|'''(Added in Cumulus 1.9.4 beta build 1078)''' Specifies the 'Character set' in which NOAA reports are generated whether automatically (by Cumulus just after rollover) or manually (by selecting '''Save''' in NOAA Monthly/Annual Reports screen within Edit menu).
|Default value = 22222, what port the WLL device broadcasts on. Only set via the ini file, there should be no need to change this.
*0 = Uses the encoding used for the viewer's operating system's default ANSI code page.  
|}
*1 = Uses UTF8 (UCS Transformation Format—8-bit) format - the dominant character encoding for the World-Wide Web as using one to three bytes it represents most characters in common use covering most languages.
 
==== Section: Windy ====
 
Not available in Cumulus 1
 
[[File:Badge vMx.png]] Only available from version 3.0.0 build 3049 onwards. Edit all parameters in the '''Internet settings''' screen, ''Windy.com'' section.
 
{| class="wikitable" border="1"
|-
|-
|AutoFTP=0
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Windy]
|style="background:lightgray;"|Section Name
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|Enabled=0
|This tick box is used if you want to export to Windy.com, default is disabled.
|-
|APIkey=
|Here you enter the API key you are given when you create a Windy account, default is null. If you have an account, this is a very long string, so paste it in carefully!
|-
|StationIdx=0
|If you were uploading more than one station, on the same account, this indicates the index for this upload, default is 0, the first station you define in your account
|-
|Interval=15
|How many minutes between updates (Windy will not allow updates more frequently than every 5 minutes, so that is minimum allowed here)
|-
|SendUV=0
|A tick box to indicate whether you want MX to send UV data, default is no UV readings to send
|-
|CatchUp=1
|When you restart MX, if the weather station allows it, MX will read "catch-up" readings from the station's logger, the default is to send these to Windy.com. Untick this box if you don't want past values to be sent.
|}
 
=== Section: NOAA ===
 
{{Version badge 1}}All these can be set in the '''NOAA Setup Screen''' in Configuration menu. 
 
[[File:Badge vMx.png]]Set these setting on the '''NOAA Settings''' page within Settings menu.
 
You might select to close Cumulus, and edit the 'NOAATempNorm[Jan-Dec]' and 'NOAARainNorm[Jan-Dec]' parameters by using a external editor to manipulate into required format, copy, and paste, the values from another source (as there are a lot of figures to type in).
 
'''Please note:''' because this section of Cumulus.ini uses [[Webtags#Time.2FDate_.27format.27_Parameter|date format]] parameters, you are advised to read [[Webtags#The_format_used_for_naming_reports]].
 
The settings that you use for Cumulus 1 may not be the same as settings you use for MX.  If for Cumulus 1, you used capital "M" to represent month it will work for MX too. If for Cumulus 1 you used "NOAAMO'mmyy'.txt" and you then move to MX at any version from version 3.3.0 onwards, it will automatically change your setting to  "NOAAMO'MMyy'.txt" (which works on both Cumulus MX and, if you then revert, also on Cumulus 1).
 
 
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:800px" | Function
|-
|style="background:lightgray;"|[NOAA]
|style="background:lightgray;"|Section Name - the following parameters are set from the NOAA Setup dialog in Cumulus
|-
|Name=
|Your NOAA Station name
|-
|City=
|NOAA location city
|-
|State=
|NOAA location state/county/province or the equivalent in your nation
|-
|12hourformat=0
|Use 12 or 24 hour time format in the reports
*0 = 24 hour format (default)
*1 = 12 hour format
|-
|HeatingThreshold=65
|The base temperature which is to be used to calculate heating demand as [[Heat/cold degree days and Chill hours | heating degree days]]. The default is 65 degrees if you use Fahrenheit scale or 18.3 degrees if you use Celsius. The value you type on the NOAA Setup Screen is entered in the units that you have selected for temperature. Degree days are calculated on a minute-by-minute basis and the totals for each day are stored in dayfile.txt. Changes to the threshold values cannot therefore apply retrospectively. But, if the dayfile.txt entry doesn't have the degree days in it, then it uses the day's average temperature to produce a 'simplified' heating or cooling degree days figure (but obviously never both at the same time) and in that case it does use the current threshold settings.
|-
|CoolingThreshold=65
|The base temperature which is to be used to calculate chilling demand as [[Heat/cold degree days and Chill hours | cooling degree days]]. The default is 65 degrees if you use Fahrenheit scale or 18.3 degrees if you use Celsius. The value you type on the NOAA Setup Screen is entered in the units that you have selected for temperature. Degree days are calculated on a minute-by-minute basis and the totals for each day are stored in dayfile.txt. Changes to the threshold values cannot therefore apply retrospectively. But, if the dayfile.txt entry doesn't have the degree days in it, then it uses the day's average temperature to produce a 'simplified' heating or cooling degree days figure (but obviously never both at the same time) and in that case it does use the current threshold settings.
|-
|MaxTempComp1=27
|The value used in the reports for the counts of days with max temperatures above the specified temperature.
|-
|MaxTempComp2=27
|The value used in the reports for the counts of days with max temperatures below the specified temperature.
|-
|MinTempComp1=0
|The value used in the reports for the counts of days with min temperatures below the specified temperature.
|-
|MinTempComp2=-18
|The value used in the reports for the counts of days with min temperatures below the specified temperature.
|-
|RainComp1=0.2
|The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount.
|-
|RainComp2=2
|The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount.
|-
|RainComp3=20
|The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount.
|-
|AutoSave=0
|If set, when Cumulus does the end of day reset, it will auto create NOAA-style reports for the month and year corresponding to the day which has just ended.
|-
|NOAAUseUTF8=0
|'''(Added in Cumulus 1.9.4 beta build 1078)''' Specifies the 'Character set' in which NOAA reports are generated whether automatically (by Cumulus just after rollover) or manually (by selecting '''Save''' in NOAA Monthly/Annual Reports screen within Edit menu).
*0 = Uses the encoding used for the viewer's operating system's default ANSI code page.
*1 = Uses UTF8 (UCS Transformation Format—8-bit) format - the dominant character encoding for the World-Wide Web as using one to three bytes it represents most characters in common use covering most languages.
|-
|AutoFTP=0
|If set, when Cumulus does the first FTP upload after the daily reset, it will also upload the latest auto-created monthly and yearly NOAA-style reports. Note that you must already have regular (non-realtime) FTP configured.
|If set, when Cumulus does the first FTP upload after the daily reset, it will also upload the latest auto-created monthly and yearly NOAA-style reports. Note that you must already have regular (non-realtime) FTP configured.
|-
|-
|MonthFileFormat=<big>"NOAAMO"</big>MMyy<big>".txt"</big>
|MonthFileFormat=<big>"NOAAMO"</big>MMyy<big>".txt"</big>
|Defines the format of the filename used for the monthly reports, using date formatting characters (see [[Webtags#Time.2FDate_.27format.27_Parameter]]). For Cumulus 1, the two digit month can be represented by 'mm', but as 'mm' represents minutes in MX, MX (recent versions) changes any 'mm' it finds into 'MM'. The default uses a 2 digit number for the month, but you may prefer the full month name or an abbreviation in your language. Note that any characters which are not date formatting characters should be in double quotes.  
|Defines the format of the filename used for the monthly reports, using date formatting characters (see [[Webtags#Time.2FDate_.27format.27_Parameter]]). For Cumulus 1, the two digit month can be represented by 'mm', but as 'mm' represents minutes in MX, MX (recent versions) changes any 'mm' it finds into 'MM'. The default uses a 2 digit number for the month, but you may prefer the full month name or an abbreviation in your language. Note that any characters which are not date formatting characters should be in double quotes.  
|-
|-
|YearFileFormat=<big>"NOAAYR"</big>yyyy<big>".txt"</big>
|YearFileFormat=<big>"NOAAYR"</big>yyyy<big>".txt"</big>
|Defines the format of the filename used for the yearly reports, using date formatting characters (see [[Webtags#Time.2FDate_.27format.27_Parameter]]). Note that any characters which are not date formatting characters should be in double quotes.
|Defines the format of the filename used for the yearly reports, using date formatting characters (see [[Webtags#Time.2FDate_.27format.27_Parameter]]). Note that any characters which are not date formatting characters should be in double quotes.
|-
|-
|FTPDirectory=
|FTPDirectory=
|The FTP directory into which Cumulus will attempt to upload the latest NOAA-style reports. You must give the full path from the point of login, and do not supply a trailing 'slash'. Note that the directory must actually exist on the server.
|The FTP directory into which Cumulus will attempt to upload the latest NOAA-style reports. You must give the full path from the point of login, and do not supply a trailing 'slash'. Note that the directory must actually exist on the server.
|-
|-
||
||
|style="background:lightgray;"| These 'climatic normal' values are set from the NOAA Setup dialog in Cumulus, but could be set up by processing information in a spreadsheet
|style="background:lightgray;"| These 'climatic normal' values are set from the NOAA Setup dialog in Cumulus, but could be set up by processing information in a spreadsheet
|-
|NOAATempNorm[Jan-Dec]=-1000
|Long term temperature averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|-
|NOAARainNorm[Jan-Dec]=-1000
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|}
 
=== MQTT ===
 
MQTT (Message Queuing Telemetry Transport) is a machine-to-machine (M2M), also known as "Internet of Things", connectivity protocol.
 
[[File:Badge vMx.png]] This section is only applicable to Cumulus MX and only available from version 3.5.0 (build 3071)
 
Most settings are on the '''Internet Settings''' screen in either the '''MQTT''' section or one of the two '''Send message''' sections (the section is named for each parameter), but as indicated one requires editing Cumulus.ini while MX is stopped.
 
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
!style="width:150px" | Where to Edit
|-
|style="background:lightgray;"|[MQTT]
|style="background:lightgray;"|Cumulus.ini Section Name
|style="background:lightgray;"|Settings Section Name
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|Server=
|Note there is no default. This text box is to enter your server name or the IPv4 or IPv6 address to find your server
|MQTT section
|-
|Username=
|This is optional.This text box is to enter the username if one is needed for updating your server
|MQTT section
|-
|Password=
|This is optional. This text box is to enter any password needed for that username
|MQTT section
|-
|Port=1883
|Note default. To edit which port is used to connect to your server
|MQTT section
|-
|-
|NOAATempNorm[Jan-Dec]=-1000
|UseTLS=0
|Long term temperature averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|Transport Layer Security (TLS), and its now-deprecated predecessor, Secure Sockets Layer (SSL), are cryptographic protocols designed to provide communications security over a computer network. This tick box on settings screen indicates whether TLS support is required,  
*default is not (0),
*set to 1 if modern security protocol is being used
|MQTT section tick box
|-
|-
|NOAARainNorm[Jan-Dec]=-1000
|IPversion=0
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|Mandatory - This parameter must be added to this Cumulus.ini section, it cannot be edited on a screen.
|}
*0=default,
 
*4=IPv4,
=== Section: Solar ===
*6=IPv6
Set mostly in solar block at foot of Station Settings screen of Configuration menu.
|In file only
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
|EnableDataUpdate=0
!style="width:600px" | Function
|This provides an easy way to stop/start the updating without losing other settings. Default is unticked as most people do not use this functionality.
|tick box in '''Send message on data update''' section
|-
|-
|style="background:lightgray;"|[Solar]
|UpdateTopic=CumulusMX/DataUpdate
|style="background:lightgray;"|Section Name - the following parameters are set from the Solar Setup dialog in Cumulus
|This feature in the '''Send message on data update''' section is where you specify the name to give to the update message
|'''Send message on data update''' section
|-
|-
|SunThreshold=75
|UpdateTemplate=DataUpdateTemplate.txt
|If you have a solar sensor: Cumulus tries to determine whether the sun is shining by determining whether the current solar radiation value is above a certain percentage of the current theoretical maximum. The value you supply here is used as that percentage. The default value is 75%.
|In the CumulusMX/mqtt folder there is a default template with a file name specified by the default value of this parameter. In that default file <tt>{"time":"<#timehhmmss>","windspeed":<#wlatest rc=y>,"winddir":<#bearing>}</tt> will send wind readings in case for example you want to close something when it is windy. If you create your own file, you can put its name here.
|'''Send message on data update''' section
|-
|-
|RStransfactor=0.8
|EnableInterval=0
|Cumulus uses the Ryan-Stolzenbach formula to determine the current theoretical maximum solar radiation at your location at the current moment in time. This formula has a factor to allow for the transmission of the radiation through the atmosphere; the default is 0.80.
|This tick box provides an easy way to stop/start this type of updating without losing other settings. Default is unticked as most people do not use this functionality.
|tick box in '''Send message at fixed intervals''' section
|-
|-
|SolarMinimum=0
|IntervalTime=600
|This setting allows you to specify a minimum solar radiation value which needs to be reached before it can be considered to be sunny. Note that this setting does not replace the calculation using the current theoretical maximum, it specifies an additional condition which has to be met. This setting therefore allows you to cater for the periods at the beginning and end of the day when the theoretical maximum is very low.
|This text box is where you enter the time between messages in seconds, the default is 600 meaning every ten minutes.
|'''Send message at fixed intervals''' section
|-
|-
|LuxToWM2=0.0079
|IntervalTopic=CumulusMX/Interval
|Edit cumulus.ini to add this parameter if you have a Fine Offset station with a solar detector. These supply 'Lux' values rather than 'W/m2' values that Davis stations supply. Cumulus attempts to convert from Lux to W/m2 using the supplied multiplication factor. You can add this parameter if you want to use a value other than the default of 0.0079, which is the generally accepted standard conversion factor for sunlight.
|This text box is where you specify the name to give to the fixed interval update message
|'''Send message at fixed intervals''' section
|-
|-
|UseBlakeLarsen=0
|IntervalTemplate=IntervalTemplate.txt
| 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.
|In the CumulusMX/mqtt folder there is a default template with a file name specified by the default value of this parameter. In that default file <tt>{"time":"<#timehhmmss>","temp":<#temp rc=y>,"humidity":<#hum>}</tt> will send temperature and humidity readings in case for example you want to open something when it feels uncomfortable. If you create your own file, you can put its name here.
|'''Send message at fixed intervals''' section
|}
|}
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/5365...7049"

Navigation menu