Category:Cumulus MX: Difference between revisions

1,255 bytes added ,  20:30, 18 March 2020
→‎Introduction: Rewritten, was previously talking about volunteers testing an experimental project
(→‎Introduction: Rewritten, was previously talking about volunteers testing an experimental project)
Line 4: Line 4:


= Introduction =
= Introduction =
This Wiki article was created by Mark Crossley based on what Steve Loft said when he first started experimenting with Cumulus MX and access was restricted to those willing to experiment with his tests.


It has now been updated to reflect that Mark Crossley has continued its development, it is now out of beta, and a fully working package.
== Restrictions on who can use MX ==
Note: The graphs used in Cumulus MX are drawn using Highcharts and they are free for non-commercial use only, i.e. you may not use them on a company web site, see http://shop.highsoft.com/faq/non-commercial for clarification. For this reason, and others, use of Cumulus MX in a commercial environment is expressly forbidden. Please include a link to the Highcharts web site (as the supplied web page does) if you use the charts under the terms of the non-commercial licence.
Note: The graphs used in Cumulus MX are drawn using Highcharts and they are free for non-commercial use only, i.e. you may not use them on a company web site, see http://shop.highsoft.com/faq/non-commercial for clarification. For this reason, and others, use of Cumulus MX in a commercial environment is expressly forbidden. Please include a link to the Highcharts web site (as the supplied web page does) if you use the charts under the terms of the non-commercial licence.


There's quite a lot to read before you start - please do read it all, most of it is very important. Thank you for volunteering to test Cumulus MX. There are likely to be a lot of issues to sort out, and some of those may not be easy, particularly on the new platforms. When posting problems, please give as much information as possible. It is likely that I will need to produce new versions with extra debugging code as we hit new issues. Please remember that the only purpose of providing you with this software is for you to test it for me and provide feedback. Note that most of the Cumulus 1 documentation also applies to Cumulus MX. If you are trying MX having never used Cumulus 1 before, you will be at a disadvantage regarding documentation of many of the features, some settings may not be obvious. Looking at the FAQ and the wiki will help, as will looking at the Cumulus 1 help file (available on the Cumulus downloads page, or as part of a Cumulus 1 installation).
== Documentation for MX ==
There's quite a lot to read before you start - please do read both this page and all the references it mentions, most of it is very important.  
 
Note that most of the Cumulus 1 documentation also applies to Cumulus MX. MX specific documentation is currently in very early stages and some settings may not be obvious. Looking at the FAQ and the wiki will help, as will looking at the Cumulus 1 help file, it is available on the [[Software|Software downloads page]].  If you already use Cumulus 1, the help is part of the standard installation.
If MX is your first encounter with Cumulus, you will be at a disadvantage regarding documentation of many of the features, while those who have previously been familiar with Cumulus 1 will find most aspects of MX easier to pick up.
 
== Comparing Cumulus 1 and MX ==
Cumulus MX aims to be as compatible with Cumulus 1 as possible. Initially MX, as developed by Steve Loft, lacked a lot of features that were available in Cumulus 1, but the developments headed by Mark Crossley have now added the majority of the missing features.  There are also many features that have been added to MX that were either on the now lost list of enhancements for Cumulus 1 that never got implemented, or they are extra functionality to reflect recent changes in weather station features.


Cumulus MX aims to be as close to 100% compatible with Cumulus 1 as possible. Aside from a very few places where it is not fully compatible, it is different in two main ways. Firstly, it consists of a stand-alone 'engine' which performs the reading and logging of data, uploading to a web site etc. This 'engine' is a command-line/console application which has no user interface. The user interface is provided by virtue of the engine acting as a web server. Once the engine is running, you can view the user interface by typing the URL of the built-in web server into your browser, either on the same machine, or on a separate machine. The default URL if the browser is on the same machine as MX is http://localhost:8998/ - substitute the machine's IP address for 'localhost' if the browser is on a different machine.
Cumulus 1 was an all in one application, it both read the data from the weather station and provided the user interface for you to see the derived data and change the settings. MX is different, it consists of a stand-alone 'engine' which performs the reading and logging of data, uploading to a web site etc. This 'engine' is a command-line/console application which has no user interface. The separate user interface is provided by virtue of the engine acting as a web server. Once the engine is running, you can view the user interface by typing the URL of the built-in web server into your browser, either on the same machine, or on a separate machine sharing the same local network. The default URL if the browser is on the same machine as MX is http://localhost:8998/ - substitute the machine's IP address for 'localhost' if the browser is on a different machine. For security reasons, the user interface should not be accessible via the public internet.


The second way in which it is different is that in addition to running on Windows, it also runs on Linux and Mac OS X. To run on Windows, you need .NET 4.5 installed. To run on the additional platforms, it requires the Mono runtime, and you will need to install this, as described below.
Cumulus 1 only runs on Microsoft Windows operating system, MX is different as that in addition to running on Windows, it also runs on Linux and Mac OS X. To run MX on Windows, you need .NET 4.5 installed. To run MX on the additional platforms, it requires a suitable version (see support forum for advice) of the Mono runtime, and you will need to install this, as described below.


Note that I cannot guarantee backwards compatibility of Cumulus data once it has been updated by MX, i.e.you are unlikely to be able to use the data from Cumulus MX with Cumulus 1.9.4 without some manual editing of some of the files.
Both Cumulus 1 and MX both use the same basic files: [[Cumulus.ini]], [[dayfile.txt]], [[today.ini]], [[month.ini]], [[year.ini]], [[alltime.ini]], [[monthlyalltime.ini]].


Look up the Log Files index page or the individual file pages just referenced to see the differences between file content, and what you need to edit to use Cumulus 1 files with MX. However, there are files that Cumulus 1 uses (most of the image files) that are not used by MX and also files that MX creates that were not part of Cumulus 1.


= Installing Cumulus MX =
= Installing Cumulus MX =
5,838

edits