5,838
edits
(17 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
{{TOCright}} | {{TOCright}} | ||
= Introduction = | = Introduction = | ||
If you have been using Cumulus 1, and now wonder whether to try using MX, be aware that: | |||
*Currently, more people are still using Cumulus 1 than are using MX; but during 2020, many have experimented with MX, then successfully moved to MX, just a few have gone back! | |||
*Cumulus 1 is a stable release, it has functionality that is not available in MX: | |||
**Select a graph | |||
**View period | |||
**provided you are happy to keep running Cumulus 1 on a Windows pc, and use a weather station that is compatible with Cumulus 1, then you don't have to change over | |||
*Cumulus MX is still under development, a change in a particular release may introduce bugs | |||
*MX does however have additional features not available in Cumulus 1 | |||
**it can run on Unix-derived (Mac, Linux, Raspberry Pi operating systems) devices as well as Windows devices | |||
**it can work with newer weather stations and newer sensors | |||
**it reports feels like, Canadian Humidity Index | |||
**it has built in updating of database tables | |||
**it can output to more external sites | |||
**it has MQTT, HTTP, and other extras, built in | |||
Please see [[Moving from Cumulus 1 to MX]] for more information. | |||
== What does Cumulus MX do? == | == What does Cumulus MX do? == | ||
If you are new to Cumulus, then you will be wondering what benefits Cumulus MX has over other weather recording software. In that case start by reading [[About Cumulus|the article that introduces Cumulus]]. | |||
You may want to read that article first, that that will explain what Cumulus software can do and perhaps help you to: | You may want to read that article first, that that will explain what Cumulus software can do and perhaps help you to: | ||
Line 16: | Line 33: | ||
== This article == | == This article == | ||
This Wiki article was originally exactly what Steve Loft said in the [https://cumulus.hosiene.co.uk/viewforum.php?f=39 MX early builds support forum] when he first started experimenting with Cumulus MX and access was restricted to those willing to experiment with his tests. | This Wiki article was originally created by Mark Crossley and contained exactly what Steve Loft said in the [https://cumulus.hosiene.co.uk/viewforum.php?f=39 MX early builds support forum] when he first started experimenting with Cumulus MX and access was restricted to those willing to experiment with his tests. | ||
In this rewrite, I | In this rewrite, somebody who used to use Cumulus 1, and experimented with MX, before moving over to MX first on a Windows PC and then on a Raspeberry Pi, has attempted to ensure this article contains everything I learnt from my experience as I explore more of the functionality of MX; and as I learn more from posts in the forum. | ||
If you can correct | If you can correct any mistakes I make, have a suggestion as to how to make it clearer, can add anything I have not yet covered, or know something that I might not know, then please remember, anyone can update this article, I don't have any special access in the Wiki and any page I edit can be edited/corrected by anyone else. | ||
During a period of my time in employment I was responsible for approving documentation on a large computerisation project, and later for supplying updated information for a public faced web site, and in both cases there were house style, and I probably continue to use that style. | During a period of my time in employment I was responsible for approving documentation on a large computerisation project, and later for supplying updated information for a public faced web site, and in both cases there were house style, and I probably continue to use that style. You might be afraid to add your contribution because my style is not the same as your natural one. Don't worry; as long as you use short paragraphs or bullet points, with lots of headings, then your contribution can blend in. | ||
As this article has grown, I have been able to shorten it by moving material to new articles, hence you will see a lot of cross-references below. You may have suggestions for what else can be moved out of this article into separate articles? | |||
If you have some ideas, but are unsure whether to apply changes, please use the discussion page first. If you have ideas, but want someone else to add them here, please write your suggestion in the support forum for wiki suggestions at https://cumulus.hosiene.co.uk/viewforum.php?f=38 | |||
= Cumulus flavours = | = Cumulus flavours = | ||
Line 114: | Line 131: | ||
=== Cross reference to article on [[Moving from Cumulus 1 to MX]] (includes general issues regarding running on Windows) === | === Cross reference to article on [[Moving from Cumulus 1 to MX]] (includes general issues regarding running on Windows) === | ||
You may be reading this article on MX as a Cumulus 1 user considering moving to MX, if so then | Whether you have been using Cumulus 1, or are new to Cumulus, you may be tempted to install MX on a PC, or other device, running Windows Operating System; the article linked in the heading will help you. | ||
You may be reading this article on MX as a Cumulus 1 user considering moving to MX, if so then it explains all issues when moving from Cumulus 1 to MX, including what functionality you will gain and what you will lose by moving to MX. The article will help you to decide whether to stick with Cumulus 1's stable release as many MX releases have bugs as the developer tries revising the code, to simplify it, as well as to introduce new features. | |||
As a new Cumulus user, using MX on Windows (but with no experience of Cumulus 1), the separate article linked from the heading to this section will still interest you as it is a definitive guide to installing Cumulus MX on Windows. | |||
=== Cross reference to article on [[Setting up Raspberry Pi]] for Cumulus === | |||
Whether you have been using Cumulus 1, or are new to Cumulus, you may be tempted to install MX on a Raspberry Pi. A Raspberry Pi (and similar devices from other manufacturers) is much simpler than a normal computer, but it can still run various operating systems that allow you to use it perhaps for both running MX and a web server. Find out more in the article linked in the heading. | |||
=== Cross reference to article on [[Updating MX to new version]] === | === Cross reference to article on [[Updating MX to new version]] === | ||
Line 164: | Line 185: | ||
In writing this update, I have drawn on my own experience of moving from Cumulus 1 to MX, and thus my knowledge of Cumulus is from over a decade of experience with this software and what it can do. | In writing this update, I have drawn on my own experience of moving from Cumulus 1 to MX, and thus my knowledge of Cumulus is from over a decade of experience with this software and what it can do. | ||
Before I swapped, I made a detailed study to check MX could do all I used to do with Cumulus 1 and much more. Before I add items to this article I play around with MX experimenting with what works and what does not work, but I have saved you the pain of where I went wrong, just telling you what is correct. I do need to add, that I don't have a separate testing environment, and therefore I am not willing to attempt anything that might muck up my collecting of weather information, plus | Before I swapped, I made a detailed study to check MX could do all I used to do with Cumulus 1 and much more. Before I add items to this article I play around with MX experimenting with what works and what does not work, but I have saved you the pain of where I went wrong, just telling you what is correct. I do need to add, that I don't have a separate testing environment, and therefore I am not willing to attempt anything that might muck up my collecting of weather information, plus my knowledge of modern technology is poor as I belong to that generation who did not have desktop computers, nor mobile devices, until some time into my working life. This all places restrictions on what I can test out, and therefore on the coverage of these notes. | ||
'''If anyone else, can improve these notes, wants to split off more parts, or in any other way make the documentation better, then please do. | '''If anyone else, can improve these notes, wants to split off more parts, or in any other way make the documentation better, then please do. This article already contains improvements that were suggested by others.''' | ||
Line 174: | Line 195: | ||
There is no automatic installer (this may change). Cumulus MX is supplied as a zipped package on a link from [[software|Software page]]. | There is no automatic installer (this may change). Cumulus MX is supplied as a zipped package on a link from [[software|Software page]]. | ||
== Replacing Cumulus 1 == | |||
See [[Moving from Cumulus 1 to MX]] article. If you wish to run MX on Windows, then you can unzip the contents of the download package over your cumulus 1 installation, i.e. so the same data and Reports folders continue to be used. But it would be best if you take a back-up copy of the Cumulus 1 installation first! | |||
The package contains several extra .dll files, and everything else you need, to continue to read from your weather station, to load up the admin interface (there are some settings you will need to change), and some simple web templates (that replace the standard Cumulus 1 ones). You might want to read topics on the MX support forum to discover about other people's experiences. | |||
== Completely new MX installation == | == Completely new MX installation == | ||
Create a new directory (recommended name CumulusMX) and unzip the contents of the download package into it. See notes below for extras required in various operating systems. | See earlier for links to other articles about installing on a Windows PC or a Raspberry Pi. Here only a brief indication of installation is covered. | ||
*Create a new directory (recommended name CumulusMX) and unzip the contents of the [[Software|download package]] into it. | |||
*See notes below for extras required in various operating systems. | |||
*The package contains everything else you need to read from your weather station (if it is a supported model), to load up the admin interface (for settings and some simple templates used to create web pages to see on a device connected to your home network). You might want to read topics on the MX support forum to discover about other people's experiences. | |||
== Running Cumulus MX == | == Running Cumulus MX == | ||
Line 186: | Line 216: | ||
# Start '''Admin Interface''', it runs in a browser, by default on port 8998, see [[#User_Interface|section]] below. | # Start '''Admin Interface''', it runs in a browser, by default on port 8998, see [[#User_Interface|section]] below. | ||
If you are running MX for the first time, without a configuration file (none is included in download package), see [[Cumulus.ini#Cumulus_MX|here]] for screen shots and instructions. | If you have been running Cumulus 1 before, then [[Moving from Cumulus 1 to MX|as instructed here]] your MX installation will require various files from your Cumulus 1 installation including all files in the '''data''' and '''Reports''' folder and all [[:Category:Configuration Files|Configuration Files]] including [[Cumulus.ini#Swapping_from_Cumulus_1_to_MX|Cumulus.ini]] and follow that link for details of a few of the parameters that you may need to change. | ||
If you are running MX for the first time, without a configuration file (none is included in download package), see [[Cumulus.ini#Cumulus_MX|here]] for screen shots showing what you see as the engine starts running, and what you see in the admin interface where you set your weather station type. In that link there are more instructions. | |||
=== .NET and Mono === | === .NET and Mono === | ||
The software currently | The software currently called .NET was originally for all operating systems, but Microsoft then decided to restrict it to just Windows (and that was the position while MX was being developed and is still true in early 2020 when this article was rewritten), mostly to encourage greater dominance by Microsoft software and hardware. | ||
Mono was then born based on .NET to work with all operating systems, Mono subsequently changed independently from .NET (although Microsoft still has a leading role). | Mono was then born based on .NET to work with all operating systems, Mono subsequently changed independently from .NET (although Microsoft still has a leading role). | ||
Line 196: | Line 228: | ||
More recently, Microsoft launched an alternative called .NET Core that took out of .NET the parts that were Windows specific, and it ceased work on further development of .NET beyond version 4.x.x. | More recently, Microsoft launched an alternative called .NET Core that took out of .NET the parts that were Windows specific, and it ceased work on further development of .NET beyond version 4.x.x. | ||
'''Perhaps confusingly, in November 2020, there will be change around of names, and the multi-operating system .NET Core product will take over the .NET name. I don't pretend to understand the technical details, but the impression I get is that the new .NET in November will be similar to Mono, so apps designed for that will still work, but apps using .NET to make code designed for windows will stop working''' | '''Perhaps confusingly, in November 2020, there will be change around of names, and the multi-operating system .NET Core product will take over the .NET name as version 5. I don't pretend to understand the technical details, but the impression I get is that the new .NET in November will be similar to Mono, so apps designed for that will still work, but apps using .NET to make code designed for windows will stop working'''. Since the Cumulus code is currently coded to behave slightly differently using .NET and using MONO, I guess it is possible old versions of MX might stop working when the new .NET is installed via Windows Update. | ||
=== Requirements for running on Windows === | === Requirements for running on Windows === | ||
Line 218: | Line 249: | ||
</pre> | </pre> | ||
You only need to do that once. If you do not issue this command, | You only need to do that once. If you do not issue this command, administrative rights are needed every time to access the port. | ||
Talking about command windows, if you want to check that the port is open for listening (i.e. able to access the admin interface) type <tt>netstat -an | findstr 8998</tt> into the command window. | Talking about command windows, if you want to check that the port is open for listening (i.e. able to access the admin interface) type <tt>netstat -an | findstr 8998</tt> into the command window. | ||
Line 271: | Line 302: | ||
#First '''start the engine''' in one of the 3 ways from last sub-section | #First '''start the engine''' in one of the 3 ways from last sub-section | ||
# Next '''start the admin interface''', it does not need to run all the time, but only when you need it (when you first use MX you will need it to access the settings where you tell MX what type of station you have and what units you want to use, and set various timing options), it normally runs on port 8998 (to vary that there is a '''-port''' parameter that is followed by required port and that port parameter has to be entered every time you start MX if you are not using the default port). | # Next '''start the admin interface''', it does not need to run all the time, but only when you need it (when you first use MX you will need it to access the settings where you tell MX what type of station you have and what units you want to use, and set various timing options), it normally runs on port 8998 (to vary that there is a '''-port''' parameter that is followed by required port and that port parameter has to be entered every time you start MX if you are not using the default port). More information on admin interface [[MX Administrative Interface|in separate article]]. | ||
Try '''start /min C:\Cumulus\CumulusMX.exe''' to run MX as a minimised package (although in Windows you can change the properties of the shortcut you use to start minimised). | Try '''start /min C:\Cumulus\CumulusMX.exe''' to run MX as a minimised package (although in Windows you can change the properties of the shortcut you use to start minimised). | ||
Line 290: | Line 321: | ||
* For OS X, you can download this here - http://www.mono-project.com/download/. | * For OS X, you can download this here - http://www.mono-project.com/download/. | ||
* How you install on Linux depends on the flavour of Linux you are running. There are download links for Linux at the same URL, but it is often easier to use a package manager, which will download and install it automatically. | * How you install on Linux depends on the flavour of Linux you are running. There are download links for Linux at the same URL, but it is often easier to use a package manager, which will download and install it automatically. | ||
**For example, in 'Raspbian' on the Raspberry Pi, you can install mono with | **For example, in 'Raspbian' on the Raspberry Pi, you can install mono with the following commands, but '''first you need to have set up various pre-requisites''' (see [[Setting_up_Raspberry_Pi]] article for details): | ||
<pre>sudo apt update && sudo apt upgrade | <pre>sudo apt update && sudo apt upgrade | ||
sudo apt install mono-complete</pre> | sudo apt install mono-complete</pre> | ||
Note that you do need to have the '''mono-complete''' package installed, not just the Mono for developers. | |||
The "sudo" prefix gives the command 'root' privileges, that allows administrative commands like update and install to run. | The "sudo" prefix gives the command 'root' privileges, that allows administrative commands like update and install to run. | ||
Line 308: | Line 336: | ||
There are some optional parameters you might need to use, as they also apply to windows they are covered later. | There are some optional parameters you might need to use, as they also apply to windows they are covered later. | ||
Next start the administrative interface, basically same as described for Windows above. More information on admin interface | Next start the administrative interface, basically same as described for Windows above. More information on admin interface [[MX Administrative Interface|in separate article]]. | ||
==== Other issues ==== | ==== Other issues ==== | ||
Line 316: | Line 344: | ||
'''APPEAL''' - Please could any readers who have experience of running MX in a Linux or Mac environment please consider writing advice into this article. I want it to be a comprehensive accurate article. | '''APPEAL''' - Please could any readers who have experience of running MX in a Linux or Mac environment please consider writing advice into this article. I want it to be a comprehensive accurate article. | ||
=== Notes by Steve Loft === | |||
''please note these notes ARE now obsolete, library routines have changed a lot since this was written in 2014'' | |||
''' | '''Any volunteers to replace this section with up to date information?''' | ||
''' | |||
**If you have a Raspberry Pi 2, there is a later version of Mono available, which you may find works better that the one in the standard distribution, particularly if you use decimal commas. Mono 3.2.8 (which is the default in some Linux distributions) will not work if you use commas for decimals, as in some countries. | |||
'' | **On Linux you will need library '''libudev.so.0''' which may not be installed by default. Installing '''package libudev0''' may resolve this. There may be issues if you are using a 64-bit version of Linux. I'm not sure what the resolution is at the moment, if this is the case. | ||
''' | You need to specify something like '''/dev/ttyUSB0''' for the connection for your weather station. This is set in the "station settings" and stored in the [[Cumulus.ini#station|ComportName attribute]] in Cumulus.ini configuration file. | ||
In some builds of MX you have to run as "root", there are ways of giving "root" like permissions when running MX as another user, see forum for details until this section has been updated. | |||
==Stopping MX== | |||
''' | The best way to stop MX is by sending a '''control and C''' sequence to it. There is a start stop routine discussed in the support forum, where you will also find some topics about shutdown issues. | ||
The MX source listing suggests it also accepts ''control and break'', '''Close main window''', ''user logoff'', and '''system shutdown''' and should still attempt to stop running tidily. There are various tasks like writing final values to log files and recreating the configuration file, [[Cumulus.ini]], that it needs to do as part of the MX closing routine, and obviously early closure of the device running MX (such as that caused by a power cut) will prevent a tidy end to MX. | |||
= Executables = | |||
The MX package, at time of typing this, includes two executables: | |||
== CumulusMX.exe == | |||
Whilst effectively MX is run by a '''CumulusMX.exe''' or '''sudo mono CumulusMX.exe''' depending on device, you actually need to ensure all the other components are loaded, so you either have a package that runs it for you, or you click a shortcut that includes the necessary path setting. | |||
''' | |||
=== Optional parameters to add to the instruction to run the MX engine === | |||
Beta builds in MX version 3.0.0 had an optional parameter <tt>-wsport nnnn</tt> that determined which port (represented by a 4 digit number ''nnnn'') was used for '''WebSockets'''. That parameter is now deprecated as WebSockets in all builds since 3045 uses the same port as the rest of the [[MX_Administrative_Interface#The_API_interface|Admin Interface]]. The remaining parameters that are still available are described in subsequent sub-sections. | |||
==== Parameter for changing Port ==== | |||
When Cumulus starts, it will display the URL of the user interface. It runs on port 8998 by default; if this is not suitable for some reason you can over-ride it using the '-port' parameter on the command line, e.g. to use port 9999 instead: | |||
<pre>sudo mono CumulusMX.exe -port 9999</pre> | |||
==== Parameter for adding debugging ==== | |||
MX has a default level of logging that stores in the [[MXDiags]] folder a log file that shows some of the interaction with the weather station and some of the output actions done as MX runs. A new log is started each time MX is restarted. | |||
If there is a problem, then there is a great benefit in actually increasing the level of detail in these logs; and that is done either within the settings ('''options''' section of ''station settings'') in admin interface while MX is running, or by adding 1 or 2 parameters when you start MX. Obviously this log file continues to grow, the longer MX is left running, and if debugging is switched on the file will grow in size must faster. Consequently, the default is not to add the extra debugging information and the settings can be used to switch it off again if you do have it switched on. Whether you start it with a parameter or enable it within settings, stopping MX will end the extra debugging, and on restart it will default back to no debugging unless turned on again with parameter or setting. | |||
''' | You can also add '''CumulusMX.exe -debug''' (to have full debugging of actions by MX turned on as MX starts), and/or '''CumulusMX.exe -Logging=1''' (for the station to MX transfers to have increased debugging logging). | ||
( | |||
<pre>sudo mono CumulusMX.exe -debug -Logging=1</pre> | |||
<pre>sudo | |||
Since this parameter is applied when you start MX, it applies while MX continues to run. Obviously, it must be applied every time you start MX if you want this increased level of logging to continue every time you restart MX. | |||
The comments in the MX source suggests -debug turns on both debug and data logging (see [[MX_Administrative_Interface#Options|Station_Settings#Options]] in admin interface settings), but I believe that is wrong as per example above, there are 2 separate parameters. | |||
==== Parameter for changing Locale ==== | |||
On Linux and (in particular) OS X, Cumulus MX may not be given the correct locale to use, and you may get the default US locale even if that is not your locale. It will output the local it is using when it starts; if it is not correct, close it down and start it again, this time specifying your locale on the command line, using the -lang parameter . For example, in the UK, on a non-Windows device type: | |||
<pre> | |||
sudo mono CumulusMX.exe -lang en-GB | |||
</pre> | |||
Other local examples: '''CumulusMX.exe Current culture: English (United States)''', '''CumulusMX.exe -lang de-DE''', '''CumulusMX.exe -lang el-GR''' (this is one of the locales that reads numbers with '''integer,decimal''' format), '''CumulusMX.exe -lang nl-NL'''. | |||
<pre> | |||
'' | |||
If you are not sure what value you need to supply for the -lang parameter, there is a list here - http://msdn.microsoft.com/en-gb/library/ee825488%28v=cs.20%29.aspx. You need to supply the code in the first column ("Language Culture Name") in that list. | |||
Note that this does not affect the language used by Cumulus MX (although it may in the future), it affects the decimal separator and the list separator. | |||
Note that you ''may'' need to supply your administrator password after typing the 'sudo ...' command line. The system will prompt you for this if it is needed. | |||
== ExportMySQL.exe == | == ExportMySQL.exe == | ||
Line 627: | Line 485: | ||
==Library Software for the MX engine== | ==Library Software for the MX engine== | ||
The distribution zip contains various '''.dll''' files and these are the libraries used by MX itself. | The distribution zip contains various '''.dll''' files and these are the libraries used by MX itself. The exact mix of libraries included has varied at various times, the list below is a snapshot of those included at the version that was investigated when this article was extended to include this section, and may not be right for the current MX version. | ||
===Devart=== | ===Devart=== |
edits