Cumulus.ini (Cumulus 1): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (Cumulus 1) (view source)

Revision as of 16:32, 30 May 2022

4,911 bytes added ,  16:32, 30 May 2022
m
→‎Completeness for original Cumulus software: Rewritten, because some information was out of date
(Page given new name)
 
m (→‎Completeness for original Cumulus software: Rewritten, because some information was out of date)
 
(8 intermediate revisions by the same user not shown)
Line 26: Line 26:
===Completeness for original Cumulus software===
===Completeness for original Cumulus software===


'''There is no guarantee that all configuration parameters that can be used (if you are running the original software) are in this list'''
This page was originally created when only Cumulus 1 was available.  It can be assumed that all parameters included here, do apply to the final formal release.  When Steve Loft wrote his software in 2008, it seemed reasonable to only specify the choice of years up to 2020 in various selection drop-downs.  Mark Crossley has supplied a patch that does not change any of the code, but does change the selection drop downs, and they now expire in 2030. Since 2020s have now been reached, it is to your benefit to upgrade to final '''legacy release''' and apply the patch to the GUI. Both final version and patch can be [[Downloads|downloaded here]].
 
'''There is no guarantee that all configuration parameters that can be used (if you are running the original software) are in this list'''.  Some of this Wiki page was written by Steve Loft, although his entries will be correct, they might not cover all parameters, and they might have been edited by other contributors who might have made errors.
 
The read-write parameters are correctly specified, as they have been checked against [[Cumulus Screenshots|Configuration screens]].  Please note, there may be typing errors in the explanations of these parameters, where possible text not supplied by Steve Loft directly in this page, has been lifted from text he specified in the Cumulus help, or [https://cumulus.hosiene.co.uk/viewforum.php?f=4 the Cumulus Support Forum], but even cut and paste can be done wrongly!
 
There is no source available for Cumulus 1, so nobody can check what read-only parameters are available against what is documented below. For read-only parameters there may be errors in both the actual parameter and the explanation!
 
If you spot a parameter that is missing from this list (check you are looking in the right section, and under the correct sub-heading where a section is sub-divided for ease of using this article), or wrongly described, then please let administrators of this Wiki know via  the [https://cumulus.hosiene.co.uk/viewforum.php?f=38 Cumulus support sub-forum for Wiki corrections]. None of the authors who have contributed so far can claim completeness.  Sometimes a search on the forum for something else reveals a mention of an additional parameter that can be added to the file but has not been previously added to this list.


''The problem is that Steve Loft lost some of his documentation and admitted he could not remember all parameters his code could process.''
''The problem is that Steve Loft lost some of his documentation and admitted he could not remember all parameters his code could process.''
Line 33: Line 41:
* Steve Loft (as developer) did make some entries that are retained on this page (those should be correct)
* Steve Loft (as developer) did make some entries that are retained on this page (those should be correct)
*Steve Loft also described in his posts on the forum a number of parameters and how they are used (hopefully all those have been copied into this page, but on 2 June 2008, Steve Loft swapped to new forum software and did not retain any posts prior to then, so there is no way to check the relevant posts between 2003 when the software was first released and May 2008)
*Steve Loft also described in his posts on the forum a number of parameters and how they are used (hopefully all those have been copied into this page, but on 2 June 2008, Steve Loft swapped to new forum software and did not retain any posts prior to then, so there is no way to check the relevant posts between 2003 when the software was first released and May 2008)
*Each contributor may also add/edit entries because of a personal experience of using a particular parameter
* ''Please note, this page can only be edited by an administrator, to prevent a MX user changing the wrong page.''  However, there may still be errors in this Wiki page, as mentioned above, please report any errors you find in the [https://cumulus.hosiene.co.uk/viewforum.php?f=38 Cumulus support sub-forum for Wiki corrections].  
 
The read-write parameters are correct, as they have been checked against [[Cumulus Screenshots|Configuration screens]]. There is no source available for Cumulus 1, so nobody can check what read-only parameters are available against what is documented below. 
 
This page was originally created when only Cumulus 1 was available. It was updated each time there was a major release, some updates mention the release that introduced that parameter. It can be assumed that all parameters marked as applicable to Cumulus 1, do apply to the final formal release.  
 
If you are still using an earlier version of Cumulus 1, it cannot be assumed that all parameters that do not apply to your version are identified. Since the final version of Cumulus 1 cleared most of the bugs present in earlier releases (not quite all, this is still a bug relating to reading pressure from Fine Offset stations), it is to your benefit to upgrade to final '''legacy release''' and apply the patch to the GUI. Both final version and patch can be [[Downloads|downloaded here]].


If you spot a parameter that is missing from this list (check you are looking in the right section, and under the correct sub-heading where a section is sub-divided for ease of using this article), then please add it to this Wiki article. None of the authors who have contributed so far can claim completeness.  Sometimes a search on the forum for something else reveals a mention of an additional parameter that can be added to the file but has not been previously added to this list.
If you are still using an earlier version of Cumulus 1, it cannot be assumed that all parameters that do not apply to your version are identified. This Wiki page was updated each time there was a major release, and where possible updates mention the release that introduced that parameter, so the documentation can be used for those not running final legacy release.  The final version of Cumulus 1 appears to have successfully cleared most of the bugs present in earlier releases (not quite all, it is known that final release still contained a bug relating to reading pressure from Fine Offset stations from wrong pair of memory locations, so the reported pressure may be wrong).


== Beta builds ==
== Beta builds ==
Line 166: Line 168:
'''(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.''
'''(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>]]
Later Cumulus 1 builds use [[today.ini] to track date/time. This date/time (regardless of whether the tracking parameter is present in Cumulus.ini or today.ini) is available on your website by using [[Webtags#Miscellaneous|<#LastDataReadT>]]
|-
|-
|UseDataLogger=1
|UseDataLogger=1
Line 222: Line 224:
|-
|-
|SnowDepthHour=9
|SnowDepthHour=9
|If this parameter is not included in the file, then any snow entries in the [[Weather Diary]] for a particular date will continue to be used {{Version badge 1}} in output by Cumulus 1 until 9am the next morning, when entries for the current date will apply.  
|If this parameter is not included in the file, then any snow entries in the [[Weather Diary]] for a particular date will continue to be used, in output, until 9am the next morning, when entries for the current date will apply.  
*Allowed values are the integers 0 to 23
*Allowed values are the integers 0 to 23
*The time is constant year round, in UK "a day of snow" could (before climate change) happen in April despite that being after swapping to summer (daylight saving) time.
*The time is constant year round, in UK "a day of snow" could (before climate change) happen in April despite that being after swapping to summer (daylight saving) time.
Line 248: Line 250:
| * When set to 1 (default) stops new Longest Wet/Dry Period records being 'flashed' in Cumulus 1
| * When set to 1 (default) stops new Longest Wet/Dry Period records being 'flashed' in Cumulus 1
* Set to 0 if you are happy to have the record light on your Cumulus 1 main screen flash for each rainfall update
* Set to 0 if you are happy to have the record light on your Cumulus 1 main screen flash for each rainfall update
[[File:Badge vMx.png]]It is not clear if MX reads this parameter, as it does not show this record on the admin interface dashboard
|-
|-
|FCPressureThreshold=0.1  
|FCPressureThreshold=0.1  
Line 277: Line 277:
#wind speed
#wind speed
#pressure
#pressure
This parameter allows disabling of that sensor check:
This parameter allows disabling of that sensor check:
*  0 = Sensor check enabled (default)
*  0 = Sensor check enabled (default)
Line 298: Line 299:
==== Read-Write parameters in the Station section ====
==== Read-Write parameters in the Station section ====


The read-write parameters are set using '''Station Configuration Screen''' in Cumulus 1 (C1). ''The defaults for Cumulus 1 are shown in left hand column.''  
The read-write parameters are set using '''Station Configuration Screen'''. ''The defaults (that apply unless you use that screen to change settings) are shown in left hand column.''  


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 309: Line 310:
|-
|-
|Type= -1  
|Type= -1  
|Station Type as set by the checked radio box in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]], Station Type block.  For details of [[Supported_Devices]] click that link.
|Station Type as set by the checked radio box in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]], Station Type block.  For details of [[Supported_Devices]] click that link, as it explains which weather station types are equivalent to the ones available as options on the screen.
*-1= default value, before a selection from those below is made. In Cumulus 1, this causes the configuration screen to be shown so that you start set up. In MX a message appears in the terminal (Windows command) screen saying that station type not known (see [[#Cumulus_MX|#Cumulus_MX section]] above.
*-1= default value, before a selection from those below is made, this causes the configuration screen to be shown when you start the software.
*0=Vantage Pro station
*0=Vantage Pro station
*1=Vantage Pro2 station
*1=Vantage Pro2 station
Line 365: Line 366:
*0 = metres Above Sea Level
*0 = metres Above Sea Level
*1 = feet ASL
*1 = feet ASL
|-
|CalculatedDP=0
|Selected on same screen as other parameters. Simple tick or not, available from version 1.1 onwards, not implemented correctly for Fine Offset until 1.8.5:
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will '''calculate dew point from temperature and humidity'''
* Don't tick (value shown as 0 in Cumulus.ini) action depends on '''Calibration settings'''
** If Cumulus has non-default multiplier and/or offset settings for temperature or humidity, from 1.8.3, Cumulus will calculate dew point. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
** If station provides dew point, then from 1.8.3 that will be used provided no multiplier/offsets have been specified for temperature or humidity
** If station does not provide dew point, then Cumulus will calculate it anyway
** For LaCrosse stations from build 1083, calculation reports normal temperature if humidity reported by station is zero.
** From version 1.8.8 added ability to calulate dew point when humidity is 100%
Note that Cumulus also calculates wet bulb temperature, irrespective of this setting; extremes for dew point were added in version 1.9.1
|-
|CalculatedWC=0
|Selected on same screen as other parameters.  Available only from version 1.8.3 beta builds.  Simple tick or not:
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will '''calculate wind chill from temperature and wind speed'''
** Note that there is a maximum temperature, and minimum wind speed, for Cumulus to make the calculation, see [[Wind_chill]] page
* Don't tick (value shown as 0 in Cumulus.ini), from later builds in 1.8.3, action depends on '''Calibration settings'''
** If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill
** If station provides wind chill, then that will be used provided no multiplier/offsets have been specified for temperature or wind speed
Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
|-
| PeakGustMinutes=10
|Selected on same screen as other parameters.
Select the number of minutes, 'N', over which wind speeds are averaged, default is 10, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]], next two parameters determine how this parameter is used.
|-
|-
|Wind10MinAverage=0  
|Wind10MinAverage=0  
|Selected on same screen as other parameters.
|Selected on same screen as other parameters.
*0 = Disabled (default), Cumulus will display the value supplied by the station. This is a 10 minute average for Davis stations, but an average over a shorter period for Oregon Scientific and Fine Offset stations, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
 
*1 = Enabled, Cumulus will calculate and display a N-minute average wind speed where N is defined by the previous parameter if present, otherwise defaults to 10, the international standard duration used to calculate average wind speeds.
The average wind speed supplied by a Davis station is calculated by considering all wind speed measurements over a ten minute period, the international standard duration used to calculate average wind speeds. Other weather station types output an average over a shorter period (e.g. Oregon Scientific and Fine Offset stations).
*0 = Disabled (default), Cumulus will display the value supplied by the station, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*1 = Enabled, Cumulus will calculate and display a N-minute average wind speed where N is defined by the previous parameter if present, otherwise defaults to 10
|-
|-
|UseSpeedForAvgCalc=0
|UseSpeedForAvgCalc=0
|Selected on same screen as other parameters.
|Selected on same screen as other parameters.
Determines how Cumulus does '''the average speed and wind run calculations''' (the preceding 'Wind10MinAverage' option must be enabled for this parameter to have any effect):
*0 = Disabled (default), Cumulus will display the average wind speed value supplied by the station, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*0 = Disabled (default), Cumulus will display the average wind speed value supplied by the station, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*1 = Enabled,  Cumulus will use the longer-term 'speed' values in the average speed calculation. The preceding 'Wind10MinAverage' option must be enabled for this parameter to have any effect.
*1 = Enabled,  Cumulus will use the longer-term (calculated as specified in last parameter) values for this calculation.  
Note that there isn't really any point enabling this option for Davis stations, as their 'longer-term speed' is a 10 minute average anyway; neither for La Crosse stations, as they only supply one wind speed anyway.
Note that enabling this option makes a Fine Offset station give much better agreement with a Davis station; there isn't really any point enabling this option for Davis stations, as their 'longer-term speed' is a 10 minute average anyway; it is not useful for La Crosse stations, as they only supply one wind speed anyway.
|-
|-
|RoundWindSpeed=0
|RoundWindSpeed=0
Line 386: Line 416:
*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 N minutes (where N is defined by previous parameter if present but defaults to 10), 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 N minutes (where N is defined by previous parameter if present but defaults to 10), 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 (note when not calm, bearing is 360 for true North)
*1 = Enabled, Cumulus display a bearing of zero (and '---' for the compass point) when the wind is calm (note when not calm, bearing is 360 for true North)
|-
|CalculatedDP=0
|Selected on same screen as other parameters.
*0 = Disabled, Cumulus will display the dew point value supplied by the station.
*1 =  Enabled, Cumulus will calculate the dew point instead. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
|-
|CalculatedWC=0
|Selected on same screen as other parameters.  Available only from version 1.8.3
*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.
Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
|-
|-
|RolloverHour=0  
|RolloverHour=0  
Line 513: Line 532:
|-
|-
|SpecialLog=0
|SpecialLog=0
|In Cumulus 1 there is an option of whether to record temperature and humidity (both indoor and outside values) in a log:
|There is an option of whether to record temperature and humidity (both indoor and outside values) in a single continuous log:
* 0 (default) = no special log
* 0 (default) = no special log
* 1 = Add this entry to start updating a file called 'speciallog.txt' in the data folder with the following fields:
* 1 = Add this entry to start updating a file called 'speciallog.txt' in the data folder with the following fields:


date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dew point,outside temp,outside humidity,outside dew point
#date(dd/mm/yy),
#time(hh:mm),
#inside temp,
#inside humidity,
#inside dew point,
#outside temp,
#outside humidity,
#outside dew point


See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
Line 525: Line 551:
*0 = Disabled, application will close immediately
*0 = Disabled, application will close immediately
*1 = Enabled, application will prompt for confirmation that you wish to close it (do not use this if you might suspend/standby/hibernate your computer)
*1 = Enabled, application will prompt for confirmation that you wish to close it (do not use this if you might suspend/standby/hibernate your computer)
'''You should not select the next parameter 'CloseOnSuspend' if you use this option.'''
|-
|-
|CloseOnSuspend=1  
|CloseOnSuspend=1  
|If this is selected, in the Station Configuration Screen Program Settings block, Cumulus will close if you suspend/standby/hibernate your computer.  You should not select the previous parameter 'ConfirmClose' if you use this option.
|If this is selected, in the Station Configuration Screen Program Settings block, Cumulus will close whenever you suspend/standby/hibernate your computer.
*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)
 
'''You should not select the previous parameter 'ConfirmClose' if you use this option.'''
|}
|}


==== Davis family specific: ====
==== Spike Removal ====


Support for Davis Vantage pro 2 was introduced at version 1.6.0. Prior to 1.9.x, not all parameter settings listed were available, check with release notes for your version and previous versions to see all settings applicable to any earlier version you use. "The DLL" is a Windows Dynamic Link Library supplied by Davis for third parties to use when writing software for Davis stations. It handles fetching data from the console, and does all kinds of useful things like converting the data into the units you require.
'''The Cumulus help file says''' - "The "Spike removal" section allows you to specify the maximum differences between successive readings that you wish to allow, for Fine Offset and La Crosse stations. If a reading differs from the previous reading by the value you specify, or more, then it will be ignored. Be careful in your choice of values; if the difference is genuine, (i.e. not a 'spike') and exceeds your supplied value, then that reading will be 'stuck' at the previous value until a new reading returns to within your supplied difference.
 
Note that the spike removal values must be supplied in the 'native' units of the station, as shown on the screen. The gust value has no effect on La Crosse stations, as it only supplies one wind value - 'spike removal' is applied at the station level, unlike offsets and multipliers which are applied at a 'common' level; just use the 'wind speed' value."
 
*This section has the parameters are listed with defaults applicable up to Cumulus 1.9.4.
**7 of the 10 spike removal parameters listed below are adjusted in the frame at the bottom of the ''Calibration'' screen, off '''Configuration''' menu, they have a prefix of EW because they were introduced for dealing with problems seen in the Fine Offset family; the corrections are only applied when Cumulus 1 is reading directly from the station at a very frequent interval, spike removal does not apply when Cumulus is re-started and is transferring observations from the station logger to the Cumulus monthly log.
**The other 3 spike removal parameters have to be entered directly in cumulus.ini, none of these ones can be set on the 'calibration' screen.
**As Cumulus 1 does not check station type before applying any of these settings, ensure for Davis stations (these do not have spike problems) the spike removal filters are set to the defaults shown below.
**However, spike removal correction may be implemented for La Crosse stations, they can have problems with their PC interface, using the same EW filter settings listed below.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 544: Line 581:
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped.
|EWMaxRainTipDiff=30
|-
|Add this line to cumulus.ini [Station] section
|VP2SleepInterval=500
Cumulus  has a configurable threshold for the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips.
|This read-only parameter is the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds. The default if the parameter has not been added manually to the file is 500 ms; if you suspect that data is being missed, you could add this parameeter, manually reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions. See note in ''readme.txt'' about VP2SleepInterval - in v1.9.3 release it is around line 50. Related FAQ: [[FAQ#My_Davis_station_shows_a_higher_maximum_wind_speed_than_Cumulus]]
 
|-
Default=30 tips in Cumulus 1
|VPClosedownTime=x
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. x is the number of seconds after the start of the re-connect attempts that you want the program to close itself (added v.1.8.5 b.726).
|-
|DavisCalcAltPress=1
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  Davis stations calculate Sea Level Pressure from Station Pressure using a formula based on several parameters such as temperature, humidity, etc, rather than just using altitude as most other stations. CWOP require 'Altimeter Pressure' to be uploaded, i.e. a value calculated simply using altitude.


The station does not provide this value directly, nor the station pressure, so Cumulus 1.x.x has to read some extra data once a minute in order to do the calculation. This can take several seconds, so it means that a 'normal' data reading may be missed.  
For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds.


If you don't use CWOP, or you are happy for Cumulus to send Sea-Level pressure to CWOP (the difference is small unless you are at high altitude), set this value to 0.
This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>.
Cumulus will then use the Sea-Level Pressure value instead of the Cumulus calculated Altimeter Pressure.
*0 = Disabled
*1 = Enabled (default)
|-
|-
|colspan="2" style="background:lightblue;"| Read-write parameters: for Cumulus 1 edit in Station Configuration Screen
|EWmaxHourlyRain=999
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
An hourly rain count 'spike removal' filter for weather stations that do not supply this figure so Cumulus has to calculate it.
Any ''changes in calculated value'', between one calculation and the next, greater than the value specified here will be ignored by Cumulus when it calculates the hourly rain total.
Cumulus ignores this parameter if the weather station directly supplies this figure to Cumulus. '''999''' is the default indicating no spike removal required.
|-
|-
|ForceVPBarUpdate=0
|EWmaxRainRate=999
|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
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
*0 = Disabled
 
*1 = Enabled
A rain rate 'spike removal' filter, ''changes in calculated value'', between one calculation and the next, greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus when it calculates the rain rate.
 
Cumulus ignores this parameter for other makes of weather station (they supply a rain rate to Cumulus). The default value of '''999''' also effectively makes Cumulus ignore spike removal.
|-
|-
|SyncDavisClock=0  
|EWgustdiff=999.0
|Set this in the Station Configuration Screen '''Settings''' block where called '''Synchronize station clock'''.
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
 
*0 = Disabled, default (as deselected on the Station Configuration Screen)
A wind gust 'spike removal' filter, ''changes in calculated value'' between one calculation and the next, greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus.
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
|-
|-
|ClockSettingHour=4
|EWwinddiff=999.0
|Configuration file read-only setting, controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
*4 = 04:00 (default value)
 
*0-23 = 00:00 to 23:00
A wind speed  'spike removal' filter, ''changes in calculated value'' between one calculation and the next greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus
|-
|-
|VP2ConnectionType=1
|EWpressurediff=999.0
|Weather station connection type that is selected in the ''Station'' Configuration Screen '''Davis type''' block
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A pressure change 'spike removal' filter, ''changes in read value'', from one reading to the next, off any station greater than the value (always mb) specified here (with a default of '''999.0''') will be ignored by Cumulus
*0 = serial (see next parameter to specify COM port)
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
*2 = TCP/IP (see later parameters to specify ports)
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
|-
|-
|VP2TCPPort=22222
|EWminpressureMB=900
|Set this in the Station Configuration Screen '''Davis TCP/IP Settings''' block.
|Add this line to cumulus.ini [Station] section
Comunications port used if VP type has TCP/IP selected. Default is 2222
 
Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
|-
|-
|VP2IPAddr=0.0.0.0
|EWmaxpressureMB=1200
|Set this in the Station Configuration Screen  '''Davis TCP/IP Settings''' block.
|Add this line to cumulus.ini [Station] section
Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
 
Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars).
|-
|-
|VP2PeriodicDisconnectInterval=0
|EWTempdiff=999.0
|Set this in the Station Configuration Screen '''Settings''' block with the ''Discon period'' value.
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A temperature change 'spike removal' filter.
When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.


Set it to zero to disable, if you are not using the Weatherlink site.
Replace default of 999.0 with the maximum difference in degrees Celsius (the units Cumulus uses for all calculations regardless of what you select for display) you are prepared to accept between successive data readings.
|-
|-
|LogExtraSensors=0
|EWhumiditydiff=999.0
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. 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 select this for Solar/UV sensors.
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.  
 
A humidity change 'spike removal' filter, ''changes in read value'' from any station greater than the value (as %) specified here (with a default of '''999.0''') will be ignored by Cumulus.
|-
|-
|DavisRainCollectorModel=X
|ErrorLogSpikeRemoval=0
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. (Available from Build 1096 of version 1.9.4)
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen on C1.
Option to specify rain collector model for Davis stations '''for situations where the Davis DLL is unable to read it from station''' (what it reads from station is default if this parameter is not present), and your rain figures in Cumulus are incorrect as a result (can happen when using Virtual VP, for example).
Value X is an integer from 0 to 5 with the following meanings:
*Default is zero as shown, disabling the spike removal feature.
*0 = 0.1 inch
*Add this line to file with Cumulus 1 stopped, and set to 1 for the spike removal feature to be enabled.  
*1 = 0.01 inch
 
*2 = 0.2 mm
??It appears that Cumulus software limits the number of messages in the error log window to a maximum of 256, so that limit may affect reporting of spike removal, but hopefully it does not restrict the functionality of spike removal ?? '''Could someone verify that, and update this entry'''
*3 = 1 mm
*4 = 'other' inch
*5 = 'other' mm
Davis have not documented what calculations the DLL does for options 4 and 5.  If this line is not included in '''cumulus.ini''' the DLL will use whatever type the station tells it to use
|-
|Port=0
|{{Version badge 1}}Set this in the Station Configuration Screen '''Serial Port''' block.
Identifies COM Port used if Davis type is serial. Default is 0.
|-
|RestartIfDataStops=0
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
*0 (default) = Cumulus will just stop logging, and processing data, if it has had no data from the Davis station for 60 seconds. As it says in the Cumulus 1 help, use of this parameter may not fix a connection problem. With this default setting a connection problem stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
*1 = Cumulus 1 attempts to restart itself if it has had no data from the station for 60 seconds. Davis stations can use this option explained in the [[#La_Crosse_specific:|La Crosse]] table if Cumulus sometimes fails to read information from the logger. Again, this may not fix the problem, but this setting does force Cumulus to have another attempt after making a new connection on start up.
|-
|Port=0
|Set this in the Station Configuration Screen '''Serial Port''' block.
Identifies COM Port used if Davis type is serial. Default is 0.
|}
|}


====Introduced for problems with Fine Offset family:====


*These parameters were introduced for Cumulus 1 to cope with Fine Offset stations and their clones, but a few of the parameters below may be found to be useful more widely.
==== Davis family specific: ====
*Some parameters are set on screens, other attributes do not appear in the '''cumulus.ini''' file unless they are added using an external editor, but the values still have a recommended default value as explained below.


Support for Davis Vantage pro 2 was introduced at Cumulus version 1.6.0. Prior to 1.9.x, not all parameter settings listed were available, check with release notes for your version and previous versions to see all settings applicable to any earlier version you use. "The DLL" is a Windows Dynamic Link Library supplied by Davis for third parties to use when writing software for Davis stations. It handles fetching data from the console, and does all kinds of useful things like converting the data into the units you require.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 643: Line 659:
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped.
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped.  
|-
|-
|FOReadAvoidPeriod=3
|VP2SleepInterval=500
|Add this line to cumulus.ini [Station] section if you wish to change the default, this parameter used to fine-tune the previous parameter.
|This read-only parameter is the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds. The default if the parameter has not been added manually to the file is 500 ms; if you suspect that data is being missed, you could add this parameter, manually reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions. See note in ''readme.txt'' (file provided with the Cumulus software) about VP2SleepInterval - in Cumulus v1.9.3 release find the note around line 50. Related FAQ: [[FAQ#My_Davis_station_shows_a_higher_maximum_wind_speed_than_Cumulus]]
*2 Minimum value
*3 = default value
Sets the interval (in seconds) during each 48 (or 60 for some models in Cumulus 1) second of station logging period when Cumulus will avoid reading the station data to try and minimise lock ups. If the clock drifts more than this value in 24 hours, then Cumulus may cause the station to lock up when reading the data. The actual station clock drift gets logged to the diags file when the re-synchronise (see last parameter) takes place, this will give an idea of whether it would be useful to adjust this setting.
|-
|-
|ReportLostSensorContact=0
|VPClosedownTime=x
|Add this line to cumulus.ini [Station] section
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. x is the number of seconds after the start of the re-connect attempts that you want the program to close itself (added v.1.8.5 b.726).
*0 = reporting off
*1 = reporting on (default)
Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b.1070)
|-
|-
|EWdisablecheckinit=0
|DavisCalcAltPress=1
|Add this line to cumulus.ini [Station] section if application gets stuck when Cumulus starts up connected to a Fine Offset (clone) station (added Cumulus version 1.9.2, build 1011).
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Davis stations calculate Sea Level Pressure from Station Pressure using a formula based on several parameters such as temperature, humidity, etc, rather than just using altitude as most other stations. CWOP require 'Altimeter Pressure' to be uploaded, i.e. a value calculated simply using altitude.
*0 = Disabled, default, it checks the first two bytes of the Fine Offset station's memory.  
 
*1 = Ignores part of memory (see [[FAQ#When_I_start_Cumulus.2C_I_get_the_error_message_.22The_station_is_not_initialised.22]]).
The station does not provide this value directly, nor the station pressure, so Cumulus 1.x.x has to read some extra data once a minute in order to do the calculation. This can take several seconds, so it means that a 'normal' data reading may be missed.  
 
If you don't use CWOP, or you are happy for Cumulus to send Sea-Level pressure to CWOP (the difference is small unless you are at high altitude), set this value to 0.
Cumulus will then use the Sea-Level Pressure value instead of the Cumulus calculated Altimeter Pressure.
*0 = Disabled
*1 = Enabled (default)
|-
|-
|EWduplicatecheck=0
|colspan="2" style="background:lightblue;"| Read-write parameters: for Cumulus 1 edit in Station Configuration Screen
|Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.
|-
Introduced in version 1.8.5 (b.630) to deal with certain bytes being given the same value in first and second line.
|ForceVPBarUpdate=0  
*0 = Disabled, default, Cumulus accepts all bytes from the Fine Offset station's memory.
|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
*1 = Ignores part of memory (see [https://cumulus.hosiene.co.uk/viewtopic.php?f=13&t=393 this forum thread]).
*0 = Disabled
For example one problem is that "55 AA" repeats at the start of the second line of data. Those bytes are only supposed to appear at the start of the first line (or so I am told).
*1 = Enabled
|-
|-
|EWpressureoffset=x.y
|SyncDavisClock=0
|Add this line to cumulus.ini [Station] section
|Set this in the Station Configuration Screen '''Settings''' block where called '''Synchronize station clock'''.
Got a pressure problem with a Fine Offset station when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero?
When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
 
*0 = Disabled, default (as deselected on the Station Configuration Screen)
Tell Cumulus what offset to use, by using an external text editor to insert this parameter where x.y is your pressure offset in  in mb or hPa [i.e. your station (absolute) pressure subtracted from the sea-level (relative) pressure].
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
|-
|-
|RestartIfUnplugged=0
|ClockSettingHour=4
|This is set in the settings frame on the Station settings screen off the configuration menu.
|Configuration file read-only setting, controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*0 = Disabled, default i.e. deselected on the Station Configuration Screen
*4 = 04:00 (default value)
*1 = Enabled, Cumulus will restart if it detects that a Fine Offset station is unplugged. '''Note:''' Unless the station has been manually plugged in again, a Cumulus restart has no benefit; normally the station should be checked to be plugged in before Cumulus is ever started and the station then left plugged in.
*0-23 = 00:00 to 23:00
|-
|-
|SyncFOReads=0
|VP2ConnectionType=1
|Default is disabled
|Weather station connection type that is selected in the ''Station'' Configuration Screen '''Davis type''' block
*0 = Synchronisation disabled, default (Cumulus reads the memory without taking into account when memory is being updated)
*0 = serial (see next parameter to specify COM port)
*1 = Re-synchronizes once each day, to avoid reading memory at time of memory update
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
A Fine Offset station will be writing to its memory every 48 or 60 seconds (depending on model); Cumulus can attempt once a day to identify when this update of memory occurs, and thereafter try not to read the memory at update time, by using what is called a synchronisation mode of operation. See next parameter.
*2 = TCP/IP (see later parameters to specify ports)
|}
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
 
==== Spike Removal ====
 
'''The Cumulus help file says''' - "The "Spike removal" section allows you to specify the maximum differences between successive readings that you wish to allow, for Fine Offset and La Crosse stations. If a reading differs from the previous reading by the value you specify, or more, then it will be ignored. Be careful in your choice of values; if the difference is genuine, (i.e. not a 'spike') and exceeds your supplied value, then that reading will be 'stuck' at the previous value until a new reading returns to within your supplied difference.
 
Note that the spike removal values must be supplied in the 'native' units of the station, as shown on the screen. The gust value has no effect on La Crosse stations, as it only supplies one wind value - 'spike removal' is applied at the station level, unlike offsets and multipliers which are applied at a 'common' level; just use the 'wind speed' value."
 
*This section has the parameters are listed with defaults applicable up to Cumulus 1.9.4.
**7 of the 10 spike removal parameters listed below are adjusted in the frame at the bottom of the ''Calibration'' screen, off '''Configuration''' menu, they have a prefix of EW because they were introduced for dealing with problems seen in the Fine Offset family; the corrections are only applied when Cumulus 1 is reading directly from the station at a very frequent interval, spike removal does not apply when Cumulus is re-started and is transferring observations from the station logger to the Cumulus monthly log.
**The other 3 spike removal parameters have to be entered directly in cumulus.ini, none of these ones can be set on the 'calibration' screen.
**As Cumulus 1 does not check station type before applying any of these settings, ensure for Davis stations (these do not have spike problems) the spike removal filters are set to the defaults shown below.
**However, spike removal correction may be implemented for La Crosse stations, they can have problems with their PC interface, using the same EW filter settings listed below.
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
|VP2TCPPort=22222
!style="width:600px" | Function
|Set this in the Station Configuration Screen '''Davis TCP/IP Settings''' block.
Comunications port used if VP type has TCP/IP selected. Default is 2222
|-
|-
|style="background:lightgray;"|[Station]
|VP2IPAddr=0.0.0.0
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|Set this in the Station Configuration Screen  '''Davis TCP/IP Settings''' block.
Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
|-
|-
|EWMaxRainTipDiff=30
|VP2PeriodicDisconnectInterval=0
|Add this line to cumulus.ini [Station] section
|Set this in the Station Configuration Screen '''Settings''' block with the ''Discon period'' value.
Cumulus has a configurable threshold for the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips.
When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.


Default=30 tips in Cumulus 1
Set it to zero to disable, if you are not using the Weatherlink site.
 
|-
For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds.
|LogExtraSensors=0
 
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. 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 select this for Solar/UV sensors.
This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>.
|-
|-
|EWmaxHourlyRain=999
|DavisRainCollectorModel=X
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. (Available from Build 1096 of version 1.9.4)
An hourly rain count 'spike removal' filter for weather stations that do not supply this figure so Cumulus has to calculate it.
Option to specify rain collector model for Davis stations '''for situations where the Davis DLL is unable to read it from station''' (what it reads from station is default if this parameter is not present), and your rain figures in Cumulus are incorrect as a result (can happen when using Virtual VP, for example).
Any ''changes in calculated value'', between one calculation and the next, greater than the value specified here will be ignored by Cumulus when it calculates the hourly rain total.
Value X is an integer from 0 to 5 with the following meanings:
Cumulus ignores this parameter if the weather station directly supplies this figure to Cumulus. '''999''' is the default indicating no spike removal required.
*0 = 0.1 inch
*1 = 0.01 inch
*2 = 0.2 mm
*3 = 1 mm
*4 = 'other' inch
*5 = 'other' mm
Davis have not documented what calculations the DLL does for options 4 and 5.  If this line is not included in '''cumulus.ini''' the DLL will use whatever type the station tells it to use
|-
|-
|EWmaxRainRate=999
|Port=0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.
|Set this in the Station Configuration Screen '''Serial Port''' block.


A rain rate 'spike removal' filter, ''changes in calculated value'', between one calculation and the next, greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus when it calculates the rain rate.
Identifies COM Port used if Davis type is serial. Default is 0.
 
Cumulus ignores this parameter for other makes of weather station (they supply a rain rate to Cumulus). The default value of '''999''' also effectively makes Cumulus ignore spike removal.
|-
|-
|EWgustdiff=999.0
|RestartIfDataStops=0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.  
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
*0 (default) = Cumulus will just stop logging, and processing data, if it has had no data from the Davis station for 60 seconds. As it says in the provided help, use of this parameter may not fix a connection problem. With this default setting a connection problem stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
*1 = Cumulus software attempts to restart itself if it has had no data from the station for 60 seconds. Davis stations can use this option explained in the [[#La_Crosse_specific:|La Crosse]] table if Cumulus sometimes fails to read information from the logger. Again, this may not fix the problem, but this setting does force Cumulus to have another attempt after making a new connection on start up.
|-
|Port=0
|Set this in the Station Configuration Screen '''Serial Port''' block.
Identifies COM Port used if Davis type is serial. Default is 0.
|}
 
====Introduced for problems with Fine Offset family:====


A wind gust 'spike removal' filter, ''changes in calculated value'' between one calculation and the next, greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus.
*These parameters were introduced to cope with Fine Offset stations and their clones, but a few of the parameters below may be found to be useful more widely.
|-
*The read-write parameters are set on screens, the read-only attributes do not appear in the '''cumulus.ini''' file unless they are added using an external editor, but the values still have a recommended default value as explained below.
|EWwinddiff=999.0
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.


A wind speed  'spike removal' filter, ''changes in calculated value'' between one calculation and the next greater than the value (always metres per second) specified here (with a default of '''999.0''') will be ignored by Cumulus
{| class="wikitable" border="1"
|-
|-
|EWpressurediff=999.0
!style="width:150px" | Parameter Line Entry
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A pressure change 'spike removal' filter, ''changes in read value'', from one reading to the next, off any station greater than the value (always mb) specified here (with a default of '''999.0''') will be ignored by Cumulus
!style="width:600px" | Function
|-
|-
|EWminpressureMB=900
|style="background:lightgray;"|[Station]  
|Add this line to cumulus.ini [Station] section
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
 
Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
|-
|-
|EWmaxpressureMB=1200
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped.
|Add this line to cumulus.ini [Station] section
 
Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars).
|-
|-
|EWTempdiff=999.0
|FOReadAvoidPeriod=3
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A temperature change 'spike removal' filter.
|Add this line to cumulus.ini [Station] section if you wish to change the default, this parameter used to fine-tune the previous parameter.
*2 Minimum value
*3 = default value
Sets the interval (in seconds) during each 48 (or 60 for some models in Cumulus 1) second of station logging period when Cumulus will avoid reading the station data to try and minimise lock ups. If the clock drifts more than this value in 24 hours, then Cumulus may cause the station to lock up when reading the data. The actual station clock drift gets logged to the diags file when the re-synchronise (see last parameter) takes place, this will give an idea of whether it would be useful to adjust this setting.
|-
|ReportLostSensorContact=0
|Add this line to cumulus.ini [Station] section
*0 = reporting off
*1 = reporting on (default)
Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b.1070)
|-
|EWdisablecheckinit=0
|Add this line to cumulus.ini [Station] section if application gets stuck when Cumulus starts up connected to a Fine Offset (clone) station (added Cumulus version 1.9.2, build 1011).
*0 = Disabled, default, it checks the first two bytes of the Fine Offset station's memory.
*1 = Ignores part of memory (see [[FAQ#When_I_start_Cumulus.2C_I_get_the_error_message_.22The_station_is_not_initialised.22]]).
|-
|EWduplicatecheck=0
|Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.


Replace default of 999.0 with the maximum difference in degrees Celsius (the units Cumulus uses for all calculations regardless of what you select for display) you are prepared to accept between successive data readings.
Introduced in version 1.8.5 (b.630) to deal with certain bytes being given the same value in first and second line.
*0 = Disabled, default, Cumulus accepts all bytes from the Fine Offset station's memory.
*1 = Ignores part of memory (see [https://cumulus.hosiene.co.uk/viewtopic.php?f=13&t=393 this forum thread]).
For example one problem is that "55 AA" repeats at the start of the second line of data. Those bytes are only supposed to appear at the start of the first line (or so Steve Loft was told).
|-
|-
|EWhumiditydiff=999.0
|EWpressureoffset=x.y
|This is set in the spike removal frame on the Calibration settings screen off the configuration menu.  
|Add this line to cumulus.ini [Station] section
 
Got a pressure problem with a Fine Offset station when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero?
 
Tell Cumulus what offset to use, by using an external text editor to insert this parameter where x.y is your pressure offset in in mb or hPa [i.e. your station (absolute) pressure subtracted from the sea-level (relative) pressure].  


A humidity change 'spike removal' filter, ''changes in read value'' from any station greater than the value (as %) specified here (with a default of '''999.0''') will be ignored by Cumulus.
'''There is a bug in the legacy software, when reading pressure, it reads a byte that is not actually reporting pressure as well as byte that is reporting pressure'''
|-
|-
|ErrorLogSpikeRemoval=0
|RestartIfUnplugged=0  
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen on C1.
|This is set in the settings frame on the Station settings screen off the configuration menu.
*0 = Disabled, default i.e. deselected on the Station Configuration Screen
*Default is zero as shown, disabling the spike removal feature.
*1 = Enabled, Cumulus will restart if it detects that a Fine Offset station is unplugged.  
*Add this line to file with Cumulus 1 stopped, and set to 1 for the spike removal feature to be enabled.  


??It appears that C1 limits the number of messages in the error log window to a maximum of 256, so that limit may affect reporting of spike removal, but hopefully it does not restrict the functionality of spike removal ?? '''Could someone verify that, and update this entry'''
'''Note:''' Unless the station has been manually plugged in again, a Cumulus restart has no benefit; normally the station should be checked to be plugged in before Cumulus is ever started and the station then left plugged in.
|-
|SyncFOReads=0
|Default is disabled
*0 = Synchronisation disabled, default (Cumulus reads the memory without taking into account when memory is being updated)
*1 = Re-synchronizes once each day, to avoid reading memory at time of memory update
Cumulus software as far as possible uses routines that are not specific to a particular weather station. A Fine Offset station will be writing to its memory every 48 (standard for models without solar sensors) or 60 (standard for models with radio controlled clock or solar sensors) seconds. Cumulus attempts to read the memory once a minute, and (if the memory updates every 48 seconds) might read the same memory update twice.  Cumulus can attempt once a day to identify when this update of memory occurs, and thereafter try not to read the memory at update time, by using what is called a synchronisation mode of operation (avoiding the particular second when the 48 or 60 second update happens).
|}
|}


==== Reading File instead of weather station  ====
==== Reading File instead of weather station  ====


Functionality added from version 1.7.12 (when Fine Offset could not be interrogated via USB):
'''Requiring Cumulus to read '''Easyweather.dat''' instead of a station directly perhaps for Stations not recognised by Cumulus'''


Functionality added from version 1.7.12 (when Fine Offset could not be interrogated via USB): '''Requiring Cumulus to read '''Easyweather.dat''' instead of a station directly perhaps for Stations not recognised by Cumulus'''
*Stations not recognised by Cumulus ''may'' be set to create an [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather_Format]] file. For these the first two (or three) parameters below are mandatory.
*Stations not recognised by Cumulus ''may'' be set to create an [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather_Format]] file. For these the first two (or three) parameters below are mandatory.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 787: Line 828:
|This parameter is entered in the Station Configuration Screen Settings block.
|This parameter is entered in the Station Configuration Screen Settings block.
*0= Default, meaning not applicable  
*0= Default, meaning not applicable  
*n= any positive decimal value representing Easyweather version 6.2, or earlier, logging interval in minutes  (used for reading single latest observations from [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather]] software output). Note to specify seconds, use decimal minutes, e.g. 30 seconds = 0.5
*n= any positive decimal value representing '''Easy Weather version 6.2, or earlier''', logging interval in minutes  (used for reading single latest observations from [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather]] software output). Note to specify seconds, use decimal minutes, e.g. 30 seconds = 0.5
'''Note:''' If you have not set Station '''Type''' to 4,  then Cumulus ignores this parameter, i.e. it only applies if Cumulus needs to know how often to read a new record from the easyweather.dat file.
'''Note:''' If you have not set Station '''Type''' to 4,  then Cumulus ignores this parameter, i.e. it only applies if Cumulus needs to know how often to read a new record from the easyweather.dat file.
|-
|-
Line 799: Line 840:
|This is set in the settings frame on the Station settings screen off the configuration menu.
|This is set in the settings frame on the Station settings screen off the configuration menu.
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled; Use if you a) have Fine Offset models (generally those [[EasyWeather_Format#Note_on_Models|models 3xyz]]) with Solar/UV sensors, and b) '''Type=4''' set in that parameter (see top of [station] section), and c) '''EWFile='''''path'''''/EasyWeatherPlus.dat''' set in previous parameter. Only relevant if '''all these''' conditions met.
*1 = Enabled; Use if you a) have Fine Offset models (generally those [[EasyWeather_Format#Note_on_Models|models 3xyz]]) with Solar/UV sensors, and b) '''Type=4''' set in that parameter (see top of [station] read-write section), and c) '''EWFile='''''path'''''/EasyWeatherPlus.dat''' set in previous parameter. Only relevant if '''all these''' conditions met.
'''Note:''' Cumulus uses this parameter to determine where to find each observation (e.g. outside temperature, wind speed, humidity etc.) in the latest file record.  If you set this parameter wrong, Cumulus will assign what it finds in various field locations wrongly and therefore it is highly likely that temperatures, wind speeds and everything else will appear to have many rogue values in Cumulus but look okay on the weather station console display.
'''Note:''' Cumulus uses this parameter to determine where to find each observation (e.g. outside temperature, wind speed, humidity etc.) in the latest file record.  If you set this parameter wrong, Cumulus will assign what it finds in various field locations wrongly and therefore it is highly likely that temperatures, wind speeds and everything else will appear to have many rogue values in Cumulus but look okay on the weather station console display.


Line 807: Line 848:
==== Oregon Scientific specific: ====
==== Oregon Scientific specific: ====


Support for Oregon stations was removed in version 1.6.0, missing from all subsequent 1.6.x versions, and restored from version 1.7.0. Some parameters are set on a configuration screen (as identified in individual entries), others have to be entered directly in this file.
Support for Oregon stations was included in early versions of Cumulus software, removed in version 1.6.0, missing from all subsequent 1.6.x versions, and restored from version 1.7.0.  
 
Read-write parameters are set on a configuration screen (as identified in individual entries), Read-only parameters have to be entered directly in this file.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 816: Line 859:
|style="background:lightgray;"|[Station]  
|style="background:lightgray;"|[Station]  
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|colspan="2" style="background:pink;"|Read-Write parameters - The parameters listed below can be edited on the screens noted.
|-
|-
|Humidity98Fix=0  
|Humidity98Fix=0  
Line 875: Line 920:
==== Hydreon specific: ====
==== Hydreon specific: ====


All 6 of these parameters are set on RG11 screen within configuration menu, see its ''Help'' for more information.
All 6 of these parameters are set on RG11 screen within configuration menu, use the ''Help'' buttonon that screen for more information.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,143: Line 1,188:
|-
|-
|RealtimeTxtFTP=0
|RealtimeTxtFTP=0
set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime.txt FTP''.
|set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime.txt FTP''.
When set to 1 Cumulus will upload the [[realtime.txt]] to your web site during realtime processing. The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.
When set to 1 Cumulus will upload the [[realtime.txt]] to your web site during realtime processing. The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.
|-
|-
Line 1,246: Line 1,291:
For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.  
For Cumulus 1, only 0 to 9 are set in the Internet option of Configuration menu by an entry in the Local column of the table on the Files Tab screen, 10 to 99 have to be inserted manually by adding parameter lines to the configuration file, they cannot be entered on any Configuration screen.  
|}
|}


=== Section: Display ===
=== Section: Display ===
Line 2,398: Line 2,442:
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|}
|}
===Proxies===
Cumulus [https://cumulus.hosiene.co.uk/viewtopic.php?p=77983#p77983 1.9.4 beta build 1061] introduces these. Currently, see [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=728 this forum topic] for initial request and [https://cumulus.hosiene.co.uk/viewtopic.php?f=2&t=9433&p=77983&hilit=Proxies#p77983 for further discussion].
It was planned for these parameters to be described here when 1.9.4 becomes a full release, however it appears this HTTP proxy feature was never tested, and apparently stayed in beta when the rest of 1.9.4 was formally released.
HTTPProxyName=
HTTPProxyPort=
HTTPProxyUser=
HTTPProxyPassword=
Sfws
5,838

edits

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

Navigation menu