5,838
edits
Category:Cumulus MX: Difference between revisions
m
→Installing and Running Cumulus MX: paste
m (→Running Cumulus MX: cut) |
m (→Installing and Running Cumulus MX: paste) |
||
| Line 83: | Line 83: | ||
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. | 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. | ||
== Optional parameters to add to the instruction to run the MX engine == | |||
The debug switch has just been mentioned, here is more on others. | |||
=== 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. | |||
== Running Cumulus MX == | |||
# Make sure your weather station (and any extra sensors) 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 your device below | |||
# Start user 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. | |||
== Requirements for running on Windows == | == Requirements for running on Windows == | ||
| Line 88: | Line 109: | ||
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. | 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 . | 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. | ||
Cumulus MX initiates a web server, to do this it may need administrative access, consequently to avoid having to run MX as an administrator you can issue a command that allows all users to bind to port 8998 which is the web server it initiates (this is used for the Cumulus MX user interface). Note that if you plan to change the interface port by using the port parameter in your launch of MX, you should change the 8998 to whatever port you are planning on 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> | |||
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 | netsh http add urlacl url=http://*:8998/ user=\users | ||
</pre> | |||
You only need to do that once. After than you can initiate MX from any user, you don't need to run as administrator. | |||
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 is used here only to denote 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 | 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. | 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). | 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). | ||
'''Each time you want to run Cumulus:''' | |||
#First start the engine in one of the following 3 ways (there are some optional parameters that can be used with the .exe call as mentioned below): | |||
#*Open the folder where you installed MX and click on the CumulusMX.exe to run it. | |||
#* 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. | |||
# Next start the user 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). | |||
== Requirements for running on Linux and OS X == | == Requirements for running on Linux and OS X == | ||
| Line 110: | Line 144: | ||
Make sure that you have the mono-complete package installed. | Make sure that you have the mono-complete package installed. | ||
== To actually run MX == | |||
Open a terminal window, change to the Cumulus MX directory, and then type: | |||
<pre>sudo mono CumulusMX.exe</pre> | |||
Next start the user interface, basically same as described for Windows above. More information on user interface later. | |||
=== Notes by ExperiMentor (in Switzerland) === | === Notes by ExperiMentor (in Switzerland) === | ||
These comprehensive notes describe how to install Cumulus MX on a Pi Zero, using a PC to do some of the work: | These comprehensive notes describe how to install Cumulus MX on a Pi Zero, using a PC to do some of the work: | ||
'''Buy equipment''' | '''Buy equipment''' | ||