Cumulus Wiki

Cumulus.ini: Difference between revisions

Page Discussion

Cumulus.ini (view source)

Revision as of 18:23, 20 August 2022

53,612 bytes removed ,  20 August 2022
m
Some of the sections needing updating have been "cut" from this page, and "pasted" into new pages
mNo edit summary
m (Some of the sections needing updating have been "cut" from this page, and "pasted" into new pages)
=Purpose of Cumulus.ini file=
 
This is a text file containing initialization parameters. {{Template:Version badge Mx}}This page covers those used by the Cumulus MX software applicationapplica3.2.0 to 3.5.4tion.
 
For MX there can only to be one '''Cumulus.ini''' file, and it must be stored in the same folder as the executable "CumulusMX.exe".
# Even more dramatic changes to the MX configuration have been happening since 3.8.0, with the biggest changes at 3.9.2, 3.10.0, and 3.12.0; therefore, <big>the decision was taken to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new empty page!</big>
 
 
All the pages, previously called "Cumulus.ini", can be found from the owning [[:Category:Configuration Files|category]]. The original page was preserved at [[Cumulus.ini_(preserving_history)]] so look there for its editing history. That page also expands on the above summary of why that old page was replaced by this new page.
All the pages, previously called "Cumulus.ini", can be found from the owning [[:Category:Configuration Files|category]]. The original page was preserved at [[Cumulus.ini_(preserving_history)]] so look there for its editing history. That page also expands on the above summary of why that old page was replaced.
 
You will also note that this page does not cover all settings in detail, and find some links to further pages within some sections below
 
==Need to install MX 3.12.0 ==
== Alarms (and emails) ==
 
The Alarm settings seem to frequently be changed by new MX releases, so have been moved to a separate [[Alarms|wiki page]] where hopefully it will be easier for somebody to keep the content updated in future.
In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page, for release 3.11.2 and subsequent the alarm also has to be enabled for it to appear.
 
Introduction column:
# There was no alarm functionality in builds in the 3.0.0 and 3.1.x series
# Any alarm functionality where the column says "Legacy Cumulus" was available before 1.9.0 and introduced into MX in one of the releases between 3.2.0 and 3.5.4.
# Any alarm functionality where the column says "Cumulus 2" was requested for that withdrawn flavour, subsequently added to a 1.9.x release, introduced into MX in one of the releases between 3.2.0 and 3.5.4.
# New alarm functionality introduced in the range of releases 3.2.0 to 3.5.4 has that range shown (rather than the exact release).
# For alarm functionality first introduced in or after release 3.7.0, the release of introduction is shown in "Introduced" column.
# There were no changes to Alarm functionality between 3.7.1 and 3.8.4 inclusive, so if you are running one of the 3.8.x releases, the Wiki page that applies for "alarms" is [[Cumulus.ini_(MX_3.0.0_to_3.7.0)|the early MX releases page]], not this Wiki page.
# In the range of releases subsequent to 3.9.0 as covered by this Wiki page, the alarm functionality has been dramatically changing:
#* Latching of alarms was introduced at 3.9.1 (b. 3096), most alarms had no default for how long they stayed "latched", but at least one had a 12 hour default and at least one had an until end of day default.
#* At 3.9.2 (b.3097) reporting of notifications were added to the admin interface (called "Cumulus Dashboard" in the relevant release announcement at [https://cumulus.hosiene.co.uk/viewtopic.php?p=148406#p148406 Cumulus MX Announcements and Download - PLEASE READ FIRST],
#* At 3.9.5 (b. 3100) the latching functionality was corected,
#* At 3.9.6 (b.3101) the alarm latch hours were all defaulted to 24 hours,
#* At 3.11.0 (build 3129) where the email functionality was added,
#* And at 3.11.2 (b. 3131) where the [https://cumulus.hosiene.co.uk/viewtopic.php?p=154233#p154233 release announcement] says "this release sees the Alarms getting some more love".
 
"Shown on Settings page?" and "MX Section" columns:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were "always" shown, and none required opening a "MX section".
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings on the "Internet Settings" page, where there is a section "Email Server Settings" that needs to be opened, and a ''master'' setting that determines whether other settings are shown or not.
 
"Label on Settings page" column:
* For releases between 3.2.0 and 3.10.5, all alarm related settings were shown using [[MX_Basic_info#dataTables|a HTML table]], so the entry in the label column in the table below quotes the text shown after the check box that starts the settings table row
* For release 3.11.0 and subsequent releases, the introduction of email functionality means there are now some alarm related settings where the label column quotes the text shown beside the individual setting, but all other alarm related settings quote the text shown after the check box that starts a settings table row
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Shown on Settings page?
!style="width:100px" | File Section
!style="width:150px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page (mostly in '''Alarm''' column)
!style="width:20px" | Default
!style="width:300px" | Description
|-
| alarmhighgust=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated (10 minute) wind gust that has to be exceeded to trigger the alarm
|-
| alarmhighpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure that has to be exceeded to trigger the alarm
|-
| alarmhighrainrate=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated rainfall rate that has to be exceeded to trigger the alarm
|-
| alarmhighraintoday=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated daily rainfall total that has to be exceeded to trigger the alarm
|-
| alarmhightemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured outside temperature that has to be exceeded to trigger the alarm
|-
| alarmhighwind=
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| Use the spin button to select the '''Value''' of calculated average wind speed that has to be exceeded to trigger the alarm
|-
|-
| alarmlowpress=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| Use the spin button to select the '''Value''' of measured Sea Level Pressure it must go below to trigger the alarm
|-
| alarmlowtemp=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0
| Use the spin button to select the '''Value''' of measured outside temperature it must go below to trigger the alarm
|-
| alarmpresschange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Pressure changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured Sea Level Pressure must rapidly change (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| alarmtempchange=0
| (always)
| [Alarms]
| Cumulus 2
| Alarm Settings
| Temperature changes by:
| 0
| Use the spin button to select the '''Value''' by which the measured outside temperature must rapidly change (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) to trigger the alarm
|-
| BatteryLowAlarmEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Station batteries are low
| (blank)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| BatteryLowAlarmLatch=
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| BatteryLowAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Station batteries are low
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| BatteryLowAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| BatteryLowAlarmSet=0
| (always)
| [Alarms]
| (changed at 3.10.3)
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if the weather station either supplies a voltage, or other battery indication that can be interpreted, and MX interprets that as indicating a low battery
|-
| BatteryLowAlarmSound=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| BatteryLowAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Station batteries are low
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataSpikeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataSpikeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataSpikeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data spike is detected
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataSpikeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataSpikeAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings &rarr; Spike removal")
|-
| DataSpikeAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataSpikeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data spike is detected
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DataStoppedAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| DataStoppedAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| DataStoppedAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Data connection is lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| DataStoppedAlarmNotify=0
| (always)
| [Alarms]
| Release 3.4.2
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| DataStoppedAlarmSet=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if while MX is processing raw data from the weather station (in archive catch-up or normal running) there is a spike (a change since previous raw value read that exceeds a difference as defined on "Calibration Settings &rarr; Spike removal")
|-
| DataStoppedAlarmSound=0
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| DataStoppedAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.7.0
| Alarm Settings
| Data connection is lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| DestEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| To email adressess(es)
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.
 
You can enter either a single email addresss or a list of email addresses here, a semicolon must be used as separator between addresses.
|-
| Enabled=0
| When section opened
| [SMTP]
| Release 3.11.0
| Internet Settings &rarr; Email Server Settings
| Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| If you tick here, a selection of further options (identified by ^) are shown
|-
| FromEmail=
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| From email address
| (blank)
| Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank.
 
You can enter a single email addresss
|-
| HighGustAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighGustAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighGustAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Wind gust more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighGustAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighGustAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighGustAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighGustAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Wind gust more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainRateAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainRateAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainRateAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall rate rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainRateAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainRateAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainRateAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainRateAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall rate rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighRainTodayAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighRainTodayAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighRainTodayAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Rainfall today more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighRainTodayAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighRainTodayAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighRainTodayAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighRainTodayAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Rainfall today more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature rises above:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighTempAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighTempAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature rises above:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HighWindAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered
|-
| HighWindAlarmLatch=0
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HighWindAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Average wind more than:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HighWindAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HighWindAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HighWindAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HighWindAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Average wind more than:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| HttpUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| HttpUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| HttpUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| HttpUploadAlarmSet=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| HttpUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| HttpUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| HttpUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| HTTP upload errors
| 1 (trigger immediately a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Logging=0
| ^
| [SMTP]
| Release 3.11.2
| Depends on release:
# (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
# (Release 3.12.0 onwards) Program Settings → Logging Options
| Email logging
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want to enable extra SMTP logging to the smtp.log file in the [[MXdiags folder|'''MXdiags''' folder]].
* Don't tick (value shown as 0 in Cumulus.ini) for no extra information in diagnostic logging
|-
| LowPressAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowPressAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowPressAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Pressure falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowPressAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowPressAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowPressAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| LowPressAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| LowTempAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| LowTempAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| LowTempAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.9.1
| Alarm Settings
| Temperature falls below:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| LowTempAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| LowTempAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| LowTempAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature falls below:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| At time of writing there is a MX bug:
* (Reads) LowTempAlarmSoundFile=alarm.mp3
* (Writes) LowTempAlarm.SoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature falls below:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| MySqlUploadAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| MySqlUploadAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| MySqlUploadAlarmNotify=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| MySqlUploadAlarmSound=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| MySqlUploadAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| MySqlUploadAlarmTriggerCount=1
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| MySQL upload errors:
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| Password=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings &rarr; Email Server Settings
| Password
| (blank)
| Text box where you enter password needed to authenticate with your SMTP email server
|-
| Port=587
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings &rarr; Email Server Settings
| Network Port
| 587
| Text box where you enter the port used to connect to your SMTP email server
|-
| PressChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| PressChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| PressChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Pressure changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| PressChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| PressChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if measured Sea Level Pressure rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| PressChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Pressure changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| PressChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Pressure changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| RequiresAuthentication=0
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings &rarr; Email Server Settings
| Use authentication
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if a user name and password is needed to authenticate with your SMTP email server
* Don't tick (value shown as 0 in Cumulus.ini) if your SMTP email server is not protected by a user name or password
|-
| SensorAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| SensorAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| SensorAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Sensor contact lost
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| SensorAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| SensorAlarmSet=1
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
|-
| SensorAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| SensorAlarmSoundFile==alarm.mp3
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Sensor contact lost
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| ServerName=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings &rarr; Email Server Settings
| Server Name
| (blank)
| Text box where you enter name, or IP address of your SMTP email server
|-
| SSLOption=1
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings &rarr; Email Server Settings
| Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security)
| 1 (Auto)
| Drop down:
* 0 = None
* 1 = Auto
* 2 = TLS on connect
* 3 = Start TLS
* 4 = Start TLS when available
|-
| SpikeAlarmTriggerCount=
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Data spike is detected
| 1 (trigger immediently a failure occurs)
| Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
|-
| TempChangeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| TempChangeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| TempChangeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Temperature changes by:
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| TempChangeAlarmNotify=0
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| TempChangeAlarmSet=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| TempChangeAlarmSound=0
| (always)
| [Alarms]
| Legacy Cumulus
| Alarm Settings
| Temperature changes by:
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| TempChangeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| within 3.2.0 to 3.5.4
| Alarm Settings
| Temperature changes by:
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UpgradeAlarmEmail=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
|-
| UpgradeAlarmLatch=0
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
|-
| UpgradeAlarmLatchHours=24
| (always)
| [Alarms]
| Release 3.11.2
| Alarm Settings
| Cumulus upgrade available
| 24 (default set only since release 3.9.6)
| Use the spin button to select the number of hours (specified in '''Latch h(ou)rs''' column) that the "latch" is maintained if previous setting is set to 1 (tick on settings page)
|-
| UpgradeAlarmNotify=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
|-
| UpgradeAlarmSet=0
| (always)
| [Alarms]
| Release 3.9.3
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Enable''', the alarm will be triggered if outside temperature rapidly changes (in legacy Cumulus this was taking trend for the last hour, the developer has not specified what period applies for MX) by, or more than, the selected '''Value''' in earlier parameter
|-
| UpgradeAlarmSound=0
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| 0 (disabled)
| If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
|-
| UpgradeAlarmSoundFile=alarm.mp3
| (always)
| [Alarms]
| Release ???
| Alarm Settings
| Cumulus upgrade available
| alarm.mp3
| Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
|-
| UseHTML=0
| (always)
| [Alarms]
| Release 3.11.0
| Alarm Settings
| '''Email uses HTML text formatting'''
| 0 (UTF-8 plain text)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you wish to use HTML encoding format for your customised emails
* Don't tick (value shown as 0 in Cumulus.ini) if you are happy to use the default emails text in UTF-8 plain text encoding
|-
| User=
| ^
| [SMTP]
| Release 3.11.0
| Internet Settings &rarr; Email Server Settings
| Username
| (blank)
| Text box where you enter user name needed to authenticate with your SMTP email server
|}
 
==Charts==
| 0 (disabled)
| This adds extra information about both data transfers initiated from MX, and all the internal MX processes.
|}
 
== Display Options ==
 
* File Section is '''[Display]'''
* MX Section is '''Station Settings &rarr; Display Options'''
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| DisplaySolarData=0
| ??? 3.10.0 ???
| Display Solar data
| Unticked (shown as 0 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display solar data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data
|-
| DisplayUvData=0
| ??? 3.10.0 ???
| Display UV-I data
| Unticked (shown as 0 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display ultra-violet intensity data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display UV intensity data
|-
| NumWindRosePoints=16
| Legacy Cumulus
| Number of wind rose points
| 16
| Drop-down determining if weather station bearing supplied by weather station is to be converted to 8 or 16 compass directions (i.e. whether to include or exclude (in English) NNE, ENE, ESE, SSE, SSW, WSW, WNW, and NNW
* 8 points
* 16 points
Despite what it says in the hint on the settings page, leave at default whichever weather station type you use, unless this actually causes you a problem. The parameter was introduced by Steve Loft. Davis wind vanes use a potentiometer to measure wind direction so send Cumulus a bearing that can vary continuously between 1 and 360 degrees. Fine Offset wind vanes use magnetic switches that depend on the magnet under the moving part selecting two switches in the fixed part for the vane being exactly in-between compass directions, and selecting one switch for the main 8 directions and slightly away from the main directions; so they have a bias against sending Cumulus the in-between directions.
|-
| UseApparent=1
| ??? MX 3.6.0 or 3.10.0 ???
| Use Apparent Temperature
| Ticked (shown as 1 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display apparent temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus prior to release 3.6.0
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to display feels like temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus from release 3.6.0
|}
 
==Optional Structured Query Language Settings==
 
MX uses a software package called "MySqlConnect" to run SQL queries.
SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey.
 
Since the text that appeared here was added, documenting plans for the future 3.12.0 release, there have been a number of changes, and now a future release (3.20.0) is expected to make more drastic changes. Therefore the content has been moved to a [[MySqlConnect|new "MySqlConnect" page]] where it is hoped somebody will find it easier to update the content as MX develops.
MX uses two types of SQL. One type is for SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type stores data in rows that are numbered, and columns that are named. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifyimg content, but that gets translated into a row number to actually determine what is updated.
 
The file section '''[MySQL]''' is about a different type of database (i.e. Maria database, or Oracle MySQL) these implement a relational database that has to satisfy the rule that all data appears in a table with rows and columns. The columns have a particular order, but there is no control over the order of rows, so you can't specify a row number, you either specify a primary key that identifies a particular row, or you specify that what is returned from query should be sorted in an ascending/descending order of the value in a specified column.
 
Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings:
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Executable
!style="width:100px" | Function
!style="width:300px" | Description
|-
| CumulusMX.exe
| Data Logs menu
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default.
|-
! rowspan="7" |CumulusMX.exe
| Settings menu &rarr; MySQL settings &rarr; General Options
| An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option.
|-
| Settings menu &rarr; MySQL settings &rarr; Realtime.txt Upload
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]].
|-
| Settings menu &rarr; MySQL settings &rarr; Dayfile.txt Upload
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table.
|-
| Settings menu &rarr; MySQL settings &rarr; Monthly log file Upload
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]].
|-
| Settings menu &rarr; MySQL settings &rarr; Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu &rarr; MySQL settings &rarr; Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
| Settings menu &rarr; MySQL settings &rarr; Custom Upload - at rollover
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur.
|-
| ExportToMySQL.exe
| parameters to utility
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
|}
WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MARIA db syntax.
 
Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....);
 
 
BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>
 
* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu &rarr; MySQL settings
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| BufferOnFailure=0
| General Options
| Buffer commands on failure
| 0 = ignore errors
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
| CustomMySqlMinutesCommandString=
| Custom Upload - minutes interval
| "SQL command" only shown if next parameter is ticked
| (empty)
| See "predetermined SQL" example above
|-
| CustomMySqlMinutesEnabled=0
| Custom Upload - minutes interval
| Custom Minutes Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlMinutesIntervalIndex=6
| Custom Upload - minutes interval
| Interval:
| 6 = 10 minutes
| Drop-down list of predetermined intervals:
* 0 = 1 minute
* 1 = 2 minutes
* 2 = 3 minutes
* 3 = 4 minutes
* 4 = 5 minutes
* 5 = 6 minutes
* 6 = 10 minutes
* 7 = 12 minutes
* 8 = 20 minutes
* 9 = 30 minutes
* 10 = 1 hour (60 minutes)
|-
| CustomMySqlRolloverCommandString=
| Custom Upload - at rollover
| "SQL command" only shown if next parameter is ticked
| (empty)
| See "predetermined SQL" example above
|-
| CustomMySqlRolloverEnabled=0
| Custom Upload - at rollover
| Custom Rollover Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsCommandString=
| Custom Upload - seconds interval
| "SQL command" only shown if next parameter is ticked
| (empty)
| See "predetermined SQL" example above
|-
| CustomMySqlSecondsEnabled=0
| Custom Upload - seconds interval
| Custom Seconds Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
|-
| CustomMySqlSecondsInterval=10
| Custom Upload - seconds interval
| Interval (seconds):
| 10
| A number field, takes 1 to 59
|-
| Database=
| Server details
| Database name:
| (empty)
| A text field where you enter the name of the database your tables are to be created/updated in
|-
| DayfileMySqlEnabled=0
| Dayfile.txt upload
| Dayfile Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but the option to update table when you edit "dayfile.txt" will fail (and if set to do so, keep failing as it repeats).
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but the option to update table when you edit "MMMyyyyLog.txt" will fail (and if set to do so, keep failing as it repeats).
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* Seconds
* Minutes
* Hours
* Days
* Weeks
* Months
Taken together, these determine the period for which rows are kept in the table named in "RealtimeTable", any row older than this specification will be deleted as part of the automatic SQL
|-
| RealtimeTable=Realtime
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see begining of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}
 
 
==Optional Web Server==
 
There are two sub-sections below, because the settings for the optional web functionality are split between '''Station Settings''' and '''Internet Settings'''.
The settings listed here changed dramatically at both 3.10.0 and 3.12.0 releases, but they have gradually evolved throughout the development of MX.
 
 
=== Display Options controlling what appears on default web pages ===
 
* File Section is '''[Display]'''
* MX Section is '''Station Settings &rarr; Display Options'''
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| DisplaySolarData=0
| ??? 3.10.0 ???
| Display Solar data
| Unticked (shown as 0 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display solar data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data
|-
| DisplayUvData=0
| ??? 3.10.0 ???
| Display UV-I data
| Unticked (shown as 0 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display ultra-violet intensity data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards)
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display UV intensity data
|-
| NumWindRosePoints=16
| Legacy Cumulus
| Number of wind rose points
| 16
| Drop-down determining if weather station bearing supplied by weather station is to be converted to 8 or 16 compass directions (i.e. whether to include or exclude (in English) NNE, ENE, ESE, SSE, SSW, WSW, WNW, and NNW
* 8 points
* 16 points
Despite what it says in the hint on the settings page, leave at default whichever weather station type you use, unless this actually causes you a problem. The parameter was introduced by Steve Loft. Davis wind vanes use a potentiometer to measure wind direction so send Cumulus a bearing that can vary continuously between 1 and 360 degrees. Fine Offset wind vanes use magnetic switches that depend on the magnet under the moving part selecting two switches in the fixed part for the vane being exactly in-between compass directions, and selecting one switch for the main 8 directions and slightly away from the main directions; so they have a bias against sending Cumulus the in-between directions.
|-
| UseApparent=1
| ??? MX 3.6.0 or 3.10.0 ???
| Use Apparent Temperature
| Ticked (shown as 1 in Cumulus.ini)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display apparent temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus prior to release 3.6.0
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to display feels like temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus from release 3.6.0
|}
 
 
=== File transfer and Copy Options controlling transfer of data to default web pages ===
 
The settings listed in table below changed dramatically at both 3.10.0 and 3.12.0 releases, but they have gradually evolved throughout the development of MX.
 
FRomFrom 3.12.0, MX can optionally ''either'' '''copy''' files to a [[Your Own Server|web server you host]] ''or'' '''file transfer''' files to a [[Webspace|commercial web server]].
 
To implement (and customise) this web server functionality, there are many settings as listed alphabetically in this table. The ''Internet settings'' page simplifies making settings by providing selections that amend multiple settings in a bulk operation:
* Some settings (marked ^ in table) are only displayed if you select '''I want to use the supplied default web site'''.
** For these settings, the "Generate" option is enabled in nearly all (see any qualifier) settings
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/10627"