5,838
edits
Cumulus 3 (MX) beta documentation: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
Cumulus 3 (MX) beta documentation (view source)
Revision as of 20:56, 22 May 2021
, 20:56, 22 May 2021Text replacement - "[[MXDiags" to "[[MXdiags"
m (Text replacement - "[[MXDiags" to "[[MXDiags_folder") |
m (Text replacement - "[[MXDiags" to "[[MXdiags") |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 63: | Line 63: | ||
==== Parameter for adding debugging ==== | ==== Parameter for adding debugging ==== | ||
MX has a default level of logging that stores in the [[ | MX has a default level of logging that stores in the [[MXdiags_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. | 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. | ||
| Line 189: | Line 189: | ||
Almost all of the [[Webtags|web tags for all Cumulus flavours on this Wiki page]] that you could use in Cumulus 1 are also supported in Cumulus MX. | Almost all of the [[Webtags|web tags for all Cumulus flavours on this Wiki page]] that you could use in Cumulus 1 are also supported in Cumulus MX. | ||
Each new build of the beta MX has increased the range of web tags it supports. For full details see the [[ | Each new build of the beta MX has increased the range of web tags it supports. For full details see the [[Webtag_Applicability|web tags applicability]] article, but a quick précis follows in next two sub-sections. | ||
== All builds of MX == | == All builds of MX == | ||
The ''''format' parameter''' on the date/time output modifier for web tags is unfortunately different, because many of the characters used are different. See [[Webtags# | The ''''format' parameter''' on the date/time output modifier for web tags is unfortunately different, because many of the characters used are different. See [[Webtags/Parameters#Dependency_on_Cumulus_flavour]] page of this Wiki. | ||
Note that this difference in date/time modifiers also affects how you specify the '''NOAA report''' file names. For example in Cumulus 1 you can specify a 2 digit month number by either 'mm' or 'MM', but MX (later versions) has to change the former to the latter as MX uses 'mm' for minutes. The same applies to using 'mmm' or 'MMM' for 3 letter month abbreviation in Cumulus 1, only the latter works in MX, so MX (later versions) will adjust that. If you are using an older MX version, you should upgrade to latest as you are missing a lot of functionality, but while you use that old version, ensure that your file names for NOAA reports do use the correct modifiers for MX. | Note that this difference in date/time modifiers also affects how you specify the '''NOAA report''' file names. For example in Cumulus 1 you can specify a 2 digit month number by either 'mm' or 'MM', but MX (later versions) has to change the former to the latter as MX uses 'mm' for minutes. The same applies to using 'mmm' or 'MMM' for 3 letter month abbreviation in Cumulus 1, only the latter works in MX, so MX (later versions) will adjust that. If you are using an older MX version, you should upgrade to latest as you are missing a lot of functionality, but while you use that old version, ensure that your file names for NOAA reports do use the correct modifiers for MX. | ||
| Line 220: | Line 220: | ||
== Replacing Cumulus 1 == | == Replacing Cumulus 1 == | ||
See [[ | See [[Migrating from Cumulus 1 to MX]] page. If you wish to run MX on Windows, then you can unzip the contents of the download package over your original cumulus installation, i.e. so the same data and Reports folders continue to be used. But it would be best if you take a back-up copy of the Cumulus 1 installation first! If you are going to run MX on another device, follow instructions in next sub-section. | ||
The package contains several extra .dll files, and everything else you need, to continue to read from your weather station, to load up the [[MX Administrative Interface|admin interface]] on a Cumulus generated web server (there are some settings you will need to change using that interface), and some simple web template examples (that replace the standard Cumulus 1 example templates). You might want to read topics on the MX support forum to discover about other people's experiences. | The package contains several extra .dll files, and everything else you need, to continue to read from your weather station, to load up the [[MX Administrative Interface|admin interface]] on a Cumulus generated web server (there are some settings you will need to change using that interface), and some simple web template examples (that replace the standard Cumulus 1 example templates). You might want to read topics on the MX support forum to discover about other people's experiences. | ||
| Line 238: | Line 238: | ||
# Start '''Admin Interface''', it runs in a browser, by default on port 8998, see [[#User_Interface|section]] below. | # Start '''Admin Interface''', it runs in a browser, by default on port 8998, see [[#User_Interface|section]] below. | ||
If you have been running Cumulus 1 before, then [[ | If you have been running Cumulus 1 before, then [[Migrating from Cumulus 1 to MX|as instructed here]] your MX installation will require various files from your Cumulus 1 installation including all files in the '''data''' and '''Reports''' folder and all [[:Category:Configuration Files|Configuration Files]] including Cumulus.ini but a few of the parameters that you may need to change. | ||
If you are running MX for the first time, without a configuration file (none is included in download package), see [[Cumulus.ini#Cumulus_MX|here]] for screen shots showing what you see as the engine starts running, and what you see in the admin interface where you set your weather station type. In that link there are more instructions. | If you are running MX for the first time, without a configuration file (none is included in download package), see [[Cumulus.ini#Cumulus_MX|here]] for screen shots showing what you see as the engine starts running, and what you see in the admin interface where you set your weather station type. In that link there are more instructions. | ||
| Line 248: | Line 248: | ||
* For OS X, you can download this here - http://www.mono-project.com/download/. | * For OS X, you can download this here - http://www.mono-project.com/download/. | ||
* How you install on Linux depends on the flavour of Linux you are running. There are download links for Linux at the same URL, but it is often easier to use a package manager, which will download and install it automatically. | * How you install on Linux depends on the flavour of Linux you are running. There are download links for Linux at the same URL, but it is often easier to use a package manager, which will download and install it automatically. | ||
**For example, in 'Raspbian' on the Raspberry Pi, you can install mono with the following commands, but '''first you need to have set up various pre-requisites''' (see [[ | **For example, in 'Raspbian' on the Raspberry Pi, you can install mono with the following commands, but '''first you need to have set up various pre-requisites''' (see [[MX_on_Linux]] article for details): | ||
<pre>sudo apt update && sudo apt upgrade | <pre>sudo apt update && sudo apt upgrade | ||
