Dayfile.txt: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Dayfile.txt (view source)

Revision as of 17:51, 8 August 2020

3,332 bytes added ,  17:51, 8 August 2020
m
→‎Changes in different releases of Cumulus
(21 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 and stay like that thereafter.
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 304: Line 310:
== Information shown in the table ==
== Information shown in the table ==


*The field number is shown starting from zero, this has two advantages:
*The fields are now numbered starting from 1 to fit in with Cumulus MX where when the log file is read, adds a line number in front of the date field.
**It stresses that the line consists of a date, (that should be a unique identifier, the same date should not be repeated in another line) plus data (mostly numerical, but some values are paired with a time)
** The Cumulus MX user may not be aware of this happening as it is within the internal workings.
**Numbering starting from zero is consistent with standard indexing used for arrays in programming languages (like JavaScript), so the number shown is the number to quote in any scripts you write to read this file if you just want to examine that particular derivative.
*The original table below was for Cumulus 1 and then field number '''was''' starting from zero. So in some forum posts you might see references to old numbering, in others to new numbering. The old numbering from zero had two advantages:
*#It stressed that the date field was different to the rest. The date '''must''' be a unique identifier, the same date should not be repeated in another line.
*#The remaining fields were all either numerical values or a time paired with preceding numerical value.
**Numbering starting from zero is consistent with standard indexing used for arrays in programming languages (like JavaScript), so the number shown '''was''' the number to quote in any scripts where a line was converted to an array, and you needed to address a single field.
*The alphabetic column identifiers used by many spreadsheets are shown, please see warnings about using spreadsheets for editing earlier on this page
*The alphabetic column identifiers used by many spreadsheets are shown, please see warnings about using spreadsheets for editing earlier on this page
*The type of field is shown, you must not put a sign for an unsigned field, you can not specify a decimal point in an integer field, all time fields must use HH:mm format
*The type of field is shown, you must not put a sign for an unsigned field, you can not specify a decimal point in an integer field, all time fields must use HH:mm format
Line 319: Line 328:
!style="width:600px" | Description  
!style="width:600px" | Description  
|-
|-
|colspan="4" style="background:lightgray;"|Included from when dayfile.txt first invented (assumed in first public release 1.0)
|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).
|-
|-
|0
|1
|A
|A
|8 characters
|8 characters
|Date as  ''2 figure day [separator] 2 figure month [separator] 2 figure year'' - the separator is that set in the windows system short date format (see [[setup]])  
|Date as  ''2 figure day [separator] 2 figure month [separator] 2 figure year'' - the separator is that set in the windows system short date format (see [[setup]])  
|-
|-
|1
|2
|B
|B
|Unsigned number
|Unsigned number
|Highest wind [[Wind_measurement#Weather_Stations_and_Cumulus|gust]] speed
|Highest wind [[Wind_measurement#Weather_Stations_and_Cumulus|gust]] speed
|-
|-
|2
|3
|C
|C
|unsigned integer
|unsigned integer
|[[Wind_measurement#Wind_Direction | Bearing]] of highest wind gust
|[[Wind_measurement#Wind_Direction | Bearing]] of highest wind gust
|-
|-
|3
|4
|D
|D
|5 characters
|5 characters
|Time of highest wind gust
|Time of highest wind gust
|-
|-
|4
|5
|E
|E
|signed decimal
|signed decimal
|Minimum [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | temperature]]
|Minimum [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | temperature]]
|-
|-
|5
|6
|F
|F
|5 characters
|5 characters
|Time of minimum temperature
|Time of minimum temperature
|-
|-
|6
|7
|G
|G
|signed decimal
|signed decimal
|Maximum temperature
|Maximum temperature
|-
|-
|7
|8
|H
|H
|5 characters
|5 characters
|Time of maximum temperature
|Time of maximum temperature
|-
|-
|8
|9
|I
|I
|Unsigned number
|Unsigned number
|Minimum [[Pressure_Measurement | sea level pressure]]
|Minimum [[Pressure_Measurement | sea level pressure]]
|-
|-
|9
|10
|J
|J
|5 characters
|5 characters
|Time of minimum pressure
|Time of minimum pressure
|-
|-
|10
|11
|K
|K
|Unsigned number
|Unsigned number
|Maximum sea level pressure
|Maximum sea level pressure
|-
|-
|11
|12
|L
|L
|5 characters
|5 characters
|Time of maximum pressure
|Time of maximum pressure
|-
|-
|12
|13
|M
|M
|unsigned number
|unsigned number
|Maximum [[Rain_measurement#Rain_Rate | rainfall rate]]
|Maximum [[Rain_measurement#Rain_Rate | rainfall rate]]
|-
|-
|13
|14
|N
|N
|5 characters
|5 characters
|Time of maximum rainfall rate
|Time of maximum rainfall rate
|-
|-
|14
|15
|O
|O
|unsigned number
|unsigned number
|Total rainfall for the day
|Total rainfall for the day
|-
|-
|colspan="4" style="background:gray;"|Above here represents the minimum length for every line, a count of 15 items
|colspan="4" style="background:lightblue;"|Above here represents the minimum length for every line, a count of 15 items
|-
|-
|colspan="4" style="background:lightgray;"|(The release history between versions 1.2.5 and 1.5.1 was lost by Steve Loft, and for MX in "DataEditor.cs" this addition has " Extended for ???" as a comment)
|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)
|-
|-
|15
|16
|P
|P
|signed decimal
|signed decimal
Line 407: Line 423:
|colspan="4" style="background:lightgray;"|(Wind run was added from version 1.8.4)
|colspan="4" style="background:lightgray;"|(Wind run was added from version 1.8.4)
|-
|-
|16
|17
|Q
|Q
|unsigned number
|unsigned number
|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)
|-
|-
|17
|18
|R
|R
|unsigned number
|unsigned number
|Highest [[Wind_measurement#Weather_Stations_and_Cumulus|Average Wind Speed]]
|Highest [[Wind_measurement#Weather_Stations_and_Cumulus|Average Wind Speed]]
|-
|-
|18
|19
|S
|S
|5 characters
|5 characters
|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 from v 1.9.0)
|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)
|-
|-
|19
|20
|T
|T
|unsigned integer
|unsigned integer
|Lowest [[Temperature_(and_humidity)_measurement | humidity]]
|Lowest [[Temperature_(and_humidity)_measurement | humidity]]
|-
|-
|20
|21
|U
|U
|5 characters
|5 characters
|Time of lowest humidity
|Time of lowest humidity
|-
|-
|21
|22
|V
|V
|unsigned integer
|unsigned integer
|Highest humidity
|Highest humidity
|-
|-
|22
|23
|W
|W
|5 characters
|5 characters
Line 448: Line 464:
|colspan="4" style="background:lightgray;"|(The next two entries were added from version 1.9.0)
|colspan="4" style="background:lightgray;"|(The next two entries were added from version 1.9.0)
|-
|-
|23
|24
|X
|X
|(not documented)
|(not documented)
|Total evapotranspiration (Only valid for Davis stations, shows zero otherwise)
|Total evapotranspiration (Only valid for Davis stations, shows zero otherwise)
|-
|-
|24
|25
|Y
|Y
|unsigned
|unsigned
|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;"|(The next 16 entries were added from version 1.9.1)
|colspan="4" style="background:lightgray;"|(The next 16 entries were added from version 1.9.1 May 2011)
|-
|-
|25
|26
|Z
|Z
|signed decimal
|signed decimal
|High [[Heat index]] (added to Cumulus in 1.7.11 only as spot value, not stored)
|High [[Heat index]] (added to Cumulus in 1.7.11 only as spot value, not stored)
|-
|-
|26
|27
|AA
|AA
|5 characters
|5 characters
|Time of high heat index
|Time of high heat index
|-
|-
|27
|28
|AB
|AB
|Signed decimal
|Signed decimal
|High [[Apparent temperature]]
|High [[Apparent temperature]]
|-
|-
|28
|29
|AC
|AC
|5 characters
|5 characters
|Time of high apparent temperature
|Time of high apparent temperature
|-
|-
|29
|30
|AD
|AD
|signed decimal
|signed decimal
|Low apparent temperature
|Low apparent temperature
|-
|-
|30
|31
|AE
|AE
|5 characters
|5 characters
|Time of low apparent temperature
|Time of low apparent temperature
|-
|-
|31
|32
|AF
|AF
|unsigned number
|unsigned number
|High hourly rain
|High hourly rain
|-
|-
|32
|33
|AG
|AG
|5 characters
|5 characters
|Time of high hourly rain
|Time of high hourly rain
|-
|-
|33
|34
|AH)
|AH)
|signed decimal
|signed decimal
|Greatest [[wind chill]] (high wind speed, low temperature) (added in 1.8.3 as spot value, not stored)
|Greatest [[wind chill]] (high wind speed, low temperature) (calculated since version 1.8.3 as spot value, not stored)
|-
|-
|34
|35
|AI
|AI
|5 characters
|5 characters
|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)
|-
|-
|35
|36
|AJ
|AJ
|signed decimal
|signed decimal
|High [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | dew point]]
|High [[Temperature_(and_humidity)_measurement#Cumulus_Calculated_Parameters | dew point]]
|-
|-
|36
|37
|AK
|AK
|5 characters
|5 characters
|Time of high dew point
|Time of high dew point
|-
|-
|37
|38
|AL
|AL
|signed decimal
|signed decimal
|Low dew point
|Low dew point
|-
|-
|38
|39
|AM)
|AM)
|5 characters
|5 characters
Line 534: Line 550:
|colspan="4" style="background:lightgray;"|(The next three entries were added in version 1.9.2 Build 1004)
|colspan="4" style="background:lightgray;"|(The next three entries were added in version 1.9.2 Build 1004)
|-
|-
|39
|40
|AN
|AN
|unsigned integer
|unsigned integer
|Today's dominant/average wind direction
|Today's dominant/average wind direction
|-
|-
|40
|41
|AO
|AO
|unsigned decimal
|unsigned decimal
|[[Heat/cold degree days and Chill hours | Heating degree days]]
|[[Heat/cold degree days and Chill hours | Heating degree days]]
|-
|-
|41
|42
|AP
|AP
|unsigned decimal
|unsigned decimal
Line 551: Line 567:
|colspan="4" style="background:lightgray;"|The next two pairs were added in version 1.9.3 build 1036 (these only show valid values if appropriate sensors exist)
|colspan="4" style="background:lightgray;"|The next two pairs were added in version 1.9.3 build 1036 (these only show valid values if appropriate sensors exist)
|-
|-
|42
|43
|AQ
|AQ
|unsigned decimal
|unsigned decimal
|High solar radiation
|High solar radiation
|-
|-
|43
|44
|AR
|AR
|5 characters
|5 characters
|Time of high solar radiation
|Time of high solar radiation
|-
|-
|44
|45
|AS
|AS
|unsigned decimal
|unsigned decimal
|High UV Index
|High UV Index
|-
|-
|45
|46
|AT
|AT
|5 characters
|5 characters
|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
|-
|-
|46
|47
|AU
|AU
|signed decimal
|signed decimal
|High [[Feels Like]] temperature
|High [[Feels Like]] temperature
|-
|-
|47
|48
|AV
|AV
|5 characters
|5 characters
|Time of high feels like temperature
|Time of high feels like temperature
|-
|-
|48
|49
|AW
|AW
|signed decimal
|signed decimal
|Low Feels Like temperature
|Low Feels Like temperature
|-
|-
|49
|50
|AX
|AX
|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)
|}
|}


Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/6268...7055"

Navigation menu