Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This page was last updated for the MX release in July 2020; that is no longer latest!
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this page, it may even need a redesign for more recent releases!
</div>
[[File:Badge vMx.png]] This page now only applies if you are using Cumulus MX.
[[File:Badge vMx.png]] This page now only applies if you are using Cumulus MX.


If you are using Cumulus 1, all the information is now on [[Cumulus.ini (Cumulus 1)]] page.
The information for the legacy Cumulus has been moved to the new [[Cumulus.ini (Cumulus 1)]] page.


[[Category: Configuration_Files]]
[[Category: Configuration_Files]]
Line 443: Line 450:
=== Section: Station ===
=== Section: Station ===


<big>THIS SECTION NEEDS TO BE REWRITTEN - MX has changed, and the sub-sections below reflect older releases where some parameters were read-only (not set with admin interface) and some were read-write 9set within admin interface)</big>
<big>THE FOLLOWING SUB-SECTIONS NEEDS TO BE REWRITTEN - MX has changed, and the sub-sections below reflect older releases where some parameters were read-only (not set with admin interface) and some were read-write (set within admin interface)</big>
 
'''The table below covers some of the parameters that at release 3.6.0 could not be edited using the settings web pages in the admin interface.'''
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|-
|StartDate=13/08/2009
|This parameter is different to all the others. In earlier releases of MX, this was not read-write as you cannot edit it. Unlike other read-only parameters it is automatically inserted into Cumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application (whichever flavour). In the later releases of MX, you can edit it within the admin interface!
|-
|UseDataLogger=1
|Some releases of Cumulus MX: This parameter (attribute=value) is added directly to the file in the [Station] section if you want to change the default, it does not appear on the settings screen.


*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
The difficulty is ensuring this Wiki page continues to help people whichever MX release they are using - the alternative is to split this page and have references to other pages (one for early MX releases, one for 3.10.1 onwards)
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
|}


=== Spike Removal ===
=== Spike Removal ===


Which parameters are available from this section depends on release of MX being used, and which type of staion you use.
Which parameters are available from this section depends on release of MX being used, and which type of station you use.




Line 533: Line 523:


<big>'''This sub-section relates to MX releases until 3.6.12 only.'''</big>  
<big>'''This sub-section relates to MX releases until 3.6.12 only.'''</big>  
'''The first table below covers some of the parameters that at release 3.6.0 could not be edited using the settings web pages in the admin interface.'''
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|-
|StartDate=13/08/2009
|This parameter is different to all the others. In earlier releases of MX, this was not read-write as you cannot edit it. Unlike other read-only parameters it is automatically inserted into Cumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application (whichever flavour). In the later releases of MX, you can edit it within the admin interface!
|-
|UseDataLogger=1
|Some releases of Cumulus MX: This parameter (attribute=value) is added directly to the file in the [Station] section if you want to change the default, it does not appear on the settings screen.
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
|}
The second table below contains those read-write parameters that existed for Cumulus 1 and I believe are understood by MX, plus some read-only parameters mentioned in MX release announcements up to June 2020, no monitoring of subsequent announcements was made, and the details shown below may not be accurate.


From 3.10.1 onwards, MX has these settings in its admin interface, although they may be under sections called "Advanced" and be displayed with warnings saying don't use unless you understand!  (In-between releases have additional read-only parameters that nobody ever documented here (or in subsequent sub-sections).
From 3.10.1 onwards, MX has these settings in its admin interface, although they may be under sections called "Advanced" and be displayed with warnings saying don't use unless you understand!  (In-between releases have additional read-only parameters that nobody ever documented here (or in subsequent sub-sections).
Line 960: Line 973:
*2 Minimum value
*2 Minimum value
*3 = default 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.
Sets the interval (in seconds) 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.
 
Note: I have not been able to find any interval that works. In my experience, if you use this setting, MX skips every attempt to read from the weather station, As MX is coded to make an attempt every 60 seconds, but is also coded to skip every 60 seconds plus or minus the setting here.


MX applies both 48 and 60 second avoidances regardless of model.
MX applies both 48 and 60 second avoidances regardless of model.
Line 1,150: Line 1,165:
(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).
|}
|}
=== Section: Limits ===
New from release 3.?.?
'''Somebody needs to insert the relevant table here'''


=== Section: Offsets ===
=== Section: Offsets ===


It is believed the following table contains parameters that apply for all MX releases, except where indicated as build 3045 onwards.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,242: Line 1,264:
|}
|}


=== Section: FTP site ===


The parameters listed here are set either on [[MX_Administrative_Interface#Internet_Settings|Internet Settings page]] or on [[MX_Administrative_Interface#Extra_Web_Files|Extra Web Files page]].


=== Section: FTP site ===
<big>'''The following table requires a lot of updating as it does not cover all the parameters that the latest version has in this section of the configuration file'''</big>
 
NOTE: For MX, the word site should be in lower case as shown in left-hand column heading and above.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,255: Line 1,277:
|style="background:lightgray;"|[FTP site]  
|style="background:lightgray;"|[FTP site]  
|style="background:lightgray;"|Section Name - the following parameters relate to your website FTP parameters
|style="background:lightgray;"|Section Name - the following parameters relate to your website FTP parameters
|-
|colspan="2" style="background:pink;"|The following parameters are only available from release 3.10.1 onwards.
|-
|IntervalEnabled=?
|<big>This parameter is just included as an example, somebody needs to enter the default and list the other new parameters</big>
|-
|?
|?
|-
|colspan="2" style="background:pink;"|The following parameters are those available at release 3.6.0 (where a parameter is not available at all earlier releases, the first version using it is shown)
|-
|-
|DailyProgram=  
|DailyProgram=  
Line 1,474: Line 1,506:
=== Section: Graphs ===
=== Section: Graphs ===


All settings in this table are controlled in the '''Graphs''' section at the bottom of the '''Station Settings''' page. Note that some are not iun all releases.
'''The following table required editing to bring it up to date, as further parameters were added at release 3.10.1.''' There are also some parameters (e.g. relating to moon) that do not apply to early releases, but nobody has indicated the starting version.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,549: Line 1,581:
=== Section: Alarms ===
=== Section: Alarms ===


[[File:Badge vMx.png]]For MX, there is a default path "\CumulusMX\interface\sounds". '''Edit''' on '''Settings''' tab, '''Alarms''' screen.
For MX, there is a default path "\CumulusMX\interface\sounds". '''Edit''' on '''Settings''' tab, '''Alarms''' screen.


{{Version badge 1}}Set these using the '''Edit''' menu, ''Alarms'' screen. The default path and file is '''\Cumulus\alert.wav''' for all the file parameters.  (Previously this article incorrectly showed "C:\Program Files\Cumulus\alert.wav" for some, but that has been removed now this applies to MX as well)
<big>The parameters shown may not be available in all releases, and '''there are more parameters in later releases''' that have not yet been added to this table.</big>
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
5,838

edits

Navigation menu