MX on Windows OS: Difference between revisions

If you are not running MX using the Microsoft Windows Operating System, then please see [[MX on Linux]] page instead.

= Requirements for running MX on Windows =

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 <code>netstat -an | findstr 8998</code> into the command window.

We need to run MX in order for it to generate a web server that will enable us to see the [[MX_Administrative_Interface|admin interface]] where we can change [[Cumulus.ini|settings]], view our weather data, or edit various [[:Category:Cumulus_Files|Cumulus files]] (extreme records or log files).   

There are two ways to run MX:

It is recommended that you run MX interactively to begin with, as this means you will see any messages it outputs, and can respond to those.  Once you are happy that MX is running smoothly, then run it as a service, as that will run in background, and you don't need to watch for messages.

{| class="wikitable" border="1"

!style="width:30px" | Step

!style="width:600px" | Interactively

| To run Cumulus MX, Windows needs to know

# which '''.exe''' you want to run (ExportToMySQL.exe, CalculateMissing.exe, or CumulusMX.exe)

Therefore it is best to always start MX using what Windows calls a '''shortcut''', because when creating the shortcut you can enter all the required information into the properties.   

#Create a shortcut on your desktop (and/or the taskbar) for the '''CumulusMX.exe''' executable <code>cmd.exe /C start CumulusMX C:\CumulusMX\CumulusMX.exe -debug</code>, the "-debug" is ''optional'', it starts the logging in debugging mode so the log created in MXDiags folder has more information. There are other optional parameters all listed later.

#*In that shortcut define the path where the executable is located as the path to start in.

#** all optional parameters are listed later

#**'''Start in''' <code>\CumulusMX</code> (include a drive specifier if necessary)

#* To add parameters to the service when it starts automatically you will have to edit the registry

#*# Right click the Windows button at left hand edge of taskbar (often at bottom of your screen)

#*# Select '''Modify'''

#*# You should see '''"C:\CumulusMX\CumulusMX.exe"'''

#*# Now you can add parameters as per [[#Optional_parameters_to_add_to_the_instruction_to_run_the_MX_engine]]

#*#* For example modify to ''' "C:\CumulusMX\CumulusMX.exe" -port 9000''' to add port

#*#* For example modify to ''' "C:\CumulusMX\CumulusMX.exe" -debug''' to add full debugging

# In your MX release distribution, navigate to '''CumulusMX\MXutils\windows'''.

# Find file '''CreateCmxResumeFromStandbyTask.ps1''' for resuming MX after Microsoft Windows has gone into standby.

# Type <code>CreateCmxResumeFromStandbyTask</code>, and press '''Enter''', this will create a Scheduled Task.  

#* The scheduled task will exist from now on, and will automatically restart the service (on resume from standby/hibernate).

|  # First '''start the MX engine''' using your shortcut (created in one of the 3 ways as above), if it has not started when you started your computer

# Next '''start the admin interface''', it does not need to run all the time, but only when you need it , 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]].

| There are two ways to start MX service:

* Either, use the Services applet:- services.msc (You can pass parameters using this tool, but they are not saved for future use)

| Simply look in the Command window or Powershell window or Terminal window you used to start MX and left open.

| You can use <code>sc query CumulusMX</code> at any time to check that the service is running.

|-

| If you have set up your short-cut in the '''Startup''' folder, you need to delete that short-cut (or move it to a sub-folder), to stop MX automatically starting when you restart your computer

| The recommended way is to click into the command window in which MX is running, ''hold down Control key'' and press '''C'''. It is normal for there to be a short wait, then a message "Cumulus Terminating" and then after another short wait, it will say "Cumulus Stopped" and immediately after that the command window  will be closed by MX.

|}

=Access to admin interface=

# Look at your hub or router (this should have come with instructions on how to access its settings in your browser) and on one screen it should show what devices are connected to your LAN and wifi.  

# Look for the IPv4 address, for example 192.168.1.64, it has assigned to the device where MX is running. That is what should replace the "*".   

However, there is one more complication, either the Windows networking settings may change, or else your hub or router may reconfigure, both can happen at any time, and both can assign a different IPv4 address to the device running MX.

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

=One-off essential settings=

So 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.  The settings you see may vary, depending on which MX release you have installed, so are not described here.  It is best to work through all the settings listed, as although some have defaults, you might want to vary them from default.

=One-off optional uploads=

The contents of that sub-folder may change when you upgrade MX, so this task might need to be repeated.

== webfiles sub-folder in releases from 3.10.1 onwards ==

You may find [[PHP|this wiki page]] useful for understanding more about the different script languages.