Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (preserving history) (view source)

Revision as of 17:27, 19 November 2019

1,412 bytes added ,  17:27, 19 November 2019
→‎Section: Graphs
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category: Configuration_Files]]
[[Category: Configuration_Files]]
= Initial Configurations =
= Initial Configurations =
The main configuration file is ''Cumulus.ini'' and located in the directory in which you installed Cumulus.exe.  If you rename the executable file to say ''cumulus1.exe'', then the configuration file takes that name i.e. ''cumulus1.ini''. For Cumulus MX, both file-names must start with a capital letter, and all the characters used within the configuration file must be within ASCII range.
The main configuration file is ''Cumulus.ini'' and located in the directory in which you installed Cumulus.exe.  If you renamed the executable file to say ''Cumulus1.exe'', then this main configuration file takes that name i.e. ''Cumulus1.ini''. '''For Cumulus MX''', both file-names must start with a capital letter, and all the characters used within the configuration file must be within ASCII range.


It is a text file containing initialization parameters used by the Cumulus 1.x.x, or Cumulus MX, application; and is read '''only''' when Cumulus starts up.  Cumulus '''re-writes''' the contents of the application configuration screens to the file when it ''shuts down'', so you will see the file shows as 'modified date' the last time that Cumulus was shut down.  
It is a text file containing initialization parameters used by the Cumulus 1.x.x, or Cumulus MX, application; and is read '''only''' when Cumulus starts up.  Cumulus '''re-writes''' the contents of the application configuration screens to the file when it ''shuts down'', so you will see the file shows as 'modified date' the last time that Cumulus was shut down.  
Line 7: Line 7:
A second ''Cumulus.ini'' may be stored in the reports sub-directory, this only contains a [[#Section:_MainForm|single section]] and relates to the screen used for NOAA reports.
A second ''Cumulus.ini'' may be stored in the reports sub-directory, this only contains a [[#Section:_MainForm|single section]] and relates to the screen used for NOAA reports.


The parameters listed can change the look of Cumulus, hold basic information about your location, amend the way Cumulus interfaces with your weather station, and hold the settings used to interface with your website, and with various external websites. The list below was created for Cumulus 1.x.y, and all of it applies to the final formal release; for MX (like any beta) please refer to announcements or the separate page referenced below for any variations.
The parameters listed can change the look of Cumulus, hold basic information about your location, amend the way Cumulus interfaces with your weather station, and hold the settings used to interface with your website, and with various external websites. The list below was created for Cumulus 1.x.y, and all of it applies to the final formal release; '''for MX''' (like any beta) please refer to announcements or the separate page referenced below for any variations.


If you are using an old version, then ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below as available in latest release.
If you are using an old version, then ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below as available in latest release.
Line 31: Line 31:
'''CURRENTLY CUMULUS MX specific parameters are listed on [[Cumulus.ini (Beta)|Cumulus.ini(Beta)]] page.'''
'''CURRENTLY CUMULUS MX specific parameters are listed on [[Cumulus.ini (Beta)|Cumulus.ini(Beta)]] page.'''


If you are using a beta build, there may be changes to the information shown below with additional sections and/or additional parameters (attribute=value) under test.  Brief details of such changes will be given in the support forum announcement for the relevant build. New sections and/or attributes and/or values for beta versions of Cumulus are not listed here until the version becomes 'live' however there is a [[Cumulus.ini_(Beta)|page]] that details the additional parameters available in the Beta version once they have become established, but for details of beta tests see  [http://sandaysoft.com/forum/viewforum.php?f=2 the forum].
If you are using a beta build, there may be changes to the information shown below with additional sections and/or additional parameters (attribute=value) under test.  Brief details of such changes will be given in the support forum announcement for the relevant build. New sections and/or attributes and/or values for beta versions of Cumulus are not listed here until the version becomes 'live' however there is a [[Cumulus.ini_(Beta)|page]] that details the additional parameters available in the Beta version once they have become established, but for details of beta tests see  [https://cumulus.hosiene.co.uk/viewforum.php?f=2 the forum].


= Editing the file =
= Editing the file =
Line 143: Line 143:
|-
|-
|AvgBearingMinutes=N
|AvgBearingMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, with this parameter N is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing. Without it, the default = 10. See next parameter for behavoir when calm.
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, with this parameter N is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing. Without it, the default sampling time = 10 minutes. Note the max number of wind samples stored by Cumulus is 720, so the maximum effective value for N for Fine Offset stations that are read every 10 seconds is 120 (2 hours) while for Davis stations that are sampled every 2 to 3 seconds the maximum effective value is only about 30 (minutes).
See next parameter for behavoir when calm.
|-
|-
|UseZeroBearing=0  
|UseZeroBearing=0  
|Set this in the Station Configuration Screen Settings block.
|Set this in the Station Configuration Screen Settings block.
*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
*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  
|CalculatedDP=0  
Line 337: Line 338:
date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dewpoint,outside temp,outside humidity,outside dewpoint
date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dewpoint,outside temp,outside humidity,outside dewpoint


See [http://sandaysoft.com/forum/viewtopic.php?f=5&t=15040 forum]
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
|-
|-
|ErrorLogSpikeRemoval=0
|ErrorLogSpikeRemoval=0
Line 350: Line 351:
|NoSensorCheck=1
|NoSensorCheck=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default value is assumed.   
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default value is assumed.   
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]
The option (for 'incomplete' stations) to disable the sensor check described in this [https://cumuluswiki.wxforum.net/a/FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads FAQ]
*0 = Sensor check enabled (default)
*0 = Sensor check enabled (default)
*1 = Sensor check disabled
*1 = Sensor check disabled
Line 360: Line 361:
It handles fetching data from the console, and does all kinds of useful things like converting the data into the units you require.
It handles fetching data from the console, and does all kinds of useful things like converting the data into the units you require.


These settings apply to Cumulus 1.9.x, check with release notes for your version and previous versions.   
These settings apply to Cumulus 1.9.x, check with release notes for your version and previous versions to see all settings applicable to any earlier version you use.   


'''ADDITIONAL CUMULUS MX parameters - see [[Cumulus.ini_%28Beta%29#Davis_family_specific:|beta page here]]'''. Many of the settings below apply to Cumulus MX too, but check the forum. For example 'Port=' is specific to Cumulus 1. Also at time of writing "RestartIfDataStops" is not available to MX users.
'''ADDITIONAL CUMULUS MX parameters - see [[Cumulus.ini_%28Beta%29#Davis_family_specific:|beta page here]]'''. Some of the settings below apply to Cumulus MX too, but check the MX support forum.
* For example 'Port=' is specific to Cumulus 1.
* 'DavisRainCollectorModel' is not available to Cumulus MX users as that does not use the DLL interface.
* At time of writing "RestartIfDataStops" is not available to MX users.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 426: Line 430:
|-
|-
|VP2PeriodicDisconnectInterval=0
|VP2PeriodicDisconnectInterval=0
|Set this in the Station Configuration Screen '''Settings''' block with the ''Discon period'' value. 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.
|Set this in the Station Configuration Screen '''Settings''' block with the ''Discon period'' value.
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.
|-
|-
|DavisCalcAltPress=1
|DavisCalcAltPress=1
Line 444: Line 451:
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
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. As it says in the help, it may not fix the connection problem, but at least it stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
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. As it says in the help, it may not fix the connection problem, but at least it stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
|}
|}


Line 498: Line 505:
Introduced in version 1.8.5 (b.630) to deal with certain bytes being given the same value in first and second line.
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.  
*0 = Disabled, default, Cumulus accepts all bytes from the Fine Offset station's memory.  
*1 = Ignores part of memory (see [http://sandaysoft.com/forum/viewtopic.php?f=13&t=393 this forum thread]).
*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 I am told).
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).


Line 655: Line 662:
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|This line needs to be added in the [Station] section of the Cumulus.ini. Option to restart Cumulus if data from La Crosse stations stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
|This line needs to be added in the [Station] section of the Cumulus.ini.  
Option for Cumulus 1, it attempts to restart itself if it has had no data from a La Crosse station for 60 seconds i.e. if data from station 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)
*0 = Disabled (default)
*1 = Enabled
*1 = Enabled
|-
|-
|ReportDataStoppedErrors=0
|ReportDataStoppedErrors=0
|This line needs to be added in the [Station] section of the Cumulus.ini. Option to turn off reporting of 'data stopped' errors to the Cumulus error log (may be needed with La Crosse stations)
|This line needs to be added in the [Station] section of the Cumulus.ini.  
Option to turn off reporting of 'data stopped' errors to the Cumulus error log (may be needed with La Crosse stations)
*0 = Disabled (default)
*0 = Disabled (default)
*1 = Enabled
*1 = Enabled
|}
|}
The spike removal parameter listed in the Fine Offset section above, may be used with La Crosse stations.
The spike removal parameter listed in the Fine Offset section above, may also be used with La Crosse stations.


==== Hydreon specific: ====
==== Hydreon specific: ====
Line 717: Line 726:
|-
|-
|LogExtraSensors=0
|LogExtraSensors=0
|This is set in the settings frame on the Station settings screen off the configuration menu by the '''Extra Sensors''' selection.  
|This is set in the settings frame on the Station settings screen off the configuration menu by the '''Extra Sensors''' selection. If you have 'extra sensors' selected, the wet bulb reading will be used as an extra temperature sensor. Otherwise it is used as 'wet bulb' and the humidity will be calculated from that and the dry bulb sensor.  
*0=Disabled (default)
*0=Disabled (default)- . For a wet bulb sensor, Cumulus will output the humidity, not the temperature shown by the wet bulb.
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations.
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations. For a wet bulb sensor, Cumulus will output the temperature it shows, but not calculate the humidity.
(Note this attribute appears in [[#Davis_family_specific|Davis family]], [[#Oregon_Scientific_specific:|Oregon Scientific specific]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above with different usage explanations).
(Note this attribute appears in [[#Davis_family_specific|Davis family]], [[#Oregon_Scientific_specific:|Oregon Scientific specific]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above with different usage explanations).
|}
|}
Line 787: Line 796:
|style="background:lightgray;"|Section Name - the following parameters relate to your website
|style="background:lightgray;"|Section Name - the following parameters relate to your website
|-
|-
|ForumURL=<nowiki>http://sandaysoft.com/forum/</nowiki>  
|ForumURL=<nowiki>https://cumulus.hosiene.co.uk/</nowiki>  
|A website forum URL
|A website forum URL
|-
|-
Line 1,038: Line 1,047:
== Section: Display ==
== Section: Display ==
Set the majority of these parameters using Configuration menu and [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|either ''Display'' or ''Colours'' screens]] as seen on link and indicated below.  The exception is "TwelveHourClock", that parameter is set by clicking on the displayed time.
Set the majority of these parameters using Configuration menu and [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|either ''Display'' or ''Colours'' screens]] as seen on link and indicated below.  The exception is "TwelveHourClock", that parameter is set by clicking on the displayed time.
The only setting used in this section by Cumulus MX is "NumWindRosePoints"
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,297: Line 1,309:
Set the colours of the data lines on graphs/charts and Select whether to plot particular data by using '''View''' menu and ''Graphs'' option, then right click over the relevant graph.
Set the colours of the data lines on graphs/charts and Select whether to plot particular data by using '''View''' menu and ''Graphs'' option, then right click over the relevant graph.
Set the SAG colours and axis position by using '''View''' menu and ''Select-A-Graph'' option, the settings for different observations are at the foot of the screen.
Set the SAG colours and axis position by using '''View''' menu and ''Select-A-Graph'' option, the settings for different observations are at the foot of the screen.
The only settings used in this section by Cumulus MX are "ChartMaxDays" and "GraphHours"
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/4104...4564"

Navigation menu