Release Notes: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Release Notes (view source)

Revision as of 07:14, 6 April 2024

22,820 bytes added ,  6 April
m
→‎Version 7.0.0 public beta 3 (05/04/24)
(173 intermediate revisions by the same user not shown)
Line 3: Line 3:
   |__TOC__
   |__TOC__
   |}
   |}
==== Version 7.0.0 (xx/xx/20xx) ====
==== Version 7.0.0 public beta 3 (06/04/24) ====  
Major Work In Progress on a transition to .NET 6 (in parallel with similar work on CMX).<br/>
#Distribution: Removed ''CutilsMenu-example.txt'' from the distribution. This was the old config for menu System-1
During this work development on version 6 has stopped, only support maintenance when required takes place.
#Graphs: Fix for a missing semicolon which prevented the Wind graphs to work properly


#Created a new project line for .NET6. When CMX is ready for .NET6 CumulusUtils will follow shortly after.
==== Version 7.0.0 public beta 2 (05/04/24) ====
#Dayfile and Standard Logfiles are now sourced through SQLite.
#ExtraSensors: Fixed the CO2 sensor webtag format for the realtime values from CO2- format (old and invalidated) to CO2_ (see [[Full_list_of_Webtags|Webtag List]])
#ExtraSensor data are now sourced through SQLite.
#WindRose has now a much better performance because of the use of SQLite (3 times faster or better depending on the system/OS).
#Use latest  versions of libraries. This may have effect on FTP, FTPS and SFTP. Standing issues to test in the beta:
##FTPS - not all servers were able to handle re-use of resource.
##SFTP - login with just un/pw does not work everywhere, thought to be provider dependent.
#Renewed compliance to [https://validator.w3.org/ W3 markup validation].
#Logging: moved some messages to different classes (Tracing, Info, Warning, Error). In general the view of the logfile improved with less messages (up to level Info).
#AirLink: Used SQLite to add the Windbarbs to the charts.
#ChartsCompiler: Used SQLite to add plot data to fetch the UserAskedData.
#Windrose bug fix: the v3 WindRose apparently had a bias to some directions/windspeeds which could not be found. The new technique with SQLite solves that issue.
#ExtraSensors: If the ExtraSensors remain open for more than 10 minutes (or multiples thereof) the ExtraSensor charts are reloaded. With this the ExtraSensors have the same feature as the Home charts.
#Top10 records now has top 10 list of minimal rain per month added. Technical update of this module.
#Top10 records now also has a scroll bar (on the containing div).


==== Version 6.15.6 (xx/xx/23) ====
==== Version 7.0.0 public beta 1 (17/03/24) ====
#General: The platform for CUtils version 7 will now be ''.NET 8''. Instructions for installing ''.NET 8'' (for Linux) will be supplied in the CMX forum. All dll libraries have been updated! It is suggested you renew the ''cumulusutils'' installation completely (so: remove the old one if you are not making a completely new CMX directory).
#General: One major change for CUtils is that the CustomLogs require a comma field separator (it was advised to be a space). As a result the definition needs to be adjusted (replace the space between webtags with comma) and the existing data need to be edited. To do this (after the conversion):
##shutdown CMX and stop your scheduler/crontab jobs (see for details the notes in the release post)
##take a customlog in the editor and check if the conversion added comma separators after the date and the hour field. Than do the following:
##find the space separator and replace with a comma. Make sure no multiple comma separators come into the file (this should be an easy automatic editor operation).
##repeat for all your CustomLog datafiles
##start CMX and restart your scheduler/crontab jobs
#General: '''''Duplication and Order of the data''''' : CUtils V7 is able to detect duplication and order errors of data. For some reason CMX sometimes has duplicate times in the logs, this may create errors in charts and definitely faults your statistics. This test is activated by default but if you wish to leave the errors (bad, but correcting it may be a lot of work) or when you are done correcting you can switch the test off by setting the parameter ''CheckDateOrder'' (section  ''General'') to ''false'' (default is ''true''). It is a choice to act upon these warnings/errors but if you wish not to act, it is best to switch the feature off as it takes time. The errors are indicated in the logfile in the section reading the monthly logs.
#General: Extensive rewrite of all logfile reading because of the invariant write by CMX. Transparent for the user.
#General: The console output when run from the command line from now on has reduced informational (progress) and Error information. If you use a colour terminal the Error should jump out.
#Website: The URL now has the current report as parameter so if copied and pastes you can bypass the menu.
#Website: As a consequence of the URL parameters, the core of the runtime system was rewritten which as a spin off now has all charts generated by the [[ChartsCompiler]] being refreshed after the configured ''Interval'' nr of minutes.
#ChartsCompiler: To have more words in the drop down menu choice of a Charts class, make a chart-ID with underscores. Underscores will get replaced by spaces.
#ChartsCompiler: Added PERIOD for SMA stats line. If no period is given a default is given by the parameter ''SmaPeriod'' in section [Compiler]. See [[Charts_Definition_Language_(CDL)|CDL]] Plot Specification
#ChartsCompiler: STATS is now also possible on equation results (which have a different name than the CMX plotvars).
#ChartsCompiler: All axis will now be generated with min and max labels (min and max values will be shown), UV axis will now have soft max of 10.
#ChartsCompiler: Rewrite of the axis logic in the code generation. Should be transparant for the user.
#Graphs: If heatmap now has more than ''HeatmapNumberOfYearsPerPage'' (parameter) the chart starts now at the highest year.
#Sysinfo: Fixed : lines to be omitted from the systeminfo output on Windows
#Support: for the new CMX un/pw encryption
#Highcharts: there were two charts which did not work with HC 11.3 which had been accepted as bugs. The Heatmap is fixed but it is unknown when it propagates through the CDN. The Rain vs EVT chart has a workaround and should work. Advise: empty the parameter ''UseSpecificHighchartsVersion'', if problems re-occur, use version 11.2
#HighCharts: There may be some cookie issues if you are working with Chrome. afawk other browsers are still working fine. No solution as yet. Please inform  me when having issues.
#Monthfiles: Because of the logfile invariance you may remove the parameter ''MonthsOfMiracleAndWonder''
 
==== Version 6.23.6 (30/01/24) ====
#CustomLogs: Addition of <#stationpressure>
 
==== Version 6.23.5 (17/01/24) ====
#General: Upgraded all libraries as shortly after the previous release it was found the no FTP variant did work anymore. Apparently nobody uses FTP anymore.
 
==== Version 6.23.4 (16/01/24) ====
#General: The limit of data only after 27 Januari 2004 (start of Cumulus) has been lifted (under the condition that the logfile records have the length of todays records). CUtils can now read whatever number of years (current record is 1 Januari 1979)
 
==== Version 6.23.3 (14/01/24) ====
#ChartsCompiler: Error messages improvement
#ChartsCompiler: If there is an error in the charts, a notification is now given in the terminal output
 
==== Version 6.23.2 (10/01/24) ====
#ExtraSensors: Fixed. The Lightning and CO2 sensors were incorrectly handled when both present
#SysInfo: If the parameter Tx (for WLL) is not filled in, the resulting SysInfo page will show an error: "A value for the Transmitter used is needed - please set parameter Tx"
 
==== Version 6.23.1 (05/01/24) ====
#Graphs: When creating the solar energy chart, the solar energy per day can be requested and will be written out to ''DailySolarEnergy.csv''. The parameter involved is [General] ''NeedSolarEnergyDailyValuesInCSV=false'' (default)
#Language: Parameters ''LimitValues, Winter1, Spring, Summer, Autumn, Winter2'' have been added to the language file to  be translated.
#Charts: All axis involving Temperature will now - when using Fahrenheit scale - have a soft minimum of 32 F-degrees i.s.o. 0
#General: It is now possible to run CUtils from day one i.e. after having at least one rollover i.e. the dayfile has at least one record.
#ExtraSensors: Fixed a unreported issue with the lightning sensor
#Graphs: Fixed a minor issue with the normal and station reference lines in the Daily Rain chart
#SystemInfo: With the WLL device you now get a message if the Tx parameter is not filled in
 
==== Version 6.23.0 (06/12/23) ====
#Technical: A cleanup of the code wrt the JSON creation. Though this is not visible for the user it has impact and will require (international) regression testing.
#Technical: Redo the logfile reading along the  line  of the CustomLogs. This reduces complexity and unifies the method. Not visible for the user and will require (international) regression testing.
#Technical: Performance gain while reading the monthly logs as a result of the previous action.
#MeteoCam: Addition of ''EcowittHP10'' as ''CamType'' (the original being the default ''CamType Manual'')
#Language: parameters ''NormalYearlyRainfall, StationYearlyRainfall, DailyRain, DailyEVT'' have been added.
#Graphs: In Rain vs EVT chart the plotline ''Normal Yearly Rainfall'' has been moved to he front and colour set to blue. The default title has the addition "Cumulative". The user who already has this in the language file will need to change it manually.
#Technical: Deprecated the use of MySQL (i.e. the parameter ''UseSQL'' is no longer used and can be removed)
#CustomLogs: Webtag ''wchillH'' has been renamed ''wchillL'' from CMX b3264 and up.
 
==== Version 6.22.0 (23/11/23) ====
#Units: fix for Distance as that was always km and should be corresponding the windspeed (mph => mi, m/s => km etc...)
#CustomLogs: addition of the following webtags: ''RecentApparent, RecentIndoorTemp, RecentIndoorHumidity''.
#Graphs: addition of ''Rain versus EVT'' graph (in the Rain section)
 
==== Version 6.21.5 (16/11/23) ====
#Sysinfo: Added reception status for Ecowitt devices
#Airlink and ChartsCompiler: WindBarbs is now a translatable word
#ChartsCompiler: added an Axis Height (ToDo: Wiki compiler spec.)
#Customlogs: Changed permitted webtag ''cloudbase'' to ''cloudbasevalue'' and attached axis Height
#Website: The pwsFWI button which in the past had been moved from the navbar to the header, has now been made configurable. If you add ''PwsfwiButtonInHeader=false'' to your [Website] section of ''cumulusutils.ini'' it will configure in the navbar just before the system led. The default for this parameter is ''true'' (placing the button in the header). Editing cumulusutils.ini yourself saves the labour of a second website run.
#CustomLogs: added the following webtags to the allowed webtag list: ''"windrunmonth", "StormRain", "RecentOutsideTemp", "RecentWindChill", "RecentDewPoint", "RecentHeatIndex", "RecentHumidity", "RecentWindSpeed", "RecentWindGust", "RecentWindLatest", "RecentWindDir", "RecentWindAvgDir", "RecentPressure", "RecentRainToday", "RecentSolarRad", "RecentUV", "RecentWindChill", "RecentFeelsLike", "RecentHumidex", "snowdepth", "snowlying", "snowfalling", "Tbeaufortnumber"''.
#Customlogs: webtags in the realtime table in the left pane are now displayed including the brackets and the hash ('''<# >''') to facilitate the showing of possible [[Webtags/Parameters|modifying parameters]].
 
==== Version 6.21.4 (12/11/23) ====
#General: Fixed: Improved logging info when asking webtag values
#CustomLogs: made the realtime table animation ''slow''
#ExtraSensors: Changed the realtime table height to ''70vh''
#Uploading file: Fixed: The CMX ''Host'' parameter is only for FTP protocols. When using PHP upload ''PHP-URL'' needs to checked for not empty
#CustomLogs: If the CustomLog Frequency in minutes modulo the Internet Interval in minutes has a value other than zero, a warning is logged when the end of the log is reached and the last record time does not match the endTime.
#ChartsCompiler: Introduction for a specific path on the website when making modular use of CUtils and wanting to separate CUtils from the webroot files. Introduction of the parameters ''DoModular'' (cannot be combined with the Website command) and ''ModularPath'' which contains the path to the CUtils modules, relative to Webroot e.g. '''''CUtils/''''' (the closing slash is required as it is with ''CumulusRealtimeLocation''). NOTE: Module and ModularPath does not hold for the AirLink module which is on the ToDo-list for Modular handling.
#CustomLogs: Added THWindex and THSWindex to the list of allowed webtags
 
==== Version 6.21.3 (07/11/23) ====
#CustomLogs: Fixed: The Ecowitt CO2 sensor has also an AirQuality sensor with four values which need an AQ axis.
#Website: Modification of website statistics parameters adding Matomo for a choice between Google and Matomo. Parameters have changed, see [[Website_Generator#Inifile_parameters|wiki]]. If you already use Google statistics, you will  need to set the new parameter ''StatisticsType'' to the value ''Google'' (the default for this new parameter  is empty).
#CustomLogs: Modified the layout and behaviour of the realtime values table in the left pane in relation to the chart chosen (length of table with ''overflow'' and a ''slideDown'' when change from RECENT to DAILY and vice versa.
 
==== Version 6.21.2 (04/11/23) ====
#CustomLogs: Fixed - When reading the logfiles over a month boundary the transition to the next month was incorrect Thus the charts were missing the days in the new month.
#CustomLogs: Modified the CustomLogs - using the units and charts axis.
#Chartscompiler: solved a few bugs while implementing the CustomLogs Units and chart Axis. Non-critical in pre-6.21 versions
 
==== Version 6.21.1 (31/10/23) ====
#CustomLogs: Fixed - When using ''CumulusRealTimeLocation'' the customlogs JSON's were not correctly located.
 
==== Version 6.21.0 (22/10/23) ====
All functionalities of the previous beta's
 
Main addition is the implementation of the CustomLogs module.
CustomLogs will:
#Make it easy to chart Lightning with the Ecowitt Lightning sensors (see below)
#Makes it possible to plot previously unavailable values (E.g. the Wet Bulb Temperature or 24 hour rain)
#... and whatever users may come up with - all webtags producing a value are available for plotting
 
The CustomLogs module is also accessible as a module for displaying the charts in other websites. The realtime table is generated but not compulsory to use (using it in an other website requires additional handling and its use becomes  more complex). Data will be supplied daily by the ''CUtils USerAskedData'' call.
 
If a you create a CustomLog with the webtag <#LightningStrikesToday> - the Daily frequency is best as it is a daily total - automatically a chart with the daily number of strikes will be created when the module is activated.
 
Default the CustomLogs are under the menu ''Extra''. If the user chooses eventually a manual handling of those charts he can use that chart anywhere.
 
Once configured, CustomLogs are a very powerful tool to chart any value available in CMX in any combination.
A picture - i.e. a chart - says more than a thousand words.
 
Checkout the [[Release_Notes#Version_6.22.0_(xx/xx/23)|ToDo list for version 6.22.0]] and possibly propose a suggestion.
 
Additional modifications since last beta:
#No more crashes when adding a webtag to an existing log
#All file copies created while running the module are now correctly removed
#Incremental now works only for a ''UserAskedData'' run
#For an Ecowitt device added the firmware version in SysInfo (when available)
#Webtag #CPUTemp is added to the list
#Webtag name comparison to the reference list is now case dependent (as it should be). So a case spelling error now correctly fails the webtag!
 
==== Version 6.21.0 beta 1 to 4 (10/10/23) ====
#SysInfo: A distinction can be made for various Linux dialects when required. If needed contact me and we'll work it out.
#Sysinfo: openSUSE (Tumbleweed) has been implemented as Linux dialect.
#Forecast: SpotWx has been reinstated as default to prevent a crash while doing a new install.
#Units: When using m/s for speed, distance will be expressed in Km (distance in m is never used by CUtils).
#Graphs: Fixed the conversion of X-axis day number to date in the tooltip when applicable, when graphs used as module (not sure what happened here so report if not working!).
#General: Added the device types according to CMX v3.27.0 - b3250
#Gauges: Modified CUgauges.js to sync with gauges.js 2.7.7 of CMX 3.27.0 b3250
#CustomLogs: A first beta for a CustomLogs module. See the [[Custom Logs|Wiki page]] and [https://cumulus.hosiene.co.uk/viewtopic.php?t=21523 the forum post] specifically for this beta.
 
==== Version 6.20.0 (21/7/23) ====
#Website: '''IMPORTANT''' => Files borrowed from CMX and (possibly) modified - notably: ''gauges.js, gauges-ss.css, language.js, RGraph.common.core.js, RGraph.rose.js, steelseries.min.js, tween.min.js'' - have been prefixed with '''CU'''. You need to do a full update i.e. with one run without thrifty. The reason for this is that some users started using the libraries from the CMX release and use all websites from the same directory. You should not do that and it will fail the system (For CumulusUtils or for your alternative website depending which is last placed in that location).
#Website: Please note that the [[Default Website Development|CMX Default Website Development]] is developing fast and the new ''Alternate Default Website'' changed its index filename to ''index.html'' (it always was ''index.htm''). ''index.html'' is the same name as for the CumulusUtils website so you can no longer have those two websites in the same directory! The advised setup is always to create separate directories on the server for any website you create (which btw most of you, but not all, do). The data access is relative through the parameter ''CumulusRealTimeLocation'' and the ''Alternate Default Website'' will have a similar feature [https://cumulus.hosiene.co.uk/viewtopic.php?p=173045#p173045 as promised by Neil].
#Heatmap: The heatmap colour axis now has a range from 0 - 100 for the Fahrenheit scale for better resolution
 
==== Version 6.19.0 (29/06/23) ====
#General: some minor formatting corrections for use of imperial units
#General: Error correction and handling improved in case of an erroneous locale (in ''cumulusutils.ini'')
#General: All dates displayed in the modules and website are now shown according to the locale defined in the language setting in ''cumulusutils.ini'':
##Records: The Records, DayRecords and Top10 pages have been reworked to display the date/time in the local format used.
##pwsFWI: Adjusted for date formatting
##Graphs: Date in clock pane now follows local format.
##Gauges: Corrected the Danish language code to ''da'' i.s.o. ''DK'' and did that also for the gauges, this should be transparent for the user (Note the Danish locale is: da-DK).
##General: With this version, the use of the locale has been formalised. Please make sure you use the locale for your language/country as defined in [http://this%20Microsoft%20documenthttps://learn.microsoft.com/en-gb/openspecs/windows_protocols/ms-lcid/70feba9f-294e-491e-b6eb-56532684c37f this Microsoft document].
#HighCharts: All charts in CUtils will now display short dates (i.e. dd/mm/yyyy) according to the locale. This only is seen in the tooltips (e.g. the heatmap and Temperature Sum)
#Charts Compiler: To accommodate the mix of scatter with other plots, only the main y-axis (the first in the definition) now generates its gridlines, and the ticks for the different y-axis are no longer aligned. This will give a slightly different experience for the charts.
#General: Correction for the distance unit: meters is now possible (btw: not accessible for the user)
#Charts Compiler: The Distance Axis now works (Note: unit has to be reworked)
 
NOTE: It is understood that Norwegian, Danish and probably Swedish show different output for the C# compile time or for the javascript runtime.
 
==== Version 6.18.3 (10/06/23) ====
#Forecasts: Text around the ''Yourweather'' forecast table is now translatable (section: ''Forecasts'')
#Forecasts: Default ''ForecastSystem'' is reset to ''YourWeather'' because ''SpotWX'' has an issue with cookies. If you have set ''SpotWX'' and want to change, please modify parameter ''ForecastSystem'' to ''YourWeather''.
#Top10: Long Dry/Wet periods. Make sure the current period is taken into account when the period is not yet finished.
#Parameters: ''CMXport'' has been moved to section ''General''. ''UseSpecificHighchartsVersion'' has been added to section ''General'' to facilitate the user who wishes to use a specific Highcharts version. If empty automaticly the last published version is used. If a specific version (e.g. 10.3.2) is entered then that one is used. No slashes, no spaces just <number>dot<number>dot<number>
#General: Some minor formatting changes for imperial units, this includes an axis boundaries change for the heatmap.
 
==== Version 6.18.2(05/05/23) ====
#Website: The value of ''MoonImageLocation'' was forced lowercase which was incorrect.
#Month files: While reading the month files it had internally a max number of errors (value 10) after which it stopped logging. That value is now parameterised inn section general. It has no influence on the processing of the files, just the logging of the errors.
#Month files: Fix for correct order of assignment in case of older logfiles where values may be missing (e.g. if EVT is not present, SolarRad is now read correctly).
#Top10: Removed a line which cause unexplained errors on an RPi. It is still unexplained what and why it happened so all RPi users are asked to check the logs once in a while and look for errors. Errors may appear as crashes or graphs not appearing at all. So far the cause seems to be in the environment but a true explanation has not been found.
 
==== Version 6.18.1(30/04/23) ====
#AirLink: The AirLink Help button now is upgraded to Bootstrap 5.2 (it did not open/close properly)
#Airlink Help: Corrected a broken link on the help page.
#pwsFWI: Fix for dry/wet periode: when a day rain amount is less than 0.2 it is not counted as rain so dry period continues
#Moon image: To avoid confusion when your site is used by more than one CMX instances and more than one CUtils sites, the moon image location is now always made explicit. Use: ''MoonImageLocation=<Full URL>''. Include the image name in the URL! (best to manually add it to ''cumulusutils.ini'' and run ''website'')
 
==== Version 6.18.0 (24/04/23) ====
#PHP upload: UTF8 header added. You need to use this CUtils version (and up) to use PHP upload with CMX 3.25.x and up
#Charts Compiler: Code  generation creates a global for windbarbdata to prevent apparent issues.
#Top10: Fixed a bug for the wet/dry periods. Those are now correct.
#Airlink: Winddata are now fetched through the API for both incremental and full json data upload (requires 3.25 as well)
#DayRecords: The report is now independent of thrifty to have correct formatting and prevent out of date reports
#Helptexts: The titles of the Helptext modal screens for the Graphs module now have titles fitting the charts they belong to (and not "Daily Rain" as it was)
 
NOTE: It is required to use CMX version 3.25.0 (and up) with this version of CUtils (and up).
 
==== Version 6.17.3 (15/03/23) ====
#General: technical wrap up of the past quick successive releases
#General: Sync up to CMX 3.24.2
 
Although no functional changes it is advised to update.
If any anomalies please report.
 
==== Version 6.17.2 (13/03/23) ====
#UserAskedData: Fix for duplicate CO2 sensor entries in the ''ExtraSensors'' JSON for Ecowitt CO2 sensor. Required for PHP upload (incremental uploads)
#General: Fix for a wrong DateTime format in RecordsBeganDate generating a crash. If format is not correct (must be ''dd/MM/yy'') then the date is reset to first date in database and a warning is issued in the logfile.
#Upload: Fix for CUtils upload to other directories than the location of ''upload.php''. The ''UploadDir'' in section FTP site is now taken into account
 
==== Version 6.17.1 (08/03/23) ====
#Parameter DoneToday: For both parameters ''DoneToday'' the format is now set as ISO to prevent an error caused by mono for some locales
#ExtraSensors: The module ExtraSensors now correctly translates the plotvariables, defaults come from ''strings.ini'' (see [[Extra_Sensors#Translation/Language|wiki]])
 
==== Version 6.17.0 (05/03/23) ====
#Top10 & DailyRecords: parameter ''UseScrollableTables''. When false no scrollbar or defined height is shown for modular use, when true otherwise. Released as patch 1 to version 6.16.0
#General: Introduction of parameter ''RecordsBeganDate'' in section General (independent of CMX parameter ''StartDate''). When set to a date (format: dd/MM/yy) it will be used as the startdate of the data in charts and reports no matter the actual startdate in dayfile or monthfile.
#Uploads: Introduction of the PHP upload protocol present in CMX version 3.24.0 and up
#Menu: The menuitem ''Print'' is added (add to ''CutilsMenu.def'' (top level) if you want to use it). This provides the possibility to print what is in the ''ReportView''.
 
==== Version 6.16.0 (12/02/23) ====
#ExtraSensors: Fix for Ecowitt AirQuality sensors typo (released as patch 1 to 6.15.6)
#Top10: records now has top 10 list of minimal rain per month added. Technical update of this module
#Top10: records now also has a scroll bar (on the containing div)
#YADR: Fix for nr of decimals for the Rain report when using inches
#Misc Graphs: Fix for the season chart which is now corrected with an addition of 10 days to winter 1 (counting not the start but the end of the 10 day temperature grace period)
#Fix gauges.js: The init was done at document ready which made the modifications ineffective. Init is now after the modifications.
 
NOTE: This is the first major update for the oldest module of CUtils ;)
 
==== Version 6.15.6 (30/01/23) ====
#Functionality of 6.15.6 but now working correctly
Additional modifications:
#ChartsCompiler: Fix for the units of the ExtraSensors
#ExtraSensors: Fix for realtime values for the ExtraSensors
#Lightning Sensor: Added the date to the time of last strike
#Lightning Sensor: Whichever unit the distance it is always presented rounded to the nearest integer


==== Version 6.15.5 (29/01/23) ====
==== Version 6.15.5 (29/01/23) ====
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/11149...11688"

Navigation menu