5,838
edits
Cumulus.ini (Cumulus 1): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Completeness for original Cumulus software: Rewritten, because some information was out of date
m (→Proxies) |
m (→Completeness for original Cumulus software: Rewritten, because some information was out of date) |
||
| (2 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) | ||
* | * ''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]. | ||
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). | |||
This page | |||
== Beta builds == | == Beta builds == | ||
| Line 364: | 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. | ||
*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 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 | *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; | 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 385: | 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) | ||
|- | |- | ||
|RolloverHour=0 | |RolloverHour=0 | ||
| Line 2,431: | Line 2,445: | ||
===Proxies=== | ===Proxies=== | ||
Cumulus 1.9.4 beta build 1061 introduces these. Currently, see [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=728 this forum topic] | 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= | HTTPProxyName= | ||
