Cumulus.ini (Beta): Difference between revisions
m (→Beta builds) |
|||
Line 69: | Line 69: | ||
|DavisIPResponseTime=500 |
|DavisIPResponseTime=500 |
||
|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. |
||
⚫ | |||
⚫ | |||
|- |
|- |
Revision as of 13:40, 7 July 2018
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. 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'.
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.
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
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.
Section: MySQL
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.
Parameter Line Entry | Function |
---|---|
[Station] | 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).
NB - this parameter also appears in 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
Parameter Line Entry | Function |
---|---|
[Station] | 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.
The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
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. |
VPrainGaugeType= | 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.
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
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
No changes.
Section: MainForm
No changes.
Section: Proxies
No changes