Cumulus.ini (Beta)

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.

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.

See main Cumulus.ini page.

Section: Display

No changes.

Section: Graphs

No changes.

Section: Alarms

No changes.

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