Cumulus Wiki

Cumulus.ini (preserving history): Difference between revisions

Cumulus.ini (preserving history) (view source)

Revision as of 18:45, 10 January 2021

2,623 bytes added ,  18:45, 10 January 2021
m
→‎Section: Station: separated out read-only table
m (→‎Section: Solar: PLEASE ENSURE THAT THIS ARTICLE CONTINUES TO BE CORRECT FOR CUMULUS 1, WHEN MAKING ANY CHANGES RELEVANT TO MX)
m (→‎Section: Station: separated out read-only table)
Line 520: Line 520:
=== Section: Station ===
=== Section: Station ===


The read-only parameters must be entered directly into the configuration file. Stop Cumulus before editing this file using any plain text editor, not a word processor


{{Version badge 1}}The read-write parameters are set using '''Station Configuration Screen''' in Cumulus 1 (C1).  
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|-
|StartDate=13/08/2009
|This parameter is different to all the others. It is not read-write as you cannot edit it in Cumulus (1 or MX). Unlike other read-only parameters it is automatically inserted into Cumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application (whichever flavour).
This date can be included in a template file, using the tag '''<#recordsbegandate>'''. The tag appears twice in the '''recordT.htm''' template that is provided with Cumulus (1 and MX) and there is a suggestion about changing that at [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|-
|-
|LastLoggerDownload=13/08/2008 12:48:52
|The date/time of the last down load from your weather station
This parameter is different to all the others. It is not read-write as you cannot edit it, nor is it read-only as Cumulus 1 (early builds) inserts it into Cumulus.ini.
 
'''(Note: no longer used, so only present if you used an early Cumulus 1 version)''';  ''If you know which builds this parameter applies to, please update this entry.''
 
Later Cumulus 1 builds,  all Cumulus 2, and all Cumulus MX builds, use [[today.ini] to track date/time. This date/time (regardless of whether this parameter is present) is available on your website by using [[Webtags#Miscellaneous|<#LastDataReadT>]]
|UseDataLogger=1
|{{Version badge 1}}Cumulus 1.x.y: Selected in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]].
 
[[File:Badge vMx.png]]Cumulus MX: This parameter (attribute=value) is added directly to the file in the [Station] section if you want to change the default, it does not appear on the settings screen.
 
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
|}


[[File:Badge vMx.png]] The read-write parameters are set using the '''Station Settings''' page in MX.


==== Read-only parameters in the Station section ====


See individual parameters for specific instructions on setting them. The defaults are shown in left hand column, but be aware that some might have different defaults in C1 and MX, and that this article was first created when only Cumulus 1 was available.
The read-only parameters must be entered directly into the configuration file. Stop Cumulus before editing this file using any plain text editor.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 541: Line 569:
   
   
This date can be included in a template file, using the tag '''<#recordsbegandate>'''. The tag appears twice in the '''recordT.htm''' template that is provided with Cumulus (1 and MX) and there is a suggestion about changing that at [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
This date can be included in a template file, using the tag '''<#recordsbegandate>'''. The tag appears twice in the '''recordT.htm''' template that is provided with Cumulus (1 and MX) and there is a suggestion about changing that at [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|-
|UseDataLogger=1
|{{Version badge 1}}Cumulus 1.x.y: Selected in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]].
[[File:Badge vMx.png]]Cumulus MX: This parameter (attribute=value) is added directly to the file in the [Station] section if you want to change the default, it does not appear on the settings screen.
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
|-
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
Line 625: Line 661:
*  0 = Sensor check enabled (default)
*  0 = Sensor check enabled (default)
*  1 = Sensor check disabled
*  1 = Sensor check disabled
|-
|PeakGustMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini.
*With this parameter, N is the number of minutes over which Cumulus calculates its highest wind gust.
*Without this parameter, the default of 10 minutes, the international standard duration, is used.
*If you select 60, then Cumulus would calculate rolling 60-minute highest wind gust speeds.
*To be in line with met stations in Cz, select 30.
|-
|AvgSpeedMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, if you have set the next parameter so that Cumulus does its own calculation of average wind speed.
*With this parameter, N is the number of minutes over which Cumulus calculates its average speed, if you have Cumulus set to do this with the next parameter enabled.
*Without it, the default of 10 minutes, the international standard duration, is used if Cumulus is set to calculate average wind speeds.
*If you selected 60, then Cumulus would calculate rolling 60-minute average wind speeds.
*To be in line with ASOS stations in USA, select 2.
|-
|ErrorLogSpikeRemoval=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen on C1 or MX prior to v3.7.0. {{Version badge 1}}??C1 keeps the number of messages in the error log window to a maximum of 256?
[[File:Badge vMx.png]] From version 3.7.0 the default for new installs is now 1. It can be set from the calibration settings screen. It controls the logging of both data spikes and data limits being exceeded. Recommended to be turned on.
|}
==== Read-Write parameters in the Station section ====
{{Version badge 1}}The read-write parameters are set using '''Station Configuration Screen''' in Cumulus 1 (C1).
[[File:Badge vMx.png]] The read-write parameters are set using the '''Station Settings''' page in MX.
See individual parameters for specific instructions on setting them. ''The defaults for Cumulus 1 are shown in left hand column.''  '''Be aware that this article was first created when only Cumulus 1 was available; some parameters might have different defaults in C1 and MX. It may not be correctly updated for MX.'''
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|-
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
Line 695: Line 770:
*0 = metres Above Sea Level
*0 = metres Above Sea Level
*1 = feet ASL
*1 = feet ASL
|-
|PeakGustMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini.
*With this parameter, N is the number of minutes over which Cumulus calculates its highest wind gust.
*Without this parameter, the default of 10 minutes, the international standard duration, is used.
*If you select 60, then Cumulus would calculate rolling 60-minute highest wind gust speeds.
*To be in line with met stations in Cz, select 30.
|-
|AvgSpeedMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, if you have set the next parameter so that Cumulus does its own calculation of average wind speed.
*With this parameter, N is the number of minutes over which Cumulus calculates its average speed, if you have Cumulus set to do this with the next parameter enabled.
*Without it, the default of 10 minutes, the international standard duration, is used if Cumulus is set to calculate average wind speeds.
*If you selected 60, then Cumulus would calculate rolling 60-minute average wind speeds.
*To be in line with ASOS stations in USA, select 2.
|-
|-
|Wind10MinAverage=0  
|Wind10MinAverage=0  
Line 737: Line 798:
|-
|-
|CalculatedWC=0  
|CalculatedWC=0  
|Selected on same screen as other parameters. Available only from version 1.8.3
|Selected on same screen as other parameters. {{Version badge 1}} - Available only from version 1.8.3
*0 = Disabled
*0 = Disabled
*1 = Enabled, Cumulus will calculate the wind chill instead of using the value supplied by the station. You should set this if you have specified any calibration values for wind and/or temperature, so that Cumulus can also apply those adjustments to the wind chill.
*1 = Enabled, Cumulus will calculate the wind chill instead of using the value supplied by the station. You should set this if you have specified any calibration values for wind and/or temperature, so that Cumulus can also apply those adjustments to the wind chill.
Line 753: Line 814:
|-
|-
|WarnMultiple=0  
|WarnMultiple=0  
|Set as 'Stop 2nd instance' in the Station Configuration Screen Program Settings block.  Controls behaviour for Multiple Instances of Cumulus running on PC. Requires a Cumulus restart if value toggled, before new behaviour will take effect.
| Controls behaviour for Multiple Instances of Cumulus running on PC. Requires a Cumulus restart if value toggled, before new behaviour will take effect.
*0 = Disabled, (default) Multiple instances allowed.
*0 = Disabled, (default) Multiple instances allowed.
*1 = Enabled, prevents multiple instances of Cumulus from running.
*1 = Enabled, prevents multiple instances of Cumulus from running.
Not available in earliest builds of any Cumulus flavour.
 
{{Version badge 1}} - Set as 'Stop 2nd instance' in the  [[Cumulus_Screenshots#Station|Station Configuration Screen]] Program Settings block. Not available in earliest builds of Cumulus 1 flavour.
 
[[File:Badge vMx.png]] - Set as 'Stop 2nd instance' in Station Settings page. Not available in earliest builds of MX.
|-
|-
|ConfirmClose=0  
|ConfirmClose=0  
Line 780: Line 844:
Notes:
Notes:
*Some weather station types do not have an in-built logger, so Cumulus cannot read any archive data from them, and they don't have a station console logging interval, to determine what this Cumulus logging interval should be.  
*Some weather station types do not have an in-built logger, so Cumulus cannot read any archive data from them, and they don't have a station console logging interval, to determine what this Cumulus logging interval should be.  
*For a Davis station MUST set Cumulus logging interval to match your station console logging interval. (Otherwise you may activate the 'feature' in the Davis stations where they send the entire contents of the data logger when Cumulus asks for the data since it was last running). See Readme.txt. For other station types, normally set so matches station console logging interval, but this is not mandatory.
*For a Davis station you MUST set Cumulus logging interval to match your station console logging interval. (Otherwise you may activate the 'feature' in the Davis stations where they send the entire contents of the data logger when Cumulus asks for the data since it was last running). See Readme.txt. For other station types, normally set so matches station console logging interval, but this is not mandatory.
*For other makes as ''Cumulus on restarting is able (see next parameter) to read logged data from your station'' you can choose to match Cumulus and station logging intervals, then the frequency of logged information will be same regardless of whether Cumulus is running continuously or restarted (this improves accuracy of any averages calculated).
*For other makes as ''Cumulus on restarting is able (see next parameter) to read logged data from your station'' you can choose to match Cumulus and station logging intervals, then the frequency of logged information will be same regardless of whether Cumulus is running continuously or restarted (this improves accuracy of any averages calculated).
*Some Cumulus users set this Cumulus logging interval to be one of the two shorter times so they retain the maximum measurement detail in case of any need to correct rogue measurements, but have set their station logging interval at a longer time so that the station does not overwrite the memory locations over the longest period they might be away.  In this case, the frequency of logged information will change between the periods Cumulus is running and the catch-up readings from station logger when it is restarted, and all averages calculated will be less accurate if Cumulus is not running all the time.
*Some Cumulus users set this Cumulus logging interval to be one of the two shorter times so they retain the maximum measurement detail in case of any need to correct rogue measurements, but have set their station logging interval at a longer time so that the station does not overwrite the memory locations over the longest period they might be away.  In this case, the frequency of logged information will change between the periods Cumulus is running and the catch-up readings from station logger when it is restarted, and all averages calculated will be less accurate if Cumulus is not running all the time.
|-
|UseDataLogger=1
|{{Version badge 1}}Cumulus 1.x.y: Selected in the Station Configuration Screen Settings block.
[[File:Badge vMx.png]]Cumulus MX: This parameter (attribute=value) is added directly to the file in the [Station] section if you want to change the default, it does not appear on the settings screen.
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
|-
|-
|WindUnit=0  
|WindUnit=0  
Line 822: Line 880:
|LocDesc=  
|LocDesc=  
|A '''Description''' for the location (as entered on the same screen as other parameters) - inserted after 'Welcome to ' on 'Now' web page.
|A '''Description''' for the location (as entered on the same screen as other parameters) - inserted after 'Welcome to ' on 'Now' web page.
|-
|LastLoggerDownload=13/08/2008 12:48:52
|The date/time of the last down load from your weather station '''(note: no longer used, so only present if you used an early Cumulus 1 version)'''; Later Cumulus 1 builds and all 2 and MX builds use [[today.ini] to track date/time. This date/time (regardless of whether this parameter is present) is available on your website by using [[Webtags#Miscellaneous|
<#LastDataReadT>]]
|-
|-
|RainSeasonStart=1
|RainSeasonStart=1
Line 868: Line 922:
|-
|-
|DataLogging=0
|DataLogging=0
|This parameter (attribute=value) determines if when you next start Cumulus it will send enhanced information to the [[debug]] file. It appears on a configuration screen in Cumulus 1 and in the station settings options section in MX.  With Cumulus stopped, you can edit the setting in the file and the new setting will apply when Cumulus is next started and it sets a local value by reading the configuration file. Debugging can also be switched on while you are running Cumulus of any flavour, the new setting of enhanced debugging will stop when you exit Cumulus as you only edit the value held locally (you don't edit the configuration file).
|This parameter (attribute=value) determines if when you next start Cumulus it will send enhanced information to the [[debug]] file. It appears on a configuration screen in Cumulus 1 and in the station settings options section in MX.   
 
With Cumulus stopped, you can edit the setting in the file and the new setting will apply when Cumulus is next started and it sets a local value by reading the configuration file. Debugging can also be switched on while you are running Cumulus of any flavour, the new setting of enhanced debugging will stop when you exit Cumulus as you only edit the value held locally (you don't edit the configuration file).
*0 = default of normal output
*0 = default of normal output
*1 = Set it to 1 to enable the enhanced output to the log that aids debugging if there is a problem.
*1 = Set it to 1 to enable the enhanced output to the log that aids debugging if there is a problem.


The parameter is ignored for MX prior to build 3018 but {{Version badge 1}}available in all Cumulus 1 builds.
The parameter is ignored for MX prior to build 3018 but {{Version badge 1}}available in all Cumulus 1 builds.
|-
|ErrorLogSpikeRemoval=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen on C1 or MX prior to v3.7.0. {{Version badge 1}}??C1 keeps the number of messages in the error log window to a maximum of 256?
[[File:Badge vMx.png]] From version 3.7.0 the default for new installs is now 1. It can be set from the calibration settings screen. It controls the logging of both data spikes and data limits being exceeded. Recommended to be turned on.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|colspan="2" style="background:lightblue;"| Cumulus 1 only
Line 905: Line 956:
|-
|-
|Logging=0
|Logging=0
|This parameter can be edited in the file or in station settings or by use of a parameter when starting MX. It controls whether MX stores extra diagnostic information about its interaction with the weather station.
|This parameter can be edited in the file, or in station settings, or by use of a parameter when starting MX. It controls whether MX stores extra diagnostic information about its interaction with the weather station.
|-
|-
|RecordSetTimeoutHrs=24
|RecordSetTimeoutHrs=24
Sfws
5,838

edits

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