Cumulus MX formal release versions

From Cumulus Wiki

Introduction

Lists all MX releases since Mark Crossley brought MX out of the beta development (that Steve Loft left to the Community when as part of his retirement he gave up involvement in Cumulus). It is intended to be used for reference, e.g. if you wonder when such and such a feature was introduced, this article is a quick way to check. This article is NOT a comprehensive guide to what you need to do when upgrading.

This article is updated independently of release announcements in the forum, so may not always be in step.

It excludes the first few releases (within Version 3.0.0) that Mark did when he was experimenting with updating the code with both fixes and new features; and starts when he said it was the first non-beta version.

Information included in this article

The tables below include

  • version number,
  • date of release,
  • build number,
  • summarises of both fixes and new features,
  • plus indicates of which files have been updated or added. Please note that as "Updates.txt" is updated in every release it does not normally appear in any list below of files that have been updated in an individual release. If you are only copying updated files then always copy in this file, as well as any listed.

Instructions

This page is a precis of the information contained in the support forum at Cumulus MX Announcements and Download - PLEASE READ FIRST

As that topic name suggests you should read it before you upgrade to a new release. If you are intending to upgrade to any new release, please read all of the release notes since the build you are currently running.

If you only want to update those files that have changed since the release you are currently using

Best practice is to copy all files included in the release zip irrespective of whether they have changed or not, but this could mean a lot of extra transfers you want to avoid.

The problem is that changes may be made to the source at various times, and the developer my not recall all changes made when a new release is made, especially if it is rushed out to fix a bug. Since the developer updates different files at different times, in-between releases, even the tracking facilities of Git Hub can make it hard to keep track of all files changed. Don't forget the developer is updating Cumulus MX in his spare time, he has a life outside MX.

It is always worth checking the date modified for every file in any release, to ensure you include all updated files, not just those the developer remembered to include in the list of changed files that appears in each announcement.

At the time I typed this, there were 261 files spread through 57 folders in each release zip. It is possible as you read this, that file count has been increased due to extra functionality!


Finding Downloads

All releases can be downloaded on this page, the latest release can always be directly downloaded directly from link at MX Current_Release. Don't forget neither download page will tell you what has changed since previous releases, nor does either page tell you any actions you must take if upgrading from a previous release.

There are currently 8 forks off from Cumulus MX on the githum.com, with other developers experimenting with Cumulus MX in different ways. Only the Mark Crossley releases are listed below.

Revision Date

The recent surge in the number of releases is hard to keep up with, so do check in case there is yet another build listed in the support forum, but not yet added below. Normally, before details of a release are added to this page a check is made that the formal release announcement does cover all changes made since previous release, to ensure the entry here is correct.

Latest Update to this page: 9 July 2020 (reporting build 3087)

Version 3.6.x

Version Build Fixes Additions Files affected
3.6.12 (10 July 2020) 3088 Fix Davis stations not downloading historic logger data (broken in b3087) Updates.txt, CumulusMX.exe
3.6.11 (8 July 2020) 3087 Davis TCP logger connections not timing out occasionally; duplicating Humidity heading on interface Now page; remove units from Humidex; FTP log file handling in Extra Files, with EOD option on the first of the month;Improve web tag token parser performance; Cumulus (Zambretti) forecast now works with localised compass points; Internal optimisations (watch out for new issues!); Extra Sensors log file added to the backup routine; previous months log files (monthly and extra) to the backup on the first of the month Feels Like added to the default web site trends temperature graph; "<currentextralogfile>" tag available in Extra Web Files to specify the variable extra log file name - it works the same as the existing "<currentlogfile>" tag; Uplift the SFTP component from a 2016 version to new beta version - supports more encryption methods and key file formats; Further additions to shutdown code for all stations; Adds new web tag <#RecentFeelsLike> \CumulusMX.exe; \Renchi.SshNet.dll; \interface\now.html; \webfiles\js\cumuluscharts.js
3.6.10 (24 June 2020) 3086 Davis WLL wind values when using units other than mph; poor performance of wind direction charts on the MX interface and base web site Make end of day SQL inserts asynchronous; Use a fixed timestamp for all EOD operations, Changed Saturated Vapour pressure formula again used for feels like (replaced formula introduced at version 3.6.8 build 3084) \CumulusMX.exe, \interface\charts.html, \interface\js\charts.js, \web\trendsT.htm, \webfiles\cumuluscharts.js
3.6.9 (withdrawn) 3085 Davis WLL wind values when using units other than mph; poor performance of wind direction charts on the MX interface and base web site Make end of day SQL inserts asynchronous; Use a fixed timestamp for all EOD operations \CumulusMX.exe, \interface\charts.html, \interface\js\charts.js, \web\trendsT.htm, \webfiles\cumuluscharts.js
3.6.8 (18 Jun 2020) 3084 Simplify realtime SFTP error detection and recovery; Change the default web site Gauges page to not show pop-up graphs by default; Fix for Ecowitt GW1000 stations when sensors go offline/online (wind and rain values); Fix for GW1000 stations wind gust values when using units other than "mph"; Fix for GW1000 stations with WH34 type sensors and firmware 1.6.0 or later. You *must* now use firmware 1.6.0+ with WH34 devices; Fix crash when creating the graph JSON files when file in use by FTP; Fix for rc=y parameter not working with the <#intemp> web tag; Fix low contrast menus on admin interface; Fix HighCharts theme on admin interface Charts page, and default web site Trends page;Fix for web tags <#daylength> and <#daylightlength> to display "24:00" if they last all day (they still allow custom formats) Changed Saturated Vapour pressure formula, and apparent temperature formula used for feels like (previous formula introduced at version 3.5.4 build 3075) \CumulusmX.exe, \interface\charts.html, \web\trendsT.htm, \webfiles\lib\steelseries\scripts\gauges.js
3.6.7 (8 Jun 2020) 3083 Add catches for real time MySQL updates and all real time file failures Adds Station (Absolute) and Altimeter pressure values for Davis WLL stations Updates.txt, CumulusMX.exe
3.6.6 (1 Jun 2020) 3082 real time SFTP reconnection on failure problems in b3081; Change ini files to use 17 significant figures for decimal values (up from 15); Davis WLL health data decoding when the WLL is LAN attached; minor edit to log file editors - changing "Cancel" back to "Close" No new features Updates.txt, CumulusMX.exe, \interface\js\datalogs.js, \interface\js\extradatalogs.js, \interface\js\dayfileeditor.js
3.6.5 (28 May 2020) 3081 real time FTP timeout/recovery issues encountered in b3080 re realtime.txt; sun rise/set and dawn/dusk calculations when there is one event but not the other in a single day No new features Updates.txt, CumulusMX.exe
3.6.4 (26 May 2020) 3080 Ctrl-C not being handled when running under Linux/mono. Now handles SIGTERM and console Ctrl-C; realtime FTP getting stuck on "already in progress" Adds support for Ecowitt GW1000 WH34 8 channel "User" (soil and water) temperature sensors; New web tags <#UserTemp1> - <#UserTemp8>; ExtraLog file has eight new fields appended - UserTemp1-8 Updates.txt, CumulusMX.exe, \Extrafileheader.txt, \SampleStrings.ini, \interface\extra.html, \interface\js\extradatalogs.js, \interface\js\extrasensors.js
3.6.3 (21 May 2020) 3079 Reverts to b3076 FluentFTP; long standing random Cumulus.ini/today.ini corruption when shutting down on Windows; Oregon WMR928 extra temperature only sensors No new features Updates.txt, CumulusMX.exe, FluentFTP.dll
3.6.2 (19 May 2020) 3078 Removes the double line feed introduced in last release for realtime.txt No new features Updates.txt, CumulusMX.exe
3.6.1 (18 May 2020) 3077 yesterdays Feels Like values in Admin interface Today/Yesterday screen; Changes GW1000 default Lightning distance to 999 (all user units), and time to 1900-01-01 00:00:00; fix for incorrectly positioned degree unit for bearing in Current data screen; Changes the wording from the "Close", "Edit" buttons on the file editor dialogs into the more meaningful "Cancel" and "Save" respectively. Adds Feels Like to realtime.txt file as field 59 PLEASE NOTE THERE IS A BUG IN realtime.txt GENERATION; Adds a new web tag <#LastRainTip>, which unlike existing <#LastRainTipISO> will accept a date/time format string Updates.txt, CumulusMX.exe, FluentFTP.dll, \interface\now.html, \interface\js\datalogs.js, \interface\js\dayfileeditor.js, \interface\js\extradatalogs.js
3.6.0 (4 May 2020) 3076 Allow records editors to read log files from Cumulus 1 versions; correct spelling error on record editors; Ecowitt GW-1000 devices can bypass the auto-discovery mechanism if it is disabled in the config
   NOAA reports now include degree, minutes, seconds symbols, AvgTempToday changed from double to string, 
Slightly enhanced program termination logging, Implements highs/low/records for Feels like, Changes to ini files to add Feels Like - Adds [FeelsLike] section to today.ini, yesterday.ini, month.ini, year.ini, alltime.ini, monthlyalltime.ini; Changes to log files monthlog.txt - adds field 27, feels like; dayfile.txt - adds fields 47-50, high feels like, high time, low, low time;

Changes to the MYSQL database tables are required: Adds column FeelsLike to the Monthly table: Adds columns MaxFeelsLike, TMaxFeelsLike, MinFeelsLike, TMinFeelsLike to the Dayfile table

New web tags: <#HighFeelsLikeRecordSet>, <#LowFeelsLikeRecordSet>, <#ByMonthFeelsLikeHT>, <#ByMonthFeelsLikeLT>, <#ByMonthFeelsLikeL>, <#ByMonthFeelsLikeH>, <#YearFeelsLikeHD>, <#YearFeelsLikeLD>, <#YearFeelsLikeHT>, <#YearFeelsLikeLT>, <#YearFeelsLikeH>, <#YearFeelsLikeL>, <#MonthFeelsLikeHD>, <#MonthFeelsLikeLD>, <#MonthFeelsLikeHT>, <#MonthFeelsLikeLT>, <#MonthFeelsLikeH>, <#MonthFeelsLikeL>, <#feelslikeH>, <#TfeelslikeH>, <#feelslikeL>, <#TfeelslikeL>, <#feelslikeYH>, <#TfeelslikeYH>, <#feelslikeYL>, <#TfeelslikeYL>, <#feelslikeTH>, <#TfeelslikeTH>, <#feelslikeTL>, <#TfeelslikeTL>

The following web tags have been updated to accept a "tx=n" parameter, where n=1-8 and equals the desired transmitter id. Omitting the tx= parameter or using tx=0 makes the tag function as before for Davis VP2 systems. <#DavisTotalPacketsMissed tx=n>, <#DavisNumberOfResynchs tx=n>, <#DavisMaxInARow tx=n>, <#DavisNumCRCerrors tx=n> New web tags for WLL transmitter reception percentage and RSSI figure, these must be used with the tx=n parameter <#DavisReceptionPercent tx=n> - defaults to tx=1, tx=0 is unused; <#DavisTxRssi tx=n> - defaults to tx=1, use tx=0 to get the WLL WiFi RSSI

Updated record editors; Updated log file viewers/editors; Adds battery and reception data for Davis WLL. It now logs battery and input voltages to the MXdiags. These are updated every 15 minutes and require you to have a WeatherLink Pro subscription.

The WLL unlike the VP2 console provides individual data for each transmitter

Updated ExportMySQL.exe to version 1.1.0 - Incorporates the new Feels Like data; Uses compass point "-" for Calm; Reads customised compass points from strings.ini if set


\CumulusMX.exe; \dayfileheader.txt; \ExportMySQL.exe; \Extrafileheader.txt; \monthlyfileheader.txt; \interface\alltimerecseditor.html; \interface\extrawebfiles.html; \interface\index.html; \interface\monthlyrecseditor.html; \interface\now.html; \interface\thismonthrecseditor.html; \interface\thisyearrecseditor.html; \interface\todayest.html; \interface\js\alltimerecseditor.js; \interface\js\charts.js; \interface\js\datalogs.js; \interface\js\dayfileeditor.js; \interface\js\monthlyrecseditor.js; \interface\js\thismonthrecseditor.js; \interface\js\thisyearrecseditor.js; \interface\json\StationOptions.json

Version 3.5.x

Version Build Fixes Additions Files affected
3.5.4 (25 Apr 2020) 3075 bearing zero on the user interface "Now" page, user interface charts popup, "normal" Extra files, Moon Phase messages All web tags that produce decimal number output now support the "rc=y" option; Additional Davis WLL health info dumped in the MXdiags log on start-up and every 10 minutes if debug logging is on (voltages, uptimes, WiFi RSSI etc); Logs warnings to the command line console and log file if voltages are too low; Adds BatteryLow Alarm for WLL (Console [if you have an API key] & Tx), VP2 (Console & Tx), GW1000 (Tx), and adds a new web tag <#BatteryLowAlarm>; Adds new web tag <#feelslike> - calculated using the JAG/TI formula (that extended earlier wind chill definitions), it is regularly used in the UK, Iceland, USA, Canada, and some other countries. \CumulusMX.exe, \interface\alarmsettings.html, \interface\alltimerecseditor.html, \interface\index.html, \interface\now.html, \interface\todayest.html, \interface\js\alarmsettings.js, \interface\js\charts.js, \interface\js\dashboard.js, \interface\js\now.js, \mqtt\DataUpdateTemplate.txt, \mqtt\IntervalUpdate.txt, \webfiles\js\cumuluscharts.js
3.5.3 (14 Apr 2020 again) 3074 Backs out changes that created bad file paths in b3073 \CumulusMX.exe, \web\webfiles\lib\steelseries\scripts\gauges.js
3.5.2 (14 Apr 2020) 3073 Improvements to MQTT processing setting for MQTT to force IPv4/IPv6 connectivity, Sensor Contact lost flag/alarm for Davis WLL devices, GW1000 raw Lux value is now available via the <#Light> weg tag, three new web tags...
  • <#timeJavaScript> - returns the current date/time in JavaScript milliseconds. Example use = "var dt = Date(<#timeJavaScript>)"
  • <#directionTM> - returns todays max wind gust direction as a compass point
  • <#directionYM> - returns yesterdays max wind gust direction as a compass point
\CumulusMX.exe, \MQTTnet.dll, \web\webfiles\lib\steelseries\scripts\gauges.js
3.5.1 (10 Apr 2020) 3072 "Stop second instance" of Cumulus running now made optional; indexT.htm had missing quotation mark in moon image reference Implements the "record set" web tags. These will be set from the time of the record until a timeout value (default 24 hours); New Cumulus.ini file settings \CumulusMX.exe, \web\indexT.htm
3.5.0 (9 Apr 2020) 3071 "Stop second instance" of Cumulus running made mandatory; hung update interval (S)FTP sessions getting hung; <#moonage> web tag support for MQTT output; Tidy up of /interface folder to remove unused files; Removal of Highcharts scripts from the distribution; support for generating a Moon Phase image; New Cumulus.ini file settings New Files: \Licences-Additional.txt, \MQTTnet.dll, \mqtt\DataUpdateTemplate.txt, \mqtt\IntervalTemplate.txt,\web\MoonBaseImage.png

Updated files: \CumulusMX.exe, \FluentFTP.dll, \Newtonsoft.Json.dll, \interface\ - [Many changes, delete and replace], \web\indexT.htm, \webfiles\js\cumuluscharts.js

Version 3.4.x

Version Build Fixes Additions Files affected
3.4.6 (23 Mar 2020) 3070 station wind chill on Davis WLL devices, auto-discovered Davis WLL Station-Ids not being saved to the config file More robust failure handling for realtime FTP connections, Additional diagnostics output in the console and log file for badly formed web tags \CumulusMX.exe only
3.4.5 (13 Mar 2020) 3069 web tags <#MoonPercent> and <#MoonPercentAbs> Adds Editors for: Dayfile, Monthly Logs, Extra Logs;

Widens the time windows for the Moons phase names

\CumulusMX.exe and most files in \interface\....
3.4.4 (8 Mar 2020) 3068 NOAA yearly report, re annual averages for temperature and wind detects invalid CumulusMX.exe command line parameters

Adds a new command line parameter -debug

\CumulusMX.exe only
3.4.3 (6 Mar 2020) 3067 Cumulus.ini: a station configuration screen option: disable the entry/update of the stations IP address via auto-discovery (ZeroConfig) \CumulusMX.exe, \interface\json\StationOptions.json, \interface\json\StationSchema.json
3.4.2 (5 Mar 2020) 3066 Improved error handing for invalid Davis WLL Station Ids; Improved error handling when the network connection to a Davis WLL is lost (and restored) Data Stopped alarm to the Dashboard and Alarm Settings screens; DataStopped handling to Ecowitt GW1000 devices; auto detect a GW1000's IP address on startup \CumulusMX.exe, \interface\alarmsettings.html, \interface\index.html, \interface\js\alarmsettings.js, \interface\js\dashboard.js
3.4.1 (27 Feb 2020) 3065 WLL if you change the WL.com logging interval around a catch-up period, gust values from WLL devices WLL broadcast data watchdog and warning, implements DataStopped flag

Cumulus.ini: readonly setting, AutoUpdateIpAddress

\CumulusMX.exe
3.4.0 (19 Feb 2020) 3064 Monthly Records editor for dry/wet periods; Beaufort calculations; Davis VP2 and WLL; FTPS on realtime FTP updates Cumulus.ini: DisableFtpsExplicit; use WL.com as a "logger" option; <#MoonAge>;FTP Now does a full update interval process (not just FTP files); console checks (if online link up) if newer MX version available \CumulusMX.exe, \interface\json\StationOptions.json, \interface\json\StationSchema.json

Version 3.3.0

Build Fixes Additions Files affected
3063 (10 Jan 2020) Ecowitt Soil Temperature/Moisture/Leaf detector channel numbering; today's rainfall during CMX start-up; GW1000 Lightning data decode; date on <#Snow*> web tags; and if Cumulus.ini inherited from Cumulus 1 generated files:

Changes the [FTP Site] section name to [FTP site] Changes NOAA default monthly name if it reads "NOAAMO'mmyy'.txt" (MX believes "mm" means minutes, not month) into "NOAAMO'MMyy'.txt (which works on both Cumulus 1 and MX)

diagnostic logging info for Lacrosse WS2300 stations \Renci.SshNet.dll (new), \CumulusMX.exe, \FluentFTP.dll, \interface\json\InternetOptions.json, \interface\json\InternetSchema.json

Version 3.2.x

Version Build Fixes Additions Files affected
3.2.6 3062 (28 Dec 2019) monthly records editor for stations with a met day starting at 9am range checks for latitude and longitude values \CumulusMX.exe
3.2.5 (15 Dec 2019) 3061 MonthlyAlltimeLog.txt, missing WLL station description This Month and This Year records editors, FTP Now option \CumulusMX.exe
3.2.4 (10 Dec 2019) 3060 uncaught Web exceptions in Davis WLL, Monthly Records editor log file '\CumulusMX\data\monthlyalltimelog.txt' for 'MonthlyAlltime.ini' file changes \CumulusMX.exe
3.2.3 (4 Dec 2019) 3059 Monthly Records editor Cumulus.ini file automatically backed up each day/program start \CumulusMX.exe, \interface\alltimerecseditor.html, \interface\monthlyrecseditor.html, \interface\js\alltimerecseditor.js, \interface\js\monthlyrecseditor.js
3.2.2 (3 Dec 2019) 3058 default website pages header not wrapping on small screens, All Time Records editor Monthly Records editor Updated files: \CumulusMX.exe, \interface\<allfiles>.html, \web\<allfiles>T.htm

New files: \interface\monthlyrecseditor.html, \interface\js\monthlyrecseditor.js

3.2.1 (29 Nov 2109) 3057 WMR200 stations writing a zero value Apparent Temperature, Dashboard for IE browser,default website index page header not wrapping on small screens, Davis stations connected via TCP/IP to detect failures Solar calibration settings offset and multiplier \CumulusMX.exe
3.2.0 (19 Nov 2019) 3056 All Time Records editor, missing Cumulus multipliers, to catch badly formed Davis WLL broadcast messages, cases producing an initial zero value wind chill on startup support for Ecowitt GW1000 WiFi gateway, lots of new web tags, new Cumulus.ini file setting [Offsets] PressMult = 1.0 (default) Updated files: \CumulusMX.exe, \interface\json\StationOptions.json, \interface\json\StationSchema.json, \interface\<AllFiles>.html, \interface\js\extrasensors.js, \interface\js\alltimerecseditor.js, \interface\js\dashboard.js, \interface\css\main.css, \interface\json\CalibrationSchema.json

New files: \interface\alarmsettings.html, \interface\js\alarmsettings.js, \interface\sounds\alarm.mp3

Version 3.1.x

Version Build Fixes Additions Files affected
3.1.2 (4 Nov 2019) 3055 All Time Records editor \CumulusMX.exe
3.1.1 (1 Nov 2019) 3054 Davis WLL timestamps always being in UTC, now uses local time 0 responses; new editors for 'current conditions' and 'all-time records' Updated files: \CumulusMX.exe, \interface\<allexistingfiles>.html

New files: \interface\currentcondeditor.html, \interface\alltimerecseditor.html, \interface\js\alltimerecseditor.js, \interface\lib\x-editable\bootstrap-editable.css, \interface\lib\x-editable\bootstrap-editable.min.js, \interface\img\loading.gif

3.1.0 (25 Oct 2019) 3053 Mono 5.x generating short month names ending with "." as used for log file names, removes that dot support for Davis WeatherLink Live devices, Cumulus.ini file setting 'EWpressureoffset' for Fine Offset stations, display and generation of NOAA Monthly and Yearly reports Updated files: \CumulusMX.exe, \CumulusMX.exe.config, \interface\<allfiles>.html, \interface\json\StationOptions.json, \interface\json\StationSchema.json

New files: \Tmds.MDns.dll

Version 3.0.2 (13 Sep 2019)

Build Fixes Additions Files affected
3052 Davis archive downloads from the the logger when the day rollover processing takes longer than 10 seconds \CumulusMX.exe, \CumulusMX.exe.config, \CumulusMX.pdb

Version 3.0.1 (10 Sep 2019)

Build Fixes Additions Files affected
3051 For various Davis features Davis archive data processing progress indication \CumulusMX.exe, \CumulusMX.pdb

Version 3.0.0 (1 May 2019)

Build Fixes Additions Files affected
3050 None adding support for locales that use multi-character date separators \CumulusMX.exe and \CumulusMX.pdb