5,838
edits
Dayfile.txt: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Changes in different releases of Cumulus
| (20 intermediate revisions by the same user not shown) | |||
| Line 12: | Line 12: | ||
== Changes in different releases of Cumulus == | == Changes in different releases of Cumulus == | ||
Be aware that this article was written for Cumulus 1, amended to also cover MX 3.0.0. Whilst the list of fields has been kept updated for more recent MX versions, other parts of this article may not be applicable to latest MX version, check for edits by developer. | |||
{{Version badge 1}} | {{Version badge 1}} | ||
| Line 120: | Line 122: | ||
=== File specific Editing Rules === | === File specific Editing Rules === | ||
[[File:Open office (editing cumulus log files).png| right]] | [[File:Open office (editing cumulus log files).png| right]] | ||
# The file should be saved without "Byte Order Mark", specialised text editors will include a menu where you select the encoding and can select not to include BOM. | # The file should be saved without "Byte Order Mark", specialised text editors will include a menu where you select the encoding and can select not to include BOM. | ||
| Line 167: | Line 170: | ||
=== Using the Cumulus 1 editing feature === | === Using the Cumulus 1 editing feature === | ||
{{Version badge 1}} | {{Version badge 1}} | ||
'''This section applies to Cumulus 1.x.y only'''. The last command in '''Edit''' [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu |menu]] is ''dayfile.txt''. ''This is how you view'' the dayfile.txt from within Cumulus. This is a text editor, so you can type new values over those currently displayed, insert and delete rows, and it works best when at full screen. Click the ''Help'' button for detailed instructions. Cumulus Help is comprehensive. | '''This section applies to Cumulus 1.x.y only'''. The last command in '''Edit''' [[Cumulus_Screenshots#File.2FEdit.2FHelp_Menu |menu]] is ''dayfile.txt''. ''This is how you view'' the dayfile.txt from within Cumulus. This is a text editor, so you can type new values over those currently displayed, insert and delete rows, and it works best when at full screen. Click the ''Help'' button for detailed instructions. Cumulus Help is comprehensive. | ||
| Line 193: | Line 197: | ||
The only method available at the time of writing involves multiple steps: | The only method available at the time of writing involves multiple steps: | ||
#*Either use '''ExportMySQL.exe monthly''' to create a database table called "monthly", and read all the standard logs into that database table | #*Either use '''ExportMySQL.exe monthly''' to create a database table called "monthly" (you can call it another name, but you must have set name in MX, before you run ExportMySQL.exe), and read all the standard logs into that database table | ||
#*Or if you already have the table and have MX updating the standard logs into that database table | #*Or if you already have the table and have MX updating the standard logs into that database table | ||
#Then, you can fairly easily update to add any missing values into existing columns in this monthly table, and from it update columns in a daily summary table. See [https://cumulus.hosiene.co.uk/viewtopic.php?f=18&t=18096 this post in support forum] where I describe two PHP scripts designed for this type of task. | #Then, you can fairly easily update to add any missing values into existing columns in this monthly table, and from it update columns in a daily summary table. See [https://cumulus.hosiene.co.uk/viewtopic.php?f=18&t=18096 this post in support forum] where I describe two PHP scripts designed for this type of task. | ||
| Line 209: | Line 213: | ||
There is a dayfile editor within the admin interface to edit this log file. | There is a dayfile editor within the admin interface to edit this log file. | ||
Only from MX version 3.6.0 has this been able to read the log file if it has some lines that were created using Cumulus 1 (with less than 46 fields. In the same version of MX, the number of fields in this log file was increased by 4. From that version all lines viewed in this editor will have 50 fields. The content of any field that was not in the line when it was created will be an empty string as far as this editor is concerned and any line edited and saved, therefore gains all these empty fields and will be stored as 50 fields | Only from MX version 3.6.0 has this been able to read the log file if it has some lines that were created using Cumulus 1 (with less than 46 fields). In the same version of MX, the number of fields in this log file was increased by 4 when Feels Like temperature was added. From that version all lines viewed in this editor will have 50 fields. The content of any field that was not in the line when it was created will be an empty string as far as this editor is concerned and any line edited and saved, therefore gains all these empty fields and will be stored as 50 fields until version 3.6.10. | ||
From Emergency Version 3.6.12 (formally released in 3.7.0), all lines have 54 fields. The extras are Canadian Humidity Index (Humidex). | |||
[[File:Badge vMx.png]]For Cumulus MX, when you select a line, both '''Edit''' and '''Delete''' buttons are enabled. There is no way of inserting new lines into dayfile.txt from within MX, nor of changing the dates in the file. | [[File:Badge vMx.png]]For Cumulus MX, when you select a line, both '''Edit''' and '''Delete''' buttons are enabled. There is no way of inserting new lines into dayfile.txt from within MX, nor of changing the dates in the file. | ||
| Line 322: | Line 328: | ||
!style="width:600px" | Description | !style="width:600px" | Description | ||
|- | |- | ||
|colspan=" | |0 | ||
|colspan="3"|For internal MX purposes, the zero field identifies a field that holds the line number. It is not actually stored as a field in the log file, but precedes any line exchanged via an application programming interface, and therefore is also included in an array representing all the fields in any log file line. | |||
If you are processing this log file using a third party (or your own) script, that probably does not place the line number into any array, and your array elements will start at 0 for the field labelled 1 in this table, so putting all field numbers out by 1. | |||
|- | |- | ||
|colspan="4" style="background:lightgray;"|Those fields included below have been in dayfile.txt from the start of Cumulus 1 (Version 1.0, the First release on 27th January 2004). | |||
|colspan=" | |||
|- | |- | ||
|1 | |1 | ||
| Line 402: | Line 410: | ||
|Total rainfall for the day | |Total rainfall for the day | ||
|- | |- | ||
|colspan="4" style="background: | |colspan="4" style="background:lightblue;"|Above here represents the minimum length for every line, a count of 15 items | ||
|- | |- | ||
|colspan="4" style="background: | |colspan="4" style="background:pink;"|(There is no record of which version added this next field, it is almost certainly one of the versions in the release history between versions 1.2.5 and 1.5.1 that was lost by Steve Loft. The first mention of it in the forum relates to a question re the 1.8.2 release confirming it was present by December 2008, but those release notes don't mention it being introduced in that release. | ||
Because of that, in "DataEditor.cs" (part of the source code that is compiled into CumulusMX.exe) this addition has "Extended for ???" as a comment) | |||
|- | |- | ||
|16 | |16 | ||
| Line 418: | Line 428: | ||
|Daily [[Windrun | wind run]] | |Daily [[Windrun | wind run]] | ||
|- | |- | ||
|colspan="4" style="background:lightgray;"|(The next pair of entries were added from version 1.8.9) | |colspan="4" style="background:lightgray;"|(The next pair of entries were added from version 1.8.9 build 907 (June 2010) as part of a total redesign of how dayfile.txt was implemented in Cumulus 1) | ||
|- | |- | ||
|18 | |18 | ||
| Line 430: | Line 440: | ||
|Time of Highest Avg. Wind speed | |Time of Highest Avg. Wind speed | ||
|- | |- | ||
|colspan="4" style="background:lightgray;"|(The two pairs of humidity entries were added | |colspan="4" style="background:lightgray;"|(The two pairs of humidity entries were added in a v 1.9.0 beta, the exact build number is now lost) | ||
|- | |- | ||
|20 | |20 | ||
| Line 464: | Line 474: | ||
|Total hours of sunshine (only valid if sunshine sensor connected) | |Total hours of sunshine (only valid if sunshine sensor connected) | ||
|- | |- | ||
|colspan="4" style="background:lightgray;" | |colspan="4" style="background:lightgray;"|(The next 16 entries were added from version 1.9.1 May 2011) | ||
|(The next 16 entries were added from version 1.9.1) | |||
|- | |- | ||
|26 | |26 | ||
| Line 510: | Line 519: | ||
|AH) | |AH) | ||
|signed decimal | |signed decimal | ||
|Greatest [[wind chill]] (high wind speed, low temperature) ( | |Greatest [[wind chill]] (high wind speed, low temperature) (calculated since version 1.8.3 as spot value, not stored) | ||
|- | |- | ||
|35 | |35 | ||
| Line 517: | Line 526: | ||
|Time of greatest wind chill | |Time of greatest wind chill | ||
|- | |- | ||
|colspan="4" style="background:lightgray;"|(The next two pairs were added in version 1.9.2 beta build) | |colspan="4" style="background:lightgray;"|(The next two pairs for dew point were added in version 1.9.2 beta build) | ||
|- | |- | ||
|36 | |36 | ||
| Line 578: | Line 587: | ||
|Time of high UV Index | |Time of high UV Index | ||
|- | |- | ||
|colspan="4" style="background:lightgray;"|The next two pairs were added in version 3.6.0, 2 more derived values | |colspan="4" style="background:lightgray;"|The next two pairs were added in version 3.6.0, 2 more derived values and their times | ||
|- | |- | ||
|47 | |47 | ||
| Line 599: | Line 608: | ||
|5 characters | |5 characters | ||
|Time of low feels like temperature | |Time of low feels like temperature | ||
|- | |||
|colspan="4" style="background:lightgray;"|The next two pairs were added in version 3.6.12 | |||
*Version 3.6.12 (build 3088) was an emergency release to cure serious problems in previous build 3087. It added the following 4 fields (2 values and their times). | |||
**The 4 extra fields are left empty in this release, although you can add values and time-stamps using the dayfile editor. | |||
*From version 3.7.0 the first 2 of these 4 fields are populated, and the last 2 are removed, so I have labelled them as error. | |||
|- | |||
|51 | |||
|AY | |||
|signed decimal | |||
|High Canadian Humidity Index or [[Humidex]] | |||
|- | |||
|52 | |||
|AZ | |||
|5 characters | |||
|Time of high Humidex | |||
|- | |||
|colspan="4" style="background:lightblue;"|Just confirming that the next 2 fields were included by mistake in an emergency release (3.6.12), and are not included in current nor any other version, so have labelled them as error. | |||
|- | |||
|53 ('''error''') | |||
|BA | |||
|signed decimal | |||
|Labelled as Low Humidex, but not used, (appear in 3.6.12, but no other version) | |||
|- | |||
|54 ('''error''') | |||
|BB | |||
|5 characters | |||
|Labelled as Time of low Humidex, but not used, (appear in 3.6.12, but no other version) | |||
|} | |} | ||
