Cumulus.ini (Beta)

From Cumulus Wiki
Jump to navigationJump to search

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. Here are the default settings. See Cumulus MX page for examples of what can be selected. 

[MySQL]
Host=127.0.0.1
Port=3306
User=
Pass=
Database=database
MonthlyMySqlEnabled=0
RealtimeMySqlEnabled=0
DayfileMySqlEnabled=0
MonthlyTable=Monthly
DayfileTable=Dayfile
RealtimeTable=Realtime
RealtimeRetention=
CustomMySqlSecondsCommandString=
CustomMySqlMinutesCommandString=
CustomMySqlRolloverCommandString=
CustomMySqlSecondsEnabled=0
CustomMySqlMinutesEnabled=0
CustomMySqlRolloverEnabled=0
CustomMySqlSecondsInterval=10
CustomMySqlMinutesIntervalIndex=6

Section: Station

Cumulus MX builds only. Edit file with Cumulus MX stopped. Remember earlier builds of MX may have fewer parameters,all those listed are available in latest build, see announcements on forum, in case even more have been added since this list was last updated.

Parameter Line Entry Function
[Station] Section name - the following parameters relate to the station configuration.
Type= -1 Station Type as set by the checked radio box in the Station Configuration Screen, Station Type block. For details of Supported_Devices click that link.
  • 11=Davis WLL
  • 12=Ecowitt GW1000

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.

  • 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.

Without 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.
DavisIncrementPressureDP=0 (from version 3.0.0 build 3042) A Cumulus.ini setting to turn off the 'extra' decimal place in pressure values on Davis stations. To limit the pressure to 1 decimal for mb/hPa and 2 for inHg, add this to the [Station] section
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.

NOTE: This setting supersedes the setting "DavisRainCollectorModel" used in Cumulus 1

DataLogging=0 This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Default is 0, change to 1 for more detailed Davis logging.
  • 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).|-

AutoUpdateIpAddress=1 (read-only, you cannot edit this on station settings screen, you must type it directly into file) default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
ZeroConfig set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery

Instromet family specific:

Parameter Line Entry Function
[Station] 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: GW1000

Settings specific to the EcoWitt GW1000 device

Parameter Line Entry Function
[GW1000] Section name - the following parameters relate to the station configuration.
IPAddress= There is no default value, stores the IP address of your GW1000 WiFi logger, set via the station configuration screen.

Section: WLL

Parameter Line Entry Function
[WLL] Section name - the following parameters relate to the station configuration.
PrimaryRainTxId=1 Default value = 1, which transmitter do you want to use as your primary rain sensor, set via the station configuration screen.
PrimaryTempHumTxId=1 Default value = 1, which transmitter do you want to use as your primary temp/hum sensor, set via the station configuration screen.
PrimaryWindTxId=1 Default value = 1, which transmitter do you want to use as your primary wind sensor, set via the station configuration screen.
PrimarySolarTxId=1 Default value = 1, which transmitter do you want to use as your primary solar sensor, set via the station configuration screen.
PrimaryUVTxId=1 Default value = 1, which transmitter do you want to use as your primary rain sensor, set via the station configuration screen.
ExtraSoilTempTxId[1 to 4]=0 Default value = 0, which transmitter do you want to use as your soil temperature sensor [1-4], set via the station configuration screen.
ExtraSoilTempIdx[1 to 4]=0 Default value = 1 to 4, which sensor number on the transmitter do you want to use as your soil temperature sensor [1-4], set via the station configuration screen.
ExtraSoilMoistureTxId[1 to 4]=0 Default value = 0, which transmitter do you want to use as your soil moisture sensor [1-4], set via the station configuration screen.
ExtraSoilMoistureIdx[1 to 4]=0 Default value = 1 to 4, which sensor number on the transmitter do you want to use as your soil moisture sensor [1-4], set via the station configuration screen.
ExtraLeafTxId[1 to 2]=0 Default value = 0, which transmitter do you want to use as your leaf wetness sensor [1-2], set via the station configuration screen.
ExtraLeafIdx[1 to 2]=0 Default value = 1 to 2, which sensor number on the transmitter do you want to use as your soil moisture sensor [1-2], set via the station configuration screen.
ExtraTempTxId[1 to 8]=0 Default value = 0, which transmitter do you want to use as your extra temperature sensor [1-8], set via the station configuration screen.
ExtraHumOnTx[1 to 8]=0 Default value = 0, does the temperature sensor transmitter [1-8] also have a humidity sensor, set via the station configuration screen.
BroadcastDuration=300 Default value = 300, how long the WLL device is requested to broadcast for before timing out. Only set via the ini file, there should be no need to change this.
BroadcastPort=22222 Default value = 22222, what port the WLL device broadcasts on. Only set via the ini file, there should be no need to change this.

Section: Offsets

Set most of these parameters using the Configuration menu and Calibration screen, the exception is 'TempMult2'.

Parameter Line Entry Function
[Offsets] Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors
PressMult=Multiplier_Value Default 'Multiplier_Value' is 1.0 in this parameter, used for formula: Cumulus pressure = (Measured Pressure * 'Multiplier_Value') + 'Offset_Value'

Section: Web Site

No changes.

Section: FTP site

In Cumulus MX the user interface Internet Settings page is used for changing some parameters but there is a separate Extra Pages settings page for all 100 possible sets of settings for processing a file, uploading it at realtime interval, normal updating interval or (added functionality in MX) at end of day. On the Internet Settings screen, changes take effect when you click 'Save' button. On the Extra Pages screen, changes take effect when you move to next row in the table.

Parameter Line Entry Function
[FTP site] Section Name - the following parameters relate to your website FTP parameters
DisableEPSV=0 (Add this to the Cumulus.ini file, it is not available on the Internet Settings page) The default is 0, change to 1 to Disable the Extended Passive FTP-mode.

Section: Display

No changes.

Section: Graphs

No changes.

Section: Alarms

No changes.

Section: Windy

Parameter Line Entry Function
[Windy] Section name - the following parameters relate to the Windy.com configuration.
APIkey= 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 your Windy.com API Key value is set.

Enabled=0 This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
  • 0 = Disable sending of data (default)
  • 1 = Enable sending of data
Interval=5 This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
  • 5 = Send new data every 5 minutes - the default and minimum allowed value
SendUV=0 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 Include UV value is set.

  • 0 = Do not send UV data (default)
  • 1 = Send UV data
CatchUp=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 option to send catchup data from the logger is set.

  • 0 = Do not send Catchup data
  • 1 = Send Catchup data (default)
StationIdx=0 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 option to set the Station Index is set. Normally set to zero, this is only used if you have defined more than one station under your Windy.com stations user id.

  • 0 = Use the first defined station (default)

Section: WeatherCloud

Parameter Line Entry Function
[WeatherCloud] Section name - the following parameters relate to the Weathercloud configuration.
Wid= 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 Weathercloud ID value is set.

Key= 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 your Weathercloud API Key value is set.

Enabled=0 This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
  • 0 = Disable sending of data (default)
  • 1 = Enable sending of data
SendUV=0 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 Include UV value is set.

  • 0 = Do not send UV data (default)
  • 1 = Send UV data
SendSR=0 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 Include Solar Radiation value is set.

  • 0 = Do not send Solar data (default)
  • 1 = Send Solar data

Section: NOAA

No changes.

Section: Solar

Parameter Line Entry Function
[Solar] 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: [MQTT]

ONLY in Cumulus MX. 

	Server=
	Port=
	UseTLS=0
	Username=
	Password=
	EnableDataUpdate=0
	UpdateTopic=CumulusMX/DataUpdate
	UpdateTemplate=DataUpdateTemplate.txt
	EnableInterval=0
	IntervalTime=600
	IntervalTopic=CumulusMX/Interval
	IntervalTemplate=IntervalTemplate.txt

Section: Proxies

No changes

Retrieved from "https://www.cumuluswiki.org/index.php?title=Cumulus.ini_(Beta)&oldid=5188"