Cumulus.ini (Beta): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)")
 
(48 intermediate revisions by 2 users not shown)
Line 5: Line 5:
Each new version of cumulus may add additional parameters set by revised configuration screens (these initially appear at the end of the relevant section), and/or permit additional parameters to be added manually (these can be inserted anywhere within the section). If you are using an old version, then checking the release information may be advisable to identify the sections applicable to your build and the parameters allowed within those sections may be a subset of those listed below.
Each new version of cumulus may add additional parameters set by revised configuration screens (these initially appear at the end of the relevant section), and/or permit additional parameters to be added manually (these can be inserted anywhere within the section). If you are using an old version, then checking the release information may be advisable to identify the sections applicable to your build and the parameters allowed within those sections may be a subset of those listed below.
== Live Version ==
== Live Version ==
See [[cumulus.ini]] for list of sections, attributes and allowed values for the current live version of Cumulus. Below is a list of the additional items available in this beta version. These details will be explained fully and transferred to the main page when the beta version becomes 'live'.
 
See [[cumulus.ini]] for list of sections, attributes and allowed values for the current live version of Cumulus.
 
== Beta builds ==
== Beta builds ==
If you are using a beta build, there may be  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. Once such changes seem established they should be added here.
If you are using a beta build, there may be  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. Once such changes seem established they should be added here.


Currently, this page reflects some experimental changes in version 1.9.4 beta regarding proxies, and in MX version regarding Davis stations.
Below is a list of the additional items available in any current beta version. These details will be explained fully and transferred to the main page when each beta version becomes 'live'.


= File Contents =
= File Contents =
== Introduction ==
== Introduction ==
The entries shown include the default value from the configuration screen where applicable, a typical example value where appropriate, or just the attribute and an equals sign where there is no typical value.
The entries shown include the default value from the configuration screen where applicable, a typical example value where appropriate, or just the attribute and an equals sign where there is no typical value.




== Section: MySQL ==
== Current Beta ==
Cumulus MX uses Cumulus.ini to store the MySQL configuration details.
All details are input on '''The MySQL settings screen'''.
This is a beta introduction still being tested, please check release information for latest.
 
== Section: Station ==
Cumulus MX builds only. Edit file with Cumulus MX stopped.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|Logging=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
*0 (default) = Cumulus MX will not add debug logging.
*1 = For '''debug''' logging, add ''Logging=1'' to the station section of Cumulus.ini.
|}
 
==== Davis family specific: ====


{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|UseDavisLoop2=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
*1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default.
The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
*0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.
With this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.
|-
|DavisIPResponseTime=500
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
Specifies the time in milliseconds that Cumulus MX allows for a response from an IP logger.  Default is 500ms, see Cumulus MX forum where times up to 2000ms are suggested.
|-
|DataLogging=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
*0 (default) = Cumulus MX will not add extra logging.
*1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large. (Build 3018 onwards).
I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards).
|}
== Section: Offsets ==
No changes.
== Section: Web Site ==
No changes.
== Section: FTP Site ==
No changes.
== Section: Display ==
No changes.
== Section: Graphs ==
No changes.
== Section: Alarms ==
No changes.
== Sections dealing with interfaces to external sites ==
No changes.
== Section: NOAA ==
No changes.
== Section: Solar ==
No changes.
== Section: MainForm ==
No changes.
No changes.
 
See main Cumulus.ini_(Cumulus_1) page.
== Section: Proxies ==
Cumulus 1.9.4 beta build 1061 introduced these.  Their inability to work with current Twitter set up is covered on [http://sandaysoft.com/forum/viewtopic.php?f=20&t=10419 this forum posting].  You can search the forum using the term 'proxy' for more background.
 
Quote from Release announcement:"Support for HTTP proxies - completely untested and will probably need further work. Feedback requested!"
 
Note (November 2013): Although version 1.9.4 is now current release [Release Date: October 27, 2013 (build 1085)], the proxies work is not confirmed as finished, hence the information below has not been copied to the main [[Cumulus.ini|Cumulus.ini]] page.
 
 
HTTPProxyName=
 
HTTPProxyPort=
 
HTTPProxyUser=
 
HTTPProxyPassword=
[[Category: Configuration_Files]]
[[Category: Configuration_Files]]

Latest revision as of 16:24, 22 March 2021

Introduction

The main cumulus.ini configuration file is located in the directory in which you installed Cumulus.exe. It is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up. Parameter lines are in the form 'attribute=value' and grouped into sections. Cumulus re-writes the contents of the application configuration screens to the file when it shuts down.

Each new version of cumulus may add additional parameters set by revised configuration screens (these initially appear at the end of the relevant section), and/or permit additional parameters to be added manually (these can be inserted anywhere within the section). If you are using an old version, then checking the release information may be advisable to identify the sections applicable to your build and the parameters allowed within those sections may be a subset of those listed below.

Live Version

See cumulus.ini for list of sections, attributes and allowed values for the current live version of Cumulus.

Beta builds

If you are using a beta build, there may be 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. Once such changes seem established they should be added here.

Below is a list of the additional items available in any current beta version. These details will be explained fully and transferred to the main page when each beta version becomes 'live'.

File Contents

Introduction

The entries shown include the default value from the configuration screen where applicable, a typical example value where appropriate, or just the attribute and an equals sign where there is no typical value.


Current Beta

No changes. See main Cumulus.ini_(Cumulus_1) page.