Cumulus.ini
Release 3.12.0 moves various options to new places and creates several new Cumulus.ini options. Consequently, this page is undergoing a substantial rewrite, and may take a while to fully cover all settings.
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
Important note about this page
Please note this page was created 13 June 2021. This new page is being created to cover Cumulus.ini file for changes in releases 3.10.0, 3.12.0, and so on. It has been written, starting with a blank page, to reflect the contents of the "Cumulus.ini" file as now applies. The rewrite was needed as there has been so many changes in the contents of the file as MX has been developed so dramatically by Mark Crossley away from the beta begun by Steve Loft
If you are interested in the editing history, associated with the page that previously was called "Cumulus.ini", and some information describing how it was previously used, the old page was moved (before this page was created) so that it is now preserved at Cumulus.ini_(preserving_history). That page also expands on the reasons why that old page was replaced by this new page, and both it, and the owning category, have links to other pages that document "Cumulus.ini" for MX releases before 3.10.0, and for the final 1.9.4 legacy Cumulus software.
Purpose of Cumulus.ini file
This page is about the 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.
The configuration settings in Cumulus.ini have the following main purposes (this list may be incomplete):
- Identify which weather station type MX is to read, and settings related to that model
- Identify which derivatives are source ones (read directly from weather station and converted to your preferred units) and which derivatives MX is to calculate for you.
- Identify where you want MX to output to (options include external web sites, and database tables)
Legacy Cumulus complications
For the legacy Cumulus, there could be one, two, or even three, Cumulus.ini files, as explained 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
The file is divided into "File sections" (see terminology definitions below), each File section name is on a separate line (with no other content) and enclosed in square brackets (e.g. [Station]). These File sections can appear in any order, by default new File sections are appended after all previous File sections, but if you prefer the File sections in another order, MX can still find them, although it may spend more time searching!
Within each File section, there are parameters. Each parameter is in format Attribute=Value, and appears on a line to itself.
The parameters, within a File section, can be in any order, by default new parameters are appended at end of the relevant File section.
How MX creates a Configuration File
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.
The key fact relevant here is that no Cumulus release distribution contains a Cumulus.ini file:
- If you start Cumulus MX interactively without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this:
- 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 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.
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)
Furthermore, at the end of each (meteorological) day, MX creates a back-up in the backup/daily/TIME_NAME sub- folder. The TIME_NAME is constructed from a string of digits representing the date and time the directory was created (without any punctuation) e.g. 20060519090000. In that folder, recent MX releases, include a copy of the current "Cumulus.ini" file.
When, and How, does MX read the Configuration File?
Whenever MX is restarted, it reads the latest Cumulus.ini and if it exists strings.ini (briefly mentioned below); from these one (or two) file(s), it learns the configuration that you want it to use.
For completeness I mention here, configuration information for MX can also be stored in an optional file strings.ini, that is used to identify how various standard output phrases are to be modified to suit you, but this Wiki page ignores that file.
MX works differently to how the legacy software that was described above worked. Essentially, MX reads the whole file, for each attribute part of a parameter in the file, there is a variable stored within the MX code. So the value part of each parameter is assigned to the respective variable. Hence MX will not permit any duplicates for any parameter. If MX finds a parameter it does not understand, it ignores that parameter.
This means a Cumulus.ini file created by the legacy software, or by an old release of MX, can still be read by the current release of MX, as it just ignores all the obsolete parameters. However, since MX now has a lot of new parameters in the file, that were not in the legacy file, nor in a file created by an early MX release, it is often easier to start again with a new configuration file, as explained later, to ensure the configuration of MX is correct for you.
MX also creates a backup copy of "Cumulus.ini" in a sub-folder of Backup folder that is named according to current date and time.
What MX finds in your "Cumulus.ini" does of course determine what you see when you open any of the Settings pages, in the admin interface. This is because the displaying of some settings is dependent on another setting.
Settings Configuration for MX
The current design of MX expects that Cumulus Users will never need to edit the "Cumulus.ini" file directly, as there are a number of settings pages in the admin interface and users are expected to use those Settings pages to amend the individual MX settings.
Please see MX_Administrative_Interface#Changing_Settings for basic information, including how to load the admin interface (sometimes called the "dashboard interface" or "user interface").
Do I need to restart MX?
If you change a setting directly in the file, you must stop MX beforehand. The setting takes effect when you restart MX.
If you change a setting, using the admin interface, it may, or may not, take effect immediently...
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
Unfortunately, there is no documentation available from developer on which settings, at any release, do not take effect until MX is restarted.
A further complication is that in some releases, certain settings that used to require a restart have been changed so they take effect intermediately.
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.
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 adding extra debugging information to file in MXDiags folder was not saved for subsequent session.
For the current MX release, any change made (on any settings page) will be saved into "Cumulus.ini", and will still apply when MX is restarted. That restart will ensure all settings changed in the last session do take effect, even those that did not take effect before the restart.
How to Remove Redundant parameters from file
If you have been using Cumulus for a while, there might be parameters that are now obsolete left in your configuration file.
MX will ignore any parameters that it no longer recognises, but there is a simple way to make MX create a new file for you, keeping your existing settings, but ensuring the new file does not have any obsolete parameters.
The following procedure is best done after, not before, you upgrade MX, as installing a new release might add/remove parameters to/from "Cumulus.ini".
Apart from that upgrade consideration, you can start afresh with a new file anytime by following this very simple procedure:
You must do this while keeping Cumulus MX running (to preserve existing settings)...
- 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):
- A major change is likely in the '''[Station]''' section as that has seen a lot of changes as MX is developed.
- The ’’’[Graphs]]’’’ section has also seen a number of changes as MX has developed.
- The most dramatic change may happen in '''[FTP Site]''' as any reorganisations to the list of parameters for Extra Web Files are reproduced 100 times.
Editing the file directly
At the time of writing this, the work to code up MX settings pages is not yet completed.
So the Settings Pages could not modify all the parameters, that can appear in the file and get used by MX. Therefore, there were still some settings that could only be amended by stopping MX, then editing the relevant parameter in the file directly, before restarting MX.
However, it is likely that in a few releases time, there will be no necessity to directly edit the file.
That said, working through the various settings pages, and all the options (often within multiple MX sections) can be laborious. Consequently, those with some understanding of the file contents may still wish to make some changes with MX stopped, by editing the file. The only caution that needs to be stressed is "be careful"; as this editing the file directly bypasses any validation that is done when using the Settings Pages, and so might result in an inconsistent set of parameters, and (in the worse case) perhaps a software crash.
An example of why you might edit file instead of using Settings Page
If (for example) you find the Extra Web Files editor hard to use, you might decide to stop Cumulus MX and still edit this configuration file directly for changes to those parameters. Given that MX ignores any parameter it does not understand, while editing the file, you can temporary have old and new parameters in the file. All you need to do is prefix those parameters you don't want MX to use with any character you like before the "Extra" in the atribute name.
When MX adds new parameters to file
If a new release of MX adds new parameters, then:
- If the new parameter has a valid default value, MX will work perfectly using that default value. You won't need to know the parameter exists, unless you decide to chnage it, and find out what values it can take either in a drop-down on the relevant Settings page, or in the relevant table below.
- Other new parameters may be given an initial illegal value, because MX cannot guess what value will work for you. This is to enforce the need to give these parameter a valid value before MX will allow you to save settings. Sometimes, MX will not do any weather data processing, until these ‘’’missing’’’ values are edited. In other cases, you might not realise that your file is missing one or more parameters, unless you go into the relevant Settings page, and find you can't save (Enable for Alarms page).
In theory, there is no reason why you should manually add any parameters to the file. Since MX creates, and edits, the file, it will ensure all parameters it understands are in the file.
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.
Example of new Parameter with valid default
When accessibility was added, its parameter defaulted to the old expand/contract sections design (see first table below). You had to go into "Program Settings" or "Staion Settings" pages to tick the box to get the (more accessiblility friendly) selection button altrernative.
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.
How this Wiki page classifies settings
There is no point in this Wiki page listing settings by where they are found in the configuration file, as they can be listed in any order, and when settings are removed or added, the order changes. If your file was originally created by the legacy Cumulus, it may contain "File sections" that are no longer used. For all these reasons, this Wiki page is not designed around the way parameters appear in the file.
The settings interface in MX is being comprehensively redesigned. That means this documentation cannot be organised by the way MX organises its settings pages. The reason is if this Wiki page was organised according to the Settings Screens that applied say at release 3.10.0, that sequence wold be of no use after the settings pages have changed in say 3.12.0.
Some classification is still needed to help you the reader find settings, only you can judge whether the grouping here suits you! In creating this page, I have tried to think of a way to group various settings and arranged those groups alphabetically, to make navigation as easy as I can.
Of course if you have your own ideas of a better way to group the documentation here, you are welcome to implement that by editing this page.
Within the groupings I have selected, individual settings are normally presented as rows in tables for clarity on this Wiki page. The individual tables can have up to 7 columns so they can explain for each setting:
- Where in the admin interface you edit it (MX page and MX section in terminology below)
- Whether the Setting is always shown on the Settings Page ("Always" is shown), or is only shown if an earlier Setting has a particular selection (dependency is shown)
- What File Section (in terminology below) it appears in with the file (always appears, and is shown, between square brackets)
- The attribute name used for the parameter in the file (always shown with an equals sign after it)
- Which release introduced the setting(s)
- What is the default value for the parameter, (and what that default value means)
- A description of what the parameter represents, and what values it can take
If the content of any column would be same for every row, then that column is omitted, and the relevant information is instead stated before the table.
Exceptions to above table styling:
- MQTT parameters are handled slightly differently, as they did not fit that standard layout
- The mean temperatures, and normal rainfall figures, with one parameter per month, have been presented as text, rather than a table for simplicity
- For the Extra Web Files Settings page, where the settings page uses editable grid software using a table to enter 800 settings, the table here is split into just 8 rows, each of which applies to 100 parameters in the file.
Terminology used on this Wiki Page
Terminology | What it means |
---|---|
Wiki page | Because "page" could refer to either this page or the Settings page, page will always be qualified |
Shown on Settings page? | Sometimes whether you see a particular setting on the Settings Page, depends on a previous selection has been made, that is explained under this heading |
MX Section | Under this heading you will find how to navigate to the relevant setting within the admin interface. This covers the page where you edit the setting, followed by →, and then the section (and sub-section where relevant) that you have to select to see the setting
Each MX section on the Settings page has to be opened individually (by either a button for maximum accessibility, or a Click ▶to expand, click ▼ to collapse for alternative styling). |
Label on Settings page | Under this heading you will discover how MX labels the individual setting where you edit that setting |
File Section | Within the file, a number of section headings are used, to gather multiple parameters together. Thus under this heading, for each setting, the table shows the File Section where the parameter will be stored |
Parameter Line Entry | Within the file each setting is represented by a parameter in format attribute=value on a line to itself without any punctuation symbols. If the parameter has a default value, that is shown here and explained in next column |
Default | This is the value (if any) that the individual setting takes when it has not been amended. Some parameters do not have a default value and "(none)" will be shown in this case. No brackets surround literal text representing default value, which is normally also seen in Parameter Line Entry. In general, round brackets are used in Default column to indicate an explanation. |
Description | Under this heading you will find an explanation of the setting including (where relevant) what values it can take |
Tables listing Settings
Accessibility
- Introduced Release 3.10.0 - build 3115
- File Section is [Program]
Parameter Line Entry | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|
EnableAccessibility=0 | * (Either) Program Settings → (First tick box)
|
Enable accessibility features | 0 (disable) | Determines styling of settings pages:
|
Alarms
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
This table has not been populated yet
Parameter Line Entry | File Section | Introduced | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|---|---|
Data Logging
- Available in all Cumulus releases
- File Section is [Station]
Parameter Line Entry | Shown on Settings page? | MX Section | Label on Settings page | Default | Description | |
---|---|---|---|---|---|---|
StartDate= | (with warning: "Here be dragons!") | Station Settings → Advanced Options | Records Began date | (Set when you first use Cumulus) | Format used is determined by locale used for running MX. If this date is edited, keep to same format. MX generally (see Calculate_Missing_Values#CreateMissing.exe for exceptions) ignores any data file entries prior to this date. | |
NoSensorCheck=0 | (not yet on a settings page) | (not known) | (not known) | 0 (normal) | Boolean:
Minimum set of sensors:
Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these). | |
UseDataLogger=1 | (probably determined by station type) | (not known) | (not known) | 1 (enabled) | Simple tick or not
| |
DataLogInterval=2 | (Always) | Station settings → General Settings | Log interval | 2 (10 minutes) | Drop-down:
| |
LogExtraSensors=0 | (Depends on station type) | Station settings → Common Options | Extra sensors | 0 (disabled) | Simple tick or not
| |
RolloverHour=0 | (Always) | Station settings → Log Rollover | Time | 0 (midnight) | Radio type selection:
| |
Use10amInSummer=1 | (Always) | Station settings → Log Rollover | Use 10am in Summer | 1 (normal) | Tick box: | * 0 = If "Daylight Saving Time" (DST) applies in Summer, MX is to use 9 am local time
|
Debugging
- Available from beta MX.
- File Section is [Station]
Parameter Line Entry | MX Section | Label on Settings page | Default | 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.
|
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.
|
Debug logging | 0 (disabled) | This adds extra information about transfers from MX, and all the internal MX processes. |
Location
- Introduced for legacy Cumulus
- File Section is [Station]
Parameter Line Entry | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|
LocName= | Station Settings → Location | Name | (empty) | A short name for the location |
LocDesc= | Station Settings → Location | Description | (empty) | A longer description for the location |
Altitude=0 | Station Settings → Location | Altitude | 0 | The height above mean sea level where the (pressure) sensor is positioned |
AltitudeInFeet=1 | Station Settings → Location | Radio Setting
| ||
"Latitude=0" and "LatTxt=" | Station Settings → Location → Latitude | "Degrees", "Minutes", "Seconds", and "Hemisphere → North or South" | The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file | |
"Longitude=0" and "LongTxt=" | Station Settings → Location → Longitude | "Degrees", "Minutes", "Seconds", and "Hemisphere → East or West" | The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file |
Extra Web Files
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.
Parameter Line Entry | Label on Settings page | Default | Description |
---|---|---|---|
[FTP site] | Section name | ||
ExtraLocal0= to ExtraLocal99= | Local File Name | (empty) | You can enter:
|
ExtraRemote0= to ExtraRemote99= | Destination Filename | (empty) | Defines where MX is to upload file to
|
ExtraProcess0= to ExtraProcess99= | Process | 0 | Simple tick or not
|
ExtraRealtime0= to ExtraRealtime99= | Realtime | 0 | Simple tick or not
|
ExtraFTP0= to ExtraFTP99= | FTP | 1 | Simple tick or not
|
ExtraUTF0= to ExtraUTF99= | UTF-8 | 1 | Please see technical guidance on encoding
|
ExtraBinary0= to ExtraBinary99= | Binary | 0 | Simple tick or not
|
ExtraEOD0= to ExtraEOD99= | End of Day | 0 | Simple tick or not
|
Optional Report Settings
- File Section is [NOAA]
Parameter Line Entry | Introduced | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|---|
AutoCopy=0 | Release 3.12.0 | NOAA Reports Settings → FTP Options | Auto Copy NOAA report files | Simple tick or not
| |
AutoFTP=0 | First with Cumulus 2 | NOAA Reports Settings → FTP Options | Auto FTP NOAA report files | 0 (disable) | Simple tick or not
|
AutoSave=1 | First with Cumulus 2 | NOAA Reports Settings → Create NOAA files after daily rollover | 0 | Simple tick or not
| |
City= | First with Cumulus 2 | NOAA Reports Settings → Site Details | City | (empty) | Enter here your hamlet, village, town, or city, name |
CoolingThreshold=22 | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Cooling threshold | 65o F or 18.3oC | Cold Degree Days are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. An international standard says 22 oCelsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in Cumulus 2 (enhancement request 44), and that was done to match some early look up tables. |
CopyDirectory= | Release 3.12.0 | NOAA Reports Settings → Report 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 | NOAA Reports Settings → FTP Options | FTP directory | (empty) | Where you want MX to use as destination folder on your FTP server
|
HeatingThreshold=15.5 | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Heating threshold | 65o F or 18.3oC | Heating Degree Days are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. An international standard says 15.5 oCelsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in Cumulus 2 (enhancement request 44), and that was done to match some early look up tables. |
MaxTempComp1=22 | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Max temp comparison 1 | (empty) | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit |
MaxTempComp2=0 | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Max temp comparison 2 | (empty) | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit |
MinTempComp1=15.5 | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Min temp comparison 1 | (empty) | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit |
MinTempComp2=0 | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Min temp comparison 2 | (empty) | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit |
MonthFileFormat='NOAAMO'MMyy'.txt' | First with Cumulus 2 | NOAA Reports Settings → Output Files | Monthly filename format | 'NOAAMO'MMyy'.txt' (note quotes round 'NOAAMO' and round '.txt') | Here you specify the filename template for MX to use when reading, or writing, monthly reports
There is a prefix text in quotes,then comes a way to specify months (see Reports_folder#NOAA_style_Report_Naming), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid. |
Name=Personal Weather Station | First with Cumulus 2 | NOAA Reports Settings → Site Details | Site Name | (empty) | What you would like to see in report title for your station name |
NOAUseUTF8=1 | First with Cumulus 2 | NOAA Reports Settings → Report Format Options | Use UTF-8 encoding | Please see Reports_folder#Encoding
| |
RainComp1=0.5 | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Rain comparison 1 | (empty) | The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold |
RainComp2= | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Rain comparison 2 | (empty) | The report will count the number of days when the daily rainfall exceeds this threshold. |
RainComp3= | First with Cumulus 2 | NOAA Reports Settings → Thresholds | Rain comparison 3 | (empty) | The report will count the number of days when the daily rainfall exceeds this threshold. |
State= | First with Cumulus 2 | NOAA Reports Settings → Site Details | State | (empty) | Enter here your local authority area or region (state in USA) |
UseDotDecimal=0 | Release 3.9.5 - b3100 | NOAA Reports Settings → Report Format Options | Use a 'dot' decimal point | 0 (disable) | Formatting real numbers for when NOAA report parsed by a script
Simple tick or not
|
UseMinMaxAvg=0 | Release 3.12.0 | NOAA Reports Settings → Report Format Options | Use WHO average or Intregated average | 0 (integrated average) | Simple tick or not
|
YearFileFormat='NOAAYR'yyyy'.txt’ | First with Cumulus 2 | NOAA Reports Settings → Output Files | Yearly filename format | 'NOAAYR'yyyy'.txt' | Here you specify the filename template for MX to use when reading, or writing, yearly reports
There is a prefix text in quotes,then comes a way to specify months (see Reports_folder#NOAA_style_Report_Naming), and finally comes the mandatory text extension. |
12hourformat=0 | ??? | Time format | 0 (24 hour) | How times are output on reports
|
Normal Mean Temperatures
- File Section is [NOAA]
- The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
- There is one box labelled for each month on the settings screens
- All the defaults are (blank)
- What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements
Normal Precipitation
- File Section is [NOAA]
Rainfall equivalents of mean temperature described above
Optional 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.
Parameter Line Entry | File Section | Introduced | Shown on Settings page? | MX Section | Label on Settings page | Default | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ActiveFTP=0 | [FTP site] | Legacy Cumulus | No | Change directly in file as at release 3.11.x | (n/a ) | *0 = Disabled (default)
| ||||||||
Copy-airquality=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | airquality.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alldailydegdaydata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailydegdaydata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alldailyhumdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailyhumdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alldailypressdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailypressdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alldailyraindata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailyraindata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alldailysolardata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailysolardata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alldailytempdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailytempdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alldailywinddata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailywinddata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-alltempsumdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | alldailytempsumdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-availabledata=0 | [FTP site] | Release 3.12.0 | ^ (once only) | Internet Settings → Graph File Settings | availabledata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-dailyrain=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | dailyrain.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-dailytemp=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | dailytemp.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-graphconfig=0 | [FTP site] | Release 3.12.0 | ^ (once only) | Internet Settings → Graph File Settings | graphconfig.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-humdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | humdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-pressdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | pressdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-raindata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | raindata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-solardata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | solardata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-sunhours=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | sunhours.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-tempdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | tempdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-wdirdata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | wdirdata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-websitedata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Standard File Settings | websitedata.json → Copy | 0 (disabled) | Relates to asking MX to process the websitedataT.json file in web folder
Simple tick or not
| |||||||
Copy-winddata=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Graph File Settings | winddata.json → Copy | 0 (disabled) | Simple tick or not
| |||||||
Copy-wxnow=0 | [FTP site] | Release 3.12.0 | ^ (disabled) | Internet Settings → Standard File Settings | wxnow.txt → Copy | 0 (disabled) | Simple tick or not
| |||||||
CopyMoonImage=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Moon Image | Copy Moon image file | 0 (disabled) | Simple tick or not
| |||||||
Create-airquality=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | airquality.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alldailydegdaydata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailydegdaydata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alldailyhumdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailyhumdata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alldailypressdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailypressdata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alldailyraindata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailyraindata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alldailysolardata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailysolardata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alldailytempdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailytempdata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alldailywinddata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailywinddata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-alltempsumdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailytempsumdata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-availabledata=0 | [FTP site] | Release 3.10.0 | ^ (once only) | Internet Settings → Graph File Settings | availabledata.json → Generate | 0 (disabled) | Simple tick or not
| |||||||
Create-dailyrain=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | dailyrain.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Create-dailytemp=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | dailytemp.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Create-graphconfig=0 | [FTP site] | Release 3.10.0 | ^ (once only) | Internet Settings → Graph File Settings | graphconfig.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-humdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | humdata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-pressdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | pressdat.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-raindata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | raindata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-solardata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | solardata.json → Generate | 1 (enabled) | Simple tick or not
|
[FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | dailytemp.json → Generate | 1 (enabled) | Simple tick or not
|
Create-sunhours=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | dailytemp.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-tempdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | tempdata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-wdirdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | wdirdata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-websitedata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | websitedata.json → Generate | 1 (enabled) | Relates to asking MX to process the websitedataT.json file in web folder
Simple tick or not
| |||||||
Create-winddata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | winddata.json → Generate | 1 (enabled) | Simple tick or not
| |||||||
Create-wxnow=0 | [FTP site] | Release 3.10.0 | ^ (disabled) | Internet Settings → Standard File Settings | wxnow.txt → Generate | 0 (disabled) | Simple tick or not
| |||||||
DeleteBeforeUpload=0 | [FTP site] | legacy Cumulus | (always) | (depends on release)
|
Delete before upload | 0 (disabled) | Simple tick or not
| |||||||
Directory= | [FTP site] | Legacy Cumulus | (always) | Internet Settings → Web/FTP Site | Remote FTP Directory | (blank) | Directory (including path) on your server to which FTP (if 'Enabled' is enabled) will upload the files.
Not used for ExtraRemoteNN parameters | |||||||
DisableEPSV=0 | [FTP site] | Beta Release 3.0.0 build 3045 | No | Still Change directly in file as at release 3.11.x | (n/a ) | 0 | *0 = Disabled (default)
| |||||||
DisableFtpsExplicit=0 | [FTP site] | Release 3.4.0 - Build 3064 | No | Change directly in file as at release 3.11.x | (n/a ) | 0 | *0 = Disabled (default) use FTPS Explicit mode
| |||||||
Enabled=1 | [FTP site] | Release 3.12.0 | (always) Controls whether ^ settings have "File Transfer" option enabled | Internet Settings → Web/FTP Settings | Enable file transfer of standard files | 1 (enabled) | Simple tick or not
| |||||||
EnableLocalCopy=0 | [FTP site] | Release 3.12.0 | (always) Controls whether ^ settings have "Copy" option enabled | Internet Settings → Web/FTP Settings | Enable file copy of standard files | 0 (disabled) | Simple tick or not
| |||||||
EnableRealtime=1 | [FTP site] | Legacy Cumulus | (always) | Internet Settings → Realtime Settings | Enable Realtime | 0 (disabled) | Simple tick or not
| |||||||
Ftp-airquality=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | airquality.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-alldailydegdaydata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailydegdaydata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-alldailyhumdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailyhumdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-alldailypressdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailypressdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-alldailyraindata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailyraindata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-alldailysolardata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailysolardata.json → File Transfer | 0 (disabled) | Simple tick or not
| |||||||
Ftp-alldailytempdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailytempdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-alldailywinddata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alldailywinddata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-alltempsumdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | alltempsumdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-availabledata=0 | [FTP site] | Release 3.10.0 | ^ (once only) | Internet Settings → Graph File Settings | availabledata.json → File Transfer | 0 (disabled) | Simple tick or not
| |||||||
Ftp-dailyrain=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | dailyrain.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-dailytemp=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | dailyrain.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-graphconfig=0 | [FTP site] | Release 3.10.0 | ^ (once only) | Internet Settings → Graph File Settings | graphconfig.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-humdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | humdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-pressdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | pressdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-raindata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | raindata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-solardata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | solardata.json → File Transfer | 0 (disabled) | Simple tick or not
| |||||||
Ftp-sunhours=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | sunhours.json → File Transfer | 0 (disabled) | Simple tick or not
| |||||||
Ftp-tempdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | tempdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-wdirdata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | wdirdata.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-websitedata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Standard File Settings | websitedata.json → File Transfer | 0 (disabled) | Relates to asking MX to process the websitedataT.json file in web folder
Simple tick or not
| |||||||
Ftp-winddata=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Graph File Settings | dailyrain.json → File Transfer | 1 (enabled) | Simple tick or not
| |||||||
Ftp-wxnow=0 | [FTP site] | Release 3.10.0 | ^ (disabled) | Internet Settings → Standard File Settings | wxnow.txt → File Transfer | 0 (disabled) | Simple tick or not
| |||||||
ForumURL= | [Web Site] | Legacy Cumulus | (always) | (depends on release)
|
Forum URL | (blank) | Left blank to allow you to choose format
3.10.0 Default web pages use "<a href=\"https://cumulus.hosiene.co.uk/index.php\">forum</a>" Some alternative URL examples:
| |||||||
FTPlogging=0 | [FTP site] | Legacy Cumulus | No | Change directly in file as at release 3.11.x | (n/a) | *0 = Disabled (default)
| ||||||||
FTPRename=1 | [FTP site] | Legacy Cumulus | (always) | (depends on release)
|
FTP rename | 1 (enabled) | Simple tick or not
The chief advantage of using rename is that it minimises the time that the web server cannot serve a file (while it is being updated) | |||||||
Host= | [FTP site] | Legacy Cumulus | (always) | Internet Settings → Web/FTP Site | Host name | (blank) | This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site. | |||||||
IncludeMoonImage=1 | [FTP site] | Release 3.5.0 | (always) | Internet Settings → Moon Image | Upload Moon image file | 0 (disabled) | Simple tick or not
| |||||||
IntervalEnabled=1 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Interval Settings | Enable web update interval | 1 (enabled) | Simple tick or not
| |||||||
LocalCopyFolder= | [FTP site] | Release 3.12.0 | (always) | Internet Settings → Web/FTP Settings | (blank) | Folder (including path) to which MX will copy the standard files (see ^ for files) if 'EnableLocalCopy' is enabled | ||||||||
Password= | [FTP site] | Legacy Cumulus | (always) | Internet Settings → Web/FTP Site | Password | (blank) | The password for your FTP/SFTP/FTPS connection (masked out on settings page, shown in plain text in file) | |||||||
Port=21 | [FTP site] | Legacy Cumulus | (always) | Internet Settings → Web/FTP Site | FTP port | 21 (plain FTP) | you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative protocol and/or alternative ports. | |||||||
RealtimeFTPEnabled=0 | [FTP site] | Legacy Cumulus | ^ | Internet Settings → Realtime Settings | Enable realtime FTP | 0 (disabled) | Simple tick or not
| |||||||
RealtimeGaugesTxtCopy=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Realtime Settings | realtimegauges.txt | 0 (disabled) | Simple tick or not
| |||||||
RealtimeGaugesTxtCreate=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Realtime Settings | realtimegauges.txt → Generate | 0 | Simple tick or not
| |||||||
RealtimeGaugesTxtFTP=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Realtime Settings | realtimegauges.txt → File Transfer | 0 | Simple tick or not
| |||||||
RealtimeInterval=45000 | [FTP site] | Legacy Cumulus | ^ | Internet Settings → Realtime Settings | Realtime interval | 45000 milliseconds (45 seconds) | Enter interval time in seconds (decimals allowed), stored in file converted to milliseconds | |||||||
RealtimeTxtCopy=0 | [FTP site] | Release 3.12.0 | ^ | Internet Settings → Realtime Settings | realtime.txt | 0 (disabled) | Simple tick or not
| |||||||
RealtimeTxtCreate=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Realtime Settings | realtime.txt → Generate | 0 | Simple tick or not
| |||||||
RealtimeTxtFTP=0 | [FTP site] | Release 3.10.0 | ^ | Internet Settings → Realtime Settings | realtime.txt → File Transfer | 0 | Simple tick or not
| |||||||
Sslftp= | [FTP site] | MX beta | (always) | Internet Settings → Web/FTP Site | Select the FTP Protocol to use | 0 | Drop down list:
| |||||||
SshFtpAuthentication=Password | [FTP site] | Release 3.8.2 - build 3092 | Only if SFTP selected above | Internet Settings → Web/FTP Site | SFTP Authentication method | Password | Drop down list:
| |||||||
SshFtpPskFile= | [FTP site] | Release 3.8.2 - build 3092 | only if 1 or 2 selected in previous setting | Internet Settings → Web/FTP Site | Pre-shared Private Key file for SFTP | (blank) | Filename for your private PSK file, include the full path if the file is not in same folder as CumulusMX.exe | |||||||
UpdateInterval=60 | [FTP site] | legacy software | ^ | Internet Settings → Interval Settings | Web interval | 60 | Interval between standard web updates in minutes | |||||||
Username= | [FTP site] | legacy software | (always) | Internet Settings → Web/FTP Site | Username | (blank) | the user name for connecting to your server | |||||||
UTF8encode=1 | [FTP site] | legacy software | (always) | (depends on release)
|
UTF-8 encoding | 1 (enabled) | Simple tick or not
| |||||||
WebcamURL= | [Web Site] | Legacy Software | (always) | (depends on release)
|
Webcam URL | (blank) | Can be used to add a link to any other web page, you have on any web server. In default web pages will be labelled as "web cam", but for your own web pages, this might lead to a home or blog page. |
Program Start-up Options
- Introduced release 3.9.4 - b3099
- File Section is [Program]
Parameter Line Entry | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|
StartupPingHost= | Program Settings → Program Start-up Options | Host to PING on program start-up | None (no remote host) | Add a hostname or IP to address to ping at startup. Cumulus waits until the ping is successful before trying to read from your station. Leave blank to disable |
StartupPingEscapeTime=999 | PING escape time (mins) | 999 (minutes) | Specify a time after which if no ping response is received carry on starting Cumulus MX anyway | |
StartupDelaySecs=0 | Start-up Delay (secs) | zero (no delay) | Add a delay before the Cumulus tries to start reading the station. | |
StartupDelayMaxUptime=300 | Max system uptime to apply the start-up delay | 300 (seconds equivalent to 5 minutes) | The time that has passed sice MX was started (up-time) is compared against the (max delay time) figure here.
|
Station specific alternatives
A number of settings are shown only for specific station types, and so the following tables are grouped here.
Since MX is being developed by someone who uses a Davis station, a lot of "Labels on the Settings Screens" mention "Davis" even if you have selected a different station, because the code was written by copy and paste!
Parameter Line Entry | File Section | Introduced | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|---|---|
Type= -1 | [Station] | 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0) | Station Settings → General Settings | Station type | Drop-down
NOTE: You can also use Type=4 if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the data subfolder copied from a system with a weather station attached is needed, but in this case, the EWFile= attribute should be at its default of not having any filename value.
Selection made here determines what MX sections appear on the Station Settings page | |
Model= | [Station] | Early legacy version | Station Settings → General Settings | Station model | (empty) | The weather station model description that you want output by the web tag <#stationtype> |
Airlink
- Introduced Release
- File Section is [AirLink]
- Not Shown on Settings page?
IsWllNode=0 WLv2ApiKey= WLv2ApiSecret= AutoUpdateIpAddress=1 In-Enabled=0 In-IPAddress=0.0.0.0 In-WLStationId=-1 In-Hostname= Out-Enabled=0 Out-IPAddress=0.0.0.0 Out-WLStationId=-1 Out-Hostname= AQIformula=0
Parameter Line Entry | Shown on Settings page? | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|---|
Davis
Two Wiki sub-sections:
Davis VP/VP2/Vue
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
This table does not yet have all details in it.
- Introduced for leagacy Cumulus
- File Section is [Station]
- Only "Shown on Settings page" if either "Type=0" or "Type=1"
Parameter Line Entry | Label on Settings page | Default | Description |
---|---|---|---|
[Station] | Section name - the following parameters appear in Station section | ||
VP2SleepInterval=500 | 500 (milli-seconds) | the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds.
| |
VPClosedownTime=x | (default not yet documented) | x is the number of seconds after the start of the re-connect attempts that you want the program to close itself | |
DavisCalcAltPress=1 | 1 | Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude
CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.
| |
SyncDavisClock=0 | 0 | When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
| |
ClockSettingHour=4 | 4 | Controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
| |
VP2ConnectionType=1 | Weather station connection type
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP. | ||
VP2TCPPort=22222 | 2222 | Communications port used if VP type has TCP/IP selected. | |
VP2IPAddr=0.0.0.0 | 0.0.0.0 | Weather station IP address if VP type has TCP/IP selected. | |
VP2PeriodicDisconnectInterval=0 | 0 (disable) | When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.
Set it to zero to disable, if you are not using the Weatherlink site. | |
LogExtraSensors=0 | 0 | This is set in the Settings block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors. | |
UseDavisLoop2=1 | 1 (use Loop2) | The current MX code uses LOOP2 for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX. | |
DavisIPResponseTime=500 | 500 | The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger, see Cumulus MX forum where times up to 2000ms are suggested. | |
ForceVPBarUpdate=0 | 0 (normal) | Added in build 3042 (January 2017).
The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware. | |
DavisIncrementPressureDP=0 | 1 | (from version 3.0.0 build 3042)
| |
VPrainGaugeType=0 | 1 | Specifies the units selected on your Vantage Pro Rain Gauge.
Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur. | |
DataLogging=0 | 0 | (Build 3018 onwards).
I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards). | |
AutoUpdateIpAddress=1 | 1 | default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP. | |
ZeroConfig | (default not known) | set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery |
Davis WeatherLink Live
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
This table has not been populated yet
- Introduced in a MX beta build
- File Section is [WLL]
- Only "Shown on Settings page" if "Type=11"
Parameter Line Entry | Label on Settings page | Default | Description |
---|---|---|---|
[Station] | Section name - the following parameters appear in Station section | ||
EasyWeather (Reading File instead of connecting to a Weather Station)
- Introduced in a Legacy version
- File Section is [Station]
- MX Section is "EasyWeather File Settings"
- Only "Shown on Settings page" if "Type=4"
Parameter Line Entry | Label on Settings page | Default | Description |
---|---|---|---|
EWInterval=10 | File Read Interval | 10 (minutes between new line becoming available in file) | Cumulus needs to know how often to read a new record from the easyweather.dat file. Enter any number in box.
|
EWFile= | Filename | (empty) | * Full file path/name for Easyweather.dat or EasyWeatherPlus.dat
See FAQ here for reduced functionality using Cumulus 1 in this way. |
EWminpressureMB=900 | Minimum Pressure Value | 900 | Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars) |
EWmaxpressureMB=1200 | Maximum Pressure Value | 1200 | Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars) |
EWMaxRainTipDiff=40 | Rain Tip Difference | Default=30 tips in Cumulus 1, MX default is 40 tips | This configurable threshold is the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips.
For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds. This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>. |
EWpressureoffset=x.y | Pressure Offset | 9999 | The pressure that Cumulus MX processes is equal to what read in the file plus the value set for this parameter. Normally used to convert the station pressure to the equivalent Sea Level Pressure. |
Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific
- Introduced in release 3.2.0
- File Section is [GW100]
- MX Section is "Ecowitt GW1000 Settings"
- Only "Shown on Settings page" if "Type=12"
Parameter Line Entry | Label on Settings page | Default | Description |
---|---|---|---|
AutoUpdateIpAddress=1 | Auto-discovery | 1 (selected) | Should MX attempt to discover IP address
|
IPAddress= | IP address | (no default) | stores the IP address of your GW1000 WiFi logger |
MACAddress= | MAC addresss | (no default) | Populated by MX when auto-discovery enabled |
Fine Offset Stations
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
This table has not been populated yet
- Introduced in a Legacy version
- File Section is [Station]
- MX Section is "Fine Offset Settings"
- Only "Shown on Settings page" if either "Type=5" or "Type=7"
Parameter Line Entry | Label on Settings page | Default | Description |
---|---|---|---|
Synchronise Reads | 0 (disabled) | Simple tick or not
Selecting this parameter has given some problems in earlier MX builds, so the code has recently been rewritten. | |
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) |
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
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.
Parameter Line Entry | Shown on Settings page? | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|---|
Instromet Settings
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
The following table has some gaps to fill in
- Introduced in a Legacy version
- File Section is [Station]
- MX Section is "Instromet Settings" or "Instromet Advanced Options" as indicated
- Only "Shown on Settings page" if either "Type=5" or "Type=7"
Parameter Line Entry | MX Section | Label on Settings page | Default | Description |
---|---|---|---|---|
ComportName=xxxxxx | Station Settings → Instromet Settings | Serial port name | /dev/ttyUSB0 (on Linux), COM1 (on Microsoft Windows) | Only required if your station is connected via a real, or virtual, serial port |
ImetBaudRate=19200 | Station Settings → Instromet Settings | Serial Baud Rate (DavisBaudRate) | 19200 | Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value |
"SyncDavisClock=0" and "ClockSettingHour=4" | Station Settings → Instromet Advanced Options | "Sychronise Station Clock" and "Clock sync hour" | Tick box not selected, data box set to 4 | Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
|
ImetUpdateLogPointer=1 | Station Settings → Instromet Advanced Options | Update logger pointer | 1 (enabled) | Simple tick or not
|
ImetWaitTime=500 | Station Settings → Instromet Advanced Options | Delay between sending data read commands | 500 | Specifies the time in milliseconds that Cumulus waits after one read, before it does the next read from an Instromet station. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too. |
ImetReadDelay=500 | Station Settings → Instromet Advanced Options | Delay after sending a command before trying to read data from the serial port | 500 | Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too. |
WM918/WMR928 Settings
Oregon Scientific specific
This document is 'Work In Progress' so content may not be complete.
Request for help from Wiki Readers
- Do you understand how MX works?
- Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
- Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
- Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
- Does any page need a section for novices, so they don't need to read more technical information further down that page?
- Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?
If you plan on contributing to the Wiki, then you will need an account.
- Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- You will find help on how to contribute to this wiki at How to Edit.
- If you need to consult others, please use the Cumulus Wiki suggestions forum.
Please be aware that information on this page may be incorrect.
This table has not been populated yet
- Introduced for legacy Cumulus
- File Section is [Station]
Parameter Line Entry | Label on Settings page | Default | Description |
---|
Parameter Line Entry | Label on Settings page | Default | Description |
---|---|---|---|
[Station] | Section name - the following parameters appear in Station section | ||
Humidity98Fix=0 | 0 (disable) | Applies to weather station types that never report more than 98% relative humidity.
| |
LogExtraSensors=0 | 0 (disable) | This setting determines whether MX looks for readings from extra temperature probes etc.
| |
WMR928TempChannel=N | (no default) | 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 | (no default) | 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 |