5,838
edits
Category:Log Files: Difference between revisions
m
Made a lot clearer!
m (Adding more about BOM) |
m (Made a lot clearer!) |
||
|
Descriptions, and tips, can also be found in the Help file within the Cumulus software.
== CAUTIONS ==
Remember, if you edit any of these log files to obey cautions in the individual articles:
* stop cumulus before editing any file that Cumulus might be updating,
* don't change the format of files for example don't change format of dates or real numbers (using a spreadsheet, like Microsoft Office Excel or Libre Office Calc, don't let dates or special numbers be recognised),
* don't add 'Byte Order Mark' (many pieces of software on Microsoft Windows such as Notepad treat a BOM as a required magic number and add a BOM when saving text as UTF-8. Google Docs also adds a BOM when converting a document to a plain text file for download.),
* don't add blank lines to any Comma Separated Value files(the only 'blank' line in a log file is the final one, where Cumulus will later append the next item), (you can add blank lines to log files that contain "attribute=value" lines such as 'today.ini')
* don't add
== TYPES ==
Essentially, there are 4 types:
# '''.ini''' files - these hold values that represent sums, counts, or extremes, for cumulus to read, and update, as it reads the weather observations.
# '''.txt''' files - 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.
# '''.xml''' file - this holds the [[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.
# '''.log''' file - cumulus writes either "Logging Disabled" messages or logs its actions in detail for debugging purposes into [[debug.log]].
== CUMULUS 1 and MX differences ==
These files apply to both Cumulus 1 and Cumulus MX. Note that file names are case-sensitive, read documentation to see where capital letters are required. In individual articles, any differences in the files will be highlighted. In general, some dates/times are in different formats so may need editing if you move the file concerned between Cumulus 1 and MX, and MX may add extra entries to those used in Cumulus 1, but otherwise the files can be interchanged.
Cumulus MX also has some JSON files with data for its trends web page. See MX documentation for more details.
[[Category:Cumulus Files]]
| |||