MX on Windows OS: Difference between revisions

338 bytes removed ,  07:09, 25 July 2021
m
m (→‎Optional parameters to add to the instruction to run the MX engine: adding actual parameter names to sub-headings)
Line 339: Line 339:
The following two parameters are not available since MX came out of 3.0.0 beta.
The following two parameters are not available since MX came out of 3.0.0 beta.


=== web sockets ===
=== -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'''.  
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'''.  
Line 345: Line 345:
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.
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.


=== Debugging of data flow between station and MX===
=== -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).
Use '''CumulusMX -Logging=1''' (for the station to MX transfers to have increased debugging logging).
Line 353: Line 353:
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.
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.


==Parameter for installing as Windows Service==
== -install parameter for installing as Windows Service==


Use '''CumulusMX -install''' to install MX as a service.
Use '''CumulusMX -install''' to install MX as a service.


==Parameter for uninstalling the Windows Service==
== -uninstall parameter for uninstalling the Windows Service==


Use '''CumulusMX -uninstall''' to uninstall the service that runs MX.
Use '''CumulusMX -uninstall''' to uninstall the service that runs MX.


== Parameter for changing Port ==
== -Port parameter for changing HTTP Port ==


When Cumulus starts, it will display the URL of the user interface.  
When Cumulus starts, it will display the URL of the user interface.  
Line 368: Line 368:
:<code>CumulusMX -port 9999</code>
:<code>CumulusMX -port 9999</code>


== Parameter for adding debugging ==
== -debug parameter for adding debugging ==


MX has a default level of logging that stores in  the [[MXdiags_folder]] folder a log file that shows some of the interaction with the weather station and some of the output actions done as MX runs. A new log is started each time MX is restarted.
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:
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>
:<code>CumulusMX -debug</code>
Obviously this log file continues to grow, the longer MX is left running, and if debugging is switched on the file will grow in size must faster. Consequently, the default is not to add the extra debugging information and the settings can be used to switch it off again if you do have it switched on. Since this parameter is applied when you start MX, it applies while MX continues to run. Obviously, it must be applied every time you start MX if you want this increased level of logging to continue every time you restart MX.
5,838

edits