|
[[File:Badge vMx.png]] This page now only applies if you are using Cumulus MX.
If you are using Cumulus 1, all the information is now on [[Cumulus.ini (Cumulus 1)]] page.
[[Category: Configuration_Files]]
{{TOCright}}
= Introduction =
*'''Cumulus.ini''' is a text file containing initialization parameters used by the Cumulus 1.x.x, or Cumulus MX, application.
*It is '''only read''' when Cumulus MX starts up.
*It is '''only read''' when Cumulus (of either flavour) starts up. When Cumulus (either flavour) is run for very first time, the file does not exist, as it is not included in the download (of either flavour). For MX only, if the file does exist as MX starts, a backup is taken so if you subsequently change any settings you can go back to how it was before you made those changes.
**When Cumulus (1MX oris 2run orfor MX)very createsfirst atime, new version of thisthe file whendoes itnot ''shuts down''exist, ifas thisit is thenot firstincluded run ofin the softwaredownload this(of willeither createflavour). the file for first time.
** if this is the first run of the software, part of what it does will create the file for first time.
*The file shows as 'modified date' the last time that Cumulus was shut down, the file will contain the contents of the application's configuration screens and also any parameters that were in any previous copy of the file that cannot be configured within Cumulus.
***In the case of that first run, the file will exist when it ''shuts down''
*Note this Cumulus save action may change the order, or add lines, compared to any file that you manually edited.
** if the file does exist as MX starts, a backup is taken so if you subsequently change any settings you can go back to how it was before you made those changes.
*For Cumulus MX only, a back up copy of Cumulus.ini is stored at end of each day (together with some of the log files).
*The file shows as 'modified date' the last time that Cumulus was shut down, the file will contain the contents of the application's configuration screens
**In early versions of MX, there were some "read-only" parameters, these cannot be configured within Cumulus, but were retained if they were in any previous copy of the file.
*Note any Cumulus MX save action may change the order, or add lines, compared to any file that you manually edited.
*In some versions of MX, a back up copy of Cumulus.ini is stored at end of each day (together with some of the log files).
*If you do need to edit the file, close Cumulus first to ensure you are working on latest contents, and your edit cannot conflict with any edit Cumulus may be making. When Cumulus restarts it will read the file again and see any edits you have made.
The parameters listed can change the look of Cumulus, can hold basic information about your location, can amend the way Cumulus interfaces with your weather station, can hold the settings used to interface with your website, and with various external websites.
==Is this documentation definitive?==
The short answer to that question is that it is likely this documentation has not been kept up to date!
<big>Anybody with a log-in for this Wiki can edit this page, and your contribution to improving this article is welcomed.</big>
The only rules are to follow existing table layout where possible,
*If a table is sub-divided between read-only and read-write, add any new parameters to the correct sub-section
*If create a table isnew sub-dividedsection between "both flavours", "Cumulus 1 only", and "MX only", add any new parameters toif the correct sub-section does not exist
* the default value should be shown in first column,
* the explanation should be in second column
Later on this page there is a table showing parameters that may be in the configuration file, the default value for each attribute is mentioned, and it is made clear whether that parameter can be set through the settings screen in the software or must be manually added to the file.
Now this page has to cover both the original software, and the MX software where development continues, you will find that the table listing parameters available is divided in multiple ways:
*Cumulus.ini uses '''sections''', thus the first way that the list is divided is by the relevant section where the parameter must be placed
** Some sections can take a lot of parameters, and for these sub-sections may be added, that allow you to navigate directly to them from the table of contents
** A parameter may be defined in multiple sub-sections, if its definition needs to be explained differently according to weather station types
*As explained later, in past MX releases, some parameters are read-only, and some are read-write
**To make it easier to navigate larger tables, read-only and read-write parameters may be grouped under relevant sub-heading within the table
***A parameter may be read-only in theearlier original softwarereleases, but read-write in MXlater releases, this means some parameters may not be where you first expect them to be
*In larger tables, parameters may be grouped by whether they apply to both Cumulus 1 and MX, or apply to one flavour only
**There are no references to which parameters apply to Cumulus 2, as that flavour of the software is not available now
If you spot a parameter that is missing from this list (check you are looking in the right section, and under the correct sub-heading where a section is sub-divided for ease of using this article), then please add it to this Wiki article. None of the authors who have contributed so far can claim completeness. Sometimes a search on the forum for something else reveals a mention of an additional parameter that can be added to the file but has not been previously added to this list.
===Completeness for original Cumulus software===
'''There is no guarantee that all configuration parameters that can be used (if you are running the original software) are in this list'''
''The problem is that Steve Loft lost some of his documentation and admitted he could not remember all parameters his code could process.''
*There have been over a thousand builds of Cumulus version 1
* Steve Loft (as developer) did make some entries that are retained on this page (those should be correct)
*Steve Loft also described in his posts on the forum a number of parameters and how they are used (hopefully all those have been copied into this page, but on 2 June 2008, Steve Loft swapped to new forum software and did not retain any posts prior to then, so there is no way to check the relevant posts between 2003 when the software was first released and May 2008)
*Each contributor may also add/edit entries because of a personal experience of using a particular parameter
The read-write parameters are correct, as they have been checked against [[Cumulus Screenshots|Configuration screens]]. There is no source available for Cumulus 1, so nobody can check what read-only parameters are available against what is documented below.
This page was originally created when only Cumulus 1 was available. It was updated each time there was a major release, some updates mention the release that introduced that parameter. It can be assumed that all parameters marked as applicable to Cumulus 1, do apply to the final formal release.
If you are still using an earlier version of Cumulus 1, it cannot be assumed that all parameters that do not apply to your version are identified. Since the final version of Cumulus 1 cleared most of the bugs present in earlier releases (not quite all, this is still a bug relating to reading pressure from Fine Offset stations), it is to your benefit to upgrade to final '''legacy release''' and apply the patch to the GUI. Both final version and patch can be [[Downloads|downloaded here]].
=== Completeness of this list for MX releases ===
'''Please note that this list is not updated by the developers when they change the software to react to a new attribute, therefore there is no guarantee that all attributes available appear in this documentation.'''
'''The configuration parameters available in MX are often changed by a new release'''.
*Any new read-write parameters introduced by a new release will be added to "Cumulus.ini" when you close MX, but unless someone manually adds them to this article they will not be documented here. However, the default for those read-write parameters might not agree with your preference.
*Any new read-only parameters added by a MX release will neither be added to your "Cumulus.ini", nor be added to this article, unless someone checks this page is updated for each release.
**Hopefully, new parameters are listed in a release announcement, but sometimes you may need to look in a topic with contributions from both users and the developer.
== Beta builds ==
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.
== Beta builds ==
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., Thisduring page continued to show what applied to Cumulus 1,that andperiod 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 articlepage, thatoriginally nowcreated coversfor boththe legacy Cumulus (1) software, but the legacy information was subsequently moved to another page (see reference andat MXtop inof onethis placepage).
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.
== Swapping from Cumulus 1 to MX ==
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 ===
There are some parameters that are different for Cumulus 1 and Cumulus MX, whether you need to change them depends on your set-up.
If you use the standard trends web page:
*Replace: '''IncludeSTDImages=1''' (Cumulus 1) by ''IncludeGraphDataFiles=1'' (Cumulus MX) in [FTP site]
If your weather station uses a serial port type connection:
*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.
If you use a RG11 rain gauge:
*Replace: '''RG11port=n''' and '''RG11port2 =n''' (Cumulus 1) where n is a number, by '''RG11portName=xxxx''' and '''RG11portName2=yyyy''' (Cumulus MX on Windows) where the value is a string with values as per previous paragraph depending on device on which Cumulus MX is running.
=== Parameters added ===
This depends upon which version of MX you install when you move from Cumulus 1, please see all release announcements for details.
== 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. SeeIn Cumulusthe Help,latest release announcementbuild, andall available settings are set within the [[MX_Administrative_Interface| Administrative Interface Settings Pages]]. You may need to work through the settings pages to ensure that any new othersettings providedare documentationreflecting foryour morepreferences.
= File Structure =
The main file consists of a number of sections, each with a heading delimited by '[ ]', (although the order in the file may be different to that in this article). Parameter lines are in the form 'attribute=value' and grouped by those sections. Those attributes can be listed in any order, Cumulus software will always add new attributes to the end of the section. If you are manually adding attributes, it may be best if you sort the attributes so they appear in alphabetical order and thus ensure you do not duplicate attribute names with different values.
The main file consists of a number of sections, each with a heading delimited by '[ ]', (although the order in the file may be different to that in this article). Parameter lines are in the form 'attribute=value' and grouped by those sections. Those attributes can be listed in any order, Cumulus software will always add new attributes to the end of the section. If you are running an old release that allows manually adding attributes, it may be best if you sort the attributes so they appear in alphabetical order and thus ensure you do not duplicate attribute names with different values.
Some [[#Sections_dealing_with_interfaces_to_external_sites|sections]] relate to the external websites that Cumulus can optionally supply with updates. These are set by configuration screens and the whole sections will always be present. If you do not use those external services their parameters will be set to the defaults.
Each new version of cumulus may add additional parameters set by revised configuration screens (these initially appear at the end of the relevant section), and/or permit additional parameters to be added manually (these can be inserted anywhere within the section).
== Creating Configuration File ==
When you download Cumulus 1 or MX, ''there is no configuration file included in the download''. So when you first use the software, either flavour of Cumulus, you will need to enter some settings, and that will lead to creation of the main configuration file. How to enter these minimum settings will be described next.
=== Cumulus 1 ===
#If you start Cumulus 1, without a configuration file, then it will open at the [[Cumulus_Screenshots#Station|station settings screen]]. Follow the link to see what the screen looks like for both old builds and newer builds (as 2 different screens are illustrated).
# At the very minimum, you must select a station type in the top left frame, and units in the middle of the screen.
# Most other entries on the screen have defaults, but you might want to change some of these. Click the '''Help''' button at bottom right of the screen for guidance on what each choice means.
# Optionally, move to other settings screens, accessed from the main screen using the [[Cumulus_Screenshots#Configuration_Menu_Screens|Configuration menu]]. Again click '''Help''' on each screen for more information.
# Optionally create a [[Strings.ini]] file (look up the cross reference if you want to do this now, but you can leave it to later) where you can tailor a number of texts that Cumulus produces.
# Back on the main screen, in the ''File'' menu click '''Exit'''. This is the action that creates the configuration file, the first part of the name is taken from the name of the executable, but the extension is '''.ini''' (instead of .exe).
# Restart Cumulus 1, it will read the configuration file, and connect to your weather station. Note that on this run, it does not read any archive data, it just reads what the weather station holds from now on. See [[FAQ#I.E2.80.99ve_just_installed_Cumulus.2C_and_it_didn.E2.80.99t_download_all_the_old_data_from_my_weather_station|this FAQ]] for a way to change this behavoir.
=== Cumulus MX ===
#If you start Cumulus MX without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this: [[File:MX first start.PNG]]
#As you can see, it is running, but it does not know what station type, so it cannot connect to it, and will not do anything more.
== Configuration File names ==
=== Configuration file created when first installing Cumulus MX ===
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 ===
As downloaded at most versions, the Cumulus 1 installer will create a single executable called '''cumulus.exe''' with all letters in lowercase (there were a few releases where the created executable started with a capital letter). Also the installer for various beta versions behaved slightly differently. The configuration file that Cumulus 1 creates on first use will take the name of the executable file (keeping to the same case for each character) and replace the extension ('''.ini''' instead of .exe) and will be stored in same folder as the executable, it will contain all sections.
Cumulus 1 does not actually care what its executable is called, so some people have renamed it to reflect the version number. 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.
= Editing the file =
== Initialisation ==
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.
For Cumulus MX, if it is being run for the first time and it does not inherit a file, it needs some settings before it can do anything. Consequently, MX just hangs, because unless you look at the Terminal output or the file it creates in [[MXDiags_folder]], you won't know it is waiting for settings. You need to start up the[[MX_Administrative_Interface| Administrative 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.
=== 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.
Please note some settings can take immediate effect while MX is running, others only take on their new values when MX is restarted. Don't ever edit the configuration file directly while Cumulus MX is running!
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_folder]], 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.
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.
== 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.
''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.
== 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.
=== 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 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.
*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'' (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 =
Please look at MX release announcements in the support forum for all releases since July 2020, as they may contain changes not shown below. Volunteers are sought who are able to work as hard as the developer in maintaining this article (and others) in the Wiki to keep up with the frequent releases.
== Minimum Content of "Cumulus.ini" ==
The minimum content of the main configuration file is an entry for every setting that can be defined in the software (that depends on flavour you are using, and it also depends on the version you are running).
== Default and Example Values ==
== Section by Section ==
=== Section: MainForm ===
=== Section: Station ===
This section applies to [[File:Badge v1.png]]Cumulus 1 only.
There are two actions that will create this section in a file that is always called ''Cumulus.ini'' stored in different locations according to the creating action:
*If you edit NOAA parameters then
**One file with this section is stored in the reports sub-directory and it stores the position of your last saved NOAA screen.
*If you have set 'Save main window position' on Display settings screen,
**This section appears in the cumulus.ini file found in same directory as cumulus.exe, and it stores the position of the main Cumulus screen on your monitor.
**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.
<big>THIS SECTION NEEDS TO BE REWRITTEN - MX has changed, and the sub-sections below reflect older releases where some parameters were read-only (not set with admin interface) and some were read-write 9set within admin interface)</big>
{| class="wikitable" border="1"
|-
!style="width:600px" | Function
|-
|style="background:lightgray;"|[MainFormStation]
|style="background:lightgray;"|Section name - the following parameters relate to theall Cumulusweather or NOAA screen positionstations.
|-
|StartDate=13/08/2009
|Left=100
|This parameter is different to all the others. In earlier releases of MX, this was not read-write as you cannot edit it. 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). In the later releases of MX, you can edit it within the admin interface!
|The last saved Cumulus main or NOAA screen position, in pixels from the left-hand edge of the screen.
|-
|UseDataLogger=1
|Top=50
|Some releases of 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.
|The last saved Cumulus main or NOAA screen position, in pixels from the top edge of the screen
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*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.
|}
=== Section: Station ===
=== Spike Removal ===
Which parameters are available from this section depends on release of MX being used, and which type of staion you use.
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to allthe weatherstation stationsconfiguration.
|-
|EWMaxRainTipDiff=30
|StartDate=13/08/2009
|Cumulus MX has a configurable threshold for the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips. For other weather station types, this parameter may be irrelevent.
|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]]
|-
|LastLoggerDownload=13/08/2008 12:48:52
|The date/time of the last down load from your weather station
This parameter is different to all the others. It is not read-write as you cannot edit it, nor is it read-only as Cumulus 1 (early builds) inserts it into Cumulus.ini.
MX default has not been defined anywhere
'''(Note: no longer used, so only present if you used an early Cumulus 1 version)'''; ''If you know which builds this parameter applies to, please update this entry.''
For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds.
Later Cumulus 1 builds, all Cumulus 2, and all Cumulus MX builds, use [[today.ini] to track date/time. This date/time (regardless of whether this parameter is present) is available on your website by using [[Webtags#Miscellaneous|<#LastDataReadT>]]
This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>.
|-
|EWmaxHourlyRain=999
|UseDataLogger=1
|An hourly rain count 'spike removal' filter for weather stations that do not supply this figure so Cumulus has to calculate it.
|{{Version badge 1}}Cumulus 1.x.y: Selected in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]].
Any ''changes in calculated value'', between one calculation and the next, greater than the value specified here will be ignored by Cumulus when it calculates the hourly rain total.
Cumulus ignores this parameter if the weather station directly supplies this figure to Cumulus. '''999''' is the default indicating no spike removal required.
|-
|EWmaxRainRate=999
|A rain rate 'spike removal' filter, ''changes in calculated value'', between one calculation and the next, greater than the value specified here will be ignored by Cumulus when it calculates the rain rate.The default value of '''999''' effectively makes Cumulus ignore spike removal.
|-
|EWgustdiff=999.0
|A wind gust 'spike removal' filter, ''changes in calculated value'' between one calculation and the next, greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus.
|-
|EWwinddiff=999.0
|A wind speed 'spike removal' filter, ''changes in calculated value'' between one calculation and the next greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus
|-
|EWpressurediff=999.0
|A pressure change 'spike removal' filter, ''changes in read value'', from one reading to the next, off any station greater than the value (always mb) specified here (with a default of '''999.0''') will be ignored by Cumulus
|-
|EWminpressureMB=900
|Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
As the bug re reading pressure readings was corrected, this parameter is irrelevent in recent MX releases.
[[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.
|-
|EWmaxpressureMB=1200
|Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars).
As the bug re reading pressure readings was corrected, this parameter is irrelevent in recent MX releases.
*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.
|-
|EWTempdiff=999.0
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|A temperature change 'spike removal' filter. Replace default of 999.0 with the maximum difference in degrees Celsius (the units Cumulus uses for all calculations regardless of what you select for display) you are prepared to accept between successive data readings.
|-
|EWhumiditydiff=999.0
|Logging=0
|A humidity change 'spike removal' filter, ''changes in read value'' from any station greater than the value (as %) specified here (with a default of '''999.0''') will be ignored by Cumulus.
|This is yet another odd parameter for Cumulus 1 (a parameter of the same name in MX appears in the [[Cumulus.ini#Read-Write_parameters_in_the_Station_section|MX only section of read-write parameters]]). The oddness is because it is ''read-only'' in the sense that it has to be manually added to the file and '''cannot''' be amended within [[Cumulus_Screenshots#Station|Configuration individual setting screens]], it is ''read-write'' in the sense that when you exit Cumulus it is reset to its default.
|-
* 0, Default, logging of debugging information is disabled
|ErrorLogSpikeRemoval=0
* 1, add this parameter (if it is not already present). When you set it to one, this means that logging of [[Debug.log|debugging information]] will be enabled when Cumulus 1 is restarted.
|Following applies before version 3.7.0:
*Default is zero as shown, disabling the spike removal feature.
From build 1003 onwards it becomes a '''read-write''' parameter as you can also turn it on/off using the Configuration menu (debug option in menu).
*Add this line to file with Cumulus MX stopped, and set to 1 for the spike removal feature to be enabled.
Following applies from version 3.7.0 :
*the default for new installs is now 1.
* change to zero if you don't want this feature. 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.
|}
==== Read-only parameters in the Station section ====
Some releases of Cumulus MX: The read-only parameters must be entered directly into the configuration file. Stop Cumulus before editing this file using any plain text editor.
{| class="wikitable" border="1"
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|-
|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
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 CelciusCelsius.
*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"
|-
|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.
#The parameter specifies the threshold value which the daily rainfall has to equal or exceed for the day to be considered a 'rain day'.
#Value is entered in your current [[Rain_measurement]] units.
|-
|NoFlashWetDryDayRecords=1
| * When set to 1 (default) stops new Longest Wet/Dry Period records being 'flashed' in Cumulus 1
* Set to 0 if you are happy to have the record light on your Cumulus 1 main screen flash for each rainfall update
[[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
|-
|FCPressureThreshold=0.1
|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.
|-
|RTdisconnectcount=infinite
|{{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
|-
|ErrorLogSpikeRemoval=0
|-
|UVdecimals=0
|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:
|{{Version badge 1}}(added 1.9.3 build 1038) [[File:Badge vMx.png]] applies at all versions
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
|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 its highest wind gust.
*Without this parameter, the default of 10 minutes, the international standard duration, is used.
|-
|AvgSpeedMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, if you have set the next parameter so that Cumulus does its own calculation of average wind speed.
*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.
==== Read-Write parameters in the Station section ====
'''Be aware that this article may not be correctly updated for MX.'''
{{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 for Cumulus 1 are shown in left hand column.'' '''Be aware that this article was first created when only Cumulus 1 was available; some parameters might have different defaults in C1 and MX. It may not be correctly updated for MX.'''
{| class="wikitable" border="1"
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings, for Cumulus 1 edit in Station Configuration Screen
|-
|Type= -1
|Station Type as set by the checked radio box in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]], Station Type block. For details of [[Supported_Devices]] click that link.
*-1= default value, 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.
*0=Vantage Pro station
*1=Vantage Pro2 station
Following added from version 1.7.0:
*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.
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:
|-
|Model="your Model description"
|The weather station model description that you want output by the web tag <#stationtype> - this does not appear in the station settings, stop MX, and add it directly into Cumulus.ini within this [Station] section.
{{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.
|-
|Latitude=0
|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'. Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
{{Version badge 1}}Do this in the Station Configuration Screen Location block.
[[File:Badge vMx.png]] Exactly same entries, enter using station settings by expanding location section.
Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
|-
|Longitude=0
|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'. Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
The place to do this is as described for Latitude depending on Cumulus flavour.
Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
|-
|LatTxt=
|-
|Altitude=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.
|-
|AltitudeInFeet=1
|-
|CalculatedWC=0
|Selected on same screen as other parameters. {{Version badge 1}} - Available only from version 1.8.3
*0 = Disabled
*1 = Enabled, Cumulus will calculate the wind chill instead of using the value supplied by the station. You should set this if you have specified any calibration values for wind and/or temperature, so that Cumulus can also apply those adjustments to the wind chill.
|-
|WarnMultiple=0
| Controls behaviour for Multiple Instances of Cumulus running on PC. Requires a Cumulus restart if value toggled, before new behaviour will take effect. Set as 'Stop 2nd instance' in Station Settings page. Not available in earliest builds of MX.
*0 = Disabled, (default) Multiple instances allowed.
*1 = Enabled, prevents multiple instances of Cumulus from running.
{{Version badge 1}} - Set as 'Stop 2nd instance' in the [[Cumulus_Screenshots#Station|Station Configuration Screen]] Program Settings block. Not available in earliest builds of Cumulus 1 flavour.
[[File:Badge vMx.png]] - Set as 'Stop 2nd instance' in Station Settings page. Not available in earliest builds of MX.
|-
|DataLogInterval=2
|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 = 1 min
*1 = 5 mins
|-
|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
|-
|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
|-
|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, mostnot weatherrelated stationsto workunits inused oneby unityour weather stations (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.
|-
|RainSeasonStart=1
|-
|DataLogging=0
|This parameter (attribute=value) is ignored for MX prior to build 3018, it determines if when you next start Cumulus it will send enhanced information to thea [[debugMXDiags_folder]] 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).
*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 {{Version badge 1}}available in all Cumulus 1 builds.
|-
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|-
|Port=0
|{{Version badge 1}}Selected in the Station Configuration Screen Settings block. Com port in your computer which is connected to your weather station if connected via a serial port. Defaults to port 0.
[[File:Badge vMx.png]] This parameter is ignored by MX, best to remove it, MX uses a Comport parameter instead, see [[#Parameters_changed|#Parameters_changed section]] above.
|-
|SpecialLog=0
|{{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:
* 0 (default) = no special log
* 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]
[[File:Badge vMx.png]] '''SpecialLog''' parameter is ignored in MX
|-
|ConfirmClose=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
*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]]'''ConfirmClose''' parameter is ignored by MX.
|-
|CloseOnSuspend=1
|{{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)
'''CloseOnSuspend=1''' ''is ignored by MX, however if you are running a MX release that permits running MX as a service, and'' '''you do run MX as a service''', ''the service handler on the Windows Operating System, does respond to suspend/standby/hibernate conditions.''
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|RecordSetTimeoutHrs=24
|[[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.
This parameter is not available in any earlier versions (i.e. not in MX up to, and including, 3.5.0; nor in any {{Version badge 1}} Cumulus 1 version).
|-
|Logging=0
*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.
|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.
{{Version badge 1}} Cumulus 1 ignores this parameter, see [[Diagnostics]].
|-
|RecordSetTimeoutHrs=24
|[[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.
|}
==== Davis family specific: ====
{{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.
|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 in earlier releases must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|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 parameeterparameter, 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. '''Note for MX''', use of the LOOP2 interface means s.l.p. can be obtained from the Davis station.
[[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.
*1 = Enabled (default)
|-
|colspan="2" style="background:lightblue;"| Read-write parameters: 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
*0 = Disabled
*1 = Enabled
|-
|SyncDavisClock=0
|When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
|Set this in the Station Configuration Screen '''Settings''' block where called '''Synchronize station clock'''.
When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
*0 = Disabled, default (as deselected on the Station Configuration Screen)
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
|-
|ClockSettingHour=4
|Configuration file read-only setting, controlsControls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*4 = 04:00 (default value)
*0-23 = 00:00 to 23:00
|-
|VP2ConnectionType=1
|Weather station connection type that is selected in the ''Station'' Configuration Screen '''Davis type''' block
*0 = serial (see next parameter to specify COM port)
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
|-
|VP2TCPPort=22222
|Comunications port used if VP type has TCP/IP selected. Default is 2222
|Set this in the Station Configuration Screen '''Davis TCP/IP Settings''' block.
Comunications port used if VP type has TCP/IP selected. Default is 2222
|-
|VP2IPAddr=0.0.0.0
|Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
|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
|-
|VP2PeriodicDisconnectInterval=0
|When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.
|Set this in the Station Configuration Screen '''Settings''' block with the ''Discon period'' value.
When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.
Set it to zero to disable, if you are not using the Weatherlink site.
|LogExtraSensors=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.
|-
|colspan="2" style="background:lightblue;"|{{Version badge 1}} Cumulus 1 only: edit in Station Configuration Screen (if read-write) or file (both read-only and read-write) as indicated
|-
|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)
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).
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
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
|-
|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.
|-
|RestartIfDataStops=0
|{{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.
|-
|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.
|-
|colspan="2" style="background:lightblue;"| Only available in Cumulus MX: edit in Station Settings (if read-write) or if read-only directly in file
|-
|UseDavisLoop2=1
|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.
|[[File:Badge vMx.png]]This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
*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.
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.
|-
|DavisIPResponseTime=500
|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.
|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
| Added in build 3042 (January 2017).
|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.
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". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|-
|DavisIncrementPressureDP=0
|[[File:Badge vMx.png]](from version 3.0.0 build 3042) A read-only 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
|-
|VPrainGaugeType=0
|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.
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.
NOTE: This setting supersedes the setting "DavisRainCollectorModel" used in Cumulus 1
|-
|DataLogging=0
|[[File:Badge(Build vMx3018 onwards).png]]Read-write: Set in options section of station settings page. Default is 0, change to 1 for more detailed Davis logging.
*0 (default) = Cumulus MX will not add extra logging.
*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).|-
|-
|AutoUpdateIpAddress=1
|[[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.
|-
|ZeroConfig
|[[File:Badge vMx.png]]Read-write: 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="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
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.
|-
|EWpressureoffset=x.y
|ReportLostSensorContact=0
|Got a pressure problem with a Fine Offset station when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero? Early releases of MX had a bug and treated a memory byte in the Fine Offset console that is nothing to do with pressure as part of the pressure reading!
|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).
*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]]).
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].
Not applicable to MX.
|-
|EWduplicatecheck=0
|Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.
Introduced in version 1.8.5 (b.630) to deal with certain bytes being given the same value in first and second line.
*0 = Disabled, default, Cumulus accepts all bytes from the Fine Offset station's memory.
*1 = Ignores part of memory (see [https://cumulus.hosiene.co.uk/viewtopic.php?f=13&t=393 this forum thread]).
For example one problem is that "55 AA" repeats at the start of the second line of data. Those bytes are only supposed to appear at the start of the first line (or so I am told).
May not be useful in later releases of MX that read pressure from Fine Offset correctly.
Not applicable to MX
|-
|EWpressureoffset=x.y
|Add this line to cumulus.ini [Station] section
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]. 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
*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 ====
'''The Cumulus help file says''' - "The "Spike removal" section allows you to specify the maximum differences between successive readings that you wish to allow, for Fine Offset and La Crosse stations. If a reading differs from the previous reading by the value you specify, or more, then it will be ignored. Be careful in your choice of values; if the difference is genuine, (i.e. not a 'spike') and exceeds your supplied value, then that reading will be 'stuck' at the previous value until a new reading returns to within your supplied difference.
Note that the spike removal values must be supplied in the 'native' units of the station, as shown on the screen. The gust value has no effect on La Crosse stations, as it only supplies one wind value - 'spike removal' is applied at the station level, unlike offsets and multipliers which are applied at a 'common' level; just use the 'wind speed' value."
* {{Version badge 1}} This section was written when only Cumulus 1 was available, so the parameters are listed with defaults applicable up to Cumulus 1.9.4.
**7 of the 10 spike removal parameters listed below are adjusted in the frame at the bottom of the ''Calibration'' screen, off '''Configuration''' menu, they have a prefix of EW because they were introduced for dealing with problems seen in the Fine Offset family; the corrections are only applied when Cumulus 1 is reading directly from the station at a very frequent interval, spike removal does not apply when Cumulus is re-started and is transferring observations from the station logger to the Cumulus monthly log.
**The other 3 spike removal parameters have to be entered directly in cumulus.ini, none of these ones can be set on the 'calibration' screen.
**As Cumulus 1 does not check station type before applying any of these settings, ensure for Davis stations (these do not have spike problems) the spike removal filters are set to the defaults shown below.
**However, spike removal correction may be implemented for La Crosse stations, they can have problems with their PC interface, using the same EW filter settings listed below.
*[[File:Badge vMx.png]] Please check by looking at support forum whether parameters in this section are correct for your version of MX.
** With MX, spike removal still compares successive readings from your weather station
**The difference, in MX, is that spike removal applies to all weather station types.
{| 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.
|-
|EWMaxRainTipDiff=30
|Add this line to cumulus.ini [Station] section
Cumulus (1 and MX) has a configurable threshold for the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips.
Default=30 tips in Cumulus 1, MX default has not been defined anywhere
For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds.
This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>.
|-
|EWmaxHourlyRain=999
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
An hourly rain count 'spike removal' filter for weather stations that do not supply this figure so Cumulus has to calculate it.
Any ''changes in calculated value'', between one calculation and the next, greater than the value specified here will be ignored by Cumulus when it calculates the hourly rain total.
Cumulus ignores this parameter if the weather station directly supplies this figure to Cumulus. '''999''' is the default indicating no spike removal required.
|-
|EWmaxRainRate=999
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
A rain rate 'spike removal' filter, ''changes in calculated value'', between one calculation and the next, greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus when it calculates the rain rate.
Cumulus ignores this parameter for other makes of weather station (they supply a rain rate to Cumulus). The default value of '''999''' also effectively makes Cumulus ignore spike removal.
|-
|EWgustdiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
A wind gust 'spike removal' filter, ''changes in calculated value'' between one calculation and the next, greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus.
|-
|EWwinddiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
A wind speed 'spike removal' filter, ''changes in calculated value'' between one calculation and the next greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus
|-
|EWpressurediff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A pressure change 'spike removal' filter, ''changes in read value'', from one reading to the next, off any station greater than the value (always mb) specified here (with a default of '''999.0''') will be ignored by Cumulus
|-
|EWminpressureMB=900
|Add this line to cumulus.ini [Station] section
Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
|-
|EWmaxpressureMB=1200
|Add this line to cumulus.ini [Station] section
Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars).
|-
|EWTempdiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A temperature change 'spike removal' filter.
Replace default of 999.0 with the maximum difference in degrees Celsius (the units Cumulus uses for all calculations regardless of what you select for display) you are prepared to accept between successive data readings.
|-
|EWhumiditydiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
A humidity change 'spike removal' filter, ''changes in read value'' from any station greater than the value (as %) specified here (with a default of '''999.0''') will be ignored by Cumulus.
|-
|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.
{{Version badge 1}}
*Default is zero as shown, disabling the spike removal feature.
*Add this line to file with Cumulus 1 stopped, and set to 1 for the spike removal feature to be enabled.
??It appears that C1 limits the number of messages in the error log window to a maximum of 256, so that limit may affect reporting of spike removal, but hopefully it does not restrict the functionality of spike removal ?? '''Could someone verify that, and update this entry'''
[[File:Badge vMx.png]] Before version 3.7.0
*Default is zero as shown, disabling the spike removal feature.
*Add this line to file with Cumulus MX stopped, and set to 1 for the spike removal feature to be enabled.
[[File:Badge vMx.png]] From version 3.7.0
*the default for new installs is now 1.
* change to zero if you don't want this feature. 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.
|}
==== 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"
|-
|Humidity98Fix=0
|Applies to weather station types that never report more than 98% relative humidity.
|Selected in the Station Configuration Screen Settings block.
*0 = Disabled (default)
*1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98% or greater. Normally only useful for Oregon Scientific stations.
|-
|LogExtraSensors=0
|This setting determines whether MX looks for readings from extra temperature probes etc.
|This is set in the settings frame on the Station settings screen off the configuration menu by the '''Extra Sensors''' selection.
*0=Disabled (default)
*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).
|-
|colspan="2" style="background:pink;"|Read-only parameters - Thehow parametersto listedset belowdepends muston be entered directly into file with Cumulus stopped. Used in both C1 andyour MX unless indicatedrelease.
|-
|WMR928TempChannel=N
|This line needs to be added in the [Station] section of the Cumulus.ini file for WMR-928 stations (and other serial stations using the same protocol, eg WMR-968) to use an 'extra' channel (see previous parameter) as your main temperature sensor, set N to the required channel
|-
|WMR200TempChannel=N
|This line needs to be added in the [Station] section of the Cumulus.ini file for WMR200 stations (and any other Oregon Scientific USB stations which work with Cumulus, e.g. WMR100) to use an 'extra' channel as your main temperature sensor, set N to the required channel
|}
==== La Crosse specific: ====
'''NOT AVAILABLE IN CUMULUS MX - at time of writing "RestartIfDataStops" is not available'''
{| class="wikitable" border="1"
|-
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|colspan="2" style="background:pink;"|Read-only parameters - Thehow parametersto listedset belowdepends muston be entered directly into file with Cumulus stopped. Used in both C1 andyour MX unless indicatedrelease.
|-
|WS2300Sync=1
|This line needs to be added in the [Station] section of the Cumulus.ini. This makes Cumulus check the time that the station is going to communicate with the sensors, and synchronises all of its reads to be 2.5 seconds after that. Experiments have shown that this does not help the bad data situation.
|-
|LCMaxWind=X
|This line needs to be added in the [Station] section of the Cumulus.ini. It is setting for the La Crosse max wind speed, where X is the maximum (uncalibratedprior to any offset settings) wind speed in m/s that you want to allow. The value you supply should be in metres/second, regardless of what wind unit you are using in Cumulus.(V1.8.8 Build 874 on)
|-
|WS2300IgnoreStationClock=0
|This line needs to be added in the [Station] section of the Cumulus.ini. Option to ignore the La Crosse station clock on logger download.
*0 = Disabled (default)
*1 = Enabled
|-
|RestartIfDataStops=0
|{{Version badge 1}}This line needs to be added in the [Station] section of the Cumulus.ini.
Option for Cumulus 1, it attempts to restart itself if it has had no data from a La Crosse station for 60 seconds i.e. if data from station stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
*0 = Disabled (default)
*1 = Enabled
|-
|ReportDataStoppedErrors=0
|This line needs to be added in the [Station] section of the Cumulus.ini.
Option to turn off reporting of 'data stopped' errors to the Cumulus error log (may be needed with La Crosse stations)
*0 = Disabled (default)
*1 = Enabled
|}
The spike removal parameterparameters listed in the Fine Offset section above, may also be used with La Crosse stations.
==== Hydreon specific: ====
All 6 of these parameters are set on RG11 screen within configuration menu, see its ''Help'' for more information.
{| class="wikitable" border="1"
====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="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|colspan="2" style="background:pink;"|Read-only parameters - Thehow parameterto listedset belowdepends muston beyour enteredMX directly into file with Cumulus stopped. Used in both C1 and MXrelease.
|-
|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.
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
|The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value
|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
|Set this in the Station Configuration Screen Settings block where called '''Synchronize station clock'''. Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
When set, at Cumulus start-up and at 04:00 each day, Cumulus will set the Instromet clock to within a minute of the same time as the PC
*0 = Disabled, default as deselected on the Station Configuration Screen
|-
|LogExtraSensors=0
|This is set in the settings frame on the Station settings screen off the configuration menu by the '''Extra Sensors''' selection. If you have 'extra sensors' selected, the wet bulb reading will be used as an extra temperature sensor. Otherwise it is used as 'wet bulb' and the humidity will be calculated from that and the dry bulb sensor.
*0=Disabled (default)- . For a wet bulb sensor, Cumulus will output the humidity, not the temperature shown by the wet bulb.
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations. For a wet bulb sensor, Cumulus will output the temperature it shows, but not calculate the humidity.
(Note this attribute appears in [[#Davis_family_specific|Davis family]], [[#Oregon_Scientific_specific:|Oregon Scientific specific]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above with different usage explanations).
=== 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.
{| class="wikitable" border="1"
|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 - Thehow parameterto listedset belowdepends muston beyour enteredMX directly into file with Cumulus stopped. Used in both C1 and MXrelease.
|-
|TempMult2=0.0
"Second order" multiplier by which measured outdoor Temperature is to be corrected, this means that the logged reading can be (TempMult2 X measured-temp X measured_temp) + (TempMult X measured_temp) + TempOffset
|-
|colspan="2" style="background:pink;"|Read-onlyOnly parametersMX -(build The3045 parameteronwards) listed- belowhow mustto beset entereddepends directlyon into file with Cumulus stopped. Onlyyour MX (build 3045 onwards)release.
|-
|HumMult2=0.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;"| BothAll CumulusMX flavoursreleases
|-
|TempOffset=Offset_Value
|Multiplier by which measured Average [[Wind_measurement#Wind_Speed|Wind Speed]] is to be corrected (default=1).
e.g. Officially in UK (and most WMO obeying nations) the wind speed is measured with sensors at 10m above ground level. If your sensor is not at 10m AGL then a correction multiplier should be applied using the following formula ''V10/Vh = 1/(0.233 + 0.656*log10(h+4.75))'' where "h" is your sensor height in meters so if your anemometer is 5m off the ground, V10/Vh comes out at 1.134
|-
|WindGustMult=1
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
|-
|PressMult = 1.0
|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
|}
=== Section: Web Site ===
Applies to both flavours of Cumulus:
*Both parameters edited in Cumulus 1 using the Internet Configuration screen ''Sites/Options tab'' Web Site block.
*Both parameters edited in MX using Internet Settings screen within '''Web/FTP site''' section.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Web Site]
|style="background:lightgray;"|Section Name - the following parameters relate to your website
|-
|ForumURL=<nowiki>https://cumulus.hosiene.co.uk/</nowiki>
|A website forum URL
|-
|WebcamURL=<nowiki>http://www.sanday.org.uk/webcam/webcam.php </nowiki>
|URL for your Webcam
|}
=== Section: FTP site ===
[[File:Badge vMx.png]]NOTE: For MX, the word site should be in lower case as shown in left-hand column heading and above.
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.
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"
|-
|style="background:lightgray;"|[FTP site]
|style="background:lightgray;"|Section Name - the following parameters relate to your website FTP parameters
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|-
|DailyProgram=
|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
|-
|DailyParams=
|
|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
The corresponding 'parameters' for 'DailyProgram' used to specify any parameters to be passed to that command.
|-
|Host=
|''Leave blank, "'''Host='''", if you are not using ftp'', but simply creating the output files on your pc with a Copy instruction.
|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''.
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.
''Leave blank, "'''Host='''", if you are not using ftp'', but simply creating the output files on your pc with a Copy instruction.
|-
|Port=21
|you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS i.e.FTPS (port=25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative ports.
|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, so don't change default unless your set-up is non-standard.
For Cumulus MX, you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS i.e.FTPS (port=25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative ports.
|-
|Username=
|the user name for connecting to your server
|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=
|Shows your web site FTP login password as entered in the ''Internet'' option of '''Configuration''' menu (note: this is not encrypted)
|-
|Directory=
|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)
*A path from the starting point as the position specified by ftp server (see Host above)
|-
|IncludeSTD=1
|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
*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
|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.
*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).
|-
|FTPlogging=0
|Where output is stored depends on what type of FTP you have selected
|Set (Cumulus 1) by selecting ''FTP Logging'' in '''Configuration''' menu, or by adding this line to 'FTP site' section of Cumulus.ini.
*0 (default) = Cumulus will not store messages from FTP server.
*1 = Cumulus will 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_folder]] file.
|-
|MaxFTPconnectRetries=3
|Allow configurable max FTP connect retries (default is retry up to 3 times).
|Set in this config file only.
Allow configurable max FTP connect retries (default is retry up to 3 times).
|-
|ActiveFTP=0
|Whether to ''Use active FTP mode''.
|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
|Whether to ''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
*1 = Enabled, the new update is loaded using temporary names, files are renamed on the sever afterwards
|-
|DeleteBeforeUpload=0
|Whether to use ''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)
*1 = Enabled, files are deleted from sever before the new update is loaded
|-
|UpdateInterval=15
|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=
|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 'normalstandard' web update interval (defined by previous parameter), after all of the other processing has been performed.
|-
|ExternalParams=
|Selected in the '''Params''' box alongside the '''Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'ExternalProgram' used to specify any parameters to be passed to that command.
|-
|EnableRealtime=0
|Cumulus wil not set up a timer for actions to be performed at a "real time interval" as well as a "standard interval" unless this parameter is enabled.
|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)
** - If you do not have ''Auto Update'' option set (top of Web Settings block), the ''realtime.txt'' file is not created/updated.
*1 = Enabled, Cumulus will add a timer that allows you to upload at a more frequent interval than the standard upload interval set above
**Cumulus will create a new ''realtime.txt'' file at the Real-time Interval (Note that neither Cumulus 1 nor Cumulus MX use this file in standard features, but it can be fed to other software that requires frequent values updating)
** - Other parameters need to be set for more actions..
The [[realtime.txt]] file contains various weather parameters and was used by the CumulusRealtime.swf (shock wave flash) real time wind gauges (as on the supplied 'gauges' web page for early versions of Cumulus 1.x.x). Shockwave flash software was withdrawn some years ago, so this usage ceased. This parameter controls whether the file is created, the next 2 parameters control how and whether it is uploaded.
|-
|RealtimeFTPEnabled=0
|This parameter is enabled if you want a file transfer process to be initiated on any files to be uploaded at the real time interval. The preceding 'EnableRealtime' setting must be set to 1 for this setting to have any effect.
|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.
*1 = Enabled, Cumulus will establish an FTP connection to your web site, so that the realtime.txt file, and any other files you specify, can be uploaded when realtime processing takes place.
The 'EnableRealtime' setting must be set to 1 for this setting to have any effect.
** - If you have the ''RealtimeFTPEnabled'' option set, and a suitable ''RealtimeInterval'' configured, (for second of these see below) Cumulus will upload the ''realtime.txt'' file to your web site, after the number of seconds specified by '''RealtimeInterval''' (see that parameter below) since any previous upload
|-
|RealtimeTxtFTP=0
|When set to 1, Cumulus will upload the [[realtime.txt]] to your web site during realtime processing. The preceding 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.
|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.
|-
|{{Version badge 1}}RealtimeInterval=1530000
|The time '''between''' uploads of the '''realtime.txt''' file, and any other files associated with real-time interval, (i.e. a new upload of files will '''begin''' this number of micro-seconds '''after''' the last upload has '''ended''').
[[File:Badge vMx.png]]RealtimeInterval=30000
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime Interval''. The time '''between''' uploads of the '''realtime.txt''' file, and any other files associated with real-time interval, (i.e. a new upload of files will '''begin''' this number of seconds '''after''' the last upload has '''ended''').
*If you set it to 15 seconds and it takes say 10 seconds for any uploads, it will not be until the time it takes plus another 15 seconds has elapsed that it does the next upload (i.e it starts 25 seconds after last start).
*If you set it to 5 seconds, and it takes say 10 seconds for any uploads, while you won't actually get an upload every 5 seconds, it will always attempt the next upload within 5 seconds of the previous one ending, so it starts approximately every 15 seconds.
Note the difference in default value between the two flavours as shown in previous column.
|-
|RealtimeProgram=
|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=
|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
|-
|IncludeSTDImages=1
|{{Version badge 1}}Set in the ''Internet'' option of '''Configuration''' menu of Cumulus 1 by the ''Include Standard Images'' at the top of ''Files'' Tab screen.
*0 = Disabled
*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'.
|-
|ResizeGraphs=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web graphs block.
*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.
|-
|GraphHeight=300
|Graph height, default is 300 (pixels) - see previous parameter
|-
|GraphWidth=750
|Graph width, default is 750 (pixels) - see ResizeGraphs parameter
|-
|ImageFolder=
|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.
|-
|ImageCopyRealtime=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Realtime?'' at the bottom of ''Files'' Tab screen.
*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
|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'.
|-
|IncludeUVChart=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''UV'' at the top of ''Files'' Tab screen.
*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'.
|-
|IncludeSunshineChart=0
|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="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|-
|ExtraLocalxx=
|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. From build 3087, MX also allows you to use "<currentextralogfile>" to specify the name of the extra sensor log files being currently 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=
|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>" (allas versionspart of Cumulusa 1 or MX)path on its ownspecification 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). From build 3087, MX also allows you to use "<currentextralogfile>" to specify the name of the extra sensor log files being currently 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.
|-
|ExtraProcessxx=0
|Where 'xx' varies between 0 and 99; used to specify if file named in ExtraLocal parameter is a template file 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
*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
|Where 'xx' varies between 0 and 99; The format of the file named in Extra Local
*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). useUse 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. 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.
|-
|ExtraFTPxx=1
*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 (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
*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
*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
|[[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
*1 = to be uploaded at end of day, the realtime interval must be set to 0.
|-
|RealtimeGaugesTxtFTP=0
|[[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 (default) = the file is only uploaded at the standard interval
*1 = the file is uploaded by FTP at the real time interval
|-
|DisableEPSV=0
|[[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.
|-
|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
|-
|ComportName=/dev/ttyUSB0
|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.
|[[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.
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.
|-
|DisableFtpsExplicit=0
|[[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
|-
|}
=== 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 MXMX_Administrative_Interface#MySQL_settings]] page for examples of what can be selected.
<pre>
[MySQL]
=== Section: Display ===
The only settings used in this section by Cumulus MX are "NumWindRosePoints" and those for extras.
{{Version badge 1}}Set the majority of these parameters using Configuration menu and [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|either ''Display'' or ''Colours'' screens]] as seen on link and indicated below. The exception is "TwelveHourClock", that parameter is set by clicking on the displayed time.
[[File:Badge vMx.png]]The only settings used in this section by Cumulus MX are "NumWindRosePoints" and those for extras.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Display]
|style="background:lightgray;"|Section heading - the following parameters affect how the main screen looks.
|-
|Heading=My Weather
|{{Version badge 1}}Title Heading on the Main Screen. Set in the Display Configuration Screen General block
|-
|SavePosition=0
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*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
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*0= default, the main window will be displayed on the main or only monitor connected to your pc
*1= If set to 1, Cumulus will start with the main window minimised, either to the system tray or the task bar, depending on the 'MinimizeToTray' setting (see next parameter).
|-
|MinimizeToTray=0
|{{Version badge 1}}Set in the Display Configuration Screen General block
*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
|{{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
|-
|FontColour=4227327
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the screen font color
|-
|BackColour=12632256
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the application background color
|-
|HeadingColour=10485760
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the screen heading color
|-
|ClockDigitColour=4227327
|{{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
|-
|ClockColour=16777201
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the main screen clock background color
|-
|TwelveHourClock=0
|{{Version badge 1}}Set by left click on clock on main screen
*0 = 24Hr clock mode
*1 - 12 Hr am/pm clock mode
|-
|WMR928Channel1Caption=Extra channel 1
|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.
|-
|WMR928Channel2Caption=Extra channel 2
|See previous parameter.
|-
|WMR928Channel3Caption=Extra channel 3
|See 'WMR928Channel1Caption=Extra channel 1' parameter
|-
|SnowUnitText=cm
|Set in ''Snow units'' box in the Display Configuration Screen ''General'' block. Default is cm.
This allows you to set the text that appears with the snow depth in the weather diary. Note that there is no significance attached to this and the effect is purely cosmetic; the snow depth is effectively unitless and you can supply any text you wish, remember all snow depth observations must be entered as an integer (without any decimal part)!
|-
|DisplayCloudBase=0
|{{Version badge 1}}Set in the Display Configuration Screen General block.
*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
|{{Version badge 1}}Set in the Display Configuration Screen General block
*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
|{{Version badge 1}}Set by ''Display solar/extra data'' item in the Display Configuration Screen ''General'' block.
*0 = Disabled (default)
*1 = Enabled, adds an extra panel to the main screen below the recent extremes panel - EITHER
**Panel displays ''Temp'', ''Dew pt'' and ''Hum'' (this [[FAQ#How_does_Cumulus_deal_with_extra_sensors.3F|extra sensor data]], can be populated from Oregon WMR-928 stations, see next 3 parameters) OR
**Panel displays ''Evapotranspiration (ET)'', ''Ultraviolet (UV)'' and ''Solar radiation'' if station '''Type''' is Vantage Pro and solar data is available
|-
|DisplayStormRain=0
|{{Version badge 1}}Set by ''Display 'Storm Rain' '' item in the Display Configuration Screen ''General'' block.
*0 = Disabled, (default)
*1 = Enabled, adds an extra output to the main screen to show what Davis stations report as Storm Rain
|-
|ShowCurrentConditions=0
|Set in the Display Configuration Screen General block
*0 = Disabled, (default)
*1 = Enabled, a box labelled 'Current:' appears at bottom of Cumulus main screen. See [[Webtags_as_boolean_operators_in_HTML#Current_Weather_Conditions]] for possible use of this information, and [[Currentconditions.txt]] for the effect when the contents of the box on main screen changes.
|-
|LegendSymbolWidth=3
|{{Version badge 1}}Set in the Display Configuration Screen Graph block. The width of the plot lines in graph legends
|-
|ChartLineWidth=2
|{{Version badge 1}}Set in the Display Configuration Screen Graph block. The width of the plot lines in the graph body
|-
|WindGaugeRange=50
|{{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.
|-
|WindGaugeArcColour=16773091
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeAnimated=1
|{{Version badge 1}}Set by ''Wind gauge animated'' item in the Display Configuration Screen ''General'' block. Animate the Wind Gauge pointer movement
*0 = Disabled,
*1 = Enabled (default)
|-
|WindGaugeAnimationFactor=2
|{{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.
|-
|WindGaugeTickColour=9841920
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeFontColour=9841920
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeInnerCircleColour=16765615
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeNeedleColour=128
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeInnerCentreColourFrom=16765615
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeInnerCentreColourTo=16765615
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeOuterCentreColourFrom=16765357
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeOuterCentreColourTo=16711680
|{{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
|-
|WindGaugeOuterRimColour=9470064
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeAverageSectorColour=32768
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugePeakSectorColour=33023
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeNeedleShineColourFrom=1049273
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|WindGaugeNeedleShineColourTo=328090
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots
|-
|CompassColour=12632256
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|CompassTickColour=16711680
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|CompassLabelColour=16777215
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|CompassBearingColour=0
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|CompassCurrentPointerColour=255
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|CompassAveragePointerColour=16711680
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots
|-
|WindRoseColour=8388608
|{{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
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the wind rose compass points
|-
|WindRoseAxesColour=8388608
|{{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
|-
|WindRoseTransparency=50
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu.
|-
|NumWindRosePoints=16
|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)
|-
|TransparentGauges=0
|{{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.
|-
|TransparentGraphs=0
|{{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
|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.
|-
|DigitBackground=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
|-
|LabelColour=0
|{{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).
|-
|AlarmColour=255
|{{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
|-
|PastAlarmColour=16711680
|{{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
|{{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
|-
|PanelLineColour=0
|{{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
|-
|PanelBorderColour=8421504
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the edging of each panel with observations
|-
|PanelGradientColourFrom=16777215
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the panel background
|-
|PanelGradientColourTo=13226453
|{{Version badge 1}}Set on the colour setting screen in the Configuration menu. Decimal code for the panel background
|-
|DisplayBeaufortDesc=1
|{{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.
|-
|DisplayBarometerTrendText=1
|{{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.
|-
|UpdateAtStartup=1
|{{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.
|-
|IndependentGraphsWindow=0
|{{Version badge 1}}Set in the Display Configuration Screen Graphs block
*0 = Disabled (default)
*1 = Enabled
|}
=== Section: Solar ===
Irrelevant if you do not have solar sensors.
{{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"
|-
|style="background:lightgray;"|[Solar]
|style="background:lightgray;"|Section Name - the following parameters are set as described above
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours
|-
|SunThreshold=75
|-
|LuxToWM2=0.0079
|Edit cumulus.ini to add this parameter applies if you have a Fine Offset station with a solar detector. These supply 'Lux' values rather than 'W/m2' values that Davis stations supply. Cumulus attempts to convert from Lux to W/m2 using the supplied multiplication factor. You can add this parameter if you want to use a value other than the default of 0.0079, which is the generally accepted standard conversion factor for sunlight.
|-
|UseBlakeLarsen=0
| Called B/l on screen. Set this to 1 if you have a Blake-Larsen Sun Recorder, and you want Cumulus to get today's sunshine hours from it. You need to configure the Blake-Larsen software to put the SRsunshine.dat file into the correct folder fori.e. yourthe ''' program root folder''' in MX (i.e. same folder as where "Cumulus.ini" is stored). flavour:
{{Version badge 1}} The correct folder is '''Cumulus\data\''' in Cumulus 1 (C1 only runs in Windows operating system).
[[File:Badge vMx.png]] The correct folder is the ''' program root folder''' in MX (i.e. same folder as where "Cumulus.ini" is stored).
|-
|colspan="2" style="background:lightblue;"| [[File:Badge vMx.png]] Available from MX version 3.0.0 only
|-
|SolarCalc=1
=== Section: Graphs ===
All settings in this table are controlled in the '''Graphs''' section at the bottom of the '''Station Settings''' page. Note that some are not iun all releases.
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"
|-
|style="background:lightgray;"|Section Name - the following parameters relate to your graph settings
|-
|GraphHours=
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|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. the default varies depending on which release you are using.
|-
You can enter any multiple of 12.
|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
|-
|TempVisible=1
|Select whether to plot the outside air temperature on the temperature graph. '''MX from v3.7.0'''
*0 = Disabled
*1 = Enabled
|-
|HIVisible=0
|Select whether to plot the heat index on the temperature graph. '''MX from v3.7.0'''
*0 = Disabled
*1 = Enabled
|-
|DPVisible=1
|Select whether to plot the dewpoint values on the temperature graph. '''MX from v3.7.0'''
*0 = Disabled
*1 = Enabled
|-
|WCVisible=1
|Select whether to plot the wind chill values on the temperature graph. '''MX from v3.7.0'''
*0 = Disabled
*1 = Enabled
|-
|AppTempVisible=1
|Select whether to plot the apparent temperature values on the temperature graph. '''MX from v3.7.0'''
*0 = Disabled
*1 = Enabled
|-
|InHumVisible=1
|Select whether to plot the indoor humidity values on the humidity graph. '''MX from v3.7.0'''
*0 = Disabled
*1 = Enabled
|-
|OutHumVisible=1
|Select whether to plot the outdoor humidity values on the humidity graph. '''MX from v3.7.0'''
*0 = Disabled
*1 = Enabled
|-
|colspan="3" style="background:lightblue;"| Cumulus MX only
|-
|MoonImageEnabled=1
*0 = Disabled
*1 = Enabled
|-
|colspan="3" style="background:lightblue;"| Cumulus 1 only
|-
|Background=12632256
|Decimal value for the Graph and Chart background colour.
|-
|WindColour=65535
|Decimal value for the 10 minute average wind speed plot colour
|-
|GustColour=8421376
|Decimal value for the Wind Gust plot colour
|-
|RainColour=9527753
|Decimal value for the Rain plot colour
|-
|RainTodayColour=9527753
|Decimal value for the Rain Today plot colour
|-
|TempColour=9527753
|Decimal value for the Outside Temperature plot colour
|-
|HeatIndexColour=16711680
|Decimal value for the Heat Index plot colour
|-
|AppTempColour=8388736
|Decimal value for the Apparent Temperature plot colour
|-
|PressColour=9527753
|Decimal value for the Pressure plot colour
|-
|WindDirColour=255
|Decimal value for the Wind Direction plot colour
|-
|DewPointColour=255
|Decimal value for the Dew Point plot colour
|-
|WindChillColour=32768
|Decimal value for the Wind Chill plot colour
|-
|MinTempColour=16711680
|Decimal value for the Minimum Temperature chart plot colour
|-
|MaxTempColour=255
|Decimal value for the Maximum Temperature chart plot colour
|-
|AvgTempColour=32768
|Decimal value for the Average Temperature chart plot colour
|-
|DailyRainColour=32768
|Decimal value for the Daily Rain chart plot colour
|-
|InsideTempColour=0
|Decimal value for the Inside Temperature plot colour
|-
|InsideHumColour=255
|Decimal value for the Inside Humidity plot colour
|-
|OutsideHumColour=16711680
|Decimal value for the Outside Humidity plot colour
|-
|Graph3D=0
|3D or normal graph selection as selected in the Display Configuration Graphs block
*0 = normal graph selected
*1 = 3D graph selected
|-
|PlotLatestGust=0
|Plot Latest Gust selection as selected in the Display Configuration Graphs block
*0 = Disabled
*1 = Enabled
|-
|OriginIsSouth=0
|Wind Direction Graph Y Axis origin
*0 = North as Origin (default)
*1 = South as Origin
|-
|ShowFreezingLine=0
|Draw a horizontal line on the temperature graph at 0°C/32°F
|-
|GraphGradientEnabled=0
|Use gradient shading on the graph background
*0 = Disabled
*1 = Enabled
|-
|GradientStart=12632256
|
|-
|GradientMiddle=16777215
|
|-
|GradientEnd=8421504
|
|-
|SAGintempcolour=32768
|(Select-A-Graph)
|-
|SAGouttempcolour=255
|
|-
|SAGpressurecolour=16711680
|
|-
|SAGraintotalcolour=8388608
|
|-
|SAGrainratecolour=16776960
|
|-
|SAGgustcolour=16711935
|
|-
|SAGpeakgustcolour=65280
|
|-
|SAGspeedcolour=8388736
|
|-
|SAGinhumcolour=32896
|
|-
|SAGouthumcolour=8388608
|
|-
|SAGheatindexcolour=128
|
|-
|SAGwindchillcolour=8421504
|
|-
|SAGwinddircolour=0
|
|-
|SAGdewpointcolour=8421376
|
|-
|SAGsolarradcolour=65535
|
|-
|SAGmaxsolarradcolour=16711935
|
|-
|SAGapptempcolour=0
|
|-
|SAGuvindexcolour=65280
|
|-
|SAGintempaxis=L
|(Select-A-Graph)
|-
|SAGouttempaxis=L
|
|-
|SAGpressureaxis=L
|
|-
|SAGraintotalaxis=L
|
|-
|SAGrainrateaxis=L
|
|-
|SAGgustaxis=L
|
|-
|SAGpeakgustaxis=L
|
|-
|SAGspeedaxis=L
|
|-
|SAGinhumaxis=L
|
|-
|SAGouthumaxis=L
|
|-
|SAGheatindexaxis=L
|
|-
|SAGwindchillaxis=L
|
|-
|SAGwinddiraxis=L
|
|-
|SAGdewpointaxis=L
|
|-
|SAGsolarradaxis=L
|
|-
|SAGmaxsolarradaxis=L
|
|-
|SAGapptempaxis=L
|
|-
|SAGuvindexaxis=L
|
|-
|SAG3D=0
|
|-
|SAGgradientback=0
|
|-
|SAGleftgrid=1
|
|-
|SAGrightgrid=1
|
|}
==== Section: xAP ====
It is in Cumulus.ini for MX, but it is unclear how it can be edited within the Admin interface.
{{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"
==== Section: WeatherCloud ====
Not available in Cumulus 1
[[File:Badge vMx.png]] Only available from version 3.0.0
{| class="wikitable" border="1"
|style="background:lightgray;"|[WeatherCloud]
|style="background:lightgray;"|Section name - the following parameters relate to the Weathercloud configuration.
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|Wid=
==== Section: WLL ====
Not available in Cumulus 1
[[File:Badge vMx.png]] Only available from version 3.0.0
{| class="wikitable" border="1"
|style="background:lightgray;"|[WLL]
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|PrimaryRainTxId=1
==== Section: Windy ====
Only available from version 3.0.0 build 3049 onwards. Edit all parameters in the '''Internet settings''' screen, ''Windy.com'' section.
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"
|style="background:lightgray;"|[Windy]
|style="background:lightgray;"|Section Name
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|Enabled=0
=== Section: NOAA ===
'''Please note:''' because this section of Cumulus.ini uses date formatting parameters, you are advised to read [[Reports_folder#NOAA_style_Report_Naming]].
{{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"
|-
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"
| 