Alarms: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m (Added screen shot) |
mNo edit summary |
||
| Line 35: | Line 35: | ||
= |
= The Alarm Settings= |
||
Once again, be aware that the information shown may be badly out of date, as MX evolves very quickly. |
|||
| ⚫ | |||
== The "Alarm settings" screen in interface == |
|||
| ⚫ | The following screenshot is for release 3.20.0, showing some invalid selections (red edged), some selections made (entries ticked or populated with content), and is intended just as an indication of what you may see. The files listed for sound are at path of '''CumulusMX/interface/sounds'''. Alarm latch time hours are from 3.20.0 able to take decimal values, earlier releases only accepted integer latch hour values. The ''Action'' columns are new at 3.20.0, and can be used to call a script or run external exe etc. but are not listed in the table below. |
||
[[File:Alarm settings.png]] |
[[File:Alarm settings.png]] |
||
==Notes== |
==Notes for table below == |
||
In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX. |
In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX. |
||
Revision as of 06:20, 21 August 2022
Introduction
MX has a sophisticated system allowing alarms to be displayed (and optionally other actions, including sending emails) for many different events.
This Wiki page lists the alarms available, and provides some guidance for using the alarm settings page in the interface.
It briefly covers the file that stores alarm settings, but see main Cumulus.ini page for more general information.
Since this Wiki page describes settings that frequently change, this page may be out of date, unless somebody is willing to update the Wiki when a MX release makes a change, it is hoped that presenting Alarms as a separate small Wiki page will make it more likely that somebody will keep it up to date.
Structure of Cumulus.ini
The settings described here are stored in a file called "Cumulus.ini".
The file is divided into "File sections" (see terminology definitions below), each File section name is on a separate line (with no other content) and enclosed in square brackets (e.g. [Station]).
These File sections can appear in any order, by default new File sections are appended after all previous File sections, but if you prefer the File sections in another order, MX can still find them, although it may spend more time searching!
Within each File section, there are parameters. Each parameter is in format Attribute=Value, and appears on a line to itself.
The parameters, within a File section, can be in any order, by default new parameters are appended at end of the relevant File section.
Why are settings now split between several Wiki pages?
The basic answer is because there are a lot of settings, some get changed, and more are added as Cumulus develops!
MX has been developed very dramatically by Mark Crossley:
- There were minor differences between the legacy cumulus.ini (for versions 1.x.y, ending with 1.9.4) with documentation now here and the original 3.0.0 beta (previously documented on Cumulus.ini (Beta) page, but that page has been cleared)
- The dramatic development of MX produced considerable differences between that original MX beta, and the configuration that applied up to 3.7.0, as now documented here
- 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, the decision was taken in June 2021 to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new page now found here!
All the pages, previously called "Cumulus.ini", can be found from the owning 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.
The Alarm Settings
Once again, be aware that the information shown may be badly out of date, as MX evolves very quickly.
The "Alarm settings" screen in interface
The following screenshot is for release 3.20.0, showing some invalid selections (red edged), some selections made (entries ticked or populated with content), and is intended just as an indication of what you may see. The files listed for sound are at path of CumulusMX/interface/sounds. Alarm latch time hours are from 3.20.0 able to take decimal values, earlier releases only accepted integer latch hour values. The Action columns are new at 3.20.0, and can be used to call a script or run external exe etc. but are not listed in the table below.
Notes for table below
In the table below "Notify" determines whether an alarm is shown on the "Dashboard" page in the local network interface (confusingly the developer describes it by a variety of different names, and "user interface" or "admin interface" have been used) provided with MX.
For release 3.11.2 and subsequent each individual alarm also has to be enabled for it to appear in that display. Please see release announcements in the support forum for information on individual alarms, to help you find the appropriate post, and indication is given in the table of which release introduced each alarm:
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, and was introduced into MX in one of the releases between 3.2.0 and 3.5.4; rather than indicate the precise release any introductions in that range of releases has that range shown.
- For alarm functionality first introduced in or after release 3.7.0, the exact 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 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 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 release announcement says "this release sees the Alarms getting some more love".
- Please check earlier on this page to see whether any update has been made yet for changes to Alarms in subsequent releases, as this page may be badly out of date.
"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 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
Table showing Alarm details
At last update, this table shows position as at beta build 3135, (missing some changes included in the 3.12.0 release build of 3141). It is therefore somewhat out of date, in regard to latest MX release, but most of the information that is included below remains valid.
| Parameter Line Entry | Shown on Settings page? | File Section | Introduced | MX Section | Label on Settings page (mostly in Alarm column) | Default | 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 (by default over 10 minutes) 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 based on 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 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 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 → 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 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 → 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 address 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 → 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 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 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 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 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 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 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 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:
|
Email logging | 0 (disabled) | Simple tick or not
|
| 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 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 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:
|
(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 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 → 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 → 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 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 → Email Server Settings | Use authentication | 0 (disabled) | Simple tick or not
|
| 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 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 → 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 → Email Server Settings | Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) | 1 (Auto) | Drop down:
|
| 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 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 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
|
| User= | ^ | [SMTP] | Release 3.11.0 | Internet Settings → Email Server Settings | Username | (blank) | Text box where you enter user name needed to authenticate with your SMTP email server |
