5,838
edits
Software: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
Improved styling
m (Improved styling) |
|||
|
= Cumulus MX =
: a cross platform version of Cumulus
==Usage Restriction==
Are you representing a commercial organisation running a facility for others to use? If so, then sorry, you cannot use Cumulus MX to make weather data available to your organisation.
Note: '''Cumulus MX is strictly for non-commercial, non-government use only.'''▼
▲
Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default web site]], contains products produced by [https://www.highcharts.com Highsoft] which are not free for commercial and governmental use. ▼
▲Both the mandatory [[MX Administrative Interface|MX Interface]], and the optional [[New Default Web Site Information|default web site]], contains products produced by [https://www.highcharts.com Highsoft].
HighSoft apply a charge if their products are made available for commercial and governmental use.
== 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]]
Please read the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before installing it (to see what changes affect you, and what actions you may need to take).▼
▲
▲If you need any help with Cumulus MX, please first consult, in this Wiki, [[What_to_do_when_I_have_a_problem_with_MX]], or 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 those links, then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have answers.▼
▲If you cannot answer your questions from
==Upgrading==
We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest
* 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
* 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 more easily offer support if you are using the build he most recently released.
There are interdependencies 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 (I add a prefix of "_" in front of files I 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
*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,
** 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
** (a few builds will include one-off actions, e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables, in these cases you probably need to upgrade in multiple steps, to ensure these special actions are done at the particular release versions where the actions are supposed to be done).
*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.
===Latest build distribution download===
===Raspberry Pi Image===
<br>
# 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 may not work with other models
#* it is produced using a GB locale and GB time-zone, so that automatically started MX may not be running correctly for your locale.
▲*The instructions for using this image can be found here: [[Raspberry_Pi_Image|Raspberry Pi Image]]
▲** 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).
==Source download==
This code base is updated for all releases resulting from development by M Crossley.
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
(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.)
=== Create Missing ===
This is a MX utility, by Mark Crossley, to populate
~ The CreateMissing.exe ''v1.2.0'' download dated 05 December 2021 (works with release of MX 3.14.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.2.0/CreateMissing-v1.2.0.zip is here].
If you are using an earlier MX release than that stated above, upgrade
▲This is a MX utility, by Mark Crossley, to populate any missing [[Calculate_Missing_Values#Derived_value|derived fields]] from the [[Calculate_Missing_Values#Source_value|source values]] in your [[Standard log files|month by month (MMMyylog.txt)]], and to insert missing lines in [[dayfile.txt|daily summary (dayfile.txt)]].
More information by the author of the utility can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.]
A utility, by Mark Crossley, to export content of Cumulus MX [[Standard log files|month by month (MMMyylog.txt)]] and [[dayfile.txt|daily summary (dayfile.txt)]] [[Category:Files with Comma Separated Values|files]] to a [[Your Own Server|MySQL, or Maria, database server]].
~ The ExportToMySQL.exe ''v1.4.0'' download dated 05 December 2021 (works with release of MX 3.14.0 onwards) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.4.0/ExportToMySQL-v1.4.0.zip is here.]
If you are using an earlier MX release, upgrade that, before using this utility.
See [[Downloads| downloads page]] for full details.
The installer for the FINAL release of the legacy Cumulus 1 is available here:
However, during 2020 to 2021 there was an avalanche of people who used to use the legacy software swapping to MX. Be aware, the longer you wait before swapping, the more that MX will have developed away from the legacy, and potentially the more difficulty you might encounter with the migration of your data files.
*[//{{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/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight application for displaying 2 extra dials showing real time wind data on the standard Cumulus (with temperature and rainfall in histogram style) gauges page for a web site (no longer developed or supported)▼
*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French▼
=== 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.
**This does not affect any automatic generation of NOAA reports, but does prevent re-generation.
▲*[//{{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/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight application for displaying 2 extra dials showing real time wind data on the standard Cumulus (with temperature and rainfall in histogram style) gauges page for a web site (no longer developed or supported)
▲*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French
▲== Cumulus 2 ==
The software for Cumulus 2 is no longer available.
| |||
