MX on Linux: Difference between revisions

MX on Linux (view source)

Revision as of 10:33, 17 May 2021

7,316 bytes added , 10:33, 17 May 2021

m

→‎That is all folks

Sfws

5,838

edits

@@ Line 338: / Line 338: @@
 The documentation for the latest release can be found at [[Cumulus.ini]], note that this does not explain the changes from 3.9.7 to 3.10.1, but it does include advice on (while MX is running) it can automatically update the file.  This automatic approach is easy, but you might want to work through settings to change preferences for any new parameters.
+=Running MX on Linux=
+This section explores the optional parameters, and then covers 2 ways to run MX:
+# as a service and
+#directly with terminal window left open.
+== Optional parameters to add to the instruction to run the MX engine ==
+Beta builds in MX version 3.0.0 had an optional parameter <code>-wsport nnnn</code> that determined which port (represented by a 4 digit number ''nnnn'') was used for '''WebSockets'''. That parameter is now deprecated as WebSockets in all builds since 3045 uses the same port as the rest of the [[MX_Administrative_Interface#The_API_interface|Admin Interface]]. The remaining parameters that are still available are described in subsequent sub-sections.
+=== 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 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.
+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 ('''options''' section of ''station settings'') in admin interface  while MX is running, or by adding 1 or 2 parameters when you start MX.  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. Whether you start it with a parameter or enable it within settings, stopping MX will end the extra debugging, and on restart it will default back to no debugging unless turned on again with parameter or setting.
+You can also add  '''CumulusMX.exe -debug''' (to have full debugging of actions by MX turned on as MX starts), and/or '''CumulusMX.exe -Logging=1''' (for the station to MX transfers to have increased debugging logging).
+<pre>sudo mono CumulusMX.exe -debug -Logging=1</pre>
+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.
+The comments in the MX source suggests -debug turns on both debug and data logging (see [[MX_Administrative_Interface#Options|Station_Settings#Options]] in admin interface settings), but I believe that is wrong as per example above, there are 2 separate parameters.
+=== 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, on a non-Windows device type:
+<pre>
+sudo mono CumulusMX.exe -lang en-GB
+</pre>
+Other local examples:  '''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'''.
+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") in that list.
+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.
+=== Parameter for running as service ===
+Use of this is explained next.  The parameter syntax is <code>sudo mono CumulusMX.exe -service</code>
+=== Setting up as a service ===
+If you have installed MX release 3.8.0 or later, you can set up MX to run as a service.
+#There is a task to do just once to configure the service
+#Find the '''EXISTING PATH/CumulusMX/MXutils/linux/''' sub-folder, that might be in home directory and therefore found using "~/CumulusMX/MXutils/linux" as explained elsewhere on this page
+#* At time of typing this, the sub-folder only contains one file, the one we need to edit
+# As described later there is a choice of editors, but you can use <code>sudo nano cumulusmx.service</code> to edit the service configuration file
+# Look for '''ExecStart=/usr/bin/mono-service -d:'''
+#* Replace the path that follows the above text with the path to your CumulusMX.exe, add the '''-service''' and optionally add any other parameter (e.g. '''-debug''', -locale, -port) as described in sub-sections above.
+#save file
+#now copy file
+:<code>sudo cp EXISTING_PATH/CumulusMX/MXutils/linux/cumulusmx.service /etc/systemd/system/</code>
+If you upgrade to a new release, the file in EXISTING PATH will be overwritten, but the critical file in "/etc/sytemd/system" will not be affected.
+===Running as a service===
+If you want MX to automatically start when your Linux computer is booted, just type <code>sudo systemctl enable cumulusmx</code> once, and it will be activated on each reboot.
+To manually start MX as a service, (such as after any MX upgrade to a new release, or when you want to first run it), simply type <code>sudo systemctl start cumulusmx</code>
+Use <code>systemctl status cumulusmx.service</code> in a terminal session to see status of Cumulus service
+=== Running with a terminal session left open ===
+This is alternative to the running as service as described above.
+Whichever operating system you are using, to run MX requires an instruction that changes to the directory (EXISTING PATH) where it is installed (the instruction below is assuming it is in the standard Pi user home directory, the change directory command will be different if you have installed it elsewhere), and then starting the executable (using mono in the instruction below that applies to any non-Windows operating system). You may wish to add [[Cumulus_MX#Optional_parameters_to_add_to_the_instruction_to_run_the_MX_engine|Optional_parameters]].
+The simplest instruction to run Cumulus MX  is <code>cd EXISTING PATH/CumulusMX && sudo mono CumulusMX.exe</code>.  Just in case it is not obvious .... if you start MX using this command in a terminal window on your Pi, you must leave that session running, then MX will continue to run.
+You can start it off directly on your Pi, and then
+*optionally disconnect the keyboard,
+*switch off monitor or TV attached to your Pi,
+*Just ensure you leave Pi on (with that window minimised) so that terminal session continues running.
+Use <code>'''ps -ef | grep -i cumulus | grep -v grep'''</code> to see if Cumulus is running or not.
 =That is all folks=
@@ Line 344: / Line 436: @@
 The remaining sections are more technical and so you can skip them.
 =Technical Extra=