Cumulus Wiki - User contributions [en]

User:Sfws

2022-11-02T04:27:09Z

Sfws: removed text

CumulusWiki:About

2022-10-30T20:11:00Z

Sfws: /* About the Cumulus Wiki */

== About the Cumulus Wiki ==

The Wiki was founded in 2009 by [[User:Daj|Daj]] as a repository for useful documentation regarding Steve Loft's [[About_Cumulus|Cumulus weather software]]. It has expanded to include documentation regarding third-party software that is useful with a Cumulus-driven personal weather website.

As the opening page says, "It is '''your''' Wiki" and relies on the documentation efforts of Cumulus users/Wiki members to provide the documentation for display.
It is a community effort of weather enthusiasts to help each other.

Please note that Steve Loft has retired in October, 2018, so is no longer providing updates to either Cumulus V1 or Cumulus MX software, both of which are available on the [[Software|Software/Downloads]] page.

The Cumulus Wiki was moved by [[User:saratogaWX|Ken True]] to his server in October, 2018 as part of the shutdown of Steve's sandaysoft.com website with his retirement. The Cumulus Wiki was moved by User:Freddie (Niall Hosiene) to his server in October, 2022 from Ken's server prior to further Wiki reorganisation.

Please also read the [[GeneralDisclamer]] and [[Privacy_policy|Privacy Policy]] pages for additional information about this Wiki.

CumulusWiki:About

2022-10-30T20:08:10Z

Sfws: /* About the Cumulus Wiki */

== About the Cumulus Wiki ==

The Wiki was founded in 2009 by [[User:Daj|Daj]] as a repository for useful documentation regarding Steve Loft's [[About_Cumulus|Cumulus weather software]]. It has expanded to include documentation regarding third-party software that is useful with a Cumulus-driven personal weather website.

As the opening page says, "It is '''your''' Wiki" and relies on the documentation efforts of Cumulus users/Wiki members to provide the documentation for display.
It is a community effort of weather enthusiasts to help each other.

Please note that Steve Loft has retired in October, 2018, so is no longer providing updates to either Cumulus V1 or Cumulus MX software, both of which are available on the [[Software|Software/Downloads]] page.

The Cumulus Wiki was moved by [[User:saratogaWX|Ken True]] to his server in October, 2018 as part of the shutdown of Steve's sandaysoft.com website with his retirement. The Cumulus Wiki was moved by User:Freddie (Niall Hosiene) to his server in October, 2022 as part of the shutdown of Steve's sandaysoft.com website with his retirement.

Please also read the [[GeneralDisclamer]] and [[Privacy_policy|Privacy Policy]] pages for additional information about this Wiki.

Dayfile.txt

2022-09-27T07:14:44Z

Sfws: Correcting Typos (mostly missing, but critical, colon characters in links), and mention of some more release 3.20.0 changes

{{Template:Version badge Mx}}{{Version badge 1}}This Wiki page applies to both Cumulus flavours. [[Category:Files_with_Comma_Separated_Values]]

As part of a redevelopment of Wiki, this page has been simplified, by moving some content to new pages. Old links in the support forum, that were to content no longer on this page, will bring you here.

'''Content previously on this page has been moved as follows''':
* Explanations about Cumulus terminology can be accessed from [[:Category:Terminology]] page
* Each line in this file represents one day, but the start time need not be same for all fields,
** so please see [[Meteorological_day|Meteorological day]], and [[today.ini]] for more details about that
* Advice regarding editing this file has been moved to [[Amending dayfile]] page, this also covers date-separator issues and dealing with missing or corrupted lines
* General advice about Cumulus files with a '''.txt''' extension has been consolidated on [[:Category:Files_with_Comma_Separated_Values]] page
* Advice about correcting any rogue extreme figures inadvertently stored in this file has been consolidated in new [[Correcting Extremes]] page
* If some lines in your file have fewer fields than other lines the advice has been consolidated on [[Calculate Missing Values]] page
** For MX there is a [[Calculate_Missing_Values#CreateMissing.exe|Create Missing Utility]], which checks spot readings in the [[Standard_log_files|MMMyylog.txt]] files, adds any missing derivative spots (e.g. heat index) and uses these figures to recalculate daily derivatives and uses those to replace missing fields/lines in dayfile.txt
** For the legacy Cumulus, there was a [[Amending_dayfile#Create_Missing_on_legacy_dayfile_editor|dayfile editor with create missing option]], that performed equivalent function
** If you import historic data from before you started using Cumulus into [[Standard log files]],
** then see [[Calculate Missing Values]] page for how to generate new lines in dayfile.txt
* Cumulus MX is more fussy, than Cumulus 1, about various formatting issues, see below, also see [[Migrating_from_Cumulus_1_to_MX#dayfile.txt]] section for more advice

The content that remains on this page is summarised by the table of contents that follows.

=About this file=

* This Wiki page describes one of the [[:Category:Cumulus Files|files]] not included in any release download.
* This daily summary file (Steve Loft shortened that to "day" plus "file") uses a ".txt" extension, and is essentially a plain text file in CSV format.
** CSV stands for "Comma Separated Values", but in the Cumulus context the field separator can be other characters including ";" or "|"
* The file is created in [[data folder|data sub-folder]] of your Cumulus installation when Cumulus needs to store its first line in this file.
* Cumulus MX reads the whole of this file into an internal array (stored in RAM) each time you restart the software,
** Please see [[Amending_dayfile#Warning_if_editing_outside_MX|here for implications]]
** Therefore MX users who move to a different location should archive the old "dayfile.txt", to avoid any discontinuities in any graphs plotted from active file

([[Speciallog.txt|speciallog.txt]] is another log file that contains all dates in a single file, as do all the [[:Category:Ini_Files|.ini files]]).

==How Cumulus Creates and Updates this file==

* Cumulus reads values supplied by your weather station, (either directly while Cumulus running, or for some weather station types can read historic data during catch-up on restarting Cumulus)
* Cumulus converts them to the units you prefer,
* Cumulus applies any calibration (multiplier and offset) you have set,
* For a sub-set of those readings (perhaps those every minute if readings are collected every 10 seconds), the spot values of source items like temperature, humidity, wind speed, can be used in calculations of derived items like "wind chill", "dewpoint" and "feel-like" temperature.
* Cumulus then sees if the resulting soource, or derived, value implies [[:Category:Ini Files|any extreme records file]] needs to be updated
** Daily extremes are held in [[today.ini]] and that is main source used when a new line is added to "dayfile.txt"

==Why this file should be backed up==

* This file contains daily extremes, the accuracy of those daily extremes depends on the interval between the spot readings that are used as explained above.
* If the file is corrupted, and not regenerated from a back-up, the only source of spot readings is the [[Standard_log_files|MMMyylog.txt]] files, and their interval might be only every half an hour (it has to be an exact fraction of an hour).
* As explained [[Monthly_log_files#Enhancement never implemented|here]] minima and maxima between such logging intervals are not recorded by Cumulus software
* Thus it is worth backing up this file, to another device than that running Cumulus, on a regular basis, probably a few times a week, to ensure this precious data is not lost if your device running Cumulus has a malfunction (or is damaged), or an electrical blip (or mistake by you) causes corruption to the original file,

Cumulus does periodically copy this file within the installation, but the copies are only kept for a limited time, and are on the same physical storage device, and so your main file is corrupted you might not be able to access the Cumulus back up or might not be able to go far back enough to find a file that has not been corrupted:
* The file is backed up when MX is restarted into a date/time stamped sub-folder of the [[Backup folder|'''backup''' folder]]
*The file is also backed up (to a date/time stamped sub-folder within '''daily''' sub-folder of that backup sub-folder) during the end of day process, but (depending on the release you are running) the back-up copy may, or may not, include a line for the previous day (the line that is appended in the same end of day)

Retention of these back ups:
* [[File:Badge vMx.png]] MX only keeps the last 9 of the date/time stamped sub-folders.
* [[File:Badge v1.png]] Legacy Cumulus 1 only keeps up to 8 of the date/time stamped sub-folders.

== Specific issues for MX ==

WARNING: It is important to note that some releases of MX are very fussy about consistency in all lines of '''dayfile.txt'''. Earlier releases tended to have better compatibility with the legacy software. Subsequent releases expected every line to be expressed exactly as specified in the locale. MX in its latest release is trying to cope better with inconsistent date separators.

Date field: Cumulus 1 (C1) did not care what character (or characters) separated the day, month, and year elements of the date field. MX insists that the same character (or characters), as defined in the locale, is used for all lines in file.

Real number fields: MX uses the '''locale''' to decide what character (decimal comma or decimal point) separates integer and decimal parts of numbers. Every line of the file must be consistent in use of integer/decimal separator. C1 used the '''Region''' settings in Microsoft's Control Panel to determine how to store (and output) numbers for you, but (except if ''list separation character'' was comma) was fairly tolerant when reading old data in files. At the time of writing this, it was proposed the next major release will force this file to use decimal points (full stops not commas) regardless of locale. This proposal may or may not happen, the point is that information here might be incorrect for the release that you are using.

Time-stamp fields: MX insists on HH:mm format being consistently used in every line of file, C1 did not care what (non-space, non-field separator) symbol separated the minutes from the hours.

Number of fields: The number of fields in the file increases in various versions as shown in [[#List_of_fields]].
* C1 will accept (as did Cumulus 2) any line with 15 to 45 fields in it. This is because the earliest version only stored 15 fields, as C1 was developed fields were added (as shown in field list) until there were 45 fields.
* Each release of MX expects a particular number of fields in each line of file; MX has added fields as the software has developed, and it even (as shown in field list) inadvertently added 2 fields later removed. The difference is that MX (for some functionality from release 3.4.5, for all functionality from release 3.9.5) reads the whole file into an internal (RAM held) array with a fixed number of elements, therefore every line ends up with same number of fields when written back into file.
** If you have some lines in your file that were created by an earlier release of Cumulus, and so have less than whatever is the current number of fields for the release you are using, there is a utility to run that will create a new dayfile.txt with all fields populated, please see [[Calculate Missing Values]] page. Please ensure you use the right version of the "Create Missing" utility mentioned on that page as it also get upgraded when fields are added, and it uses various software libraries contained within .dll files specific to a particular CumulusMX.exe release.

==How to view or edit this file==

The detailed information has been moved to [[Amending dayfile|viewing/editing '''dayfile.txt''' page]].

An editor has been included within recent Cumulus releases of each flavour:
* [[File:Badge vMx.png]] Available from release 3.4.5 (13 Mar 2020): In [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|the interface]] go to '''Data logs''' menu and select ''Dayfile''
* [[File:Badge v1.png]] Available from version 1.9.2 (5th October 2011) to final legacy release: On Main Screen from [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|'''Edit''' menu]] select ''Dayfile.txt''
**'''Note for obsolete version 1.9.0 to 1.9.3:''' There is a bug in these versions in that 'Create missing' inserts 'heating and cooling degree day' values the wrong way round.
**'''Note for obsolete version 1.9.3 only:''' Create missing might in some cases be affected by a bug in 1.9.3 that can cause lines to be stored in incorrect date order (dayfile.txt uses dd.mm.yy, dd/mm/yy or dd-mm-yy, for its date field; and all lines should be in ascending chronological order)
**There are no known bugs for dayfile.txt handling in version 1.9.4 builds 1086 to 1101. Build 1099 is the standard stable final release of Cumulus 1 for most weather station types, 1100 and 1101 are for specific weather station types.

Please note that the editor in Cumulus 1 allows you to change the date, as well as all the other fields, although the lines must be kept in ascending date order to avoid errors when subsequently reading the file.

The MX editor does not let you change the date, you can only change other fields or delete an entire line, so you have no control over the order of the lines in the file.

==Reading the file==

See [[Daily Summary]] page for a full discussion of ways, external to Cumulus, to read this file.

Apart from the viewing/editing options just described, Cumulus software reads this daily summary file in vaCumulus 1 does not actually number lines, however it does count lines as it reads them, so if there is an error when it reads the file, the original Cumulus will report the line number (numbering from 1) where it first found an error (line numbering uniquely identifies the line, even if a date is duplicated, or a line feed has been deleted so two lines are merged).rious other circumstances depending on the release you are running.

* [[File:Badge v1.png]] The legacy software only reads the file when the Cumulus user makes a specific request, in normal operation the existing content is ignored:
** The legacy Cumulus has a number of [[Cumulus_Screenshots#View_data|screens for viewing data for various periods]], to populate these screens Cumulus has to read all of the [[:Category:Files with Comma Separated Values|Files with Comma Separated Values]] as the derivatives shown generally do not match the extremes tracked in [[:Category:Ini Files|.Ini files]].
** The '''Select a graph''' feature also uses all of the [[:Category:Files with Comma Separated Values|Files with Comma Separated Values]].
** The end of day action uses a simple "append" instruction, so it does not need to read the file
* [[File:Badge vMx.png]] As already mentioned, MX reads the entire '''dayfile.txt''' file when it is first started into an internally held array. That internal copy was introduced in release 3.9.2 - b3097 (7 Dec 2020), it was needed to drive the [[Highcharts_-_Historic|'''historic charts functionality''']]; both in the [[MX Administrative Interface|interface]], and the example included [[New Default Web Site Information|Historic Charts web page]].
** From release 3.20.0 - b3200 (21 Aug 2022) there is a '''This Period Highs and Lows''' web page (accessed from ''Records'' menu) which is similar to the ''screens for viewing data for various periods'' except that the extremes it shows match those tracked in [[:Category:Ini Files|.Ini files]].
** From release 3.20.0 - b3200 (21 Aug 2022) there is an option to '''Reload dayfile''' in a ''Utils'' menu, this updates the internal held array by reading the file again; essential if an edit has been made to the file.

==Line numbering and Error messages==

Cumulus 1 does not actually number lines, however it does count lines as it reads them, so if there is an error when it reads the file, the original Cumulus will report the line number (numbering from 1) where it first found an error.

Cumulus MX stores the contents of the file in an internal two dimensional array. The outer dimension is identified by numbering (from zero) what were lines in the file. The inner dimension has that line number as element zero, and the fields taken from file are therefore numbered from one.

Obviously, line numbering uniquely identifies the line, even if a date is duplicated, or a line feed has been deleted so two lines are merged in the file. This is why you will see line numbers quoted in any error messages related to this file.

Some of the editors you may use to view/edit the file may number the lines (in some cases always, in others as an option). If you have seen an error message, then to correct the file you need to use a tool that does number the lines in order to find where the correction is needed. Error messages report just the first error found, so check subsequent lines in case they have same error.

= List of fields in dayfile.txt =

For your installed build please see ''[[dayfileheader.txt]]''. This file identifies all the fields in each line of the '''dayfile.txt''' file in the release you are running.

That file has changed location from release 3.20.0 - b3200 (21 Aug 2022), it is now in [[data folder]], for Cumulus 1 and all earlier MX releases it was in same directory as the Cumulus executable.

As explained earlier, the number of fields in a line has (with one exception when fields were added in error) increased as the Cumulus software has been developed. The table below therefore groups the fields under labels that indicate which version/release introduced them.

==Field numbering==

The table below was first created when the only flavour of Cumulus software available was what we now call the legacy Cumulus 1. Back then the fields '''were''' numbered starting from zero. This reflected the way fields were identified when processed as elements of an single-dimension array variable representing a line.

The old numbering from zero had two advantages:
# It stressed that the date field was different to the rest, all other fields were either values or time-stamps
# Numbering starting from zero is consistent with standard indexing used for arrays in programming languages (like JavaScript), so the number shown '''was''' the number to quote in any scripts where a Cumulus 1 line was converted to an array, and you needed to address a single field.

Please note the list of fields has been rewritten especially for MX. As part of the rewrite, the fields have been renumbered, in some forum posts you might see references to old numbering, in others to new numbering. As explained [[#Line numbering and Error messages|above]] the fields are now numbered starting from 1 to fit in with an internal array created when the log file is read, the processing code adds a line number in front of the date field on each array 'line' it holds.

== Information shown in the table ==

* The date '''is supposed to''' be a unique identifier, the same date should not be repeated in another line, however Cumulus 1's editor allows you to change that date field.
** The dates, as mentioned earlier, should be in ascending order.
** Please see [[amending dayfile]] page for more information on dates
** Both Cumulus 1 and MX may get confused if you restart the software close to rollover time, and in that confused state they may create a second line with same date as a date already in the file.
** If you regularly restart Cumulus close to rollover time, then a whole sequence of dates can be repeated either as a block or as pairs.
* The remaining fields are all either numerical values, or a time paired with (except for first wind field) preceding numerical value.
** Cumulus 1 actually enforces this pairing (i.e. it validates that a time is present where it is needed). Cumulus MX only validates that each field is of correct type, it does not recognise any relationships between fields.
*The alphabetic column identifiers used by many spreadsheet editors are shown in the table
** IMPORTANT: If you do use a spreadsheet editor, do ensure '''all columns are set to "text" format''',
** Note that you will corrupt this file if you let your spreadsheet recognise content as dates or time, or let it change the number of decimal places.
* The type of field is shown in the table:
** Note you must not include a sign for an unsigned field,
** Note you can not specify a decimal comma/point in an integer field,
** Note all fields of type time must use 5 character "HH:mm" format, although Cumulus 1 will accept other separator characters where ":" shown.
* The field description is shown, together with references to where that terminology is explained

== Table listing Fields ==

{| class="wikitable" border="1"
|-
!style="width:50px" | Field number
!style="width:50px" | Spreadsheet column
!style="width:200px" | Field type
!style="width:600px" | Description
|-
|0
|Colspan="4" style="background: pink;"|For internal MX purposes, the zero field identifies a field that holds the line number. It is not actually stored as a field in the log file, but precedes any line exchanged via an application programming interface, and therefore is also included in an array representing all the fields in any log file line.

If you are processing this log file using a third party (or your own) script, that probably does not place the line number into any array, and your array elements will start at 0 for the field labelled 1 in this table, so putting all field numbers out by 1.
|-
|colspan="4" style="background:lightgray;"|Those fields included below have been in dayfile.txt from the start of Cumulus 1 (Version 1.0, the First release on 27th January 2004).
|-
|1
|A
|8 characters
|Date as ''2 figure day [separator] 2 figure month [separator] 2 figure year'' - the separator is that set in the windows system short date format (see [[setup]])
|-
|2
|B
|Unsigned number
|Highest wind [[Wind_measurement#Weather_Stations_and_Cumulus|gust]] speed
|-
|3
|C
|unsigned integer
|[[Wind_measurement#Wind_Direction | Bearing]] of highest wind gust
|-
|4
|D
|5 characters
|Time of highest wind gust
|-
|5
|E
|signed decimal
|Minimum [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | temperature]]
|-
|6
|F
|5 characters
|Time of minimum temperature
|-
|7
|G
|signed decimal
|Maximum temperature
|-
|Colspan="4" style="background: pink;"| Consistency Note: In some cases Minimum comes before Maximum, in other cases Maximum is before Mimum
|-
|8
|H
|5 characters
|Time of maximum temperature
|-
|9
|I
|Unsigned number
|Minimum [[Pressure_Measurement | sea level pressure]]
|-
|10
|J
|5 characters
|Time of minimum pressure
|-
|11
|K
|Unsigned number
|Maximum sea level pressure
|-
|12
|L
|5 characters
|Time of maximum pressure
|-
|13
|M
|unsigned number
|Maximum [[Rain_measurement#Rain_Rate | rainfall rate]]
|-
|14
|N
|5 characters
|Time of maximum rainfall rate
|-
|15
|O
|unsigned number
|Total rainfall for the day
|-
|colspan="4" style="background:lightblue;"|Above here represents the minimum length for every line, a count of 15 items
|-
|colspan="4" style="background:pink;"|[There is no record of which version added this next field. The Cumulus Support Forum, while it was hosted by Steve Loft, moved to new forum software (phpBBB3) on 2 Jun 2008, and started afresh without retaining any previous content. Therefore all announcements about the content of each build prior to version 1.7.9 were lost. All that can be deduced is that it was between versions 1.2.5 and 1.5.1 as these do not appear in the release history issued by Steve Loft. The first mention of it in the new forum was not until December 2008, but that was not about when it was released. A web tag for this variable was added in Build 978 of 1.9.1 beta, which was obviously long after it was first calculated.

Because of that, in "DataEditor.cs" (part of the source code that is compiled into CumulusMX.exe) this addition has "Extended for ???" as a comment]
|-
|16
|P
|signed decimal
|[[Average temperature]] for the day
|-
|colspan="4" style="background:lightgray;"|(Wind run was added from version 1.8.4)
|-
|17
|Q
|unsigned number
|Daily [[Windrun | wind run]]
|-
|colspan="4" style="background:lightgray;"|(The next pair of entries were added from version 1.8.9 build 907 (June 2010) as part of a total redesign of how dayfile.txt was implemented in Cumulus 1)
|-
|18
|R
|unsigned number
|Highest [[Wind_measurement#Weather_Stations_and_Cumulus|Average Wind Speed]]
|-
|19
|S
|5 characters
|Time of Highest Avg. Wind speed
|-
|colspan="4" style="background:lightgray;"|(The two pairs of humidity entries were added in October 2010, a v 1.9.0 beta, the exact build number is now lost)
|-
|20
|T
|unsigned integer
|Lowest [[Temperature_(and_humidity)_measurement | humidity]]
|-
|21
|U
|5 characters
|Time of lowest humidity
|-
|22
|V
|unsigned integer
|Highest humidity
|-
|23
|W
|5 characters
|Time of highest humidity
|-
|colspan="4" style="background:lightgray;"|(The next two entries were added from version 1.9.0)
|-
|24
|X
|(not documented)
|Total evapotranspiration (Only valid for Davis stations, shows zero otherwise)
|-
|25
|Y
|unsigned
|Total hours of sunshine (only valid if sunshine sensor connected)

'''Important if rollover time is 9 am or 10 am:''' Most fields in this file are updated taking information from [[today.ini]]. For a non-midnight rollover, then the Sunshine hours reported here is from 00:01 on the calendar date corresponding to the date in the first field of this file, to subsequent midnight, and that end time is 9 or 10 hours before when this file is updated. Meanwhile, the sunshine hours count has been reset and so the figure in today.ini is not what is wanted here. For that reason the sunshine hours reported here are taken from [[yesterday.ini]].
|-
|colspan="4" style="background:lightgray;"|(The next 16 entries were added from version 1.9.1 May 2011)
|-
|26
|Z
|signed decimal
|High [[Heat index]] (added to Cumulus in 1.7.11 only as spot value, not stored)
|-
|27
|AA
|5 characters
|Time of high heat index
|-
|28
|AB
|Signed decimal
|High [[Apparent temperature]]
|-
|29
|AC
|5 characters
|Time of high apparent temperature
|-
|30
|AD
|signed decimal
|Low apparent temperature
|-
|31
|AE
|5 characters
|Time of low apparent temperature
|-
|32
|AF
|unsigned number
|High hourly rain
|-
|33
|AG
|5 characters
|Time of high hourly rain
|-
|34
|AH)
|signed decimal
|Greatest [[wind chill]] (high wind speed, low temperature) (calculated since version 1.8.3 as spot value, not stored)
|-
|35
|AI
|5 characters
|Time of greatest wind chill
|-
|colspan="4" style="background:lightgray;"|(The next two pairs for dew point were added in version 1.9.2 beta build)
|-
|36
|AJ
|signed decimal
|High [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | dew point]]
|-
|37
|AK
|5 characters
|Time of high dew point
|-
|38
|AL
|signed decimal
|Low dew point
|-
|39
|AM)
|5 characters
|Time of low dew point
|-
|colspan="4" style="background:lightgray;"|(The next three entries were added in version 1.9.2 Build 1004)
|-
|40
|AN
|unsigned integer
|Today's dominant/average wind direction
|-
|41
|AO
|unsigned decimal
|[[Heat/cold degree days and Chill hours | Heating degree days]]
|-
|42
|AP
|unsigned decimal
|[[Heat/cold degree days and Chill hours | Cooling degree days]]
|-
|colspan="4" style="background:lightgray;"|The next two pairs were added in legacy version 1.9.3 build 1036 (these only show valid values if appropriate sensors exist).

Fields listed up to those following here applied to the final legacy Cumulus 1.9.4 and formed the basis for early releases of Cumulus MX.
|-
|43
|AQ
|unsigned decimal
|High solar radiation
|-
|44
|AR
|5 characters
|Time of high solar radiation
|-
|45
|AS
|unsigned decimal
|High UV Index
|-
|46
|AT
|5 characters
|Time of high UV Index
|-
|colspan="4" style="background:lightgray;"|The next two pairs were added in MX release 3.6.0, 2 more derived values and their times
|-
|47
|AU
|signed decimal
|High [[Feels Like]] temperature
|-
|48
|AV
|5 characters
|Time of high feels like temperature
|-
|49
|AW
|signed decimal
|Low Feels Like temperature
|-
|50
|AX
|5 characters
|Time of low feels like temperature
|-
|colspan="4" style="background:lightgray;"|The next two pairs were added in release 3.6.12

*Version 3.6.12 (build 3088) was an emergency release to cure serious problems in previous build 3087. It added the following 4 fields (2 values and their times).
**The 4 extra fields are left empty in this release, although you can add values and time-stamps using the dayfile editor.
*From release 3.7.0 the first 2 of these 4 fields are populated, and the last 2 are removed, so I have labelled them as error.
|-
|51
|AY
|signed decimal
|High Canadian Humidity Index or [[Humidex]]
|-
|52
|AZ
|5 characters
| style="background:pink;"|Time of high Humidex

'''Bug for releases 3.13.0 to 3.14.2 inclusive''': The major code rewrite for release 3.13.0 replaced the previous code for the processing for all Cumulus files, the new code incorrectly stored ''Time of high feels like temperature'' in this field for all these releases! Corrected in minor code rewrite for 3.14.3 - b3163 25 Jan 2022 (not released to public until 3.15.0 - b3169 Released 31 Jan 2022)
|-
|colspan="4" style="background:lightblue;"|Just confirming that the next 2 fields were included by mistake in an emergency release (3.6.12), and are not included in any other version, so have labelled them as error.
|-
| 53 ('''error''')
| BA
| signed decimal
| Labelled as Low Humidex, but not used, (appear in 3.6.12, but no other release)
|-
| 54 ('''error''')
| BB
| 5 characters
| Labelled as Time of low Humidex, but not used, (appear in 3.6.12, but no other release)
|-
|colspan="4" style="background:lightgray;"|The next value was added in release 3.12.0
|-
| 53 (new)
| BA
| unsigned decimal
| [[Heat/cold_degree_days_and_Chill_hours#Chill_Hours_and.2For_Air_Frost|Cumulative Chill Hours]] since start of season
|-
|colspan="4" style="background:lightgray;"|The next value and time fields were added in release 3.20.0
|-
| 54
| BB
| unsigned decimal
| Highest rainfall total in (an approximate, as it depends upon timing of earlier entries in [[Recent history]]) 24 hour period ending in [[Meteorological day]]
|-
| 55
| BC
| 5 characters
| Time when (approximate) 24 hour period for rainfall total above ends
|}

==Example of the file==

An extract of a few lines of a dayfile.txt

<pre>
01/08/11,19.3,61,10:22,12.5,06:58,23.8,14:49,1014.26,20:46,1018.83,09:28,0.0,00:00,0.0,17.8,21.6,4.6,10:44,36,14:14,86,01:56,3.56,8.9,23.8,14:49,23.1,14:50,12.3,06:59,0.0,00:00,12.5,06:58,11.3,00:16,6.9,14:34,354,2.0,1.5

02/08/11,16.1,20,16:55,14.7,06:45,24.2,13:54,1013.79,19:13,1015.65,11:14,0.0,00:00,0.0,18.9,13.7,8.0,15:55,42,20:42,85,06:50,2.79,4.9,24.2,13:54,24.3,13:55,15.1,06:40,0.0,00:00,14.7,06:45,14.8,11:59,7.0,21:09,57,1.0,1.7

03/08/11,14.5,36,17:23,14.9,05:50,24.6,14:46,1012.70,18:44,1015.99,08:34,0.0,00:00,0.0,19.4,17.2,4.8,16:04,50,14:38,79,07:04,3.05,5.8,24.6,14:46,25.4,14:47,15.0,05:50,0.0,00:00,14.9,05:50,14.2,20:01,8.9,00:16,32,0.8,1.9

04/08/11,17.7,16,15:43,14.1,06:20,25.3,15:06,1013.08,18:42,1015.31,08:28,0.0,00:00,0.0,20.2,19.4,8.1,14:12,52,18:20,92,06:55,3.30,9.1,25.3,15:06,26.8,14:55,14.9,06:20,0.0,00:00,14.1,06:20,15.8,14:55,12.5,06:25,36,1.0,2.9

05/08/11,16.1,32,12:52,14.2,06:12,22.2,14:07,1013.89,00:01,1016.36,09:43,0.0,00:00,0.0,18.6,21.6,5.2,13:00,62,15:57,87,06:11,3.30,8.4,22.2,14:07,23.5,14:10,14.8,07:19,0.0,00:00,14.2,06:12,15.4,10:33,12.0,06:03,34,0.9,1.3

06/08/11,16.1,309,11:15,14.3,05:29,22.4,17:12,1014.46,20:02,1016.97,10:38,0.0,00:00,0.0,18.4,19.2,5.5,16:21,55,13:33,92,05:20,2.79,7.9,22.4,17:12,23.3,18:17,15.1,06:09,0.0,00:00,14.3,05:29,14.2,18:12,10.9,10:38,32,1.1,1.3

07/08/11,17.7,342,13:24,12.9,05:47,24.1,14:53,1013.92,19:49,1016.43,09:36,0.0,00:00,0.0,18.4,19.1,6.3,14:06,48,12:45,89,05:36,3.30,9.0,24.1,14:53,24.6,15:48,13.3,05:47,0.0,00:00,12.9,05:47,14.6,15:52,10.7,11:33,11,1.6,1.7
</pre>

ExportMySQL.exe

2022-09-24T05:59:24Z

Sfws: Record as obsolete

OBSOLETE PAGE - please see [[Software#Export_To_MySQL]] re replacement.

Only applicable to MX, was PREVIOUSLY available in all builds.

For advice on using this executable please read [[Cumulus_MX#ExportMySQL.exe|Cumulus_MX article, executables section]]

There is also a '''ExportMySQL.exe.config''', please note both files must be from same release distribution in order for the functionality to work.

[[Category:Cumulus Files]]

Meteorological day

2022-09-21T18:40:11Z

Sfws: Resequence so background follows detail

{{Version badge Mx}}{{Version badge 1}}This page applies to both the original Cumulus software and MX.[[Category:Terminology]]

=Daily assignment=

The World Meteorological Office (WMO) allows individual nations some flexibility, and does not prescribe total international alignment. Thus the practice of UK Met Office, the Australian BOM, the Met organisations in New Zealand, Israel, Canada and the USA, each have differences that cannot be fully covered here (some get mentioned in forum posts, see [[#Read more]]).

Most weather organisations in the world still to some extent remain consistent with the traditional way of working. This means that they report by '''meteorological day'''. The table below shows this concept is not as simple as that sounds, generally that day is made up of several periods (see [[#Traditionally]]), and which date a period is assigned to depends on the weather measurement being recorded. For example the minimum temperature is most often experienced in early morning and the maximum temperature is most often experienced in mid-afternoon so these occur either side of the traditional 9 a.m. used to determine the date to which these daily extremes are assigned.

Steve Loft created Cumulus software, back in 2003, because he owned a weather station and he could not find any software that allowed him to process measurements in the way he wanted. The first public release, allowing other people to use his software, was on 27th January 2004. Most weather software can only report daily measurments on a calendar day basis (since midnight). Steve Loft did make a simplifying assumption that does not align with the practice of most Meteorological Offices, as the table also indicates, he decided to design Cumulus software so it would report all daily derivatives based on a day that started at 9 a.m., he later added reporting since midnight for rain. MX development by Mark Crossley has added reporting rainfall maximums in any 24 hour period and reporting maximum and minimum temperature since midnight.

The legacy Cumulus made the swap to 10 a.m. in Daylight Saving time optional, and also permits the use of a midnight rollover as another option.

The following table tries to illustrate the divergence if you choose a rollover time other than midnight:
{| class="wikitable" border="1"
|-
!style="width:30px" | Derivative
!style="width:800px" | Typical national practice
!style="width:800px" | Cumulus approach
|-
! scope="row"| Minimum Temperature
| The daily minimum temperature in the 12 hours (9 p.m. to 9 a.m.) prior to the traditional observation time is assigned to the date of that observation
| The daily minimum temperature in the 24 hours starting at the selected rollover time is assigned to the date of that rollover
|-
! scope="row"| Maximum temperature
| The daily maximum temperature in the 12 hours (9 a.m. to 9 p.m.) after the traditional observation time is assigned to the date that applies to both times
| Reported for day starting at rollover time
|-
! scope="row"| Average temperature
| The WMO says that daily temperature average is best calculated in a way that is comparable with historic climatic records, although it accepts there is some divergence between nations. The WMO preference is to report for mean temperature the average, of the minimum in previous 12 hours, and maximum in subsequent 12 hours, this ensures consistency with traditional climate statistics that might be dependent on a single observation of maximum and lowest per day.
* Prior to automatic recording, some stations would have manual recordings taken a few times a day, and if these were at 0600, 12:00, and 18:00, the mean might be calculated by adding the 3 readings, then adding the last again (to compensate for no night-time observations), and dividing by 4!
* Nations are permitted by WMO to use integrated averages for their internal purposes. (By integrated all automatic measurements that are available, the reported average is a better representation for the entire day).
| Every time Cumulus processes a temperature from your weather, after conversion to your units, and any calibration multiplier/offset has been applied, the resulting temperature is added to a total kept in [[today.ini]], incremented the count in the same file. The integrated [[Average_temperature|average]] reported at the end of the day is a simple calculation, the total is divided by the count.
|-
! scope="row"| Rainfall
| Some nations report the daily rainfall for the 24 hours prior to the standard observation time on a particular date (that time might be 9 a.m. or 3 p.m.). Others, throw their rainfall total back to previous date, i.e. recording the total for the 24 hours after 9 a.m on the particular date.
| Cumulus checks the current reading from a "count" supplied by weather station, it subtracts from this the count it stored at rollover time. From the count different, converted to required units, and calibrated, Cumulus assigns a rainfall total to the date when the day started. The later additional options of rain since midnight, and maximum rain in 24 hours, subtract current count from count at midnight and (tracking maximum) from count approximately 24 hours earlier respectively.
|-
! scope="row"| Sunshine Hours
| Always reported by calendar day (00:01 to 23:59, there is some inconsistency whether the exact second of midnight belongs to day just ended or day just starting)
| Regardless of which rollover time is selected, Cumulus always reports sunshine hours from one minute past midnight until exactly midnight for any day. Note, MX does this efficiently, by using [[yesterday.ini]] if necessary to store total at midnight; the legacy Cumulus 1 was dependent on internally (RAM) held counts, so (if that software was not running continuously) the count was reset when the legacy software was restarted.
|-
! scope="row"| Snowfall
| A snow day is reported by calendar day. The snow depth may be only reported at standard observation time of 9 a.m. (or as maximum that day)
| Processing changes by flavour:
* [[File:Badge vMx.png]] MX reports snow falling, snow lying, and snow depth, taken from the weather [[diary.db]]. If the hour part of the current clock time is less than [[Cumulus.ini#Data_Logging|SnowDepthHour]], the diary entry for previous calendar date is sought, for SnowDepthHour onwards it seeks diary entry with current calendar date
* [[File:Badge v1.png]] The legacy Cumulus reported just snow depth, but it used that to calculate the snow index for a month, year, or season. Again, it checks hour of clock time against [[Cumulus.ini_(Cumulus_1)#Read-only_parameters_in_the_Station_section|SnowDepthHour]] to decide which date to seek in [[Log.xml|Weather Diary]]. However, that diary could have any number of entries for any one date, so Cumulus permitted retrieval of any of those, but for snow index only uses last one of any date.
|-
! scope="row"| Highest and lowest pressure
| Reported for day starting at 9 a.m.
| Reported for day starting at selected rollover time
|-
! scope="row| Wind measurements
| Highest wind speed is reported, based on measurements involving averaging over 10 minutes, for day starting at 9 a.m. Gusts are highest speed reported in a 10-minute sample. [[Gale Days]] are reported for any day when for at least 10 minutes starting at midnight the sustained wind speed exceeds 39 mph (62 km/h, 34 kts) or more, equivalent to Beaufort F8 or above.
| Reported for day starting at selected rollover time
|}

==Choice of rollover time==

It has been mentioned that Cumulus allows for 3 rollover time choices:
# 9 a.m. throughout year (if timezone does not include daylight saving period, all days will be 24 hours long; otherwise there will be issues when clocks change to/from DST)
# 9 a.m. in winter, 10 a.m. when/if Daylight Saving Time applies (all days will be 24 hours long, throughout year; still will be issues when clocks change to/from DST)
# Midnight throughout year (if timezone does not include daylight saving period, all days will be 24 hours long; otherwise there will be issues when clocks change to/from DST)

Once you have made the choice of one of these rollover time settings, you will stick to that. If you make a change, then it is best to start with a new set of files in the [[data folder]] because the only unaffected file is '''all-time.ini'''.

Steve Loft did not ever share the code for Cumulus 1, but he did make some observations concerning his code. It appears some (but apparently not all) of his legacy code used a special time zone with a 9 a.m. rollover recording as if it was midnight on the date in question, i.e. the internal Cumulus clock was subtracting 9 hours from the computer clock; e.g. when a clock showed 3 p.m. the time stored by Cumulus (and this could be seen in certain tags that by default only showed date) was 06:00 on the date in question (not 15:00).

Cumulus MX consistently uses the clock time reported by whatever device is running the software; if that time is wrong for any reason, every action by MX will be recorded against wrong time, and possibly wrong date.

=Traditionally=

The modern Cumulus user tends to forget that computerisation is a fairly recent (at end of 20th century) change for weather recording, which started in a few places in ancient times, but became widespread from 19th century in most nations.

Older people will remember how weather was traditionally recorded because there were a lot of local measuring stations, often located in places where they could be seen, like parks within settlements, roofs of public buildings, near public viewing points at airfields, or in fields on edges of smaller settlements. The fairly standard layout of instruments made them very easy to spot. Such weather instruments were not directly connected to a computer. Observers could be seen to manually read the instruments at least once a day, traditionally at 9 a.m. (one hour later in daylight saving time). At key stations, observers made measurements every hour, and even more frequently at places like airfields, especially in increment weather.

Most measurements were manually logged onto a sheet, or into a notebook, as they were made. Semi-automated instruments, like barographs and sun recorders, were often spotted at tourist hot spots, these did record readings on a chart using a continuous process over a 24 hour or 7 day period. Once a day, or once a week, the chart paper was changed, it would then be manually read, and converted to recorded figures. For temperature, [[Temperature_(and_humidity)_measurement#James_Six_and_Diurnal_Variation_measurements|James Six]] invented an instrument that could store the highest and lowest temperatures between manual readings, and a muslin wick was used to record wet bulb temperatures in order to derive humidity and dew point.

Subsequently, longer period derivatives could be calculated from the manual measurements; and these might be either posted/phoned to the main weather service, transmitted electronically (originally by telex), or entered into an electronic record (probably shared in arrears).

=Modern era=

Towards the end of the 20th century, not only did computers become small enough to be located on a widespread basis, but electronic sensors that could record various weather parameters started to become cheap, reliable, and widely available. Also the invention of the teleprinter, and later of internet, provided ways of electronically sharing in near enough real-time.

Thus the concept of recording/sharing weather data in real-time finally became available.

Subsequently labour costs mean that in most nations, few physical weather stations remain, generally maintained only for two purposes. The first purpose is to serve the needs of pilots, most airfields continue to have local recording sensors, fully automatic at some airports, supplemented by manual observations at airports prone to fog or other issues of concern, and still manually operated at smaller airfields that have not invested in computerised kit. The second purpose is to provide consistency with past measurements where still used to inform climatological models based on measurements over 1 to 3 decades, this has preserved a few physical representational sites in each nation.

For all other locations, there is a reliance on satellites to sense the weather. National meteorological services use mathematical models to interpolate those widely spaced sensings to produce estimates of readings, and to make forecasts, for a more local grid based network of locations.

=Read more=

[https://cumulus.hosiene.co.uk/viewtopic.php?f=10&t=17925&p=139901#p139901 thunder, rainfall, mean sea level pressure, snow days, fog day, minimum and maximum temperature]

[https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=5177 minimum temperature, and rainfall, a day out]

[https://library.wmo.int/doc_num.php?explnum_id=4166 WMO guidance for climate normals] see table 1 on page 3 where it says " Different methods are in operational use for the calculation of daily mean temperature."

Realtime.txt

2022-09-18T16:49:32Z

Sfws: Start to make the page more MX friendly

{{Template:Version badge Mx}}{{Version badge 1}}This Wiki page applies to both Cumulus flavours.

[[Category:Cumulus Files]] [[Category:MX_txt_Files]]
This Wiki page describes one of the [[:Category:Cumulus Files|files]] that Cumulus can optionally generate.

= List of fields in the file =

The list below represents the field list for the final 1.9.4 version of Cumulus, (and releases of MX before 3.7.0).

For historic interest, old versions of Cumulus 1 had fewer fields; although the table does not indicate the version at which each field was added, you can click the '''History''' tab and look at the early edits.
{| border="1" class="wikitable"
|-
! style="width:60px" | Field number
! style="width:80px" | Example content
! style="width:450px" | Description
! style="width:90px" | Equivalent [[Webtags|web tag]] if your locale/region uses decimal points See [[#MX web tags]] for equivalents in latest MX releases.
|-
| 1
| 19/08/09
| Date as ''2 figure day [separator] 2 figure month [separator] 2 figure year'' - the separator is that set in the windows system short date format (see [[setup]])
| <#date>
|-
| 2
| 16:03:45
| time(always hh:mm:ss as per computer system)
| <#timehhmmss>
|-
| 3
| 8.4
| outside temperature
| <#temp>
|-
| 4
| 84
| [http://en.wikipedia.org/wiki/Relative_humidity relative humidity]
| <#hum>
|-
| 5
| 5.8
| [http://en.wikipedia.org/wiki/Dewpoint dewpoint]
| <#dew>
|-
| 6
| 24.2
| wind speed (average)
| <#wspeed>
|-
| 7
| 33.0
| latest wind speed reading
| <#wlatest>
|-
| 8
| 261
| wind bearing (degrees)
| <#bearing>
|-
| 9
| 0.0
| current rain rate (per hour)
| <#rrate>
|-
| 10
| 1.0
| rain today
| <#rfall>
|-
| 11
| 999.7
| barometer (The sea level pressure)
| <#press>
|-
| 12
| W
| current wind direction (compass point)
| <#currentwdir>
|-
| 13
| 6
| wind speed as in 6 converted to force number ([http://en.wikipedia.org/wiki/Beaufort_scale beaufort])
| <#beaufortnumber>
|-
| 14
| km/h
| wind units - m/s, mph, km/h, kts
| <#windunit>
|-
| 15
| C
| temperature units - degree C, degree F
| <#tempunitnodeg>
|-
| 16
| hPa
| pressure units - mb, hPa, in
| <#pressunit>
|-
| 17
| mm
| rain units - mm, in
| <#rainunit>
|-
| 18
| 146.6
| wind run (today)
| <#windrun>
|-
| 19
| +0.1
| pressure trend value (The average rate of pressure change over the last three hours)
| <#presstrendval>
|-
| 20
| 85.2
| monthly rainfall
| <#rmonth>
|-
| 21
| 588.4
| yearly rainfall
| <#ryear>
|-
| 22
| 11.6
| yesterday's rainfall
| <#rfallY>
|-
| 23
| 20.3
| inside temperature
| <#intemp>
|-
| 24
| 57
| inside [http://en.wikipedia.org/wiki/Humidity humidity]
| <#inhum>
|-
| 25
| 3.6
| [http://en.wikipedia.org/wiki/Wind_chill wind chill]
| <#wchill>
|-
| 26
| -0.7
| temperature trend value (The average rate of change in temperature over the last three hours)
| <#temptrend>
|-
| 27
| 10.9
| today's high temp
| <#tempTH>
|-
| 28
| 12:00
| time of today's high temp (hh:mm)
| <#TtempTH>
|-
| 29
| 7.8
| today's low temp
| <#tempTL>
|-
| 30
| 14:41
| time of today's low temp (hh:mm)
| <#TtempTL>
|-
| 31
| 37.4
| today's high wind speed [[Wind_measurement#Weather_Stations_and_Cumulus |(of average as per choice)]]
| <#windTM>
|-
| 32
| 14:38
| time of today's high wind speed (average) (hh:mm)
| <#TwindTM>
|-
| 33
| 44.0
| today's high wind gust
| <#wgustTM>
|-
| 34
| 14:28
| time of today's high wind gust (hh:mm)
| <#TwgustTM>
|-
| 35
| 999.8
| today's high pressure
| <#pressTH>
|-
| 36
| 16:01
| time of today's high pressure (hh:mm)
| <#TpressTH>
|-
| 37
| 998.4
| today's low pressure
| <#pressTL>
|-
| 38
| 12:06
| time of today's low pressure (hh:mm)
| <#TpressTL>
|-
| 39
| 1.8.7
| [[Cumulus Versions]] (the specific version in use)
| <#version>
|-
| 40
| 819
| Cumulus build number
| <#build>
|-
| 41
| 36.0
| 10-minute high gust
| <#wgust>
|-
| 42
| 10.3
| [[Heat index]]
| <#heatindex>
|-
| 43
| 10.5
| [[Humidex]]
| <#humidex>
|-
| 44
| 13
| [http://en.wikipedia.org/wiki/Uv_index UV Index]
| <#UV>
|-
| 45
| 0.2
| [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration] today
| <#ET>
|-
| 46
| 14
| [http://en.wikipedia.org/wiki/Solar_radiation solar radiation] W/m2
| <#SolarRad>
|-
| 47
| 260
| 10-minute average wind bearing (degrees)
| <#avgbearing>
|-
| 48
| 2.3
| rainfall last hour
| <#rhour>
|-
| 49
| 3
| The number of the current (Zambretti) forecast as per [[Strings.ini]].
| <#forecastnumber>
|-
| 50
| 1
| Flag to indicate that the location of the station is currently in daylight (1 = yes, 0 = No)
| <#isdaylight>
|-
| 51
| 1
| If the station has lost contact with its remote sensors "Fine Offset only", a Flag number is given (1 = Yes, 0 = No)
| <#SensorContactLost>
|-
| 52
| NNW
| Average wind direction
| <#wdir>
|-
| 53
| 2040
| Cloud base
| <#cloudbasevalue>
|-
| 54
| ft
| Cloud base units
| <#cloudbaseunit>
|-
| 55
| 12.3
| [[Apparent temperature]]
| <#apptemp>
|-
| 56
| 11.1
| Sunshine hours so far today
| <#SunshineHours>
|-
| 57
| 420.1
| Current theoretical max solar radiation
| <#CurrentSolarMax>
|-
| 58
| 1
| Is it sunny? 1 if the sun is shining, otherwise 0 (above or below [[Cumulus.ini_(Cumulus_1)#Section:_Solar |threshold]])
| <#IsSunny>
|}

==Fields added with later releases of MX ==

Please be aware that MX develops very rapidly, and there is a lack of contributors to the Wiki, so the information here may be out of date.

{| border="1" class="wikitable"
|-
! style="width:60px" | Field number
! style="width:80px" | Example content
! style="width:450px" | Description
! style="width:90px" | Equivalent [[Webtags|web tag]] if your locale/region uses decimal points See [[#MX web tags]] for equivalents in latest MX releases.
|-
|59 (only included for release 3.7.0 and later)
| 13.6
| Feels Like
|<#feelslike>
|}

= Bandwidth Considerations =

Most internet providers now place a limit on the amount of Bandwidth you can consume each month. Bandwidth is a figure representing the quantity of data you can upload and download. The various uploads done by Cumulus will have a huge impact on your allowance if you choose to upload at very frequent intervals.

* Sizing guidance for the legacy Cumulus (1) uploads:
** The "realtime.txt" file the is less than 1024 bytes in size, but for the calculation we will assume 1024 bytes, and typically this is (for non Fine Offset stations, see [[#Special note to Fine Offset/EasyWeather users]]) updated every 5 to 15 seconds depending on your [[#Enabling generation of this file in MX|'Realtime interval' setting]]. 1 kilobyte every 10 seconds represents 144 kB a day.
** Uploading [[FAQ#What_is_the_size_of_the_standard_Cumulus_update.3F|the realtime.txt plus the standard templates]] represents about 90 MB per day (based on uploading only every 10 minutes).

* Sizing guidance for MX uploads:
** For Cumulus MX, the optional '''realtime.txt''' file is at least 262 bytes, (a lot of the content never changes, but if you have enabled generation and upload of this file, the whole file is uploaded every time), so still smaller than that 1024 bytes, and therefore still less than 1.5 MB a day even if uploaded every second.
** The [[SteelSeries Gauges]] web page is often supplied with data every second, (34 560 times a day), that represents a minimum of 110 MB per day, as the mandatory file '''realtimegaugesT.txt''' is 2.2 kiloBytes (kB).
** MX graph drawing uses assorted [[:Category:JSON_Files|*.json]] files which add up to several megabytes (MB) at every upload (compared against the highly compressed legacy Cumulus graph images of 400 kB per upload). So assuming these .json files are uploaded at the standard interval and that is set to 1 minute, just for graph plotting, MX requires a further 150 to 350 MB per day, this is dependent on various settings (e.g. data period represented on graphs, which graphs are being plotted).
** For the other web pages, the file concerned is [[websitedataT.json]] which is 31.5 kB, and if that is uploaded every minute, that adds about 50 MB a day.
** Don't forget that you may have files uploaded at end of day, you may be sending files to third party sites, to home automation, and be uploading [[MySqlConnect|SQL commands]], all these need to be multiplied by how often they are sent in a day, and then included in your calculation where relevant.

On top of your internet connection bandwidth restrictions, you may also have bandwidth caps on your database, or web, servers so this same figure should be considered for your various servers.

= Explaining the file =

Cumulus optionally generates this file, it represents one way that current Cumulus derivatives can be supplied to any [[:Category:User Contributions|third party additions]] you use, or your own external purposes.

Three examples taken from third party [[:Category:AddOns|addons]]:
* [[CumulusRealtime|developing real time]] functionality. This add-on is by the author of Cumulus, Steve Loft, and involves 2 extra wind graphics added at the bottom of the example 'gauges' page in the web template set produced by Cumulus 1, it was developed using [http://silverlight.net/ SilverLight] and uses data obtained by reading this file
* [[WeatherConsole]]
* [[Sidebar gadget]]

There are two key points to understand about the source for generation of the file:
#First is that a [[Cumulus template file]] is held internally in the Cumulus code that can generate this file with some standard content as [[#List of fields in the file|listed in table above]]
# Second is that this internal template, regardless of any locale (or region) settings, always generates the file so that it is readable by [[PHP#Incorporating_Script|script languages]] that expect a full stop to separate the integer part of any real number from the decimal part of that real number.

Information about the default generated file:
* As hinted above, the generation of the file requires you to set various options, see [[#Generation of this file]]
* There is no functionality, included in any Cumulus software that you download, that requires this file to exist
* The '''realtime.txt''' is generated as a text file with a single line of ''space'' separated values.
* The file contains a list of key values of the sensors
* The file is intended to be re-created frequently.
* The file is usually set to upload to your website, where it might be used as a source of near instant readings.
* The realtime.txt file will never contain any extreme records, nor any daily (or longer period) summaries, nor any historic data.

==Creating a customised real time file==

Some users, and some third-party supplied web pages, require fewer, or more, fields than those provided in the standard '''realtime.txt''' file.

Arranging this is easy, the content of a file, that Cumulus uploads to an external site for you, can be tailored to the needs of whatever you choose.

All you need to do is create your own [[Cumulus template file]], sometimes called ''realtime-xT.txt'' (to indicate it is an e''X''tra file, a ''T''emplate file and is related to ''realtime''.txt), you can place this file in the [[web folder]], and ask Cumulus to process that file for you:
* [[File:Badge v1.png]] Legacy software versions:
*# Create the template file picking the web tags you want to include from:
*#* If you use decimal commas, the list [[Webtags#CURRENT_CONDITIONS:|here]]
*#* If you use decimal points, the list [[Webtags#Current_Conditions|here]]
*# Arrange for the processing and uploading by using the Cumulus menu selections: '''Configuration''' → ''Internet'' → '''Files''' tab dialog. [[File:Cumulus Internet Settings Files.png|Right]]
*#* Type in the name you have used for your template file in ''Local Filename''
*#* Tick the ''Process?'' checkbox,
*#* Tick the ''Realtime?'' checkbox,
*#* Finally, supplying a remote path and filename that you want created remotely, you can call it "realtime.txt" after the path name if you like
* [[File:Badge vMx.png]] From build 3075 onwards, all decimal web tags now support the "rc=y" modification parameter.
*# Create the template file based on the list of web tags in the code snippet [[#MX web tags|below]]. If you are unsure what they represent, look [[Webtags#Current_Conditions|here]].
*# Arrange for the processing and uploading by using the '''Extra web files''' page in the [[MX_Administrative_Interface#Extra_Web_Files|interface]], follow the instructions in that link, [[File:Extra web settings.png|Right]] ticking the ''Process?'' checkbox, the ''Real Time?'' checkbox, and the '''UTF8''' checkbox (as shown in first row in image)

===MX web tags===
''(this is one complete line, although it may appear on this page as two or more due to screen width restrictions)''

:<code><#date format=dd/mm/yy> <#timehhmmss> <#temp rc=y> <#hum> <#dew rc=y> <#wspeed rc=y> <#wlatest rc=y> <#bearing> <#rrate rc=y> <#rfall rc=y> <#press rc=y> <#currentwdir> <#beaufortnumber> <#windunit> <#tempunitnodeg> <#pressunit> <#rainunit> <#windrun rc=y> <#presstrendval rc=y> <#rmonth rc=y> <#ryear rc=y> <#rfallY rc=y> <#intemp rc=y> <#inhum> <#wchill rc=y> <#temptrend rc=y> <#tempTH rc=y> <#TtempTH> <#tempTL rc=y> <#TtempTL> <#windTM rc=y> <#TwindTM> <#wgustTM rc=y> <#TwgustTM> <#pressTH rc=y> <#TpressTH> <#pressTL rc=y> <#TpressTL> <#version> <#build> <#wgust rc=y> <#heatindex rc=y> <#humidex rc=y> <#UV rc=y> <#ET rc=y> <#SolarRad> <#avgbearing> <#rhour rc=y> <#forecastnumber> <#isdaylight> <#SensorContactLost> <#wdir> <#cloudbasevalue> <#cloudbaseunit> <#apptemp rc=y> <#SunshineHours rc=y> <#CurrentSolarMax> <#IsSunny> <#feelslike rc=y></code>

== Different interval or different file name ==

Occasionally there is a requirement from some users to create a copy of the realtime.txt file and have it posted to a location at the normal Cumulus web update interval rather than the real time interval, or perhaps because a filename other than realtime.txt is required.

Simply follow a variant on the instructions above.
* If you want the normal web update interval, don't tick the ''Realtime?'' checkbox.
* If you want a different filename, simply change what you put for ''Remote filename''.

=Generation of this file=

This is optional functionality, the default (in all flavours of Cumulus) is not to generate this file.

==Enabling generation of this file in MX==

The Settings pages of MX are being drastically rewritten as the software is developed.

Indeed the way of selecting generation of this file is due to change in the next release of MX as I type this, so specific instructions are not included here.

In general you need to make three selections:
# You need to enable the timer in MX that does actions at a real time interval.
# You need to configure (as a number of seconds) how frequently that timer triggers the actions
# You need to enable the file transfer (or if available, the copy) process that gets files uploaded onto an external (e.g. web) site
# You need to enable the generation of this specific file

==Enabling generation of this file in Cumulus 1==

The legacy screen that controls production of this file, is obtained by a click on the 'Configuration' menu then 'Internet', once the ''Internet Settings'' screen appears, you should be looking at the '''Sites/Options''' tab. That screen's original look (as Steve Loft included here) is in the larger image.

When he developed Cumulus 1 further, with two extra real-time boxes to tick to respectively, generate, and upload, the file, Steve Loft did not update the screen shots he included in this Wiki. [[Image:CumulusInternetSettingsScreen.png|Right]]

However, the smaller image (below) shows a later version of part of the original image;
[[File:Web settings.JPG|left]] and you will see the new set of three tick boxes in the lower part of that smaller image:
*The 'Realtime interval' sets how often Cumulus produces the file, to set that interval, set parameter labelled 'Realtime interval' by entering an integer number of seconds.
*Optionally the file can be uploaded to your [[Website_setup|externally-hosted web site]], if you want this (and it is usual) select all 3 selectors:
**Enable Realtime
**Enable Realtime FTP
**Realtime.txt FTP (Note in the smaller image this is not ticked, as not creating the file is the default)
*The uploading interval is the same as the file creation interval.

means that most of it gets very out of date, as MX is develo

= Special note to Fine Offset/EasyWeather users =

Weather stations which come shipped with the EasyWeather software should consider carefully how they use the real-time updating.

The station only updates every 48 (solar is only updated every 60) seconds, so aim for a real-time interval of around 30 seconds, that way a visitor knows not to expect updates too often but you also allow Cumulus to catch up to two updates within a minute (depending on when the first and second 48 second update came to Cumulus).

= Example of the file =

''(this is one complete line, although it may appear on this page as two or more due to screen width restrictions)''

 <tt>18/10/08 16:03:45 8.4 84 5.8 24.2 33.0 261 0.0 1.0 999.7 W 6 mph C mb mm 146.6 +0.1 85.2 588.4 11.6 20.3 57 3.6 -0.7 10.9 12:00 7.8 14:41 37.4 14:38 44.0 14:28 999.8 16:01 998.4 12:06 1.8.2 448 36.0 10.3 10.5 13 0.2 14 260 2.3 3 1 1 NNW 2040 ft 12.3 11.1 420.1 1 13.6</tt>

MySqlConnect

2022-09-13T08:23:50Z

Sfws: Update for 3.21.1

[[Category:Configuration Files]][[Category:Cumulus MX]]

This Wiki page provides a brief introduction to SQL, and describes the settings that define how CMX functionality is controlled.

= Why are Cumulus settings now split between several Wiki pages? =

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

MX has been developed very dramatically by Mark Crossley:
# The MySQL settings for the original 3.0.0 beta were 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)|that latter documentation remains available 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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>
# Since the MySQL settings have continued to change, since 2021 they have been moved here from that last mentioned page.

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

=What is SQL?=

SQL is an abbreviation of "Structured Query Language", SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory.

SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks.

SQL is a collection of languages. Each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words (and constructions) that all SQL dialects should obey.

==How does MX use SQL?==

MX uses two types of SQL.

MX uses SQL when updating a SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type of database stores data in what is known technically as a sequential file. In a sequential file, the data appears as a number of lines that have to be stored in order (by row number). Because entries can be deleted, not every possible row number has to be present, but new entries are appended at end. The various fields (or columns) are named, it is possible (but rarely done) to change the order of the columns, rewriting the entire database file. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifying content, but that gets translated into a row number to actually determine the row that is updated.

MX also uses SQL when creating, or updating, a relational database type. The commands issued by "MySqlConnect" software work with two types of relational databases, MySQL (commercial software by Oracle) and MariaDB (free software from an independent provider). A relational database also uses the row, column, and field terminology; but there is no control over the order in which rows are stored, there is an order for columns (although you can change the column order), and rows are identified by a unique key (known as "primary key" as a row can contain a secondary key that links to data in another table). Any retrieval query can specify that what is returned from that query should be sorted in an ascending/descending order of the value(s) in specified column(s).

==How does MX use MySqlConnect?==

MySqlConnect is used by both [[Software#Current_Release|CumulusMX.exe]] and [[Software#Export_To_MySQL|ExportToMySQL.exe]], but the latter only works with two of the default tables (those called "monthly" and "dayfile", or as renamed by the user).

Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:

{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu → MySQL settings → General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu → MySQL settings → Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu → MySQL settings → Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu → MySQL settings → Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu → MySQL settings → Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}

=The My SQL settings page in interface=

MX controls settings for the relational database tables on a page called "MySQL settings" although you may be using "MariaDB". Here is a screenshot of that page (with all sections closed up) as applicable from release 3.20.0 (build 3202):

[[File:MySQL settings.png]]

Please note, the text included elsewhere on this Wiki page may be for different release.

==Changes by MX release==

This Wiki page was created 20 August 2022, by doing a "cut" from the [[Cumulus.ini]] page as it had existed prior to then, and a "paste" onto this page.

# In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulus 3 software (MX beta 3.0.0).
# The information transferred in the cut/paste mentioned above related to the beta build 3135 of 3.12.0 (before subsequent development that led to formal release on 29 July 2021).
# Further development of MX, by Mark Crossley, resulted in changes at releases between 3.20.0 and 3.21.1, which have been reported below.

{{Template:WorkInProgressBanner}}

Whether this page reflects the latest MX release, depends on whether there have been any further developments, and whether any contributor has kept this page up to date.

{| class="wikitable" border="1"
|-
!style="width:30px" | Release
!style="width:50px" | Date
!style="width:300px" | Description
|-
| 3.0.0 b.3025
| Fri 22 May 2015 (Beta release)
| Cumulus can now update a MySQL database. There are six options:
* The first three are for [[realtime.txt]] data, [[Standard log files|monthly logfile data]], and [[dayfile.txt]] data; schema as [[ImportCumulusFile]] script. If respective option enabled, the appropriate SQL upload will take place when Cumulus creates the realtime.txt file, or appends a line to a monthly log or dayfile.txt. The MySQL settings screen has buttons for creating the tables, once you have submitted the configuration details.
* The last three options are for 'custom' MySQL uploads. For these, you need to supply the SQL insert statement, using webtags for the data, and you need to have created the table yourself. See [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 forum announcement] for example SQL.
|-
| 3.12.0 b.3134-BETA
| Thu 29 July 2021 (Released as b.3140)
| New: Adds the ability to buffer failed MySQL commands until the MySQL server becomes available again, or Cumulus MX is restarted - when they will be lost
# Enabled via an option in MySQL Settings
# Note: Whilst Realtime updates are buffered, the uploading of failed queries is only performed by the Log updates
|-
| 3.20.0 b.3199 commit a (31 July 2022)
| Sun 21 Aug 2022 (Released as b.3202)
| Multiple changes:
# New: Custom MySQLConnector Uploads (seconds, minutes, rollover) can now each have up to 10 commands:
#* The 10 commands are not available if MX is stopped and restarted, due to bugs:
#*# A copy and paste of code from 3.20.0 - b3197 beta (which changed Custom HTTP seconds/minutes/rollover strings so set to 10 URLs) error, meant the 10 SQL custom seconds, custom minute, commands are stored in <nowiki>[</nowiki>Http<nowiki>]</nowiki> section of file
#*# Another copy and paste error meant that custom rollover comands are only stored if custom minutes are enabled
# Change: Changes to dayfile MySQLConnector query, add specific reference to dayfile table, add extra columns for rain24hour
# A one-off MySQL script in the MXutils folder to alter existing dayfile table adding the 2 new extra columns for rain24hour
# Change: In interface, the MySQL Settings page gets new functions for checking number of columns, allowing updating of existing tables by adding columns to match the current schema
|-
| 3.21.0 b.3204
| Fri 2 Sept 2022
| Failed MySQL commands are stored in [[Cumulusmx.db|SQLite RecentData database table "SqlCache"]] to persist when CMX stopped/restarted (30 Aug commit 1) and can be individually edited/deleted (29 Aug commit 3 and 30 Aug commit 3)
|-
| 3.21.1 b.3205
| Sun 4 Sept 2022
| The 10 custom MySQLConnector Uploads (seconds, minutes, rollover) are now stored in/read from <nowiki>[</nowiki>MySql<nowiki>]</nowiki> section of '''Cumulus.ini''', so now preserved when CMX stopped/restarted. Also the bug re custom rollover is fixed, its commands are stored if custom rollover is enabled.
|}

==Introduction to the 6 SQL update options==

MX supports (default) tables where it determines the columns in the table , and (custom) tables where it determines when actions take place.

===The MX default database tables===

There are three default tables (by default called "realtime", "monthly", and "dayfile"; although these names can be changed by the Cumulus user) where Cumulus determines the '''schema''' (what columns appear in the database table)

For the default tables, every MySqlConnect command issued by MX specifies column names. Some MX releases add columns that were not present in earlier MX releases, and these releases should provide a utility that will add the extra columns to existing tables. The commands generated by CMX will fail if all named columns are not present in the table.

====Creation of default tables====

You must define how to access your database server, enable the particular table and indicate what the table is to be called first. Then you must click '''Save settings''' so all those details are registered before any create command will work.

For each default table, MX provides a button which (after database server details, table name and other settings have been saved) can send a '''CREATE table_name''' command to your database server. If a table with that name already exists, or certain other standard errors happen, MX can give you feedback. MX will also tell you when the SQL has worked, and the table has been created.

Note that as MX names the columns in any commands it generates, the named columns can be in any order in the table. The default order (as named in '''CREATE table_name''' command) represents when the relevant derivative was added to the corresponding Cumulus file. If you have the knowledge of the SQL command required to, or can use a tool (such as ''PhpMyAdmin'') that provides a user-friendly interface to do this, reorganise column order; then you can collect all wind-related columns together, all rain-related columns together, and so on, or simply put what you regard as most important columns before others.

====Modifying schema (columns in table)====

Some release announcements for MX mention that extra columns have been added to a particular table. A script may be provided (either in release announcement, or in the '''MXutils''' directory within the download, that you can run to add the extra columns. For example '''b3089-AlterMySqlTables.sql''' was provided in the '''MXutils''' directory with build 3089 to add the ''Feels Like temperature'' columns

In release 3.20.0, '''v3.20.0-AlterMySqlTables.sql''' was provided to edit the "dayfile" table and add 3 new columns (cumulative chill hours, highest 24 hour rainfall, and time when highest 24 hour rainfall ended).

Release 3.20.0 as seen on screenshot below provides buttons (under heading of '''Update database table''') for each of the default tables. The code here is rather crude, it counts the number of columns currently defined in the table (does not check what names those columns have, nor what properties those columns have) and compares against number of columns that MX can automatically insert/update at that release in that table. It assumes columns appear in same order as the fields in related file, and modifies the table to add the extra columns in the correct position to match the respective file.

(If a Cumulus user adds extra columns to a default table, those extra columns must be defined with null as default value, so MX can ignore them, but the columns can be in any position).

====Populating rows that do not exist====

Use the utility described at [[Software#Export_To_MySQL]] for '''monthly''' or '''dayfile''' tables.

The only way to populate '''realtime''' is via the action described in settings page description.

====Populating missing/incorrect columns in existing rows====

The options provided in the ''Data logs'' menu of the interface can be used to edit a single line of a file, and there is a setting that lets that edit also update the corresponding single row of a default table.

Whilst it may not take long to send SQL for a single line update to your database server, it will take a lot of time to select each line in file in turn, and to send the SQL to insert every line to your database server.

To update one or more columns in multiple rows, you need to generate a succession of UPDATE queries, keeping the text to send to the database server as short as possible.

One way to do this is to open the relevant file using a spreadsheet (e.g. Libre Office has a "calc" option, this is free and available for most operating systems). Create an extra column after existing columns in the spreadsheet for the "primary key", you should be able to generate this from the first one or two columns of the spreadsheet with some manipulation. Now "Hide" all the columns except those with data that you want to include in the update, and the primary key column. With some spreadsheet skills (see https://cumulus.hosiene.co.uk/viewtopic.php?p=165767#p165767) you can generate the required SQL in this format:
<pre>
UPDATE name-of-table SET first-column-name=first-row-and-first-column-value, second-column-name=first-row-and-second-column-value WHERE primary-key-column-name=first-row-primary-key-value;
UPDATE name-of-table SET first-column-name=second-row-and-first-column-value, second-column-name=second-row-and-second-column-value WHERE primary-key-column-name=second-row-primary-key-value;
</pre>

Alternatively, if you have skills in a script language like PHP Hypertext Preprocessor (PHP) you can write a small script that reads the file within a loop, picks the fields required from the line of the file, and generates the SQL (as above), and after ending loop closes file and sends the SQL to the database server.

===Custom Interval actions on tables===

MX can run SQL (using MySqlConnect commands) that work with Oracle's MySQL, or the MariaDB, database servers at one, or more, of three intervals (MX calls these "custom seconds", "custom minutes", and "custom rollover").

You can enable/disable individual settings, but the mechanism is not designed to do any one-off actions like creating the custom tables.

The Cumulus user can create any number of custom tables, where the user chooses the "schema" (columns in the table). At each custom interval, actions can affect any number of these pre-created tables; and in fact you can define several commands to run in succession against any one table.

==== Predetermined SQL ====

The custom table options in MX require you to specify the SQL in advance of it being used.

This means you have to predetermine all the SQL you might use (conditionals can be included to decide what queries actually get executed if there are alternatives).

WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the Oracle MySQL Client or MariaDB syntax.

Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#tag_name_1 modifier_1>', '<#tag_name_2 modifier_2>' ....);

BEGIN NOT ATOMIC
IF '<#tag_name>' = '---' THEN
simpler query to run (perhaps creating a row for a particular Cumulus tag value);
ELSE
UPDATE table_name_2 SET column_name_1 = '<#tag_name_1 modifier_1>', column_name_2 = '<#tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>

From MX release 3.21.1, the INSERT and conditional can be defined in separate command boxes on the settings page.

=Structure of ''Cumulus.ini''=

The settings described here are held internally (stored in RAM) while CMX is running.

If you click ''Save settings'' on the '''Settings → MySQL settings''' page, then the settings are also stored in a file called "Cumulus.ini".

==File sections==

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

These File sections can appear in any order, MX has a default order set by the order in which the sections appear in the code that writes to the file.

If you prefer the File sections in another order, you can stop MX, and then rearrange the file section order. On restart of the software, MX will still find them, although it may spend more time searching! However, some MX releases discard existing file, and create a new file, so then order will revert too what MX chooses.

==Parameters==

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.

Steve Loft recommended that the user sorted the parameters alphabetically, this was because the file used to have to be edited manually as many settings were not included on settings pages. Having the parameters in alphabetical order made it easier to find what to edit, and to check a parameter did not appear more than once, as Cumulus ignores any duplicates. Now all settings are controlled by the interface, CMX determines the parameter order.

==Content of "Cumulus.ini" relating to MySQL==

* File Section is [MySQL]
* MX page is Settings menu → MySQL settings

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Applicability
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| BufferOnFailure=0
| 3.12.0 onwards
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| 3.0.0 to 3.21.0
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if ''Custom Minutes Enabled'' parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| 10 commands:
* CustomMySqlMinutesCommandString=
* CustomMySqlMinutesCommandString1=
* to
* CustomMySqlMinutesCommandString9=
| 3.21.1 onwards
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if ''Custom Minutes Enabled'' parameter is ticked
| (empty commands don't appear)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlMinutesEnabled=0
| 3.0.0 onwards
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| 3.0.0 onwards
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| 3.0.0 to 3.21.0
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if ''Custom Rollover Enabled'' parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| 10 commands:
* CustomMySqlRolloverCommandString=
* CustomMySqlRolloverCommandString1=
* to
* CustomMySqlRolloverCommandString9=
| 3.21.1 onwards
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if ''Custom Rollover Enabled'' parameter is ticked
| (empty commands don't appear)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlRolloverEnabled=0
| 3.0.0 onwards
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous, and next, options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| 3.0.0 to 3.21.0
| Custom Upload - seconds interval
| Option to enter "SQL command" only shown if '''Custom Seconds Enabled''' is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| 10 commands:
* CustomMySqlSecondsCommandString=
* CustomMySqlSecondsCommandString1=
* to
* CustomMySqlSecondsCommandString9=
| 3.21.1 onwards
| Custom Upload - at Seconds interval
| Option to enter "SQL command" only shown if ''Custom Seconds Enabled'' parameter is ticked
| (empty commands don't appear)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlSecondsEnabled=0
| 3.0.0 onwards
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| 3.0.0 onwards
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| 3.0.0 onwards
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| 3.0.0 onwards
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal rollover updates and "ExportToMySQl.exe" will use the table name you define. Depending which MX release you use, the option to update table when you edit "dayfile.txt" may fail!
|-
| Host=Localhost
| 3.0.0 onwards
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| 3.0.0 onwards
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| 3.0.0 onwards
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but at some releases the option to update table when you edit "MMMyyyyLog.txt" may fail
|-
| Pass=
| 3.0.0 onwards
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| 3.0.0 onwards
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| 3.0.0 onwards
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| 3.0.0 onwards
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| 3.0.0 onwards
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* 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
| 3.0.0 onwards
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| 3.12.0 - b3134 - BETA onwards
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see beginning of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| 3.0.0 onwards
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}

Cumulus.ini

2022-09-13T05:39:14Z

Sfws: Minor clarifications in response to forum post

<big>Please note this page was created 13 June 2021.

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

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

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

=Purpose of Cumulus.ini file=

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

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

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

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

[[Category:Configuration Files]]
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>

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

==Need to install MX 3.12.0 ==

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

The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from [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].

== Simplifications ==

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

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

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

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

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

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

=Structure of Cumulus.ini=

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

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

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

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

=How this Wiki page classifies settings=

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

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

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

==Tabular presentation==

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

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

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

==Terminology used on this Wiki Page==

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

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

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

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

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

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

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

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

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

=Settings Configuration for MX=

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

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

==What happens if I upgrade MX?==

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

==Where do I change settings?==

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

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

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

==Do I need to restart MX?==

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

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

The settings available on the various pages in the admin interface fall into two groups:
#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.

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

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

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

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

==How to Remove Redundant parameters from file==

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

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

''The following procedure is best done after'', not before, you [[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:

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

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

*Introduced Release 3.10.0 - build 3115
* File Section is [Program]

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|EnableAccessibility=0
| Two places where you can edit this setting:
* (Either) Program Settings → (First tick box)
* (Or) Station Settings → (First tick box)
|Enable accessibility features
|0 (disable)
|Determines styling of settings pages:
*Set to 1 to make this (and other pages) appear in a '''button selection''' style (more friendly on an accessibility basis).
*Leave it at zero for a '''Click ▶to expand, click ▼ to collapse''' styling.
|}

== Alarms (and emails) ==

The Alarm settings seem to frequently be changed by new MX releases, so have been moved to a separate [[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?

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

==Data Logging==

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

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

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

==Debugging==

* Available from beta MX.
* File Section is [Station]
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:300px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| Logging=1
| Depends on release installed:
# Alternatives:
#* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Debug logging
| 0 (disabled)
| This adds extra information about data transfers between your weather station and MX.

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

==Extra Web Files==

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

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

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

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:800px" | Description
|-
|style="background:lightgray;"|[FTP site]
|
|
|style="background:lightgray;"|Section name
|-
|ExtraLocal0= to ExtraLocal99=
|Local File Name
|(empty)
|You can enter:
* A relative path name, with respect to the "CumulusMX" root folder
** 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]
** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
* 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=
|Destination Filename
|(empty)
|Defines where MX is to upload file to
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
**I can't tell you what the file path is for your web server, but I can give a couple of examples to steer you
*** e.g. httpdocs/dayfile.txt
*** e.g. public_html/thismonthyear.htm
* If the FTP is not ticked, the file path should be full path for a file on the computer running MX
** e.g. /var/www/html/weather/images/moon.png could be destinatation for uploading the MX generated moon image to a Linux hosted [[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=
|Process
|0
|Simple tick or not
* 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'''
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
|-
|ExtraRealtime0= to ExtraRealtime99=
|Realtime
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if
*# 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]])
|-
|ExtraFTP0= to ExtraFTP99=
|FTP
|1
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
* Don't tick (value shown as 0 in Cumulus.ini) if the remote file is on the computer running MX and a simple Copy File is required
|-
|ExtraUTF0= to ExtraUTF99=
|UTF-8
|1
|Please see [[Reports_folder#Encoding|technical guidance on encoding]]
*Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters
*If unticked (0 appears in file), then iso-8859-1 encoding is used
|-
|ExtraBinary0= to ExtraBinary99=
|Binary
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
|-
|ExtraEOD0= to ExtraEOD99=
|End of Day
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
* Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]])
|}

== Location==

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

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| Altitude=0
| Station Settings → Location
| Altitude
| 0
| The height above mean sea level where the (pressure) sensor is positioned
|-
| AltitudeInFeet=1
| Station Settings → Location
| Altitude Units
| Default depends on release:
# 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=
| Station Settings → Location
| Name
| (empty)
| A short name for the location
|-
| LocDesc=
| Station Settings → Location
| Description
| (empty)
| A longer description for the location
|-
| "Latitude=0" and "LatTxt="
| Station Settings → Location → Latitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere → North or South"
| (blank)
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|-
| "Longitude=0" and "LongTxt="
| Station Settings → Location → Longitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere → East or West"
| (blank)
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|}

==Optional Report Settings==

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

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

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

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

===Normal Mean Temperatures===

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

===Normal Precipitation===

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

==Optional Structured Query Language Settings==

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

Since the text that appeared here was added, documenting plans for the future 3.12.0 release, there have been a number of changes, and now a future release (3.20.0) is expected to make more drastic changes. Therefore the content has been moved to a [[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"
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | File Section
!style="width:60px" | MX Section
!style="width:80px" | Action on Settings page
!style="width:20px" | Default
|-
| <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
|-
| <pre>User=
Password=
Language=en
Enabled=0
Interval=900
SendUV=0
SendSR=0
SendSoilTemp=0
SendIndoor=0
SendSoilMoisture=0
SendLeafWetness=0
SendAirQuality=0</pre>
| [Awekas]
| AWEKAS
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Enabled=0
CatchUp=1
APIkey=
StationId=
Interval=15</pre>
| [OpenWeatherMap]
| OpenWeatherMap
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [PWSweather]
| PWS Weather
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>User=
Password=
Enabled=0
Interval=60
OauthToken=unknown
OauthTokenSecret=unknown
TwitterSendLocation=1</pre>
| [Twitter]
| Twitter
| Please note that twitter is deprecated, no new settings possible, existing settings can be used by people who migrated from Cumulus 1 with working tokens
| Defaults are as shown in list of parameters
|-
| <pre>Wid=
Key=
Enabled=0
Interval=10
SendUV=0
SendSR=0
SendAQI=0
SendSoilMoisture=0
SoilMoistureSensor=0
SendLeafWetness=0
LeafWetnessSensor=0</pre>
| [WeatherCloud]
| WeatherCloud
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Enabled=0
StationUID=
Password=
Interval=1
SendRain=0</pre>
| [WindGuru]
| Windguru
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>APIkey=
StationIdx=0
Enabled=0
Interval=15
SendUV=0
CatchUp=1</pre>
| [Windy]
| Windy.com
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [WOW]
| Met Office WOW
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|}

==Optional Web Server==

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

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

* File Section is '''[Display]'''
* MX Section is '''Station Settings → 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
|-
| NumWindRosePoints=16
| Legacy Cumulus
| Number of wind rose points
| 16
| Drop-down determining if weather station bearing supplied by weather station is to be converted to 8 or 16 compass directions (i.e. whether to include or exclude (in English) NNE, ENE, ESE, SSE, SSW, WSW, WNW, and NNW
* 8 points
* 16 points
Despite what it says in the hint on the settings page, leave at default whichever weather station type you use, unless this actually causes you a problem. The parameter was introduced by Steve Loft. Davis wind vanes use a potentiometer to measure wind direction so send Cumulus a bearing that can vary continuously between 1 and 360 degrees. Fine Offset wind vanes use magnetic switches that depend on the magnet under the moving part selecting two switches in the fixed part for the vane being exactly in-between compass directions, and selecting one switch for the main 8 directions and slightly away from the main directions; so they have a bias against sending Cumulus the in-between directions.
|-
| UseApparent=1
| ??? MX 3.6.0 or 3.10.0 ???
| Use Apparent Temperature
| Ticked (shown as 1 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display apparent temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus prior to release 3.6.0
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to display feels like temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus from release 3.6.0
|}

=== 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"
|-
!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 )
| (n/a)
| *0 = Disabled (default)
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
|-
| Copy-airquality=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| airquality.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
|-
| Copy-alldailydegdaydata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailydegdaydata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailydegdaydata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailyhumdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailyhumdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailypressdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailypressdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailyraindata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailyraindata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailysolardata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailysolardata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-alldailytempdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailytempdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailywinddata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailywinddata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alltempsumdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailytempsumdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempsumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-availabledata=0
| [FTP site]
| Release 3.12.0
| ^ (once only)
| Internet Settings → Graph File Settings
| availabledata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[availabledata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-dailyrain=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| dailyrain.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-dailytemp=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailytemp.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-graphconfig=0
| [FTP site]
| Release 3.12.0
| ^ (once only)
| Internet Settings → Graph File Settings
| graphconfig.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[graphconfig.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-humdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| humdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[humdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-pressdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| pressdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[pressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-raindata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| raindata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[raindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-solardata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| solardata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[solardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-sunhours=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| sunhours.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[sunhours.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-tempdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| tempdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[tempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-wdirdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| wdirdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[wdirdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-websitedata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Standard File Settings
| websitedata.json → Copy
| 0 (disabled)
| Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]

Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the resulting websitedata.json to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-winddata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| winddata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[winddata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-wxnow=0
| [FTP site]
| Release 3.12.0
| ^ (disabled)
| Internet Settings → Standard File Settings
| wxnow.txt → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy that file to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| CopyMoonImage=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Moon Image
| Copy Moon image file
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy moon image file to your local web server (need to select "Generate Moon Image" see '''MoonImageEnabled=''' too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-airquality=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| airquality.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the airquality.json file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailydegdaydata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailydegdaydata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailydegdaydata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailyhumdata=0

| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailyhumdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyhumdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailypressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailypressdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailypressdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailyraindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailyraindata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyraindata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailysolardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailysolardata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailysolarydata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-alldailytempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailytempdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailywinddata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailywinddata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailywinddata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alltempsumdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailytempsumdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempsumdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-availabledata=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings → Graph File Settings
| availabledata.json → Generate
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[availabledata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-dailyrain=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailyrain.json → File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailyrain.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-dailytemp=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-graphconfig=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings → Graph File Settings
| graphconfig.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[graphconfig.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-humdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| humdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[humdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-pressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| pressdat.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[pressdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-raindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| raindata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[raindata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-solardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| solardata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[solardata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-tempdata=1
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-sunhours=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-tempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| tempdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[tempdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-wdirdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| wdirdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[wdirdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-websitedata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| websitedata.json → Generate
| 1 (enabled)
| Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]

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

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

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

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

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

==Program Start-up Options==

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

==Proxy==

This is a continuation of an experimental legacy Cumulus software feature, please see [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==

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

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

=== Solar===

Cumulus MX is unable to work out if you have a solar sensor, so these options are always displayed.
{| 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
|-
| SolarCalc=0
| [Solar]
| 3.13
| Station Settings → Solar
| Solar Calculation Method
| 0=Ryan-Stololzenbach
| Drop-down list:
* 0=Ryan-Stololzenbach
* 1=Bras
|-
| SunThreshold=75
| [Solar]
| 3.13
| Station Settings → Solar
| Sun Threshold (percent)
| 75
| Enter a number
|-
| SolarMinimum=0
| [Solar]
| 3.13
| Station Settings → Solar
| Solar minimum (W/m2)
| 30
| Enter a number
|-
| RStransfactorJul=0.80000000000000004
| [Solar]
| 3.14
| Station Settings → Solar
| RS Transmission factor (June)

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

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

{| 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
| [Station]
| 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0)
| Station Settings → General Settings
| Station type
| -1 (not yet defined)
| Drop-down
* -1 = "Select Station", shown before a selection from those below is made
* 0 = Davis Vantage Pro station
* 1 = Davis Vantage Pro2 or Vue station
* 2 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wireless connection (e.g. WMR-928 station)
* 3 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wired connection (e.g. WM-918 station)
* 4 = Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
'''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.
* 5 = Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] ('''without''' solar measurement sensors (with or without solar recharging))
* 6 = For all La Crosse WS23xx models e.g. WS2300
* 7 = Fine Offset/Watson/MyDel etc '''with Solar Sensors''' as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]].
* 8 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR100
* 9 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR200
* 10 = Instromet (with optional extra solar sensors or without)
* 11 = Davis WLL
* 12 = Ecowitt GW1000 and Froggit DP1500 (and any equivalents)

'''Selection made here determines what MX sections appear on the Station Settings page
|-
| Model=
| [Station]
| Early legacy version
| Station Settings → General Settings
| Station model
| (empty)
|The weather station model description that you want output by the web tag <#stationtype>
|}

===Airlink===

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

* Introduced Release
* File Section is [AirLink]
* Not Shown on Settings page?
IsWllNode=0
WLv2ApiKey=
WLv2ApiSecret=
AutoUpdateIpAddress=1
In-Enabled=0
In-IPAddress=0.0.0.0
In-WLStationId=-1
In-Hostname=
Out-Enabled=0
Out-IPAddress=0.0.0.0
Out-WLStationId=-1
Out-Hostname=
AQIformula=0
{| 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
|-
|
|}

===Davis===

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

====Davis VP/VP2/Vue====

{{Template:WorkInProgressBanner}} This table does not yet have all details in it.
* Introduced for legacy Cumulus
* File Section is [Station]
* Only "Shown on Settings page" if either "Type=0" or "Type=1"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:120px" | Default
!style="width:800px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|VP2SleepInterval=500
|
|500 (milli-seconds)
|the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds.
* if you suspect that data is being missed, reduce number
*For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
|-
|VPClosedownTime=x
|
|(default not yet documented)
| x is the number of seconds after the start of the re-connect attempts that you want the program to close itself
|-
|DavisCalcAltPress=1
|
|1
|Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude

CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.
*0 = Use SLP supplied by Davis
*1 = Convert the SP Davis supplies to AP using the altitude you have supplied.
|-
|SyncDavisClock=0
|
|0
|When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
*0 = Disabled, default (as deselected on the Station Configuration Screen)
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
|-
|ClockSettingHour=4
|
|4
|Controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*4 = 04:00 (default value)
*0-23 = 00:00 to 23:00
|-
|VP2ConnectionType=1
|
|
|Weather station connection type
*0 = serial (see next parameter to specify COM port)
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
*2 = TCP/IP (see later parameters to specify ports)
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
|-
|VP2TCPPort=22222
|
| 2222
|Communications port used if VP type has TCP/IP selected.
|-
|VP2IPAddr=0.0.0.0
|
| 0.0.0.0
|Weather station IP address if VP type has TCP/IP selected.
|-
|VP2PeriodicDisconnectInterval=0
|
|0 (disable)
|When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.

Set it to zero to disable, if you are not using the Weatherlink site.
|-
|LogExtraSensors=0
|
|0
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
|-
|UseDavisLoop2=1
|
|1 (use Loop2)
|The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
*1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default. The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
*0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.

Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.
|-
|DavisIPResponseTime=500
|
|500
|The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger, see Cumulus MX forum where times up to 2000ms are suggested.
|-
|ForceVPBarUpdate=0
|
|0 (normal)
| Added in build 3042 (January 2017).

The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|-
|DavisIncrementPressureDP=0
|
|1
|(from version 3.0.0 build 3042)
* 0= Pressure values shown to 1 decimal places when reported in mb/hPa, shown to 2 decimal places for inHg
* 1= Pressure values shown to 2 decimal places when reported in mb/hPa, shown to 3 decimal places for inHg
|-
|VPrainGaugeType=0
|
|1
|Specifies the units selected on your Vantage Pro Rain Gauge.
*0 = Metric Rain Adapter fitted, a 0.2mm gauge
*1 = Imperial gauge without adapter, a 0.01" gauge.
Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur.
|-
|DataLogging=0
|
|0
|(Build 3018 onwards).
*0 (default) = Cumulus MX will not add extra logging.
*1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large.
I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards).
|-
|AutoUpdateIpAddress=1
|
|1
|default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
|-
|ZeroConfig
|
|(default not known)
|set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|}

====Davis WeatherLink Live====

{{Template:WorkInProgressBanner}} 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"

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|
|
|
|
|}

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

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

* Introduced in a Legacy version
* File Section is [Station]
* MX Section is "EasyWeather File Settings"
* Only "Shown on Settings page" if "Type=4"

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

See [[FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads|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===

{{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
* File Section is [GW100]
* MX Section is "Ecowitt GW1000 Settings"
* Only "Shown on Settings page" if "Type=12"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|AutoUpdateIpAddress=1
|Auto-discovery
|1 (selected)
|Should MX attempt to discover IP address
*0=Disable
*1=Enable
|-
|IPAddress=
|IP address
|(no default)
| stores the IP address of your GW1000 WiFi logger
|-
|MACAddress=
|MAC addresss
|(no default)
|Populated by MX when auto-discovery enabled
|}

===Fine Offset Stations===

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

{| class="wikitable" border="1"
|-
!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:20px" | Default
!style="width:300px" | Description
|-
| FOReadAvoidPeriod=3
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Read Avoid Period
| 3 (seconds)
| If previous setting enabled, MX will avoid reading the circular memory from the number of seconds specified before it expects Fine Offset to be writing to the circular memory, to the number of seconds specified after it expects Fine Offset to be writing to the circular memory

(One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor)
|-
| ??
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Set the Fine Offset Logger interval to match Cumulus MX interval
| 0 (disabled)
| Simple tick or not - labelled as "Experimental - use with caution"
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to "update the Davis interval" (I said copy and paste was used from Davis section!) to match the interval MX is using.
* Don't tick (value shown as 0 in Cumulus.ini) for no effect on your weather station
|-
| FineOffsetReadTime=150
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Request/Read Delay
| 150 (milliseconds)
| Adjust time (in milliseconds) between request for read, and actual attempt to read data via USB
|-
| ProductID=-1
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| USB Product Id (PID)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|-
| SyncFOReads=0
| Legacy Cumulus
| Only if Fine Offset selected
| Station Settings → Fine Offset Settings
| Synchronise Reads
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
* Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data

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

===Instromet Settings===

{{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
* 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"

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:300px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| ComportName=xxxxxx
| Station Settings → Instromet Settings
| Serial port name
| /dev/ttyUSB0 (on Linux), COM1 (on Microsoft Windows)
| Only required if your station is connected via a real, or virtual, serial port
|-
|ImetBaudRate=19200
| Station Settings → Instromet Settings
| Serial Baud Rate (DavisBaudRate)
| 19200
| Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value
|-
| "SyncDavisClock=0" and "ClockSettingHour=4"
| Station Settings → Instromet Advanced Options
| "Sychronise Station Clock" and "Clock sync hour"
| Tick box not selected, data box set to 4
| Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.

*Simple tick or not
** Tick (value shown as 1 in Cumulus.ini) for MX to attempt to sychronise the Instromet Station Clock with your computer time. This ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time!
** Don't tick (value shown as 0 in Cumulus.ini) if you don't want MX to attempt to keep station clock in line with computer clock
* Box taking an integer
** The hour of the day when, if enabled, Cumulus will set the Instromet clock to within a minute of the same time as the computer. This will happen at a default time of 04:00 each day, (4 a.m.) unless the setting box is edited
|-
| ImetUpdateLogPointer=1
| Station Settings → Instromet Advanced Options
| Update logger pointer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to update the memory pointer to the last record after every 30 data reads
* Don't tick to disable this action
|-
|ImetWaitTime=500
| Station Settings → Instromet Advanced Options
| Delay between sending data read commands
| 500
| Specifies the time in milliseconds that Cumulus waits after one read, before it does the next read from an Instromet station. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
|-
| ImetReadDelay=500
| Station Settings → Instromet Advanced Options
| Delay after sending a command before trying to read data from the serial port
| 500
| Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
|}

===LaCrosse stations===

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

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!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: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 → Common Options → Advanced Options
| La Crosse max wind speed
| ???
| It is setting for the La Crosse max wind speed, where X is the maximum (before calibrated by any definitions in Offsets) wind speed in m/s that you want to allow. The value you supply should be in metres/second, regardless of what wind unit you are using in Cumulus
|}

It is assumed that [[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"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | External to MX edit
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|Humidity98Fix=0
| Stop MX and add this into file
|0 (disable)
|Applies to weather station types that never report more than 98% relative humidity.
*0 = Disabled (default)
*1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98%. Normally only useful for Oregon Scientific stations.
|-
|LogExtraSensors=0
| Stop MX and add this into file
|0 (disable)
|This setting determines whether MX looks for readings from extra temperature probes etc.
*0=Disabled (default)
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors..
|-
|WMR928TempChannel=N
| Stop MX and add this into file
|(by default no extra sensors)
|for WMR-928 stations (and other serial stations using the same protocol, eg WMR-968) to use an 'extra' channel (see previous parameter) as your main temperature sensor, set N to the required channel
|-
|WMR200TempChannel=N
| Stop MX and add this into file
|(by default no extra sensors)
|for WMR200 stations (and any other Oregon Scientific USB stations which work with Cumulus, e.g. WMR100) to use an 'extra' channel as your main temperature sensor, set N to the required channel
|}

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

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

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

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

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

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

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

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

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

Correcting Extremes

2022-09-09T09:21:04Z

Sfws: /* Correcting an error in today's total rainfall */ extend list of where might send rainfall data

[[Category:Cumulus Files]][[Category:Ini Files]]
=Terminology=

For simplicity, the terminology "extremes" is used on this page, the meaning includes:
# The ''totals'' maintained (such as rainfall, chill hours, and the various "degree days"), and
# The high/low "extreme records" for various periods (such as all-time, and this month).

This Wiki page has been created to cover both {{Version badge 1}} and {{Template:Version badge Mx}}, but do be aware that some terminology varies between the two flavours. All too often a mistake in one extreme record is propagated to other extreme records, so the purpose of this page is to cover all the necessary corrections in one place (previously the information was scattered between Wiki pages for each specific file, this redesign brings together all such text here).

==Rogue value==

Throughout this Wiki the term '''rogue value''' is used to mean you see a value somewhere in Cumulus that you believe should not be there.

Generally, "rogue" usage refers to a single data point. However, where that weather derivative is cumulative in nature it might affect a string of recorded values. Regardless of whether it is single or not, such a rogue value can be propagated into several of the extreme derivatives that Cumulus calculates and maintains in its various logging files. Specifically, on this Wiki page, the meaning covers any incorrect entry in one or more of the [[:Category:Ini Files|extreme record files]].

Here are some typical examples:
* it might appear that a gust of 89 mph was recorded as the highest on a day when you are sure it was not that windy, a single data point is wrong
* perhaps you saw 478.8mm of rain occurring on a dry day, this might be a single data point error, or as rain total is cumulative a series of wrong date points
* an extreme can be attributed to wrong time (or even wrong day), because the time on your weather station clock is wrong

=How Cumulus software tracks "extremes"=

As Cumulus weather software processes each reading from your weather station, it checks that value (and any [[Calculate_Missing_Values#Derived spot values|derived]] from it) against the extremes currently stored in various RAM variables, and if necessary updates the extreme records that are affected. Please note these extreme records are held by Cumulus software in internal variables. Periodically, these totals and high/low "extreme records" are written out to [[:Category:Log_Files|.ini files]] (ensuring such "extremes" are kept when MX is stopped and restarted).

The totals/extreme records that are maintained in this way are:

{| class="wikitable" border="1"
|-
!style="width:200px"|Period
!style="width:50px"|File storing extremes
!style="width:300px"|How to correct
!style="width:50px"|Link to web tag section
!style="width:300px"|Notes
|-
! scope="row"|For current day so far
|[[today.ini]]
| Editor for "Today's rain" (no editor for other derivatives)
|[[Webtags#Today|today.htm]]
|Many entries in this file (for non-midnight rollover, use is made of [[yesterday.ini]] too) get transferred to [[dayfile.txt]] at end of day.
|-
! scope="row"| For past days
| [[dayfile.txt]]
| See [[Amending dayfile]]
| Web tags only exist for [[Webtags#Yesterday|yesterday]]
| Often used as source for corrections - see [[#How editing accuracy depends on source selected|Depends on source selected Note]]
|-
! scope="row"|For current month-to-date
|[[month.ini]]
| Editor for "This month's records"
|[[Webtags#Monthly|thismonth.htm]]
| Please see [[#Accuracy Note]]
|-
|colspan="5" style="background:pink;"|monthyyyyMM.ini are archived copies for past months
|-
! scope="row"|For current year-to-date
|[[year.ini]]
| Editor for "This year's records"
|[[Webtags#Yearly|thisyear.htm]]
| Please see [[#How editing accuracy depends on source selected|Accuracy Note]]
|-
|colspan="5" style="background:pink;"|yearyyyy.ini are archived copies for past years
|-
! scope="row"|For all readings since a '''start date''
|[[alltime.ini]]
| Editor for "All Time Records"
|[[Webtags#All_Time|records.htm]]
|See table below for start date
|-
! scope="row"|For a particular month in all years
|[[monthlyalltime.ini]]
| Editor for "Monthly Records"
|[[Webtags#Monthly_All_Time_Records|monthlyrecord.htm]]
| Similar to previous row, but different start date, and separate extremes maintained for each month (regardless of the year)
|}
Explaining columns in above table:
# The first (label) column is self-explanatory
# The second column contains a link to the page that explains more about the file named there, which is where the extreme records are stored for that period
# The third column gives the name for the '''Edit''' menu item to choose to edit these extreme records
# The links in fourth column leads you to more information about the web tags associated with that period, you can incorporate those in your own [[Customised_templates|templates]].

=Built in extreme record editors=

[[File:Badge v1.png]] Cumulus 1 gained extreme record editing functionality from version 1.9.1 6th April 2011. See screenshot [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|Edit menu]] for how to select which file to edit, once on required editing screen, follow instructions on screen:
* Simply type over the existing value and time-stamp as shown (or if you have loaded the log files, select which value to copy across and click "Copy" to copy figure from identified log file to extreme record file). Press Save button to retain the change and exit.

Cumulus MX gradually gained extreme record editing functionality in releases from 3.1.1 - b3054 to 3.4.0 - b3064 (1 Nov 2019 to 19 Feb 2020), with a major redesign of user interface in release 3.18.0 (b.3189 14 June 2022):
* In latest MX release, if you click on an individual extreme record, then a pop-up appears where you can directly edit value and time-stamp to typed new content
* To load data from [[Standard log files]] you have to click on a button, from release 3.2.0 - build 3056 - only the relevant [[dayfile.txt]] entries are shown by default
* In latest MX release, if you click on a value in either dayfile.txt or standard monthly log file columns, then you are presented with yes/no options to select to copy value across or not, this does not update date/time
* In latest MX release, if you click on a date/time-stamp in either dayfile.txt or standard monthly log file columns, then you are presented with yes/no options to select to copy date/time across or not, this does not update value
* There is some validation on editing, you cannot empty the content of any extreme record

The built-in editors do allow you to load the standard monthly log files as well as the daily summary file (dayfile.txt). The other advantage of loading up these log files is that it allows you to see if the rogue value is also present in these log files. However, do exercise caution about using values from such sources, because as will be explained next, they may not hold the extreme values.

==How editing accuracy depends on source selected==

The editors built into Cumulus, for long term extremes (over a period of a month or more), give you the ability to display, for each extreme record:
# The (hopefully more accurate) figure taken from a search for that extreme by examining all entries in the [[dayfile.txt]] for that period
# The (usually less accurate) figure taken from a search for that extreme by examining all entries in the [[Standard log files]] for that period

Obviously, it is possible that the dayfile.txt file has been corrupted, and if you are using MX, then you may want to read [[Calculate_Missing_Values#CreateMissing.exe|about a utility that can recreate dayfile.txt]].

But generally, dayfile.txt is the best starting point for recreating any longer period extreme records, to understand why read on:
* Using [[Standard log files]] as source for recalculating past extremes:
** Let us assume you are using the default logging interval of 10 minutes
** Unlike some other weather station software available (which logs highest and lowest since previous log), Cumulus logs spot values
** That means the [[Monthly log files]] do not capture any extremes recorded in the time (by default 599 seconds) between logs
** Therefore the detailed log files are not normally the most accurate source
** Please note, this less accurate way of deducing daily extremes/totals (to update dayfile.txt) is used by Cumulus software:
*** For Legacy Cumulus 1: [[Amending_dayfile#Create_Missing_on_legacy_dayfile_editor|Create Missing in legacy dayfile editor]].
*** For MX: [[Calculate_Missing_Values#CreateMissing.exe|CreateMissing.exe]] utility.
* Using [[dayfile.txt]] as source for recalculating past extremes
** MX typically processes data from your weather station every second (even if you use a weather station type that only reads its sensors every 40 or 60 seconds). Cumulus 1 processes data from your weather station at intervals that vary for the different station types, but we can assume it is at least every 60 seconds.
** Therefore extremes recorded in '''today.ini''' (and from there into '''dayfile.ini'') are based on the full sampling done by Cumulus
** This means none, or very few, extremes are missed
** In March 2021, a new utility '''Create Records''' was planned (for use with MX only), as at July 2021 no progress has been made in coding it. It appears that this utility will read '''dayfile.txt''' and use the more accurate daily extremes it finds there, as a basis for updating longer term extremes in the other [[:Category:Ini Files|files like monthly-all-time and all-time]]. ''<big>Perhaps you my reader can be the contributor who updates this if the proposed utility becomes available</big>''.

==Cautionary warning and other files to examine==

File corruption can happen as a response to an electrical supply problem, a temporary input/output problem within the operating system, or the storage device being used, as well as after corruption of data within your weather station generating a rogue value fed through to current files.

Any or all of the [[:Category:Ini Files| Extreme Record .ini Files]] ''currently in use by Cumulus'' may get corrupted, as Cumulus gains exclusive write access that can overwrite the entire file during an update.

Remember the values displayed in the built-in editor from dayfile.txt or monthly standard log files just might have been corrupted in the same problem. Cumulus only appends new lines to the end of these files, so it should never overwrite the whole file, but it is possible for a connection problem to make Cumulus start a new file.

Therefore it is worth noting where else you can look to find values and date/time-stamps to use when correcting rogue data, and the next few subsections make some suggestions.

===Update tracking logs===

Cumulus 1 logs most extreme updates in files stored in [[Diags folder]]. Read that cross-reference for more guidance. As already mentioned, there is a log [[Alltimelog.txt]] that tracks the updates to all-time extremes.

Cumulus MX can log useful information in [[MXdiags folder]], depending on settings mentioned in that cross-reference, but it maintains two logs [[Alltimelog.txt]] and [[Monthlyalltimelog.txt]] as already mentioned.

These tracking logs can, in certain circumstances, be the best place to look up previous values as replacements for rogue values, when the built-in editors reveal that the rogue values exist in dayfile.txt and (possibly) the standard monthly log, so you can't within the editors find the correct value you seek.

===Looking at graphical representations===

Many people find it easy to interpolate replacements for rogue values by looking at graphical representations of their weather data covering before and after the time when the rogue figure got recorded.

In Cumulus 1, the obvious place to look is select-a-graphs (available from version 1.2 released on 5th April 2004).

In Cumulus MX, later releases also have a select a chart feature, that may be more useful than the standard charts (in both interface web pages and default web pages).

Some plots record values every minute, and those high resolution plots are ideal for your search.

===Using the Cumulus backup===

Cumulus makes backups of the extreme record files that are kept in folders within the [[Backup folder|backup sub-folder]] in the Cumulus installation, with a maximum of about 8 being retained (it varies between flavours), so this method cannot be used for rogue values that are a week old or older.

If you notice the rogue update when it happens, remember provided you act, as soon as possible afterwards, [[Calculate_Missing_Values#Reading_archive_data|you may be able to make use]] of the earlier version of the relevant extreme records file, as a source of correct extreme records before the corruption by a rogue figure.

All the extreme record files mentioned in the table above are backed up when Cumulus is restarted and (depending on which release you are using - see [[today.ini]]), with their contents just as they were either with the end of day or start of day. It is therefore possible no true extreme has happened since the most recent backup, or maybe by comparing two recent back-ups you can obtain guidance on when the last true extreme occurred. Obviously, such back-up files are no use for correcting daily extremes, but for this month, monthly-all-time, this year, and all-time, extreme records, updates to extremes don't always happen every day, especially when near end of a month. Therefore there is a good chance that you can find the previous extreme by examining a backup copy, providing a true extreme has not happened since.

===Searching recent history===

Cumulus 1 only provides one way to access the [[Webtags#Recent_History|Recent_History]], and that is by web tags. It is not easy, but if you know the time when a rogue value was reported, it may be possible to check values slightly earlier and slightly later by requesting them using web tags.

Cumulus MX stores its [[Recent history]] in a SQLite3 database that you can read/edit as explained at [[Cumulusmx.db#Reading.2Fediting_database_table_outside_MX]].

=General Editing Advice=

The remainder of this Wiki page describes general techniques for correcting rogue values, including using the built-in-editors, and gives guidance on all the different ways to find correct values.

You may have a feel as to which files in above table will need correction, but if in doubt it is highly recommended that you always start your extreme record correction by seeing if the error is present in the [[Alltime.ini]] file that holds all-time extreme records. That approach is best, partly because many Cumulus Users take a lot of interest when their all-time extreme records are broken, and partly as all-time is a good place to start as it can make subsequent edits easier.

==Extreme monitoring start-dates==

As Cumulus has developed, various derived values have been added that it calculates in addition to whatever your weather station supplies. At some releases, these extras are only available via web tags for current values, and it may be some significant time later that a release makes them available as all-time, or other period, extremes. You may be able to track these changes by examining "changes.txt" for Cumulus 1 or "updates.txt" for MX, but those sources are not comprehensive.

''There is no guarantee that this Wiki content has been checked, or that it is up to date. Any contributor is welcome to make corrections or bring it up to date''

For simplicity, this article will only document the development of yearly functionality and attempts to record when various extreme records became available in that context.

It should be obvious that full extreme record data was not available in all Cumulus releases for all the weather variables that the latest release reports. In general, for Cumulus 1, daily extreme functionality was added first, then all-time, followed by this month/year extreme functionality, and finally monthly-all-time. For MX, generally extras were added as current values first, and later the extremes for all the various periods were added together, but development does not always happen in a consistent way!

This section has intentionally been kept brief, so it does not list all bugs that might result in incorrect extremes being stored, nor when such bugs were subsequently resolved.

[[Image:Icon info.png|left|30px]]The '''start date''' referenced in the last bullet in the introduction, is generally when you first started using Cumulus. However, as Cumulus has developed it has started monitoring more extreme records compared to those it was previously monitoring, so if you were using Cumulus software before 28 Jul 2020, you should check the following table. For any parameter you select in the table, the monitoring of all-time extreme records started whenever you decided to install the release shown in the following table, or a later release:

{| class="wikitable" border="1"
|-
!style="width:300px"|Parameter
!style="width:200px"|First released
!style="width:100px"|First in Version
!style="width:100px"|First in Build
|-
! scope="row"|highest/lowest apparent temperature
|26 Oct 2010
|1.9.1 beta
|957
|-
! scope="row"|highest/lowest feels like temperature
|24 June 2020
|3.6.10
|3086
|-
! scope="row"|highest Canadian Humidity Index (humidex)
| 28 Jul 2020
| 3.7.0
|3089
|-
! scope="row"|highest minimum temperature
| 15 April 2004
| 1.2.2
|(lost)
|-
! scope="row"|highest USA heat index
| 29 Aug 2010
| 1.9.0 beta
|955
|-
! scope="row"|wettest month
| 5 April 2004
| 1.2
|(lost)
|-
| 24 hour rainfall
| 30 Apr 2022
| 3.16.0
| 3182
|-
! scope="row"|highest daily wind run
|3 Jul 2011
|1.9.2 beta
|1001
|-
| Sunshine hours
| 31 July 2021
| 3.12.0
| 3134
|}

Please note the Cumulus Support Forum, while it was hosted by Steve Loft, moved to new forum software on 2 Jun 2008 without preserving what had existed before. This was some months before key information in the forum started being copied to this Cumulus Wiki. Consequently, all his announcements prior to that were lost, this is why some details in above table are marked ''(lost)'', and there is some vagueness in information mentioned elsewhere in this page.

==Correcting multiple extremes==

There are two cases to consider:

===Correcting extremes recorded for every logging entry (plus every day/month/year of long period)===

Sometimes a mistake is made in setting up or calibrating a sensor, or (despite the warnings within both flavours of Cumulus about getting your choice of units correct from the start), you decide to change your units.

In both cases, you will identify a constant/multiplier adjustment to be applied to adjust all values (luckily times and dates of extremes are not affected) over the past period. In both cases, you need to correct past entries in any [[Extra Sensor Files]], any [[Standard log files]], in [[dayfile.txt]], plus the multiple [[Category:Ini Files|extreme record files]].

The built-in editors only correct one extreme record at a time, so they cannot be used for such a task.

It is important to remember that there are [[Calculate_Missing_Values#Some_definitions|source and derived values]] in Cumulus. If you change the units, or introduce a calibration multiplier/offset, that affects the source values, but as derived values are calculated from spot values (e.g. temperature, wind speed, humidity, all recorded at same time), you cannot simply change extremes for derived values by any constant/multiplier. Please see [[Calculate Missing Values]] page for further advice.

The easiest way to change entries in any Extra Sensor Files, any Standard log files, and in dayfile.txt, is to either write a batch editing script (see [https://cumulus.hosiene.co.uk/viewtopic.php?p=155539#p155539 changed rainfall units example]), or to use a spreadsheet (be careful not to affects dates or times) like '''Libre Office Calc''' where you can paste special a multiplier to all cells in a particular column.

===Correcting extremes just for a few logging entries (plus selected days/months/years in a short period)===

There are a further two sub-cases that fall in this category. Both are near impossible to resolve!

Both Cumulus 1 and MX have had bugs in some releases of their software. This may mean that some of the past extremes need correction because incorrect calculations were used when those extremes were recorded, it is not possible here to say exactly how to correct these, but essentially extremes can only be recalculated from corrected spot values, and all the files for that past time will have incorrect data, so any correction is likely to be a slow extremely complex process!

[[File:Badge v1.png]]There were bugs introduced sometimes in builds of the original Cumulus (known now as legacy Cumulus 1). Information about a few of the bugs and fixes can be found in [[File:Changes.zip]], although that does not cover any 1.7.x versions, nor does not detail bugs created (and fixed) within the beta builds. More information may be found by searching within [https://cumulus.hosiene.co.uk/viewforum.php?f=2 Cumulus forum announcements], but it will require a lot of effort (as there are a lot of posts to search). (For historic interest only, one example is that what is stored in '''month.ini''' and '''year.ini''' depends on when they were first created, because they are initiated from the daily summary log, dayfile.txt, for the relevant period. Therefore, an individual parameter can only be initialised if the corresponding field is present in '''dayfile.txt''' for the whole of that period).

[[File:Badge vMx.png]]Cumulus MX had lots of bugs in its early builds. So if you ever used Cumulus MX versions 3.0.0 to 3.3.0, you cannot rely that all all-time extreme records
reported correctly take into account any records broken on a date prior to 19 Feb 2020. Also there have been some changes in how some derivatives are calculated, and these might invalidate other 2020 dated entries. The '''updates.txt''' that is part of each MX release distribution has brief details of when the very many issues were fixed. Again, searching all the posts in [https://cumulus.hosiene.co.uk/viewforum.php?f=40 the relevant support forum] will yield more information in return for a lot more effort.

A sensor might fail, and Cumulus does not recognise that "Null" (this might mean the weather station sends all bits set to zero or all bits set to one) values should be ignored when comparing against existing extreme records, and so set the extreme record to zero or maximum number that the number of bits can convey.

In this second sub-case, you again effectively have rogue measurements over an extended past period. Theoretically you can correct using a special batch editing script, or an external editor, but in this case you have to decide what value to use to represent '''not-working'''. You don't want to use a value that affects extremes (so you can't use an obviously wrong high or low value), you can't blank off any extreme (set it to empty), and Cumulus will not accept "--" type inputs, or anything else that might represent a null. Some people take values from a neighbouring measuring station or in some other way insert values that are good approximations. However, there is no official solution to this problem!

==All-time corrections==

For the all-time extreme records, each individual update is logged in [[Alltimelog.txt]] from version 1.8.9 onwards. Depending on sequence of extreme values, you may get an accurate previous value from this tracking log.
* The tracking log will not tell you a correct high/low extreme record if ''the rogue extreme occurred before the actual high/low extreme'' was experienced. This is because the rogue extreme stopped any subsequent true extreme being recorded.
* If the ''actual high/low extreme that you want to retain was recorded before the rogue extreme'', then you can see that true value, and its time-stamp, in the tracking log. Based on that time-stamp, the tracking log tells you whether the error will have also affected the relevant month monthly-all-time, and whether it has affected this month/year, so you have pointers to what other files to edit.

==Introduction of Monthly All Time Extreme records==

From version 1.9.3 beta build 1033 released on 10 April 2012, Cumulus introduced the ability to monitor extremes like 'highest ever January temperature'.

==Initialisation of monthly-all-time extreme records==

Although the release did not automatically initialise monthly-all-time extreme records, the new monthly records editor provided in that release had a "fetch dayfile" button. By clicking just one '''Copy''' button, the one ''in the header row'', all the relevant daily records were copied into the monthly-all-time records for the month of the selected tab. Therefore by doing that again for every other tab (except any tab for a month when you had never used the original Cumulus), and then clicking '''OK''' button, you manually initialised all the parameters (assuming your dayfile had all the parameters - see [[Calculate Missing Values]]).

==Monthly-all-time corrections==

If the rogue value has not affected the all-time extreme records, it is recommended you see if the error is present in the [[Monthlyalltime.ini|monthly-all-time]] file.
* From version 1.9.3 beta build 1033 released on 10 April 2012, Cumulus introduced the ability to monitor extremes like 'highest ever January temperature'.
* If you are using Cumulus 1, then make the best guess as to which tab to pick, or work through each tab until you find the month affected.
* If you use MX, then [[Monthlyalltimelog.txt]]) logs each time any extreme is updated, so that file tells you which tab has the rogue value. You may also get an accurate previous value from this tracking log, it depends on sequence of extreme values, the value you want may not have been noted if the rogue extreme occurred before the value you want, so stopped any subsequent true extreme being recorded.

==Correction of extremes for past year==

An earlier correction may have identified that the rogue value was in a past year, so this sub-section explores whether you can continue correction pathway:
* [[File:Badge v1.png]]Cumulus 1 never allows you to see a '''year.ini''' file when the year is completed, because at the end of the year it is initialised ready for the new year.
* [[File:Badge vMx.png]] From build 3035 released 2 Dec 2015, the MX beta (3.0.0), and later MX releases, at the start of a new year, saves the old year.ini (whenever it was last updated) as a file with a name like '''year2015.ini''', and only then overwrites the ''year.ini'' file.
** Although MX does not provide any functionality to read this old file, let alone edit it, you may want to use a standard text editor to amend the relevant part of this old file. Your edit to either ''alltime.ini'' or ''monthlyalltime.ini'' should have told you what old value in old file is wrong, and told you correct value to replace that.

==Correction of extremes for past month==

An earlier correction may have identified that the rogue value was in a past month, so this sub-section explores whether you can continue correction pathway:
* [[File:Badge v1.png]]Cumulus 1 never allows you to see a '''month.ini''' file when the month is completed, because at the end of the month it is re-initialised ready for the new month.
* [[File:Badge vMx.png]] From build 3035 released 2 Dec 2015, the MX beta (3.0.0), and later MX releases, at the end of a month, saves the old '''month.ini''' (whenever it was last updated) as a file with a name like '''month201501.ini''' (i.e. "month", followed by year, followed by month number, and with file type ".ini"), before writing standard "reset high/low values" to '''month.ini'''.
** Although MX does not provide any functionality to read this old file, let alone edit it, you may want to use a standard text editor to amend the relevant part of this old file. Your edit to either ''alltime.ini'' or ''monthlyalltime.ini'' should have told you what old value in old file is wrong, and told you correct value to replace that.

==Current month/year corrections==

If your earlier correction (''finding how the rogue value has affected monthly-all-time has given you a date'' in the current month/year), that is a steer to whether the [[Month.ini|this month]] extremes file will need correction, and whether [[Year.ini|this year]] extreme records file will need correction.

They are relatively small files, so it should be easy to use the [[#Built in extreme record editors]] to edit them.

==Correction of extremes for past days==

If the rogue value relates to yesterday, or an earlier day, then you must edit [[Amending dayfile|dayfile.txt]] to make any necessary corrections for past days.

It is entirely optional whether you choose to update [[Yesterday.ini|yesterday.ini]] if that contains a rogue value. That file is overwritten at both midnight and at next rollover, so in general there is no benefit gained from any editing.

=== Correcting an error in rainfall for a past day===

For the legacy Cumulus 1, rainfall corrections are covered at [[FAQ#My_station_invented_some_rain_that_didn.27t_really_occur.2C_and_I_want_to_set_it_to_zero_.28or_some_other_figure.29]].

The total rainfall for a month, or 12-month season (rainfall labelled as ''Rain this year'' can start counting from zero on first [[Meteorological day]] of any month chosen by user (Interface: '''Station settings''' → ''Annual Rainfall'' %rarr; '''Start of rainfall season'''), is held in an internal (RAM) variable in Cumulus software. When you start Cumulus software, the program looks in [[dayfile.txt]] and reads the amount for each past day (of current month/season) in that file, then adds the rainfall for today-so-far. For rain this season, Cumulus flavour alters calculation:
* Cumulus 1 - if the year entered in [[Cumulus_Screenshots#Station]] "Annual Rainfall" frame, box labelled ''Year'', matches the current '''calendar''' year, then the amount in box labelled ''Amount'' is added. Note if your season does not start in "January" then this only affects the part of the season that is in the specified year.
* Cumulus MX - if your rainfall season starts in a month within year specified in box labelled "Year to which year-to-date amount applies", then the amount in box labelled "Year-to-date amount" is added to your rain for that season as shown in ''Rain this year'' (and the <ryear> tag if used for [[MySqlConnect|Custom SQL]], MQTT, [[Cumulus_MX_Local_API]], or [[Cumulus_template_file]])

So if the rainfall reported for current month, or current "season" (year) is wrong, you need to correct [[dayfile.txt]], both Cumulus 1 and MX have [[Amending_dayfile#Editors_built_into_Cumulus|built-in dayfile.txt editors]].

==Today corrections==

As described below, the Cumulus '''Edit' menu includes a '''Today's rain''' option where you can adjust the [[Today.ini#Editing_rainfall_in_today.ini_within_Cumulus|total rainfall for today]] (e.g. if you or the wind have knocked your rain gauge).

''There is no facility provided to edit any other content'' of [[today.ini]]. Manual correction may be possible, but do read advice on [[today.ini]] page, in particular noting that MX only reads "today.ini" when first started, MX uses an internal array that represents content of file while MX is running.

In working through the various files in above table, remember that if the rogue value was recorded today, then [[today.ini]] will be wrong:
* In Cumulus 1, you possibly could edit today.ini without stopping the software, provided you get the timing right, but it is more sensible to stop Cumulus before editing that file
* In MX, the values are held internally, with periodic updates to today.ini, so any edit you make to that file while MX is running is ignored. Since MX does not provide a today.ini editor, you must stop MX (see [[MX on Linux]] or [[MX on Windows OS]]) and edit the file using a text editor, or programmer's editor, that will not add unwanted content to the file.

=== Correcting an error in today's total rainfall ===

You can correct rainfall total (for current [[meteorological day]] since rollover).

Just use the [[Today.ini#Editing_rainfall_in_today.ini_within_Cumulus | 'today's rain']] editor on the edit menu.
* [[File:Badge v1.png]]select ''Today's rain'' in the [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|edit menu]] accessed from main screen in Cumulus 1,
* [[File:Badge vMx.png]]select '''Today's rain''' in the [[MX_Administrative_Interface#Today.27s_rain.27|edit menu]] of MX interface.

This edit will actually alter '''the start of day rainfall counter figure held by Cumulus internally''' (RAM):
* If you want today's rain to seem less (perhaps you, an animal, or the wind, knocked the rain gauge), Cumulus will increase the start of day counter
* If you want today's rain to seem greater (perhaps the rain gauge got blocked by a leaf, or a bird), Cumulus will decrease the start of day counter
* Be aware that if you stop Cumulus, and restart it, before end of meteorological day, internally held variables are lost, so the start of day figure will revert

Please note that this edit ''does not affect'' "rain rate", "maximum hourly rain", "maximum 24-hour rain", or "rain since midnight", ''nor does it update'' ANY EXISTING data log line so it has correct rainfall counter reading. Please see [[Today.ini#Editing_rainfall_in_today.ini_within_Cumulus]] for details of how to edit those related fields so when Cumulus is restarted all are corrected.

If you send rainfall data to:
* any third-party external web site
* MQTT or other local system
* any database tables (e.g. if you ask MX to automatically insert a new row into a monthly table on your database server whenever a new line is stored in the [[Standard_log_files]])
''then be aware that'' that this correction does '''not send any update''' for any messages/values '''already sent'''.

=Some definitions=

==Flavour, Release, Version, and Build==

'''Flavour''' is used to represent the original Cumulus, Cumulus 2, and Cumulus MX, collectively. Where the text says applicability is dependant on flavour, it means that the action you do depends on whether you are installing/running Cumulus MX or the original Cumulus software.

'''Release''' is used to signify what the Cumulus developer makes available for download after there has been a modification to the software. For most Cumulus 1 builds, the release consisted of a executable that would create all the folders and files needed to run that software. For Cumulus 2, releases were a zip file and were numbered using a identifier with many digits. MX releases are as a zip file that is labelled with the build number.

'''Version''' here is a precise term, it identifies collectively all builds that are given a particular version number, that can include alpha and beta releases. For Cumulus 2, the log string of digits that identifies each release was sometimes called the version number. For the original Cumulus, and some MX releases, the version number only changes when new features are included in the release. Major functionally changes affect digit after the first decimal point (digit before decimal point identifies the flavour), while for minor functionally changes, a third part is added to the version number.

'''Build''' number in Cumulus 1 and 3 (MX), was used to identify each release, and historically alpha, beta, and bug fixing, releases could all share the same version number.

Steve Loft generally went through a lot of beta releases identified by build number before finally having a stable release with new version number. Most beta releases were available to everyone.

Mark Crossley has sometimes issued his beta commits identified by beta, beta 1, beta 2, etc. without changing build number, and sometimes incremented build number several times between changes to release version number. Most beta releases are made available to just a select few testers, via a sub-forum with limited access, or via direct email of zip files to particular people. The beta history is not documented in "updates.txt", which only quotes the more significant changes.

Software

2022-09-08T08:51:31Z

Sfws: Removed obsolete reference to Mono crashing issues

[[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX. It lists all standard utilities as well as MX itself.

= What is Cumulus MX? =

: a cross platform version of Cumulus software that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X.

==CumulusMX.exe Usage Restriction==

Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default MX web site]], include the [https://www.highcharts.com HighStock] product.

Are you using MX for a non-profit organisation, personal website, or school project?
Then download MX and start using it with Highcharts today.

Are you representing any commercial organisation running a facility that others use? If so, then you cannot use Cumulus MX to share weather data on behalf of your organisation without buying a licence from the High Charts organisation.

'''HighCharts rules for usage of their products are described ''' [https://shop.highcharts.com/ on their licence purchase web page], and ''it is your responsibility to ensure compliance''.

== Help with ‘Stable’ MX releases ==

If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]].

It is recommended you check you have complied with any instructions in the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before seeking help (to see what changes in any release affect you, and what actions you may need to take).

If you wish to research the documentation on MX to try to resolve your problem yourself, use the entry point of the [[:Category:Cumulus MX]] page for pointers to other Wiki pages connected with MX that may help.

If you cannot answer your questions from information in this Wiki (and MX changes so quickly any information here can be very out of date), then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] and the developer or Cumulus community will offer assistance.

== Current Release ==

There are ''inter-dependencies between different files'' in the MX release distribution:
* ''Therefore you must always install into your MX folders, every file included in the download zip''.
* If you customise any file that is in the distribution, either give the new file a new name (perhaps add a prefix of "_" in front of files you edit) or place your tailored version in a different folder
** Either approach will ensure your tailored files are not overwritten by files from the download, and let you compare your tailored file with the new file in any future download to see if you need to tweak your tailored file
* When upgrading, it is strongly recommended that you install all files in the download for a new release of MX directly over your existing installation.
** You can take a back-up of any existing installation before you copy in any new files, that will provide you with the ability to regress to the earlier release, if the new release does cause you an issue
** You may end up with some files no longer needed by the new release, left over from older release, but this is better than risking missing some vital files
** You need a good understanding of the use of each file, before considering deleting any file that you think might be obsolete, because not all files that Cumulus uses are contained within the release zip, some are created as it runs.

===Latest build distribution download===

~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3205/CumulusMXDist3205.zip Cumulus MX v3.21.1 build 3205, 04-September-2022]

===Latest MX Source Code===

~ View/download [https://github.com/cumulusmx/CumulusMX Cumulus MX Current Source Code]

This source code base is updated for all releases resulting from development by M Crossley, it includes some contributions from other developers.

===Raspberry Pi Image===

~ Download [//{{SERVERNAME}}/Downloads/rpi-CumulusMX-lite-3.19.0.zip Raspberry Pi Image for Cumulus MX 3.19.0]

As at April 2022, the image includes Raspberry Pi. O. S. 11 "Bullseye" version of Linux.

 

# This is a pre-built disk image file for your first installation onto a Raspberry Pi computer.
# Do read the instructions for using this image on the [[Raspberry_Pi_Image|Raspberry Pi Image]] page to see what is in the image and how to use it
# It is of course possible that sometimes the image provided may have issues for you,
#* it is set up so that MX starts running as a service immediately you boot up your Raspberry Pi, rather than letting you first run MX interactively (see [[MX_on_Linux#Running_MX]]);
#* it is produced with a Raspberry Pi model 3, so with other models you may need to replace the Mono software included in image, and consider what updating rates your model can support;
#* it is produced using a GB locale and GB time-zone, so that automatically started MX may not initially be running correctly for your locale (however as you need to restart MX after changing settings you should be okay when MX starts recording data).

: Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono).

==Upgrading==

: There is an [[Updating_MX_to_new_version#Installer_Option|installer utility]] available to help with upgrading.

We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest release:
* The main developer can most easily offer support if you are using the most familiar recently released build.
* You may wish to wait a few days after a new release comes out, just in case a new release has some bugs
** MX is extremely complex, the developers work on MX edits in their spare time, have settings that suit them, and do not have the full set of sensors that MX can support, so pre-release testing is never perfect
* By switching to latest release, you gain any extra functionality it may offer (although it may not be useful to you), but more importantly you gain fixes of bugs your existing release may have

*Important, please read all of the release notes (in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 appropriate forum announcement] threads) for the builds since the version you are upgrading from, especially noting when there are references to necessary once-off actions.
*If you have never upgraded before, or you are currently running a fairly old release of MX, you are advised to read the [[Updating MX to new version]] page in this Wiki,
** you may be recommended to upgrade in stages, as certain releases do essential one off actions that are missed if you skip that release; e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables
** overwriting an existing installation will add any new files, but it won't remove obsolete files, and sometimes [[MX_Basic_info#Library_software|replacement files]] have different names to their predecessors so don't overwrite the old files
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page
** However, it is likely that information on those pages was written for earlier MX releases, and might be out of date, so like many other people you might want to ask in the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have more up-to-date advice.

Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software that have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software.

==Older releases==

It is always possible that a new release introduces a bug, and you decide to regress to an earlier release.

Find link to earlier MX release distributions [https://github.com/cumulusmx/CumulusMX/releases here].

(You can search using the history tab on this Wiki page to see which past builds were made available as Raspberry Pi images, as these are not created for all releases, but there is no way to tell if the old filenames can still be downloaded. Generally, it is easiest to download a different normal MX release distribution over whatever MX release was in the image you downloaded.)

= Other utilities =

==By Mark Crossley==

The utilities listed here are only for use with MX, they may be included in the [[#Latest build distribution download|MX release zip]], but links to latest releases without the ''*.dll'' files ("software libraries") needed to run the respective utility, are provided below.

The "software libraries" are provided in the MX release zip that is stated alongside download link. The different utilities vary with regard to which software libraries they require, and those with technical understanding can check the code sources.

If you are using an earlier MX release than that stated beside a utility download below, upgrade MX to bring in the new "*.dll" files needed, because the utility will not work with the versions of "software libraries" included with earlier MX releases.

If you are using a later MX release than that stated, check [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 the MX release announcements] for all releases since that stated below to see if the "software libraries" have been upgraded, if they have then the respective utility because it has been compiled with older versions of the respective .dll files will probably not work. (Sometimes the names of new .dll files are different to the names of the old .dll files, so an upgrade of MX done by copying files over an existing installation will leave the old files there, in that case the utility might still work by picking up old names).

=== Create Missing ===

~ The CreateMissing.exe ''v1.3.0'' download dated 18 August 2022 (works with MX release of 3.20.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.3.0/CreateMissing-v1.3.0.zip is here].

Check compatibility with the MX release you have running as per notes above. (Although earlier releases of "Create Missing" exist on "github.com/cumulusmx/CreateMissing/releases", their software bugs imply they should not be used). Install into same directory as "CumulusMX.exe".

This MX utility, affects [[Category:Files with Comma Separated Values|Cumulus CSV files]]:
# It will create a new [[dayfile.txt|daily summary (dayfile.txt)]]. If you already have a "dayfile.txt", that is renamed, the new file should include individual fields, and lines, missing from your old file.
# It will read, and where appropriate update, your [[Standard log files|month by month (MMMyylog.txt)]] files.
#* The utility reads the [[Calculate_Missing_Values#Source_value|source values]] in as input values. This utility has the ability to calculate many of the [[Calculate_Missing_Values#Derived_value|derived fields]], so will add any missing derived values to your month by month files as it proceeds.
#* Therefore the utility should be used to add the [[Standard_log_files#Number_of_fields_per_line_varies_by_release|extra fields]] for those months where the input file was produced by Cumulus 1 or an earlier release of MX (which might have populated fewer fields or used a [[Feels_Like#How_to_express_Feels_Like_for_highest_temperatures|different calculation]]).

Usage information by the author of the utility can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.]
* Learn more about this utility by reading the [[Calculate_Missing_Values#CreateMissing.exe|calculate missing]] page in this Wiki.
** Elsewhere on that same page learn when this utility might be useful, and what else you can try.
* Check in the support forum for information about status of bugs in this utility, at time of last updating this paragraph there was an outstanding issue concerning storing the line in dayfile.txt for the first of some months if your rollover time is not midnight.
* For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page.

=== Create Records ===

This utility is not yet available.

A utility to create, or recreate, missing [[Correcting_Extremes|extreme records]] from Cumulus MX by parsing your [[dayfile.txt|daily summary (dayfile.txt)]].

=== Export ''To'' MySQL ===

~ The ExportToMySQL.exe ''v1.6.1'' download dated 02 September 2022 (works with release of MX 3.21.0) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.6.1/ExportToMySQL-v1.6.1.zip is here.]

Check compatibility with the MX release you have running as per notes above. Note that compatibility is needed both with the .dll files and with the columns present in the database table to be updated.

If you are not using the MX release named above, then other release zips (and source code) for this utility are available at [https://github.com/cumulusmx/ExportToMySQL/releases ExportToMySQL/releases] and each release there is labelled as to which MX release creates default tables with correct columns.

This utility reads [[MySqlConnect|Settings]] that are also used by "CumulusMX.exe". Parameters supplied to this utility enable it to do ''one of the following actions'' affecting rows not already present on a [[Your Own Server|MySQL, or MariaDB, database server]]:
# The parameter used is "dayfile", will insert missing rows into a database table that is called "dayfile" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of [[dayfile.txt|daily summary (dayfile.txt)]] file
# Insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of the single file of [[Standard log files|month by month (MMMyylog.txt)]] whose relative path "data/..." is named in the parameter
# The parameter used is "monthly", will insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) reading data from the contents of all files of type [[Standard log files|month by month (MMMyylog.txt)]] found in the [[Data folder|data sub-folder]].

Installation and usage information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.]

''This new utility replaces the "ExportMySQL.exe" (no "To" in that name) utility included by Steve Loft in his MX beta distributions.'' That is not compatible with any recent MX releases.

==By Steve Loft==

Source code for these utilities are not available, therefore they cannot be altered or upgraded.

=== Utility for Fine Offset Stations ===

*[//{{SERVERNAME}}/Downloads/SetLogger.zip Set Logger Interval] A utility by Steve Loft to adjust the internal logging interval on Fine Offset stations

=== Weather Display Converter ===

This utility was provided by Steve to convert '''Weather Display''' log files to legacy Cumulus 1 format, download it [https://cumuluswiki.org/a/File:WDconverter.zip here].

Please carefully read the '''readme''' file in the zip. There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about using this converter with the legacy Cumulus here].

Remember this utility will not support all fields used by MX. It is advised you use [[#Create Missing]] (see above) after using this utility to populate the other fields. If you do find this utility does not work with your MX release, you may need to manually recreate records, etc. using Cumulus 1 formats, and then [[Migrating from Cumulus 1 to MX|Migrate all your files from Cumulus 1 to MX]].

=== WeatherLink Converter ===

This utility was provided by Steve to convert Davis '''WeatherLink''' log files to Cumulus format, download it [https://cumuluswiki.org/a/File:WLconverter.zip here]. Please carefully read the '''readme''' file in the zip to understand how to use this utility.

NOTE: this has nothing to do with Davis ''Weather Link Live'' despite confusing similarity in name.

Basically, this converter utility reads '''.wlk''' files, it creates a folder called '''converted''' into which it places [[Standard log files]] and [[dayfile.txt]] files as used by Cumulus software. You need to be able to manually merge (using a text file editor) the newly created files with any files of same name in your Cumulus [[data folder|'''data''' folder]]. You might also want to read (although not directly related to this converter utility) [[Amending_dayfile#Importing_data_not_recorded_by_Cumulus|Importing_data_not_recorded_by_Cumulus]].

A search on the support forum will reveal various posts on use of this converter. The key topics are:
* [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=20017 forum topic about using this converter with MX here]
* [https://cumulus.hosiene.co.uk/viewtopic.php?t=11349 forum topic about using this converter with the legacy Cumulus here].

== Third Party Contributions by other Cumulus Users ==

For files, and add-on's, contributed by Cumulus users, see these Categories (where third party authors may have mentioned what they offer):
# [[:Category:3rd Party Apps]] - contributions for various devices,
# [[:Category:AddOns]] - adding extra functionality,
# [[:Category:WebTools]] - for your web server, and
# [[:Category:User_Contributions]] - key contributions from the user community

=Current MX Developed from =

Cumulus 3 (MX) software was developed as a beta with limited functionality by Steve Loft.
* Steve Loft previously developed Cumulus 2 (where he tested using the C# language, now used for MX)
* Steve Loft created the original Cumulus software (now known as legacy cumulus 1) just for his use, before making it generally available, he then developed it over the next decade to include requirements suggested by thousands of users.
* Steve Loft, the author of Cumulus/Cumulus MX has since fully retired, and stopped providing support, or updates, to any of his software.

==Steve's final beta MX==

You can download below the final Cumulus 3 beta release, as made available by Steve Loft, and also his ''subsequent'' final source code.

If you are able to understand his source code (linked below), and compare it to the latest source code (linked above), you can appreciate the transformation that has taken place in recent years.

*[//{{SERVERNAME}}/Downloads/CumulusMXDist3043.zip Cumulus MX v3.0.0 beta build 3043, 20-Jan-2017] Cumulus MX, a cross platform version of Cumulus 3 which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X (Steve Loft - final release), single zip that includes both "CumulusMX.exe" and "ExportMySQL.exe".
*[//{{SERVERNAME}}/Downloads/CumulusMXSource.zip subsequent updated Cumulus MX Source Code] from Steve Loft. He made the following comments, as he handed the project over to "the community":
**This version of the code is post the last release I made at build 3043 as it includes some extra changes that I have not finalised.
**My source code is offered as my parting gift, completely '''without support''', in the hope that it might be useful to future developers.
**My source code is very badly structured due to the 'Frankenstein' way I cobbled it together from various places. Some of it is a machine translation of parts of Cumulus 1.

= Legacy releases =

See [[Downloads| downloads page]] for full details.

== Cumulus 1 ==

Cumulus 1 software was popular, when it went public in 2004, and its [[Cumulus_Users|usage]] grew very rapidly in the subsequent decade until final 2014 release. Even now (in mid-2022) some people are still using the final release version (and a quite substantial number of public viewable weather sites are still driven by earlier builds).

Be aware, the longer you wait before swapping from legacy to Cumulus MX software; the more that MX will have developed away from the legacy. MX's development has effectively abandoned its former focus on compatibility, so you might encounter more difficulty with [[Migrating from Cumulus 1 to MX|transferring your data files when you migrate]].

In all months of 2020, (when the year selection drop-down provided in all releases of original software reached its limit, and MX gained a substantial increase in functionality), and continuing into mid-2021, there was an avalanche of people who used to use the legacy software successfully swapping to MX. As of mid-2022, the usage of this legacy software is in fast decline, implying fewer people can offer assistance.

The '''installer for the FINAL release of the legacy Cumulus 1''' is available here:
#[//{{SERVERNAME}}/Downloads/CumulusSetup.exe Cumulus 1099 installer] Full set of files within an installer.
#* On the "this period" type, and snow index, screens you can still manually enter any year,but you have to over-type with the full year yourself, outside range 2008 to 2020.
#* You cannot manually regenerate NOAA reports after 2020, but there is no problem with automatic generation.
#[//{{SERVERNAME}}/Downloads/cumulus.1099.2.zip Cumulus 1.9.4 build 1099.2 patch] Patched version of one file (cumulus.exe) to replace that file from above installer
#* Note this is not the full installation package, just one file to replace in the suite of files created by the installer.
#* This patch modifies the drop-down year selectors, (on "this period" screens, for NOAA reports, and for Snow Index) making it easier to choose date entries (patch version 1099.2 was released 28 Jan 2020) up to the year 2030.

=== Legacy Cumulus 1 Resources ===

*[//{{SERVERNAME}}/Downloads/Cumulus%20basic%20installation%20guide.pdf Cumulus installation guide] Instructions for installing Cumulus 1
*[//{{SERVERNAME}}/Downloads/readme.txt Cumulus readme.txt] Please read this before installing or updating Cumulus
*[//{{SERVERNAME}}/Downloads/Cumulus.chm Cumulus help file] The Cumulus 1 help file (this also gets installed when Cumulus is installed)
*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French
*[//{{SERVERNAME}}/Downloads/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight (Silverlight is no longer developed or supported by Microsoft) application for displaying 2 extra dials showing real time wind data on the standard Cumulus gauges page (with temperature and rainfall in histogram style) for a web site

=== Special Variants ===

It is '''STRONGLY RECOMMENDED''' that users of Cumulus '''1.9.4 variants''' migrate to Cumulus MX, which has ongoing support by Mark Crossley. The baud rate can be selected within MX as a configuration setting.

*[//{{SERVERNAME}}/Downloads/CumulusSetup1100.zip Cumulus 1.9.4 build 1100 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 115200 baud, you should use build 1100
*[//{{SERVERNAME}}/Downloads/CumulusSetup1101.zip Cumulus 1.9.4 build 1101 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 19200 baud, you should use build 1101
*'''NOTE:''' '''These Cumulus 1.9.4 variants will not have any updates in the future.'''
* The patch for Cumulus.exe, cannot be used with these variants
* The menu items with year drop-down selectors will not display years beyond 2020.
**For example, this will happen on manual generation of NOAA-style reports.
**This does not affect any automatic generation of NOAA reports, but does prevent re-generation.

== Cumulus 2 ==

The software for Cumulus 2 alpha release is no longer available.

Software

2022-09-08T08:26:44Z

Sfws: /* WeatherLink Converter */

[[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX.

= What is Cumulus MX? =

: a cross platform version of Cumulus software that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X.

'''NOTE relating to MX Release v3.9.1 or later: On Linux/RPi/macOS, Mono version 5, or 6, is needed for CreateMissing.Exe, ExportToMySQL.exe, and CumulusMX.exe. Mono v4 is subject to random crashes.'''

==CumulusMX.exe Usage Restriction==

Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default MX web site]], include the [https://www.highcharts.com HighStock] product.

Are you using MX for a non-profit organisation, personal website, or school project?
Then download MX and start using it with Highcharts today.

Are you representing any commercial organisation running a facility that others use? If so, then you cannot use Cumulus MX to share weather data on behalf of your organisation without buying a licence from the High Charts organisation.

'''HighCharts rules for usage of their products are described ''' [https://shop.highcharts.com/ on their licence purchase web page], and ''it is your responsibility to ensure compliance''.

== Help with ‘Stable’ MX releases ==

If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]].

It is recommended you check you have complied with any instructions in the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before seeking help (to see what changes in any release affect you, and what actions you may need to take).

If you wish to research the documentation on MX to try to resolve your problem yourself, use the entry point of the [[:Category:Cumulus MX]] page for pointers to other Wiki pages connected with MX that may help.

If you cannot answer your questions from information in this Wiki (and MX changes so quickly any information here can be very out of date), then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] and the developer or Cumulus community will offer assistance.

==Upgrading==

We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest release:
* You may wish to wait a few days after a new release comes out, just in case a new release has some bugs
** MX is extremely complex, the developers work on MX edits in their spare time, have settings that suit them, and do not have the full set of sensors that MX can support, so pre-release testing is never perfect
* By switching to latest release, you gain any extra functionality it may offer (although it may not be useful to you), but more importantly you gain fixes of bugs your existing release may have
* Also the main developer can most easily offer support if you are using the build he most recently released.

There are inter-dependencies between different files in the MX release distribution:
* ''Therefore you must always install into your MX folders, every file included in the download zip''.
** You can take a back-up of your existing installation before you copy in any new files, that will provide you with the ability to regress to the earlier release, if the new release does cause you an issue
* If you customise any file that is in the distribution, either give the new file a new name (perhaps add a prefix of "_" in front of files you edit) or place your tailored version in a different folder
** Either approach will ensure your tailored files are not overwritten by files from the download, and let you compare your tailored file with the new file in the download to see if you need to tweak your tailored file
* It is strongly recommended that you install all files in the download for a new release of MX directly over your existing installation.
** You may end up with some files no longer needed by the new release, left over from older release, but this is better than risking missing some vital files

: There is an [[Updating_MX_to_new_version#Installer_Option|installer utility]] available to help with upgrading.

*Important, please read all of the release notes (in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 appropriate forum announcement] threads) for the builds since the version you are upgrading from, especially noting when there are references to necessary once-off actions.
*If you have never upgraded before, or you are currently running a fairly old release of MX, you are advised to read the [[Updating MX to new version]] page in this Wiki,
** you may be recommended to upgrade in stages, as certain releases do essential one off actions that are missed if you skip that release; e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables
** overwriting an existing installation will add any new files, but it won't remove obsolete files, and sometimes [[MX_Basic_info#Library_software|replacement files]] have different names to their predecessors so don't overwrite the old files
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page
** However, it is likely that information on those pages was written for earlier MX releases, and might be out of date, so like many other people you might want to ask in the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have more up-to-date advice.

Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software that have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software.

== Current Release ==

===Latest build distribution download===

~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3205/CumulusMXDist3205.zip Cumulus MX v3.21.1 build 3205, 04-September-2022]

===Latest MX Source Code===

~ View/download [https://github.com/cumulusmx/CumulusMX Cumulus MX Current Source Code]

This source code base is updated for all releases resulting from development by M Crossley, it includes some contributions from other developers.

===Raspberry Pi Image===

~ Download [//{{SERVERNAME}}/Downloads/rpi-CumulusMX-lite-3.19.0.zip Raspberry Pi Image for Cumulus MX 3.19.0]

As at April 2022, the image includes Raspberry Pi. O. S. 11 "Bullseye" version of Linux.

 

# This is a pre-built disk image file for your first installation onto a Raspberry Pi computer.
# Do read the instructions for using this image on the [[Raspberry_Pi_Image|Raspberry Pi Image]] page to see what is in the image and how to use it
# It is of course possible that sometimes the image provided may have issues for you,
#* it is set up so that MX starts running as a service immediately you boot up your Raspberry Pi, rather than letting you first run MX interactively (see [[MX_on_Linux#Running_MX]]);
#* it is produced with a Raspberry Pi model 3, so with other models you may need to replace the Mono software included in image, and consider what updating rates your model can support;
#* it is produced using a GB locale and GB time-zone, so that automatically started MX may not initially be running correctly for your locale (however as you need to restart MX after changing settings you should be okay when MX starts recording data).

: Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono).

==Older releases==

It is always possible that a new release introduces a bug, and you decide to regress to an earlier release.

Find link to earlier MX release distributions [https://github.com/cumulusmx/CumulusMX/releases here].

(You can search using the history tab on this Wiki page to see which past builds were made available as Raspberry Pi images, as these are not created for all releases, but there is no way to tell if the old filenames can still be downloaded. Generally, it is easiest to download a different normal MX release distribution over whatever MX release was in the image you downloaded.)

= Other utilities =

==By Mark Crossley==

The following download zips do not include the ''*.dll'' files ("software libraries") needed to run the respective utility, these are provided in the MX release zip that is stated alongside download link. The different utilities vary with regard to which software libraries they require, and those with technical understanding can check the code sources.

If you are using an earlier MX release than that stated, upgrade MX to bring in the new "*.dll" files needed, because the utility will not work with the versions of "software libraries" included with earlier MX releases.

If you are using a later MX release than that stated, check [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 the MX release announcements] for all releases since that stated to see if the "software libraries" have been upgraded, if they have then the respective utility because it has been compiled with older versions of the respective .dll files will probably not work. (Sometimes the names of new .dll files are different to the names of the old .dll files, so an upgrade of MX done by copying files over an existing installation will leave the old files there, in that case the utility might still work by picking up old names).

=== Create Records ===

This utility is not yet available.

A utility to create, or recreate, missing [[Correcting_Extremes|extreme records]] from Cumulus MX by parsing your [[dayfile.txt|daily summary (dayfile.txt)]].

=== Create Missing ===

~ The CreateMissing.exe ''v1.3.0'' download dated 18 August 2022 (works with release of MX 3.20.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.3.0/CreateMissing-v1.3.0.zip is here].

Check compatibility with the MX release you have running as per notes above. (Although earlier releases of "Create Missing" exist on "github.com/cumulusmx/CreateMissing/releases", their software bugs imply they should not be used). Install into same directory as "CumulusMX.exe".

This MX utility, affects [[Category:Files with Comma Separated Values|Cumulus CSV files]]:
# It will create a new [[dayfile.txt|daily summary (dayfile.txt)]]. If you already have a "dayfile.txt", that is renamed, the new file should include individual fields, and lines, missing from your old file.
# It will read, and where appropriate update, your [[Standard log files|month by month (MMMyylog.txt)]] files.
#* The utility reads the [[Calculate_Missing_Values#Source_value|source values]] in as input values. This utility has the ability to calculate many of the [[Calculate_Missing_Values#Derived_value|derived fields]], so will add any missing derived values to your month by month files as it proceeds.
#* Therefore the utility should be used to add the [[Standard_log_files#Number_of_fields_per_line_varies_by_release|extra fields]] for those months where the input file was produced by Cumulus 1 or an earlier release of MX (which might have populated fewer fields or used a [[Feels_Like#How_to_express_Feels_Like_for_highest_temperatures|different calculation]]).

Usage information by the author of the utility can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.]
* Learn more about this utility by reading the [[Calculate_Missing_Values#CreateMissing.exe|calculate missing]] page in this Wiki.
** Elsewhere on that same page learn when this utility might be useful, and what else you can try.
* Check in the support forum for information about status of bugs in this utility, at time of last updating this paragraph there was an outstanding issue concerning storing the line in dayfile.txt for the first of some months if your rollover time is not midnight.
* For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page.

=== Export ''To'' MySQL ===

~ The ExportToMySQL.exe ''v1.6.1'' download dated 02 September 2022 (works with release of MX 3.21.0) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.6.1/ExportToMySQL-v1.6.1.zip is here.]

Check compatibility with the MX release you have running as per notes above. Note that compatibility is needed both with the .dll files and with the columns present in the table to be updated.

If you are not using the MX release named above, then other release zips (and source code) for this utility are available at [https://github.com/cumulusmx/ExportToMySQL/releases ExportToMySQL/releases] and each release there is labelled as to which MX release creates default tables with correct columns.

This utility reads [[MySqlConnect|Settings]] that are also used by "CumulusMX.exe". Parameters supplied to this utility enable it to do ''one of the following actions'' affecting rows not already present on a [[Your Own Server|MySQL, or MariaDB, database server]]:
# The parameter used is "dayfile", will insert missing rows into a database table that is called "dayfile" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of [[dayfile.txt|daily summary (dayfile.txt)]] file
# Insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of the single file of [[Standard log files|month by month (MMMyylog.txt)]] whose relative path "data/..." is named in the parameter
# The parameter used is "monthly", will insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) reading data from the contents of all files of type [[Standard log files|month by month (MMMyylog.txt)]] found in the [[Data folder|data sub-folder]].

Installation and usage information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.]

''This new utility replaces the "ExportMySQL.exe" (no "To" in that name) utility included by Steve Loft in his MX beta distributions.'' That is not compatible with any recent MX releases.

==By Steve Loft==

Source code for these utilities are not available, therefore they cannot be altered or upgraded.

=== Utility for Fine Offset Stations ===

*[//{{SERVERNAME}}/Downloads/SetLogger.zip Set Logger Interval] A utility by Steve Loft to adjust the internal logging interval on Fine Offset stations

=== Weather Display Converter ===

This utility was provided by Steve to convert '''Weather Display''' log files to Cumulus 1 format, download [https://cumuluswiki.org/a/File:WDconverter.zip here].

Please read the readme file in the zip.

There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about using this converter with the legacy Cumulus here].

 

At time of creating this utility, the functionality offered by MX was limited, and this utility was not useful with MX. MX now has much more functionality, and depending on the release you are using, this utility may be useful. Remember this utility will not support all fields used by MX. It is advised you use [[#Create Missing]] (see above) after using this utility to populate the other fields. If you do find this utility does not work with your MX release, you may need to manually recreate records, etc. using Cumulus 1 formats, and then [[Migrating from Cumulus 1 to MX|Migrate all your files from Cumulus 1 to MX]].

=== WeatherLink Converter ===

This utility was provided by Steve to convert Davis '''WeatherLink''' log files to Cumulus format, download it [https://cumuluswiki.org/a/File:WLconverter.zip here]. Please carefully read the '''readme''' file in the zip to understand how to use this utility.

Note this has nothing to do with Davis ''Weather Link Live'' despite confusing similarity in name.

Basically, this converter utility reads '''.wlk''' files, it creates a folder called '''converted''' into which it places [[Standard log files]] and [[dayfile.txt]] files as used by Cumulus software. You need to be able to manually merge (using a text file editor) the newly created files with any files of same name in your Cumulus [[data folder|'''data''' folder]]. You might also want to read (although not directly related to this converter utility) [[Amending_dayfile#Importing_data_not_recorded_by_Cumulus|Importing_data_not_recorded_by_Cumulus]].

A search on the support forum will reveal various posts on use of this converter. The key topics are:
* [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=20017 forum topic about using this converter with MX here]
* [https://cumulus.hosiene.co.uk/viewtopic.php?t=11349 forum topic about using this converter with the legacy Cumulus here].

== Third Party Contributions by other Cumulus Users ==

For files, and add-on's, contributed by Cumulus users, see these Categories (where third party authors may have mentioned what they offer):
# [[:Category:3rd Party Apps]] - contributions for various devices,
# [[:Category:AddOns]] - adding extra functionality,
# [[:Category:WebTools]] - for your web server, and
# [[:Category:User_Contributions]] - key contributions from the user community

=Current MX Developed from =

Cumulus 3 (MX) software was developed as a beta with limited functionality by Steve Loft.
* Steve Loft previously developed Cumulus 2 (where he tested using the C# language, now used for MX)
* Steve Loft created the original Cumulus software (now known as legacy cumulus 1) just for his use, before making it generally available, he then developed it over the next decade to include requirements suggested by thousands of users.
* Steve Loft, the author of Cumulus/Cumulus MX has since fully retired, and stopped providing support, or updates, to any of his software.

==Steve's final beta MX==

You can download below the final Cumulus 3 beta release, as made available by Steve Loft, and also his ''subsequent'' final source code.

If you are able to understand his source code (linked below), and compare it to the latest source code (linked above), you can appreciate the transformation that has taken place in recent years.

*[//{{SERVERNAME}}/Downloads/CumulusMXDist3043.zip Cumulus MX v3.0.0 beta build 3043, 20-Jan-2017] Cumulus MX, a cross platform version of Cumulus 3 which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X (Steve Loft - final release), single zip that includes both "CumulusMX.exe" and "ExportMySQL.exe".
*[//{{SERVERNAME}}/Downloads/CumulusMXSource.zip subsequent updated Cumulus MX Source Code] from Steve Loft. He made the following comments, as he handed the project over to "the community":
**This version of the code is post the last release I made at build 3043 as it includes some extra changes that I have not finalised.
**My source code is offered as my parting gift, completely '''without support''', in the hope that it might be useful to future developers.
**My source code is very badly structured due to the 'Frankenstein' way I cobbled it together from various places. Some of it is a machine translation of parts of Cumulus 1.

= Legacy releases =

See [[Downloads| downloads page]] for full details.

== Cumulus 1 ==

Cumulus 1 software was popular, when it went public in 2004, and its [[Cumulus_Users|usage]] grew very rapidly in the subsequent decade until final 2014 release. Even now (in mid-2022) some people are still using the final release version (and a quite substantial number of public viewable weather sites are still driven by earlier builds).

Be aware, the longer you wait before swapping from legacy to Cumulus MX software; the more that MX will have developed away from the legacy. MX's development has effectively abandoned its former focus on compatibility, so you might encounter more difficulty with [[Migrating from Cumulus 1 to MX|transferring your data files when you migrate]].

In all months of 2020, (when the year selection drop-down provided in all releases of original software reached its limit, and MX gained a substantial increase in functionality), and continuing into mid-2021, there was an avalanche of people who used to use the legacy software successfully swapping to MX. As of mid-2022, the usage of this legacy software is in fast decline, implying fewer people can offer assistance.

The '''installer for the FINAL release of the legacy Cumulus 1''' is available here:
#[//{{SERVERNAME}}/Downloads/CumulusSetup.exe Cumulus 1099 installer] Full set of files within an installer.
#* On the "this period" type, and snow index, screens you can still manually enter any year,but you have to over-type with the full year yourself, outside range 2008 to 2020.
#* You cannot manually regenerate NOAA reports after 2020, but there is no problem with automatic generation.
#[//{{SERVERNAME}}/Downloads/cumulus.1099.2.zip Cumulus 1.9.4 build 1099.2 patch] Patched version of one file (cumulus.exe) to replace that file from above installer
#* Note this is not the full installation package, just one file to replace in the suite of files created by the installer.
#* This patch modifies the drop-down year selectors, (on "this period" screens, for NOAA reports, and for Snow Index) making it easier to choose date entries (patch version 1099.2 was released 28 Jan 2020) up to the year 2030.

=== Legacy Cumulus 1 Resources ===

*[//{{SERVERNAME}}/Downloads/Cumulus%20basic%20installation%20guide.pdf Cumulus installation guide] Instructions for installing Cumulus 1
*[//{{SERVERNAME}}/Downloads/readme.txt Cumulus readme.txt] Please read this before installing or updating Cumulus
*[//{{SERVERNAME}}/Downloads/Cumulus.chm Cumulus help file] The Cumulus 1 help file (this also gets installed when Cumulus is installed)
*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French
*[//{{SERVERNAME}}/Downloads/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight (Silverlight is no longer developed or supported by Microsoft) application for displaying 2 extra dials showing real time wind data on the standard Cumulus gauges page (with temperature and rainfall in histogram style) for a web site

=== Special Variants ===

It is '''STRONGLY RECOMMENDED''' that users of Cumulus '''1.9.4 variants''' migrate to Cumulus MX, which has ongoing support by Mark Crossley. The baud rate can be selected within MX as a configuration setting.

*[//{{SERVERNAME}}/Downloads/CumulusSetup1100.zip Cumulus 1.9.4 build 1100 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 115200 baud, you should use build 1100
*[//{{SERVERNAME}}/Downloads/CumulusSetup1101.zip Cumulus 1.9.4 build 1101 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 19200 baud, you should use build 1101
*'''NOTE:''' '''These Cumulus 1.9.4 variants will not have any updates in the future.'''
* The patch for Cumulus.exe, cannot be used with these variants
* The menu items with year drop-down selectors will not display years beyond 2020.
**For example, this will happen on manual generation of NOAA-style reports.
**This does not affect any automatic generation of NOAA reports, but does prevent re-generation.

== Cumulus 2 ==

The software for Cumulus 2 alpha release is no longer available.

Correcting Extremes

2022-09-07T17:17:31Z

Sfws: Some spelling corrections, and layout sequence improvements

[[Category:Cumulus Files]][[Category:Ini Files]]
=Terminology=

For simplicity, the terminology "extremes" is used on this page, the meaning includes:
# The ''totals'' maintained (such as rainfall, chill hours, and the various "degree days"), and
# The high/low "extreme records" for various periods (such as all-time, and this month).

This Wiki page has been created to cover both {{Version badge 1}} and {{Template:Version badge Mx}}, but do be aware that some terminology varies between the two flavours. All too often a mistake in one extreme record is propagated to other extreme records, so the purpose of this page is to cover all the necessary corrections in one place (previously the information was scattered between Wiki pages for each specific file, this redesign brings together all such text here).

==Rogue value==

Throughout this Wiki the term '''rogue value''' is used to mean you see a value somewhere in Cumulus that you believe should not be there.

Generally, "rogue" usage refers to a single data point. However, where that weather derivative is cumulative in nature it might affect a string of recorded values. Regardless of whether it is single or not, such a rogue value can be propagated into several of the extreme derivatives that Cumulus calculates and maintains in its various logging files. Specifically, on this Wiki page, the meaning covers any incorrect entry in one or more of the [[:Category:Ini Files|extreme record files]].

Here are some typical examples:
* it might appear that a gust of 89 mph was recorded as the highest on a day when you are sure it was not that windy, a single data point is wrong
* perhaps you saw 478.8mm of rain occurring on a dry day, this might be a single data point error, or as rain total is cumulative a series of wrong date points
* an extreme can be attributed to wrong time (or even wrong day), because the time on your weather station clock is wrong

=How Cumulus software tracks "extremes"=

As Cumulus weather software processes each reading from your weather station, it checks that value (and any [[Calculate_Missing_Values#Derived spot values|derived]] from it) against the extremes currently stored in various RAM variables, and if necessary updates the extreme records that are affected. Please note these extreme records are held by Cumulus software in internal variables. Periodically, these totals and high/low "extreme records" are written out to [[:Category:Log_Files|.ini files]] (ensuring such "extremes" are kept when MX is stopped and restarted).

The totals/extreme records that are maintained in this way are:

{| class="wikitable" border="1"
|-
!style="width:200px"|Period
!style="width:50px"|File storing extremes
!style="width:300px"|How to correct
!style="width:50px"|Link to web tag section
!style="width:300px"|Notes
|-
! scope="row"|For current day so far
|[[today.ini]]
| Editor for "Today's rain" (no editor for other derivatives)
|[[Webtags#Today|today.htm]]
|Many entries in this file (for non-midnight rollover, use is made of [[yesterday.ini]] too) get transferred to [[dayfile.txt]] at end of day.
|-
! scope="row"| For past days
| [[dayfile.txt]]
| See [[Amending dayfile]]
| Web tags only exist for [[Webtags#Yesterday|yesterday]]
| Often used as source for corrections - see [[#How editing accuracy depends on source selected|Depends on source selected Note]]
|-
! scope="row"|For current month-to-date
|[[month.ini]]
| Editor for "This month's records"
|[[Webtags#Monthly|thismonth.htm]]
| Please see [[#Accuracy Note]]
|-
|colspan="5" style="background:pink;"|monthyyyyMM.ini are archived copies for past months
|-
! scope="row"|For current year-to-date
|[[year.ini]]
| Editor for "This year's records"
|[[Webtags#Yearly|thisyear.htm]]
| Please see [[#How editing accuracy depends on source selected|Accuracy Note]]
|-
|colspan="5" style="background:pink;"|yearyyyy.ini are archived copies for past years
|-
! scope="row"|For all readings since a '''start date''
|[[alltime.ini]]
| Editor for "All Time Records"
|[[Webtags#All_Time|records.htm]]
|See table below for start date
|-
! scope="row"|For a particular month in all years
|[[monthlyalltime.ini]]
| Editor for "Monthly Records"
|[[Webtags#Monthly_All_Time_Records|monthlyrecord.htm]]
| Similar to previous row, but different start date, and separate extremes maintained for each month (regardless of the year)
|}
Explaining columns in above table:
# The first (label) column is self-explanatory
# The second column contains a link to the page that explains more about the file named there, which is where the extreme records are stored for that period
# The third column gives the name for the '''Edit''' menu item to choose to edit these extreme records
# The links in fourth column leads you to more information about the web tags associated with that period, you can incorporate those in your own [[Customised_templates|templates]].

=Built in extreme record editors=

[[File:Badge v1.png]] Cumulus 1 gained extreme record editing functionality from version 1.9.1 6th April 2011. See screenshot [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|Edit menu]] for how to select which file to edit, once on required editing screen, follow instructions on screen:
* Simply type over the existing value and time-stamp as shown (or if you have loaded the log files, select which value to copy across and click "Copy" to copy figure from identified log file to extreme record file). Press Save button to retain the change and exit.

Cumulus MX gradually gained extreme record editing functionality in releases from 3.1.1 - b3054 to 3.4.0 - b3064 (1 Nov 2019 to 19 Feb 2020), with a major redesign of user interface in release 3.18.0 (b.3189 14 June 2022):
* In latest MX release, if you click on an individual extreme record, then a pop-up appears where you can directly edit value and time-stamp to typed new content
* To load data from [[Standard log files]] you have to click on a button, from release 3.2.0 - build 3056 - only the relevant [[dayfile.txt]] entries are shown by default
* In latest MX release, if you click on a value in either dayfile.txt or standard monthly log file columns, then you are presented with yes/no options to select to copy value across or not, this does not update date/time
* In latest MX release, if you click on a date/time-stamp in either dayfile.txt or standard monthly log file columns, then you are presented with yes/no options to select to copy date/time across or not, this does not update value
* There is some validation on editing, you cannot empty the content of any extreme record

The built-in editors do allow you to load the standard monthly log files as well as the daily summary file (dayfile.txt). The other advantage of loading up these log files is that it allows you to see if the rogue value is also present in these log files. However, do exercise caution about using values from such sources, because as will be explained next, they may not hold the extreme values.

==How editing accuracy depends on source selected==

The editors built into Cumulus, for long term extremes (over a period of a month or more), give you the ability to display, for each extreme record:
# The (hopefully more accurate) figure taken from a search for that extreme by examining all entries in the [[dayfile.txt]] for that period
# The (usually less accurate) figure taken from a search for that extreme by examining all entries in the [[Standard log files]] for that period

Obviously, it is possible that the dayfile.txt file has been corrupted, and if you are using MX, then you may want to read [[Calculate_Missing_Values#CreateMissing.exe|about a utility that can recreate dayfile.txt]].

But generally, dayfile.txt is the best starting point for recreating any longer period extreme records, to understand why read on:
* Using [[Standard log files]] as source for recalculating past extremes:
** Let us assume you are using the default logging interval of 10 minutes
** Unlike some other weather station software available (which logs highest and lowest since previous log), Cumulus logs spot values
** That means the [[Monthly log files]] do not capture any extremes recorded in the time (by default 599 seconds) between logs
** Therefore the detailed log files are not normally the most accurate source
** Please note, this less accurate way of deducing daily extremes/totals (to update dayfile.txt) is used by Cumulus software:
*** For Legacy Cumulus 1: [[Amending_dayfile#Create_Missing_on_legacy_dayfile_editor|Create Missing in legacy dayfile editor]].
*** For MX: [[Calculate_Missing_Values#CreateMissing.exe|CreateMissing.exe]] utility.
* Using [[dayfile.txt]] as source for recalculating past extremes
** MX typically processes data from your weather station every second (even if you use a weather station type that only reads its sensors every 40 or 60 seconds). Cumulus 1 processes data from your weather station at intervals that vary for the different station types, but we can assume it is at least every 60 seconds.
** Therefore extremes recorded in '''today.ini''' (and from there into '''dayfile.ini'') are based on the full sampling done by Cumulus
** This means none, or very few, extremes are missed
** In March 2021, a new utility '''Create Records''' was planned (for use with MX only), as at July 2021 no progress has been made in coding it. It appears that this utility will read '''dayfile.txt''' and use the more accurate daily extremes it finds there, as a basis for updating longer term extremes in the other [[:Category:Ini Files|files like monthly-all-time and all-time]]. ''<big>Perhaps you my reader can be the contributor who updates this if the proposed utility becomes available</big>''.

==Cautionary warning and other files to examine==

File corruption can happen as a response to an electrical supply problem, a temporary input/output problem within the operating system, or the storage device being used, as well as after corruption of data within your weather station generating a rogue value fed through to current files.

Any or all of the [[:Category:Ini Files| Extreme Record .ini Files]] ''currently in use by Cumulus'' may get corrupted, as Cumulus gains exclusive write access that can overwrite the entire file during an update.

Remember the values displayed in the built-in editor from dayfile.txt or monthly standard log files just might have been corrupted in the same problem. Cumulus only appends new lines to the end of these files, so it should never overwrite the whole file, but it is possible for a connection problem to make Cumulus start a new file.

Therefore it is worth noting where else you can look to find values and date/time-stamps to use when correcting rogue data, and the next few subsections make some suggestions.

===Update tracking logs===

Cumulus 1 logs most extreme updates in files stored in [[Diags folder]]. Read that cross-reference for more guidance. As already mentioned, there is a log [[Alltimelog.txt]] that tracks the updates to all-time extremes.

Cumulus MX can log useful information in [[MXdiags folder]], depending on settings mentioned in that cross-reference, but it maintains two logs [[Alltimelog.txt]] and [[Monthlyalltimelog.txt]] as already mentioned.

These tracking logs can, in certain circumstances, be the best place to look up previous values as replacements for rogue values, when the built-in editors reveal that the rogue values exist in dayfile.txt and (possibly) the standard monthly log, so you can't within the editors find the correct value you seek.

===Looking at graphical representations===

Many people find it easy to interpolate replacements for rogue values by looking at graphical representations of their weather data covering before and after the time when the rogue figure got recorded.

In Cumulus 1, the obvious place to look is select-a-graphs (available from version 1.2 released on 5th April 2004).

In Cumulus MX, later releases also have a select a chart feature, that may be more useful than the standard charts (in both interface web pages and default web pages).

Some plots record values every minute, and those high resolution plots are ideal for your search.

===Using the Cumulus backup===

Cumulus makes backups of the extreme record files that are kept in folders within the [[Backup folder|backup sub-folder]] in the Cumulus installation, with a maximum of about 8 being retained (it varies between flavours), so this method cannot be used for rogue values that are a week old or older.

If you notice the rogue update when it happens, remember provided you act, as soon as possible afterwards, [[Calculate_Missing_Values#Reading_archive_data|you may be able to make use]] of the earlier version of the relevant extreme records file, as a source of correct extreme records before the corruption by a rogue figure.

All the extreme record files mentioned in the table above are backed up when Cumulus is restarted and (depending on which release you are using - see [[today.ini]]), with their contents just as they were either with the end of day or start of day. It is therefore possible no true extreme has happened since the most recent backup, or maybe by comparing two recent back-ups you can obtain guidance on when the last true extreme occurred. Obviously, such back-up files are no use for correcting daily extremes, but for this month, monthly-all-time, this year, and all-time, extreme records, updates to extremes don't always happen every day, especially when near end of a month. Therefore there is a good chance that you can find the previous extreme by examining a backup copy, providing a true extreme has not happened since.

===Searching recent history===

Cumulus 1 only provides one way to access the [[Webtags#Recent_History|Recent_History]], and that is by web tags. It is not easy, but if you know the time when a rogue value was reported, it may be possible to check values slightly earlier and slightly later by requesting them using web tags.

Cumulus MX stores its [[Recent history]] in a SQLite3 database that you can read/edit as explained at [[Cumulusmx.db#Reading.2Fediting_database_table_outside_MX]].

=General Editing Advice=

The remainder of this Wiki page describes general techniques for correcting rogue values, including using the built-in-editors, and gives guidance on all the different ways to find correct values.

You may have a feel as to which files in above table will need correction, but if in doubt it is highly recommended that you always start your extreme record correction by seeing if the error is present in the [[Alltime.ini]] file that holds all-time extreme records. That approach is best, partly because many Cumulus Users take a lot of interest when their all-time extreme records are broken, and partly as all-time is a good place to start as it can make subsequent edits easier.

==Extreme monitoring start-dates==

As Cumulus has developed, various derived values have been added that it calculates in addition to whatever your weather station supplies. At some releases, these extras are only available via web tags for current values, and it may be some significant time later that a release makes them available as all-time, or other period, extremes. You may be able to track these changes by examining "changes.txt" for Cumulus 1 or "updates.txt" for MX, but those sources are not comprehensive.

''There is no guarantee that this Wiki content has been checked, or that it is up to date. Any contributor is welcome to make corrections or bring it up to date''

For simplicity, this article will only document the development of yearly functionality and attempts to record when various extreme records became available in that context.

It should be obvious that full extreme record data was not available in all Cumulus releases for all the weather variables that the latest release reports. In general, for Cumulus 1, daily extreme functionality was added first, then all-time, followed by this month/year extreme functionality, and finally monthly-all-time. For MX, generally extras were added as current values first, and later the extremes for all the various periods were added together, but development does not always happen in a consistent way!

This section has intentionally been kept brief, so it does not list all bugs that might result in incorrect extremes being stored, nor when such bugs were subsequently resolved.

[[Image:Icon info.png|left|30px]]The '''start date''' referenced in the last bullet in the introduction, is generally when you first started using Cumulus. However, as Cumulus has developed it has started monitoring more extreme records compared to those it was previously monitoring, so if you were using Cumulus software before 28 Jul 2020, you should check the following table. For any parameter you select in the table, the monitoring of all-time extreme records started whenever you decided to install the release shown in the following table, or a later release:

{| class="wikitable" border="1"
|-
!style="width:300px"|Parameter
!style="width:200px"|First released
!style="width:100px"|First in Version
!style="width:100px"|First in Build
|-
! scope="row"|highest/lowest apparent temperature
|26 Oct 2010
|1.9.1 beta
|957
|-
! scope="row"|highest/lowest feels like temperature
|24 June 2020
|3.6.10
|3086
|-
! scope="row"|highest Canadian Humidity Index (humidex)
| 28 Jul 2020
| 3.7.0
|3089
|-
! scope="row"|highest minimum temperature
| 15 April 2004
| 1.2.2
|(lost)
|-
! scope="row"|highest USA heat index
| 29 Aug 2010
| 1.9.0 beta
|955
|-
! scope="row"|wettest month
| 5 April 2004
| 1.2
|(lost)
|-
| 24 hour rainfall
| 30 Apr 2022
| 3.16.0
| 3182
|-
! scope="row"|highest daily wind run
|3 Jul 2011
|1.9.2 beta
|1001
|-
| Sunshine hours
| 31 July 2021
| 3.12.0
| 3134
|}

Please note the Cumulus Support Forum, while it was hosted by Steve Loft, moved to new forum software on 2 Jun 2008 without preserving what had existed before. This was some months before key information in the forum started being copied to this Cumulus Wiki. Consequently, all his announcements prior to that were lost, this is why some details in above table are marked ''(lost)'', and there is some vagueness in information mentioned elsewhere in this page.

==Correcting multiple extremes==

There are two cases to consider:

===Correcting extremes recorded for every logging entry (plus every day/month/year of long period)===

Sometimes a mistake is made in setting up or calibrating a sensor, or (despite the warnings within both flavours of Cumulus about getting your choice of units correct from the start), you decide to change your units.

In both cases, you will identify a constant/multiplier adjustment to be applied to adjust all values (luckily times and dates of extremes are not affected) over the past period. In both cases, you need to correct past entries in any [[Extra Sensor Files]], any [[Standard log files]], in [[dayfile.txt]], plus the multiple [[Category:Ini Files|extreme record files]].

The built-in editors only correct one extreme record at a time, so they cannot be used for such a task.

It is important to remember that there are [[Calculate_Missing_Values#Some_definitions|source and derived values]] in Cumulus. If you change the units, or introduce a calibration multiplier/offset, that affects the source values, but as derived values are calculated from spot values (e.g. temperature, wind speed, humidity, all recorded at same time), you cannot simply change extremes for derived values by any constant/multiplier. Please see [[Calculate Missing Values]] page for further advice.

The easiest way to change entries in any Extra Sensor Files, any Standard log files, and in dayfile.txt, is to either write a batch editing script (see [https://cumulus.hosiene.co.uk/viewtopic.php?p=155539#p155539 changed rainfall units example]), or to use a spreadsheet (be careful not to affects dates or times) like '''Libre Office Calc''' where you can paste special a multiplier to all cells in a particular column.

===Correcting extremes just for a few logging entries (plus selected days/months/years in a short period)===

There are a further two sub-cases that fall in this category. Both are near impossible to resolve!

Both Cumulus 1 and MX have had bugs in some releases of their software. This may mean that some of the past extremes need correction because incorrect calculations were used when those extremes were recorded, it is not possible here to say exactly how to correct these, but essentially extremes can only be recalculated from corrected spot values, and all the files for that past time will have incorrect data, so any correction is likely to be a slow extremely complex process!

[[File:Badge v1.png]]There were bugs introduced sometimes in builds of the original Cumulus (known now as legacy Cumulus 1). Information about a few of the bugs and fixes can be found in [[File:Changes.zip]], although that does not cover any 1.7.x versions, nor does not detail bugs created (and fixed) within the beta builds. More information may be found by searching within [https://cumulus.hosiene.co.uk/viewforum.php?f=2 Cumulus forum announcements], but it will require a lot of effort (as there are a lot of posts to search). (For historic interest only, one example is that what is stored in '''month.ini''' and '''year.ini''' depends on when they were first created, because they are initiated from the daily summary log, dayfile.txt, for the relevant period. Therefore, an individual parameter can only be initialised if the corresponding field is present in '''dayfile.txt''' for the whole of that period).

[[File:Badge vMx.png]]Cumulus MX had lots of bugs in its early builds. So if you ever used Cumulus MX versions 3.0.0 to 3.3.0, you cannot rely that all all-time extreme records
reported correctly take into account any records broken on a date prior to 19 Feb 2020. Also there have been some changes in how some derivatives are calculated, and these might invalidate other 2020 dated entries. The '''updates.txt''' that is part of each MX release distribution has brief details of when the very many issues were fixed. Again, searching all the posts in [https://cumulus.hosiene.co.uk/viewforum.php?f=40 the relevant support forum] will yield more information in return for a lot more effort.

A sensor might fail, and Cumulus does not recognise that "Null" (this might mean the weather station sends all bits set to zero or all bits set to one) values should be ignored when comparing against existing extreme records, and so set the extreme record to zero or maximum number that the number of bits can convey.

In this second sub-case, you again effectively have rogue measurements over an extended past period. Theoretically you can correct using a special batch editing script, or an external editor, but in this case you have to decide what value to use to represent '''not-working'''. You don't want to use a value that affects extremes (so you can't use an obviously wrong high or low value), you can't blank off any extreme (set it to empty), and Cumulus will not accept "--" type inputs, or anything else that might represent a null. Some people take values from a neighbouring measuring station or in some other way insert values that are good approximations. However, there is no official solution to this problem!

==All-time corrections==

For the all-time extreme records, each individual update is logged in [[Alltimelog.txt]] from version 1.8.9 onwards. Depending on sequence of extreme values, you may get an accurate previous value from this tracking log.
* The tracking log will not tell you a correct high/low extreme record if ''the rogue extreme occurred before the actual high/low extreme'' was experienced. This is because the rogue extreme stopped any subsequent true extreme being recorded.
* If the ''actual high/low extreme that you want to retain was recorded before the rogue extreme'', then you can see that true value, and its time-stamp, in the tracking log. Based on that time-stamp, the tracking log tells you whether the error will have also affected the relevant month monthly-all-time, and whether it has affected this month/year, so you have pointers to what other files to edit.

==Introduction of Monthly All Time Extreme records==

From version 1.9.3 beta build 1033 released on 10 April 2012, Cumulus introduced the ability to monitor extremes like 'highest ever January temperature'.

==Initialisation of monthly-all-time extreme records==

Although the release did not automatically initialise monthly-all-time extreme records, the new monthly records editor provided in that release had a "fetch dayfile" button. By clicking just one '''Copy''' button, the one ''in the header row'', all the relevant daily records were copied into the monthly-all-time records for the month of the selected tab. Therefore by doing that again for every other tab (except any tab for a month when you had never used the original Cumulus), and then clicking '''OK''' button, you manually initialised all the parameters (assuming your dayfile had all the parameters - see [[Calculate Missing Values]]).

==Monthly-all-time corrections==

If the rogue value has not affected the all-time extreme records, it is recommended you see if the error is present in the [[Monthlyalltime.ini|monthly-all-time]] file.
* From version 1.9.3 beta build 1033 released on 10 April 2012, Cumulus introduced the ability to monitor extremes like 'highest ever January temperature'.
* If you are using Cumulus 1, then make the best guess as to which tab to pick, or work through each tab until you find the month affected.
* If you use MX, then [[Monthlyalltimelog.txt]]) logs each time any extreme is updated, so that file tells you which tab has the rogue value. You may also get an accurate previous value from this tracking log, it depends on sequence of extreme values, the value you want may not have been noted if the rogue extreme occurred before the value you want, so stopped any subsequent true extreme being recorded.

==Correction of extremes for past year==

An earlier correction may have identified that the rogue value was in a past year, so this sub-section explores whether you can continue correction pathway:
* [[File:Badge v1.png]]Cumulus 1 never allows you to see a '''year.ini''' file when the year is completed, because at the end of the year it is initialised ready for the new year.
* [[File:Badge vMx.png]] From build 3035 released 2 Dec 2015, the MX beta (3.0.0), and later MX releases, at the start of a new year, saves the old year.ini (whenever it was last updated) as a file with a name like '''year2015.ini''', and only then overwrites the ''year.ini'' file.
** Although MX does not provide any functionality to read this old file, let alone edit it, you may want to use a standard text editor to amend the relevant part of this old file. Your edit to either ''alltime.ini'' or ''monthlyalltime.ini'' should have told you what old value in old file is wrong, and told you correct value to replace that.

==Correction of extremes for past month==

An earlier correction may have identified that the rogue value was in a past month, so this sub-section explores whether you can continue correction pathway:
* [[File:Badge v1.png]]Cumulus 1 never allows you to see a '''month.ini''' file when the month is completed, because at the end of the month it is re-initialised ready for the new month.
* [[File:Badge vMx.png]] From build 3035 released 2 Dec 2015, the MX beta (3.0.0), and later MX releases, at the end of a month, saves the old '''month.ini''' (whenever it was last updated) as a file with a name like '''month201501.ini''' (i.e. "month", followed by year, followed by month number, and with file type ".ini"), before writing standard "reset high/low values" to '''month.ini'''.
** Although MX does not provide any functionality to read this old file, let alone edit it, you may want to use a standard text editor to amend the relevant part of this old file. Your edit to either ''alltime.ini'' or ''monthlyalltime.ini'' should have told you what old value in old file is wrong, and told you correct value to replace that.

==Current month/year corrections==

If your earlier correction (''finding how the rogue value has affected monthly-all-time has given you a date'' in the current month/year), that is a steer to whether the [[Month.ini|this month]] extremes file will need correction, and whether [[Year.ini|this year]] extreme records file will need correction.

They are relatively small files, so it should be easy to use the [[#Built in extreme record editors]] to edit them.

==Correction of extremes for past days==

If the rogue value relates to yesterday, or an earlier day, then you must edit [[Amending dayfile|dayfile.txt]] to make any necessary corrections for past days.

It is entirely optional whether you choose to update [[Yesterday.ini|yesterday.ini]] if that contains a rogue value. That file is overwritten at both midnight and at next rollover, so in general there is no benefit gained from any editing.

=== Correcting an error in rainfall for a past day===

For the legacy Cumulus 1, rainfall corrections are covered at [[FAQ#My_station_invented_some_rain_that_didn.27t_really_occur.2C_and_I_want_to_set_it_to_zero_.28or_some_other_figure.29]].

The total rainfall for a month, or 12-month season (rainfall labelled as ''Rain this year'' can start counting from zero on first [[Meteorological day]] of any month chosen by user (Interface: '''Station settings''' → ''Annual Rainfall'' %rarr; '''Start of rainfall season'''), is held in an internal (RAM) variable in Cumulus software. When you start Cumulus software, the program looks in [[dayfile.txt]] and reads the amount for each past day (of current month/season) in that file, then adds the rainfall for today-so-far. For rain this season, Cumulus flavour alters calculation:
* Cumulus 1 - if the year entered in [[Cumulus_Screenshots#Station]] "Annual Rainfall" frame, box labelled ''Year'', matches the current '''calendar''' year, then the amount in box labelled ''Amount'' is added. Note if your season does not start in "January" then this only affects the part of the season that is in the specified year.
* Cumulus MX - if your rainfall season starts in a month within year specified in box labelled "Year to which year-to-date amount applies", then the amount in box labelled "Year-to-date amount" is added to your rain for that season as shown in ''Rain this year'' (and the <ryear> tag if used for [[MySqlConnect|Custom SQL]], MQTT, [[Cumulus_MX_Local_API]], or [[Cumulus_template_file]])

So if the rainfall reported for current month, or current "season" (year) is wrong, you need to correct [[dayfile.txt]], both Cumulus 1 and MX have [[Amending_dayfile#Editors_built_into_Cumulus|built-in dayfile.txt editors]].

==Today corrections==

As described below, the Cumulus '''Edit' menu includes a '''Today's rain''' option where you can adjust the [[Today.ini#Editing_rainfall_in_today.ini_within_Cumulus|total rainfall for today]] (e.g. if you or the wind have knocked your rain gauge).

''There is no facility provided to edit any other content'' of [[today.ini]]. Manual correction may be possible, but do read advice on [[today.ini]] page, in particular noting that MX only reads "today.ini" when first started, MX uses an internal array that represents content of file while MX is running.

In working through the various files in above table, remember that if the rogue value was recorded today, then [[today.ini]] will be wrong:
* In Cumulus 1, you possibly could edit today.ini without stopping the software, provided you get the timing right, but it is more sensible to stop Cumulus before editing that file
* In MX, the values are held internally, with periodic updates to today.ini, so any edit you make to that file while MX is running is ignored. Since MX does not provide a today.ini editor, you must stop MX (see [[MX on Linux]] or [[MX on Windows OS]]) and edit the file using a text editor, or programmer's editor, that will not add unwanted content to the file.

=== Correcting an error in today's total rainfall ===

Easy - correct today's total using the [[Today.ini#Editing_rainfall_in_today.ini_within_Cumulus | 'today's rain']] editor on the edit menu.
* [[File:Badge v1.png]]select 'Today's rain in the [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|edit menu]] accessed from main screen in Cumulus 1,
* [[File:Badge vMx.png]]select '''Today's rain''' in the [[MX_Administrative_Interface#Today.27s_rain.27|edit menu]] of MX interface.

This edit will actually alter the start of day rainfall counter figure:
*If you want today's rain to seem less (perhaps you or the wind knocked the rain gauge), Cumulus will increase the start of day counter
*If you want today's rain to seem greater (perhaps the rain gauge got blocked by a leaf), Cumulus will decrease the start of day counter

Please note that this edit does not affect "rain rate", "maximum hourly rain", "maximum 24-hour rain", or "rain since midnight", nor does it update every data log line so it has correct rainfall counter reading. Also, if you ask MX to automatically insert a new row into a monthly table on your database server whenever a new line is stored in the [[Standard_log_files]], your database will retain incorrect values, as these are not updated by this correction.

Please see [[Today.ini#Editing_rainfall_in_today.ini_within_Cumulus]] for details of how to edit those related fields.

=Some definitions=

==Flavour, Release, Version, and Build==

'''Flavour''' is used to represent the original Cumulus, Cumulus 2, and Cumulus MX, collectively. Where the text says applicability is dependant on flavour, it means that the action you do depends on whether you are installing/running Cumulus MX or the original Cumulus software.

'''Release''' is used to signify what the Cumulus developer makes available for download after there has been a modification to the software. For most Cumulus 1 builds, the release consisted of a executable that would create all the folders and files needed to run that software. For Cumulus 2, releases were a zip file and were numbered using a identifier with many digits. MX releases are as a zip file that is labelled with the build number.

'''Version''' here is a precise term, it identifies collectively all builds that are given a particular version number, that can include alpha and beta releases. For Cumulus 2, the log string of digits that identifies each release was sometimes called the version number. For the original Cumulus, and some MX releases, the version number only changes when new features are included in the release. Major functionally changes affect digit after the first decimal point (digit before decimal point identifies the flavour), while for minor functionally changes, a third part is added to the version number.

'''Build''' number in Cumulus 1 and 3 (MX), was used to identify each release, and historically alpha, beta, and bug fixing, releases could all share the same version number.

Steve Loft generally went through a lot of beta releases identified by build number before finally having a stable release with new version number. Most beta releases were available to everyone.

Mark Crossley has sometimes issued his beta commits identified by beta, beta 1, beta 2, etc. without changing build number, and sometimes incremented build number several times between changes to release version number. Most beta releases are made available to just a select few testers, via a sub-forum with limited access, or via direct email of zip files to particular people. The beta history is not documented in "updates.txt", which only quotes the more significant changes.

Cumulusmx.db (preserving history)

2022-09-05T05:19:22Z

Sfws: Further minor layout change

[[Category:Cumulus MX]][[Category:Cumulus Files]]

= Basic information =

Skip this section if you want details specific to a particular database table.

==Location of this database file==

* This database file/files is/are specific to Cumulus MX (as the file name suggests), not used by legacy Cumulus 1
* For MX Releases 3.0.0 to 3.11.4 inclusive, there were two databases with this name:
*# One database table with this name was held in Random Access Memory for MX Releases 3.0.0 to 3.11.4 inclusive
*# One database table with this name is stored as '''CumulusMX/data/cumulusmx.db''' (get case of each character correct unless Microsoft Windows Operating System)
* The two database tables were merged from release 3.12.0 (beta build 3134) and stored as '''/CumulusMX/data/cumulusmx.db''' (get case of each character correct unless Microsoft Windows Operating System)

==Database type==

This file/files holds a SQLite3 database. Databases of this type are based on sequential file design, i.e. each row in the database table is sequenced by when created (new rows are only appended on end), and given a sequential number to act as primary key (numbers are not automatically revised when a row is deleted).

The MX [[Weather Diary]] also uses a SQLite3 database stored in [[diary.db|CumulusMX/data/diary.db]].

== Reading/editing database table outside MX ==

There are many software tools available that can read/edit SQLite3, should you wish to examine this database.

You could use any application that can read ODBC files (e.g. Libre Office's Base functionality), these can read the MX databases.

You might find '''sqlitebrowser''' easiest to use in a Linux environment.

You might try '''phpLiteAdmin''' if your device runs a Microsoft Windows Operating System.

= Database Tables included =

The following table lists the tables found in this database, indicating which release added the table, and where further details can be found.

{| border="1" class="wikitable"
|-
! style="width:80px" | Table name
! style="width:120px" | How MX updates
! style="width:80px" | Introduced
! style="width:450px" | Description
! style="width:220px" | Editor within MX
! style="width:120px" | Further details
|-
| RecentData
| Updated once a minute when MX is running
| MX beta 3.0.0
* Database of this name with this table originally in RAM
* In 3.12.0 (beta build 3134) table moved to external file
| The update.txt for CumulusMX at release 3.12.0 (beta build 3134) states "Change: Cumulus MX now uses a persistent database to store the recent 1 minute data
- This means that charts, recent web tags, and internal calculations for trends and periodic values will be more accurate after a restart
- If Cumulus MX is offline for a prolonged period, data for that offline period will obviously still be at the station logging interval resolution".
| No editor for Cumulus user
| [[Recent history]] and [[#RecentData table]]
|-
| SqlCache
| Updated when certain conditions are met and SQL is queued
| MX 3.21.0
| The update.txt for CumulusMX at release 3.21.0 states "New - Failed MySQL commands can now be individually edited/deleted

Changed - Failed MySQL commands are now stored in the SQLite database to persist across Cumulus runs"

| Edit or purge the failed MySQL command queue using '''Utils menu''' -->> ''PurgeMySQL''
| [[MySqlConnect]] and [[#SqlCache table]]
|-
| StandardData
| At time of writing, the current MX release does not use this table
| MX beta 3.0.0
(always in file)
| In [https://cumulus.hosiene.co.uk/viewtopic.php?p=123594#p123594 this forum post] Steve Loft describes this table as being for a possible future enhancement. It is believed this is the table that Steve had developed in Cumulus 2, as a replacement for the [[Monthly_log_files]].
| At time of writing, the current MX release does not use this table
| [[#StandardData table]]
|-
| sqlite_sequence
| Developer has not stated when updated
| MX 3.21.0
| Developer has not supplied a description
| Not known
| [[#sqlite_sequence table]]
|}

== RecentData table ==

This table has the following columns:
{| border="1" class="wikitable"
|-
! style="width:10px" | Column number #
! style="width:80px" | Column name
! style="width:80px" | Column type
! style="width:280px" | Properties
! style="width:450px" | Description
! style="width:120px" | Example column value
|-
| 0
| Timestamp
| datetime
| Primary Key, can never be NULL, No Default Value,
| Dates and times for the last 7 days, at whatever interval available (at logging interval for historic archive data, at one minute intervals while MX is running)
| 2021-07-31 19:44:00
|-
| 1
| WindSpeed
| float
| Not NULL, No Default Value
| The average wind speed (see [[Wind_measurement#Weather_Stations_and_Cumulus]] for links) calculated at the stated time, if necessary converted to units requested
| 2.2593056529
|-
| 2
| WindGust
| float
| Not NULL, No Default Value
| The spot gust speed recorded at the stated time, if necessary converted to units requested
| 6.99691241605804
|-
| 3
| WindLatest
| float
| Not NULL, No Default Value
| The spot latest wind speed recorded at the stated time, if necessary converted to units requested
| 3.15989597323001
|-
| 4
| WindDir
| integer
| Not NULL, No Default Value
| The wind bearing (0 =calm), (1 to 360 = number of degrees)
| 315
|-
| 5
| WindAvgDir
| integer
| Not NULL, No Default Value
| The average wind bearing over the defined period
| 270
|-
| 6
| OutsideTemp
| float
| Not NULL, No Default Value
| The measured [[Temperature_(and_humidity)_measurement|outside air temperature]], if necessary converted to units requested
| 17.0
|-
| 7
| WindChill
| float
| Not NULL, No Default Value
| The [[wind chill]], either calculated by MX, or supplied by weather station. (Note: strictly only valid for low temperatures and significant wind speeds)
| (In the example used here, temperature in previous column was too high for wind chill, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 8
| DewPoint
| float
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters|dew point]], either calculated by MX, or supplied by weather station, for the stated time.
| 11.9134549845367
|-
| 9
| HeatIndex
| float
| Not NULL, No Default Value
| The USA [[Heat index]] as calculated by Cumulus for the stated time (if the temperature is high enough)
| (In the example used here, temperature in 'OutsideTemp' column was too low for heat index, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 10
| Humidity
| float (1 decimal place)
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement|Relative Humidity]] reported by the station at the stated time
| 72.0
|-
| 11
| Pressure
| float
| Not NULL, No Default Value
| The sea level pressure at the stated time, either as reported by the station or calculated by Cumulus from the absolute pressure reported by the station, if necessary converted to units requested
| 996.400024414062
|-
| 12
| RainToday
| float
| Not NULL, No Default Value
| The rainfall for today so far, calculated by Cumulus from the rain counter (column 15) now minus the rain counter at start of day, if necessary converted to units requested
| 4.5
|-
| 13
| SolarRad
| integer
| Not NULL, No Default Value
| Solar radiation value reported by station at stated time
| 200
|-
| 14
| UV
| float
| Not NULL, No Default Value
| The Ultra Violet Index reported by station at stated time
| 3.0
|-
| 15
| raincounter
| float
| Not NULL, No Default Value
| The rain counter is used by Cumulus for all rainfall outputs, this is its value at stated time
| 550.4
|-
| 16
| FeelsLike
| float
| Not NULL, No Default Value
| The [[Feels Like]] temperature calculated by MX at stated time
| 17.0782773978147
|-
| 17
| Humidex
| float
| Not NULL, No Default Value
| The Canadian [[Humidex|Humidity Index]], calculated by Cumulus at the stated time
| 19.1775362738161
|-
| 18
| AppTemp
| float
| Not NULL, No Default Value
| The [[Apparent temperature]], calculated by MX at the stated time
| 16.8864476063546
|-
| 19
| IndoorTemp
| float
| Not NULL, No Default Value
| The indoor temperature directly as reported by station at stated time
| 120.89999961853
|-
| 20
| IndoorHumidity
| integer (0 decimal places, contrast with column 10)
| Not NULL, No Default Value
| The indoor relative humidity directly as reported by station at stated time
| 61
|-
| 21
| SolarMax
| integer
| Not NULL, No Default Value
| The calculated maximum value for solar radiation at stated time
| 1026
|-
| 22
| Pm2p5
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 2.5 μm, or less, (?? Rolling 24 hours average ??)
| 1.5
|-
| 23
| Pm10
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 10 μm, or less, (?? Rolling 24 hours average ??)
| 1.7
|-
| 24
| RainRate
| float
| Not NULL, No Default Value
| The [[FAQ#How_is_my_rain_rate_calculated.3F|rainfall rate]] calculated for the stated time
| 303.2
|}

See [[Recent history|'''Recent history''' page]] for more details.

==SqlCache table==

There is a MX setting ('''Settings''' -->> ''MySQL settings'' -->> '''General Options''' -->> Buffer commands on failure) that when enabled allows failed commands to be stored here.

This table holds a list of MySQL commands that are in the queue for '''[[MySqlConnect]]''' to run again.

Commands that fail because the database server is down are added to the queue when the setting is enabled (although MX will not save more than one query referencing same primary key). Because the error returned by the server cannot be predetermined, MX instead checks the error returned is not one of the following reasons before adding it to queue:
* ParseError (the query does not make sense)
* EmptyQuery (query has not been specified)
* TooBigSelect (there is a limit to how much data can be selected)
* InvalidUseOfNull (the schema has to say for each column whether null is permitted)
* MixOfGroupFunctionAndFields (syntax can't mix these)
* SyntaxError (an error in the SQL syntax)
* TooLongString (there is a limit to what can be input)
* WrongColumnName (the column name must exist in the referenced table/view)
* DuplicateUnique (you can't insert a new row with same primary key as an existing row)
* PrimaryCannotHaveNull (the primary key must be set to a specific value)
* DivisionByZero (certain mathematical operations cannot be handled)

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE "SqlCache"(
"key" integer primary key autoincrement not null,
"statement" varchar)

The table contents are simple to explain, each time a new command is stored it is assigned a new number (that is automatically incremented from last number used) and the command itself is stored in a variable text length entry.

==StandardData table==

At time of writing this documentation, the latest MX release does not use this table, and it has zero rows. A [https://cumulus.hosiene.co.uk/viewtopic.php?p=113475#p113475 forum post by Steve Loft] about a database based logging proposal for Cumulus 3 (MX) confirms the original purpose was to improve the ability to [[Correcting Extremes|Correct Extremes Records]] by storing the most frequent and accurate extremes possible.

While that does not specifically explain this table, his choice of [[Standard log files|table name]] suggests he was planning to either replace, or duplicate, the use of text files for logging data. It appears he was actually thinking about implementing [[Monthly_log_files#Enhancement never implemented]] from his inclusion of "Lo" and "Hi" values in the column list.

The only alternative theory is Steve Loft actually thought he could improve on the [[Recent history]] functionality, by storing the highest and lowest readings read from weather station in-between the one minute resolution.

Here is the relevant create table instruction, so this tells you the 17 fields in the table as Steve created it (these have never been changed):

CREATE TABLE "StandardData"(
"Timestamp" datetime primary key not null ,
"Interval" integer ,
"OutTemp" float ,
"LoOutTemp" float ,
"HiOutTemp" float ,
"DewPoint" float ,
"LoDewPoint" float ,
"HiDewPoint" float ,
"WindChill" float ,
"LoWindChill" float ,
"HiWindChill" float ,
"InTemp" float ,
"LoInTemp" float ,
"HiInTemp" float ,
"Pressure" float ,
"LoPressure" float ,
"HiPressure" float )

==sqlite_sequence table==

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE sqlite_sequence (`name` TEXT, `seq` TEXT)

Cumulusmx.db (preserving history)

2022-09-05T04:48:55Z

Sfws: layout

[[Category:Cumulus MX]][[Category:Cumulus Files]]

= Basic information =

Skip this section if you want details specific to a particular database table.

==Location of this database file==

* This database file is specific to Cumulus MX (as the file name suggests), not used by legacy Cumulus 1
* The file is held in Random Access Memory in MX Releases 3.0.0 to 3.11.4 inclusive
* This database file is stored as '''/CumulusMX/data/cumulusmx.db''' (get case of each character correct unless Microsoft Windows Operating System) from release 3.12.0 (beta build 3134)

==Database type==

This file holds a SQLite3 database. Databases of this type are based on sequential file design, i.e. each row in the database table is sequenced by when created (new rows are only appended on end), and given a sequential number to act as primary key (numbers are not automatically revised when a row is deleted).

The MX [[Weather Diary]] also uses a SQLite3 database stored in [[diary.db]].

== Reading/editing database table outside MX ==

There are many software tools available that can read/edit SQLite3, should you wish to examine this database.

You could use any application that can read ODBC files (e.g. Libre Office's Base functionality), these can read the MX databases.

You might find '''sqlitebrowser''' easiest to use in a Linux environment.

You might try '''phpLiteAdmin''' if your device runs a Microsoft Windows Operating System.

= Database Tables included =

The following table lists the tables found in this database, indicating which release added the table, and where further details can be found.

{| border="1" class="wikitable"
|-
! style="width:80px" | Table name
! style="width:120px" | How MX updates
! style="width:80px" | Introduced
! style="width:450px" | Description
! style="width:220px" | Editor within MX
! style="width:120px" | Further details
|-
| RecentData
| Updated once a minute when MX is running
| Changed:
* MX beta 3.0.0 in RAM
* 3.12.0 (beta build 3134) as external file
| The update.txt for CumulusMX at release 3.12.0 (beta build 3134) states "Change: Cumulus MX now uses a persistent database to store the recent 1 minute data
- This means that charts, recent web tags, and internal calculations for trends and periodic values will be more accurate after a restart
- If Cumulus MX is offline for a prolonged period, data for that offline period will obviously still be at the station logging interval resolution".
| No editor for Cumulus user
| [[Recent history]] and [[#RecentData table]]
|-
| SqlCache
| Updated when certain conditions are met and SQL is queued
| MX 3.21.0
| The update.txt for CumulusMX at release 3.21.0 states "New
- Failed MySQL commands are now can now be individually edited/deleted

Changed
- Failed MySQL commands are now stored in the SQLite database to persist across Cumulus runs"

| Edit or purge the failed MySQL command queue using '''Utils menu''' -->> ''PurgeMySQL''
| [[MySqlConnect]] and [[#SqlCache table]]
|-
| StandardData
| At time of writing, the current MX release does not use this table
| MX beta 3.0.0
| In [https://cumulus.hosiene.co.uk/viewtopic.php?p=123594#p123594 this forum post] Steve Loft describes this table as being for a possible future enhancement. It is believed this is the table that Steve had developed in Cumulus 2, as a replacement for the [[Monthly_log_files]].
| At time of writing, the current MX release does not use this table
| [[#StandardData table]]
|-
| sqlite_sequence
| Developer has not stated when updated
| MX 3.21.0
| Developer has not supplied a description
| Not known
| [[#sqlite_sequence table]]
|}

== RecentData table ==

This table has the following columns:
{| border="1" class="wikitable"
|-
! style="width:10px" | Column number #
! style="width:80px" | Column name
! style="width:80px" | Column type
! style="width:280px" | Properties
! style="width:450px" | Description
! style="width:120px" | Example column value
|-
| 0
| Timestamp
| datetime
| Primary Key, can never be NULL, No Default Value,
| Dates and times for the last 7 days, at whatever interval available (at logging interval for historic archive data, at one minute intervals while MX is running)
| 2021-07-31 19:44:00
|-
| 1
| WindSpeed
| float
| Not NULL, No Default Value
| The average wind speed (see [[Wind_measurement#Weather_Stations_and_Cumulus]] for links) calculated at the stated time, if necessary converted to units requested
| 2.2593056529
|-
| 2
| WindGust
| float
| Not NULL, No Default Value
| The spot gust speed recorded at the stated time, if necessary converted to units requested
| 6.99691241605804
|-
| 3
| WindLatest
| float
| Not NULL, No Default Value
| The spot latest wind speed recorded at the stated time, if necessary converted to units requested
| 3.15989597323001
|-
| 4
| WindDir
| integer
| Not NULL, No Default Value
| The wind bearing (0 =calm), (1 to 360 = number of degrees)
| 315
|-
| 5
| WindAvgDir
| integer
| Not NULL, No Default Value
| The average wind bearing over the defined period
| 270
|-
| 6
| OutsideTemp
| float
| Not NULL, No Default Value
| The measured [[Temperature_(and_humidity)_measurement|outside air temperature]], if necessary converted to units requested
| 17.0
|-
| 7
| WindChill
| float
| Not NULL, No Default Value
| The [[wind chill]], either calculated by MX, or supplied by weather station. (Note: strictly only valid for low temperatures and significant wind speeds)
| (In the example used here, temperature in previous column was too high for wind chill, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 8
| DewPoint
| float
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters|dew point]], either calculated by MX, or supplied by weather station, for the stated time.
| 11.9134549845367
|-
| 9
| HeatIndex
| float
| Not NULL, No Default Value
| The USA [[Heat index]] as calculated by Cumulus for the stated time (if the temperature is high enough)
| (In the example used here, temperature in 'OutsideTemp' column was too low for heat index, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 10
| Humidity
| float (1 decimal place)
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement|Relative Humidity]] reported by the station at the stated time
| 72.0
|-
| 11
| Pressure
| float
| Not NULL, No Default Value
| The sea level pressure at the stated time, either as reported by the station or calculated by Cumulus from the absolute pressure reported by the station, if necessary converted to units requested
| 996.400024414062
|-
| 12
| RainToday
| float
| Not NULL, No Default Value
| The rainfall for today so far, calculated by Cumulus from the rain counter (column 15) now minus the rain counter at start of day, if necessary converted to units requested
| 4.5
|-
| 13
| SolarRad
| integer
| Not NULL, No Default Value
| Solar radiation value reported by station at stated time
| 200
|-
| 14
| UV
| float
| Not NULL, No Default Value
| The Ultra Violet Index reported by station at stated time
| 3.0
|-
| 15
| raincounter
| float
| Not NULL, No Default Value
| The rain counter is used by Cumulus for all rainfall outputs, this is its value at stated time
| 550.4
|-
| 16
| FeelsLike
| float
| Not NULL, No Default Value
| The [[Feels Like]] temperature calculated by MX at stated time
| 17.0782773978147
|-
| 17
| Humidex
| float
| Not NULL, No Default Value
| The Canadian [[Humidex|Humidity Index]], calculated by Cumulus at the stated time
| 19.1775362738161
|-
| 18
| AppTemp
| float
| Not NULL, No Default Value
| The [[Apparent temperature]], calculated by MX at the stated time
| 16.8864476063546
|-
| 19
| IndoorTemp
| float
| Not NULL, No Default Value
| The indoor temperature directly as reported by station at stated time
| 120.89999961853
|-
| 20
| IndoorHumidity
| integer (0 decimal places, contrast with column 10)
| Not NULL, No Default Value
| The indoor relative humidity directly as reported by station at stated time
| 61
|-
| 21
| SolarMax
| integer
| Not NULL, No Default Value
| The calculated maximum value for solar radiation at stated time
| 1026
|-
| 22
| Pm2p5
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 2.5 μm, or less, (?? Rolling 24 hours average ??)
| 1.5
|-
| 23
| Pm10
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 10 μm, or less, (?? Rolling 24 hours average ??)
| 1.7
|-
| 24
| RainRate
| float
| Not NULL, No Default Value
| The [[FAQ#How_is_my_rain_rate_calculated.3F|rainfall rate]] calculated for the stated time
| 303.2
|}

See [[Recent history|'''Recent history''' page]] for more details.

==SqlCache table==

There is a MX setting ('''Settings''' -->> ''MySQL settings'' -->> '''General Options''' -->> Buffer commands on failure) that when enabled allows failed commands to be stored here.

This table holds a list of MySQL commands that are in the queue for '''[[MySqlConnect]]''' to run again.

Commands that fail because the database server is down are added to the queue when the setting is enabled (although MX will not save more than one query referencing same primary key). Because the error returned by the server cannot be predetermined, MX instead checks the error returned is not one of the following reasons before adding it to queue:
* ParseError (the query does not make sense)
* EmptyQuery (query has not been specified)
* TooBigSelect (there is a limit to how much data can be selected)
* InvalidUseOfNull (the schema has to say for each column whether null is permitted)
* MixOfGroupFunctionAndFields (syntax can't mix these)
* SyntaxError (an error in the SQL syntax)
* TooLongString (there is a limit to what can be input)
* WrongColumnName (the column name must exist in the referenced table/view)
* DuplicateUnique (you can't insert a new row with same primary key as an existing row)
* PrimaryCannotHaveNull (the primary key must be set to a specific value)
* DivisionByZero (certain mathematical operations cannot be handled)

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE "SqlCache"(
"key" integer primary key autoincrement not null,
"statement" varchar)

The table contents are simple to explain, each time a new command is stored it is assigned a new number (that is automatically incremented from last number used) and the command itself is stored in a variable text length entry.

==StandardData table==

At time of writing this documentation, the latest MX release does not use this table, and it has zero rows. A [https://cumulus.hosiene.co.uk/viewtopic.php?p=113475#p113475 forum post by Steve Loft] about a database based logging proposal for Cumulus 3 (MX) confirms the original purpose was to improve the ability to [[Correcting Extremes|Correct Extremes Records]] by storing the most frequent and accurate extremes possible.

While that does not specifically explain this table, his choice of [[Standard log files|table name]] suggests he was planning to either replace, or duplicate, the use of text files for logging data. It appears he was actually thinking about implementing [[Monthly_log_files#Enhancement never implemented]] from his inclusion of "Lo" and "Hi" values in the column list.

The only alternative theory is Steve Loft actually thought he could improve on the [[Recent history]] functionality, by storing the highest and lowest readings read from weather station in-between the one minute resolution.

Here is the relevant create table instruction, so this tells you the 17 fields in the table as Steve created it (these have never been changed):

CREATE TABLE "StandardData"(
"Timestamp" datetime primary key not null ,
"Interval" integer ,
"OutTemp" float ,
"LoOutTemp" float ,
"HiOutTemp" float ,
"DewPoint" float ,
"LoDewPoint" float ,
"HiDewPoint" float ,
"WindChill" float ,
"LoWindChill" float ,
"HiWindChill" float ,
"InTemp" float ,
"LoInTemp" float ,
"HiInTemp" float ,
"Pressure" float ,
"LoPressure" float ,
"HiPressure" float )

==sqlite_sequence table==

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE sqlite_sequence (`name` TEXT, `seq` TEXT)

Cumulusmx.db (preserving history)

2022-09-05T04:46:24Z

Sfws: typo

[[Category:Cumulus MX]][[Category:Cumulus Files]]

= Basic information =

Skip this section if you want details specific to a particular database table.

==Location of this database file==

* This database file is specific to Cumulus MX (as the file name suggests), not used by legacy Cumulus 1
* The file is held in Random Access Memory in MX Releases 3.0.0 to 3.11.4 inclusive
* This database file is stored as '''/CumulusMX/data/cumulusmx.db''' (get case of each character correct unless Microsoft Windows Operating System) from release 3.12.0 (beta build 3134)

==Database type==

This file holds a SQLite3 database. Databases of this type are based on sequential file design, i.e. each row in the database table is sequenced by when created (new rows are only appended on end), and given a sequential number to act as primary key (numbers are not automatically revised when a row is deleted).

The MX [[Weather Diary]] also uses a SQLite3 database stored in [[diary.db]].

== Reading/editing database table outside MX ==

There are many software tools available that can read/edit SQLite3, should you wish to examine this database.

You could use any application that can read ODBC files (e.g. Libre Office's Base functionality), these can read the MX databases.

You might find '''sqlitebrowser''' easiest to use in a Linux environment.

You might try '''phpLiteAdmin''' if your device runs a Microsoft Windows Operating System.

= Database Tables included =

The following table lists the tables found in this database, indicating which release added the table, and where further details can be found.

{| border="1" class="wikitable"
|-
! style="width:80px" | Table name
! style="width:120px" | How MX updates
! style="width:80px" | Introduced
! style="width:450px" | Description
! style="width:220px" | Editor within MX
! style="width:120px" | Further details
|-
| RecentData
| Updated once a minute when MX is running
| * MX beta 3.0.0 in RAM
* 3.12.0 (beta build 3134) as external file
| The update.txt for CumulusMX at release 3.12.0 (beta build 3134) states "Change: Cumulus MX now uses a persistent database to store the recent 1 minute data
- This means that charts, recent web tags, and internal calculations for trends and periodic values will be more accurate after a restart
- If Cumulus MX is offline for a prolonged period, data for that offline period will obviously still be at the station logging interval resolution".
| No editor for Cumulus user
| [[Recent history]] and [[#RecentData table]]
|-
| SqlCache
| Updated when certain conditions are met and SQL is queued
| MX 3.21.0
| The update.txt for CumulusMX at release 3.21.0 states "New
- Failed MySQL commands are now can now be individually edited/deleted

Changed
- Failed MySQL commands are now stored in the SQLite database to persist across Cumulus runs"

| Edit or purge the failed MySQL command queue using '''Utils menu''' -->> ''PurgeMySQL''
| [[MySqlConnect]] and [[#SqlCache table]]
|-
| StandardData
| At time of writing, the current MX release does not use this table
| MX beta 3.0.0
| In [https://cumulus.hosiene.co.uk/viewtopic.php?p=123594#p123594 this forum post] Steve Loft describes this table as being for a possible future enhancement. It is believed this is the table that Steve had developed in Cumulus 2, as a replacement for the [[Monthly_log_files]].
| At time of writing, the current MX release does not use this table
| [[#StandardData table]]
|-
| sqlite_sequence
| Developer has not stated when updated
| MX 3.21.0
| Developer has not supplied a description
| Not known
| [[#sqlite_sequence table]]
|}

== RecentData table ==

This table has the following columns:
{| border="1" class="wikitable"
|-
! style="width:10px" | Column number #
! style="width:80px" | Column name
! style="width:80px" | Column type
! style="width:280px" | Properties
! style="width:450px" | Description
! style="width:120px" | Example column value
|-
| 0
| Timestamp
| datetime
| Primary Key, can never be NULL, No Default Value,
| Dates and times for the last 7 days, at whatever interval available (at logging interval for historic archive data, at one minute intervals while MX is running)
| 2021-07-31 19:44:00
|-
| 1
| WindSpeed
| float
| Not NULL, No Default Value
| The average wind speed (see [[Wind_measurement#Weather_Stations_and_Cumulus]] for links) calculated at the stated time, if necessary converted to units requested
| 2.2593056529
|-
| 2
| WindGust
| float
| Not NULL, No Default Value
| The spot gust speed recorded at the stated time, if necessary converted to units requested
| 6.99691241605804
|-
| 3
| WindLatest
| float
| Not NULL, No Default Value
| The spot latest wind speed recorded at the stated time, if necessary converted to units requested
| 3.15989597323001
|-
| 4
| WindDir
| integer
| Not NULL, No Default Value
| The wind bearing (0 =calm), (1 to 360 = number of degrees)
| 315
|-
| 5
| WindAvgDir
| integer
| Not NULL, No Default Value
| The average wind bearing over the defined period
| 270
|-
| 6
| OutsideTemp
| float
| Not NULL, No Default Value
| The measured [[Temperature_(and_humidity)_measurement|outside air temperature]], if necessary converted to units requested
| 17.0
|-
| 7
| WindChill
| float
| Not NULL, No Default Value
| The [[wind chill]], either calculated by MX, or supplied by weather station. (Note: strictly only valid for low temperatures and significant wind speeds)
| (In the example used here, temperature in previous column was too high for wind chill, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 8
| DewPoint
| float
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters|dew point]], either calculated by MX, or supplied by weather station, for the stated time.
| 11.9134549845367
|-
| 9
| HeatIndex
| float
| Not NULL, No Default Value
| The USA [[Heat index]] as calculated by Cumulus for the stated time (if the temperature is high enough)
| (In the example used here, temperature in 'OutsideTemp' column was too low for heat index, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 10
| Humidity
| float (1 decimal place)
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement|Relative Humidity]] reported by the station at the stated time
| 72.0
|-
| 11
| Pressure
| float
| Not NULL, No Default Value
| The sea level pressure at the stated time, either as reported by the station or calculated by Cumulus from the absolute pressure reported by the station, if necessary converted to units requested
| 996.400024414062
|-
| 12
| RainToday
| float
| Not NULL, No Default Value
| The rainfall for today so far, calculated by Cumulus from the rain counter (column 15) now minus the rain counter at start of day, if necessary converted to units requested
| 4.5
|-
| 13
| SolarRad
| integer
| Not NULL, No Default Value
| Solar radiation value reported by station at stated time
| 200
|-
| 14
| UV
| float
| Not NULL, No Default Value
| The Ultra Violet Index reported by station at stated time
| 3.0
|-
| 15
| raincounter
| float
| Not NULL, No Default Value
| The rain counter is used by Cumulus for all rainfall outputs, this is its value at stated time
| 550.4
|-
| 16
| FeelsLike
| float
| Not NULL, No Default Value
| The [[Feels Like]] temperature calculated by MX at stated time
| 17.0782773978147
|-
| 17
| Humidex
| float
| Not NULL, No Default Value
| The Canadian [[Humidex|Humidity Index]], calculated by Cumulus at the stated time
| 19.1775362738161
|-
| 18
| AppTemp
| float
| Not NULL, No Default Value
| The [[Apparent temperature]], calculated by MX at the stated time
| 16.8864476063546
|-
| 19
| IndoorTemp
| float
| Not NULL, No Default Value
| The indoor temperature directly as reported by station at stated time
| 120.89999961853
|-
| 20
| IndoorHumidity
| integer (0 decimal places, contrast with column 10)
| Not NULL, No Default Value
| The indoor relative humidity directly as reported by station at stated time
| 61
|-
| 21
| SolarMax
| integer
| Not NULL, No Default Value
| The calculated maximum value for solar radiation at stated time
| 1026
|-
| 22
| Pm2p5
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 2.5 μm, or less, (?? Rolling 24 hours average ??)
| 1.5
|-
| 23
| Pm10
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 10 μm, or less, (?? Rolling 24 hours average ??)
| 1.7
|-
| 24
| RainRate
| float
| Not NULL, No Default Value
| The [[FAQ#How_is_my_rain_rate_calculated.3F|rainfall rate]] calculated for the stated time
| 303.2
|}

See [[Recent history|'''Recent history''' page]] for more details.

==SqlCache table==

There is a MX setting ('''Settings''' -->> ''MySQL settings'' -->> '''General Options''' -->> Buffer commands on failure) that when enabled allows failed commands to be stored here.

This table holds a list of MySQL commands that are in the queue for '''[[MySqlConnect]]''' to run again.

Commands that fail because the database server is down are added to the queue when the setting is enabled (although MX will not save more than one query referencing same primary key). Because the error returned by the server cannot be predetermined, MX instead checks the error returned is not one of the following reasons before adding it to queue:
* ParseError (the query does not make sense)
* EmptyQuery (query has not been specified)
* TooBigSelect (there is a limit to how much data can be selected)
* InvalidUseOfNull (the schema has to say for each column whether null is permitted)
* MixOfGroupFunctionAndFields (syntax can't mix these)
* SyntaxError (an error in the SQL syntax)
* TooLongString (there is a limit to what can be input)
* WrongColumnName (the column name must exist in the referenced table/view)
* DuplicateUnique (you can't insert a new row with same primary key as an existing row)
* PrimaryCannotHaveNull (the primary key must be set to a specific value)
* DivisionByZero (certain mathematical operations cannot be handled)

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE "SqlCache"(
"key" integer primary key autoincrement not null,
"statement" varchar)

The table contents are simple to explain, each time a new command is stored it is assigned a new number (that is automatically incremented from last number used) and the command itself is stored in a variable text length entry.

==StandardData table==

At time of writing this documentation, the latest MX release does not use this table, and it has zero rows. A [https://cumulus.hosiene.co.uk/viewtopic.php?p=113475#p113475 forum post by Steve Loft] about a database based logging proposal for Cumulus 3 (MX) confirms the original purpose was to improve the ability to [[Correcting Extremes|Correct Extremes Records]] by storing the most frequent and accurate extremes possible.

While that does not specifically explain this table, his choice of [[Standard log files|table name]] suggests he was planning to either replace, or duplicate, the use of text files for logging data. It appears he was actually thinking about implementing [[Monthly_log_files#Enhancement never implemented]] from his inclusion of "Lo" and "Hi" values in the column list.

The only alternative theory is Steve Loft actually thought he could improve on the [[Recent history]] functionality, by storing the highest and lowest readings read from weather station in-between the one minute resolution.

Here is the relevant create table instruction, so this tells you the 17 fields in the table as Steve created it (these have never been changed):

CREATE TABLE "StandardData"(
"Timestamp" datetime primary key not null ,
"Interval" integer ,
"OutTemp" float ,
"LoOutTemp" float ,
"HiOutTemp" float ,
"DewPoint" float ,
"LoDewPoint" float ,
"HiDewPoint" float ,
"WindChill" float ,
"LoWindChill" float ,
"HiWindChill" float ,
"InTemp" float ,
"LoInTemp" float ,
"HiInTemp" float ,
"Pressure" float ,
"LoPressure" float ,
"HiPressure" float )

==sqlite_sequence table==

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE sqlite_sequence (`name` TEXT, `seq` TEXT)

Cumulusmx.db (preserving history)

2022-09-05T04:45:14Z

Sfws: Rewritten for MX release 3.21.0

[[Category:Cumulus MX]][[Category:Cumulus Files]]

= Basic information =

Skip this section if you want details specific to a particular database table.

==Location of this database file==

* This database file is specific to Cumulus MX (as the file name suggests), not used by legacy Cumulus 1
* The file is held in Random Access Memory in MX Releases 3.0.0 to 3.11.4 inclusive
* This database file is stored as '''/CumulusMX/data/cumulusmx.db''' (get case of each character correct unless Microsoft Windows Operating System) from release 3.12.0 (beta build 3134)

==Database type==

This file holds a SQLite3 database. Databases of this type are based on sequential file design, i.e. each row in the database table is sequenced by when created (new rows are only appended on end), and given a sequential number to act as primary key (numbers are not automatically revised when a row is deleted).

The MX [[weather diary]] also uses a SQLite3 database stored in [[diary.db]].

== Reading/editing database table outside MX ==

There are many software tools available that can read/edit SQLite3, should you wish to examine this database.

You could use any application that can read ODBC files (e.g. Libre Office's Base functionality), these can read the MX databases.

You might find '''sqlitebrowser''' easiest to use in a Linux environment.

You might try '''phpLiteAdmin''' if your device runs a Microsoft Windows Operating System.

= Database Tables included =

The following table lists the tables found in this database, indicating which release added the table, and where further details can be found.

{| border="1" class="wikitable"
|-
! style="width:80px" | Table name
! style="width:120px" | How MX updates
! style="width:80px" | Introduced
! style="width:450px" | Description
! style="width:220px" | Editor within MX
! style="width:120px" | Further details
|-
| RecentData
| Updated once a minute when MX is running
| * MX beta 3.0.0 in RAM
* 3.12.0 (beta build 3134) as external file
| The update.txt for CumulusMX at release 3.12.0 (beta build 3134) states "Change: Cumulus MX now uses a persistent database to store the recent 1 minute data
- This means that charts, recent web tags, and internal calculations for trends and periodic values will be more accurate after a restart
- If Cumulus MX is offline for a prolonged period, data for that offline period will obviously still be at the station logging interval resolution".
| No editor for Cumulus user
| [[Recent history]] and [[#RecentData table]]
|-
| SqlCache
| Updated when certain conditions are met and SQL is queued
| MX 3.21.0
| The update.txt for CumulusMX at release 3.21.0 states "New
- Failed MySQL commands are now can now be individually edited/deleted

Changed
- Failed MySQL commands are now stored in the SQLite database to persist across Cumulus runs"

| Edit or purge the failed MySQL command queue using '''Utils menu''' -->> ''PurgeMySQL''
| [[MySqlConnect]] and [[#SqlCache table]]
|-
| StandardData
| At time of writing, the current MX release does not use this table
| MX beta 3.0.0
| In [https://cumulus.hosiene.co.uk/viewtopic.php?p=123594#p123594 this forum post] Steve Loft describes this table as being for a possible future enhancement. It is believed this is the table that Steve had developed in Cumulus 2, as a replacement for the [[Monthly_log_files]].
| At time of writing, the current MX release does not use this table
| [[#StandardData table]]
|-
| sqlite_sequence
| Developer has not stated when updated
| MX 3.21.0
| Developer has not supplied a description
| Not known
| [[#sqlite_sequence table]]
|}

== RecentData table ==

This table has the following columns:
{| border="1" class="wikitable"
|-
! style="width:10px" | Column number #
! style="width:80px" | Column name
! style="width:80px" | Column type
! style="width:280px" | Properties
! style="width:450px" | Description
! style="width:120px" | Example column value
|-
| 0
| Timestamp
| datetime
| Primary Key, can never be NULL, No Default Value,
| Dates and times for the last 7 days, at whatever interval available (at logging interval for historic archive data, at one minute intervals while MX is running)
| 2021-07-31 19:44:00
|-
| 1
| WindSpeed
| float
| Not NULL, No Default Value
| The average wind speed (see [[Wind_measurement#Weather_Stations_and_Cumulus]] for links) calculated at the stated time, if necessary converted to units requested
| 2.2593056529
|-
| 2
| WindGust
| float
| Not NULL, No Default Value
| The spot gust speed recorded at the stated time, if necessary converted to units requested
| 6.99691241605804
|-
| 3
| WindLatest
| float
| Not NULL, No Default Value
| The spot latest wind speed recorded at the stated time, if necessary converted to units requested
| 3.15989597323001
|-
| 4
| WindDir
| integer
| Not NULL, No Default Value
| The wind bearing (0 =calm), (1 to 360 = number of degrees)
| 315
|-
| 5
| WindAvgDir
| integer
| Not NULL, No Default Value
| The average wind bearing over the defined period
| 270
|-
| 6
| OutsideTemp
| float
| Not NULL, No Default Value
| The measured [[Temperature_(and_humidity)_measurement|outside air temperature]], if necessary converted to units requested
| 17.0
|-
| 7
| WindChill
| float
| Not NULL, No Default Value
| The [[wind chill]], either calculated by MX, or supplied by weather station. (Note: strictly only valid for low temperatures and significant wind speeds)
| (In the example used here, temperature in previous column was too high for wind chill, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 8
| DewPoint
| float
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters|dew point]], either calculated by MX, or supplied by weather station, for the stated time.
| 11.9134549845367
|-
| 9
| HeatIndex
| float
| Not NULL, No Default Value
| The USA [[Heat index]] as calculated by Cumulus for the stated time (if the temperature is high enough)
| (In the example used here, temperature in 'OutsideTemp' column was too low for heat index, so the value was set to agree with 'OutsideTemp' column instead)
|-
| 10
| Humidity
| float (1 decimal place)
| Not NULL, No Default Value
| The [[Temperature_(and_humidity)_measurement|Relative Humidity]] reported by the station at the stated time
| 72.0
|-
| 11
| Pressure
| float
| Not NULL, No Default Value
| The sea level pressure at the stated time, either as reported by the station or calculated by Cumulus from the absolute pressure reported by the station, if necessary converted to units requested
| 996.400024414062
|-
| 12
| RainToday
| float
| Not NULL, No Default Value
| The rainfall for today so far, calculated by Cumulus from the rain counter (column 15) now minus the rain counter at start of day, if necessary converted to units requested
| 4.5
|-
| 13
| SolarRad
| integer
| Not NULL, No Default Value
| Solar radiation value reported by station at stated time
| 200
|-
| 14
| UV
| float
| Not NULL, No Default Value
| The Ultra Violet Index reported by station at stated time
| 3.0
|-
| 15
| raincounter
| float
| Not NULL, No Default Value
| The rain counter is used by Cumulus for all rainfall outputs, this is its value at stated time
| 550.4
|-
| 16
| FeelsLike
| float
| Not NULL, No Default Value
| The [[Feels Like]] temperature calculated by MX at stated time
| 17.0782773978147
|-
| 17
| Humidex
| float
| Not NULL, No Default Value
| The Canadian [[Humidex|Humidity Index]], calculated by Cumulus at the stated time
| 19.1775362738161
|-
| 18
| AppTemp
| float
| Not NULL, No Default Value
| The [[Apparent temperature]], calculated by MX at the stated time
| 16.8864476063546
|-
| 19
| IndoorTemp
| float
| Not NULL, No Default Value
| The indoor temperature directly as reported by station at stated time
| 120.89999961853
|-
| 20
| IndoorHumidity
| integer (0 decimal places, contrast with column 10)
| Not NULL, No Default Value
| The indoor relative humidity directly as reported by station at stated time
| 61
|-
| 21
| SolarMax
| integer
| Not NULL, No Default Value
| The calculated maximum value for solar radiation at stated time
| 1026
|-
| 22
| Pm2p5
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 2.5 μm, or less, (?? Rolling 24 hours average ??)
| 1.5
|-
| 23
| Pm10
| float
| Not NULL, No Default Value
| Air Quality expressed in terms of particulate matter of 10 μm, or less, (?? Rolling 24 hours average ??)
| 1.7
|-
| 24
| RainRate
| float
| Not NULL, No Default Value
| The [[FAQ#How_is_my_rain_rate_calculated.3F|rainfall rate]] calculated for the stated time
| 303.2
|}

See [[Recent history|'''Recent history''' page]] for more details.

==SqlCache table==

There is a MX setting ('''Settings''' -->> ''MySQL settings'' -->> '''General Options''' -->> Buffer commands on failure) that when enabled allows failed commands to be stored here.

This table holds a list of MySQL commands that are in the queue for '''[[MySqlConnect]]''' to run again.

Commands that fail because the database server is down are added to the queue when the setting is enabled (although MX will not save more than one query referencing same primary key). Because the error returned by the server cannot be predetermined, MX instead checks the error returned is not one of the following reasons before adding it to queue:
* ParseError (the query does not make sense)
* EmptyQuery (query has not been specified)
* TooBigSelect (there is a limit to how much data can be selected)
* InvalidUseOfNull (the schema has to say for each column whether null is permitted)
* MixOfGroupFunctionAndFields (syntax can't mix these)
* SyntaxError (an error in the SQL syntax)
* TooLongString (there is a limit to what can be input)
* WrongColumnName (the column name must exist in the referenced table/view)
* DuplicateUnique (you can't insert a new row with same primary key as an existing row)
* PrimaryCannotHaveNull (the primary key must be set to a specific value)
* DivisionByZero (certain mathematical operations cannot be handled)

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE "SqlCache"(
"key" integer primary key autoincrement not null,
"statement" varchar)

The table contents are simple to explain, each time a new command is stored it is assigned a new number (that is automatically incremented from last number used) and the command itself is stored in a variable text length entry.

==StandardData table==

At time of writing this documentation, the latest MX release does not use this table, and it has zero rows. A [https://cumulus.hosiene.co.uk/viewtopic.php?p=113475#p113475 forum post by Steve Loft] about a database based logging proposal for Cumulus 3 (MX) confirms the original purpose was to improve the ability to [[Correcting Extremes|Correct Extremes Records]] by storing the most frequent and accurate extremes possible.

While that does not specifically explain this table, his choice of [[Standard log files|table name]] suggests he was planning to either replace, or duplicate, the use of text files for logging data. It appears he was actually thinking about implementing [[Monthly_log_files#Enhancement never implemented]] from his inclusion of "Lo" and "Hi" values in the column list.

The only alternative theory is Steve Loft actually thought he could improve on the [[Recent history]] functionality, by storing the highest and lowest readings read from weather station in-between the one minute resolution.

Here is the relevant create table instruction, so this tells you the 17 fields in the table as Steve created it (these have never been changed):

CREATE TABLE "StandardData"(
"Timestamp" datetime primary key not null ,
"Interval" integer ,
"OutTemp" float ,
"LoOutTemp" float ,
"HiOutTemp" float ,
"DewPoint" float ,
"LoDewPoint" float ,
"HiDewPoint" float ,
"WindChill" float ,
"LoWindChill" float ,
"HiWindChill" float ,
"InTemp" float ,
"LoInTemp" float ,
"HiInTemp" float ,
"Pressure" float ,
"LoPressure" float ,
"HiPressure" float )

==sqlite_sequence table==

Here is the relevant create table instruction, so this tells you the 2 fields in the table as Mark Crossley created it:

CREATE TABLE sqlite_sequence (`name` TEXT, `seq` TEXT)

MySqlConnect

2022-08-22T13:18:03Z

Sfws: /* Populating missing/incorrect columns in existing rows */ added cross-ref to forum

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulus 3 software (MX beta 3.0.0).

Essentially, MX can ''either'' create and update one, or more, of three tables (by default called "realtime", "monthly", and "dayfile"; although these names can be changed by the Cumulus user) where it determines the '''schema''' (what columns appear in the database table); ''or'' MX can run SQL (devised by user) against tables (created by user) that can have any "schema" (columns in the table) chosen by user at one, or more, of three intervals (MX calls these "custom seconds", "custom minutes", and "custom rollover").

This Wiki page provides a brief introduction to SQL, and describes the settings that define how this functionality is controlled.

At last update, this Wiki page shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

==What is SQL?==

SQL is an abbreviation of "Structured Query Language", SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey.

==How does MX use SQL?==

MX uses two types of SQL.

MX uses SQL when updating a SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type of database stores data in what is known technically as a sequential file. In a sequential file, the data appears as a number of lines that have to be stored in order (by row number). Because entries can be deleted, not every possible row number has to be present, but new entries are appended at end. The various fields (or columns) are named, it is possible (but rarely done) to change the order of the columns, rewriting the entire database file. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifying content, but that gets translated into a row number to actually determine the row that is updated.

MX also uses SQL when creating, or updating, a relational database type. The commands issued by "MySqlConnect" software work with two types of relational databases, MySQL (commercial software by Oracle) and MariaDB (free software from an independent provider). A relational database also uses the row, column, and field terminology; but there is no control over the order in which rows are stored, there is an order for columns (although you can change the column order), and rows are identified by a unique key (known as "primary key" as a row can contain a secondary key that links to data in another table). Any retrieval query can specify that what is returned from that query should be sorted in an ascending/descending order of the value(s) in specified column(s).

As mentioned earlier, MX supports (default) tables where it determines the columns in the table , and (custom) tables where the user determines the columns. For the default tables, every MySqlConnect command issued by MX specifies column names, so those columns must be present in the table, but can be in any order. (If the user adds extra columns, those extra columns must be defined with null as default value, so MX can ignore them). Some MX releases add columns that were not present in earlier MX releases, and these releases should provide a utility that will add the extra columns to existing tables.

===How does MX use MySqlConnect?===

MySqlConnect is used by both [[Software#Current_Release|CumulusMX.exe]] and [[Software#Export_To_MySQL|ExportToMySQL.exe]], but the latter only works with two of the default tables (those called "monthly" and "dayfile", or as renamed by the user).

Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:

{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu → MySQL settings → General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu → MySQL settings → Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu → MySQL settings → Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu → MySQL settings → Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu → MySQL settings → Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}

=The My SQL settings page in interface=

MX controls settings for the relational database tables on a page called "MySQL settings" although you may be using "MariaDB". Here is a screenshot of that page (with all sections closed up) as applicable from release 3.20.0 (build 3202):

[[File:MySQL settings.png]]

Please note, the text included elsewhere on this Wiki page may be for different release.

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

== Predetermined SQL ==

The custom table options in MX require you to specify the SQL in advance of it being used, and are therefore intended for use to predetermine all the SQL you might use (conditionals can be included to decide what queries actually get executed if there are alternatives). You can enable/disable individual settings, but the mechanism is not designed to do any one-off actions like creating the custom tables.

WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MariaDB syntax.

Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....);

BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>

== Why are Cumulus settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

MX has been developed very dramatically by Mark Crossley:
# The MySQL settings for the original 3.0.0 beta were 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)|that latter documentation remains available 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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>
# Since the MySQL settings have continued to change, since 2021 they have been moved here from that last mentioned page.

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

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

The settings described here are stored in a file called "Cumulus.ini".

The file is divided into "File sections", 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.

==Content of "Cumulus.ini" relating to MySQL==

* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu → MySQL settings
* The table below relates to a beta for 3.12.0 (see top of this page), there will have been changes in later MX releases that are not documented

{| 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
|-
| BufferOnFailure=0
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlMinutesEnabled=0
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlRolloverEnabled=0
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous, and next, options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| Custom Upload - seconds interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlSecondsEnabled=0
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal rollover updates and "ExportToMySQl.exe" will use the table name you define. Depending which MX release you use, the option to update table when you edit "dayfile.txt" may fail!
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but at some releases the option to update table when you edit "MMMyyyyLog.txt" may fail
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* 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
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see beginning of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}

=The MX default database tables=

Further work is needed here, but this is a quick attempt to include some notes that might help you, written because of the extensive changes in release 3.20.0

==Creation of default tables==

The settings page as described above includes the ability to issue the SQL command to your server to create whichever default table you wish.

You must define how to access your database server, enable the particular table and indicate what the table is to be called first. Then you must click '''Save settings''' so all those details are registered before the create command will work.

If a table with that name already exists, or certain other standard errors happen, MX can give you feedback. MX will also tell you when the SQL has worked, and thetable has been created.

==Modifying schema (columns in table)==

Some release announcements for MX mention that extra columns have been added to a particular table. A script may be provided (either in release announcement, or in the '''MXutils''' directory within the download, that you can run to add the extra columns. For example '''b3089-AlterMySqlTables.sql''' was provided in the '''MXutils''' directory with build 3089 to add the ''Feels Like temperature'' columns

In release 3.20.0, '''v3.20.0-AlterMySqlTables.sql''' was provided to edit the "dayfile" table and add 3 new columns (cumulative chill hours, highest 24 hour rainfall, and time when highest 24 hour rainfall ended).

Release 3.20.0 as seen on screenshot above provides buttons (under heading of '''Update database table''') for each of the default tables. The code here is rather crude, it counts the number of columns currently defined in the table (does not check what names those columns have, nor what properties those columns have) and compares against number of columns that MX can automatically insert/update at that release in that table. It assumes columns appear in same order as the fields in related file, and modifies the table to add the extra columns in the correct position to match the respective file.

==Populating rows that do not exist==

Use the utility described at [[Software#Export_To_MySQL]] for '''monthly''' or '''dayfile''' tables.

The only way to populate '''realtime''' is via the action described in settings page description above.

==Populating missing/incorrect columns in existing rows==

The options provided in the ''Data logs'' menu of the interface can be used to edit a single line of a file, and there is a setting that lets that edit also update the corresponding single row of a default table.

Whilst it may not take long to send SQL for a single line update to your database server, it will take a lot of time to select each line in file in turn, and to send the SQL to insert every line to your database server.

To update one or more columns in multiple rows, you need to generate a succession of UPDATE queries, keeping the text to send to the database server as short as possible.

One way to do this is to open the relevant file using a spreadsheet (e.g. Libre Office has a "calc" option, this is free and available for most operating systems). Create an extra column after existing columns in the spreadsheet for the "primary key", you should be able to generate this from the first one or two columns of the spreadsheet with some manipulation. Now "Hide" all the columns except those with data that you want to include in the update, and the primary key column. With some spreadsheet skills (see https://cumulus.hosiene.co.uk/viewtopic.php?p=165767#p165767) you can generate the required SQL in this format:
<pre>
UPDATE name-of-table SET first-column-name=first-row-and-first-column-value, second-column-name=first-row-and-second-column-value WHERE primary-key-column-name=first-row-primary-key-value;
UPDATE name-of-table SET first-column-name=second-row-and-first-column-value, second-column-name=second-row-and-second-column-value WHERE primary-key-column-name=second-row-primary-key-value;
</pre>

Alternatively, if you have skills in a script language like PHP Hypertext Preprocessor (PHP) you can write a small script that reads the file within a loop, picks the fields required from the line of the file, and generates the SQL (as above), and after ending loop closes file and sends the SQL to the database server.

MySqlConnect

2022-08-22T11:39:26Z

Sfws: /* Populating missing/incorrect columns in existing rows */ typo

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulus 3 software (MX beta 3.0.0).

Essentially, MX can ''either'' create and update one, or more, of three tables (by default called "realtime", "monthly", and "dayfile"; although these names can be changed by the Cumulus user) where it determines the '''schema''' (what columns appear in the database table); ''or'' MX can run SQL (devised by user) against tables (created by user) that can have any "schema" (columns in the table) chosen by user at one, or more, of three intervals (MX calls these "custom seconds", "custom minutes", and "custom rollover").

This Wiki page provides a brief introduction to SQL, and describes the settings that define how this functionality is controlled.

At last update, this Wiki page shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

==What is SQL?==

SQL is an abbreviation of "Structured Query Language", SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey.

==How does MX use SQL?==

MX uses two types of SQL.

MX uses SQL when updating a SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type of database stores data in what is known technically as a sequential file. In a sequential file, the data appears as a number of lines that have to be stored in order (by row number). Because entries can be deleted, not every possible row number has to be present, but new entries are appended at end. The various fields (or columns) are named, it is possible (but rarely done) to change the order of the columns, rewriting the entire database file. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifying content, but that gets translated into a row number to actually determine the row that is updated.

MX also uses SQL when creating, or updating, a relational database type. The commands issued by "MySqlConnect" software work with two types of relational databases, MySQL (commercial software by Oracle) and MariaDB (free software from an independent provider). A relational database also uses the row, column, and field terminology; but there is no control over the order in which rows are stored, there is an order for columns (although you can change the column order), and rows are identified by a unique key (known as "primary key" as a row can contain a secondary key that links to data in another table). Any retrieval query can specify that what is returned from that query should be sorted in an ascending/descending order of the value(s) in specified column(s).

As mentioned earlier, MX supports (default) tables where it determines the columns in the table , and (custom) tables where the user determines the columns. For the default tables, every MySqlConnect command issued by MX specifies column names, so those columns must be present in the table, but can be in any order. (If the user adds extra columns, those extra columns must be defined with null as default value, so MX can ignore them). Some MX releases add columns that were not present in earlier MX releases, and these releases should provide a utility that will add the extra columns to existing tables.

===How does MX use MySqlConnect?===

MySqlConnect is used by both [[Software#Current_Release|CumulusMX.exe]] and [[Software#Export_To_MySQL|ExportToMySQL.exe]], but the latter only works with two of the default tables (those called "monthly" and "dayfile", or as renamed by the user).

Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:

{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu → MySQL settings → General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu → MySQL settings → Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu → MySQL settings → Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu → MySQL settings → Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu → MySQL settings → Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}

=The My SQL settings page in interface=

MX controls settings for the relational database tables on a page called "MySQL settings" although you may be using "MariaDB". Here is a screenshot of that page (with all sections closed up) as applicable from release 3.20.0 (build 3202):

[[File:MySQL settings.png]]

Please note, the text included elsewhere on this Wiki page may be for different release.

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

== Predetermined SQL ==

The custom table options in MX require you to specify the SQL in advance of it being used, and are therefore intended for use to predetermine all the SQL you might use (conditionals can be included to decide what queries actually get executed if there are alternatives). You can enable/disable individual settings, but the mechanism is not designed to do any one-off actions like creating the custom tables.

WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MariaDB syntax.

Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....);

BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>

== Why are Cumulus settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

MX has been developed very dramatically by Mark Crossley:
# The MySQL settings for the original 3.0.0 beta were 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)|that latter documentation remains available 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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>
# Since the MySQL settings have continued to change, since 2021 they have been moved here from that last mentioned page.

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

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

The settings described here are stored in a file called "Cumulus.ini".

The file is divided into "File sections", 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.

==Content of "Cumulus.ini" relating to MySQL==

* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu → MySQL settings
* The table below relates to a beta for 3.12.0 (see top of this page), there will have been changes in later MX releases that are not documented

{| 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
|-
| BufferOnFailure=0
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlMinutesEnabled=0
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlRolloverEnabled=0
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous, and next, options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| Custom Upload - seconds interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlSecondsEnabled=0
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal rollover updates and "ExportToMySQl.exe" will use the table name you define. Depending which MX release you use, the option to update table when you edit "dayfile.txt" may fail!
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but at some releases the option to update table when you edit "MMMyyyyLog.txt" may fail
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* 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
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see beginning of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}

=The MX default database tables=

Further work is needed here, but this is a quick attempt to include some notes that might help you, written because of the extensive changes in release 3.20.0

==Creation of default tables==

The settings page as described above includes the ability to issue the SQL command to your server to create whichever default table you wish.

You must define how to access your database server, enable the particular table and indicate what the table is to be called first. Then you must click '''Save settings''' so all those details are registered before the create command will work.

If a table with that name already exists, or certain other standard errors happen, MX can give you feedback. MX will also tell you when the SQL has worked, and thetable has been created.

==Modifying schema (columns in table)==

Some release announcements for MX mention that extra columns have been added to a particular table. A script may be provided (either in release announcement, or in the '''MXutils''' directory within the download, that you can run to add the extra columns. For example '''b3089-AlterMySqlTables.sql''' was provided in the '''MXutils''' directory with build 3089 to add the ''Feels Like temperature'' columns

In release 3.20.0, '''v3.20.0-AlterMySqlTables.sql''' was provided to edit the "dayfile" table and add 3 new columns (cumulative chill hours, highest 24 hour rainfall, and time when highest 24 hour rainfall ended).

Release 3.20.0 as seen on screenshot above provides buttons (under heading of '''Update database table''') for each of the default tables. The code here is rather crude, it counts the number of columns currently defined in the table (does not check what names those columns have, nor what properties those columns have) and compares against number of columns that MX can automatically insert/update at that release in that table. It assumes columns appear in same order as the fields in related file, and modifies the table to add the extra columns in the correct position to match the respective file.

==Populating rows that do not exist==

Use the utility described at [[Software#Export_To_MySQL]] for '''monthly''' or '''dayfile''' tables.

The only way to populate '''realtime''' is via the action described in settings page description above.

==Populating missing/incorrect columns in existing rows==

The options provided in the ''Data logs'' menu of the interface can be used to edit a single line of a file, and there is a setting that lets that edit also update the corresponding single row of a default table.

Whilst it may not take long to send SQL for a single line update to your database server, it will take a lot of time to select each line in file in turn, and to send the SQL to insert every line to your database server.

To update one or more columns in multiple rows, you need to generate a succession of UPDATE queries, keeping the text to send to the database server as short as possible.

One way to do this is to open the relevant file using a spreadsheet (e.g. Libre Office has a "calc" option, this is free and available for most operating systems). Create an extra column after existing columns in the spreadsheet for the "primary key", you should be able to generate this from the first one or two columns of the spreadsheet with some manipulation. Now "Hide" all the columns except those with data that you want to include in the update, and the primary key column. With some spreadsheet skills you can generate the required SQL in this format:
<pre>
UPDATE name-of-table SET first-column-name=first-row-and-first-column-value, second-column-name=first-row-and-second-column-value WHERE primary-key-column-name=first-row-primary-key-value;
UPDATE name-of-table SET first-column-name=second-row-and-first-column-value, second-column-name=second-row-and-second-column-value WHERE primary-key-column-name=second-row-primary-key-value;
</pre>

Alternatively, if you have skills in a script language like PHP Hypertext Preprocessor (PHP) you can write a small script that reads the file within a loop, picks the fields required from the line of the file, and generates the SQL (as above), and after ending loop closes file and sends the SQL to the database server.

MySqlConnect

2022-08-22T11:38:57Z

Sfws: new section at end

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulus 3 software (MX beta 3.0.0).

Essentially, MX can ''either'' create and update one, or more, of three tables (by default called "realtime", "monthly", and "dayfile"; although these names can be changed by the Cumulus user) where it determines the '''schema''' (what columns appear in the database table); ''or'' MX can run SQL (devised by user) against tables (created by user) that can have any "schema" (columns in the table) chosen by user at one, or more, of three intervals (MX calls these "custom seconds", "custom minutes", and "custom rollover").

This Wiki page provides a brief introduction to SQL, and describes the settings that define how this functionality is controlled.

At last update, this Wiki page shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

==What is SQL?==

SQL is an abbreviation of "Structured Query Language", SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey.

==How does MX use SQL?==

MX uses two types of SQL.

MX uses SQL when updating a SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type of database stores data in what is known technically as a sequential file. In a sequential file, the data appears as a number of lines that have to be stored in order (by row number). Because entries can be deleted, not every possible row number has to be present, but new entries are appended at end. The various fields (or columns) are named, it is possible (but rarely done) to change the order of the columns, rewriting the entire database file. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifying content, but that gets translated into a row number to actually determine the row that is updated.

MX also uses SQL when creating, or updating, a relational database type. The commands issued by "MySqlConnect" software work with two types of relational databases, MySQL (commercial software by Oracle) and MariaDB (free software from an independent provider). A relational database also uses the row, column, and field terminology; but there is no control over the order in which rows are stored, there is an order for columns (although you can change the column order), and rows are identified by a unique key (known as "primary key" as a row can contain a secondary key that links to data in another table). Any retrieval query can specify that what is returned from that query should be sorted in an ascending/descending order of the value(s) in specified column(s).

As mentioned earlier, MX supports (default) tables where it determines the columns in the table , and (custom) tables where the user determines the columns. For the default tables, every MySqlConnect command issued by MX specifies column names, so those columns must be present in the table, but can be in any order. (If the user adds extra columns, those extra columns must be defined with null as default value, so MX can ignore them). Some MX releases add columns that were not present in earlier MX releases, and these releases should provide a utility that will add the extra columns to existing tables.

===How does MX use MySqlConnect?===

MySqlConnect is used by both [[Software#Current_Release|CumulusMX.exe]] and [[Software#Export_To_MySQL|ExportToMySQL.exe]], but the latter only works with two of the default tables (those called "monthly" and "dayfile", or as renamed by the user).

Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:

{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu → MySQL settings → General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu → MySQL settings → Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu → MySQL settings → Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu → MySQL settings → Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu → MySQL settings → Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}

=The My SQL settings page in interface=

MX controls settings for the relational database tables on a page called "MySQL settings" although you may be using "MariaDB". Here is a screenshot of that page (with all sections closed up) as applicable from release 3.20.0 (build 3202):

[[File:MySQL settings.png]]

Please note, the text included elsewhere on this Wiki page may be for different release.

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

== Predetermined SQL ==

The custom table options in MX require you to specify the SQL in advance of it being used, and are therefore intended for use to predetermine all the SQL you might use (conditionals can be included to decide what queries actually get executed if there are alternatives). You can enable/disable individual settings, but the mechanism is not designed to do any one-off actions like creating the custom tables.

WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MariaDB syntax.

Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....);

BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>

== Why are Cumulus settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

MX has been developed very dramatically by Mark Crossley:
# The MySQL settings for the original 3.0.0 beta were 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)|that latter documentation remains available 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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>
# Since the MySQL settings have continued to change, since 2021 they have been moved here from that last mentioned page.

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

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

The settings described here are stored in a file called "Cumulus.ini".

The file is divided into "File sections", 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.

==Content of "Cumulus.ini" relating to MySQL==

* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu → MySQL settings
* The table below relates to a beta for 3.12.0 (see top of this page), there will have been changes in later MX releases that are not documented

{| 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
|-
| BufferOnFailure=0
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlMinutesEnabled=0
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlRolloverEnabled=0
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous, and next, options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| Custom Upload - seconds interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlSecondsEnabled=0
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal rollover updates and "ExportToMySQl.exe" will use the table name you define. Depending which MX release you use, the option to update table when you edit "dayfile.txt" may fail!
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but at some releases the option to update table when you edit "MMMyyyyLog.txt" may fail
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* 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
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see beginning of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}

=The MX default database tables=

Further work is needed here, but this is a quick attempt to include some notes that might help you, written because of the extensive changes in release 3.20.0

==Creation of default tables==

The settings page as described above includes the ability to issue the SQL command to your server to create whichever default table you wish.

You must define how to access your database server, enable the particular table and indicate what the table is to be called first. Then you must click '''Save settings''' so all those details are registered before the create command will work.

If a table with that name already exists, or certain other standard errors happen, MX can give you feedback. MX will also tell you when the SQL has worked, and thetable has been created.

==Modifying schema (columns in table)==

Some release announcements for MX mention that extra columns have been added to a particular table. A script may be provided (either in release announcement, or in the '''MXutils''' directory within the download, that you can run to add the extra columns. For example '''b3089-AlterMySqlTables.sql''' was provided in the '''MXutils''' directory with build 3089 to add the ''Feels Like temperature'' columns

In release 3.20.0, '''v3.20.0-AlterMySqlTables.sql''' was provided to edit the "dayfile" table and add 3 new columns (cumulative chill hours, highest 24 hour rainfall, and time when highest 24 hour rainfall ended).

Release 3.20.0 as seen on screenshot above provides buttons (under heading of '''Update database table''') for each of the default tables. The code here is rather crude, it counts the number of columns currently defined in the table (does not check what names those columns have, nor what properties those columns have) and compares against number of columns that MX can automatically insert/update at that release in that table. It assumes columns appear in same order as the fields in related file, and modifies the table to add the extra columns in the correct position to match the respective file.

==Populating rows that do not exist==

Use the utility described at [[Software#Export_To_MySQL]] for '''monthly''' or '''dayfile''' tables.

The only way to populate '''realtime''' is via the action described in settings page description above.

===Populating missing/incorrect columns in existing rows===

The options provided in the ''Data logs'' menu of the interface can be used to edit a single line of a file, and there is a setting that lets that edit also update the corresponding single row of a default table.

Whilst it may not take long to send SQL for a single line update to your database server, it will take a lot of time to select each line in file in turn, and to send the SQL to insert every line to your database server.

To update one or more columns in multiple rows, you need to generate a succession of UPDATE queries, keeping the text to send to the database server as short as possible.

One way to do this is to open the relevant file using a spreadsheet (e.g. Libre Office has a "calc" option, this is free and available for most operating systems). Create an extra column after existing columns in the spreadsheet for the "primary key", you should be able to generate this from the first one or two columns of the spreadsheet with some manipulation. Now "Hide" all the columns except those with data that you want to include in the update, and the primary key column. With some spreadsheet skills you can generate the required SQL in this format:
<pre>
UPDATE name-of-table SET first-column-name=first-row-and-first-column-value, second-column-name=first-row-and-second-column-value WHERE primary-key-column-name=first-row-primary-key-value;
UPDATE name-of-table SET first-column-name=second-row-and-first-column-value, second-column-name=second-row-and-second-column-value WHERE primary-key-column-name=second-row-primary-key-value;
</pre>

Alternatively, if you have skills in a script language like PHP Hypertext Preprocessor (PHP) you can write a small script that reads the file within a loop, picks the fields required from the line of the file, and generates the SQL (as above), and after ending loop closes file and sends the SQL to the database server.

Calculate Missing Values

2022-08-22T09:01:00Z

Sfws: /* CreateMissing.exe */ Rewritten for 3.20.0 release

{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}{{Version badge 1}}This page applies to both the legacy Cumulus 1 and to MX. It is intended that this page will cover all the different ways in which you add back any missing data. This means it should cover:
* Data that you want to add from another system for a period when you were not running Cumulus
* How Cumulus captures archive data if it is available for a period when Cumulus was stopped
* Derivatives that have been added since particular log files lines were stored
* Solving problems when a line was not successfully written to the daily summary log file

[[Category:Cumulus MX]][[Category:Cumulus Files]][[Category:Files_with_Comma_Separated_Values]][[Category:Cumulus 1]]

=How Cumulus Works=

{{TOCright}}

The way that Cumulus works is that:
# It reads what we can call '''source values''' (defined below) from your weather station (based on measurements from sensors being transmitted in some way by the station)
# It calculates what we can call '''derived values''' which may be either the source re-expressed in different units, or calculated by combining two or three source values to get a new derivative
# It tracks various extremes, and cumulative totals, by comparing the derived values against existing extremes and sums stored in various [[:Category:Ini_Files|period tracking files]]
#* You can find out about how a rogue source value can affect extreme records derived from it, and how to correct such issues on the [[Correcting_Extremes]] page.
# It periodically stores the spot (current) derived values in a collection of [[Monthly_log_files]], (and so when you move to a different device, or upgrade to a new release, then providing you copy these files to the new location you will not lose any data)
#* for MX these files include [[Standard log files]], [[Extra Sensor Files]], and [[Air_Link_Log.txt]], at time of writing
#* for Cumulus 1 these files are [[Speciallog.txt]], [[Standard log files]], and [[Extra Sensor Files]], for all version 1.9.3 and 1.9.4 releases
# At the end of each day, Cumulus logs the daily extremes or daily sums, from monitoring changes in each derived value into [[Dayfile.txt#List_of_fields_in_dayfile.txt|daily summary log]]

==Reading archive data==

If you are using a weather station type that has a internal memory storing weather data that Cumulus can read, then when Cumulus is restarted it can read historic data from that logging memory.

This means that if you discover that Cumulus has missed some data, soon after it misses that data, you can '''rewind''', by stopping Cumulus, optionally replacing files in [[Data folder| '''data''' folder]] with earlier copies of those files from [[Backup folder| '''backup''' folder or ''backup/daily'' folder]], and restarting Cumulus. Typical reasons for missing some data would include power blips and problems with the interface between Cumulus and the weather station.

* For Cumulus 1, to stop Cumulus, you select [[Cumulus Screenshots|Exit]] from the main menu.
* For MX, how you stop MX depends on your device, and whether running as a service, please see [[MX on Linux]] or [[MX on Windows OS]] pages as appropriate for advice.
Put simply, Cumulus stores the latest time it successfully read data from the weather station in [[Today.ini|today.ini]]. When Cumulus is restarted, if it is possible to read the historic data from the weather station, then any entries between the time stored and the current time will be read.

With Cumulus 1, there is some dependence on weather station type, but usually two passes are made through the external logging memory, the first pass investigates what records are available in the weather station, by reading backwards in time, and the second pass works forward in past time reading and processing those records.

With MX, again there will be some dependence on weather station type, and the process has not been documented by the developer; it appears just a single pass is made.

=Importing data from other systems for periods when Cumulus was not running=

<big>This section needs more work on it</big>

Essentially, what we need to do, is to compare the format of the data we have available against the format of the relevant Cumulus file.

==CSV outputs from software like EasyWeather==

You might want to read [[EasyWeather_Format#Transferring_past_observations_from_EasyWeather.dat_to_Cumulus|Transferring_past_observations_from_EasyWeather.dat_to_Cumulus]], although that is now an obsolete article, Easy Weather has changed, and Cumulus MX is different from the original Cumulus described there.

The CSV output from such files has fields in the wrong order, may not match our Cumulus units, and does not have a match for each of the fields we need in our Cumulus - see [[Standard_log_files#Importing_pre-Cumulus_data|importing into standard log file fields]]. The solution is to use a CSV file editor, or a spreadsheet, to move the fields into a better order, to apply a formula where necessary to change units, and create any missing fields.

Cumulus does not allow for "null", field not available, except in that it can allow shorter lines with just the fields applying to an earlier release. For MX, [[#CreateMissing.exe|CreateMissing.exe]] can calculate some of the derivatives missing from earlier releases for the [[Standard_log_files]], and that utility can generate the necessary [[Dayfile.txt|dayfile.txt]] lines.

On the Support Forum - Dane - offered a translation service - see [https://cumulus.hosiene.co.uk/viewtopic.php?f=13&t=250 here], but the last post is May 2018, so I am unsure whether it is still available as I type this in July 2021.

==Weather Display==

Please see [[Software#Weather_Display_Converter|Software page - Weather_Display_Converter]]. When you run this routine, it brings up a screen where you select the units that you want the Cumulus [[Standard_log_files]] it produces to use, as the units that weather display uses for the export are fixed.

The routine was written for Cumulus 1, so will not produce all the fields that MX uses, but [[#CreateMissing.exe|CreateMissing.exe]] can calculate some of the derivatives missing from earlier releases, as well as producing [[Dayfile.txt|dayfile.txt]].

==Weather Link log file==

There is a routine, see [[Software#WeatherLink_Converter|Software page - WeatherLink_Converter]] for this. When you run this routine, it brings up a screen where you select the units. Please note, this utility assumes the units you select on that screen apply both to the file (OR MULTIPLE FILES) being converted and to the (multiple) Cumulus [[Standard_log_files]] it produces.

It was written for Cumulus 1, so will not produce all the fields that MX uses, but [[#CreateMissing.exe|CreateMissing.exe]] can calculate some of the derivatives missing from earlier releases, as well as producing [[Dayfile.txt|dayfile.txt]].

==Weather Link Live==

PLEASE CAN SOMEBODY FULLY DOCUMENT THIS.

My understanding is that while MX can read current data from the WLL, you need a "pro subscription" to export past data. I don't know the format of that past data export, but can only guess it can be easily imported into Cumulus.

==OTHERS????==

PLEASE CAN SOMEBODY CONTRIBUTE WAYS OF IMPORTING FROM OTHER SOFTWARE HERE.

Meanwhile, people should ask for help in the support forum.

=Some definitions=

To make sense of explanations on this page, you need to understand the terminology used here.

==Source value==

A weather station sends values based on its sensors to Cumulus. If Cumulus reports that value without changing it (an offset and/or multiplier might be applied to convert it to the unit wanted by the Cumulus User), the value is described as a '''source value''' because Cumulus is reporting something that has its source elsewhere.

There is not a single list of what weather values are called "source values", because this varies depending on the weather station, and in some cases, a Cumulus User can ask Cumulus to recalculate a value instead of using what is sent by their weather station.

However, Cumulus does include code that expects a weather station to provide ''a defined minimum set of source values'':
# Current air temperature
# Current Relative Humidity
# At least one wind speed
# Current air pressure (absolute or sea-level)
Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these).

This requirement is a default, but it can be changed:
*For recent releases of MX, this is classified as an advanced setting "No sensor check" (see [[Cumulus.ini]])
*For earlier releases of MX, this is "No sensor check" (see [[Cumulus.ini (MX_3.0.0_to_3.7.0)#Read-only_parameters_in_the_Station_section_.28releases_3.0.0_to_3.6.12.29|here for how to change default]])
*For legacy Cumulus 1, [[Cumulus.ini_(Cumulus_1)#Read-only_parameters_in_the_Station_section|see here for how to change default]]

Cumulus also expects that your weather station can provide:
* A rainfall counter (this could be annual rainfall, or count of rocker bucket gauge tips)
Although the lack of that rainfall counter source value will affect functionality, Cumulus will continue to process other source values that are available.

Some weather stations may also provide one, or more, of these optional source values (not a complete definitive list):
* Dew-point Temperature
* Wind Chill Temperature
* Evaporation
* Sunshine hours
* Solar radiation
* UV index
* Air pollution measurement

==Derived value==

A dictionary will define '''derived''' as "obtained from a source", and that is the meaning adopted on this page. Steve Loft (in the Cumulus Support Forum) used the terminology "derived" for two purposes.
# One type of derived value takes a source value, applies any multiplier (may be both first order and second order multipliers) and/or constant that has been defined in calibration settings, and converts the output to the units selected by the Cumulus user.
# The other type of derived value takes more than one source value, applies a standard calculation, and ouputs a new derivative
#* Because newer releases calculate more derivatives than older releases, extra fields have been added to the standard log file

=="Calculate Missing"==

This also has two meanings in a Cumulus context:
# If a particular standard log file line has fewer fields than the latest line;
#* '''Calculate Missing''' is the process of looking at the derived values of first type above, and calculating any derivative (second type of derived value) that is missing in that particular line
# If a particular daily summary log file, either does not have a line for a particular meteorological date, or does not have all fields defined in a line for a particular meteorological date;
#* Please see [[Amending dayfile]] page for full details.
#* '''Calculate Missing''' is the process of scanning all the lines in the standard log file that relate to the meteorological date and recalulating approximate extremes, or sums, for the missing fields.

If you are using Cumulus MX, there is a download [[Software#Create_Missing| linked from here]] that does both of these. There are also editors within the [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|admin interface]] for manually editing the files on a line by line basis. You can also use the PHP Hypertext Pre-processor (PHP) script specified for Cumulus 1 below, although be aware it was written for a very old PHP version.

If you are using the legacy Cumulus 1 software:
# For the standard log file meaning above, provided you have access to a web server that can run PHP Hypertext Pre-processor (PHP) scripts, then [https://cumulus.hosiene.co.uk/viewtopic.php?f=18&t=18096 this post in support forum] includes a script that produces a HTML form where you specify [[Standard_log_files#Introduction|the log file name]] you wish to edit. The script will read that file, and output a replacement file with all possible spot derived fields populated. Please note that script was written to run on an old version of PHP that was current at the time the script was written, it will need some editing to work on latest PHP.
# For the daily summary log meaning above, go to the '''Edit''' menu, and select ''Dayfile.txt''. This brings up an editor with a button labelled "Create Missing", that will not affect any existing line, but can insert missing lines, see [[Amending_dayfile#Create_Missing]].

===Accurate or Not?===

This Wiki page describes some techniques for calculating and inserting values that are missing from standard log files and from daily summary log file.

Since the derived values this page is discussing are spot values, they have to be calculated from source values measured at the same time. This means that if one of your [[:Category:Ini Files|.ini]] files is missing some fields, these missing fields cannot be calculated from other fields. This applies to any missing extreme records for today, this month, this year, monthly-all-time, or all-time.

However, the techniques for correcting rogue values described on the [[Correcting_Extremes]] page, can be used for inserting missing values in the daily and longer period extreme records.

For the standard log files, all the fields in any one line relate to the same time, therefore for derived values calculated from other fields in the same line, you should have the same value whether it was calculated when that line was originally stored, or calculated afterwards. I say '''should''' because the calculation formula is not always the same for all releases, in particular there are differences between how Cumulus 1 and how MX calculate some derivatives.

For entries in today.ini, month.ini, year.ini, alltime.ini, and monthlyalltime.ini files, you don't have access to the source values used for the original calculation afterwards.
* The original values are calculated as Cumulus is running
**Depending on your weather station, Cumulus is able to read values every minute, and consequently update today.ini (and the other files listed) each minute if an extreme happens
** Obviously, dayfile.txt is updated from today.ini, so it is just as accurate
* Any "Calculate Missing" operation, done subsequently, does not have access to old data, it can only look in the spot values that have been logged.
**If Cumulus is set up to only log the readings every half an hour, create missing is only able to see 1/30th of the data,
** Due to this mismatch, the derived values (averages, highs, lows) this approach can store are much less accurate (hence getting missing lines from a backup is better)

=Derived spot values=

Cumulus software code as it reads source spot values, will detect if that source value is required for the calculation of an instant derived spot value.

Here are all the derived spot values that Cumulus can calculate (depending on Cumulus configuration settings, and what your weather station can output):
* '''Dew point''', a weather station might output dew point temperatures, but Cumulus can calculate it from source values for outdoor temperature and outdoor humidity
** The original legacy Cumulus, and MX, use [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters|different formulae to calculate dew point]], so there is a continuity break if some of your data logs were created by the original Cumulus software and some by MX.
* '''Wet Bulb''', is only calculated by Cumulus 1, not MX
* [[Wind_chill|'''Wind Chill''']], again this might be output by your weather station, but Cumulus can calculate it from outdoor temperature and average wind speed.
* [[Humidex|'''Canadian Humidity Index (Humidex)''']], [[Heat_index|'''USA Heat Index''']], and [[Apparent_temperature|'''Apparent Temperature''']] are not output by your weather station, but both the original Cumulus 1 and the newer Cumulus MX will derive these spot values for you (except if you are running a very old release)
** (The implementation of these by Cumulus software is briefly mentioned [[Feels_Like#The_various_ways_to_express_Feels_Like|here]]).
** The calculation formulae used for these may not be consistent for all releases, so again there is a possibility a data log might have continuity breaks.
* [[Feels_Like|'''Feels Like Temperature''']] is calculated by the Cumulus MX flavour only, the actual calculation formula [[Feels_Like#The_various_ways_to_express_Feels_Like|has varied]] in different releases, but use a variation on
* [[Heat/cold_degree_days_and_Chill_hours|'''Heating Degree Days''' and '''Cooling Degree Days''']]; these are further examples of derived values that most versions of Cumulus will calculate for you (from all processed outdoor temperatures in a day)
**A bug in some versions of the original Cumulus software could result in these derived values being swapped and therefore tracked wrongly when reporting extremes.

The links above will take you to where the derived values are explained in the [[:Category:Terminology]] pages of this Wiki, however at the time of writing this page, many of those links have very little information, so you may wish to search online to find more information in for example Wikipedia.

There are some configuration settings where you can decide whether to use a weather station supplied dew point temperature and whether to use a weather station supplied wind chill temperature.
* For MX, please see [[MX_Administrative_Interface#Changing_Settings]] and [[Cumulus.ini]] pages for how to find the settings
* For legacy Cumulus 1, please see [[Cumulus_Screenshots#Station|Configuration -->> Station]] menu and [[Cumulus.ini_(Cumulus_1)]] pages

=Field Count Variations=

When the [[Standard_log_files#List_of_fields_in_the_file|standard data logging]] file was introduced it only had 16 (or fewer?) fields. As time has gone by, extra fields have been added to the file. At time of writing, 29 fields have been in the file since release 3.6.12 (build 3088), and currently the "To Do" database does not include any suggestions that would add more fields.

When the [[Dayfile.txt#List_of_fields_in_dayfile.txt|daily summary log]] file was introduced it had 15 fields. As time has gone by, extra fields have been added to the file. At release 3.6.12 there were 54 fields, but at earlier and later releases there are fewer fields. At the last update of this page (release 3.7.0) there were 52 fields. The number of fields in a line of the file might be changed in a future release.

When you use Cumulus to edit any of these files, it expects the file to have the number of fields defined in the release you are using. If an existing line in the file has fewer fields, Cumulus can still read it, but Cumulus will add trailing field separators if the file line is edited.

Consequently, those people who have used Cumulus for a while may have files that include some lines with fewer fields stored than their latest lines.

=Why do "Calculate Missing"?=

Most functionality in Cumulus is concerned with current data or extremes/sums that are derived for a hour, a day, or longer, periods. For these contexts, you might encounter an odd rogue value that needs to be corrected as described on the [[Correcting_Extremes]] page. You are unlikely to worry about missing past values.

However, if you want to be sure that your all-time extremes, or monthly-all-time extremes, are correct, then [[Correcting_Extremes#All-time_extreme_functionality|this table]] shows how the start date for these extremes varies. You might want to achieve better consistency by adding missing fields to earlier lines in the log files, if so you want to do a "create missing".

If you are using the [[Highcharts_-_Historic|'''Historic Charts''']] feature introduced from release 3.9.2 - b3097 (7 December 2020), you may notice that these new charts have gaps in available data, and the dates with/without data vary depending on what is being plotted. You might want to achieve better consistency by adding missing fields to earlier lines in the log files, if so you want to do a "create missing".

=How to do "Calculate Missing"=

As mentioned earlier, there are a number of options, here are the detailed instructions for each option.

==CreateMissing.exe==

Mark Crossley has written a utility that can add any of the following fields to your [[Standard_log_files#List of fields in the file|MMMYYlog.txt]] lines:
* [[Wind chill|Wind Chill]]
* [[Apparent_temperature|Australian Apparent Temperature]]
* [[Feels Like|Feels Like temperature]]
* [[Heat index|North American Heat Index]]
* [[Temperature_(and_humidity)_measurement#Dry_and_Wet_Bulb|Wet Bulb temperature]]
* [[Temperature_(and_humidity)_measurement#How_Cumulus_software_handles_Temperature_and_Humidity|Dew Point]]

The primary purpose of the utility is however to create a new ''dayfile.txt'' populating each field as summarised in table below.

''Please note the developer does not fully describe his utility at [https://github.com/cumulusmx/CreateMissing/blob/master/README.md his github page] so the author of this Wiki update cannot guarantee the detailed documentation here is correct''

===Requirements for using Create Missing utility===

This utility is only for those who have already installed Cumulus MX:
* It uses some [[Software#By_Mark_Crossley|.dll files]] that are in the MX installation package referenced beside the [https://github.com/cumulusmx/CreateMissing/releases release download]
* Each "CreateMissing.exe" release relates to the fields in [[dayfile.txt]] at a particular "CumulusMX.exe" release (see [[Software#Create_Missing]] page)
* It uses some information in [[Cumulus.ini]] a file created when MX is run

Although the developer works on "CreateMissing.exe" independently of "CumulusMX.exe" code, so they can get out of step, normally the latest release of the former works with the latest release of the latter.

In a Microsoft Windows environment, Create Missing uses the .NET software that is normally already available.

In a UNIX-derived operating system (e.g. a computer running Linux or Raspberry Pi operating system), there is a need to [[Preparing_your_Linux_computer_for_MX#Checking_if_mono-complete_is_in_Source_List|install MONO]] to run either "CreateMissing.exe" or "CumulusMX.exe".

===Obtaining the Create Missing Utility===

There is a download link on [[Software#Create_Missing]] page for the latest release of the utility. The MX 3.20.0 release zip also includes a copy of the utility; it was not included in release packages for earlier MX releases, and I can't predict whether it will be included in any subsequent MX release.

All releases are available at [https://github.com/cumulusmx/CreateMissing/releases Github release download], but be aware that Create Missing version 1.0.2 definitely had a bug as mentioned by developer in the forum, and the forum reports issues found by some users over handling the first day of any month with some other releases. Each release works only with specific "CumulusMX.exe" releases as described (with links to details) in previous subsection.

# Run whatever package your computer uses to extract/unzip packages.
# The package should list 2 or 3 components found in the zip file
# Extract those components to a new folder in your download area
# Copy/install the "CreateMissing.exe" and "CreateMissing.exe.config" into same folder as CumulusMX.exe.
# If there is a "Updates.txt" included, you will need to rename that file before copying as it conflicts with a file of that same name issued with "CumulusMX.exe" and "ExportToMySQL.exe" release downloads.

If you are installing it into a UNIX environment (e.g. a computer running Linux or Raspberry Pi operating system), the '''CreateMissing.exe''' file may need to be given execute access (see [[Preparing_your_Linux_computer_for_MX#chmod]]).

===Preparing to run the Create Missing Utility===

# Open up the MX interface in a browser, and navigate to ''Settings menu -> Station Settings -> General Settings -> Advanced Options -> Records Began Date''
#* The date that is shown there is the date where "Create Missing" will start by default, so if you have MMMYYlog.txt log files with an earlier date, edit the date here
#*# Ensure any new date you enter there uses exactly the same format as the date that was there
#*# Click '''Save Settings''' button if you have made a change to this date
# Close your browser, and (if using an interactive screen for your computer) open up your file manager, or (if using a terminal session for access to your computer) navigate to your CumulusMX folder
# Navigate to your [[Data_folder|data sub-folder]]
# If there is a file there called '''dayfile.txt.sav''', rename that file to '''dayfile.txt.sav.bak''' (or any other name that does not already exist)

Optionally, you may wish to take a backup of the existing contents of the "data" directory onto a separate storage device, because the utility edits files in there, and if something goes wrong mid-edit (e.g. power cut, storage device failure) you could lose your valuable data.

===Running the Create Missing Utility===

The utility can be run while "CumulusMX.exe" is running (see below) either interactively or as a service, or while MX is stopped.

'''On Microsoft Windows operating systems''':
# First change the path to your Cumulus MX root folder
# Start a command window, Powershell window, or Terminal window (whichever is available when you right click in the folder or on the "Start" icon)
# Now type <code>CreateMissing</code> (or type "CreateMissing.exe", both will work)

'''On Unix-derived operating systems (such as Linux)''':
# First change your command line path to your Cumulus MX root folder (cd CHOSEN PATH/CumulusMX)
# Now type <code>sudo mono CreateMissing.exe</code>
#* If the user you are using already has execute access it is possible to leave out 'sudo' (the present writer has not tested this)
#* If mono is already running, it has been suggested it might be possible to leave out 'mono' (the present writer has not tested this)

''It is important to understand'' that when you start MX interactively, or as a service, it reads the contents of '''dayfile.txt''' into an internal array (held in random access memory - RAM).
* The only other time that 'CumulusMX.exe'' accesses the '''dayfile.txt''' is at rollover when it copies what it generates internally for the day just ended into the file
* You should never run '''CreateMissing.exe''' near to your rollover time
* At any other time, if you run '''CreateMissing.exe''' while ''CumulusMX.exe'' is running, any updates to the file are ''not'' seen by MX until that software is restarted.
* Release 3.20.0 (beta build 3199 onwards) adds a new "Utils" menu with a new option to refresh the internally held values without restarting MX.
* The internally held values, not the contents of '''dayfile.txt''' itself, are displayed when you use any of the [[Correcting_Extremes|extreme record editors]]

===How the Create Missing Utility works===

The utility program will output to any terminal session open and also (with further detail) to a file saved in [[#How the utility reports progress|MXdiags directory]].

This utility program looks in [[Cumulus.ini]] for:
# The Cumulus start date in "StartDate=" parameter, which defaults to the date you first ran Cumulus (as mentioned above it can be edited to another date, to include imported earlier data or to exclude data that relates to a former location).
#* That will be the earliest date the utility program processes.
#* However, if a dayfile.txt file exists and that has an earlier date, then "Create Missing" will only continue if you accept that earlier date.
# The meteorological day start time in "RolloverHour=" and "Use10amInSummer=" parameters.
#* This identifies which standard log lines belong to each day by checking against date and time of that line.
# The thresholds for Heating Degree Days, Cooling Degree Days, and Chill Hours
# The starting month for Chill Hours Season

This utility program looks in the [[Data_folder|data sub-folder]]:
# If there is a file there called '''dayfile.txt.sav''', the utility aborts
# If there is a file there called '''dayfile.txt''', the utility renames that to ''dayfile.txt.sav''

The sequence followed by the utility is:
# The utility will not run if a file called '''dayfile.txt.sav''' already exists in [[data folder]]
# The utility reads [[Cumulus.ini]] and displays the 'record start date' it finds
# It asks if this date is correct
# If you answer with anything other than 'Y' or 'y', the utility aborts
# If you answer with 'Y' or 'y', the utility continues
# It creates an internal array to hold the equivalent of '''dayfile.txt''' in random access memory - RAM
# If there is an existing [[dayfile.txt]], its contents are used to populate that two-dimensional array
# It renames any existing 'dayfile.txt' to '''dayfile.txt.sav''' in your [[Data_folder|data sub-folder]]
# It then works through the MMMYYlog.txt files that have lines for dates after that 'record start date'
# For each of these [[Standard log files]] there is another sequence:
## The inner sequence involves opening the file (the log in MXDiags records when each file is opened, files may be opened more than once)
## The dates being processed are shown in the terminal window; as each output is followed by just a "Line Feed" character the lines will overwrite each other in a Microsoft Windows environment (which expects "Carriage Return" and "Line Feed" in sequence to terminate a line), will be on successive lines in a Linux environment (where the normal line terminator is "Line Feed"), and will be on one long line in a Mac operating system (where the normal line terminator is "Carriage Return")
## If a line read in the source file does not include a particular [[#Derived_value|derived value]] (see list [[#CreateMissing.exe|above]]), then the utility will calculate that required value from the [[#Source_value|spot source field values]] in the same line, and update that line
## The exact calculation done for each item in dayfile.txt is listed in the table [[#How the utility creates a dayfile.txt line]] below, but here are the basic principles
## For solar data, it examines lines in the file with times between two successive midnights
##* If the array already holds a "sun hours" figure for the date quoted in those lines, the utility skips to next midnight to midnight period
##* If the array is missing a "sun hours" figure for the date quoted in those lines, the utility stores the sun hours recorded in last entry of that period in the part of the internal array with matching date
## From release 1.3.0, CreateMissing.exe will also calculate the maximum rainfall in a 24-hour period; to do this it looks at rain counter for the line in the source file it is currently processing, and attempts to find rain counter in another line nearest to 24 hours later (if the time interval between the lines is not exactly 24 hours then the difference figure reported will be for whatever period is available) looking up the rain counter there; it will track the maximum difference ending on a date that date determines where in the array the figure is stored; if the difference in rain counter yields a negative figure it is ignored
## For other daily data, the lines examined will start at rollover time and continue until just before the next rollover time (with allowance for any DST change)
##* If the daily data is an extreme, then the highest or lowest (source or derived) value seen in that range of lines is added to the array if an entry does not already exist
##* If the daily data is cumulative (over a day or over a season), then if the internal array does not already have a value, that from the last value in the range of lines is stored
##* If the daily data is not directly related to fields held in the source file (e.g. cumulative chill hours), then it will be calculated from what is available (for chill hours, if the recorded temperature in line being examined is below threshold, then the time interval passed since the previous entry is added to an internally held count; note this MX calculation is slightly different to Steve Loft approach that worked on average of temperature in a particular line and the temperature in previous line being below threshold)
## When all lines in a particular file have been examined, that file is closed (the log in MXDiags records when each file is closed, files may be closed more than once)
## The next file (chronologically) is opened (the log in MXDiags records when each file is opened, files may be opened more than once) and the inner sequence continues
# When all the source files have been processed, the utility continues
# The utility creates a new file, naming it '''dayfile.txt'''
# The utility copies what is stored in its internal array to the new file
# To prevent the terminal screen closing, the utility ends with a "Press any key to continue" prompt

=== How the utility creates a dayfile.txt line ===
{| class="wikitable" border="1"
|-
!style="background:pink; width:250px" | dayfile.txt field
|colspan="4" style="background:lightgray; width:150px" | Standard log file fields
!style="background:pink; width:400px" | Description
|-
|style="background:pink;"| Daily derivative
|style="background:lightgray;"| Preferred field
|style="background:lightgray;"| First source
|style="background:lightgray;"| Second source
|style="background:lightgray;"| Third source
|style="background:pink;"| (how calculated)
|-
| [[Meteorological_day|date]]
|
| Day-Month-Year
| Hour-Minute
|
| From processing lines linked with that Meteorological day.
|-
|Highest wind [[Wind_measurement#Weather_Stations_and_Cumulus|gust]] speed
| colspan="4" | Cumulus '''Gust''' wind speed
| Stores highest value of that log file field in that Meteorological day.
|-
|[[Wind_measurement#Wind_Direction | Bearing]] of highest wind gust
| colspan="4" | Average wind bearing (in degrees)
| Stores the bearing recorded at same time as maximum value in previous field
|-
|Time of highest wind gust
| colspan="4" | Hour-Minute
| Stores the time in log file line used in two previous fields
|-
|Minimum [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | temperature]]
| colspan="4" | Current temperature
| Stores the lowest value of that log file field in that Meteorological day.
|-
|Time of minimum temperature
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Maximum temperature
| colspan="4" | Current temperature
| Stores highest value of that log file field in that Meteorological day.
|-
|Time of maximum temperature
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Minimum [[Pressure_Measurement | sea level pressure]]
| colspan="4" | Current sea level pressure
| Stores the lowest value of that log file field in that Meteorological day.
|-
|Time of minimum pressure
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Maximum sea level pressure
| colspan="4" | Current sea level pressure
| Stores highest value of that log file field in that Meteorological day.
|-
|Time of maximum pressure
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Maximum [[Rain_measurement#Rain_Rate | rainfall rate]]
| colspan="4" | [[FAQ#How_is_my_rain_rate_calculated.3F | Current rainfall rate]]
| Stores highest value of that log file field in that Meteorological day.
|-
|Time of maximum rainfall rate
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Total rainfall for the day
| colspan="4" | Total rainfall today so far
| Stores the entry in the last log file field in that Meteorological day.
|-
|[[Average temperature]] for the day
|
| Hour-Minute
| Current temperature
|
|Loop through every log file pair of fields in that Meteorological day:
# Work out interval time in minutes obtained by subtracting previous "Hour-Minute" field from current "Hour-Minute" field
# Work out product of above interval time times "Current temperature" field
# Sum the interval times in step 1 for whole day
# Sum the products in step 2 for whole day
# When completed loop, store the sum in step 3 divided by the sum in step 4
|-
|Daily [[Windrun | wind run]]
|
| Hour-Minute
| Cumulus moving ''''Average'''' of wind speed measurements over a particular period
|
|Loop through every log file pair of fields in that Meteorological day:
# Work out interval time in hours obtained by subtracting previous "Hour-Minute" field from current "Hour-Minute" field
# Work out product of above interval time times "Current average wind speed" field
# Sum the products in step 2 for whole day
# When completed loop, store the sum in step 3
|-
|Highest [[Wind_measurement#Weather_Stations_and_Cumulus|Average Wind Speed]]
| colspan="4" | Cumulus moving ''''Average'''' of wind speed measurements over a particular period
| Stores highest value of that log file field in that Meteorological day.
|-
|Time of Highest Avg. Wind speed
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Lowest [[Temperature_(and_humidity)_measurement | humidity]]
| colspan="4" | Current [http://en.wikipedia.org/wiki/Relative_humidity relative humidity]
| Stores the lowest value of that log file field in that Meteorological day.
|-
|Time of lowest humidity
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Highest humidity
| colspan="4" | Current relative humidity
| Stores highest value of that log file field in that Meteorological day.
|-
|Time of highest humidity
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Total evapotranspiration
| colspan="4" | Evapotranspiration
| Stores highest value of that log file field in that Meteorological day.
|-
|Total hours of sunshine
| colspan="4" | Hours of sunshine so far today
| Stores highest value of that log file field in that '''calendar''' day (i.e. midnight to midnight)
|-
|High USA [[Heat index]]
| Heat Index
| Current relative humidity
| Current temperature
|
| The heat index is a derived value, if the field in "preferred field" does not contain a valid number, then that field is populated for each line linked with that Meteorological day using the values in fields named in the the other columns of this table. When all the preferred field in day have a value, the highest is stored.
|-
| Time of high heat index
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
| High [[Apparent temperature]]
| Apparent temperature
| Current relative humidity
| Current temperature
|
| Apparent temperature is a derived value, if the field in "preferred field" does not contain a valid number, then that field is populated for each line linked with that Meteorological day using the values in fields named in the the other columns of this table. When all the preferred field in day have a value, the highest is stored.
|-
|Time of high apparent temperature
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Low apparent temperature
| Apparent temperature
| Current relative humidity
| Current temperature
|
| Apparent temperature is a derived value, if the field in "preferred field" does not contain a valid number, then that field is populated for each line linked with that Meteorological day using the values in fields named in the the other columns of this table. When all the preferred field in day have a value, the lowest is stored.
|-
|Time of low apparent temperature
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|High hourly rain
| colspan="4" | Total rainfall today so far
| High hourly rain is a derived value. Loop through every log file field in that Meteorological day, build up a series of hourly values (total rainfall in this entry minus total rainfall an hour earlier), find maximum of all those hourly values, and store that.
|-
|Time of high hourly rain
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Greatest [[wind chill]] (high wind speed, low temperature)
| Wind chill
| Cumulus moving ''''Average'''' of wind speed measurements over a particular period
| Current temperature
|
| Wind Chill can be reported by weather station or it can be derived. If the field in "preferred field" does not contain a valid number, then that field is populated for each line linked with that Meteorological day using the values in fields named in the the other columns of this table. When all the preferred field in day have a value, the highest is stored.
|-
|Time of greatest wind chill
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|High [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | dew point]]
| colspan="4" | Current dew point
| Dew Point can be reported by weather station or it can be derived. However, all Cumulus releases have this log file field. Stores highest value of that log file field in that Meteorological day.
|-
|Time of high dew point
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Low dew point
| colspan="4" | Current dew point
| Dew Point can be reported by weather station or it can be derived. However, all Cumulus releases have this log file field. Stores lowest value of that log file field in that Meteorological day.
|-
|Time of low dew point
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Today's dominant/average wind direction
|
| Cumulus moving ''''Average'''' of wind speed measurements over a particular period
| Average wind bearing (in degrees)
|
| The dominant/average wind direction is a derived value.
# Loop through every log file pair of fields in that Meteorological day:
#* Calculate increment in X as product of wind speed times sine of bearing, and sum those increments
#* Calculate increment in Y as product of wind speed times cosine of bearing, and sum those increments
# Convert final X and Y coordinates back to a bearing in degrees
|-
|[[Heat/cold degree days and Chill hours | Heating degree days]] (HDD)
|
| Hour-Minute
| Current temperature
|
|Loop through every log file pair of fields in that Meteorological day:
# Work out interval time in days obtained by subtracting previous "Hour-Minute" field from current "Hour-Minute" field
# Work out increment in HDD by subtracting current temperature from HDD threshold
# Work out product multiplying result in step 1 by result in step 2, and sum those products
# At end of loop store the final sum
|-
|[[Heat/cold degree days and Chill hours | Cooling degree days]] (CDD)
|
| Hour-Minute
| Current temperature
|
|Loop through every log file pair of fields in that Meteorological day:
# Work out interval time in days obtained by subtracting previous "Hour-Minute" field from current "Hour-Minute" field
# Work out increment in HDD by subtracting CDD threshold from current temperature
# Work out product multiplying result in step 1 by result in step 2, and sum those products
# At end of loop store the final sum
|-
|High solar radiation
| colspan="4" | current solar radiation
| Stores highest value of that log file field in that Meteorological day.
|-
|Time of high solar radiation
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|High UV Index
| colspan="4" | UV Index
| Stores highest value of that log file field in that Meteorological day.
|-
|Time of high UV Index
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|High [[Feels Like]] temperature
| Feels Like temperature
| Current relative humidity
| Cumulus moving ''''Average'''' of wind speed measurements over a particular period
| Current temperature
| Feels Like temperature is a derived value, if the field in "preferred field" does not contain a valid number, then that field is populated for each line linked with that Meteorological day using the values in fields named in the the other columns of this table. When all the preferred field in day have a value, the highest is stored.
|-
|Time of high feels like temperature
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|Low Feels Like temperature
| Feels Like temperature
| Current relative humidity
| Cumulus moving ''''Average'''' of wind speed measurements over a particular period
| Current temperature
| Feels Like temperature is a derived value, if the field in "preferred field" does not contain a valid number, then that field is populated for each line linked with that Meteorological day using the values in fields named in the the other columns of this table. When all the preferred field in day have a value, the lowest is stored.
|-
|Time of low feels like temperature
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
|High Canadian Humidity Index or [[Humidex]]
| Humidex
| Current relative humidity
| Current temperature
|
| The Canadian Humidity index is a derived value, if the field in "preferred field" does not contain a valid number, then that field is populated for each line linked with that Meteorological day using the values in fields named in the the other columns of this table. When all the preferred field in day have a value, the highest is stored.
|-
|Time of high Humidex
| colspan="4" | Hour-Minute
| Stores the time in log file line used in the previous field
|-
| Cumulative Seasonal Chill Hours
|
| Current temperature
| Hour-Minute
|
| "Chill Hours" is a derived value, loop through every log file field in that Meteorological day:
# Work out interval time in hours obtained by subtracting previous "Hour-Minute" field from current "Hour-Minute" field
# Work out if there is increment in Chill hours by seeing if "Current temperature" field is below Chill Hours threshold temperature
# If there is an increment, sum value from step 1
# At end of loop, store final value of sum after (except on first day of month specified as Start of Chill hours season) adding it to value in previous day
|-
| Maximum rainfall in a 24 hour period ending on particular day
| colspan="4" | Rainfall Counter
| Two log file lines are examined, approximately 24 hours apart, the rainfall counter value in earlier of the two lines is subtracted from that in later of the two lines. If the difference is negative it is ignored. If the difference is zero, or positive, then it is inserted into the Rain 24 hours for the relevant Meteorological day date for the time in the later line, unless it is lower than any number already there
|-
| Time of maximum rainfall in a 24 hour period
| colspan="4" | Hour-Minute
| Stores the time in later of the two log file lines used in the previous field
|}

===After running Create Missing===

If MX was running while Create Missing was run, then MX will remain unaware that "dayfile.txt" has been updated, and that can cause a problem at rollover when MX appends a new line to the file.

If you are running a MX release up to 3.19.3, then you should first stop and then restart MX, so it loads the contents of the new file into its internal array (see [[#Running the Create Missing Utility]]. From release 3.20.0 (beta build 3199 onwards) released as build 3202, there is a '''Utils''' menu in the interface, and you should select ''Reload Dayfile'' menu item and on the web page subsequently displayed click the ''Reload Dayfile'' button.

Create Missing changes the content of your [[Standard log files|MMMYYlog.txt files]] and your [[Amending dayfile|dayfile.txt]], so you may then wish to work through all the [[Correcting_Extremes|extreme record editors]] and decide if you want to update any entries.

===How the utility reports progress===

Here is a short section of typical output (from version 1.0.2 that had a bug and never processed 1st day of month) in a log that was stored in [[MXdiags folder|MXdiags]]:
<pre>
2021-06-08 19:35:44.108 Loading log file - data/Jul20log.txt
2021-06-08 19:35:44.191 01/07/2020 : No monthly data was found, not updating this record
2021-06-08 19:35:44.688 Date: 02/07/2020 : Adding missing data
2021-06-08 19:35:44.705 Date: 03/07/2020 : Adding missing data
2021-06-08 19:35:44.719 Date: 04/07/2020 : Entry is OK
2021-06-08 19:35:44.720 Date: 05/07/2020 : Entry is OK
2021-06-08 19:35:44.720 Date: 06/07/2020 : Entry is OK
2021-06-08 19:35:44.720 Date: 07/07/2020 : Entry is OK
2021-06-08 19:35:44.720 Date: 08/07/2020 : Entry is OK
2021-06-08 19:35:44.720 Date: 09/07/2020 : Entry is OK
2021-06-08 19:35:44.720 Date: 10/07/2020 : Entry is OK
2021-06-08 19:35:44.721 Date: 11/07/2020 : Adding missing data
2021-06-08 19:35:44.777 Date: 12/07/2020 : Adding missing data
2021-06-08 19:35:44.791 Date: 13/07/2020 : Adding missing data
2021-06-08 19:35:44.805 Date: 14/07/2020 : Adding missing data
2021-06-08 19:35:44.819 Date: 15/07/2020 : Adding missing data
2021-06-08 19:35:44.834 Date: 16/07/2020 : Adding missing data
2021-06-08 19:35:44.848 Date: 17/07/2020 : Adding missing data
2021-06-08 19:35:44.863 Date: 18/07/2020 : Adding missing data
2021-06-08 19:35:44.877 Date: 19/07/2020 : Adding missing data
2021-06-08 19:35:44.892 Date: 20/07/2020 : Adding missing data
2021-06-08 19:35:44.905 Date: 21/07/2020 : Adding missing data
2021-06-08 19:35:44.919 Date: 22/07/2020 : Adding missing data
2021-06-08 19:35:44.933 Date: 23/07/2020 : Adding missing data
2021-06-08 19:35:44.948 Date: 24/07/2020 : Adding missing data
2021-06-08 19:35:44.962 Date: 25/07/2020 : Adding missing data
2021-06-08 19:35:44.977 Date: 26/07/2020 : Adding missing data
2021-06-08 19:35:44.992 Date: 27/07/2020 : Adding missing data
2021-06-08 19:35:45.006 Date: 28/07/2020 : Entry is OK
2021-06-08 19:35:45.006 Date: 29/07/2020 : Entry is OK
2021-06-08 19:35:45.006 Date: 30/07/2020 : Entry is OK
2021-06-08 19:35:45.141 Date: 31/07/2020 : Adding missing data
2021-06-08 19:35:45.156 Finished processing log file - data/Jul20log.txt
2021-06-08 19:35:45.156 Loading log file - data/Aug20log.txt
</pre>

==Using a PHP script on your web server==

If you have access to a web server that can run PHP Hypertext Pre-processor (PHP) scripts, then [https://cumulus.hosiene.co.uk/viewtopic.php?f=18&t=18096 this post in support forum] includes a script that produces a HTML form where you specify [[Standard_log_files#Introduction|the log file name]] you wish to edit. The script will read that file, and output a replacement file with all possible spot derived fields populated.

That might sound a bit technical, so here are some step by step instructions:
#Download the '''processStandardLog.php''' script from [https://cumulus.hosiene.co.uk/viewtopic.php?f=18&t=18096 here].
#File transfer (or copy for local web server) that script to your web server
#File transfer (or copy for local web server) all the standard log files from the data sub-folder in your Cumulus installation to a suitable holding folder (you may need to create it) on your web server
#Open in a browser '''PATH/processStandardLog.php''' by preceding the file name with the path as defined from the root on your web server
#This loads a web page where you have a field asking you to enter a path and file name for the data log you want to process
#Continue to follow the instructions on the web page
#When it has created a replacement file, you can enter details for another data log, and continue until all your data logs have been processed
#Take a backup of your existing Cumulus installation (you should be doing that on a regular basis anyway, so I will not give instructions here)
#Carefully delete any non-current data log in your data sub-folder that you have a replacement for, and file transfer (or copy back) the replacement data logs from your web server into the local data sub-folder, noting that the file extension will need to be renamed from '''.csv''' to '''.txt'''.

==Using the '''data log''' editor provided in MX==

<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This document was written for the (legacy) Cumulus 1 software. It has been updated to cover MX, but that was for a MX release that is no longer latest!

When this section was written, the number of lines shown was fixed at a maximum of 10; later releases have given the option to display different numbers of lines, and there may be other changes still to be documented here.
</div>
In the [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|MX admin interface]] go to the '''Data Logs''' menu tab, and select the ''Data Logs'' page.

There is a box for selecting the data log you want to edit. Once you have loaded that, the first (up to) 10 lines are shown. Navigation links let you select 'First', 'Previous', 'Next', and 'Last' pages, also a small number of pages can be selected directly.

Once you select a line, an '''Edit''' button is enabled, click that and you can manually input the missing values for that line. '''Save''' that edit, and you can select another line. Once you have edited all the lines on that page, you can select another page, and repeat the process. Then you can select another log, and repeat the process.

It is a long-winded way to edit, and the MX editor does not even validate what you have entered. An alternative is to edit each log file externally, and you can read how to do that in the "Work around for standard log files" section below.

Some readers of the Cumulus support forum will know that a third-party replacement for the MX editor was worked on, but never got incorporated into MX. The idea was to replace the alt_editor software used by Mark Crossley, with a standard HTML form script. This allowed in-line editing, it allowed the derived values to be calculated and displayed (so you simply decided whether to accept the replacements as suggested for the various fields), and finally it applied some validation to each field to ensure any manual edit inserted a value that was within the allowed range. The main reason for its rejection from the public MX was the complex way in which different files included in the admin interface interact, and the consequent issue that changes made for this replacement had a knock on effect on other pages in the admin interface. The author could not afford the time to redesign the whole admin interface so the proposed replacement could be integrated.

==Lack of editor in Cumulus 1==

Cumulus 1 provides a [[Cumulus_Screenshots#View_Menu|viewer]] for the data logs, that does not permit editing of the file.

On the '''View''' menu, select ''''Data Logs''', then enter the file name you want to view and load it. You can scroll left to right through the fields, and you can scroll up and down through the lines. The viewer shows a header row so you know which field is which. You cannot do any editing.

If you find that this viewer cannot load a data log, it is probably because you ignored the '''read me''' that is part of the Cumulus 1 installation procedure, see [[FAQ#I_can.E2.80.99t_find_my_data_files.21|FAQ: I can't find my data files]]. If the displayed headings do not match the data shown, you have not read the caution on the screen, which says the viewer is only for standard data logs, not extra sensor data logs , nor the daily summary log.

Cumulus 1 does not provide any functionality to edit the standard data logs, whether to correct a rogue value, or to add a missing derivative.

==Work around for standard log files==

An option is to edit the file outside Cumulus using a '''Comma Separated File''' editor, a plain text editor, or a spreadsheet program (like the free open source '''Libre Office Calc''' or the commercially charged for ''Microsoft Excel'').

Note: Cumulus 1 applies an exclusive lock to current standard log file, and conflicts can happen if another process seeks to access this file. Consequently don't let your antivirus scans access this file, nor try to edit it outside Cumulus while the original Cumulus software is running. A full discussion of the problems with conflicts of access to the standard log file can be found [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=12721 in this support forum topic].

If you decide to edit the current log outside Cumulus, then remember that, if you leave Cumulus running it will continue to append new lines. Therefore, you either need to close Cumulus while you are doing the edit; or (if you are able to merge two files) close Cumulus while you replace its file with a merge of what you have edited and the extra lines added since you took away a copy to edit.

It is best practice, to take a back-up copy of all your Cumulus installation before starting any editing. It is also best practice to take a further copy of any file you want to amend, and to do your edit on that copy, so you do not edit any Cumulus file directly. The original full backup will preserve the existing file, so you can regress to it, should Cumulus find an error in your edit.

Also note these log files do not include a header line, and should not be edited to include it. All flavours of Cumulus provide, in the data sub-folder, a file called '''monthlyfileheader.txt''' which contains the headers appropriate to the release you are running, and you can add that temporarily to your spreadsheet if it helps you with editing, but don't forget to delete it before saving the file ready to make it available to Cumulus.

Here are some other rules to follow when editing the standard log files:
* You can't edit any log file with a word processor, as they add control characters, and other information, that Cumulus cannot understand.
* Editing is straight forward if you use a specialised comma separated value file editor, such editors will split the content by field so it is easy to ensure you only amend field content and do not accidentally change a field divider, plus these editors will not add additional content to any line as they can cope with the number of fields varying in different lines and don't change encoding.
* If you want to use a text editor, it is best if you choose one designed for computer programmers or developers. Such an editor will allow you to select the encoding (Cumulus will be confused by any Byte Order Mark, so select the encoding type without BOM).
* If you choose to use a spreadsheet, ensure that all columns are treated as normal text, do not let (don't accept Excel default) the spreadsheet recognise the first field contains a date as it will convert that column into a number (e.g. days since 1900 or days since 1970). For example in Libre Office make sure that "Detect special numbers" is not selected. Many spreadsheets will offer a CSV option for saving the file (in Libre Office tick "Edit Filter Settings" on "save as ...").
* If you amend a field, ensure that replacement is same format as original (same decimal separator if not integer).
* Ensure no blank lines are introduced by your editing.
*Ensure that all lines continue to have date and time information at the start of the line, and that the format of that identifier is not changed (same sequence, same character(s) separating each element of date, and a colon separating hours and minutes, and that the time does not have a seconds element added.

=General External Editing Rules=

* Take a copy of the file that can be reverted to if there is a subsequent problem, and you have messed up the file that Cumulus (1 or MX) is now trying to use.
* Take another copy and use that for your editing, don't edit the actual file being used by the software.
** This prevents any conflicts between access by the software and access by your script or tool being used to modify the file.
** It also means that you can go back to the last working copy, you can't upset your "revert" copy.
* The file must never be edited with a word processor, as they store many control and identification characters that prevent Cumulus correctly reading the values.
* Generally, it is easiest if you use either a specialised "Comma Separated Value" file editor or a text editor.
** These tools have the advantage that they can cope with different lines having a different number of fields depending on which version number of Cumulus created each line.
* You can use a spreadsheet application, but if you do, there may be a number of settings to change from their defaults to ensure the file remains in a readable format for Cumulus.
** You need to ensure that your spreadsheet treats every column as plain text, don't let it recognise dates or times and convert them into another format, don't let it convert any numeric field into another format
** If you do use a spreadsheet, extra field separators may be added at end of shorter lines as these make all lines end up with same number of fields.
* Don't remove any figures from fields where figures currently exist, simply overtype one entry with another entry in same format.
* If your file has previously been edited by the relevant editor in MX, a field that looks empty may actually contain one or two space characters.
* If you are editing a field which was empty previously, remember that Cumulus does not accept the concept of nulls (entering -999 or "Null"), there is nothing that can be placed as a place-holder when the correct figure is not known, and empty fields are not permitted in one field if any subsequent field in same line is not empty.
**Beware - if you do insert zero or an obviously wrong extreme value, Cumulus will display those in any editing screen where you wish to update the all-time, monthly-all-time, this month, or this year, extremes. This can make editing by picking values in logs harder.
** Cumulus itself will use zero for any parameters (e.g. solar) not provided by your station, and for up to 6 times it will repeat the last valid value if the station fails to send a value it should provide (normally six successive readings will happen between entries in the standard data log, so repeated values are less likely to affect log files).
* The character (or in a few locales, two characters) used for separating both the day of the month from the month, and for separating the month from the year, must be consistent throughout the whole file (and must not be a single space). Normally, the separator will be either "-" or "/". Whether Cumulus expects a hyphen or a slash is determined by the locale, you must keep to the same locale for the whole file, you cannot change the locale when you do an edit, nor when you update the device running Cumulus. Although, use of comma or point for separating parts of the date is in some locales, and therefore allowed by Cumulus, those locale settings are not recommended as these date separators can cause issues for subsequent edits.
* USA date format with month before day of month, and finally year, is not permitted for log files.
* All figures must be within the range of sensible figures for that field (no hour 24 or higher, no signed numbers when accepted values must be positive, don't put in 200 for a relative humidity)
* Make sure that any editing does not create any blank lines in the file. Cumulus assumes an empty line means end of processing.
* Don't add a header line to the file, Cumulus expects all lines to be data lines.
*Be aware that different devices use different line terminators, so ensure that after editing a file, the line terminator is correct for the device that is running Cumulus:
**The single character representing line feed (in most encodings, LF is binary equivalent of a decimal 10) is used for both UNIX and Linux devices (including Raspberry Pi Operating System)
**The single character representing carriage return (in most encodings, CR is binary equivalent of a decimal 13) is used for Apple operating systems (like Mac)
**The two character sequence first CR then LF is used to terminate lines in all Windows operating systems (part of Microsoft's determination to be different)
**Problems with terminating characters are normally intercepted by operating system, before the contents of a line reaches any software like Cumulus, but if partial editing or merging has produced a file with mixed line terminators, there is a high possibility this will stop any software understanding the resulting file, so be careful if you edit the file on a different device to that running Cumulus.
**Finally, if you are going to use a script (such as JavaScript or PHP) to attempt to read a Cumulus file, that script might only recognise a different line terminator to that your device operating system recognises (most likely with processing on a windows device, the script will treat one of the terminating characters (CR) as part of the adjacent field's text, and only treat the LF as a line terminator).

Amending dayfile

2022-08-22T05:55:48Z

Sfws: /* Using CreateMissing.exe editing functionality */ Minor further changes

Cumulus uses a daily summary log file, the fields in that file are listed at [[Dayfile.txt#List_of_Fields]]. The information about amending the file that was originally on the same page has been moved to this page. {{Version badge 1}}When the text was first created (on the other page) it was for the (legacy) Cumulus 1 software. {{Template:Version badge Mx}}As MX was developed, the text here has been amended to keep up, it currently applies up to release 3.12.0.

[[Category:Files_with_Comma_Separated_Values]]
[[Category:Cumulus 1]]
[[Category:Cumulus Files]]

=How Cumulus uses the daily summary log=

While Cumulus is reading your weather station, all daily extremes, counts, and totals, Cumulus needs are stored in [[today.ini]].

==Reading the daily summary log file==

For MX release 3.9.2 - build 3097 onwards, when the software first starts, the whole of '''dayfile.txt''' is read, the contents are used to drive the [[Highcharts_-_Historic]] functionality.

The file is also read, if you are using the editor provided in either Cumulus flavour.

==Writing a new line to the daily summary log file==

At the end of each meteorological day, Cumulus uses information held in '''today.ini''' to write a new line into [[dayfile.txt]], before it resets '''today.ini''' ready for the new day.

Chill Hours Daily Increment for storing in '''dayfile.txt''' is calculated by substracting the cumulative count in [[yesterday.ini]] from the cumulative count in '''today.ini'''.

If rollover, is not at midnight, sunshine hours (these run from midnight to midnight) for the '''dayfile.txt'' are read from '''yesterday.ini'''. For rollover at midnight, sunshine hours from '''today.ini'' (before reset) is read.

= Problems that occur in the daily summary log and how to safely rectify them =

As discussed in [[Correcting_Extremes]], it is possible for rogue values to be read from a weather station, and propagate into various log files. An error in many of those files, corrupts a particular extreme record (or more than one), but generally does not stop Cumulus working.

Since release 3.9.2 (build 3097) MX now reads the entire daily summary log when you start it up. This implies that an error in '''dayfile.txt''' is now always picked up when MX starts, error messages will be added to the latest file in [[MXdiags folder]], but most Cumulus users will not realise there is a problem until they use historic charts (either in the local admin interface, or on a external web server). There is other functionality that uses recent lines in the '''dayfile.txt''' for certain calculations.

== Thoughts required ==

To correct '''dayfile.txt''', you might think the best approach is to look in your [[standard log files|log file]] covering the relevant date, or to use "Create Missing" (which works differently for the legacy software and MX as explained later). Often that is not a good idea, your standard log file might be corrupted as well, and since these log files only record spot values, they miss any extremes occurring between the log entries.

Equally, to stop Cumulus, and make it rewind, may worsen the problem, because you throw away the good data you have on other derivatives just to try to resolve one rogue value.

If you discover the corruption within a few days of it happening, you can make use of an earlier [[Backup folder|back-up]] as explained later.

==Summary for most common problems==

{| class="wikitable" border="1"
|-
!style="width:200px" | Problem
!style="width:300px" | Possible cause
!style="width:300px" | Rectification for MX releases
!style="width:300px" | Rectification for legacy versions
|-
| One, or more, past line(s) accidentally deleted or corrupted
| A mistake during a manual view/edit to the file, or a mistake while using the built-in editor
| See [[#Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software]]
| See [[#Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software]]
|-
| Inconsistencies in date formats (what comes between day of month, month, and year)
| Examples:
# File was previously used with Cumulus 1 (that did not care what symbol came between parts of date)
# Moving from one device to another (and not ensuring same locale on both devices)
# Editing using an external app (like Excel) and treating date cells as date type, should be text type
| Cannot use editor in MX admin interface, for bulk line edits see [[#Correcting date separator errors]]
| Type over individual dates in built-in editor, for bulk line edits see [[#Correcting date separator errors]]
|-
| Inconsistencies between decimal comma and decimal points
| Moving from one device to another (and not ensuring same locale on both devices)
| Correct "locale" and/or use an external editor that offers "Replace all" (see [[#Validation by in-built editors]])
| Use '''Control Panel''' to correct region (that defines decimal symbol). To edit the file, use an external editor that offers "Replace all"
|-
| Inconsistencies in list separator (what comes between fields)
| Moving from one device to another (and not ensuring same locale on both devices)
| Correct "locale" and/or use an external editor that offers "Replace all"
| Use '''Control Panel''' to correct region (that defines list separator). See [[#Using the Cumulus 1 editing feature]] to check file is now consistent.
|-
| Duplication of dates between lines (either consecutive lines, or non-adjacient lines)
| Electrical fault (or manual restart) affecting Cumulus close to rollover time (should not restart within one "standard interval" plus one minute, before or after)
| Use [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|editor in MX admin interface]], amend one line, and delete other
| See [[#Using the Cumulus 1 editing feature]]. Looking at the duplicate lines, correct one line, using information from it or from the duplicates, then click '''Delete''' to remove the uncorrected line(s)
|-
| Lines not in ascending date order
| Example possibilities:
# Bug in some Cumulus 1.9.2 builds sorted lines into wrong order if PC used USA date format (m-d-y), corrected from 1.9.3 onwards
# Restarting Cumulus after a crash, either manually using "Rewind" approach or Cumulus is confused by a corrupted file
| Manual editing outside MX in a text editor, if particular dates appear twice, see [[#Dates restart/repeat]]
| The legacy editor can resequence lines for you, if no duplicates. However, if particular dates appear twice, see [[#Dates restart/repeat]]
|-
| Some lines with fewer fields than others
| As explained at [[Dayfile.txt#List_of_Fields]], as Cumulus has developed, more fields have been added
| Use [[Calculate_Missing_Values#CreateMissing.exe|separate CreateMissing.exe utility]]
| Use workaround described at [[#Legacy Workaround]]
|-
| Some dates (lines) missing
| Examples:
* Inserting data before you start using Cumulus, see [[#Importing data not recorded by Cumulus]]
* Cumulus fails during rollover, so a line is not stored
| Use [[Calculate_Missing_Values#CreateMissing.exe|CreateMissing.exe]]
| Use [[#'''Create Missing''' on legacy dayfile editor]]
|}

== Editors built into Cumulus ==

If you need to view, or edit, a line in the [[dayfile.txt|daily summary log]:
* MX: Use [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|Edit menu in MX's admin interface]]
* C1: Use [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|Edit menu on Main Screen]]

===Validation by in-built editors===

Both the legacy editor and the MX editor will ensure that the correct number of fields is stored (as defined at the release where you do editing) (one common error in an external editor is to accidentally add/delete a field).

The legacy editor will allow you to edit the date field, the MX editor cannot change the date field. The MX editor, reads the file into an array, it uses the array index for all actions on a particular line, and it then writes the array back to the file when you finish editing.

The legacy editor will validate any edit you make to individual fields; it checks for appropriate content (integer, real number, time-stamp).

Unfortunately, '''the editor provided with MX does not validate any fields'''. In MX, the editor will save an edited line, even if there are errors in individual fields:
* you can put inappropriate content in a particular field (integer, real number, time-stamp)
* you can use the wrong separator in fields you do edit (i.e. between hour and minute for time-stamps, or between integer and decimal parts in any real number)

==Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software==

If you have one, or more, dates missing in your dayfile.txt file, then the first question is:
* '''Has the line been deleted by accident?'''
* ''Is the line missing because it was never saved into the file?''

* If a line for a particular date was present before, but is now corrupted or missing:
*# See if you have a back-up of '''dayfile.txt''' with the line present, and correct
*#* If the missing/corrupted line is for a recent date, then Cumulus makes '''a backup of dayfile.txt every time it is restarted and after every end-of-day rollover'''
*#* If the missing/corrupted line is for an older date, then ''maybe you took a back-up onto a separate drive or separate device''
*# If you have a suitable backup available, '''take a copy of that back-up file'''
*# Append onto the copy of the backup, '''any dates after when that copy ends''', taking the extra lines from the current dayfile.txt
*# Rename the current dayfile.txt to say dayfile.old
*# Rename the copy you have edited to dayfile.txt and place into '''[[Data folder|data]]''' sub-folder
*# Cumulus will now use the file with all days correct
* If Cumulus never saved the line in the file in the first place
*# The missing line will not be in any back-up
*# If it is the last line on the file that is missing (i.e. last rollover failed), take a copy of the whole [[data folder]], and keep that copy in a safe place
*# Now look in [[backup folder]], and open the '''daily''' sub-folder
*# If there is a subfolder within "daily" that was successfully created during the rollover that failed, rewind Cumulus by overwriting the contents of '''data'' folder with files from the backup in '''daily''' sub-folder. Restart Cumulus, and let it create a new dayfile.txt line. Stop Cumulus again, restore the original files (except "dayfile.txt) from the copy you put in safe place
*# If the rollover failure meant a backup was not created in the "daily" sub-folder, this will usually be the case, you need to follow instructions for the MX, or legacy, Create Missing

''One lesson here, is to try to remember (once a week), to check your dayfile.txt log file is okay, because Cumulus retains back-ups for only the last 7 days''

'''Another lesson here, is to periodically take your own backup, stored away from your Cumulus running environment in case you ever corrupt an old line'''

==Dates restart/repeat==

If you have a Cumulus crash (either because the connection between the weather station and Cumulus fails; or because there is a unmanaged error in the Cumulus code; or because there is a power issue), then when it restarts it is possible that Cumulus will think it is doing catch-up from an earlier day, and the ''dayfile.txt'' may end up with consecutive lines being in date ascending order until the problem, then jumping back to an earlier date, before continuing in date ascending order (but repeating one, or more, dates already in file).

If Cumulus was working correctly before the problem, then the lines stored before the problem should be okay, just delete the lines that repeat earlier dates, so the file ends up being date ascending order with no duplicates. Similarly, if Cumulus was working correctly after the problem, but there was an issue before the restart, then keep the lines that repeat the dates, but delete the earlier lines with same dates, so the file ends up being date ascending order with no duplicates.

If there are two lines with the date when the problem occurred, then it is likely you will manually have to edit the two lines into one line. Any field with a time-stamp before the problem will be kept unless it is obvious that extreme was correctly broken (i.e. not rogue restart value) after the problem.

If the dates restart in your daily summary log file, because you manually stopped Cumulus close to a rollover time, or you corrupted a file perhaps by regressing to an older release and back; then it is likely you will need to merge the two lines with same date, deciding for each value field which is more likely to be right, and matching it with correct time-stamp. A rainfall (or wind run) total might require summing totals in the two individual lines, or discarding a rouge value and accepting the other, your judgement!

==Correcting date separator errors==

Cumulus uses a format of "day of month in 2 digits", separator, "month number as 2 digits", separator, "last 2 digits of year" in the first field of every line stored in '''dayfile.txt'''. It might be expected that "separator" is consistent throughout the file, because the device/locale when the line is created determines the separator. The problem comes when a user moves their Cumulus installation to a new device, and forgets to ensure that new device uses same (Microsoft Windows PC) region, or (Unix, Linux, and other operating systems) locale, settings.

Historic notes:
*In Cumulus 1 builds, any symbol (including ;, :, /, &, -, and .) character (excluding what is defined as list separator) within the first field of each line was treated as part of separator characters when parsing for date. Thus Cumulus 1 was reasonably tolerant when someone moved to a new device.
*For builds 3000 to build 3049, MX used fixed offsets to find day, month, year in date field. This meant MX could process any file that the legacy software had accepted. The issue was this did not work for locales that used two characters for separator, and with MX now working with far more locales, this proved to be a serious problem.
*From Build 3050 MX uses the separators, defined by the locale, to split the values (so allowing for multi-character separators). The same character(s) had to be used in every line of the file, or this gave a new problem.

Some [[Daily Summary|third party routines]] for reading dayfile.txt take a different approach, they check the first field for the first character that is not a "0 to 9" digit, take that as start of separator, then look for the next "0 to 9" digit, that belongs to next part of the date, so the separator ends at previous character. Other third party routines, ask user what they use as date separator.

=== Date Separator in MX===
MX is fussy, the same separator must be used in every date in the file. An error will be reported in diagnostics, and the historic graphs will stop working if the separator changes from one line to another.
# So look at the last line in the file, that is the character MX expects
# If any earlier line, or lines, uses a different character, then that line, or lines, must be edited, it is best to use an editor designed for programmers
#*If the last line has hyphen "-", but some earlier lines use slash "/", it is simple to do an edit
#** Use "Replace All" option in your chosen editor, to find "/", and replace with "-". This works because "/" does not appear anywhere else in the file
#*If the last line has "/", but some earlier lines have "." or "-" as separator, then the correction is more complex, because you don't want to edit any minus signs or decimal points in any other fields
#** See if your editor accepts "Regular Expressions", then you can look for two matching separators in same field, see [https://cumulus.hosiene.co.uk/viewtopic.php?p=152540#p152540 this forum post].

See [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=18340 this forum thread] for a fuller discussion.

===Date Separator in Legacy Software===
The legacy software accepts any character (except space) as the separator between the day of month, the month, and the year, elements of the date. Therefore Cumulus 1 does not care if that separator is sometimes "/", sometimes "-", and/or sometimes ".".

= Importing data not recorded by Cumulus =

You might have been using your weather station with some other weather software before you installed Cumulus. If you can get weather data in the format of daily summaries (and the rollover times match), you can import that data into the Cumulus '''dayfile.txt''' file using a script or spreadsheet package. All you have to ensure is that you can arrange the output to be in lines with fields in sequence shown in [[Dayfile.txt#List_of_Fields]]. There is more guidance later on this page about the rules you must obey for this file.

If you have imported the data from the other weather software into the [[Standard_log_files]] format, then
* a separate utility "CreateMissing.exe" can create the new rows, for MX users, for those days previously missing in dayfile.txt, as explained below.
* in the Cumulus 1 editor, ''Create missing'' can insert the new rows, for those days previously missing, in dayfile.txt, as explained below.

= Using CumulusMX.exe editing functionality =

The editor in MX can be found in the administrative interface by selecting [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|Data Logs menu and '''Dayfile''' page]]. The '''Dayfile viewer/editor'' will display some lines at a time (e.g. 10 at a time or more). When the page is first loaded, the oldest lines will be read from the file by the Cumulus MX engine, and via an '''application programming interface''' (api) transferred to the web page where the lines are displayed using some software called ''datatables''. That software generates a navigation section where you can navigate to First, Previous, Next, and Last, with (for a longer file) up to 6 page numbers (each containing up to the selected number of lines) that you can select directly.

Basically, this is a text editor, but you have to amend lines using a pop-up, a proposal to use in-line editing never made it into a formal release. Another pop-up is used to confirm dleting a line. The editor does not let you edit the date field. Each line is identified by a line number.

This editor does not provide any way of inserting new lines into dayfile.txt (so you cannot correct an error when MX end of day failed and a line was not created), nor is there any way of changing the dates used by lines in the file (a very common problem reported by Cumulus users is that MX is giving them problems because not all lines in this file use the same format for the date, but this editor cannot resolve that).

There is a '''Refresh''' button that sends a '''application programming interface''' instruction asking the MX engine to resend the lines on the currently selected page via the api.

When you select a line in the provided editor, both '''Edit''' and '''Delete''' buttons are enabled.

Pick '''Edit''', click that, and an editing dialog pops up (MX uses '''altEditor ''' software for this). The pop up window does not let you change the line number nor the date, but all other fields show their current contents and you can overtype as necessary. Scroll down to see 2 buttons (how they are labelled depends on which version you are using), the left hand button ignores any edits you have made (it is labelled 'Close' or "Cancel" and simply does same effect as clicking the "x" in the top right corner), it prevents the api sending any replace message back to the MX engine. The right hand button saves your changes (even if it is labelled 'Edit' rather than "Save" in the version you are using) by using the api to send the replacement array back to the MX engine where it will replace the relevant line number before writing back to the log file.

There is no validation in the MX editor that was set up relatively quickly in version 3.4.5 as the first of 3 log file editors to plug a gap in MX functionality in earlier versions, so you must manually ensure you enter correct data:
* some fields can only accept integers, other expect decimals,
* and some fields can accept negatives, others don't accept signed numbers
* some fields have a minimum and/or maximum acceptable value
* time-stamps must use a colon between the 24 hour time sections for hours and minutes

As all lines are passed back via an application programme interface to the MX engine, there is no validation there either, the new line replaces the old one when the whole file is recreated. It is likely that the next time MX attempts to read the dayfile.txt it will find any error. There was a third-party proposal to add simple validation, as listed above into a replacement editor, as well as adding in-line editing, but it could not be made compatible with the particular third-party modules used by the admin interface at release 3.6.0.

Pick '''Delete''', click that, and a simple dialog pops up (MX uses '''altEditor ''' software for this) showing all the fields in the selected line and asking you to confirm that you want to delete it. Again, the labelling on the buttons varies depending on which version you are running, one confirms the deletion (which sends the array back to the MX engine with an instruction that line number is to be deleted. Despite the MX engine getting a copy of the fields that are to be deleted, it only checks the line number. The button labelled 'Close' or 'Cancel' does the same effect as clicking the "x" in the top right corner, it prevents the api sending any deletion message back to the MX engine.

==Cautions if using an obsolete MX release==

* '''Cumulus MX beta version 3.0.0 (checked at build 3043) does not provide an editor'''
* '''Cumulus MX Version 3.4.5 - Build 3069 onwards provides an editor'''
* From MX release 3.9.2 - b3097 historic charts are added to admin interface
** If you use the in-built editor to update dayfile.txt, your change will be reflected in the historic graphs
** If you edit dayfile.txt outside Cumulus MX, historic graphs will not be updated until Cumulus MX is restarted

If lines in your [[dayfile.txt|daily summary log]] were created by a variety of Cumulus 1 releases (so some have less than 46 fields), you need to use Cumulus MX version 3.7.0, or later, to be sure that the provided editor will cope. The code was actually amended to be able to read lines with fewer fields at version 3.6.0, when 4 fields were added for feels like, so the total number of fields became 50.

It is recommended that nobody uses any 3.6.x version (see [[Updating_MX_to_new_version#If_using_a_3.5.x_release]]. (For historical interest only, Emergency Version 3.6.12 changed the number of fields to 54 in error)

From formal release 3.7.0, MX's dayfile.txt reverted to 52 fields. The extras are Canadian Humidity Index (Humidex). At the time of typing this, it has been said this file structure will not be changed again.

Whatever MX release you use, any line that is edited (even if it originally had fewer or more fields) will be saved with the same number of fields that release uses when it creates a line from the contents of today.ini.

= Using CreateMissing.exe editing functionality=

Basically, this utility will create a new '''dayfile.txt''', if there is already a file with that name it gets renamed, and existing fields are copied across. If there are some dates missing in an existing file it will create new lines ''if data for those missing lines can be derived'' from data already in [[Standard_log_files]]. If an individual line in an existing '''dayfile.txt''' is shorter than the number of fields expected in the current MX release, then '''CreateMissing.exe''' will calculate daily values for the missing fields based on data already in [[Standard_log_files]].

'''You must have installed MX in order to use this utility''', as some information in [[Cumulus.ini]] and some [[Software#By_Mark_Crossley|.dll files]] are shared between CumulusMX.exe and CreateMissing.exe .

''It is important to understand'' that when you start MX interactively, or as a service, it reads the contents of '''dayfile.txt''' into an internal array (held in random access memory - RAM). Therefore, if you run '''CreateMissing.exe''' while ''CumulusMX.exe'' is running, any updates to the file are ''not'' seen by MX until that software is restarted. Release 3.20.0 (beta build 3199 onwards) adds a new "Utils" menu with a new option to refresh the internal values without restarting MX.

Instructions for downloading and running '''CreateMissing.exe''' can be found on [[Calculate_Missing_Values#CreateMissing.exe|another Wiki page]] and most of the information there is not repeated here.

The developer includes brief installation and running instructions at https://github.com/cumulusmx/CreateMissing/blob/master/README.md.

= Using the Cumulus 1 editing feature =

{{Version badge 1}}'''This section applies to Cumulus 1.x.y only'''. The last command in '''Edit''' [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu |menu]] is ''dayfile.txt''.

''This is how you view'' the dayfile.txt from within Cumulus. Click the ''Help'' button for detailed instructions. Cumulus Help is concise but comprehensive.

It is a text editor, and it works best when at full screen:
*correct individual values by over-typing new values over those currently displayed,
*you can use '''insert''' key to add one or more missing rows (complete days) manually typing in values for all fields,
*use '''delete''' key to remove an entire day (e.g. if you get a 'duplicate' error message) after ensuring all fields are correct in the line that will remain,
*use '''Create missing''' button to insert missing rows (complete days) by reading from [[Standard_log_files]] and automatically calculating the best approximations for each field for those missing days (see next section)

== '''Create Missing''' on legacy dayfile editor ==

If a date is missing from dayfile.txt, and not available in a back-up, then it is possible to create a missing line (with approximations for the derived extreme values) in Cumulus 1. That functionality is known as "Create Missing" and is found [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|within the edit dayfile.txt screen]].
#Only use the editor when Cumulus is '''not''' doing catch-up or end-of-day, or any other action that could create an editing conflict.
#With the contents of the file loaded into the editing table, click the '''Create Missing''' button
#Cumulus 1 will now work through every line from start to end
#If 2 adjacent lines are not for consecutive dates, Cumulus will attempt to create missing lines
#It will read from the [[Standard log files]] all the data logged for each missing meteorological date (if 9am or 10am rollover is used, those read spans two calendar dates)
#It will derive totals, averages, highs, and lows, from the data it reads, for each missing date
#*Note that normally dayfile.txt lines are created from [[Today.ini]] which logs the daily totals, averages, highs, and lows, from every reading taken from the weather station
#*Depending on your weather station, Cumulus is able to read values at least every minute (maybe every 10 seconds), and consequently update [[today.ini]] frequently (each minute in Legacy Cumulus/each logging interval in MX) if an extreme happens,
#*If Cumulus is set up to only log the readings every half an hour, create missing is only able to see 1/30th (maybe 1/120th depending on weather station reading frequency) of the data,
#* Due to this mismatch, the derived values (averages, highs, lows) this approach can store are much less accurate (hence why getting missing lines from a backup is better)

The Cumulus 1 editor provides a "Create Missing" option where it will, for any dates for which a line does not exist, create a line if it can from reading the [[Monthly log files|detailed log file]] to extract all values relevant to that day and do the necessary minimum/maximum/total/average calculation for each dayfile.txt field, storing the time from the relevant other log file in any time-stamp field in dayfile.txt.

If a particular day does not exist as a row on the daily summary log, then 'create missing' can search the observations in the relevant monthly log, and calculate approximate highs, lows and totals to insert as an extra row in the daily summary log. These are approximate because the actual highs and lows for that day are quite likely to have occurred at moments in-between those that were logged.

For the legacy ''Create missing'' a list of inserted records is produced in [[dayfileeditlog.txt]].

If just some fields are wrong in a particular row (meteorological day) on day file, then there is a [[Standard_log_files#Using_Monthly_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | work around]] as at all current versions (up to 1.9.4) you can only use 'Create missing' to read from the [[Standard_log_files]] if the whole day (a line starting with that date) is missing in ''dayfile.txt''. Although Cumulus does not recognise the concept of a sensor not being available, it will write solar information even if you don't have a solar sensor; it does have to cope with reading a monthly log file that might have fewer derivatives than it wants (when using Create Missing) and therefore it may not know what to write into dayfile.txt as the calculated value. Cumulus 1 can't write a null value, so it writes zero for values, and "00:00" for time stamps. If you are using a 9am or 10am rollover time, be aware that create missing in Cumulus 1 always inserts 00:00 for null time-stamps, but in normal running Cumulus uses the rollover time for null time-stamps.

== Dealing with errors identified by the legacy software ==

If there is an error in ''dayfile.txt'', then it is most likely to be found when you are viewing its data on one of the screens for editing the monthly, annual or all-time extremes. Cumulus 1 will illuminate its ''Error'' light if it finds an error in such cases and tell you the line/row number of the first found error, together with some details of the error it found. For example, if a row is blank, a row is duplicated, a field is corrupted, a field does not have an acceptable value, or a field is missing so subsequent fields are to the left of where they should be.

If you do have a 'duplicate' error, you need to decide which row to ''delete'', and whether to copy any values from that row into the row you are keeping to ensure the correct extremes are retained.

==Correcting individual fields in multiple dayfile.txt lines==

Often people want to correct an individual field, in all lines within a particular period.

The most common example is because you have suddenly discovered your daily pressure high (and low) are wrong by a certain offset, because you used the wrong setting for converting absolute pressure to the sea level equivalent you want to store in the file.

Neither Cumulus 1 nor MX provide any functionality to make such multi-line editing easy.

However, this can be resolved by opening dayfile.txt in a spreadsheet (carefully ensuring each column is treated as either '''text''' (date and time fields) or number (the value fields) and that '''your field separator''' is set in the '''filter conditions''' to be a column separator for converting to spreadsheet. Spreadsheets have a "Paste Special" function that allows you to add/subtract a constant to every cell in a column.

===Correcting individual fields in multiple lines of Daily summary Log in Cumulus 1===

In the '''Edit''' menu, select '''Dayfile.txt''' screen, for a text editor where you can overwrite entries, delete entire lines, and insert new lines (and then manually type in values for every field). You can scroll left and right between fields, with a header row identifying which field is which, and you can scroll up and down through all the lines. If you know what you want to change (such as replacing a rogue figure), this is a very easy to use editor.

For the daily summary log, the original Cumulus software includes functionality to '''Create Missing''' in its daily summary log editor, see [[# '''Create Missing''' on legacy dayfile editor]]. This functionality creates '''an entire missing log line'' and will insert highs and lows whether they are extremes of source values, or extremes of derived values. It will only add those fields (to any new line) that are maximum or minimum (or sum, or equal to) a field that does exist in the [[Standard_log_files]] lines that belong to the same meteorological day.

==Legacy Workaround==

The legacy Cumulus 1 functionality is not designed to insert (or correct) individual missing extreme figures for daily summary lines that already have some fields in them, only to insert complete missing lines. However, we can workaround that constraint:

'''WORKAROUND FOR DAYFILE.TXT if required dates are present in both the standard log and dayfile.txt, but not all fields for that date exist in dayfile.txt'''

There are two common reasons for needing to use this, Cumulus 1 only, workaround:
# To add extra derived fields now calculated by Cumulus, to past lines created by an earlier version of Cumulus that did not calculate those derived fields at the time
# If you are importing into Cumulus records from other software, and that other software does not provide derived extremes (e.g. dew point, apparent temperature, heat index, rain rate, wind run) so your insert in the daily summary log file has only populated a sub-set of the fields.

The steps you need to take, to implement this Cumulus 1 only workaround:
#Select a time to do this work that is at least 10 minutes, preferably a whole hour, after Cumulus has performed a daily rollover, and ensure you finish this work long before the next rollover time. This will ensure your work cannot conflict with when Cumulus 1 is updating dayfile.txt.
# Take a copy of dayfile.txt original as backup,
# Use the Cumulus 1 editor (in '''Edit''' menu, select '''Dayfile.txt''' screen), and let it edit the original file
# Delete any days with partial information (e.g. from Cumulus versions that created fewer fields)
# Click the ''Create Missing'' button
# Wait while Cumulus scans all the standard log files, and for each source or derived field in those files, tracks the highest and lowest for each meteorological day that is now missing in dayfile.txt.
#* As an aside, be aware that when the contents of [[today.ini]] was used to create a new line in dayfile.txt originally, the high and low that were copied across were derived from all source values that Cumulus obtained from your weather station (this will usually be at least once a minute, depending on your weather station type it might be around every ten seconds; some weather stations provide new readings less frequently, some provide them more frequently).
#*Continuing this aside, the high and low that Cumulus is now deriving are based purely on those values stored in the [[Standard log files|standard data log]], by default that is just every 10 minutes, but it might be only every 30 minutes.
#The new lines that Cumulus 1 adds to your dayfile.txt while you use the editor, are also added to another log file '''dayfileeditlog.txt''', so we can access that to track the new values.
#For simplicity, click '''OK''' to save the edited '''dayfile.txt''' file, and exit the editor.
#Rename the amended dayfile.txt as "dayfile(generated).txt".
#Create an empty text file in a suitable temporary directory, and name it "dayfile.txt",
#Use an external editor to open your empty file.
#*You can use a Comma Separated Value file editor, although you will find this difficult starting with an empty file
#*You can use an editor designed for computer programmers or developers that can edit text file
#*You can use a spreadsheet application, such as "Libre Office Calc" or "Microsoft Excel", providing you obey the editing rules defined later
#You should first merge in (as read-only text) the previous contents of the original dayfile.txt from the copy taken in step 2, although you could skip the fields you have updated, that makes it more complicated!
#You should next merge in (where there are fields to be updated or previously missing) ''just those fields from the respective lines'' in either "dayfile(generated).txt", or '''dayfileeditlog.txt''' (whichever you find easier to use, the latter has fewer lines so it may be easier to use).
#Finally, copy your temporary "dayfile.txt" into the "Cumulus\data" folder, so from now on Cumulus accesses the file with the maximum number of fields present.

One note of caution:
*If a required source or derived value is not present in the standard data log lines, Cumulus will write into related dayfile.txt fields zero for values, and in the editor "00:00" (in normal running it would insert your rollover time) for time stamps, because it does not understand the concept of "Null".
*Cumulus 1 does not have the functionality to retrospectively calculate derived values (e.g. cannot work out apparent temperature) when it is reading source values (e.g. temperature, humidity, wind speed) in the standard data log line.

= Important Rules when editing dayfile.txt =

If you are editing dayfile.txt outside the Cumulus 1 or MX software, there is the danger of changing something that prevents Cumulus from understanding the file when it next tries to use it.

== Warning if editing outside MX ==

You need to understand the following difference between the legacy Cumulus 1 and MX. In the legacy software (and early MX releases), "dayfile.txt" is read by the software if any output reports past days. In later MX releases, the only time the file is read is when the software is restarted, it is not read again.

From MX release 3.9.2 - b3097, Historic Charts were added to both the interface and the default web pages. As a consequence, when you start MX in this release (or any subsequent release), the entire content of dayfile.txt is held internally (i.e. in RAM), and it is these internally held values that are used by the .json api/files that feed these [[Highcharts - Historic]] plots. MX will append an additional array when it stores a new line in the file. The MX in-built editor actually displays/edits the internally held data, and then writes back (including any deletions or edits) that internal array into the file.

'''Prior''' to release 3.20.0 - b3200, if you were to edit the "dayfile.txt" using an external editor without stopping MX, any change you make is not seen by internal array, and such external edits would be lost should you (in the same MX session) use the internal editor. To propagate your external edits, you need to first stop, and then restart MX, and then the internal array will match the file.

''From release 3.20.0 - b3200,'' there is a utility provided that can copy what is held in the daily summary log file and update the internal array. Access this utility from the '''"Utils" menu''' added to the interface at this release.

== General Editing Rules ==

These rules should be followed whatever Cumulus file you edit externally.

# Take a copy of the file that can be reverted to if there is a subsequent problem, and you have messed up the file that Cumulus (1 or MX) is now trying to use.
# Take another copy and use that for your editing, don't edit the actual file being used by the software.
#*This prevents any conflicts between access by the software and access by your script or tool being used to modify the file.
#*It also means that you can go back to the last working copy, you can't upset your "revert" copy.
#The file must never be edited with a word processor, as they store many control and identification characters that prevent Cumulus correctly reading the values.
#* It is recommended that you use either a specialised "Comma Separated Value" file editor or a text editor, both of these can be easily used.
#** These tools have the advantage that they can cope with different lines having a different number of fields depending on which version number of Cumulus created each line.
#*You can use a spreadsheet tool, but if you do, there may be a number of settings to change from their defaults to ensure the file remains in a readable format for Cumulus.
#**If you do use a spreadsheet, extra field separators may be added at end of shorter lines as these make all lines end up with same number of fields.
#*Don't remove any figures from fields where figures currently exist, only change one entry into another entry in same format.
#Cumulus does not accept the concept of nulls, there is nothing that can be placed as a place-holder when the correct figure is not known, and empty fields are not permitted.
#All figures must be within the range of sensible figures for that field (e.g. no hour 24 or higher, no signed numbers when accepted values must be positive, don't put in any number over 100 for a relative humidity)
# Make sure that any editing does not create any ''blank lines'' in the file. Cumulus assumes an empty line means end of processing. Also ensure all lines have same end of line characters, this is one way accidental blank lines can be inserted!
# Don't include any header line in the file, Cumulus expects all lines to be data lines.

=== File specific Editing Rules ===

These additional (above rules still apply) rules are specific to any external editing of "dayfile.txt".

[[File:Open office (editing cumulus log files).png| right]]
# The file should be saved without "Byte Order Mark", specialised text editors will include a menu where you select the encoding and can select not to include BOM. (If you are using old software, both Microsoft and Google editors, used to insert BOM automatically).
# All rows must ''start with date'' as a text field (not a date formatted field) and include at least 14 further fields ''in correct sequence''.
# Remember the month must be the middle figure in the text field representing date, USA date convention cannot apply within this logfile.
#The separator between the three parts of the date should be a '-' hyphen or a '/' slash, it cannot be a space.
#*Whether Cumulus expects a hyphen or a slash is determined by the locale, you must keep to the same locale for the whole file, you cannot change the locale when you do an edit, nor when you update the device running Cumulus.
#*Although, use of comma or point for separating parts of the date is in some locales, and therefore allowed by Cumulus, those locale settings are not recommended as these date separators can cause issues for subsequent edits.
#* If you move your software (any flavour) to a new device, or you change from Cumulus 1 to Cumulus MX (or back), then you must ensure your dates still use the same separator, so all lines are consistent.
# The (meteorological) date format, in this text field, uses ''two digits for the year'':
#*This is one reason why you need to edit this file using an editor that treats all fields as text (a text editor, a CSV editor, or a spreadsheet program that can be instructed ''not'' to recognise special field types).
#*For spreadsheet tools (e.g. '''Calc''' in Libre Office, or Microsoft's '''Excel''') avoid using default of recognising formats, ensure that such recognition is turned off (see image), as it is likely to change the dates to either a number representing days since e.g. 31 Dec 1899, or to change it to four figure years, in either case Cumulus will no longer be able to use the log file.
# Each of the fields from date to the end of the line are separated using the list separator (e.g. a comma or semi-colon) defined for your device. After your editing it must still match what your existing dayfile.txt uses.
#* If you wish to use Excel, or to use "Calc" in 'Apache Open Office', "Libre Office", or similar, you may on opening the file need to pre-select the field separator that is being used now (in this illustration comma is selected, but your file might use semi-colons between fields, don't select commas if your real numbers use comma between integer and decimal parts) and leave "Detect Special Numbers" (or whatever similar feature name your tool uses) unselected. Again third party packages processing dayfile.txt will need to recognise your field separator, and some may need to specify it. Don't forget to also select it when you save the edited file (you probably need to select "save as" or the equivalent in your tool to see the option).
# Rows can vary in length but only by missing off ''fields at the end''. The minimum number of fields after the date is 14, the maximum varies between different Cumulus releases.
#* (The variation between maximum number of fields may cause a problem, if you regress to an earlier release!)
# Each field has a pre-defined format, and the same format must always be used in that field position.
#No fields will accept letters.
#*Some fields (e.g. bearings, solar, humidity) are ''integers'' (see [[#List_of_fields_in_the_file]]) only take integers. Decimals are not allowed in an integer field, so no comma or full-stop can be within these fields.
#* Most value fields are in ''real number format'' using your system/locale decimal notation ("x.y" or "x,y"). Trailing zeroes are not required, so you can put an integer in a real number field, you don't have to have a decimal comma or decimal point.
# Although only the date and 14 other fields are mandatory, you cannot skip some fields defaulting them to null is not allowed, so you cannot add fields at the end, without adding all earlier fields.
#when you do add fields beyond the 14, or however many already exist, be aware that for most derivatives what you add will represent a ''lowest or highest value'' and that must be paired with a time-stamp in the next field.
#* Cumulus will only accept highest/lowest figures if each value has any related time-stamp.
# Time stamp fields must always be in ''format HH:mm'' i.e. 2 digit hour in 24-hour format, followed by a colon, then 2 digit minutes
#**Be aware you will have problems if you, or your editing software, add seconds.
#* If when editing, you don't know what time to quote, the convention is to use a time-stamp of your roll over time i.e. 00:00, 09:00, or 10:00, if you have not looked up the precise time.
#* Except for wind gust (start of line) where an extra field is fitted in, each time field will immediately follow the value field for that parameter.
# Shorter lines can have multiple field separators added at end of row added either when editing within Cumulus or when editing using a spreadsheet tool.
#* Nulls (2 field separators without something between them ',,') are thus allowed at end of line, but are not allowed within the part of the line with values and time-stamps.
#*If you are editing out rogue values and if you do not know the value for a particular field within the line, then type in a zero or 9999 for nulls in integer format and an extreme with opposite value (e.g. -999.9 for a signed decimal maximum, and 9999.9 for a decimal minimum) for nulls in decimal format (replace the full stops with your decimal separator).
#*Beware - if you do insert zero or an obviously wrong extreme value, Cumulus will display those in any editing screen where you wish to update the all-time, monthly-all-time, this month, or this year, extremes. This can make editing by picking values in logs harder.
#Cumulus itself will use zero for any parameters (e.g. solar) not provided by your station, and will repeat the last valid value if the station fails to send a value it should provide, so if a station fails to send a value for more than a day, dayfile.txt may show the same value as the previous day.
#* Note that Cumulus will stop if your station fails to send what it considers as a vital reading, like pressure or temperature, so the previous point does not apply in all cases.
# The row terminator for Windows is ''CR LF'' (a combination of Carriage Return represented in many [[Reports_folder#Encoding|character set encodings]] by the binary equivalent of decimal 13), and Line Feed represented in many character set encodings by the binary equivalent of decimal 10), ensure any external editor does not change the two character terminator into a single character. Similar rules apply for single character terminators used by other operating systems (Linux uses LF only, Mac uses CR only), don't let any editor you use change a single character terminator into its double character terminator.
#*Problems with terminating characters are intercepted by operating system, before it reaches the software, but may still stop the software understanding the resulting file, so be careful if you edit the file on a different device to that running Cumulus.

Amending dayfile

2022-08-22T05:41:38Z

Sfws: /* Using CreateMissing.exe editing functionality */ Mention new 3.20.0 functionality to refresh the RAM content

Cumulus uses a daily summary log file, the fields in that file are listed at [[Dayfile.txt#List_of_Fields]]. The information about amending the file that was originally on the same page has been moved to this page. {{Version badge 1}}When the text was first created (on the other page) it was for the (legacy) Cumulus 1 software. {{Template:Version badge Mx}}As MX was developed, the text here has been amended to keep up, it currently applies up to release 3.12.0.

[[Category:Files_with_Comma_Separated_Values]]
[[Category:Cumulus 1]]
[[Category:Cumulus Files]]

=How Cumulus uses the daily summary log=

While Cumulus is reading your weather station, all daily extremes, counts, and totals, Cumulus needs are stored in [[today.ini]].

==Reading the daily summary log file==

For MX release 3.9.2 - build 3097 onwards, when the software first starts, the whole of '''dayfile.txt''' is read, the contents are used to drive the [[Highcharts_-_Historic]] functionality.

The file is also read, if you are using the editor provided in either Cumulus flavour.

==Writing a new line to the daily summary log file==

At the end of each meteorological day, Cumulus uses information held in '''today.ini''' to write a new line into [[dayfile.txt]], before it resets '''today.ini''' ready for the new day.

Chill Hours Daily Increment for storing in '''dayfile.txt''' is calculated by substracting the cumulative count in [[yesterday.ini]] from the cumulative count in '''today.ini'''.

If rollover, is not at midnight, sunshine hours (these run from midnight to midnight) for the '''dayfile.txt'' are read from '''yesterday.ini'''. For rollover at midnight, sunshine hours from '''today.ini'' (before reset) is read.

= Problems that occur in the daily summary log and how to safely rectify them =

As discussed in [[Correcting_Extremes]], it is possible for rogue values to be read from a weather station, and propagate into various log files. An error in many of those files, corrupts a particular extreme record (or more than one), but generally does not stop Cumulus working.

Since release 3.9.2 (build 3097) MX now reads the entire daily summary log when you start it up. This implies that an error in '''dayfile.txt''' is now always picked up when MX starts, error messages will be added to the latest file in [[MXdiags folder]], but most Cumulus users will not realise there is a problem until they use historic charts (either in the local admin interface, or on a external web server). There is other functionality that uses recent lines in the '''dayfile.txt''' for certain calculations.

== Thoughts required ==

To correct '''dayfile.txt''', you might think the best approach is to look in your [[standard log files|log file]] covering the relevant date, or to use "Create Missing" (which works differently for the legacy software and MX as explained later). Often that is not a good idea, your standard log file might be corrupted as well, and since these log files only record spot values, they miss any extremes occurring between the log entries.

Equally, to stop Cumulus, and make it rewind, may worsen the problem, because you throw away the good data you have on other derivatives just to try to resolve one rogue value.

If you discover the corruption within a few days of it happening, you can make use of an earlier [[Backup folder|back-up]] as explained later.

==Summary for most common problems==

{| class="wikitable" border="1"
|-
!style="width:200px" | Problem
!style="width:300px" | Possible cause
!style="width:300px" | Rectification for MX releases
!style="width:300px" | Rectification for legacy versions
|-
| One, or more, past line(s) accidentally deleted or corrupted
| A mistake during a manual view/edit to the file, or a mistake while using the built-in editor
| See [[#Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software]]
| See [[#Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software]]
|-
| Inconsistencies in date formats (what comes between day of month, month, and year)
| Examples:
# File was previously used with Cumulus 1 (that did not care what symbol came between parts of date)
# Moving from one device to another (and not ensuring same locale on both devices)
# Editing using an external app (like Excel) and treating date cells as date type, should be text type
| Cannot use editor in MX admin interface, for bulk line edits see [[#Correcting date separator errors]]
| Type over individual dates in built-in editor, for bulk line edits see [[#Correcting date separator errors]]
|-
| Inconsistencies between decimal comma and decimal points
| Moving from one device to another (and not ensuring same locale on both devices)
| Correct "locale" and/or use an external editor that offers "Replace all" (see [[#Validation by in-built editors]])
| Use '''Control Panel''' to correct region (that defines decimal symbol). To edit the file, use an external editor that offers "Replace all"
|-
| Inconsistencies in list separator (what comes between fields)
| Moving from one device to another (and not ensuring same locale on both devices)
| Correct "locale" and/or use an external editor that offers "Replace all"
| Use '''Control Panel''' to correct region (that defines list separator). See [[#Using the Cumulus 1 editing feature]] to check file is now consistent.
|-
| Duplication of dates between lines (either consecutive lines, or non-adjacient lines)
| Electrical fault (or manual restart) affecting Cumulus close to rollover time (should not restart within one "standard interval" plus one minute, before or after)
| Use [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|editor in MX admin interface]], amend one line, and delete other
| See [[#Using the Cumulus 1 editing feature]]. Looking at the duplicate lines, correct one line, using information from it or from the duplicates, then click '''Delete''' to remove the uncorrected line(s)
|-
| Lines not in ascending date order
| Example possibilities:
# Bug in some Cumulus 1.9.2 builds sorted lines into wrong order if PC used USA date format (m-d-y), corrected from 1.9.3 onwards
# Restarting Cumulus after a crash, either manually using "Rewind" approach or Cumulus is confused by a corrupted file
| Manual editing outside MX in a text editor, if particular dates appear twice, see [[#Dates restart/repeat]]
| The legacy editor can resequence lines for you, if no duplicates. However, if particular dates appear twice, see [[#Dates restart/repeat]]
|-
| Some lines with fewer fields than others
| As explained at [[Dayfile.txt#List_of_Fields]], as Cumulus has developed, more fields have been added
| Use [[Calculate_Missing_Values#CreateMissing.exe|separate CreateMissing.exe utility]]
| Use workaround described at [[#Legacy Workaround]]
|-
| Some dates (lines) missing
| Examples:
* Inserting data before you start using Cumulus, see [[#Importing data not recorded by Cumulus]]
* Cumulus fails during rollover, so a line is not stored
| Use [[Calculate_Missing_Values#CreateMissing.exe|CreateMissing.exe]]
| Use [[#'''Create Missing''' on legacy dayfile editor]]
|}

== Editors built into Cumulus ==

If you need to view, or edit, a line in the [[dayfile.txt|daily summary log]:
* MX: Use [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|Edit menu in MX's admin interface]]
* C1: Use [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|Edit menu on Main Screen]]

===Validation by in-built editors===

Both the legacy editor and the MX editor will ensure that the correct number of fields is stored (as defined at the release where you do editing) (one common error in an external editor is to accidentally add/delete a field).

The legacy editor will allow you to edit the date field, the MX editor cannot change the date field. The MX editor, reads the file into an array, it uses the array index for all actions on a particular line, and it then writes the array back to the file when you finish editing.

The legacy editor will validate any edit you make to individual fields; it checks for appropriate content (integer, real number, time-stamp).

Unfortunately, '''the editor provided with MX does not validate any fields'''. In MX, the editor will save an edited line, even if there are errors in individual fields:
* you can put inappropriate content in a particular field (integer, real number, time-stamp)
* you can use the wrong separator in fields you do edit (i.e. between hour and minute for time-stamps, or between integer and decimal parts in any real number)

==Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software==

If you have one, or more, dates missing in your dayfile.txt file, then the first question is:
* '''Has the line been deleted by accident?'''
* ''Is the line missing because it was never saved into the file?''

* If a line for a particular date was present before, but is now corrupted or missing:
*# See if you have a back-up of '''dayfile.txt''' with the line present, and correct
*#* If the missing/corrupted line is for a recent date, then Cumulus makes '''a backup of dayfile.txt every time it is restarted and after every end-of-day rollover'''
*#* If the missing/corrupted line is for an older date, then ''maybe you took a back-up onto a separate drive or separate device''
*# If you have a suitable backup available, '''take a copy of that back-up file'''
*# Append onto the copy of the backup, '''any dates after when that copy ends''', taking the extra lines from the current dayfile.txt
*# Rename the current dayfile.txt to say dayfile.old
*# Rename the copy you have edited to dayfile.txt and place into '''[[Data folder|data]]''' sub-folder
*# Cumulus will now use the file with all days correct
* If Cumulus never saved the line in the file in the first place
*# The missing line will not be in any back-up
*# If it is the last line on the file that is missing (i.e. last rollover failed), take a copy of the whole [[data folder]], and keep that copy in a safe place
*# Now look in [[backup folder]], and open the '''daily''' sub-folder
*# If there is a subfolder within "daily" that was successfully created during the rollover that failed, rewind Cumulus by overwriting the contents of '''data'' folder with files from the backup in '''daily''' sub-folder. Restart Cumulus, and let it create a new dayfile.txt line. Stop Cumulus again, restore the original files (except "dayfile.txt) from the copy you put in safe place
*# If the rollover failure meant a backup was not created in the "daily" sub-folder, this will usually be the case, you need to follow instructions for the MX, or legacy, Create Missing

''One lesson here, is to try to remember (once a week), to check your dayfile.txt log file is okay, because Cumulus retains back-ups for only the last 7 days''

'''Another lesson here, is to periodically take your own backup, stored away from your Cumulus running environment in case you ever corrupt an old line'''

==Dates restart/repeat==

If you have a Cumulus crash (either because the connection between the weather station and Cumulus fails; or because there is a unmanaged error in the Cumulus code; or because there is a power issue), then when it restarts it is possible that Cumulus will think it is doing catch-up from an earlier day, and the ''dayfile.txt'' may end up with consecutive lines being in date ascending order until the problem, then jumping back to an earlier date, before continuing in date ascending order (but repeating one, or more, dates already in file).

If Cumulus was working correctly before the problem, then the lines stored before the problem should be okay, just delete the lines that repeat earlier dates, so the file ends up being date ascending order with no duplicates. Similarly, if Cumulus was working correctly after the problem, but there was an issue before the restart, then keep the lines that repeat the dates, but delete the earlier lines with same dates, so the file ends up being date ascending order with no duplicates.

If there are two lines with the date when the problem occurred, then it is likely you will manually have to edit the two lines into one line. Any field with a time-stamp before the problem will be kept unless it is obvious that extreme was correctly broken (i.e. not rogue restart value) after the problem.

If the dates restart in your daily summary log file, because you manually stopped Cumulus close to a rollover time, or you corrupted a file perhaps by regressing to an older release and back; then it is likely you will need to merge the two lines with same date, deciding for each value field which is more likely to be right, and matching it with correct time-stamp. A rainfall (or wind run) total might require summing totals in the two individual lines, or discarding a rouge value and accepting the other, your judgement!

==Correcting date separator errors==

Cumulus uses a format of "day of month in 2 digits", separator, "month number as 2 digits", separator, "last 2 digits of year" in the first field of every line stored in '''dayfile.txt'''. It might be expected that "separator" is consistent throughout the file, because the device/locale when the line is created determines the separator. The problem comes when a user moves their Cumulus installation to a new device, and forgets to ensure that new device uses same (Microsoft Windows PC) region, or (Unix, Linux, and other operating systems) locale, settings.

Historic notes:
*In Cumulus 1 builds, any symbol (including ;, :, /, &, -, and .) character (excluding what is defined as list separator) within the first field of each line was treated as part of separator characters when parsing for date. Thus Cumulus 1 was reasonably tolerant when someone moved to a new device.
*For builds 3000 to build 3049, MX used fixed offsets to find day, month, year in date field. This meant MX could process any file that the legacy software had accepted. The issue was this did not work for locales that used two characters for separator, and with MX now working with far more locales, this proved to be a serious problem.
*From Build 3050 MX uses the separators, defined by the locale, to split the values (so allowing for multi-character separators). The same character(s) had to be used in every line of the file, or this gave a new problem.

Some [[Daily Summary|third party routines]] for reading dayfile.txt take a different approach, they check the first field for the first character that is not a "0 to 9" digit, take that as start of separator, then look for the next "0 to 9" digit, that belongs to next part of the date, so the separator ends at previous character. Other third party routines, ask user what they use as date separator.

=== Date Separator in MX===
MX is fussy, the same separator must be used in every date in the file. An error will be reported in diagnostics, and the historic graphs will stop working if the separator changes from one line to another.
# So look at the last line in the file, that is the character MX expects
# If any earlier line, or lines, uses a different character, then that line, or lines, must be edited, it is best to use an editor designed for programmers
#*If the last line has hyphen "-", but some earlier lines use slash "/", it is simple to do an edit
#** Use "Replace All" option in your chosen editor, to find "/", and replace with "-". This works because "/" does not appear anywhere else in the file
#*If the last line has "/", but some earlier lines have "." or "-" as separator, then the correction is more complex, because you don't want to edit any minus signs or decimal points in any other fields
#** See if your editor accepts "Regular Expressions", then you can look for two matching separators in same field, see [https://cumulus.hosiene.co.uk/viewtopic.php?p=152540#p152540 this forum post].

See [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=18340 this forum thread] for a fuller discussion.

===Date Separator in Legacy Software===
The legacy software accepts any character (except space) as the separator between the day of month, the month, and the year, elements of the date. Therefore Cumulus 1 does not care if that separator is sometimes "/", sometimes "-", and/or sometimes ".".

= Importing data not recorded by Cumulus =

You might have been using your weather station with some other weather software before you installed Cumulus. If you can get weather data in the format of daily summaries (and the rollover times match), you can import that data into the Cumulus '''dayfile.txt''' file using a script or spreadsheet package. All you have to ensure is that you can arrange the output to be in lines with fields in sequence shown in [[Dayfile.txt#List_of_Fields]]. There is more guidance later on this page about the rules you must obey for this file.

If you have imported the data from the other weather software into the [[Standard_log_files]] format, then
* a separate utility "CreateMissing.exe" can create the new rows, for MX users, for those days previously missing in dayfile.txt, as explained below.
* in the Cumulus 1 editor, ''Create missing'' can insert the new rows, for those days previously missing, in dayfile.txt, as explained below.

= Using CumulusMX.exe editing functionality =

The editor in MX can be found in the administrative interface by selecting [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|Data Logs menu and '''Dayfile''' page]]. The '''Dayfile viewer/editor'' will display some lines at a time (e.g. 10 at a time or more). When the page is first loaded, the oldest lines will be read from the file by the Cumulus MX engine, and via an '''application programming interface''' (api) transferred to the web page where the lines are displayed using some software called ''datatables''. That software generates a navigation section where you can navigate to First, Previous, Next, and Last, with (for a longer file) up to 6 page numbers (each containing up to the selected number of lines) that you can select directly.

Basically, this is a text editor, but you have to amend lines using a pop-up, a proposal to use in-line editing never made it into a formal release. Another pop-up is used to confirm dleting a line. The editor does not let you edit the date field. Each line is identified by a line number.

This editor does not provide any way of inserting new lines into dayfile.txt (so you cannot correct an error when MX end of day failed and a line was not created), nor is there any way of changing the dates used by lines in the file (a very common problem reported by Cumulus users is that MX is giving them problems because not all lines in this file use the same format for the date, but this editor cannot resolve that).

There is a '''Refresh''' button that sends a '''application programming interface''' instruction asking the MX engine to resend the lines on the currently selected page via the api.

When you select a line in the provided editor, both '''Edit''' and '''Delete''' buttons are enabled.

Pick '''Edit''', click that, and an editing dialog pops up (MX uses '''altEditor ''' software for this). The pop up window does not let you change the line number nor the date, but all other fields show their current contents and you can overtype as necessary. Scroll down to see 2 buttons (how they are labelled depends on which version you are using), the left hand button ignores any edits you have made (it is labelled 'Close' or "Cancel" and simply does same effect as clicking the "x" in the top right corner), it prevents the api sending any replace message back to the MX engine. The right hand button saves your changes (even if it is labelled 'Edit' rather than "Save" in the version you are using) by using the api to send the replacement array back to the MX engine where it will replace the relevant line number before writing back to the log file.

There is no validation in the MX editor that was set up relatively quickly in version 3.4.5 as the first of 3 log file editors to plug a gap in MX functionality in earlier versions, so you must manually ensure you enter correct data:
* some fields can only accept integers, other expect decimals,
* and some fields can accept negatives, others don't accept signed numbers
* some fields have a minimum and/or maximum acceptable value
* time-stamps must use a colon between the 24 hour time sections for hours and minutes

As all lines are passed back via an application programme interface to the MX engine, there is no validation there either, the new line replaces the old one when the whole file is recreated. It is likely that the next time MX attempts to read the dayfile.txt it will find any error. There was a third-party proposal to add simple validation, as listed above into a replacement editor, as well as adding in-line editing, but it could not be made compatible with the particular third-party modules used by the admin interface at release 3.6.0.

Pick '''Delete''', click that, and a simple dialog pops up (MX uses '''altEditor ''' software for this) showing all the fields in the selected line and asking you to confirm that you want to delete it. Again, the labelling on the buttons varies depending on which version you are running, one confirms the deletion (which sends the array back to the MX engine with an instruction that line number is to be deleted. Despite the MX engine getting a copy of the fields that are to be deleted, it only checks the line number. The button labelled 'Close' or 'Cancel' does the same effect as clicking the "x" in the top right corner, it prevents the api sending any deletion message back to the MX engine.

==Cautions if using an obsolete MX release==

* '''Cumulus MX beta version 3.0.0 (checked at build 3043) does not provide an editor'''
* '''Cumulus MX Version 3.4.5 - Build 3069 onwards provides an editor'''
* From MX release 3.9.2 - b3097 historic charts are added to admin interface
** If you use the in-built editor to update dayfile.txt, your change will be reflected in the historic graphs
** If you edit dayfile.txt outside Cumulus MX, historic graphs will not be updated until Cumulus MX is restarted

If lines in your [[dayfile.txt|daily summary log]] were created by a variety of Cumulus 1 releases (so some have less than 46 fields), you need to use Cumulus MX version 3.7.0, or later, to be sure that the provided editor will cope. The code was actually amended to be able to read lines with fewer fields at version 3.6.0, when 4 fields were added for feels like, so the total number of fields became 50.

It is recommended that nobody uses any 3.6.x version (see [[Updating_MX_to_new_version#If_using_a_3.5.x_release]]. (For historical interest only, Emergency Version 3.6.12 changed the number of fields to 54 in error)

From formal release 3.7.0, MX's dayfile.txt reverted to 52 fields. The extras are Canadian Humidity Index (Humidex). At the time of typing this, it has been said this file structure will not be changed again.

Whatever MX release you use, any line that is edited (even if it originally had fewer or more fields) will be saved with the same number of fields that release uses when it creates a line from the contents of today.ini.

= Using CreateMissing.exe editing functionality=

Basically, this utility will create a new '''dayfile.txt''', if there is already a file with that name it gets renamed, and existing fields are copied across. If there are some dates missing in an existing file it will create new lines ''if data for those missing lines can be derived'' from data already in [[Standard_log_files]]. If an individual line in an existing '''dayfile.txt''' is shorter than the number of fields expected in the current MX release, then '''CreateMissing.exe''' will calculate daily values for the missing fields based on data already in [[Standard_log_files]].

'''You must have installed MX in order to use this utility''', as some information in [[Cumulus.ini]] and some [[Software#By_Mark_Crossley|.dll files]] are shared between CumulusMX.exe and CreateMissing.exe .

''It is important to understand'' that when you start MX interactively, or as a service, it reads the contents of '''dayfile.txt''' into an internal array (held in random access memory - RAM). Therefore, if you run '''CreateMissing.exe''' while ''CumulusMX.exe'' is running, any updates to the file are ''not'' seen by MX until that software is restarted. Release 3.20.0 (beta build 3199 onwards) adds a new "Utils" menu with a new option to refresh the internal values without restarting MX.

Instructions for running '''CreateMissing.exe''' can be found on [[Calculate_Missing_Values#CreateMissing.exe|another Wiki page]] and information there is not repeated here. The developer includes brief installation and running instructions at https://github.com/cumulusmx/CreateMissing/blob/master/README.md.

= Using the Cumulus 1 editing feature =

{{Version badge 1}}'''This section applies to Cumulus 1.x.y only'''. The last command in '''Edit''' [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu |menu]] is ''dayfile.txt''.

''This is how you view'' the dayfile.txt from within Cumulus. Click the ''Help'' button for detailed instructions. Cumulus Help is concise but comprehensive.

It is a text editor, and it works best when at full screen:
*correct individual values by over-typing new values over those currently displayed,
*you can use '''insert''' key to add one or more missing rows (complete days) manually typing in values for all fields,
*use '''delete''' key to remove an entire day (e.g. if you get a 'duplicate' error message) after ensuring all fields are correct in the line that will remain,
*use '''Create missing''' button to insert missing rows (complete days) by reading from [[Standard_log_files]] and automatically calculating the best approximations for each field for those missing days (see next section)

== '''Create Missing''' on legacy dayfile editor ==

If a date is missing from dayfile.txt, and not available in a back-up, then it is possible to create a missing line (with approximations for the derived extreme values) in Cumulus 1. That functionality is known as "Create Missing" and is found [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|within the edit dayfile.txt screen]].
#Only use the editor when Cumulus is '''not''' doing catch-up or end-of-day, or any other action that could create an editing conflict.
#With the contents of the file loaded into the editing table, click the '''Create Missing''' button
#Cumulus 1 will now work through every line from start to end
#If 2 adjacent lines are not for consecutive dates, Cumulus will attempt to create missing lines
#It will read from the [[Standard log files]] all the data logged for each missing meteorological date (if 9am or 10am rollover is used, those read spans two calendar dates)
#It will derive totals, averages, highs, and lows, from the data it reads, for each missing date
#*Note that normally dayfile.txt lines are created from [[Today.ini]] which logs the daily totals, averages, highs, and lows, from every reading taken from the weather station
#*Depending on your weather station, Cumulus is able to read values at least every minute (maybe every 10 seconds), and consequently update [[today.ini]] frequently (each minute in Legacy Cumulus/each logging interval in MX) if an extreme happens,
#*If Cumulus is set up to only log the readings every half an hour, create missing is only able to see 1/30th (maybe 1/120th depending on weather station reading frequency) of the data,
#* Due to this mismatch, the derived values (averages, highs, lows) this approach can store are much less accurate (hence why getting missing lines from a backup is better)

The Cumulus 1 editor provides a "Create Missing" option where it will, for any dates for which a line does not exist, create a line if it can from reading the [[Monthly log files|detailed log file]] to extract all values relevant to that day and do the necessary minimum/maximum/total/average calculation for each dayfile.txt field, storing the time from the relevant other log file in any time-stamp field in dayfile.txt.

If a particular day does not exist as a row on the daily summary log, then 'create missing' can search the observations in the relevant monthly log, and calculate approximate highs, lows and totals to insert as an extra row in the daily summary log. These are approximate because the actual highs and lows for that day are quite likely to have occurred at moments in-between those that were logged.

For the legacy ''Create missing'' a list of inserted records is produced in [[dayfileeditlog.txt]].

If just some fields are wrong in a particular row (meteorological day) on day file, then there is a [[Standard_log_files#Using_Monthly_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | work around]] as at all current versions (up to 1.9.4) you can only use 'Create missing' to read from the [[Standard_log_files]] if the whole day (a line starting with that date) is missing in ''dayfile.txt''. Although Cumulus does not recognise the concept of a sensor not being available, it will write solar information even if you don't have a solar sensor; it does have to cope with reading a monthly log file that might have fewer derivatives than it wants (when using Create Missing) and therefore it may not know what to write into dayfile.txt as the calculated value. Cumulus 1 can't write a null value, so it writes zero for values, and "00:00" for time stamps. If you are using a 9am or 10am rollover time, be aware that create missing in Cumulus 1 always inserts 00:00 for null time-stamps, but in normal running Cumulus uses the rollover time for null time-stamps.

== Dealing with errors identified by the legacy software ==

If there is an error in ''dayfile.txt'', then it is most likely to be found when you are viewing its data on one of the screens for editing the monthly, annual or all-time extremes. Cumulus 1 will illuminate its ''Error'' light if it finds an error in such cases and tell you the line/row number of the first found error, together with some details of the error it found. For example, if a row is blank, a row is duplicated, a field is corrupted, a field does not have an acceptable value, or a field is missing so subsequent fields are to the left of where they should be.

If you do have a 'duplicate' error, you need to decide which row to ''delete'', and whether to copy any values from that row into the row you are keeping to ensure the correct extremes are retained.

==Correcting individual fields in multiple dayfile.txt lines==

Often people want to correct an individual field, in all lines within a particular period.

The most common example is because you have suddenly discovered your daily pressure high (and low) are wrong by a certain offset, because you used the wrong setting for converting absolute pressure to the sea level equivalent you want to store in the file.

Neither Cumulus 1 nor MX provide any functionality to make such multi-line editing easy.

However, this can be resolved by opening dayfile.txt in a spreadsheet (carefully ensuring each column is treated as either '''text''' (date and time fields) or number (the value fields) and that '''your field separator''' is set in the '''filter conditions''' to be a column separator for converting to spreadsheet. Spreadsheets have a "Paste Special" function that allows you to add/subtract a constant to every cell in a column.

===Correcting individual fields in multiple lines of Daily summary Log in Cumulus 1===

In the '''Edit''' menu, select '''Dayfile.txt''' screen, for a text editor where you can overwrite entries, delete entire lines, and insert new lines (and then manually type in values for every field). You can scroll left and right between fields, with a header row identifying which field is which, and you can scroll up and down through all the lines. If you know what you want to change (such as replacing a rogue figure), this is a very easy to use editor.

For the daily summary log, the original Cumulus software includes functionality to '''Create Missing''' in its daily summary log editor, see [[# '''Create Missing''' on legacy dayfile editor]]. This functionality creates '''an entire missing log line'' and will insert highs and lows whether they are extremes of source values, or extremes of derived values. It will only add those fields (to any new line) that are maximum or minimum (or sum, or equal to) a field that does exist in the [[Standard_log_files]] lines that belong to the same meteorological day.

==Legacy Workaround==

The legacy Cumulus 1 functionality is not designed to insert (or correct) individual missing extreme figures for daily summary lines that already have some fields in them, only to insert complete missing lines. However, we can workaround that constraint:

'''WORKAROUND FOR DAYFILE.TXT if required dates are present in both the standard log and dayfile.txt, but not all fields for that date exist in dayfile.txt'''

There are two common reasons for needing to use this, Cumulus 1 only, workaround:
# To add extra derived fields now calculated by Cumulus, to past lines created by an earlier version of Cumulus that did not calculate those derived fields at the time
# If you are importing into Cumulus records from other software, and that other software does not provide derived extremes (e.g. dew point, apparent temperature, heat index, rain rate, wind run) so your insert in the daily summary log file has only populated a sub-set of the fields.

The steps you need to take, to implement this Cumulus 1 only workaround:
#Select a time to do this work that is at least 10 minutes, preferably a whole hour, after Cumulus has performed a daily rollover, and ensure you finish this work long before the next rollover time. This will ensure your work cannot conflict with when Cumulus 1 is updating dayfile.txt.
# Take a copy of dayfile.txt original as backup,
# Use the Cumulus 1 editor (in '''Edit''' menu, select '''Dayfile.txt''' screen), and let it edit the original file
# Delete any days with partial information (e.g. from Cumulus versions that created fewer fields)
# Click the ''Create Missing'' button
# Wait while Cumulus scans all the standard log files, and for each source or derived field in those files, tracks the highest and lowest for each meteorological day that is now missing in dayfile.txt.
#* As an aside, be aware that when the contents of [[today.ini]] was used to create a new line in dayfile.txt originally, the high and low that were copied across were derived from all source values that Cumulus obtained from your weather station (this will usually be at least once a minute, depending on your weather station type it might be around every ten seconds; some weather stations provide new readings less frequently, some provide them more frequently).
#*Continuing this aside, the high and low that Cumulus is now deriving are based purely on those values stored in the [[Standard log files|standard data log]], by default that is just every 10 minutes, but it might be only every 30 minutes.
#The new lines that Cumulus 1 adds to your dayfile.txt while you use the editor, are also added to another log file '''dayfileeditlog.txt''', so we can access that to track the new values.
#For simplicity, click '''OK''' to save the edited '''dayfile.txt''' file, and exit the editor.
#Rename the amended dayfile.txt as "dayfile(generated).txt".
#Create an empty text file in a suitable temporary directory, and name it "dayfile.txt",
#Use an external editor to open your empty file.
#*You can use a Comma Separated Value file editor, although you will find this difficult starting with an empty file
#*You can use an editor designed for computer programmers or developers that can edit text file
#*You can use a spreadsheet application, such as "Libre Office Calc" or "Microsoft Excel", providing you obey the editing rules defined later
#You should first merge in (as read-only text) the previous contents of the original dayfile.txt from the copy taken in step 2, although you could skip the fields you have updated, that makes it more complicated!
#You should next merge in (where there are fields to be updated or previously missing) ''just those fields from the respective lines'' in either "dayfile(generated).txt", or '''dayfileeditlog.txt''' (whichever you find easier to use, the latter has fewer lines so it may be easier to use).
#Finally, copy your temporary "dayfile.txt" into the "Cumulus\data" folder, so from now on Cumulus accesses the file with the maximum number of fields present.

One note of caution:
*If a required source or derived value is not present in the standard data log lines, Cumulus will write into related dayfile.txt fields zero for values, and in the editor "00:00" (in normal running it would insert your rollover time) for time stamps, because it does not understand the concept of "Null".
*Cumulus 1 does not have the functionality to retrospectively calculate derived values (e.g. cannot work out apparent temperature) when it is reading source values (e.g. temperature, humidity, wind speed) in the standard data log line.

= Important Rules when editing dayfile.txt =

If you are editing dayfile.txt outside the Cumulus 1 or MX software, there is the danger of changing something that prevents Cumulus from understanding the file when it next tries to use it.

== Warning if editing outside MX ==

You need to understand the following difference between the legacy Cumulus 1 and MX. In the legacy software (and early MX releases), "dayfile.txt" is read by the software if any output reports past days. In later MX releases, the only time the file is read is when the software is restarted, it is not read again.

From MX release 3.9.2 - b3097, Historic Charts were added to both the interface and the default web pages. As a consequence, when you start MX in this release (or any subsequent release), the entire content of dayfile.txt is held internally (i.e. in RAM), and it is these internally held values that are used by the .json api/files that feed these [[Highcharts - Historic]] plots. MX will append an additional array when it stores a new line in the file. The MX in-built editor actually displays/edits the internally held data, and then writes back (including any deletions or edits) that internal array into the file.

'''Prior''' to release 3.20.0 - b3200, if you were to edit the "dayfile.txt" using an external editor without stopping MX, any change you make is not seen by internal array, and such external edits would be lost should you (in the same MX session) use the internal editor. To propagate your external edits, you need to first stop, and then restart MX, and then the internal array will match the file.

''From release 3.20.0 - b3200,'' there is a utility provided that can copy what is held in the daily summary log file and update the internal array. Access this utility from the '''"Utils" menu''' added to the interface at this release.

== General Editing Rules ==

These rules should be followed whatever Cumulus file you edit externally.

# Take a copy of the file that can be reverted to if there is a subsequent problem, and you have messed up the file that Cumulus (1 or MX) is now trying to use.
# Take another copy and use that for your editing, don't edit the actual file being used by the software.
#*This prevents any conflicts between access by the software and access by your script or tool being used to modify the file.
#*It also means that you can go back to the last working copy, you can't upset your "revert" copy.
#The file must never be edited with a word processor, as they store many control and identification characters that prevent Cumulus correctly reading the values.
#* It is recommended that you use either a specialised "Comma Separated Value" file editor or a text editor, both of these can be easily used.
#** These tools have the advantage that they can cope with different lines having a different number of fields depending on which version number of Cumulus created each line.
#*You can use a spreadsheet tool, but if you do, there may be a number of settings to change from their defaults to ensure the file remains in a readable format for Cumulus.
#**If you do use a spreadsheet, extra field separators may be added at end of shorter lines as these make all lines end up with same number of fields.
#*Don't remove any figures from fields where figures currently exist, only change one entry into another entry in same format.
#Cumulus does not accept the concept of nulls, there is nothing that can be placed as a place-holder when the correct figure is not known, and empty fields are not permitted.
#All figures must be within the range of sensible figures for that field (e.g. no hour 24 or higher, no signed numbers when accepted values must be positive, don't put in any number over 100 for a relative humidity)
# Make sure that any editing does not create any ''blank lines'' in the file. Cumulus assumes an empty line means end of processing. Also ensure all lines have same end of line characters, this is one way accidental blank lines can be inserted!
# Don't include any header line in the file, Cumulus expects all lines to be data lines.

=== File specific Editing Rules ===

These additional (above rules still apply) rules are specific to any external editing of "dayfile.txt".

[[File:Open office (editing cumulus log files).png| right]]
# The file should be saved without "Byte Order Mark", specialised text editors will include a menu where you select the encoding and can select not to include BOM. (If you are using old software, both Microsoft and Google editors, used to insert BOM automatically).
# All rows must ''start with date'' as a text field (not a date formatted field) and include at least 14 further fields ''in correct sequence''.
# Remember the month must be the middle figure in the text field representing date, USA date convention cannot apply within this logfile.
#The separator between the three parts of the date should be a '-' hyphen or a '/' slash, it cannot be a space.
#*Whether Cumulus expects a hyphen or a slash is determined by the locale, you must keep to the same locale for the whole file, you cannot change the locale when you do an edit, nor when you update the device running Cumulus.
#*Although, use of comma or point for separating parts of the date is in some locales, and therefore allowed by Cumulus, those locale settings are not recommended as these date separators can cause issues for subsequent edits.
#* If you move your software (any flavour) to a new device, or you change from Cumulus 1 to Cumulus MX (or back), then you must ensure your dates still use the same separator, so all lines are consistent.
# The (meteorological) date format, in this text field, uses ''two digits for the year'':
#*This is one reason why you need to edit this file using an editor that treats all fields as text (a text editor, a CSV editor, or a spreadsheet program that can be instructed ''not'' to recognise special field types).
#*For spreadsheet tools (e.g. '''Calc''' in Libre Office, or Microsoft's '''Excel''') avoid using default of recognising formats, ensure that such recognition is turned off (see image), as it is likely to change the dates to either a number representing days since e.g. 31 Dec 1899, or to change it to four figure years, in either case Cumulus will no longer be able to use the log file.
# Each of the fields from date to the end of the line are separated using the list separator (e.g. a comma or semi-colon) defined for your device. After your editing it must still match what your existing dayfile.txt uses.
#* If you wish to use Excel, or to use "Calc" in 'Apache Open Office', "Libre Office", or similar, you may on opening the file need to pre-select the field separator that is being used now (in this illustration comma is selected, but your file might use semi-colons between fields, don't select commas if your real numbers use comma between integer and decimal parts) and leave "Detect Special Numbers" (or whatever similar feature name your tool uses) unselected. Again third party packages processing dayfile.txt will need to recognise your field separator, and some may need to specify it. Don't forget to also select it when you save the edited file (you probably need to select "save as" or the equivalent in your tool to see the option).
# Rows can vary in length but only by missing off ''fields at the end''. The minimum number of fields after the date is 14, the maximum varies between different Cumulus releases.
#* (The variation between maximum number of fields may cause a problem, if you regress to an earlier release!)
# Each field has a pre-defined format, and the same format must always be used in that field position.
#No fields will accept letters.
#*Some fields (e.g. bearings, solar, humidity) are ''integers'' (see [[#List_of_fields_in_the_file]]) only take integers. Decimals are not allowed in an integer field, so no comma or full-stop can be within these fields.
#* Most value fields are in ''real number format'' using your system/locale decimal notation ("x.y" or "x,y"). Trailing zeroes are not required, so you can put an integer in a real number field, you don't have to have a decimal comma or decimal point.
# Although only the date and 14 other fields are mandatory, you cannot skip some fields defaulting them to null is not allowed, so you cannot add fields at the end, without adding all earlier fields.
#when you do add fields beyond the 14, or however many already exist, be aware that for most derivatives what you add will represent a ''lowest or highest value'' and that must be paired with a time-stamp in the next field.
#* Cumulus will only accept highest/lowest figures if each value has any related time-stamp.
# Time stamp fields must always be in ''format HH:mm'' i.e. 2 digit hour in 24-hour format, followed by a colon, then 2 digit minutes
#**Be aware you will have problems if you, or your editing software, add seconds.
#* If when editing, you don't know what time to quote, the convention is to use a time-stamp of your roll over time i.e. 00:00, 09:00, or 10:00, if you have not looked up the precise time.
#* Except for wind gust (start of line) where an extra field is fitted in, each time field will immediately follow the value field for that parameter.
# Shorter lines can have multiple field separators added at end of row added either when editing within Cumulus or when editing using a spreadsheet tool.
#* Nulls (2 field separators without something between them ',,') are thus allowed at end of line, but are not allowed within the part of the line with values and time-stamps.
#*If you are editing out rogue values and if you do not know the value for a particular field within the line, then type in a zero or 9999 for nulls in integer format and an extreme with opposite value (e.g. -999.9 for a signed decimal maximum, and 9999.9 for a decimal minimum) for nulls in decimal format (replace the full stops with your decimal separator).
#*Beware - if you do insert zero or an obviously wrong extreme value, Cumulus will display those in any editing screen where you wish to update the all-time, monthly-all-time, this month, or this year, extremes. This can make editing by picking values in logs harder.
#Cumulus itself will use zero for any parameters (e.g. solar) not provided by your station, and will repeat the last valid value if the station fails to send a value it should provide, so if a station fails to send a value for more than a day, dayfile.txt may show the same value as the previous day.
#* Note that Cumulus will stop if your station fails to send what it considers as a vital reading, like pressure or temperature, so the previous point does not apply in all cases.
# The row terminator for Windows is ''CR LF'' (a combination of Carriage Return represented in many [[Reports_folder#Encoding|character set encodings]] by the binary equivalent of decimal 13), and Line Feed represented in many character set encodings by the binary equivalent of decimal 10), ensure any external editor does not change the two character terminator into a single character. Similar rules apply for single character terminators used by other operating systems (Linux uses LF only, Mac uses CR only), don't let any editor you use change a single character terminator into its double character terminator.
#*Problems with terminating characters are intercepted by operating system, before it reaches the software, but may still stop the software understanding the resulting file, so be careful if you edit the file on a different device to that running Cumulus.

Software

2022-08-21T20:45:48Z

Sfws: spelling corrections/action clarification

[[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX.

= What is Cumulus MX? =

: a cross platform version of Cumulus software that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X.

'''NOTE relating to MX Release v3.9.1 or later: On Linux/RPi/macOS, Mono version 5, or 6, is needed for CreateMissing.Exe, ExportToMySQL.exe, and CumulusMX.exe. Mono v4 is subject to random crashes.'''

==CumulusMX.exe Usage Restriction==

Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default MX web site]], include the [https://www.highcharts.com HighStock] product.

Are you using MX for a non-profit organisation, personal website, or school project?
Then download MX and start using it with Highcharts today.

Are you representing any commercial organisation running a facility that others use? If so, then you cannot use Cumulus MX to share weather data on behalf of your organisation without buying a licence from the High Charts organisation.

'''HighCharts rules for usage of their products are described ''' [https://shop.highcharts.com/ on their licence purchase web page], and ''it is your responsibility to ensure compliance''.

== Help with ‘Stable’ MX releases ==

If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]].

It is recommended you check you have complied with any instructions in the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before seeking help (to see what changes in any release affect you, and what actions you may need to take).

If you wish to research the documentation on MX to try to resolve your problem yourself, use the entry point of the [[:Category:Cumulus MX]] page for pointers to other Wiki pages connected with MX that may help.

If you cannot answer your questions from information in this Wiki (and MX changes so quickly any information here can be very out of date), then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] and the developer or Cumulus community will offer assistance.

==Upgrading==

We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest release:
* You may wish to wait a few days after a new release comes out, just in case a new release has some bugs
** MX is extremely complex, the developers work on MX edits in their spare time, have settings that suit them, and do not have the full set of sensors that MX can support, so pre-release testing is never perfect
* By switching to latest release, you gain any extra functionality it may offer (although it may not be useful to you), but more importantly you gain fixes of bugs your existing release may have
* Also the main developer can most easily offer support if you are using the build he most recently released.

There are inter-dependencies between different files in the MX release distribution:
* ''Therefore you must always install into your MX folders, every file included in the download zip''.
** You can take a back-up of your existing installation before you copy in any new files, that will provide you with the ability to regress to the earlier release, if the new release does cause you an issue
* If you customise any file that is in the distribution, either give the new file a new name (perhaps add a prefix of "_" in front of files you edit) or place your tailored version in a different folder
** Either approach will ensure your tailored files are not overwritten by files from the download, and let you compare your tailored file with the new file in the download to see if you need to tweak your tailored file
* It is strongly recommended that you install all files in the download for a new release of MX directly over your existing installation.
** You may end up with some files no longer needed by the new release, left over from older release, but this is better than risking missing some vital files

: There is an [[Updating_MX_to_new_version#Installer_Option|installer utility]] available to help with upgrading.

*Important, please read all of the release notes (in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 appropriate forum announcement] threads) for the builds since the version you are upgrading from, especially noting when there are references to necessary once-off actions.
*If you have never upgraded before, or you are currently running a fairly old release of MX, you are advised to read the [[Updating MX to new version]] page in this Wiki,
** you may be recommended to upgrade in stages, as certain releases do essential one off actions that are missed if you skip that release; e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables
** overwriting an existing installation will add any new files, but it won't remove obsolete files, and sometimes [[MX_Basic_info#Library_software|replacement files]] have different names to their predecessors so don't overwrite the old files
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page
** However, it is likely that information on those pages was written for earlier MX releases, and might be out of date, so like many other people you might want to ask in the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have more up-to-date advice.

Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software that have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software.

== Current Release ==

===Latest build distribution download===

~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3202/CumulusMXDist3202.zip Cumulus MX v3.20.0 build 3202, 21-August-2022]

===Latest MX Source Code===

~ View/download [https://github.com/cumulusmx/CumulusMX Cumulus MX Current Source Code]

This source code base is updated for all releases resulting from development by M Crossley, it includes some contributions from other developers.

===Raspberry Pi Image===

~ Download [//{{SERVERNAME}}/Downloads/rpi-CumulusMX-lite-3.19.0.zip Raspberry Pi Image for Cumulus MX 3.19.0]

As at April 2022, the image includes Raspberry Pi. O. S. 11 "Bullseye" version of Linux.

 

# This is a pre-built disk image file for your first installation onto a Raspberry Pi computer.
# Do read the instructions for using this image on the [[Raspberry_Pi_Image|Raspberry Pi Image]] page to see what is in the image and how to use it
# It is of course possible that sometimes the image provided may have issues for you,
#* it is set up so that MX starts running as a service immediately you boot up your Raspberry Pi, rather than letting you first run MX interactively (see [[MX_on_Linux#Running_MX]]);
#* it is produced with a Raspberry Pi model 3, so with other models you may need to replace the Mono software included in image, and consider what updating rates your model can support;
#* it is produced using a GB locale and GB time-zone, so that automatically started MX may not initially be running correctly for your locale (however as you need to restart MX after changing settings you should be okay when MX starts recording data).

: Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono).

==Older releases==

It is always possible that a new release introduces a bug, and you decide to regress to an earlier release.

Find link to earlier MX release distributions [https://github.com/cumulusmx/CumulusMX/releases here].

(You can search using the history tab on this Wiki page to see which past builds were made available as Raspberry Pi images, as these are not created for all releases, but there is no way to tell if the old filenames can still be downloaded. Generally, it is easiest to download a different normal MX release distribution over whatever MX release was in the image you downloaded.)

= Other utilities =

==By Mark Crossley==

The following download zips do not include the ''*.dll'' files ("software libraries") needed to run the respective utility, these are provided in the MX release zip that is stated alongside download link. The different utilities vary with regard to which software libraries they require, and those with technical understanding can check the code sources.

If you are using an earlier MX release than that stated, upgrade MX to bring in the new "*.dll" files needed, because the utility will not work with the versions of "software libraries" included with earlier MX releases.

If you are using a later MX release than that stated, check [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 the MX release announcements] for all releases since that stated to see if the "software libraries" have been upgraded, if they have then the respective utility because it has been compiled with older versions of the respective .dll files will probably not work. (Sometimes the names of new .dll files are different to the names of the old .dll files, so an upgrade of MX done by copying files over an existing installation will leave the old files there, in that case the utility might still work by picking up old names).

=== Create Records ===

This utility is not yet available.

A utility to create, or recreate, missing [[Correcting_Extremes|extreme records]] from Cumulus MX by parsing your [[dayfile.txt|daily summary (dayfile.txt)]].

=== Create Missing ===

~ The CreateMissing.exe ''v1.3.0'' download dated 18 August 2022 (works with release of MX 3.20.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.3.0/CreateMissing-v1.3.0.zip is here].

Check compatibility with the MX release you have running as per notes above. (Although earlier releases of "Create Missing" exist on "github.com/cumulusmx/CreateMissing/releases", their software bugs imply they should not be used). Install into same directory as "CumulusMX.exe".

This MX utility, affects [[Category:Files with Comma Separated Values|Cumulus CSV files]]:
# It will create a new [[dayfile.txt|daily summary (dayfile.txt)]]. If you already have a "dayfile.txt", that is renamed, the new file should include individual fields, and lines, missing from your old file.
# It will read, and where appropriate update, your [[Standard log files|month by month (MMMyylog.txt)]] files.
#* The utility reads the [[Calculate_Missing_Values#Source_value|source values]] in as input values. This utility has the ability to calculate many of the [[Calculate_Missing_Values#Derived_value|derived fields]], so will add any missing derived values to your month by month files as it proceeds.
#* Therefore the utility should be used to add the [[Standard_log_files#Number_of_fields_per_line_varies_by_release|extra fields]] for those months where the input file was produced by Cumulus 1 or an earlier release of MX (which might have populated fewer fields or used a [[Feels_Like#How_to_express_Feels_Like_for_highest_temperatures|different calculation]]).

Usage information by the author of the utility can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.]
* Learn more about this utility by reading the [[Calculate_Missing_Values#CreateMissing.exe|calculate missing]] page in this Wiki.
** Elsewhere on that same page learn when this utility might be useful, and what else you can try.
* Check in the support forum for information about status of bugs in this utility, at time of last updating this paragraph there was an outstanding issue concerning storing the line in dayfile.txt for the first of some months if your rollover time is not midnight.
* For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page.

=== Export ''To'' MySQL ===

~ The ExportToMySQL.exe ''v1.6.0'' download dated 18 August 2022 (works with release of MX 3.20.0) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.6.0/ExportToMySQL-v1.6.0.zip is here.]

Check compatibility with the MX release you have running as per notes above. Note that compatibility is needed both with the .dll files and with the columns present in the table to be updated.

If you are not using the MX release named above, then other release zips (and source code) for this utility are available at [https://github.com/cumulusmx/ExportToMySQL/releases ExportToMySQL/releases] and each release there is labelled as to which MX release creates default tables with correct columns.

This utility reads [[MySqlConnect|Settings]] that are also used by "CumulusMX.exe". Parameters supplied to this utility enable it to do ''one of the following actions'' affecting rows not already present on a [[Your Own Server|MySQL, or MariaDB, database server]]:
# The parameter used is "dayfile", will insert missing rows into a database table that is called "dayfile" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of [[dayfile.txt|daily summary (dayfile.txt)]] file
# Insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of the single file of [[Standard log files|month by month (MMMyylog.txt)]] whose relative path "data/..." is named in the parameter
# The parameter used is "monthly", will insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) reading data from the contents of all files of type [[Standard log files|month by month (MMMyylog.txt)]] found in the [[Data folder|data sub-folder]].

Installation and usage information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.]

''This new utility replaces the "ExportMySQL.exe" (no "To" in that name) utility included by Steve Loft in his MX beta distributions.'' That is not compatible with any recent MX releases.

==By Steve Loft==

Source code for these utilities are not available, therefore they cannot be altered or upgraded.

=== Utility for Fine Offset Stations ===

*[//{{SERVERNAME}}/Downloads/SetLogger.zip Set Logger Interval] A utility by Steve Loft to adjust the internal logging interval on Fine Offset stations

=== Weather Display Converter ===

This utility was provided by Steve to convert '''Weather Display''' log files to Cumulus 1 format, download [https://cumuluswiki.org/a/File:WDconverter.zip here].

Please read the readme file in the zip.

There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about using this converter with the legacy Cumulus here].

 

At time of creating this utility, the functionality offered by MX was limited, and this utility was not useful with MX. MX now has much more functionality, and depending on the release you are using, this utility may be useful. Remember this utility will not support all fields used by MX. It is advised you use [[#Create Missing]] (see above) after using this utility to populate the other fields. If you do find this utility does not work with your MX release, you may need to manually recreate records, etc. using Cumulus 1 formats, and then [[Migrating from Cumulus 1 to MX|Migrate all your files from Cumulus 1 to MX]].

=== WeatherLink Converter ===

This utility was provided by Steve to convert Davis '''WeatherLink''' log files to Cumulus format, download [https://cumuluswiki.org/a/File:WLconverter.zip here].

Note this has nothing to do with Davis ''Weather Link Live'' despite confusing similarity in name.

Please read the '''readme''' file in the zip.

* There is a recent [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=20017 forum thread about using this converter with MX here]
* There is an older [https://cumulus.hosiene.co.uk/viewtopic.php?t=11349 forum thread about using this converter with the legacy Cumulus here].

== Third Party Contributions by other Cumulus Users ==

For files, and add-on's, contributed by Cumulus users, see these Categories (where third party authors may have mentioned what they offer):
# [[:Category:3rd Party Apps]] - contributions for various devices,
# [[:Category:AddOns]] - adding extra functionality,
# [[:Category:WebTools]] - for your web server, and
# [[:Category:User_Contributions]] - key contributions from the user community

=Current MX Developed from =

Cumulus 3 (MX) software was developed as a beta with limited functionality by Steve Loft.
* Steve Loft previously developed Cumulus 2 (where he tested using the C# language, now used for MX)
* Steve Loft created the original Cumulus software (now known as legacy cumulus 1) just for his use, before making it generally available, he then developed it over the next decade to include requirements suggested by thousands of users.
* Steve Loft, the author of Cumulus/Cumulus MX has since fully retired, and stopped providing support, or updates, to any of his software.

==Steve's final beta MX==

You can download below the final Cumulus 3 beta release, as made available by Steve Loft, and also his ''subsequent'' final source code.

If you are able to understand his source code (linked below), and compare it to the latest source code (linked above), you can appreciate the transformation that has taken place in recent years.

*[//{{SERVERNAME}}/Downloads/CumulusMXDist3043.zip Cumulus MX v3.0.0 beta build 3043, 20-Jan-2017] Cumulus MX, a cross platform version of Cumulus 3 which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X (Steve Loft - final release), single zip that includes both "CumulusMX.exe" and "ExportMySQL.exe".
*[//{{SERVERNAME}}/Downloads/CumulusMXSource.zip subsequent updated Cumulus MX Source Code] from Steve Loft. He made the following comments, as he handed the project over to "the community":
**This version of the code is post the last release I made at build 3043 as it includes some extra changes that I have not finalised.
**My source code is offered as my parting gift, completely '''without support''', in the hope that it might be useful to future developers.
**My source code is very badly structured due to the 'Frankenstein' way I cobbled it together from various places. Some of it is a machine translation of parts of Cumulus 1.

= Legacy releases =

See [[Downloads| downloads page]] for full details.

== Cumulus 1 ==

Cumulus 1 software was popular, when it went public in 2004, and its [[Cumulus_Users|usage]] grew very rapidly in the subsequent decade until final 2014 release. Even now (in mid-2022) some people are still using the final release version (and a quite substantial number of public viewable weather sites are still driven by earlier builds).

Be aware, the longer you wait before swapping from legacy to Cumulus MX software; the more that MX will have developed away from the legacy. MX's development has effectively abandoned its former focus on compatibility, so you might encounter more difficulty with [[Migrating from Cumulus 1 to MX|transferring your data files when you migrate]].

In all months of 2020, (when the year selection drop-down provided in all releases of original software reached its limit, and MX gained a substantial increase in functionality), and continuing into mid-2021, there was an avalanche of people who used to use the legacy software successfully swapping to MX. As of mid-2022, the usage of this legacy software is in fast decline, implying fewer people can offer assistance.

The '''installer for the FINAL release of the legacy Cumulus 1''' is available here:
#[//{{SERVERNAME}}/Downloads/CumulusSetup.exe Cumulus 1099 installer] Full set of files within an installer.
#* On the "this period" type, and snow index, screens you can still manually enter any year,but you have to over-type with the full year yourself, outside range 2008 to 2020.
#* You cannot manually regenerate NOAA reports after 2020, but there is no problem with automatic generation.
#[//{{SERVERNAME}}/Downloads/cumulus.1099.2.zip Cumulus 1.9.4 build 1099.2 patch] Patched version of one file (cumulus.exe) to replace that file from above installer
#* Note this is not the full installation package, just one file to replace in the suite of files created by the installer.
#* This patch modifies the drop-down year selectors, (on "this period" screens, for NOAA reports, and for Snow Index) making it easier to choose date entries (patch version 1099.2 was released 28 Jan 2020) up to the year 2030.

=== Legacy Cumulus 1 Resources ===

*[//{{SERVERNAME}}/Downloads/Cumulus%20basic%20installation%20guide.pdf Cumulus installation guide] Instructions for installing Cumulus 1
*[//{{SERVERNAME}}/Downloads/readme.txt Cumulus readme.txt] Please read this before installing or updating Cumulus
*[//{{SERVERNAME}}/Downloads/Cumulus.chm Cumulus help file] The Cumulus 1 help file (this also gets installed when Cumulus is installed)
*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French
*[//{{SERVERNAME}}/Downloads/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight (Silverlight is no longer developed or supported by Microsoft) application for displaying 2 extra dials showing real time wind data on the standard Cumulus gauges page (with temperature and rainfall in histogram style) for a web site

=== Special Variants ===

It is '''STRONGLY RECOMMENDED''' that users of Cumulus '''1.9.4 variants''' migrate to Cumulus MX, which has ongoing support by Mark Crossley. The baud rate can be selected within MX as a configuration setting.

*[//{{SERVERNAME}}/Downloads/CumulusSetup1100.zip Cumulus 1.9.4 build 1100 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 115200 baud, you should use build 1100
*[//{{SERVERNAME}}/Downloads/CumulusSetup1101.zip Cumulus 1.9.4 build 1101 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 19200 baud, you should use build 1101
*'''NOTE:''' '''These Cumulus 1.9.4 variants will not have any updates in the future.'''
* The patch for Cumulus.exe, cannot be used with these variants
* The menu items with year drop-down selectors will not display years beyond 2020.
**For example, this will happen on manual generation of NOAA-style reports.
**This does not affect any automatic generation of NOAA reports, but does prevent re-generation.

== Cumulus 2 ==

The software for Cumulus 2 alpha release is no longer available.

MySqlConnect

2022-08-21T11:01:55Z

Sfws: /* The My SQL settings page in interface */ add screenshot

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulus 3 software (MX beta 3.0.0).

Essentially, MX can ''either'' create and update one, or more, of three tables (by default called "realtime", "monthly", and "dayfile"; although these names can be changed by the Cumulus user) where it determines the '''schema''' (what columns appear in the database table); ''or'' MX can run SQL (devised by user) against tables (created by user) that can have any "schema" (columns in the table) chosen by user at one, or more, of three intervals (MX calls these "custom seconds", "custom minutes", and "custom rollover").

This Wiki page provides a brief introduction to SQL, and describes the settings that define how this functionality is controlled.

At last update, this Wiki page shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

==What is SQL?==

SQL is an abbreviation of "Structured Query Language", SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey.

==How does MX use SQL?==

MX uses two types of SQL.

MX uses SQL when updating a SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type of database stores data in what is known technically as a sequential file. In a sequential file, the data appears as a number of lines that have to be stored in order (by row number). Because entries can be deleted, not every possible row number has to be present, but new entries are appended at end. The various fields (or columns) are named, it is possible (but rarely done) to change the order of the columns, rewriting the entire database file. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifying content, but that gets translated into a row number to actually determine the row that is updated.

MX also uses SQL when creating, or updating, a relational database type. The commands issued by "MySqlConnect" software work with two types of relational databases, MySQL (commercial software by Oracle) and MariaDB (free software from an independent provider). A relational database also uses the row, column, and field terminology; but there is no control over the order in which rows are stored, there is an order for columns (although you can change the column order), and rows are identified by a unique key (known as "primary key" as a row can contain a secondary key that links to data in another table). Any retrieval query can specify that what is returned from that query should be sorted in an ascending/descending order of the value(s) in specified column(s).

As mentioned earlier, MX supports (default) tables where it determines the columns in the table , and (custom) tables where the user determines the columns. For the default tables, every MySqlConnect command issued by MX specifies column names, so those columns must be present in the table, but can be in any order. (If the user adds extra columns, those extra columns must be defined with null as default value, so MX can ignore them). Some MX releases add columns that were not present in earlier MX releases, and these releases should provide a utility that will add the extra columns to existing tables.

===How does MX use MySqlConnect?===

MySqlConnect is used by both [[Software#Current_Release|CumulusMX.exe]] and [[Software#Export_To_MySQL|ExportToMySQL.exe]], but the latter only works with two of the default tables (those called "monthly" and "dayfile", or as renamed by the user).

Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:

{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu → MySQL settings → General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu → MySQL settings → Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu → MySQL settings → Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu → MySQL settings → Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu → MySQL settings → Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}

=The My SQL settings page in interface=

MX controls settings for the relational database tables on a page called "MySQL settings" although you may be using "MariaDB". Here is a screenshot of that page (with all sections closed up) as applicable from release 3.20.0 (build 3202):

[[File:MySQL settings.png]]

Please note, the text included elsewhere on this Wiki page may be for different release.

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

== Predetermined SQL ==

The custom table options in MX require you to specify the SQL in advance of it being used, and are therefore intended for use to predetermine all the SQL you might use (conditionals can be included to decide what queries actually get executed if there are alternatives). You can enable/disable individual settings, but the mechanism is not designed to do any one-off actions like creating the custom tables.

WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MariaDB syntax.

Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....);

BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>

== Why are Cumulus settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

MX has been developed very dramatically by Mark Crossley:
# The MySQL settings for the original 3.0.0 beta were 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)|that latter documentation remains available 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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>
# Since the MySQL settings have continued to change, since 2021 they have been moved here from that last mentioned page.

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

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

The settings described here are stored in a file called "Cumulus.ini".

The file is divided into "File sections", 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.

==Content of "Cumulus.ini" relating to MySQL==

* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu → MySQL settings
* The table below relates to a beta for 3.12.0 (see top of this page), there will have been changes in later MX releases that are not documented

{| 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
|-
| BufferOnFailure=0
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlMinutesEnabled=0
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlRolloverEnabled=0
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous, and next, options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| Custom Upload - seconds interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlSecondsEnabled=0
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal rollover updates and "ExportToMySQl.exe" will use the table name you define. Depending which MX release you use, the option to update table when you edit "dayfile.txt" may fail!
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but at some releases the option to update table when you edit "MMMyyyyLog.txt" may fail
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* 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
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see begining of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}

File:MySQL settings.png

2022-08-21T10:56:53Z

Sfws:

Software

2022-08-21T09:43:55Z

Sfws: /* Cumulus 1 */ correct dates

[[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX.

= What is Cumulus MX? =

: a cross platform version of Cumulus software that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X.

'''NOTE relating to MX Release v3.9.1 or later: On Linux/RPi/macOS, Mono version 5, or 6, is needed for CreateMissing.Exe, ExportToMySQL.exe, and CumulusMX.exe. Mono v4 is subject to random crashes.'''

==CumulusMX.exe Usage Restriction==

Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default MX web site]], include the [https://www.highcharts.com HighStock] product.

Are you using MX for a non-profit organisation, personal website, or school project?
Then download MX and start using it with Highcharts today.

Are you representing any commercial organisation running a facility that others use? If so, then you cannot use Cumulus MX to share weather data on behalf of your organisation without buying a licence from the High Charts organisation.

'''HighCharts rules for usage of their products are described ''' [https://shop.highcharts.com/ on their licence purchase web page], and ''it is your responsibility to ensure compliance''.

== Help with ‘Stable’ MX releases ==

If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]].

It is recommended you check you have complied with any instructions in the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before seeking help (to see what changes in any release affect you, and what actions you may need to take).

If you wish to research the documentation on MX to try to resolve your problem yourself, use the entry point of the [[:Category:Cumulus MX]] page for pointers to other Wiki pages connected with MX that may help.

If you cannot answer your questions from information in this Wiki (and MX changes so quickly any information here can be very out of date), then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] and the developer or Cumulus community will offer assistance.

==Upgrading==

We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest release:
* You may wish to wait a few days after a new release comes out, just in case a new release has some bugs
** MX is extremely complex, the developers work on MX edits in their spare time, have settings that suit them, and do not have the full set of sensors that MX can support, so pre-release testing is never perfect
* By switching to latest release, you gain any extra functionality it may offer (although it may not be useful to you), but more importantly you gain fixes of bugs your existing release may have
* Also the main developer can most easily offer support if you are using the build he most recently released.

There are inter-dependencies between different files in the MX release distribution:
* ''Therefore you must always install into your MX folders, every file included in the download zip''.
** You can take a back-up of your existing installation before you copy in any new files, that will provide you with the ability to regress to the earlier release, if the new release does cause you an issue
* If you customise any file that is in the distribution, either give the new file a new name (perhaps add a prefix of "_" in front of files you edit) or place your tailored version in a different folder
** Either approach will ensure your tailored files are not overwritten by files from the download, and let you compare your tailored file with the new file in the download to see if you need to tweak your tailored file
* It is strongly recommended that you install all files in the download for a new release of MX directly over your existing installation.
** You may end up with some files no longer needed by the new release, left over from older release, but this is better than risking missing some vital files

: There is an [[Updating_MX_to_new_version#Installer_Option|installer utility]] available to help with upgrading.

*Important, please read all of the release notes (in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 appropriate forum announcement] threads) for the builds since the version you are upgrading from, especially noting when there are references to necessary once-off actions.
*If you have never upgraded before, or you are currently running a fairly old release of MX, you are advised to read the [[Updating MX to new version]] page in this Wiki,
** you may be recommended to upgrade in stages, as certain releases do essential one off actions that are missed if you skip that release; e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables
** overwriting an existing installation will add any new files, but it won't remove obsolete files, and sometimes [[MX_Basic_info#Library_software|replacement files]] have different names to their predecessors so don't overwrite the old files
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page
** However, it is likely that information on those pages was written for earlier MX releases, and might be out of date, so like many other people you might want to ask in the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have more up-to-date advice.

Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software that have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software.

== Current Release ==

===Latest build distribution download===

~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3202/CumulusMXDist3202.zip Cumulus MX v3.20.0 build 3202, 21-August-2022]

===Latest MX Source Code===

~ View/download [https://github.com/cumulusmx/CumulusMX Cumulus MX Current Source Code]

This source code base is updated for all releases resulting from development by M Crossley, it includes some contributions from other developers.

===Raspberry Pi Image===

~ Download [//{{SERVERNAME}}/Downloads/rpi-CumulusMX-lite-3.19.0.zip Raspberry Pi Image for Cumulus MX 3.19.0]

As at April 2022, the image includes Raspberry Pi. O. S. 11 "Bullseye" version of Linux.

 

# This is a pre-built disk image file for your first installation onto a Raspberry Pi computer.
# Do read the instructions for using this image on the [[Raspberry_Pi_Image|Raspberry Pi Image]] page to see what is in the image and how to use it
# It is of course possible that sometimes the image provided may have issues for you,
#* it is set up so that MX starts running as a service immediately you boot up your Raspberry Pi, rather than letting you first run MX interactively (see [[MX_on_Linux#Running_MX]]);
#* it is produced with a Raspberry Pi model 3, so with other models you may need to replace the Mono software included in image, and consider what updating rates your model can support;
#* it is produced using a GB locale and GB time-zone, so that automatically started MX may not initially be running correctly for your locale (however as you need to restart MX after changing settings you should be okay when MX starts recording data).

: Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono).

==Older releases==

It is always possible that a new release introduces a bug, and you decide to regress to an earlier release.

Find link to earlier MX release distributions [https://github.com/cumulusmx/CumulusMX/releases here].

(You can search using the history tab on this Wiki page to see which past builds were made available as Raspberry Pi images, as these are not created for all releases, but there is no way to tell if the old filenames can still be downloaded. Generally, it is easiest to download a different normal MX release distribution over whatever MX release was in the image you downloaded.)

= Other utilities =

==By Mark Crossley==

The following download zips do not include the ''*.dll'' files ("software libraries") needed to run the respective utility, these are provided in the MX release zip that is stated alongside download link. The different utilities vary with regard to which software libraries they require, and those with technical understanding can check the code sources.

If you are using an earlier MX release than that stated, upgrade MX to bring in the new "*.dll" files needed, because the utility will not work with the versions of "software libraries" included with earlier MX releases.

If you are using a later MX release than that stated, check [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 the MX release announcements] for all releases since that stated to see if the "software libraries" have been upgraded, if they have then the respective utility because it has been compiled with older versions of the respective .dll files will probably not work. (Sometimes the names of new .dll files are different to the names of the old .dll files, so an upgrade of MX done by copying files over an existing installation will leave the old files there, in that case the utility might still work by picking up old names).

=== Create Records ===

This utility is not yet available.

A utility to create, or recreate, missing [[Correcting_Extremes|extreme records]] from Cumulus MX by parsing your [[dayfile.txt|daily summary (dayfile.txt)]].

=== Create Missing ===

~ The CreateMissing.exe ''v1.3.0'' download dated 18 August 2022 (works with release of MX 3.20.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.3.0/CreateMissing-v1.3.0.zip is here].

Check compatibility with the MX release you have running as per notes above. (Although earlier releases of "Create Missing" exist on "github.com/cumulusmx/CreateMissing/releases", their software bugs imply they should not be used). Install into same directory as "CumulusMX.exe".

This MX utility, affects [[Category:Files with Comma Separated Values|Cumulus CSV files]]:
# It will create a new [[dayfile.txt|daily summary (dayfile.txt)]]. If you already have a "dayfile.txt", that is renamed, the new file should include individual fields, and lines, missing from your old file.
# It will read, and where appropriate update, your [[Standard log files|month by month (MMMyylog.txt)]] files.
#* The utility reads the [[Calculate_Missing_Values#Source_value|source values]] in as input values. This utility has the ability to calculate many of the [[Calculate_Missing_Values#Derived_value|derived fields]], so will add those derived values to your month by month files as it proceeds.
#* Therefore the utility should be used to add the [[Standard_log_files#Number_of_fields_per_line_varies_by_release|extra fields]] for those months where the input file was produced by Cumulus 1 or an earlier release of MX (which might have populated fewer fields or used a [[Feels_Like#How_to_express_Feels_Like_for_highest_temperatures|different calculation]]).

Usage information by the author of the utility can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.]
* Learn more about this utility by reading the [[Calculate_Missing_Values#CreateMissing.exe|calculate missing]] page in this Wiki.
** Elsewhere on that same page learn when this utility might be useful, and what else you can try.
* Check in the support forum for information about status of bugs in this utility, at time of last updating this paragraph there was an outstanding issue concerning storing the line in dayfile.txt for the first of some months if your rollover time is not midnight.
* For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page.

=== Export ''To'' MySQL ===

~ The ExportToMySQL.exe ''v1.6.0'' download dated 18 August 2022 (works with release of MX 3.20.0) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.6.0/ExportToMySQL-v1.6.0.zip is here.]

Check compatibility with the MX release you have running as per notes above. Note that compatibility is needed both with the .dll files and with the columns present in the table to be updated.

If you are not using the MX release named above, then other release zips (and source code) for this utility are available at [https://github.com/cumulusmx/ExportToMySQL/releases ExportToMySQL/releases] and each release there is labelled as to which MX release creates default tables with correct columns.

This utility reads [[MySqlConnect|Settings]] that are also used by "CumulusMX.exe". Parameters supplied to this utility enable it to do ''one of the following actions'' affecting a [[Your Own Server|MySQL, or MariaDB, database server]]:
# The parameter used is "dayfile", will update a database table that is called "dayfile" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of [[dayfile.txt|daily summary (dayfile.txt)]] file
# Update a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of the single file of [[Standard log files|month by month (MMMyylog.txt)]] whose relative path "data/..." is named in the parameter
# The parameter used is "monthy", will update a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of all files of type [[Standard log files|month by month (MMMyylog.txt)]] found in the [[Data folder|data sub-folder]].

Installation and usage information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.]

''This new utility replaces the "ExportMySQL.exe" (no "To" in that name) utility included by Steve Loft in his MX beta distributions.'' That is not compatible with any recent MX releases.

==By Steve Loft==

Source code for these utilities are not available, therefore they cannot be altered or upgraded.

=== Utility for Fine Offset Stations ===

*[//{{SERVERNAME}}/Downloads/SetLogger.zip Set Logger Interval] A utility by Steve Loft to adjust the internal logging interval on Fine Offset stations

=== Weather Display Converter ===

This utility was provided by Steve to convert '''Weather Display''' log files to Cumulus 1 format, download [https://cumuluswiki.org/a/File:WDconverter.zip here].

Please read the readme file in the zip.

There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about using this converter with the legacy Cumulus here].

 

At time of creating this utility, the functionality offered by MX was limited, and this utility was not useful with MX. MX now has much more functionality, and depending on the release you are using, this utility may be useful. Remember this utility will not support all fields used by MX. It is advised you use [[#Create Missing]] (see above) after using this utility to populate the other fields. If you do find this utility does not work with your MX release, you may need to manually recreate records, etc. using Cumulus 1 formats, and then [[Migrating from Cumulus 1 to MX|Migrate all your files from Cumulus 1 to MX]].

=== WeatherLink Converter ===

This utility was provided by Steve to convert Davis '''WeatherLink''' log files to Cumulus format, download [https://cumuluswiki.org/a/File:WLconverter.zip here].

Note this has nothing to do with Davis ''Weather Link Live'' despite confusing similarity in name.

Please read the '''readme''' file in the zip.

* There is a recent [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=20017 forum thread about using this converter with MX here]
* There is an older [https://cumulus.hosiene.co.uk/viewtopic.php?t=11349 forum thread about using this converter with the legacy Cumulus here].

== Third Party Contributions by other Cumulus Users ==

For files, and add-on's, contributed by Cumulus users, see these Categories (where third party authors may have mentioned what they offer):
# [[:Category:3rd Party Apps]] - contributions for various devices,
# [[:Category:AddOns]] - adding extra functionality,
# [[:Category:WebTools]] - for your web server, and
# [[:Category:User_Contributions]] - key contributions from the user community

=Current MX Developed from =

Cumulus 3 (MX) software was developed as a beta with limited functionality by Steve Loft.
* Steve Loft previously developed Cumulus 2 (where he tested using the C# language, now used for MX)
* Steve Loft created the original Cumulus software (now known as legacy cumulus 1) just for his use, before making it generally available, he then developed it over the next decade to include requirements suggested by thousands of users.
* Steve Loft, the author of Cumulus/Cumulus MX has since fully retired, and stopped providing support, or updates, to any of his software.

==Steve's final beta MX==

You can download below the final Cumulus 3 beta release, as made available by Steve Loft, and also his ''subsequent'' final source code.

If you are able to understand his source code (linked below), and compare it to the latest source code (linked above), you can appreciate the transformation that has taken place in recent years.

*[//{{SERVERNAME}}/Downloads/CumulusMXDist3043.zip Cumulus MX v3.0.0 beta build 3043, 20-Jan-2017] Cumulus MX, a cross platform version of Cumulus 3 which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X (Steve Loft - final release), single zip that includes both "CumulusMX.exe" and "ExportMySQL.exe".
*[//{{SERVERNAME}}/Downloads/CumulusMXSource.zip subsequent updated Cumulus MX Source Code] from Steve Loft. He made the following comments, as he handed the project over to "the community":
**This version of the code is post the last release I made at build 3043 as it includes some extra changes that I have not finalised.
**My source code is offered as my parting gift, completely '''without support''', in the hope that it might be useful to future developers.
**My source code is very badly structured due to the 'Frankenstein' way I cobbled it together from various places. Some of it is a machine translation of parts of Cumulus 1.

= Legacy releases =

See [[Downloads| downloads page]] for full details.

== Cumulus 1 ==

Cumulus 1 software was popular, when it went public in 2004, and its [[Cumulus_Users|usage]] grew very rapidly in the subsequent decade until final 2014 release. Even now (in mid-2022) some people are still using the final release version (and a quite substantial number of public viewable weather sites are still driven by earlier builds).

Be aware, the longer you wait before swapping from legacy to Cumulus MX software; the more that MX will have developed away from the legacy. MX's development has effectively abandoned its former focus on compatibility, so you might encounter more difficulty with [[Migrating from Cumulus 1 to MX|transferring your data files when you migrate]].

In all months of 2020, (when the year selection drop-down provided in all releases of original software reached its limit, and MX gained a substantial increase in functionality), and continuing into mid-2021, there was an avalanche of people who used to use the legacy software successfully swapping to MX. As of mid-2022, the usage of this legacy software is in fast decline, implying fewer people can offer assistance.

The '''installer for the FINAL release of the legacy Cumulus 1''' is available here:
#[//{{SERVERNAME}}/Downloads/CumulusSetup.exe Cumulus 1099 installer] Full set of files within an installer.
#* On the "this period" type, and snow index, screens you can still manually enter any year,but you have to over-type with the full year yourself, outside range 2008 to 2020.
#* You cannot manually regenerate NOAA reports after 2020, but there is no problem with automatic generation.
#[//{{SERVERNAME}}/Downloads/cumulus.1099.2.zip Cumulus 1.9.4 build 1099.2 patch] Patched version of one file (cumulus.exe) to replace that file from above installer
#* Note this is not the full installation package, just one file to replace in the suite of files created by the installer.
#* This patch modifies the drop-down year selectors, (on "this period" screens, for NOAA reports, and for Snow Index) making it easier to choose date entries (patch version 1099.2 was released 28 Jan 2020) up to the year 2030.

=== Legacy Cumulus 1 Resources ===

*[//{{SERVERNAME}}/Downloads/Cumulus%20basic%20installation%20guide.pdf Cumulus installation guide] Instructions for installing Cumulus 1
*[//{{SERVERNAME}}/Downloads/readme.txt Cumulus readme.txt] Please read this before installing or updating Cumulus
*[//{{SERVERNAME}}/Downloads/Cumulus.chm Cumulus help file] The Cumulus 1 help file (this also gets installed when Cumulus is installed)
*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French
*[//{{SERVERNAME}}/Downloads/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight (Silverlight is no longer developed or supported by Microsoft) application for displaying 2 extra dials showing real time wind data on the standard Cumulus gauges page (with temperature and rainfall in histogram style) for a web site

=== Special Variants ===

It is '''STRONGLY RECOMMENDED''' that users of Cumulus '''1.9.4 variants''' migrate to Cumulus MX, which has ongoing support by Mark Crossley. The baud rate can be selected within MX as a configuration setting.

*[//{{SERVERNAME}}/Downloads/CumulusSetup1100.zip Cumulus 1.9.4 build 1100 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 115200 baud, you should use build 1100
*[//{{SERVERNAME}}/Downloads/CumulusSetup1101.zip Cumulus 1.9.4 build 1101 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 19200 baud, you should use build 1101
*'''NOTE:''' '''These Cumulus 1.9.4 variants will not have any updates in the future.'''
* The patch for Cumulus.exe, cannot be used with these variants
* The menu items with year drop-down selectors will not display years beyond 2020.
**For example, this will happen on manual generation of NOAA-style reports.
**This does not affect any automatic generation of NOAA reports, but does prevent re-generation.

== Cumulus 2 ==

The software for Cumulus 2 alpha release is no longer available.

Alarms

2022-08-21T06:27:06Z

Sfws: Adding some images

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

MX has a sophisticated system allowing alarms to be displayed (and optionally other actions, including sending emails) for many different events.

This Wiki page lists the alarms available, and provides some guidance for using the alarm settings page in the interface.

It briefly covers the file that stores alarm settings, but see [[Cumulus.ini|main Cumulus.ini page]] for more general information.

Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change, it is hoped that presenting Alarms as a separate small Wiki page will make it more likely that somebody will keep it up to date.

==Screenshot showing how alarms are displayed on dashboard==

You can choose which alarms are shown, so this picture shows a reduced set and is unlikely to be same as what you see on the dashboard page of the interface (at bottom).

[[File:Dashboard alarms.png]]

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

The settings described here are stored in a file called "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.

== Why are settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>

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.

= The Alarm Settings=

Once again, be aware that the information shown may be badly out of date, as MX evolves very quickly.

== The "Alarm settings" screen in interface ==

The following screenshot is for release 3.20.0, showing some invalid selections (red edged), some selections made (entries ticked or populated with content), and is intended just as an indication of what you may see. The files listed for sound are at path of '''CumulusMX/interface/sounds'''. Alarm latch time hours are from 3.20.0 able to take decimal values, earlier releases only accepted integer latch hour values. The ''Action'' columns are new at 3.20.0, and can be used to call a script or run external exe etc. but are not listed in the table below.

[[File:Alarm settings.png]]

==Notes for table below ==

In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX.

For release 3.11.2 and subsequent each individual alarm also has to be enabled for it to appear in that display. Please see [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 release announcements in the support forum] for information on individual alarms, to help you find the appropriate post, and indication is given in the table of which release introduced each alarm:

Introduction column:
# There was no alarm functionality in builds in the 3.0.0 and 3.1.x series
# Any alarm functionality where the column says "Legacy Cumulus" was available before 1.9.0 and introduced into MX in one of the releases between 3.2.0 and 3.5.4.
# Any alarm functionality where the column says "Cumulus 2" was requested for that withdrawn flavour, subsequently added to a 1.9.x release, and was introduced into MX in one of the releases between 3.2.0 and 3.5.4; rather than indicate the precise release any introductions in that range of releases has that range shown.
# For alarm functionality first introduced in or after release 3.7.0, the exact release of introduction is shown in "Introduced" column.
# There were no changes to Alarm functionality between 3.7.1 and 3.8.4 inclusive, so if you are running one of the 3.8.x releases, the Wiki page that applies for "alarms" is [[Cumulus.ini_(MX_3.0.0_to_3.7.0)|the early MX releases page]], not this Wiki page.
# In the range of releases subsequent to 3.9.0 as covered by this Wiki page, the alarm functionality has been dramatically changing:
#* Latching of alarms was introduced at 3.9.1 (b. 3096), most alarms had no default for how long they stayed "latched", but at least one had a 12 hour default and at least one had an until end of day default.
#* At 3.9.2 (b.3097) reporting of notifications were added to the admin interface (called "Cumulus Dashboard" in the relevant release announcement at [https://cumulus.hosiene.co.uk/viewtopic.php?p=148406#p148406 Cumulus MX Announcements and Download - PLEASE READ FIRST],
#* At 3.9.5 (b. 3100) the latching functionality was corected,
#* At 3.9.6 (b.3101) the alarm latch hours were all defaulted to 24 hours,
#* At 3.11.0 (build 3129) where the email functionality was added,
#* And at 3.11.2 (b. 3131) where the [https://cumulus.hosiene.co.uk/viewtopic.php?p=154233#p154233 release announcement] says "this release sees the Alarms getting some more love".
# Please check earlier on this page to see whether any update has been made yet for changes to Alarms in subsequent releases, as this page may be badly out of date.

"Shown on Settings page?" and "MX Section" columns:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were "always" shown, and none required opening a "MX section".
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings on the "Internet Settings" page, where there is a section "Email Server Settings" that needs to be opened, and a ''master'' setting that determines whether other settings are shown or not.

"Label on Settings page" column:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were shown using [[MX_Basic_info#dataTables|a HTML table]], so the entry in the label column in the table below quotes the text shown after the check box that starts the settings table row
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings where the label column quotes the text shown beside the individual setting, but all other alarm related settings quote the text shown after the check box that starts a settings table row

== Table showing Alarm details ==

At last update, this table shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but most of the information that is included below remains valid.

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!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:300px" | Description
|-
| alarmhighgust=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated (by default over 10 minutes) wind gust that has to be exceeded to trigger the alarm
|-
| alarmhighpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure that has to be exceeded to trigger the alarm
|-
| alarmhighrainrate=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated rainfall rate that has to be exceeded to trigger the alarm
|-
| alarmhighraintoday=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated [[Meteorological day|daily]] rainfall total that has to be exceeded to trigger the alarm
|-
| alarmhightemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured outside temperature that has to be exceeded to trigger the alarm
|-
| alarmhighwind=
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated average wind speed that has to be exceeded to trigger the alarm
|-
|-
| alarmlowpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure it must go below to trigger the alarm
|-
| alarmlowtemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0
| Use the spin button to select the '''Value''' of measured outside temperature it must go below to trigger the alarm
|-
| alarmpresschange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Pressure changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured Sea Level Pressure must rapidly change (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| alarmtempchange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Temperature changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured outside temperature must rapidly change (in legacy Cumulus this was based on taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| BatteryLowAlarmEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Station batteries are low
| (blank)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| BatteryLowAlarmLatch=
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| BatteryLowAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| BatteryLowAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| BatteryLowAlarmSet=0
| (always)
| [Alarms]
| (changed at 3.10.3)
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if the weather station either supplies a voltage, or other battery indication that can be interpreted, and MX interprets that as indicating a low battery
|-
| BatteryLowAlarmSound=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| BatteryLowAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataSpikeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataSpikeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataSpikeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataSpikeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataSpikeAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataSpikeAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataSpikeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataStoppedAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataStoppedAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataStoppedAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataStoppedAlarmNotify=0
| (always)
| [Alarms]
| Release 3.4.2
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataStoppedAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataStoppedAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataStoppedAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DestEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| To email adressess(es)
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter either a ''single email address'' or '''a list of email addresses''' here, a semicolon must be used as separator between addresses.
|-
| Enabled=0
| When section opened
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| If you tick here, a selection of further options (identified by ^) are shown
|-
| FromEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| From email address
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter a single email addresss
|-
| HighGustAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighGustAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighGustAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighGustAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighGustAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighGustAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighGustAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainRateAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainRateAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainRateAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainRateAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainRateAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainRateAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainRateAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainTodayAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainTodayAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainTodayAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainTodayAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainTodayAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainTodayAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainTodayAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighTempAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighTempAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighWindAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighWindAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighWindAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighWindAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighWindAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighWindAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighWindAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| HttpUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HttpUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HttpUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HttpUploadAlarmSet=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HttpUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HttpUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 1 (trigger immediately a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Logging=0
| ^
| [SMTP]
| Release 3.11.2
| Depends on release:
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Email logging
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want to enable extra SMTP logging to the smtp.log file in the [[MXdiags folder|'''MXdiags''' folder]].
* Don't tick (value shown as 0 in Cumulus.ini) for no extra information in diagnostic logging
|-
| LowPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| LowPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| LowTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowTempAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| At time of writing there is a MX bug:
* (Reads) LowTempAlarmSoundFile=alarm.mp3
* (Writes) LowTempAlarm.SoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| MySqlUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| MySqlUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| MySqlUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| MySqlUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| MySqlUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Password=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Password
| (blank)
| Text box where you enter password needed to authenticate with your SMTP email server
|-
| Port=587
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Network Port
| 587
| Text box where you enter the port used to connect to your SMTP email server
|-
| PressChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| PressChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| PressChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| PressChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| PressChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if measured Sea Level Pressure rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| PressChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| PressChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| RequiresAuthentication=0
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use authentication
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if a user name and password is needed to authenticate with your SMTP email server
* Don't tick (value shown as 0 in Cumulus.ini) if your SMTP email server is not protected by a user name or password
|-
| SensorAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| SensorAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| SensorAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| SensorAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| SensorAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| SensorAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| SensorAlarmSoundFile==alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| ServerName=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Server Name
| (blank)
| Text box where you enter name, or IP address of your SMTP email server
|-
| SSLOption=1
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security)
| 1 (Auto)
| Drop down:
* 0 = None
* 1 = Auto
* 2 = TLS on connect
* 3 = Start TLS
* 4 = Start TLS when available
|-
| SpikeAlarmTriggerCount=
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Data spike is detected
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| TempChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| TempChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| TempChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| TempChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| TempChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| TempChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| TempChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UpgradeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| UpgradeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| UpgradeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| UpgradeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| UpgradeAlarmSet=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| UpgradeAlarmSound=0
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| UpgradeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UseHTML=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| '''Email uses HTML text formatting'''
| 0 (UTF-8 plain text)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you wish to use HTML encoding format for your customised emails
* Don't tick (value shown as 0 in Cumulus.ini) if you are happy to use the default emails text in UTF-8 plain text encoding
|-
| User=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Username
| (blank)
| Text box where you enter user name needed to authenticate with your SMTP email server
|}

File:Dashboard alarms.png

2022-08-21T06:24:15Z

Sfws: Sfws moved page File:Dshboard alarms.png to File:Dashboard alarms.png without leaving a redirect

File:Dashboard alarms.png

2022-08-21T06:23:48Z

Sfws:

Alarms

2022-08-21T06:20:50Z

Sfws:

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

MX has a sophisticated system allowing alarms to be displayed (and optionally other actions, including sending emails) for many different events.

This Wiki page lists the alarms available, and provides some guidance for using the alarm settings page in the interface.

It briefly covers the file that stores alarm settings, but see [[Cumulus.ini|main Cumulus.ini page]] for more general information.

Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change, it is hoped that presenting Alarms as a separate small Wiki page will make it more likely that somebody will keep it up to date.

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

The settings described here are stored in a file called "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.

== Why are settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>

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.

= The Alarm Settings=

Once again, be aware that the information shown may be badly out of date, as MX evolves very quickly.

== The "Alarm settings" screen in interface ==

The following screenshot is for release 3.20.0, showing some invalid selections (red edged), some selections made (entries ticked or populated with content), and is intended just as an indication of what you may see. The files listed for sound are at path of '''CumulusMX/interface/sounds'''. Alarm latch time hours are from 3.20.0 able to take decimal values, earlier releases only accepted integer latch hour values. The ''Action'' columns are new at 3.20.0, and can be used to call a script or run external exe etc. but are not listed in the table below.

[[File:Alarm settings.png]]

==Notes for table below ==

In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX.

For release 3.11.2 and subsequent each individual alarm also has to be enabled for it to appear in that display. Please see [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 release announcements in the support forum] for information on individual alarms, to help you find the appropriate post, and indication is given in the table of which release introduced each alarm:

Introduction column:
# There was no alarm functionality in builds in the 3.0.0 and 3.1.x series
# Any alarm functionality where the column says "Legacy Cumulus" was available before 1.9.0 and introduced into MX in one of the releases between 3.2.0 and 3.5.4.
# Any alarm functionality where the column says "Cumulus 2" was requested for that withdrawn flavour, subsequently added to a 1.9.x release, and was introduced into MX in one of the releases between 3.2.0 and 3.5.4; rather than indicate the precise release any introductions in that range of releases has that range shown.
# For alarm functionality first introduced in or after release 3.7.0, the exact release of introduction is shown in "Introduced" column.
# There were no changes to Alarm functionality between 3.7.1 and 3.8.4 inclusive, so if you are running one of the 3.8.x releases, the Wiki page that applies for "alarms" is [[Cumulus.ini_(MX_3.0.0_to_3.7.0)|the early MX releases page]], not this Wiki page.
# In the range of releases subsequent to 3.9.0 as covered by this Wiki page, the alarm functionality has been dramatically changing:
#* Latching of alarms was introduced at 3.9.1 (b. 3096), most alarms had no default for how long they stayed "latched", but at least one had a 12 hour default and at least one had an until end of day default.
#* At 3.9.2 (b.3097) reporting of notifications were added to the admin interface (called "Cumulus Dashboard" in the relevant release announcement at [https://cumulus.hosiene.co.uk/viewtopic.php?p=148406#p148406 Cumulus MX Announcements and Download - PLEASE READ FIRST],
#* At 3.9.5 (b. 3100) the latching functionality was corected,
#* At 3.9.6 (b.3101) the alarm latch hours were all defaulted to 24 hours,
#* At 3.11.0 (build 3129) where the email functionality was added,
#* And at 3.11.2 (b. 3131) where the [https://cumulus.hosiene.co.uk/viewtopic.php?p=154233#p154233 release announcement] says "this release sees the Alarms getting some more love".
# Please check earlier on this page to see whether any update has been made yet for changes to Alarms in subsequent releases, as this page may be badly out of date.

"Shown on Settings page?" and "MX Section" columns:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were "always" shown, and none required opening a "MX section".
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings on the "Internet Settings" page, where there is a section "Email Server Settings" that needs to be opened, and a ''master'' setting that determines whether other settings are shown or not.

"Label on Settings page" column:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were shown using [[MX_Basic_info#dataTables|a HTML table]], so the entry in the label column in the table below quotes the text shown after the check box that starts the settings table row
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings where the label column quotes the text shown beside the individual setting, but all other alarm related settings quote the text shown after the check box that starts a settings table row

== Table showing Alarm details ==

At last update, this table shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but most of the information that is included below remains valid.

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!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:300px" | Description
|-
| alarmhighgust=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated (by default over 10 minutes) wind gust that has to be exceeded to trigger the alarm
|-
| alarmhighpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure that has to be exceeded to trigger the alarm
|-
| alarmhighrainrate=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated rainfall rate that has to be exceeded to trigger the alarm
|-
| alarmhighraintoday=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated [[Meteorological day|daily]] rainfall total that has to be exceeded to trigger the alarm
|-
| alarmhightemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured outside temperature that has to be exceeded to trigger the alarm
|-
| alarmhighwind=
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated average wind speed that has to be exceeded to trigger the alarm
|-
|-
| alarmlowpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure it must go below to trigger the alarm
|-
| alarmlowtemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0
| Use the spin button to select the '''Value''' of measured outside temperature it must go below to trigger the alarm
|-
| alarmpresschange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Pressure changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured Sea Level Pressure must rapidly change (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| alarmtempchange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Temperature changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured outside temperature must rapidly change (in legacy Cumulus this was based on taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| BatteryLowAlarmEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Station batteries are low
| (blank)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| BatteryLowAlarmLatch=
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| BatteryLowAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| BatteryLowAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| BatteryLowAlarmSet=0
| (always)
| [Alarms]
| (changed at 3.10.3)
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if the weather station either supplies a voltage, or other battery indication that can be interpreted, and MX interprets that as indicating a low battery
|-
| BatteryLowAlarmSound=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| BatteryLowAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataSpikeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataSpikeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataSpikeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataSpikeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataSpikeAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataSpikeAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataSpikeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataStoppedAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataStoppedAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataStoppedAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataStoppedAlarmNotify=0
| (always)
| [Alarms]
| Release 3.4.2
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataStoppedAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataStoppedAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataStoppedAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DestEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| To email adressess(es)
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter either a ''single email address'' or '''a list of email addresses''' here, a semicolon must be used as separator between addresses.
|-
| Enabled=0
| When section opened
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| If you tick here, a selection of further options (identified by ^) are shown
|-
| FromEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| From email address
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter a single email addresss
|-
| HighGustAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighGustAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighGustAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighGustAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighGustAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighGustAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighGustAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainRateAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainRateAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainRateAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainRateAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainRateAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainRateAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainRateAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainTodayAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainTodayAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainTodayAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainTodayAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainTodayAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainTodayAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainTodayAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighTempAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighTempAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighWindAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighWindAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighWindAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighWindAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighWindAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighWindAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighWindAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| HttpUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HttpUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HttpUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HttpUploadAlarmSet=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HttpUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HttpUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 1 (trigger immediately a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Logging=0
| ^
| [SMTP]
| Release 3.11.2
| Depends on release:
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Email logging
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want to enable extra SMTP logging to the smtp.log file in the [[MXdiags folder|'''MXdiags''' folder]].
* Don't tick (value shown as 0 in Cumulus.ini) for no extra information in diagnostic logging
|-
| LowPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| LowPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| LowTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowTempAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| At time of writing there is a MX bug:
* (Reads) LowTempAlarmSoundFile=alarm.mp3
* (Writes) LowTempAlarm.SoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| MySqlUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| MySqlUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| MySqlUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| MySqlUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| MySqlUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Password=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Password
| (blank)
| Text box where you enter password needed to authenticate with your SMTP email server
|-
| Port=587
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Network Port
| 587
| Text box where you enter the port used to connect to your SMTP email server
|-
| PressChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| PressChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| PressChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| PressChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| PressChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if measured Sea Level Pressure rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| PressChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| PressChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| RequiresAuthentication=0
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use authentication
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if a user name and password is needed to authenticate with your SMTP email server
* Don't tick (value shown as 0 in Cumulus.ini) if your SMTP email server is not protected by a user name or password
|-
| SensorAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| SensorAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| SensorAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| SensorAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| SensorAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| SensorAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| SensorAlarmSoundFile==alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| ServerName=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Server Name
| (blank)
| Text box where you enter name, or IP address of your SMTP email server
|-
| SSLOption=1
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security)
| 1 (Auto)
| Drop down:
* 0 = None
* 1 = Auto
* 2 = TLS on connect
* 3 = Start TLS
* 4 = Start TLS when available
|-
| SpikeAlarmTriggerCount=
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Data spike is detected
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| TempChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| TempChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| TempChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| TempChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| TempChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| TempChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| TempChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UpgradeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| UpgradeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| UpgradeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| UpgradeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| UpgradeAlarmSet=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| UpgradeAlarmSound=0
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| UpgradeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UseHTML=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| '''Email uses HTML text formatting'''
| 0 (UTF-8 plain text)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you wish to use HTML encoding format for your customised emails
* Don't tick (value shown as 0 in Cumulus.ini) if you are happy to use the default emails text in UTF-8 plain text encoding
|-
| User=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Username
| (blank)
| Text box where you enter user name needed to authenticate with your SMTP email server
|}

Alarms

2022-08-21T06:18:34Z

Sfws: Added screen shot

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

MX has a sophisticated system allowing alarms to be displayed (and optionally other actions, including sending emails) for many different events.

This Wiki page lists the alarms available, and provides some guidance for using the alarm settings page in the interface.

It briefly covers the file that stores alarm settings, but see [[Cumulus.ini|main Cumulus.ini page]] for more general information.

Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change, it is hoped that presenting Alarms as a separate small Wiki page will make it more likely that somebody will keep it up to date.

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

The settings described here are stored in a file called "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.

== Why are settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>

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.

= Latest list of Alarm Settings=

Once again, be aware that the information shown may be badly out of date, as MX evolves very quickly. The following screenshot is for release 3.20.0, showing some invalid selections (red edged), some selections made (entries ticked or populated with content), and is intended just as an indication of what you may see. The files listed for sound are at path of '''CumulusMX/interface/sounds'''. Alarm latch time hours are from 3.20.0 able to take decimal values, earlier releases only accepted integer latch hour values. The ''Action'' columns are new at 3.20.0, and can be used to call a script or run external exe etc. but are not listed in the table below.

[[File:Alarm settings.png]]

==Notes==

In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX.

For release 3.11.2 and subsequent each individual alarm also has to be enabled for it to appear in that display. Please see [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 release announcements in the support forum] for information on individual alarms, to help you find the appropriate post, and indication is given in the table of which release introduced each alarm:

Introduction column:
# There was no alarm functionality in builds in the 3.0.0 and 3.1.x series
# Any alarm functionality where the column says "Legacy Cumulus" was available before 1.9.0 and introduced into MX in one of the releases between 3.2.0 and 3.5.4.
# Any alarm functionality where the column says "Cumulus 2" was requested for that withdrawn flavour, subsequently added to a 1.9.x release, and was introduced into MX in one of the releases between 3.2.0 and 3.5.4; rather than indicate the precise release any introductions in that range of releases has that range shown.
# For alarm functionality first introduced in or after release 3.7.0, the exact release of introduction is shown in "Introduced" column.
# There were no changes to Alarm functionality between 3.7.1 and 3.8.4 inclusive, so if you are running one of the 3.8.x releases, the Wiki page that applies for "alarms" is [[Cumulus.ini_(MX_3.0.0_to_3.7.0)|the early MX releases page]], not this Wiki page.
# In the range of releases subsequent to 3.9.0 as covered by this Wiki page, the alarm functionality has been dramatically changing:
#* Latching of alarms was introduced at 3.9.1 (b. 3096), most alarms had no default for how long they stayed "latched", but at least one had a 12 hour default and at least one had an until end of day default.
#* At 3.9.2 (b.3097) reporting of notifications were added to the admin interface (called "Cumulus Dashboard" in the relevant release announcement at [https://cumulus.hosiene.co.uk/viewtopic.php?p=148406#p148406 Cumulus MX Announcements and Download - PLEASE READ FIRST],
#* At 3.9.5 (b. 3100) the latching functionality was corected,
#* At 3.9.6 (b.3101) the alarm latch hours were all defaulted to 24 hours,
#* At 3.11.0 (build 3129) where the email functionality was added,
#* And at 3.11.2 (b. 3131) where the [https://cumulus.hosiene.co.uk/viewtopic.php?p=154233#p154233 release announcement] says "this release sees the Alarms getting some more love".
# Please check earlier on this page to see whether any update has been made yet for changes to Alarms in subsequent releases, as this page may be badly out of date.

"Shown on Settings page?" and "MX Section" columns:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were "always" shown, and none required opening a "MX section".
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings on the "Internet Settings" page, where there is a section "Email Server Settings" that needs to be opened, and a ''master'' setting that determines whether other settings are shown or not.

"Label on Settings page" column:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were shown using [[MX_Basic_info#dataTables|a HTML table]], so the entry in the label column in the table below quotes the text shown after the check box that starts the settings table row
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings where the label column quotes the text shown beside the individual setting, but all other alarm related settings quote the text shown after the check box that starts a settings table row

== Table showing Alarm details ==

At last update, this table shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but most of the information that is included below remains valid.

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!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:300px" | Description
|-
| alarmhighgust=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated (by default over 10 minutes) wind gust that has to be exceeded to trigger the alarm
|-
| alarmhighpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure that has to be exceeded to trigger the alarm
|-
| alarmhighrainrate=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated rainfall rate that has to be exceeded to trigger the alarm
|-
| alarmhighraintoday=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated [[Meteorological day|daily]] rainfall total that has to be exceeded to trigger the alarm
|-
| alarmhightemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured outside temperature that has to be exceeded to trigger the alarm
|-
| alarmhighwind=
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated average wind speed that has to be exceeded to trigger the alarm
|-
|-
| alarmlowpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure it must go below to trigger the alarm
|-
| alarmlowtemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0
| Use the spin button to select the '''Value''' of measured outside temperature it must go below to trigger the alarm
|-
| alarmpresschange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Pressure changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured Sea Level Pressure must rapidly change (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| alarmtempchange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Temperature changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured outside temperature must rapidly change (in legacy Cumulus this was based on taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| BatteryLowAlarmEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Station batteries are low
| (blank)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| BatteryLowAlarmLatch=
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| BatteryLowAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| BatteryLowAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| BatteryLowAlarmSet=0
| (always)
| [Alarms]
| (changed at 3.10.3)
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if the weather station either supplies a voltage, or other battery indication that can be interpreted, and MX interprets that as indicating a low battery
|-
| BatteryLowAlarmSound=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| BatteryLowAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataSpikeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataSpikeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataSpikeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataSpikeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataSpikeAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataSpikeAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataSpikeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataStoppedAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataStoppedAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataStoppedAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataStoppedAlarmNotify=0
| (always)
| [Alarms]
| Release 3.4.2
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataStoppedAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataStoppedAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataStoppedAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DestEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| To email adressess(es)
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter either a ''single email address'' or '''a list of email addresses''' here, a semicolon must be used as separator between addresses.
|-
| Enabled=0
| When section opened
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| If you tick here, a selection of further options (identified by ^) are shown
|-
| FromEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| From email address
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter a single email addresss
|-
| HighGustAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighGustAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighGustAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighGustAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighGustAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighGustAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighGustAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainRateAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainRateAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainRateAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainRateAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainRateAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainRateAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainRateAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainTodayAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainTodayAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainTodayAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainTodayAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainTodayAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainTodayAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainTodayAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighTempAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighTempAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighWindAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighWindAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighWindAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighWindAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighWindAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighWindAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighWindAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| HttpUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HttpUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HttpUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HttpUploadAlarmSet=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HttpUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HttpUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 1 (trigger immediately a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Logging=0
| ^
| [SMTP]
| Release 3.11.2
| Depends on release:
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Email logging
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want to enable extra SMTP logging to the smtp.log file in the [[MXdiags folder|'''MXdiags''' folder]].
* Don't tick (value shown as 0 in Cumulus.ini) for no extra information in diagnostic logging
|-
| LowPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| LowPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| LowTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowTempAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| At time of writing there is a MX bug:
* (Reads) LowTempAlarmSoundFile=alarm.mp3
* (Writes) LowTempAlarm.SoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| MySqlUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| MySqlUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| MySqlUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| MySqlUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| MySqlUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Password=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Password
| (blank)
| Text box where you enter password needed to authenticate with your SMTP email server
|-
| Port=587
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Network Port
| 587
| Text box where you enter the port used to connect to your SMTP email server
|-
| PressChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| PressChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| PressChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| PressChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| PressChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if measured Sea Level Pressure rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| PressChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| PressChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| RequiresAuthentication=0
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use authentication
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if a user name and password is needed to authenticate with your SMTP email server
* Don't tick (value shown as 0 in Cumulus.ini) if your SMTP email server is not protected by a user name or password
|-
| SensorAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| SensorAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| SensorAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| SensorAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| SensorAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| SensorAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| SensorAlarmSoundFile==alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| ServerName=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Server Name
| (blank)
| Text box where you enter name, or IP address of your SMTP email server
|-
| SSLOption=1
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security)
| 1 (Auto)
| Drop down:
* 0 = None
* 1 = Auto
* 2 = TLS on connect
* 3 = Start TLS
* 4 = Start TLS when available
|-
| SpikeAlarmTriggerCount=
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Data spike is detected
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| TempChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| TempChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| TempChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| TempChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| TempChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| TempChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| TempChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UpgradeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| UpgradeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| UpgradeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| UpgradeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| UpgradeAlarmSet=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| UpgradeAlarmSound=0
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| UpgradeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UseHTML=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| '''Email uses HTML text formatting'''
| 0 (UTF-8 plain text)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you wish to use HTML encoding format for your customised emails
* Don't tick (value shown as 0 in Cumulus.ini) if you are happy to use the default emails text in UTF-8 plain text encoding
|-
| User=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Username
| (blank)
| Text box where you enter user name needed to authenticate with your SMTP email server
|}

File:Alarm settings.png

2022-08-21T05:50:04Z

Sfws:

Alarms

2022-08-20T19:50:22Z

Sfws: Correct categories

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

MX has a sophisticated system allowing alarms to be displayed (and optionally emails sent) for many different events.

This Wiki page lists the alarms available, and provides an expanded version of the hints found within the alarm settings page in the interface.

At last update, it shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

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

The settings described here are stored in a file called "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.

== Why are settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>

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.

= Latest list of Alarm Settings=

Once again, be aware that the information shown may be badly out of date, as MX evolves very quickly.

==Notes==

In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX.

For release 3.11.2 and subsequent each individual alarm also has to be enabled for it to appear in that display. Please see [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 release announcements in the support forum] for information on individual alarms, to help you find the appropriate post, and indication is given in the table of which release introduced each alarm:

Introduction column:
# There was no alarm functionality in builds in the 3.0.0 and 3.1.x series
# Any alarm functionality where the column says "Legacy Cumulus" was available before 1.9.0 and introduced into MX in one of the releases between 3.2.0 and 3.5.4.
# Any alarm functionality where the column says "Cumulus 2" was requested for that withdrawn flavour, subsequently added to a 1.9.x release, and was introduced into MX in one of the releases between 3.2.0 and 3.5.4; rather than indicate the precise release any introductions in that range of releases has that range shown.
# For alarm functionality first introduced in or after release 3.7.0, the exact release of introduction is shown in "Introduced" column.
# There were no changes to Alarm functionality between 3.7.1 and 3.8.4 inclusive, so if you are running one of the 3.8.x releases, the Wiki page that applies for "alarms" is [[Cumulus.ini_(MX_3.0.0_to_3.7.0)|the early MX releases page]], not this Wiki page.
# In the range of releases subsequent to 3.9.0 as covered by this Wiki page, the alarm functionality has been dramatically changing:
#* Latching of alarms was introduced at 3.9.1 (b. 3096), most alarms had no default for how long they stayed "latched", but at least one had a 12 hour default and at least one had an until end of day default.
#* At 3.9.2 (b.3097) reporting of notifications were added to the admin interface (called "Cumulus Dashboard" in the relevant release announcement at [https://cumulus.hosiene.co.uk/viewtopic.php?p=148406#p148406 Cumulus MX Announcements and Download - PLEASE READ FIRST],
#* At 3.9.5 (b. 3100) the latching functionality was corected,
#* At 3.9.6 (b.3101) the alarm latch hours were all defaulted to 24 hours,
#* At 3.11.0 (build 3129) where the email functionality was added,
#* And at 3.11.2 (b. 3131) where the [https://cumulus.hosiene.co.uk/viewtopic.php?p=154233#p154233 release announcement] says "this release sees the Alarms getting some more love".
# Please check earlier on this page to see whether any update has been made yet for changes to Alarms in subsequent releases, as this page may be badly out of date.

"Shown on Settings page?" and "MX Section" columns:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were "always" shown, and none required opening a "MX section".
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings on the "Internet Settings" page, where there is a section "Email Server Settings" that needs to be opened, and a ''master'' setting that determines whether other settings are shown or not.

"Label on Settings page" column:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were shown using [[MX_Basic_info#dataTables|a HTML table]], so the entry in the label column in the table below quotes the text shown after the check box that starts the settings table row
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings where the label column quotes the text shown beside the individual setting, but all other alarm related settings quote the text shown after the check box that starts a settings table row

== Table showing Alarm details ==

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!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:300px" | Description
|-
| alarmhighgust=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated (by default over 10 minutes) wind gust that has to be exceeded to trigger the alarm
|-
| alarmhighpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure that has to be exceeded to trigger the alarm
|-
| alarmhighrainrate=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated rainfall rate that has to be exceeded to trigger the alarm
|-
| alarmhighraintoday=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated [[Meteorological day|daily]] rainfall total that has to be exceeded to trigger the alarm
|-
| alarmhightemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured outside temperature that has to be exceeded to trigger the alarm
|-
| alarmhighwind=
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated average wind speed that has to be exceeded to trigger the alarm
|-
|-
| alarmlowpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure it must go below to trigger the alarm
|-
| alarmlowtemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0
| Use the spin button to select the '''Value''' of measured outside temperature it must go below to trigger the alarm
|-
| alarmpresschange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Pressure changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured Sea Level Pressure must rapidly change (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| alarmtempchange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Temperature changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured outside temperature must rapidly change (in legacy Cumulus this was based on taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| BatteryLowAlarmEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Station batteries are low
| (blank)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| BatteryLowAlarmLatch=
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| BatteryLowAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| BatteryLowAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| BatteryLowAlarmSet=0
| (always)
| [Alarms]
| (changed at 3.10.3)
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if the weather station either supplies a voltage, or other battery indication that can be interpreted, and MX interprets that as indicating a low battery
|-
| BatteryLowAlarmSound=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| BatteryLowAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataSpikeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataSpikeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataSpikeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataSpikeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataSpikeAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataSpikeAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataSpikeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataStoppedAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataStoppedAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataStoppedAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataStoppedAlarmNotify=0
| (always)
| [Alarms]
| Release 3.4.2
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataStoppedAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataStoppedAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataStoppedAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DestEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| To email adressess(es)
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter either a ''single email address'' or '''a list of email addresses''' here, a semicolon must be used as separator between addresses.
|-
| Enabled=0
| When section opened
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| If you tick here, a selection of further options (identified by ^) are shown
|-
| FromEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| From email address
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter a single email addresss
|-
| HighGustAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighGustAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighGustAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighGustAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighGustAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighGustAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighGustAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainRateAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainRateAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainRateAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainRateAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainRateAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainRateAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainRateAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainTodayAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainTodayAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainTodayAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainTodayAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainTodayAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainTodayAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainTodayAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighTempAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighTempAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighWindAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighWindAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighWindAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighWindAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighWindAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighWindAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighWindAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| HttpUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HttpUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HttpUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HttpUploadAlarmSet=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HttpUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HttpUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 1 (trigger immediately a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Logging=0
| ^
| [SMTP]
| Release 3.11.2
| Depends on release:
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Email logging
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want to enable extra SMTP logging to the smtp.log file in the [[MXdiags folder|'''MXdiags''' folder]].
* Don't tick (value shown as 0 in Cumulus.ini) for no extra information in diagnostic logging
|-
| LowPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| LowPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| LowTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowTempAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| At time of writing there is a MX bug:
* (Reads) LowTempAlarmSoundFile=alarm.mp3
* (Writes) LowTempAlarm.SoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| MySqlUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| MySqlUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| MySqlUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| MySqlUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| MySqlUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Password=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Password
| (blank)
| Text box where you enter password needed to authenticate with your SMTP email server
|-
| Port=587
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Network Port
| 587
| Text box where you enter the port used to connect to your SMTP email server
|-
| PressChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| PressChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| PressChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| PressChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| PressChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if measured Sea Level Pressure rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| PressChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| PressChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| RequiresAuthentication=0
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use authentication
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if a user name and password is needed to authenticate with your SMTP email server
* Don't tick (value shown as 0 in Cumulus.ini) if your SMTP email server is not protected by a user name or password
|-
| SensorAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| SensorAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| SensorAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| SensorAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| SensorAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| SensorAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| SensorAlarmSoundFile==alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| ServerName=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Server Name
| (blank)
| Text box where you enter name, or IP address of your SMTP email server
|-
| SSLOption=1
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security)
| 1 (Auto)
| Drop down:
* 0 = None
* 1 = Auto
* 2 = TLS on connect
* 3 = Start TLS
* 4 = Start TLS when available
|-
| SpikeAlarmTriggerCount=
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Data spike is detected
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| TempChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| TempChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| TempChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| TempChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| TempChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| TempChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| TempChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UpgradeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| UpgradeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| UpgradeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| UpgradeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| UpgradeAlarmSet=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| UpgradeAlarmSound=0
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| UpgradeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UseHTML=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| '''Email uses HTML text formatting'''
| 0 (UTF-8 plain text)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you wish to use HTML encoding format for your customised emails
* Don't tick (value shown as 0 in Cumulus.ini) if you are happy to use the default emails text in UTF-8 plain text encoding
|-
| User=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Username
| (blank)
| Text box where you enter user name needed to authenticate with your SMTP email server
|}

MySqlConnect

2022-08-20T19:49:01Z

Sfws: Correct categories

=Introduction=

[[Category:Configuration Files]][[Category:Cumulus MX]]

In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulus 3 software (MX beta 3.0.0).

Essentially, MX can ''either'' create and update one, or more, of three tables (by default called "realtime", "monthly", and "dayfile"; although these names can be changed by the Cumulus user) where it determines the '''schema''' (what columns appear in the database table); ''or'' MX can run SQL (devised by user) against tables (created by user) that can have any "schema" (columns in the table) chosen by user at one, or more, of three intervals (MX calls these "custom seconds", "custom minutes", and "custom rollover").

This Wiki page provides a brief introduction to SQL, and describes the settings that define how this functionality is controlled.

At last update, this Wiki page shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

==What is SQL?==

SQL is an abbreviation of "Structured Query Language", SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey.

==How does MX use SQL?==

MX uses two types of SQL.

MX uses SQL when updating a SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type of database stores data in what is known technically as a sequential file. In a sequential file, the data appears as a number of lines that have to be stored in order (by row number). Because entries can be deleted, not every possible row number has to be present, but new entries are appended at end. The various fields (or columns) are named, it is possible (but rarely done) to change the order of the columns, rewriting the entire database file. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifying content, but that gets translated into a row number to actually determine the row that is updated.

MX also uses SQL when creating, or updating, a relational database type. The commands issued by "MySqlConnect" software work with two types of relational databases, MySQL (commercial software by Oracle) and MariaDB (free software from an independent provider). A relational database also uses the row, column, and field terminology; but there is no control over the order in which rows are stored, there is an order for columns (although you can change the column order), and rows are identified by a unique key (known as "primary key" as a row can contain a secondary key that links to data in another table). Any retrieval query can specify that what is returned from that query should be sorted in an ascending/descending order of the value(s) in specified column(s).

As mentioned earlier, MX supports (default) tables where it determines the columns in the table , and (custom) tables where the user determines the columns. For the default tables, every MySqlConnect command issued by MX specifies column names, so those columns must be present in the table, but can be in any order. (If the user adds extra columns, those extra columns must be defined with null as default value, so MX can ignore them). Some MX releases add columns that were not present in earlier MX releases, and these releases should provide a utility that will add the extra columns to existing tables.

===How does MX use MySqlConnect?===

MySqlConnect is used by both [[Software#Current_Release|CumulusMX.exe]] and [[Software#Export_To_MySQL|ExportToMySQL.exe]], but the latter only works with two of the default tables (those called "monthly" and "dayfile", or as renamed by the user).

Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:

{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu → MySQL settings → General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu → MySQL settings → Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu → MySQL settings → Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu → MySQL settings → Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu → MySQL settings → Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}

=The My SQL settings page in interface=

MX controls settings for the relational database tables on a page called "MySQL settings" although you may be using "MariaDB".

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

== Predetermined SQL ==

The custom table options in MX require you to specify the SQL in advance of it being used, and are therefore intended for use to predetermine all the SQL you might use (conditionals can be included to decide what queries actually get executed if there are alternatives). You can enable/disable individual settings, but the mechanism is not designed to do any one-off actions like creating the custom tables.

WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MariaDB syntax.

Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....);

BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>

== Why are Cumulus settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

MX has been developed very dramatically by Mark Crossley:
# The MySQL settings for the original 3.0.0 beta were 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)|that latter documentation remains available 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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>
# Since the MySQL settings have continued to change, since 2021 they have been moved here from that last mentioned page.

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

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

The settings described here are stored in a file called "Cumulus.ini".

The file is divided into "File sections", 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.

==Content of "Cumulus.ini" relating to MySQL==

* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu → MySQL settings

{| 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
|-
| BufferOnFailure=0
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlMinutesEnabled=0
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlRolloverEnabled=0
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous, and next, options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| Custom Upload - seconds interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlSecondsEnabled=0
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal rollover updates and "ExportToMySQl.exe" will use the table name you define. Depending which MX release you use, the option to update table when you edit "dayfile.txt" may fail!
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but at some releases the option to update table when you edit "MMMyyyyLog.txt" may fail
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* 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
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see begining of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}

Software

2022-08-20T19:37:15Z

Sfws:

[[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX.

= What is Cumulus MX? =

: a cross platform version of Cumulus software that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X.

'''NOTE relating to MX Release v3.9.1 or later: On Linux/RPi/macOS, Mono version 5, or 6, is needed for CreateMissing.Exe, ExportToMySQL.exe, and CumulusMX.exe. Mono v4 is subject to random crashes.'''

==CumulusMX.exe Usage Restriction==

Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default MX web site]], include the [https://www.highcharts.com HighStock] product.

Are you using MX for a non-profit organisation, personal website, or school project?
Then download MX and start using it with Highcharts today.

Are you representing any commercial organisation running a facility that others use? If so, then you cannot use Cumulus MX to share weather data on behalf of your organisation without buying a licence from the High Charts organisation.

'''HighCharts rules for usage of their products are described ''' [https://shop.highcharts.com/ on their licence purchase web page], and ''it is your responsibility to ensure compliance''.

== Help with ‘Stable’ MX releases ==

If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]].

It is recommended you check you have complied with any instructions in the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before seeking help (to see what changes in any release affect you, and what actions you may need to take).

If you wish to research the documentation on MX to try to resolve your problem yourself, use the entry point of the [[:Category:Cumulus MX]] page for pointers to other Wiki pages connected with MX that may help.

If you cannot answer your questions from information in this Wiki (and MX changes so quickly any information here can be very out of date), then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] and the developer or Cumulus community will offer assistance.

==Upgrading==

We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest release:
* You may wish to wait a few days after a new release comes out, just in case a new release has some bugs
** MX is extremely complex, the developers work on MX edits in their spare time, have settings that suit them, and do not have the full set of sensors that MX can support, so pre-release testing is never perfect
* By switching to latest release, you gain any extra functionality it may offer (although it may not be useful to you), but more importantly you gain fixes of bugs your existing release may have
* Also the main developer can most easily offer support if you are using the build he most recently released.

There are inter-dependencies between different files in the MX release distribution:
* ''Therefore you must always install into your MX folders, every file included in the download zip''.
** You can take a back-up of your existing installation before you copy in any new files, that will provide you with the ability to regress to the earlier release, if the new release does cause you an issue
* If you customise any file that is in the distribution, either give the new file a new name (perhaps add a prefix of "_" in front of files you edit) or place your tailored version in a different folder
** Either approach will ensure your tailored files are not overwritten by files from the download, and let you compare your tailored file with the new file in the download to see if you need to tweak your tailored file
* It is strongly recommended that you install all files in the download for a new release of MX directly over your existing installation.
** You may end up with some files no longer needed by the new release, left over from older release, but this is better than risking missing some vital files

: There is an [[Updating_MX_to_new_version#Installer_Option|installer utility]] available to help with upgrading.

*Important, please read all of the release notes (in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 appropriate forum announcement] threads) for the builds since the version you are upgrading from, especially noting when there are references to necessary once-off actions.
*If you have never upgraded before, or you are currently running a fairly old release of MX, you are advised to read the [[Updating MX to new version]] page in this Wiki,
** you may be recommended to upgrade in stages, as certain releases do essential one off actions that are missed if you skip that release; e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables
** overwriting an existing installation will add any new files, but it won't remove obsolete files, and sometimes [[MX_Basic_info#Library_software|replacement files]] have different names to their predecessors so don't overwrite the old files
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page
** However, it is likely that information on those pages was written for earlier MX releases, and might be out of date, so like many other people you might want to ask in the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have more up-to-date advice.

Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software that have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software.

== Current Release ==

===Latest build distribution download===

~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3196/CumulusMXDist3196.zip Cumulus MX v3.19.3 build 3196, 25-July-2022]

===Latest MX Source Code===

~ View/download [https://github.com/cumulusmx/CumulusMX Cumulus MX Current Source Code]

This source code base is updated for all releases resulting from development by M Crossley, it includes some contributions from other developers.

===Raspberry Pi Image===

~ Download [//{{SERVERNAME}}/Downloads/rpi-CumulusMX-lite-3.19.0.zip Raspberry Pi Image for Cumulus MX 3.19.0]

As at April 2022, the image includes Raspberry Pi. O. S. 11 "Bullseye" version of Linux.

 

# This is a pre-built disk image file for your first installation onto a Raspberry Pi computer.
# Do read the instructions for using this image on the [[Raspberry_Pi_Image|Raspberry Pi Image]] page to see what is in the image and how to use it
# It is of course possible that sometimes the image provided may have issues for you,
#* it is set up so that MX starts running as a service immediately you boot up your Raspberry Pi, rather than letting you first run MX interactively (see [[MX_on_Linux#Running_MX]]);
#* it is produced with a Raspberry Pi model 3, so with other models you may need to replace the Mono software included in image, and consider what updating rates your model can support;
#* it is produced using a GB locale and GB time-zone, so that automatically started MX may not initially be running correctly for your locale (however as you need to restart MX after changing settings you should be okay when MX starts recording data).

: Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono).

==Older releases==

It is always possible that a new release introduces a bug, and you decide to regress to an earlier release.

Find link to earlier MX release distributions [https://github.com/cumulusmx/CumulusMX/releases here].

(You can search using the history tab on this Wiki page to see which past builds were made available as Raspberry Pi images, as these are not created for all releases, but there is no way to tell if the old filenames can still be downloaded. Generally, it is easiest to download a different normal MX release distribution over whatever MX release was in the image you downloaded.)

= Other utilities =

==By Mark Crossley==

The following download zips do not include the ''*.dll'' files ("software libraries") needed to run the respective utility, these are provided in the MX release zip that is stated alongside download link. The different utilities vary with regard to which software libraries they require, and those with technical understanding can check the code sources.

If you are using an earlier MX release than that stated, upgrade MX to bring in the new "*.dll" files needed, because the utility will not work with the versions of "software libraries" included with earlier MX releases.

If you are using a later MX release than that stated, check [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 the MX release announcements] for all releases since that stated to see if the "software libraries" have been upgraded, if they have then the respective utility because it has been compiled with older versions of the respective .dll files will probably not work. (Sometimes the names of new .dll files are different to the names of the old .dll files, so an upgrade of MX done by copying files over an existing installation will leave the old files there, in that case the utility might still work by picking up old names).

=== Create Records ===

This utility is not yet available.

A utility to create, or recreate, missing [[Correcting_Extremes|extreme records]] from Cumulus MX by parsing your [[dayfile.txt|daily summary (dayfile.txt)]].

=== Create Missing ===

~ The CreateMissing.exe ''v1.2.1'' download dated 20 May 2022 (works with release of MX 3.14.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.2.1/CreateMissing-v1.2.1.zip is here].

Check compatibility with the MX release you have running as per notes above. (Although earlier releases of "Create Missing" exist on "github.com/cumulusmx/CreateMissing/releases", their software bugs imply they should not be used). Install into same directory as "CumulusMX.exe".

This MX utility, affects [[Category:Files with Comma Separated Values|Cumulus CSV files]]:
# It will create a new [[dayfile.txt|daily summary (dayfile.txt)]]. If you already have a "dayfile.txt", that is renamed, the new file should include individual fields, and lines, missing from your old file.
# It will read, and where appropriate update, your [[Standard log files|month by month (MMMyylog.txt)]] files.
#* The utility reads the [[Calculate_Missing_Values#Source_value|source values]] in as input values. This utility has the ability to calculate many of the [[Calculate_Missing_Values#Derived_value|derived fields]], so will add those derived values to your month by month files as it proceeds.
#* Therefore the utility should be used to add the [[Standard_log_files#Number_of_fields_per_line_varies_by_release|extra fields]] for those months where the input file was produced by Cumulus 1 or an earlier release of MX (which might have populated fewer fields or used a [[Feels_Like#How_to_express_Feels_Like_for_highest_temperatures|different calculation]]).

Usage information by the author of the utility can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.]
* Learn more about this utility by reading the [[Calculate_Missing_Values#CreateMissing.exe|calculate missing]] page in this Wiki.
** Elsewhere on that same page learn when this utility might be useful, and what else you can try.
* Check in the support forum for information about status of bugs in this utility, at time of last updating this paragraph there was an outstanding issue concerning storing the line in dayfile.txt for the first of some months if your rollover time is not midnight.
* For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page.

=== Export ''To'' MySQL ===

~ The ExportToMySQL.exe ''v1.4.1'' download dated 21 June 2022 (works with release of MX 3.18.0) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.4.1/ExportToMySQL-v1.4.1.zip is here.]

Check compatibility with the MX release you have running as per notes above. Note that compatibility is needed both with the .dll files and with the columns present in the table to be updated.

If you are not using the MX release named above, then other release zips (and source code) for this utility are available at [https://github.com/cumulusmx/ExportToMySQL/releases ExportToMySQL/releases] and each release there is labelled as to which MX release creates default tables with correct columns.

This utility reads [[MySqlConnect|Settings]] that are also used by "CumulusMX.exe". Parameters supplied to this utility enable it to do ''one of the following actions'' affecting a [[Your Own Server|MySQL, or MariaDB, database server]]:
# The parameter used is "dayfile", will update a database table that is called "dayfile" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of [[dayfile.txt|daily summary (dayfile.txt)]] file
# Update a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of the single file of [[Standard log files|month by month (MMMyylog.txt)]] whose relative path "data/..." is named in the parameter
# The parameter used is "monthy", will update a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of all files of type [[Standard log files|month by month (MMMyylog.txt)]] found in the [[Data folder|data sub-folder]].

Installation and usage information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.]

''This new utility replaces the "ExportMySQL.exe" (no "To" in that name) utility included by Steve Loft in his MX beta distributions.'' That is not compatible with any recent MX releases.

==By Steve Loft==

Source code for these utilities are not available, therefore they cannot be altered or upgraded.

=== Utility for Fine Offset Stations ===

*[//{{SERVERNAME}}/Downloads/SetLogger.zip Set Logger Interval] A utility by Steve Loft to adjust the internal logging interval on Fine Offset stations

=== Weather Display Converter ===

This utility was provided by Steve to convert '''Weather Display''' log files to Cumulus 1 format, download [https://cumuluswiki.org/a/File:WDconverter.zip here].

Please read the readme file in the zip.

There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about using this converter with the legacy Cumulus here].

 

At time of creating this utility, the functionality offered by MX was limited, and this utility was not useful with MX. MX now has much more functionality, and depending on the release you are using, this utility may be useful. Remember this utility will not support all fields used by MX. It is advised you use [[#Create Missing]] (see above) after using this utility to populate the other fields. If you do find this utility does not work with your MX release, you may need to manually recreate records, etc. using Cumulus 1 formats, and then [[Migrating from Cumulus 1 to MX|Migrate all your files from Cumulus 1 to MX]].

=== WeatherLink Converter ===

This utility was provided by Steve to convert Davis '''WeatherLink''' log files to Cumulus format, download [https://cumuluswiki.org/a/File:WLconverter.zip here].

Note this has nothing to do with Davis ''Weather Link Live'' despite confusing similarity in name.

Please read the '''readme''' file in the zip.

* There is a recent [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=20017 forum thread about using this converter with MX here]
* There is an older [https://cumulus.hosiene.co.uk/viewtopic.php?t=11349 forum thread about using this converter with the legacy Cumulus here].

== Third Party Contributions by other Cumulus Users ==

For files, and add-on's, contributed by Cumulus users, see these Categories (where third party authors may have mentioned what they offer):
# [[:Category:3rd Party Apps]] - contributions for various devices,
# [[:Category:AddOns]] - adding extra functionality,
# [[:Category:WebTools]] - for your web server, and
# [[:Category:User_Contributions]] - key contributions from the user community

=Current MX Developed from =

Cumulus 3 (MX) software was developed as a beta with limited functionality by Steve Loft.
* Steve Loft previously developed Cumulus 2 (where he tested using the C# language, now used for MX)
* Steve Loft created the original Cumulus software (now known as legacy cumulus 1) just for his use, before making it generally available, he then developed it over the next decade to include requirements suggested by thousands of users.
* Steve Loft, the author of Cumulus/Cumulus MX has since fully retired, and stopped providing support, or updates, to any of his software.

==Steve's final beta MX==

You can download below the final Cumulus 3 beta release, as made available by Steve Loft, and also his ''subsequent'' final source code.

If you are able to understand his source code (linked below), and compare it to the latest source code (linked above), you can appreciate the transformation that has taken place in recent years.

*[//{{SERVERNAME}}/Downloads/CumulusMXDist3043.zip Cumulus MX v3.0.0 beta build 3043, 20-Jan-2017] Cumulus MX, a cross platform version of Cumulus 3 which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X (Steve Loft - final release), single zip that includes both "CumulusMX.exe" and "ExportMySQL.exe".
*[//{{SERVERNAME}}/Downloads/CumulusMXSource.zip subsequent updated Cumulus MX Source Code] from Steve Loft. He made the following comments, as he handed the project over to "the community":
**This version of the code is post the last release I made at build 3043 as it includes some extra changes that I have not finalised.
**My source code is offered as my parting gift, completely '''without support''', in the hope that it might be useful to future developers.
**My source code is very badly structured due to the 'Frankenstein' way I cobbled it together from various places. Some of it is a machine translation of parts of Cumulus 1.

= Legacy releases =

See [[Downloads| downloads page]] for full details.

== Cumulus 1 ==

Cumulus 1 software was popular, when it went public in 2008, and its [[Cumulus_Users|usage]] grew very rapidly in the subsequent decade. Even now (in mid-2022) some people are still using the final release version (and a quite substantial number of public viewable weather sites are still driven by earlier builds).

Be aware, the longer you wait before swapping from legacy to Cumulus MX software; the more that MX will have developed away from the legacy. MX's development has effectively abandoned its former focus on compatibility, so you might encounter more difficulty with [[Migrating from Cumulus 1 to MX|transferring your data files when you migrate]].

In all months of 2020, (when the year selection drop-down provided in all releases of original software reached its limit, and MX gained a substantial increase in functionality), and continuing into mid-2021, there was an avalanche of people who used to use the legacy software successfully swapping to MX. As of mid-2022, the usage of this legacy software is in fast decline, implying fewer people can offer assistance.

The '''installer for the FINAL release of the legacy Cumulus 1''' is available here:
#[//{{SERVERNAME}}/Downloads/CumulusSetup.exe Cumulus 1099 installer] Full set of files within an installer.
#* On the "this period" type, and snow index, screens you can still manually enter any year,but you have to over-type with the full year yourself, outside range 2008 to 2020.
#* You cannot manually regenerate NOAA reports after 2020, but there is no problem with automatic generation.
#[//{{SERVERNAME}}/Downloads/cumulus.1099.2.zip Cumulus 1.9.4 build 1099.2 patch] Patched version of one file (cumulus.exe) to replace that file from above installer
#* Note this is not the full installation package, just one file to replace in the suite of files created by the installer.
#* This patch modifies the drop-down year selectors, (on "this period" screens, for NOAA reports, and for Snow Index) making it easier to choose date entries (patch version 1099.2 was released 28 Jan 2020) up to the year 2030.

=== Legacy Cumulus 1 Resources ===

*[//{{SERVERNAME}}/Downloads/Cumulus%20basic%20installation%20guide.pdf Cumulus installation guide] Instructions for installing Cumulus 1
*[//{{SERVERNAME}}/Downloads/readme.txt Cumulus readme.txt] Please read this before installing or updating Cumulus
*[//{{SERVERNAME}}/Downloads/Cumulus.chm Cumulus help file] The Cumulus 1 help file (this also gets installed when Cumulus is installed)
*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French
*[//{{SERVERNAME}}/Downloads/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight (Silverlight is no longer developed or supported by Microsoft) application for displaying 2 extra dials showing real time wind data on the standard Cumulus gauges page (with temperature and rainfall in histogram style) for a web site

=== Special Variants ===

It is '''STRONGLY RECOMMENDED''' that users of Cumulus '''1.9.4 variants''' migrate to Cumulus MX, which has ongoing support by Mark Crossley. The baud rate can be selected within MX as a configuration setting.

*[//{{SERVERNAME}}/Downloads/CumulusSetup1100.zip Cumulus 1.9.4 build 1100 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 115200 baud, you should use build 1100
*[//{{SERVERNAME}}/Downloads/CumulusSetup1101.zip Cumulus 1.9.4 build 1101 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 19200 baud, you should use build 1101
*'''NOTE:''' '''These Cumulus 1.9.4 variants will not have any updates in the future.'''
* The patch for Cumulus.exe, cannot be used with these variants
* The menu items with year drop-down selectors will not display years beyond 2020.
**For example, this will happen on manual generation of NOAA-style reports.
**This does not affect any automatic generation of NOAA reports, but does prevent re-generation.

== Cumulus 2 ==

The software for Cumulus 2 alpha release is no longer available.

Cumulus.ini

2022-08-20T18:23:44Z

Sfws: Some of the sections needing updating have been "cut" from this page, and "pasted" into new pages

<big>Please note this page was created 13 June 2021.

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

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

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

=Purpose of Cumulus.ini file=

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

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

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

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

[[Category:Configuration Files]]
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>

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

==Need to install MX 3.12.0 ==

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

The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from [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].

== Simplifications ==

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

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

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

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

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

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

=Structure of Cumulus.ini=

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

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

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

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

=How this Wiki page classifies settings=

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

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

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

==Tabular presentation==

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

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

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

==Terminology used on this Wiki Page==

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

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

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

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

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

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

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

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

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

=Settings Configuration for MX=

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

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

==What happens if I upgrade MX?==

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

==Where do I change settings?==

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

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

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

==Do I need to restart MX?==

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

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

The settings available on the various pages in the admin interface fall into two groups:
#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.

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

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

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

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

==How to Remove Redundant parameters from file==

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

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

''The following procedure is best done after'', not before, you [[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:

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

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

*Introduced Release 3.10.0 - build 3115
* File Section is [Program]

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|EnableAccessibility=0
| Two places where you can edit this setting:
* (Either) Program Settings → (First tick box)
* (Or) Station Settings → (First tick box)
|Enable accessibility features
|0 (disable)
|Determines styling of settings pages:
*Set to 1 to make this (and other pages) appear in a '''button selection''' style (more friendly on an accessibility basis).
*Leave it at zero for a '''Click ▶to expand, click ▼ to collapse''' styling.
|}

== Alarms (and emails) ==

The Alarm settings seem to frequently be changed by new MX releases, so have been moved to a separate [[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?

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

==Data Logging==

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

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

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

==Debugging==

* Available from beta MX.
* File Section is [Station]
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:300px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| Logging=1
| Depends on release installed:
# Alternatives:
#* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Debug logging
| 0 (disabled)
| This adds extra information about data transfers between your weather station and MX.

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

==Extra Web Files==

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

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

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

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:800px" | Description
|-
|style="background:lightgray;"|[FTP site]
|
|
|style="background:lightgray;"|Section name
|-
|ExtraLocal0= to ExtraLocal99=
|Local File Name
|(empty)
|You can enter:
* A relative path name, with respect to the "CumulusMX" root folder
** 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]
** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
* 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=
|Destination Filename
|(empty)
|Defines where MX is to upload file to
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
**I can't tell you what the file path is for your web server, but I can give a couple of examples to steer you
*** e.g. httpdocs/dayfile.txt
*** e.g. public_html/thismonthyear.htm
* If the FTP is not ticked, the file path should be full path for a file on the computer running MX
** e.g. /var/www/html/weather/images/moon.png could be destinatation for uploading the MX generated moon image to a Linux hosted [[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=
|Process
|0
|Simple tick or not
* 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'''
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
|-
|ExtraRealtime0= to ExtraRealtime99=
|Realtime
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if
*# 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]])
|-
|ExtraFTP0= to ExtraFTP99=
|FTP
|1
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
* Don't tick (value shown as 0 in Cumulus.ini) if the remote file is on the computer running MX and a simple Copy File is required
|-
|ExtraUTF0= to ExtraUTF99=
|UTF-8
|1
|Please see [[Reports_folder#Encoding|technical guidance on encoding]]
*Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters
*If unticked (0 appears in file), then iso-8859-1 encoding is used
|-
|ExtraBinary0= to ExtraBinary99=
|Binary
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
|-
|ExtraEOD0= to ExtraEOD99=
|End of Day
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
* Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]])
|}

== Location==

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

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| Altitude=0
| Station Settings → Location
| Altitude
| 0
| The height above mean sea level where the (pressure) sensor is positioned
|-
| AltitudeInFeet=1
| Station Settings → Location
| Altitude Units
| Default depends on release:
# 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=
| Station Settings → Location
| Name
| (empty)
| A short name for the location
|-
| LocDesc=
| Station Settings → Location
| Description
| (empty)
| A longer description for the location
|-
| "Latitude=0" and "LatTxt="
| Station Settings → Location → Latitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere → North or South"
| (blank)
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|-
| "Longitude=0" and "LongTxt="
| Station Settings → Location → Longitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere → East or West"
| (blank)
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
|}

==Optional Report Settings==

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

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

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

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

===Normal Mean Temperatures===

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

===Normal Precipitation===

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

==Optional Structured Query Language Settings==

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

Since the text that appeared here was added, documenting plans for the future 3.12.0 release, there have been a number of changes, and now a future release (3.20.0) is expected to make more drastic changes. Therefore the content has been moved to a [[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"
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | File Section
!style="width:60px" | MX Section
!style="width:80px" | Action on Settings page
!style="width:20px" | Default
|-
| <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
|-
| <pre>User=
Password=
Language=en
Enabled=0
Interval=900
SendUV=0
SendSR=0
SendSoilTemp=0
SendIndoor=0
SendSoilMoisture=0
SendLeafWetness=0
SendAirQuality=0</pre>
| [Awekas]
| AWEKAS
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Enabled=0
CatchUp=1
APIkey=
StationId=
Interval=15</pre>
| [OpenWeatherMap]
| OpenWeatherMap
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [PWSweather]
| PWS Weather
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>User=
Password=
Enabled=0
Interval=60
OauthToken=unknown
OauthTokenSecret=unknown
TwitterSendLocation=1</pre>
| [Twitter]
| Twitter
| Please note that twitter is deprecated, no new settings possible, existing settings can be used by people who migrated from Cumulus 1 with working tokens
| Defaults are as shown in list of parameters
|-
| <pre>Wid=
Key=
Enabled=0
Interval=10
SendUV=0
SendSR=0
SendAQI=0
SendSoilMoisture=0
SoilMoistureSensor=0
SendLeafWetness=0
LeafWetnessSensor=0</pre>
| [WeatherCloud]
| WeatherCloud
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Enabled=0
StationUID=
Password=
Interval=1
SendRain=0</pre>
| [WindGuru]
| Windguru
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>APIkey=
StationIdx=0
Enabled=0
Interval=15
SendUV=0
CatchUp=1</pre>
| [Windy]
| Windy.com
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [WOW]
| Met Office WOW
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|}

==Optional Web Server==

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

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

* File Section is '''[Display]'''
* MX Section is '''Station Settings → 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
|-
| NumWindRosePoints=16
| Legacy Cumulus
| Number of wind rose points
| 16
| Drop-down determining if weather station bearing supplied by weather station is to be converted to 8 or 16 compass directions (i.e. whether to include or exclude (in English) NNE, ENE, ESE, SSE, SSW, WSW, WNW, and NNW
* 8 points
* 16 points
Despite what it says in the hint on the settings page, leave at default whichever weather station type you use, unless this actually causes you a problem. The parameter was introduced by Steve Loft. Davis wind vanes use a potentiometer to measure wind direction so send Cumulus a bearing that can vary continuously between 1 and 360 degrees. Fine Offset wind vanes use magnetic switches that depend on the magnet under the moving part selecting two switches in the fixed part for the vane being exactly in-between compass directions, and selecting one switch for the main 8 directions and slightly away from the main directions; so they have a bias against sending Cumulus the in-between directions.
|-
| UseApparent=1
| ??? MX 3.6.0 or 3.10.0 ???
| Use Apparent Temperature
| Ticked (shown as 1 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display apparent temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus prior to release 3.6.0
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to display feels like temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus from release 3.6.0
|}

=== 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"
|-
!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 )
| (n/a)
| *0 = Disabled (default)
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
|-
| Copy-airquality=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| airquality.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
|-
| Copy-alldailydegdaydata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailydegdaydata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailydegdaydata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailyhumdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailyhumdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailypressdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailypressdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailyraindata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailyraindata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailysolardata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailysolardata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-alldailytempdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailytempdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailywinddata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailywinddata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alltempsumdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| alldailytempsumdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempsumdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-availabledata=0
| [FTP site]
| Release 3.12.0
| ^ (once only)
| Internet Settings → Graph File Settings
| availabledata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[availabledata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-dailyrain=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| dailyrain.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-dailytemp=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailytemp.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-graphconfig=0
| [FTP site]
| Release 3.12.0
| ^ (once only)
| Internet Settings → Graph File Settings
| graphconfig.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[graphconfig.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-humdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| humdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[humdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-pressdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| pressdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[pressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-raindata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| raindata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[raindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-solardata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| solardata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[solardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-sunhours=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| sunhours.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[sunhours.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-tempdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| tempdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[tempdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-wdirdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| wdirdata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[wdirdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-websitedata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Standard File Settings
| websitedata.json → Copy
| 0 (disabled)
| Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]

Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the resulting websitedata.json to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-winddata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Graph File Settings
| winddata.json → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[winddata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-wxnow=0
| [FTP site]
| Release 3.12.0
| ^ (disabled)
| Internet Settings → Standard File Settings
| wxnow.txt → Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy that file to your local web server
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| CopyMoonImage=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings → Moon Image
| Copy Moon image file
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy moon image file to your local web server (need to select "Generate Moon Image" see '''MoonImageEnabled=''' too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-airquality=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| airquality.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the airquality.json file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailydegdaydata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailydegdaydata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailydegdaydata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailyhumdata=0

| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailyhumdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyhumdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailypressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailypressdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailypressdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailyraindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailyraindata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyraindata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailysolardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailysolardata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailysolarydata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-alldailytempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailytempdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alldailywinddata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailywinddata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailywinddata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-alltempsumdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| alldailytempsumdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempsumdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-availabledata=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings → Graph File Settings
| availabledata.json → Generate
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[availabledata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-dailyrain=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailyrain.json → File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailyrain.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-dailytemp=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → File Transfer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-graphconfig=0
| [FTP site]
| Release 3.10.0
| ^ (once only)
| Internet Settings → Graph File Settings
| graphconfig.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[graphconfig.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-humdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| humdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[humdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-pressdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| pressdat.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[pressdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-raindata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| raindata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[raindata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-solardata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| solardata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[solardata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-tempdata=1
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-sunhours=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| dailytemp.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Create-tempdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| tempdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[tempdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-wdirdata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| wdirdata.json → Generate
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[wdirdata.json]] file
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Create-websitedata=0
| [FTP site]
| Release 3.10.0
| ^
| Internet Settings → Graph File Settings
| websitedata.json → Generate
| 1 (enabled)
| Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]

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

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

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

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

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

==Program Start-up Options==

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

==Proxy==

This is a continuation of an experimental legacy Cumulus software feature, please see [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==

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

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

=== Solar===

Cumulus MX is unable to work out if you have a solar sensor, so these options are always displayed.
{| 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
|-
| SolarCalc=0
| [Solar]
| 3.13
| Station Settings → Solar
| Solar Calculation Method
| 0=Ryan-Stololzenbach
| Drop-down list:
* 0=Ryan-Stololzenbach
* 1=Bras
|-
| SunThreshold=75
| [Solar]
| 3.13
| Station Settings → Solar
| Sun Threshold (percent)
| 75
| Enter a number
|-
| SolarMinimum=0
| [Solar]
| 3.13
| Station Settings → Solar
| Solar minimum (W/m2)
| 30
| Enter a number
|-
| RStransfactorJul=0.80000000000000004
| [Solar]
| 3.14
| Station Settings → Solar
| RS Transmission factor (June)

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

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

{| 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
| [Station]
| 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0)
| Station Settings → General Settings
| Station type
| -1 (not yet defined)
| Drop-down
* -1 = "Select Station", shown before a selection from those below is made
* 0 = Davis Vantage Pro station
* 1 = Davis Vantage Pro2 or Vue station
* 2 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wireless connection (e.g. WMR-928 station)
* 3 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wired connection (e.g. WM-918 station)
* 4 = Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
'''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.
* 5 = Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] ('''without''' solar measurement sensors (with or without solar recharging))
* 6 = For all La Crosse WS23xx models e.g. WS2300
* 7 = Fine Offset/Watson/MyDel etc '''with Solar Sensors''' as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]].
* 8 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR100
* 9 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR200
* 10 = Instromet (with optional extra solar sensors or without)
* 11 = Davis WLL
* 12 = Ecowitt GW1000 and Froggit DP1500 (and any equivalents)

'''Selection made here determines what MX sections appear on the Station Settings page
|-
| Model=
| [Station]
| Early legacy version
| Station Settings → General Settings
| Station model
| (empty)
|The weather station model description that you want output by the web tag <#stationtype>
|}

===Airlink===

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

* Introduced Release
* File Section is [AirLink]
* Not Shown on Settings page?
IsWllNode=0
WLv2ApiKey=
WLv2ApiSecret=
AutoUpdateIpAddress=1
In-Enabled=0
In-IPAddress=0.0.0.0
In-WLStationId=-1
In-Hostname=
Out-Enabled=0
Out-IPAddress=0.0.0.0
Out-WLStationId=-1
Out-Hostname=
AQIformula=0
{| 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
|-
|
|}

===Davis===

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

====Davis VP/VP2/Vue====

{{Template:WorkInProgressBanner}} This table does not yet have all details in it.
* Introduced for legacy Cumulus
* File Section is [Station]
* Only "Shown on Settings page" if either "Type=0" or "Type=1"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:120px" | Default
!style="width:800px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|VP2SleepInterval=500
|
|500 (milli-seconds)
|the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds.
* if you suspect that data is being missed, reduce number
*For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
|-
|VPClosedownTime=x
|
|(default not yet documented)
| x is the number of seconds after the start of the re-connect attempts that you want the program to close itself
|-
|DavisCalcAltPress=1
|
|1
|Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude

CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.
*0 = Use SLP supplied by Davis
*1 = Convert the SP Davis supplies to AP using the altitude you have supplied.
|-
|SyncDavisClock=0
|
|0
|When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
*0 = Disabled, default (as deselected on the Station Configuration Screen)
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
|-
|ClockSettingHour=4
|
|4
|Controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*4 = 04:00 (default value)
*0-23 = 00:00 to 23:00
|-
|VP2ConnectionType=1
|
|
|Weather station connection type
*0 = serial (see next parameter to specify COM port)
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
*2 = TCP/IP (see later parameters to specify ports)
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
|-
|VP2TCPPort=22222
|
| 2222
|Communications port used if VP type has TCP/IP selected.
|-
|VP2IPAddr=0.0.0.0
|
| 0.0.0.0
|Weather station IP address if VP type has TCP/IP selected.
|-
|VP2PeriodicDisconnectInterval=0
|
|0 (disable)
|When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.

Set it to zero to disable, if you are not using the Weatherlink site.
|-
|LogExtraSensors=0
|
|0
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
|-
|UseDavisLoop2=1
|
|1 (use Loop2)
|The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
*1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default. The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
*0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.

Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.
|-
|DavisIPResponseTime=500
|
|500
|The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger, see Cumulus MX forum where times up to 2000ms are suggested.
|-
|ForceVPBarUpdate=0
|
|0 (normal)
| Added in build 3042 (January 2017).

The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|-
|DavisIncrementPressureDP=0
|
|1
|(from version 3.0.0 build 3042)
* 0= Pressure values shown to 1 decimal places when reported in mb/hPa, shown to 2 decimal places for inHg
* 1= Pressure values shown to 2 decimal places when reported in mb/hPa, shown to 3 decimal places for inHg
|-
|VPrainGaugeType=0
|
|1
|Specifies the units selected on your Vantage Pro Rain Gauge.
*0 = Metric Rain Adapter fitted, a 0.2mm gauge
*1 = Imperial gauge without adapter, a 0.01" gauge.
Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur.
|-
|DataLogging=0
|
|0
|(Build 3018 onwards).
*0 (default) = Cumulus MX will not add extra logging.
*1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large.
I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards).
|-
|AutoUpdateIpAddress=1
|
|1
|default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
|-
|ZeroConfig
|
|(default not known)
|set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|}

====Davis WeatherLink Live====

{{Template:WorkInProgressBanner}} 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"

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|
|
|
|
|}

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

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

* Introduced in a Legacy version
* File Section is [Station]
* MX Section is "EasyWeather File Settings"
* Only "Shown on Settings page" if "Type=4"

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

See [[FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads|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===

{{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
* File Section is [GW100]
* MX Section is "Ecowitt GW1000 Settings"
* Only "Shown on Settings page" if "Type=12"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|AutoUpdateIpAddress=1
|Auto-discovery
|1 (selected)
|Should MX attempt to discover IP address
*0=Disable
*1=Enable
|-
|IPAddress=
|IP address
|(no default)
| stores the IP address of your GW1000 WiFi logger
|-
|MACAddress=
|MAC addresss
|(no default)
|Populated by MX when auto-discovery enabled
|}

===Fine Offset Stations===

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

{| class="wikitable" border="1"
|-
!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:20px" | Default
!style="width:300px" | Description
|-
| FOReadAvoidPeriod=3
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Read Avoid Period
| 3 (seconds)
| If previous setting enabled, MX will avoid reading the circular memory from the number of seconds specified before it expects Fine Offset to be writing to the circular memory, to the number of seconds specified after it expects Fine Offset to be writing to the circular memory

(One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor)
|-
| ??
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Set the Fine Offset Logger interval to match Cumulus MX interval
| 0 (disabled)
| Simple tick or not - labelled as "Experimental - use with caution"
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to "update the Davis interval" (I said copy and paste was used from Davis section!) to match the interval MX is using.
* Don't tick (value shown as 0 in Cumulus.ini) for no effect on your weather station
|-
| FineOffsetReadTime=150
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Request/Read Delay
| 150 (milliseconds)
| Adjust time (in milliseconds) between request for read, and actual attempt to read data via USB
|-
| ProductID=-1
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| USB Product Id (PID)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|-
| SyncFOReads=0
| Legacy Cumulus
| Only if Fine Offset selected
| Station Settings → Fine Offset Settings
| Synchronise Reads
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
* Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data

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

===Instromet Settings===

{{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
* 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"

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:300px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| ComportName=xxxxxx
| Station Settings → Instromet Settings
| Serial port name
| /dev/ttyUSB0 (on Linux), COM1 (on Microsoft Windows)
| Only required if your station is connected via a real, or virtual, serial port
|-
|ImetBaudRate=19200
| Station Settings → Instromet Settings
| Serial Baud Rate (DavisBaudRate)
| 19200
| Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value
|-
| "SyncDavisClock=0" and "ClockSettingHour=4"
| Station Settings → Instromet Advanced Options
| "Sychronise Station Clock" and "Clock sync hour"
| Tick box not selected, data box set to 4
| Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.

*Simple tick or not
** Tick (value shown as 1 in Cumulus.ini) for MX to attempt to sychronise the Instromet Station Clock with your computer time. This ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time!
** Don't tick (value shown as 0 in Cumulus.ini) if you don't want MX to attempt to keep station clock in line with computer clock
* Box taking an integer
** The hour of the day when, if enabled, Cumulus will set the Instromet clock to within a minute of the same time as the computer. This will happen at a default time of 04:00 each day, (4 a.m.) unless the setting box is edited
|-
| ImetUpdateLogPointer=1
| Station Settings → Instromet Advanced Options
| Update logger pointer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to update the memory pointer to the last record after every 30 data reads
* Don't tick to disable this action
|-
|ImetWaitTime=500
| Station Settings → Instromet Advanced Options
| Delay between sending data read commands
| 500
| Specifies the time in milliseconds that Cumulus waits after one read, before it does the next read from an Instromet station. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
|-
| ImetReadDelay=500
| Station Settings → Instromet Advanced Options
| Delay after sending a command before trying to read data from the serial port
| 500
| Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
|}

===LaCrosse stations===

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

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!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: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 → Common Options → Advanced Options
| La Crosse max wind speed
| ???
| It is setting for the La Crosse max wind speed, where X is the maximum (before calibrated by any definitions in Offsets) wind speed in m/s that you want to allow. The value you supply should be in metres/second, regardless of what wind unit you are using in Cumulus
|}

It is assumed that [[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"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | External to MX edit
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|Humidity98Fix=0
| Stop MX and add this into file
|0 (disable)
|Applies to weather station types that never report more than 98% relative humidity.
*0 = Disabled (default)
*1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98%. Normally only useful for Oregon Scientific stations.
|-
|LogExtraSensors=0
| Stop MX and add this into file
|0 (disable)
|This setting determines whether MX looks for readings from extra temperature probes etc.
*0=Disabled (default)
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors..
|-
|WMR928TempChannel=N
| Stop MX and add this into file
|(by default no extra sensors)
|for WMR-928 stations (and other serial stations using the same protocol, eg WMR-968) to use an 'extra' channel (see previous parameter) as your main temperature sensor, set N to the required channel
|-
|WMR200TempChannel=N
| Stop MX and add this into file
|(by default no extra sensors)
|for WMR200 stations (and any other Oregon Scientific USB stations which work with Cumulus, e.g. WMR100) to use an 'extra' channel as your main temperature sensor, set N to the required channel
|}

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

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

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

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

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

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

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

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

It was welcomed by people outside Israel, it turned out growers are often interested in a growing season rainfall total
|-
| RainUnit=0
| Legacy Cumulus
| Units
| Rain
| 0 (mm)
| Drop-down:
* 0 = millimetres
* 1 = inches
|-
| RoundWindSpeed=0
| Legacy Cumulus
| Common Options
| Rounding of wind speed
| 0 (no)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX 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
|-
| SunshineHrsDecimals=2
| Release 3.8.0
| Units → Advanced Options (Here be dragons!)
| Sunshine hours decimals
| 2 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| TempDecimals=1
| Release 3.9.2
| Units → Advanced Options (Here be dragons!)
| Temperature decimals
| 1 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| TempUnit=0
| Legacy Cumulus
| Units
| Temperature
| 0 (oC
| Drop-down:
* 0 = Celsius
* 1 = Fahrenheit
|-
| UseCumulusForecast=0
| Legacy Cumulus
| Forecast
| Use Cumulus Forecast
| 0 (disabled)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, or as an alternative to the one supplied by your station. Please see [[Forecast_webtag]] for details.
* Don't tick (value shown as 0 in Cumulus.ini) then MX will not do any forecasting, so it will return "not available" unless your weather station provides an alternative forecast
|-
| UseCumulusPresstrendstr=0
| Legacy Cumulus
| Common Options
| Cumulus pressure trend names
| 0 (depends on weather station type)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]].
* Don't tick (value shown as 0 in Cumulus.ini) then effect depends on whether your weather station supplies pressure trends
** If your station does supply pressure trends, then MX will use those
** If your station does not supply pressure trends, then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]].
|-
| UseSpeedForAvgCalc=0
| Legacy Cumulus
| Common Options
| Use speed for average calculation
| 0 (disable)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will use what the weather station supplies as "wind speed" to calculate the average wind speed.
* Don't tick (value shown as 0 in Cumulus.ini) then MX will use what the weather station supplies as "latest wind speed" to calculate the average wind speed
Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details.
|-
| UseZeroBearing=1
| Legacy Software
| Common Options
| Use bearing zero when calm
| 1 (enable)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will report a wind bearing of zero when the wind is calm
* Don't tick (value shown as 0 in Cumulus.ini) then MX will continue to report the last wind bearing when the wind stops blowing
|-
| UVDecimals=1
| Release 3.9.2
| Units → Advanced Options (Here be dragons!)
| Ultra Violet decimals
| 1 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| Wind10MinAverage=0
| Legacy Cumulus
| Common Options
| Calculate average wind speed
| 0 (disable)
| Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then MX will calculate an average wind speed (over ten minutes) as defined by "UseSpeedForAvgCalc" parameter
* Don't tick (value shown as 0 in Cumulus.ini) then MX will use whatever the weather station provides as an average wind speed
Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details.
|-
| WindRunDecimals=1
| Release 3.9.2
| Units → Advanced Options (Here be dragons!)
| Wind run decimals
| 1 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| WindSpeedAvgDecimals=1
| Release 3.8.3
| Units → Advanced Options (Here be dragons!)
| Wind speed average decimals
| 1 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| WindSpeedDecimals=2
| Release 3.8.3
| Units → Advanced Options (Here be dragons!)
| Wind speed average decimals
| 2 (displayed as blank)
| Select a number of decimal places to overwrite the default
|-
| WindUnit=0
| Legacy Cumulus
| Units
| Wind
| Default depends on release:
* Legacy to 3.11.4: 0 (m s-1)
* 3.12.0 onwards: 2 (km hr-1)
| Drop-down:
* 0 = metres per second
* 1 = miles per hour
* 2 = Kilometres per hour
* 3 = Knots (nautical miles per hour or kts)
|-
| YTDrain=0
| Legacy Cumulus
| Annual Rainfall
| Year-to-date amount
| 0 (displayed as blank)
| Enter the amount of rainfall to be added to the calendar year in next parameter (used when start using Cumulus in middle of year)
|-
| YTDrainyear=
| Legacy Cumulus
| Annual Rainfall
| Year to which year-to-date amount applies
| (displayed as blank)
| Enter a 4 digit year:
* Legacy Releases (1.7.12 5 July 2008) and MX up to 3.11.4 (build 3133 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 this year if your first season starts this year, and set this to last year if your second season has started and you don't want the previous value added to your second season
* From Release 3.12.0 (?? 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 starts (be that last calendar year or this calendar year)
|}

MySqlConnect

2022-08-20T18:22:16Z

Sfws: Created page with "=Introduction= Category:Configuration Files In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulu..."

=Introduction=

[[Category:Configuration Files]]

In May 2015, Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=138868#p138868 added SQL functionality] to his Cumulus 3 software (MX beta 3.0.0).

Essentially, MX can ''either'' create and update one, or more, of three tables (by default called "realtime", "monthly", and "dayfile"; although these names can be changed by the Cumulus user) where it determines the '''schema''' (what columns appear in the database table); ''or'' MX can run SQL (devised by user) against tables (created by user) that can have any "schema" (columns in the table) chosen by user at one, or more, of three intervals (MX calls these "custom seconds", "custom minutes", and "custom rollover").

This Wiki page provides a brief introduction to SQL, and describes the settings that define how this functionality is controlled.

At last update, this Wiki page shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

==What is SQL?==

SQL is an abbreviation of "Structured Query Language", SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey.

==How does MX use SQL?==

MX uses two types of SQL.

MX uses SQL when updating a SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type of database stores data in what is known technically as a sequential file. In a sequential file, the data appears as a number of lines that have to be stored in order (by row number). Because entries can be deleted, not every possible row number has to be present, but new entries are appended at end. The various fields (or columns) are named, it is possible (but rarely done) to change the order of the columns, rewriting the entire database file. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifying content, but that gets translated into a row number to actually determine the row that is updated.

MX also uses SQL when creating, or updating, a relational database type. The commands issued by "MySqlConnect" software work with two types of relational databases, MySQL (commercial software by Oracle) and MariaDB (free software from an independent provider). A relational database also uses the row, column, and field terminology; but there is no control over the order in which rows are stored, there is an order for columns (although you can change the column order), and rows are identified by a unique key (known as "primary key" as a row can contain a secondary key that links to data in another table). Any retrieval query can specify that what is returned from that query should be sorted in an ascending/descending order of the value(s) in specified column(s).

As mentioned earlier, MX supports (default) tables where it determines the columns in the table , and (custom) tables where the user determines the columns. For the default tables, every MySqlConnect command issued by MX specifies column names, so those columns must be present in the table, but can be in any order. (If the user adds extra columns, those extra columns must be defined with null as default value, so MX can ignore them). Some MX releases add columns that were not present in earlier MX releases, and these releases should provide a utility that will add the extra columns to existing tables.

===How does MX use MySqlConnect?===

MySqlConnect is used by both [[Software#Current_Release|CumulusMX.exe]] and [[Software#Export_To_MySQL|ExportToMySQL.exe]], but the latter only works with two of the default tables (those called "monthly" and "dayfile", or as renamed by the user).

Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:

{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu → MySQL settings → General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu → MySQL settings → Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu → MySQL settings → Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu → MySQL settings → Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu → MySQL settings → Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu → MySQL settings → Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}

=The My SQL settings page in interface=

MX controls settings for the relational database tables on a page called "MySQL settings" although you may be using "MariaDB".

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

== Predetermined SQL ==

The custom table options in MX require you to specify the SQL in advance of it being used, and are therefore intended for use to predetermine all the SQL you might use (conditionals can be included to decide what queries actually get executed if there are alternatives). You can enable/disable individual settings, but the mechanism is not designed to do any one-off actions like creating the custom tables.

WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MariaDB syntax.

Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....);

BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>

== Why are Cumulus settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

MX has been developed very dramatically by Mark Crossley:
# The MySQL settings for the original 3.0.0 beta were 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)|that latter documentation remains available 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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>
# Since the MySQL settings have continued to change, since 2021 they have been moved here from that last mentioned page.

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

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

The settings described here are stored in a file called "Cumulus.ini".

The file is divided into "File sections", 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.

==Content of "Cumulus.ini" relating to MySQL==

* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu → MySQL settings

{| 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
|-
| BufferOnFailure=0
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| Custom Upload - minutes interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlMinutesEnabled=0
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| Custom Upload - at rollover
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlRolloverEnabled=0
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous, and next, options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| Custom Upload - seconds interval
| Option to enter "SQL command" only shown if next parameter is ticked
| (empty)
| See [[#Predetermined SQL|"predetermined SQL"]] example above
|-
| CustomMySqlSecondsEnabled=0
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal rollover updates and "ExportToMySQl.exe" will use the table name you define. Depending which MX release you use, the option to update table when you edit "dayfile.txt" may fail!
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but at some releases the option to update table when you edit "MMMyyyyLog.txt" may fail
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* 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
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see begining of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}

Alarms

2022-08-20T16:44:59Z

Sfws: Out of date content moved from "Cumulus.ini" page

=Introduction=

[[Category:Configuration Files]]

MX has a sophisticated system allowing alarms to be displayed (and optionally emails sent) for many different events.

This Wiki page lists the alarms available, and provides an expanded version of the hints found within the alarm settings page in the interface.

At last update, it shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but it is hoped that presenting it as a separate Wiki page will make it more likely that somebody will bring it up to date.

{{Template:WorkInProgressBanner}}
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change.

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

The settings described here are stored in a file called "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.

== Why are settings now split between several Wiki pages? ==

The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!

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 in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found [[Cumulus.ini|here]]!</big>

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.

= Latest list of Alarm Settings=

Once again, be aware that the information shown may be badly out of date, as MX evolves very quickly.

==Notes==

In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX.

For release 3.11.2 and subsequent each individual alarm also has to be enabled for it to appear in that display. Please see [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 release announcements in the support forum] for information on individual alarms, to help you find the appropriate post, and indication is given in the table of which release introduced each alarm:

Introduction column:
# There was no alarm functionality in builds in the 3.0.0 and 3.1.x series
# Any alarm functionality where the column says "Legacy Cumulus" was available before 1.9.0 and introduced into MX in one of the releases between 3.2.0 and 3.5.4.
# Any alarm functionality where the column says "Cumulus 2" was requested for that withdrawn flavour, subsequently added to a 1.9.x release, and was introduced into MX in one of the releases between 3.2.0 and 3.5.4; rather than indicate the precise release any introductions in that range of releases has that range shown.
# For alarm functionality first introduced in or after release 3.7.0, the exact release of introduction is shown in "Introduced" column.
# There were no changes to Alarm functionality between 3.7.1 and 3.8.4 inclusive, so if you are running one of the 3.8.x releases, the Wiki page that applies for "alarms" is [[Cumulus.ini_(MX_3.0.0_to_3.7.0)|the early MX releases page]], not this Wiki page.
# In the range of releases subsequent to 3.9.0 as covered by this Wiki page, the alarm functionality has been dramatically changing:
#* Latching of alarms was introduced at 3.9.1 (b. 3096), most alarms had no default for how long they stayed "latched", but at least one had a 12 hour default and at least one had an until end of day default.
#* At 3.9.2 (b.3097) reporting of notifications were added to the admin interface (called "Cumulus Dashboard" in the relevant release announcement at [https://cumulus.hosiene.co.uk/viewtopic.php?p=148406#p148406 Cumulus MX Announcements and Download - PLEASE READ FIRST],
#* At 3.9.5 (b. 3100) the latching functionality was corected,
#* At 3.9.6 (b.3101) the alarm latch hours were all defaulted to 24 hours,
#* At 3.11.0 (build 3129) where the email functionality was added,
#* And at 3.11.2 (b. 3131) where the [https://cumulus.hosiene.co.uk/viewtopic.php?p=154233#p154233 release announcement] says "this release sees the Alarms getting some more love".
# Please check earlier on this page to see whether any update has been made yet for changes to Alarms in subsequent releases, as this page may be badly out of date.

"Shown on Settings page?" and "MX Section" columns:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were "always" shown, and none required opening a "MX section".
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings on the "Internet Settings" page, where there is a section "Email Server Settings" that needs to be opened, and a ''master'' setting that determines whether other settings are shown or not.

"Label on Settings page" column:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were shown using [[MX_Basic_info#dataTables|a HTML table]], so the entry in the label column in the table below quotes the text shown after the check box that starts the settings table row
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings where the label column quotes the text shown beside the individual setting, but all other alarm related settings quote the text shown after the check box that starts a settings table row

== Table showing Alarm details ==

{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!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:300px" | Description
|-
| alarmhighgust=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated (by default over 10 minutes) wind gust that has to be exceeded to trigger the alarm
|-
| alarmhighpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure that has to be exceeded to trigger the alarm
|-
| alarmhighrainrate=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated rainfall rate that has to be exceeded to trigger the alarm
|-
| alarmhighraintoday=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated [[Meteorological day|daily]] rainfall total that has to be exceeded to trigger the alarm
|-
| alarmhightemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured outside temperature that has to be exceeded to trigger the alarm
|-
| alarmhighwind=
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated average wind speed that has to be exceeded to trigger the alarm
|-
|-
| alarmlowpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure it must go below to trigger the alarm
|-
| alarmlowtemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0
| Use the spin button to select the '''Value''' of measured outside temperature it must go below to trigger the alarm
|-
| alarmpresschange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Pressure changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured Sea Level Pressure must rapidly change (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| alarmtempchange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Temperature changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured outside temperature must rapidly change (in legacy Cumulus this was based on taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| BatteryLowAlarmEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Station batteries are low
| (blank)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| BatteryLowAlarmLatch=
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| BatteryLowAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| BatteryLowAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| BatteryLowAlarmSet=0
| (always)
| [Alarms]
| (changed at 3.10.3)
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if the weather station either supplies a voltage, or other battery indication that can be interpreted, and MX interprets that as indicating a low battery
|-
| BatteryLowAlarmSound=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| BatteryLowAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataSpikeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataSpikeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataSpikeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataSpikeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataSpikeAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataSpikeAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataSpikeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataStoppedAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataStoppedAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataStoppedAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataStoppedAlarmNotify=0
| (always)
| [Alarms]
| Release 3.4.2
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataStoppedAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings → Spike removal")
|-
| DataStoppedAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataStoppedAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DestEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| To email adressess(es)
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter either a ''single email address'' or '''a list of email addresses''' here, a semicolon must be used as separator between addresses.
|-
| Enabled=0
| When section opened
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| If you tick here, a selection of further options (identified by ^) are shown
|-
| FromEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| From email address
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.

You can enter a single email addresss
|-
| HighGustAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighGustAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighGustAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighGustAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighGustAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighGustAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighGustAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainRateAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainRateAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainRateAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainRateAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainRateAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainRateAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainRateAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainTodayAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainTodayAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainTodayAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainTodayAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainTodayAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainTodayAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainTodayAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighTempAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighTempAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighWindAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighWindAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighWindAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighWindAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighWindAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighWindAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighWindAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| HttpUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HttpUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HttpUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HttpUploadAlarmSet=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HttpUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HttpUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 1 (trigger immediately a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Logging=0
| ^
| [SMTP]
| Release 3.11.2
| Depends on release:
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Email logging
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want to enable extra SMTP logging to the smtp.log file in the [[MXdiags folder|'''MXdiags''' folder]].
* Don't tick (value shown as 0 in Cumulus.ini) for no extra information in diagnostic logging
|-
| LowPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| LowPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| LowTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowTempAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| At time of writing there is a MX bug:
* (Reads) LowTempAlarmSoundFile=alarm.mp3
* (Writes) LowTempAlarm.SoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| MySqlUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| MySqlUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| MySqlUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| MySqlUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| MySqlUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Password=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Password
| (blank)
| Text box where you enter password needed to authenticate with your SMTP email server
|-
| Port=587
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Network Port
| 587
| Text box where you enter the port used to connect to your SMTP email server
|-
| PressChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| PressChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| PressChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| PressChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| PressChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if measured Sea Level Pressure rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| PressChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| PressChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| RequiresAuthentication=0
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use authentication
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if a user name and password is needed to authenticate with your SMTP email server
* Don't tick (value shown as 0 in Cumulus.ini) if your SMTP email server is not protected by a user name or password
|-
| SensorAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| SensorAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| SensorAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| SensorAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| SensorAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| SensorAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| SensorAlarmSoundFile==alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| ServerName=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Server Name
| (blank)
| Text box where you enter name, or IP address of your SMTP email server
|-
| SSLOption=1
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security)
| 1 (Auto)
| Drop down:
* 0 = None
* 1 = Auto
* 2 = TLS on connect
* 3 = Start TLS
* 4 = Start TLS when available
|-
| SpikeAlarmTriggerCount=
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Data spike is detected
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| TempChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| TempChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| TempChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| TempChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| TempChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| TempChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| TempChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UpgradeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| UpgradeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| UpgradeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| UpgradeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| UpgradeAlarmSet=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| UpgradeAlarmSound=0
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| UpgradeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UseHTML=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| '''Email uses HTML text formatting'''
| 0 (UTF-8 plain text)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you wish to use HTML encoding format for your customised emails
* Don't tick (value shown as 0 in Cumulus.ini) if you are happy to use the default emails text in UTF-8 plain text encoding
|-
| User=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings → Email Server Settings
| Username
| (blank)
| Text box where you enter user name needed to authenticate with your SMTP email server
|}

The Alternative Interface (ai.cmx)

2022-08-10T15:26:20Z

Sfws: /* Technical Changes */

{{TOCright}}
== An Alternative (additional) Interface ==

=== Overview ===

Following the release of the responsive default website for CumulusMX, I am now looking at the development of the main CumulusMX Interface.

Although the main focus of the Interface is to manage your weather station, it also provides your initial view of the data that you are collecting. As such I feel that it should also use the same up-to-date features as the supplied public default website.

Like the public website supplied with CumulusMX, the AI uses colour themes and, wherever possible, is fully responsive. This should make it easier to use on tablets and phones as well as the more traditional desktop/laptop screen.

Like the supplied Interface, the AI includes all the required pages to manage your weather station but also provides some additional information, especially on the dashboard page. It also provides 30+ themes that can be applied to it and the default public website, it required.

=== How it fits with the existing inteface ===

The AI has been developed as an '''alternative''' to the existing Interface - it is '''not a replacement'''. The existing Interface '''should always be retained''' as it is this that will be updated by Mark as and when required.

As said above, the AI includes all the same resources needed to view the data being generated by your website; to configure your station and to edit data should errors occur.

However, some changes to layout have been made:
*The '''Header''' and '''Footer''' are both fixed by default. This can be changed by you if required.
*The '''Menu''' has been adapted to take less space but includes a button to return to the default '''Interface''' pages.
*The header area is now better at being responsive on small screens - reducing in size to give you more space for your data.
=====Viewing generated data=====
*The '''Dashboard''' page
**Shows the '''alarm LEDs''' at the top of the page. (These can be hidden/re-displayed using the button provided with the page title).
**The '''Sun and Moon''' rise & setting times are displayed in a popup; again using the button in the page title bar.
**The Temperature, Pressure, Winds & Rain panels will flash when a new record is set
**For those users with Davis weather stations, you can see '''Packets''' data, '''CRC errors''' and the percentage failure rate. I have found that this last piece of info is a good indicator for when the battery needs changing. This option toggles across sessions so if you hide them they stay hidden until you choose to view them again.
*The '''Charts''' pages
**All charts can be zoomed, i.e., you can swipe the mouse over parts of the chart to view readings in detail.
**The '''recent''' and '''historic''' charts use buttons that always span a complete line (or lines).
**The '''Select-a-Chart''' groups the buttons in two groups of three pairs, as in the default Interface.
*The '''NOAA''' pages
**Both pages have been amended so that the required report loads when a date is selected.
*'''Extra Sensors''' - No significant cosmetic changes

=====Management and Setup Menus=====
*The '''Data Logs''' Menu
**All pages automatically load data when the pages open.
**The '''Readings Logs''' and '''Extra Data Logs''' pages display the last 7 days of entries but this can be changed using the popup calendar. These tables also display metric units for all appropriate data. If you use other units then you will need to edit the three html files. (Details are in the 'readme' file included in the download).
*The '''Settings''' Menu This menu provides access to the same pages as in the default system although some have been redesigned
**The '''MySQL Settings''' page has been made into two columns.
**The '''Alarm Settings''' page has simply been tidied up.
*The '''Edit...''' Menu
**The '''rain editor''' is now much narrower and the shading on read-only entries made more obvious.
**'''Weather Conditions Editor'''
***This is a new page that combines the old ''Current Conditions'' & ''Weather Diary'' pages. The original pages are still available but not in the menu. This can be edited to display the original pages if preferred.
*The four '''Edit Records...''' pages
**These are esentially the same except that editing is done using a popup box rather than in-line. This simply avoids the tables becoming confusing on small screens.
*The '''AI Settings...''' menu
**Gives you access to the various theme colour styles available. Selecting a theme makes it active for the current page '''only'''. To make it ''permanent'' you need to click the '''Use for all pages''' button.
**Enables you to change the status of the header and footer from static to scrolling - either or both.
**You can now also adjust the gap between the body of the page and the header and footer.
----

===Screen Shots===
Below are a number of screenshots of various pages.
<gallery>
Screenshot_Dashboard.png|The Dashboard showing some version 3 developments ideas
Screenshot_Charts.png|A sample of the carts page - note all charts are zoomable and any buttons always spread across the width of the page
Screenshot_TodayVYesterday.png|The Today verses Yesterday page. All panels can be re-ordered as required.
Screenshot_Edit_Data_Logs.png|The 'Edit Data Logs' page showing rows hovered and rows selected.
Screenshot_Edit_Data_Logs_2.png|This is the same page showing the edit popup.
</gallery>
<gallery>
Screenshot_Alarm_Settings.png|The Alarms settings page.
Screenshot_Extra_Web_Files.png|The extra Webfiles page. Note I put a heading in the first entry of every page to identify role of upload.
Screenshot_Weather_Diary_Editor.png|Showing the combined diary and current conditions editor.
AI_Weather_Records.png|Showing the weather records.
AI_Extra_Sensors.png|Version 2 of this page enables you to re-order each block to suite your weather station resources
The_AI_Settings_page.png|Build 3 showing the new AI Settings page
</gallery>
All the above are taken from my current Version 2 of the Interface except the last two.
----

===Technical Changes===
Generally, this has been limited to ensuring that all JavaScript files use the correct URL for '''API''' calls to both read and update settings / data. All modified JavaScript files are included in the '''AI''' package and do not over-write existing files.

The following JavaScript files were (January 2022) additions for the AI.
*'''AI-Charts-Plus.js''': This script handles all buttons on the ''Readings'' and ''Historic'' charts pages.
*'''AI-Page-Manager.js''': This script is a utility used by all pages to control the layout, obtain the CumulusMX Version data, handle the selected theme and various other utilities. If you have hidden the 'Davis Stats Panel' on the Dashboard then this script makes sure it is hidden the next time you open the page.
*'''AI-Configure.js''': This script is only used to configure the AI: Static or scrolling header/footer and gapes between them and the main body. You can also change the colour theme for the site.

Those users not using Microsoft Windows OS should note case inconsistencies; e.g. "ai-config.html" (December 2021) has become "AI-Config.html" now.

This package also includes:
* the '''gauges.js''' file in the ''steelseries'' library - it has been modified to make to make the ''tooltips'' use the theme,
* and the "datatables editor" library - again modified to make use of the themes.

====Things you can change easily====
As already mentioned, the ''Header'' and ''Footer'' area of the site is static by default - i.e. they are always on page. To change this use the '''AI-Config.html''' page. It can also be used to make the header and/or footer scroll and change the gap between the body of the page and the header/footer.

==Download the latest version==
Download the latest current version: [https://cumuluswiki.org/images/c/c2/Ai.cmx.zip the latest ai.cmx ] (''Updated 10th August 2022 @ 15:18'')

This update accommodates the latest update from Mark - build 3196 and also for the All Time Records page so that it shows the overlay.

The records pages now include the ability to update directly from the log files as in the default interface. This upload includes the required changes to the weather diary page. It also includes an update to the Alarms Settings page which I had omitted to edit in the last version.

For full history of changes to the zip see [[File:Ai.cmx.zip|File:Ai-cmx.zip page]].

==Installation==
Once you have downloaded the zip file, extract it '''somewhere other''' than your CumulusMX installation. This will avoid accidentally overwriting your existing Interface contents.

The Extracted package should consist of a single folder - ai.cmx, which can then be copied into the existing Interface folder so it shows as a '''sub-folder'''.

You are then ready to start using it. If you use the url: '''<nowiki>http://localhost:8998/</nowiki>''' to run your normal interface, you can simply add the folder name to the end like so:
'''<nowiki>http://localhost:8998/ai.cmx/</nowiki>'''. (''Note the trailing backslash'')

Of course localhost can be replaced with the IP address of the machine running CumulusMX. Using the IP address of your CumulusMX computer, you can also brows to it from another computer on your ''local'' network.

You still have access to the default interface if you want.

PLEASE read the included ''''ReadMe'''' file as this shows how you can change the '''UNITS''' in the DayFile and Data Logs pages.

The Alternative Interface (ai.cmx)

2022-08-10T15:05:38Z

Sfws: /* Download the latest version */

{{TOCright}}
== An Alternative (additional) Interface ==

=== Overview ===

Following the release of the responsive default website for CumulusMX, I am now looking at the development of the main CumulusMX Interface.

Although the main focus of the Interface is to manage your weather station, it also provides your initial view of the data that you are collecting. As such I feel that it should also use the same up-to-date features as the supplied public default website.

Like the public website supplied with CumulusMX, the AI uses colour themes and, wherever possible, is fully responsive. This should make it easier to use on tablets and phones as well as the more traditional desktop/laptop screen.

Like the supplied Interface, the AI includes all the required pages to manage your weather station but also provides some additional information, especially on the dashboard page. It also provides 30+ themes that can be applied to it and the default public website, it required.

=== How it fits with the existing inteface ===

The AI has been developed as an '''alternative''' to the existing Interface - it is '''not a replacement'''. The existing Interface '''should always be retained''' as it is this that will be updated by Mark as and when required.

As said above, the AI includes all the same resources needed to view the data being generated by your website; to configure your station and to edit data should errors occur.

However, some changes to layout have been made:
*The '''Header''' and '''Footer''' are both fixed by default. This can be changed by you if required.
*The '''Menu''' has been adapted to take less space but includes a button to return to the default '''Interface''' pages.
*The header area is now better at being responsive on small screens - reducing in size to give you more space for your data.
=====Viewing generated data=====
*The '''Dashboard''' page
**Shows the '''alarm LEDs''' at the top of the page. (These can be hidden/re-displayed using the button provided with the page title).
**The '''Sun and Moon''' rise & setting times are displayed in a popup; again using the button in the page title bar.
**The Temperature, Pressure, Winds & Rain panels will flash when a new record is set
**For those users with Davis weather stations, you can see '''Packets''' data, '''CRC errors''' and the percentage failure rate. I have found that this last piece of info is a good indicator for when the battery needs changing. This option toggles across sessions so if you hide them they stay hidden until you choose to view them again.
*The '''Charts''' pages
**All charts can be zoomed, i.e., you can swipe the mouse over parts of the chart to view readings in detail.
**The '''recent''' and '''historic''' charts use buttons that always span a complete line (or lines).
**The '''Select-a-Chart''' groups the buttons in two groups of three pairs, as in the default Interface.
*The '''NOAA''' pages
**Both pages have been amended so that the required report loads when a date is selected.
*'''Extra Sensors''' - No significant cosmetic changes

=====Management and Setup Menus=====
*The '''Data Logs''' Menu
**All pages automatically load data when the pages open.
**The '''Readings Logs''' and '''Extra Data Logs''' pages display the last 7 days of entries but this can be changed using the popup calendar. These tables also display metric units for all appropriate data. If you use other units then you will need to edit the three html files. (Details are in the 'readme' file included in the download).
*The '''Settings''' Menu This menu provides access to the same pages as in the default system although some have been redesigned
**The '''MySQL Settings''' page has been made into two columns.
**The '''Alarm Settings''' page has simply been tidied up.
*The '''Edit...''' Menu
**The '''rain editor''' is now much narrower and the shading on read-only entries made more obvious.
**'''Weather Conditions Editor'''
***This is a new page that combines the old ''Current Conditions'' & ''Weather Diary'' pages. The original pages are still available but not in the menu. This can be edited to display the original pages if preferred.
*The four '''Edit Records...''' pages
**These are esentially the same except that editing is done using a popup box rather than in-line. This simply avoids the tables becoming confusing on small screens.
*The '''AI Settings...''' menu
**Gives you access to the various theme colour styles available. Selecting a theme makes it active for the current page '''only'''. To make it ''permanent'' you need to click the '''Use for all pages''' button.
**Enables you to change the status of the header and footer from static to scrolling - either or both.
**You can now also adjust the gap between the body of the page and the header and footer.
----

===Screen Shots===
Below are a number of screenshots of various pages.
<gallery>
Screenshot_Dashboard.png|The Dashboard showing some version 3 developments ideas
Screenshot_Charts.png|A sample of the carts page - note all charts are zoomable and any buttons always spread across the width of the page
Screenshot_TodayVYesterday.png|The Today verses Yesterday page. All panels can be re-ordered as required.
Screenshot_Edit_Data_Logs.png|The 'Edit Data Logs' page showing rows hovered and rows selected.
Screenshot_Edit_Data_Logs_2.png|This is the same page showing the edit popup.
</gallery>
<gallery>
Screenshot_Alarm_Settings.png|The Alarms settings page.
Screenshot_Extra_Web_Files.png|The extra Webfiles page. Note I put a heading in the first entry of every page to identify role of upload.
Screenshot_Weather_Diary_Editor.png|Showing the combined diary and current conditions editor.
AI_Weather_Records.png|Showing the weather records.
AI_Extra_Sensors.png|Version 2 of this page enables you to re-order each block to suite your weather station resources
The_AI_Settings_page.png|Build 3 showing the new AI Settings page
</gallery>
All the above are taken from my current Version 2 of the Interface except the last two.
----

===Technical Changes===
Generally, this has been limited to ensuring that all JavaScript files use the correct URL for '''API''' calls to both read and update settings / data. All modified JavaScript files are included in the '''AI''' package and do not over-write existing files.

The following JavaScript files are additions for the AI.
*'''AI-Charts-Plus.js''': This script handles all buttons on the ''Readings'' and ''Historic'' charts pages.
*'''AI-Page-Manager.js''': This script is a utility used by all pages to control the layout, obtain the CumulusMX Version data, handle the selected theme and various other utilities. If you have hidden the 'Davis Stats Panel' on the Dashboard then this script makes sure it is hidden the next time you open the page.
*'''AI-Configure.js''': This script is only used to configure the AI: Static or scrolling header/footer and gapes between them and the main body. You can also change the colour theme for the site.

This package also includes the gauges.js file in th esteelseries library - it has been modified to make to make the tooltips use the theme, and the datatables editor library again to make use of the themes.

====Things you can change easily====
As already mentioned, the ''Header'' and ''Footer'' area of the site is static by default - i.e. they are always on page. To change this use the '''AI-Config.html''' page. It can also be used to make the header and/or footer scroll and change the gap between the body of the page and the header/footer.

==Download the latest version==
Download the latest current version: [https://cumuluswiki.org/images/c/c2/Ai.cmx.zip the latest ai.cmx ] (''Updated 10th August 2022 @ 15:18'')

This update accommodates the latest update from Mark - build 3196 and also for the All Time Records page so that it shows the overlay.

The records pages now include the ability to update directly from the log files as in the default interface. This upload includes the required changes to the weather diary page. It also includes an update to the Alarms Settings page which I had omitted to edit in the last version.

For full history of changes to the zip see [[File:Ai.cmx.zip|File:Ai-cmx.zip page]].

==Installation==
Once you have downloaded the zip file, extract it '''somewhere other''' than your CumulusMX installation. This will avoid accidentally overwriting your existing Interface contents.

The Extracted package should consist of a single folder - ai.cmx, which can then be copied into the existing Interface folder so it shows as a '''sub-folder'''.

You are then ready to start using it. If you use the url: '''<nowiki>http://localhost:8998/</nowiki>''' to run your normal interface, you can simply add the folder name to the end like so:
'''<nowiki>http://localhost:8998/ai.cmx/</nowiki>'''. (''Note the trailing backslash'')

Of course localhost can be replaced with the IP address of the machine running CumulusMX. Using the IP address of your CumulusMX computer, you can also brows to it from another computer on your ''local'' network.

You still have access to the default interface if you want.

PLEASE read the included ''''ReadMe'''' file as this shows how you can change the '''UNITS''' in the DayFile and Data Logs pages.

File:Ai-cmx-latest.zip

2022-08-10T15:04:43Z

Sfws: /* Summary */

== Summary ==
This (despite the file name) is out of date, see [[File:Ai.cmx.zip|this page for more up to date zip]]

Zip file containing AI and ReadMe pdf file to help with install

The Alternative Interface (ai.cmx)

2022-08-10T15:02:04Z

Sfws: /* Download the latest version */

{{TOCright}}
== An Alternative (additional) Interface ==

=== Overview ===

Following the release of the responsive default website for CumulusMX, I am now looking at the development of the main CumulusMX Interface.

Although the main focus of the Interface is to manage your weather station, it also provides your initial view of the data that you are collecting. As such I feel that it should also use the same up-to-date features as the supplied public default website.

Like the public website supplied with CumulusMX, the AI uses colour themes and, wherever possible, is fully responsive. This should make it easier to use on tablets and phones as well as the more traditional desktop/laptop screen.

Like the supplied Interface, the AI includes all the required pages to manage your weather station but also provides some additional information, especially on the dashboard page. It also provides 30+ themes that can be applied to it and the default public website, it required.

=== How it fits with the existing inteface ===

The AI has been developed as an '''alternative''' to the existing Interface - it is '''not a replacement'''. The existing Interface '''should always be retained''' as it is this that will be updated by Mark as and when required.

As said above, the AI includes all the same resources needed to view the data being generated by your website; to configure your station and to edit data should errors occur.

However, some changes to layout have been made:
*The '''Header''' and '''Footer''' are both fixed by default. This can be changed by you if required.
*The '''Menu''' has been adapted to take less space but includes a button to return to the default '''Interface''' pages.
*The header area is now better at being responsive on small screens - reducing in size to give you more space for your data.
=====Viewing generated data=====
*The '''Dashboard''' page
**Shows the '''alarm LEDs''' at the top of the page. (These can be hidden/re-displayed using the button provided with the page title).
**The '''Sun and Moon''' rise & setting times are displayed in a popup; again using the button in the page title bar.
**The Temperature, Pressure, Winds & Rain panels will flash when a new record is set
**For those users with Davis weather stations, you can see '''Packets''' data, '''CRC errors''' and the percentage failure rate. I have found that this last piece of info is a good indicator for when the battery needs changing. This option toggles across sessions so if you hide them they stay hidden until you choose to view them again.
*The '''Charts''' pages
**All charts can be zoomed, i.e., you can swipe the mouse over parts of the chart to view readings in detail.
**The '''recent''' and '''historic''' charts use buttons that always span a complete line (or lines).
**The '''Select-a-Chart''' groups the buttons in two groups of three pairs, as in the default Interface.
*The '''NOAA''' pages
**Both pages have been amended so that the required report loads when a date is selected.
*'''Extra Sensors''' - No significant cosmetic changes

=====Management and Setup Menus=====
*The '''Data Logs''' Menu
**All pages automatically load data when the pages open.
**The '''Readings Logs''' and '''Extra Data Logs''' pages display the last 7 days of entries but this can be changed using the popup calendar. These tables also display metric units for all appropriate data. If you use other units then you will need to edit the three html files. (Details are in the 'readme' file included in the download).
*The '''Settings''' Menu This menu provides access to the same pages as in the default system although some have been redesigned
**The '''MySQL Settings''' page has been made into two columns.
**The '''Alarm Settings''' page has simply been tidied up.
*The '''Edit...''' Menu
**The '''rain editor''' is now much narrower and the shading on read-only entries made more obvious.
**'''Weather Conditions Editor'''
***This is a new page that combines the old ''Current Conditions'' & ''Weather Diary'' pages. The original pages are still available but not in the menu. This can be edited to display the original pages if preferred.
*The four '''Edit Records...''' pages
**These are esentially the same except that editing is done using a popup box rather than in-line. This simply avoids the tables becoming confusing on small screens.
*The '''AI Settings...''' menu
**Gives you access to the various theme colour styles available. Selecting a theme makes it active for the current page '''only'''. To make it ''permanent'' you need to click the '''Use for all pages''' button.
**Enables you to change the status of the header and footer from static to scrolling - either or both.
**You can now also adjust the gap between the body of the page and the header and footer.
----

===Screen Shots===
Below are a number of screenshots of various pages.
<gallery>
Screenshot_Dashboard.png|The Dashboard showing some version 3 developments ideas
Screenshot_Charts.png|A sample of the carts page - note all charts are zoomable and any buttons always spread across the width of the page
Screenshot_TodayVYesterday.png|The Today verses Yesterday page. All panels can be re-ordered as required.
Screenshot_Edit_Data_Logs.png|The 'Edit Data Logs' page showing rows hovered and rows selected.
Screenshot_Edit_Data_Logs_2.png|This is the same page showing the edit popup.
</gallery>
<gallery>
Screenshot_Alarm_Settings.png|The Alarms settings page.
Screenshot_Extra_Web_Files.png|The extra Webfiles page. Note I put a heading in the first entry of every page to identify role of upload.
Screenshot_Weather_Diary_Editor.png|Showing the combined diary and current conditions editor.
AI_Weather_Records.png|Showing the weather records.
AI_Extra_Sensors.png|Version 2 of this page enables you to re-order each block to suite your weather station resources
The_AI_Settings_page.png|Build 3 showing the new AI Settings page
</gallery>
All the above are taken from my current Version 2 of the Interface except the last two.
----

===Technical Changes===
Generally, this has been limited to ensuring that all JavaScript files use the correct URL for '''API''' calls to both read and update settings / data. All modified JavaScript files are included in the '''AI''' package and do not over-write existing files.

The following JavaScript files are additions for the AI.
*'''AI-Charts-Plus.js''': This script handles all buttons on the ''Readings'' and ''Historic'' charts pages.
*'''AI-Page-Manager.js''': This script is a utility used by all pages to control the layout, obtain the CumulusMX Version data, handle the selected theme and various other utilities. If you have hidden the 'Davis Stats Panel' on the Dashboard then this script makes sure it is hidden the next time you open the page.
*'''AI-Configure.js''': This script is only used to configure the AI: Static or scrolling header/footer and gapes between them and the main body. You can also change the colour theme for the site.

This package also includes the gauges.js file in th esteelseries library - it has been modified to make to make the tooltips use the theme, and the datatables editor library again to make use of the themes.

====Things you can change easily====
As already mentioned, the ''Header'' and ''Footer'' area of the site is static by default - i.e. they are always on page. To change this use the '''AI-Config.html''' page. It can also be used to make the header and/or footer scroll and change the gap between the body of the page and the header/footer.

==Download the latest version==
Download the latest current version: [https://cumuluswiki.org/images/c/c2/Ai.cmx.zip the latest ai.cmx ] (''Updated 10th August 2022 @ 15:18'')

This update accommodates the latest update from Mark - build 3196 and also for the All Time Records page so that it shows the overlay.

The records pages now include the ability to update directly from the log files as in the default interface. This upload includes the required changes to the weather diary page. It also includes an update to the Alarms Settings page which I had omitted to edit in the last version.

For full history of changes to the zip see [[:File:Ai.cmx.zip|File:Ai-cmx.zip page]].

==Installation==
Once you have downloaded the zip file, extract it '''somewhere other''' than your CumulusMX installation. This will avoid accidentally overwriting your existing Interface contents.

The Extracted package should consist of a single folder - ai.cmx, which can then be copied into the existing Interface folder so it shows as a '''sub-folder'''.

You are then ready to start using it. If you use the url: '''<nowiki>http://localhost:8998/</nowiki>''' to run your normal interface, you can simply add the folder name to the end like so:
'''<nowiki>http://localhost:8998/ai.cmx/</nowiki>'''. (''Note the trailing backslash'')

Of course localhost can be replaced with the IP address of the machine running CumulusMX. Using the IP address of your CumulusMX computer, you can also brows to it from another computer on your ''local'' network.

You still have access to the default interface if you want.

PLEASE read the included ''''ReadMe'''' file as this shows how you can change the '''UNITS''' in the DayFile and Data Logs pages.

The Alternative Interface (ai.cmx)

2022-08-10T15:00:05Z

Sfws: /* Download the latest version */

{{TOCright}}
== An Alternative (additional) Interface ==

=== Overview ===

Following the release of the responsive default website for CumulusMX, I am now looking at the development of the main CumulusMX Interface.

Although the main focus of the Interface is to manage your weather station, it also provides your initial view of the data that you are collecting. As such I feel that it should also use the same up-to-date features as the supplied public default website.

Like the public website supplied with CumulusMX, the AI uses colour themes and, wherever possible, is fully responsive. This should make it easier to use on tablets and phones as well as the more traditional desktop/laptop screen.

Like the supplied Interface, the AI includes all the required pages to manage your weather station but also provides some additional information, especially on the dashboard page. It also provides 30+ themes that can be applied to it and the default public website, it required.

=== How it fits with the existing inteface ===

The AI has been developed as an '''alternative''' to the existing Interface - it is '''not a replacement'''. The existing Interface '''should always be retained''' as it is this that will be updated by Mark as and when required.

As said above, the AI includes all the same resources needed to view the data being generated by your website; to configure your station and to edit data should errors occur.

However, some changes to layout have been made:
*The '''Header''' and '''Footer''' are both fixed by default. This can be changed by you if required.
*The '''Menu''' has been adapted to take less space but includes a button to return to the default '''Interface''' pages.
*The header area is now better at being responsive on small screens - reducing in size to give you more space for your data.
=====Viewing generated data=====
*The '''Dashboard''' page
**Shows the '''alarm LEDs''' at the top of the page. (These can be hidden/re-displayed using the button provided with the page title).
**The '''Sun and Moon''' rise & setting times are displayed in a popup; again using the button in the page title bar.
**The Temperature, Pressure, Winds & Rain panels will flash when a new record is set
**For those users with Davis weather stations, you can see '''Packets''' data, '''CRC errors''' and the percentage failure rate. I have found that this last piece of info is a good indicator for when the battery needs changing. This option toggles across sessions so if you hide them they stay hidden until you choose to view them again.
*The '''Charts''' pages
**All charts can be zoomed, i.e., you can swipe the mouse over parts of the chart to view readings in detail.
**The '''recent''' and '''historic''' charts use buttons that always span a complete line (or lines).
**The '''Select-a-Chart''' groups the buttons in two groups of three pairs, as in the default Interface.
*The '''NOAA''' pages
**Both pages have been amended so that the required report loads when a date is selected.
*'''Extra Sensors''' - No significant cosmetic changes

=====Management and Setup Menus=====
*The '''Data Logs''' Menu
**All pages automatically load data when the pages open.
**The '''Readings Logs''' and '''Extra Data Logs''' pages display the last 7 days of entries but this can be changed using the popup calendar. These tables also display metric units for all appropriate data. If you use other units then you will need to edit the three html files. (Details are in the 'readme' file included in the download).
*The '''Settings''' Menu This menu provides access to the same pages as in the default system although some have been redesigned
**The '''MySQL Settings''' page has been made into two columns.
**The '''Alarm Settings''' page has simply been tidied up.
*The '''Edit...''' Menu
**The '''rain editor''' is now much narrower and the shading on read-only entries made more obvious.
**'''Weather Conditions Editor'''
***This is a new page that combines the old ''Current Conditions'' & ''Weather Diary'' pages. The original pages are still available but not in the menu. This can be edited to display the original pages if preferred.
*The four '''Edit Records...''' pages
**These are esentially the same except that editing is done using a popup box rather than in-line. This simply avoids the tables becoming confusing on small screens.
*The '''AI Settings...''' menu
**Gives you access to the various theme colour styles available. Selecting a theme makes it active for the current page '''only'''. To make it ''permanent'' you need to click the '''Use for all pages''' button.
**Enables you to change the status of the header and footer from static to scrolling - either or both.
**You can now also adjust the gap between the body of the page and the header and footer.
----

===Screen Shots===
Below are a number of screenshots of various pages.
<gallery>
Screenshot_Dashboard.png|The Dashboard showing some version 3 developments ideas
Screenshot_Charts.png|A sample of the carts page - note all charts are zoomable and any buttons always spread across the width of the page
Screenshot_TodayVYesterday.png|The Today verses Yesterday page. All panels can be re-ordered as required.
Screenshot_Edit_Data_Logs.png|The 'Edit Data Logs' page showing rows hovered and rows selected.
Screenshot_Edit_Data_Logs_2.png|This is the same page showing the edit popup.
</gallery>
<gallery>
Screenshot_Alarm_Settings.png|The Alarms settings page.
Screenshot_Extra_Web_Files.png|The extra Webfiles page. Note I put a heading in the first entry of every page to identify role of upload.
Screenshot_Weather_Diary_Editor.png|Showing the combined diary and current conditions editor.
AI_Weather_Records.png|Showing the weather records.
AI_Extra_Sensors.png|Version 2 of this page enables you to re-order each block to suite your weather station resources
The_AI_Settings_page.png|Build 3 showing the new AI Settings page
</gallery>
All the above are taken from my current Version 2 of the Interface except the last two.
----

===Technical Changes===
Generally, this has been limited to ensuring that all JavaScript files use the correct URL for '''API''' calls to both read and update settings / data. All modified JavaScript files are included in the '''AI''' package and do not over-write existing files.

The following JavaScript files are additions for the AI.
*'''AI-Charts-Plus.js''': This script handles all buttons on the ''Readings'' and ''Historic'' charts pages.
*'''AI-Page-Manager.js''': This script is a utility used by all pages to control the layout, obtain the CumulusMX Version data, handle the selected theme and various other utilities. If you have hidden the 'Davis Stats Panel' on the Dashboard then this script makes sure it is hidden the next time you open the page.
*'''AI-Configure.js''': This script is only used to configure the AI: Static or scrolling header/footer and gapes between them and the main body. You can also change the colour theme for the site.

This package also includes the gauges.js file in th esteelseries library - it has been modified to make to make the tooltips use the theme, and the datatables editor library again to make use of the themes.

====Things you can change easily====
As already mentioned, the ''Header'' and ''Footer'' area of the site is static by default - i.e. they are always on page. To change this use the '''AI-Config.html''' page. It can also be used to make the header and/or footer scroll and change the gap between the body of the page and the header/footer.

==Download the latest version==
Download the latest current version: [https://cumuluswiki.org/images/c/c2/Ai.cmx.zip the latest ai.cmx ] (''Updated 10th August 2022 @ 15:18'')

This update accommodates the latest update from Mark - build 3196 and also for the All Time Records page so that it shows the overlay.

The records pages now include the ability to update directly from the log files as in the default interface. This upload includes the required changes to the weather diary page. It also includes an update to the Alarms Settings page which I had omitted to edit in the last version.

For full history of changes to the zip see [[:File:Ai-cmx-latest.zip|File:Ai-cmx-latest.zip page]].

==Installation==
Once you have downloaded the zip file, extract it '''somewhere other''' than your CumulusMX installation. This will avoid accidentally overwriting your existing Interface contents.

The Extracted package should consist of a single folder - ai.cmx, which can then be copied into the existing Interface folder so it shows as a '''sub-folder'''.

You are then ready to start using it. If you use the url: '''<nowiki>http://localhost:8998/</nowiki>''' to run your normal interface, you can simply add the folder name to the end like so:
'''<nowiki>http://localhost:8998/ai.cmx/</nowiki>'''. (''Note the trailing backslash'')

Of course localhost can be replaced with the IP address of the machine running CumulusMX. Using the IP address of your CumulusMX computer, you can also brows to it from another computer on your ''local'' network.

You still have access to the default interface if you want.

PLEASE read the included ''''ReadMe'''' file as this shows how you can change the '''UNITS''' in the DayFile and Data Logs pages.

File:Ai.cmx.zip

2022-08-10T14:55:27Z

Sfws: Updated "summary"

== Summary ==
See file history section to see how rapidly changing MX development has been tracked by changes to contents of this zip.

Today.ini

2022-08-06T17:27:17Z

Sfws: add categories

[[Category:Ini Files]] [[Category:Cumulus 1]] [[Category:Cumulus MX]] This Wiki page previously only covered Cumulus 1; it still covers the legacy software, but has been updated so it focuses on MX.

= Introduction to tracking of Daily Extremes/Totals/Averages =

Steve Loft first wrote Cumulus software in 2003, although it was not shared with the public until 27th January 2004. His (no longer available) web site claimed (amongst other reasons) that Cumulus was invented to cope with [[Meteorological_day|tracking high and low for days starting at 9 a.m.]] as (at that time) no other software could do that. Therefore, it can be assumed that even in 2003, Cumulus software was tracking the highest/lowest for all time as well as for each day . (For daily period, there is also tracking of some totals, and in some cases by dividing by number of samples averages can be calculated). This Wiki page covers all aspects of the daily tracking.

The legacy Cumulus 1 software has a '''Recent extremes''' frame on its [[Cumulus_Screenshots#Main_Screen|main screen]]. In release 1.0 (27th January 2004) this only showed extremes for today, but from 1.1 (17th February 2004) it also shows extremes for yesterday. The interface provided with Cumulus MX is also able to show the extremes for today and yesterday (on a single web page).

=Essential reading=

Cumulus 1 has a [[Downloads#Resources|Help file]] that is part of the Cumulus 1 installation package; that provides a simple explanation for each file.

David Jamieson created this Wiki page on 27 August 2009, to cover "today.ini" and "yesterday.ini" files. His introductory text simply stated these files were for tracking extremes in the two days and new files were created at 9am or midnight rollover. David also included a listing of a typical "today.ini" file.

Since the initial creation of the Wiki, it has attempted to become reference documentation that answers questions that arise frequently in the support forum. This does mean its pages have become harder to read, and thus there is now an attempt to split "essential" facts that give a basic understanding (as in following subsections) from "technical" facts (later on this page with more complex instructions on how to cope with problems).

Therefore for a quick read, stop after this essential section or use the page index above to skip quickly to whatever is of interest to you.

== How Cumulus tracks extremes and why two files were introduced ==

Cumulus software handles daily tracking by storing values internally, i.e. within its use of random access memory. As the software processes (the time interval for doing this varies between weather station type and also on exactly which release you are running) data from the weather station, incoming values are compared against internally held values, and when appropriate the values being processed update the internal values.

Cumulus initially made the assumption that it would be left running continuously, so holding values internally enabled them to be shown on that screen. However, subsequently it was realised that Cumulus had to be stopped and restarted to install a new version (and Microsoft's updates system restarts computers as part of its installation process). Information held in RAM is lost when the software is closed.

Apparently when version 1.3 was released (18 January 2005) it did not include "today.ini" nor "yesterday.ini". An attempt to track the history of the "today.ini" file appears [[Changes to this file at particular releases|below]]. Unfortunately, Steve Loft lost some of his notes, and the Cumulus 1 version history in his [[Downloads#Earlier_Versions|changes.txt]] is incomplete. So it is pure guesswork that version 1.4 resolved the problem of losing daily information on closing Cumulus by introducing a '''today.ini'' file to hold the daily extremes and total records.

Steve Loft did document that at rollover, the daily extreme/average records were "transferred" (there are some differences) from "today.ini" to [[yesterday.ini]]. That second file was not vital, but made it easier to display yesterday's extremes on the main screen of the legacy software.

The sub-section below covers end of day actions in more detail, subsequently explaining actions might happen twice a day!

When you close Cumulus, it will write the final values for highs and lows and their timestamps to ''today.ini'' as part of the close down process.

==End of day actions==

End of day actions happen when Cumulus detects that it is processing weather data for the rollover time [either midnight, or 9am (or 10am) depending on your configuration and season], this might be during the processing of archive data while Cumulus is catching up after it has been restarted, or in normal running when those clock times are reached.

Oversimplifying the process a bit, the contents of today.ini, goes to two places:
# yesterday.ini
# a new line appended onto [[dayfile.txt]]

After that a new today.ini is created populated with initial values for each extreme/total entry.

The three files have a few differences in content, so rolling-over does involve a little editing work:
# The multiple lines in the [General] section of today.ini shrink to just one item in yesterday.ini (Date) and one item in dayfile.txt (abbreviated date)
# The 'Total' and 'Samples' values in "today.ini" become the single 'AvgTemp' in "yesterday.ini" and "dayfile.txt"

=== Complexity if you are recording sunshine hours ===

Sunshine hours are recorded starting at midnight, regardless of what rollover time is used.

For MX only, the sunshine hours are partly recorded in [[yesterday.ini]] and partly in today.ini. So even if your rollover is 9 am, there will be an update to both files at midnight which is when the current sunshine hours figure in today.ini is copied to yesterday.ini before the figure in today.ini is reset to zero.

==Where are the files stored?==

The files '''today.ini''' and '''[[yesterday.ini]]''' are located in the [[Data folder|"data" sub-folder]] of the path where your cumulus.exe (or CumulusMX.exe) is installed.

(NOTE: Microsoft Windows Operating Systems, may relocate some files, as explained at [[FAQ#I_can.E2.80.99t_find_my_data_files.21| FAQ on location of data log files]]).

When Cumulus is left running, a daily backup of all the files is created as part of this rollover in a subfolder 'daily' of the [[Backup_folder|backup folder]]. Depending on the release you are running, the files included in the backup may be a snapshot of their content just before rollover, just after rollover, or at the first standard interval after rollover.

== How Cumulus updates the file ==

This depends on which flavour of Cumulus you run. The [[#End of day actions|end of day process]] is same for both flavours, but updates during the day work differently for the legacy software and for MX.

For '''today.ini''', it is important to be aware that MX can read a file created by Cumulus 1 (MX can read the time format in the value for '''Timestamp=''' parameter whether it is in Cumulus 1 or MX format), but Cumulus 1 cannot read a file that has been updated by MX.

Cumulus MX and the legacy software handle the updating of "today.ini" differently, this difference is critical should you want to [[Correcting_Extremes#Correction_of_extremes_for_today|edit out rogue data]].

=== How Cumulus 1 updates the file ===

Steve Loft never shared his souce code, so what follows is just a guess at how the update might work. The frequency at which data is read from a weather station varies depending on the type, but is at least every 30 seconds.

The indications are that Cumulus 1 has an internal one minute timer that triggers the logging of readings (after conversion to units selected) to an internally held [[Recent history|recent history database]] and the comparison of those readings against existing internally held extremes/totals. The file is updated immediently afterwards, each update only changes those lines (within sections) where the extreme/total/count/time has changed, and other lines retain the same content as before the update.

Whilst you are strongly advised not to manually edit the file with Cumulus running, because access to the file cannot be shared, if you are able to complete the edit between one real-time interval and the next, any change you make is retained.

(NOTE: A full set of latest spot readings are logged to a file at a configurable interval that might be every 10 or 30 minutes).

===How MX replaces the file===

Note the subtle difference in this sub-section header. MX does all updates to the today extremes/totals/counts only to internally held values. Although the [[Software#Latest_MX_Source_Code|source code]] is available, you need to be more technical than the person typing this to understand at what frequency these internal updates occur. It is probably every time data is read from the weather station, but might be just when the externally stored [[Recent history|recent history database]] is updated.

Critically, MX only updates the "today.ini" file at the configurable [[Standard log files|Standard interval]] used for logging the spot values (might be every 10 or 30 minutes). Each update is a ''rewrite of the entire file contents'', from the internally (RAM) held values.

You would be wasting your time should you try a manual edit of the file while MX is running, as the next MX update will overwrite any manual changes! Don't be misled by the fact that a sharing violation is less likely to be an issue (because of the longer interval between MX updates).

== Format of the file ==

The files are text files, consisting of many lines. Some lines consist of a single piece of text surrounded by square brackets, these are the section names. The sections (for "today.ini" after the first [General]) can be in any order, Cumulus will maintain whatever order the sections are currently in.

Under each section name, there is a list of parameters <code>attribute=value</code>, with one parameter per line. The attribute names are defined by Cumulus, but can appear in any order:
* Where a time-stamp is stored, note that in "today.ini" only the hour and minute parts of a time are stored.
* Where an extreme/total value is stored, note that it is always post conversion to the units selected by the Cumulus user.
** It was mentioned earlier that the file exists to store values that Cumulus holds in RAM. Internally those numbers are in binary (base 2), but in the file the numbers are expressed to base 10. The value of any integer part of numbers is unchanged between the two bases, but decimal parts in base 2 and base 10 do not convert exactly, therefore in the file you may see some strange looking numbers with lots of decimal places.

The key difference between all [[:Category:Ini_Files]] for the different flavours is the formatting of any time-stamps that include a date:
* [[File:Badge v1.png]] Cumulus 1 used the format specified in Control Panel for your region settings, for UK that would typically be <code>day/month/year (space) hour:minute</code> in today.ini
* Cumulus 2 (withdrawn) worked differently, all date/time stamps were converted to UTC, and stored in ISO 8601 format of <code>yyyy-MM-ddTHH:mm:ss</code>(using the net specifiers that MX uses).
* [[File:Badge vMx.png]] Cumulus MX uses the same format as Cumulus 2, but all date/times are expressed according to date/time read from the computer running MX, so use whatever time-zone you have selected on that device.

Please look at the category page (link above) to read more on formatting differences between the legacy Cumulus and MX.

===Typical Sections within file===

As Cumulus is developed it is adding further sections, but the legacy Cumulus (by 1.9.4) used the following:
* The [General] section stores current date and time.
* The [Wind} section stores the highest wind speed and highest gust, it holds the sum of wind speeds as wind run, and details for the dominant wind.
* The [Temp], or temperature, section stores the highest and lowest temperature, the sum of all temperatures from every sample (Total), and the number of Samples in that total, the Cumulative Chill Hours total (for the season), and the cumulative Heating and Cooling Degree Days for the current day-so-far.
* The [Pressure], [Humidity], [AppTemp] (for apparent temperature), and [Dewpoint] sections just hold Highs and Lows.
* The [WindChill] section only holds lowest, the [HeatIndex] section only has highest.
* The [Rain] section holds a lot of different parameters, including the Start count that derives most rain outputs, and the LastTip date-time.
* Other sections present in 1.9.4 are [ET], [Solar], [NOAA], and [FineOffset]; whether these are updated depends on what sensors you have, and whether you have set up NOAA reports.

MX development has been far more rapid than the legacy software, and there have been a lot of changes to the content of the two files. Unfortunately, the MX release announcements rarely go into enough detail to permit good documentation, so all mentions relating to MX on this page are guesses from examination of the file, and it cannot be guanteed that the information is correct for whatever MX release you may be running!

A typical MX release will include all the 1.9.4 sections, plus:
* The '''[Records]''' section contains one line denoting when extreme records were last revised. For example "Alltime=2020-03-06T06:42:13", indicates when the all-time extreme records was last updated. In the example file, there were various extreme records broken at that time on 6 March (lowest temperature, lowest apparent temperature, and greatest wind chill), but none have been broken since.
* Other sections (depending on MX release) may include [FeelsLike], [Humidex], [Lightning], and [TempMidnight]; whether these are updated depends on what sensors you have.

===Composite Example of 'today.ini' file===

'''Notes in round brackets () are not part of the file, they simply explain elements of the composite.'''

* This is an example made up of composites that may not all be present in an actual file.
* This composite contains time-stamp formats used by Cumulus 1.x.y and Cumulus MX in the few places where they differ.
* Because this example is made up of composites, the times shown are not all consistent, in a real file no time anywhere will be later than the time at the top!
* The order the sections appear in this composite may not match your file; as mentioned above the section order can be edited.

<pre>
[General]
Date=29/09/2009
Timestamp= (format for Cumulus 1 e.g. "29/09/2009 09:50:00"; format for Cumulus MX e.g. "2019-09-29T09:50:00")
CurrentYear=2009
CurrentMonth=9
CurrentDay=13

[Wind]
Speed=10.7008972167969
SpTime=10:09
Gust=22.0114517211914
Time=08:42
Bearing=90
Direction=E
Windrun=63.1526298522949
DominantWindBearing=317
DominantWindBearingMinutes=1041
DominantWindBearingX=-3914.11743164063
DominantWindBearingY=4215.82763671875

[Pressure]
Low=1014.89996337891
LTime=11:13
High=1018.79998779297
HTime=00:06

[Rain]
High=0
HTime=00:00
Start=1923.59997558594
Yesterday=0
LastTip=2009-09-14 10:48
HourlyHigh=0
HHourlyTime=00:00
ConsecutiveRainDays=2
ConsecutiveDryDays=0
RG11Today=20

[ET]
Annual=1148.2578125
Startofday=1147.24182128906

[Temp]
Low=8.30000019073486
LTime=01:16
High=16.8999996185303
HTime=11:41
Total=7500.697265625
Samples=714
ChillHours=3147.15673828125
HeatingDegreeDays=5.34738397598267
CoolingDegreeDays=0.502222061157227

[HeatIndex]
High=16.8999996185303
HTime=11:41

[AppTemp]
Low=5.0417857170105
LTime=01:30
High=15.0359125137329
HTime=11:52

[WindChill]
Low=6.39816427230835
LTime=01:30

[Dewpoint]
Low=5.30104923248291
LTime=00:52
High=10.7219848632813
HTime=11:38

[Humidity]
Low=65
High=88
LTime=11:45
HTime=06:06

[Solar]
SunshineHours=1.08333301544189 (This is Cumulus 1 example)
SunshineHoursToMidnight=5.80002069473267 (This is Cumulus 1 approach)
HighSolarRad=1048
HighSolarRadTime=09:41
HighUV=7.40000009536743
HighUVTime=09:41
SunStart=0

[NOAA]
LatestMonthlyReport=NOAAMOSep2012.txt
LatestYearlyReport=NOAAYR2012.txt

(The above section will look like the one below if NOAA reporting has not been set up)

[NOAA]
LatestMonthlyReport=
LatestYearlyReport=

[FineOffset] (if not using a Fine Offset station, the MX defaults are as shown)
FOSensorClockTime=(the format here is different for Cumulus 1 e.g. "29/09/2009 09:50:00" and Cumulus MX e.g. "0001-01-01T00:00:00")
FOStationClockTime=(the format here is different for Cumulus 1 e.g. "29/09/2009 09:50:00" and Cumulus MX e.g. "0001-01-01T00:00:00")
FOSolarClockTime=0001-01-01T00:00:00 (this parameter only appears in later MX releases, the time shown is the default if no solar sensor)
</pre>

 
<hr>
 

=Non-essential more technical information=

You can skip the following subsections unless you have a particular need to read them.

== First use of Cumulus ==

When you use Cumulus software for the very first time, it records a start date, and assumes you have no data anywhere for earlier than that start time.

Some weather station types have an internal logger that can be accessed for historic data. It is theoretically possible, but not recommended, to read in that historic data, so it is included in your Cumulus extreme tracking. The minimum content for "today.ini" is the "[General]" section. If you stop Cumulus, manually edit "today.ini" to remove all other sections, and then restart Cumulus, then the software will attempt to read that historic data. Please read [[FAQ#I.E2.80.99ve_just_installed_Cumulus.2C_and_it_didn.E2.80.99t_download_all_the_old_data_from_my_weather_station | FAQ here]] for full guidance. Remember this only applies when you are first starting use of Cumulus with a weather station.

== Restart and Catch-up ==

If you restart Cumulus during the day it will read the ''today.ini'' file at startup, so it can resume tracking extremes of the key parameters starting from latest stored values in today.ini. If your weather station type permits, a restart of Cumulus can go into a catch-up mode during which it reads any historic data from the weather station, for the period while Cumulus was not running, before starting the reading of the current data.

During that catch-up of historic data, internally held daily extremes, and the "today.ini" file, will be updated with revised highs and lows as Cumulus processes the historic data from the station's memory; and if necessary Cumulus will do a roll-over (see [[#End of day actions]]) as it processes the readings for the relevant time.

On restart Cumulus writes a backup of today.ini (and some of the other Cumulus files) into the [[Backup_folder|backup folder]] found below the folder with the cumulus.exe (or CumulusMX.exe). With Cumulus stopped, you can copy the today.ini file in either a restart backup, or a daily backup (see [[#Where are the files stored?]]), also copying the other files in that backup folder into their original folders (mostly [[data_folder|data sub-folder]]) overwriting the files in those destinations. When you restart Cumulus, the tracking will begin again as if the time has been rewound back to the date those copied files were last updated. This rewinding works best if historic data can be read from your weather station. One example of when this might be useful is if you spot a rogue value very soon after it has been recorded, the rewinding often brings in correct data for the recent period. Another example is if your computer on rebooting initially shows the wrong time and so Cumulus records some data against that wrong time; a rewind can eliminate the wrongly timed records and replace them with records timed correctly.

You are strongly advised not to stop/restart Cumulus close to either midnight or your rollover time. Steve Loft defines "close" in this context as within whatever time you have set as interval between logging of spot values (e.g. 10 or 30 minutes). The potential problems were significantly worse for earlier versions of Cumulus 1, but restart problems have been reduced in newer builds of C1. In general, MX is more tolerant over restart timings, but the way its code works you will encounter more problems with accuracy of output if MX is stopped for more than the few minutes needed for an upgrade (or computer reboot).

== Editing rainfall in today.ini within Cumulus ==

This sub-section applies to Cumulus 1 and Cumulus MX.

At the time of writing, no Cumulus release contains an editor for today's daily extreme records as stored in "today.ini". There is just one exception, both flavours do contain an editor for 'Today's rain'.

Cumulus internally stores a "start of day rain counter". This is copied into "today.ini" into the ''Start='' line within the '[rain]' section. Subtracting that from the current rain counter value allows Cumulus to calculate (in your chosen units) the toatl rainfall for today. The provided editor changes the internal "start of day rain counter" so that the current rainfall total becomes what you enter into the editor.

It is important to note:
* The rainfall counter was invented in Cumulus 1 as a way that could calculate rain when the software was made to serve multiple weather station types
* The counter is based on a piece of data that can be read from a particular weather station type, it might be based on an all-time total rainfall, or based on a rainfall this year figure
* The counter is not intended to be of any interest to the Cumulus user
* Any increase in the rainfall counter is treated as representing valid rain (spike removal functionality exists only for rain rate and rain in last hour, not the total rain)
* Cumulus has special code to detect if the counter value decreases, without going into the complexity, Cumulus will normally reset its internal start of day counter based on the decrease in the number received.
* The "Today's rain" editor does not affect any derived rainfall output;
** The following in "today.ini" are not affected:
*** last tip time-stamp ("LastTip=")
*** highest rainfall rate so far today and time-stamp ("High=" and "HTime=")
*** hourly high amount and time-stamp ("HourlyHigh=" and "HHourlyTime=")
*** Highest 24 hour amount
** Outside "today.ini" it does not affect any recent records nor monthly, yearly, monthly-all-time, or all-time extremes:
*** The recent history entries whether held internally (Cumulus 1), or for MX in [[Cumulusmx.db]], are not amended so any tags used for web page data, local API, custom SQL, MQTT, HTTP (see [[Webtags/Parameters#Cumulus_MX_software|this Wiki section]]) will report incorrect values
*** Total Rainfall this month, rainfall this year/season will only be recalculated if Cumulus is stopped and restarted after the edit
*** Highest rainfall rate, highest hourly rainfall, highest 24-hour rainfall, highest daily rainfall; applying to these longer periods are not changed unles each extreme record is individually manually edited (Cumulus provides an editor for most of these, but cannot generally suggest what new value to use).
*** The consecutive wet/dry days ("ConsecutiveRainDays=" and "ConsecutiveDryDays=") in this month/year - remember these counts are to last roll-over, they exclude today
** The editor does not alter any lines already logged in [[Standard_log_files |log file]] for the current month. This means you will see distorted graphs attempting to portray rainfall within a day
** The editor does not update any database records that may be affected by the change of the rainfall total

== Dealing with rogue values ==

The "today.ini" file is written to throughout the current day, as described [[#How Cumulus updates the file|earlier]]. As mentioned above, Cumulus only provides extremely restricted ability to edit "Today's rain", not any other extreme/total that is stored in the "today.ini" file.

If your weather station reports a rogue value, an incorrect update to a High, Low, or Total, may get stored in this file. At end of day, it will then be stored in [[dayfile.txt]]. Cumulus developer advice is that instead of manually editing "today.ini", you should wait until the day has been stored in "dayfile.txt" and then use the editor for that log file to make the desired changes.

The rogue value may also affect extreme records held for this month, this year, monthly-all-time, and/or all-time. Cumulus does provide editing functionality for most (not all) entries in the files holding those extreme records and you can read instructions on [[Correcting Extremes]] Wiki page. Here it is sufficient to say it is worth looking in the diagnostics, to see if you can spot when the problem occurred, because that helps you work out what may be affected:
* [[File:Badge vMx.png]] [[MXdiags folder]]
* [[File:Badge v1.png]] [[Diags_folder]]

=== Manual editing of "today.ini" ===

The developer advice to wait until next day has a flaw; every process that happens in the meantime sees wrong data, and that might include sending data to several external sites, and a number of extra custom processes you might have in your system.

Therefore this Wiki page will now give some advice on how to manually edit the file:
# You must stop Cumulus (please see earlier in this page for details as reason depends on flavour you are running)
# Always take a back-up of existing file, or (if you decide it is easiest to create a new file rather than edit the existing one) rename it; your corrections may cause problems, so you must be able to revert
# Any plain text file editor can be used (that includes coding editors like Geany, Notepad++, NoteTab, and many others)
# Be careful to ensure any change maintains existing format (integer, decimal,time, date/time, text) paying attention to any punctuation (including decimal commas or decimal points, direction type of any slashes)
# For readability you can insert blank lines into files '''today.ini''' and '''yesterday.ini''', Cumulus will not mind.
# It is up to you to work out what new value/time to type, Cumulus won't accept nulls, but there are some "initial values/dates" that it will accept (I won't tell you these here, because they depend on release you are running and you should not be editing this file unless you have enough technical understanding to work out what Cumulus will accept)
# Remember changing extremes for [[Calculate_Missing_Values#Some_definitions|source value extremes and derived extremes]] is complicated:
#* Please see specific advice in sub-sections below

==== Edits related to pressure ====

Should be straight forward, the maximum/minimum can be edited without this affecting anything else. You should be able to look in either [[Standard_log_files |log file]] or for MX in [[Cumulusmx.db]] for pressure readings earlier or later in the day to find the new extreme value/time to replace the rogue pressure value and time.

==== Edits relating to Temperature ====

#If you change a temperature source extreme (i.e. highest/lowest temperature) you should also be taking the old value out of 'Total' line and decreasing by one the'Samples' count
# You cannot work out from any change in a temperature source extreme (i.e.. highest/lowest temperature) how to change the related derived extremes (e.g. wind chill, apparent temperature, feels like, dew point). Each derived value is worked out by combining spot values at a particular time, so you have to recalculate as many spot derived values as possible in order to work out the new derived extreme.

==== Editing Chill Hours====

Prior to release 3.12.0, the web template "thisyearT.htm" included a single cumulative figure for [[Heat/cold_degree_days_and_Chill_hours#Calculation_of_Chill_Hours|seasonal chill hours]], and that figure was taken from the chill hours figure stored in "today.ini". A lot of processing was needed to calculate this figure so, in these earlier releases, it was unusual for anyone to correct any rogue figure.

From release 3.12.0 onwards, yesterday's cumulative total is stored in "yesterday.ini". Once you have corrected any rogue maximum or minimum temperature, you can look at the outdoor temperature reported in every row in [[Cumulusmx.db]] since last rollover. For each figure that is below your chosen threshold temperature, add the fraction 1/60 (assuming interval between rows is one minute). The cumulative totals of those fractional increments are added to obtain the figure that should be in today.ini. Unless today is the first day of the month set as first month of season, add on the figure stored in yesterday.ini, to get value to put in today.ini.

==== Edits related to humidity or wind speed ====

Obviously changes to humidity, wind speed, also have an effect on derived temperature extremes mentioned above, but again you have to recalculate as many spot derived values as possible in order to work out the new derived extreme.

====Edits related to rainfall ====

If you want to edit ''rainfall since midnight'' in today.ini, it should be fairly easy to calculate a new value. Remember you also need to manually edit entries in [[Standard_log_files |log file]] and for MX in [[Cumulusmx.db]].

To edit the "rainfall counter" in [[Standard_log_files |log file]] remember that for any decrease in the actual rain, you need to increase the rain counter, and vice versa. It is probably easiest to work backwards through time working out the alteration to the rain counter for the actual rainfall increment, in the period since the preceding entry.

Other derivatives like "maximum hourly rain", "highest rainfall rate", or "highest 24 hour rainfall", all will have to be guessed or recalculated manually, there is no easy way to work these out as past values for the day are not logged anywhere.

==Cross-references for explanations of key parameters==

[[Wind_measurement | Bearing and Direction]],
[[Windrun]];

[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Temp]],
[[Average temperature | Total and Samples]],
[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Humidity]],
[[Heat/cold degree days and Chill hours | Heating degree days]],
[[Heat/cold degree days and Chill hours | Cooling degree days]],
[[Apparent temperature | AppTemp]],
[[Heat index]],
[[wind chill]],
[[Heat/cold degree days and Chill hours | Chill hours]],
[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Dewpoint]];

[[Webtags|Rain]],
[[FAQ#The_longest_dry.2Fwet_spell_for_this_month.2Fyear_includes_days_from_last_month.2Fyear | ConsecutiveRainDays]], [[FAQ#The_longest_dry.2Fwet_spell_for_this_month.2Fyear_includes_days_from_last_month.2Fyear | ConsecutiveDryDays]];

[[Reports folder|NOAA]]

== Changes to this file at particular releases ==

''This section may not be a complete history, and may not be kept up to date; so don't take it as authoritative''

* 3.18.0 build 3189 (pre release 14 June 2022)
** Added '''TempMidnight''' section for tracking of min/max temperature based on day starting at midnight, to complement tracking starting at rollover time
* 3.17.0 build 3184 (released 23 May 2022)
** Some changes to handling of lighning (regarding when no strikes)
* 3.12.0 beta build 3134 (released 29 July 2021)
** Added '''Lightning''' section (lightning distance and last strike time)
* 3.11.0 build 3129 (released on 7 May 2021)
**Fix: End of day backup now always runs at rollover, so like most releases of the legacy software, the stored file represents the true end of day position.
*** For example in the '''[General]''' section, the ''Date'' (calendar date) and ''Timestamp'' attributes will relate to when it was last updated, but the three '''Current'' attributes will relate to the meteorological date just ended.
*** For the today.ini in the backup/daily folder, last update time-stamp will indicate time as at one update cycle before end of day, but file last modified will show that was at end-of-day
** New: Added (to [Temp]) GrowingDegreeDaysThisYear1=, and GrowingDegreeDaysThisYear2=.
* 3.7.0 - build 3089 (released on 28 July 2020)
** Canadian Humidity Index (Humidex) added for highest extreme monitoring in today.ini (and other longer period extreme log files)
* Release 3.6.6 build 3082 (released on 1 June 2020)
** Values in the file had been stored (in all previous builds) using 15 decimal places (because of difficulty in representing decimal parts of numbers in binary), from this release revised so all values stored using 17 significant figures
* Release 3.6.3 - build 3079 (released on 21 May 2020)
** Fix long standing problem with today.ini becoming corrupted when Microsoft Windows is shutdown
* Release 3.6.0 build 3076 (released on 4 May 2020)
** Added '''Feels Like''' section to daily high and low extremes monitored in today.ini (and other longer period extreme log files)
* Release 3.1.0
** Added '''Records''' section, this holds one attribute "Alltime" that holds a datetime stamp recording the most recent update to the [[alltime.ini]] file
*From version 1.9.4 build 1089 to release 3.10.5 build 3122
** The '''today.ini''' stored in the daily backup contains the position as at '''start of day''' (or in specified older MX releases, up to one UPDATE interval later), so it does not contain any information (except Cumulative Chill Hours) that relates to day that has just ended.
*Up to version 1.9.4 build 1088 (released 28 Jan 2014)
**The '''today.ini''' stored in the ''cumulus\backup\daily\FOLDER_NAME'' ((where FOLDER_NAME is based on date and time of creation) represented the end of day (including on last day of month) extremes
*version 1.8.9 (released on 31st March 2010)
**Fix problem with month names (timestamp in today.ini) using ''short date format''
* version 1.8.6 (released on 14th April 2009)
**Don't write today.ini unless station contacted
*version 1.8.5 (released on 12th February 2009)
**Fix wrong times for some of today's extremes
*Not documented
** It is believed that today.ini may have been introduced at version 1.4
*Version 1.0 27th January 2004 First release
**Included internal tracking of daily extremes, and display on main screen, but not storing in a file.

Amending dayfile

2022-08-06T17:23:38Z

Sfws: /* Important Rules when editing dayfile.txt */ 3.20.0 edit

Cumulus uses a daily summary log file, the fields in that file are listed at [[Dayfile.txt#List_of_Fields]]. The information about amending the file that was originally on the same page has been moved to this page. {{Version badge 1}}When the text was first created (on the other page) it was for the (legacy) Cumulus 1 software. {{Template:Version badge Mx}}As MX was developed, the text here has been amended to keep up, it currently applies up to release 3.12.0.

[[Category:Files_with_Comma_Separated_Values]]
[[Category:Cumulus 1]]
[[Category:Cumulus Files]]

=How Cumulus uses the daily summary log=

While Cumulus is reading your weather station, all daily extremes, counts, and totals, Cumulus needs are stored in [[today.ini]].

==Reading the daily summary log file==

For MX release 3.9.2 - build 3097 onwards, when the software first starts, the whole of '''dayfile.txt''' is read, the contents are used to drive the [[Highcharts_-_Historic]] functionality.

The file is also read, if you are using the editor provided in either Cumulus flavour.

==Writing a new line to the daily summary log file==

At the end of each meteorological day, Cumulus uses information held in '''today.ini''' to write a new line into [[dayfile.txt]], before it resets '''today.ini''' ready for the new day.

Chill Hours Daily Increment for storing in '''dayfile.txt''' is calculated by substracting the cumulative count in [[yesterday.ini]] from the cumulative count in '''today.ini'''.

If rollover, is not at midnight, sunshine hours (these run from midnight to midnight) for the '''dayfile.txt'' are read from '''yesterday.ini'''. For rollover at midnight, sunshine hours from '''today.ini'' (before reset) is read.

= Problems that occur in the daily summary log and how to safely rectify them =

As discussed in [[Correcting_Extremes]], it is possible for rogue values to be read from a weather station, and propagate into various log files. An error in many of those files, corrupts a particular extreme record (or more than one), but generally does not stop Cumulus working.

Since release 3.9.2 (build 3097) MX now reads the entire daily summary log when you start it up. This implies that an error in '''dayfile.txt''' is now always picked up when MX starts, error messages will be added to the latest file in [[MXdiags folder]], but most Cumulus users will not realise there is a problem until they use historic charts (either in the local admin interface, or on a external web server). There is other functionality that uses recent lines in the '''dayfile.txt''' for certain calculations.

== Thoughts required ==

To correct '''dayfile.txt''', you might think the best approach is to look in your [[standard log files|log file]] covering the relevant date, or to use "Create Missing" (which works differently for the legacy software and MX as explained later). Often that is not a good idea, your standard log file might be corrupted as well, and since these log files only record spot values, they miss any extremes occurring between the log entries.

Equally, to stop Cumulus, and make it rewind, may worsen the problem, because you throw away the good data you have on other derivatives just to try to resolve one rogue value.

If you discover the corruption within a few days of it happening, you can make use of an earlier [[Backup folder|back-up]] as explained later.

==Summary for most common problems==

{| class="wikitable" border="1"
|-
!style="width:200px" | Problem
!style="width:300px" | Possible cause
!style="width:300px" | Rectification for MX releases
!style="width:300px" | Rectification for legacy versions
|-
| One, or more, past line(s) accidentally deleted or corrupted
| A mistake during a manual view/edit to the file, or a mistake while using the built-in editor
| See [[#Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software]]
| See [[#Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software]]
|-
| Inconsistencies in date formats (what comes between day of month, month, and year)
| Examples:
# File was previously used with Cumulus 1 (that did not care what symbol came between parts of date)
# Moving from one device to another (and not ensuring same locale on both devices)
# Editing using an external app (like Excel) and treating date cells as date type, should be text type
| Cannot use editor in MX admin interface, for bulk line edits see [[#Correcting date separator errors]]
| Type over individual dates in built-in editor, for bulk line edits see [[#Correcting date separator errors]]
|-
| Inconsistencies between decimal comma and decimal points
| Moving from one device to another (and not ensuring same locale on both devices)
| Correct "locale" and/or use an external editor that offers "Replace all" (see [[#Validation by in-built editors]])
| Use '''Control Panel''' to correct region (that defines decimal symbol). To edit the file, use an external editor that offers "Replace all"
|-
| Inconsistencies in list separator (what comes between fields)
| Moving from one device to another (and not ensuring same locale on both devices)
| Correct "locale" and/or use an external editor that offers "Replace all"
| Use '''Control Panel''' to correct region (that defines list separator). See [[#Using the Cumulus 1 editing feature]] to check file is now consistent.
|-
| Duplication of dates between lines (either consecutive lines, or non-adjacient lines)
| Electrical fault (or manual restart) affecting Cumulus close to rollover time (should not restart within one "standard interval" plus one minute, before or after)
| Use [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|editor in MX admin interface]], amend one line, and delete other
| See [[#Using the Cumulus 1 editing feature]]. Looking at the duplicate lines, correct one line, using information from it or from the duplicates, then click '''Delete''' to remove the uncorrected line(s)
|-
| Lines not in ascending date order
| Example possibilities:
# Bug in some Cumulus 1.9.2 builds sorted lines into wrong order if PC used USA date format (m-d-y), corrected from 1.9.3 onwards
# Restarting Cumulus after a crash, either manually using "Rewind" approach or Cumulus is confused by a corrupted file
| Manual editing outside MX in a text editor, if particular dates appear twice, see [[#Dates restart/repeat]]
| The legacy editor can resequence lines for you, if no duplicates. However, if particular dates appear twice, see [[#Dates restart/repeat]]
|-
| Some lines with fewer fields than others
| As explained at [[Dayfile.txt#List_of_Fields]], as Cumulus has developed, more fields have been added
| Use [[Calculate_Missing_Values#CreateMissing.exe|separate CreateMissing.exe utility]]
| Use workaround described at [[#Legacy Workaround]]
|-
| Some dates (lines) missing
| Examples:
* Inserting data before you start using Cumulus, see [[#Importing data not recorded by Cumulus]]
* Cumulus fails during rollover, so a line is not stored
| Use [[Calculate_Missing_Values#CreateMissing.exe|CreateMissing.exe]]
| Use [[#'''Create Missing''' on legacy dayfile editor]]
|}

== Editors built into Cumulus ==

If you need to view, or edit, a line in the [[dayfile.txt|daily summary log]:
* MX: Use [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|Edit menu in MX's admin interface]]
* C1: Use [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|Edit menu on Main Screen]]

===Validation by in-built editors===

Both the legacy editor and the MX editor will ensure that the correct number of fields is stored (as defined at the release where you do editing) (one common error in an external editor is to accidentally add/delete a field).

The legacy editor will allow you to edit the date field, the MX editor cannot change the date field. The MX editor, reads the file into an array, it uses the array index for all actions on a particular line, and it then writes the array back to the file when you finish editing.

The legacy editor will validate any edit you make to individual fields; it checks for appropriate content (integer, real number, time-stamp).

Unfortunately, '''the editor provided with MX does not validate any fields'''. In MX, the editor will save an edited line, even if there are errors in individual fields:
* you can put inappropriate content in a particular field (integer, real number, time-stamp)
* you can use the wrong separator in fields you do edit (i.e. between hour and minute for time-stamps, or between integer and decimal parts in any real number)

==Missing or Corrupted past ''dayfile.txt'' lines in any Cumulus software==

If you have one, or more, dates missing in your dayfile.txt file, then the first question is:
* '''Has the line been deleted by accident?'''
* ''Is the line missing because it was never saved into the file?''

* If a line for a particular date was present before, but is now corrupted or missing:
*# See if you have a back-up of '''dayfile.txt''' with the line present, and correct
*#* If the missing/corrupted line is for a recent date, then Cumulus makes '''a backup of dayfile.txt every time it is restarted and after every end-of-day rollover'''
*#* If the missing/corrupted line is for an older date, then ''maybe you took a back-up onto a separate drive or separate device''
*# If you have a suitable backup available, '''take a copy of that back-up file'''
*# Append onto the copy of the backup, '''any dates after when that copy ends''', taking the extra lines from the current dayfile.txt
*# Rename the current dayfile.txt to say dayfile.old
*# Rename the copy you have edited to dayfile.txt and place into '''[[Data folder|data]]''' sub-folder
*# Cumulus will now use the file with all days correct
* If Cumulus never saved the line in the file in the first place
*# The missing line will not be in any back-up
*# If it is the last line on the file that is missing (i.e. last rollover failed), take a copy of the whole [[data folder]], and keep that copy in a safe place
*# Now look in [[backup folder]], and open the '''daily''' sub-folder
*# If there is a subfolder within "daily" that was successfully created during the rollover that failed, rewind Cumulus by overwriting the contents of '''data'' folder with files from the backup in '''daily''' sub-folder. Restart Cumulus, and let it create a new dayfile.txt line. Stop Cumulus again, restore the original files (except "dayfile.txt) from the copy you put in safe place
*# If the rollover failure meant a backup was not created in the "daily" sub-folder, this will usually be the case, you need to follow instructions for the MX, or legacy, Create Missing

''One lesson here, is to try to remember (once a week), to check your dayfile.txt log file is okay, because Cumulus retains back-ups for only the last 7 days''

'''Another lesson here, is to periodically take your own backup, stored away from your Cumulus running environment in case you ever corrupt an old line'''

==Dates restart/repeat==

If you have a Cumulus crash (either because the connection between the weather station and Cumulus fails; or because there is a unmanaged error in the Cumulus code; or because there is a power issue), then when it restarts it is possible that Cumulus will think it is doing catch-up from an earlier day, and the ''dayfile.txt'' may end up with consecutive lines being in date ascending order until the problem, then jumping back to an earlier date, before continuing in date ascending order (but repeating one, or more, dates already in file).

If Cumulus was working correctly before the problem, then the lines stored before the problem should be okay, just delete the lines that repeat earlier dates, so the file ends up being date ascending order with no duplicates. Similarly, if Cumulus was working correctly after the problem, but there was an issue before the restart, then keep the lines that repeat the dates, but delete the earlier lines with same dates, so the file ends up being date ascending order with no duplicates.

If there are two lines with the date when the problem occurred, then it is likely you will manually have to edit the two lines into one line. Any field with a time-stamp before the problem will be kept unless it is obvious that extreme was correctly broken (i.e. not rogue restart value) after the problem.

If the dates restart in your daily summary log file, because you manually stopped Cumulus close to a rollover time, or you corrupted a file perhaps by regressing to an older release and back; then it is likely you will need to merge the two lines with same date, deciding for each value field which is more likely to be right, and matching it with correct time-stamp. A rainfall (or wind run) total might require summing totals in the two individual lines, or discarding a rouge value and accepting the other, your judgement!

==Correcting date separator errors==

Cumulus uses a format of "day of month in 2 digits", separator, "month number as 2 digits", separator, "last 2 digits of year" in the first field of every line stored in '''dayfile.txt'''. It might be expected that "separator" is consistent throughout the file, because the device/locale when the line is created determines the separator. The problem comes when a user moves their Cumulus installation to a new device, and forgets to ensure that new device uses same (Microsoft Windows PC) region, or (Unix, Linux, and other operating systems) locale, settings.

Historic notes:
*In Cumulus 1 builds, any symbol (including ;, :, /, &, -, and .) character (excluding what is defined as list separator) within the first field of each line was treated as part of separator characters when parsing for date. Thus Cumulus 1 was reasonably tolerant when someone moved to a new device.
*For builds 3000 to build 3049, MX used fixed offsets to find day, month, year in date field. This meant MX could process any file that the legacy software had accepted. The issue was this did not work for locales that used two characters for separator, and with MX now working with far more locales, this proved to be a serious problem.
*From Build 3050 MX uses the separators, defined by the locale, to split the values (so allowing for multi-character separators). The same character(s) had to be used in every line of the file, or this gave a new problem.

Some [[Daily Summary|third party routines]] for reading dayfile.txt take a different approach, they check the first field for the first character that is not a "0 to 9" digit, take that as start of separator, then look for the next "0 to 9" digit, that belongs to next part of the date, so the separator ends at previous character. Other third party routines, ask user what they use as date separator.

=== Date Separator in MX===
MX is fussy, the same separator must be used in every date in the file. An error will be reported in diagnostics, and the historic graphs will stop working if the separator changes from one line to another.
# So look at the last line in the file, that is the character MX expects
# If any earlier line, or lines, uses a different character, then that line, or lines, must be edited, it is best to use an editor designed for programmers
#*If the last line has hyphen "-", but some earlier lines use slash "/", it is simple to do an edit
#** Use "Replace All" option in your chosen editor, to find "/", and replace with "-". This works because "/" does not appear anywhere else in the file
#*If the last line has "/", but some earlier lines have "." or "-" as separator, then the correction is more complex, because you don't want to edit any minus signs or decimal points in any other fields
#** See if your editor accepts "Regular Expressions", then you can look for two matching separators in same field, see [https://cumulus.hosiene.co.uk/viewtopic.php?p=152540#p152540 this forum post].

See [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=18340 this forum thread] for a fuller discussion.

===Date Separator in Legacy Software===
The legacy software accepts any character (except space) as the separator between the day of month, the month, and the year, elements of the date. Therefore Cumulus 1 does not care if that separator is sometimes "/", sometimes "-", and/or sometimes ".".

= Importing data not recorded by Cumulus =

You might have been using your weather station with some other weather software before you installed Cumulus. If you can get weather data in the format of daily summaries (and the rollover times match), you can import that data into the Cumulus '''dayfile.txt''' file using a script or spreadsheet package. All you have to ensure is that you can arrange the output to be in lines with fields in sequence shown in [[Dayfile.txt#List_of_Fields]]. There is more guidance later on this page about the rules you must obey for this file.

If you have imported the data from the other weather software into the [[Standard_log_files]] format, then
* a separate utility "CreateMissing.exe" can create the new rows, for MX users, for those days previously missing in dayfile.txt, as explained below.
* in the Cumulus 1 editor, ''Create missing'' can insert the new rows, for those days previously missing, in dayfile.txt, as explained below.

= Using CumulusMX.exe editing functionality =

The editor in MX can be found in the administrative interface by selecting [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|Data Logs menu and '''Dayfile''' page]]. The '''Dayfile viewer/editor'' will display some lines at a time (e.g. 10 at a time or more). When the page is first loaded, the oldest lines will be read from the file by the Cumulus MX engine, and via an '''application programming interface''' (api) transferred to the web page where the lines are displayed using some software called ''datatables''. That software generates a navigation section where you can navigate to First, Previous, Next, and Last, with (for a longer file) up to 6 page numbers (each containing up to the selected number of lines) that you can select directly.

Basically, this is a text editor, but you have to amend lines using a pop-up, a proposal to use in-line editing never made it into a formal release. Another pop-up is used to confirm dleting a line. The editor does not let you edit the date field. Each line is identified by a line number.

This editor does not provide any way of inserting new lines into dayfile.txt (so you cannot correct an error when MX end of day failed and a line was not created), nor is there any way of changing the dates used by lines in the file (a very common problem reported by Cumulus users is that MX is giving them problems because not all lines in this file use the same format for the date, but this editor cannot resolve that).

There is a '''Refresh''' button that sends a '''application programming interface''' instruction asking the MX engine to resend the lines on the currently selected page via the api.

When you select a line in the provided editor, both '''Edit''' and '''Delete''' buttons are enabled.

Pick '''Edit''', click that, and an editing dialog pops up (MX uses '''altEditor ''' software for this). The pop up window does not let you change the line number nor the date, but all other fields show their current contents and you can overtype as necessary. Scroll down to see 2 buttons (how they are labelled depends on which version you are using), the left hand button ignores any edits you have made (it is labelled 'Close' or "Cancel" and simply does same effect as clicking the "x" in the top right corner), it prevents the api sending any replace message back to the MX engine. The right hand button saves your changes (even if it is labelled 'Edit' rather than "Save" in the version you are using) by using the api to send the replacement array back to the MX engine where it will replace the relevant line number before writing back to the log file.

There is no validation in the MX editor that was set up relatively quickly in version 3.4.5 as the first of 3 log file editors to plug a gap in MX functionality in earlier versions, so you must manually ensure you enter correct data:
* some fields can only accept integers, other expect decimals,
* and some fields can accept negatives, others don't accept signed numbers
* some fields have a minimum and/or maximum acceptable value
* time-stamps must use a colon between the 24 hour time sections for hours and minutes

As all lines are passed back via an application programme interface to the MX engine, there is no validation there either, the new line replaces the old one when the whole file is recreated. It is likely that the next time MX attempts to read the dayfile.txt it will find any error. There was a third-party proposal to add simple validation, as listed above into a replacement editor, as well as adding in-line editing, but it could not be made compatible with the particular third-party modules used by the admin interface at release 3.6.0.

Pick '''Delete''', click that, and a simple dialog pops up (MX uses '''altEditor ''' software for this) showing all the fields in the selected line and asking you to confirm that you want to delete it. Again, the labelling on the buttons varies depending on which version you are running, one confirms the deletion (which sends the array back to the MX engine with an instruction that line number is to be deleted. Despite the MX engine getting a copy of the fields that are to be deleted, it only checks the line number. The button labelled 'Close' or 'Cancel' does the same effect as clicking the "x" in the top right corner, it prevents the api sending any deletion message back to the MX engine.

==Cautions if using an obsolete MX release==

* '''Cumulus MX beta version 3.0.0 (checked at build 3043) does not provide an editor'''
* '''Cumulus MX Version 3.4.5 - Build 3069 onwards provides an editor'''
* From MX release 3.9.2 - b3097 historic charts are added to admin interface
** If you use the in-built editor to update dayfile.txt, your change will be reflected in the historic graphs
** If you edit dayfile.txt outside Cumulus MX, historic graphs will not be updated until Cumulus MX is restarted

If lines in your [[dayfile.txt|daily summary log]] were created by a variety of Cumulus 1 releases (so some have less than 46 fields), you need to use Cumulus MX version 3.7.0, or later, to be sure that the provided editor will cope. The code was actually amended to be able to read lines with fewer fields at version 3.6.0, when 4 fields were added for feels like, so the total number of fields became 50.

It is recommended that nobody uses any 3.6.x version (see [[Updating_MX_to_new_version#If_using_a_3.5.x_release]]. (For historical interest only, Emergency Version 3.6.12 changed the number of fields to 54 in error)

From formal release 3.7.0, MX's dayfile.txt reverted to 52 fields. The extras are Canadian Humidity Index (Humidex). At the time of typing this, it has been said this file structure will not be changed again.

Whatever MX release you use, any line that is edited (even if it originally had fewer or more fields) will be saved with the same number of fields that release uses when it creates a line from the contents of today.ini.

= Using CreateMissing.exe editing functionality=

'''You must be running MX in order to use this utility''', as some information is shared between CumulusMX.exe and CreateMissing.exe.

Please see [[Calculate_Missing_Values#CreateMissing.exe|CreateMissing.exe]] and/or https://github.com/cumulusmx/CreateMissing/blob/master/README.md.

Information there is not repeated here.

Basically, this utility will not replace any data that is already in the daily summary log file. It will create new lines if data for those missing lines can be derived from data already in [[Standard_log_files]]. If an individual line in '''dayfile.txt''' is shorter than the number of fields expected in the current MX release, then '''CreateMissing.exe''' will calculate daily values for the missing fields based on data already in [[Standard_log_files]].

= Using the Cumulus 1 editing feature =

{{Version badge 1}}'''This section applies to Cumulus 1.x.y only'''. The last command in '''Edit''' [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu |menu]] is ''dayfile.txt''.

''This is how you view'' the dayfile.txt from within Cumulus. Click the ''Help'' button for detailed instructions. Cumulus Help is concise but comprehensive.

It is a text editor, and it works best when at full screen:
*correct individual values by over-typing new values over those currently displayed,
*you can use '''insert''' key to add one or more missing rows (complete days) manually typing in values for all fields,
*use '''delete''' key to remove an entire day (e.g. if you get a 'duplicate' error message) after ensuring all fields are correct in the line that will remain,
*use '''Create missing''' button to insert missing rows (complete days) by reading from [[Standard_log_files]] and automatically calculating the best approximations for each field for those missing days (see next section)

== '''Create Missing''' on legacy dayfile editor ==

If a date is missing from dayfile.txt, and not available in a back-up, then it is possible to create a missing line (with approximations for the derived extreme values) in Cumulus 1. That functionality is known as "Create Missing" and is found [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|within the edit dayfile.txt screen]].
#Only use the editor when Cumulus is '''not''' doing catch-up or end-of-day, or any other action that could create an editing conflict.
#With the contents of the file loaded into the editing table, click the '''Create Missing''' button
#Cumulus 1 will now work through every line from start to end
#If 2 adjacent lines are not for consecutive dates, Cumulus will attempt to create missing lines
#It will read from the [[Standard log files]] all the data logged for each missing meteorological date (if 9am or 10am rollover is used, those read spans two calendar dates)
#It will derive totals, averages, highs, and lows, from the data it reads, for each missing date
#*Note that normally dayfile.txt lines are created from [[Today.ini]] which logs the daily totals, averages, highs, and lows, from every reading taken from the weather station
#*Depending on your weather station, Cumulus is able to read values at least every minute (maybe every 10 seconds), and consequently update [[today.ini]] frequently (each minute in Legacy Cumulus/each logging interval in MX) if an extreme happens,
#*If Cumulus is set up to only log the readings every half an hour, create missing is only able to see 1/30th (maybe 1/120th depending on weather station reading frequency) of the data,
#* Due to this mismatch, the derived values (averages, highs, lows) this approach can store are much less accurate (hence why getting missing lines from a backup is better)

The Cumulus 1 editor provides a "Create Missing" option where it will, for any dates for which a line does not exist, create a line if it can from reading the [[Monthly log files|detailed log file]] to extract all values relevant to that day and do the necessary minimum/maximum/total/average calculation for each dayfile.txt field, storing the time from the relevant other log file in any time-stamp field in dayfile.txt.

If a particular day does not exist as a row on the daily summary log, then 'create missing' can search the observations in the relevant monthly log, and calculate approximate highs, lows and totals to insert as an extra row in the daily summary log. These are approximate because the actual highs and lows for that day are quite likely to have occurred at moments in-between those that were logged.

For the legacy ''Create missing'' a list of inserted records is produced in [[dayfileeditlog.txt]].

If just some fields are wrong in a particular row (meteorological day) on day file, then there is a [[Standard_log_files#Using_Monthly_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | work around]] as at all current versions (up to 1.9.4) you can only use 'Create missing' to read from the [[Standard_log_files]] if the whole day (a line starting with that date) is missing in ''dayfile.txt''. Although Cumulus does not recognise the concept of a sensor not being available, it will write solar information even if you don't have a solar sensor; it does have to cope with reading a monthly log file that might have fewer derivatives than it wants (when using Create Missing) and therefore it may not know what to write into dayfile.txt as the calculated value. Cumulus 1 can't write a null value, so it writes zero for values, and "00:00" for time stamps. If you are using a 9am or 10am rollover time, be aware that create missing in Cumulus 1 always inserts 00:00 for null time-stamps, but in normal running Cumulus uses the rollover time for null time-stamps.

== Dealing with errors identified by the legacy software ==

If there is an error in ''dayfile.txt'', then it is most likely to be found when you are viewing its data on one of the screens for editing the monthly, annual or all-time extremes. Cumulus 1 will illuminate its ''Error'' light if it finds an error in such cases and tell you the line/row number of the first found error, together with some details of the error it found. For example, if a row is blank, a row is duplicated, a field is corrupted, a field does not have an acceptable value, or a field is missing so subsequent fields are to the left of where they should be.

If you do have a 'duplicate' error, you need to decide which row to ''delete'', and whether to copy any values from that row into the row you are keeping to ensure the correct extremes are retained.

==Correcting individual fields in multiple dayfile.txt lines==

Often people want to correct an individual field, in all lines within a particular period.

The most common example is because you have suddenly discovered your daily pressure high (and low) are wrong by a certain offset, because you used the wrong setting for converting absolute pressure to the sea level equivalent you want to store in the file.

Neither Cumulus 1 nor MX provide any functionality to make such multi-line editing easy.

However, this can be resolved by opening dayfile.txt in a spreadsheet (carefully ensuring each column is treated as either '''text''' (date and time fields) or number (the value fields) and that '''your field separator''' is set in the '''filter conditions''' to be a column separator for converting to spreadsheet. Spreadsheets have a "Paste Special" function that allows you to add/subtract a constant to every cell in a column.

===Correcting individual fields in multiple lines of Daily summary Log in Cumulus 1===

In the '''Edit''' menu, select '''Dayfile.txt''' screen, for a text editor where you can overwrite entries, delete entire lines, and insert new lines (and then manually type in values for every field). You can scroll left and right between fields, with a header row identifying which field is which, and you can scroll up and down through all the lines. If you know what you want to change (such as replacing a rogue figure), this is a very easy to use editor.

For the daily summary log, the original Cumulus software includes functionality to '''Create Missing''' in its daily summary log editor, see [[# '''Create Missing''' on legacy dayfile editor]]. This functionality creates '''an entire missing log line'' and will insert highs and lows whether they are extremes of source values, or extremes of derived values. It will only add those fields (to any new line) that are maximum or minimum (or sum, or equal to) a field that does exist in the [[Standard_log_files]] lines that belong to the same meteorological day.

==Legacy Workaround==

The legacy Cumulus 1 functionality is not designed to insert (or correct) individual missing extreme figures for daily summary lines that already have some fields in them, only to insert complete missing lines. However, we can workaround that constraint:

'''WORKAROUND FOR DAYFILE.TXT if required dates are present in both the standard log and dayfile.txt, but not all fields for that date exist in dayfile.txt'''

There are two common reasons for needing to use this, Cumulus 1 only, workaround:
# To add extra derived fields now calculated by Cumulus, to past lines created by an earlier version of Cumulus that did not calculate those derived fields at the time
# If you are importing into Cumulus records from other software, and that other software does not provide derived extremes (e.g. dew point, apparent temperature, heat index, rain rate, wind run) so your insert in the daily summary log file has only populated a sub-set of the fields.

The steps you need to take, to implement this Cumulus 1 only workaround:
#Select a time to do this work that is at least 10 minutes, preferably a whole hour, after Cumulus has performed a daily rollover, and ensure you finish this work long before the next rollover time. This will ensure your work cannot conflict with when Cumulus 1 is updating dayfile.txt.
# Take a copy of dayfile.txt original as backup,
# Use the Cumulus 1 editor (in '''Edit''' menu, select '''Dayfile.txt''' screen), and let it edit the original file
# Delete any days with partial information (e.g. from Cumulus versions that created fewer fields)
# Click the ''Create Missing'' button
# Wait while Cumulus scans all the standard log files, and for each source or derived field in those files, tracks the highest and lowest for each meteorological day that is now missing in dayfile.txt.
#* As an aside, be aware that when the contents of [[today.ini]] was used to create a new line in dayfile.txt originally, the high and low that were copied across were derived from all source values that Cumulus obtained from your weather station (this will usually be at least once a minute, depending on your weather station type it might be around every ten seconds; some weather stations provide new readings less frequently, some provide them more frequently).
#*Continuing this aside, the high and low that Cumulus is now deriving are based purely on those values stored in the [[Standard log files|standard data log]], by default that is just every 10 minutes, but it might be only every 30 minutes.
#The new lines that Cumulus 1 adds to your dayfile.txt while you use the editor, are also added to another log file '''dayfileeditlog.txt''', so we can access that to track the new values.
#For simplicity, click '''OK''' to save the edited '''dayfile.txt''' file, and exit the editor.
#Rename the amended dayfile.txt as "dayfile(generated).txt".
#Create an empty text file in a suitable temporary directory, and name it "dayfile.txt",
#Use an external editor to open your empty file.
#*You can use a Comma Separated Value file editor, although you will find this difficult starting with an empty file
#*You can use an editor designed for computer programmers or developers that can edit text file
#*You can use a spreadsheet application, such as "Libre Office Calc" or "Microsoft Excel", providing you obey the editing rules defined later
#You should first merge in (as read-only text) the previous contents of the original dayfile.txt from the copy taken in step 2, although you could skip the fields you have updated, that makes it more complicated!
#You should next merge in (where there are fields to be updated or previously missing) ''just those fields from the respective lines'' in either "dayfile(generated).txt", or '''dayfileeditlog.txt''' (whichever you find easier to use, the latter has fewer lines so it may be easier to use).
#Finally, copy your temporary "dayfile.txt" into the "Cumulus\data" folder, so from now on Cumulus accesses the file with the maximum number of fields present.

One note of caution:
*If a required source or derived value is not present in the standard data log lines, Cumulus will write into related dayfile.txt fields zero for values, and in the editor "00:00" (in normal running it would insert your rollover time) for time stamps, because it does not understand the concept of "Null".
*Cumulus 1 does not have the functionality to retrospectively calculate derived values (e.g. cannot work out apparent temperature) when it is reading source values (e.g. temperature, humidity, wind speed) in the standard data log line.

= Important Rules when editing dayfile.txt =

If you are editing dayfile.txt outside the Cumulus 1 or MX software, there is the danger of changing something that prevents Cumulus from understanding the file when it next tries to use it.

== Warning if editing outside MX ==

You need to understand the following difference between the legacy Cumulus 1 and MX. In the legacy software (and early MX releases), "dayfile.txt" is read by the software if any output reports past days. In later MX releases, the only time the file is read is when the software is restarted, it is not read again.

From MX release 3.9.2 - b3097, Historic Charts were added to both the interface and the default web pages. As a consequence, when you start MX in this release (or any subsequent release), the entire content of dayfile.txt is held internally (i.e. in RAM), and it is these internally held values that are used by the .json api/files that feed these [[Highcharts - Historic]] plots. MX will append an additional array when it stores a new line in the file. The MX in-built editor actually displays/edits the internally held data, and then writes back (including any deletions or edits) that internal array into the file.

'''Prior''' to release 3.20.0 - b3200, if you were to edit the "dayfile.txt" using an external editor without stopping MX, any change you make is not seen by internal array, and such external edits would be lost should you (in the same MX session) use the internal editor. To propagate your external edits, you need to first stop, and then restart MX, and then the internal array will match the file.

''From release 3.20.0 - b3200,'' there is a utility provided that can copy what is held in the daily summary log file and update the internal array. Access this utility from the '''"Utils" menu''' added to the interface at this release.

== General Editing Rules ==

These rules should be followed whatever Cumulus file you edit externally.

# Take a copy of the file that can be reverted to if there is a subsequent problem, and you have messed up the file that Cumulus (1 or MX) is now trying to use.
# Take another copy and use that for your editing, don't edit the actual file being used by the software.
#*This prevents any conflicts between access by the software and access by your script or tool being used to modify the file.
#*It also means that you can go back to the last working copy, you can't upset your "revert" copy.
#The file must never be edited with a word processor, as they store many control and identification characters that prevent Cumulus correctly reading the values.
#* It is recommended that you use either a specialised "Comma Separated Value" file editor or a text editor, both of these can be easily used.
#** These tools have the advantage that they can cope with different lines having a different number of fields depending on which version number of Cumulus created each line.
#*You can use a spreadsheet tool, but if you do, there may be a number of settings to change from their defaults to ensure the file remains in a readable format for Cumulus.
#**If you do use a spreadsheet, extra field separators may be added at end of shorter lines as these make all lines end up with same number of fields.
#*Don't remove any figures from fields where figures currently exist, only change one entry into another entry in same format.
#Cumulus does not accept the concept of nulls, there is nothing that can be placed as a place-holder when the correct figure is not known, and empty fields are not permitted.
#All figures must be within the range of sensible figures for that field (e.g. no hour 24 or higher, no signed numbers when accepted values must be positive, don't put in any number over 100 for a relative humidity)
# Make sure that any editing does not create any ''blank lines'' in the file. Cumulus assumes an empty line means end of processing. Also ensure all lines have same end of line characters, this is one way accidental blank lines can be inserted!
# Don't include any header line in the file, Cumulus expects all lines to be data lines.

=== File specific Editing Rules ===

These additional (above rules still apply) rules are specific to any external editing of "dayfile.txt".

[[File:Open office (editing cumulus log files).png| right]]
# The file should be saved without "Byte Order Mark", specialised text editors will include a menu where you select the encoding and can select not to include BOM. (If you are using old software, both Microsoft and Google editors, used to insert BOM automatically).
# All rows must ''start with date'' as a text field (not a date formatted field) and include at least 14 further fields ''in correct sequence''.
# Remember the month must be the middle figure in the text field representing date, USA date convention cannot apply within this logfile.
#The separator between the three parts of the date should be a '-' hyphen or a '/' slash, it cannot be a space.
#*Whether Cumulus expects a hyphen or a slash is determined by the locale, you must keep to the same locale for the whole file, you cannot change the locale when you do an edit, nor when you update the device running Cumulus.
#*Although, use of comma or point for separating parts of the date is in some locales, and therefore allowed by Cumulus, those locale settings are not recommended as these date separators can cause issues for subsequent edits.
#* If you move your software (any flavour) to a new device, or you change from Cumulus 1 to Cumulus MX (or back), then you must ensure your dates still use the same separator, so all lines are consistent.
# The (meteorological) date format, in this text field, uses ''two digits for the year'':
#*This is one reason why you need to edit this file using an editor that treats all fields as text (a text editor, a CSV editor, or a spreadsheet program that can be instructed ''not'' to recognise special field types).
#*For spreadsheet tools (e.g. '''Calc''' in Libre Office, or Microsoft's '''Excel''') avoid using default of recognising formats, ensure that such recognition is turned off (see image), as it is likely to change the dates to either a number representing days since e.g. 31 Dec 1899, or to change it to four figure years, in either case Cumulus will no longer be able to use the log file.
# Each of the fields from date to the end of the line are separated using the list separator (e.g. a comma or semi-colon) defined for your device. After your editing it must still match what your existing dayfile.txt uses.
#* If you wish to use Excel, or to use "Calc" in 'Apache Open Office', "Libre Office", or similar, you may on opening the file need to pre-select the field separator that is being used now (in this illustration comma is selected, but your file might use semi-colons between fields, don't select commas if your real numbers use comma between integer and decimal parts) and leave "Detect Special Numbers" (or whatever similar feature name your tool uses) unselected. Again third party packages processing dayfile.txt will need to recognise your field separator, and some may need to specify it. Don't forget to also select it when you save the edited file (you probably need to select "save as" or the equivalent in your tool to see the option).
# Rows can vary in length but only by missing off ''fields at the end''. The minimum number of fields after the date is 14, the maximum varies between different Cumulus releases.
#* (The variation between maximum number of fields may cause a problem, if you regress to an earlier release!)
# Each field has a pre-defined format, and the same format must always be used in that field position.
#No fields will accept letters.
#*Some fields (e.g. bearings, solar, humidity) are ''integers'' (see [[#List_of_fields_in_the_file]]) only take integers. Decimals are not allowed in an integer field, so no comma or full-stop can be within these fields.
#* Most value fields are in ''real number format'' using your system/locale decimal notation ("x.y" or "x,y"). Trailing zeroes are not required, so you can put an integer in a real number field, you don't have to have a decimal comma or decimal point.
# Although only the date and 14 other fields are mandatory, you cannot skip some fields defaulting them to null is not allowed, so you cannot add fields at the end, without adding all earlier fields.
#when you do add fields beyond the 14, or however many already exist, be aware that for most derivatives what you add will represent a ''lowest or highest value'' and that must be paired with a time-stamp in the next field.
#* Cumulus will only accept highest/lowest figures if each value has any related time-stamp.
# Time stamp fields must always be in ''format HH:mm'' i.e. 2 digit hour in 24-hour format, followed by a colon, then 2 digit minutes
#**Be aware you will have problems if you, or your editing software, add seconds.
#* If when editing, you don't know what time to quote, the convention is to use a time-stamp of your roll over time i.e. 00:00, 09:00, or 10:00, if you have not looked up the precise time.
#* Except for wind gust (start of line) where an extra field is fitted in, each time field will immediately follow the value field for that parameter.
# Shorter lines can have multiple field separators added at end of row added either when editing within Cumulus or when editing using a spreadsheet tool.
#* Nulls (2 field separators without something between them ',,') are thus allowed at end of line, but are not allowed within the part of the line with values and time-stamps.
#*If you are editing out rogue values and if you do not know the value for a particular field within the line, then type in a zero or 9999 for nulls in integer format and an extreme with opposite value (e.g. -999.9 for a signed decimal maximum, and 9999.9 for a decimal minimum) for nulls in decimal format (replace the full stops with your decimal separator).
#*Beware - if you do insert zero or an obviously wrong extreme value, Cumulus will display those in any editing screen where you wish to update the all-time, monthly-all-time, this month, or this year, extremes. This can make editing by picking values in logs harder.
#Cumulus itself will use zero for any parameters (e.g. solar) not provided by your station, and will repeat the last valid value if the station fails to send a value it should provide, so if a station fails to send a value for more than a day, dayfile.txt may show the same value as the previous day.
#* Note that Cumulus will stop if your station fails to send what it considers as a vital reading, like pressure or temperature, so the previous point does not apply in all cases.
# The row terminator for Windows is ''CR LF'' (a combination of Carriage Return represented in many [[Reports_folder#Encoding|character set encodings]] by the binary equivalent of decimal 13), and Line Feed represented in many character set encodings by the binary equivalent of decimal 10), ensure any external editor does not change the two character terminator into a single character. Similar rules apply for single character terminators used by other operating systems (Linux uses LF only, Mac uses CR only), don't let any editor you use change a single character terminator into its double character terminator.
#*Problems with terminating characters are intercepted by operating system, before it reaches the software, but may still stop the software understanding the resulting file, so be careful if you edit the file on a different device to that running Cumulus.

Dayfile.txt

2022-08-06T17:01:48Z

Sfws: /* Table listing Fields */ release 3.20.0

{{Template:Version badge Mx}}{{Version badge 1}}This Wiki page applies to both Cumulus flavours. [[Category:Files_with_Comma_Separated_Values]]

As part of a redevelopment of Wiki, this page has been simplified, by moving some content to new pages. Old links in the support forum, that were to content no longer on this page, will bring you here.

Content previously on this page has been moved as follows:
* Explanations about Cumulus terminology can be accessed from [[:Category:Terminology]] page
* Each line in this file represents one day, but the start time need not be same for all fields,
** so please see [[Meteorological_day|Meteorological day]], and [[today.ini]] for more details about that
* Advice regarding editing this file has been moved to [[Amending dayfile]] page, this also covers date-separator issues and dealing with missing or corrupted lines
* General advice about Cumulus files with a '''.txt''' extension has been consolidated on [[:Category:Files_with_Comma_Separated_Values]] page
* Advice about correcting any rogue extreme figures inadvertently stored in this file has been consolidated in new [[Correcting Extremes]] page
* If some lines in your file have fewer fields than other lines the advice has been consolidated on [[Calculate Missing Values]] page
** For MX there is a [[Calculate_Missing_Values#CreateMissing.exe|Create Missing Utility]], which checks spot readings in the [[Standard_log_files|MMMyylog.txt]] files, adds any missing derivative spots (e.g. heat index) and uses these figures to recalculate daily derivatives and uses those to replace missing fields/lines in dayfile.txt
** For the legacy Cumulus, there was a [[Amending_dayfile#Create_Missing_on_legacy_dayfile_editor|dayfile editor with create missing option]], that performed equivalent function
** If you import historic data from before you started using Cumulus into [[Standard log files]],
** then see [[Calculate Missing Values]] page for how to generate new lines in dayfile.txt
* Cumulus MX is more fussy, than Cumulus 1, about various formattting issues, see below, also see [[Migrating_from_Cumulus_1_to_MX#dayfile.txt]] section for more advice

The content that remains on this page is summarised by the table of contents that follows.

=About this file=

* This Wiki page describes one of the [[:Category:Cumulus Files|files]] not included in any release download.
* This daily summary file (Steve Loft shortened that to "day" plus "file") uses a ".txt" extension, and is essentially a plain text file in CSV format.
* The file is created in [[Data folder|data sub-folder]] of your Cumulus installation when Cumulus needs to store its first line in this file.
* Cumulus MX reads the whole of this file when you restart the software,
** So if you move house, it is probably best to archive the old "dayfile.txt", and avoid any discontinuities in any graphs plotted from active file

([[Speciallog.txt|speciallog.txt]] is another log file that contains all dates in a single file, as do all the [[:Category:Ini_Files|.ini files]]).

==How Cumulus Creates and Updates this file==

* Cumulus reads values supplied by your weather station, (either directly while Cumulus running, or for some weather station types can read historic data during catch-up on restarting Cumulus)
* Cumulus converts them to the units you prefer,
* Cumulus applies any calibration (multiplier and offset) you have set,
* For a sub-set of those readings (perhaps those every minute if readings are collected every 10 seconds), the spot values of source items like temperature, humidity, wind speed, can be used in calculations of derived items like "wind chill", "dewpoint" and "feel-like" temperature.
* Cumulus then sees if the resulting soource, or derived, value implies [[:Category:Ini Files|any extreme records file]] needs to be updated
** Daily extremes are held in [[today.ini]] and that is main source used when a new line is added to "dayfile.txt"

==Why this file should be backed up==

* This file contains daily extremes, the accuracy of those daily extremes depends on the interval between the spot readings that are used as explained above.
* If the file is corrupted, and not regenerated from a back-up, the only source of spot readings is the [[Standard_log_files|MMMyylog.txt]] files, and their interval might be only every half an hour (it has to be an exact fraction of an hour).
* As explained [[Monthly_log_files#Enhancement never implemented|here]] minima and maxima between such logging intervals are not recorded by Cumulus software
* Thus it is worth backing up this file, to another device than that running Cumulus, on a regular basis, probably a few times a week, to ensure this precious data is not lost if your device running Cumulus has a malfunction (or is damaged), or an electrical blip (or mistake by you) causes corruption to the original file,

Cumulus does periodically copy this file within the installation, but the copies are only kept for a limited time, and are on the same physical storage device, and so your main file is corrupted you might not be able to access the Cumulus back up or might not be able to go far back enough for an uncorrupted file:
* The file is backed up when MX is restarted into a date/time stamped sub-folder of the [[Backup folder|'''backup''' folder]]
*The file is also backed up (to a date/time stamped sub-folder within '''daily''' sub-folder of that backup sub-folder) during the end of day process, depending on the release you are running the back-up copy may, or may not, include the line that is appended in the same end of day

Retention of these back ups:
* [[File:Badge vMx.png]] MX only keeps the last 9 of the date/time stamped subfolders.
* [[File:Badge v1.png]] Legacy Cumulus 1 only keeps up to 8 of the date/time stamped subfolders.

== Specific issues for MX ==

WARNING: It is important to note that some releases of MX are very fussy about consistency in all lines of '''dayfile.txt'''. Earlier releases tended to have better compatibility with the legacy software. Subsequent releases expected every line to be expressed exactly as specified in the locale. MX in its latest release is trying to cope better with inconsistent date separators, and at the time of writing this there was a proposal for forcing this file to use decimal points (full stops not commas) regardless of locale. Therefore, information here might be incorrect for the release that you are using.

Date field: Cumulus 1 (C1) did not care what character (or characters) separated the day, month, and year elements of the date field. MX insists that the same character (or characters), as defined in the locale, is used for all lines in file.

Real number fields: MX uses the '''locale''' to decide what character (decimal comma or decimal point) separates integer and decimal parts of numbers. Every line of the file must be consistent in use of integer/decimal separator. C1 used the '''Region''' settings in Microsoft's Control Panel to determine how to store (and output) numbers for you, but (except if ''list separation character'' was comma) was fairly tolerant when reading old data in files.

Time-stamp fields: MX insists on HH:mm format being consistently used in every line of file, C1 did not care what (non-space, non-field separator) symbol separated the minutes from the hours.

Number of fields: The number of fields in the file increases in various versions as shown in [[#List_of_fields]].
* C1 will accept (as did Cumulus 2) any line with 15 to 45 fields in it. This is because the earliest version only stored 15 fields, as C1 was developed fields were added (as shown in field list) until there were 45 fields.
* MX too has added fields as the software has developed, and it even (as shown in field list) inadvertently added 2 fields later removed. The difference is that MX (for some functionality from release 3.4.5, for all functionality from release 3.9.5) reads the whole file into an array with a fixed number of elements, therefore every line ends up with same number of fields when written back into file. If you have some lines in your file that were created by an earlier release of Cumulus, and so have less than whatever is the current number of fields for the release you are using, you can add the missing derived fields, please see [[Calculate Missing Values]] page. Please ensure you use the right version of the "Create Missing" utility mentioned on that page as it also get upgraded when fields are added.

==How to view or edit this file==

An editor has been included within Cumulus:
* [[File:Badge vMx.png]] From release 3.4.5 (13 Mar 2020) onwards: In [[MX_Administrative_Interface#The_Data_Log_Viewing_and_Editing_interface|the interface]] go to '''Data logs''' menu and select ''Dayfile''
* [[File:Badge v1.png]] From version 1.9.2 (5th October 2011) to final legacy release: On Main Screen from [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu|'''Edit''' menu]] select ''Dayfile.txt''
**'''Note for obsolete version 1.9.0 to 1.9.3:''' There is a bug in these versions in that 'Create missing' inserts 'heating and cooling degree day' values the wrong way round.
**'''Note for obsolete version 1.9.3 only:''' Create missing might in some cases be affected by a bug in 1.9.3 that can cause lines to be stored in incorrect date order (dayfile.txt uses dd.mm.yy, dd/mm/yy or dd-mm-yy, for its date field; and all lines should be in ascending chronological order)
**There are no known bugs for dayfile.txt handling in version 1.9.4 builds 1086 to 1101. Build 1099 is the standard stable final release of Cumulus 1 for most weather station types, 1100 and 1101 are for specific weather station types.

For detailed information, please see [[Amending dayfile|viewing/editing '''dayfile.txt''']].

==Reading the file==

See [[Daily Summary]] page for a full discussion of ways, external to Cumulus, to read this file.

Apart from the viewing/editing options just described, Cumulus software reads this daily summary file in various other circumstances depending on the release you are running.
* [[File:Badge v1.png]] The legacy Cumulus has a number of [[Cumulus_Screenshots#View_data|screens for viewing data for various periods]], these use several of the [[Category:Cumulus Files|files]] for their source, including "dayfile.txt". The '''Select a graph''' feature also uses several of the [[Category:Cumulus Files|files]] for their source, including "dayfile.txt". Thus the legacy software only reads the file when the Cumulus user makes a specific request, in normal operation the existing content is ignored, and the end of day action uses a simple "append" instruction.
* [[File:Badge vMx.png]] From release 3.9.2 - b3097 (7 Dec 2020), MX reads the entire '''dayfile.txt''' file, to drive the [[Highcharts_-_Historic|'''historic charts functionality''']]; both in the [[MX Administrative Interface|interface]], and the example included [[New Default Web Site Information|Historic Charts web page]].
** Consequently, any error in say the date field (or change of separating character) will stop historic charts working.

= List of fields in dayfile.txt =

'''For your installed build please see ''[[dayfileheader.txt]]'' (stored within the folder that contains your Cumulus executable), as that will list which fields your Cumulus installation uses.'''

If you have been using Cumulus for a while, you may wonder which of your log file lines might be shorter, so the table below shows fields grouped by the Cumulus version when those fields were added.

==Field numbering==

Please note the list of fields has been rewritten especially for MX. As part of the rewrite, the fields have been renumbered, in some forum posts you might see references to old numbering, in others to new numbering.
* The original table below was for Cumulus 1 and then field number '''was''' starting from zero.
** Cumulus 1 does not actually number lines, however it does count lines as it reads them, so if there is an error when it reads the file, the original Cumulus will report the line number where it first found an error (this uniquely identifies the line even if a date is duplicated or a line feed has been deleted so two lines are merged).
** Please note that the editor in Cumulus 1 allows you to change the date, as well as all the other fields, although the lines must be kept in ascending date order to avoid errors when subsequently reading the file
*The fields are now numbered starting from 1 to fit in with Cumulus MX where when the log file is read, the processing code adds a line number in front of the date field on each line it holds.
** The Cumulus MX user may not be aware of this happening as it is within the internal workings, where data from the file is transferred to an array, or data from the array is written back into the file.
**By using line numbers, MX is able to identify which line has been deleted or edited, MX coding treats the date as a fixed bit of text (MX does not allow you to change a date)

The old numbering from zero had two advantages:
# It stressed that the date field was different to the rest, all other fields were either values or time-stamps
# Numbering starting from zero is consistent with standard indexing used for arrays in programming languages (like JavaScript), so the number shown '''was''' the number to quote in any scripts where a Cumulus 1 line was converted to an array, and you needed to address a single field.

== Information shown in the table ==

* The date '''must''' be a unique identifier, the same date should not be repeated in another line, however Cumulus 1's editor allows you to change that date field.
* The remaining fields were all either numerical values, or a time paired with (except for first wind field) preceding numerical value.
** Cumulus 1 actually enforces this pairing (i.e. it validates that a time is present where it is needed).
*The alphabetic column identifiers used by many spreadsheets are shown
** IMPORTANT: Ensure '''all columns are set to "text" format''',
** Note that you will corrupt this file if you let your spreadsheet recognise content as dates or time, change the number of decimal places.
* The type of field is shown in the table,
** you must not include a sign for an unsigned field,
** you can not specify a decimal point in an integer field,
** all time fields must use 5 character "HH:mm" format
* The field description is shown, together with references to where that terminology is explained

== Table listing Fields ==

{| class="wikitable" border="1"
|-
!style="width:50px" | Field number
!style="width:50px" | Spreadsheet column
!style="width:200px" | Field type
!style="width:600px" | Description
|-
|0
|colspan="3"|For internal MX purposes, the zero field identifies a field that holds the line number. It is not actually stored as a field in the log file, but precedes any line exchanged via an application programming interface, and therefore is also included in an array representing all the fields in any log file line.

If you are processing this log file using a third party (or your own) script, that probably does not place the line number into any array, and your array elements will start at 0 for the field labelled 1 in this table, so putting all field numbers out by 1.
|-
|colspan="4" style="background:lightgray;"|Those fields included below have been in dayfile.txt from the start of Cumulus 1 (Version 1.0, the First release on 27th January 2004).
|-
|1
|A
|8 characters
|Date as ''2 figure day [separator] 2 figure month [separator] 2 figure year'' - the separator is that set in the windows system short date format (see [[setup]])
|-
|2
|B
|Unsigned number
|Highest wind [[Wind_measurement#Weather_Stations_and_Cumulus|gust]] speed
|-
|3
|C
|unsigned integer
|[[Wind_measurement#Wind_Direction | Bearing]] of highest wind gust
|-
|4
|D
|5 characters
|Time of highest wind gust
|-
|5
|E
|signed decimal
|Minimum [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | temperature]]
|-
|6
|F
|5 characters
|Time of minimum temperature
|-
|7
|G
|signed decimal
|Maximum temperature
|-
|Colspan="4" style="background: pink;"| Consistency Note: In some cases Minimum comes before Maximum, in other cases Maximum is before Mimum
|-
|8
|H
|5 characters
|Time of maximum temperature
|-
|9
|I
|Unsigned number
|Minimum [[Pressure_Measurement | sea level pressure]]
|-
|10
|J
|5 characters
|Time of minimum pressure
|-
|11
|K
|Unsigned number
|Maximum sea level pressure
|-
|12
|L
|5 characters
|Time of maximum pressure
|-
|13
|M
|unsigned number
|Maximum [[Rain_measurement#Rain_Rate | rainfall rate]]
|-
|14
|N
|5 characters
|Time of maximum rainfall rate
|-
|15
|O
|unsigned number
|Total rainfall for the day
|-
|colspan="4" style="background:lightblue;"|Above here represents the minimum length for every line, a count of 15 items
|-
|colspan="4" style="background:pink;"|[There is no record of which version added this next field. The Cumulus Support Forum, while it was hosted by Steve Loft, moved to new forum software (phpBBB3) on 2 Jun 2008, and started afresh without retaining any previous content. Therefore all announcements about the content of each build prior to version 1.7.9 were lost. All that can be deduced is that it was between versions 1.2.5 and 1.5.1 as these do not appear in the release history issued by Steve Loft. The first mention of it in the new forum was not until December 2008, but that was not about when it was released. A web tag for this variable was added in Build 978 of 1.9.1 beta, which was obviously long after it was first calculated.

Because of that, in "DataEditor.cs" (part of the source code that is compiled into CumulusMX.exe) this addition has "Extended for ???" as a comment]
|-
|16
|P
|signed decimal
|[[Average temperature]] for the day
|-
|colspan="4" style="background:lightgray;"|(Wind run was added from version 1.8.4)
|-
|17
|Q
|unsigned number
|Daily [[Windrun | wind run]]
|-
|colspan="4" style="background:lightgray;"|(The next pair of entries were added from version 1.8.9 build 907 (June 2010) as part of a total redesign of how dayfile.txt was implemented in Cumulus 1)
|-
|18
|R
|unsigned number
|Highest [[Wind_measurement#Weather_Stations_and_Cumulus|Average Wind Speed]]
|-
|19
|S
|5 characters
|Time of Highest Avg. Wind speed
|-
|colspan="4" style="background:lightgray;"|(The two pairs of humidity entries were added in October 2010, a v 1.9.0 beta, the exact build number is now lost)
|-
|20
|T
|unsigned integer
|Lowest [[Temperature_(and_humidity)_measurement | humidity]]
|-
|21
|U
|5 characters
|Time of lowest humidity
|-
|22
|V
|unsigned integer
|Highest humidity
|-
|23
|W
|5 characters
|Time of highest humidity
|-
|colspan="4" style="background:lightgray;"|(The next two entries were added from version 1.9.0)
|-
|24
|X
|(not documented)
|Total evapotranspiration (Only valid for Davis stations, shows zero otherwise)
|-
|25
|Y
|unsigned
|Total hours of sunshine (only valid if sunshine sensor connected)

'''Important if rollover time is 9 am or 10 am:''' Most fields in this file are updated taking information from [[today.ini]]. For a non-midnight rollover, then the Sunshine hours reported here is from 00:01 on the calendar date corresponding to the date in the first field of this file, to subsequent midnight, and that end time is 9 or 10 hours before when this file is updated. Meanwhile, the sunshine hours count has been reset and so the figure in today.ini is not what is wanted here. For that reason the sunshine hours reported here are taken from [[yesterday.ini]].
|-
|colspan="4" style="background:lightgray;"|(The next 16 entries were added from version 1.9.1 May 2011)
|-
|26
|Z
|signed decimal
|High [[Heat index]] (added to Cumulus in 1.7.11 only as spot value, not stored)
|-
|27
|AA
|5 characters
|Time of high heat index
|-
|28
|AB
|Signed decimal
|High [[Apparent temperature]]
|-
|29
|AC
|5 characters
|Time of high apparent temperature
|-
|30
|AD
|signed decimal
|Low apparent temperature
|-
|31
|AE
|5 characters
|Time of low apparent temperature
|-
|32
|AF
|unsigned number
|High hourly rain
|-
|33
|AG
|5 characters
|Time of high hourly rain
|-
|34
|AH)
|signed decimal
|Greatest [[wind chill]] (high wind speed, low temperature) (calculated since version 1.8.3 as spot value, not stored)
|-
|35
|AI
|5 characters
|Time of greatest wind chill
|-
|colspan="4" style="background:lightgray;"|(The next two pairs for dew point were added in version 1.9.2 beta build)
|-
|36
|AJ
|signed decimal
|High [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | dew point]]
|-
|37
|AK
|5 characters
|Time of high dew point
|-
|38
|AL
|signed decimal
|Low dew point
|-
|39
|AM)
|5 characters
|Time of low dew point
|-
|colspan="4" style="background:lightgray;"|(The next three entries were added in version 1.9.2 Build 1004)
|-
|40
|AN
|unsigned integer
|Today's dominant/average wind direction
|-
|41
|AO
|unsigned decimal
|[[Heat/cold degree days and Chill hours | Heating degree days]]
|-
|42
|AP
|unsigned decimal
|[[Heat/cold degree days and Chill hours | Cooling degree days]]
|-
|colspan="4" style="background:lightgray;"|The next two pairs were added in legacy version 1.9.3 build 1036 (these only show valid values if appropriate sensors exist).

Fields listed up to those following here applied to the final legacy Cumulus 1.9.4 and formed the basis for early releases of Cumulus MX.
|-
|43
|AQ
|unsigned decimal
|High solar radiation
|-
|44
|AR
|5 characters
|Time of high solar radiation
|-
|45
|AS
|unsigned decimal
|High UV Index
|-
|46
|AT
|5 characters
|Time of high UV Index
|-
|colspan="4" style="background:lightgray;"|The next two pairs were added in MX release 3.6.0, 2 more derived values and their times
|-
|47
|AU
|signed decimal
|High [[Feels Like]] temperature
|-
|48
|AV
|5 characters
|Time of high feels like temperature
|-
|49
|AW
|signed decimal
|Low Feels Like temperature
|-
|50
|AX
|5 characters
|Time of low feels like temperature
|-
|colspan="4" style="background:lightgray;"|The next two pairs were added in release 3.6.12

*Version 3.6.12 (build 3088) was an emergency release to cure serious problems in previous build 3087. It added the following 4 fields (2 values and their times).
**The 4 extra fields are left empty in this release, although you can add values and time-stamps using the dayfile editor.
*From release 3.7.0 the first 2 of these 4 fields are populated, and the last 2 are removed, so I have labelled them as error.
|-
|51
|AY
|signed decimal
|High Canadian Humidity Index or [[Humidex]]
|-
|52
|AZ
|5 characters
| style="background:pink;"|Time of high Humidex

'''Bug for releases 3.13.0 to 3.14.2 inclusive''': The major code rewrite for release 3.13.0 replaced the previous code for the processing for all Cumulus files, the new code incorrectly stored ''Time of high feels like temperature'' in this field for all these releases! Corrected in minor code rewrite for 3.14.3 - b3163 25 Jan 2022 (not released to public until 3.15.0 - b3169 Released 31 Jan 2022)
|-
|colspan="4" style="background:lightblue;"|Just confirming that the next 2 fields were included by mistake in an emergency release (3.6.12), and are not included in any other version, so have labelled them as error.
|-
| 53 ('''error''')
| BA
| signed decimal
| Labelled as Low Humidex, but not used, (appear in 3.6.12, but no other release)
|-
| 54 ('''error''')
| BB
| 5 characters
| Labelled as Time of low Humidex, but not used, (appear in 3.6.12, but no other release)
|-
|colspan="4" style="background:lightgray;"|The next value was added in release 3.12.0
|-
| 53 (new)
| BA
| unsigned decimal
| [[Heat/cold_degree_days_and_Chill_hours#Chill_Hours_and.2For_Air_Frost|Cumulative Chill Hours]] since start of season
|-
|colspan="4" style="background:lightgray;"|The next value and time fields were added in release 3.20.0
|-
| 54
| BB
| unsigned decimal
| Highest rainfall total in (an approximate, as it depends upon timing of earlier entries in [[Recent history]]) 24 hour period ending in [[Meteorological day]]
|-
| 55
| BC
| 5 characters
| Time when (approximate) 24 hour period for rainfall total above ends
|}

==Example of the file==

An extract of a few lines of a dayfile.txt

<pre>
01/08/11,19.3,61,10:22,12.5,06:58,23.8,14:49,1014.26,20:46,1018.83,09:28,0.0,00:00,0.0,17.8,21.6,4.6,10:44,36,14:14,86,01:56,3.56,8.9,23.8,14:49,23.1,14:50,12.3,06:59,0.0,00:00,12.5,06:58,11.3,00:16,6.9,14:34,354,2.0,1.5

02/08/11,16.1,20,16:55,14.7,06:45,24.2,13:54,1013.79,19:13,1015.65,11:14,0.0,00:00,0.0,18.9,13.7,8.0,15:55,42,20:42,85,06:50,2.79,4.9,24.2,13:54,24.3,13:55,15.1,06:40,0.0,00:00,14.7,06:45,14.8,11:59,7.0,21:09,57,1.0,1.7

03/08/11,14.5,36,17:23,14.9,05:50,24.6,14:46,1012.70,18:44,1015.99,08:34,0.0,00:00,0.0,19.4,17.2,4.8,16:04,50,14:38,79,07:04,3.05,5.8,24.6,14:46,25.4,14:47,15.0,05:50,0.0,00:00,14.9,05:50,14.2,20:01,8.9,00:16,32,0.8,1.9

04/08/11,17.7,16,15:43,14.1,06:20,25.3,15:06,1013.08,18:42,1015.31,08:28,0.0,00:00,0.0,20.2,19.4,8.1,14:12,52,18:20,92,06:55,3.30,9.1,25.3,15:06,26.8,14:55,14.9,06:20,0.0,00:00,14.1,06:20,15.8,14:55,12.5,06:25,36,1.0,2.9

05/08/11,16.1,32,12:52,14.2,06:12,22.2,14:07,1013.89,00:01,1016.36,09:43,0.0,00:00,0.0,18.6,21.6,5.2,13:00,62,15:57,87,06:11,3.30,8.4,22.2,14:07,23.5,14:10,14.8,07:19,0.0,00:00,14.2,06:12,15.4,10:33,12.0,06:03,34,0.9,1.3

06/08/11,16.1,309,11:15,14.3,05:29,22.4,17:12,1014.46,20:02,1016.97,10:38,0.0,00:00,0.0,18.4,19.2,5.5,16:21,55,13:33,92,05:20,2.79,7.9,22.4,17:12,23.3,18:17,15.1,06:09,0.0,00:00,14.3,05:29,14.2,18:12,10.9,10:38,32,1.1,1.3

07/08/11,17.7,342,13:24,12.9,05:47,24.1,14:53,1013.92,19:49,1016.43,09:36,0.0,00:00,0.0,18.4,19.1,6.3,14:06,48,12:45,89,05:36,3.30,9.0,24.1,14:53,24.6,15:48,13.3,05:47,0.0,00:00,12.9,05:47,14.6,15:52,10.7,11:33,11,1.6,1.7
</pre>

Today.ini

2022-08-05T21:07:37Z

Sfws: /* Dealing with rogue values */ deal with more typing errors

[[Category:Ini Files]]

= Introduction to tracking of Daily Extremes/Totals/Averages =

Steve Loft first wrote Cumulus software in 2003, although it was not shared with the public until 27th January 2004. His (no longer available) web site claimed (amongst other reasons) that Cumulus was invented to cope with [[Meteorological_day|tracking high and low for days starting at 9 a.m.]] as (at that time) no other software could do that. Therefore, it can be assumed that even in 2003, Cumulus software was tracking the highest/lowest for all time as well as for each day . (For daily period, there is also tracking of some totals, and in some cases by dividing by number of samples averages can be calculated). This Wiki page covers all aspects of the daily tracking.

The legacy Cumulus 1 software has a '''Recent extremes''' frame on its [[Cumulus_Screenshots#Main_Screen|main screen]]. In release 1.0 (27th January 2004) this only showed extremes for today, but from 1.1 (17th February 2004) it also shows extremes for yesterday. The interface provided with Cumulus MX is also able to show the extremes for today and yesterday (on a single web page).

=Essential reading=

Cumulus 1 has a [[Downloads#Resources|Help file]] that is part of the Cumulus 1 installation package; that provides a simple explanation for each file.

David Jamieson created this Wiki page on 27 August 2009, to cover "today.ini" and "yesterday.ini" files. His introductory text simply stated these files were for tracking extremes in the two days and new files were created at 9am or midnight rollover. David also included a listing of a typical "today.ini" file.

Since the initial creation of the Wiki, it has attempted to become reference documentation that answers questions that arise frequently in the support forum. This does mean its pages have become harder to read, and thus there is now an attempt to split "essential" facts that give a basic understanding (as in following subsections) from "technical" facts (later on this page with more complex instructions on how to cope with problems).

Therefore for a quick read, stop after this essential section or use the page index above to skip quickly to whatever is of interest to you.

== How Cumulus tracks extremes and why two files were introduced ==

Cumulus software handles daily tracking by storing values internally, i.e. within its use of random access memory. As the software processes (the time interval for doing this varies between weather station type and also on exactly which release you are running) data from the weather station, incoming values are compared against internally held values, and when appropriate the values being processed update the internal values.

Cumulus initially made the assumption that it would be left running continuously, so holding values internally enabled them to be shown on that screen. However, subsequently it was realised that Cumulus had to be stopped and restarted to install a new version (and Microsoft's updates system restarts computers as part of its installation process). Information held in RAM is lost when the software is closed.

Apparently when version 1.3 was released (18 January 2005) it did not include "today.ini" nor "yesterday.ini". An attempt to track the history of the "today.ini" file appears [[Changes to this file at particular releases|below]]. Unfortunately, Steve Loft lost some of his notes, and the Cumulus 1 version history in his [[Downloads#Earlier_Versions|changes.txt]] is incomplete. So it is pure guesswork that version 1.4 resolved the problem of losing daily information on closing Cumulus by introducing a '''today.ini'' file to hold the daily extremes and total records.

Steve Loft did document that at rollover, the daily extreme/average records were "transferred" (there are some differences) from "today.ini" to [[yesterday.ini]]. That second file was not vital, but made it easier to display yesterday's extremes on the main screen of the legacy software.

The sub-section below covers end of day actions in more detail, subsequently explaining actions might happen twice a day!

When you close Cumulus, it will write the final values for highs and lows and their timestamps to ''today.ini'' as part of the close down process.

==End of day actions==

End of day actions happen when Cumulus detects that it is processing weather data for the rollover time [either midnight, or 9am (or 10am) depending on your configuration and season], this might be during the processing of archive data while Cumulus is catching up after it has been restarted, or in normal running when those clock times are reached.

Oversimplifying the process a bit, the contents of today.ini, goes to two places:
# yesterday.ini
# a new line appended onto [[dayfile.txt]]

After that a new today.ini is created populated with initial values for each extreme/total entry.

The three files have a few differences in content, so rolling-over does involve a little editing work:
# The multiple lines in the [General] section of today.ini shrink to just one item in yesterday.ini (Date) and one item in dayfile.txt (abbreviated date)
# The 'Total' and 'Samples' values in "today.ini" become the single 'AvgTemp' in "yesterday.ini" and "dayfile.txt"

=== Complexity if you are recording sunshine hours ===

Sunshine hours are recorded starting at midnight, regardless of what rollover time is used.

For MX only, the sunshine hours are partly recorded in [[yesterday.ini]] and partly in today.ini. So even if your rollover is 9 am, there will be an update to both files at midnight which is when the current sunshine hours figure in today.ini is copied to yesterday.ini before the figure in today.ini is reset to zero.

==Where are the files stored?==

The files '''today.ini''' and '''[[yesterday.ini]]''' are located in the [[Data folder|"data" sub-folder]] of the path where your cumulus.exe (or CumulusMX.exe) is installed.

(NOTE: Microsoft Windows Operating Systems, may relocate some files, as explained at [[FAQ#I_can.E2.80.99t_find_my_data_files.21| FAQ on location of data log files]]).

When Cumulus is left running, a daily backup of all the files is created as part of this rollover in a subfolder 'daily' of the [[Backup_folder|backup folder]]. Depending on the release you are running, the files included in the backup may be a snapshot of their content just before rollover, just after rollover, or at the first standard interval after rollover.

== How Cumulus updates the file ==

This depends on which flavour of Cumulus you run. The [[#End of day actions|end of day process]] is same for both flavours, but updates during the day work differently for the legacy software and for MX.

For '''today.ini''', it is important to be aware that MX can read a file created by Cumulus 1 (MX can read the time format in the value for '''Timestamp=''' parameter whether it is in Cumulus 1 or MX format), but Cumulus 1 cannot read a file that has been updated by MX.

Cumulus MX and the legacy software handle the updating of "today.ini" differently, this difference is critical should you want to [[Correcting_Extremes#Correction_of_extremes_for_today|edit out rogue data]].

=== How Cumulus 1 updates the file ===

Steve Loft never shared his souce code, so what follows is just a guess at how the update might work. The frequency at which data is read from a weather station varies depending on the type, but is at least every 30 seconds.

The indications are that Cumulus 1 has an internal one minute timer that triggers the logging of readings (after conversion to units selected) to an internally held [[Recent history|recent history database]] and the comparison of those readings against existing internally held extremes/totals. The file is updated immediently afterwards, each update only changes those lines (within sections) where the extreme/total/count/time has changed, and other lines retain the same content as before the update.

Whilst you are strongly advised not to manually edit the file with Cumulus running, because access to the file cannot be shared, if you are able to complete the edit between one real-time interval and the next, any change you make is retained.

(NOTE: A full set of latest spot readings are logged to a file at a configurable interval that might be every 10 or 30 minutes).

===How MX replaces the file===

Note the subtle difference in this sub-section header. MX does all updates to the today extremes/totals/counts only to internally held values. Although the [[Software#Latest_MX_Source_Code|source code]] is available, you need to be more technical than the person typing this to understand at what frequency these internal updates occur. It is probably every time data is read from the weather station, but might be just when the externally stored [[Recent history|recent history database]] is updated.

Critically, MX only updates the "today.ini" file at the configurable [[Standard log files|Standard interval]] used for logging the spot values (might be every 10 or 30 minutes). Each update is a ''rewrite of the entire file contents'', from the internally (RAM) held values.

You would be wasting your time should you try a manual edit of the file while MX is running, as the next MX update will overwrite any manual changes! Don't be misled by the fact that a sharing violation is less likely to be an issue (because of the longer interval between MX updates).

== Format of the file ==

The files are text files, consisting of many lines. Some lines consist of a single piece of text surrounded by square brackets, these are the section names. The sections (for "today.ini" after the first [General]) can be in any order, Cumulus will maintain whatever order the sections are currently in.

Under each section name, there is a list of parameters <code>attribute=value</code>, with one parameter per line. The attribute names are defined by Cumulus, but can appear in any order:
* Where a time-stamp is stored, note that in "today.ini" only the hour and minute parts of a time are stored.
* Where an extreme/total value is stored, note that it is always post conversion to the units selected by the Cumulus user.
** It was mentioned earlier that the file exists to store values that Cumulus holds in RAM. Internally those numbers are in binary (base 2), but in the file the numbers are expressed to base 10. The value of any integer part of numbers is unchanged between the two bases, but decimal parts in base 2 and base 10 do not convert exactly, therefore in the file you may see some strange looking numbers with lots of decimal places.

The key difference between all [[:Category:Ini_Files]] for the different flavours is the formatting of any time-stamps that include a date:
* [[File:Badge v1.png]] Cumulus 1 used the format specified in Control Panel for your region settings, for UK that would typically be <code>day/month/year (space) hour:minute</code> in today.ini
* Cumulus 2 (withdrawn) worked differently, all date/time stamps were converted to UTC, and stored in ISO 8601 format of <code>yyyy-MM-ddTHH:mm:ss</code>(using the net specifiers that MX uses).
* [[File:Badge vMx.png]] Cumulus MX uses the same format as Cumulus 2, but all date/times are expressed according to date/time read from the computer running MX, so use whatever time-zone you have selected on that device.

Please look at the category page (link above) to read more on formatting differences between the legacy Cumulus and MX.

===Typical Sections within file===

As Cumulus is developed it is adding further sections, but the legacy Cumulus (by 1.9.4) used the following:
* The [General] section stores current date and time.
* The [Wind} section stores the highest wind speed and highest gust, it holds the sum of wind speeds as wind run, and details for the dominant wind.
* The [Temp], or temperature, section stores the highest and lowest temperature, the sum of all temperatures from every sample (Total), and the number of Samples in that total, the Cumulative Chill Hours total (for the season), and the cumulative Heating and Cooling Degree Days for the current day-so-far.
* The [Pressure], [Humidity], [AppTemp] (for apparent temperature), and [Dewpoint] sections just hold Highs and Lows.
* The [WindChill] section only holds lowest, the [HeatIndex] section only has highest.
* The [Rain] section holds a lot of different parameters, including the Start count that derives most rain outputs, and the LastTip date-time.
* Other sections present in 1.9.4 are [ET], [Solar], [NOAA], and [FineOffset]; whether these are updated depends on what sensors you have, and whether you have set up NOAA reports.

MX development has been far more rapid than the legacy software, and there have been a lot of changes to the content of the two files. Unfortunately, the MX release announcements rarely go into enough detail to permit good documentation, so all mentions relating to MX on this page are guesses from examination of the file, and it cannot be guanteed that the information is correct for whatever MX release you may be running!

A typical MX release will include all the 1.9.4 sections, plus:
* The '''[Records]''' section contains one line denoting when extreme records were last revised. For example "Alltime=2020-03-06T06:42:13", indicates when the all-time extreme records was last updated. In the example file, there were various extreme records broken at that time on 6 March (lowest temperature, lowest apparent temperature, and greatest wind chill), but none have been broken since.
* Other sections (depending on MX release) may include [FeelsLike], [Humidex], [Lightning], and [TempMidnight]; whether these are updated depends on what sensors you have.

===Composite Example of 'today.ini' file===

'''Notes in round brackets () are not part of the file, they simply explain elements of the composite.'''

* This is an example made up of composites that may not all be present in an actual file.
* This composite contains time-stamp formats used by Cumulus 1.x.y and Cumulus MX in the few places where they differ.
* Because this example is made up of composites, the times shown are not all consistent, in a real file no time anywhere will be later than the time at the top!
* The order the sections appear in this composite may not match your file; as mentioned above the section order can be edited.

<pre>
[General]
Date=29/09/2009
Timestamp= (format for Cumulus 1 e.g. "29/09/2009 09:50:00"; format for Cumulus MX e.g. "2019-09-29T09:50:00")
CurrentYear=2009
CurrentMonth=9
CurrentDay=13

[Wind]
Speed=10.7008972167969
SpTime=10:09
Gust=22.0114517211914
Time=08:42
Bearing=90
Direction=E
Windrun=63.1526298522949
DominantWindBearing=317
DominantWindBearingMinutes=1041
DominantWindBearingX=-3914.11743164063
DominantWindBearingY=4215.82763671875

[Pressure]
Low=1014.89996337891
LTime=11:13
High=1018.79998779297
HTime=00:06

[Rain]
High=0
HTime=00:00
Start=1923.59997558594
Yesterday=0
LastTip=2009-09-14 10:48
HourlyHigh=0
HHourlyTime=00:00
ConsecutiveRainDays=2
ConsecutiveDryDays=0
RG11Today=20

[ET]
Annual=1148.2578125
Startofday=1147.24182128906

[Temp]
Low=8.30000019073486
LTime=01:16
High=16.8999996185303
HTime=11:41
Total=7500.697265625
Samples=714
ChillHours=3147.15673828125
HeatingDegreeDays=5.34738397598267
CoolingDegreeDays=0.502222061157227

[HeatIndex]
High=16.8999996185303
HTime=11:41

[AppTemp]
Low=5.0417857170105
LTime=01:30
High=15.0359125137329
HTime=11:52

[WindChill]
Low=6.39816427230835
LTime=01:30

[Dewpoint]
Low=5.30104923248291
LTime=00:52
High=10.7219848632813
HTime=11:38

[Humidity]
Low=65
High=88
LTime=11:45
HTime=06:06

[Solar]
SunshineHours=1.08333301544189 (This is Cumulus 1 example)
SunshineHoursToMidnight=5.80002069473267 (This is Cumulus 1 approach)
HighSolarRad=1048
HighSolarRadTime=09:41
HighUV=7.40000009536743
HighUVTime=09:41
SunStart=0

[NOAA]
LatestMonthlyReport=NOAAMOSep2012.txt
LatestYearlyReport=NOAAYR2012.txt

(The above section will look like the one below if NOAA reporting has not been set up)

[NOAA]
LatestMonthlyReport=
LatestYearlyReport=

[FineOffset] (if not using a Fine Offset station, the MX defaults are as shown)
FOSensorClockTime=(the format here is different for Cumulus 1 e.g. "29/09/2009 09:50:00" and Cumulus MX e.g. "0001-01-01T00:00:00")
FOStationClockTime=(the format here is different for Cumulus 1 e.g. "29/09/2009 09:50:00" and Cumulus MX e.g. "0001-01-01T00:00:00")
FOSolarClockTime=0001-01-01T00:00:00 (this parameter only appears in later MX releases, the time shown is the default if no solar sensor)
</pre>

 
<hr>
 

=Non-essential more technical information=

You can skip the following subsections unless you have a particular need to read them.

== First use of Cumulus ==

When you use Cumulus software for the very first time, it records a start date, and assumes you have no data anywhere for earlier than that start time.

Some weather station types have an internal logger that can be accessed for historic data. It is theoretically possible, but not recommended, to read in that historic data, so it is included in your Cumulus extreme tracking. The minimum content for "today.ini" is the "[General]" section. If you stop Cumulus, manually edit "today.ini" to remove all other sections, and then restart Cumulus, then the software will attempt to read that historic data. Please read [[FAQ#I.E2.80.99ve_just_installed_Cumulus.2C_and_it_didn.E2.80.99t_download_all_the_old_data_from_my_weather_station | FAQ here]] for full guidance. Remember this only applies when you are first starting use of Cumulus with a weather station.

== Restart and Catch-up ==

If you restart Cumulus during the day it will read the ''today.ini'' file at startup, so it can resume tracking extremes of the key parameters starting from latest stored values in today.ini. If your weather station type permits, a restart of Cumulus can go into a catch-up mode during which it reads any historic data from the weather station, for the period while Cumulus was not running, before starting the reading of the current data.

During that catch-up of historic data, internally held daily extremes, and the "today.ini" file, will be updated with revised highs and lows as Cumulus processes the historic data from the station's memory; and if necessary Cumulus will do a roll-over (see [[#End of day actions]]) as it processes the readings for the relevant time.

On restart Cumulus writes a backup of today.ini (and some of the other Cumulus files) into the [[Backup_folder|backup folder]] found below the folder with the cumulus.exe (or CumulusMX.exe). With Cumulus stopped, you can copy the today.ini file in either a restart backup, or a daily backup (see [[#Where are the files stored?]]), also copying the other files in that backup folder into their original folders (mostly [[data_folder|data sub-folder]]) overwriting the files in those destinations. When you restart Cumulus, the tracking will begin again as if the time has been rewound back to the date those copied files were last updated. This rewinding works best if historic data can be read from your weather station. One example of when this might be useful is if you spot a rogue value very soon after it has been recorded, the rewinding often brings in correct data for the recent period. Another example is if your computer on rebooting initially shows the wrong time and so Cumulus records some data against that wrong time; a rewind can eliminate the wrongly timed records and replace them with records timed correctly.

You are strongly advised not to stop/restart Cumulus close to either midnight or your rollover time. Steve Loft defines "close" in this context as within whatever time you have set as interval between logging of spot values (e.g. 10 or 30 minutes). The potential problems were significantly worse for earlier versions of Cumulus 1, but restart problems have been reduced in newer builds of C1. In general, MX is more tolerant over restart timings, but the way its code works you will encounter more problems with accuracy of output if MX is stopped for more than the few minutes needed for an upgrade (or computer reboot).

== Editing rainfall in today.ini within Cumulus ==

This sub-section applies to Cumulus 1 and Cumulus MX.

At the time of writing, no Cumulus release contains an editor for today's daily extreme records as stored in "today.ini". There is just one exception, both flavours do contain an editor for 'Today's rain'.

Cumulus internally stores a "start of day rain counter". This is copied into "today.ini" into the ''Start='' line within the '[rain]' section. Subtracting that from the current rain counter value allows Cumulus to calculate (in your chosen units) the toatl rainfall for today. The provided editor changes the internal "start of day rain counter" so that the current rainfall total becomes what you enter into the editor.

It is important to note:
* The rainfall counter was invented in Cumulus 1 as a way that could calculate rain when the software was made to serve multiple weather station types
* The counter is based on a piece of data that can be read from a particular weather station type, it might be based on an all-time total rainfall, or based on a rainfall this year figure
* The counter is not intended to be of any interest to the Cumulus user
* Any increase in the rainfall counter is treated as representing valid rain (spike removal functionality exists only for rain rate and rain in last hour, not the total rain)
* Cumulus has special code to detect if the counter value decreases, without going into the complexity, Cumulus will normally reset its internal start of day counter based on the decrease in the number received.
* The "Today's rain" editor does not affect any derived rainfall output;
** The following in "today.ini" are not affected:
*** last tip time-stamp ("LastTip=")
*** highest rainfall rate so far today and time-stamp ("High=" and "HTime=")
*** hourly high amount and time-stamp ("HourlyHigh=" and "HHourlyTime=")
*** Highest 24 hour amount
** Outside "today.ini" it does not affect any recent records nor monthly, yearly, monthly-all-time, or all-time extremes:
*** The recent history entries whether held internally (Cumulus 1), or for MX in [[Cumulusmx.db]], are not amended so any tags used for web page data, local API, custom SQL, MQTT, HTTP (see [[Webtags/Parameters#Cumulus_MX_software|this Wiki section]]) will report incorrect values
*** Total Rainfall this month, rainfall this year/season will only be recalculated if Cumulus is stopped and restarted after the edit
*** Highest rainfall rate, highest hourly rainfall, highest 24-hour rainfall, highest daily rainfall; applying to these longer periods are not changed unles each extreme record is individually manually edited (Cumulus provides an editor for most of these, but cannot generally suggest what new value to use).
*** The consecutive wet/dry days ("ConsecutiveRainDays=" and "ConsecutiveDryDays=") in this month/year - remember these counts are to last roll-over, they exclude today
** The editor does not alter any lines already logged in [[Standard_log_files |log file]] for the current month. This means you will see distorted graphs attempting to portray rainfall within a day
** The editor does not update any database records that may be affected by the change of the rainfall total

== Dealing with rogue values ==

The "today.ini" file is written to throughout the current day, as described [[#How Cumulus updates the file|earlier]]. As mentioned above, Cumulus only provides extremely restricted ability to edit "Today's rain", not any other extreme/total that is stored in the "today.ini" file.

If your weather station reports a rogue value, an incorrect update to a High, Low, or Total, may get stored in this file. At end of day, it will then be stored in [[dayfile.txt]]. Cumulus developer advice is that instead of manually editing "today.ini", you should wait until the day has been stored in "dayfile.txt" and then use the editor for that log file to make the desired changes.

The rogue value may also affect extreme records held for this month, this year, monthly-all-time, and/or all-time. Cumulus does provide editing functionality for most (not all) entries in the files holding those extreme records and you can read instructions on [[Correcting Extremes]] Wiki page. Here it is sufficient to say it is worth looking in the diagnostics, to see if you can spot when the problem occurred, because that helps you work out what may be affected:
* [[File:Badge vMx.png]] [[MXdiags folder]]
* [[File:Badge v1.png]] [[Diags_folder]]

=== Manual editing of "today.ini" ===

The developer advice to wait until next day has a flaw; every process that happens in the meantime sees wrong data, and that might include sending data to several external sites, and a number of extra custom processes you might have in your system.

Therefore this Wiki page will now give some advice on how to manually edit the file:
# You must stop Cumulus (please see earlier in this page for details as reason depends on flavour you are running)
# Always take a back-up of existing file, or (if you decide it is easiest to create a new file rather than edit the existing one) rename it; your corrections may cause problems, so you must be able to revert
# Any plain text file editor can be used (that includes coding editors like Geany, Notepad++, NoteTab, and many others)
# Be careful to ensure any change maintains existing format (integer, decimal,time, date/time, text) paying attention to any punctuation (including decimal commas or decimal points, direction type of any slashes)
# For readability you can insert blank lines into files '''today.ini''' and '''yesterday.ini''', Cumulus will not mind.
# It is up to you to work out what new value/time to type, Cumulus won't accept nulls, but there are some "initial values/dates" that it will accept (I won't tell you these here, because they depend on release you are running and you should not be editing this file unless you have enough technical understanding to work out what Cumulus will accept)
# Remember changing extremes for [[Calculate_Missing_Values#Some_definitions|source value extremes and derived extremes]] is complicated:
#* Please see specific advice in sub-sections below

==== Edits related to pressure ====

Should be straight forward, the maximum/minimum can be edited without this affecting anything else. You should be able to look in either [[Standard_log_files |log file]] or for MX in [[Cumulusmx.db]] for pressure readings earlier or later in the day to find the new extreme value/time to replace the rogue pressure value and time.

==== Edits relating to Temperature ====

#If you change a temperature source extreme (i.e. highest/lowest temperature) you should also be taking the old value out of 'Total' line and decreasing by one the'Samples' count
# You cannot work out from any change in a temperature source extreme (i.e.. highest/lowest temperature) how to change the related derived extremes (e.g. wind chill, apparent temperature, feels like, dew point). Each derived value is worked out by combining spot values at a particular time, so you have to recalculate as many spot derived values as possible in order to work out the new derived extreme.

==== Editing Chill Hours====

Prior to release 3.12.0, the web template "thisyearT.htm" included a single cumulative figure for [[Heat/cold_degree_days_and_Chill_hours#Calculation_of_Chill_Hours|seasonal chill hours]], and that figure was taken from the chill hours figure stored in "today.ini". A lot of processing was needed to calculate this figure so, in these earlier releases, it was unusual for anyone to correct any rogue figure.

From release 3.12.0 onwards, yesterday's cumulative total is stored in "yesterday.ini". Once you have corrected any rogue maximum or minimum temperature, you can look at the outdoor temperature reported in every row in [[Cumulusmx.db]] since last rollover. For each figure that is below your chosen threshold temperature, add the fraction 1/60 (assuming interval between rows is one minute). The cumulative totals of those fractional increments are added to obtain the figure that should be in today.ini. Unless today is the first day of the month set as first month of season, add on the figure stored in yesterday.ini, to get value to put in today.ini.

==== Edits related to humidity or wind speed ====

Obviously changes to humidity, wind speed, also have an effect on derived temperature extremes mentioned above, but again you have to recalculate as many spot derived values as possible in order to work out the new derived extreme.

====Edits related to rainfall ====

If you want to edit ''rainfall since midnight'' in today.ini, it should be fairly easy to calculate a new value. Remember you also need to manually edit entries in [[Standard_log_files |log file]] and for MX in [[Cumulusmx.db]].

To edit the "rainfall counter" in [[Standard_log_files |log file]] remember that for any decrease in the actual rain, you need to increase the rain counter, and vice versa. It is probably easiest to work backwards through time working out the alteration to the rain counter for the actual rainfall increment, in the period since the preceding entry.

Other derivatives like "maximum hourly rain", "highest rainfall rate", or "highest 24 hour rainfall", all will have to be guessed or recalculated manually, there is no easy way to work these out as past values for the day are not logged anywhere.

==Cross-references for explanations of key parameters==

[[Wind_measurement | Bearing and Direction]],
[[Windrun]];

[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Temp]],
[[Average temperature | Total and Samples]],
[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Humidity]],
[[Heat/cold degree days and Chill hours | Heating degree days]],
[[Heat/cold degree days and Chill hours | Cooling degree days]],
[[Apparent temperature | AppTemp]],
[[Heat index]],
[[wind chill]],
[[Heat/cold degree days and Chill hours | Chill hours]],
[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Dewpoint]];

[[Webtags|Rain]],
[[FAQ#The_longest_dry.2Fwet_spell_for_this_month.2Fyear_includes_days_from_last_month.2Fyear | ConsecutiveRainDays]], [[FAQ#The_longest_dry.2Fwet_spell_for_this_month.2Fyear_includes_days_from_last_month.2Fyear | ConsecutiveDryDays]];

[[Reports folder|NOAA]]

== Changes to this file at particular releases ==

''This section may not be a complete history, and may not be kept up to date; so don't take it as authoritative''

* 3.18.0 build 3189 (pre release 14 June 2022)
** Added '''TempMidnight''' section for tracking of min/max temperature based on day starting at midnight, to complement tracking starting at rollover time
* 3.17.0 build 3184 (released 23 May 2022)
** Some changes to handling of lighning (regarding when no strikes)
* 3.12.0 beta build 3134 (released 29 July 2021)
** Added '''Lightning''' section (lightning distance and last strike time)
* 3.11.0 build 3129 (released on 7 May 2021)
**Fix: End of day backup now always runs at rollover, so like most releases of the legacy software, the stored file represents the true end of day position.
*** For example in the '''[General]''' section, the ''Date'' (calendar date) and ''Timestamp'' attributes will relate to when it was last updated, but the three '''Current'' attributes will relate to the meteorological date just ended.
*** For the today.ini in the backup/daily folder, last update time-stamp will indicate time as at one update cycle before end of day, but file last modified will show that was at end-of-day
** New: Added (to [Temp]) GrowingDegreeDaysThisYear1=, and GrowingDegreeDaysThisYear2=.
* 3.7.0 - build 3089 (released on 28 July 2020)
** Canadian Humidity Index (Humidex) added for highest extreme monitoring in today.ini (and other longer period extreme log files)
* Release 3.6.6 build 3082 (released on 1 June 2020)
** Values in the file had been stored (in all previous builds) using 15 decimal places (because of difficulty in representing decimal parts of numbers in binary), from this release revised so all values stored using 17 significant figures
* Release 3.6.3 - build 3079 (released on 21 May 2020)
** Fix long standing problem with today.ini becoming corrupted when Microsoft Windows is shutdown
* Release 3.6.0 build 3076 (released on 4 May 2020)
** Added '''Feels Like''' section to daily high and low extremes monitored in today.ini (and other longer period extreme log files)
* Release 3.1.0
** Added '''Records''' section, this holds one attribute "Alltime" that holds a datetime stamp recording the most recent update to the [[alltime.ini]] file
*From version 1.9.4 build 1089 to release 3.10.5 build 3122
** The '''today.ini''' stored in the daily backup contains the position as at '''start of day''' (or in specified older MX releases, up to one UPDATE interval later), so it does not contain any information (except Cumulative Chill Hours) that relates to day that has just ended.
*Up to version 1.9.4 build 1088 (released 28 Jan 2014)
**The '''today.ini''' stored in the ''cumulus\backup\daily\FOLDER_NAME'' ((where FOLDER_NAME is based on date and time of creation) represented the end of day (including on last day of month) extremes
*version 1.8.9 (released on 31st March 2010)
**Fix problem with month names (timestamp in today.ini) using ''short date format''
* version 1.8.6 (released on 14th April 2009)
**Don't write today.ini unless station contacted
*version 1.8.5 (released on 12th February 2009)
**Fix wrong times for some of today's extremes
*Not documented
** It is believed that today.ini may have been introduced at version 1.4
*Version 1.0 27th January 2004 First release
**Included internal tracking of daily extremes, and display on main screen, but not storing in a file.

Today.ini

2022-08-05T21:01:40Z

Sfws: /* Restart and Catch-up */ unmatched brackets

[[Category:Ini Files]]

= Introduction to tracking of Daily Extremes/Totals/Averages =

Steve Loft first wrote Cumulus software in 2003, although it was not shared with the public until 27th January 2004. His (no longer available) web site claimed (amongst other reasons) that Cumulus was invented to cope with [[Meteorological_day|tracking high and low for days starting at 9 a.m.]] as (at that time) no other software could do that. Therefore, it can be assumed that even in 2003, Cumulus software was tracking the highest/lowest for all time as well as for each day . (For daily period, there is also tracking of some totals, and in some cases by dividing by number of samples averages can be calculated). This Wiki page covers all aspects of the daily tracking.

The legacy Cumulus 1 software has a '''Recent extremes''' frame on its [[Cumulus_Screenshots#Main_Screen|main screen]]. In release 1.0 (27th January 2004) this only showed extremes for today, but from 1.1 (17th February 2004) it also shows extremes for yesterday. The interface provided with Cumulus MX is also able to show the extremes for today and yesterday (on a single web page).

=Essential reading=

Cumulus 1 has a [[Downloads#Resources|Help file]] that is part of the Cumulus 1 installation package; that provides a simple explanation for each file.

David Jamieson created this Wiki page on 27 August 2009, to cover "today.ini" and "yesterday.ini" files. His introductory text simply stated these files were for tracking extremes in the two days and new files were created at 9am or midnight rollover. David also included a listing of a typical "today.ini" file.

Since the initial creation of the Wiki, it has attempted to become reference documentation that answers questions that arise frequently in the support forum. This does mean its pages have become harder to read, and thus there is now an attempt to split "essential" facts that give a basic understanding (as in following subsections) from "technical" facts (later on this page with more complex instructions on how to cope with problems).

Therefore for a quick read, stop after this essential section or use the page index above to skip quickly to whatever is of interest to you.

== How Cumulus tracks extremes and why two files were introduced ==

Cumulus software handles daily tracking by storing values internally, i.e. within its use of random access memory. As the software processes (the time interval for doing this varies between weather station type and also on exactly which release you are running) data from the weather station, incoming values are compared against internally held values, and when appropriate the values being processed update the internal values.

Cumulus initially made the assumption that it would be left running continuously, so holding values internally enabled them to be shown on that screen. However, subsequently it was realised that Cumulus had to be stopped and restarted to install a new version (and Microsoft's updates system restarts computers as part of its installation process). Information held in RAM is lost when the software is closed.

Apparently when version 1.3 was released (18 January 2005) it did not include "today.ini" nor "yesterday.ini". An attempt to track the history of the "today.ini" file appears [[Changes to this file at particular releases|below]]. Unfortunately, Steve Loft lost some of his notes, and the Cumulus 1 version history in his [[Downloads#Earlier_Versions|changes.txt]] is incomplete. So it is pure guesswork that version 1.4 resolved the problem of losing daily information on closing Cumulus by introducing a '''today.ini'' file to hold the daily extremes and total records.

Steve Loft did document that at rollover, the daily extreme/average records were "transferred" (there are some differences) from "today.ini" to [[yesterday.ini]]. That second file was not vital, but made it easier to display yesterday's extremes on the main screen of the legacy software.

The sub-section below covers end of day actions in more detail, subsequently explaining actions might happen twice a day!

When you close Cumulus, it will write the final values for highs and lows and their timestamps to ''today.ini'' as part of the close down process.

==End of day actions==

End of day actions happen when Cumulus detects that it is processing weather data for the rollover time [either midnight, or 9am (or 10am) depending on your configuration and season], this might be during the processing of archive data while Cumulus is catching up after it has been restarted, or in normal running when those clock times are reached.

Oversimplifying the process a bit, the contents of today.ini, goes to two places:
# yesterday.ini
# a new line appended onto [[dayfile.txt]]

After that a new today.ini is created populated with initial values for each extreme/total entry.

The three files have a few differences in content, so rolling-over does involve a little editing work:
# The multiple lines in the [General] section of today.ini shrink to just one item in yesterday.ini (Date) and one item in dayfile.txt (abbreviated date)
# The 'Total' and 'Samples' values in "today.ini" become the single 'AvgTemp' in "yesterday.ini" and "dayfile.txt"

=== Complexity if you are recording sunshine hours ===

Sunshine hours are recorded starting at midnight, regardless of what rollover time is used.

For MX only, the sunshine hours are partly recorded in [[yesterday.ini]] and partly in today.ini. So even if your rollover is 9 am, there will be an update to both files at midnight which is when the current sunshine hours figure in today.ini is copied to yesterday.ini before the figure in today.ini is reset to zero.

==Where are the files stored?==

The files '''today.ini''' and '''[[yesterday.ini]]''' are located in the [[Data folder|"data" sub-folder]] of the path where your cumulus.exe (or CumulusMX.exe) is installed.

(NOTE: Microsoft Windows Operating Systems, may relocate some files, as explained at [[FAQ#I_can.E2.80.99t_find_my_data_files.21| FAQ on location of data log files]]).

When Cumulus is left running, a daily backup of all the files is created as part of this rollover in a subfolder 'daily' of the [[Backup_folder|backup folder]]. Depending on the release you are running, the files included in the backup may be a snapshot of their content just before rollover, just after rollover, or at the first standard interval after rollover.

== How Cumulus updates the file ==

This depends on which flavour of Cumulus you run. The [[#End of day actions|end of day process]] is same for both flavours, but updates during the day work differently for the legacy software and for MX.

For '''today.ini''', it is important to be aware that MX can read a file created by Cumulus 1 (MX can read the time format in the value for '''Timestamp=''' parameter whether it is in Cumulus 1 or MX format), but Cumulus 1 cannot read a file that has been updated by MX.

Cumulus MX and the legacy software handle the updating of "today.ini" differently, this difference is critical should you want to [[Correcting_Extremes#Correction_of_extremes_for_today|edit out rogue data]].

=== How Cumulus 1 updates the file ===

Steve Loft never shared his souce code, so what follows is just a guess at how the update might work. The frequency at which data is read from a weather station varies depending on the type, but is at least every 30 seconds.

The indications are that Cumulus 1 has an internal one minute timer that triggers the logging of readings (after conversion to units selected) to an internally held [[Recent history|recent history database]] and the comparison of those readings against existing internally held extremes/totals. The file is updated immediently afterwards, each update only changes those lines (within sections) where the extreme/total/count/time has changed, and other lines retain the same content as before the update.

Whilst you are strongly advised not to manually edit the file with Cumulus running, because access to the file cannot be shared, if you are able to complete the edit between one real-time interval and the next, any change you make is retained.

(NOTE: A full set of latest spot readings are logged to a file at a configurable interval that might be every 10 or 30 minutes).

===How MX replaces the file===

Note the subtle difference in this sub-section header. MX does all updates to the today extremes/totals/counts only to internally held values. Although the [[Software#Latest_MX_Source_Code|source code]] is available, you need to be more technical than the person typing this to understand at what frequency these internal updates occur. It is probably every time data is read from the weather station, but might be just when the externally stored [[Recent history|recent history database]] is updated.

Critically, MX only updates the "today.ini" file at the configurable [[Standard log files|Standard interval]] used for logging the spot values (might be every 10 or 30 minutes). Each update is a ''rewrite of the entire file contents'', from the internally (RAM) held values.

You would be wasting your time should you try a manual edit of the file while MX is running, as the next MX update will overwrite any manual changes! Don't be misled by the fact that a sharing violation is less likely to be an issue (because of the longer interval between MX updates).

== Format of the file ==

The files are text files, consisting of many lines. Some lines consist of a single piece of text surrounded by square brackets, these are the section names. The sections (for "today.ini" after the first [General]) can be in any order, Cumulus will maintain whatever order the sections are currently in.

Under each section name, there is a list of parameters <code>attribute=value</code>, with one parameter per line. The attribute names are defined by Cumulus, but can appear in any order:
* Where a time-stamp is stored, note that in "today.ini" only the hour and minute parts of a time are stored.
* Where an extreme/total value is stored, note that it is always post conversion to the units selected by the Cumulus user.
** It was mentioned earlier that the file exists to store values that Cumulus holds in RAM. Internally those numbers are in binary (base 2), but in the file the numbers are expressed to base 10. The value of any integer part of numbers is unchanged between the two bases, but decimal parts in base 2 and base 10 do not convert exactly, therefore in the file you may see some strange looking numbers with lots of decimal places.

The key difference between all [[:Category:Ini_Files]] for the different flavours is the formatting of any time-stamps that include a date:
* [[File:Badge v1.png]] Cumulus 1 used the format specified in Control Panel for your region settings, for UK that would typically be <code>day/month/year (space) hour:minute</code> in today.ini
* Cumulus 2 (withdrawn) worked differently, all date/time stamps were converted to UTC, and stored in ISO 8601 format of <code>yyyy-MM-ddTHH:mm:ss</code>(using the net specifiers that MX uses).
* [[File:Badge vMx.png]] Cumulus MX uses the same format as Cumulus 2, but all date/times are expressed according to date/time read from the computer running MX, so use whatever time-zone you have selected on that device.

Please look at the category page (link above) to read more on formatting differences between the legacy Cumulus and MX.

===Typical Sections within file===

As Cumulus is developed it is adding further sections, but the legacy Cumulus (by 1.9.4) used the following:
* The [General] section stores current date and time.
* The [Wind} section stores the highest wind speed and highest gust, it holds the sum of wind speeds as wind run, and details for the dominant wind.
* The [Temp], or temperature, section stores the highest and lowest temperature, the sum of all temperatures from every sample (Total), and the number of Samples in that total, the Cumulative Chill Hours total (for the season), and the cumulative Heating and Cooling Degree Days for the current day-so-far.
* The [Pressure], [Humidity], [AppTemp] (for apparent temperature), and [Dewpoint] sections just hold Highs and Lows.
* The [WindChill] section only holds lowest, the [HeatIndex] section only has highest.
* The [Rain] section holds a lot of different parameters, including the Start count that derives most rain outputs, and the LastTip date-time.
* Other sections present in 1.9.4 are [ET], [Solar], [NOAA], and [FineOffset]; whether these are updated depends on what sensors you have, and whether you have set up NOAA reports.

MX development has been far more rapid than the legacy software, and there have been a lot of changes to the content of the two files. Unfortunately, the MX release announcements rarely go into enough detail to permit good documentation, so all mentions relating to MX on this page are guesses from examination of the file, and it cannot be guanteed that the information is correct for whatever MX release you may be running!

A typical MX release will include all the 1.9.4 sections, plus:
* The '''[Records]''' section contains one line denoting when extreme records were last revised. For example "Alltime=2020-03-06T06:42:13", indicates when the all-time extreme records was last updated. In the example file, there were various extreme records broken at that time on 6 March (lowest temperature, lowest apparent temperature, and greatest wind chill), but none have been broken since.
* Other sections (depending on MX release) may include [FeelsLike], [Humidex], [Lightning], and [TempMidnight]; whether these are updated depends on what sensors you have.

===Composite Example of 'today.ini' file===

'''Notes in round brackets () are not part of the file, they simply explain elements of the composite.'''

* This is an example made up of composites that may not all be present in an actual file.
* This composite contains time-stamp formats used by Cumulus 1.x.y and Cumulus MX in the few places where they differ.
* Because this example is made up of composites, the times shown are not all consistent, in a real file no time anywhere will be later than the time at the top!
* The order the sections appear in this composite may not match your file; as mentioned above the section order can be edited.

<pre>
[General]
Date=29/09/2009
Timestamp= (format for Cumulus 1 e.g. "29/09/2009 09:50:00"; format for Cumulus MX e.g. "2019-09-29T09:50:00")
CurrentYear=2009
CurrentMonth=9
CurrentDay=13

[Wind]
Speed=10.7008972167969
SpTime=10:09
Gust=22.0114517211914
Time=08:42
Bearing=90
Direction=E
Windrun=63.1526298522949
DominantWindBearing=317
DominantWindBearingMinutes=1041
DominantWindBearingX=-3914.11743164063
DominantWindBearingY=4215.82763671875

[Pressure]
Low=1014.89996337891
LTime=11:13
High=1018.79998779297
HTime=00:06

[Rain]
High=0
HTime=00:00
Start=1923.59997558594
Yesterday=0
LastTip=2009-09-14 10:48
HourlyHigh=0
HHourlyTime=00:00
ConsecutiveRainDays=2
ConsecutiveDryDays=0
RG11Today=20

[ET]
Annual=1148.2578125
Startofday=1147.24182128906

[Temp]
Low=8.30000019073486
LTime=01:16
High=16.8999996185303
HTime=11:41
Total=7500.697265625
Samples=714
ChillHours=3147.15673828125
HeatingDegreeDays=5.34738397598267
CoolingDegreeDays=0.502222061157227

[HeatIndex]
High=16.8999996185303
HTime=11:41

[AppTemp]
Low=5.0417857170105
LTime=01:30
High=15.0359125137329
HTime=11:52

[WindChill]
Low=6.39816427230835
LTime=01:30

[Dewpoint]
Low=5.30104923248291
LTime=00:52
High=10.7219848632813
HTime=11:38

[Humidity]
Low=65
High=88
LTime=11:45
HTime=06:06

[Solar]
SunshineHours=1.08333301544189 (This is Cumulus 1 example)
SunshineHoursToMidnight=5.80002069473267 (This is Cumulus 1 approach)
HighSolarRad=1048
HighSolarRadTime=09:41
HighUV=7.40000009536743
HighUVTime=09:41
SunStart=0

[NOAA]
LatestMonthlyReport=NOAAMOSep2012.txt
LatestYearlyReport=NOAAYR2012.txt

(The above section will look like the one below if NOAA reporting has not been set up)

[NOAA]
LatestMonthlyReport=
LatestYearlyReport=

[FineOffset] (if not using a Fine Offset station, the MX defaults are as shown)
FOSensorClockTime=(the format here is different for Cumulus 1 e.g. "29/09/2009 09:50:00" and Cumulus MX e.g. "0001-01-01T00:00:00")
FOStationClockTime=(the format here is different for Cumulus 1 e.g. "29/09/2009 09:50:00" and Cumulus MX e.g. "0001-01-01T00:00:00")
FOSolarClockTime=0001-01-01T00:00:00 (this parameter only appears in later MX releases, the time shown is the default if no solar sensor)
</pre>

 
<hr>
 

=Non-essential more technical information=

You can skip the following subsections unless you have a particular need to read them.

== First use of Cumulus ==

When you use Cumulus software for the very first time, it records a start date, and assumes you have no data anywhere for earlier than that start time.

Some weather station types have an internal logger that can be accessed for historic data. It is theoretically possible, but not recommended, to read in that historic data, so it is included in your Cumulus extreme tracking. The minimum content for "today.ini" is the "[General]" section. If you stop Cumulus, manually edit "today.ini" to remove all other sections, and then restart Cumulus, then the software will attempt to read that historic data. Please read [[FAQ#I.E2.80.99ve_just_installed_Cumulus.2C_and_it_didn.E2.80.99t_download_all_the_old_data_from_my_weather_station | FAQ here]] for full guidance. Remember this only applies when you are first starting use of Cumulus with a weather station.

== Restart and Catch-up ==

If you restart Cumulus during the day it will read the ''today.ini'' file at startup, so it can resume tracking extremes of the key parameters starting from latest stored values in today.ini. If your weather station type permits, a restart of Cumulus can go into a catch-up mode during which it reads any historic data from the weather station, for the period while Cumulus was not running, before starting the reading of the current data.

During that catch-up of historic data, internally held daily extremes, and the "today.ini" file, will be updated with revised highs and lows as Cumulus processes the historic data from the station's memory; and if necessary Cumulus will do a roll-over (see [[#End of day actions]]) as it processes the readings for the relevant time.

On restart Cumulus writes a backup of today.ini (and some of the other Cumulus files) into the [[Backup_folder|backup folder]] found below the folder with the cumulus.exe (or CumulusMX.exe). With Cumulus stopped, you can copy the today.ini file in either a restart backup, or a daily backup (see [[#Where are the files stored?]]), also copying the other files in that backup folder into their original folders (mostly [[data_folder|data sub-folder]]) overwriting the files in those destinations. When you restart Cumulus, the tracking will begin again as if the time has been rewound back to the date those copied files were last updated. This rewinding works best if historic data can be read from your weather station. One example of when this might be useful is if you spot a rogue value very soon after it has been recorded, the rewinding often brings in correct data for the recent period. Another example is if your computer on rebooting initially shows the wrong time and so Cumulus records some data against that wrong time; a rewind can eliminate the wrongly timed records and replace them with records timed correctly.

You are strongly advised not to stop/restart Cumulus close to either midnight or your rollover time. Steve Loft defines "close" in this context as within whatever time you have set as interval between logging of spot values (e.g. 10 or 30 minutes). The potential problems were significantly worse for earlier versions of Cumulus 1, but restart problems have been reduced in newer builds of C1. In general, MX is more tolerant over restart timings, but the way its code works you will encounter more problems with accuracy of output if MX is stopped for more than the few minutes needed for an upgrade (or computer reboot).

== Editing rainfall in today.ini within Cumulus ==

This sub-section applies to Cumulus 1 and Cumulus MX.

At the time of writing, no Cumulus release contains an editor for today's daily extreme records as stored in "today.ini". There is just one exception, both flavours do contain an editor for 'Today's rain'.

Cumulus internally stores a "start of day rain counter". This is copied into "today.ini" into the ''Start='' line within the '[rain]' section. Subtracting that from the current rain counter value allows Cumulus to calculate (in your chosen units) the toatl rainfall for today. The provided editor changes the internal "start of day rain counter" so that the current rainfall total becomes what you enter into the editor.

It is important to note:
* The rainfall counter was invented in Cumulus 1 as a way that could calculate rain when the software was made to serve multiple weather station types
* The counter is based on a piece of data that can be read from a particular weather station type, it might be based on an all-time total rainfall, or based on a rainfall this year figure
* The counter is not intended to be of any interest to the Cumulus user
* Any increase in the rainfall counter is treated as representing valid rain (spike removal functionality exists only for rain rate and rain in last hour, not the total rain)
* Cumulus has special code to detect if the counter value decreases, without going into the complexity, Cumulus will normally reset its internal start of day counter based on the decrease in the number received.
* The "Today's rain" editor does not affect any derived rainfall output;
** The following in "today.ini" are not affected:
*** last tip time-stamp ("LastTip=")
*** highest rainfall rate so far today and time-stamp ("High=" and "HTime=")
*** hourly high amount and time-stamp ("HourlyHigh=" and "HHourlyTime=")
*** Highest 24 hour amount
** Outside "today.ini" it does not affect any recent records nor monthly, yearly, monthly-all-time, or all-time extremes:
*** The recent history entries whether held internally (Cumulus 1), or for MX in [[Cumulusmx.db]], are not amended so any tags used for web page data, local API, custom SQL, MQTT, HTTP (see [[Webtags/Parameters#Cumulus_MX_software|this Wiki section]]) will report incorrect values
*** Total Rainfall this month, rainfall this year/season will only be recalculated if Cumulus is stopped and restarted after the edit
*** Highest rainfall rate, highest hourly rainfall, highest 24-hour rainfall, highest daily rainfall; applying to these longer periods are not changed unles each extreme record is individually manually edited (Cumulus provides an editor for most of these, but cannot generally suggest what new value to use).
*** The consecutive wet/dry days ("ConsecutiveRainDays=" and "ConsecutiveDryDays=") in this month/year - remember these counts are to last roll-over, they exclude today
** The editor does not alter any lines already logged in [[Standard_log_files |log file]] for the current month. This means you will see distorted graphs attempting to portray rainfall within a day
** The editor does not update any database records that may be affected by the change of the rainfall total

== Dealing with rogue values ==

The "today.ini" file is written to throughout the current day, as described [[#How Cumulus updates the file|earlier]]. As mentioned above, Cumulus only provides extremely restricted ability to edit "Today's rain", not any other extreme/total that is stored in the "today.ini" file.

If your weather station reports a rogue value, an incorrect update to a High, Low, or Total, may get stored in this file. At end of day, it will then be stored in [[dayfile.txt]]. Cumulus developer advice is that instead of manually editing "today.ini", you should wait until the day has been stored in "dayfile.txt" and then use the editor for that log file to make the desired changes.

The rogue value may also affect extreme records held for this month, this year, monthly-all-time, and/or all-time. Cumulus does provide editing functionality for most (not all) entries in the files holding thgose extreme records and you can read instructions on [[Correcting Extremes]] Wiki page. Here it is sufficient to say it is worth looking in the diagnostics, to see if you can spot when the problem occurred, because that helps you work out what may be affected:
* [[File:Badge vMx.png]] [[MXdiags folder]]
* [[File:Badge v1.png]] [[Diags_folder]]

=== Manual editing of "today.ini" ===

The developer advice to wait until next day has a flaw that every process that happens in the meantime sees wrong data, and that might include sending data to several external sites and a number of extra custom processes you might have in your system.

Therefore this Wiki page will now give some advice on how to manually edit the file:
# You must stop Cumulus (please see earlier in this page for details as reason depends on flavour you are running)
# Take a back-up of existing file, or rename it (if you decide it easiest to create a new file rather than edit the existing one)
# Any plain text file editor can be used (that includes coding editors like Geany, Notepad++, NoteTab, and many others)
# Be careful to ensure any change maintains existing format (integer, decimal,time, date/time, text) paying attention to any punctuation (including decimal commas or decimal points, direction type of any slashes)
# For readability you can insert blank lines into files '''today.ini''' and '''yesterday.ini''', Cumulus will not mind.
# It is up to you to work out what new value/time to type, Cumulus won't accept nulls, but there are some "initial values/dates" that it will accept (I won't tell you these here, because they depend on release you are running and you should not be editing this file unless you have enough technical understanding to work out what Cumulus will accept)
# Remember changing extremes for [[Calculate_Missing_Values#Some_definitions|source value extremes and derived extremes]] is complicated:
#* Please see specific advice in sub-sections below

==== Edits related to pressure ====

Should be straight forward, the maximum/minimum can be edited without this affecting anything else. You should be able to look in either [[Standard_log_files |log file]] or for MX in [[Cumulusmx.db]] for pressure readings earlier or later in the day to find the new extreme value/time to replace the rogue pressure value and time.

==== Edits relating to Temperature ====

#If you change a temperature source extreme (i.e. highest/lowest temperature) you should also be taking the old value out of 'Total' line and decreasing by one the'Samples' count
# You cannot work out from any change in a temperature source extreme (i.e.. highest/lowest temperature) how to change the related derived extremes (e.g. wind chill, apparent temperature, feels like, dew point). Each derived value is worked out by combining spot values at a particular time, so you have to recalculate as many spot derived values as possible in order to work out the new derived extreme.

==== Editing Chill Hours====

Prior to release 3.12.0, the web template "thisyearT.htm" included a single cumulative figure for [[Heat/cold_degree_days_and_Chill_hours#Calculation_of_Chill_Hours|seasonal chill hours]], and that figure was taken from the chill hours figure stored in "today.ini". A lot of processing was needed to calculate this figure so, in these earlier releases, it was unusual for anyone to correct any rogue figure.

From release 3.12.0 onwards, yesterday's cumulative total is stored in "yesterday.ini". Once you have corrected any rogue maximum or minimum temperature, you can look at the outdoor temperature reported in every row in [[Cumulusmx.db]] since last rollover. For each figure that is below your chosen threshold temperature, add the fraction 1/60 (assuming interval between rows is one minute). The cumulative totals of those fractional increments are added to obtain the figure that should be in today.ini. Unless today is the first day of the month set as first month of season, add on the figure stored in yesterday.ini, to get value to put in today.ini.

==== Edits related to humidity or wind speed ====

Obviously changes to humidity, wind speed, also have an effect on derived temperature extremes mentioned above, but again you have to recalculate as many spot derived values as possible in order to work out the new derived extreme.

====Edits related to rainfall ====

If you want to edit ''rainfall since midnight'' in today.ini, it should be fairly easy to calculate a new value. Remember you also need to manually edit entries in [[Standard_log_files |log file]] and for MX in [[Cumulusmx.db]].

To edit the "rainfall counter" in [[Standard_log_files |log file]] remember that for any decrease in the actual rain, you need to increase the rain counter, and vice versa. It is probably easiest to work backwards through time working out the alteration to the rain counter for the actual rainfall increment, in the period since the preceding entry.

Other derivatives like "maximum hourly rain", "highest rainfall rate", or "highest 24 hour rainfall", all will have to be guessed or recalculated manually, there is no easy way to work these out as past values for the day are not logged anywhere.

==Cross-references for explanations of key parameters==

[[Wind_measurement | Bearing and Direction]],
[[Windrun]];

[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Temp]],
[[Average temperature | Total and Samples]],
[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Humidity]],
[[Heat/cold degree days and Chill hours | Heating degree days]],
[[Heat/cold degree days and Chill hours | Cooling degree days]],
[[Apparent temperature | AppTemp]],
[[Heat index]],
[[wind chill]],
[[Heat/cold degree days and Chill hours | Chill hours]],
[[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | Dewpoint]];

[[Webtags|Rain]],
[[FAQ#The_longest_dry.2Fwet_spell_for_this_month.2Fyear_includes_days_from_last_month.2Fyear | ConsecutiveRainDays]], [[FAQ#The_longest_dry.2Fwet_spell_for_this_month.2Fyear_includes_days_from_last_month.2Fyear | ConsecutiveDryDays]];

[[Reports folder|NOAA]]

== Changes to this file at particular releases ==

''This section may not be a complete history, and may not be kept up to date; so don't take it as authoritative''

* 3.18.0 build 3189 (pre release 14 June 2022)
** Added '''TempMidnight''' section for tracking of min/max temperature based on day starting at midnight, to complement tracking starting at rollover time
* 3.17.0 build 3184 (released 23 May 2022)
** Some changes to handling of lighning (regarding when no strikes)
* 3.12.0 beta build 3134 (released 29 July 2021)
** Added '''Lightning''' section (lightning distance and last strike time)
* 3.11.0 build 3129 (released on 7 May 2021)
**Fix: End of day backup now always runs at rollover, so like most releases of the legacy software, the stored file represents the true end of day position.
*** For example in the '''[General]''' section, the ''Date'' (calendar date) and ''Timestamp'' attributes will relate to when it was last updated, but the three '''Current'' attributes will relate to the meteorological date just ended.
*** For the today.ini in the backup/daily folder, last update time-stamp will indicate time as at one update cycle before end of day, but file last modified will show that was at end-of-day
** New: Added (to [Temp]) GrowingDegreeDaysThisYear1=, and GrowingDegreeDaysThisYear2=.
* 3.7.0 - build 3089 (released on 28 July 2020)
** Canadian Humidity Index (Humidex) added for highest extreme monitoring in today.ini (and other longer period extreme log files)
* Release 3.6.6 build 3082 (released on 1 June 2020)
** Values in the file had been stored (in all previous builds) using 15 decimal places (because of difficulty in representing decimal parts of numbers in binary), from this release revised so all values stored using 17 significant figures
* Release 3.6.3 - build 3079 (released on 21 May 2020)
** Fix long standing problem with today.ini becoming corrupted when Microsoft Windows is shutdown
* Release 3.6.0 build 3076 (released on 4 May 2020)
** Added '''Feels Like''' section to daily high and low extremes monitored in today.ini (and other longer period extreme log files)
* Release 3.1.0
** Added '''Records''' section, this holds one attribute "Alltime" that holds a datetime stamp recording the most recent update to the [[alltime.ini]] file
*From version 1.9.4 build 1089 to release 3.10.5 build 3122
** The '''today.ini''' stored in the daily backup contains the position as at '''start of day''' (or in specified older MX releases, up to one UPDATE interval later), so it does not contain any information (except Cumulative Chill Hours) that relates to day that has just ended.
*Up to version 1.9.4 build 1088 (released 28 Jan 2014)
**The '''today.ini''' stored in the ''cumulus\backup\daily\FOLDER_NAME'' ((where FOLDER_NAME is based on date and time of creation) represented the end of day (including on last day of month) extremes
*version 1.8.9 (released on 31st March 2010)
**Fix problem with month names (timestamp in today.ini) using ''short date format''
* version 1.8.6 (released on 14th April 2009)
**Don't write today.ini unless station contacted
*version 1.8.5 (released on 12th February 2009)
**Fix wrong times for some of today's extremes
*Not documented
** It is believed that today.ini may have been introduced at version 1.4
*Version 1.0 27th January 2004 First release
**Included internal tracking of daily extremes, and display on main screen, but not storing in a file.