Category:MX txt Files

From Cumulus Wiki

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete or accurate!

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on CONTRIBUTING to the Wiki, then you will need a userid.

When everyone used Cumulus 1, the Cumulus Wiki was highly rated as being comprehensive. But the legacy software was much simpler to document, and there were multiple contributors, one of whom was the Cumulus author who knew what the software was doing. (Unfortunately, it is not easy to convert pages originally written for the legacy software into pages that document MX, as it is often unclear if the two flavours work the same way, and MX is diverging rapidly from the old functionality).

Please be aware that any information on this page may be incorrect, unless the relevant contributor was the developer. This is because when new releases change functionality, the announcement is often unclear on what exactly changed. A lot of research is often needed before MX can be correctly documented here by any other contributor!

Cumulus Version MX Specific MX only

Explanation

This sub-category provides links to pages that give explanations for all of the Log files with a .txt extension within Cumulus MX.

For Cumulus 1, a sub-set of the files listed here are used, although there are some differences with their content. Please note that descriptions of those files, and tips, can be found in the Help file within the Cumulus 1 software, it can be read at Cumulus.chm although it is formatted to only open if your computer is using a Microsoft Windows Operating System.

The file types used by Cumulus

Essentially, there are 2 file types used by all flavours of Cumulus:

  1. .ini file type - these hold values that represent sums, counts, or extremes, for cumulus to read, and update, as it reads the weather observations, click on Category:Ini Files for details.
  2. .txt file type - these are the logs that Cumulus updates at defined intervals to hold details of what has happened, but it can also read these files when requested, please see links below for details.

Badge v1.png The following types were used by Cumulus 1:

  1. .rec file type - this has been deprecated, and replaced by .ini, for details see Alltime.ini.
  2. .xml file type - this holds the Cumulus 1 Weather_Diary. Although it uses standard XML, the component that Cumulus 1 uses also writes a special value that other XML editors will not understand.

Badge vMx.png The following types are only used by MX:

  1. .db file type - there are two of these for Cumulus MX, click on Diary.db or Cumulusmx.db for details.
  2. .json file type - these hold data to be sent to a web server, please see .json files category for details. See MX announcements for more details, as this functionality varies depending on your MX release.

Differences in .txt files

The files linked below all use plain text, so that they can be edited outside Cumulus. There are a number of formats, as some files use "comma separated value" approach, although the separator does not need to be a comma.

The files will be different depending on the device running MX. So on Microsoft Windows Operating System each line is terminated by a pair of characters (CR and LF), on a UNIX-derived system where Linux uses just LF to end a line, and some versions of Mac Operating System use just CR to terminate each line.