5,838
edits
Category:Cumulus MX: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Setting up for either manual or automatic running
| (15 intermediate revisions by the same user not shown) | |||
| Line 227: | Line 227: | ||
There are 3 ways on Windows to create a way to run MX | There are 3 ways on Windows to create a way to run MX | ||
#Create a shortcut on your desktop (and/or the taskbar) for the '''CumulusMX.exe''' executable | #Create a shortcut on your desktop (and/or the taskbar) for the '''CumulusMX.exe''' executable <tt>cmd.exe /C start CumulusMX C:\CumulusMX\CumulusMX.exe -debug</tt>, 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. | ||
#* '''Remember, if you have not done the <tt>''netsh http add urlacl url=http://*:8998/ user=\users''</tt> command mentioned above, you must run as administrator.''' | #* '''Remember, if you have not done the <tt>''netsh http add urlacl url=http://*:8998/ user=\users''</tt> command mentioned above, you must run as administrator.''' | ||
| Line 237: | Line 237: | ||
# OR declare a task in the scheduler to start MX; in the '''Actions''' tab fill in fields as follows (the other tabs should be obvious): | # OR declare a task in the scheduler to start MX; in the '''Actions''' tab fill in fields as follows (the other tabs should be obvious): | ||
#**'''Action''' <tt>Start a program</tt> from drop-down | #**'''Action''' <tt>Start a program</tt> from drop-down | ||
#**'''Program/script''' <tt>cmd.exe</tt> | #**'''Program/script''' <tt>cmd.exe</tt> (this is standard Windows environment to run something) | ||
#**'''Add arguments''' <tt>/C start | #**'''Add arguments''' <tt>/C start Start_MX \CumulusMX\CumulusMX.exe -debug -port=nnnn</tt> (the "/C" means this task will close once it has started the task, the "Start_MX" is how the task will be labelled as it is running, the next argument "\CumulusMX\CumulusMX.exe" actually starts the executable and it does not need a drive prefix as that is in next box. | ||
#** | #**Note in this example I have included next two optional parameters that can be used after the .exe call in that same box, here '''-debug''' (only include if you want full debugging logging) and '''-port=nnnn''' where nnnn is the port to be used for admin interface (only include if want to change from default 8998), | ||
#** all optional parameters are listed later | |||
#**'''Start in''' <tt>\CumulusMX</tt> (include a drive specifier if necessary) | #**'''Start in''' <tt>\CumulusMX</tt> (include a drive specifier if necessary) | ||
| Line 643: | Line 644: | ||
= Updating to a new MX release = | = Updating to a new MX release = | ||
== MX output message === | == Knowing when a new release is available == | ||
=== Using forum notifications === | |||
As new releases are announced in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 Cumulus MX Announcements and Download - PLEASE READ FIRST] topic, you can use the spanner tool to '''subscribe''' to this topic to receive notifications of a new post announcing a new release (or any other release-related announcement). | |||
=== MX installations will output message === | |||
If ... | If ... | ||
#...you have a monitor to see the output from the Cumulus MX engine (Windows call this a console window, Unix-based implementations | #...you have a monitor to see the output from the Cumulus MX engine (Windows call this a console window, for Unix-based implementations this is the output window when using terminal), AND | ||
#.. | #...your device running MX is connected to internet, AND | ||
#...your MONO (if not Windows) is not obsolete (SSL certificate out of date), AND | |||
#...you restart MX | #...you restart MX | ||
... then you will see a prompt when a new version | ... then you will see a prompt when a new version is available. | ||
There is no message in either place ... | === MXDiags === | ||
*... if you are using latest version, | |||
In addition ... | |||
#...if you can view the MXdiags file for the current session of MX, AND | |||
#... that is running with connection to the internet, AND | |||
#...you restart MX | |||
... if a new version of MX is available, the MXDiags file will say so (the message is not easy to spot as there is a lot output before it, but here is an example): | |||
<pre> | |||
2020-05-27 04:18:48.326 Calculating sunrise and sunset times | |||
2020-05-27 04:18:48.326 Sunrise: 04:58:11 | |||
2020-05-27 04:18:48.326 Sunset : 21:19:54 | |||
2020-05-27 04:18:48.326 Tomorrow sunrise: 04:57:08 | |||
2020-05-27 04:18:48.326 Tomorrow sunset : 21:21:11 | |||
2020-05-27 04:18:48.388 You are not running the latest version of CumulusMX, build 3080 is available. | |||
2020-05-27 04:18:48.763 Station type:</pre> | |||
There is no message in either place above ... | |||
*... if you are using latest version, OR | |||
* ... if you are not connected to the internet, OR | * ... if you are not connected to the internet, OR | ||
* you do not restart MX! | *... if you do not restart MX! | ||
=== Start/Stop script === | |||
When the '''Status''' option of this script is used, when a new release of MX is available, it will output a message. | |||
== What to read before updating == | == What to read before updating == | ||
*If your update is from the immediately previous build, then just check the release announcement in | *If your update is from the immediately previous build, then just check the release announcement in[https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 Cumulus MX Announcements and Download - PLEASE READ FIRST] topic, or the précis style entry at [[Cumulus_MX_formal_release_versions]] in this wiki (if that is up to date) for which files have been affected. | ||
*If your update is skipping some intermediate versions, then check the corresponding release announcements or Wiki entries for every version since the one you have been using before planning your upgrade. Again there may be one-off actions required at particular in-between versions. | **The actual release announcement will be more informative telling you if the upgrade requires one-off actions (like changing the schema if you use a database, or editing your web pages to take advantage of new web tags). | ||
**The release announcement may sometimes include scripts to download and run to perform one-off actions. | |||
*If your update is skipping some intermediate versions, then check the corresponding release announcements or Wiki entries for every version since the one you have been using before planning your upgrade. | |||
**Again there may be one-off actions required at particular in-between versions. | |||
== Back-ups == | == Back-ups == | ||
| Line 749: | Line 781: | ||
<big>WARNING: In any of these editors, when you save a row that was shorter because it was created by an earlier version, datatables will store the row with the length defined in the MX version you are using, so extra commas (and any values you set) will be added to end of just any line that has been edited, leaving other lines unchanged in length.</big> | <big>WARNING: In any of these editors, when you save a row that was shorter because it was created by an earlier version, datatables will store the row with the length defined in the MX version you are using, so extra commas (and any values you set) will be added to end of just any line that has been edited, leaving other lines unchanged in length.</big> | ||
=== Data logs === | === Data logs === | ||
| Line 757: | Line 786: | ||
This screen can be used to display any monthly log file in the '''CumulusMX/data''' folder. None are displayed until you select date (defaults to current month) and click '''Load'''. The selector will find any file in the folder, including those those for dates before when MX believes is earliest date (StartDate= xxxx, in Cumulus.ini). The only proviso is that the file naming must obey that currently defined in the current locale supplied to MONO (or defined in Control Panel for Windows operating system). Obviously, if you choose to load the default (the current) log file, what you see loaded from the api mentioned above is how the file was at time of creating that api, more lines may be appended to the file while the screen is open, but as far as I can tell the contents shown are not refreshed, so you can only edit those available at time of load. | This screen can be used to display any monthly log file in the '''CumulusMX/data''' folder. None are displayed until you select date (defaults to current month) and click '''Load'''. The selector will find any file in the folder, including those those for dates before when MX believes is earliest date (StartDate= xxxx, in Cumulus.ini). The only proviso is that the file naming must obey that currently defined in the current locale supplied to MONO (or defined in Control Panel for Windows operating system). Obviously, if you choose to load the default (the current) log file, what you see loaded from the api mentioned above is how the file was at time of creating that api, more lines may be appended to the file while the screen is open, but as far as I can tell the contents shown are not refreshed, so you can only edit those available at time of load. | ||
Highlight any one row and the ''datatables'' software used here will offer '''Edit''' and '''Delete''' buttons that operate on that row. The Edit button pops up a dialog showing all fields available in the version of MX you are using. If the log file has fewer fields because it was created by an earlier version of Cumulus, the excess fields will not show any value. Make any edits, click the '''Save'''(prior to MX version 3.6.1, it was "Edit") button and hopefully you will see a ''Success'' message. | Highlight any one row and the ''datatables'' software used here will offer '''Edit''' and '''Delete''' buttons that operate on that row. The Edit button pops up a dialog showing all fields available in the version of MX you are using. If the log file has fewer fields because it was created by an earlier version of Cumulus, the excess fields will not show any value. Make any edits, click the '''Save''' (prior to MX version 3.6.1, it was "Edit") button and hopefully you will see a ''Success'' message. | ||
(Aside: From version 3.6.1, the <tt>\CumulusMX\interface\js\datalogs.js</tt> uses a | |||
<pre>language: { | |||
altEditor: { | |||
modalClose: 'Cancel', | |||
edit: { | |||
title: 'Edit record', | |||
button: 'Save' | |||
} | |||
} | |||
},</pre> construct to rename button names in <tt>CumulusMX\interface\lib\datatableseditor\dataTables.altEditor.free.js</tt>, although I would advise against editing any admin interface files, those who want to tinker with the admin interface could use this approach to get button names in their own language, the messages for "success" and "error" are set to use that wording in the functions later in the first script). | |||
=== Extra Data Logs === | === Extra Data Logs === | ||
As I am typing this, a new release has just been announced with a new version of this screen, so I'm not going to talk about this moving target. | As I am typing this, a new release (3.6.4) has just been announced with a new version of this screen, so I'm not going to talk about this moving target. | ||
=== Dayfile === | === Dayfile === | ||
