5,838
edits
m (Text replacement - "[[Diags" to "[[Diags_folder") |
No edit summary |
||
Line 1: | Line 1: | ||
= Introduction = | = Introduction = | ||
Cumulus has ability to create a number of data logs, most ('''[[Speciallog.txt]]''' , [[Extra_Sensor_Files]], and [[Air_Link_Log.txt]]) are optional, in that settings determine whether they are created or not. However, thi page documents the data logs that are not optional (hence termed "standard"). These store the full set of current (read and derived) values at whatever interval you have set for Cumulus to keep detailed logging. The default time interval between adding data logging lines is every 10 minutes, but you can change this: | |||
*Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Data log interval''' box on extreme RH side. | *Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Data log interval''' box on extreme RH side. | ||
*Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Log interval''' after the ''Ecowitt GW1000 Settings'' section. | *Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Log interval''' after the ''Ecowitt GW1000 Settings'' section. | ||
Line 11: | Line 11: | ||
There is an equivalent logging file for [[Extra_Sensor_Files|extra sensor]] values. In fact, in Cumulus MX, the processing of this extra sensor logging file shares a lot of the code with the processing of the standard logging file, as they both are updated at same interval, and they both take values processed following a read from your weather station. The applications programming interface (api) that sends values between the MX engine and the MX admin interface is also identical (with a parameter "Extra" that swaps between true and false depending on the log file involved). | There is an equivalent logging file for [[Extra_Sensor_Files|extra sensor]] values. In fact, in Cumulus MX, the processing of this extra sensor logging file shares a lot of the code with the processing of the standard logging file, as they both are updated at same interval, and they both take values processed following a read from your weather station. The applications programming interface (api) that sends values between the MX engine and the MX admin interface is also identical (with a parameter "Extra" that swaps between true and false depending on the log file involved). | ||
There is another logging file, [[speciallog.txt]], for detailed logging of internal temperature and humidity, but it is not split into separate files for each month. Although this exists in Cumulus 1, it appears this functionality | There is another logging file, [[speciallog.txt]], for detailed logging of internal temperature and humidity, but it is not split into separate files for each month. Although this exists in Cumulus 1, it appears this functionality will remain missing from MX. | ||
Finally, MX development has added another data log, this stores the output from [[Air Link Log.txt|air link]] sensors. | |||
{{TOCright}} | {{TOCright}} | ||
= File content = | = File content = | ||
Line 24: | Line 24: | ||
*Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Units''' box is just below the centre of that screen. | *Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Units''' box is just below the centre of that screen. | ||
*Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Units''' section at the start of that screen. | *Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Units''' section at the start of that screen. | ||
Each line has a number of fields separated by whatever symbol is defined as the list separator on your device, typically a comma (,) or a semi-colon (;). | Each line has a number of fields separated by whatever symbol is defined as the list separator on your device, typically a comma (,) or a semi-colon (;). | ||
Line 32: | Line 31: | ||
***Note that it is perfectly possible to have two successive lines in a standard log file with same time, although this should not happen in normal running, it can result from a hiccup or other interference on your device. If you are asking MX to upload the contents of this file, a second line with same time is ignored, only the first line with a particular date and time is uploaded. | ***Note that it is perfectly possible to have two successive lines in a standard log file with same time, although this should not happen in normal running, it can result from a hiccup or other interference on your device. If you are asking MX to upload the contents of this file, a second line with same time is ignored, only the first line with a particular date and time is uploaded. | ||
** All Remaining fields are spot values, either what has just been read from your station, or a derived value calculated from a set of values read from your station. For these value fields, Cumulus may have converted from the unit used by your weather station to the unit that you have requested to use, and there will be some inaccuracy inevitable in such conversions. Where the value to be stored is a real number with decimal places, Cumulus will use a decimal comma or decimal point depending on which is defined in your locale, do be careful not to change that locale if you need to change your device or update it, as Cumulus can only read files where the same decimal separator is used everywhere. | ** All Remaining fields are spot values, either what has just been read from your station, or a derived value calculated from a set of values read from your station. For these value fields, Cumulus may have converted from the unit used by your weather station to the unit that you have requested to use, and there will be some inaccuracy inevitable in such conversions. Where the value to be stored is a real number with decimal places, Cumulus will use a decimal comma or decimal point depending on which is defined in your locale, do be careful not to change that locale if you need to change your device or update it, as Cumulus can only read files where the same decimal separator is used everywhere. | ||
For ''more information'' on these files see in the '''Cumulus help''' file, in the section “The Data log file”. This is installed with Cumulus 1, but can be read with Windows after downloading from [[Software#Resources]] page in this Wiki. | For ''more information'' on these files see in the '''Cumulus help''' file, in the section “The Data log file”. This is installed with Cumulus 1, but can be read with Windows after downloading from [[Software#Resources]] page in this Wiki. | ||
= Accessing the Standard Log File = | = Accessing the Standard Log File = | ||
Please see [[Calculate Missing Values]] and [[Correcting Extremes]] for full details on relevant functionality in Cumulus software. | |||
== Access to current log by other processes == | == Access to current log by other processes == | ||
As the log file for the current month will be updated frequently by Cumulus (when it is running), Cumulus 1 applies an exclusive lock, and | As the log file for the current month will be updated frequently by Cumulus (when it is running), Cumulus 1 applies an exclusive lock, and [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=12721 conflicts] can happen if another process seeks to access this file. Consequently don't let your antivirus scans access this file, nor try to edit it outside Cumulus while Cumulus is running. Whilst MX does not apply such locks, it would be unwise to externally edit a file that is being frequently updated while MX is running. | ||
Also note these log files do not include a header line, and should not be edited to include it. | Also note these log files do not include a header line, and should not be edited to include it. | ||
== Additional ideas for how any Standard Log File can be used within Cumulus == | == Additional ideas for how any Standard Log File can be used within Cumulus == | ||
Line 110: | Line 70: | ||
#The second, which only uploads the line most recently added to the standard log file is found in the '''My SQL''' settings section of the admin interface. Find more information at [[Cumulus_MX#MySQL_settings|MySQL settings]]. In this option the default table name is "monthly", but it can be changed. | #The second, which only uploads the line most recently added to the standard log file is found in the '''My SQL''' settings section of the admin interface. Find more information at [[Cumulus_MX#MySQL_settings|MySQL settings]]. In this option the default table name is "monthly", but it can be changed. | ||
=== | ===Additional Functionality in Cumulus=== | ||
* | *Additional derived values in original Cumulus software | ||
** You can see '''[[Average_temperature | Mean temperatures]]''', '''[[Heat/cold_degree_days_and_Chill_hours | Air frosts]]''', '''[[Gale_Days |Gale days]]''', '''[[Rain_measurement#Precipitation_measurement_and_Cumulus | Rain days, Dry days]]''', and '''Total [[Windrun |Wind run]]''' using '''View''' menu displays for ''This month'', ''This period'', and ''This year'' (These figures are not stored anywhere, nor available as [[Webtags|web tags]]), but Cumulus 1 can calculate these from what it finds in the standard log files and the daily summary log. | |||
** You can use '''create missing''' button in the ''[[dayfile.txt]]'' selection in the '''Edit''' menu. | |||
** | |||
** | |||
** create the relevant monthly and/or annual '''NOAA style report''' by choosing ''NOAA Monthly Report'' or ''NOAA Annual Report''. | ** create the relevant monthly and/or annual '''NOAA style report''' by choosing ''NOAA Monthly Report'' or ''NOAA Annual Report''. | ||
***In Cumulus 1 do this from the '''View''' menu, then select the required period using the selectors. Click the ''Update Display'' button to see various statistics (including [[Average_temperature|mean temperature]]) calculated. Generation of complete NOAA reports takes most information from dayfile.txt (based on rollover to rollover meteorological days), except average wind speed and dominant wind direction (both of these it calculates from values read from the standard log files) for period in question. Finally press ''Save'' button to store the new or amended report. | ***In Cumulus 1 do this from the '''View''' menu, then select the required period using the selectors. Click the ''Update Display'' button to see various statistics (including [[Average_temperature|mean temperature]]) calculated. Generation of complete NOAA reports takes most information from dayfile.txt (based on rollover to rollover meteorological days), except average wind speed and dominant wind direction (both of these it calculates from values read from the standard log files) for period in question. Finally press ''Save'' button to store the new or amended report. | ||
*The last of these is also in MX | |||
***In Cumulus MX, use the '''Reports''' tab, then choosing ''NOAA Monthly Report'' or ''NOAA Annual Report''. A date selector allows you to choose the exact report you want, click "Load" button next to it. You can alternatively click another button to generate a missing report, or to regenerate an existing report after any corrections you have made to any standard log file relevant to that report. | |||
= | =Rules to follow if editing a standard data log= | ||
==Important Rules for Cumulus 1== | |||
*Each line must contain the fields in correct sequence (since new versions/builds can add to number of fields, Cumulus will accept different months having various row lengths i.e. older ones without the more recent fields at the end). | *Each line must contain the fields in correct sequence (since new versions/builds can add to number of fields, Cumulus will accept different months having various row lengths i.e. older ones without the more recent fields at the end). | ||
Line 193: | Line 93: | ||
* Note that some fields (e.g. those related to evaporation, UV, solar data) will only contain valid data if your station has the appropriate sensor(s) (without the sensor they contain the default value of zero), but if they apply make sure you note which are stored as integers. | * Note that some fields (e.g. those related to evaporation, UV, solar data) will only contain valid data if your station has the appropriate sensor(s) (without the sensor they contain the default value of zero), but if they apply make sure you note which are stored as integers. | ||
==Equivalent rules for MX == | |||
*All fields in all lines must contain the same character for separating one field from next and it must be consistent with whatever locale you use when you run MX (it might be set using a parameter to the command running MX, it might be set in Mono, or in Windows control panel). | *All fields in all lines must contain the same character for separating one field from next and it must be consistent with whatever locale you use when you run MX (it might be set using a parameter to the command running MX, it might be set in Mono, or in Windows control panel). | ||
Line 203: | Line 103: | ||
* For MX the rules for fields containing values are different to those for Cumulus 1, which makes it difficult to successfully edit any pre MX log files. For MX if a field can take a decimal place, it must contain a decimal figure, and it must use the correct decimal separator as defined in locale. If the field only takes integers (see [[#List_of_fields_in_the_file]]) then you cannot edit in any decimal places. | * For MX the rules for fields containing values are different to those for Cumulus 1, which makes it difficult to successfully edit any pre MX log files. For MX if a field can take a decimal place, it must contain a decimal figure, and it must use the correct decimal separator as defined in locale. If the field only takes integers (see [[#List_of_fields_in_the_file]]) then you cannot edit in any decimal places. | ||
==Importing pre-Cumulus data== | |||
If you were recording weather data manually, or with different weather station software, you might create files, using the standard data log files format, holding that pre-Cumulus data. Cumulus can treat these files just like any where it created the data log entries, and therefore you can apply any of the techniques explained in [[Calculate Missing Values]] and [[Correcting Extremes]]. | |||
The original Cumulus 1 software takes no notice of the <#recordsbegandate> see [[Webtags#Records]], so it is quite happy to process standard data logs with lines with earlier dates. The same applies to '''ExportMySQL.exe'''. However, by default, '''CumulusMX.exe''' will ignore any data log lines dated before the [[Cumulus.ini#Section:_Station|start date]] it recorded in the configuration file. | |||
===Potential issues when trying to match formats=== | |||
'''Here are some issues to consider.''' There are some postings in the Support Forum about importing past data. Essentially match the fields listed in [[Standard_log_files#List_of_fields_in_the_file|List of fields in the file]] below with the fields you have available in your source. | '''Here are some issues to consider.''' There are some postings in the Support Forum about importing past data. Essentially match the fields listed in [[Standard_log_files#List_of_fields_in_the_file|List of fields in the file]] below with the fields you have available in your source. | ||
Line 217: | Line 120: | ||
* Wind speed fields may not directly match to weather station outputs. See [[#Cumulus_Wind_Speed_Terminology]] | * Wind speed fields may not directly match to weather station outputs. See [[#Cumulus_Wind_Speed_Terminology]] | ||
* Temperature fields may not directly match to weather station outputs. Copy across the fields you can and set the others to -999.99 so they are obvious. See the [[Standard_log_files#Using_Standard_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | workaround]] described below for a way of getting Cumulus to generate (from your newly created monthly logs) apparent temperature, wind chill and heat index to replace any -999.99 figures. | * Temperature fields may not directly match to weather station outputs. Copy across the fields you can and set the others to -999.99 so they are obvious. See the [[Standard_log_files#Using_Standard_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | workaround]] described below for a way of getting Cumulus to generate (from your newly created monthly logs) apparent temperature, wind chill and heat index to replace any -999.99 figures. | ||
* Rainfall fields may not directly match to weather station outputs. [[FAQ#How_is_my_rain_rate_calculated.3F | Rain rate]] in field 8 may be generated | * Rainfall fields may not directly match to weather station outputs. [[FAQ#How_is_my_rain_rate_calculated.3F | Rain rate]] in field 8 may be generated by following advice in [[Calculate Missing Values]]. | ||
==== Cumulus Wind Speed Terminology ==== | |||
'''This section was written for the original Cumulus software'''. There are some differences in how MX reads information from weather stations, particularly those by Davis, but that should not affect content below. | |||
How wind speeds relate to various weather stations is explained in FAQ. Basically there are 3 values processed by Cumulus: | How wind speeds relate to various weather stations is explained in FAQ. Basically there are 3 values processed by Cumulus: | ||
Line 243: | Line 140: | ||
[[Windrun]] is also calculated from average wind speed measurements, in this case every minute if Cumulus is running, or from the values that are logged (at station logging interval) as average wind speed when Cumulus is restarted and catches up from the station logger. Again, if Cumulus is not left running the calculated value will be skewed. | [[Windrun]] is also calculated from average wind speed measurements, in this case every minute if Cumulus is running, or from the values that are logged (at station logging interval) as average wind speed when Cumulus is restarted and catches up from the station logger. Again, if Cumulus is not left running the calculated value will be skewed. | ||
=List of fields in the file= | |||
The table is split by Cumulus version for all changes since version 1.8.5; it shows: | The table is split by Cumulus version for all changes since version 1.8.5; it shows: | ||
#The field number | #The field number | ||
#*When this list was first produced, Cumulus | #*When this list was first produced, only the original Cumulus software was available and the decision then was to start with date in field zero to be consistent with index used for arrays in programming languages like JavaScript. | ||
#* | #*In the data log editing page of the MX admin interface, and internally in its code, MX uses field zero for the line number, and therefore the table below has been edited so that date moves to field 1. | ||
#* For each field the equivalent letter that would be seen in a spreadsheet like Libre Office, Open Office, Excel etc is also shown in first column. | #* For each field the equivalent letter that would be seen in a spreadsheet like Libre Office, Open Office, Excel etc is also shown in first column. | ||
#As a quick guide to which fields can take signs and which can not accept decimal places, the second column indicates formatting rules. | #As a quick guide to which fields can take signs and which can not accept decimal places, the second column indicates formatting rules. | ||
Line 255: | Line 152: | ||
#*Any item labelled unsigned will not accept a minus sign. Those labelled signed don't need '''+''' for positive, but do need '''-''' for negative. | #*Any item labelled unsigned will not accept a minus sign. Those labelled signed don't need '''+''' for positive, but do need '''-''' for negative. | ||
#The third column shows an example of a value accepted by Cumulus 1 | #The third column shows an example of a value accepted by Cumulus 1 | ||
#*The file content rules for MX changed in release 3.7.0, and it has not been verified that all Cumulus 1 examples are still accepted | |||
#* For Cumulus 1, where decimals are allowed, the stored value might be an integer as this depends on a number of factors, including your station type. | #* For Cumulus 1, where decimals are allowed, the stored value might be an integer as this depends on a number of factors, including your station type. | ||
#*If you are editing the values manually, you should use integers for humidity, wind bearings, and the two solar radiation figures | #*If you are editing the values manually, you should use integers for humidity, wind bearings, and the two solar radiation figures | ||
#* Note that the figure in a field varies depending on the units you select, and your weather station may not have all the sensors needed | #* In Cumulus 1 it is optional to use floating point for the others | ||
#*In Cumulus 1 any fields defined in the version you are using for sensors you do not have will always contain zero. Also, for Cumulus 1 any fields that are not defined at the version when the line was created can: | #* In Cumulus MX add a ".0" if necessary because MX must see decimal places where these are allowed | ||
#* Note that the figure in a field varies depending on the units you select, and your weather station may not have all the sensors needed | |||
#*In Cumulus 1 any fields defined in the version you are using for sensors you do not have will always contain zero. | |||
#*Also, for Cumulus 1 any fields that are not defined at the version when the line was created can: | |||
#**Either be missing (no fields seen after the last field at your version) | #**Either be missing (no fields seen after the last field at your version) | ||
#**Or can be null (field separators only are seen | #**Or can be null (field separators only are seen after the last field at your version) | ||
#* MX since version 3.7.0 is more fussy, but less consistent, certain fields contain a single space when not used, others contain zero, and others can be left empty | |||
#The final column describes the observation often with a link to where there is more information. | #The final column describes the observation often with a link to where there is more information. | ||
edits