Cumulus.ini (Beta): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m (→Section: GW1000: cut) |
m (Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)") |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 15: | Line 15: | ||
= 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 == |
||
{| class="wikitable" border="1" |
|||
|- |
|||
!style="width:150px" | Parameter Line Entry |
|||
!style="width:600px" | Function |
|||
|- |
|||
|style="background:lightgray;"|[WLL] |
|||
|style="background:lightgray;"|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'. |
|||
{| class="wikitable" border="1" |
|||
|- |
|||
!style="width:150px" | Parameter Line Entry |
|||
!style="width:600px" | Function |
|||
|- |
|||
|style="background:lightgray;"|[Offsets] |
|||
|style="background:lightgray;"|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. |
No changes. |
||
See main Cumulus.ini_(Cumulus_1) page. |
|||
== 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: Windy == |
|||
{| class="wikitable" border="1" |
|||
|- |
|||
!style="width:150px" | Parameter Line Entry |
|||
!style="width:600px" | Function |
|||
|- |
|||
|style="background:lightgray;"|[Windy] |
|||
|style="background:lightgray;"|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 == |
|||
{| class="wikitable" border="1" |
|||
|- |
|||
!style="width:150px" | Parameter Line Entry |
|||
!style="width:600px" | Function |
|||
|- |
|||
|style="background:lightgray;"|[WeatherCloud] |
|||
|style="background:lightgray;"|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 == |
|||
{| 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: [MQTT] == |
|||
ONLY in Cumulus MX. |
|||
<pre> |
|||
Server= |
|||
Port= |
|||
UseTLS=0 |
|||
Username= |
|||
Password= |
|||
EnableDataUpdate=0 |
|||
UpdateTopic=CumulusMX/DataUpdate |
|||
UpdateTemplate=DataUpdateTemplate.txt |
|||
EnableInterval=0 |
|||
IntervalTime=600 |
|||
IntervalTopic=CumulusMX/Interval |
|||
IntervalTemplate=IntervalTemplate.txt |
|||
</pre> |
|||
== 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.
