Cumulus.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (Minor clarifications in response to forum post)
 
(122 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<big>Please note this page was created 13 June 2021.
<big>Release 3.12.0 moves various options to new places and creates several new Cumulus.ini options.

Consequently, this page will need a substantial rewrite.</big>
At last update, it shows position as at beta build 3135, (missing some changes for the 3.12.0 release build of 3141).

This new page was created to reflect parameters added to Cumulus.ini in releases 3.8.0, 3.9.2, 3.10.0, and 3.12.0 (early beta builds - June 2021). It excludes all parameters removed after release 3.7.0.</big>

{{Template:WorkInProgressBanner}}
Since this page describes a file whose content frequently changes, this page may be out of date, unless somebody bothers to update it for every change.

=Purpose of Cumulus.ini file=

This is a text file containing initialization parameters. {{Template:Version badge Mx}}This page covers those used by the Cumulus MX software applica3.2.0 to 3.5.4tion.

For MX there can only to be one '''Cumulus.ini''' file, and it must be stored in the same folder as the executable "CumulusMX.exe".

The configuration settings in '''Cumulus.ini''' have the following main purposes (this list may be incomplete):
* Identify which weather station type MX is to read, and settings related to that model
* Identify which [[Calculate_Missing_Values#Some_definitions|derivatives]] are source ones (read directly from weather station and converted to your preferred units) and which derivatives MX is to calculate for you.
* Identify where you want MX to output to (options include external web sites, and database tables)
* Control what is output to those destinations, to the extent that each can be configured



= Why does this Wiki now contain multiple pages describing "Cumulus.ini"?=


[[Category:Configuration Files]]
[[Category:Configuration Files]]
MX has been developed very dramatically by Mark Crossley:
{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}
# There were minor differences between the legacy '''cumulus.ini''' (for versions 1.x.y, ending with 1.9.4) [[Cumulus.ini (Cumulus 1)|with documentation now here]] and the original 3.0.0 beta (previously documented on [[Cumulus.ini (Beta)]] page, but that page has been cleared)
# The dramatic development of MX produced considerable differences between that original MX beta, and the configuration that applied up to 3.7.0, [[Cumulus.ini (MX 3.0.0 to 3.7.0)|as now documented here]]
# Even more dramatic changes to the MX configuration have been happening since 3.8.0, with the biggest changes at 3.9.2, 3.10.0, and 3.12.0; therefore, <big>the decision was taken to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new empty page!</big>


= Important note about this page =


All the pages, previously called "Cumulus.ini", can be found from the owning [[:Category:Configuration Files|category]]. The original page was preserved at [[Cumulus.ini_(preserving_history)]] so look there for its editing history. That page also expands on the above summary of why that old page was replaced.
Please note this page was created 13 June 2021. This new page is being created to cover Cumulus.ini file for changes in releases 3.10.0, 3.12.0, and so on. It has been written, starting with a blank page, to reflect the contents of the "Cumulus.ini" file as now applies. The rewrite was needed as there has been so many changes in the contents of the file as MX has been developed so dramatically by Mark Crossley away from the beta begun by Steve Loft


You will also note that this page does not cover all settings in detail, and find some links to further pages within some sections below
If you are interested in the editing history, associated with the page that previously was called "Cumulus.ini", and some information describing how it was previously used, the old page was moved (before this page was created) so that it is now preserved at [[Cumulus.ini_(preserving_history)]]. That page also expands on the reasons why that old page was replaced by this new page, and both it, and the owning [[:Category:Configuration Files|category]], have links to other pages that document "Cumulus.ini" for MX releases before 3.10.0, and for the final 1.9.4 legacy Cumulus software.


==Need to install MX 3.12.0 ==


If you are using Cumulus 1 or a release of MX earlier than 3.12.0, be aware that the content of "Cumulus.ini" is totally different to the file for later MX releases. (It might have been better had the file been given a new name in release 3.12.0).
=Purpose of Cumulus.ini file=


The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from [https://github.com/cumulusmx/CumulusMX/releases/download/b3141/CumulusMXDist3141.zip here] and runs that release for a while before upgrading to the latest release [https://github.com/cumulusmx/CumulusMX here].
This page is about the [[:Category:Configuration Files|main configuration file]], '''Cumulus.ini''', this is a text file containing initialization parameters used by the Cumulus MX software application. This Wiki page describes the content that applies at release 3.10.0, and should be updated (providing at least one contributor is willing to keep this page up to date) for later releases.


== Simplifications ==
The configuration settings in '''Cumulus.ini''' have the following main purposes (this list may be incomplete):
*Identify which weather station type MX is to read, and settings related to that model
*Identify which [[Calculate_Missing_Values#Some_definitions|derivatives]] are source ones (read directly from weather station and converted to your preferred units) and which derivatives MX is to calculate for you.
*Identify where you want MX to output to (options include external web sites, and database tables)


The MX configuration is very different to that used by the legacy software. MX has far more optional functionality than the legacy software, therefore MX requires far more parameters to tailor all these functionality options.
== Legacy Cumulus complications==


The file is read into Internal Variables as Cumulus starts, and those variables are written back into the file when any settings are changed.
For the legacy Cumulus, there could be one, two, or even three, Cumulus.ini files, as explained [[Cumulus.ini_(Cumulus_1)#Configuration_File_names|here]]. Back then, the vast majority of parameters that could appear in the file could only be edited directly in the file, and the author (Steve Loft) recommended that, within the File section you were going to change, you sorted the parameters into alphabetical order, before editing the file. That advice was given because having parameters in alphabetical order would prevent you inserting a parameter that already existed. This would avoid the potential problem arising from the design that Cumulus 1 would ignore any duplicate parameter, and take the first one it found, as that might not be the last one you edited!

In the MX releases covered by this Wiki page, almost all settings are edited from a number of web pages for settings included in the local web interface.

To make it easier for the Cumulus MX user, the developer had to devise a way to make it easier to quickly assign the settings that might be best for those new to Cumulus to get the software working without needing to understand all the settings. This is achieved by introducing some "master" settings, these both determine which dependent settings are displayed, and what default values those dependent settings take. So a novice just has to get the "master" settings right and they then achieve a typical way of using that functionality! For those who are slightly more expert, full flexibility is available by adjusting the majority of dependent settings to what is required for more specialised requirements.

The ongoing development of MX is focused on making configuration even simpler, by revising the pages for the setting of all parameters, and improving the labels/grouping. By moving away from legacy software terminology and the parameters it needed; the developer has started introducing parameters and labelling that fits the MX design.

It may be worth remembering why the legacy software made life complicated:
# There could be more than one "cumulus.ini" file for the Legacy Cumulus up to 1.9.4, as explained [[Cumulus.ini_(Cumulus_1)#Configuration_File_names|here]].
# The vast majority of parameters (that could appear in the file) could only be edited directly in the file.
#* To simplify the editing in-situ, the author (Steve Loft) recommended that, within any "File section" you intended to change, you sorted the parameters into alphabetical order, before editing the file.
#* That advice was given because having parameters in alphabetical order would prevent you inserting a parameter that already existed.
#* This would avoid the potential problem arising from the design that Cumulus 1 would ignore any duplicate parameter; (Cumulus would take the first one it found, and that might not be the last one you edited!)


=Structure of Cumulus.ini=
=Structure of Cumulus.ini=


The file is divided into "File sections" (see terminology definitions below), each File section name is on a separate line (with no other content) and enclosed in square brackets (e.g. [Station]). These File sections can appear in any order, by default new File sections are appended after all previous File sections, but if you prefer the File sections in another order, MX can still find them, although it may spend more time searching!
The file is divided into "File sections" (see terminology definitions below), each File section name is on a separate line (with no other content) and enclosed in square brackets (e.g. '''[Station]''').

These File sections can appear in any order, by default new File sections are appended after all previous File sections, but if you prefer the File sections in another order, MX can still find them, although it may spend more time searching!


Within each File section, there are parameters. Each parameter is in format '''Attribute=Value''', and appears on a line to itself.
Within each File section, there are parameters. Each parameter is in format '''Attribute=Value''', and appears on a line to itself.


The parameters, within a File section, can be in any order, by default new parameters are appended at end of the relevant File section.
The parameters, within a File section, can be in any order, by default new parameters are appended at end of the relevant File section.


=How this Wiki page classifies settings=


This new Wiki page is no longer designed around the way parameters appear in the file, as earlier pages with this name were. Here are some of the reasons:
== How MX creates a Configuration File ==
# Settings can appear in any order in the file, but it is easier to find them on this page if they are listed alphabetically
# Releases might add new parameters, or remove old parameters, so looking at a file does not identify which parameters need to be explained on this page
# Releases might add new sections in the file, or remove old sections in the file, so organising this page by those "File sections" no longer makes sense
# The settings interface in MX is being comprehensively redesigned. That means this documentation cannot be organised by the way MX organises its settings pages.
#* To clarify that reason, if this Wiki page was organised according to the Settings Screens that applied say at release 3.8.0, a different sequence might be required in say 3.12.0 because that changed the Settings Screens.


Some classification is still needed to help you the reader find settings, only you can judge whether the grouping here suits you! In creating this page, I have tried to think of a way to group various settings and arranged those groups alphabetically, to make navigation as easy as I can.
This Wiki page does not explain how to start using MX, please see [[MX on Linux]], [[MX on Windows OS]], and [[MX Administrative Interface]] as appropriate.


Of course if you have your own ideas of a better way to group the documentation here, you are welcome to implement your preference, by editing this page.
The key fact relevant here is that no Cumulus release distribution contains a '''Cumulus.ini''' file:
#If you start Cumulus MX interactively 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 any weather station, and will not do anything more.


==Tabular presentation==
So when you first use the software, you will need to use the [[MX_Administrative_Interface#Changing_Settings|admin interface]] to enter all settings (some have defaults that might be right for you), and that will lead to creation of the main configuration file.


Within the groupings I have selected, individual settings are normally presented as rows in tables for clarity on this Wiki page. The individual tables can have up to 7 columns. The columns can explain for each setting:
If you later upgrade to a newer MX build, as that release distribution does not contain a "Cumulus.ini", you cannot lose your settings entered in your existing file. However, be aware that a new release may remove some settings, and add new settings, hopefully the release announcement will give specific details. Otherwise, you will need to work through all the Settings Pages, and all the "MX Sections" (see Terminolgy below)
* Where in the admin interface you edit it (MX page and MX section in terminology below)
* Whether the Setting is always shown on the Settings Page ("Always" is shown), or is only shown if an earlier Setting has a particular selection (dependency is shown)
* What File Section (in terminology below) it appears in with the file (always appears, and is shown, between square brackets)
* The attribute name used for the parameter in the file (always shown with an equals sign after it)
* Which release introduced the setting(s)
* What is the default value for the parameter, (and what that default value means)
* A description of what the parameter represents, and what values it can take


If the content of any column would be same for every row, then that column is omitted, and the relevant information is instead stated before the table.
Furthermore, at the end of each (meteorological) day, MX creates a back-up in the [[Backup folder|backup/daily/TIME_NAME sub- folder]]. The TIME_NAME is constructed from a string of digits representing the date and time the directory was created (without any punctuation) e.g. 20060519090000. In that folder, recent MX releases, include a copy of the current "Cumulus.ini" file.

Exceptions to above table styling:
# MQTT parameters are handled slightly differently, as they did not fit that standard layout
# The mean temperatures, and normal rainfall figures, with one parameter per month, have been presented as text, rather than a table for simplicity
# For the Extra Web Files Settings page, where the settings page uses [[MX_Basic_info#editable_grid|editable grid software]], instead of listing all 800 settings individually, the table here is split into just 8 rows, each of which applies to 100 parameters in the file.


==Terminology used on this Wiki Page==

{| class="wikitable" border="1"
|-
!style="width:30px" | Terminology
!style="width:800px" | What it means
|-
| Qualifications:
* '''Settings page'''
* '''Wiki page'''
| Because "page" could refer to either this page or the Settings page, page will always be qualified
|-
| Shown on Settings page?
| Sometimes whether you see a particular setting on the Settings Page, depends on a previous selection has been made, that is explained under this heading
|-
| MX Section
| Under this heading you will find how to navigate to the relevant setting within the admin interface. This covers the page where you edit the setting, followed by &rarr;, and then the section (and sub-section where relevant) that you have to select to see the setting

Each MX section on the Settings page has to be opened individually (by either a button for maximum accessibility, or a '''Click &#9654;to expand, click &#9660; to collapse''' for alternative styling).
|-
| Label on Settings page
| Under this heading you will discover how MX labels the individual setting where you edit that setting
|-
| File Section
| Within the file, a number of section headings are used, to gather multiple parameters together. Thus under this heading, for each setting, the table shows the '''File Section''' where the parameter will be stored
|-
| Parameter Line Entry
| Within the file each setting is represented by a parameter in format '''attribute=value''' on a line to itself without any punctuation symbols. If the parameter has a default value, that is shown here and explained in next column
|-
| Default
| This is the value (if any) that the individual setting takes when it has not been amended. Some parameters do not have a default value and "(none)" will be shown in this case. No brackets surround literal text representing default value, which is normally also seen in '''Parameter Line Entry'''. In general, round brackets are used in '''Default''' column to indicate an explanation.
|-
| Description
| Under this heading you will find an explanation of the setting including (where relevant) what values it can take
|}


==When, and How, does MX read the Configuration File?==
==When, and How, does MX read the Configuration File?==
Line 52: Line 142:
Whenever MX is restarted, it reads the latest ''Cumulus.ini'' and if it exists [[Strings.ini|strings.ini]] (briefly mentioned below); from these one (or two) file(s), it learns the configuration that you want it to use.
Whenever MX is restarted, it reads the latest ''Cumulus.ini'' and if it exists [[Strings.ini|strings.ini]] (briefly mentioned below); from these one (or two) file(s), it learns the configuration that you want it to use.


Essentially, MX reads the whole file, for each attribute part of a parameter in the file, there is a variable stored within the MX code. So the value part of each parameter is assigned to the respective variable. Hence MX will not permit any duplicates for any parameter. If MX finds a parameter it does not understand, it ignores that parameter.
For completeness I mention here, configuration information for MX can also be stored in an optional file [[strings.ini]], that is used to identify how various standard output phrases are to be modified to suit you, but this Wiki page ignores that file.

MX works differently to how the legacy software that was described above worked. Essentially, MX reads the whole file, for each attribute part of a parameter in the file, there is a variable stored within the MX code. So the value part of each parameter is assigned to the respective variable. Hence MX will not permit any duplicates for any parameter. If MX finds a parameter it does not understand, it ignores that parameter.


This means a Cumulus.ini file created by the legacy software, or by an old release of MX, can still be read by the current release of MX, as it just ignores all the obsolete parameters. However, since MX now has a lot of new parameters in the file, that were not in the legacy file, nor in a file created by an early MX release, it is often easier to start again with a new configuration file, as explained later, to ensure the configuration of MX is correct for you.
This means a Cumulus.ini file created by the legacy software, or by an old release of MX, can still be read by the current release of MX, as it just ignores all the obsolete parameters. However, since MX now has a lot of new parameters in the file, that were not in the legacy file, nor in a file created by an early MX release, it is often easier to start again with a new configuration file, as explained later, to ensure the configuration of MX is correct for you.
Line 62: Line 150:
What MX finds in your "Cumulus.ini" does of course determine what you see when you open any of the Settings pages, in the admin interface. This is because the displaying of some settings is dependent on another setting.
What MX finds in your "Cumulus.ini" does of course determine what you see when you open any of the Settings pages, in the admin interface. This is because the displaying of some settings is dependent on another setting.


For completeness I mention here, configuration information for MX can also be stored in an optional file [[strings.ini]], that is used to identify how various standard output phrases are to be modified to suit you.


=Settings Configuration for MX=
=Settings Configuration for MX=

The MX software offers much functionality and flexibility. Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting.

<big>Please see [[First Run of MX]] for how to set up settings when you first use MX.</big>

==What happens if I upgrade MX?==

If you upgrade to a newer MX build, as that release distribution does not contain a "Cumulus.ini", you cannot lose your settings entered in your existing file. However, be aware that a new release may remove some settings, and add new settings, hopefully the release announcement will give specific details. Otherwise, you will need to work through all the Settings Pages, and all the "MX Sections" (see Terminolgy above)

==Where do I change settings?==


The current design of MX expects that Cumulus Users will never need to edit the "Cumulus.ini" file directly, as there are a number of settings pages in the [[MX_Administrative_Interface#Changing_Settings|admin interface]] and users are expected to use those Settings pages to amend the individual MX settings.
The current design of MX expects that Cumulus Users will never need to edit the "Cumulus.ini" file directly, as there are a number of settings pages in the [[MX_Administrative_Interface#Changing_Settings|admin interface]] and users are expected to use those Settings pages to amend the individual MX settings.


Please see [[MX_Administrative_Interface#Changing_Settings]] for basic information, including how to load the admin interface (sometimes called the "dashboard interface" or "user interface").
Please see [[MX_Administrative_Interface#Changing_Settings]] for basic information, including how to load the admin interface (sometimes called the "dashboard interface" or "user interface").


Furthermore, at the end of each (meteorological) day, MX creates a back-up in the [[Backup folder|backup/daily/TIME_NAME sub- folder]]. The TIME_NAME is constructed from a string of digits representing the date and time the directory was created (without any punctuation) e.g. 20060519090000. In that folder, recent MX releases, include a copy of the current "Cumulus.ini" file.


==Do I need to restart MX?==
==Do I need to restart MX?==
Line 73: Line 175:
If you change a setting directly in the file, you must stop MX beforehand. The setting takes effect when you restart MX.
If you change a setting directly in the file, you must stop MX beforehand. The setting takes effect when you restart MX.


If you change a setting, using the admin interface, it may, or may not, take effect immediently...
If you change a setting, using the admin interface, it may, or may not, take effect immediately...


The settings available on the various pages in the admin interface fall into two groups:
The settings available on the various pages in the admin interface fall into two groups:
Line 79: Line 181:
#SETTINGS THAT ONLY TAKE EFFECT WHEN MX IS RESTARTED
#SETTINGS THAT ONLY TAKE EFFECT WHEN MX IS RESTARTED


''There used to be a third group''. Before '''Release 3.11.2 - build 3131''' a few changes made in the interface were not saved into "Cumulus.ini", and those few settings were therefore lost when MX was restarted. One example of these former exceptions was that the former action selecting [[MXdiags folder|adding extra debugging information to file in MXDiags folder]] was previously not saved for subsequent session.
Unfortunately, there is no documentation available from developer on which settings, at any release, do not take effect until MX is restarted.


For the current MX release, any change made (on any settings page) will be saved into "Cumulus.ini", and will still apply when MX is restarted. That restart will ensure all settings changed in the last session do take effect, even those that did not take effect before the restart.
A further complication is that in some releases, certain settings that used to require a restart have been changed so they take effect intermediately.


Unfortunately, there is no documentation available from developer on which settings, at any release, do not take effect until MX is restarted. We do know that you need to do a restart after choosing the station model, and that is unlikely to change.
This means that any attempt to document which changes do require a restart is working against a moving target, so this documentation cannot indicate where a restart is required. You can play safe, and restart MX each time you finish making edits to settings.

In early MX releases most configuration settings required a restart of MX before they took effect, but since then in some releases, certain settings that used to require a restart have been changed so they take effect intermediately. It is anticipated, as MX develops, the majority of settings will become ones that take effect without a restart of MX.

This means that any attempt to document here which changes do require a restart of MX is working against a moving target. Consequently, this documentation does not indicate where a restart is required. You can either play safe, and restart MX each time you finish making edits to settings, or you can read all the support forum announcements, and see if you can find any information about whether a restart is needed, for whatever particular settings you are changing, at the release you are using.


There used to be a third group. Before '''Release 3.11.2 - build 3131''' a few changes made in the interface were not saved into "Cumulus.ini", and therefore lost when MX was restarted. One example of these former exceptions was on Program Settings page where the former action was that choice for [[MXdiags folder|adding extra debugging information to file in MXDiags folder]] was not saved for subsequent session.


For the current MX release, any change made (on any settings page) will be saved into "Cumulus.ini", and will still apply when MX is restarted. That restart will ensure all settings changed in the last session do take effect, even those that did not take effect before the restart.


==How to Remove Redundant parameters from file==
==How to Remove Redundant parameters from file==
Line 126: Line 230:
=== An example of why you might edit file instead of using Settings Page===
=== An example of why you might edit file instead of using Settings Page===


If (for example) you find the '''Extra Web Files''' editor hard to use, you might decide to stop Cumulus MX and still edit this configuration file directly for changes to those parameters. Given that MX ignores any parameter it does not understand, while editing the file, you can temporary have old and new parameters in the file. All you need to do is prefix those parameters you don't want MX to use with any character you like before the "Extra" in the atribute name.
If (for example) you find the '''Extra Web Files''' editor hard to use, you might decide to stop Cumulus MX and still edit this configuration file directly for changes to those parameters. Given that MX ignores any parameter it does not understand, while editing the file, you can temporary have old and new parameters in the file. All you need to do is prefix those parameters you don't want MX to use with any character you like before the "Extra" in the attribute name.


==When MX adds new parameters to file==
==When MX adds new parameters to file==


In theory, there is no reason why you should manually add any extra parameters directly into the file.
If a new release of MX adds new parameters, then:
* If the new parameter has a valid default value, MX will work perfectly using that default value. You won't need to know the parameter exists, unless you decide to chnage it, and find out what values it can take either in a drop-down on the relevant Settings page, or in the relevant table below.
* Other new parameters may be given an initial illegal value, because MX cannot guess what value will work for you. This is to enforce the need to give these parameter a valid value before MX will allow you to save settings. Sometimes, MX will not do any weather data processing, until these ‘’’missing’’’ values are edited. In other cases, you might not realise that your file is missing one or more parameters, unless you go into the relevant Settings page, and find you can't save (Enable for Alarms page).


In theory, there is no reason why you should manually add any parameters to the file. Since MX creates, and edits, the file, it will ensure all parameters it understands are in the file.
Since MX creates, and edits, the file, it should ensure all parameters it understands are in the file.

When this new page was being created, some of the parameters in the file that MX understands, could not be matched to any known setting in the [[MX Administrative Interface|Settings Interface pages]], but it may be a future release will correct that.

If a new release of MX adds new parameters, then:
* If the new parameter has a valid default value, MX will work perfectly using that default value.
** You won't need to know the parameter exists, unless you decide to change it, and find out what values it can take either in a drop-down on the relevant Settings page, or in the relevant table below.
* Other new parameters may be given an initial illegal value, because MX cannot guess what value will work for you.
** This is to enforce the need to give these parameter a valid value before MX will allow you to save settings.
*** Sometimes, MX will not do any weather data processing, until these ‘’’missing’’’ values are edited.
*** In other cases, you might not realise that your file is missing one or more parameters, unless you go into the relevant Settings page, and find you can't '''save''' (''Enable'' for Alarms page).


In practice, as already mentioned, there might be a parameter that you need to get MX working correctly for you, but have to add directly to the file as (at the release you are using) that setting has not yet been added to any Settings page.
In practice, as already mentioned, there might be a parameter that you need to get MX working correctly for you, but have to add directly to the file as (at the release you are using) that setting has not yet been added to any Settings page.

Before this page actually lists all the settings I know of, let me give an example of a seting with a valid default, and an example of a setting that has an invalid default:


===Example of new Parameter with valid default===
===Example of new Parameter with valid default===


When accessibility was added, its parameter defaulted to the old expand/contract sections design (see first table below). You had to go into "Program Settings" or "Staion Settings" pages to tick the box to get the (more accessiblility friendly) selection button altrernative.
When accessibility was added, its parameter defaulted to the old expand/contract sections design (see first table below).

You can, optionally, go into "Program Settings" or "Station Settings" pages, where you tick the box to get the (more accessibility friendly) selection button alternative.


===Example of new Parameters with no valid initial value===
===Example of new Parameters with no valid initial value===


As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file. You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page.
As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file. You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page.

=How this Wiki page classifies settings=

There is no point in this Wiki page listing settings by where they are found in the configuration file, as they can be listed in any order, and when settings are removed or added, the order changes. If your file was originally created by the legacy Cumulus, it may contain "File sections" that are no longer used. For all these reasons, this Wiki page is not designed around the way parameters appear in the file.

The settings interface in MX is being comprehensively redesigned. That means this documentation cannot be organised by the way MX organises its settings pages. The reason is if this Wiki page was organised according to the Settings Screens that applied say at release 3.10.0, that sequence wold be of no use after the settings pages have changed in say 3.12.0.

Some classification is still needed to help you the reader find settings, only you can judge whether the grouping here suits you! In creating this page, I have tried to think of a way to group various settings and arranged those groups alphabetically, to make navigation as easy as I can.

Of course if you have your own ideas of a better way to group the documentation here, you are welcome to implement that by editing this page.

Within the groupings I have selected, individual settings are normally presented as rows in tables for clarity on this Wiki page. The individual tables can have up to 7 columns so they can explain for each setting:
* Where in the admin interface you edit it (MX page and MX section in terminology below)
* Whether the Setting is always shown on the Settings Page ("Always" is shown), or is only shown if an earlier Setting has a particular selection (dependency is shown)
* What File Section (in terminology below) it appears in with the file (always appears, and is shown, between square brackets)
* The attribute name used for the parameter in the file (always shown with an equals sign after it)
* Which release introduced the setting(s)
* What is the default value for the parameter, (and what that default value means)
* A description of what the parameter represents, and what values it can take

If the content of any column would be same for every row, then that column is omitted, and the relevant information is instead stated before the table.

Exceptions to above table styling:
# MQTT parameters are handled slightly differently, as they did not fit that standard layout
# The mean temperatures, and normal rainfall figures, with one parameter per month, have been presented as text, rather than a table for simplicity
# For the Extra Web Files Settings page, where the settings page uses [[MX_Basic_info#editable_grid|editable grid software]] using a table to enter 800 settings, the table here is split into just 8 rows, each of which applies to 100 parameters in the file.


==Terminology used on this Wiki Page==

{| class="wikitable" border="1"
|-
!style="width:30px" | Terminology
!style="width:100px" | What it means
|-
| Wiki page
| Because "page" could refer to either this page or the Settings page, page will always be qualified
|-
| Shown on Settings page?
| Sometimes whether you see a particular setting on the Settings Page, depends on a previous selection has been made, that is explained under this heading
|-
| MX Section
| Under this heading you will find how to navigate to the relevant setting within the admin interface. This covers the page where you edit the setting, followed by &rarr;, and then the section (and sub-section where relevant) that you have to select to see the setting

Each MX section on the Settings page has to be opened individually (by either a button for maximum accessibility, or a '''Click &#9654;to expand, click &#9660; to collapse''' for alternative styling).
|-
| Label on Settings page
| Under this heading you will discover how MX labels the individual setting where you edit that setting
|-
| File Section
| Within the file, a number of section headings are used, to gather multiple parameters together. Thus under this heading, for each setting, the table shows the '''File Section''' where the parameter will be stored
|-
| Parameter Line Entry
| Within the file each setting is represented by a parameter in format '''attribute=value''' on a line to itself without any punctuation symbols. If the parameter has a default value, that is shown here and explained in next column
|-
| Default
| This is the value (if any) that the individual setting takes when it has not been amended. Some parameters do not have a default value and "(none)" will be shown in this case. No brackets surround literal text representing default value, which is normally also seen in '''Parameter Line Entry'''. In general, round brackets are used in '''Default''' column to indicate an explanation.
|-
| Description
| Under this heading you will find an explanation of the setting including (where relevant) what values it can take
|}




=Tables listing Settings=
=Tables listing Settings=
Line 225: Line 278:
|-
|-
|EnableAccessibility=0
|EnableAccessibility=0
| Two places where you can edit this setting:
| * (Either) Program Settings &raa; (First tick box)
* (Either) Program Settings &rarr; (First tick box)
* (Or) Station Settings &rarr; (First tick box)
* (Or) Station Settings &rarr; (First tick box)
|Enable accessibility features
|Enable accessibility features
Line 234: Line 288:
|}
|}


== Alarms ==
== Alarms (and emails) ==


The Alarm settings seem to frequently be changed by new MX releases, so have been moved to a separate [[Alarms|wiki page]] where hopefully it will be easier for somebody to keep the content updated in future.

==Charts==
{{Template:WorkInProgressBanner}} Charts have evolved rapidly in MX development, this table needs verification by somebody who uses the functionality documented here. Can you be the contributor to bring it up to date?


{{Template:WorkInProgressBanner}} This table has not been populated yet
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 246: Line 303:
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:600px" | Description
|-
| GraphHours=24
| [Graphs]
| Legacy Cumulus
| Station Settings &rarr; Graphs
| Graph hours
| 24 (2 rolling days worth of values)
| For those plots that show values (if available) minute by minute, how many days back to go. Some people prefer to set this to 48 or 96, that means uploading a lot more data in the [[:Category:JSON_Files|.json files]], but it shows more on charts
|-
| AppTempVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Apparent temperature
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Australian Apparent Temperature plotted on Charts
|-
| BaseTemperature1=
| [GrowingDD] and [TempSum]
| Release 3.11.0 - b3129
| Station Settings &rarr; Growing Degree Days
| Base temperature #1
| Depends on selected temperature units (not quite same)
* (Celsius) 5 (equivalent to 41 <sup>o</sup>Fahrenheit)
* (Fahrenheit) 40 (equivalent to 4.44 <sup>o</sup>Celsius)
| Base temperature for series 1
|-
| BaseTemperature2=
| [GrowingDD] and [TempSum]
| Release 3.11.0 - b3129
| Station Settings &rarr; Growing Degree Days
| Base temperature #1
| Depends on selected temperature units (equivalent)
* (Celsius) 10
* (Fahrenheit) 50
| Base temperature for series 2
|-
| Cap30C=1
| [GrowingDD]
| Release3.11.0 - b3129
| Station Settings &rarr; Growing Degree Days
| Cap GDD at 30°C / 86°F
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want growing degree days capped and not incremented at high temperatures (threshold shown in setting name)
|-
| ChartMaxDays=31
| [Graphs]
| Legacy Cumulus
| Station Settings &rarr; Graphs
| Graph Days
| 31 (daily values)
| For those plots that show recent daily values, this states how many of them to plot
|-
| Colour0=#058DC7, Colour1=#50B432, Colour2=#ED561B, Colour3=#DDDF00, Colour4=#24CBE5, and Colour5=#64E572
| [Select-a-Chart]
| Release 3.9.7 - b3107
| ???
| ???
| Hex colours as shown in parameter list
| Colour of line used for plotting the respective series
|-
| DailyAvgTempVisible=1
| [Graphs]
| Release 3.11.0 - b3129
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Daily Average Temperature
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Daily (integrated) Average temperature plotted on Charts
|-
| DailyMaxTempVisible=1
| [Graphs]
| Release 3.11.0 - b3129
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Daily Maximum Temperature
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Daily Maximum temperature plotted on Charts
|-
|-
| DailyMinTempVisible=1
|
| [Graphs]
|
| Release 3.11.0 - b3129
|
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
|
| Daily Minimum Temperature
|
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Daily Minimum temperature plotted on Charts
|-
| DPVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Dew Point plotted on Charts
|-
| FeelsLikeVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Feels Like Temperature plotted on Charts
|-
| GrowingDegreeDaysVisible1=1
| [Graphs]
| Release3.11.0 - b3129
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Degree Days
| Growing Degree Days series #1
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see series 1 plotted on Charts
|-
| GrowingDegreeDaysVisible2=1
| [Graphs]
| Release3.11.0 - b3129
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Degree Days
| Growing Degree Days series #2
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see series 2 plotted on Charts
|-
| HIVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see USA Heat Index plotted on Charts
|-
| HumidexVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Canadian Humidity Index plotted on Charts
|-
| InHumVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Humidity Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Indoor Relative Humidity plotted on Charts
|-
| InTempVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Indoor Temperature plotted on Charts
|-
| OutHumVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Humidity Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Outdoor Relative Humidity plotted on Charts
|-
| Series0= to Series5=
| [Select-a-Chart]
| Release 3.9.7 - b3107
| ???
| ???
| 0 (disabled)
| Name of parameter to plot (in series 0 to 5) e.g. "Pressure", "Wind Gust", "Temperature", "Rainfall Rate", "Wind Bearing"
|-
| SolarVisible=1
| [Graphs]
| MX release 3.10.0
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Solar Data
| UV Index
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Solar radiation plotted on Charts
|-
| SunshineVisible=1
| [Graphs]
| MX release 3.10.0
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Solar Data
| UV Index
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Sunshine Hours plotted on Charts
|-
| TempSumVisible0=1
| [TempSum]
| Release 3.11.0 - b3129
| Station Settings &rarr; Annual Temperature Sum
| Annual Temperature Sum 0
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Annual Temperature Sum series 0 plotted on Charts
|-
| TempSumVisible1=1
| [TempSum]
| Release 3.11.0 - b3129
| Station Settings &rarr; Annual Temperature Sum
| Annual Temperature Sum #1
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 1 plotted on Charts
|-
| TempSumVisible2=1
| [TempSum]
| Release 3.11.0 - b3129
| Station Settings &rarr; Annual Temperature Sum
| Annual Temperature Sum #2
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 2 plotted on Charts
|-
| TempSumYearStart=
| [TempSum]
| Release 3.11.0 - b3129
| Station Settings &rarr; Annual Temperature Sum
| Year summation starting month
| Depends on hemisphere
* (Northern hemisphere) 1 = January
* (Southern hemisphere) 7 = July
| Enter as a number the month for which (on first of that month) annual temperature summation is reset to zero
|-
| TempVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Outdoor Temperature plotted on Charts
|-
| UVVisible=1
| [Graphs]
| MX release 3.10.0
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Solar Data
| UV Index
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Ultra Violet Index plotted on Charts
|-
| WCVisible=1
| [Graphs]
| MX release 3.7.0 - b3089
| Station Settings &rarr; Graphs &rarr; Visibility &rarr; Temperature Data
| Dew point
| Ticked (shown in Cumulus.ini as 1)
| Simple tick or not indicating whether you want to see Wind Chill plotted on charts
|-
| YearStarts=
| [GrowingDD]
| Release 3.11.0 - b3129
| Station Settings &rarr; Growing Degree Days
| Growing season starting month
| Depends on hemisphere
* (Northern hemisphere) 1 = January
* (Southern hemisphere) 7 = July
| Enter as a number the month for which (on first of that month) Growing degree days is reset to zero
|}
|}


Line 267: Line 566:
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
!style="width:600px" | Description
|-
| StartDate=
| (with warning: "Here be dragons!")
| Station Settings &rarr; Advanced Options
| Records Began date
| (Set when you first use Cumulus)
| Format used is determined by locale used for running MX. If this date is edited, keep to same format. MX generally (see [[Calculate_Missing_Values#CreateMissing.exe]] for exceptions) ignores any data file entries prior to this date.
|-
| NoSensorCheck=0
| (not yet on a settings page)
| (not known)
| (not known)
| 0 (normal)
| Boolean:
* 0 = MX will stop if any of the minimum set of sensors listed below fails
* 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails

Minimum set of sensors:
# Current air temperature
# Current Relative Humidity
# At least one wind speed
# Current air pressure (absolute or sea-level)
Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these).
|-
| UseDataLogger=1
| (probably determined by station type)
| (not known)
| (not known)
| 1 (enabled)
|Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if your weather station has its own storage, so MX can do a catch up when it first starts and read any "archive data"
* Don't tick (value shown as 0 in Cumulus.ini) if your weather station has no storage, and therefore MX cannot capture any readings when it is not running
|-
|-
| DataLogInterval=2
| DataLogInterval=2
Line 314: Line 581:
|-
|-
| LogExtraSensors=0
| LogExtraSensors=0
| (Depends on station type)
| (Depends on station type) Only from Release 3.12.0
| Station settings &rarr; Common Options
| Station settings &rarr; Common Options
| Extra sensors
| Extra sensors
Line 321: Line 588:
* Tick (value shown as 1 in Cumulus.ini) if your weather station can output readings to be logged in [[Extra Sensor Files]]
* Tick (value shown as 1 in Cumulus.ini) if your weather station can output readings to be logged in [[Extra Sensor Files]]
* Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files.
* Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files.
|-
| NoSensorCheck=0
| (not yet on a settings page)
| (not known)
| (not known)
| 0 (normal)
| Boolean:
* 0 = MX will stop if any of the minimum set of sensors listed below fails
* 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails

Minimum set of sensors:
# Current air temperature
# Current Relative Humidity
# At least one wind speed
# Current air pressure (absolute or sea-level)
Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these).
|-
| RainDayThreshold=-1
| (with warning: "Here be dragons!")
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; Advanced options
| Rain day threshold
| -1 (that represents 0.2 mm or 0.01 inches)
| The amount of rainfall that must be collected before MX treats today as a wet day

''The intention is this will represent more than one tip, as the first tip might contain some rain from an earlier day''
|-
|-
| RolloverHour=0
| RolloverHour=0
Line 330: Line 624:
* 0 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches midnight
* 0 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches midnight
* 1 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time
* 1 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time
|-
| SnowDepthHour=0
| (with warning: "Here be dragons!")
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; Advanced options
| Snow depth hour
| 0 (midnight)
| Spin selector of 0 to 23: Defines hour from which entries in [[Weather Diary]] for current calendar day are used. Prior to this hour the weather diary will be searched for Calendar yesterday
|-
| StartDate=
| (with warning: "Here be dragons!")
| Station Settings &rarr; Common Options &rarr; Advanced Options
| Records Began date
| (Set when you first use Cumulus)
| Format used is determined by locale used for running MX. If this date is edited, keep to same format. MX generally (see [[Calculate_Missing_Values#CreateMissing.exe]] for exceptions) ignores any data file entries prior to this date.
|-
| UseDataLogger=1
| (probably determined by station type)
| (not known)
| (not known)
| 1 (enabled)
|Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if your weather station has its own storage, so MX can do a catch up when it first starts and read any "archive data"
* Don't tick (value shown as 0 in Cumulus.ini) if your weather station has no storage, and therefore MX cannot capture any readings when it is not running
|-
|-
| Use10amInSummer=1
| Use10amInSummer=1
Line 337: Line 656:
| 1 (normal)
| 1 (normal)
| Tick box:
| Tick box:
| * 0 = If "Daylight Saving Time" (DST) applies in Summer, MX is to use 9 am local time
* 0 = If "Daylight Saving Time" (DST) applies in Summer,
** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
** If rollover time is 9 a.m., MX is to use 9 am local time, regardless of whether DST is in operation or not
* 1 = Normal behaviour:
* 1 = Normal behaviour:
** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
** If MX would do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time, then it waits until 10 a.m. local time while DST is in effect
** If MX would do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time, then it waits until 10 a.m. local time while DST is in effect
|}
|}




Line 351: Line 672:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:300px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
Line 357: Line 678:
|-
|-
| Logging=1
| Logging=1
| Depends on release installed:
| * (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
# Alternatives:
* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
#* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
* (Release 3.9.4 onwards) Program Settings &rarr; Program General Options
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
| Debug logging
| Debug logging
| 0 (disabled)
| 0 (disabled)
| This adds extra information about transfers between your weather station and MX. It was introduced originally for Davis stations only, but later (can someone add here the relevant release) extended to cover more stations.
| This adds extra information about data transfers between your weather station and MX.

It was introduced originally for Davis stations only, but later (can someone insert here the relevant release) extended to cover more stations.
|-
|-
| DataLogging=1
| DataLogging=1
| Depends on release installed:
| * (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: DataLogging = 1, then restart Cumulus MX.
# Alternatives:
* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
#* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: DataLogging = 1, then restart Cumulus MX.
* (Release 3.9.4 onwards) Program Settings &rarr; Program General Options
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
| Debug logging
| Debug logging
| 0 (disabled)
| 0 (disabled)
| This adds extra information about transfers from MX, and all the internal MX processes.
| This adds extra information about both data transfers initiated from MX, and all the internal MX processes.
|}
|}


== Location==

* Introduced for legacy Cumulus
* File Section is [Station]

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| LocName=
| Station Settings &rarr; Location
| Name
| (empty)
| A short name for the location
|-
| LocDesc=
| Station Settings &rarr; Location
| Description
| (empty)
| A longer description for the location
|-
| Altitude=0
| Station Settings &rarr; Location
| Altitude
| 0
| The height above mean sea level where the (pressure) sensor is positioned
|-
| AltitudeInFeet=1
| Station Settings &rarr; Location
| Radio Setting
* feet (value shown as 1 in Cumulus.ini)
* metres (value shown as 0 in Cumulus.ini)
|-
| "Latitude=0" and "LatTxt="
| Station Settings &rarr; Location &rarr; Latitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; North or South"
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|-
| "Longitude=0" and "LongTxt="
| Station Settings &rarr; Location &rarr; Longitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; East or West"
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|}




==Extra Web Files==
==Extra Web Files==
Line 430: Line 707:


The settings interface presents the rows on multiple pages, the rows are not numbered, so you have to do some counting to work out which row in the admin interface page corresponds with which parameter in Cumulus.ini file.
The settings interface presents the rows on multiple pages, the rows are not numbered, so you have to do some counting to work out which row in the admin interface page corresponds with which parameter in Cumulus.ini file.

'''You MUST restart MX after any changes in this section, before the new settings take effect.'''


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
!style="width:800px" | Description
|-
|-
|style="background:lightgray;"|[FTP site]
|style="background:lightgray;"|[FTP site]
Line 522: Line 801:
|}
|}


==NOAA Settings==
== Location==


* Introduced for legacy Cumulus
===Create NOAA files after daily rollover===
* File Section is [Station]


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:600px" | Description
|-
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
|-
| AutoSave=1
| Altitude=0
| Station Settings &rarr; Location
| Create NOAA files after daily rollover
| Altitude
|0
| 0
| *0= do not use Reports functionality
| The height above mean sea level where the (pressure) sensor is positioned
*1= do use Reports functionality
|-
|-
| AltitudeInFeet=1
| UseDotDecimal=0
| Station Settings &rarr; Location
|
| Altitude Units
| 0 (disable)
| Default depends on release:
| (Introduced 3.9.5 - b3100) Formatting real numbers for when NOAA report parsed by a script
# Legacy until 3.11.4: 1 (labelled as feet)
* 0= NOAA reports use the integer/decimal separator specified by locale
# From 3.12.0: 0 (labelled metres)
* 1= NOAA reports used decimal point even if locale says use decimal comma
| Radio Setting
|}
* feet (value shown as 1 in Cumulus.ini)

* metres (value shown as 0 in Cumulus.ini)
===Site Details===

{| class="wikitable" border="1"
|-
|-
| LocName=
!style="width:30px" | Parameter Line Entry
| Station Settings &rarr; Location
!style="width:60px" | Label on Settings page
| Name
!style="width:20px" | Default
| (empty)
!style="width:300px" | Description
| A short name for the location
|-
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
|-
| LocDesc=
|Name=Personal Weather Station
| Station Settings &rarr; Location
|Site Name
| Description
|(empty)
| (empty)
|What you would like to see in report title for your station name
| A longer description for the location
|-
|-
| "Latitude=0" and "LatTxt="
|City=
| Station Settings &rarr; Location &rarr; Latitude
|City
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; North or South"
|(empty)
| (blank)
|Enter here your hamlet, village, town, or city, name
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|-
|-
| "Longitude=0" and "LongTxt="
|State=
| Station Settings &rarr; Location &rarr; Longitude
|State
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; East or West"
|(empty)
| (blank)
|Enter here your local authority area or region (state in USA)
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|}
|}


===Output Files===


==Optional Report Settings==

* File Section is [NOAA]
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
|-
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
|-
| AutoCopy=0
|MonthFileFormat='NOAAMO'MMyy'.txt'
| Release 3.12.0
|Monthly filename format
| NOAA Reports Settings &rarr; FTP Options
|'NOAAMO'MMyy'.txt' (note quotes round 'NOAAMO' and round '.txt')
| Auto Copy NOAA report files
|Here you specify the filename template for MX to use when reading, or writing, monthly reports
| 0 (disable)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if your report is to be copied to copy directory during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
* Don't tick (value shown as 0 in Cumulus.ini) for no copy action
|-
| AutoFTP=0
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| Auto transfer NOAA report files
| 0 (disable)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) to enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed)
* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
|-
| AutoSave=1
| First with Cumulus 2
| NOAA Reports Settings
| Create NOAA files after daily rollover
|0
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality
* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required
|-
| City=
| First with Cumulus 2
| NOAA Reports Settings &rarr; Site Details
| City
| (empty)
| Enter here your hamlet, village, town, or city, name
|-
| CoolingThreshold=22
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Cooling threshold
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
| [[Heat/cold_degree_days_and_Chill_hours#Cold_Degree_Days|Cold Degree Days]] are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. An international standard says 22 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
|-
| CopyDirectory=
| Release 3.12.0
| NOAA Reports Settings &rarr; Report Options
| Copy Directory
| (empty)
| The folder on the web server you host to which reports are to be copied
|-
| FTPDirectory=
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| destination folder
| Depends on release:
* (3.1.0 to 3.11.4) blank
* (3.12.0 onwards) to match change in default web site script specification of '''Reports''' folder
| Specify the destination folder for file transfer to, on your FTP server
*Leave at default (for your release) and MX will work with the default web pages script supplied (at same release)
* Specify a folder relative to FTP root, and MX will upload reports to that folder instead (you are then responsible for writing any script on your web site to find each report and do any processing).
|-
| HeatingThreshold=15.5
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Heating threshold
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
|[[Heat/cold_degree_days_and_Chill_hours#Heat_Degree_Days| Heating Degree Days]] are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. An international standard says 15.5 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
|-
| MaxTempComp1=22
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Max temp comparison 1
| (empty)
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit
|-
| MaxTempComp2=0
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Max temp comparison 2
| (empty)
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit
|-
| MinTempComp1=15.5
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Min temp comparison 1
| (empty)
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit
|-
| MinTempComp2=0
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Min temp comparison 2
| (empty)
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit
|-
| MonthFileFormat='NOAAMO'MMyy'.txt'
| First with Cumulus 2
| NOAA Reports Settings &rarr; Output Files
| Monthly filename format
| 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''')
| Here you specify the filename template for MX to use when reading, or writing, monthly reports


There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid.
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid.
|-
|-
| Name=Personal Weather Station
|YearFileFormat='NOAAYR'yyyy'.txt’
| First with Cumulus 2
|Yearly filename format
| NOAA Reports Settings &rarr; Site Details
|'NOAAYR'yyyy'.txt'
| Site Name
|Here you specify the filename template for MX to use when reading, or writing, yearly reports
| (empty)
| What you would like to see in report title for your station name
|-
| NOAAUseUTF8=1
| First with Cumulus 2
| NOAA Reports Settings &rarr; Report Options
| Use UTF-8 encoding
| 1 (UTF-8)
| Please see [[Reports_folder#Encoding]]
* Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the <sup>o</sup> degree symbol
* If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the <sup>o</sup> degree symbol is coded differently
|-
| RainComp1=0.5
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Rain comparison 1
| (empty)
| The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold
|-
| RainComp2=
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Rain comparison 2
| (empty)
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
| RainComp3=
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| Rain comparison 3
| (empty)
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
| State=
| First with Cumulus 2
| NOAA Reports Settings &rarr; Site Details
| State
| (empty)
| Enter here your local authority area or region (state in USA)
|-
| UseDotDecimal=0
| Release 3.9.5 - b3100
| NOAA Reports Settings &rarr; Report Options
| Use a 'dot' decimal point
| 0 (disable)
| Formatting real numbers for when NOAA report parsed by a script

Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma
* Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale
|-
| UseMinMaxAvg=0
| Release 3.12.0
| NOAA Reports Settings &rarr; Report Options
| Use WHO average or Integrated average
| 0 (integrated average)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2
* Don't tick (value shown as 0 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use integrated calculation: Sum of all temperature measurements divided by count of measurements
|-
| YearFileFormat='NOAAYR'yyyy'.txt’
| First with Cumulus 2
| NOAA Reports Settings &rarr; Output Files
| Yearly filename format
| 'NOAAYR'yyyy'.txt'
| Here you specify the filename template for MX to use when reading, or writing, yearly reports


There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension.
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension.
|-
|12hourformat=0
| ???
| NOAA Reports Settings &rarr; Output Files
|Time format
|0 (24 hour)
| How times are output on reports
* 24 Hour (value shown as 0 in Cumulus.ini)
* 12 Hour (value shown as 1 in Cumulus.ini)
|}
|}




===Report Format Options===
===Normal Mean Temperatures===

* File Section is [NOAA]
* The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
* There is one box labelled for each month on the settings screens
* All the defaults are (blank)
* What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements

===Normal Precipitation===

* File Section is [NOAA]
Rainfall equivalents of mean temperature described above


==Optional Structured Query Language Settings==

MX uses a software package called "MySqlConnect" to run SQL queries.

Since the text that appeared here was added, documenting plans for the future 3.12.0 release, there have been a number of changes, and now a future release (3.20.0) is expected to make more drastic changes. Therefore the content has been moved to a [[MySqlConnect|new "MySqlConnect" page]] where it is hoped somebody will find it easier to update the content as MX develops.


==Optional Third-party Upload Settings==



{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:30px" | File Section
!style="width:60px" | MX Section
!style="width:80px" | Action on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
|-
| <pre>ID=
|12hourformat=0
pass=-1
|Time format
server=cwop.aprs.net
|0 (24 hour)
port=14580
| How times are output on reports
Enabled=0
* 24 Hour
Interval=9
* 12 Hour
SendSR=0
APRSHumidityCutoff=0</pre>
| [APRS]
| APRS/CWOP
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
|-
| <pre>User=
|NOAUseUTF8=1
Password=
|Use UTF-8 encoding
Language=en
|Please see [[Reports_folder#Encoding]]
Enabled=0
*Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the <sup>o</sup> degree symbol
Interval=900
*If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the <sup>o</sup> degree symbol is coded differently
SendUV=0
SendSR=0
SendSoilTemp=0
SendIndoor=0
SendSoilMoisture=0
SendLeafWetness=0
SendAirQuality=0</pre>
| [Awekas]
| AWEKAS
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
|-
| <pre>Enabled=0
|UseDotDecimal=0
CatchUp=1
|Use a 'dot' decimal point
APIkey=
|0 (locale)
StationId=
| Should dot or comma decimal be used?
Interval=15</pre>
*0= as defined in your locale
| [OpenWeatherMap]
*1= dot decimal place, regardless of what in locale
| OpenWeatherMap
(The reason for this is that some people instead of looking at reports, have a script that parses the report and outputs in a different way)
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [PWSweather]
| PWS Weather
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>User=
Password=
Enabled=0
Interval=60
OauthToken=unknown
OauthTokenSecret=unknown
TwitterSendLocation=1</pre>
| [Twitter]
| Twitter
| Please note that twitter is deprecated, no new settings possible, existing settings can be used by people who migrated from Cumulus 1 with working tokens
| Defaults are as shown in list of parameters
|-
| <pre>Wid=
Key=
Enabled=0
Interval=10
SendUV=0
SendSR=0
SendAQI=0
SendSoilMoisture=0
SoilMoistureSensor=0
SendLeafWetness=0
LeafWetnessSensor=0</pre>
| [WeatherCloud]
| WeatherCloud
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Enabled=0
StationUID=
Password=
Interval=1
SendRain=0</pre>
| [WindGuru]
| Windguru
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>APIkey=
StationIdx=0
Enabled=0
Interval=15
SendUV=0
CatchUp=1</pre>
| [Windy]
| Windy.com
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [WOW]
| Met Office WOW
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|}
|}


==Optional Web Server==


There are two sub-sections below, because the settings for the optional web functionality are split between '''Station Settings''' and '''Internet Settings'''.
===FTP Options===



=== Display Options controlling what appears on default web pages ===

* File Section is '''[Display]'''
* MX Section is '''Station Settings &rarr; Display Options'''
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:600px" | Description
|-
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
|-
| DisplaySolarData=0
|AutoFTP=0
| ??? 3.10.0 ???
|Auto FTP NOAA report files
| Display Solar data
|0 (disable)
| Unticked (shown as 0 in Cumulus.ini)
|Assuming you have selected (in earlier sub-section) that MX is to create reports
| Simple tick or not
*0= Disable any further action with filename
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display solar data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards)
*1= Enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data
|-
|-
| DisplayUvData=0
|FTPDirectory=
| ??? 3.10.0 ???
|FTP directory
| Display UV-I data
|(empty)
| Unticked (shown as 0 in Cumulus.ini)
|Where you want MX to use as destination folder on your FTP server
| Simple tick or not
*Leave blank and MX will use wherever has been specified in main internet settings (this fits how the default web site is designed to work)
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display ultra-violet intensity data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards)
* Specify a folder relative to FTP root, and MX will upload reports to that folder instead (if you use any files from default web site, then you will need to amend the JavaScript file:
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display UV intensity data
<code>let rptPath = ''; // Your path should have a trailing "/", eg. 'Reports/'</code> by putting your folder name in, an example is given for the case when “/Reports” is a sub folder off the main upload destination, note how you don’t include a leading slash, but you must add a trailing one.
|-
| NumWindRosePoints=16
| Legacy Cumulus
| Number of wind rose points
| 16
| Drop-down determining if weather station bearing supplied by weather station is to be converted to 8 or 16 compass directions (i.e. whether to include or exclude (in English) NNE, ENE, ESE, SSE, SSW, WSW, WNW, and NNW
* 8 points
* 16 points
Despite what it says in the hint on the settings page, leave at default whichever weather station type you use, unless this actually causes you a problem. The parameter was introduced by Steve Loft. Davis wind vanes use a potentiometer to measure wind direction so send Cumulus a bearing that can vary continuously between 1 and 360 degrees. Fine Offset wind vanes use magnetic switches that depend on the magnet under the moving part selecting two switches in the fixed part for the vane being exactly in-between compass directions, and selecting one switch for the main 8 directions and slightly away from the main directions; so they have a bias against sending Cumulus the in-between directions.
|-
| UseApparent=1
| ??? MX 3.6.0 or 3.10.0 ???
| Use Apparent Temperature
| Ticked (shown as 1 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display apparent temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus prior to release 3.6.0
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to display feels like temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus from release 3.6.0
|}
|}


===Thresholds===


=== File transfer and Copy Options controlling transfer of data to default web pages ===
‘’Please note any temperatures you specify in these settings must use the same units as you have asked MX to report temperature in. Equally any rainfall amounts you specify here must use the same units as you have asked MX to report rainfall in.’’


The settings listed in table below changed dramatically at both 3.10.0 and 3.12.0 releases, but they have gradually evolved throughout the development of MX.

From 3.12.0, MX can optionally ''either'' '''copy''' files to a [[Your Own Server|web server you host]] ''or'' '''file transfer''' files to a [[Webspace|commercial web server]].

To implement (and customise) this web server functionality, there are many settings as listed alphabetically in this table. The ''Internet settings'' page simplifies making settings by providing selections that amend multiple settings in a bulk operation:
* Some settings (marked ^ in table) are only displayed if you select '''I want to use the supplied default web site'''.
** For these settings, the "Generate" option is enabled in nearly all (see any qualifier) settings
** If you select "Enable file copy of standard files" (default is disabled) then those settings have their "Copy" option enabled in nearly all (see any qualifier) cases, and their "FTP Transfer" option deselected (instead of defaults shown in table)
** If you deselect "Enable file transfer of standard files" (default is enabled) then those settings have their "Copy" option disabled, and their "FTP Transfer" option enabled in nearly all (see any qualifier) cases (as per defaults shown in table)
* '''The default selections assume you have air quality, and solar, sensors; so you may need to disable some of the defaults the above selections have made'''
* If you don't select '''I want to use the supplied default web site''', then all the settings marked ^ are disabled
** This is what you want if you do not use the MX optional web server functionality
** If you have a customised web site, you may want to select '''I want to use the supplied default web site''' to see the settings that would otherwise all be disabled, and then pick any options that would be useful to you.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | File Section
!style="width:100px" | Introduced
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:600px" | Description
|-
| ActiveFTP=0
| [FTP site]
| Legacy Cumulus
| No
| Change directly in file as at release 3.11.x
| (n/a )
| (n/a)
| *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.
|-
| Copy-airquality=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| airquality.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
|-
|-
| Copy-alldailydegdaydata=0
|style="background:lightgray;"|[NOAA]
| [FTP site]
|
| Release 3.12.0
|
| ^
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
| Internet Settings &rarr; Graph File Settings
| alldailydegdaydata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailydegdaydata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailyhumdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailyhumdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailypressdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailypressdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailyraindata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailyraindata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailysolardata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailysolardata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
|-
| Copy-alldailytempdata=0
|HeatingThreshold=15.5
| [FTP site]
|Heating threshold
| Release 3.12.0
|65<sup>o</sup> F or 18.3<sup>o</sup>C
| ^
|[[Heat/cold_degree_days_and_Chill_hours#Heat_Degree_Days| Heating Degree Days]] are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. The international standard says 15.5 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
| Internet Settings &rarr; Graph File Settings
| alldailytempdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| Copy-alldailywinddata=0
|CoolingThreshold=22
| [FTP site]
|Cooling threshold
| Release 3.12.0
|65<sup>o</sup> F or 18.3<sup>o</sup>C
| ^
|[[Heat/cold_degree_days_and_Chill_hours#Cold_Degree_Days|Cold Degree Days]] are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. The international standard says 22 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
| Internet Settings &rarr; Graph File Settings
| alldailywinddata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| Copy-alltempsumdata=0
|MaxTempComp1=22
| [FTP site]
|Max temp comparison 1
| Release 3.12.0
|(empty)
| ^
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold
| Internet Settings &rarr; Graph File Settings
| alldailytempsumdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempsumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| Copy-availabledata=0
|MaxTempComp2=0
| [FTP site]
|Max temp comparison 2
| Release 3.12.0
|(empty)
| ^ (once only)
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius)
| Internet Settings &rarr; Graph File Settings
| availabledata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[availabledata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| Copy-dailyrain=0
|MinTempComp1=15.5
| [FTP site]
|Min temp comparison 1
| Release 3.12.0
|(empty)
| ^
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold
| Internet Settings &rarr; Graph File Settings
| dailyrain.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-dailytemp=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| dailytemp.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailytemp.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-graphconfig=0
| [FTP site]
| Release 3.12.0
| ^ (once only)
| Internet Settings &rarr; Graph File Settings
| graphconfig.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[graphconfig.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| Copy-humdata=0
|MinTempComp2=0
| [FTP site]
|Min temp comparison 2
| Release 3.12.0
|(empty)
| ^
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius)
| Internet Settings &rarr; Graph File Settings
| humdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[humdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-pressdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| pressdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[pressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-raindata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| raindata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[raindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-solardata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| solardata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[solardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-sunhours=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| sunhours.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[sunhours.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-tempdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| tempdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[tempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-wdirdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| wdirdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[wdirdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-websitedata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Standard File Settings
| websitedata.json &rarr; Copy
| 0 (disabled)
| Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]

Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the resulting websitedata.json to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-winddata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Graph File Settings
| winddata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[winddata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-wxnow=0
| [FTP site]
| Release 3.12.0
| ^ (disabled)
| Internet Settings &rarr; Standard File Settings
| wxnow.txt &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy that file to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| CopyMoonImage=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Moon Image
| Copy Moon image file
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy moon image file to your local web server (need to select "Generate Moon Image" see '''MoonImageEnabled=''' too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| Create-airquality=0
|RainComp1=0.5
| [FTP site]
|Rain comparison 1
| Release 3.10.0
|(empty)
| ^
| The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold
| Internet Settings &rarr; Graph File Settings
| airquality.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the airquality.json file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailydegdaydata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailydegdaydata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailydegdaydata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailyhumdata=0

| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailyhumdata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyhumdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailypressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailypressdata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailypressdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailyraindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailyraindata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyraindata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailysolardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailysolardata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailysolarydata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-alldailytempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailytempdata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailywinddata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailywinddata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailywinddata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alltempsumdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailytempsumdata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempsumdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-availabledata=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings &rarr; Graph File Settings
| availabledata.json &rarr; Generate
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[availabledata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| Create-dailyrain=0
|RainComp2=
| [FTP site]
|Rain comparison 2
| Release 3.10.0
|(empty)
| ^
| The report will count the number of days when the daily rainfall exceeds this threshold.
| Internet Settings &rarr; Graph File Settings
| dailyrain.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailyrain.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-dailytemp=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| dailytemp.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-graphconfig=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings &rarr; Graph File Settings
| graphconfig.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[graphconfig.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-humdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| humdata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[humdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-pressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| pressdat.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[pressdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-raindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| raindata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[raindata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-solardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| solardata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[solardata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
|-
| Create-tempdata=1
|RainComp3=
| [FTP site]
|Rain comparison 3
| Release 3.10.0
|(empty)
| ^
| The report will count the number of days when the daily rainfall exceeds this threshold.
| Internet Settings &rarr; Graph File Settings
|}
| dailytemp.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-sunhours=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| dailytemp.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-tempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| tempdata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[tempdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-wdirdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| wdirdata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[wdirdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-websitedata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| websitedata.json &rarr; Generate
| 1 (enabled)
| Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]


Simple tick or not
===Normal Mean Temperatures===
* Tick (value shown as 1 in Cumulus.ini) for MX to process the '''websitedataT.json''' file into websitedata.json
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-winddata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| winddata.json &rarr; Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[winddata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-wxnow=0
| [FTP site]
| Release 3.10.0
| ^ (disabled)
| (depends on release)
* (releases 3.10.0 to 3.11.4) Internet Settings &rarr; Web/FTP Settings
* (release 3.12.0 on) Internet Settings &rarr; Standard File Settings
| wxnow.txt &rarr; Generate
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate a [[wsnow.txt]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| DeleteBeforeUpload=0
| [FTP site]
| legacy Cumulus
| (always)
| (depends on release)
* (releases 3.0.0 to 3.11.4) Internet Settings &rarr; Web Settings &rarr; General Settings
* (release 3.12.0 on) Internet Settings &rarr; Web Site &rarr; General Settings
| Delete before upload
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to delete existing file (with same name) on the web server before it creates the new file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (this is the option appropriate to most servers)
|-
| Directory=
| [FTP site]
| Legacy Cumulus
| (always)
| Internet Settings &rarr; Web/FTP Site
| Remote FTP Directory
| (blank)
| Directory (including path) on your server to which FTP (if 'Enabled' is enabled) will upload the files.
*value is left Blank, default, the root position specified by ftp server
*A path from the starting point as the position specified by ftp server


Not used for ExtraRemoteNN parameters
*The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
|-
*There is one box labelled for each month on the settings screens
| DisableEPSV=0
*All the defaults are (blank)
| [FTP site]
*What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements
| Beta Release 3.0.0 build 3045
| No
| Still Change directly in file as at release 3.11.x
| (n/a )
| 0
| *0 = Disabled (default)
*1 = Enabled, to use Extended Passive FTP-mode
|-
| DisableFtpsExplicit=0
| [FTP site]
| Release 3.4.0 - Build 3064
| No
| Change directly in file as at release 3.11.x
| (n/a )
| 0
| (change value following attribute)
*0 = Disabled (default) use FTPS Explicit mode
*1 = Enabled, to use FTPS Implicit mode
|-
| Enabled=1
| [FTP site]
| Release 3.12.0
| (always) Controls whether ^ settings have "File Transfer" option enabled
| Internet Settings &rarr; Interval Configuration
| Enable file transfer of standard files
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to enable file transfer of standard files (see rows marked ^ for further selections)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| EnableLocalCopy=0
| [FTP site]
| Release 3.12.0
| (always) Controls whether ^ settings have "Copy" option enabled
| Internet Settings &rarr; Interval Configuration
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to enable copying of files (see rows marked ^ for further selections)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| EnableRealtime=1
| [FTP site]
| Legacy Cumulus
| (always)
| Internet Settings &rarr; Realtime Settings
| Enable Realtime
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate a timer that will permit real time actions
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-airquality=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| airquality.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the airquality.json file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
|-
| Ftp-alldailydegdaydata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailydegdaydata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailydegdaydata.json file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-alldailyhumdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailyhumdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-alldailypressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailypressdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-alldailyraindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailyraindata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-alldailysolardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailysolardata.json &rarr; File Transfer
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Ftp-alldailytempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailytempdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-alldailywinddata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alldailywinddata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-alltempsumdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| alltempsumdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alltempsumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-availabledata=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings &rarr; Graph File Settings
| availabledata.json &rarr; File Transfer
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[availabledata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-dailyrain=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| dailyrain.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-dailytemp=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| dailyrain.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-graphconfig=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings &rarr; Graph File Settings
| graphconfig.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[graphconfig.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-humdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| humdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[humdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-pressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| pressdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[pressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-raindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| raindata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[raindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-solardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| solardata.json &rarr; File Transfer
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[solardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Ftp-sunhours=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| sunhours.json &rarr; File Transfer
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[sunhours.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Ftp-tempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| tempdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[tempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-wdirdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| wdirdata.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[wdirdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-websitedata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Standard File Settings
| websitedata.json &rarr; File Transfer
| 0 (disabled)
| Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]


Simple tick or not
===Normal Precipitation===
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the resulting websitedata.json to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-winddata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Graph File Settings
| dailyrain.json &rarr; File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Ftp-wxnow=0
| [FTP site]
| Release 3.10.0
| ^ (disabled)
| (depends on release)
* (release 3.10.0 to 3.11.4) Internet Settings &rarr; Web/FTP Settings
* (release 3.12.0 on) Internet Settings &rarr; Standard File Settings
| wxnow.txt &rarr; File Transfer
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer that file to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| ForumURL=
| [Web Site]
| Legacy Cumulus
| (always)
| (depends on release)
* (releases 3.0.0 to 3.11.4) Internet Settings &rarr; Web Site
* (release 3.12.0 on) Internet Settings &rarr; Miscellaneous
| Forum URL
| (blank)
| Left blank to allow you to choose format


3.10.0 Default web pages use "<a href=\"https://cumulus.hosiene.co.uk/index.php\">forum</a>"
Rainfall equivalents of mean temperature described above

Some alternative URL examples:
*https://cumulus.hosiene.co.uk/index.php (for above example in default web pages)
*https://cumulus.hosiene.co.uk
*https://cumulus.hosiene.co.uk/search.php?search_id=active_topics
|-
| FTPlogging=0
| [FTP site]
| Legacy Cumulus
| FTP logging
| Depends on release installed:
# (Releases 3.1.0 to 3.10.5) Internet Settings &rarr; &rarr; Web Settings &rarr; General Settings
# (Releases 3.11.0 to 3.11.4) Program Settings &rarr; Program General Options
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
| (n/a)
| (n/a)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX in standard FTP mode add output to [[ftplog.txt]].
to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers)
* Don't tick (value shown as 0 in Cumulus.ini) to disable updates to '''ftplog.txt'''
For other types of file transfer (STTP, FTPS), any extra diagnostic information appears in latest log in [[MXdiags folder]]
|-
| FTPRename=1
| [FTP site]
| Legacy Cumulus
| (always)
| (depends on release)
* (releases 3.0.0 to 3.11.4) Internet Settings &rarr; Web Settings &rarr; General Settings
* (release 3.12.0 on) Internet Settings &rarr; Web Site &rarr; General Settings
| FTP rename
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
The chief advantage of using rename is that it minimises the time that the web server cannot serve a file (while it is being updated)
|-
| Host=
| [FTP site]
| Legacy Cumulus
| (always)
| Internet Settings &rarr; Web/FTP Site
| Host name
| (blank)
| 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.
|-
| IncludeMoonImage=1
| [FTP site]
| Release 3.5.0
| (always)
| Internet Settings &rarr; Moon Image
| (FTP) Upload Moon image file
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer moon image file to your local web server (need to select "Generate Moon Image" see '''MoonImageEnabled=''' too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| IntervalFtpEnabled=1
| [FTP site]
| Release 3.12.0
| ??
| Internet Settings &rarr; Interval Settings
| Enable file transfer update interval
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file transfer actions
* Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected '''LocalCopyEnabled''' (see below)
|-
| ListWebTags=0
| [Station]
| Legacy Cumulus
| Only from Release 3.12.0
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; Advanced options
| 0
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to create ''WebTags.txt'' file when Cumulus is restarted (contains an unordered list of all the tag names your Cumulus build will recognise and process)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| LocalCopyEnabled=0
| [FTP site]
| Release 3.12.0
| (always)
| Internet Settings &rarr; Interval Configuration
| Enable local copy update interval
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file copy actions
* Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected file transfer '''IntervalFtpEnabled''' (see previous)
|-
| LocalCopyFolder=
| [FTP site]
| Release 3.12.0
| (always)
| Internet Settings &rarr; Interval Configuration
| (blank)
| Folder (including path) to which MX will copy the standard files (see rows marked ^ for further selections) if 'EnableLocalCopy' is enabled
|-
| MoonImageEnabled=1
| [Graphs]
| Release 3.5.0
| (always)
| Internet Settings &rarr; Moon Image
| Generate Moon Image
| ^ Default controlled by selection of default web site
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to use System Drawing to modify CumulusMX/web/MoonBaseImage.png and create CumulusMX/web/moon.png
* Don't tick (value shown as 0 in Cumulus.ini) if you don't need MX to create a "moon.png"
|-
| MoonImageSize=
| [Graphs]
| Release 3.5.0
| (always)
| Internet Settings &rarr; Moon Image
| Image size
| ???
| Enter a size (in pixels) for the generated moon image (according to space on your web page)
|-
| Password=
| [FTP site]
| Legacy Cumulus
| (always)
| Internet Settings &rarr; Web/FTP Site
| Password
| (blank)
| The password for your FTP/SFTP/FTPS connection (masked out on settings page, shown in plain text in file)
|-
| Port=21
| [FTP site]
| Legacy Cumulus
| (always)
| Internet Settings &rarr; Web/FTP Site
| FTP port
| 21 (plain FTP)
|you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative protocol and/or alternative ports.
|-
| RealtimeFTPEnabled=0
| [FTP site]
| Legacy Cumulus
| ^
| Internet Settings &rarr; Realtime Settings
| Enable realtime FTP
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to be able to do file transfers at real-time interval
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| RealtimeGaugesTxtCopy=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Realtime Settings
| realtimegauges.txt
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[SteelSeries_Gauges|realtimegauges.txt]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| RealtimeGaugesTxtCreate=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Realtime Settings
| realtimegauges.txt &rarr; Generate
| 0
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[SteelSeries_Gauges|realtimegauges.txt]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| RealtimeGaugesTxtFTP=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Realtime Settings
| realtimegauges.txt &rarr; File Transfer
| 0
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[SteelSeries_Gauges|realtimegauges.txt]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| RealtimeInterval=45000
| [FTP site]
| Legacy Cumulus
| ^
| Internet Settings &rarr; Realtime Settings
| Realtime interval
| 45000 milliseconds (45 seconds)
| Enter interval time in seconds (decimals allowed), stored in file converted to milliseconds
|-
| RealtimeTxtCopy=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr; Realtime Settings
| realtime.txt
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[realtime.txt]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| RealtimeTxtCreate=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Realtime Settings
| realtime.txt &rarr; Generate
| 0
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[realtime.txt]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| RealtimeTxtFTP=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings &rarr; Realtime Settings
| realtime.txt &rarr; File Transfer
| 0
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[realtime.txt]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| RecordSetTimeoutHrs=24
| [Station]
| Release 3.5.1
| Only from Release 3.12.0
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) '''Two places''':
*# Station setings &rarr; General Settings &rarr; Advanced options
*# Station settings &rarr; Common Options &rarr; Advanced options
| Depends on where changed (respectively):
# New record timeout
# Record set timeout
| 24
| Number of hours before the following web tags are reset: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet, LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet, HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet
|-
| Sslftp=
| [FTP site]
| MX beta
| (always)
| Internet Settings &rarr; Web/FTP Site
| Select the FTP Protocol to use
| 0
| Drop down list:
* 0 = FTP (plain old FTP) - default
* 1 = Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) for FTP (FTPS)
* 2 = Use Secure Shell Home (SSH) for FTP (SFTP)
|-
| SshFtpAuthentication=Password
| [FTP site]
| Release 3.8.2 - build 3092
| Only if SFTP selected above
| Internet Settings &rarr; Web/FTP Site
| SFTP Authentication method
| Password
|Drop down list:
* 0 = Password
* 1 = Pre-shared key
* 2 = Password or pre-shared key
|-
| SshFtpPskFile=
| [FTP site]
| Release 3.8.2 - build 3092
| only if 1 or 2 selected in previous setting
| Internet Settings &rarr; Web/FTP Site
| Pre-shared Private Key file for SFTP
| (blank)
| Filename for your private PSK file, include the full path if the file is not in same folder as CumulusMX.exe
|-
| UpdateInterval=60
| [FTP site]
| legacy software
| ^
| Internet Settings &rarr; Interval Settings
| Web interval
| 60
| Interval between standard web updates in minutes
|-
| Username=
| [FTP site]
| legacy software
| (always)
| Internet Settings &rarr; Web/FTP Site
| Username
| (blank)
| the user name for connecting to your server
|-
| UTF8encode=
| [FTP site]
| legacy software
| (always)
| (depends on release)
* (releases 3.0.0 to 3.11.4) Internet Settings &rarr; Web Settings &rarr; General Settings
* (release 3.12.0 on) Internet Settings &rarr; Web Site &rarr; General Settings
| UTF-8 encoding
| Default depends on release:
* (Legacy versions and MX up to 3.9.7) 0 (ISO 8859-1 character set)
* (Release 3.10.0 on) 1 (UTF-8 encoding enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to use [[Reports_folder#Encoding|'''UTF-8''' encoding]] in all [[:Category:JSON Files|.json files]]
* Don't tick (value shown as 0 in Cumulus.ini) and MX will create its .json files using '''ISO 8859-1 character set''', ''please note that this encoding is incompatible with [[New_Default_Web_Site_Information#Installing_the_new_template_for_new_users|web pages]] included in '''webfiles''' folder''; so if you upgrade from an earlier release, you may need to change this setting
|-
|WebcamURL=
| [Web Site]
| Legacy Software
| (always)
| (depends on release)
* (releases 3.0.0 to 3.11.4) Internet Settings &rarr; Web Site
* (release 3.12.0 on) Internet Settings &rarr; Miscellaneous
| Webcam URL
| (blank)
| Can be used to add a link to any other web page, you have on any web server. In default web pages will be labelled as "web cam", but for your own web pages, this might lead to a home or blog page.
|}


==Program Start-up Options==
==Program Start-up Options==
Line 759: Line 2,494:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:160px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:160px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
!style="width:600px" | Description
Line 771: Line 2,506:
|-
|-
|StartupPingEscapeTime=999
|StartupPingEscapeTime=999
| Program Settings &rarr; Program Start-up Options
|PING escape time (mins)
|PING escape time (mins)
|999 (minutes)
|999 (minutes)
Line 776: Line 2,512:
|-
|-
|StartupDelaySecs=0
|StartupDelaySecs=0
| Program Settings &rarr; Program Start-up Options
|Start-up Delay (secs)
|Start-up Delay (secs)
|zero (no delay)
|zero (no delay)
Line 781: Line 2,518:
|-
|-
|StartupDelayMaxUptime=300
|StartupDelayMaxUptime=300
| Program Settings &rarr; Program Start-up Options
|Max system uptime to apply the start-up delay
|Max system uptime to apply the start-up delay
|300 (seconds equivalent to 5 minutes)
|300 (seconds equivalent to 5 minutes)
Line 789: Line 2,527:
|}
|}


==Proxy==


This is a continuation of an experimental legacy Cumulus software feature, please see [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=728 here for request] and see [[Cumulus.ini_(Cumulus_1)#Proxies|here]] for potential content. I have not seen any evidence that this feature ever came out of beta, and nobody has ever commented on its use, so I see no reason to do any further documentation.


==Station specific alternatives==
==Station specific alternatives==
Line 797: Line 2,537:
Since MX is being developed by someone who uses a Davis station, a lot of "Labels on the Settings Screens" mention "Davis" even if you have selected a different station, because the code was written by copy and paste!
Since MX is being developed by someone who uses a Davis station, a lot of "Labels on the Settings Screens" mention "Davis" even if you have selected a different station, because the code was written by copy and paste!


=== Solar===


Cumulus MX is unable to work out if you have a solar sensor, so these options are always displayed.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 806: Line 2,548:
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:800px" | Description
|-
| SolarCalc=0
| [Solar]
| 3.13
| Station Settings &rarr; Solar
| Solar Calculation Method
| 0=Ryan-Stololzenbach
| Drop-down list:
* 0=Ryan-Stololzenbach
* 1=Bras
|-
| SunThreshold=75
| [Solar]
| 3.13
| Station Settings &rarr; Solar
| Sun Threshold (percent)
| 75
| Enter a number
|-
| SolarMinimum=0
| [Solar]
| 3.13
| Station Settings &rarr; Solar
| Solar minimum (W/m2)
| 30
| Enter a number
|-
| RStransfactorJul=0.80000000000000004
| [Solar]
| 3.14
| Station Settings &rarr; Solar
| RS Transmission factor (June)

(Note the internal calculation does apply this to June, but some MX releases were incorrectly typed to say "July" on the settings screen).
| 0.8
| MX does a sinusoidal interpolation between this value and the next. So this June factor changes very little either side of that solstice, with the average value from both factors applying at the equinoxes (March and September) and different amounts of each factor each side of equinox. (So actually more like a cosine interpolation!)
|-
| RStransfactorDec=0.80000000000000004
| [Solar]
| 3.14
| Station Settings &rarr; Solar
| RS Transmission factor (December)
| 0.8
| MX does a sinusoidal interpolation between last value and this one. So this December factor changes very little either side of that solstice, with the average value from both factors applying at the equinoxes (March and September) and different amounts of each factor each side of equinox. (So actually more like a cosine interpolation!)
|-
| UseBlakeLarsen=0
| [Solar]
| Legacy
| Extra Sensor Settings
| Blake-Larsen Sunshine Recorder
| 0=deselected
| checkbox
|}

===Selecting the weather station type determines which options are shown===

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | File Section
!style="width:100px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:800px" | Description
|-
|-
|Type= -1
|Type= -1
Line 813: Line 2,620:
| Station Settings &rarr; General Settings
| Station Settings &rarr; General Settings
| Station type
| Station type
| -1 (not yet defined)
| Drop-down
| Drop-down
* -1 = "Select Station", shown before a selection from those below is made
* -1 = "Select Station", shown before a selection from those below is made
Line 842: Line 2,650:


===Airlink===
===Airlink===

The details in this sub-section need to be checked by someone who uses the relevant hardware.


* Introduced Release
* Introduced Release
Line 873: Line 2,683:
===Davis===
===Davis===


Two Wiki sub-sections:
Two Wiki sub-sections, that need to be checked by by somebody who uses the relevant functionality:




Line 880: Line 2,690:


{{Template:WorkInProgressBanner}} This table does not yet have all details in it.
{{Template:WorkInProgressBanner}} This table does not yet have all details in it.
* Introduced for leagacy Cumulus
* Introduced for legacy Cumulus
* File Section is [Station]
* File Section is [Station]
* Only "Shown on Settings page" if either "Type=0" or "Type=1"
* Only "Shown on Settings page" if either "Type=0" or "Type=1"
Line 887: Line 2,697:
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:120px" | Default
!style="width:300px" | Description
!style="width:800px" | Description
|-
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|[Station]
Line 1,015: Line 2,825:
|set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|}
|}




====Davis WeatherLink Live====
====Davis WeatherLink Live====
Line 1,043: Line 2,851:
|}
|}


====EasyWeather (Reading File instead of connecting to a Weather Station)====
===EasyWeather (Reading File instead of connecting to a Weather Station)===


This sub-section is based on what applied for the legacy software, assuming nothing has changed for MX.


* Introduced in a Legacy version
* Introduced in a Legacy version
Line 1,055: Line 2,864:
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:120px" | Default
!style="width:300px" | Description
!style="width:800px" | Description
|-
|-
| EWInterval=10
| EWInterval=10
Line 1,098: Line 2,907:
|}
|}


====Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific====
===Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific===

{{Template:WorkInProgressBanner}} An Ecowitt user needs to check/update this sub-section, it is understood significant changes are included in 3.12.0 beta builds, but the forum does not give away any details


* Introduced in release 3.2.0
* Introduced in release 3.2.0
Line 1,131: Line 2,942:


===Fine Offset Stations===
===Fine Offset Stations===


{{Template:WorkInProgressBanner}} This table has not been populated yet


* Introduced in a Legacy version
* Introduced in a Legacy version
Line 1,144: Line 2,952:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
|-
|
| Synchronise Reads
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
* Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data
Selecting this parameter has given some problems in earlier MX builds, so the code has recently been rewritten.
|-
|-
| FOReadAvoidPeriod=3
|
| MX release ??
| Only if Fine Offset selected
| Station Settings &rarr; Fine Offset Advanced Settings
| Read Avoid Period
| Read Avoid Period
| 3 (seconds)
| 3 (seconds)
Line 1,162: Line 2,968:


(One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor)
(One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor)
|}



{{Template:WorkInProgressBanner}}
There are a number of settings in a MX sub-section called "Fine Offset Advanced Options". These are new settings, and have not been documented yet.

{| class="wikitable" border="1"
|-
|-
| ??
!style="width:30px" | Parameter Line Entry
| MX release ??
!style="width:100px" | Shown on Settings page?
| Only if Fine Offset selected
!style="width:100px" | MX Section
| Station Settings &rarr; Fine Offset Advanced Settings
!style="width:60px" | Label on Settings page
| Set the Fine Offset Logger interval to match Cumulus MX interval
!style="width:20px" | Default
| 0 (disabled)
!style="width:600px" | Description
| Simple tick or not - labelled as "Experimental - use with caution"
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to "update the Davis interval" (I said copy and paste was used from Davis section!) to match the interval MX is using.
* Don't tick (value shown as 0 in Cumulus.ini) for no effect on your weather station
|-
|-
| FineOffsetReadTime=150
|
| MX release ??
|}
| Only if Fine Offset selected
| Station Settings &rarr; Fine Offset Advanced Settings
| Request/Read Delay
| 150 (milliseconds)
| Adjust time (in milliseconds) between request for read, and actual attempt to read data via USB
|-
| ProductID=-1
| MX release ??
| Only if Fine Offset selected
| Station Settings &rarr; Fine Offset Advanced Settings
| USB Product Id (PID)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|-
| SyncFOReads=0
| Legacy Cumulus
| Only if Fine Offset selected
| Station Settings &rarr; Fine Offset Settings
| Synchronise Reads
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
* Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data

# The parameter was added for legacy releases, to try to reduce the occurrence of "lock-up" issues.
# MX uses a different way to interrogate Fine Offset stations, originally ticking this could result in more reads being skipped, than actually processed, potentially updating just a few times a day, so it was best disabled!
# The MX code relating to this parameter was rewritten 1n 3.11.0, but the developer labels this as an "attempt", so it may still be best to try to manage without enabling this setting
|-
| VendorID=-1
| MX release ??
| Only if Fine Offset selected
| Station Settings &rarr; Fine Offset Advanced Settings
| USB Vendor Id (PID)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|}


===Instromet Settings===
===Instromet Settings===




{{Template:WorkInProgressBanner}} The following table has some gaps to fill in
{{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station


* Introduced in a Legacy version
* Introduced in a Legacy version
Line 1,194: Line 3,031:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:300px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
Line 1,244: Line 3,081:
|}
|}


===WM918/WMR928 Settings===


===LaCrosse stations===
Oregon Scientific specific



{{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station


{{Template:WorkInProgressBanner}} This table has not been populated yet


* Introduced for legacy Cumulus
* File Section is [Station]
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:100px" | Shown on Settings page?
!style="width:100px" | File Section
!style="width:150px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page (mostly in '''Alarm''' column)
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
|-
|-
| LCMaxWind=X
| Shown only if La Crosse was selected as station type
| [Station]
| 3.12.0
| Depends on release:
* (Version 1.8.8 Build 874 to release 3.11.4) Need to edit manually in file directly
* (Release 3.12.0 onwards) Station Settings &rarr; Common Options &rarr; Advanced Options
| La Crosse max wind speed
| ???
| It is setting for the La Crosse max wind speed, where X is the maximum (before calibrated by any definitions in Offsets) 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
|}
|}


It is assumed that [[Cumulus.ini_(Cumulus_1)#La_Crosse_specific:|most parameters remain same]]

===Oregon Scientific WM918/WMR928 Settings===

The Oregon Scientific code has not changed since the earliest beta MX (3.0.0) builds based on moving compiled code from Cumulus 1.

It appears very few current Cumulus users own these obsolete models, so all these settings have to be added directly into the file, you can't edit them in the admin interface, and they will be missing from any configuration file created by any MX release.

* Introduced for legacy Cumulus, and unchanged by MX
* File Section is [Station], these settings need to be manually entered into file below that section heading
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:100px" | External to MX edit
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
Line 1,274: Line 3,135:
|-
|-
|Humidity98Fix=0
|Humidity98Fix=0
| Stop MX and add this into file
|
|0 (disable)
|0 (disable)
|Applies to weather station types that never report more than 98% relative humidity.
|Applies to weather station types that never report more than 98% relative humidity.
Line 1,281: Line 3,142:
|-
|-
|LogExtraSensors=0
|LogExtraSensors=0
| Stop MX and add this into file
|
|0 (disable)
|0 (disable)
|This setting determines whether MX looks for readings from extra temperature probes etc.
|This setting determines whether MX looks for readings from extra temperature probes etc.
Line 1,288: Line 3,149:
|-
|-
|WMR928TempChannel=N
|WMR928TempChannel=N
| Stop MX and add this into file
|
|(no default)
|(by default no extra sensors)
|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
|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
|WMR200TempChannel=N
| Stop MX and add this into file
|
|(no default)
|(by default no extra sensors)
|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
|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
|}

==Units, Derivative Options, and Decimal Places==

For altitude units, please see [[#Location]].

* File Section is [Station]
* Edit on Station Settings page (except where indicated in bold as another page)
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
| AirQualityDecimals=1
| Release 3.9.2
| Units &rarr; Advanced Options (Here be dragons!)
| Air Quality decimals
| 1 (displayed as blank)
| Number of decimal places for all outputs
|-
| AvgBearingMinutes=10
| Legacy Cumulus
| Common Options &rarr; Advanced Options (Here be dragons!)
| Average Bearing Minutes
| 10 (minutes)
| This parameter's value is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing
|-
| AvgSpeedMinutes=10
| Legacy Cumulus
| Common Options &rarr; Advanced Options (Here be dragons!)
| Average Speed Minutes
| 10 (minutes)
| This parameter's value is the number of minutes over which Cumulus averages out reported current wind speeds
|-
| CalculatedDP=0
| Legacy Cumulus
| Common Options
| Calculate dew point
| Unticked (shown as 0 in Cumulus.ini)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate dew point from temperature and humidity supplied by station
* Don't tick (value shown as 0 in Cumulus.ini) action depends on '''Calibration settings'''
** If Cumulus has non-default multiplier and/or offset settings for temperature or humidity, Cumulus will calculate dew-point. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
** If station provides dew point, then that will be used provided no multiplier/offsets have been specified for temperature or humidity
|-
| CalculatedWC=1
| Legacy Cumulus
| Common Options
| Calculate wind chill
| Unticked (shown as 0 in Cumulus.ini)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate wind chill from temperature and wind speed
** Note that there is a maximum temperature, and minimum wind speed, for Cumulus to make the calculation, see [[Wind_chill]] page
* Don't tick (value shown as 0 in Cumulus.ini) action depends on other items:
** If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill
** If station does NOT make a wind chill value available to Cumulus, Cumulus MX reports an error if you have not ticked this setting, (that is different to how the setting worked with the legacy software).
** If station provides wind chill, then that value will be used provided no multiplier/offsets have been specified for temperature or wind speed.
|-
| ChillHourSeasonStart=
| Legacy Cumulus
| Chill Hours
| Chill Season Starts
| Default depends on release
* (up to 3.11.4) 10 = October
* (from 3.12.0) 4 in Southern hemisphere, 10 in Northern hemisphere
| The value to enter is the month number (1=January, 12=December) and the Cumulative Chill Hours Count is reset to zero on the first of the selected month
|-
| ChillHourThreshold=
| Legacy Cumulus
| Chill Hours
| Chill Hours
| Default depends on Temperature Units
* Either 45 degrees Fahrenheit (equivalent to 7.22 <sup>o</sup>Celsius)
* Or 7 degrees Celsius (equivalent to 44.6 <sup>o</sup>Fahrenheit)
| Chill Hours are incremented by the number of (fractional) hours that the air temperature is below the threshold. In practice, Cumulus simply detects if the current temperature is below the threshold and adds an increment equivalent to the (interval) time passed since the last temperature reading.
* 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 or 32 <sup>o</sup>F) and they relabel "chill hours" to "frost hours"
|-
| CloudBaseInFeet=0
| Legacy Cumulus
| (As at 3.11.4, can only adjust in the file)
|
| 0 (default in MX is metres)
| Select units used for reporting theoretical cloud base:
* 0 = metres (default if file created by MX)
* 1 = feet (default if file created by legacy software)
|-
| ErrorLogSpikeRemoval=1
| Legacy Cumulus
| '''Calibration Settings''' &rarr; Final tick box
| Log spike and limit violations to error log
| 1 (default in MX is enabled)
| Log spike and limit violations to error log (in MX this is in [[MXdiags folder]]):
* 1 = do log (default if file created by MX)
* 0 = don't log (default if file created by legacy software)
|-
| HourlyForecast=1
| Legacy Cumulus
| Forecast
| Update forecast hourly
| 1 (default in MX is enabled)
| When Cumulus derives its Zambretti forecast

Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will derive a Zambretti forecast just once an hour, on the hour
* Don't tick (value shown as 0 in Cumulus.ini) to derive a forecast every time MX does a process of the pressure reading
|-
| Humidity98Fix=0
| Legacy Cumulus
| Common Options
| Max humidity
| 0 (disable)
| For any weather station that never reports a relative humidity greater than 98%

Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then if weather station reading is 98%, process that as 100% for all outputs from MX
* Don't tick (value shown as 0 in Cumulus.ini) to always report what weather station reports for relative humidity
|-
| PeakGustMinutes=10
| Legacy Cumulus
| Common Options &rarr; Advanced Options (Here be dragons!)
| Peak wind gust time
| 10 (minutes)
| MX waits until a gust has been measured for number of minutes specified by value of parameter, before checking whether previous gust extreme record have been exceeded
|-
| PressDecimals=1
| Release 3.9.2
| Units &rarr; Advanced Options (Here be dragons!)
| Pressure decimals
| Default depends on Pressure Units (displayed as blank)
* default is 1 if units are hPa or mb
* default is 2 if units are inches of mercury
| Number of decimal places for all outputs
|-
| PressureUnit=1
| Legacy Cumulus
| Units
| Pressure
| Depends on release:
# Legacy to 3.11.4: 0 (mbar)
# 3.12.0 onwards: 1 (hPa)

| Drop-down:
* 0 = millibar (mb)
* 1 = hectoPascals (hPa)
* 2 = inches of mercury (in Hg)
|-
| RainDayThreshold=
| Legacy Cumulus
| Common Options &rarr; Advanced Options
| Rain day threshold
| Default is -1 which depends on Rainfall Units AND station type
* -1 = normally 0.2 if units are millimetres
* -1 = normally 0.01 if units are inches
* Otherwise enter a value in your selected units
| For derivatives like count of consecutive wet/dry days, any daily rainfall less than this threshold will be ignored.

(If rainfall is measured in tips, usually set to just over one tip, as first tip of day might be result of less that one tip accumulated on earlier days or because of dew)
|-
| RainDecimals=1
| Release 3.9.2
| Units &rarr; Advanced Options (Here be dragons!)
| Rainfall decimals
| Default depends on Rainfall Units (displayed as blank)
* default is 1 if units are millimetres
* default is 2 if units are inches
| Number of decimal places for all outputs
|-
| RainSeasonStart=1
| Legacy Cumulus
| Annual Rainfall
| Start of rainfall season
| 1 (Jan)
| Drop-down
* 1 = January
* 2 = February
* 3 = March
...
* 9 = September
* 10 = October
* 11 = November
* 12 = December

Added in late 2010 because Cumulus users in Israel said they do not total rainfall from January.

It was welcomed by people outside Israel, it turned out growers are often interested in a growing season rainfall total
|-
| RainUnit=0
| Legacy Cumulus
| Units
| Rain
| 0 (mm)
| Drop-down:
* 0 = millimetres
* 1 = inches
|-
| RoundWindSpeed=0
| Legacy Cumulus
| Common Options
| Rounding of wind speed
| 0 (no)
| Simple tick or not, (only applicable if any reported wind speed would otherwise include decimal places):
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will round all the wind speeds it reports to nearest integer
* Don't tick (value shown as 0 in Cumulus.ini) then Cumulus will report wind speeds to the precision defined in "WindSpeedDecimals", "WindSpeedAvgDecimals", and "WindRunDecimals", parameters
|-
| SunshineHrsDecimals=2
| Release 3.8.0
| Units &rarr; Advanced Options (Here be dragons!)
| Sunshine hours decimals
| 2 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| TempDecimals=1
| Release 3.9.2
| Units &rarr; Advanced Options (Here be dragons!)
| Temperature decimals
| 1 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| TempUnit=0
| Legacy Cumulus
| Units
| Temperature
| 0 (<sup>o</sup>C
| Drop-down:
* 0 = Celsius
* 1 = Fahrenheit
|-
| UseCumulusForecast=0
| Legacy Cumulus
| Forecast
| Use Cumulus Forecast
| 0 (disabled)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, or as an alternative to the one supplied by your station. Please see [[Forecast_webtag]] for details.
* Don't tick (value shown as 0 in Cumulus.ini) then MX will not do any forecasting, so it will return "not available" unless your weather station provides an alternative forecast
|-
| UseCumulusPresstrendstr=0
| Legacy Cumulus
| Common Options
| Cumulus pressure trend names
| 0 (depends on weather station type)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]].
* Don't tick (value shown as 0 in Cumulus.ini) then effect depends on whether your weather station supplies pressure trends
** If your station does supply pressure trends, then MX will use those
** If your station does not supply pressure trends, then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]].
|-
| UseSpeedForAvgCalc=0
| Legacy Cumulus
| Common Options
| Use speed for average calculation
| 0 (disable)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will use what the weather station supplies as "wind speed" to calculate the average wind speed.
* Don't tick (value shown as 0 in Cumulus.ini) then MX will use what the weather station supplies as "latest wind speed" to calculate the average wind speed
Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details.
|-
| UseZeroBearing=1
| Legacy Software
| Common Options
| Use bearing zero when calm
| 1 (enable)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will report a wind bearing of zero when the wind is calm
* Don't tick (value shown as 0 in Cumulus.ini) then MX will continue to report the last wind bearing when the wind stops blowing
|-
| UVDecimals=1
| Release 3.9.2
| Units &rarr; Advanced Options (Here be dragons!)
| Ultra Violet decimals
| 1 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| Wind10MinAverage=0
| Legacy Cumulus
| Common Options
| Calculate average wind speed
| 0 (disable)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will calculate an average wind speed (over ten minutes) as defined by "UseSpeedForAvgCalc" parameter
* Don't tick (value shown as 0 in Cumulus.ini) then MX will use whatever the weather station provides as an average wind speed
Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details.
|-
| WindRunDecimals=1
| Release 3.9.2
| Units &rarr; Advanced Options (Here be dragons!)
| Wind run decimals
| 1 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| WindSpeedAvgDecimals=
| Release 3.8.3
| Units &rarr; Advanced Options (Here be dragons!)
| Wind speed average decimals
| (displayed as blank)
| Select a number of decimal places to overwrite the default. (NOTE: If the weather station does not provide an average wind speed, or if the user requires a change of units from how the weather station reports it, then CMX will calculate it to 1 decimal place by default; otherwise average wind speed will default to integer, or to one decimal place, depending how it is provided by the station).
|-
| WindSpeedDecimals=
| Release 3.8.3
| Units &rarr; Advanced Options (Here be dragons!)
| Wind speed average decimals
| (displayed as blank)
| Select a number of decimal places to overwrite the default which depends both on the weather station type and what units have been selected by user (speeds are normally reported as integers unless metres per second are reporting unit, because most sensors are not precise enough to give any decimal places in other units)
|-
| WindUnit=0
| Legacy Cumulus
| Units
| Wind
| Default depends on release:
* Legacy to 3.11.4: 0 (m s<sup>-1</sup>)
* 3.12.0 onwards: 2 (km hr<sup>-1</sup>)
| Drop-down:
* 0 = metres per second
* 1 = miles per hour
* 2 = Kilometres per hour
* 3 = Knots (nautical miles per hour or kts)
|-
| YTDrain=0
| Legacy Cumulus
| Annual Rainfall
| Year-to-date amount
| 0 (displayed as blank)
| Enter the amount of rainfall to be added to the calendar year in next parameter (used when start using Cumulus in middle of year)
|-
| YTDrainyear=
| Legacy Cumulus
| Annual Rainfall
| Year to which year-to-date amount applies
| (displayed as blank)
| Enter a 4 digit year:
* Legacy Releases (1.7.12 from 5 July 2008) and MX up to 3.11.4 (build 3133 from 25 May 2021): The year-to-date amount in previous parameter is added to the current (seasonal) rain if the year specified in this parameter matches the current year.
** If your rain season starts in January (default) then set this to the calendar year when you first use Cumulus (in a particular location).
** If your rain year starts in any other month, set this to the current calendar year during your first season (remember to change the year mid-season when reach 1 January), and delete the year when your second season starts as you don't want the previous value added to your second season
* From Release 3.12.0 (29 July 2021), the current calendar year is compared against (current month - season start month + 1) year, so you enter the year in which your first season would start had it been a full season (be that last calendar year or this calendar year)
|}
|}

Latest revision as of 05:39, 13 September 2022

Please note this page was created 13 June 2021.

At last update, it shows position as at beta build 3135, (missing some changes for the 3.12.0 release build of 3141).

This new page was created to reflect parameters added to Cumulus.ini in releases 3.8.0, 3.9.2, 3.10.0, and 3.12.0 (early beta builds - June 2021). It excludes all parameters removed after release 3.7.0.


Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

Since this page describes a file whose content frequently changes, this page may be out of date, unless somebody bothers to update it for every change.

Purpose of Cumulus.ini file

This is a text file containing initialization parameters. Cumulus Version MX SpecificThis page covers those used by the Cumulus MX software applica3.2.0 to 3.5.4tion.

For MX there can only to be one Cumulus.ini file, and it must be stored in the same folder as the executable "CumulusMX.exe".

The configuration settings in Cumulus.ini have the following main purposes (this list may be incomplete):

  • Identify which weather station type MX is to read, and settings related to that model
  • Identify which derivatives are source ones (read directly from weather station and converted to your preferred units) and which derivatives MX is to calculate for you.
  • Identify where you want MX to output to (options include external web sites, and database tables)
  • Control what is output to those destinations, to the extent that each can be configured


Why does this Wiki now contain multiple pages describing "Cumulus.ini"?

MX has been developed very dramatically by Mark Crossley:

  1. There were minor differences between the legacy cumulus.ini (for versions 1.x.y, ending with 1.9.4) with documentation now here and the original 3.0.0 beta (previously documented on Cumulus.ini (Beta) page, but that page has been cleared)
  2. The dramatic development of MX produced considerable differences between that original MX beta, and the configuration that applied up to 3.7.0, as now documented here
  3. Even more dramatic changes to the MX configuration have been happening since 3.8.0, with the biggest changes at 3.9.2, 3.10.0, and 3.12.0; therefore, the decision was taken to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new empty page!


All the pages, previously called "Cumulus.ini", can be found from the owning category. The original page was preserved at Cumulus.ini_(preserving_history) so look there for its editing history. That page also expands on the above summary of why that old page was replaced.

You will also note that this page does not cover all settings in detail, and find some links to further pages within some sections below

Need to install MX 3.12.0

If you are using Cumulus 1 or a release of MX earlier than 3.12.0, be aware that the content of "Cumulus.ini" is totally different to the file for later MX releases. (It might have been better had the file been given a new name in release 3.12.0).

The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from here and runs that release for a while before upgrading to the latest release here.

Simplifications

The MX configuration is very different to that used by the legacy software. MX has far more optional functionality than the legacy software, therefore MX requires far more parameters to tailor all these functionality options.

The file is read into Internal Variables as Cumulus starts, and those variables are written back into the file when any settings are changed.

In the MX releases covered by this Wiki page, almost all settings are edited from a number of web pages for settings included in the local web interface.

To make it easier for the Cumulus MX user, the developer had to devise a way to make it easier to quickly assign the settings that might be best for those new to Cumulus to get the software working without needing to understand all the settings. This is achieved by introducing some "master" settings, these both determine which dependent settings are displayed, and what default values those dependent settings take. So a novice just has to get the "master" settings right and they then achieve a typical way of using that functionality! For those who are slightly more expert, full flexibility is available by adjusting the majority of dependent settings to what is required for more specialised requirements.

The ongoing development of MX is focused on making configuration even simpler, by revising the pages for the setting of all parameters, and improving the labels/grouping. By moving away from legacy software terminology and the parameters it needed; the developer has started introducing parameters and labelling that fits the MX design.

It may be worth remembering why the legacy software made life complicated:

  1. There could be more than one "cumulus.ini" file for the Legacy Cumulus up to 1.9.4, as explained here.
  2. The vast majority of parameters (that could appear in the file) could only be edited directly in the file.
    • To simplify the editing in-situ, the author (Steve Loft) recommended that, within any "File section" you intended to change, you sorted the parameters into alphabetical order, before editing the file.
    • That advice was given because having parameters in alphabetical order would prevent you inserting a parameter that already existed.
    • This would avoid the potential problem arising from the design that Cumulus 1 would ignore any duplicate parameter; (Cumulus would take the first one it found, and that might not be the last one you edited!)

Structure of Cumulus.ini

The file is divided into "File sections" (see terminology definitions below), each File section name is on a separate line (with no other content) and enclosed in square brackets (e.g. [Station]).

These File sections can appear in any order, by default new File sections are appended after all previous File sections, but if you prefer the File sections in another order, MX can still find them, although it may spend more time searching!

Within each File section, there are parameters. Each parameter is in format Attribute=Value, and appears on a line to itself.

The parameters, within a File section, can be in any order, by default new parameters are appended at end of the relevant File section.

How this Wiki page classifies settings

This new Wiki page is no longer designed around the way parameters appear in the file, as earlier pages with this name were. Here are some of the reasons:

  1. Settings can appear in any order in the file, but it is easier to find them on this page if they are listed alphabetically
  2. Releases might add new parameters, or remove old parameters, so looking at a file does not identify which parameters need to be explained on this page
  3. Releases might add new sections in the file, or remove old sections in the file, so organising this page by those "File sections" no longer makes sense
  4. The settings interface in MX is being comprehensively redesigned. That means this documentation cannot be organised by the way MX organises its settings pages.
    • To clarify that reason, if this Wiki page was organised according to the Settings Screens that applied say at release 3.8.0, a different sequence might be required in say 3.12.0 because that changed the Settings Screens.

Some classification is still needed to help you the reader find settings, only you can judge whether the grouping here suits you! In creating this page, I have tried to think of a way to group various settings and arranged those groups alphabetically, to make navigation as easy as I can.

Of course if you have your own ideas of a better way to group the documentation here, you are welcome to implement your preference, by editing this page.

Tabular presentation

Within the groupings I have selected, individual settings are normally presented as rows in tables for clarity on this Wiki page. The individual tables can have up to 7 columns. The columns can explain for each setting:

  • Where in the admin interface you edit it (MX page and MX section in terminology below)
  • Whether the Setting is always shown on the Settings Page ("Always" is shown), or is only shown if an earlier Setting has a particular selection (dependency is shown)
  • What File Section (in terminology below) it appears in with the file (always appears, and is shown, between square brackets)
  • The attribute name used for the parameter in the file (always shown with an equals sign after it)
  • Which release introduced the setting(s)
  • What is the default value for the parameter, (and what that default value means)
  • A description of what the parameter represents, and what values it can take

If the content of any column would be same for every row, then that column is omitted, and the relevant information is instead stated before the table.

Exceptions to above table styling:

  1. MQTT parameters are handled slightly differently, as they did not fit that standard layout
  2. The mean temperatures, and normal rainfall figures, with one parameter per month, have been presented as text, rather than a table for simplicity
  3. For the Extra Web Files Settings page, where the settings page uses editable grid software, instead of listing all 800 settings individually, the table here is split into just 8 rows, each of which applies to 100 parameters in the file.


Terminology used on this Wiki Page

Terminology What it means
Qualifications:
  • Settings page
  • Wiki page
 Because "page" could refer to either this page or the Settings page, page will always be qualified
Shown on Settings page? Sometimes whether you see a particular setting on the Settings Page, depends on a previous selection has been made, that is explained under this heading
MX Section Under this heading you will find how to navigate to the relevant setting within the admin interface. This covers the page where you edit the setting, followed by →, and then the section (and sub-section where relevant) that you have to select to see the setting

Each MX section on the Settings page has to be opened individually (by either a button for maximum accessibility, or a Click ▶to expand, click ▼ to collapse for alternative styling).

Label on Settings page Under this heading you will discover how MX labels the individual setting where you edit that setting
File Section Within the file, a number of section headings are used, to gather multiple parameters together. Thus under this heading, for each setting, the table shows the File Section where the parameter will be stored
Parameter Line Entry Within the file each setting is represented by a parameter in format attribute=value on a line to itself without any punctuation symbols. If the parameter has a default value, that is shown here and explained in next column
Default This is the value (if any) that the individual setting takes when it has not been amended. Some parameters do not have a default value and "(none)" will be shown in this case. No brackets surround literal text representing default value, which is normally also seen in Parameter Line Entry. In general, round brackets are used in Default column to indicate an explanation.
Description Under this heading you will find an explanation of the setting including (where relevant) what values it can take

When, and How, does MX read the Configuration File?

Whenever MX is restarted, it reads the latest Cumulus.ini and if it exists strings.ini (briefly mentioned below); from these one (or two) file(s), it learns the configuration that you want it to use.

Essentially, MX reads the whole file, for each attribute part of a parameter in the file, there is a variable stored within the MX code. So the value part of each parameter is assigned to the respective variable. Hence MX will not permit any duplicates for any parameter. If MX finds a parameter it does not understand, it ignores that parameter.

This means a Cumulus.ini file created by the legacy software, or by an old release of MX, can still be read by the current release of MX, as it just ignores all the obsolete parameters. However, since MX now has a lot of new parameters in the file, that were not in the legacy file, nor in a file created by an early MX release, it is often easier to start again with a new configuration file, as explained later, to ensure the configuration of MX is correct for you.

MX also creates a backup copy of "Cumulus.ini" in a sub-folder of Backup folder that is named according to current date and time.

What MX finds in your "Cumulus.ini" does of course determine what you see when you open any of the Settings pages, in the admin interface. This is because the displaying of some settings is dependent on another setting.

For completeness I mention here, configuration information for MX can also be stored in an optional file strings.ini, that is used to identify how various standard output phrases are to be modified to suit you.

Settings Configuration for MX

The MX software offers much functionality and flexibility. Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting.

Please see First Run of MX for how to set up settings when you first use MX.

What happens if I upgrade MX?

If you upgrade to a newer MX build, as that release distribution does not contain a "Cumulus.ini", you cannot lose your settings entered in your existing file. However, be aware that a new release may remove some settings, and add new settings, hopefully the release announcement will give specific details. Otherwise, you will need to work through all the Settings Pages, and all the "MX Sections" (see Terminolgy above)

Where do I change settings?

The current design of MX expects that Cumulus Users will never need to edit the "Cumulus.ini" file directly, as there are a number of settings pages in the admin interface and users are expected to use those Settings pages to amend the individual MX settings.

Please see MX_Administrative_Interface#Changing_Settings for basic information, including how to load the admin interface (sometimes called the "dashboard interface" or "user interface").


Furthermore, at the end of each (meteorological) day, MX creates a back-up in the backup/daily/TIME_NAME sub- folder. The TIME_NAME is constructed from a string of digits representing the date and time the directory was created (without any punctuation) e.g. 20060519090000. In that folder, recent MX releases, include a copy of the current "Cumulus.ini" file.

Do I need to restart MX?

If you change a setting directly in the file, you must stop MX beforehand. The setting takes effect when you restart MX.

If you change a setting, using the admin interface, it may, or may not, take effect immediately...

The settings available on the various pages in the admin interface fall into two groups:

  1. SETTINGS THAT TAKE EFFECT IMMEDIATELY ON CLICKING “SAVE”
  2. SETTINGS THAT ONLY TAKE EFFECT WHEN MX IS RESTARTED

There used to be a third group. Before Release 3.11.2 - build 3131 a few changes made in the interface were not saved into "Cumulus.ini", and those few settings were therefore lost when MX was restarted. One example of these former exceptions was that the former action selecting adding extra debugging information to file in MXDiags folder was previously not saved for subsequent session.

For the current MX release, any change made (on any settings page) will be saved into "Cumulus.ini", and will still apply when MX is restarted. That restart will ensure all settings changed in the last session do take effect, even those that did not take effect before the restart.

Unfortunately, there is no documentation available from developer on which settings, at any release, do not take effect until MX is restarted. We do know that you need to do a restart after choosing the station model, and that is unlikely to change.

In early MX releases most configuration settings required a restart of MX before they took effect, but since then in some releases, certain settings that used to require a restart have been changed so they take effect intermediately. It is anticipated, as MX develops, the majority of settings will become ones that take effect without a restart of MX.

This means that any attempt to document here which changes do require a restart of MX is working against a moving target. Consequently, this documentation does not indicate where a restart is required. You can either play safe, and restart MX each time you finish making edits to settings, or you can read all the support forum announcements, and see if you can find any information about whether a restart is needed, for whatever particular settings you are changing, at the release you are using.


How to Remove Redundant parameters from file

If you have been using Cumulus for a while, there might be parameters that are now obsolete left in your configuration file.

MX will ignore any parameters that it no longer recognises, but there is a simple way to make MX create a new file for you, keeping your existing settings, but ensuring the new file does not have any obsolete parameters.

The following procedure is best done after, not before, you upgrade MX, as installing a new release might add/remove parameters to/from "Cumulus.ini".

Apart from that upgrade consideration, you can start afresh with a new file anytime by following this very simple procedure:

You must do this while keeping Cumulus MX running (to preserve existing settings)...

  1. Rename your existing Cumulus.ini to say Cumulus.ini.sav (this keeps the file, but stops MX finding it)
  2. In Cumulus go to one of the settings screens, (e.g. Program Settings which is currently a short page) – simply click ‘’’Save Settings’’ (i.e. any action that makes MX save settings to its configuration file)
    • It is possible this might highlight a new parameter that does not yet have a valid value (e.g. the Alarm settings page, which uses ‘’’Enable Alarms’’’ rather than "Save settings", got extra settings without defaults at 3.11.0).
  3. Cumulus (if it accepts that save) will now create a brand new Cumulus.ini file,
  4. This will have all the settings you have chosen
  5. They will now be in the order MX is expecting
    • MX default sort order is from where entries are set in the code, and that is far from alphabetic!
  6. As MX is unaware of settings it used previously, but does not use now, (and MX is unaware of what settings the legacy software used), it won’t write back any redundant settings in the new configuration file.

As well as changing the order in which parameters are stored, this re-generation may show up other changes (if you do have reason to examine the new file and compare with the old file):

  • A major change is likely in the '''[Station]''' section as that has seen a lot of changes as MX is developed.
  • The ’’’[Graphs]]’’’ section has also seen a number of changes as MX has developed.
  • The most dramatic change may happen in '''[FTP Site]''' as any reorganisations to the list of parameters for Extra Web Files are reproduced 100 times.

Editing the file directly

At the time of writing this, the work to code up MX settings pages is not yet completed.

So the Settings Pages could not modify all the parameters, that can appear in the file and get used by MX. Therefore, there were still some settings that could only be amended by stopping MX, then editing the relevant parameter in the file directly, before restarting MX.

However, it is likely that in a few releases time, there will be no necessity to directly edit the file.

That said, working through the various settings pages, and all the options (often within multiple MX sections) can be laborious. Consequently, those with some understanding of the file contents may still wish to make some changes with MX stopped, by editing the file. The only caution that needs to be stressed is "be careful"; as this editing the file directly bypasses any validation that is done when using the Settings Pages, and so might result in an inconsistent set of parameters, and (in the worse case) perhaps a software crash.

An example of why you might edit file instead of using Settings Page

If (for example) you find the Extra Web Files editor hard to use, you might decide to stop Cumulus MX and still edit this configuration file directly for changes to those parameters. Given that MX ignores any parameter it does not understand, while editing the file, you can temporary have old and new parameters in the file. All you need to do is prefix those parameters you don't want MX to use with any character you like before the "Extra" in the attribute name.

When MX adds new parameters to file

In theory, there is no reason why you should manually add any extra parameters directly into the file.

Since MX creates, and edits, the file, it should ensure all parameters it understands are in the file.

When this new page was being created, some of the parameters in the file that MX understands, could not be matched to any known setting in the Settings Interface pages, but it may be a future release will correct that.

If a new release of MX adds new parameters, then:

  • If the new parameter has a valid default value, MX will work perfectly using that default value.
    • You won't need to know the parameter exists, unless you decide to change it, and find out what values it can take either in a drop-down on the relevant Settings page, or in the relevant table below.
  • Other new parameters may be given an initial illegal value, because MX cannot guess what value will work for you.
    • This is to enforce the need to give these parameter a valid value before MX will allow you to save settings.
      • Sometimes, MX will not do any weather data processing, until these ‘’’missing’’’ values are edited.
      • In other cases, you might not realise that your file is missing one or more parameters, unless you go into the relevant Settings page, and find you can't save (Enable for Alarms page).

In practice, as already mentioned, there might be a parameter that you need to get MX working correctly for you, but have to add directly to the file as (at the release you are using) that setting has not yet been added to any Settings page.

Before this page actually lists all the settings I know of, let me give an example of a seting with a valid default, and an example of a setting that has an invalid default:

Example of new Parameter with valid default

When accessibility was added, its parameter defaulted to the old expand/contract sections design (see first table below).

You can, optionally, go into "Program Settings" or "Station Settings" pages, where you tick the box to get the (more accessibility friendly) selection button alternative.

Example of new Parameters with no valid initial value

As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file. You could use MX without these new parameters, but the Alarm Settings page would not allow you to click Enable until you had defined various settings on another Settings page, as well as on this Alarm Settings page.

Tables listing Settings

Accessibility

  • Introduced Release 3.10.0 - build 3115
  • File Section is [Program]
Parameter Line Entry MX Section Label on Settings page Default Description
EnableAccessibility=0 Two places where you can edit this setting:
  • (Either) Program Settings → (First tick box)
  • (Or) Station Settings → (First tick box)
 Enable accessibility features 0 (disable) Determines styling of settings pages:
  • Set to 1 to make this (and other pages) appear in a button selection style (more friendly on an accessibility basis).
  • Leave it at zero for a Click ▶to expand, click ▼ to collapse styling.

Alarms (and emails)

The Alarm settings seem to frequently be changed by new MX releases, so have been moved to a separate wiki page where hopefully it will be easier for somebody to keep the content updated in future.

Charts

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

Charts have evolved rapidly in MX development, this table needs verification by somebody who uses the functionality documented here. Can you be the contributor to bring it up to date?

Parameter Line Entry File Section Introduced MX Section Label on Settings page Default Description
GraphHours=24 [Graphs] Legacy Cumulus Station Settings → Graphs Graph hours 24 (2 rolling days worth of values) For those plots that show values (if available) minute by minute, how many days back to go. Some people prefer to set this to 48 or 96, that means uploading a lot more data in the .json files, but it shows more on charts
AppTempVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Apparent temperature Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Australian Apparent Temperature plotted on Charts
BaseTemperature1= [GrowingDD] and [TempSum] Release 3.11.0 - b3129 Station Settings → Growing Degree Days Base temperature #1 Depends on selected temperature units (not quite same)
  • (Celsius) 5 (equivalent to 41 oFahrenheit)
  • (Fahrenheit) 40 (equivalent to 4.44 oCelsius)
 Base temperature for series 1
BaseTemperature2= [GrowingDD] and [TempSum] Release 3.11.0 - b3129 Station Settings → Growing Degree Days Base temperature #1 Depends on selected temperature units (equivalent)
  • (Celsius) 10
  • (Fahrenheit) 50
 Base temperature for series 2
Cap30C=1 [GrowingDD] Release3.11.0 - b3129 Station Settings → Growing Degree Days Cap GDD at 30°C / 86°F Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want growing degree days capped and not incremented at high temperatures (threshold shown in setting name)
ChartMaxDays=31 [Graphs] Legacy Cumulus Station Settings → Graphs Graph Days 31 (daily values) For those plots that show recent daily values, this states how many of them to plot
Colour0=#058DC7, Colour1=#50B432, Colour2=#ED561B, Colour3=#DDDF00, Colour4=#24CBE5, and Colour5=#64E572 [Select-a-Chart] Release 3.9.7 - b3107 ??? ??? Hex colours as shown in parameter list Colour of line used for plotting the respective series
DailyAvgTempVisible=1 [Graphs] Release 3.11.0 - b3129 Station Settings → Graphs → Visibility → Temperature Data Daily Average Temperature Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Daily (integrated) Average temperature plotted on Charts
DailyMaxTempVisible=1 [Graphs] Release 3.11.0 - b3129 Station Settings → Graphs → Visibility → Temperature Data Daily Maximum Temperature Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Daily Maximum temperature plotted on Charts
DailyMinTempVisible=1 [Graphs] Release 3.11.0 - b3129 Station Settings → Graphs → Visibility → Temperature Data Daily Minimum Temperature Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Daily Minimum temperature plotted on Charts
DPVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Dew Point plotted on Charts
FeelsLikeVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Feels Like Temperature plotted on Charts
GrowingDegreeDaysVisible1=1 [Graphs] Release3.11.0 - b3129 Station Settings → Graphs → Visibility → Degree Days Growing Degree Days series #1 Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see series 1 plotted on Charts
GrowingDegreeDaysVisible2=1 [Graphs] Release3.11.0 - b3129 Station Settings → Graphs → Visibility → Degree Days Growing Degree Days series #2 Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see series 2 plotted on Charts
HIVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see USA Heat Index plotted on Charts
HumidexVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Canadian Humidity Index plotted on Charts
InHumVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Humidity Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Indoor Relative Humidity plotted on Charts
InTempVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Indoor Temperature plotted on Charts
OutHumVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Humidity Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Outdoor Relative Humidity plotted on Charts
Series0= to Series5= [Select-a-Chart] Release 3.9.7 - b3107 ??? ??? 0 (disabled) Name of parameter to plot (in series 0 to 5) e.g. "Pressure", "Wind Gust", "Temperature", "Rainfall Rate", "Wind Bearing"
SolarVisible=1 [Graphs] MX release 3.10.0 Station Settings → Graphs → Visibility → Solar Data UV Index Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Solar radiation plotted on Charts
SunshineVisible=1 [Graphs] MX release 3.10.0 Station Settings → Graphs → Visibility → Solar Data UV Index Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Sunshine Hours plotted on Charts
TempSumVisible0=1 [TempSum] Release 3.11.0 - b3129 Station Settings → Annual Temperature Sum Annual Temperature Sum 0 Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Annual Temperature Sum series 0 plotted on Charts
TempSumVisible1=1 [TempSum] Release 3.11.0 - b3129 Station Settings → Annual Temperature Sum Annual Temperature Sum #1 Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 1 plotted on Charts
TempSumVisible2=1 [TempSum] Release 3.11.0 - b3129 Station Settings → Annual Temperature Sum Annual Temperature Sum #2 Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 2 plotted on Charts
TempSumYearStart= [TempSum] Release 3.11.0 - b3129 Station Settings → Annual Temperature Sum Year summation starting month Depends on hemisphere
  • (Northern hemisphere) 1 = January
  • (Southern hemisphere) 7 = July
 Enter as a number the month for which (on first of that month) annual temperature summation is reset to zero
TempVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Outdoor Temperature plotted on Charts
UVVisible=1 [Graphs] MX release 3.10.0 Station Settings → Graphs → Visibility → Solar Data UV Index Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Ultra Violet Index plotted on Charts
WCVisible=1 [Graphs] MX release 3.7.0 - b3089 Station Settings → Graphs → Visibility → Temperature Data Dew point Ticked (shown in Cumulus.ini as 1) Simple tick or not indicating whether you want to see Wind Chill plotted on charts
YearStarts= [GrowingDD] Release 3.11.0 - b3129 Station Settings → Growing Degree Days Growing season starting month Depends on hemisphere
  • (Northern hemisphere) 1 = January
  • (Southern hemisphere) 7 = July
 Enter as a number the month for which (on first of that month) Growing degree days is reset to zero

Data Logging

  • Available in all Cumulus releases
  • File Section is [Station]
Parameter Line Entry Shown on Settings page? MX Section Label on Settings page Default Description
DataLogInterval=2 (Always) Station settings → General Settings Log interval 2 (10 minutes) Drop-down:
  • 0 = 1 minute between MX logs into the one to three Monthly_log_files (i.e. Standard log files, and optionally Extra Sensor Files, Air_Link_Log.txt)
  • 1 = 5 minutes between MX logging lines
  • 2 = 10 minutes between MX logging lines
  • 3 = 15 minutes between MX logging lines
  • 4 = 20 minutes between MX logging lines
  • 5 = 30 minutes between MX logging lines
LogExtraSensors=0 (Depends on station type) Only from Release 3.12.0 Station settings → Common Options Extra sensors 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if your weather station can output readings to be logged in Extra Sensor Files
  • Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files.
NoSensorCheck=0 (not yet on a settings page) (not known) (not known) 0 (normal) Boolean:
  • 0 = MX will stop if any of the minimum set of sensors listed below fails
  • 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails

Minimum set of sensors:

  1. Current air temperature
  2. Current Relative Humidity
  3. At least one wind speed
  4. Current air pressure (absolute or sea-level)

Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these).

RainDayThreshold=-1 (with warning: "Here be dragons!") Depends on release:
  • (3.5.1 to 3.11.4) Manual edit of file
  • (3.12.0 onwards) Station settings → Common Options → Advanced options
 Rain day threshold -1 (that represents 0.2 mm or 0.01 inches) The amount of rainfall that must be collected before MX treats today as a wet day

The intention is this will represent more than one tip, as the first tip might contain some rain from an earlier day

RolloverHour=0 (Always) Station settings → Log Rollover Time 0 (midnight) Radio type selection:
  • 0 = MX will do an end of day process when the time (on Weather Station if it provides time) reaches midnight
  • 1 = MX will do an end of day process when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time
SnowDepthHour=0 (with warning: "Here be dragons!") Depends on release:
  • (3.5.1 to 3.11.4) Manual edit of file
  • (3.12.0 onwards) Station settings → Common Options → Advanced options
 Snow depth hour 0 (midnight) Spin selector of 0 to 23: Defines hour from which entries in Weather Diary for current calendar day are used. Prior to this hour the weather diary will be searched for Calendar yesterday
StartDate= (with warning: "Here be dragons!") Station Settings → Common Options → Advanced Options Records Began date (Set when you first use Cumulus) Format used is determined by locale used for running MX. If this date is edited, keep to same format. MX generally (see Calculate_Missing_Values#CreateMissing.exe for exceptions) ignores any data file entries prior to this date.
UseDataLogger=1 (probably determined by station type) (not known) (not known) 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if your weather station has its own storage, so MX can do a catch up when it first starts and read any "archive data"
  • Don't tick (value shown as 0 in Cumulus.ini) if your weather station has no storage, and therefore MX cannot capture any readings when it is not running
Use10amInSummer=1 (Always) Station settings → Log Rollover Use 10am in Summer 1 (normal) Tick box:
  • 0 = If "Daylight Saving Time" (DST) applies in Summer,
    • If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
    • If rollover time is 9 a.m., MX is to use 9 am local time, regardless of whether DST is in operation or not
  • 1 = Normal behaviour:
    • If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
    • If MX would do an end of day process when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time, then it waits until 10 a.m. local time while DST is in effect


Debugging

  • Available from beta MX.
  • File Section is [Station]
Parameter Line Entry MX Section Label on Settings page Default Description
Logging=1 Depends on release installed:
  1. Alternatives:
    • (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
    • (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
  2. (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
  3. (Release 3.12.0 onwards) Program Settings → Logging Options
 Debug logging 0 (disabled) This adds extra information about data transfers between your weather station and MX.

It was introduced originally for Davis stations only, but later (can someone insert here the relevant release) extended to cover more stations.

DataLogging=1 Depends on release installed:
  1. Alternatives:
    • (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: DataLogging = 1, then restart Cumulus MX.
    • (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
  2. (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
  3. (Release 3.12.0 onwards) Program Settings → Logging Options
 Debug logging 0 (disabled) This adds extra information about both data transfers initiated from MX, and all the internal MX processes.

Extra Web Files

There are 100 occurrences of each parameter in Cumulus.ini, and therefore each parameter has a base name followed by numbers 0 to 99.

The settings interface presents the rows on multiple pages, the rows are not numbered, so you have to do some counting to work out which row in the admin interface page corresponds with which parameter in Cumulus.ini file.

You MUST restart MX after any changes in this section, before the new settings take effect.

Parameter Line Entry Label on Settings page Default Description
[FTP site] Section name
ExtraLocal0= to ExtraLocal99= Local File Name (empty) You can enter:
  • A relative path name, with respect to the "CumulusMX" root folder
  • A full path name for a file on the computer running MX
    • e.g. /home/pi/documents/myFile
    • e.g. C:\Users\Public\Documents\working.txt
  • You can place any of the following special tags into the entry
    • These should be typed as shown on their own
      • <noaayearfile> and <noaamonthfile> these respectively represent latest yearly and latest monthly reports
      • <currentlogfile>, <currentextralogfile>, and <airlinklogfile> these respectively represent standard, extra sensor, and Davis AirLink air quality monitor log files e.g. ExtraLocal3=<currentlogfile>
ExtraRemote0= to ExtraRemote99= Destination Filename (empty) Defines where MX is to upload file to
  • If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
    • I can't tell you what the file path is for your web server, but I can give a couple of examples to steer you
      • e.g. httpdocs/dayfile.txt
      • e.g. public_html/thismonthyear.htm
  • If the FTP is not ticked, the file path should be full path for a file on the computer running MX
    • e.g. /var/www/html/weather/images/moon.png could be destinatation for uploading the MX generated moon image to a Linux hosted server
    • e.g. /var/www/html/weather/webfilesMX/tempdata.json for uploading one of the files with graph data to a Linux hosted server
  • You can place any of the following special tags into the entry
    • These should be typed as shown as part of the destination path, note that they can be used:
      • either to represent the final filename part of the path e.g. ExtraRemote3=/var/www/html/weather/monthly/<currentlogfile>
      • or to modify a filename, so it becomes unique to a particular month e.g. ExtraRemote0=/var/www/html/weather/cumulus_generated/savedFiles/web_tags_real_time_<currentlogfile>.inc
    • <noaayearfile> and <noaamonthfile> these respectively represent latest yearly and latest monthly reports
    • <currentlogfile>, <currentextralogfile>, and <airlinklogfile> these respectively represent standard, extra sensor, and Davis AirLink air quality monitor log files
ExtraProcess0= to ExtraProcess99= Process 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if the local file is a template file, see here for full explanation of Process
  • Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
ExtraRealtime0= to ExtraRealtime99= Realtime 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if
    1. See #Realtime Settings, you must have "Enable realtime" ticked, and defined an interval there
    2. Uploads the file to destination specified at interval defined
  • Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. Standard interval)
ExtraFTP0= to ExtraFTP99= FTP 1 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in #Web/FTP Site
  • Don't tick (value shown as 0 in Cumulus.ini) if the remote file is on the computer running MX and a simple Copy File is required
ExtraUTF0= to ExtraUTF99= UTF-8 1 Please see technical guidance on encoding
  • Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters
  • If unticked (0 appears in file), then iso-8859-1 encoding is used
ExtraBinary0= to ExtraBinary99= Binary 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
  • Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
ExtraEOD0= to ExtraEOD99= End of Day 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the End of Day process
  • Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. Standard interval)

Location

  • Introduced for legacy Cumulus
  • File Section is [Station]
Parameter Line Entry MX Section Label on Settings page Default Description
Altitude=0 Station Settings → Location Altitude 0 The height above mean sea level where the (pressure) sensor is positioned
AltitudeInFeet=1 Station Settings → Location Altitude Units Default depends on release:
  1. Legacy until 3.11.4: 1 (labelled as feet)
  2. From 3.12.0: 0 (labelled metres)
 Radio Setting
  • feet (value shown as 1 in Cumulus.ini)
  • metres (value shown as 0 in Cumulus.ini)
LocName= Station Settings → Location Name (empty) A short name for the location
LocDesc= Station Settings → Location Description (empty) A longer description for the location
"Latitude=0" and "LatTxt=" Station Settings → Location → Latitude "Degrees", "Minutes", "Seconds", and "Hemisphere → North or South" (blank) The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
"Longitude=0" and "LongTxt=" Station Settings → Location → Longitude "Degrees", "Minutes", "Seconds", and "Hemisphere → East or West" (blank) The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file


Optional Report Settings

  • File Section is [NOAA]
Parameter Line Entry Introduced MX Section Label on Settings page Default Description
AutoCopy=0 Release 3.12.0 NOAA Reports Settings → FTP Options Auto Copy NOAA report files 0 (disable) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if your report is to be copied to copy directory during the End of Day process
  • Don't tick (value shown as 0 in Cumulus.ini) for no copy action
AutoFTP=0 First with Cumulus 2 NOAA Reports Settings → FTP Options Auto transfer NOAA report files 0 (disable) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) to enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
AutoSave=1 First with Cumulus 2 NOAA Reports Settings Create NOAA files after daily rollover 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality
  • Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required
City= First with Cumulus 2 NOAA Reports Settings → Site Details City (empty) Enter here your hamlet, village, town, or city, name
CoolingThreshold=22 First with Cumulus 2 NOAA Reports Settings → Thresholds Cooling threshold 65o F or 18.3oC Cold Degree Days are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. An international standard says 22 oCelsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in Cumulus 2 (enhancement request 44), and that was done to match some early look up tables.
CopyDirectory= Release 3.12.0 NOAA Reports Settings → Report Options Copy Directory (empty) The folder on the web server you host to which reports are to be copied
FTPDirectory= First with Cumulus 2 NOAA Reports Settings → FTP Options destination folder Depends on release:
  • (3.1.0 to 3.11.4) blank
  • (3.12.0 onwards) to match change in default web site script specification of Reports folder
 Specify the destination folder for file transfer to, on your FTP server
  • Leave at default (for your release) and MX will work with the default web pages script supplied (at same release)
  • Specify a folder relative to FTP root, and MX will upload reports to that folder instead (you are then responsible for writing any script on your web site to find each report and do any processing).
HeatingThreshold=15.5 First with Cumulus 2 NOAA Reports Settings → Thresholds Heating threshold 65o F or 18.3oC Heating Degree Days are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. An international standard says 15.5 oCelsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in Cumulus 2 (enhancement request 44), and that was done to match some early look up tables.
MaxTempComp1=22 First with Cumulus 2 NOAA Reports Settings → Thresholds Max temp comparison 1 (empty) The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit
MaxTempComp2=0 First with Cumulus 2 NOAA Reports Settings → Thresholds Max temp comparison 2 (empty) The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit
MinTempComp1=15.5 First with Cumulus 2 NOAA Reports Settings → Thresholds Min temp comparison 1 (empty) The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit
MinTempComp2=0 First with Cumulus 2 NOAA Reports Settings → Thresholds Min temp comparison 2 (empty) The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit
MonthFileFormat='NOAAMO'MMyy'.txt' First with Cumulus 2 NOAA Reports Settings → Output Files Monthly filename format 'NOAAMO'MMyy'.txt' (note quotes round NOAAMO and round .txt) Here you specify the filename template for MX to use when reading, or writing, monthly reports

There is a prefix text in quotes,then comes a way to specify months (see Reports_folder#NOAA_style_Report_Naming), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid.

Name=Personal Weather Station First with Cumulus 2 NOAA Reports Settings → Site Details Site Name (empty) What you would like to see in report title for your station name
NOAAUseUTF8=1 First with Cumulus 2 NOAA Reports Settings → Report Options Use UTF-8 encoding 1 (UTF-8) Please see Reports_folder#Encoding
  • Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the o degree symbol
  • If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the o degree symbol is coded differently
RainComp1=0.5 First with Cumulus 2 NOAA Reports Settings → Thresholds Rain comparison 1 (empty) The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold
RainComp2= First with Cumulus 2 NOAA Reports Settings → Thresholds Rain comparison 2 (empty) The report will count the number of days when the daily rainfall exceeds this threshold.
RainComp3= First with Cumulus 2 NOAA Reports Settings → Thresholds Rain comparison 3 (empty) The report will count the number of days when the daily rainfall exceeds this threshold.
State= First with Cumulus 2 NOAA Reports Settings → Site Details State (empty) Enter here your local authority area or region (state in USA)
UseDotDecimal=0 Release 3.9.5 - b3100 NOAA Reports Settings → Report Options Use a 'dot' decimal point 0 (disable) Formatting real numbers for when NOAA report parsed by a script

Simple tick or not

  • Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma
  • Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale
UseMinMaxAvg=0 Release 3.12.0 NOAA Reports Settings → Report Options Use WHO average or Integrated average 0 (integrated average) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2
  • Don't tick (value shown as 0 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use integrated calculation: Sum of all temperature measurements divided by count of measurements
YearFileFormat='NOAAYR'yyyy'.txt’ First with Cumulus 2 NOAA Reports Settings → Output Files Yearly filename format 'NOAAYR'yyyy'.txt' Here you specify the filename template for MX to use when reading, or writing, yearly reports

There is a prefix text in quotes,then comes a way to specify months (see Reports_folder#NOAA_style_Report_Naming), and finally comes the mandatory text extension.

12hourformat=0 ??? NOAA Reports Settings → Output Files Time format 0 (24 hour) How times are output on reports
  • 24 Hour (value shown as 0 in Cumulus.ini)
  • 12 Hour (value shown as 1 in Cumulus.ini)


Normal Mean Temperatures

  • File Section is [NOAA]
  • The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
  • There is one box labelled for each month on the settings screens
  • All the defaults are (blank)
  • What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements

Normal Precipitation

  • File Section is [NOAA]

Rainfall equivalents of mean temperature described above


Optional Structured Query Language Settings

MX uses a software package called "MySqlConnect" to run SQL queries.

Since the text that appeared here was added, documenting plans for the future 3.12.0 release, there have been a number of changes, and now a future release (3.20.0) is expected to make more drastic changes. Therefore the content has been moved to a new "MySqlConnect" page where it is hoped somebody will find it easier to update the content as MX develops.


Optional Third-party Upload Settings

Parameter Line Entry File Section MX Section Action on Settings page Default 
ID=
pass=-1
server=cwop.aprs.net
port=14580
Enabled=0
Interval=9
SendSR=0
APRSHumidityCutoff=0
 [APRS] APRS/CWOP Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters 
User=
 Password=
 Language=en
 Enabled=0
 Interval=900
 SendUV=0
 SendSR=0
 SendSoilTemp=0
 SendIndoor=0
 SendSoilMoisture=0
 SendLeafWetness=0
 SendAirQuality=0
 [Awekas] AWEKAS Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters 
Enabled=0
 CatchUp=1
 APIkey=
 StationId=
 Interval=15
 [OpenWeatherMap] OpenWeatherMap Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters 
ID=
 Password=
 Enabled=0
 Interval=15
 SendUV=0
 SendSR=0
 CatchUp=1
 [PWSweather] PWS Weather Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters 
User=
 Password=
 Enabled=0
 Interval=60
 OauthToken=unknown
 OauthTokenSecret=unknown
 TwitterSendLocation=1
 [Twitter] Twitter Please note that twitter is deprecated, no new settings possible, existing settings can be used by people who migrated from Cumulus 1 with working tokens Defaults are as shown in list of parameters 
Wid=
 Key=
 Enabled=0
 Interval=10
 SendUV=0
 SendSR=0
 SendAQI=0
 SendSoilMoisture=0
 SoilMoistureSensor=0
 SendLeafWetness=0
 LeafWetnessSensor=0
 [WeatherCloud] WeatherCloud Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters 
Enabled=0
 StationUID=
 Password=
 Interval=1
 SendRain=0
 [WindGuru] Windguru Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters 
APIkey=
 StationIdx=0
 Enabled=0
 Interval=15
 SendUV=0
 CatchUp=1
 [Windy] Windy.com Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters 
ID=
 Password=
 Enabled=0
 Interval=15
 SendUV=0
 SendSR=0
 CatchUp=1
 [WOW] Met Office WOW Tick "Enabled" to see list of parameters so you can edit them Defaults are as shown in list of parameters

Optional Web Server

There are two sub-sections below, because the settings for the optional web functionality are split between Station Settings and Internet Settings.


Display Options controlling what appears on default web pages

  • File Section is [Display]
  • MX Section is Station Settings → Display Options
Parameter Line Entry Introduced Label on Settings page Default Description
DisplaySolarData=0 ??? 3.10.0 ??? Display Solar data Unticked (shown as 0 in Cumulus.ini) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if you want MX to display solar data in tables shown on the web pages provided in webfiles folder (from release 3.10.0 onwards)
  • Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data
DisplayUvData=0 ??? 3.10.0 ??? Display UV-I data Unticked (shown as 0 in Cumulus.ini) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if you want MX to display ultra-violet intensity data in tables shown on the web pages provided in webfiles folder (from release 3.10.0 onwards)
  • Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display UV intensity data
NumWindRosePoints=16 Legacy Cumulus Number of wind rose points 16 Drop-down determining if weather station bearing supplied by weather station is to be converted to 8 or 16 compass directions (i.e. whether to include or exclude (in English) NNE, ENE, ESE, SSE, SSW, WSW, WNW, and NNW
  • 8 points
  • 16 points

Despite what it says in the hint on the settings page, leave at default whichever weather station type you use, unless this actually causes you a problem. The parameter was introduced by Steve Loft. Davis wind vanes use a potentiometer to measure wind direction so send Cumulus a bearing that can vary continuously between 1 and 360 degrees. Fine Offset wind vanes use magnetic switches that depend on the magnet under the moving part selecting two switches in the fixed part for the vane being exactly in-between compass directions, and selecting one switch for the main 8 directions and slightly away from the main directions; so they have a bias against sending Cumulus the in-between directions.

UseApparent=1 ??? MX 3.6.0 or 3.10.0 ??? Use Apparent Temperature Ticked (shown as 1 in Cumulus.ini) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) if you want MX to display apparent temperature in tables shown on the web pages provided in webfiles folder (from release 3.10.0 onwards) for consistency with Cumulus prior to release 3.6.0
  • Don't tick (value shown as 0 in Cumulus.ini) if you want MX to display feels like temperature in tables shown on the web pages provided in webfiles folder (from release 3.10.0 onwards) for consistency with Cumulus from release 3.6.0


File transfer and Copy Options controlling transfer of data to default web pages

The settings listed in table below changed dramatically at both 3.10.0 and 3.12.0 releases, but they have gradually evolved throughout the development of MX.

From 3.12.0, MX can optionally either copy files to a web server you host or file transfer files to a commercial web server.

To implement (and customise) this web server functionality, there are many settings as listed alphabetically in this table. The Internet settings page simplifies making settings by providing selections that amend multiple settings in a bulk operation:

  • Some settings (marked ^ in table) are only displayed if you select I want to use the supplied default web site.
    • For these settings, the "Generate" option is enabled in nearly all (see any qualifier) settings
    • If you select "Enable file copy of standard files" (default is disabled) then those settings have their "Copy" option enabled in nearly all (see any qualifier) cases, and their "FTP Transfer" option deselected (instead of defaults shown in table)
    • If you deselect "Enable file transfer of standard files" (default is enabled) then those settings have their "Copy" option disabled, and their "FTP Transfer" option enabled in nearly all (see any qualifier) cases (as per defaults shown in table)
  • The default selections assume you have air quality, and solar, sensors; so you may need to disable some of the defaults the above selections have made
  • If you don't select I want to use the supplied default web site, then all the settings marked ^ are disabled
    • This is what you want if you do not use the MX optional web server functionality
    • If you have a customised web site, you may want to select I want to use the supplied default web site to see the settings that would otherwise all be disabled, and then pick any options that would be useful to you.
Parameter Line Entry File Section Introduced Shown on Settings page? MX Section Label on Settings page Default Description
ActiveFTP=0 [FTP site] Legacy Cumulus No Change directly in file as at release 3.11.x (n/a ) (n/a) *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.
Copy-airquality=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings airquality.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
Copy-alldailydegdaydata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailydegdaydata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailydegdaydata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-alldailyhumdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailyhumdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailyhumdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-alldailypressdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailypressdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailypressdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-alldailyraindata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailyraindata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailyraindata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-alldailysolardata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailysolardata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailysolardata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Copy-alldailytempdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailytempdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailytempdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-alldailywinddata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailywinddata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailywinddata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-alltempsumdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings alldailytempsumdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the alldailytempsumdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-availabledata=0 [FTP site] Release 3.12.0 ^ (once only) Internet Settings → Graph File Settings availabledata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the availabledata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-dailyrain=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings dailyrain.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the dailyrain.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-dailytemp=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings dailytemp.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the dailytemp.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-graphconfig=0 [FTP site] Release 3.12.0 ^ (once only) Internet Settings → Graph File Settings graphconfig.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the graphconfig.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-humdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings humdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the humdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-pressdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings pressdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the pressdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-raindata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings raindata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the raindata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-solardata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings solardata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the solardata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Copy-sunhours=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings sunhours.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the sunhours.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Copy-tempdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings tempdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the tempdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-wdirdata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings wdirdata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the wdirdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-websitedata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Standard File Settings websitedata.json → Copy 0 (disabled) Relates to asking MX to process the websitedataT.json file in web folder

Simple tick or not

  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the resulting websitedata.json to your local web server
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-winddata=0 [FTP site] Release 3.12.0 ^ Internet Settings → Graph File Settings winddata.json → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the winddata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Copy-wxnow=0 [FTP site] Release 3.12.0 ^ (disabled) Internet Settings → Standard File Settings wxnow.txt → Copy 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy that file to your local web server
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
CopyMoonImage=0 [FTP site] Release 3.12.0 ^ Internet Settings → Moon Image Copy Moon image file 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy moon image file to your local web server (need to select "Generate Moon Image" see MoonImageEnabled= too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-airquality=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings airquality.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the airquality.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-alldailydegdaydata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailydegdaydata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailydegdaydata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-alldailyhumdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailyhumdata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailyhumdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-alldailypressdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailypressdata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailypressdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-alldailyraindata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailyraindata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailyraindata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-alldailysolardata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailysolardata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailysolarydata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Create-alldailytempdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailytempdata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailytempdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-alldailywinddata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailywinddata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailywinddata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-alltempsumdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailytempsumdata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the alldailytempsumdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-availabledata=0 [FTP site] Release 3.10.0 ^ (once only) Internet Settings → Graph File Settings availabledata.json → Generate 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the availabledata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-dailyrain=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings dailyrain.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the dailyrain.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-dailytemp=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings dailytemp.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the dailytemp.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-graphconfig=0 [FTP site] Release 3.10.0 ^ (once only) Internet Settings → Graph File Settings graphconfig.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the graphconfig.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-humdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings humdata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the humdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-pressdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings pressdat.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the pressdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-raindata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings raindata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the raindata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-solardata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings solardata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the solardata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Create-tempdata=1 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings dailytemp.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the dailytemp.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-sunhours=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings dailytemp.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the dailytemp.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Create-tempdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings tempdata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the tempdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-wdirdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings wdirdata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the wdirdata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-websitedata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings websitedata.json → Generate 1 (enabled) Relates to asking MX to process the websitedataT.json file in web folder

Simple tick or not

  • Tick (value shown as 1 in Cumulus.ini) for MX to process the websitedataT.json file into websitedata.json
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-winddata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings winddata.json → Generate 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the winddata.json file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Create-wxnow=0 [FTP site] Release 3.10.0 ^ (disabled) (depends on release)
  • (releases 3.10.0 to 3.11.4) Internet Settings → Web/FTP Settings
  • (release 3.12.0 on) Internet Settings → Standard File Settings
 wxnow.txt → Generate 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate a wsnow.txt file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
DeleteBeforeUpload=0 [FTP site] legacy Cumulus (always) (depends on release)
  • (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings
  • (release 3.12.0 on) Internet Settings → Web Site → General Settings
 Delete before upload 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to delete existing file (with same name) on the web server before it creates the new file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (this is the option appropriate to most servers)
Directory= [FTP site] Legacy Cumulus (always) Internet Settings → Web/FTP Site Remote FTP Directory (blank) Directory (including path) on your server to which FTP (if 'Enabled' is enabled) will upload the files.
  • value is left Blank, default, the root position specified by ftp server
  • A path from the starting point as the position specified by ftp server

Not used for ExtraRemoteNN parameters

DisableEPSV=0 [FTP site] Beta Release 3.0.0 build 3045 No Still Change directly in file as at release 3.11.x (n/a ) 0 *0 = Disabled (default)
  • 1 = Enabled, to use Extended Passive FTP-mode
DisableFtpsExplicit=0 [FTP site] Release 3.4.0 - Build 3064 No Change directly in file as at release 3.11.x (n/a ) 0 (change value following attribute)
  • 0 = Disabled (default) use FTPS Explicit mode
  • 1 = Enabled, to use FTPS Implicit mode
Enabled=1 [FTP site] Release 3.12.0 (always) Controls whether ^ settings have "File Transfer" option enabled Internet Settings → Interval Configuration Enable file transfer of standard files 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to enable file transfer of standard files (see rows marked ^ for further selections)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
EnableLocalCopy=0 [FTP site] Release 3.12.0 (always) Controls whether ^ settings have "Copy" option enabled Internet Settings → Interval Configuration 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to enable copying of files (see rows marked ^ for further selections)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
EnableRealtime=1 [FTP site] Legacy Cumulus (always) Internet Settings → Realtime Settings Enable Realtime 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate a timer that will permit real time actions
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-airquality=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings airquality.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the airquality.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
Ftp-alldailydegdaydata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailydegdaydata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailydegdaydata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-alldailyhumdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailyhumdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailyhumdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-alldailypressdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailypressdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailypressdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-alldailyraindata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailyraindata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailyraindata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-alldailysolardata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailysolardata.json → File Transfer 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailysolardata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Ftp-alldailytempdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailytempdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailytempdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-alldailywinddata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alldailywinddata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailywinddata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-alltempsumdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings alltempsumdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alltempsumdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-availabledata=0 [FTP site] Release 3.10.0 ^ (once only) Internet Settings → Graph File Settings availabledata.json → File Transfer 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the availabledata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-dailyrain=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings dailyrain.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the dailyrain.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-dailytemp=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings dailyrain.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the dailyrain.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-graphconfig=0 [FTP site] Release 3.10.0 ^ (once only) Internet Settings → Graph File Settings graphconfig.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the graphconfig.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-humdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings humdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the humdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-pressdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings pressdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the pressdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-raindata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings raindata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the raindata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-solardata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings solardata.json → File Transfer 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the solardata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Ftp-sunhours=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings sunhours.json → File Transfer 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the sunhours.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
Ftp-tempdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings tempdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the tempdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-wdirdata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings wdirdata.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the wdirdata.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-websitedata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Standard File Settings websitedata.json → File Transfer 0 (disabled) Relates to asking MX to process the websitedataT.json file in web folder

Simple tick or not

  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the resulting websitedata.json to your local web server
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-winddata=0 [FTP site] Release 3.10.0 ^ Internet Settings → Graph File Settings dailyrain.json → File Transfer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the dailyrain.json file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
Ftp-wxnow=0 [FTP site] Release 3.10.0 ^ (disabled) (depends on release)
  • (release 3.10.0 to 3.11.4) Internet Settings → Web/FTP Settings
  • (release 3.12.0 on) Internet Settings → Standard File Settings
 wxnow.txt → File Transfer 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer that file to your local web server
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
ForumURL= [Web Site] Legacy Cumulus (always) (depends on release)
  • (releases 3.0.0 to 3.11.4) Internet Settings → Web Site
  • (release 3.12.0 on) Internet Settings → Miscellaneous
 Forum URL (blank) Left blank to allow you to choose format

3.10.0 Default web pages use "<a href=\"https://cumulus.hosiene.co.uk/index.php\">forum</a>"

Some alternative URL examples:

FTPlogging=0 [FTP site] Legacy Cumulus FTP logging Depends on release installed:
  1. (Releases 3.1.0 to 3.10.5) Internet Settings → → Web Settings → General Settings
  2. (Releases 3.11.0 to 3.11.4) Program Settings → Program General Options
  3. (Release 3.12.0 onwards) Program Settings → Logging Options
 (n/a) (n/a) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX in standard FTP mode add output to ftplog.txt.

to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers)

  • Don't tick (value shown as 0 in Cumulus.ini) to disable updates to ftplog.txt

For other types of file transfer (STTP, FTPS), any extra diagnostic information appears in latest log in MXdiags folder

FTPRename=1 [FTP site] Legacy Cumulus (always) (depends on release)
  • (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings
  • (release 3.12.0 on) Internet Settings → Web Site → General Settings
 FTP rename 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable

The chief advantage of using rename is that it minimises the time that the web server cannot serve a file (while it is being updated)

Host= [FTP site] Legacy Cumulus (always) Internet Settings → Web/FTP Site Host name (blank) 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.
IncludeMoonImage=1 [FTP site] Release 3.5.0 (always) Internet Settings → Moon Image (FTP) Upload Moon image file 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer moon image file to your local web server (need to select "Generate Moon Image" see MoonImageEnabled= too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
IntervalFtpEnabled=1 [FTP site] Release 3.12.0 ?? Internet Settings → Interval Settings Enable file transfer update interval 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file transfer actions
  • Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected LocalCopyEnabled (see below)
ListWebTags=0 [Station] Legacy Cumulus Only from Release 3.12.0 Depends on release:
  • (3.5.1 to 3.11.4) Manual edit of file
  • (3.12.0 onwards) Station settings → Common Options → Advanced options
 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to create WebTags.txt file when Cumulus is restarted (contains an unordered list of all the tag names your Cumulus build will recognise and process)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
LocalCopyEnabled=0 [FTP site] Release 3.12.0 (always) Internet Settings → Interval Configuration Enable local copy update interval 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file copy actions
  • Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected file transfer IntervalFtpEnabled (see previous)
LocalCopyFolder= [FTP site] Release 3.12.0 (always) Internet Settings → Interval Configuration (blank) Folder (including path) to which MX will copy the standard files (see rows marked ^ for further selections) if 'EnableLocalCopy' is enabled
MoonImageEnabled=1 [Graphs] Release 3.5.0 (always) Internet Settings → Moon Image Generate Moon Image ^ Default controlled by selection of default web site Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to use System Drawing to modify CumulusMX/web/MoonBaseImage.png and create CumulusMX/web/moon.png
  • Don't tick (value shown as 0 in Cumulus.ini) if you don't need MX to create a "moon.png"
MoonImageSize= [Graphs] Release 3.5.0 (always) Internet Settings → Moon Image Image size ??? Enter a size (in pixels) for the generated moon image (according to space on your web page)
Password= [FTP site] Legacy Cumulus (always) Internet Settings → Web/FTP Site Password (blank) The password for your FTP/SFTP/FTPS connection (masked out on settings page, shown in plain text in file)
Port=21 [FTP site] Legacy Cumulus (always) Internet Settings → Web/FTP Site FTP port 21 (plain FTP) you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative protocol and/or alternative ports.
RealtimeFTPEnabled=0 [FTP site] Legacy Cumulus ^ Internet Settings → Realtime Settings Enable realtime FTP 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to be able to do file transfers at real-time interval
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
RealtimeGaugesTxtCopy=0 [FTP site] Release 3.12.0 ^ Internet Settings → Realtime Settings realtimegauges.txt 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the realtimegauges.txt file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
RealtimeGaugesTxtCreate=0 [FTP site] Release 3.10.0 ^ Internet Settings → Realtime Settings realtimegauges.txt → Generate 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the realtimegauges.txt file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
RealtimeGaugesTxtFTP=0 [FTP site] Release 3.10.0 ^ Internet Settings → Realtime Settings realtimegauges.txt → File Transfer 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the realtimegauges.txt file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
RealtimeInterval=45000 [FTP site] Legacy Cumulus ^ Internet Settings → Realtime Settings Realtime interval 45000 milliseconds (45 seconds) Enter interval time in seconds (decimals allowed), stored in file converted to milliseconds
RealtimeTxtCopy=0 [FTP site] Release 3.12.0 ^ Internet Settings → Realtime Settings realtime.txt 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to copy the realtime.txt file to your local web server (need to select "Generate" too)
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
RealtimeTxtCreate=0 [FTP site] Release 3.10.0 ^ Internet Settings → Realtime Settings realtime.txt → Generate 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to generate the realtime.txt file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
RealtimeTxtFTP=0 [FTP site] Release 3.10.0 ^ Internet Settings → Realtime Settings realtime.txt → File Transfer 0 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the realtime.txt file
  • Don't tick (value shown as 0 in Cumulus.ini) to disable
RecordSetTimeoutHrs=24 [Station] Release 3.5.1 Only from Release 3.12.0 Depends on release:
  • (3.5.1 to 3.11.4) Manual edit of file
  • (3.12.0 onwards) Two places:
    1. Station setings → General Settings → Advanced options
    2. Station settings → Common Options → Advanced options
 Depends on where changed (respectively):
  1. New record timeout
  2. Record set timeout
 24 Number of hours before the following web tags are reset: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet, LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet, HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet
Sslftp= [FTP site] MX beta (always) Internet Settings → Web/FTP Site Select the FTP Protocol to use 0 Drop down list:
  • 0 = FTP (plain old FTP) - default
  • 1 = Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) for FTP (FTPS)
  • 2 = Use Secure Shell Home (SSH) for FTP (SFTP)
SshFtpAuthentication=Password [FTP site] Release 3.8.2 - build 3092 Only if SFTP selected above Internet Settings → Web/FTP Site SFTP Authentication method Password Drop down list:
  • 0 = Password
  • 1 = Pre-shared key
  • 2 = Password or pre-shared key
SshFtpPskFile= [FTP site] Release 3.8.2 - build 3092 only if 1 or 2 selected in previous setting Internet Settings → Web/FTP Site Pre-shared Private Key file for SFTP (blank) Filename for your private PSK file, include the full path if the file is not in same folder as CumulusMX.exe
UpdateInterval=60 [FTP site] legacy software ^ Internet Settings → Interval Settings Web interval 60 Interval between standard web updates in minutes
Username= [FTP site] legacy software (always) Internet Settings → Web/FTP Site Username (blank) the user name for connecting to your server
UTF8encode= [FTP site] legacy software (always) (depends on release)
  • (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings
  • (release 3.12.0 on) Internet Settings → Web Site → General Settings
 UTF-8 encoding Default depends on release:
  • (Legacy versions and MX up to 3.9.7) 0 (ISO 8859-1 character set)
  • (Release 3.10.0 on) 1 (UTF-8 encoding enabled)
 Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to use UTF-8 encoding in all .json files
  • Don't tick (value shown as 0 in Cumulus.ini) and MX will create its .json files using ISO 8859-1 character set, please note that this encoding is incompatible with web pages included in webfiles folder; so if you upgrade from an earlier release, you may need to change this setting
WebcamURL= [Web Site] Legacy Software (always) (depends on release)
  • (releases 3.0.0 to 3.11.4) Internet Settings → Web Site
  • (release 3.12.0 on) Internet Settings → Miscellaneous
 Webcam URL (blank) Can be used to add a link to any other web page, you have on any web server. In default web pages will be labelled as "web cam", but for your own web pages, this might lead to a home or blog page.

Program Start-up Options

  • Introduced release 3.9.4 - b3099
  • File Section is [Program]
Parameter Line Entry MX Section Label on Settings page Default Description
StartupPingHost= Program Settings → Program Start-up Options Host to PING on program start-up None (no remote host) Add a hostname or IP to address to ping at startup. Cumulus waits until the ping is successful before trying to read from your station. Leave blank to disable
StartupPingEscapeTime=999 Program Settings → Program Start-up Options PING escape time (mins) 999 (minutes) Specify a time after which if no ping response is received carry on starting Cumulus MX anyway
StartupDelaySecs=0 Program Settings → Program Start-up Options Start-up Delay (secs) zero (no delay) Add a delay before the Cumulus tries to start reading the station.
StartupDelayMaxUptime=300 Program Settings → Program Start-up Options Max system uptime to apply the start-up delay 300 (seconds equivalent to 5 minutes) The time that has passed sice MX was started (up-time) is compared against the (max delay time) figure here.
  • If max delay time less than up-time, the delay specified in previous parameter will NOT be applied
  • If up-time less than this max delay time, then MX will apply any delay specified in previous parameter
  • If this parameter is set to zero, then MX will always apply any delay specified in previous parameter

Proxy

This is a continuation of an experimental legacy Cumulus software feature, please see here for request and see here for potential content. I have not seen any evidence that this feature ever came out of beta, and nobody has ever commented on its use, so I see no reason to do any further documentation.

Station specific alternatives

A number of settings are shown only for specific station types, and so the following tables are grouped here.

Since MX is being developed by someone who uses a Davis station, a lot of "Labels on the Settings Screens" mention "Davis" even if you have selected a different station, because the code was written by copy and paste!

Solar

Cumulus MX is unable to work out if you have a solar sensor, so these options are always displayed.

Parameter Line Entry File Section Introduced MX Section Label on Settings page Default Description
SolarCalc=0 [Solar] 3.13 Station Settings → Solar Solar Calculation Method 0=Ryan-Stololzenbach Drop-down list:
  • 0=Ryan-Stololzenbach
  • 1=Bras
SunThreshold=75 [Solar] 3.13 Station Settings → Solar Sun Threshold (percent) 75 Enter a number
SolarMinimum=0 [Solar] 3.13 Station Settings → Solar Solar minimum (W/m2) 30 Enter a number
RStransfactorJul=0.80000000000000004 [Solar] 3.14 Station Settings → Solar RS Transmission factor (June)

(Note the internal calculation does apply this to June, but some MX releases were incorrectly typed to say "July" on the settings screen).

0.8 MX does a sinusoidal interpolation between this value and the next. So this June factor changes very little either side of that solstice, with the average value from both factors applying at the equinoxes (March and September) and different amounts of each factor each side of equinox. (So actually more like a cosine interpolation!)
RStransfactorDec=0.80000000000000004 [Solar] 3.14 Station Settings → Solar RS Transmission factor (December) 0.8 MX does a sinusoidal interpolation between last value and this one. So this December factor changes very little either side of that solstice, with the average value from both factors applying at the equinoxes (March and September) and different amounts of each factor each side of equinox. (So actually more like a cosine interpolation!)
UseBlakeLarsen=0 [Solar] Legacy Extra Sensor Settings Blake-Larsen Sunshine Recorder 0=deselected checkbox

Selecting the weather station type determines which options are shown

Parameter Line Entry File Section Introduced MX Section Label on Settings page Default Description
Type= -1 [Station] 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0) Station Settings → General Settings Station type -1 (not yet defined) Drop-down
  • -1 = "Select Station", shown before a selection from those below is made
  • 0 = Davis Vantage Pro station
  • 1 = Davis Vantage Pro2 or Vue station
  • 2 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wireless connection (e.g. WMR-928 station)
  • 3 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wired connection (e.g. WM-918 station)
  • 4 = Reading from file 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 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 EWFile= attribute should be at its default of not having any filename value.

  • 5 = Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in Fine Offset section in Supported_Devices article (without solar measurement sensors (with or without solar recharging))
  • 6 = For all La Crosse WS23xx models e.g. WS2300
  • 7 = Fine Offset/Watson/MyDel etc with Solar Sensors as defined in Fine Offset with UV/Light sensor in Supported_Devices article.
  • 8 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using WMR100-200_Protocol e.g. WMR100
  • 9 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using WMR100-200_Protocol e.g. WMR200
  • 10 = Instromet (with optional extra solar sensors or without)
  • 11 = Davis WLL
  • 12 = Ecowitt GW1000 and Froggit DP1500 (and any equivalents)

Selection made here determines what MX sections appear on the Station Settings page

Model= [Station] Early legacy version Station Settings → General Settings Station model (empty) The weather station model description that you want output by the web tag <#stationtype>

Airlink

The details in this sub-section need to be checked by someone who uses the relevant hardware.

  • Introduced Release
  • File Section is [AirLink]
  • Not Shown on Settings page?

IsWllNode=0 WLv2ApiKey= WLv2ApiSecret= AutoUpdateIpAddress=1 In-Enabled=0 In-IPAddress=0.0.0.0 In-WLStationId=-1 In-Hostname= Out-Enabled=0 Out-IPAddress=0.0.0.0 Out-WLStationId=-1 Out-Hostname= AQIformula=0

Parameter Line Entry Shown on Settings page? MX Section Label on Settings page Default Description

Davis

Two Wiki sub-sections, that need to be checked by by somebody who uses the relevant functionality:


Davis VP/VP2/Vue

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

This table does not yet have all details in it.

  • Introduced for legacy Cumulus
  • File Section is [Station]
  • Only "Shown on Settings page" if either "Type=0" or "Type=1"
Parameter Line Entry Label on Settings page Default Description
[Station] Section name - the following parameters appear in Station section
VP2SleepInterval=500 500 (milli-seconds) the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds.
  • if you suspect that data is being missed, reduce number
  • For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
VPClosedownTime=x (default not yet documented) x is the number of seconds after the start of the re-connect attempts that you want the program to close itself
DavisCalcAltPress=1 1 Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude

CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.

  • 0 = Use SLP supplied by Davis
  • 1 = Convert the SP Davis supplies to AP using the altitude you have supplied.
SyncDavisClock=0 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).
  • 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 4 Controls 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
  • 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)
  • 2 = TCP/IP (see later parameters to specify ports)

Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.

VP2TCPPort=22222 2222 Communications port used if VP type has TCP/IP selected.
VP2IPAddr=0.0.0.0 0.0.0.0 Weather station IP address if VP type has TCP/IP selected.
VP2PeriodicDisconnectInterval=0 0 (disable) 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 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.
UseDavisLoop2=1 1 (use Loop2) The current MX code uses LOOP2 for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
  • 1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default. The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
  • 0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.

Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.

DavisIPResponseTime=500 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, see Cumulus MX forum where times up to 2000ms are suggested.
ForceVPBarUpdate=0 0 (normal) Added in build 3042 (January 2017).

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 1 (from version 3.0.0 build 3042)
  • 0= Pressure values shown to 1 decimal places when reported in mb/hPa, shown to 2 decimal places for inHg
  • 1= Pressure values shown to 2 decimal places when reported in mb/hPa, shown to 3 decimal places for inHg
VPrainGaugeType=0 1 Specifies the units selected on your Vantage Pro Rain Gauge.
  • 0 = Metric Rain Adapter fitted, a 0.2mm gauge
  • 1 = Imperial gauge without adapter, a 0.01" gauge.

Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur.

DataLogging=0 0 (Build 3018 onwards).
  • 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.

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 1 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 (default not known) set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery

Davis WeatherLink Live

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

This table has not been populated yet

  • Introduced in a MX beta build
  • File Section is [WLL]
  • Only "Shown on Settings page" if "Type=11"
Parameter Line Entry Label on Settings page Default Description
[Station] Section name - the following parameters appear in Station section

EasyWeather (Reading File instead of connecting to a Weather Station)

This sub-section is based on what applied for the legacy software, assuming nothing has changed for MX.

  • Introduced in a Legacy version
  • File Section is [Station]
  • MX Section is "EasyWeather File Settings"
  • Only "Shown on Settings page" if "Type=4"
Parameter Line Entry Label on Settings page Default Description
EWInterval=10 File Read Interval 10 (minutes between new line becoming available in file) Cumulus needs to know how often to read a new record from the easyweather.dat file. Enter any number in box.
  • 0= Default, meaning not applicable
  • n= any positive decimal value representing Easyweather version 6.2, or earlier, logging interval in minutes (used for reading single latest observations from Easyweather software output). Note to specify seconds, use decimal minutes, e.g. 30 seconds = 0.5
EWFile= Filename (empty) * Full file path/name for Easyweather.dat or EasyWeatherPlus.dat
  • (empty) (i.e. attribute and equals sign, but no value) Note: If you want to run Cumulus without an attached weather station (because your station has a fault or because you have a second PC), it is possible to run Cumulus with station Type=4 but with the default of no file specified in this parameter. The full Cumulus directory structure and its files including those in the data sub-directory are needed (kept from when your station was working or copied from the PC with the station). Although only the old observations can be accessed, (no new ones are being added), this does allow analysis of the old observations via all Cumulus features

See FAQ here for reduced functionality using Cumulus 1 in this way.

EWminpressureMB=900 Minimum Pressure Value 900 Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
EWmaxpressureMB=1200 Maximum Pressure Value 1200 Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars)
EWMaxRainTipDiff=40 Rain Tip Difference Default=30 tips in Cumulus 1, MX default is 40 tips This configurable threshold is 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 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>.

EWpressureoffset=x.y Pressure Offset 9999 The pressure that Cumulus MX processes is equal to what read in the file plus the value set for this parameter. Normally used to convert the station pressure to the equivalent Sea Level Pressure.

Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

An Ecowitt user needs to check/update this sub-section, it is understood significant changes are included in 3.12.0 beta builds, but the forum does not give away any details

  • Introduced in release 3.2.0
  • File Section is [GW100]
  • MX Section is "Ecowitt GW1000 Settings"
  • Only "Shown on Settings page" if "Type=12"
Parameter Line Entry Label on Settings page Default Description
AutoUpdateIpAddress=1 Auto-discovery 1 (selected) Should MX attempt to discover IP address
  • 0=Disable
  • 1=Enable
IPAddress= IP address (no default) stores the IP address of your GW1000 WiFi logger
MACAddress= MAC addresss (no default) Populated by MX when auto-discovery enabled


Fine Offset Stations

  • Introduced in a Legacy version
  • File Section is [Station]
  • MX Section is "Fine Offset Settings"
  • Only "Shown on Settings page" if either "Type=5" or "Type=7"


Parameter Line Entry Introduced Shown on Settings page? MX Section Label on Settings page Default Description
FOReadAvoidPeriod=3 MX release ?? Only if Fine Offset selected Station Settings → Fine Offset Advanced Settings Read Avoid Period 3 (seconds) If previous setting enabled, MX will avoid reading the circular memory from the number of seconds specified before it expects Fine Offset to be writing to the circular memory, to the number of seconds specified after it expects Fine Offset to be writing to the circular memory

(One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor)

?? MX release ?? Only if Fine Offset selected Station Settings → Fine Offset Advanced Settings Set the Fine Offset Logger interval to match Cumulus MX interval 0 (disabled) Simple tick or not - labelled as "Experimental - use with caution"
  • Tick (value shown as 1 in Cumulus.ini) for MX to attempt to "update the Davis interval" (I said copy and paste was used from Davis section!) to match the interval MX is using.
  • Don't tick (value shown as 0 in Cumulus.ini) for no effect on your weather station
FineOffsetReadTime=150 MX release ?? Only if Fine Offset selected Station Settings → Fine Offset Advanced Settings Request/Read Delay 150 (milliseconds) Adjust time (in milliseconds) between request for read, and actual attempt to read data via USB
ProductID=-1 MX release ?? Only if Fine Offset selected Station Settings → Fine Offset Advanced Settings USB Product Id (PID) -1 (default setting) Advanced setting if you don't want to leave it to MX to find your HID
SyncFOReads=0 Legacy Cumulus Only if Fine Offset selected Station Settings → Fine Offset Settings Synchronise Reads 0 (disabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
  • Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data
  1. The parameter was added for legacy releases, to try to reduce the occurrence of "lock-up" issues.
  2. MX uses a different way to interrogate Fine Offset stations, originally ticking this could result in more reads being skipped, than actually processed, potentially updating just a few times a day, so it was best disabled!
  3. The MX code relating to this parameter was rewritten 1n 3.11.0, but the developer labels this as an "attempt", so it may still be best to try to manage without enabling this setting
VendorID=-1 MX release ?? Only if Fine Offset selected Station Settings → Fine Offset Advanced Settings USB Vendor Id (PID) -1 (default setting) Advanced setting if you don't want to leave it to MX to find your HID

Instromet Settings

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

The following table has some gaps to fill in, needs a contributor who uses this type of weather station

  • Introduced in a Legacy version
  • File Section is [Station]
  • MX Section is "Instromet Settings" or "Instromet Advanced Options" as indicated
  • Only "Shown on Settings page" if either "Type=5" or "Type=7"
Parameter Line Entry MX Section Label on Settings page Default Description
ComportName=xxxxxx Station Settings → Instromet Settings Serial port name /dev/ttyUSB0 (on Linux), COM1 (on Microsoft Windows) Only required if your station is connected via a real, or virtual, serial port
ImetBaudRate=19200 Station Settings → Instromet Settings Serial Baud Rate (DavisBaudRate) 19200 Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value
"SyncDavisClock=0" and "ClockSettingHour=4" Station Settings → Instromet Advanced Options "Sychronise Station Clock" and "Clock sync hour" Tick box not selected, data box set to 4 Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
  • Simple tick or not
    • Tick (value shown as 1 in Cumulus.ini) for MX to attempt to sychronise the Instromet Station Clock with your computer time. This ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time!
    • Don't tick (value shown as 0 in Cumulus.ini) if you don't want MX to attempt to keep station clock in line with computer clock
  • Box taking an integer
    • The hour of the day when, if enabled, Cumulus will set the Instromet clock to within a minute of the same time as the computer. This will happen at a default time of 04:00 each day, (4 a.m.) unless the setting box is edited
ImetUpdateLogPointer=1 Station Settings → Instromet Advanced Options Update logger pointer 1 (enabled) Simple tick or not
  • Tick (value shown as 1 in Cumulus.ini) for MX to update the memory pointer to the last record after every 30 data reads
  • Don't tick to disable this action
ImetWaitTime=500 Station Settings → Instromet Advanced Options Delay between sending data read commands 500 Specifies the time in milliseconds that Cumulus waits after one read, before it does the next read from an Instromet station. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
ImetReadDelay=500 Station Settings → Instromet Advanced Options Delay after sending a command before trying to read data from the serial port 500 Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.


LaCrosse stations

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

The following table has some gaps to fill in, needs a contributor who uses this type of weather station


Parameter Line Entry Shown on Settings page? File Section Introduced MX Section Label on Settings page (mostly in Alarm column) Default Description
LCMaxWind=X Shown only if La Crosse was selected as station type [Station] 3.12.0 Depends on release:
  • (Version 1.8.8 Build 874 to release 3.11.4) Need to edit manually in file directly
  • (Release 3.12.0 onwards) Station Settings → Common Options → Advanced Options
 La Crosse max wind speed ??? It is setting for the La Crosse max wind speed, where X is the maximum (before calibrated by any definitions in Offsets) 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

It is assumed that most parameters remain same

Oregon Scientific WM918/WMR928 Settings

The Oregon Scientific code has not changed since the earliest beta MX (3.0.0) builds based on moving compiled code from Cumulus 1.

It appears very few current Cumulus users own these obsolete models, so all these settings have to be added directly into the file, you can't edit them in the admin interface, and they will be missing from any configuration file created by any MX release.

  • Introduced for legacy Cumulus, and unchanged by MX
  • File Section is [Station], these settings need to be manually entered into file below that section heading
Parameter Line Entry External to MX edit Default Description
[Station] Section name - the following parameters appear in Station section
Humidity98Fix=0 Stop MX and add this into file 0 (disable) Applies to weather station types that never report more than 98% relative humidity.
  • 0 = Disabled (default)
  • 1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98%. Normally only useful for Oregon Scientific stations.
LogExtraSensors=0 Stop MX and add this into file 0 (disable) This setting determines whether MX looks for readings from extra temperature probes etc.
  • 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..
WMR928TempChannel=N Stop MX and add this into file (by default no extra sensors) 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 Stop MX and add this into file (by default no extra sensors) 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

Units, Derivative Options, and Decimal Places

For altitude units, please see #Location.

  • File Section is [Station]
  • Edit on Station Settings page (except where indicated in bold as another page)
Parameter Line Entry Introduced MX Section Label on Settings page Default Description
AirQualityDecimals=1 Release 3.9.2 Units → Advanced Options (Here be dragons!) Air Quality decimals 1 (displayed as blank) Number of decimal places for all outputs
AvgBearingMinutes=10 Legacy Cumulus Common Options → Advanced Options (Here be dragons!) Average Bearing Minutes 10 (minutes) This parameter's value is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing
AvgSpeedMinutes=10 Legacy Cumulus Common Options → Advanced Options (Here be dragons!) Average Speed Minutes 10 (minutes) This parameter's value is the number of minutes over which Cumulus averages out reported current wind speeds
CalculatedDP=0 Legacy Cumulus Common Options Calculate dew point Unticked (shown as 0 in Cumulus.ini) Simple tick or not:
  • Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate dew point from temperature and humidity supplied by station
  • Don't tick (value shown as 0 in Cumulus.ini) action depends on Calibration settings
    • If Cumulus has non-default multiplier and/or offset settings for temperature or humidity, Cumulus will calculate dew-point. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
    • If station provides dew point, then that will be used provided no multiplier/offsets have been specified for temperature or humidity
CalculatedWC=1 Legacy Cumulus Common Options Calculate wind chill Unticked (shown as 0 in Cumulus.ini) Simple tick or not:
  • Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate wind chill from temperature and wind speed
    • Note that there is a maximum temperature, and minimum wind speed, for Cumulus to make the calculation, see Wind_chill page
  • Don't tick (value shown as 0 in Cumulus.ini) action depends on other items:
    • If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill
    • If station does NOT make a wind chill value available to Cumulus, Cumulus MX reports an error if you have not ticked this setting, (that is different to how the setting worked with the legacy software).
    • If station provides wind chill, then that value will be used provided no multiplier/offsets have been specified for temperature or wind speed.
ChillHourSeasonStart= Legacy Cumulus Chill Hours Chill Season Starts Default depends on release
  • (up to 3.11.4) 10 = October
  • (from 3.12.0) 4 in Southern hemisphere, 10 in Northern hemisphere
 The value to enter is the month number (1=January, 12=December) and the Cumulative Chill Hours Count is reset to zero on the first of the selected month
ChillHourThreshold= Legacy Cumulus Chill Hours Chill Hours Default depends on Temperature Units
  • Either 45 degrees Fahrenheit (equivalent to 7.22 oCelsius)
  • Or 7 degrees Celsius (equivalent to 44.6 oFahrenheit)
 Chill Hours are incremented by the number of (fractional) hours that the air temperature is below the threshold. In practice, Cumulus simply detects if the current temperature is below the threshold and adds an increment equivalent to the (interval) time passed since the last temperature reading.
  • You can put in any value you want, with a decimal place if required
  • Some people have put in the freezing-point temperature (0oC or 32 oF) and they relabel "chill hours" to "frost hours"
CloudBaseInFeet=0 Legacy Cumulus (As at 3.11.4, can only adjust in the file) 0 (default in MX is metres) Select units used for reporting theoretical cloud base:
  • 0 = metres (default if file created by MX)
  • 1 = feet (default if file created by legacy software)
ErrorLogSpikeRemoval=1 Legacy Cumulus Calibration Settings → Final tick box Log spike and limit violations to error log 1 (default in MX is enabled) Log spike and limit violations to error log (in MX this is in MXdiags folder):
  • 1 = do log (default if file created by MX)
  • 0 = don't log (default if file created by legacy software)
HourlyForecast=1 Legacy Cumulus Forecast Update forecast hourly 1 (default in MX is enabled) When Cumulus derives its Zambretti forecast

Simple tick or not:

  • Tick (value shown as 1 in Cumulus.ini) then MX will derive a Zambretti forecast just once an hour, on the hour
  • Don't tick (value shown as 0 in Cumulus.ini) to derive a forecast every time MX does a process of the pressure reading
Humidity98Fix=0 Legacy Cumulus Common Options Max humidity 0 (disable) For any weather station that never reports a relative humidity greater than 98%

Simple tick or not:

  • Tick (value shown as 1 in Cumulus.ini) then if weather station reading is 98%, process that as 100% for all outputs from MX
  • Don't tick (value shown as 0 in Cumulus.ini) to always report what weather station reports for relative humidity
PeakGustMinutes=10 Legacy Cumulus Common Options → Advanced Options (Here be dragons!) Peak wind gust time 10 (minutes) MX waits until a gust has been measured for number of minutes specified by value of parameter, before checking whether previous gust extreme record have been exceeded
PressDecimals=1 Release 3.9.2 Units → Advanced Options (Here be dragons!) Pressure decimals Default depends on Pressure Units (displayed as blank)
  • default is 1 if units are hPa or mb
  • default is 2 if units are inches of mercury
 Number of decimal places for all outputs
PressureUnit=1 Legacy Cumulus Units Pressure Depends on release:
  1. Legacy to 3.11.4: 0 (mbar)
  2. 3.12.0 onwards: 1 (hPa)
 Drop-down:
  • 0 = millibar (mb)
  • 1 = hectoPascals (hPa)
  • 2 = inches of mercury (in Hg)
RainDayThreshold= Legacy Cumulus Common Options → Advanced Options Rain day threshold Default is -1 which depends on Rainfall Units AND station type
  • -1 = normally 0.2 if units are millimetres
  • -1 = normally 0.01 if units are inches
  • Otherwise enter a value in your selected units
 For derivatives like count of consecutive wet/dry days, any daily rainfall less than this threshold will be ignored.

(If rainfall is measured in tips, usually set to just over one tip, as first tip of day might be result of less that one tip accumulated on earlier days or because of dew)

RainDecimals=1 Release 3.9.2 Units → Advanced Options (Here be dragons!) Rainfall decimals Default depends on Rainfall Units (displayed as blank)
  • default is 1 if units are millimetres
  • default is 2 if units are inches
 Number of decimal places for all outputs
RainSeasonStart=1 Legacy Cumulus Annual Rainfall Start of rainfall season 1 (Jan) Drop-down
  • 1 = January
  • 2 = February
  • 3 = March

...

  • 9 = September
  • 10 = October
  • 11 = November
  • 12 = December

Added in late 2010 because Cumulus users in Israel said they do not total rainfall from January.

It was welcomed by people outside Israel, it turned out growers are often interested in a growing season rainfall total

RainUnit=0 Legacy Cumulus Units Rain 0 (mm) Drop-down:
  • 0 = millimetres
  • 1 = inches
RoundWindSpeed=0 Legacy Cumulus Common Options Rounding of wind speed 0 (no) Simple tick or not, (only applicable if any reported wind speed would otherwise include decimal places):
  • Tick (value shown as 1 in Cumulus.ini) then Cumulus will round all the wind speeds it reports to nearest integer
  • Don't tick (value shown as 0 in Cumulus.ini) then Cumulus will report wind speeds to the precision defined in "WindSpeedDecimals", "WindSpeedAvgDecimals", and "WindRunDecimals", parameters
SunshineHrsDecimals=2 Release 3.8.0 Units → Advanced Options (Here be dragons!) Sunshine hours decimals 2 (displayed as blank) Select a number of decimal places to overwrite the default
TempDecimals=1 Release 3.9.2 Units → Advanced Options (Here be dragons!) Temperature decimals 1 (displayed as blank) Select a number of decimal places to overwrite the default
TempUnit=0 Legacy Cumulus Units Temperature 0 (oC Drop-down:
  • 0 = Celsius
  • 1 = Fahrenheit
UseCumulusForecast=0 Legacy Cumulus Forecast Use Cumulus Forecast 0 (disabled) Simple tick or not:
  • Tick (value shown as 1 in Cumulus.ini) then Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, or as an alternative to the one supplied by your station. Please see Forecast_webtag for details.
  • Don't tick (value shown as 0 in Cumulus.ini) then MX will not do any forecasting, so it will return "not available" unless your weather station provides an alternative forecast
UseCumulusPresstrendstr=0 Legacy Cumulus Common Options Cumulus pressure trend names 0 (depends on weather station type) Simple tick or not:
  • Tick (value shown as 1 in Cumulus.ini) then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using strings.ini.
  • Don't tick (value shown as 0 in Cumulus.ini) then effect depends on whether your weather station supplies pressure trends
    • If your station does supply pressure trends, then MX will use those
    • If your station does not supply pressure trends, then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using strings.ini.
UseSpeedForAvgCalc=0 Legacy Cumulus Common Options Use speed for average calculation 0 (disable) Simple tick or not:
  • Tick (value shown as 1 in Cumulus.ini) then MX will use what the weather station supplies as "wind speed" to calculate the average wind speed.
  • Don't tick (value shown as 0 in Cumulus.ini) then MX will use what the weather station supplies as "latest wind speed" to calculate the average wind speed

Please see Wind_measurement#Weather_Stations_and_Cumulus for more details.

UseZeroBearing=1 Legacy Software Common Options Use bearing zero when calm 1 (enable) Simple tick or not:
  • Tick (value shown as 1 in Cumulus.ini) then MX will report a wind bearing of zero when the wind is calm
  • Don't tick (value shown as 0 in Cumulus.ini) then MX will continue to report the last wind bearing when the wind stops blowing
UVDecimals=1 Release 3.9.2 Units → Advanced Options (Here be dragons!) Ultra Violet decimals 1 (displayed as blank) Select a number of decimal places to overwrite the default
Wind10MinAverage=0 Legacy Cumulus Common Options Calculate average wind speed 0 (disable) Simple tick or not:
  • Tick (value shown as 1 in Cumulus.ini) then MX will calculate an average wind speed (over ten minutes) as defined by "UseSpeedForAvgCalc" parameter
  • Don't tick (value shown as 0 in Cumulus.ini) then MX will use whatever the weather station provides as an average wind speed

Please see Wind_measurement#Weather_Stations_and_Cumulus for more details.

WindRunDecimals=1 Release 3.9.2 Units → Advanced Options (Here be dragons!) Wind run decimals 1 (displayed as blank) Select a number of decimal places to overwrite the default
WindSpeedAvgDecimals= Release 3.8.3 Units → Advanced Options (Here be dragons!) Wind speed average decimals (displayed as blank) Select a number of decimal places to overwrite the default. (NOTE: If the weather station does not provide an average wind speed, or if the user requires a change of units from how the weather station reports it, then CMX will calculate it to 1 decimal place by default; otherwise average wind speed will default to integer, or to one decimal place, depending how it is provided by the station).
WindSpeedDecimals= Release 3.8.3 Units → Advanced Options (Here be dragons!) Wind speed average decimals (displayed as blank) Select a number of decimal places to overwrite the default which depends both on the weather station type and what units have been selected by user (speeds are normally reported as integers unless metres per second are reporting unit, because most sensors are not precise enough to give any decimal places in other units)
WindUnit=0 Legacy Cumulus Units Wind Default depends on release:
  • Legacy to 3.11.4: 0 (m s-1)
  • 3.12.0 onwards: 2 (km hr-1)
 Drop-down:
  • 0 = metres per second
  • 1 = miles per hour
  • 2 = Kilometres per hour
  • 3 = Knots (nautical miles per hour or kts)
YTDrain=0 Legacy Cumulus Annual Rainfall Year-to-date amount 0 (displayed as blank) Enter the amount of rainfall to be added to the calendar year in next parameter (used when start using Cumulus in middle of year)
YTDrainyear= Legacy Cumulus Annual Rainfall Year to which year-to-date amount applies (displayed as blank) Enter a 4 digit year:
  • Legacy Releases (1.7.12 from 5 July 2008) and MX up to 3.11.4 (build 3133 from 25 May 2021): The year-to-date amount in previous parameter is added to the current (seasonal) rain if the year specified in this parameter matches the current year.
    • If your rain season starts in January (default) then set this to the calendar year when you first use Cumulus (in a particular location).
    • If your rain year starts in any other month, set this to the current calendar year during your first season (remember to change the year mid-season when reach 1 January), and delete the year when your second season starts as you don't want the previous value added to your second season
  • From Release 3.12.0 (29 July 2021), the current calendar year is compared against (current month - season start month + 1) year, so you enter the year in which your first season would start had it been a full season (be that last calendar year or this calendar year)
Retrieved from "https://www.cumuluswiki.org/index.php?title=Cumulus.ini&oldid=10682"