Cumulus.ini (Beta): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
No edit summary |
m (Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)") |
||
| (36 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. |
||
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'. |
|||
Currently, this page reflects some changes in MX version as notified in the forum, if you are using MX and find something missing from here, please add it (or post request in forum). |
|||
= 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. |
||
== |
== 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. |
|||
|- |
|||
|ComportName=/dev/ttyUSB0 |
|||
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen. |
|||
You can set the serial port name in the MX user interface, but if for some reason you want to do it by editing Cumulus.ini, note that the item in MX is called ComportName (which is a string, for the full device name, e.g. COM1 or /dev/ttyUSB0) rather than 'Port' which is just an integer. |
|||
|- |
|||
|Logging=0 |
|||
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen. |
|||
Note that if set on the user interface, it only remains set while Cumulus MX continues to run (as in Cumulus 1, it defaults to off on restart). |
|||
*0 (default) = Cumulus MX will not add debug logging. |
|||
*1 = For '''debug''' logging when Cumulus MX (re-)starts, add ''Logging=1'' to the station section of Cumulus.ini. |
|||
NB - this parameter also appears in [[Cumulus.ini#Section:_Station|Cumulus 1 list]], repeated here for those looking up ''datalogging=1'' parameter below. |
|||
|} |
|||
==== Davis family specific: ==== |
|||
'''NOT AVAILABLE IN CUMULUS MX - at time of writing "RestartIfDataStops" is not available''' |
|||
{| 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. |
|||
The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger . Default is 500ms, see Cumulus MX forum where times up to 2000ms are suggested. |
|||
|- |
|||
|ForceVPBarUpdate=0 |
|||
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Added in build 3042 (January 2017). Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware. |
|||
|- |
|||
|VPrainGaugeType=0 |
|||
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The default is to assume that people using MM units to display rain in Cumulus have a Metric Rain Adapter fitted to their rain gauge so it tips for every 0.2mm, and those selecting inches as their unit have the unmodified 0.01" rain gauge. This parameter over-rides that assumption, but note that conversion rounding errors will then occur. |
|||
Specifies the units selected on your Vantage Pro Rain Gauge. Set to 0 for a 0.2mm gauge and 1 for a 0.01" gauge. |
|||
|- |
|||
|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). |
|||
|} |
|||
==== Instromet 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. |
|||
|- |
|||
|ImetBaudRate=19200 |
|||
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. |
|||
The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to manually set this value in Cumulus.ini before running the program. |
|||
|} |
|||
== Section: Offsets == |
|||
No changes. |
No changes. |
||
See main Cumulus.ini_(Cumulus_1) page. |
|||
== Section: Web Site == |
|||
No changes. |
|||
== Section: FTP site == |
|||
In Cumulus MX the user interface is used for changing parameters that are selected via the configuration menu in Cumulus 1. |
|||
== 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 == |
|||
{| class="wikitable" border="1" |
|||
|- |
|||
!style="width:150px" | Parameter Line Entry |
|||
!style="width:600px" | Function |
|||
|- |
|||
|style="background:lightgray;"|[Solar] |
|||
|style="background:lightgray;"|Section name - the following parameters relate to the solar configuration. |
|||
|- |
|||
|SolarCalc=1 |
|||
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen. |
|||
The value is set in the MX user interface when the solar calculation method is set. |
|||
*0 (default) = Ryan-Stolzenbach calculation, which uses the RStransfactor entry to tune the output. |
|||
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output. |
|||
|- |
|||
|BrasTurbidity=2.0 |
|||
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen. |
|||
*2.0 (default) = Perfect clear sky |
|||
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy) |
|||
|} |
|||
== Section: MainForm == |
|||
No changes. |
|||
== Section: Proxies == |
|||
No changes |
|||
[[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.
