5,838
edits
Category:Cumulus MX: Difference between revisions
m
→Running Cumulus MX
m (→Introduction) |
|||
| Line 220: | Line 220: | ||
= Running Cumulus MX = | = 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 | |||
== Windows == | == 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> | <pre> | ||
netsh http add urlacl url=http://*:8998/ user=\users | netsh http add urlacl url=http://*:8998/ user=\users | ||
</pre> | </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 == | == Linux and OS X == | ||
Open a terminal window, change to the Cumulus MX directory, and then type: | Open a terminal window, change to the Cumulus MX directory, and then type: | ||
<pre>sudo mono CumulusMX.exe</pre> | |||
sudo mono CumulusMX.exe | === 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: | 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> | |||
sudo mono CumulusMX.exe -port 9999 | === 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: | 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> | <pre> | ||
| Line 252: | Line 250: | ||
</pre> | </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. | 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. | ||
=== Restrictions in MX for decimal separators | 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. | 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 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. | #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. | 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. | ||
| Line 279: | Line 288: | ||
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. | 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 web tags from Cumulus 1 are supported in Cumulus MX. | 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 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 individual 'record set' tags such as <#TempRecordSet> etc did not work (because the interface then had no indicators for new records). | ||
| Line 290: | Line 299: | ||
*The snow tags were not available as there was no '''Weather Diary''' | *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: | The web tags you have depend on which build you are using: | ||
| Line 317: | Line 326: | ||
*Implements the missing <#txbattery> web tag | *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. | The ''''format' parameter''' on the date/time web tags is unfortunately different, because many of the characters used are different. | ||