Category:Cumulus MX: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
mNo edit summary
 
(478 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This category lists all the pages that are relevant to MX, so is a good starting point.
{{TOCright}}
* There are pages in this category for all folders and files, used by MX
* If you contribute a new page, add it to this category by quoting '''<nowiki>[[Category:Cumulus MX]]</nowiki>''' on your new page.
* ''[[Migrating_from_Cumulus_1_to_MX|How to migrate to MX]]'' - For those still using the original Cumulus software


SOME KEY INFORMATIVE PAGES (FOR NOVICES):
If you are wondering what Cumulus software does, see [[About Cumulus|this article]].
* [[New Default Web Site Information|MX's Default Web Site Information]]
* [[What to do when I have a problem with MX]] - read this before you seek advice in the Cumulus Support Forum
* [[Raspberry_Pi_Image|Setting up Raspberry Pi using a pre-built Image]] - install MX on a Raspberry Pi computer, (with all access to the rPi done from another computer on same network).
* [[Samplestring.ini]] - configuration samples for customisations you store in [[strings.ini]]
* [[Cumulus.ini]] - comprehensive guide to settings and configuration file


REFERENCE PAGES (FOR EVERYONE):
= Introduction =
* [[MX_on_Linux|MX on Linux]] - MX is really easy to install, and run, on any simple computer running any UNIX derivative
This Wiki article was originally exactly what Steve Loft said in the [https://cumulus.hosiene.co.uk/viewforum.php?f=39 support forum] when he first started experimenting with Cumulus MX and access was restricted to those willing to experiment with his tests.
* [[MX_on_Windows_OS|MX on Windows Op Sys]] - you can install MX on a Windows PC, or laptop
* [[Updating MX to new version|How to upgrade to new MX release]] - comprehensive guide
* [[MX Administrative Interface|The Interface]]- all about the pages used for settings, correcting log files, and viewing your weather derivatives locally
* [[:Category:Ini Files]] for all pages that deal with the files storing highs and lows
* [[:Category:MX txt Files]] for all pages that deal with the files logging your Cumulus data
* [[Weather Diary]] for information about the diary feature
* [[Recent history]] for information about database storing minute by minute data for rolling 7 days


SPECIALIST GUIDES (NOT FOR NOVICES):
At that stage, Cumulus 1 was still recommended for most users, and MX had limited functionality. Now with lots more functionality in MX, it is what most users will select, but whether you have used Cumulus 1 in the past, or are new to Cumulus, there are no instructions built into the package, and it is hoped that the update of this article will help people to understand MX sufficiently to use it usefully.
* [[:Category:JSON Files]] for all pages dealing with files used to get data to your web site
* [[Webtags/Parameters]] - see this page if you want to vary how data appears on web pages
* [[Cumulus_MX_Local_API|MX application programming local interface]] - the developer explains how data is made available for local interfaces
* [[MX Basic info]] - contains details like the library functions used by MX, and how the end of day process works.
* [[Cs Code Modules]] - quick guide to the components compiled up to make the MX executable


PAGES THAT WERE CREATED FOR MX BETA:
== Restrictions on who can use MX ==
These were created in a rush when there was a threat that the support forum would close, they need a willing contributor to sort them into useful pages:
=== Message from Steve Loft ===
* [[MX Issues]] Detailed known issues with 3.0.0 beta releases
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.'''
* [[Cumulus MX FAQ]] Was intended to be quick reference answers to frequent questions

''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.''

== Documentation for MX ==
=== Message from Steve Loft ===
There's quite a lot to read before you start - please do read all of 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|Frequently Asked Questions for Cumulus 1]], [[Cumulus MX FAQ|Frequently asked questions for MX]], and articles elsewhere in this 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. Before you read this article any further, read [[About Cumulus|the article that introduces Cumulus]] first, then you will be linked back to this page.
=== Update ===
If this page, and those other Wiki pages it links to (e.g. a new Cumulus FAQ), do not answer all your questions then see [https://cumulus.hosiene.co.uk/viewforum.php?f=40 the support forum for current Cumulus MX] as that will let you see what other people have asked about, as well as giving you the opportunity to post your own query.

== Comparing Cumulus 1 and MX ==
Cumulus MX aims to be as compatible with Cumulus 1 as possible with 2 exceptions:
* Like Cumulus 2, MX separates the engine (reads weather station, calculates derivatives, creates web server for user interface, and sends updates to various external web sites) from the user interface (displays basic information, allows you to vary settings, contains editors for highs and lows and for log files).
* Like Cumulus 2, MX runs on Linux and OS X as well as (like Cumulus 1) Windows.
=== Features and functionality ===
Initially MX, as written by Steve Loft, [https://cumulus.hosiene.co.uk/viewtopic.php?f=27&t=13298#p104138 lacked a lot of features] that were available in Cumulus 1, but subsequent 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. All quotes are from the release notes issued by Steve or Mark. Only changes to functionality are noted below (for fixes see support forum for full release announcements).
*build 3023 - you can now control the output format of <#tomorrowdaylength> using an entry in '''strings.ini''' like this example:
<pre>[Solar]
MoreDaylightTomorrow=Il y aura {0} minutes {1} secondes plus la lumière du jour demain
LessDaylightTomorrow=Il y aura {0} minutes {1} secondes moins la lumière du jour demain</pre>
*Build 3025 - new MySQL (6 options) and custom HTTP uploads (can invoke a PHP script) facilities
** Also introduces a second pass to read archive records in catch up '''for Davis stations only'''
**Debug logging, diagnostic data logging, and ftp logging can now be set in the UI
** Changes for reading from Fine Offset and Davis station
**Improved console messages at start up to indicate whether station has been connected successfully
**Make sure dayfile.txt entry is always logged to diags in case of problems writing file
**'Stop second instance' option now implemented
**Graph periods can now be configured

*build 3035 - archives the [[month.ini]] and [[year.ini]] file at the end of the month/year as monthYYYYMM.ini and yearYYYY.ini.
*Build 3041 - Support for FTP over SSL/TLS (FTPS) - enable in Internet Settings
*build 3046 -added [[Weather_Diary|weather diary]] database (Note the MX diary file is different to the Cumulus 1 diary file).
*build 3047 - Web token parser updated to cope with html tag characters "<>" in the format string (see [[Webtags#Using_HTML_tags_within_format_parameters_.28MX_only.29|web tag page]]).
*build 3049 - This build enables ability to upload data to Windy.com.
*Version 3.1.1 - This release is mainly part of my attempts to add some of the Cumulus 1 features that are missing from CMX.
** build 3054 - Adds a Current Conditions editor and an All Time Records editor to admin interface
** Build 3056 - Fix for the All Time Records editor
* Version 3.2.5 - adds editors for files that track extremes previously missing from MX
**Build 3061 - that completes all the missing record editors from Cumulus 1
*Version 3.4.0 - The big change for this release is adding historic data "catch-up" for Davis WeatherLink Live devices.
**Build 3064 - fixes bug in Monthly Records editor for dry/wet periods.
*Version 3.4.5 - This release continues attempts to add some of the Cumulus 1 features that are missing from CMX.
** Build 3069 - Adds Editors for: Dayfile, Monthly Logs, Extra Logs

=== Accessing user interface ===
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 '192.168.y.z' (where y and z are numbers that vary between implementations) if the browser is on a different machine OR if "localhost" is already in use for another web server. For security reasons, the user interface should not be accessible via the public internet.

=== Operating Systems ===
MX runs on:
* Microsoft Windows operating system (Cumulus 1 only runs on this)
**To run MX on Windows, you need '''.NET''' installed which is included on Windows 7 upwards.
* Unix derivatives Linux and Mac OS X.
**To run MX on the additional platforms, it requires the '''Mono''' runtime, and you will need to install this

=== Configuration and Log 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 ''may'' need to edit to use Cumulus 1 files with MX. Both Cumulus 1 and Cumulus MX supply a number of ''templates that are processed into web pages'', although the end produce web pages are identical, '''the templates are not interchangeable'''. However, there are files that Cumulus 1 uses (for example it uses several image files and a weather diary in a XML file) that are not used by MX and also many files that MX creates (for example json files) that were not part of Cumulus 1.

= Installing and Running Cumulus MX =

There is no automatic installer (this may change). Cumulus MX is supplied as a zipped package on a link from [[software|download page]].

When running Cumulus MX, you either have a package that runs it for you, or you type '''CumulusMX.exe''' in your command type interface (or click a shortcut). You can however add parameters to the run instruction e.g. '''CumulusMX.exe -lang en-GB''' (to select the GB locale), '''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''', '''CumulusMX.exe -port 8002''' (to change the port where the user interface runs), or '''CumulusMX.exe -debug''' (to have full debugging turned on as MX starts), '''CumulusMX.exe -Logging=1''' (for the Davis specific logging). Try '''start /min C:\Cumulus\CumulusMX.exe''' to run MX as a minimised package.

== Requirements for running on Windows ==

To run MX on Windows, you need .Net version of at least 4.5.2 installed. This is only available for Vista SP2, Windows 7 SP1, Windows 8, Windows 8.1.

For Windows 10 you need version 4.8 or later, this should already be installed by your windows update feature. The .Net download for version 4.8 should be here https://dotnet.microsoft.com/download/dotnet-framework/net48 .

You can run MX as administrator, but you don't need to if you run this MSDOS command in a Command Prompt window opened with Administrator rights that will grant all users the right to bind to port 8998 -
netsh http add urlacl url=http://*:8998/ user=\users
After you have done this you can run CumulusMX.exe normally without Administrator rights and therefore you can create a short-cut to run MX when your PC starts (put your user name where I have put ...), the shortcut should point to T:\CumulusMX\CumulusMX.exe (where T denotes the drive on which you have installed MX as it does not need to be the same as where your operating system is):
C:\Users\...\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup\CumulusMX.exe
With this you might want to right click on that shortcut, select properties, then you can set the starting position for the command window, the colours and font it will use, and even choose to start minimised, amongst many other selections.

Look at your hub or router (this should have come with instructions on how to do this in your browser) and on one screen it should show what devices are connected to your LAN and wifi. Look for the IPv4 address (w.x.y.z) of the device you have installed MX on, for example 192.168.1.64. Then give your Computer a fixed address for MX user interface by finding the network card via Network and Sharing Centre (Control Panel), click on Change Adapter Settings, then Right click on Ethernet or WiFi Adapter, select Properties and in the window that opens right click on Internet Protocol Version 4 (TCP/IP 4), and select properties and on that pop up screen tell the computer to "use the following IP address and fill it out with a subnet mask of 255.255.255.0 and gateway address between 192.168.1.1 and 192.168.1.254 (depending on the address of your hub/router).

== Requirements for running on Linux and OS X ==

You will need to install the Mono runtime.
* 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.
**For example, in 'Raspbian' on the Raspberry Pi, you can install mono with these commands:
<pre>
sudo apt-get update
sudo apt-get install mono-complete
</pre>
Make sure that you have the mono-complete package installed.

**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.

== Completely new MX installation ==

Create a new directory (recommended name CumulusMX) and unzip the contents of the download package into it.

== Changing from Cumulus 1 to MX ==
# Two alternatives
#*Just create a new directory (recommended name CumulusMX) and unzip the contents into it. Then copy over your existing data files and your [[Cumulus.ini]] file, and any other configuration files that you may have created (e.g. strings.ini, twitter.txt etc). In this case you will need to edit that copied across "Cumulus.ini" so any lines that referenced the old folder are changed to reference the new folder, and you may need to edit a few other items either now, or via the settings functionality in MX user interface. The big advantage of this approach is that anytime you are not running MX you can go back to Cumulus 1 and let it run from where it left off (subject to availability of past data in your weather station).
#* Alternatively, to run Cumulus MX with your existing Cumulus data, take a back up copy of your existing Cumulus directory, and then unzip Cumulus MX into the original Cumulus folder. This saves you from the need to edit any reference to folders, but stops you going back easily to Cumulus 1 if you have an issue.
#If your "Cumulus.ini" was actually called "cumulus.ini" you should rename it to start with a capital letter.
#See pages already referenced for how to edit your '''.ini''' files to work with MX.

== What I did to Install MX ==
I have used Cumulus 1 for a decade or so, and been very happy with it, but I wanted to give MX a go without affecting my Cumulus 1 installation. Here is exactly what I did on my ex NHS Windows 10 Pro PC, step by step; I am hoping it might help some readers.
=== Download and unzip ===
#I downloaded the '''CumulusMXDist3069''' zip from [[Software#Current_Release|the Current Release section]] on the downloads page. N.B. 3069 is no longer latest distribution, but the link will give you latest.
#I unzipped the contents (on my Windows PC) into a partition I use just for software downloads
#I used a package that verifies the files it copies to duplicate the folder '''CumuluxMX''' onto the drive where I run Cumulus. I then noticed that the package contained some very obsolete copies of some external packages:
#*As downloaded, the MX package contained obsolete vintage version 2.1.4 (2015-03-10) of Highstocks and Highcharts, so I downloaded latest versions from [https://www.highcharts.com/blog/download/ the Highstock link] on this page. I then created a new folder obsolete at "\CumulusMX\interface\lib\highstock\js", moved the folders "modules" and "themes" that were there in my new folder, and the various highstock and highchart files that were there were moved into the obsolete folder. Now I navigated to the code folder within that download, copied the files within it to "\CumulusMX\interface\lib\highstock\js" and then copied the folders "modules" and "themes" from that code download folder into the same location. So now (in March 2020) everything is related to version 8.04 released 10 March 2020. This matches the version I use with my web pages on my web server.
#*As downloaded, "\CumulusMX\webfiles\lib\jquery" contained jQuery version 1.9.1, that is 2014 vintage and very obsolete, I already have the latest jQuery on my web server, so I did not need to put that new version into this webfiles\lib location, I just noted that this new path meant I ''may'' have to make some change on my web server later. If you do want to use a newer version of jQuery on your web site, you can download latest compressed production version from [https://jquery.com/download/ jQuery web site]. I prefixed the version in the MX package with the word OBSOLETE (OBSOLETEjquery-latest.min.js), you will find the latest version you download is called '''jquery-3.4.1.min.js'''. If you are using MX web pages, rename the new jQuery to "jquery-latest.min.js" to match the name that MX uses.
#* Other parts of the interface also had old versions of library software, but (because the interface uses json files to drive content of the various screens) I had no guarantee that its screens would work with later versions of the following libraries:
#** "\CumulusMX\interface\lib\jquery" contained the same old jQuery version 1.9.1, that is 2014 vintage and very obsolete, whether you update that or not is your choice, but there is no guarantee that the MX user interface will work fully with latest jQuery version.
#* "\CumulusMX\interface\lib\alpaca" included "alpaca" old version 1.1.3, the latest I found [http://www.alpacajs.org on the alpaca home page] was version: 1.5.27 released on 14 May 2019, again there is no guarantee that the MX user interface will work fully with these new versions.

=== Copying Cumulus 1 files into MX folder ===
The locale I used for Cumulus 1 is going to be the same I will use for MX (same PC!) so my copying across of my existing files should be fairly easy:
#First, I copied my '''\Cumulus\strings.ini''' to '''\CumulusMX\strings.ini'''. This preserves any tailoring I have done of terminology.
#Next, I copied my existing Cumulus 1 alarm sounds in "\Cumulus" across to MX folder "\CumulusMX\interface\sounds" as these were referenced in my main Cumulus.ini file.
# I copy '''\Cumulus\Cumulus1.ini''' to ''\CumulusMX'' folder as "Cumulus.ini". I then edit the MX "Cumulus.ini" file:
#* In the '''[Alarms]''' section (your Cumulus.ini may have sections in a different order to mine) I edit all the parameter lines where the attribute ends in "File" to reflect their MX location in the sounds folder (there is no such folder in Cumulus 1).
#*In the "'''[FTP site]'''" section (yes, mine was named correctly with second word all lowercase), I had a number of edits to make:
#*# I change any references to any web pages within "Cumulus" folder to say within "CumulusMX" folder. The approach I am taking is to continue to use my customised web pages, but I am editing the template files as required to cope with differences in the output parameters of [[Webtags#Output_.28format_modifier.29_parameters_for_times_and_dates|MX web tags]].
#*# Next where I want a transfer done only at end of day, I have added lines like "ExtraEOD19=1" and changed the previous "ExtraRealtime19=1" to "ExtraRealtime19=0" (I previously used realtime as that was only way in Cumulus 1 to ensure a template file was processed so it held correct values as close to end of day as possible, but it inefficiently also made huge numbers of unwanted transfers during the day). I had 9 such files being copied far too often, so those 9 changes will cause a huge reduction in processing load! ''I know I could do this later using the MX interface, but it makes sense to me to do it as I am working through the file.''
#*# I have a few files that are PHP scripts, or web pages, listed in this section, all written as Cumulus templates; each PHP script has a number of PHP variables being set equal to a Cumulus web tag while the web page templates embed a lot of Cumulus web tags. In some cases the web tags have date/time output format parameters, for these I had previously edited any ""hh" into "HH", any "mm" into "MM", any "mmm" into "MMM" and any "mmmm" into "MMMM" in line with the recommendations that I had some years ago typed into [[Webtags#List_of_allowed_modifiers|this table]] for Cumulus 1. That left "nn" for minutes in Cumulus 1 where I could only change it to a MX equivalent "mm" in those cases where Cumulus 1 would have not taken it as month, I was too lazy to check every individual cases (I prefer to use global edits across all my files). So now I created a new version of each PHP script that used "nn", changed it in each new script to "mm" and changed each reference in the MX '''Cumulus.ini''' to the old files to refer to the new files. Subsequently I realised all my "am/pm" references had to be changed to "tt" so I edited my new files again. There were other changes I had to make, in Cumulus 1 you can use tags like 'H' and 'M' on their own, in MX a single modifier on its own often means something different to when that modifier appears with other modifers. Yes quite a lot of work here, despite being able to use the Search ... Replace option in Notepad++. As a result I have done some edits to [[Webtags#List_of_allowed_modifiers|this table]] hopefully making life simpler for the next person faced with this.
#*# I mentioned some of my web pages are generated from my own Cumulus templates. Despite now having Cumulus 1 and Cumulus MX templates with different names, these still both generate web pages given the same names, so I don't need to alter any navigation between pages on my web server.
#*In the "'''[NOAA]'''" section I had '''MonthFileFormat="NOAAMO"MMMyyyy".txt"''' on a line, I checked at [[Webtags#List_of_allowed_modifiers|List of allowed date/time modifiers]] that 'MMM' and 'yyyy' were valid in Cumulus MX as well as in Cumulus 1, they were so no edit needed either to that line or to "YearFileFormat="NOAAYR"yyyy".txt" line.
#The file "\CumulusMX\Reports\.gitignore" is joined in the '''\CumulusMX\Reports''' folder by copying in what I currently have in "\Cumulus\Reports". These are another "Cumulus.ini" (I am certain this is not used, but I am playing safe by coping it in) and the existing monthly and annual NOAA reports. I don't need to change those file names as I will continue to use the same format (see change to main Cumulus.ini mentioned above).
#Next I compare "\Cumulus\web" with "\CumulusMX\web", I notice the subfolder "images" has gone, I expected that from what I already know about MX and its use of Highcharts instead of uploading weather time-series graphs (and the moon image). Also "realtimegaugesT.txt" is only in MX, I expected that knowing the gauges pages supplied with Cumulus 1 and MX are different. I mostly use my own web pages, so I don't worry about the template files.
# Next I see there is a "MXdiags" folder, so I don't copy across the Cumulus 1 "diags" folder. Equally I don't change anything in the new MX "webfiles" folder, but I do copy across to my web server the "cumuluscharts.js" and "logoSmall.png" files I see there that I have not seen before.
# So left to last is the "data" folder:
#* I have copied all files from "\Cumulus\data" to "\CumulusMX\data" (except '''log.xml''' as MX uses a different file), and will see what edits I need to make later. Some of my '''.ini''' contain date-time entries like "12/03/2019 14:50:45".

=== Almost "Ready to run" ===
# I find after running the CumulusMX engine, that it edits those '''.ini''' files it needs to, and the new versions contain date-time entries in the "2019-03-16T12:45:00" style, but despite what I picked up from reading on the forum, you '''don't''' need to edit beforehand these entries in log files like '''month.ini''' as Cumulus MX can read the old ones.
# I right clicked on the "CumulusMX.exe" entry in the top level folder and selected '''Send to ... desktop (create shortcut) '''. On the same right click menu I also selected '''Pin to taskbar'''. [When I am happy with MX, I can copy the shortcut into '''C:\Users\Personal\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup\''' and then MX will start automatically after I (or Windows Update) reboot my PC].
# I clicked on one of my new shortcuts. '''Windows Defender''' popped up, so I told it '''allow all''' for Cumulus MX.
# I opened my Internet Security premium package, in the "unrecognised files" section I selected CumulusMX.exe then right clicked and selected '''Change File Rating to Trusted''' (I will need to repeat this every time a new version is installed) and in the "Firewall" section of the Internet Security package I added port '''8998''' as one that was permitted.
# I right clicked on my desktop (you may need to right click ''on the windows symbol at bottom left''), selected '''command prompt as administrator''' that opened a command window where I typed
netsh http add urlacl url=http://*:8998/ user=\users
to allow all users to bind to port 8998 (i.e. that used for the Cumulus interface). This also means you don't have to run the engine (CumulusMX.exe) in an administrator user, nor select "Run as administrator" from right click menu on the shortcut.
Finally, I viewed my hub (router) to see the IPv4 address allocated to my Cumulus MX computer (192.168.1.64), that told me that I would find the user interface by typing "http://192.168.1.64:8998/" into my browser while the MX engine command window remains open (so MX is actually running), so I typed that and I saw the user interface and navigated around it.

IMPORTANT NOTE: I don't use "localhost:8998" for two reasons, first I already have a web server on my PC at IPv4 "127.0.0.1"
using "localhost" as an alternative name (and port 81), and second using the IPv4 exact "http://192.168.1.64:8998/" address as a bookmark, I can view the Cumulus user interface on my mobile phone which shares bookmarks with my PC and connects to my LAN via wifi.

When I am happy to stop using MX, I type '''Control + C''' into that MX command window on my PC and MX closes.

One more lesson, you cannot have Cumulus 1 and Cumulus MX running at same time, accessing same weather station. If you sometimes run one flavour (say MX) and sometimes the other (Cumulus 1), you must copy all the updated log files from the ''just used'' data folder to the data folder you are ''about to use'' when you close one favour before you start the other flavour, or you must have both executables in same top level folder to force them to share the data folder. If you don't do either of those alternatives, various derivatives (e.g. Chill Hours) will become wrong and you may have conflicting rows in dayfile.txt (because its content is generated from what that flavour saw when it was running the previous day) and generally this will be particularly evident in any weather parameter that varies a lot like wind vector. It also affects any that rely on averaging (temperature, wind run, rain rate) as these are calculated biased towards the actual times when that flavour of Cumulus was actually running, so you can have issues if you run the 2 flavours in different folders/devices as if the other does not exist.

I have some batch scripts that Cumulus initiates, and a number of Cumulus templates, and in my case I had to be happy these were working before I stopped using Cumulus 1, and got MX as the flavour that auto-started on switching on my PC.

=== Success ===
My installation of Cumulus MX has succeeded, and as the experiment did help me find a mistake in one of my Cumulus templates where I had not defined input parameters for "Recent History", it has been useful. I am continuing to use Cumulus 1 for the moment, until I am absolutely sure MX can do everything I want. I believe it will do some tasks better, but there is a lot more to learn about how to use it.
== Editing the User Interface ==
You need some understanding of Hyper-Text Markup Language to do this correctly, but here are simple examples.

Remember, if you decide to download a new release to not overwrite any file(s) that you have edited, or your edit will be lost. It is less likely that a new release will change the interface files than other files, but each release zip contains all MX files, even those not changed since previous release. The release notice will usually give some idea of whether interface files have changed.
=== Removing Solar Figures ===
If your weather station does not have solar instrumentation you might wish to remove some of the display elements that relate to that.
# Navigate to '''\CumulusMX\interface''' folder.
# Open the file '''now.html''' in an editor designed for code (e.g. Notepad++ for Windows)
# Near the bottom of the file edit it by inserting HTML comment delimiters (opening after &lt;/thead>, closing before &lt;/table>) so it looks like this:
<pre><table id="SolarTable" style="width:100%">
<thead>
<tr>
<th>&nbsp;Solar</th>
<th></th>
<th></th>
</tr>
</thead>
<!--
<tr>
<td>Solar Radiation</td>
<td><span id="SolarRad">--</span></td>
<td>W/m<sup>2</sup></td>
</tr>
<tr>
<td>Sunshine Today</td>
<td><span id="SunshineHours">--</span></td>
<td>hrs</td>
</tr>
<tr>
<td>UV</td>
<td><span id="UVindex">--</span></td>
<td></td>
</tr>
-->
</table> </pre>
IMPORTANT NOTES:
#This works on "now.html", but does not work on other pages where table rows are dynamically created by an external script, so the existing rows in the table body are dummies whose content is ignored. An alternative technique is to delete the whole table and any "&lt;div> .. &lt;/div>" that surrounds only that table, that will work on all the HTML pages.
#In general it is not a good idea to vary any code provided as part of the package as it will be overwritten if you install a new release distribution over it. What I do, and suggest you do is to maintain a back-up copy of the original elsewhere (so it can be gone back to) and I also save my edited file under a new name (so I can't lose my edited file by installing a new release).

=== Adding derivatives not shown on the existing interface page ===
It is a JavaScript file '''\CumulusMX\interface\js\dashboard.js''' that reads the real-time file and inserts particular content into position indicated by values of the HTML attribute "id" on the interface screens. The standard '''\CumulusMX\interface\now.html''' does not include temperature trend for example, but because there is a '''temptrend: inp.TempTrend.toString()''' defined in the JavaScript file, you can easily add it to the "now" page by a simple insert of the middle row here:
<pre><tr>
<td>Outdoor Temperature</td>
<td><span id="OutdoorTemp">--</span></td>
<td><span class="TempUnit">--</span></td>
</tr>
<tr>
<td>Trend</td>
<td><span id="TempTrend">--</span></td>
<td><span class="TempUnit">--</span>&nbsp;hour<sup>-1</sup></td>
</tr>
<tr>
<td>Dew Point</td>
<td><span id="OutdoorDewpoint">--</span></td>
<td><span class="TempUnit">--</span></td>
</tr></pre>
You can't add any derivatives into any table unless the value (for the derivative you want to add) is already defined in the related files.

There is a section of the support forum devoted to [https://cumulus.hosiene.co.uk/viewforum.php?f=28 Cumulus MX interface customisation], so you can see what other people are doing. There is also [https://cumulus.hosiene.co.uk/viewforum.php?f=36 another sub-forum] for making suggestions on what you would like added to MX.

=== Changing Look ===
You need some understanding of Cascading Style Sheets (CSS) to do this, but all you need to do is to edit the relevant style sheet in '''\CumulusMX\interface\css'''.

== Changing Settings ==
This is done using the MX "user interface", you will see that '''Settings''' is the penultimate option in the navigation bar, and it has a drop down for the various settings screens that are now described.

=== Station Settings ===
Each setting has a hint beside it (with a small 'i' for information before each hint). If you have used [[Cumulus_Screenshots#Station|Cumulus 1]], the layout and section headings will be familiar. Like all the settings pages, the headings are collapsed and need to be clicked to see the items under them. The table [[Cumulus.ini#Section:_Station|here]] will explain how MX stores the selections you make here, and give a bit more detail about each item and the values it can take.

=== Internet Settings ===
This has a lot of similarities with the [[Cumulus_Screenshots#Sites.2FOptions_Tab|Cumulus 1 settings]]. Again there are hints, MX has more options than Cumulus 1 had, and some defaults are different in the two flavours.

=== Extra Web Files ===
This is an extension of the Cumulus 1 facility, that is explained for both Cumulus flavours [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|here]], it has an extra "end of day" option (leave "realtime" column blank if you tick the new column), but otherwise you fill it out exactly the same way. If you have moved from Cumulus 1, you might need to:
# change some paths in local column
# edit some templates where the process column is ticked because of [[Webtags|Web tags differences]].

=== Calibration settings ===
This is identical to [[Cumulus_Screenshots#Calibration|Cumulus 1]] functionality, already explained elsewhere in this wiki.

=== NOAA report settings ===
This is identical to Cumulus 1 functionality, already explained [[Cumulus.ini#Section:_NOAA|elsewhere]] in this wiki.

=== MySQL settings ===
This is new. <big>THIS SECTION NEEDS TO BE WRITTEN - WILL YOU VOLUNTEER ???</big>

=== Alarms ===
This is identical to Cumulus 1 functionality, apart from using a new default location for the files "\CumulusMX\interface\sounds", already explained [[Cumulus.ini#Section:_Alarms|elsewhere]] in this wiki.

=== FTP Now ===
This is similar to the option in Cumulus 1 to do an update now.

= Updating to a new MX release =
It is always best to take a backup of your existing MX installation before you do an update, this allows you to regress back to the earlier version if you mess up installing the new version.

Follow the instructions for installing, you download the zip, and copy it over the existing components in your MX folder.

If you have edited any files, see if the release notice says that file has been revised, if it has not then keep your edited file by not copying in the file within the zip. If the release revises a file you previously edited, take a backup of your edited file, before you copy the new file into your folder. You can then use a file comparing tool to see what has changed in the release and what you changed and hopefully manage to merge to a new file. This includes any web pages you might have edited to give the look you desire, or the content you want (e.g. adding rain this month to this month page, or combining this month and this year page).

= Running Cumulus MX =
#Make sure your station is connected to the device on which you have installed Cumulus MX, before you try to run Cumulus MX.
# Start Cumulus MX engine (command to do this varies between operating systems, so see sub-heading for you device below
# Start user interface

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.

== Windows ==
Cumulus MX initiates a web server, to do this it may need administrative access, consequently to avoid having to run it as an administrator you can issue a command that allows all users to bind to port 8998 (used for the Cumulus interface). Note that if you change the interface port as described below, you should change the 8998 to whatever port you are using. To enter the command, first open a command window as administrator. One way to do this is to right click the windows symbol at the start of the windows task bar. The option to choose there (on windows 10) is '''Windows PowerShell (admin)''', but an option called '''Command Prompt (Administrator)''' will also work. Once that opens a new window type:
<pre>
netsh http add urlacl url=http://*:8998/ user=\users
</pre>

You only need to do that once.

#Each time you want to run Cumulus:
#*Open the folder where you installed MX and click on the CumulusMX.exe to run it. (There are some optional parameters that can be used)
#* OR create a shortcut on your desktop (and/or the taskbar) for that executable and click the shortcut to start the engine.
#* OR place the shortcut in the start up folder for the user account so MX automatically starts when you connect/log in.
# Start the user interface, 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 has to be entered every time you start MX).

== Linux and OS X ==
Open a terminal window, change to the Cumulus MX directory, and then type:
<pre>sudo mono CumulusMX.exe</pre>
=== 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 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, type:
<pre>
sudo mono CumulusMX.exe -lang en-GB
</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"). 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.

= User Interface =
Type the URL which is displayed (when MX starts running) into your browser (replace the * with the IP address, or use 'localhost') and the interface should appear. If this is a 'clean' installation, the first thing you will need to do is to go to the '''settings''' and set the station type and units, and any other configuration settings you want to make. Having set the station type, you will need stop Cumulus MX and start it again. Note that this also applies to '''some''' other settings - you ''may'' need to restart Cumulus MX to get the new setting picked up.

As with Cumulus 1, if there are any settings which are not currently available via the user interface, you can change them by stopping Cumulus and editing [[Cumulus.ini]]. Follow that link to see what you can add in that file, and (if you are swapping from Cumulus 1 to MX) how that file varies between Cumulus flavours.
= Operating a web site =
*If you want to operate the 'standard' web site, then just the same as with Cumulus 1, you will need to upload the contents of the '''webfiles''' folder from the zip file (don't upload the containing webfiles folder itself).
*Note that the MX web files are not the same as the ones for Cumulus 1, so make sure you upload the MX files if moving from Cumulus 1 to MX.
*The standard gauges are now the SteelSeries gauges.

= SPECIAL CONSIDERATIONS - Text by Steve Loft =
== Restrictions in MX for decimal separators ==
On the subject of decimal and list separators, there are a couple of issues which users of decimal commas may encounter.
#The first is that there may be an issue with some of the user interface not working correctly. Please report these issues and I will fix them. There may be aspects of the displays that I cannot change (because the package used does not support decimal commas) but it should be possible to at least get it working.
#The second issue with decimal separators only affects the Raspberry Pi (as far as I am aware). There is apparently an issue with the current version (3.2.8) of the Mono package on Raspbian 'hard float' where it cannot parse values using decimal commas. If this does turn out to be an issue, there are a number of possible workarounds until the Raspbian package gets updated. One workaround is to use the 'soft float' version of Debian instead. Obviously, this will have performance issues, but is probably the easiest. The second workaround is to build Mono from the latest sources, see http://www.mono-project.com/docs/compiling-mono/linux/. I am told that this fixes the problem. Another possible workaround would be to find an already fixed binary package, but I don't know if one currently exists.

== If you want to use your Cumulus 1 data with MX ==
If you use decimal commas in your Cumulus 1 data, you will need to edit the .ini files to change the decimal commas into periods/full stops, because '''Cumulus MX always expects periods/full stops in .ini files''' ''regardless of the locale in use''. The other data files will be OK - assuming you are using the same decimal and list separators in MX as you used in Cumulus 1 (i.e. the same locale). If you try to switch to a different locale, then your data log files will of course no longer be in the correct format, so you would need to edit all of your files.

== A note to Davis owners ==
I am experimenting with the use of the LOOP2 packet. The current code uses this for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed (although hopefully this will not be such an issue with Cumulus MX as it does not use the Davis DLL), and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.

The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue. If you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet. In these cases, you should edit cumulus.ini and add a line to the [Station] section:

UseDavisLoop2=0

With this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.

Also for Davis stations, I have assumed that people using millimetres in Cumulus have a metric rain gauge (0.2 mm per tip), and those using inches have a 0.01" rain gauge. This can be over-ridden by adding a line to the [Station] section of Cumulus.ini:

VPrainGaugeType=0

or

VPrainGaugeType=1

Where 0 is a 0.2mm gauge and 1 is a 0.01" gauge. Note that changing this after MX has already read some data may cause your rainfall reading for today etc to change considerably, so you will need to correct that.

= Web Tags and related features =
Almost all of the [[Webtags|web tags]] from Cumulus 1 are supported in Cumulus MX.

== Beta builds of MX ==
The following web tags were not available or worked differently:
*The individual 'record set' tags such as <#TempRecordSet> etc did not work (because the interface then had no indicators for new records).
*The <#newrecord> tag does work, but works differently, it turns itself off automatically after 24 hours.
*Some of the 'system status' web tags do not work: <#CpuName>, <#MemoryStatus>, <#DisplayMode>, <#DiskSize> and <#DiskFree>
*The <#txbattery> web tag has no content currently. Using it with a 'channel' parameter causes a 'token error'.
*The snow tags were not available as there was no '''Weather Diary'''

== Current builds of MX ==
The web tags you have depend on which build you are using:

From Build 3046
* added <#snowdepth> tag processing
* added '''diary.db''' file

From build 3047
* Web token parser updated to cope with html tag characters "<>" in the format string e.g. <#TapptempH format="dd'&nbsp;'MMM'&nbsp;'yyyy'<span class=\'xx\'> at 'HH:mm'</span>'">
*All record Value tags should now return '---' and Date tags '----' until they are first set.
*<#MoonAge>, <#MoonPercent>, <#MoonPercentAbs> - all given new 'dp' and 'rc' parameters.

From Version 3.1.1 - b3054
*Adds new web tags <#snowlying>, <#snowfalling>, both provide 1|0 responses

From build 3056 of version 3.2.0 (19 November 2019):
* Enables alarms as per Cumulus 1
**New Alarm page under Settings
**Alarms are shown visually on the dashboard
**Due to browser restrictions, alarm sounds on the browser page may require you to click a button on the first alarm in order to hear it.
***You can add the MX admin site to your browsers list of sites allowed to play sound automatically. Your browser should "learn" that you want to allow sounds to play automatically.
*** Alarm sound files should be placed in the /interface/sounds folder, they must be a browser compatible format (mp3 are good). The alarm settings for the sound file should be just the filename without any path
*Lots of new web tags not available in Cumulus 1, see release announcement for details

From Version 3.2.2 - build 3058
*Implements the missing <#txbattery> web tag

== All builds of MX ==
The ''''format' parameter''' on the date/time web tags is unfortunately different, because many of the characters used are different.

Note that this also applies to the '''NOAA report file formats'''.

For full details see the [[Webtags#Differences_between_Cumulus_1_and_Cumulus_MX_.28Cumulus_3.29:|web tags]] article.

= [[Cumulus MX FAQ]] =
The [[FAQ]] page that was originally written for Cumulus 1 has now had some MX differences highlighted. A new FAQ for MX has been started at [[Cumulus_MX_FAQ|another page]].

MX specific questions, such as those related to installation are now covered by the updated text on this "Cumulus MX" page.

= [[MX Issues|Cumulus MX Known Issues]] =
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=27&t=12943#p101209 Steve Loft's post]

Latest revision as of 15:18, 10 January 2022

This category lists all the pages that are relevant to MX, so is a good starting point.

  • There are pages in this category for all folders and files, used by MX
  • If you contribute a new page, add it to this category by quoting [[Category:Cumulus MX]] on your new page.
  • How to migrate to MX - For those still using the original Cumulus software

SOME KEY INFORMATIVE PAGES (FOR NOVICES):

REFERENCE PAGES (FOR EVERYONE):

SPECIALIST GUIDES (NOT FOR NOVICES):

PAGES THAT WERE CREATED FOR MX BETA: These were created in a rush when there was a threat that the support forum would close, they need a willing contributor to sort them into useful pages:

  • MX Issues Detailed known issues with 3.0.0 beta releases
  • Cumulus MX FAQ Was intended to be quick reference answers to frequent questions

Subcategories

This category has the following 5 subcategories, out of 5 total.

F

I

J

M

Pages in category "Cumulus MX"

The following 72 pages are in this category, out of 72 total.

A

C

D

E

F

H

M

P

R

S

T

U

V

W

Y

Retrieved from "https://www.cumuluswiki.org/index.php?title=Category:Cumulus_MX&oldid=10149"