5,838
edits
Software: Difference between revisions
m
no edit summary
mNo edit summary |
|||
| Line 1: | Line 1: | ||
[[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX. | |||
= 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. | : 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. | ||
| Line 7: | Line 8: | ||
== | ==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. | 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. | ||
| Line 22: | Line 23: | ||
If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]]. | 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 | 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 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] | 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== | ==Upgrading== | ||
| Line 32: | Line 33: | ||
We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest release: | 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 | * 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, and do not have the full set of sensors that MX can support, so pre-release testing is never perfect | ** 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 | * 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 developer can | * Also the main developer can most easily offer support if you are using the build he most recently released. | ||
There are | 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''. | * ''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 | ** 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 ( | * 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 | ** 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. | * It is strongly recommended that you install all files in the download for a new release of MX directly over your existing installation. | ||
| Line 48: | Line 49: | ||
*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. | *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, | *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, | ||
** 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 | ** 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 | *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. | ** 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. | ||
| Line 60: | Line 61: | ||
~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3196/CumulusMXDist3196.zip Cumulus MX v3.19.3 build 3196, 25-July-2022] | ~ 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=== | ===Raspberry Pi Image=== | ||
| Line 78: | Line 85: | ||
: 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). | : 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== | ==Older releases== | ||
| Line 96: | Line 98: | ||
==By Mark Crossley== | ==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 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 "software libraries" included with earlier MX releases. | 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). | 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 === | === 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]]). | |||
* Learn about this utility by reading the [[Calculate_Missing_Values#CreateMissing.exe|calculate missing]] page in this Wiki. | 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. | ** 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. | * 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. | * 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. | ''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. | ||
| Line 142: | Line 157: | ||
=== Weather Display Converter === | === 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]. | 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. | Please read the readme file in the zip. | ||
| Line 150: | Line 165: | ||
<br> | <br> | ||
At time of creating this utility, the functionality offered by MX was limited, and this utility was not useful with MX. | 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. | Please read the '''readme''' file in the zip. | ||
* There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=20017 | * 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]. | * 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 == | == Third Party Contributions by other Cumulus Users == | ||
For files, and add-on's, contributed by Cumulus users, see these Categories: | 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:3rd Party Apps]] - contributions for various devices, | ||
# [[:Category:AddOns]] - adding extra functionality, | # [[:Category:AddOns]] - adding extra functionality, | ||
| Line 173: | Line 186: | ||
# [[:Category:User_Contributions]] - key contributions from the user community | # [[:Category:User_Contributions]] - key contributions from the user community | ||
=Current MX Developed from = | =Current MX Developed from = | ||