MX on Windows OS: Difference between revisions

41 bytes added ,  14:07, 19 August 2021
m
Line 267: Line 267:


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.
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==
== -install parameter for installing as Windows Service==


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


By default, MX's Microsoft Windows service is installed to run under the System account.  
By default, MX's Microsoft Windows service is installed to run under the System account.  
Line 308: Line 289:
== -debug 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 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.
This is only available for [https://cumulus.hosiene.co.uk/viewtopic.php?p=138839#p138839 release 3.4.4 - Build 3068] onwards. This switches on debug and data logging from the start-up of Cumulus MX by adding a parameter:
:<code>CumulusMX -debug</code>


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:
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.
:<code>CumulusMX -debug</code>
 
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 [[:Category:Diagnostics]] page for details) or the above command.
 
== 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'''.
 
Note use of this parameter is now deprecated, as it has been incorporated into '''-port''' parameter described earlier.  The reason is that [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887&p=138815&hilit=sockets#p138815 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]]. 
 
=== -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, as it has been incorporated into '''-debug''', see above.


=Access to admin interface=
=Access to admin interface=
5,838

edits