Cumulus MX formal release versions: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
add category
m (add category)
 
(45 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Introduction =
= 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.


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.  
This article lists in concise tabular format all MX releases starting at build 3045, the first with significant updates.  


It gives version number, date of release, build number, summarises fixes and new features, plus indicates which files have been updated or added. Please note that as "Updates.txt" is updated in every release it does not 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. It is always worth checking the date modified for every file in any release, to ensure you include all updated files, not just that the developer remembered to include in the list of changed files.
Mark Crossley brought MX out of the beta development with build 3050, but the preceding few builds contained important changes they are worth including here.
 
The very first version 3.0.0 build by Mark was 3044 which included some elements that were in Steve Loft's source (left to the Community when as part of his retirement he gave up involvement in Cumulus) but had not been previously released. However, 3044, 3045, 3046 were all experimental in that they tried to fix certain bugs and prepare a basis from which later builds could start really introducing new functionality, you can look them up at [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 MX Current (releases since b3043)] in support forum.
 
The purpose of this article is to make it easier to look up what features were introduced at each version. It uses material taken from the support forum, both from the release announcements and from discussions about problems and fixes mentioned elsewhere, as often the official release announcement focusses on how affects user and does not cover all bug fixes and code improvements.
 
This article is NOT a comprehensive guide to what you need to do when upgrading. If you are using an old version and wish to know what version to update to, please see detailed advice in [[Updating MX to new version]] article.


'''This article is updated independently of release announcements in the forum, so may not always be in step.'''
'''This article is updated independently of release announcements in the forum, so may not always be in step.'''
{{TOCright}}
== Information included in this article ==
Please note that the support files (e.g. those in folder interface) are not part of the commit when creating CumulusMX.exe.  This can lead to the zip provided in the release download not matching the release description in the formal announcement. In extreme cases, as some entries in tables below show, it has been flagged where the wrong files are included.
The tables below include
* version number,
* date of release (date when the principal changes in the build were first available in a public release),
**please note that changes to some support files included in a release zip may be made after the build release date without being announced as a new build, and sometimes updated support files have accidentally appeared in zip for an earlier release than that of formal release.
* build number,
* summary of any fixes or improvements to existing functionality
*summary of any new functionality made available in build
*Basic indication of those files that have been updated, removed, 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.
** In a few releases the files included in the zip have had some inconsistencies with what is reported as the changed files. This is generally because either a particular correction was made in advance of other preparation for a new release and forgotten about, or because a minor correction was made after the formal release.
**For the rare case where the files included are not matched with the commit to form the executable, this may mean although you have a working release for most aspects of MX, some functionality within MX does not work at that 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.


== Instructions ==
== Instructions ==


This page is a precis of the information contained in the support forum at [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 Cumulus MX Announcements and Download - PLEASE READ FIRST]
This page is a prećis of the information contained in the support forum at [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 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.
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.


{{TOCright}}
=== 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.


== Past Releases ==
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!


All releases can be downloaded at [https://github.com/cumulusmx/CumulusMX/releases/ this page], the latest release can be directly downloaded directly from link at [[Software#Current_Release|MX Current_Release]].
== Finding Downloads ==


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.
All releases can be downloaded on [https://github.com/cumulusmx/CumulusMX/releases/ this page], the latest release can always be directly downloaded directly from link at [[Software#Current_Release|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.


== Revision Date ==
== Revision Date ==


Latest Update: 18 May 2020 (build 3077)
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.


Any builds released since this date are listed in the support forum, but not yet added below.
Latest Update to this page: 28 July 2020 (reporting build 3089)
 
 
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This document is 'Work In Progress' so content may not be complete or accurate!
</div>
[[Category:Cumulus MX]]
 
= Version 3.7.x =
 
{| class="wikitable" border="1"
|-
!style="width:50px"|Version
!style="width:50px"|Build
!style="width:300px"|Fixes
!style="width:350px"|Additions
!style="width:400px"|Files affected
|-
|3.7.0 (28 Jul 2020)
|3089
|There are quite a few fixes in this 50th release since Mark Crossley took over......see release announcement at https://cumulus.hosiene.co.uk/viewtopic.php?p=145048#p145048
|There are many new features in this release......see release announcement
|In release announcement the recommendation is to replace all files
|}


= Version 3.6.x =
= Version 3.6.x =
Line 34: Line 92:
!style="width:90px"|Version
!style="width:90px"|Version
!style="width:50px"|Build
!style="width:50px"|Build
!style="width:300px"|Fixes
!style="width:400px"|Fixes
!style="width:350px"|Additions
!style="width:400px"|Additions
!style="width:350px"|Files affected
!style="width:350px"|Files affected
|-
|3.6.12 (10 July 2020)
|3088 (wrong files in zip)
|Fix Davis stations not downloading historic logger data (broken in b3087)
|
|Updates.txt, CumulusMX.exe
'''The release zip contains the wrong files in the interface folder, use interface files for previous build instead'''
|-
|3.6.11 (8 July 2020)
|3087 (has bug)
| Davis TCP logger connections not timing out occasionally; removing wrongly placed 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) added to the backup on the first of any 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
'''There is a error in the compiled code for this release, use the CumulusMX.exe from next build instead of one in this release zip'''
|-
|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 '''This release is withdrawn'''
|-
|3.6.8 (18 Jun 2020)
|3084 (has bug)
|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) '''There is a critical error in the feels like formula used in this release'''
|\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)
|3.6.1 (18 May 2020)
|3077
|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.
|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; Adds a new web tag <#LastRainTip>, which unlike <#LastRainTipISO> will accept a date/time format string
|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
| Updates.txt, CumulusMX.exe, FluentFTP.dll, \interface\now.html, \interface\js\datalogs.js, \interface\js\dayfileeditor.js, \interface\js\extradatalogs.js
|-
|-
Line 179: Line 305:
|-
|-
|3063 (10 Jan 2020)
|3063 (10 Jan 2020)
|Ecowitt Soil Temperature/Moisture/Leak 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:
|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 the [FTP Site] section name to [FTP site]
Line 242: Line 368:


New files: \interface\alarmsettings.html, \interface\js\alarmsettings.js, \interface\sounds\alarm.mp3
New files: \interface\alarmsettings.html, \interface\js\alarmsettings.js, \interface\sounds\alarm.mp3
Although not mentioned in release environment,various library dependencies for CumulusMX.exe were added to distribution in this release - see dll files mentioned in[[Cumulus_MX#Library_Software_for_the_MX_engine|Library_Software_for_the_MX_engine]].
|}
|}


Line 320: Line 448:
|adding support for locales that use multi-character date separators
|adding support for locales that use multi-character date separators
|\CumulusMX.exe and \CumulusMX.pdb
|\CumulusMX.exe and \CumulusMX.pdb
|-
|3049
|No fixes
|upload data to Windy.com
| \CumulusMX.exe; \CumulusMX.pdb; \interface\json\InternetOptions.json; \interface\json\InternetSchema.json
|-
|3048
|enable/disable Realtime FTP without having to restart CMX; Instromet stations now record and report rainfall (mm) and sunshine hours to 2 decimal places; Improved real-time FTP error handling; Improved Davis protocol handling; Fix Davis protocol mixing up LOOP1 and LOOP2 packets and consequently providing invalid rain and wind data; Fix web tag <#YearLowDailyTempRangeD> broken in b3047; Bug fixes to FTP Component, and internal changes to FTP transfer mechanism
|No new functionality
|\CumulusMX.exe; \CumulusMX.pdb; \FluentFTP.dll; (all updated 2 Mar 2019)
\interface\js\gaugefeed.js (updated 16 April 2019)
|-
|3047
|Improvement to Instromet logger protocol handling; Change the Fine Offset Synchronised Reads option to default to enabled; Change VP2 automatic disabling of LOOP2 to an advisory message, as the firmware version is not always detected; Consistency: All record Value tags should now return '---' and Date tags '----' until they are first set; changes to moon web tags; Fix for Fine Offset & WMR100/200 stations on Mac operating systems (introduced in b3044); Fix for invalid (extremely high) pressure readings from Fine Offset stations (thanks to 79669weather) masked out 2 highest bits on data [1] with 0x3F to reduce problems with pressure spikes; Fix to not updating the Instromet loggers memory pointer correctly;  Fixed Weather Diary Time Zone issues; Bug fixes and performance improvements to the FTP component; 
|Web token parser updated to cope with html tag characters "<>" in the format string; Added new option for the "Extra files" - End of Day
|Removed: \fastJSON.dll
Updated: \CumulusMX.exe; \CumulusMX.exe.config; \CumulusMX.pub; \FluentFTP.dll; \HidSharp.dll; \interface\js\diaryeditor.js; \interface\json\StationOptions.json
|-
|3046
|ET annual rollover
|Weather diary
|\CumulusMX.exe
|-
|3045
|Davis TCP; WebSocket connection now uses same port as HTTP (optionally set by -port parameter when starting MX)
|Added refraction correction; 2nd order humidity correction
|}
|}
5,838

edits

Navigation menu