Cumulus.ini (preserving history): Difference between revisions

m
→‎Section: Station: Minor improvement to structuring now 'station' so long
m (→‎Section: Station: Minor improvement to structuring now 'station' so long)
Line 134: Line 134:
*0 = Disabled, application will not close if you suspend/standby/hibernate your computer (it is highly recommended you close Cumulus manually before your computer is put into suspend/standby/hibernate state)   
*0 = Disabled, application will not close if you suspend/standby/hibernate your computer (it is highly recommended you close Cumulus manually before your computer is put into suspend/standby/hibernate state)   
*1 = Enabled, application will close on suspend/standby/hibernate of your computer (recommended if your computer can go into any of these states when left alone)
*1 = Enabled, application will close on suspend/standby/hibernate of your computer (recommended if your computer can go into any of these states when left alone)
|-
|RestartIfUnplugged=0
|Cumulus will restart if it detects that a Fine Offset station is unplugged.
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled as selected on the Station Configuration Screen
|-
|SyncDavisClock=0
|When set, at start-up, Cumulus will set the Davis VP/VP2 clock to the same time as the PC
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled
|-
|-
|DataLogInterval=2  
|DataLogInterval=2  
Line 197: Line 187:
|YTDrainyear=0  
|YTDrainyear=0  
|The year for which the YTDrain is to be applied. Default is 0 meaning not applied to any year.
|The year for which the YTDrain is to be applied. Default is 0 meaning not applied to any year.
|-
|EWInterval=0
|Easyweather interval in minutes as entered in the Station Configuration Screen Settings block. Default is 0 meaning not applicable as not reading [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat]] file.
|-
|EWFile=
|[[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat]] file path/name as entered in the Station Configuration Screen Settings block.
|-
|-
|UseDataLogger=1  
|UseDataLogger=1  
Line 229: Line 213:
|FChighpress=1050  
|FChighpress=1050  
|High Pressure extreme limit as entered in the Station Configuration Forecast block. Default is 1050mb
|High Pressure extreme limit as entered in the Station Configuration Forecast block. Default is 1050mb
|-
|ForceVPBarUpdate=0
|Set this in the Station Configuration Screen Settings block. Select to force the Vantage Pro (and Pro2) barometer to update once a minute instead of the default 15 minutes. Note that you may not need this, more recent stations already update every minute
*0 = Disabled
*1 = Enabled
|-
|-
|UseZeroBearing=0  
|UseZeroBearing=0  
Line 239: Line 218:
*0 = Disabled, Cumulus displays the current bearing read from the station (i.e. the last direction the wind was blowing from before it became calm). Note that the average wind bearing will always display zero bearing if there has been no wind for the last 10 minutes, as the average bearing takes wind speed into account.
*0 = Disabled, Cumulus displays the current bearing read from the station (i.e. the last direction the wind was blowing from before it became calm). Note that the average wind bearing will always display zero bearing if there has been no wind for the last 10 minutes, as the average bearing takes wind speed into account.
*1 = Enabled, Cumulus display a bearing of zero (and '---' for the compass point) when the wind is calm
*1 = Enabled, Cumulus display a bearing of zero (and '---' for the compass point) when the wind is calm
|-
|VP2ConnectionType=0
|Weather station connection type as selected in the Station Configuration Screen VP type block
*0 = serial
*1 = usb
*2 = TCP/IP
|-
|VP2TCPPort=22222
|Comunications port used if VP type has TCP/IP selected. Default is 2222
|-
|VP2IPAddr=0.0.0.0
|Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
|-
|-
|WarnMultiple=0  
|WarnMultiple=0  
Line 261: Line 228:
*0 = metres
*0 = metres
*1 = feet (default)
*1 = feet (default)
|-
|EWTempdiff=x.y
|Enter this line in the [Station] section of the Cumulus.ini to filter erroneous temperature readings from your sensor. Replace x.y with the maximum difference in degrees C you are prepared to accept between successive data readings
|-
|WMR928TempChannel=N
|For WMR928 stations (and other stations using the same protocol, eg WMR968) to use an 'extra' channel as your main temperature sensor, set N to the required channel
|-
|-
|RTdisconnectcount=N
|RTdisconnectcount=N
|By default, the 'realtime' ftp connection stays connected. You can make it disconnect periodically by adding an Option to periodically disconnect the realtime FTP connection, the theory being that it will not get stuck if the server dies, and will keep trying to reconnect.  
|By default, the 'realtime' ftp connection stays connected. You can make it disconnect periodically by adding an Option to periodically disconnect the realtime FTP connection, the theory being that it will not get stuck if the server dies, and will keep trying to reconnect.  
N must be a positive integer. For example set N to '60'; it represents the number of realtime ftp uploads between disconnections - so 60 would give an hour if 1 minute realtime interval selected.
N must be a positive integer. For example set N to '60'; it represents the number of realtime ftp uploads between disconnections - so 60 would give an hour if 1 minute realtime interval selected.
|-
|EWpressureoffset=x.y
|Got a pressure problem with a Fine Offset station? This can occur on startup when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero (so effectively you end up with your absolute pressure being recorded instead of relative pressure). There's a work around for this by telling Cumulus what offset to use, rather than reading it from the station. You specify it in cumulus.ini by adding a line to the [Station] section: where x.y is the difference between your station (absolute) and sea-level (relative) pressures, in mb/hPA.
|-
|-
|Logging=1
|Logging=1
|Add to cumulus.ini [Station] section to have Cumulus start with [[debug]] logging on
|Add to cumulus.ini [Station] section to have Cumulus start with [[debug]] logging on
|-
|VP2SleepInterval=x
|where x is sleepinterval in milliseconds
This is the period which Cumulus waits between reads of the data from Davis stations. The default is 500 ms; if you suspect that data is being missed, you could try reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
|-
|WS2300Sync=1
|This makes Cumulus check the time that the station is going to communicate with the sensors, and synchronises all of its reads to be 2.5 seconds after that. Experiments have shown that this does not help the bad data situation.
|-
|VPClosedownTime=x
|where x is the number of seconds after the start of the re-connect attempts that you want the program to close itself.
|-
|EWduplicatecheck=0
|Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.
|-
|LCMaxWind=X
|To use the cumulus.ini setting for the La Crosse max wind speed add to the [station] section, where X is the maximum (uncalibrated) wind speed in m/s that you want to allow. (V1.8.8 Build 874 on)
|-
|-
|AvgSpeedMinutes=N
|AvgSpeedMinutes=N
Line 302: Line 244:
|ListWebTags=1
|ListWebTags=1
|Add this entry to make Cumulus create (each time it is restarted) a file called webtags.txt that contains an unsorted list of all the webtags that Cumulus supports
|Add this entry to make Cumulus create (each time it is restarted) a file called webtags.txt that contains an unsorted list of all the webtags that Cumulus supports
|-
|EWmaxHourlyRain=999
|An hourly rain rate 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWmaxRainRate=999
|A rain rate 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWpressurediff=999
|A pressure change 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWhumiditydiff=999
|A humidity change 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWgustdiff=999
|A wind gust 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWwinddiff=999
|A wind speed  'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|Option to restart Cumulus if data stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
|Option to restart Cumulus if data stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
*0 = Disabled (default)
*1 = Enabled
|-
|WS2300IgnoreStationClock=0
|Option to ignore the La Crosse station clock on logger download.
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled
*1 = Enabled
Line 354: Line 273:
|When set to 1, this setting causes wind speeds rounded to the nearest integer.
|When set to 1, this setting causes wind speeds rounded to the nearest integer.
|-
|-
|VP2PeriodicDisconnectInterval=0
|ErrorLogSpikeRemoval=0
|Causes Cumulus to disconnect for the specified number of seconds, once a minute, on the minute (or as close as possible) to allow the Weatherlink IP to connect to the Davis Weatherlink site. Set it to zero to disable, if you are not using the Weatherlink site.
|??keeps the number of messages in the error log window to a maximum of 256?
|-
|UVdecimals=1
|UV values are now displayed and logged as whole numbers by default. You can change this by adding this entry specifying the number of decimal places.
*0 = Integer Values (default)
*n = Number of decimal places
|-
|NoSensorCheck=1
|The option (for 'incomplete' stations) to disable the sensor check described in this [http://wiki.sandaysoft.com/a/FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads FAQ]
*0 = Sensor check enabled (default)
*1 = Sensor check disabled
|}
 
==== Davis family specific: ====
{| 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 the station configuration.
|-
|ForceVPBarUpdate=0
|Set this in the Station Configuration Screen Settings block. Select to force the Vantage Pro (and Pro2) barometer to update once a minute instead of the default 15 minutes. Note that you may not need this, more recent stations already update every minute
*0 = Disabled
*1 = Enabled
|-
|SyncDavisClock=0
|When set, at start-up, Cumulus will set the Davis VP/VP2 clock to the same time as the PC
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled
|-
|VP2ConnectionType=0
|Weather station connection type as selected in the Station Configuration Screen VP type block
*0 = serial
*1 = usb
*2 = TCP/IP
|-
|VP2TCPPort=22222
|Comunications port used if VP type has TCP/IP selected. Default is 2222
|-
|-
|EWminpressureMB=900
|VP2IPAddr=0.0.0.0
|Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millbars)
|Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
|-
|-
|EWmaxpressureMB=1200
|VP2SleepInterval=x
|Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millbars)
|where x is sleepinterval in milliseconds
This is the period which Cumulus waits between reads of the data from Davis stations. The default is 500 ms; if you suspect that data is being missed, you could try reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
|-
|-
|ErrorLogSpikeRemoval=0
|VPClosedownTime=x
|??keeps the number of messages in the error log window to a maximum of 256?
|where x is the number of seconds after the start of the re-connect attempts that you want the program to close itself.
|-
|-
|LogExtraSensors=0
|VP2PeriodicDisconnectInterval=0
|Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't need to select this for Solar/UV sensors.
|Causes Cumulus to disconnect for the specified number of seconds, once a minute, on the minute (or as close as possible) to allow the Weatherlink IP to connect to the Davis Weatherlink site. Set it to zero to disable, if you are not using the Weatherlink site.
|-
|-
|DavisCalcAltPress=1
|DavisCalcAltPress=1
Line 377: Line 336:
*1 = Enabled (default)
*1 = Enabled (default)
|-
|-
|UVdecimals=1
|LogExtraSensors=0
|UV values are now displayed and logged as whole numbers by default. You can change this by adding this entry specifying the number of decimal places.
|Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't need to select this for Solar/UV sensors.
*0 = Integer Values (default)
|}
*n = Number of decimal places
====Introduced for problems with Fine Offset family, but may be more widely applicable:====
{| 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 the station configuration.
|-
|EWInterval=0
|Easyweather interval in minutes as entered in the Station Configuration Screen Settings block. Default is 0 meaning not applicable as not reading [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat]] file.
|-
|EWFile=
|[[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat]] file path/name as entered in the Station Configuration Screen Settings block.
|-
|RestartIfUnplugged=0
|Cumulus will restart if it detects that a Fine Offset station is unplugged.
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled as selected on the Station Configuration Screen
|-
|EWTempdiff=x.y
|Enter this line in the [Station] section of the Cumulus.ini to filter erroneous temperature readings from your sensor. Replace x.y with the maximum difference in degrees C you are prepared to accept between successive data readings
|-
|EWpressureoffset=x.y
|Got a pressure problem with a Fine Offset station? This can occur on startup when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero (so effectively you end up with your absolute pressure being recorded instead of relative pressure). There's a work around for this by telling Cumulus what offset to use, rather than reading it from the station. You specify it in cumulus.ini by adding a line to the [Station] section: where x.y is the difference between your station (absolute) and sea-level (relative) pressures, in mb/hPA.
|-
|EWmaxHourlyRain=999
|An hourly rain rate 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWmaxRainRate=999
|A rain rate 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWpressurediff=999
|A pressure change 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWhumiditydiff=999
|A humidity change 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWgustdiff=999
|A wind gust 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWwinddiff=999
|A wind speed  'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|EWduplicatecheck=0
|Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.
|-
|SyncFOReads=1
|Specifies the Fine Offset synchronisation mode of operation.
*0 = default
*1 = Re-synchronizes each day
|-
|ReportLostSensorContact=0
|Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b1070)
*0 = reporting off
*1 = reporting on (default)
|-
|EWminpressureMB=900
|Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millbars)
|-
|EWmaxpressureMB=1200
|Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millbars)
|}
==== Other specific: ====
{| 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 the station configuration.
|-
|WMR928TempChannel=N
|For WMR928 stations (and other stations using the same protocol, eg WMR968) to use an 'extra' channel as your main temperature sensor, set N to the required channel
|-
|WS2300Sync=1
|This makes Cumulus check the time that the station is going to communicate with the sensors, and synchronises all of its reads to be 2.5 seconds after that. Experiments have shown that this does not help the bad data situation.
|-
|LCMaxWind=X
|To use the cumulus.ini setting for the La Crosse max wind speed add to the [station] section, where X is the maximum (uncalibrated) wind speed in m/s that you want to allow. (V1.8.8 Build 874 on)
|-
|-
|NoSensorCheck=1
|WS2300IgnoreStationClock=0
|The option (for 'incomplete' stations) to disable the sensor check described in this [http://wiki.sandaysoft.com/a/FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads FAQ]
|Option to ignore the La Crosse station clock on logger download.
*0 = Sensor check enabled (default)
*0 = Disabled (default)
*1 = Sensor check disabled
*1 = Enabled
|-
|-
|RG11port=1
|RG11port=1
Line 405: Line 443:
|Settings to connect a second Hydreon RG-11 rain detection device.
|Settings to connect a second Hydreon RG-11 rain detection device.
Note that you must have one RG-11 set to "It's raining" mode and the other to "tipping bucket" mode. Cumulus does not validate this.
Note that you must have one RG-11 set to "It's raining" mode and the other to "tipping bucket" mode. Cumulus does not validate this.
|-
|SyncFOReads=1
|Specifies the Fine Offset synchronisation mode of operation.
*0 = default
*1 = Re-synchronizes each day
|-
|ReportLostSensorContact=0
|Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b1070)
*0 = reporting off
*1 = reporting on (default)
|}
|}


5,838

edits