Cumulus.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (view source)

Revision as of 05:39, 13 September 2022

17,570 bytes added ,  05:39, 13 September 2022
m
Minor clarifications in response to forum post
m (Minor clarifications in response to forum post)
 
(100 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<big>Please note this page was created 13 June 2021.  This new page was created to reflect parameters added to Cumulus.ini in releases 3.8.0, 3.9.2, 3.10.0, 3.12.0, and after that.  It excludes all parameters removed since 3.8.0.
<big>Please note this page was created 13 June 2021.


MX has been developed very dramatically by Mark Crossley (away from the beta begun by Steve Loft) and as a consequence the "Cumulus.ini" file content has considerable differences. Therefore, the decision was taken to abandon maintaining the page previously called "Cumulus.ini" and start again with a brand new empty page!</big>
At last update, it shows position as at beta build 3135, (missing some changes for the 3.12.0 release build of 3141).


If you are using the final 1.9.4 legacy Cumulus software, or an old release of MX, please go to the owning [[:Category:Configuration Files|category]] to find the links to the relevant former contents of pages previously called "Cumulus.ini".
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>


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 the editing history of that former page 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.
{{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.


[[Category:Configuration Files]]
=Purpose of Cumulus.ini file=
{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}


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


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.
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):  
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 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 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)
* 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


== Legacy Cumulus complications==


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!


=Structure of Cumulus.ini=
= Why does this Wiki now contain multiple pages describing "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!
[[Category:Configuration Files]]
MX has been developed very dramatically by Mark Crossley:
#  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>


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


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


== How MX creates a Configuration File ==
==Need to install MX 3.12.0 ==


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.
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 key fact relevant here is that no Cumulus release distribution contains a '''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].
#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.


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


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


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.
The file is read into Internal Variables as Cumulus starts, and those variables are written back into the file when any settings are changed.  


==When, and How, does MX read the Configuration File?==
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.


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


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


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


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.
=Structure of Cumulus.ini=


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.
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]''').


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


=Settings Configuration for MX=
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 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.
=How this Wiki page classifies 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").
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:
# 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.


==Do I need to restart MX?==
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.


If you change a setting directly in the file, you must stop MX beforehand. The setting takes effect when you restart MX.
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.


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


The settings available on the various pages in the admin interface fall into two groups:
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:
#SETTINGS THAT TAKE EFFECT IMMEDIATELY ON CLICKING “SAVE”
* Where in the admin interface you edit it (MX page and MX section in terminology below)
#SETTINGS THAT ONLY TAKE EFFECT WHEN MX IS RESTARTED
* 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


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


Unfortunately, there is no documentation available from developer on which settings, at any release, do not take effect until MX is restarted.
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.


A further complication is that in some releases, certain settings that used to require a restart have been changed so they take effect intermediately.  It is anticipated this will continue to change as MX develops.


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, or you can read all the support forum announcements, and see if you can find any information about whether a restart is needed.
==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


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


==How to Remove Redundant parameters from file==
==When, and How, does MX read the Configuration File?==


If you have been using Cumulus for a while, there might be parameters that are now obsolete left in your configuration file.  
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.  


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


''The following procedure is best done after'', not before, you [[Updating MX to new version|upgrade]] MX, as installing a new release might add/remove parameters to/from "Cumulus.ini".
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.
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)...
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.
# Rename your existing '''Cumulus.ini''' to say '''Cumulus.ini.sav''' (this keeps the file, but stops MX finding it)
# 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).
# Cumulus (if it accepts that save) will now create a brand new '''Cumulus.ini''' file,
#This will have all the settings you have chosen
#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!
#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):
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.
*A major change is likely in the <nowiki>'''[Station]'''</nowiki> section as that has seen a lot of changes as MX is developed.
*The <nowiki>’’’[Graphs]]’’’</nowiki> section has also seen a number of changes as MX has developed.
*The most dramatic change may happen in <nowiki>'''[FTP Site]'''</nowiki> as any reorganisations to the list of parameters for '''Extra Web Files''' are reproduced 100 times.


==Editing the file directly==
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.


''At the time of writing this'', the work to code up MX settings pages is not yet completed.
=Settings Configuration for MX=


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


However, it is likely that in a few releases time, there will be no necessity to directly edit the file.
<big>Please see [[First Run of MX]] for how to set up settings when you first use MX.</big>


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.
==What happens if I upgrade MX?==


=== An example of why you might edit file instead of using Settings Page===
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)


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.
==Where do I change settings?==


==When MX adds new parameters to file==
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.


If a new release of MX adds new parameters, then:
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").
* 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.


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


===Example of new Parameter with valid default===
==Do I need to restart MX?==


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.
If you change a setting directly in the file, you must stop MX beforehand. The setting takes effect when you restart MX.


===Example of new Parameters with no valid initial value===
If you change a setting, using the admin interface, it may, or may not, take effect immediately...


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.
The settings available on the various pages in the admin interface fall into two groups:
#SETTINGS THAT TAKE EFFECT IMMEDIATELY ON CLICKING “SAVE”
#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.


=How this Wiki page classifies settings=
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.


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


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


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


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.
==How to Remove Redundant parameters from file==


Exceptions to above table styling:
If you have been using Cumulus for a while, there might be parameters that are now obsolete left in your configuration file.  
# 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.


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.


==Terminology used on this Wiki Page==
''The following procedure is best done after'', not before, you [[Updating MX to new version|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:


{| class="wikitable" border="1"
'''You must do this while keeping Cumulus MX running''' (to preserve existing settings)...
|-
# Rename your existing '''Cumulus.ini''' to say '''Cumulus.ini.sav''' (this keeps the file, but stops MX finding it)
!style="width:30px" | Terminology
# 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)
!style="width:800px" | What it means
#*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).
|-
# Cumulus (if it accepts that save) will now create a brand new '''Cumulus.ini''' file,  
| Qualifications:
#This will have all the settings you have chosen
* '''Settings page'''
#They will now be in the order MX is expecting
* '''Wiki page'''
#* MX default sort order is from where entries are set in the code, and that is far from alphabetic!
| Because "page" could refer to either this page or the Settings page, page will always be qualified
#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.
|-
| 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).
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 <nowiki>'''[Station]'''</nowiki> section as that has seen a lot of changes as MX is developed.
| Label on Settings page
*The <nowiki>’’’[Graphs]]’’’</nowiki> section has also seen a number of changes as MX has developed.
| Under this heading you will discover how MX labels the individual setting where you edit that setting
*The most dramatic change may happen in <nowiki>'''[FTP Site]'''</nowiki> as any reorganisations to the list of parameters for '''Extra Web Files''' are reproduced 100 times.
|-
| 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=
==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 [[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.
 
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==
==Accessibility==
Line 224: Line 278:
|-
|-
|EnableAccessibility=0
|EnableAccessibility=0
| * (Either) Program Settings &rarr; (First tick box)
| Two places where you can edit this setting:
* (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 233: Line 288:
|}
|}


== Alarms and Email Settings ==
== 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}} Please will somebody who uses this functionality complete this section, alarms have changed dramatically since 3.8.0 with introduction of email messages
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 245: 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
|
|
|
|
|}
[SMTP]
Enabled=0
ServerName=
Port=587
SSLOption=1
RequiresAuthentication=0
User=
Password=
Logging=0
 
[Alarms]
alarmlowtemp=0
LowTempAlarmSet=0
LowTempAlarmSound=0
LowTempAlarmSoundFile=alarm.mp3
alarmhightemp=0
HighTempAlarmSet=0
HighTempAlarmSound=0
HighTempAlarmSoundFile=alarm.mp3
alarmtempchange=0
TempChangeAlarmSet=0
TempChangeAlarmSound=0
TempChangeAlarmSoundFile=alarm.mp3
alarmlowpress=0
LowPressAlarmSet=0
LowPressAlarmSound=0
LowPressAlarmSoundFile=alarm.mp3
alarmhighpress=0
HighPressAlarmSet=0
HighPressAlarmSound=0
HighPressAlarmSoundFile=alarm.mp3
alarmpresschange=0
PressChangeAlarmSet=0
PressChangeAlarmSound=0
PressChangeAlarmSoundFile=alarm.mp3
alarmhighraintoday=0
HighRainTodayAlarmSet=0
HighRainTodayAlarmSound=0
HighRainTodayAlarmSoundFile=alarm.mp3
alarmhighrainrate=0
HighRainRateAlarmSet=0
HighRainRateAlarmSound=0
HighRainRateAlarmSoundFile=alarm.mp3
alarmhighgust=0
HighGustAlarmSet=0
HighGustAlarmSound=0
HighGustAlarmSoundFile=alarm.mp3
alarmhighwind=0
HighWindAlarmSet=0
HighWindAlarmSound=0
HighWindAlarmSoundFile=alarm.mp3
SensorAlarmSet=0
SensorAlarmSound=0
SensorAlarmSoundFile=alarm.mp3
DataStoppedAlarmSet=0
DataStoppedAlarmSound=0
DataStoppedAlarmSoundFile=alarm.mp3
BatteryLowAlarmSet=0
BatteryLowAlarmSound=0
BatteryLowAlarmSoundFile=alarm.mp3
DataSpikeAlarmSet=0
DataSpikeAlarmSound=0
DataSpikeAlarmSoundFile=alarm.mp3
 
==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?
 
{| 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:600px" | Description
|-
| GraphHours=24
| [Graphs]
| [Graphs]
| Legacy Cumulus
| Legacy Cumulus
Line 592: Line 567:
!style="width:600px" | Description
!style="width:600px" | Description
|-
|-
| StartDate=
| DataLogInterval=2
| (with warning: "Here be dragons!")
| (Always)
| Station Settings &rarr; Advanced Options
| Station settings &rarr; General Settings
| Records Began date
| Log interval
| (Set when you first use Cumulus)
| 2 (10 minutes)
| 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.
| 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]])
| NoSensorCheck=0
* 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 &rarr; 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 yet on a settings page)
| (not known)
| (not known)
Line 614: Line 604:
# Current air pressure (absolute or sea-level)
# 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).
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
| (Always)
| Station settings &rarr; Log Rollover
| Time
| 0 (midnight)
| Radio type selection:
* 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
|-
| 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
| UseDataLogger=1
Line 624: Line 650:
* 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
* 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
| Use10amInSummer=1
| (Always)
| Station settings &rarr; 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)
| Station settings &rarr; 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.
|-
| RolloverHour=0
| (Always)
| Station settings &rarr; Log Rollover
| Time
| 0 (midnight)
| Radio type selection:
* 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
|-
| Use10amInSummer=1
| (Always)
| (Always)
| Station settings &rarr; Log Rollover
| Station settings &rarr; Log Rollover
Line 661: 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
Line 667: Line 664:
|}
|}


==Database==


==Debugging==


* Available from beta MX.
* Available from beta MX.
* File Section is [MySQL]
* 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" | Shown on Settings page?
!style="width:300px" | MX Section
!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:600px" | Description
!style="width:600px" | Description
|-
|-
| CustomMySqlMinutesCommandString=
| Logging=1
| only if "Custom Minutes Enabled"
| Depends on release installed:
| MySQL Settings &rarr; Monthly log file upload
# Alternatives:
| SQL command
#* (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.
| (blank)
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
| SQL to be obeyed at the interval defined in "CustomMySqlMinutesIntervalIndex"
# (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
| 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.
|-
|-
| CustomMySqlMinutesIntervalIndex=6
| DataLogging=1
| only if "Custom Minutes Enabled"
| Depends on release installed:
| MySQL Settings &rarr; Monthly log file upload
# Alternatives:
| Interval
#* (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.
| 6 = 10 minutes
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
| Time between custom SQL uploads:
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
* 0 = 1 minute
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
* 1 = 2 minutes
| Debug logging
* 2 = 3 minutes
| 0 (disabled)
* 3 = 4 minutes
| This adds extra information about both data transfers initiated from MX, and all the internal MX processes.
* 4 = 5 minutes
|}
* 5 = 6 minutes
 
* 6 = 10 minutes
==Extra Web Files==
* 7 = 12 minutes
 
* 8 = 20 minutes
There are 100 occurrences of each parameter in Cumulus.ini, and therefore each parameter has a base name followed by numbers 0 to 99.
* 9 = 30 minutes
 
* 10 = 1 hour (60 minutes)
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"
|-
|-
| CustomMySqlMinutesEnabled=0
!style="width:30px" | Parameter Line Entry
| (always)
!style="width:100px" | Label on Settings page
| MySQL Settings
!style="width:20px" | Default
| Custom Minutes Enabled
!style="width:800px" | Description
| Not ticked (shown as 0 in Cumulus.ini)
| Enable the optional functionality to run SQL at a selected interval in minutes
|-
|-
| CustomMySqlSecondsCommandString=
|style="background:lightgray;"|[FTP site]
| only if "Custom Seconds Enabled"
|
| MySQL Settings &rarr; Monthly log file upload
|
| SQL command
|style="background:lightgray;"|Section name
| (blank)
| SQL to be obeyed at the interval defined in "CustomMySqlSecondsInterval"
|-
|-
| CustomMySqlSecondsInterval=10
|ExtraLocal0= to ExtraLocal99=
| only if "Custom Seconds Enabled"
|Local File Name
| MySQL Settings &rarr; Monthly log file upload
|(empty)
| Interval
|You can enter:
| 10 (seconds)
* A relative path name, with respect to the "CumulusMX" root folder
| Time between custom SQL uploads
** e.g.  '''./data/dayfile.txt''' (Note: this is the [[Daily_Summary|daily summary log file]], see link for how it can be used on a web server)
|-
** e.g. '''./webMX/betel_monthlyrecord_liteMXT.html''' (Note: this is a third party [[Cumulus_template_file|template file]] - see [https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=7500 Alternative Monthly Extremes using <#webtag>s]
| CustomMySqlSecondsEnabled=0
** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
| (always)
* A full path name for a file on the computer running MX
| MySQL Settings
** e.g. '''/home/pi/documents/myFile'''
| Custom Minutes Enabled
** e.g. '''C:\Users\Public\Documents\working.txt'''
| Not ticked (shown as 0 in Cumulus.ini)
*You can place any of the following special tags into the entry
| Enable the optional functionality to run SQL at a selected interval in seconds
** These should be typed as shown on their own
|-
*** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports 
| Database=
***  '''<currentlogfile>''',  '''<currentextralogfile>''', and '''<airlinklogfile>''' these respectively represent [[Standard_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files  e.g. ExtraLocal3=<currentlogfile>
| when section opened
| MySQL Settings &rarr; Server Details
| Database name
| (blank)
| The name given to the database that includes the table(s) you want to update
|-
| DayfileMySqlEnabled=0
| (always)
| MySQL Settings
| Dayfile Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| Enable the automatic upload to the table named in "DayfileTable" within the database named in "Database"
|-
|-
| DayfileTable=Dayfile
|ExtraRemote0= to ExtraRemote99=
| when "Dayfile Enabled" is ticked and the next section is opened
|Destination Filename
| MySQL Settings &rarr; Dayfile.txt upload
|(empty)
| Table name
|Defines where MX is to upload file to
| Dayfile
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
| Enables you to choose the name for the database table to be updated when "DayfileMySqlEnabled" is ticked
**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 [[Your_Own_Server|server]]
** e.g. /var/www/html/weather/webfilesMX/tempdata.json for uploading one of the [[:Category:JSON_Files|files with graph data]] to a Linux hosted [[Your_Own_Server|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_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files
|-
|-
| Host=
|ExtraProcess0= to ExtraProcess99=
| when section opened
|Process
| MySQL Settings &rarr; Server Details
|0
| Host name
|Simple tick or not
| (blank)
* Tick (value shown as 1 in Cumulus.ini) if the local file is a [[Cumulus_template_file|template file]], see [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|here]] for full explanation of '''Process'''
| Enter the database server name or Internet Protocol address
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
|-
|-
| MonthlyMySqlEnabled=0
|ExtraRealtime0= to ExtraRealtime99=
| (always)
|Realtime
| MySQL Settings
|0
| Monthly Log Enabled
|Simple tick or not
| Not ticked (shown as 0 in Cumulus.ini)
*Tick (value shown as 1 in Cumulus.ini) if
| Enable the automatic upload to the table named in "MonthlyTable" within the database named in "Database"
*# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there
*# 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. [[#Interval Settings|Standard interval]])
|-
|-
| MonthlyTable=Monthly
|ExtraFTP0= to ExtraFTP99=
| when "Dayfile Enabled" is ticked and the next section is opened
|FTP
| MySQL Settings &rarr; Monthly log file upload
|1
| Table name
|Simple tick or not
| Monthly
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
| Enables you to choose the name for the database table to be updated when "MonthlyMySqlEnabled" is ticked
* 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
|-
| Pass=
| when section opened
| MySQL Settings &rarr; Server Details
| Password
| (blank)
| Enter the password needed to access the database server specified in "Host"
|-
|-
| Port=3306
|ExtraUTF0= to ExtraUTF99=
| when section opened
|UTF-8
| MySQL Settings &rarr; Server Details
|1
| Port
|Please see [[Reports_folder#Encoding|technical guidance on encoding]]
| 3306
*Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters
| Enter the port used to access the database server
*If unticked (0 appears in file), then iso-8859-1 encoding is used
|-
|-
| RealtimeMySql1MinLimit=0
|ExtraBinary0= to ExtraBinary99=
| When section opened
|Binary
| MySQL Settings &rarr; Raltime.txt upload
|0
| Limit real time table inserts to once a minute 
|Simple tick or not
| Not ticked (shown as 0 in Cumulus.ini)
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
| Enable the optional functionality to limit database uploads, if your real time interval has been set to less than 60 seconds
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
|-
| RealtimeMySqlEnabled=0
| (always)
| MySQL Settings
| Realtime enabled
| Not ticked (shown as 0 in Cumulus.ini)
| Enable the automatic upload to the table named in "RealtimeTable" within the database named in "Database"
|-
|-
| RealtimeRetention=
|ExtraEOD0= to ExtraEOD99=
| When section opened
|End of Day
| MySQL Settings &rarr; Raltime.txt upload
|0
| '''Data Retention value''' and '''Data Retention unit'''
|Simple tick or not
| "7" and "Days"
*Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
| The value field will take any number, the unit field is a dropdown:
* Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]])
* Seconds
* Minutes
* Hours
* Days
* Weeks
* Months
Taken together, these determine the period for which rows are kept in the table named in "RealtimeTable", any row older than this specification will be deleted as part of the automatic SQL
|-
| RealtimeTable=Realtime
| When section opened
| MySQL Settings &rarr; Raltime.txt upload
| Table name
| Realtime
| Enables you to choose the name for the database table to be updated when "RealtimeMySqlEnabled" is ticked
|-
| User=
| when section opened
| MySQL Settings &rarr; Server Details
| User name
| (blank)
| Enter the username associated with "Pass"
|}
 
==Debugging==
 
* Available from beta MX.
* 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
|-
| Logging=1
| * (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
* (Release 3.9.4 onwards) Program Settings &rarr; Program General Options
| Debug logging
| 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.
|-
| DataLogging=1
| * (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
* (Release 3.9.4 onwards) Program Settings &rarr; Program General Options
| Debug logging
| 0 (disabled)
| This adds extra information about transfers from MX, and all the internal MX processes.
|}
|}


Line 874: Line 813:
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
!style="width:600px" | Description
|-
| 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
| Altitude Units
| Default depends on release:
# Legacy until 3.11.4: 1 (labelled as feet)
# 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=
| LocName=
Line 886: Line 841:
| (empty)
| (empty)
| A longer description for the location
| 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="
| "Latitude=0" and "LatTxt="
| Station Settings &rarr; Location &rarr; Latitude
| Station Settings &rarr; Location &rarr; Latitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; North or South"
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; 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
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|-
|-
Line 907: Line 851:
| Station Settings &rarr; Location &rarr; Longitude
| Station Settings &rarr; Location &rarr; Longitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; East or West"
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; 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
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|}
|}




==Optional Report Settings==


==Extra Web Files==
* File Section is [NOAA]
 
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.
 
{| 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:600px" | Description
!style="width:300px" | Description
|-
|-
|style="background:lightgray;"|[FTP site]
| AutoCopy=0
|
| Release 3.12.0
|
| NOAA Reports Settings &rarr; FTP Options
|style="background:lightgray;"|Section name
| 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 [[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
|-
|-
|ExtraLocal0= to ExtraLocal99=
| AutoFTP=0
|Local File Name
| First with Cumulus 2
|(empty)
| NOAA Reports Settings &rarr; FTP Options
|You can enter:
| Auto transfer NOAA report files
* A relative path name, with respect to the "CumulusMX" root folder
| 0 (disable)
** e.g.  '''./data/dayfile.txt''' (Note: this is the [[Daily_Summary|daily summary log file]], see link for how it can be used on a web server)
| Simple tick or not
** e.g. '''./webMX/betel_monthlyrecord_liteMXT.html''' (Note: this is a third party [[Cumulus_template_file|template file]] - see [https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=7500 Alternative Monthly Extremes using <#webtag>s]
* 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)
** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
* 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_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files  e.g. ExtraLocal3=<currentlogfile>
|-
|-
|ExtraRemote0= to ExtraRemote99=
| AutoSave=1
|Destination Filename
| First with Cumulus 2
|(empty)
| NOAA Reports Settings
|Defines where MX is to upload file to
| Create NOAA files after daily rollover
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
|0
**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
| Simple tick or not
*** e.g. httpdocs/dayfile.txt
* Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality
*** e.g. public_html/thismonthyear.htm
* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required
* 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 [[Your_Own_Server|server]]
** e.g. /var/www/html/weather/webfilesMX/tempdata.json for uploading one of the [[:Category:JSON_Files|files with graph data]] to a Linux hosted [[Your_Own_Server|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_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files
|-
|-
|ExtraProcess0= to ExtraProcess99=
| City=
|Process
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Site Details
|Simple tick or not
| City
* Tick (value shown as 1 in Cumulus.ini) if the local file is a [[Cumulus_template_file|template file]], see [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|here]] for full explanation of '''Process'''
| (empty)
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
| Enter here your hamlet, village, town, or city, name
|-
|-
|ExtraRealtime0= to ExtraRealtime99=
| CoolingThreshold=22
|Realtime
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Thresholds
|Simple tick or not
| Cooling threshold
*Tick (value shown as 1 in Cumulus.ini) if
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
*# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there
| [[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.
*# 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. [[#Interval Settings|Standard interval]])
|-
|-
|ExtraFTP0= to ExtraFTP99=
| CopyDirectory=
|FTP
| Release 3.12.0
|1
| NOAA Reports Settings &rarr; Report Options
|Simple tick or not
| Copy Directory
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
| (empty)
* 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
| The folder on the web server you host to which reports are to be copied
|-
|-
|ExtraUTF0= to ExtraUTF99=
| FTPDirectory=
|UTF-8
| First with Cumulus 2
|1
| NOAA Reports Settings &rarr; FTP Options
|Please see [[Reports_folder#Encoding|technical guidance on encoding]]
| destination folder
*Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters
| Depends on release:
*If unticked (0 appears in file), then iso-8859-1 encoding is used
* (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).
|-
|-
|ExtraBinary0= to ExtraBinary99=
| HeatingThreshold=15.5
|Binary
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Thresholds
|Simple tick or not
| Heating threshold
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
|[[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.
|-
|-
|ExtraEOD0= to ExtraEOD99=
| MaxTempComp1=22
|End of Day
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Thresholds
|Simple tick or not
| Max temp comparison 1
*Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
| (empty)
* Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]])
| 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
|}
 
==Optional Report Settings==
 
* File Section is [NOAA]
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
| MaxTempComp2=0
!style="width:100px" | Introduced
| First with Cumulus 2
!style="width:100px" | MX Section
| NOAA Reports Settings &rarr; Thresholds
!style="width:60px" | Label on Settings page
| Max temp comparison 2
!style="width:20px" | Default
| (empty)
!style="width:300px" | Description
| 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
|-
|-
| AutoCopy=0
| MinTempComp1=15.5
| Release 3.12.0
| NOAA Reports Settings &rarr; 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 [[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
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| NOAA Reports Settings &rarr; Thresholds
| Auto FTP NOAA report files
| Min temp comparison 1
| 0 (disable)
| (empty)
| Simple tick or not
| 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
* 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
| 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
|-
|-
| AutoSave=1
| MonthFileFormat='NOAAMO'MMyy'.txt'
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings  
| NOAA Reports Settings &rarr; Output Files
| Create NOAA files after daily rollover
| Monthly filename format
|0
| 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''')
| Simple tick or not
| Here you specify the filename template for MX to use when reading, or writing, monthly reports
* 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
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.
|-
|-
| City=
| Name=Personal Weather Station
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Site Details
| NOAA Reports Settings &rarr; Site Details
| City
| Site Name
| (empty)
| (empty)
| Enter here your hamlet, village, town, or city, name
| What you would like to see in report title for your station name
|-
|-
| CoolingThreshold=22
| NOAAUseUTF8=1
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Report Options
| Cooling threshold
| Use UTF-8 encoding
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
| 1 (UTF-8)
| [[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.
| 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
|-
|-
| CopyDirectory=
| RainComp1=0.5
| Release 3.12.0
| NOAA Reports Settings &rarr; Report Format Options
| Copy Directory
| (empty)
| The folder on the web server you host to which reports are to be copied
|-
| FTPDirectory=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| NOAA Reports Settings &rarr; Thresholds
| FTP directory
| Rain comparison 1
| (empty)
| (empty)
| Where you want MX to use as destination folder on your FTP server
| 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
*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)
* 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:
<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.
|-
|-
| HeatingThreshold=15.5
| RainComp2=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Thresholds
| Heating threshold
| Rain comparison 2
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
| (empty)
|[[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.
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
|-
| MaxTempComp1=22
| RainComp3=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Thresholds
| Max temp comparison 1
| Rain comparison 3
| (empty)
| (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
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
|-
| MaxTempComp2=0
| State=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Site Details
| Max temp comparison 2
| State
| (empty)
| (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
| Enter here your local authority area or region (state in USA)
|-
|-
| MinTempComp1=15.5
| UseDotDecimal=0
| First with Cumulus 2
| Release 3.9.5 - b3100
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Report Options
| Min temp comparison 1
| Use a 'dot' decimal point
| (empty)
| 0 (disable)
| 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
| 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
|-
|-
| MinTempComp2=0
| UseMinMaxAvg=0
| First with Cumulus 2
| Release 3.12.0
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Report Options
| Min temp comparison 2
| Use WHO average or Integrated average
| (empty)
| 0 (integrated average)
| 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
| 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
|-
|-
| MonthFileFormat='NOAAMO'MMyy'.txt'
| YearFileFormat='NOAAYR'yyyy'.txt’
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Output Files
| NOAA Reports Settings &rarr; Output Files
| Monthly filename format
| Yearly filename format
| 'NOAAMO'MMyy'.txt' (note quotes round 'NOAAMO' and round '.txt')
| 'NOAAYR'yyyy'.txt'
| Here you specify the filename template for MX to use when reading, or writing, monthly reports
| 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.  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.  
|-
|-
| Name=Personal Weather Station
|12hourformat=0
| First with Cumulus 2
| ???
| NOAA Reports Settings &rarr; Site Details
| NOAA Reports Settings &rarr; Output Files
| Site Name
|Time format
| (empty)
|0 (24 hour)  
| What you would like to see in report title for your station name
| How times are output on reports
|-
* 24 Hour (value shown as 0 in Cumulus.ini)
| NOAUseUTF8=1
* 12 Hour (value shown as 1 in Cumulus.ini)
| First with Cumulus 2
|}
| NOAA Reports Settings &rarr; Report Format Options
 
| Use UTF-8 encoding
 
| 1 (UTF-8)
===Normal Mean Temperatures===
| 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
* File Section is [NOAA]
* 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
* The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
|-
* There is one box labelled for each month on the settings screens
| RainComp1=0.5
* All the defaults are (blank)
| First with Cumulus 2
* 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
| NOAA Reports Settings &rarr; Thresholds
 
| Rain comparison 1
===Normal Precipitation===
| (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
* 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"
|-
|-
| RainComp2=
!style="width:30px" | Parameter Line Entry
| First with Cumulus 2
!style="width:30px" | File Section
| NOAA Reports Settings &rarr; Thresholds
!style="width:60px" | MX Section
| Rain comparison 2
!style="width:80px" | Action on Settings page
| (empty)
!style="width:20px" | Default
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
|-
| RainComp3=
| <pre>ID=
| First with Cumulus 2
pass=-1
| NOAA Reports Settings &rarr; Thresholds
server=cwop.aprs.net
| Rain comparison 3
port=14580
| (empty)
Enabled=0
| The report will count the number of days when the daily rainfall exceeds this threshold.
Interval=9
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
|-
|-
| State=
| <pre>User=
| First with Cumulus 2
Password=
| NOAA Reports Settings &rarr; Site Details
Language=en
| State
Enabled=0
| (empty)
Interval=900
| Enter here your local authority area or region (state in USA)
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
|-
|-
| UseDotDecimal=0
| <pre>Enabled=0
| Release 3.9.5 - b3100
CatchUp=1
| NOAA Reports Settings &rarr; Report Format Options
APIkey=
| Use a 'dot' decimal point
StationId=
| 0 (disable)
Interval=15</pre>
| Formatting real numbers for when NOAA report parsed by a script
| [OpenWeatherMap]
 
| OpenWeatherMap
Simple tick or not
| Tick "Enabled" to see list of parameters so you can edit them
* Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma
| Defaults are as shown in list of parameters
* Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale
|-
|-
| UseMinMaxAvg=0
| <pre>ID=
| Release 3.12.0
Password=
| NOAA Reports Settings &rarr; Report Format Options
Enabled=0
| Use WHO average or Intregated average
Interval=15
| 0 (integrated average)
SendUV=0
| Simple tick or not
SendSR=0
* Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2
CatchUp=1</pre>
* 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
| [PWSweather]
| PWS Weather
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
|-
| YearFileFormat='NOAAYR'yyyy'.txt’
| <pre>User=
| First with Cumulus 2
Password=
| NOAA Reports Settings &rarr; Output Files
Enabled=0
| Yearly filename format
Interval=60
| 'NOAAYR'yyyy'.txt'
OauthToken=unknown
| Here you specify the filename template for MX to use when reading, or writing, yearly reports
OauthTokenSecret=unknown
 
TwitterSendLocation=1</pre>
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.
| [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
|-
|-
|12hourformat=0
| <pre>Wid=
| ???
Key=
| NOAA Reports Settings &rarr; Output Files
Enabled=0
|Time format
Interval=10
|0 (24 hour)
SendUV=0
| How times are output on reports
SendSR=0
* 24 Hour (value shown as 0 in Cumulus.ini)
SendAQI=0
* 12 Hour (value shown as 1 in Cumulus.ini)
SendSoilMoisture=0
|}
SoilMoistureSensor=0
 
SendLeafWetness=0
 
LeafWetnessSensor=0</pre>
 
| [WeatherCloud]
===Normal Mean Temperatures===
| WeatherCloud
 
| Tick "Enabled" to see list of parameters so you can edit them
* 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 Third-party Upload Settings==
 
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | File Section
!style="width:60px" | MX Section
!style="width:60px" | Action on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| <pre>ID=
pass=-1
server=cwop.aprs.net
port=14580
Enabled=0
Interval=9
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
| Defaults are as shown in list of parameters
|-
|-
| <pre>User=
| <pre>Enabled=0
StationUID=
  Password=
  Password=
Language=en
  Interval=1
Enabled=0
  SendRain=0</pre>
  Interval=900
| [WindGuru]
SendUV=0
| Windguru
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
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
| Defaults are as shown in list of parameters
|-
|-
| <pre>Enabled=0
| <pre>APIkey=
  CatchUp=1
StationIdx=0
  APIkey=
  Enabled=0
  StationId=
  Interval=15
  Interval=15</pre>
  SendUV=0
| [OpenWeatherMap]
  CatchUp=1</pre>
| OpenWeatherMap
| [Windy]
| Windy.com
| Tick "Enabled" to see list of parameters so you can edit them
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
| Defaults are as shown in list of parameters
Line 1,281: Line 1,195:
  SendSR=0
  SendSR=0
  CatchUp=1</pre>
  CatchUp=1</pre>
| [PWSweather]
| [WOW]
| PWS Weather
| Met Office WOW
| 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
| Tick "Enabled" to see list of parameters so you can edit them
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
| 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 &rarr; Display Options'''
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | 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 [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|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 [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|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
|-
|-
| <pre>Wid=
| NumWindRosePoints=16
Key=
| Legacy Cumulus
Enabled=0
| Number of wind rose points
Interval=10
| 16
SendUV=0
| 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
SendSR=0
* 8 points
SendAQI=0
* 16 points
  SendSoilMoisture=0
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.
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
| UseApparent=1
StationUID=
| ??? MX 3.6.0 or 3.10.0 ???
Password=
| Use Apparent Temperature
Interval=1
| Ticked (shown as 1 in Cumulus.ini)
  SendRain=0</pre>
| Simple tick or not
| [WindGuru]
* 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
| Windguru
* 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
| Tick "Enabled" to see list of parameters so you can edit them
|}
| Defaults are as shown in list of parameters
 
 
=== 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 [[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"
|-
|-
| <pre>APIkey=
!style="width:30px" | Parameter Line Entry
StationIdx=0
!style="width:100px" | File Section
Enabled=0
!style="width:100px" | Introduced
Interval=15
!style="width:100px" | Shown on Settings page?
SendUV=0
!style="width:100px" | MX Section
CatchUp=1</pre>
!style="width:60px" | Label on Settings page
| [Windy]
!style="width:20px" | Default
| Windy.com
!style="width:600px" | Description
| Tick "Enabled" to see list of parameters so you can edit them
|-
| Defaults are as shown in list of parameters
| 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.
|-
|-
| <pre>ID=
| Copy-airquality=0
Password=
| [FTP site]
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==
 
The settings listed here 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.
{| class="wikitable" border="1"
|-
!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:20px" | Default
!style="width:600px" | Description
|-
| ActiveFTP=0
| [FTP site]
| Legacy Cumulus
| No
| Change directly in file as at release 3.11.x
| (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
| Release 3.12.0
| ^
| ^
Line 1,646: Line 1,552:
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| 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" too)
* 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
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
Line 1,836: Line 1,742:
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[solardata.json]] file
* 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)
* 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]
| [FTP site]
| Release 3.10.0
| Release 3.10.0
Line 1,907: Line 1,815:
| Release 3.10.0
| Release 3.10.0
| ^ (disabled)
| ^ (disabled)
| Internet Settings &rarr; Standard File Settings
| (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
| wxnow.txt &rarr; Generate
| 0 (disabled)
| 0 (disabled)
Line 1,920: Line 1,830:
| (depends on release)
| (depends on release)
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Settings &rarr; General Settings
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Settings &rarr; General Settings
* (release 3.12.0 onwards)  Internet Settings &rarr; Web Site &rarr; General Settings
* (release 3.12.0 on)  Internet Settings &rarr; Web Site &rarr; General Settings
| Delete before upload
| Delete before upload
| 0 (disabled)
| 0 (disabled)
Line 1,957: Line 1,867:
| (n/a )
| (n/a )
| 0
| 0
| *0 = Disabled (default) use FTPS Explicit mode
| (change value following attribute)
*0 = Disabled (default) use FTPS Explicit mode
*1 = Enabled, to use FTPS Implicit mode
*1 = Enabled, to use FTPS Implicit mode
|-  
|-  
Line 1,964: Line 1,875:
| Release 3.12.0
| Release 3.12.0
| (always) Controls whether ^ settings have "File Transfer" option enabled
| (always) Controls whether ^ settings have "File Transfer" option enabled
| Internet Settings &rarr; Web/FTP Settings
| Internet Settings &rarr; Interval Configuration
| Enable file transfer of standard files
| Enable file transfer of standard files
| 1 (enabled)
| 1 (enabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to enable file transfer of standard files
* 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
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
Line 1,975: Line 1,886:
| Release 3.12.0
| Release 3.12.0
| (always) Controls whether ^ settings have "Copy" option enabled
| (always) Controls whether ^ settings have "Copy" option enabled
| Internet Settings &rarr;  Web/FTP Settings
| Internet Settings &rarr;  Interval Configuration
| Enable file copy of standard files
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate a [[wsnow.txt]] file and then copy that file to your local web server
* 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
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
Line 2,241: Line 2,151:
| Release 3.10.0
| Release 3.10.0
| ^ (disabled)
| ^ (disabled)
| Internet Settings &rarr; Standard File Settings
| (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
| wxnow.txt &rarr; File Transfer
| 0 (disabled)
| 0 (disabled)
Line 2,254: Line 2,166:
| (depends on release)
| (depends on release)
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Site
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Site
* (release 3.12.0 onwards)  Internet Settings &rarr; Miscellaneous
* (release 3.12.0 on)  Internet Settings &rarr; Miscellaneous
| Forum URL
| Forum URL
| (blank)
| (blank)
Line 2,269: Line 2,181:
| [FTP site]
| [FTP site]
| Legacy Cumulus
| Legacy Cumulus
| No
| FTP logging
| Change directly in file as at release 3.11.x
| 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)
| (n/a)
| *0 = Disabled (default)
| Simple tick or not
*1 = Enabled, Cumulus will for standard FTP mode add output to [[ftplog.txt]].
* 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
| FTPRename=1
Line 2,281: Line 2,200:
| (depends on release)
| (depends on release)
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Settings &rarr; General Settings
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Settings &rarr; General Settings
* (release 3.12.0 onwards)  Internet Settings &rarr; Web Site &rarr; General Settings  
* (release 3.12.0 on)  Internet Settings &rarr; Web Site &rarr; General Settings  
| FTP rename
| FTP rename
| 1 (enabled)
| 1 (enabled)
Line 2,303: Line 2,222:
| (always)
| (always)
| Internet Settings &rarr; Moon Image
| Internet Settings &rarr; Moon Image
| Upload Moon image file
| (FTP) Upload Moon image file
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| 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" too)
* 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
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
|-
| IntervalEnabled=1
| IntervalFtpEnabled=1
| [FTP site]
| [FTP site]
| Release 3.10.0
| Release 3.12.0
| ^
| ??
| Internet Settings &rarr; Interval Settings
| Internet Settings &rarr; Interval Settings
| Enable web update interval
| Enable file transfer update interval  
| 1 (enabled)
| 1 (enabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate a timer that will permit standard interval actions
* 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
* 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=
| LocalCopyFolder=
Line 2,324: Line 2,266:
| Release 3.12.0
| Release 3.12.0
| (always)  
| (always)  
| Internet Settings &rarr; Web/FTP Settings
| Internet Settings &rarr; Interval Configuration
| (blank)
| (blank)
| Folder (including path) to which MX will copy the standard files (see ^ for files) if 'EnableLocalCopy' is enabled
| 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=
| Password=
Line 2,344: Line 2,306:
| FTP port
| FTP port
| 21 (plain FTP)
| 21 (plain FTP)
|you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS 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.
|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
| RealtimeFTPEnabled=0
Line 2,354: Line 2,316:
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to be able to do file transfers at realtime interval
* 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
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-  
|-  
Line 2,431: Line 2,393:
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[realtime.txt]] file
* 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
* 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=
| Sslftp=
Line 2,441: Line 2,418:
| Drop down list:
| Drop down list:
* 0 = FTP (plain old FTP) - default
* 0 = FTP (plain old FTP) - default
* 1 = Use SSL/TLS for FTP (FTPS)
* 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)
* 2 = Use Secure Shell Home (SSH) for FTP (SFTP)
|-
|-
Line 2,483: Line 2,460:
| the user name for connecting to your server
| the user name for connecting to your server
|-
|-
| UTF8encode=1
| UTF8encode=
| [FTP site]
| [FTP site]
| legacy software
| legacy software
Line 2,489: Line 2,466:
| (depends on release)
| (depends on release)
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Settings &rarr; General Settings
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Settings &rarr; General Settings
* (release 3.12.0 onwards)  Internet Settings &rarr; Web Site &rarr; General Settings
* (release 3.12.0 on)  Internet Settings &rarr; Web Site &rarr; General Settings
| UTF-8 encoding
| UTF-8 encoding
| 1 (enabled)
| 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
| 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)
* 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) to disable
* 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=
|WebcamURL=
Line 2,502: Line 2,481:
| (depends on release)
| (depends on release)
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Site
* (releases 3.0.0 to 3.11.4)  Internet Settings &rarr; Web Site
* (release 3.12.0 onwards)  Internet Settings &rarr; Miscellaneous
* (release 3.12.0 on)  Internet Settings &rarr; Miscellaneous
| Webcam URL
| Webcam URL
| (blank)
| (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.
| 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 2,516: 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 2,528: 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 2,533: 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 2,538: 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 2,546: 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 2,554: 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 2,563: 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 2,570: 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 2,599: 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 2,630: 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 2,637: 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 2,644: 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 2,772: 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 2,802: Line 2,853:
===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 2,812: 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 2,856: Line 2,908:


===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 2,888: 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 2,901: 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
|-
| FOReadAvoidPeriod=3
| MX release ??
| Only if Fine Offset selected
| Station Settings &rarr; 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 &rarr; 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 &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
| Synchronise Reads
| 0 (disabled)
| 0 (disabled)
Line 2,911: Line 3,004:
* 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
* 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
* 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.
 
# 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
| Read Avoid Period
| MX release ??
| 3 (seconds)
| Only if Fine Offset selected
| 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
| Station Settings &rarr; Fine Offset Advanced Settings
 
| USB Vendor Id (PID)
(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)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|}
|}
{{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
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|
|}


===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 2,951: 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 3,001: Line 3,081:
|}
|}


===WM918/WMR928 Settings===


Oregon Scientific specific
===LaCrosse stations===
 
 
 
{{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 3,031: 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 3,038: 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 3,045: 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==


==Units, Derivative Options,  and Decimal Places==
For altitude units, please see [[#Location]].


* File Section is [Station]
* File Section is [Station]
Line 3,079: Line 3,184:
| Legacy Cumulus
| Legacy Cumulus
| Common Options &rarr; Advanced Options (Here be dragons!)
| Common Options &rarr; Advanced Options (Here be dragons!)
| Average Bearing Miniutes
| Average Bearing Minutes
| 10 (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
| 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
Line 3,089: Line 3,194:
| 10 (minutes)
| 10 (minutes)
| This parameter's value is the number of minutes over which Cumulus averages out reported current wind speeds
| 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=
| ChillHourSeasonStart=
| Legacy Cumulus
| Legacy Cumulus
| (TO BE DETERMINED)
| Chill Hours
|
| Chill Season Starts
| Default depends on release
| Default depends on release
* (up to 3.11.4) 10 = October
* (up to 3.11.4) 10 = October
Line 3,101: Line 3,230:
| ChillHourThreshold=
| ChillHourThreshold=
| Legacy Cumulus
| Legacy Cumulus
| (TO BE DETERMINED)
| Chill Hours
|
| Chill Hours
| Default depends on Temperature Units
| Default depends on Temperature Units
* Either 45 degrees Fahrenheit (equivalent to 7.22 <sup>o</sup>Celsius)
* Either 45 degrees Fahrenheit (equivalent to 7.22 <sup>o</sup>Celsius)
Line 3,116: Line 3,245:
| 0 (default in MX is metres)
| 0 (default in MX is metres)
| Select units used for reporting theoretical cloud base:
| Select units used for reporting theoretical cloud base:
* 0 = metres (default if file created by MX)
* 0 = metres (default if file created by MX)
* 1 = feet (default if file created by legacy software)
* 1 = feet (default if file created by legacy software)
|-
|-
Line 3,141: Line 3,270:
| Humidity98Fix=0
| Humidity98Fix=0
| Legacy Cumulus
| Legacy Cumulus
| (TO BE DETERMINED)
| Common Options
| n/a
| Max humidity
| 0 (disable)
| 0 (disable)
| For any weather station that never reports a relative humidity greater than 98%
| For any weather station that never reports a relative humidity greater than 98%
Line 3,148: Line 3,277:
Simple tick or not:
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
* 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 staion reports for relative humidity
* Don't tick (value shown as 0 in Cumulus.ini) to always report what weather station reports for relative humidity
|-
|-
| PeakGustMinutes=10
| PeakGustMinutes=10
Line 3,170: Line 3,299:
| Units
| Units
| Pressure
| Pressure
| 1 (hPa)
| Depends on release:
# Legacy to 3.11.4: 0 (mbar)
# 3.12.0 onwards: 1 (hPa)
 
| Drop-down:
| Drop-down:
* 0 = millibar (mb)
* 0 = millibar (mb)
Line 3,178: Line 3,310:
| RainDayThreshold=
| RainDayThreshold=
| Legacy Cumulus
| Legacy Cumulus
| (TO BE DETERMINED)
| Common Options &rarr; Advanced Options
| n/a
| Rain day threshold
| (TO BE DETERMINED)
| Default is -1 which depends on Rainfall Units AND station type
| For derivatives like count of consectuative wet/dry days, any daily rainfall less than this threshold will be ignored.
* -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)
(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)
Line 3,208: Line 3,343:
* 11 = November
* 11 = November
* 12 = December
* 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
| RainUnit=0
Line 3,223: Line 3,362:
| Rounding of wind speed
| Rounding of wind speed
| 0 (no)
| 0 (no)
| Simple tick or not:
| 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 MX will round all the wind speeds it reports to nearest integer
* 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 MX will report wind speeds to the precision defined in "WindSpeedDecimals" parameter
* 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
| SunshineHrsDecimals=2
Line 3,256: Line 3,395:
| 0 (disabled)
| 0 (disabled)
| Simple tick or not:  
| 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|here]] for details.
* 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 staion provides an alternative forecast
* 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
| UseCumulusPresstrendstr=0
Line 3,313: Line 3,452:
| Select a number of decimal places to overwrite the default
| Select a number of decimal places to overwrite the default
|-
|-
| WindSpeedAvgDecimals=1
| WindSpeedAvgDecimals=
| Release 3.8.3
| Release 3.8.3
| Units &rarr; Advanced Options (Here be dragons!)
| Units &rarr; Advanced Options (Here be dragons!)
| Wind speed average decimals
| Wind speed average decimals
| 1 (displayed as blank)
| (displayed as blank)
| Select a number of decimal places to overwrite the default
| 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=2
| WindSpeedDecimals=
| Release 3.8.3
| Release 3.8.3
| Units &rarr; Advanced Options (Here be dragons!)
| Units &rarr; Advanced Options (Here be dragons!)
| Wind speed average decimals
| Wind speed average decimals
| 2 (displayed as blank)
| (displayed as blank)
| Select a number of decimal places to overwrite the default
| 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
| WindUnit=0
Line 3,331: Line 3,470:
| Units
| Units
| Wind
| Wind
| 0 (m/s)
| 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:
| Drop-down:
* 0 = metres per second
* 0 = metres per second
Line 3,350: Line 3,491:
| Year to which year-to-date amount applies
| Year to which year-to-date amount applies
| (displayed as blank)
| (displayed as blank)
| Enter a 4 digit year (can be last year, if season starts mid-year; or this year if season starts in January)
| 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)
|}
|}
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/9276...10682"

Navigation menu