5,838
edits
MX on Windows OS: Difference between revisions
m
Minor resequencing of page
m (Making more consistent with "MX on Linux" for easier future maintenance) |
m (Minor resequencing of page) |
||
| Line 182: | Line 182: | ||
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. | 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. | ||
There are 3 ways on Windows to create a shortcut to run | There are 3 ways on Windows to create a shortcut to run the CumulusMX executable: | ||
#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. | #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. | #*In that shortcut define the path where the executable is located as the path to start in. | ||
| Line 260: | Line 260: | ||
* Or, use the service command line tool:- <code>sc stop CumulusMX</code> | * Or, use the service command line tool:- <code>sc stop CumulusMX</code> | ||
|} | |} | ||
= Optional parameters to add to the instruction to run the MX engine = | |||
As seen above, in Microsoft Windows, we leave off the file extension when we want to run one of the Cumulus executables, but we might need to add a parameter (starts with a minus symbol), and that parameter might need to be followed with a value. | |||
== Beta builds of MX == | |||
The following two parameters are not available since MX came out of 3.0.0 beta. | |||
=== -wsport parameter for web sockets === | |||
Beta builds in MX version 3.0.0 had an optional parameter <code>CumulusMX -wsport nnnn</code> that determined which port (represented by a 4 digit number ''nnnn'') was used for '''Web Sockets'''. | |||
That parameter [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887&p=138815&hilit=sockets#p138815 is now deprecated as Web Sockets in all builds since 3045] use the same port for web sockets as for the HTTP port of the [[MX_Administrative_Interface#The_API_interface|Admin Interface], see '''-port''' parameter below. | |||
=== -Logging parameter for debugging of data flow between station and MX=== | |||
Use '''CumulusMX -Logging=1''' (for the station to MX transfers to have increased debugging logging). | |||
Note use of this parameter is now deprecated. | |||
Although this is not mentioned in any release announcements, it appears that on all recent MX releases this effect is incorporated into the '''-debug''' parameter. Perhaps someone could confirm whether this is true. | |||
== -install parameter for installing as Windows Service== | |||
Use '''CumulusMX -install''' to install MX as a service. | |||
== -uninstall parameter for uninstalling the Windows Service== | |||
Use '''CumulusMX -uninstall''' to uninstall the service that runs MX. | |||
== -Port parameter for changing HTTP 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: | |||
:<code>CumulusMX -port 9999</code> | |||
== -debug parameter for adding debugging == | |||
MX has a default level of logging that stores in the [[MXdiags_folder]] folder a log file that shows minimal details of the interaction with the weather station and of the output actions done as MX runs. A new log is started each time MX is restarted, and when a log reaches a particular size, so the log cannot keep growing. | |||
If there is a problem, then there is a great benefit in actually increasing the level of detail in these logs; and that is done either within the settings (on recent MX releases this is on '''Program Settings''' page of admin interface - please see [[MXdiags_folder]] page for details) or by adding a parameter as you start running MX: | |||
:<code>CumulusMX -debug</code> | |||
=Access to admin interface= | =Access to admin interface= | ||
| Line 365: | Line 409: | ||
You may find [[PHP|this wiki page]] useful for understanding more about the different script languages. | You may find [[PHP|this wiki page]] useful for understanding more about the different script languages. | ||