|
|
| (37 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| <big>Please note this page was created 13 June 2021. | | <big>Please note this page was created 13 June 2021. |
|
| |
|
| At last update, it shows position as at beta build 3135. | | At last update, it shows position as at beta build 3135, (missing some changes for the 3.12.0 release build of 3141). |
|
| |
|
| This new page was created to reflect parameters added to Cumulus.ini in releases 3.8.0, 3.9.2, 3.10.0, and 3.12.0 (early beta builds - June 2021). It excludes all parameters removed after release 3.7.0.</big> | | This new page was created to reflect parameters added to Cumulus.ini in releases 3.8.0, 3.9.2, 3.10.0, and 3.12.0 (early beta builds - June 2021). It excludes all parameters removed after release 3.7.0.</big> |
| Line 7: |
Line 7: |
| {{Template:WorkInProgressBanner}} | | {{Template:WorkInProgressBanner}} |
| Since this page describes a file whose content frequently changes, this page may be out of date, unless somebody bothers to update it for every change. | | Since this page describes a file whose content frequently changes, this page may be out of date, unless somebody bothers to update it for every change. |
|
| |
| ''Note that 3.12.0 (when first installed) apparently automatically rewrites this file, to remove some historic parameters, and to insert some new parameters, hopefully the release announcement will explain this.''
| |
|
| |
|
| =Purpose of Cumulus.ini file= | | =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 application. | | This is a text file containing initialization parameters. {{Template:Version badge Mx}}This page covers those used by the Cumulus MX software applica3.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". | | 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". |
| Line 22: |
Line 20: |
| * Control what is output to those destinations, to the extent that each can be configured | | * Control what is output to those destinations, to the extent that each can be configured |
|
| |
|
| == Why does this Wiki now contain multiple pages describing "Cumulus.ini"?==
| | |
| | |
| | = Why does this Wiki now contain multiple pages describing "Cumulus.ini"?= |
|
| |
|
| [[Category:Configuration Files]] | | [[Category:Configuration Files]] |
| Line 30: |
Line 30: |
| # 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> | | # 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 == |
| | |
| | If you are using Cumulus 1 or a release of MX earlier than 3.12.0, be aware that the content of "Cumulus.ini" is totally different to the file for later MX releases. (It might have been better had the file been given a new name in release 3.12.0). |
| | |
| | The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from [https://github.com/cumulusmx/CumulusMX/releases/download/b3141/CumulusMXDist3141.zip here] and runs that release for a while before upgrading to the latest release [https://github.com/cumulusmx/CumulusMX here]. |
|
| |
|
| == Simplifications == | | == Simplifications == |
| Line 147: |
Line 156: |
| The MX software offers much functionality and flexibility. Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting. | | The MX software offers much functionality and flexibility. Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting. |
|
| |
|
| ==First run of MX==
| | <big>Please see [[First Run of MX]] for how to set up settings when you first use MX.</big> |
| | |
| This Wiki page does not explain how to start using MX, please see [[MX on Linux]], [[MX on Windows OS]], and [[MX Administrative Interface]] as appropriate.
| |
| | |
| The key fact relevant here is that no Cumulus release distribution contains a '''Cumulus.ini''' file. So when you first use the software, you will need to use the [[MX_Administrative_Interface#Changing_Settings|admin interface]] to enter all settings (some have defaults that might be right for you) as described later in this page, and that will lead to creation of the main configuration file.
| |
| | |
| # If you start Cumulus MX without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this: [[File:MX first start.PNG]]
| |
| # As you can see, it is running, but it does not know what station type, so it cannot connect to it, and will not do anything more.
| |
| # At this stage, MX creates a very basic Cumulus.ini with the default settings (shown below).
| |
| #Open the [[MX Administrative Interface|admin interface]], and select the station settings if necessary: [[File:MX_station_settings.png|800px|center]]
| |
| # At the very minimum, you must select a station type and units (as shown in image here)
| |
| # Optionally, move down the page, entering more settings,
| |
| #* The settings that are displayed to you vary depending on the station type you have selected (and the particular MX release), so there is not a screenshot to show you the other settings for your station type.
| |
| # Optionally, move to other settings pages accessed from the menu seen in the image, these cover the optional functionality of MX, so the pages you need to visit depends on what functionality you wish to use.
| |
| # Optionally, use [[Samplestring.ini]] file as a guide to create a [[Strings.ini|strings.ini]] file (look up the cross reference if you want to do this now, but you can leave it to later) where you can tailor a number of texts that Cumulus produces.
| |
| #* The advantage of creating your '''strings.ini''' file now, is that it is read when MX starts, and we will shortly restart MX.
| |
| # Closing MX is the action that will create the main configuration file.
| |
| # MX must be stopped correctly, because it has to do a number of actions after it receives a request to close:
| |
| #* If you have a screen attached to the device running the MX engine, you can click in that screen and terminate Cumulus MX by typing '''C''' while holding down the control key (or equivalent if you are using an apple mac).
| |
| #* If you are connecting to MX from a remote device, then type into that remote session the control '''C'''.
| |
| #* Otherwise do whatever is needed to end the MX executable on your installation.
| |
| # Restart Cumulus MX, it will read your new settings (in '''Cumulus.ini''' and the optional '''strings.ini''') on re-starting, it will find the weather station, and start reading the weather data from it. On this first access to your weather station, it will not read any archive data (there is a way to modify [[today.ini]] so it can read what is in the separate logger), but from now (until you stop it) it will read (and from time to time log) the live data while MX remains running.
| |
|
| |
|
| ==What happens if I upgrade MX?== | | ==What happens if I upgrade MX?== |
| Line 273: |
Line 261: |
|
| |
|
| As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file. You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page. | | As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file. You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page. |
|
| |
|
| |
|
| |
|
| =Tables listing Settings= | | =Tables listing Settings= |
| Line 304: |
Line 290: |
| == Alarms (and emails) == | | == Alarms (and emails) == |
|
| |
|
| 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.
| | 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. |
|
| |
|
| Introduction column:
| | ==Charts== |
| # There was no alarm functionality in builds in the 3.0.0 and 3.1.x series
| | {{Template:WorkInProgressBanner}} Charts have evolved rapidly in MX development, this table needs verification by somebody who uses the functionality documented here. Can you be the contributor to bring it up to date? |
| # 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" | | {| class="wikitable" border="1" |
| |- | | |- |
| !style="width:30px" | Parameter Line Entry | | !style="width:30px" | Parameter Line Entry |
| !style="width:100px" | Shown on Settings page?
| |
| !style="width:100px" | File Section | | !style="width:100px" | File Section |
| !style="width:150px" | Introduced | | !style="width:100px" | Introduced |
| !style="width:100px" | MX Section | | !style="width:100px" | MX Section |
| !style="width:60px" | Label on Settings page (mostly in '''Alarm''' column) | | !style="width:60px" | Label on Settings page |
| !style="width:20px" | Default | | !style="width:20px" | Default |
| !style="width:300px" | Description | | !style="width:600px" | Description |
| |- | | |- |
| | alarmhighgust=0 | | | GraphHours=24 |
| | (always)
| | | [Graphs] |
| | [Alarms] | |
| | Legacy Cumulus | | | Legacy Cumulus |
| | Alarm Settings | | | Station Settings → Graphs |
| | Wind gust more than: | | | Graph hours |
| | 0 (disabled) | | | 24 (2 rolling days worth of values) |
| | Use the spin button to select the '''Value''' of calculated (10 minute) wind gust that has to be exceeded to trigger the alarm | | | For those plots that show values (if available) minute by minute, how many days back to go. Some people prefer to set this to 48 or 96, that means uploading a lot more data in the [[:Category:JSON_Files|.json files]], but it shows more on charts |
| |- | | |- |
| | alarmhighpress=0 | | | AppTempVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Legacy Cumulus | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings
| | | Apparent temperature |
| | Pressure rises above:
| | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled)
| | | Simple tick or not indicating whether you want to see Australian Apparent Temperature plotted on Charts |
| | 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 | | | BaseTemperature1= |
| | (always)
| | | [GrowingDD] and [TempSum] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Legacy Cumulus | | | Station Settings → Growing Degree Days |
| | Alarm Settings | | | Base temperature #1 |
| | Rainfall today more than: | | | Depends on selected temperature units (not quite same) |
| | 0 (disabled) | | * (Celsius) 5 (equivalent to 41 <sup>o</sup>Fahrenheit) |
| | Use the spin button to select the '''Value''' of calculated daily rainfall total that has to be exceeded to trigger the alarm
| | * (Fahrenheit) 40 (equivalent to 4.44 <sup>o</sup>Celsius) |
| | | Base temperature for series 1 |
| |- | | |- |
| | alarmhightemp=0 | | | BaseTemperature2= |
| | (always)
| | | [GrowingDD] and [TempSum] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Legacy Cumulus | | | Station Settings → Growing Degree Days |
| | Alarm Settings | | | Base temperature #1 |
| | Temperature rises above: | | | Depends on selected temperature units (equivalent) |
| | 0 (disabled) | | * (Celsius) 10 |
| | Use the spin button to select the '''Value''' of measured outside temperature that has to be exceeded to trigger the alarm
| | * (Fahrenheit) 50 |
| |-
| | | Base temperature for series 2 |
| | 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 | |
| |- | | |- |
| | | Cap30C=1 |
| | | [GrowingDD] |
| | | Release3.11.0 - b3129 |
| | | Station Settings → Growing Degree Days |
| | | Cap GDD at 30°C / 86°F |
| | | Ticked (shown in Cumulus.ini as 1) |
| | | Simple tick or not indicating whether you want growing degree days capped and not incremented at high temperatures (threshold shown in setting name) |
| |- | | |- |
| | alarmlowpress=0 | | | ChartMaxDays=31 |
| | (always)
| | | [Graphs] |
| | [Alarms] | |
| | Legacy Cumulus | | | Legacy Cumulus |
| | Alarm Settings | | | Station Settings → Graphs |
| | Pressure falls below: | | | Graph Days |
| | 0 (disabled) | | | 31 (daily values) |
| | Use the spin button to select the '''Value''' of measured Sea Level Pressure it must go below to trigger the alarm | | | For those plots that show recent daily values, this states how many of them to plot |
| |- | | |- |
| | alarmlowtemp=0 | | | Colour0=#058DC7, Colour1=#50B432, Colour2=#ED561B, Colour3=#DDDF00, Colour4=#24CBE5, and Colour5=#64E572 |
| | (always)
| | | [Select-a-Chart] |
| | [Alarms] | | | Release 3.9.7 - b3107 |
| | Legacy Cumulus | | | ??? |
| | Alarm Settings | | | ??? |
| | Temperature falls below: | | | Hex colours as shown in parameter list |
| | 0 | | | Colour of line used for plotting the respective series |
| | Use the spin button to select the '''Value''' of measured outside temperature it must go below to trigger the alarm | |
| |- | | |- |
| | alarmpresschange=0 | | | DailyAvgTempVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Cumulus 2 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Daily Average Temperature |
| | Pressure changes by: | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 | | | Simple tick or not indicating whether you want to see Daily (integrated) Average temperature plotted on Charts |
| | 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 | | | DailyMaxTempVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Cumulus 2 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Daily Maximum Temperature |
| | Temperature changes by: | | | Ticked (shown in Cumulus.ini as 1) |
| | 0
| | | Simple tick or not indicating whether you want to see Daily Maximum temperature plotted on Charts |
| | 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= | | | DailyMinTempVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Release 3.11.0 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Daily Minimum Temperature |
| | Station batteries are low | | | Ticked (shown in Cumulus.ini as 1) |
| | (blank) | | | Simple tick or not indicating whether you want to see Daily Minimum temperature plotted on Charts |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered | |
| |- | | |- |
| | BatteryLowAlarmLatch= | | | DPVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Release 3.9.1 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Dew point |
| | Station batteries are low | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see Dew Point plotted on Charts |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | |
| |- | | |- |
| | BatteryLowAlarmLatchHours=24 | | | FeelsLikeVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Release 3.9.1 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Dew point |
| | Station batteries are low | | | Ticked (shown in Cumulus.ini as 1) |
| | 24 (default set only since release 3.9.6) | | | Simple tick or not indicating whether you want to see Feels Like Temperature plotted on Charts |
| | 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 | | | GrowingDegreeDaysVisible1=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | Release3.11.0 - b3129 |
| | within 3.2.0 to 3.5.4 | | | Station Settings → Graphs → Visibility → Degree Days |
| | Alarm Settings | | | Growing Degree Days series #1 |
| | Station batteries are low | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see series 1 plotted on Charts |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | |
| |- | | |- |
| | BatteryLowAlarmSet=0 | | | GrowingDegreeDaysVisible2=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | Release3.11.0 - b3129 |
| | (changed at 3.10.3) | | | Station Settings → Graphs → Visibility → Degree Days |
| | Alarm Settings | | | Growing Degree Days series #2 |
| | Station batteries are low | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see series 2 plotted on Charts |
| | 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 | | | HIVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | within 3.2.0 to 3.5.4 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Dew point |
| | Station batteries are low | | | Ticked (shown in Cumulus.ini as 1) |
| | alarm.mp3 | | | Simple tick or not indicating whether you want to see USA Heat Index plotted on Charts |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder | |
| |- | | |- |
| | DataSpikeAlarmEmail=0 | | | HumidexVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Release 3.11.0 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Dew point |
| | Data spike is detected | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see Canadian Humidity Index plotted on Charts |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered | |
| |- | | |- |
| | DataSpikeAlarmLatch=0 | | | InHumVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Release 3.9.1 | | | Station Settings → Graphs → Visibility → Humidity Data |
| | Alarm Settings | | | Dew point |
| | Data spike is detected | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see Indoor Relative Humidity plotted on Charts |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | |
| |- | | |- |
| | DataSpikeAlarmLatchHours=24 | | | InTempVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Release 3.9.1 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Dew point |
| | Data spike is detected | | | Ticked (shown in Cumulus.ini as 1) |
| | 24 (default set only since release 3.9.6) | | | Simple tick or not indicating whether you want to see Indoor Temperature plotted on Charts |
| | 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 | | | OutHumVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Release 3.7.0 | | | Station Settings → Graphs → Visibility → Humidity Data |
| | Alarm Settings | | | Dew point |
| | Data spike is detected | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see Outdoor Relative Humidity plotted on Charts |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | |
| |- | | |- |
| | DataSpikeAlarmSet=0 | | | Series0= to Series5= |
| | (always)
| | | [Select-a-Chart] |
| | [Alarms] | | | Release 3.9.7 - b3107 |
| | Release 3.7.0 | | | ??? |
| | Alarm Settings | | | ??? |
| | Data spike is detected | |
| | 0 (disabled) | | | 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") | | | Name of parameter to plot (in series 0 to 5) e.g. "Pressure", "Wind Gust", "Temperature", "Rainfall Rate", "Wind Bearing" |
| |- | | |- |
| | DataSpikeAlarmSound=0 | | | SolarVisible=1 |
| | (always) | | | [Graphs] |
| | [Alarms] | | | MX release 3.10.0 |
| | Release 3.7.0 | | | Station Settings → Graphs → Visibility → Solar Data |
| | Alarm Settings | | | UV Index |
| | Data spike is detected | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see Solar radiation plotted on Charts |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played | | |- |
| | | SunshineVisible=1 |
| | | [Graphs] |
| | | MX release 3.10.0 |
| | | Station Settings → Graphs → Visibility → Solar Data |
| | | UV Index |
| | | Ticked (shown in Cumulus.ini as 1) |
| | | Simple tick or not indicating whether you want to see Sunshine Hours plotted on Charts |
| |- | | |- |
| | DataSpikeAlarmSoundFile=alarm.mp3 | | | TempSumVisible0=1 |
| | (always)
| | | [TempSum] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Release 3.7.0 | | | Station Settings → Annual Temperature Sum |
| | Alarm Settings | | | Annual Temperature Sum 0 |
| | Data spike is detected | | | Ticked (shown in Cumulus.ini as 1) |
| | alarm.mp3
| | | Simple tick or not indicating whether you want to see Annual Temperature Sum series 0 plotted on Charts |
| | 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 | | | TempSumVisible1=1 |
| | (always)
| | | [TempSum] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Release 3.9.1 | | | Station Settings → Annual Temperature Sum |
| | Alarm Settings | | | Annual Temperature Sum #1 |
| | Data connection is lost | | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled) | | | Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 1 plotted on Charts |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | |
| |- | | |- |
| | DataStoppedAlarmLatchHours=24 | | | TempSumVisible2=1 |
| | (always)
| | | [TempSum] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Release 3.9.1 | | | Station Settings → Annual Temperature Sum |
| | Alarm Settings | | | Annual Temperature Sum #2 |
| | Data connection is lost | | | Ticked (shown in Cumulus.ini as 1) |
| | 24 (default set only since release 3.9.6) | | | Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 2 plotted on Charts |
| | 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 | | | TempSumYearStart= |
| | (always)
| | | [TempSum] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Release 3.4.2 | | | Station Settings → Annual Temperature Sum |
| | Alarm Settings | | | Year summation starting month |
| | Data connection is lost | | | Depends on hemisphere |
| | 0 (disabled) | | * (Northern hemisphere) 1 = January |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | | * (Southern hemisphere) 7 = July |
| | | Enter as a number the month for which (on first of that month) annual temperature summation is reset to zero |
| |- | | |- |
| | DataStoppedAlarmSet=0 | | | TempVisible=1 |
| | (always)
| | | [Graphs] |
| | [Alarms] | | | MX release 3.7.0 - b3089 |
| | Release 3.7.0 | | | Station Settings → Graphs → Visibility → Temperature Data |
| | Alarm Settings | | | Dew point |
| | Data connection is lost
| | | Ticked (shown in Cumulus.ini as 1) |
| | 0 (disabled)
| | | Simple tick or not indicating whether you want to see Outdoor Temperature plotted on Charts |
| | 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 | | | UVVisible=1 |
| | (always) | | | [Graphs] |
| | [Alarms] | | | MX release 3.10.0 |
| | Release 3.7.0 | | | Station Settings → Graphs → Visibility → Solar Data |
| | Alarm Settings | | | UV Index |
| | Data connection is lost | | | Ticked (shown in Cumulus.ini as 1) |
| | alarm.mp3 | | | Simple tick or not indicating whether you want to see Ultra Violet Index plotted on Charts |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder | | |- |
| | | WCVisible=1 |
| | | [Graphs] |
| | | MX release 3.7.0 - b3089 |
| | | Station Settings → Graphs → Visibility → Temperature Data |
| | | Dew point |
| | | Ticked (shown in Cumulus.ini as 1) |
| | | Simple tick or not indicating whether you want to see Wind Chill plotted on charts |
| |- | | |- |
| | DestEmail= | | | YearStarts= |
| | (always)
| | | [GrowingDD] |
| | [Alarms] | | | Release 3.11.0 - b3129 |
| | Release 3.11.0 | | | Station Settings → Growing Degree Days |
| | Alarm Settings | | | Growing season starting month |
| | To email adressess(es) | | | Depends on hemisphere |
| | (blank)
| | * (Northern hemisphere) 1 = January |
| | Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank. | | * (Southern hemisphere) 7 = July |
| | | Enter as a number the month for which (on first of that month) Growing degree days is reset to zero |
| | |} |
| | |
| | ==Data Logging== |
|
| |
|
| You can enter either a single email addresss or a list of email addresses here, a semicolon must be used as separator between addresses.
| | * Available in all Cumulus releases |
| | * File Section is [Station] |
| | {| class="wikitable" border="1" |
| |- | | |- |
| | Enabled=0
| | !style="width:30px" | Parameter Line Entry |
| | When section opened | | !style="width:100px" | Shown on Settings page? |
| | [SMTP] | | !style="width:100px" | MX Section |
| | Release 3.11.0 | | !style="width:60px" | Label on Settings page |
| | Internet Settings → Email Server Settings | | !style="width:20px" | Default |
| | Enabled | | !style="width:600px" | Description |
| | Not ticked (shown as 0 in Cumulus.ini)
| |
| | If you tick here, a selection of further options (identified by ^) are shown | |
| |- | | |- |
| | FromEmail= | | | DataLogInterval=2 |
| | (always) | | | (Always) |
| | [Alarms] | | | Station settings → General Settings |
| | Release 3.11.0
| | | Log interval |
| | Alarm Settings
| | | 2 (10 minutes) |
| | From email address | | | Drop-down: |
| | (blank) | | * 0 = 1 minute between MX logs into the one to three [[Monthly_log_files]] (i.e. [[Standard log files]], and optionally [[Extra Sensor Files]], [[Air_Link_Log.txt]]) |
| | Please note: You cannot '''Update Alarms''' to save any settings on this page if the text box for this parameter is left blank. | | * 1 = 5 minutes between MX logging lines |
| | | * 2 = 10 minutes between MX logging lines |
| You can enter a single email addresss
| | * 3 = 15 minutes between MX logging lines |
| | * 4 = 20 minutes between MX logging lines |
| | * 5 = 30 minutes between MX logging lines |
| |- | | |- |
| | HighGustAlarmEmail=0 | | | LogExtraSensors=0 |
| | (always) | | | (Depends on station type) Only from Release 3.12.0 |
| | [Alarms]
| | | Station settings → Common Options |
| | Release 3.11.0
| | | Extra sensors |
| | Alarm Settings | |
| | Wind gust more than: | |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered | | |Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) if your weather station can output readings to be logged in [[Extra Sensor Files]] |
| | * Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files. |
| |- | | |- |
| | HighGustAlarmLatch=0 | | | NoSensorCheck=0 |
| | (always) | | | (not yet on a settings page) |
| | [Alarms] | | | (not known) |
| | Release 3.9.1
| | | (not known) |
| | Alarm Settings
| | | 0 (normal) |
| | Wind gust more than:
| | | Boolean: |
| | 0 (disabled)
| | * 0 = MX will stop if any of the minimum set of sensors listed below fails |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | | * 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails |
| |- | | |
| | HighGustAlarmLatchHours=24
| | Minimum set of sensors: |
| | (always)
| | # Current air temperature |
| | [Alarms] | | # Current Relative Humidity |
| | Release 3.9.1
| | # At least one wind speed |
| | Alarm Settings
| | # Current air pressure (absolute or sea-level) |
| | Wind gust more than:
| | Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these). |
| | 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 | | | RainDayThreshold=-1 |
| | (always) | | | (with warning: "Here be dragons!") |
| | [Alarms] | | | Depends on release: |
| | Legacy Cumulus
| | * (3.5.1 to 3.11.4) Manual edit of file |
| | Alarm Settings
| | * (3.12.0 onwards) Station settings → Common Options → Advanced options |
| | Wind gust more than: | | | Rain day threshold |
| | 0 (disabled) | | | -1 (that represents 0.2 mm or 0.01 inches) |
| | If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter | | | The amount of rainfall that must be collected before MX treats today as a wet day |
| | |
| | ''The intention is this will represent more than one tip, as the first tip might contain some rain from an earlier day'' |
| |- | | |- |
| | HighGustAlarmSound=0 | | | RolloverHour=0 |
| | (always) | | | (Always) |
| | [Alarms] | | | Station settings → Log Rollover |
| | Legacy Cumulus | | | Time |
| | Alarm Settings | | | 0 (midnight) |
| | Wind gust more than: | | | Radio type selection: |
| | 0 (disabled) | | * 0 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches midnight |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played | | * 1 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time |
| |- | | |- |
| | HighGustAlarmSoundFile=alarm.mp3 | | | SnowDepthHour=0 |
| | (always) | | | (with warning: "Here be dragons!") |
| | [Alarms] | | | Depends on release: |
| | Legacy Cumulus
| | * (3.5.1 to 3.11.4) Manual edit of file |
| | Alarm Settings
| | * (3.12.0 onwards) Station settings → Common Options → Advanced options |
| | Wind gust more than:
| | | Snow depth hour |
| | alarm.mp3
| | | 0 (midnight) |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
| | | Spin selector of 0 to 23: Defines hour from which entries in [[Weather Diary]] for current calendar day are used. Prior to this hour the weather diary will be searched for Calendar yesterday |
| |-
| |
| | 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 | | | StartDate= |
| | (always) | | | (with warning: "Here be dragons!") |
| | [Alarms] | | | Station Settings → Common Options → Advanced Options |
| | Release 3.9.1
| | | Records Began date |
| | Alarm Settings
| | | (Set when you first use Cumulus) |
| | Pressure rises above: | | | Format used is determined by locale used for running MX. If this date is edited, keep to same format. MX generally (see [[Calculate_Missing_Values#CreateMissing.exe]] for exceptions) ignores any data file entries prior to this date. |
| | 0 (disabled) | |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | |
| |- | | |- |
| | HighPressAlarmLatchHours=24 | | | UseDataLogger=1 |
| | (always) | | | (probably determined by station type) |
| | [Alarms] | | | (not known) |
| | Release 3.9.1 | | | (not known) |
| | Alarm Settings | | | 1 (enabled) |
| | Pressure rises above: | | |Simple tick or not |
| | 24 (default set only since release 3.9.6)
| | * Tick (value shown as 1 in Cumulus.ini) if your weather station has its own storage, so MX can do a catch up when it first starts and read any "archive data" |
| | 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)
| | * Don't tick (value shown as 0 in Cumulus.ini) if your weather station has no storage, and therefore MX cannot capture any readings when it is not running |
| |- | | |- |
| | HighPressAlarmNotify=0 | | | Use10amInSummer=1 |
| | (always) | | | (Always) |
| | [Alarms] | | | Station settings → Log Rollover |
| | within 3.2.0 to 3.5.4 | | | Use 10am in Summer |
| | Alarm Settings | | | 1 (normal) |
| | Pressure rises above: | | | Tick box: |
| | 0 (disabled)
| | * 0 = If "Daylight Saving Time" (DST) applies in Summer, |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
| | ** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not |
| |-
| | ** If rollover time is 9 a.m., MX is to use 9 am local time, regardless of whether DST is in operation or not |
| | HighPressAlarmSet=0
| | * 1 = Normal behaviour: |
| | (always)
| | ** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not |
| | [Alarms]
| | ** If MX would do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time, then it waits until 10 a.m. local time while DST is in effect |
| | Legacy Cumulus
| | |} |
| | Alarm Settings
| | |
| | Pressure rises above:
| | |
| | 0 (disabled)
| | ==Debugging== |
| | If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
| | |
| |- | | * Available from beta MX. |
| | HighPressAlarmSound=0
| | * File Section is [Station] |
| | (always)
| | {| class="wikitable" border="1" |
| | [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
| | !style="width:30px" | Parameter Line Entry |
| | (always) | | !style="width:300px" | MX Section |
| | [Alarms] | | !style="width:60px" | Label on Settings page |
| | Legacy Cumulus
| | !style="width:20px" | Default |
| | Alarm Settings | | !style="width:600px" | Description |
| | 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 | | | Logging=1 |
| | (always) | | | Depends on release installed: |
| | [Alarms]
| | # Alternatives: |
| | Release 3.11.0
| | #* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX. |
| | Alarm Settings
| | #* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options |
| | Rainfall rate rises above: | | # (Release 3.9.4 to 3.11.4) Program Settings → Program General Options |
| | # (Release 3.12.0 onwards) Program Settings → Logging Options |
| | | Debug logging |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered | | | This adds extra information about data transfers between your weather station and MX. |
| | |
| | It was introduced originally for Davis stations only, but later (can someone insert here the relevant release) extended to cover more stations. |
| |- | | |- |
| | HighRainRateAlarmLatch=0 | | | DataLogging=1 |
| | (always) | | | Depends on release installed: |
| | [Alarms]
| | # Alternatives: |
| | Release 3.9.1
| | #* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: DataLogging = 1, then restart Cumulus MX. |
| | Alarm Settings
| | #* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options |
| | Rainfall rate rises above:
| | # (Release 3.9.4 to 3.11.4) Program Settings → Program General Options |
| | 0 (disabled)
| | # (Release 3.12.0 onwards) Program Settings → Logging Options |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
| | | Debug logging |
| |-
| |
| | 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) | | | 0 (disabled) |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | | | This adds extra information about both data transfers initiated from MX, and all the internal MX processes. |
| | |} |
| | |
| | ==Extra Web Files== |
| | |
| | There are 100 occurrences of each parameter in Cumulus.ini, and therefore each parameter has a base name followed by numbers 0 to 99. |
| | |
| | The settings interface presents the rows on multiple pages, the rows are not numbered, so you have to do some counting to work out which row in the admin interface page corresponds with which parameter in Cumulus.ini file. |
| | |
| | '''You MUST restart MX after any changes in this section, before the new settings take effect.''' |
| | |
| | {| class="wikitable" border="1" |
| |- | | |- |
| | HighRainRateAlarmSet=0
| | !style="width:30px" | Parameter Line Entry |
| | (always) | | !style="width:100px" | Label on Settings page |
| | [Alarms]
| | !style="width:20px" | Default |
| | Legacy Cumulus
| | !style="width:800px" | Description |
| | 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 | | |style="background:lightgray;"|[FTP site] |
| | (always)
| | | |
| | [Alarms] | | | |
| | Legacy Cumulus | | |style="background:lightgray;"|Section name |
| | 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 | | |ExtraLocal0= to ExtraLocal99= |
| | (always) | | |Local File Name |
| | [Alarms] | | |(empty) |
| | Legacy Cumulus
| | |You can enter: |
| | Alarm Settings | | * A relative path name, with respect to the "CumulusMX" root folder |
| | Rainfall rate rises above: | | ** e.g. '''./data/dayfile.txt''' (Note: this is the [[Daily_Summary|daily summary log file]], see link for how it can be used on a web server) |
| | alarm.mp3
| | ** e.g. '''./webMX/betel_monthlyrecord_liteMXT.html''' (Note: this is a third party [[Cumulus_template_file|template file]] - see [https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=7500 Alternative Monthly Extremes using <#webtag>s] |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
| | ** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example |
| |-
| | * A full path name for a file on the computer running MX |
| | HighRainTodayAlarmEmail=0
| | ** e.g. '''/home/pi/documents/myFile''' |
| | (always)
| | ** e.g. '''C:\Users\Public\Documents\working.txt''' |
| | [Alarms]
| | *You can place any of the following special tags into the entry |
| | Release 3.11.0
| | ** These should be typed as shown on their own |
| | Alarm Settings
| | *** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports |
| | Rainfall today more than:
| | *** '''<currentlogfile>''', '''<currentextralogfile>''', and '''<airlinklogfile>''' these respectively represent [[Standard_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files e.g. ExtraLocal3=<currentlogfile> |
| | 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 | | |ExtraRemote0= to ExtraRemote99= |
| | (always) | | |Destination Filename |
| | [Alarms] | | |(empty) |
| | Release 3.9.1
| | |Defines where MX is to upload file to |
| | Alarm Settings
| | * If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root |
| | Rainfall today more than:
| | **I can't tell you what the file path is for your web server, but I can give a couple of examples to steer you |
| | 0 (disabled)
| | *** e.g. httpdocs/dayfile.txt |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
| | *** e.g. public_html/thismonthyear.htm |
| | * If the FTP is not ticked, the file path should be full path for a file on the computer running MX |
| | ** e.g. /var/www/html/weather/images/moon.png could be destinatation for uploading the MX generated moon image to a Linux hosted [[Your_Own_Server|server]] |
| | ** e.g. /var/www/html/weather/webfilesMX/tempdata.json for uploading one of the [[:Category:JSON_Files|files with graph data]] to a Linux hosted [[Your_Own_Server|server]] |
| | *You can place any of the following special tags into the entry |
| | ** These should be typed as shown as part of the destination path, note that they can be used: |
| | *** either to represent the final filename part of the path e.g. ExtraRemote3=/var/www/html/weather/monthly/<currentlogfile> |
| | *** or to modify a filename, so it becomes unique to a particular month e.g. ExtraRemote0=/var/www/html/weather/cumulus_generated/savedFiles/web_tags_real_time_<currentlogfile>.inc |
| | ** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports |
| | ** '''<currentlogfile>''', '''<currentextralogfile>''', and '''<airlinklogfile>''' these respectively represent [[Standard_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files |
| |- | | |- |
| | HighRainTodayAlarmLatchHours=24 | | |ExtraProcess0= to ExtraProcess99= |
| | (always) | | |Process |
| | [Alarms] | | |0 |
| | Release 3.9.1 | | |Simple tick or not |
| | Alarm Settings | | * Tick (value shown as 1 in Cumulus.ini) if the local file is a [[Cumulus_template_file|template file]], see [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|here]] for full explanation of '''Process''' |
| | Rainfall today more than:
| | * Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content |
| | 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 | | |ExtraRealtime0= to ExtraRealtime99= |
| | (always) | | |Realtime |
| | [Alarms]
| | |0 |
| | within 3.2.0 to 3.5.4
| | |Simple tick or not |
| | Alarm Settings
| | *Tick (value shown as 1 in Cumulus.ini) if |
| | Rainfall today more than:
| | *# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there |
| | 0 (disabled)
| | *# Uploads the file to destination specified at interval defined |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
| | * Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]]) |
| |- | | |- |
| | HighRainTodayAlarmSet=0 | | |ExtraFTP0= to ExtraFTP99= |
| | (always)
| | |FTP |
| | [Alarms]
| | |1 |
| | Legacy Cumulus | | |Simple tick or not |
| | Alarm Settings | | *Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]] |
| | Rainfall today more than: | | * Don't tick (value shown as 0 in Cumulus.ini) if the remote file is on the computer running MX and a simple Copy File is required |
| | 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 | | |ExtraUTF0= to ExtraUTF99= |
| | (always) | | |UTF-8 |
| | [Alarms] | | |1 |
| | Legacy Cumulus | | |Please see [[Reports_folder#Encoding|technical guidance on encoding]] |
| | Alarm Settings | | *Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters |
| | Rainfall today more than:
| | *If unticked (0 appears in file), then iso-8859-1 encoding is used |
| | 0 (disabled)
| |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
| |
| |- | | |- |
| | HighRainTodayAlarmSoundFile=alarm.mp3 | | |ExtraBinary0= to ExtraBinary99= |
| | (always) | | |Binary |
| | [Alarms] | | |0 |
| | Legacy Cumulus | | |Simple tick or not |
| | Alarm Settings
| | *Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png) |
| | Rainfall today more than:
| | * Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript |
| | alarm.mp3
| |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
| |
| |- | | |- |
| | HighTempAlarmEmail=0 | | |ExtraEOD0= to ExtraEOD99= |
| | (always) | | |End of Day |
| | [Alarms] | | |0 |
| | Release 3.11.0
| | |Simple tick or not |
| | Alarm Settings | | *Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]] |
| | Temperature rises above:
| | * Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]]) |
| | 0 (disabled)
| | |} |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if alarm is triggered | | |
| | == Location== |
| | |
| | * Introduced for legacy Cumulus |
| | * File Section is [Station] |
| | |
| | {| class="wikitable" border="1" |
| |- | | |- |
| | HighTempAlarmLatch=0
| | !style="width:30px" | Parameter Line Entry |
| | (always) | | !style="width:100px" | MX Section |
| | [Alarms] | | !style="width:60px" | Label on Settings page |
| | Release 3.9.1
| | !style="width:20px" | Default |
| | Alarm Settings | | !style="width:600px" | Description |
| | 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 | | | Altitude=0 |
| | (always) | | | Station Settings → Location |
| | [Alarms]
| | | Altitude |
| | Release 3.9.1 | | | 0 |
| | Alarm Settings | | | The height above mean sea level where the (pressure) sensor is positioned |
| | 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 | | | AltitudeInFeet=1 |
| | (always) | | | Station Settings → Location |
| | [Alarms] | | | Altitude Units |
| | within 3.2.0 to 3.5.4 | | | Default depends on release: |
| | Alarm Settings | | # Legacy until 3.11.4: 1 (labelled as feet) |
| | Temperature rises above:
| | # From 3.12.0: 0 (labelled metres) |
| | 0 (disabled)
| | | Radio Setting |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
| | * feet (value shown as 1 in Cumulus.ini) |
| | * metres (value shown as 0 in Cumulus.ini) |
| |- | | |- |
| | HighTempAlarmSet=0 | | | LocName= |
| | (always) | | | Station Settings → Location |
| | [Alarms]
| | | Name |
| | Legacy Cumulus
| | | (empty) |
| | Alarm Settings
| | | A short name for the location |
| | 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 | | | LocDesc= |
| | (always) | | | Station Settings → Location |
| | [Alarms]
| | | Description |
| | Legacy Cumulus
| | | (empty) |
| | Alarm Settings
| | | A longer description for the location |
| | 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 | | | "Latitude=0" and "LatTxt=" |
| | (always) | | | Station Settings → Location → Latitude |
| | [Alarms] | | | "Degrees", "Minutes", "Seconds", and "Hemisphere → North or South" |
| | Legacy Cumulus | | | (blank) |
| | Alarm Settings | | | The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file |
| | 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 | | | "Longitude=0" and "LongTxt=" |
| | (always) | | | Station Settings → Location → Longitude |
| | [Alarms] | | | "Degrees", "Minutes", "Seconds", and "Hemisphere → East or West" |
| | Release 3.11.0 | | | (blank) |
| | Alarm Settings
| | | The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file |
| | 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 | | |
| | ==Optional Report Settings== |
| | |
| | * File Section is [NOAA] |
| | {| class="wikitable" border="1" |
| |- | | |- |
| | HighWindAlarmLatch=0
| | !style="width:30px" | Parameter Line Entry |
| | (always) | | !style="width:100px" | Introduced |
| | [Alarms] | | !style="width:100px" | MX Section |
| | Release 3.9.1 | | !style="width:60px" | Label on Settings page |
| | Alarm Settings | | !style="width:20px" | Default |
| | Average wind more than:
| | !style="width:300px" | Description |
| | 0 (disabled) | |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | |
| |- | | |- |
| | HighWindAlarmLatchHours=24 | | | AutoCopy=0 |
| | (always)
| | | Release 3.12.0 |
| | [Alarms]
| | | NOAA Reports Settings → FTP Options |
| | Release 3.9.1 | | | Auto Copy NOAA report files |
| | Alarm Settings | | | 0 (disable) |
| | Average wind more than: | | | Simple tick or not |
| | 24 (default set only since release 3.9.6) | | * Tick (value shown as 1 in Cumulus.ini) if your report is to be copied to copy directory during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]] |
| | 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) | | * Don't tick (value shown as 0 in Cumulus.ini) for no copy action |
| |- | | |- |
| | HighWindAlarmNotify=0 | | | AutoFTP=0 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → FTP Options |
| | within 3.2.0 to 3.5.4
| | | Auto transfer NOAA report files |
| | Alarm Settings | | | 0 (disable) |
| | Average wind more than: | | | Simple tick or not |
| | 0 (disabled) | | * Tick (value shown as 1 in Cumulus.ini) to enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed) |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | | * Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process |
| |- | | |- |
| | HighWindAlarmSet=0 | | | AutoSave=1 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings |
| | Legacy Cumulus
| | | Create NOAA files after daily rollover |
| | Alarm Settings | | |0 |
| | Average wind more than: | | | Simple tick or not |
| | 0 (disabled) | | * Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality |
| | If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter | | * Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required |
| |- | | |- |
| | HighWindAlarmSound=0 | | | City= |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → Site Details |
| | Legacy Cumulus
| | | City |
| | Alarm Settings | | | (empty) |
| | Average wind more than: | | | Enter here your hamlet, village, town, or city, name |
| | 0 (disabled) | |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played | |
| |- | | |- |
| | HighWindAlarmSoundFile=alarm.mp3 | | | CoolingThreshold=22 |
| | (always)
| | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → Thresholds |
| | Legacy Cumulus
| | | Cooling threshold |
| | Alarm Settings | | | 65<sup>o</sup> F or 18.3<sup>o</sup>C |
| | Average wind more than: | | | [[Heat/cold_degree_days_and_Chill_hours#Cold_Degree_Days|Cold Degree Days]] are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. An international standard says 22 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables. |
| | alarm.mp3 | |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder | |
| |- | | |- |
| | HttpUploadAlarmEmail=0 | | | CopyDirectory= |
| | (always)
| | | Release 3.12.0 |
| | [Alarms]
| | | NOAA Reports Settings → Report Options |
| | Release 3.11.2 | | | Copy Directory |
| | Alarm Settings | | | (empty) |
| | HTTP upload errors | | | The folder on the web server you host to which reports are to be copied |
| | 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 | | | FTPDirectory= |
| | (always) | | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → FTP Options |
| | Release 3.11.2 | | | destination folder |
| | Alarm Settings
| | | Depends on release: |
| | HTTP upload errors
| | * (3.1.0 to 3.11.4) blank |
| | 0 (disabled)
| | * (3.12.0 onwards) to match change in default web site script specification of '''Reports''' folder |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
| | | Specify the destination folder for file transfer to, on your FTP server |
| | *Leave at default (for your release) and MX will work with the default web pages script supplied (at same release) |
| | * Specify a folder relative to FTP root, and MX will upload reports to that folder instead (you are then responsible for writing any script on your web site to find each report and do any processing). |
| |- | | |- |
| | HttpUploadAlarmLatchHours=24 | | | HeatingThreshold=15.5 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → Thresholds |
| | Release 3.11.2
| | | Heating threshold |
| | Alarm Settings | | | 65<sup>o</sup> F or 18.3<sup>o</sup>C |
| | HTTP upload errors | | |[[Heat/cold_degree_days_and_Chill_hours#Heat_Degree_Days| Heating Degree Days]] are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. An international standard says 15.5 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables. |
| | 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 | | | MaxTempComp1=22 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → Thresholds |
| | Release 3.11.2
| | | Max temp comparison 1 |
| | Alarm Settings | | | (empty) |
| | HTTP upload errors | | | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit |
| | 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 | | | MaxTempComp2=0 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → Thresholds |
| | Release 3.11.2
| | | Max temp comparison 2 |
| | Alarm Settings | | | (empty) |
| | HTTP upload errors | | | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit |
| | 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 | | | MinTempComp1=15.5 |
| | (always)
| | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → Thresholds |
| | Release 3.11.2
| | | Min temp comparison 1 |
| | Alarm Settings | | | (empty) |
| | HTTP upload errors | | | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit |
| | 0 (disabled) | |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played | |
| |- | | |- |
| | HttpUploadAlarmSoundFile=alarm.mp3 | | | MinTempComp2=0 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → Thresholds |
| | Release 3.11.2 | | | Min temp comparison 2 |
| | Alarm Settings | | | (empty) |
| | HTTP upload errors | | | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit |
| | alarm.mp3
| |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
| |
| |- | | |- |
| | HttpUploadAlarmTriggerCount=1 | | | MonthFileFormat='NOAAMO'MMyy'.txt' |
| | (always)
| | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → Output Files |
| | Release 3.11.2
| | | Monthly filename format |
| | Alarm Settings | | | 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''') |
| | HTTP upload errors | | | Here you specify the filename template for MX to use when reading, or writing, monthly reports |
| | 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 | | There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid. |
| |- | | |- |
| | Logging=0 | | | Name=Personal Weather Station |
| | ^ | | | First with Cumulus 2 |
| | [SMTP]
| | | NOAA Reports Settings → Site Details |
| | Release 3.11.2
| | | Site Name |
| | Depends on release: | | | (empty) |
| # (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
| | | What you would like to see in report title for your station name |
| # (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 | | | NOAAUseUTF8=1 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → Report Options |
| | Release 3.11.0 | | | Use UTF-8 encoding |
| | Alarm Settings | | | 1 (UTF-8) |
| | Pressure falls below: | | | Please see [[Reports_folder#Encoding]] |
| | 0 (disabled)
| | * Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the <sup>o</sup> degree symbol |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
| | * If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the <sup>o</sup> degree symbol is coded differently |
| |- | | |- |
| | LowPressAlarmLatch=0 | | | RainComp1=0.5 |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → Thresholds |
| | Release 3.11.2
| | | Rain comparison 1 |
| | Alarm Settings | | | (empty) |
| | Pressure falls below: | | | The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold |
| | 0 (disabled) | |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | |
| |- | | |- |
| | LowPressAlarmLatchHours=24 | | | RainComp2= |
| | (always) | | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → Thresholds |
| | Release 3.9.1
| | | Rain comparison 2 |
| | Alarm Settings
| | | (empty) |
| | Pressure falls below: | | | The report will count the number of days when the daily rainfall exceeds this threshold. |
| | 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 | | | RainComp3= |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → Thresholds |
| | within 3.2.0 to 3.5.4
| | | Rain comparison 3 |
| | Alarm Settings | | | (empty) |
| | Pressure falls below: | | | The report will count the number of days when the daily rainfall exceeds this threshold. |
| | 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 | | | State= |
| | (always) | | | First with Cumulus 2 |
| | [Alarms]
| | | NOAA Reports Settings → Site Details |
| | Legacy Cumulus
| | | State |
| | Alarm Settings | | | (empty) |
| | Pressure falls below: | | | Enter here your local authority area or region (state in USA) |
| | 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 | | | UseDotDecimal=0 |
| | (always) | | | Release 3.9.5 - b3100 |
| | [Alarms]
| | | NOAA Reports Settings → Report Options |
| | Legacy Cumulus
| | | Use a 'dot' decimal point |
| | Alarm Settings | | | 0 (disable) |
| | Pressure falls below: | | | Formatting real numbers for when NOAA report parsed by a script |
| | 0 (disabled) | | |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma |
| | * Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale |
| |- | | |- |
| | LowPressAlarmSoundFile=alarm.mp3 | | | UseMinMaxAvg=0 |
| | (always) | | | Release 3.12.0 |
| | [Alarms] | | | NOAA Reports Settings → Report Options |
| | Legacy Cumulus | | | Use WHO average or Integrated average |
| | Alarm Settings | | | 0 (integrated average) |
| | Pressure falls below:
| | | Simple tick or not |
| | alarm.mp3
| | * Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2 |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
| | * Don't tick (value shown as 0 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use integrated calculation: Sum of all temperature measurements divided by count of measurements |
| |- | | |- |
| | LowTempAlarmEmail=0 | | | YearFileFormat='NOAAYR'yyyy'.txt’ |
| | (always) | | | First with Cumulus 2 |
| | [Alarms] | | | NOAA Reports Settings → Output Files |
| | Release 3.11.0 | | | Yearly filename format |
| | Alarm Settings | | | 'NOAAYR'yyyy'.txt' |
| | Temperature falls below:
| | | Here you specify the filename template for MX to use when reading, or writing, yearly reports |
| | 0 (disabled)
| | |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
| | There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. |
| |- | | |- |
| | LowTempAlarmLatch=0 | | |12hourformat=0 |
| | (always) | | | ??? |
| | [Alarms]
| | | NOAA Reports Settings → Output Files |
| | Release 3.11.2
| | |Time format |
| | Alarm Settings | | |0 (24 hour) |
| | Temperature falls below: | | | How times are output on reports |
| | 0 (disabled) | | * 24 Hour (value shown as 0 in Cumulus.ini) |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
| | * 12 Hour (value shown as 1 in Cumulus.ini) |
| |-
| | |} |
| | LowTempAlarmLatchHours=24
| | |
| | (always)
| | |
| | [Alarms] | | ===Normal Mean Temperatures=== |
| | Release 3.9.1
| | |
| | Alarm Settings
| | * File Section is [NOAA] |
| | Temperature falls below:
| | * The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’ |
| | 24 (default set only since release 3.9.6)
| | * There is one box labelled for each month on the settings screens |
| | 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)
| | * All the defaults are (blank) |
| |- | | * What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements |
| | LowTempAlarmNotify=0
| | |
| | (always)
| | ===Normal Precipitation=== |
| | [Alarms]
| | |
| | within 3.2.0 to 3.5.4
| | * File Section is [NOAA] |
| | Alarm Settings
| | Rainfall equivalents of mean temperature described above |
| | 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]]
| | ==Optional Structured Query Language Settings== |
| |-
| | |
| | LowTempAlarmSet=1
| | MX uses a software package called "MySqlConnect" to run SQL queries. |
| | (always)
| | |
| | [Alarms]
| | 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. |
| | Legacy Cumulus
| | |
| | Alarm Settings
| | |
| | Temperature falls below:
| | ==Optional Third-party Upload Settings== |
| | 0 (disabled)
| | |
| | If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
| | |
| |-
| | {| class="wikitable" border="1" |
| | 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
| | !style="width:30px" | Parameter Line Entry |
| | (always) | | !style="width:30px" | File Section |
| | [Alarms] | | !style="width:60px" | MX Section |
| | Release 3.11.2 | | !style="width:80px" | Action on Settings page |
| | Alarm Settings | | !style="width:20px" | Default |
| | 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 | | | <pre>ID= |
| | (always)
| | pass=-1 |
| | [Alarms] | | server=cwop.aprs.net |
| | Release 3.11.2 | | port=14580 |
| | Alarm Settings | | Enabled=0 |
| | MySQL upload errors
| | Interval=9 |
| | 0 (disabled) | | SendSR=0 |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
| | APRSHumidityCutoff=0</pre> |
| | | [APRS] |
| | | APRS/CWOP |
| | | Tick "Enabled" to see list of parameters so you can edit them |
| | | Defaults are as shown in list of parameters |
| |- | | |- |
| | MySqlUploadAlarmLatchHours=24 | | | <pre>User= |
| | (always)
| | Password= |
| | [Alarms]
| | Language=en |
| | Release 3.11.2
| | Enabled=0 |
| | Alarm Settings
| | Interval=900 |
| | MySQL upload errors | | SendUV=0 |
| | 24 (default set only since release 3.9.6) | | SendSR=0 |
| | 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) | | SendSoilTemp=0 |
| | SendIndoor=0 |
| | SendSoilMoisture=0 |
| | SendLeafWetness=0 |
| | SendAirQuality=0</pre> |
| | | [Awekas] |
| | | AWEKAS |
| | | Tick "Enabled" to see list of parameters so you can edit them |
| | | Defaults are as shown in list of parameters |
| |- | | |- |
| | MySqlUploadAlarmNotify=0 | | | <pre>Enabled=0 |
| | (always)
| | CatchUp=1 |
| | [Alarms]
| | APIkey= |
| | Release 3.11.2
| | StationId= |
| | Alarm Settings
| | Interval=15</pre> |
| | MySQL upload errors: | | | [OpenWeatherMap] |
| | 0 (disabled) | | | OpenWeatherMap |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | | | Tick "Enabled" to see list of parameters so you can edit them |
| | | Defaults are as shown in list of parameters |
| |- | | |- |
| | MySqlUploadAlarmSound=0 | | | <pre>ID= |
| | (always)
| | Password= |
| | [Alarms]
| | Enabled=0 |
| | Release 3.11.2
| | Interval=15 |
| | Alarm Settings
| | SendUV=0 |
| | MySQL upload errors:
| | SendSR=0 |
| | 0 (disabled)
| | CatchUp=1</pre> |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
| | | [PWSweather] |
| |-
| | | PWS Weather |
| | MySqlUploadAlarmSoundFile=alarm.mp3
| | | Tick "Enabled" to see list of parameters so you can edit them |
| | (always)
| | | Defaults are as shown in list of parameters |
| | [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= | | | <pre>User= |
| | ^
| | Password= |
| | [SMTP] | | Enabled=0 |
| | Release 3.11.0 | | Interval=60 |
| | Internet Settings → Email Server Settings | | OauthToken=unknown |
| | Password
| | OauthTokenSecret=unknown |
| | (blank) | | TwitterSendLocation=1</pre> |
| | Text box where you enter password needed to authenticate with your SMTP email server
| | | [Twitter] |
| | | Twitter |
| | | Please note that twitter is deprecated, no new settings possible, existing settings can be used by people who migrated from Cumulus 1 with working tokens |
| | | Defaults are as shown in list of parameters |
| |- | | |- |
| | Port=587 | | | <pre>Wid= |
| | ^
| | Key= |
| | [SMTP]
| | Enabled=0 |
| | Release 3.11.0
| | Interval=10 |
| | Internet Settings → Email Server Settings | | SendUV=0 |
| | Network Port | | SendSR=0 |
| | 587 | | SendAQI=0 |
| | Text box where you enter the port used to connect to your SMTP email server | | SendSoilMoisture=0 |
| | SoilMoistureSensor=0 |
| | SendLeafWetness=0 |
| | LeafWetnessSensor=0</pre> |
| | | [WeatherCloud] |
| | | WeatherCloud |
| | | Tick "Enabled" to see list of parameters so you can edit them |
| | | Defaults are as shown in list of parameters |
| |- | | |- |
| | PressChangeAlarmEmail=0 | | | <pre>Enabled=0 |
| | (always)
| | StationUID= |
| | [Alarms]
| | Password= |
| | Release 3.11.0
| | Interval=1 |
| | Alarm Settings | | SendRain=0</pre> |
| | Pressure changes by: | | | [WindGuru] |
| | 0 (disabled) | | | Windguru |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails | | | Tick "Enabled" to see list of parameters so you can edit them |
| | | Defaults are as shown in list of parameters |
| |- | | |- |
| | PressChangeAlarmLatch=0 | | | <pre>APIkey= |
| | (always)
| | StationIdx=0 |
| | [Alarms] | | Enabled=0 |
| | Release 3.11.2 | | Interval=15 |
| | Alarm Settings | | SendUV=0 |
| | Pressure changes by:
| | CatchUp=1</pre> |
| | 0 (disabled) | | | [Windy] |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter)
| | | Windy.com |
| | | Tick "Enabled" to see list of parameters so you can edit them |
| | | Defaults are as shown in list of parameters |
| |- | | |- |
| | PressChangeAlarmLatchHours=24 | | | <pre>ID= |
| | (always)
| | Password= |
| | [Alarms]
| | Enabled=0 |
| | Release 3.11.2
| | Interval=15 |
| | Alarm Settings
| | SendUV=0 |
| | Pressure changes by: | | SendSR=0 |
| | 24 (default set only since release 3.9.6) | | CatchUp=1</pre> |
| | 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) | | | [WOW] |
| |- | | | Met Office WOW |
| | PressChangeAlarmNotify=0 | | | Tick "Enabled" to see list of parameters so you can edit them |
| | (always)
| | | Defaults are as shown in list of parameters |
| | [Alarms]
| | |} |
| | within 3.2.0 to 3.5.4
| | |
| | Alarm Settings
| | ==Optional Web Server== |
| | Pressure changes by:
| | |
| | 0 (disabled)
| | There are two sub-sections below, because the settings for the optional web functionality are split between '''Station Settings''' and '''Internet Settings'''. |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]]
| | |
| |-
| | |
| | PressChangeAlarmSet=0
| | === Display Options controlling what appears on default web pages === |
| | (always)
| | |
| | [Alarms]
| | * File Section is '''[Display]''' |
| | Legacy Cumulus
| | * MX Section is '''Station Settings → Display Options''' |
| | Alarm Settings
| | {| class="wikitable" border="1" |
| | 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
| | !style="width:30px" | Parameter Line Entry |
| | (always) | | !style="width:100px" | Introduced |
| | [Alarms] | | !style="width:60px" | Label on Settings page |
| | within 3.2.0 to 3.5.4
| | !style="width:20px" | Default |
| | Alarm Settings | | !style="width:600px" | Description |
| | 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 | | | DisplaySolarData=0 |
| | ^ | | | ??? 3.10.0 ??? |
| | [SMTP]
| | | Display Solar data |
| | Release 3.11.0
| | | Unticked (shown as 0 in Cumulus.ini) |
| | Internet Settings → Email Server Settings | |
| | Use authentication
| |
| | 0 (disabled) | |
| | Simple tick or not | | | 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 | | * 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 your SMTP email server is not protected by a user name or password | | * Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data |
| |- | | |- |
| | SensorAlarmEmail=0 | | | DisplayUvData=0 |
| | (always) | | | ??? 3.10.0 ??? |
| | [Alarms] | | | Display UV-I data |
| | Release 3.11.0 | | | Unticked (shown as 0 in Cumulus.ini) |
| | Alarm Settings
| | | Simple tick or not |
| | Sensor contact lost
| | * 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) |
| | 0 (disabled)
| | * 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 |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails
| |
| |- | | |- |
| | SensorAlarmLatch=0 | | | NumWindRosePoints=16 |
| | (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 | | | Legacy Cumulus |
| | Alarm Settings | | | Number of wind rose points |
| | Sensor contact lost | | | 16 |
| | 0 (disabled) | | | 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 |
| | If tick '''Enable''', the alarm will be triggered if calculated (10 minute) wind gust exceeds the selected '''Value''' in earlier parameter
| | * 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. |
| |- | | |- |
| | SensorAlarmSound=0 | | | UseApparent=1 |
| | (always) | | | ??? MX 3.6.0 or 3.10.0 ??? |
| | [Alarms] | | | Use Apparent Temperature |
| | Legacy Cumulus | | | Ticked (shown as 1 in Cumulus.ini) |
| | Alarm Settings | | | Simple tick or not |
| | Sensor contact lost | | * 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 |
| | 0 (disabled) | | * 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 |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played
| | |} |
| |- | | |
| | SensorAlarmSoundFile==alarm.mp3
| | |
| | (always)
| | === File transfer and Copy Options controlling transfer of data to default web pages === |
| | [Alarms] | | |
| | Legacy Cumulus
| | 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. |
| | Alarm Settings
| | |
| | Sensor contact lost
| | From 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]]. |
| | alarm.mp3
| | |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
| | 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'''. |
| | ServerName= | | ** For these settings, the "Generate" option is enabled in nearly all (see any qualifier) settings |
| | ^ | | ** If you select "Enable file copy of standard files" (default is disabled) then those settings have their "Copy" option enabled in nearly all (see any qualifier) cases, and their "FTP Transfer" option deselected (instead of defaults shown in table) |
| | [SMTP]
| | ** If you deselect "Enable file transfer of standard files" (default is enabled) then those settings have their "Copy" option disabled, and their "FTP Transfer" option enabled in nearly all (see any qualifier) cases (as per defaults shown in table) |
| | Release 3.11.0
| | * '''The default selections assume you have air quality, and solar, sensors; so you may need to disable some of the defaults the above selections have made''' |
| | Internet Settings → Email Server Settings
| | * If you don't select '''I want to use the supplied default web site''', then all the settings marked ^ are disabled |
| | Server Name
| | ** This is what you want if you do not use the MX optional web server functionality |
| | (blank)
| | ** If you have a customised web site, you may want to select '''I want to use the supplied default web site''' to see the settings that would otherwise all be disabled, and then pick any options that would be useful to you. |
| | Text box where you enter name, or IP address of your SMTP email server
| | {| class="wikitable" border="1" |
| |- | | |- |
| | SSLOption=1
| | !style="width:30px" | Parameter Line Entry |
| | ^ | | !style="width:100px" | File Section |
| | [SMTP] | | !style="width:100px" | Introduced |
| | Release 3.11.0 | | !style="width:100px" | Shown on Settings page? |
| | Internet Settings → Email Server Settings | | !style="width:100px" | MX Section |
| | Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) | | !style="width:60px" | Label on Settings page |
| | 1 (Auto) | | !style="width:20px" | Default |
| | Drop down:
| | !style="width:600px" | Description |
| * 0 = None
| |
| * 1 = Auto
| |
| * 2 = TLS on connect
| |
| * 3 = Start TLS
| |
| * 4 = Start TLS when available
| |
| |- | | |- |
| | SpikeAlarmTriggerCount= | | | ActiveFTP=0 |
| | (always) | | | [FTP site] |
| | [Alarms] | | | Legacy Cumulus |
| | Release 3.11.2 | | | No |
| | Alarm Settings | | | Change directly in file as at release 3.11.x |
| | Data spike is detected | | | (n/a ) |
| | 1 (trigger immediently a failure occurs) | | | (n/a) |
| | Use the spin button to specify how many failures need to occur, within the latch time, before the alarm is triggered
| | | *0 = Disabled (default) |
| | *1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads. |
| |- | | |- |
| | TempChangeAlarmEmail=0 | | | Copy-airquality=0 |
| | (always)
| | | [FTP site] |
| | [Alarms] | | | Release 3.12.0 |
| | Release 3.11.0 | | | ^ |
| | Alarm Settings | | | Internet Settings → Graph File Settings |
| | Temperature changes by: | | | airquality.json → Copy |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails | | | Simple tick or not |
| |- | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too) |
| | TempChangeAlarmLatch=0 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor) |
| | (always)
| | |- |
| | [Alarms] | | | Copy-alldailydegdaydata=0 |
| | Release 3.11.2 | | | [FTP site] |
| | Alarm Settings | | | Release 3.12.0 |
| | Temperature changes by: | | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alldailydegdaydata.json → Copy |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | | | Simple tick or not |
| |-
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailydegdaydata.json]] file to your local web server (need to select "Generate" too) |
| | TempChangeAlarmLatchHours=24
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (always)
| | |- |
| | [Alarms]
| | | Copy-alldailyhumdata=0 |
| | Release 3.11.2
| | | [FTP site] |
| | Alarm Settings
| | | Release 3.12.0 |
| | Temperature changes by:
| | | ^ |
| | 24 (default set only since release 3.9.6)
| | | Internet Settings → Graph File Settings |
| | 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)
| | | alldailyhumdata.json → Copy |
| |- | |
| | TempChangeAlarmNotify=0 | |
| | (always)
| |
| | [Alarms] | |
| | within 3.2.0 to 3.5.4 | |
| | Alarm Settings | |
| | Temperature changes by: | |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | | | Simple tick or not |
| |- | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too) |
| | TempChangeAlarmSet=0 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (always) | | |- |
| | [Alarms] | | | Copy-alldailypressdata=0 |
| | Legacy Cumulus | | | [FTP site] |
| | Alarm Settings | | | Release 3.12.0 |
| | Temperature changes by: | | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alldailypressdata.json → Copy |
| | 0 (disabled) | | | 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 | | | Simple tick or not |
| |- | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too) |
| | TempChangeAlarmSound=0 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (always) | | |- |
| | [Alarms] | | | Copy-alldailyraindata=0 |
| | Legacy Cumulus | | | [FTP site] |
| | Alarm Settings | | | Release 3.12.0 |
| | Temperature changes by: | | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alldailyraindata.json → Copy |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Play sound''', if the alarm is triggered, then the file specified in next parameter will be played | | | Simple tick or not |
| |-
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too) |
| | TempChangeAlarmSoundFile=alarm.mp3
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (always)
| | |- |
| | [Alarms]
| | | Copy-alldailysolardata=0 |
| | within 3.2.0 to 3.5.4
| | | [FTP site] |
| | Alarm Settings | | | Release 3.12.0 |
| | Temperature changes by:
| | | ^ |
| | alarm.mp3
| | | Internet Settings → Graph File Settings |
| | Specify a file name for a music file stored in the CumulusMX\interface\sounds or CumulusMX/interface/sounds folder
| | | alldailysolardata.json → Copy |
| |- | |
| | UpgradeAlarmEmail=0
| |
| | (always)
| |
| | [Alarms] | |
| | Release 3.11.0 | |
| | Alarm Settings | |
| | Cumulus upgrade available | |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Email''', and all the email settings marked ^ have been completed, an alarm will be sent if an HTTP upload fails | | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| |- | | |- |
| | UpgradeAlarmLatch=0 | | | Copy-alldailytempdata=0 |
| | (always)
| | | [FTP site] |
| | [Alarms] | | | Release 3.12.0 |
| | Release 3.11.2 | | | ^ |
| | Alarm Settings | | | Internet Settings → Graph File Settings |
| | Cumulus upgrade available | | | alldailytempdata.json → Copy |
| | 0 (disabled) | | | 0 (disabled) |
| | If tick '''Latches''', an alarm will be maintained (latched) for a user configurable number of hours (see next parameter) | | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | UpgradeAlarmLatchHours=24 | | | Copy-alldailywinddata=0 |
| | (always)
| | | [FTP site] |
| | [Alarms] | | | Release 3.12.0 |
| | Release 3.11.2 | | | ^ |
| | Alarm Settings
| | | Internet Settings → Graph File Settings |
| | Cumulus upgrade available
| | | alldailywinddata.json → Copy |
| | 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) | | | 0 (disabled) |
| | If tick '''Notify'', MX will show the status of this alarm on the [[MX_Administrative_Interface#Dashboard|'''Dashboard''' page of the interface]] | | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | UpgradeAlarmSet=0 | | | Copy-alltempsumdata=0 |
| | (always)
| | | [FTP site] |
| | [Alarms] | | | Release 3.12.0 |
| | Release 3.9.3 | | | ^ |
| | Alarm Settings | | | Internet Settings → Graph File Settings |
| | Cumulus upgrade available | | | alldailytempsumdata.json → Copy |
| | 0 (disabled) | | | 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 | | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempsumdata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | UpgradeAlarmSound=0 | | | Copy-availabledata=0 |
| | (always)
| | | [FTP site] |
| | [Alarms] | | | Release 3.12.0 |
| | Release ??? | | | ^ (once only) |
| | Alarm Settings | | | Internet Settings → Graph File Settings |
| | Cumulus upgrade available | | | availabledata.json → Copy |
| | 0 (disabled) | | | 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 | | | Simple tick or not |
| * Tick (value shown as 1 in Cumulus.ini) if you wish to use HTML encoding format for your customised emails | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[availabledata.json]] file to your local web server (need to select "Generate" too) |
| * 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 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | User= | | | Copy-dailyrain=0 |
| | | [FTP site] |
| | | Release 3.12.0 |
| | ^ | | | ^ |
| | [SMTP] | | | Internet Settings → Graph File Settings |
| | Release 3.11.0 | | | dailyrain.json → Copy |
| | Internet Settings → Email Server Settings | | | 0 (disabled) |
| | Username | | | Simple tick or not |
| | (blank) | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailyrain.json]] file to your local web server (need to select "Generate" too) |
| | Text box where you enter user name needed to authenticate with your SMTP email server | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |} | | |- |
| | | | Copy-dailytemp=0 |
| ==Charts==
| | | [FTP site] |
| {{Template:WorkInProgressBanner}} Charts have evolved rapidly in MX development, this table needs verification by somebody who uses the functionality documented here. Can you be the contributor to bring it up to date?
| | | Release 3.12.0 |
| | | | ^ |
| {| class="wikitable" border="1"
| | | Internet Settings → Graph File Settings |
| | | dailytemp.json → Copy |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailytemp.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Copy-graphconfig=0 |
| | | [FTP site] |
| | | Release 3.12.0 |
| | | ^ (once only) |
| | | Internet Settings → Graph File Settings |
| | | graphconfig.json → Copy |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[graphconfig.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| !style="width:30px" | Parameter Line Entry
| | | Copy-humdata=0 |
| !style="width:100px" | File Section
| | | [FTP site] |
| !style="width:100px" | Introduced
| | | Release 3.12.0 |
| !style="width:100px" | MX Section
| | | ^ |
| !style="width:60px" | Label on Settings page
| | | Internet Settings → Graph File Settings |
| !style="width:20px" | Default
| | | humdata.json → Copy |
| !style="width:600px" | Description
| | | 0 (disabled) |
| |- | | | Simple tick or not |
| | GraphHours=24
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[humdata.json]] file to your local web server (need to select "Generate" too) |
| | [Graphs] | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Legacy Cumulus | | |- |
| | Station Settings → Graphs | | | Copy-pressdata=0 |
| | Graph hours | | | [FTP site] |
| | 24 (2 rolling days worth of values) | | | Release 3.12.0 |
| | For those plots that show values (if available) minute by minute, how many days back to go. Some people prefer to set this to 48 or 96, that means uploading a lot more data in the [[:Category:JSON_Files|.json files]], but it shows more on charts | | | ^ |
| |- | | | Internet Settings → Graph File Settings |
| | AppTempVisible=1 | | | pressdata.json → Copy |
| | [Graphs] | | | 0 (disabled) |
| | MX release 3.7.0 - b3089 | | | Simple tick or not |
| | Station Settings → Graphs → Visibility → Temperature Data | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[pressdata.json]] file to your local web server (need to select "Generate" too) |
| | Apparent temperature | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Ticked (shown in Cumulus.ini as 1) | | |- |
| | Simple tick or not indicating whether you want to see Australian Apparent Temperature plotted on Charts
| | | Copy-raindata=0 |
| |- | | | [FTP site] |
| | BaseTemperature1= | | | Release 3.12.0 |
| | [GrowingDD] and [TempSum] | | | ^ |
| | Release 3.11.0 - b3129 | | | Internet Settings → Graph File Settings |
| | Station Settings → Growing Degree Days | | | raindata.json → Copy |
| | Base temperature #1 | | | 0 (disabled) |
| | Depends on selected temperature units (not quite same) | | | Simple tick or not |
| * (Celsius) 5 (equivalent to 41 <sup>o</sup>Fahrenheit) | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[raindata.json]] file to your local web server (need to select "Generate" too) |
| * (Fahrenheit) 40 (equivalent to 4.44 <sup>o</sup>Celsius) | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Base temperature for series 1 | | |- |
| |- | | | Copy-solardata=0 |
| | BaseTemperature2=
| | | [FTP site] |
| | [GrowingDD] and [TempSum] | | | Release 3.12.0 |
| | Release 3.11.0 - b3129 | | | ^ |
| | Station Settings → Growing Degree Days | | | Internet Settings → Graph File Settings |
| | Base temperature #1 | | | solardata.json → Copy |
| | Depends on selected temperature units (equivalent) | | | 0 (disabled) |
| * (Celsius) 10 | | | Simple tick or not |
| * (Fahrenheit) 50 | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[solardata.json]] file to your local web server (need to select "Generate" too) |
| | Base temperature for series 2 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| |- | | |- |
| | Cap30C=1
| | | Copy-sunhours=0 |
| | [GrowingDD] | | | [FTP site] |
| | Release3.11.0 - b3129 | | | Release 3.12.0 |
| | Station Settings → Growing Degree Days | | | ^ |
| | Cap GDD at 30°C / 86°F | | | Internet Settings → Graph File Settings |
| | Ticked (shown in Cumulus.ini as 1) | | | sunhours.json → Copy |
| | Simple tick or not indicating whether you want growing degree days capped and not incremented at high temperatures (threshold shown in setting name)
| | | 0 (disabled) |
| |- | | | Simple tick or not |
| | ChartMaxDays=31 | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[sunhours.json]] file to your local web server (need to select "Generate" too) |
| | [Graphs] | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| | Legacy Cumulus | | |- |
| | Station Settings → Graphs | | | Copy-tempdata=0 |
| | Graph Days | | | [FTP site] |
| | 31 (daily values) | | | Release 3.12.0 |
| | For those plots that show recent daily values, this states how many of them to plot | | | ^ |
| |- | | | Internet Settings → Graph File Settings |
| | Colour0=#058DC7, Colour1=#50B432, Colour2=#ED561B, Colour3=#DDDF00, Colour4=#24CBE5, and Colour5=#64E572 | | | tempdata.json → Copy |
| | [Select-a-Chart] | | | 0 (disabled) |
| | Release 3.9.7 - b3107 | | | Simple tick or not |
| | ??? | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[tempdata.json]] file to your local web server (need to select "Generate" too) |
| | ??? | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Hex colours as shown in parameter list | | |- |
| | Colour of line used for plotting the respective series
| | | Copy-wdirdata=0 |
| |- | | | [FTP site] |
| | DailyAvgTempVisible=1 | | | Release 3.12.0 |
| | [Graphs] | | | ^ |
| | Release 3.11.0 - b3129 | | | Internet Settings → Graph File Settings |
| | Station Settings → Graphs → Visibility → Temperature Data | | | wdirdata.json → Copy |
| | Daily Average Temperature | | | 0 (disabled) |
| | Ticked (shown in Cumulus.ini as 1) | | | Simple tick or not |
| | Simple tick or not indicating whether you want to see Daily (integrated) Average temperature plotted on Charts
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[wdirdata.json]] file to your local web server (need to select "Generate" too) |
| |- | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | DailyMaxTempVisible=1 | | |- |
| | [Graphs] | | | Copy-websitedata=0 |
| | Release 3.11.0 - b3129 | | | [FTP site] |
| | Station Settings → Graphs → Visibility → Temperature Data | | | Release 3.12.0 |
| | Daily Maximum Temperature | | | ^ |
| | Ticked (shown in Cumulus.ini as 1) | | | Internet Settings → Standard File Settings |
| | Simple tick or not indicating whether you want to see Daily Maximum temperature plotted on Charts
| | | websitedata.json → Copy |
| |- | | | 0 (disabled) |
| | DailyMinTempVisible=1 | | | Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]] |
| | [Graphs] | | |
| | Release 3.11.0 - b3129 | | Simple tick or not |
| | Station Settings → Graphs → Visibility → Temperature Data | | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the resulting websitedata.json to your local web server |
| | Daily Minimum Temperature | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Ticked (shown in Cumulus.ini as 1) | | |- |
| | Simple tick or not indicating whether you want to see Daily Minimum temperature plotted on Charts
| | | Copy-winddata=0 |
| |- | | | [FTP site] |
| | DPVisible=1 | | | Release 3.12.0 |
| | [Graphs] | | | ^ |
| | MX release 3.7.0 - b3089 | | | Internet Settings → Graph File Settings |
| | Station Settings → Graphs → Visibility → Temperature Data | | | winddata.json → Copy |
| | Dew point | | | 0 (disabled) |
| | Ticked (shown in Cumulus.ini as 1) | | | Simple tick or not |
| | Simple tick or not indicating whether you want to see Dew Point plotted on Charts
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[winddata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Copy-wxnow=0 |
| | | [FTP site] |
| | | Release 3.12.0 |
| | | ^ (disabled) |
| | | Internet Settings → Standard File Settings |
| | | wxnow.txt → Copy |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy that file to your local web server |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | CopyMoonImage=0 |
| | | [FTP site] |
| | | Release 3.12.0 |
| | | ^ |
| | | Internet Settings → Moon Image |
| | | Copy Moon image file |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy moon image file to your local web server (need to select "Generate Moon Image" see '''MoonImageEnabled=''' too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | FeelsLikeVisible=1 | | | Create-airquality=0 |
| | [Graphs] | | | [FTP site] |
| | MX release 3.7.0 - b3089 | | | Release 3.10.0 |
| | Station Settings → Graphs → Visibility → Temperature Data | | | ^ |
| | Dew point | | | Internet Settings → Graph File Settings |
| | Ticked (shown in Cumulus.ini as 1) | | | airquality.json → Generate |
| | Simple tick or not indicating whether you want to see Feels Like Temperature plotted on Charts
| | | 1 (enabled) |
| |- | | | Simple tick or not |
| | GrowingDegreeDaysVisible1=1 | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the airquality.json file |
| | [Graphs] | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Release3.11.0 - b3129 | | |- |
| | Station Settings → Graphs → Visibility → Degree Days | | | Create-alldailydegdaydata=0 |
| | Growing Degree Days series #1 | | | [FTP site] |
| | Ticked (shown in Cumulus.ini as 1) | | | Release 3.10.0 |
| | Simple tick or not indicating whether you want to see series 1 plotted on Charts
| | | ^ |
| |-
| | | Internet Settings → Graph File Settings |
| | GrowingDegreeDaysVisible2=1
| | | alldailydegdaydata.json → Generate |
| | [Graphs]
| | | 1 (enabled) |
| | Release3.11.0 - b3129
| | | Simple tick or not |
| | Station Settings → Graphs → Visibility → Degree Days
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailydegdaydata.json]] file |
| | Growing Degree Days series #2
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Ticked (shown in Cumulus.ini as 1)
| | |- |
| | Simple tick or not indicating whether you want to see series 2 plotted on Charts
| | | Create-alldailyhumdata=0 |
| |- | | |
| | HIVisible=1 | | | [FTP site] |
| | [Graphs] | | | Release 3.10.0 |
| | MX release 3.7.0 - b3089 | | | ^ |
| | Station Settings → Graphs → Visibility → Temperature Data | | | Internet Settings → Graph File Settings |
| | Dew point | | | alldailyhumdata.json → Generate |
| | Ticked (shown in Cumulus.ini as 1) | | | 1 (enabled) |
| | Simple tick or not indicating whether you want to see USA Heat Index plotted on Charts
| | | Simple tick or not |
| |-
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyhumdata.json]] file |
| | HumidexVisible=1
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | [Graphs]
| | |- |
| | MX release 3.7.0 - b3089
| | | Create-alldailypressdata=0 |
| | Station Settings → Graphs → Visibility → Temperature Data
| | | [FTP site] |
| | Dew point
| | | Release 3.10.0 |
| | Ticked (shown in Cumulus.ini as 1)
| | | ^ |
| | Simple tick or not indicating whether you want to see Canadian Humidity Index plotted on Charts
| | | Internet Settings → Graph File Settings |
| |- | | | alldailypressdata.json → Generate |
| | InHumVisible=1 | | | 1 (enabled) |
| | [Graphs] | | | Simple tick or not |
| | MX release 3.7.0 - b3089 | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailypressdata.json]] file |
| | Station Settings → Graphs → Visibility → Humidity Data | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Dew point | | |- |
| | Ticked (shown in Cumulus.ini as 1) | | | Create-alldailyraindata=0 |
| | Simple tick or not indicating whether you want to see Indoor Relative Humidity plotted on Charts
| | | [FTP site] |
| |-
| | | Release 3.10.0 |
| | InTempVisible=1
| | | ^ |
| | [Graphs]
| | | Internet Settings → Graph File Settings |
| | MX release 3.7.0 - b3089
| | | alldailyraindata.json → Generate |
| | Station Settings → Graphs → Visibility → Temperature Data
| | | 1 (enabled) |
| | Dew point
| | | Simple tick or not |
| | Ticked (shown in Cumulus.ini as 1)
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyraindata.json]] file |
| | Simple tick or not indicating whether you want to see Indoor Temperature plotted on Charts
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | |
| | OutHumVisible=1 | |
| | [Graphs] | |
| | MX release 3.7.0 - b3089 | |
| | Station Settings → Graphs → Visibility → Humidity Data | |
| | Dew point | |
| | Ticked (shown in Cumulus.ini as 1)
| |
| | Simple tick or not indicating whether you want to see Outdoor Relative Humidity plotted on Charts | |
| |-
| |
| | Series0= to Series5=
| |
| | [Select-a-Chart]
| |
| | Release 3.9.7 - b3107
| |
| | ???
| |
| | ???
| |
| | 0 (disabled)
| |
| | Name of parameter to plot (in series 0 to 5) e.g. "Pressure", "Wind Gust", "Temperature", "Rainfall Rate", "Wind Bearing"
| |
| |-
| |
| | SolarVisible=1
| |
| | [Graphs]
| |
| | MX release 3.10.0
| |
| | Station Settings → Graphs → Visibility → Solar Data
| |
| | UV Index
| |
| | Ticked (shown in Cumulus.ini as 1)
| |
| | Simple tick or not indicating whether you want to see Solar radiation plotted on Charts
| |
| |- | | |- |
| | SunshineVisible=1 | | | Create-alldailysolardata=0 |
| | [Graphs] | | | [FTP site] |
| | MX release 3.10.0 | | | Release 3.10.0 |
| | Station Settings → Graphs → Visibility → Solar Data | | | ^ |
| | UV Index | | | Internet Settings → Graph File Settings |
| | Ticked (shown in Cumulus.ini as 1) | | | alldailysolardata.json → Generate |
| | Simple tick or not indicating whether you want to see Sunshine Hours plotted on Charts | | | 1 (enabled) |
| |- | | | Simple tick or not |
| | TempSumVisible0=1 | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailysolarydata.json]] file |
| | [TempSum] | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| | Release 3.11.0 - b3129 | | |- |
| | Station Settings → Annual Temperature Sum | | | Create-alldailytempdata=0 |
| | Annual Temperature Sum 0 | | | [FTP site] |
| | Ticked (shown in Cumulus.ini as 1) | | | Release 3.10.0 |
| | Simple tick or not indicating whether you want to see Annual Temperature Sum series 0 plotted on Charts | | | ^ |
| |- | | | Internet Settings → Graph File Settings |
| | TempSumVisible1=1 | | | alldailytempdata.json → Generate |
| | [TempSum] | | | 1 (enabled) |
| | Release 3.11.0 - b3129 | | | Simple tick or not |
| | Station Settings → Annual Temperature Sum | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempdata.json]] file |
| | Annual Temperature Sum #1 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Ticked (shown in Cumulus.ini as 1) | | |- |
| | Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 1 plotted on Charts
| | | Create-alldailywinddata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alldailywinddata.json → Generate |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailywinddata.json]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Create-alltempsumdata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alldailytempsumdata.json → Generate |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempsumdata.json]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Create-availabledata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ (once only) |
| | | Internet Settings → Graph File Settings |
| | | availabledata.json → Generate |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[availabledata.json]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | TempSumVisible2=1 | | | Create-dailyrain=0 |
| | [TempSum] | | | [FTP site] |
| | Release 3.11.0 - b3129 | | | Release 3.10.0 |
| | Station Settings → Annual Temperature Sum | | | ^ |
| | Annual Temperature Sum #2 | | | Internet Settings → Graph File Settings |
| | Ticked (shown in Cumulus.ini as 1) | | | dailyrain.json → File Transfer |
| | Simple tick or not indicating whether you want to see Annual Temperature Sum minus baseline 2 plotted on Charts | | | 1 (enabled) |
| |-
| | | Simple tick or not |
| | TempSumYearStart=
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailyrain.json]] file |
| | [TempSum]
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Release 3.11.0 - b3129
| |
| | Station Settings → Annual Temperature Sum
| |
| | Year summation starting month
| |
| | Depends on hemisphere
| |
| * (Northern hemisphere) 1 = January | |
| * (Southern hemisphere) 7 = July
| |
| | Enter as a number the month for which (on first of that month) annual temperature summation is reset to zero
| |
| |-
| |
| | TempVisible=1
| |
| | [Graphs]
| |
| | MX release 3.7.0 - b3089
| |
| | Station Settings → Graphs → Visibility → Temperature Data
| |
| | Dew point
| |
| | Ticked (shown in Cumulus.ini as 1)
| |
| | Simple tick or not indicating whether you want to see Outdoor Temperature plotted on Charts
| |
| |-
| |
| | UVVisible=1
| |
| | [Graphs]
| |
| | MX release 3.10.0
| |
| | Station Settings → Graphs → Visibility → Solar Data
| |
| | UV Index
| |
| | Ticked (shown in Cumulus.ini as 1)
| |
| | Simple tick or not indicating whether you want to see Ultra Violet Index plotted on Charts
| |
| |- | | |- |
| | WCVisible=1 | | | Create-dailytemp=0 |
| | [Graphs] | | | [FTP site] |
| | MX release 3.7.0 - b3089 | | | Release 3.10.0 |
| | Station Settings → Graphs → Visibility → Temperature Data | | | ^ |
| | Dew point | | | Internet Settings → Graph File Settings |
| | Ticked (shown in Cumulus.ini as 1) | | | dailytemp.json → File Transfer |
| | Simple tick or not indicating whether you want to see Wind Chill plotted on charts
| | | 1 (enabled) |
| |- | | | Simple tick or not |
| | YearStarts= | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file |
| | [GrowingDD] | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Release 3.11.0 - b3129 | | |- |
| | Station Settings → Growing Degree Days | | | Create-graphconfig=0 |
| | Growing season starting month | | | [FTP site] |
| | Depends on hemisphere | | | Release 3.10.0 |
| * (Northern hemisphere) 1 = January | | | ^ (once only) |
| * (Southern hemisphere) 7 = July | | | Internet Settings → Graph File Settings |
| | Enter as a number the month for which (on first of that month) Growing degree days is reset to zero | | | graphconfig.json → Generate |
| |} | | | 1 (enabled) |
| | | | Simple tick or not |
| ==Data Logging==
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[graphconfig.json]] file |
| | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| * Available in all Cumulus releases | | |- |
| * File Section is [Station] | | | Create-humdata=0 |
| {| class="wikitable" border="1"
| | | [FTP site] |
| |- | | | Release 3.10.0 |
| !style="width:30px" | Parameter Line Entry
| | | ^ |
| !style="width:100px" | Shown on Settings page?
| | | Internet Settings → Graph File Settings |
| !style="width:100px" | MX Section
| | | humdata.json → Generate |
| !style="width:60px" | Label on Settings page
| | | 1 (enabled) |
| !style="width:20px" | Default
| | | Simple tick or not |
| !style="width:600px" | Description
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[humdata.json]] file |
| |- | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | DataLogInterval=2 | | |- |
| | (Always) | | | Create-pressdata=0 |
| | Station settings → General Settings | | | [FTP site] |
| | Log interval | | | Release 3.10.0 |
| | 2 (10 minutes) | | | ^ |
| | Drop-down: | | | Internet Settings → Graph File Settings |
| * 0 = 1 minute between MX logs into the one to three [[Monthly_log_files]] (i.e. [[Standard log files]], and optionally [[Extra Sensor Files]], [[Air_Link_Log.txt]]) | | | pressdat.json → Generate |
| * 1 = 5 minutes between MX logging lines
| | | 1 (enabled) |
| * 2 = 10 minutes between MX logging lines
| | | Simple tick or not |
| * 3 = 15 minutes between MX logging lines | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[pressdata.json]] file |
| * 4 = 20 minutes between MX logging lines | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| * 5 = 30 minutes between MX logging lines
| | |- |
| | | Create-raindata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | raindata.json → Generate |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[raindata.json]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Create-solardata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | solardata.json → Generate |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[solardata.json]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| |- | | |- |
| | LogExtraSensors=0 | | | Create-tempdata=1 |
| | (Depends on station type) | | | [FTP site] |
| | Station settings → Common Options | | | Release 3.10.0 |
| | Extra sensors | | | ^ |
| | 0 (disabled) | | | Internet Settings → Graph File Settings |
| |Simple tick or not | | | dailytemp.json → Generate |
| * Tick (value shown as 1 in Cumulus.ini) if your weather station can output readings to be logged in [[Extra Sensor Files]] | | | 1 (enabled) |
| * Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files. | | | Simple tick or not |
| |- | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file |
| | NoSensorCheck=0 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (not yet on a settings page) | | |- |
| | (not known) | | | Create-sunhours=0 |
| | (not known) | | | [FTP site] |
| | 0 (normal) | | | Release 3.10.0 |
| | Boolean: | | | ^ |
| * 0 = MX will stop if any of the minimum set of sensors listed below fails | | | Internet Settings → Graph File Settings |
| * 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails | | | dailytemp.json → Generate |
| | | | 1 (enabled) |
| Minimum set of sensors:
| | | Simple tick or not |
| # Current air temperature
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file |
| # Current Relative Humidity
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| # At least one wind speed
| | |- |
| # Current air pressure (absolute or sea-level)
| | | Create-tempdata=0 |
| Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these). | | | [FTP site] |
| |- | | | Release 3.10.0 |
| | RainDayThreshold=-1 | | | ^ |
| | (with warning: "Here be dragons!") | | | Internet Settings → Graph File Settings |
| | legacy cumulus | | | tempdata.json → Generate |
| | Only from Release 3.12.0
| | | 1 (enabled) |
| | Depends on release: | | | Simple tick or not |
| * (3.5.1 to 3.11.4) Manual edit of file | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[tempdata.json]] file |
| * (3.12.0 onwards) Station settings → Common Options → Advanced options | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |-1 (that represents 0.2 mm or 0.01 inches) | | |- |
| | The amount of rainfall that must be collected before MX treats today as a wet day | | | Create-wdirdata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | wdirdata.json → Generate |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[wdirdata.json]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Create-websitedata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | websitedata.json → Generate |
| | | 1 (enabled) |
| | | Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]] |
|
| |
|
| ''The intention is this will represent more than one tip,as the first tip might contain some rain from an earlier day'' | | Simple tick or not |
| |- | | * Tick (value shown as 1 in Cumulus.ini) for MX to process the '''websitedataT.json''' file into websitedata.json |
| | RolloverHour=0 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (Always) | | |- |
| | Station settings → Log Rollover | | | Create-winddata=0 |
| | Time | | | [FTP site] |
| | 0 (midnight) | | | Release 3.10.0 |
| | Radio type selection: | | | ^ |
| * 0 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches midnight | | | Internet Settings → Graph File Settings |
| * 1 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time | | | winddata.json → Generate |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[winddata.json]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | SnowDepthHour=0 | | | Create-wxnow=0 |
| | (with warning: "Here be dragons!") | | | [FTP site] |
| | legacy cumulus | | | Release 3.10.0 |
| | Only from Release 3.12.0
| | | ^ (disabled) |
| | Depends on release: | | | (depends on release) |
| * (3.5.1 to 3.11.4) Manual edit of file | | * (releases 3.10.0 to 3.11.4) Internet Settings → Web/FTP Settings |
| * (3.12.0 onwards) Station settings → Common Options → Advanced options | | * (release 3.12.0 on) Internet Settings → Standard File Settings |
| | Snow depth hour
| | | wxnow.txt → Generate |
| | 0 (midnight) | | | 0 (disabled) |
| | Spin selector of 0 to 23: Defines hour from which entries in [[Weather Diary]] for current calendar day are used. Prior to this hour the weather diary will be searched for Calendar yesterday | | | Simple tick or not |
| |- | | * Tick (value shown as 1 in Cumulus.ini) for MX to generate a [[wsnow.txt]] file |
| | StartDate= | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (with warning: "Here be dragons!") | | |- |
| | Station Settings → Common Options → Advanced Options | | | DeleteBeforeUpload=0 |
| | Records Began date | | | [FTP site] |
| | (Set when you first use Cumulus) | | | legacy Cumulus |
| | Format used is determined by locale used for running MX. If this date is edited, keep to same format. MX generally (see [[Calculate_Missing_Values#CreateMissing.exe]] for exceptions) ignores any data file entries prior to this date. | | | (always) |
| | | (depends on release) |
| | * (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings |
| | * (release 3.12.0 on) Internet Settings → Web Site → General Settings |
| | | Delete before upload |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to delete existing file (with same name) on the web server before it creates the new file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable (this is the option appropriate to most servers) |
| |- | | |- |
| | UseDataLogger=1 | | | Directory= |
| | (probably determined by station type) | | | [FTP site] |
| | (not known)
| | | Legacy Cumulus |
| | (not known)
| | | (always) |
| | 1 (enabled)
| | | Internet Settings → Web/FTP Site |
| |Simple tick or not | | | Remote FTP Directory |
| * Tick (value shown as 1 in Cumulus.ini) if your weather station has its own storage, so MX can do a catch up when it first starts and read any "archive data"
| | | (blank) |
| * Don't tick (value shown as 0 in Cumulus.ini) if your weather station has no storage, and therefore MX cannot capture any readings when it is not running
| | | Directory (including path) on your server to which FTP (if 'Enabled' is enabled) will upload the files. |
| |-
| | *value is left Blank, default, the root position specified by ftp server |
| | Use10amInSummer=1
| | *A path from the starting point as the position specified by ftp server |
| | (Always) | |
| | Station settings → Log Rollover | |
| | Use 10am in Summer | |
| | 1 (normal) | |
| | Tick box: | |
| * 0 = If "Daylight Saving Time" (DST) applies in Summer, MX is to use 9 am local time
| |
| * 1 = Normal behaviour: | |
| ** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
| |
| ** If MX would do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time, then it waits until 10 a.m. local time while DST is in effect | |
| |}
| |
|
| |
|
| ==Database== | | Not used for ExtraRemoteNN parameters |
| | | |- |
| | | | DisableEPSV=0 |
| * Available from beta MX.
| | | [FTP site] |
| * File Section is [MySQL]
| | | Beta Release 3.0.0 build 3045 |
| {| class="wikitable" border="1"
| | | No |
| | | Still Change directly in file as at release 3.11.x |
| | | (n/a ) |
| | | 0 |
| | | *0 = Disabled (default) |
| | *1 = Enabled, to use Extended Passive FTP-mode |
| |- | | |- |
| !style="width:30px" | Parameter Line Entry
| | | DisableFtpsExplicit=0 |
| !style="width:100px" | Shown on Settings page?
| | | [FTP site] |
| !style="width:100px" | MX Section
| | | Release 3.4.0 - Build 3064 |
| !style="width:60px" | Label on Settings page
| | | No |
| !style="width:20px" | Default
| | | Change directly in file as at release 3.11.x |
| !style="width:600px" | Description
| | | (n/a ) |
| |- | | | 0 |
| | CustomMySqlMinutesCommandString= | | | (change value following attribute) |
| | only if "Custom Minutes Enabled" | | *0 = Disabled (default) use FTPS Explicit mode |
| | MySQL Settings → Monthly log file upload | | *1 = Enabled, to use FTPS Implicit mode |
| | SQL command | | |- |
| | (blank) | | | Enabled=1 |
| | SQL to be obeyed at the interval defined in "CustomMySqlMinutesIntervalIndex" | | | [FTP site] |
| | | Release 3.12.0 |
| | | (always) Controls whether ^ settings have "File Transfer" option enabled |
| | | Internet Settings → Interval Configuration |
| | | Enable file transfer of standard files |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to enable file transfer of standard files (see rows marked ^ for further selections) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | CustomMySqlMinutesIntervalIndex=6 | | | EnableLocalCopy=0 |
| | only if "Custom Minutes Enabled" | | | [FTP site] |
| | MySQL Settings → Monthly log file upload | | | Release 3.12.0 |
| | Interval
| | | (always) Controls whether ^ settings have "Copy" option enabled |
| | 6 = 10 minutes | | | Internet Settings → Interval Configuration |
| | Time between custom SQL uploads: | | | 0 (disabled) |
| * 0 = 1 minute | | | Simple tick or not |
| * 1 = 2 minutes
| | * Tick (value shown as 1 in Cumulus.ini) for MX to enable copying of files (see rows marked ^ for further selections) |
| * 2 = 3 minutes
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| * 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) | |
| |- | | |- |
| | CustomMySqlMinutesEnabled=0 | | | EnableRealtime=1 |
| | | [FTP site] |
| | | Legacy Cumulus |
| | (always) | | | (always) |
| | MySQL Settings | | | Internet Settings → Realtime Settings |
| | Custom Minutes Enabled | | | Enable Realtime |
| | Not ticked (shown as 0 in Cumulus.ini) | | | 0 (disabled) |
| | Enable the optional functionality to run SQL at a selected interval in minutes
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate a timer that will permit real time actions |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | CustomMySqlSecondsCommandString= | | | Ftp-airquality=0 |
| | only if "Custom Seconds Enabled" | | | [FTP site] |
| | MySQL Settings → Monthly log file upload | | | Release 3.10.0 |
| | SQL command
| | | ^ |
| | (blank)
| | | Internet Settings → Graph File Settings |
| | SQL to be obeyed at the interval defined in "CustomMySqlSecondsInterval"
| | | airquality.json → File Transfer |
| |-
| | | 1 (enabled) |
| | CustomMySqlSecondsInterval=10
| | | Simple tick or not |
| | only if "Custom Seconds Enabled" | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the airquality.json file to your local web server (need to select "Generate" too) |
| | MySQL Settings → Monthly log file upload | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor) |
| | Interval
| |
| | 10 (seconds)
| |
| | Time between custom SQL uploads
| |
| |-
| |
| | CustomMySqlSecondsEnabled=0
| |
| | (always)
| |
| | MySQL Settings
| |
| | Custom Minutes Enabled | |
| | Not ticked (shown as 0 in Cumulus.ini)
| |
| | Enable the optional functionality to run SQL at a selected interval in seconds
| |
| |-
| |
| | Database=
| |
| | when section opened
| |
| | MySQL Settings → Server Details
| |
| | Database name
| |
| | (blank) | |
| | The name given to the database that includes the table(s) you want to update | |
| |-
| |
| | DayfileMySqlEnabled=0
| |
| | (always)
| |
| | MySQL Settings
| |
| | Dayfile Enabled
| |
| | Not ticked (shown as 0 in Cumulus.ini)
| |
| | Enable the automatic upload to the table named in "DayfileTable" within the database named in "Database"
| |
| |-
| |
| | DayfileTable=Dayfile
| |
| | when "Dayfile Enabled" is ticked and the next section is opened
| |
| | MySQL Settings → Dayfile.txt upload
| |
| | Table name
| |
| | Dayfile
| |
| | Enables you to choose the name for the database table to be updated when "DayfileMySqlEnabled" is ticked
| |
| |-
| |
| | Host=
| |
| | when section opened
| |
| | MySQL Settings → Server Details
| |
| | Host name
| |
| | (blank)
| |
| | Enter the database server name or Internet Protocol address
| |
| |-
| |
| | MonthlyMySqlEnabled=0
| |
| | (always)
| |
| | MySQL Settings
| |
| | Monthly Log Enabled
| |
| | Not ticked (shown as 0 in Cumulus.ini)
| |
| | Enable the automatic upload to the table named in "MonthlyTable" within the database named in "Database"
| |
| |-
| |
| | MonthlyTable=Monthly
| |
| | when "Dayfile Enabled" is ticked and the next section is opened
| |
| | MySQL Settings → Monthly log file upload
| |
| | Table name
| |
| | Monthly
| |
| | Enables you to choose the name for the database table to be updated when "MonthlyMySqlEnabled" is ticked
| |
| |- | | |- |
| | Pass= | | | Ftp-alldailydegdaydata=0 |
| | when section opened | | | [FTP site] |
| | MySQL Settings → Server Details | | | Release 3.10.0 |
| | Password | | | ^ |
| | (blank)
| | | Internet Settings → Graph File Settings |
| | Enter the password needed to access the database server specified in "Host"
| | | alldailydegdaydata.json → File Transfer |
| |-
| | | 1 (enabled) |
| | Port=3306
| | | Simple tick or not |
| | when section opened
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailydegdaydata.json file to your local web server (need to select "Generate" too) |
| | MySQL Settings → Server Details
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | Port | |
| | 3306 | |
| | Enter the port used to access the database server
| |
| |-
| |
| | RealtimeMySql1MinLimit=0
| |
| | When section opened
| |
| | MySQL Settings → Raltime.txt upload
| |
| | Limit real time table inserts to once a minute
| |
| | Not ticked (shown as 0 in Cumulus.ini)
| |
| | Enable the optional functionality to limit database uploads, if your real time interval has been set to less than 60 seconds
| |
| |- | | |- |
| | RealtimeMySqlEnabled=0 | | | Ftp-alldailyhumdata=0 |
| | (always) | | | [FTP site] |
| | MySQL Settings | | | Release 3.10.0 |
| | Realtime enabled | | | ^ |
| | Not ticked (shown as 0 in Cumulus.ini) | | | Internet Settings → Graph File Settings |
| | Enable the automatic upload to the table named in "RealtimeTable" within the database named in "Database"
| | | alldailyhumdata.json → File Transfer |
| |- | | | 1 (enabled) |
| | RealtimeRetention= | | | Simple tick or not |
| | When section opened | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too) |
| | MySQL Settings → Raltime.txt upload | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | '''Data Retention value''' and '''Data Retention unit''' | | |- |
| | "7" and "Days" | | | Ftp-alldailypressdata=0 |
| | The value field will take any number, the unit field is a dropdown: | | | [FTP site] |
| * Seconds | | | Release 3.10.0 |
| * Minutes
| | | ^ |
| * Hours
| | | Internet Settings → Graph File Settings |
| * Days
| | | alldailypressdata.json → File Transfer |
| * Weeks
| | | 1 (enabled) |
| * Months
| | | Simple tick or not |
| 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
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too) |
| |- | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | RealtimeTable=Realtime | | |- |
| | When section opened | | | Ftp-alldailyraindata=0 |
| | MySQL Settings → Raltime.txt upload | | | [FTP site] |
| | Table name | | | Release 3.10.0 |
| | Realtime | | | ^ |
| | Enables you to choose the name for the database table to be updated when "RealtimeMySqlEnabled" is ticked
| | | Internet Settings → Graph File Settings |
| |-
| | | alldailyraindata.json → File Transfer |
| | User=
| | | 1 (enabled) |
| | when section opened
| | | Simple tick or not |
| | MySQL Settings → Server Details
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too) |
| | User name | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | (blank) | | |- |
| | Enter the username associated with "Pass" | | | Ftp-alldailysolardata=0 |
| |}
| | | [FTP site] |
| | | | Release 3.10.0 |
| ==Debugging==
| | | ^ |
| | | | Internet Settings → Graph File Settings |
| * Available from beta MX. | | | alldailysolardata.json → File Transfer |
| * File Section is [Station]
| |
| {| class="wikitable" border="1"
| |
| |- | |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:300px" | MX Section
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:600px" | Description
| |
| |- | |
| | Logging=1
| |
| | Depends on release installed: | |
| # Alternatives:
| |
| #* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
| |
| #* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
| |
| # (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
| |
| # (Release 3.12.0 onwards) Program Settings → Logging Options
| |
| | Debug logging
| |
| | 0 (disabled) | | | 0 (disabled) |
| | This adds extra information about data transfers between your weather station and MX.
| |
|
| |
| It was introduced originally for Davis stations only, but later (can someone insert here the relevant release) extended to cover more stations.
| |
| |-
| |
| | DataLogging=1
| |
| | Depends on release installed:
| |
| # Alternatives:
| |
| #* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: DataLogging = 1, then restart Cumulus MX.
| |
| #* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
| |
| # (Release 3.9.4 to 3.11.4) Program Settings → Program General Options
| |
| # (Release 3.12.0 onwards) Program Settings → Logging Options
| |
| | Debug logging
| |
| | 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 → 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 | | | 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) | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too) |
| * Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| |- | | |- |
| | DisplayUvData=0 | | | Ftp-alldailytempdata=0 |
| | ??? 3.10.0 ??? | | | [FTP site] |
| | Display UV-I data | | | Release 3.10.0 |
| | Unticked (shown as 0 in Cumulus.ini) | | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alldailytempdata.json → File Transfer |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Ftp-alldailywinddata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alldailywinddata.json → File Transfer |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Ftp-alltempsumdata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | alltempsumdata.json → File Transfer |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alltempsumdata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Ftp-availabledata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ (once only) |
| | | Internet Settings → Graph File Settings |
| | | availabledata.json → File Transfer |
| | | 0 (disabled) |
| | Simple tick or not | | | 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) | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[availabledata.json]] file to your local web server (need to select "Generate" too) |
| * 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 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | NumWindRosePoints=16 | | | Ftp-dailyrain=0 |
| | Legacy Cumulus | | | [FTP site] |
| | Number of wind rose points | | | Release 3.10.0 |
| | 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 | | | Internet Settings → Graph File Settings |
| * 8 points
| | | dailyrain.json → File Transfer |
| * 16 points | | | 1 (enabled) |
| 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.
| | | Simple tick or not |
| |- | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too) |
| | UseApparent=1 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | ??? MX 3.6.0 or 3.10.0 ??? | | |- |
| | Use Apparent Temperature | | | Ftp-dailytemp=0 |
| | Ticked (shown as 1 in Cumulus.ini) | | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | dailyrain.json → File Transfer |
| | | 1 (enabled) |
| | Simple tick or not | | | 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 | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too) |
| * 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 | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |} | | |- |
| | | | Ftp-graphconfig=0 |
| ==Extra Web Files==
| | | [FTP site] |
| | | | Release 3.10.0 |
| There are 100 occurrences of each parameter in Cumulus.ini, and therefore each parameter has a base name followed by numbers 0 to 99.
| | | ^ (once only) |
| | | | Internet Settings → Graph File Settings |
| The settings interface presents the rows on multiple pages, the rows are not numbered, so you have to do some counting to work out which row in the admin interface page corresponds with which parameter in Cumulus.ini file.
| | | graphconfig.json → File Transfer |
| | | | 1 (enabled) |
| {| class="wikitable" border="1"
| | | Simple tick or not |
| |-
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[graphconfig.json]] file to your local web server (need to select "Generate" too) |
| !style="width:30px" | Parameter Line Entry
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| !style="width:100px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:800px" | Description
| |
| |- | | |- |
| |style="background:lightgray;"|[FTP site] | | | Ftp-humdata=0 |
| | | | | [FTP site] |
| | | | | Release 3.10.0 |
| |style="background:lightgray;"|Section name | | | ^ |
| |- | | | Internet Settings → Graph File Settings |
| |ExtraLocal0= to ExtraLocal99=
| | | humdata.json → File Transfer |
| |Local File Name
| | | 1 (enabled) |
| |(empty) | | | Simple tick or not |
| |You can enter: | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[humdata.json]] file to your local web server (need to select "Generate" too) |
| * A relative path name, with respect to the "CumulusMX" root folder | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| ** e.g. '''./data/dayfile.txt''' (Note: this is the [[Daily_Summary|daily summary log file]], see link for how it can be used on a web server) | | |- |
| ** e.g. '''./webMX/betel_monthlyrecord_liteMXT.html''' (Note: this is a third party [[Cumulus_template_file|template file]] - see [https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=7500 Alternative Monthly Extremes using <#webtag>s] | | | Ftp-pressdata=0 |
| ** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
| | | [FTP site] |
| * A full path name for a file on the computer running MX | | | Release 3.10.0 |
| ** e.g. '''/home/pi/documents/myFile'''
| | | ^ |
| ** e.g. '''C:\Users\Public\Documents\working.txt''' | | | Internet Settings → Graph File Settings |
| *You can place any of the following special tags into the entry
| | | pressdata.json → File Transfer |
| ** These should be typed as shown on their own
| | | 1 (enabled) |
| *** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports
| | | Simple tick or not |
| *** '''<currentlogfile>''', '''<currentextralogfile>''', and '''<airlinklogfile>''' these respectively represent [[Standard_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files e.g. ExtraLocal3=<currentlogfile>
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[pressdata.json]] file to your local web server (need to select "Generate" too) |
| |- | | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |ExtraRemote0= to ExtraRemote99= | | |- |
| |Destination Filename | | | Ftp-raindata=0 |
| |(empty) | | | [FTP site] |
| |Defines where MX is to upload file to | | | Release 3.10.0 |
| * If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root | | | ^ |
| **I can't tell you what the file path is for your web server, but I can give a couple of examples to steer you
| | | Internet Settings → Graph File Settings |
| *** e.g. httpdocs/dayfile.txt | | | raindata.json → File Transfer |
| *** e.g. public_html/thismonthyear.htm
| | | 1 (enabled) |
| * If the FTP is not ticked, the file path should be full path for a file on the computer running MX
| | | Simple tick or not |
| ** e.g. /var/www/html/weather/images/moon.png could be destinatation for uploading the MX generated moon image to a Linux hosted [[Your_Own_Server|server]] | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[raindata.json]] file to your local web server (need to select "Generate" too) |
| ** e.g. /var/www/html/weather/webfilesMX/tempdata.json for uploading one of the [[:Category:JSON_Files|files with graph data]] to a Linux hosted [[Your_Own_Server|server]]
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| *You can place any of the following special tags into the entry | | |- |
| ** These should be typed as shown as part of the destination path, note that they can be used:
| | | Ftp-solardata=0 |
| *** either to represent the final filename part of the path e.g. ExtraRemote3=/var/www/html/weather/monthly/<currentlogfile>
| | | [FTP site] |
| *** or to modify a filename, so it becomes unique to a particular month e.g. ExtraRemote0=/var/www/html/weather/cumulus_generated/savedFiles/web_tags_real_time_<currentlogfile>.inc
| | | Release 3.10.0 |
| ** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports
| | | ^ |
| ** '''<currentlogfile>''', '''<currentextralogfile>''', and '''<airlinklogfile>''' these respectively represent [[Standard_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files
| | | Internet Settings → Graph File Settings |
| |- | | | solardata.json → File Transfer |
| |ExtraProcess0= to ExtraProcess99= | | | 0 (disabled) |
| |Process | | | Simple tick or not |
| |0 | | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[solardata.json]] file to your local web server (need to select "Generate" too) |
| |Simple tick or not | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| * Tick (value shown as 1 in Cumulus.ini) if the local file is a [[Cumulus_template_file|template file]], see [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|here]] for full explanation of '''Process''' | | |- |
| * Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content | | | Ftp-sunhours=0 |
| |- | | | [FTP site] |
| |ExtraRealtime0= to ExtraRealtime99= | | | Release 3.10.0 |
| |Realtime | | | ^ |
| |0 | | | Internet Settings → Graph File Settings |
| |Simple tick or not | | | sunhours.json → File Transfer |
| *Tick (value shown as 1 in Cumulus.ini) if | | | 0 (disabled) |
| *# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there
| | | Simple tick or not |
| *# Uploads the file to destination specified at interval defined
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[sunhours.json]] file to your local web server (need to select "Generate" too) |
| * Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]]) | | * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) |
| | |- |
| | | Ftp-tempdata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | tempdata.json → File Transfer |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[tempdata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Ftp-wdirdata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Graph File Settings |
| | | wdirdata.json → File Transfer |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[wdirdata.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Ftp-websitedata=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ |
| | | Internet Settings → Standard File Settings |
| | | websitedata.json → File Transfer |
| | | 0 (disabled) |
| | | Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]] |
| | |
| | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the resulting websitedata.json to your local web server |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| |ExtraFTP0= to ExtraFTP99= | | | Ftp-winddata=0 |
| |FTP | | | [FTP site] |
| |1 | | | Release 3.10.0 |
| |Simple tick or not | | | ^ |
| *Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]] | | | Internet Settings → Graph File Settings |
| * Don't tick (value shown as 0 in Cumulus.ini) if the remote file is on the computer running MX and a simple Copy File is required | | | dailyrain.json → File Transfer |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | Ftp-wxnow=0 |
| | | [FTP site] |
| | | Release 3.10.0 |
| | | ^ (disabled) |
| | | (depends on release) |
| | * (release 3.10.0 to 3.11.4) Internet Settings → Web/FTP Settings |
| | * (release 3.12.0 on) Internet Settings → Standard File Settings |
| | | wxnow.txt → File Transfer |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer that file to your local web server |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| |ExtraUTF0= to ExtraUTF99= | | | ForumURL= |
| |UTF-8 | | | [Web Site] |
| |1 | | | Legacy Cumulus |
| |Please see [[Reports_folder#Encoding|technical guidance on encoding]] | | | (always) |
| *Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters
| | | (depends on release) |
| *If unticked (0 appears in file), then iso-8859-1 encoding is used
| | * (releases 3.0.0 to 3.11.4) Internet Settings → Web Site |
| |-
| | * (release 3.12.0 on) Internet Settings → Miscellaneous |
| |ExtraBinary0= to ExtraBinary99=
| | | Forum URL |
| |Binary
| | | (blank) |
| |0
| | | Left blank to allow you to choose format |
| |Simple tick or not
| |
| *Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png) | |
| * Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript | |
| |- | |
| |ExtraEOD0= to ExtraEOD99= | |
| |End of Day
| |
| |0
| |
| |Simple tick or not | |
| *Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
| |
| * Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]])
| |
| |}
| |
|
| |
|
| == Location== | | 3.10.0 Default web pages use "<a href=\"https://cumulus.hosiene.co.uk/index.php\">forum</a>" |
|
| |
|
| * Introduced for legacy Cumulus | | Some alternative URL examples: |
| * File Section is [Station] | | *https://cumulus.hosiene.co.uk/index.php (for above example in default web pages) |
| | | *https://cumulus.hosiene.co.uk |
| {| class="wikitable" border="1"
| | *https://cumulus.hosiene.co.uk/search.php?search_id=active_topics |
| |- | | |- |
| !style="width:30px" | Parameter Line Entry
| | | FTPlogging=0 |
| !style="width:100px" | MX Section
| | | [FTP site] |
| !style="width:60px" | Label on Settings page
| | | Legacy Cumulus |
| !style="width:20px" | Default
| | | FTP logging |
| !style="width:600px" | Description
| | | Depends on release installed: |
| | # (Releases 3.1.0 to 3.10.5) Internet Settings → → Web Settings → General Settings |
| | # (Releases 3.11.0 to 3.11.4) Program Settings → Program General Options |
| | # (Release 3.12.0 onwards) Program Settings → Logging Options |
| | | (n/a) |
| | | (n/a) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX in standard FTP mode add output to [[ftplog.txt]]. |
| | to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable updates to '''ftplog.txt''' |
| | For other types of file transfer (STTP, FTPS), any extra diagnostic information appears in latest log in [[MXdiags folder]] |
| |- | | |- |
| | Altitude=0 | | | FTPRename=1 |
| | Station Settings → Location
| | | [FTP site] |
| | Altitude | | | Legacy Cumulus |
| | 0 | | | (always) |
| | The height above mean sea level where the (pressure) sensor is positioned
| | | (depends on release) |
| | * (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings |
| | * (release 3.12.0 on) Internet Settings → Web Site → General Settings |
| | | FTP rename |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | The chief advantage of using rename is that it minimises the time that the web server cannot serve a file (while it is being updated) |
| |- | | |- |
| | AltitudeInFeet=1 | | | Host= |
| | Station Settings → Location | | | [FTP site] |
| | Altitude Units | | | Legacy Cumulus |
| | Default depends on release: | | | (always) |
| # Legacy until 3.11.4: 1 (labelled as feet)
| | | Internet Settings → Web/FTP Site |
| # From 3.12.0: 0 (labelled metres)
| | | Host name |
| | Radio Setting | | | (blank) |
| * feet (value shown as 1 in Cumulus.ini)
| | | This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site. |
| * metres (value shown as 0 in Cumulus.ini)
| |
| |- | | |- |
| | LocName= | | | IncludeMoonImage=1 |
| | Station Settings → Location | | | [FTP site] |
| | Name | | | Release 3.5.0 |
| | (empty) | | | (always) |
| | A short name for the location | | | Internet Settings → Moon Image |
| | | (FTP) Upload Moon image file |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer moon image file to your local web server (need to select "Generate Moon Image" see '''MoonImageEnabled=''' too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | LocDesc= | | | IntervalFtpEnabled=1 |
| | Station Settings → Location | | | [FTP site] |
| | Description | | | Release 3.12.0 |
| | (empty) | | | ?? |
| | A longer description for the location | | | Internet Settings → Interval Settings |
| | | Enable file transfer update interval |
| | | 1 (enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file transfer actions |
| | * Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected '''LocalCopyEnabled''' (see below) |
| |- | | |- |
| | "Latitude=0" and "LatTxt=" | | | ListWebTags=0 |
| | Station Settings → Location → Latitude | | | [Station] |
| | "Degrees", "Minutes", "Seconds", and "Hemisphere → North or South" | | | Legacy Cumulus |
| | (blank) | | | Only from Release 3.12.0 |
| | The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file | | | Depends on release: |
| | * (3.5.1 to 3.11.4) Manual edit of file |
| | * (3.12.0 onwards) Station settings → Common Options → Advanced options |
| | | 0 |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to create ''WebTags.txt'' file when Cumulus is restarted (contains an unordered list of all the tag names your Cumulus build will recognise and process) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | LocalCopyEnabled=0 |
| | | [FTP site] |
| | | Release 3.12.0 |
| | | (always) |
| | | Internet Settings → Interval Configuration |
| | | Enable local copy update interval |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file copy actions |
| | * Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected file transfer '''IntervalFtpEnabled''' (see previous) |
| |- | | |- |
| | "Longitude=0" and "LongTxt=" | | | LocalCopyFolder= |
| | Station Settings → Location → Longitude | | | [FTP site] |
| | "Degrees", "Minutes", "Seconds", and "Hemisphere → East or West" | | | Release 3.12.0 |
| | | (always) |
| | | Internet Settings → Interval Configuration |
| | (blank) | | | (blank) |
| | The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file | | | Folder (including path) to which MX will copy the standard files (see rows marked ^ for further selections) if 'EnableLocalCopy' is enabled |
| |}
| |
| | |
| ==Optional Report Settings==
| |
| | |
| * File Section is [NOAA]
| |
| {| class="wikitable" border="1"
| |
| |- | | |- |
| !style="width:30px" | Parameter Line Entry
| | | MoonImageEnabled=1 |
| !style="width:100px" | Introduced
| | | [Graphs] |
| !style="width:100px" | MX Section
| | | Release 3.5.0 |
| !style="width:60px" | Label on Settings page
| | | (always) |
| !style="width:20px" | Default
| | | Internet Settings → Moon Image |
| !style="width:300px" | Description
| | | Generate Moon Image |
| |-
| | | ^ Default controlled by selection of default web site |
| | AutoCopy=0
| |
| | Release 3.12.0 | |
| | NOAA Reports Settings → FTP Options | |
| | Auto Copy NOAA report files | |
| | 0 (disable) | |
| | Simple tick or not | | | Simple tick or not |
| * Tick (value shown as 1 in Cumulus.ini) if your report is to be copied to copy directory during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]] | | * Tick (value shown as 1 in Cumulus.ini) for MX to use System Drawing to modify CumulusMX/web/MoonBaseImage.png and create CumulusMX/web/moon.png |
| * Don't tick (value shown as 0 in Cumulus.ini) for no copy action | | * Don't tick (value shown as 0 in Cumulus.ini) if you don't need MX to create a "moon.png" |
| |- | | |- |
| | AutoFTP=0 | | | MoonImageSize= |
| | First with Cumulus 2 | | | [Graphs] |
| | NOAA Reports Settings → FTP Options | | | Release 3.5.0 |
| | Auto transfer NOAA report files | | | (always) |
| | 0 (disable) | | | Internet Settings → Moon Image |
| | Simple tick or not | | | Image size |
| * Tick (value shown as 1 in Cumulus.ini) to enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed)
| | | ??? |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
| | | Enter a size (in pixels) for the generated moon image (according to space on your web page) |
| |- | | |- |
| | AutoSave=1 | | | Password= |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings | | | Legacy Cumulus |
| | Create NOAA files after daily rollover | | | (always) |
| |0 | | | Internet Settings → Web/FTP Site |
| | Simple tick or not | | | Password |
| * Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality
| | | (blank) |
| * Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required
| | | The password for your FTP/SFTP/FTPS connection (masked out on settings page, shown in plain text in file) |
| |- | | |- |
| | City= | | | Port=21 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Site Details | | | Legacy Cumulus |
| | City | | | (always) |
| | (empty) | | | Internet Settings → Web/FTP Site |
| | Enter here your hamlet, village, town, or city, name | | | FTP port |
| | | 21 (plain FTP) |
| | |you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative protocol and/or alternative ports. |
| |- | | |- |
| | CoolingThreshold=22 | | | RealtimeFTPEnabled=0 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | Legacy Cumulus |
| | Cooling threshold | | | ^ |
| | 65<sup>o</sup> F or 18.3<sup>o</sup>C | | | Internet Settings → Realtime Settings |
| | [[Heat/cold_degree_days_and_Chill_hours#Cold_Degree_Days|Cold Degree Days]] are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. An international standard says 22 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
| | | Enable realtime FTP |
| |- | | | 0 (disabled) |
| | CopyDirectory= | | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to be able to do file transfers at real-time interval |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| | |- |
| | | RealtimeGaugesTxtCopy=0 |
| | | [FTP site] |
| | Release 3.12.0 | | | Release 3.12.0 |
| | NOAA Reports Settings → Report Options | | | ^ |
| | Copy Directory | | | Internet Settings → Realtime Settings |
| | (empty) | | | realtimegauges.txt |
| | The folder on the web server you host to which reports are to be copied | | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[SteelSeries_Gauges|realtimegauges.txt]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | FTPDirectory= | | | RealtimeGaugesTxtCreate=0 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → FTP Options | | | Release 3.10.0 |
| | destination folder | | | ^ |
| | Depends on release: | | | Internet Settings → Realtime Settings |
| * (3.1.0 to 3.11.4) blank | | | realtimegauges.txt → Generate |
| * (3.12.0 onwards) to match change in default web site script specification of '''Reports''' folder | | | 0 |
| | Specify the destination folder for file transfer to, on your FTP server
| | | Simple tick or not |
| *Leave at default (for your release) and MX will work with the default web pages script supplied (at same release)
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[SteelSeries_Gauges|realtimegauges.txt]] file |
| * Specify a folder relative to FTP root, and MX will upload reports to that folder instead (you are then responsible for writing any script on your web site to find each report and do any processing).
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | HeatingThreshold=15.5 | | | RealtimeGaugesTxtFTP=0 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | Release 3.10.0 |
| | Heating threshold | | | ^ |
| | 65<sup>o</sup> F or 18.3<sup>o</sup>C | | | Internet Settings → Realtime Settings |
| |[[Heat/cold_degree_days_and_Chill_hours#Heat_Degree_Days| Heating Degree Days]] are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. An international standard says 15.5 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
| | | realtimegauges.txt → File Transfer |
| | | 0 |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[SteelSeries_Gauges|realtimegauges.txt]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | MaxTempComp1=22 | | | RealtimeInterval=45000 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | Legacy Cumulus |
| | Max temp comparison 1 | | | ^ |
| | (empty) | | | Internet Settings → Realtime Settings |
| | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit | | | Realtime interval |
| | | 45000 milliseconds (45 seconds) |
| | | Enter interval time in seconds (decimals allowed), stored in file converted to milliseconds |
| | |- |
| | | RealtimeTxtCopy=0 |
| | | [FTP site] |
| | | Release 3.12.0 |
| | | ^ |
| | | Internet Settings → Realtime Settings |
| | | realtime.txt |
| | | 0 (disabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[realtime.txt]] file to your local web server (need to select "Generate" too) |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | MaxTempComp2=0 | | | RealtimeTxtCreate=0 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | Release 3.10.0 |
| | Max temp comparison 2 | | | ^ |
| | (empty) | | | Internet Settings → Realtime Settings |
| | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit
| | | realtime.txt → Generate |
| | | 0 |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[realtime.txt]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | MinTempComp1=15.5 | | | RealtimeTxtFTP=0 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | Release 3.10.0 |
| | Min temp comparison 1 | | | ^ |
| | (empty) | | | Internet Settings → Realtime Settings |
| | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit | | | realtime.txt → File Transfer |
| | | 0 |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[realtime.txt]] file |
| | * Don't tick (value shown as 0 in Cumulus.ini) to disable |
| |- | | |- |
| | MinTempComp2=0 | | | RecordSetTimeoutHrs=24 |
| | First with Cumulus 2 | | | [Station] |
| | NOAA Reports Settings → Thresholds
| | | Release 3.5.1 |
| | Min temp comparison 2
| | | Only from Release 3.12.0 |
| | (empty) | | | Depends on release: |
| | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit | | * (3.5.1 to 3.11.4) Manual edit of file |
| | * (3.12.0 onwards) '''Two places''': |
| | *# Station setings → General Settings → Advanced options |
| | *# Station settings → Common Options → Advanced options |
| | | Depends on where changed (respectively): |
| | # New record timeout |
| | # Record set timeout |
| | | 24 |
| | | Number of hours before the following web tags are reset: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet, LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet, HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet |
| |- | | |- |
| | MonthFileFormat='NOAAMO'MMyy'.txt' | | | Sslftp= |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Output Files | | | MX beta |
| | Monthly filename format | | | (always) |
| | 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''') | | | Internet Settings → Web/FTP Site |
| | Here you specify the filename template for MX to use when reading, or writing, monthly reports
| | | Select the FTP Protocol to use |
| | | | 0 |
| There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid.
| | | Drop down list: |
| | * 0 = FTP (plain old FTP) - default |
| | * 1 = Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) for FTP (FTPS) |
| | * 2 = Use Secure Shell Home (SSH) for FTP (SFTP) |
| |- | | |- |
| | Name=Personal Weather Station | | | SshFtpAuthentication=Password |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Site Details | | | Release 3.8.2 - build 3092 |
| | Site Name | | | Only if SFTP selected above |
| | (empty) | | | Internet Settings → Web/FTP Site |
| | What you would like to see in report title for your station name | | | SFTP Authentication method |
| | | Password |
| | |Drop down list: |
| | * 0 = Password |
| | * 1 = Pre-shared key |
| | * 2 = Password or pre-shared key |
| |- | | |- |
| | NOAAUseUTF8=1 | | | SshFtpPskFile= |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Report Options | | | Release 3.8.2 - build 3092 |
| | Use UTF-8 encoding | | | only if 1 or 2 selected in previous setting |
| | 1 (UTF-8) | | | Internet Settings → Web/FTP Site |
| | Please see [[Reports_folder#Encoding]] | | | Pre-shared Private Key file for SFTP |
| * Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the <sup>o</sup> degree symbol
| | | (blank) |
| * If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the <sup>o</sup> degree symbol is coded differently
| | | Filename for your private PSK file, include the full path if the file is not in same folder as CumulusMX.exe |
| |- | | |- |
| | RainComp1=0.5 | | | UpdateInterval=60 |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | legacy software |
| | Rain comparison 1 | | | ^ |
| | (empty) | | | Internet Settings → Interval Settings |
| | The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold | | | Web interval |
| | | 60 |
| | | Interval between standard web updates in minutes |
| |- | | |- |
| | RainComp2= | | | Username= |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | legacy software |
| | Rain comparison 2 | | | (always) |
| | (empty) | | | Internet Settings → Web/FTP Site |
| | The report will count the number of days when the daily rainfall exceeds this threshold. | | | Username |
| | | (blank) |
| | | the user name for connecting to your server |
| |- | | |- |
| | RainComp3= | | | UTF8encode= |
| | First with Cumulus 2 | | | [FTP site] |
| | NOAA Reports Settings → Thresholds | | | legacy software |
| | Rain comparison 3 | | | (always) |
| | (empty) | | | (depends on release) |
| | The report will count the number of days when the daily rainfall exceeds this threshold. | | * (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings |
| | * (release 3.12.0 on) Internet Settings → Web Site → General Settings |
| | | UTF-8 encoding |
| | | Default depends on release: |
| | * (Legacy versions and MX up to 3.9.7) 0 (ISO 8859-1 character set) |
| | * (Release 3.10.0 on) 1 (UTF-8 encoding enabled) |
| | | Simple tick or not |
| | * Tick (value shown as 1 in Cumulus.ini) for MX to use [[Reports_folder#Encoding|'''UTF-8''' encoding]] in all [[:Category:JSON Files|.json files]] |
| | * Don't tick (value shown as 0 in Cumulus.ini) and MX will create its .json files using '''ISO 8859-1 character set''', ''please note that this encoding is incompatible with [[New_Default_Web_Site_Information#Installing_the_new_template_for_new_users|web pages]] included in '''webfiles''' folder''; so if you upgrade from an earlier release, you may need to change this setting |
| |- | | |- |
| | State= | | |WebcamURL= |
| | First with Cumulus 2 | | | [Web Site] |
| | NOAA Reports Settings → Site Details
| | | Legacy Software |
| | State | | | (always) |
| | (empty) | | | (depends on release) |
| | Enter here your local authority area or region (state in USA) | | * (releases 3.0.0 to 3.11.4) Internet Settings → Web Site |
| |-
| | * (release 3.12.0 on) Internet Settings → Miscellaneous |
| | UseDotDecimal=0
| | | Webcam URL |
| | Release 3.9.5 - b3100
| | | (blank) |
| | NOAA Reports Settings → Report Options
| | | Can be used to add a link to any other web page, you have on any web server. In default web pages will be labelled as "web cam", but for your own web pages, this might lead to a home or blog page. |
| | Use a 'dot' decimal point | | |} |
| | 0 (disable) | | |
| | Formatting real numbers for when NOAA report parsed by a script | | ==Program Start-up Options== |
|
| |
|
| Simple tick or not
| | * Introduced release 3.9.4 - b3099 |
| * Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma | | * File Section is [Program] |
| * Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale | | {| class="wikitable" border="1" |
| |- | | |- |
| | UseMinMaxAvg=0 | | !style="width:30px" | Parameter Line Entry |
| | Release 3.12.0 | | !style="width:160px" | MX Section |
| | NOAA Reports Settings → Report Options | | !style="width:160px" | Label on Settings page |
| | Use WHO average or Integrated average | | !style="width:20px" | Default |
| | 0 (integrated average)
| | !style="width:600px" | Description |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2
| |
| * Don't tick (value shown as 0 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use integrated calculation: Sum of all temperature measurements divided by count of measurements
| |
| |- | | |- |
| | YearFileFormat='NOAAYR'yyyy'.txt’ | | |StartupPingHost= |
| | First with Cumulus 2 | | | Program Settings → Program Start-up Options |
| | NOAA Reports Settings → Output Files | | |Host to PING on program start-up |
| | Yearly filename format | | |None (no remote host) |
| | 'NOAAYR'yyyy'.txt' | | | Add a hostname or IP to address to ping at startup. Cumulus waits until the ping is successful before trying to read from your station. Leave blank to disable |
| | Here you specify the filename template for MX to use when reading, or writing, yearly reports | | |- |
| | | |StartupPingEscapeTime=999 |
| There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension.
| | | Program Settings → Program Start-up Options |
| | |PING escape time (mins) |
| | |999 (minutes) |
| | |Specify a time after which if no ping response is received carry on starting Cumulus MX anyway |
| | |- |
| | |StartupDelaySecs=0 |
| | | Program Settings → Program Start-up Options |
| | |Start-up Delay (secs) |
| | |zero (no delay) |
| | |Add a delay before the Cumulus tries to start reading the station. |
| |- | | |- |
| |12hourformat=0 | | |StartupDelayMaxUptime=300 |
| | ??? | | | Program Settings → Program Start-up Options |
| | NOAA Reports Settings → Output Files
| | |Max system uptime to apply the start-up delay |
| |Time format | | |300 (seconds equivalent to 5 minutes) |
| |0 (24 hour) | | |The time that has passed sice MX was started (up-time) is compared against the (max delay time) figure here. |
| | How times are output on reports | | *If max delay time less than up-time, the delay specified in previous parameter will NOT be applied |
| * 24 Hour (value shown as 0 in Cumulus.ini) | | *If up-time less than this max delay time, then MX will apply any delay specified in previous parameter |
| * 12 Hour (value shown as 1 in Cumulus.ini) | | *If this parameter is set to zero, then MX will always apply any delay specified in previous parameter |
| |} | | |} |
|
| |
|
| | ==Proxy== |
|
| |
|
| | This is a continuation of an experimental legacy Cumulus software feature, please see [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=728 here for request] and see [[Cumulus.ini_(Cumulus_1)#Proxies|here]] for potential content. I have not seen any evidence that this feature ever came out of beta, and nobody has ever commented on its use, so I see no reason to do any further documentation. |
|
| |
|
| ===Normal Mean Temperatures=== | | ==Station specific alternatives== |
| | |
| | A number of settings are shown only for specific station types, and so the following tables are grouped here. |
|
| |
|
| * File Section is [NOAA]
| | Since MX is being developed by someone who uses a Davis station, a lot of "Labels on the Settings Screens" mention "Davis" even if you have selected a different station, because the code was written by copy and paste! |
| * The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
| |
| * There is one box labelled for each month on the settings screens
| |
| * All the defaults are (blank)
| |
| * What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements
| |
|
| |
|
| ===Normal Precipitation=== | | === Solar=== |
|
| |
|
| * File Section is [NOAA]
| | Cumulus MX is unable to work out if you have a solar sensor, so these options are always displayed. |
| Rainfall equivalents of mean temperature described above
| | {| class="wikitable" border="1" |
| | |- |
| | !style="width:30px" | Parameter Line Entry |
| | !style="width:100px" | File Section |
| | !style="width:100px" | Introduced |
| | !style="width:100px" | MX Section |
| | !style="width:60px" | Label on Settings page |
| | !style="width:20px" | Default |
| | !style="width:800px" | Description |
| | |- |
| | | SolarCalc=0 |
| | | [Solar] |
| | | 3.13 |
| | | Station Settings → Solar |
| | | Solar Calculation Method |
| | | 0=Ryan-Stololzenbach |
| | | Drop-down list: |
| | * 0=Ryan-Stololzenbach |
| | * 1=Bras |
| | |- |
| | | SunThreshold=75 |
| | | [Solar] |
| | | 3.13 |
| | | Station Settings → Solar |
| | | Sun Threshold (percent) |
| | | 75 |
| | | Enter a number |
| | |- |
| | | SolarMinimum=0 |
| | | [Solar] |
| | | 3.13 |
| | | Station Settings → Solar |
| | | Solar minimum (W/m2) |
| | | 30 |
| | | Enter a number |
| | |- |
| | | RStransfactorJul=0.80000000000000004 |
| | | [Solar] |
| | | 3.14 |
| | | Station Settings → Solar |
| | | RS Transmission factor (June) |
|
| |
|
| ==Optional Third-party Upload Settings== | | (Note the internal calculation does apply this to June, but some MX releases were incorrectly typed to say "July" on the settings screen). |
| | | 0.8 |
| | | MX does a sinusoidal interpolation between this value and the next. So this June factor changes very little either side of that solstice, with the average value from both factors applying at the equinoxes (March and September) and different amounts of each factor each side of equinox. (So actually more like a cosine interpolation!) |
| | |- |
| | | RStransfactorDec=0.80000000000000004 |
| | | [Solar] |
| | | 3.14 |
| | | Station Settings → Solar |
| | | RS Transmission factor (December) |
| | | 0.8 |
| | | MX does a sinusoidal interpolation between last value and this one. So this December factor changes very little either side of that solstice, with the average value from both factors applying at the equinoxes (March and September) and different amounts of each factor each side of equinox. (So actually more like a cosine interpolation!) |
| | |- |
| | | UseBlakeLarsen=0 |
| | | [Solar] |
| | | Legacy |
| | | Extra Sensor Settings |
| | | Blake-Larsen Sunshine Recorder |
| | | 0=deselected |
| | | checkbox |
| | |} |
|
| |
|
| | ===Selecting the weather station type determines which options are shown=== |
|
| |
|
| {| class="wikitable" border="1" | | {| class="wikitable" border="1" |
| |- | | |- |
| !style="width:30px" | Parameter Line Entry | | !style="width:30px" | Parameter Line Entry |
| !style="width:30px" | File Section | | !style="width:100px" | File Section |
| !style="width:60px" | MX Section | | !style="width:100px" | Introduced |
| !style="width:80px" | Action on Settings page | | !style="width:100px" | MX Section |
| | !style="width:60px" | Label on Settings page |
| !style="width:20px" | Default | | !style="width:20px" | Default |
| | !style="width:800px" | Description |
| |- | | |- |
| | <pre>ID= | | |Type= -1 |
| pass=-1
| | | [Station] |
| server=cwop.aprs.net
| | | 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0) |
| port=14580
| | | Station Settings → General Settings |
| Enabled=0
| | | Station type |
| Interval=9
| | | -1 (not yet defined) |
| SendSR=0
| | | Drop-down |
| APRSHumidityCutoff=0</pre>
| | * -1 = "Select Station", shown before a selection from those below is made |
| | [APRS] | | * 0 = Davis Vantage Pro station |
| | APRS/CWOP | | * 1 = Davis Vantage Pro2 or Vue station |
| | Tick "Enabled" to see list of parameters so you can edit them | | * 2 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wireless connection (e.g. WMR-928 station) |
| | Defaults are as shown in list of parameters | | * 3 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wired connection (e.g. WM-918 station) |
| | * 4 = Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set. |
| | '''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value. |
| | * 5 = Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] ('''without''' solar measurement sensors (with or without solar recharging)) |
| | * 6 = For all La Crosse WS23xx models e.g. WS2300 |
| | * 7 = Fine Offset/Watson/MyDel etc '''with Solar Sensors''' as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]]. |
| | * 8 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR100 |
| | * 9 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR200 |
| | * 10 = Instromet (with optional extra solar sensors or without) |
| | * 11 = Davis WLL |
| | * 12 = Ecowitt GW1000 and Froggit DP1500 (and any equivalents) |
| | |
| | '''Selection made here determines what MX sections appear on the Station Settings page |
| |- | | |- |
| | <pre>User= | | | Model= |
| Password= | | | [Station] |
| Language=en
| | | Early legacy version |
| Enabled=0
| | | Station Settings → General Settings |
| Interval=900
| | | Station model |
| SendUV=0
| | | (empty) |
| SendSR=0
| | |The weather station model description that you want output by the web tag <#stationtype> |
| SendSoilTemp=0
| | |} |
| SendIndoor=0
| | |
| SendSoilMoisture=0
| | ===Airlink=== |
| SendLeafWetness=0
| | |
| SendAirQuality=0</pre>
| | The details in this sub-section need to be checked by someone who uses the relevant hardware. |
| | [Awekas]
| | |
| | AWEKAS
| | * Introduced Release |
| | Tick "Enabled" to see list of parameters so you can edit them
| | * File Section is [AirLink] |
| | Defaults are as shown in list of parameters
| | * Not Shown on Settings page? |
| |-
| | IsWllNode=0 |
| | <pre>Enabled=0
| | WLv2ApiKey= |
| CatchUp=1
| | WLv2ApiSecret= |
| APIkey=
| | AutoUpdateIpAddress=1 |
| StationId=
| | In-Enabled=0 |
| Interval=15</pre>
| | In-IPAddress=0.0.0.0 |
| | [OpenWeatherMap]
| | In-WLStationId=-1 |
| | OpenWeatherMap
| | In-Hostname= |
| | Tick "Enabled" to see list of parameters so you can edit them
| | Out-Enabled=0 |
| | Defaults are as shown in list of parameters
| | Out-IPAddress=0.0.0.0 |
| | Out-WLStationId=-1 |
| | Out-Hostname= |
| | AQIformula=0 |
| | {| class="wikitable" border="1" |
| |- | | |- |
| | <pre>ID= | | !style="width:30px" | Parameter Line Entry |
| Password=
| | !style="width:100px" | Shown on Settings page? |
| Enabled=0
| | !style="width:100px" | MX Section |
| Interval=15
| | !style="width:60px" | Label on Settings page |
| SendUV=0
| | !style="width:20px" | Default |
| SendSR=0
| | !style="width:600px" | Description |
| CatchUp=1</pre>
| |
| | [PWSweather]
| |
| | PWS Weather
| |
| | Tick "Enabled" to see list of parameters so you can edit them
| |
| | Defaults are as shown in list of parameters | |
| |- | | |- |
| | <pre>User= | | | |
| Password=
| | |} |
| Enabled=0
| | |
| Interval=60
| | ===Davis=== |
| OauthToken=unknown
| | |
| OauthTokenSecret=unknown
| | Two Wiki sub-sections, that need to be checked by by somebody who uses the relevant functionality: |
| TwitterSendLocation=1</pre>
| | |
| | [Twitter] | | |
| | Twitter | | ====Davis VP/VP2/Vue==== |
| | Please note that twitter is deprecated, no new settings possible, existing settings can be used by people who migrated from Cumulus 1 with working tokens | | |
| | Defaults are as shown in list of parameters | | |
| | {{Template:WorkInProgressBanner}} This table does not yet have all details in it. |
| | * Introduced for legacy Cumulus |
| | * File Section is [Station] |
| | * Only "Shown on Settings page" if either "Type=0" or "Type=1" |
| | {| class="wikitable" border="1" |
| | |- |
| | !style="width:30px" | Parameter Line Entry |
| | !style="width:60px" | Label on Settings page |
| | !style="width:120px" | Default |
| | !style="width:800px" | Description |
| | |- |
| | |style="background:lightgray;"|[Station] |
| | | |
| | | |
| | |style="background:lightgray;"|Section name - the following parameters appear in Station section |
| |- | | |- |
| | <pre>Wid= | | |VP2SleepInterval=500 |
| Key=
| | | |
| Enabled=0
| | |500 (milli-seconds) |
| Interval=10
| | |the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds. |
| SendUV=0
| | * if you suspect that data is being missed, reduce number |
| SendSR=0
| | *For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions. |
| SendAQI=0
| |
| SendSoilMoisture=0
| |
| SoilMoistureSensor=0
| |
| SendLeafWetness=0
| |
| LeafWetnessSensor=0</pre>
| |
| | [WeatherCloud] | |
| | WeatherCloud | |
| | Tick "Enabled" to see list of parameters so you can edit them | |
| | Defaults are as shown in list of parameters
| |
| |- | | |- |
| | <pre>Enabled=0 | | |VPClosedownTime=x |
| StationUID=
| | | |
| Password=
| | |(default not yet documented) |
| Interval=1
| | | x is the number of seconds after the start of the re-connect attempts that you want the program to close itself |
| SendRain=0</pre>
| |
| | [WindGuru] | |
| | Windguru | |
| | Tick "Enabled" to see list of parameters so you can edit them | |
| | Defaults are as shown in list of parameters
| |
| |- | | |- |
| | <pre>APIkey= | | |DavisCalcAltPress=1 |
| StationIdx=0
| | | |
| Enabled=0
| | |1 |
| Interval=15
| | |Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude |
| SendUV=0
| | |
| CatchUp=1</pre>
| | CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude. |
| | [Windy] | | *0 = Use SLP supplied by Davis |
| | Windy.com
| | *1 = Convert the SP Davis supplies to AP using the altitude you have supplied. |
| | Tick "Enabled" to see list of parameters so you can edit them
| |
| | Defaults are as shown in list of parameters
| |
| |- | | |- |
| | <pre>ID= | | |SyncDavisClock=0 |
| Password=
| | | |
| Enabled=0
| | |0 |
| Interval=15
| | |When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX). |
| SendUV=0
| | *0 = Disabled, default (as deselected on the Station Configuration Screen) |
| SendSR=0
| | *1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X! |
| CatchUp=1</pre>
| |
| | [WOW] | |
| | Met Office WOW | |
| | Tick "Enabled" to see list of parameters so you can edit them | |
| | Defaults are as shown in list of parameters
| |
| |}
| |
| | |
| ==Optional Web Server==
| |
| | |
| 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.
| |
| | |
| FRom 3.12.0, MX can optionally either copy files to a web server you host or file transfer files to a 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 | |
| ** If you select "Enable file copy of standard files" (default is disabled) then those settings have their "Copy" option enabled in nearly all (see any qualifier) cases, and their "FTP Transfer" option deselected (instead of defaults shown in table)
| |
| ** If you deselect "Enable file transfer of standard files" (default is enabled) then those settings have their "Copy" option disabled, and their "FTP Transfer" option enabled in nearly all (see any qualifier) cases (as per defaults shown in table) | |
| * '''The default selections assume you have air quality, and solar, sensors; so you may need to disable some of the defaults the above selections have made'''
| |
| * If you don't select '''I want to use the supplied default web site''', then all the settings marked ^ are disabled
| |
| ** This is what you want if you do not use the MX optional web server functionality
| |
| ** If you have a customised web site, you may want to select '''I want to use the supplied default web site''' to see the settings that would otherwise all be disabled, and then pick any options that would be useful to you.
| |
| {| class="wikitable" border="1"
| |
| |- | | |- |
| !style="width:30px" | Parameter Line Entry
| | |ClockSettingHour=4 |
| !style="width:100px" | File Section
| | | |
| !style="width:100px" | Introduced
| | |4 |
| !style="width:100px" | Shown on Settings page?
| | |Controls what hour of the day the SyncDavisClock activity will take place if it is enabled. |
| !style="width:100px" | MX Section
| | *4 = 04:00 (default value) |
| !style="width:60px" | Label on Settings page
| | *0-23 = 00:00 to 23:00 |
| !style="width:20px" | Default
| | |- |
| !style="width:600px" | Description
| | |VP2ConnectionType=1 |
| | | |
| | | |
| | |Weather station connection type |
| | *0 = serial (see next parameter to specify COM port) |
| | *(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis) |
| | *2 = TCP/IP (see later parameters to specify ports) |
| | Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP. |
| |- | | |- |
| | ActiveFTP=0 | | |VP2TCPPort=22222 |
| | [FTP site] | | | |
| | Legacy Cumulus | | | 2222 |
| | No | | |Communications port used if VP type has TCP/IP selected. |
| | Change directly in file as at release 3.11.x
| |
| | (n/a )
| |
| | (n/a)
| |
| | *0 = Disabled (default)
| |
| *1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
| |
| |- | | |- |
| | Copy-airquality=0 | | |VP2IPAddr=0.0.0.0 |
| | [FTP site] | | | |
| | Release 3.12.0 | | | 0.0.0.0 |
| | ^ | | |Weather station IP address if VP type has TCP/IP selected. |
| | Internet Settings → Graph File Settings | | |- |
| | airquality.json → Copy | | |VP2PeriodicDisconnectInterval=0 |
| | 0 (disabled) | | | |
| | Simple tick or not | | |0 (disable) |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too)
| | |When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect. |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
| | |
| |- | | Set it to zero to disable, if you are not using the Weatherlink site. |
| | Copy-alldailydegdaydata=0 | | |- |
| | [FTP site] | | |LogExtraSensors=0 |
| | Release 3.12.0 | | | |
| | ^ | | |0 |
| | Internet Settings → Graph File Settings
| | |This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors. |
| | alldailydegdaydata.json → Copy
| | |- |
| | 0 (disabled)
| | |UseDavisLoop2=1 |
| | Simple tick or not
| | | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailydegdaydata.json]] file to your local web server (need to select "Generate" too)
| | |1 (use Loop2) |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | |The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP. |
| |- | | *1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default. The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue. |
| | Copy-alldailyhumdata=0 | | *0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet. |
| | [FTP site] | | |
| | Release 3.12.0 | | Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX. |
| | ^
| | |- |
| | Internet Settings → Graph File Settings
| | |DavisIPResponseTime=500 |
| | alldailyhumdata.json → Copy
| | | |
| | 0 (disabled)
| | |500 |
| | Simple tick or not
| | |The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger, see Cumulus MX forum where times up to 2000ms are suggested. |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too)
| | |- |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | |ForceVPBarUpdate=0 |
| |- | | | |
| | Copy-alldailypressdata=0 | | |0 (normal) |
| | [FTP site] | | | Added in build 3042 (January 2017). |
| | Release 3.12.0 | | |
| | ^ | | The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware. |
| | Internet Settings → Graph File Settings | | |- |
| | alldailypressdata.json → Copy | | |DavisIncrementPressureDP=0 |
| | 0 (disabled) | | | |
| | Simple tick or not | | |1 |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
| | |(from version 3.0.0 build 3042) |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | * 0= Pressure values shown to 1 decimal places when reported in mb/hPa, shown to 2 decimal places for inHg |
| |- | | * 1= Pressure values shown to 2 decimal places when reported in mb/hPa, shown to 3 decimal places for inHg |
| | Copy-alldailyraindata=0 | | |- |
| | [FTP site] | | |VPrainGaugeType=0 |
| | Release 3.12.0 | | | |
| | ^
| | |1 |
| | Internet Settings → Graph File Settings
| | |Specifies the units selected on your Vantage Pro Rain Gauge. |
| | alldailyraindata.json → Copy
| | *0 = Metric Rain Adapter fitted, a 0.2mm gauge |
| | 0 (disabled)
| | *1 = Imperial gauge without adapter, a 0.01" gauge. |
| | Simple tick or not
| | Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur. |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too) | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | |
| |- | |
| | Copy-alldailysolardata=0 | |
| | [FTP site] | |
| | Release 3.12.0 | |
| | ^ | |
| | Internet Settings → Graph File Settings
| |
| | alldailysolardata.json → Copy
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too) | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
| |
| |- | | |- |
| | Copy-alldailytempdata=0 | | |DataLogging=0 |
| | [FTP site] | | | |
| | Release 3.12.0 | | |0 |
| | ^ | | |(Build 3018 onwards). |
| | Internet Settings → Graph File Settings
| | *0 (default) = Cumulus MX will not add extra logging. |
| | alldailytempdata.json → Copy
| | *1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large. |
| | 0 (disabled)
| | I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards). |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too) | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |- | | |- |
| | Copy-alldailywinddata=0 | | |AutoUpdateIpAddress=1 |
| | [FTP site] | | | |
| | Release 3.12.0 | | |1 |
| | ^
| | |default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP. |
| | Internet Settings → Graph File Settings
| |
| | alldailywinddata.json → Copy
| |
| | 0 (disabled) | |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |- | | |- |
| | Copy-alltempsumdata=0 | | |ZeroConfig |
| | [FTP site] | | | |
| | Release 3.12.0 | | |(default not known) |
| | ^ | | |set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery |
| | Internet Settings → Graph File Settings | | |} |
| | alldailytempsumdata.json → Copy
| | |
| | 0 (disabled)
| | ====Davis WeatherLink Live==== |
| | Simple tick or not
| | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailytempsumdata.json]] file to your local web server (need to select "Generate" too) | | {{Template:WorkInProgressBanner}} This table has not been populated yet |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | * Introduced in a MX beta build |
| | * File Section is [WLL] |
| | * Only "Shown on Settings page" if "Type=11" |
| | |
| | {| class="wikitable" border="1" |
| |- | | |- |
| | Copy-availabledata=0 | | !style="width:30px" | Parameter Line Entry |
| | [FTP site] | | !style="width:60px" | Label on Settings page |
| | Release 3.12.0 | | !style="width:20px" | Default |
| | ^ (once only) | | !style="width:300px" | Description |
| | Internet Settings → Graph File Settings | | |- |
| | availabledata.json → Copy | | |style="background:lightgray;"|[Station] |
| | 0 (disabled) | | | |
| | Simple tick or not | | | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[availabledata.json]] file to your local web server (need to select "Generate" too)
| | |style="background:lightgray;"|Section name - the following parameters appear in Station section |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |- | | |- |
| | Copy-dailyrain=0 | | | |
| | [FTP site] | | | |
| | Release 3.12.0 | | | |
| | ^ | | | |
| | Internet Settings → Graph File Settings | | |} |
| | dailyrain.json → Copy
| | |
| | 0 (disabled)
| | ===EasyWeather (Reading File instead of connecting to a Weather Station)=== |
| | Simple tick or not
| | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailyrain.json]] file to your local web server (need to select "Generate" too) | | This sub-section is based on what applied for the legacy software, assuming nothing has changed for MX. |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | |
| | * Introduced in a Legacy version |
| | * File Section is [Station] |
| | * MX Section is "EasyWeather File Settings" |
| | * Only "Shown on Settings page" if "Type=4" |
| | |
| | {| class="wikitable" border="1" |
| | |- |
| | !style="width:30px" | Parameter Line Entry |
| | !style="width:60px" | Label on Settings page |
| | !style="width:120px" | Default |
| | !style="width:800px" | Description |
| |- | | |- |
| | Copy-dailytemp=0 | | | EWInterval=10 |
| | [FTP site] | | | File Read Interval |
| | Release 3.12.0 | | | 10 (minutes between new line becoming available in file) |
| | ^
| | | Cumulus needs to know how often to read a new record from the easyweather.dat file. Enter any number in box. |
| | Internet Settings → Graph File Settings
| | *0= Default, meaning not applicable |
| | dailytemp.json → Copy
| | *n= any positive decimal value representing Easyweather version 6.2, or earlier, logging interval in minutes (used for reading single latest observations from [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather]] software output). Note to specify seconds, use decimal minutes, e.g. 30 seconds = 0.5 |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[dailytemp.json]] file to your local web server (need to select "Generate" too) | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |- | | |- |
| | Copy-graphconfig=0 | | | EWFile= |
| | [FTP site]
| | | Filename |
| | Release 3.12.0 | | | (empty) |
| | ^ (once only) | | | * Full file path/name for [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat or EasyWeatherPlus.dat]] |
| | Internet Settings → Graph File Settings | | * (empty) (i.e. attribute and equals sign, but no value) '''Note:''' If you want to run Cumulus without an attached weather station (because your station has a fault or because you have a second PC), it is possible to run Cumulus with station '''Type=4''' but with the default of no file specified in this parameter. The full Cumulus directory structure and its files including those in the ''data'' sub-directory are needed (kept from when your station was working or copied from the PC with the station). Although only the old observations can be accessed, (no new ones are being added), this does allow analysis of the old observations via all Cumulus features |
| | graphconfig.json → Copy | | |
| | 0 (disabled)
| | See [[FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads|FAQ here]] for reduced functionality using Cumulus 1 in this way. |
| | Simple tick or not
| | |- |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[graphconfig.json]] file to your local web server (need to select "Generate" too)
| | | EWminpressureMB=900 |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | | Minimum Pressure Value |
| | | 900 |
| | | Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars) |
| | |- |
| | | EWmaxpressureMB=1200 |
| | | Maximum Pressure Value |
| | | 1200 |
| | | Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars) |
| |- | | |- |
| | Copy-humdata=0 | | | EWMaxRainTipDiff=40 |
| | [FTP site] | | | Rain Tip Difference |
| | Release 3.12.0 | | | Default=30 tips in Cumulus 1, MX default is 40 tips |
| | ^ | | | This configurable threshold is the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips. |
| | Internet Settings → Graph File Settings | | |
| | humdata.json → Copy | | For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds. |
| | 0 (disabled) | | |
| | Simple tick or not
| | This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>. |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[humdata.json]] file to your local web server (need to select "Generate" too) | | |- |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | | EWpressureoffset=x.y |
| |- | | | Pressure Offset |
| | Copy-pressdata=0 | | | 9999 |
| | [FTP site] | | | The pressure that Cumulus MX processes is equal to what read in the file plus the value set for this parameter. Normally used to convert the station pressure to the equivalent Sea Level Pressure. |
| | Release 3.12.0 | | |} |
| | ^ | | |
| | Internet Settings → Graph File Settings | | ===Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific=== |
| | pressdata.json → Copy | | |
| | 0 (disabled) | | {{Template:WorkInProgressBanner}} An Ecowitt user needs to check/update this sub-section, it is understood significant changes are included in 3.12.0 beta builds, but the forum does not give away any details |
| | Simple tick or not | | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[pressdata.json]] file to your local web server (need to select "Generate" too)
| | * Introduced in release 3.2.0 |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | * File Section is [GW100] |
| |- | | * MX Section is "Ecowitt GW1000 Settings" |
| | Copy-raindata=0 | | * Only "Shown on Settings page" if "Type=12" |
| | [FTP site] | | {| class="wikitable" border="1" |
| | Release 3.12.0 | | |- |
| | ^ | | !style="width:30px" | Parameter Line Entry |
| | Internet Settings → Graph File Settings | | !style="width:100px" | Label on Settings page |
| | raindata.json → Copy | | !style="width:20px" | Default |
| | 0 (disabled) | | !style="width:600px" | Description |
| | Simple tick or not | | |- |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[raindata.json]] file to your local web server (need to select "Generate" too) | | |AutoUpdateIpAddress=1 |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | |Auto-discovery |
| |- | | |1 (selected) |
| | Copy-solardata=0 | | |Should MX attempt to discover IP address |
| | [FTP site] | | *0=Disable |
| | Release 3.12.0 | | *1=Enable |
| | ^ | | |- |
| | Internet Settings → Graph File Settings | | |IPAddress= |
| | solardata.json → Copy | | |IP address |
| | 0 (disabled) | | |(no default) |
| | Simple tick or not | | | stores the IP address of your GW1000 WiFi logger |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[solardata.json]] file to your local web server (need to select "Generate" too)
| | |- |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
| | |MACAddress= |
| |- | | |MAC addresss |
| | Copy-sunhours=0 | | |(no default) |
| | [FTP site] | | |Populated by MX when auto-discovery enabled |
| | Release 3.12.0 | | |} |
| | ^ | | |
| | Internet Settings → Graph File Settings
| | |
| | sunhours.json → Copy | | ===Fine Offset Stations=== |
| | |
| | * Introduced in a Legacy version |
| | * File Section is [Station] |
| | * MX Section is "Fine Offset Settings" |
| | * Only "Shown on Settings page" if either "Type=5" or "Type=7" |
| | |
| | |
| | {| class="wikitable" border="1" |
| | |- |
| | !style="width:30px" | Parameter Line Entry |
| | !style="width:100px" | Introduced |
| | !style="width:100px" | Shown on Settings page? |
| | !style="width:100px" | MX Section |
| | !style="width:60px" | Label on Settings page |
| | !style="width:20px" | Default |
| | !style="width:300px" | Description |
| | |- |
| | | FOReadAvoidPeriod=3 |
| | | MX release ?? |
| | | Only if Fine Offset selected |
| | | Station Settings → Fine Offset Advanced Settings |
| | | Read Avoid Period |
| | | 3 (seconds) |
| | | If previous setting enabled, MX will avoid reading the circular memory from the number of seconds specified before it expects Fine Offset to be writing to the circular memory, to the number of seconds specified after it expects Fine Offset to be writing to the circular memory |
| | |
| | (One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor) |
| | |- |
| | | ?? |
| | | MX release ?? |
| | | Only if Fine Offset selected |
| | | Station Settings → Fine Offset Advanced Settings |
| | | Set the Fine Offset Logger interval to match Cumulus MX interval |
| | 0 (disabled) | | | 0 (disabled) |
| | Simple tick or not | | | Simple tick or not - labelled as "Experimental - use with caution" |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[sunhours.json]] file to your local web server (need to select "Generate" too) | | * Tick (value shown as 1 in Cumulus.ini) for MX to attempt to "update the Davis interval" (I said copy and paste was used from Davis section!) to match the interval MX is using. |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) | | * Don't tick (value shown as 0 in Cumulus.ini) for no effect on your weather station |
| | |- |
| | | FineOffsetReadTime=150 |
| | | MX release ?? |
| | | Only if Fine Offset selected |
| | | Station Settings → Fine Offset Advanced Settings |
| | | Request/Read Delay |
| | | 150 (milliseconds) |
| | | Adjust time (in milliseconds) between request for read, and actual attempt to read data via USB |
| | |- |
| | | ProductID=-1 |
| | | MX release ?? |
| | | Only if Fine Offset selected |
| | | Station Settings → Fine Offset Advanced Settings |
| | | USB Product Id (PID) |
| | | -1 (default setting) |
| | | Advanced setting if you don't want to leave it to MX to find your HID |
| |- | | |- |
| | Copy-tempdata=0 | | | SyncFOReads=0 |
| | [FTP site] | | | Legacy Cumulus |
| | Release 3.12.0 | | | Only if Fine Offset selected |
| | ^
| | | Station Settings → Fine Offset Settings |
| | Internet Settings → Graph File Settings | | | Synchronise Reads |
| | tempdata.json → Copy | |
| | 0 (disabled) | | | 0 (disabled) |
| | Simple tick or not | | | Simple tick or not |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[tempdata.json]] file to your local web server (need to select "Generate" too) | | * Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | * Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data |
| |-
| | |
| | Copy-wdirdata=0
| | # The parameter was added for legacy releases, to try to reduce the occurrence of "lock-up" issues. |
| | [FTP site]
| | # MX uses a different way to interrogate Fine Offset stations, originally ticking this could result in more reads being skipped, than actually processed, potentially updating just a few times a day, so it was best disabled! |
| | Release 3.12.0
| | # The MX code relating to this parameter was rewritten 1n 3.11.0, but the developer labels this as an "attempt", so it may still be best to try to manage without enabling this setting |
| | ^
| | |- |
| | Internet Settings → Graph File Settings
| | | VendorID=-1 |
| | wdirdata.json → Copy
| | | MX release ?? |
| | 0 (disabled)
| | | Only if Fine Offset selected |
| | Simple tick or not
| | | Station Settings → Fine Offset Advanced Settings |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[wdirdata.json]] file to your local web server (need to select "Generate" too)
| | | USB Vendor Id (PID) |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | | -1 (default setting) |
| |- | | | Advanced setting if you don't want to leave it to MX to find your HID |
| | Copy-websitedata=0 | | |} |
| | [FTP site] | | |
| | Release 3.12.0
| | ===Instromet Settings=== |
| | ^ | | |
| | Internet Settings → Standard File Settings | |
| | websitedata.json → Copy | |
| | 0 (disabled) | |
| | Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]] | |
|
| |
|
| Simple tick or not
| | {{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the resulting websitedata.json to your local web server | | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | * Introduced in a Legacy version |
| |-
| | * File Section is [Station] |
| | Copy-winddata=0 | | * MX Section is "Instromet Settings" or "Instromet Advanced Options" as indicated |
| | [FTP site] | | * Only "Shown on Settings page" if either "Type=5" or "Type=7" |
| | Release 3.12.0 | | |
| | ^ | | {| class="wikitable" border="1" |
| | Internet Settings → Graph File Settings | | |- |
| | winddata.json → Copy | | !style="width:30px" | Parameter Line Entry |
| | 0 (disabled)
| | !style="width:300px" | MX Section |
| | Simple tick or not
| | !style="width:60px" | Label on Settings page |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[winddata.json]] file to your local web server (need to select "Generate" too)
| | !style="width:20px" | Default |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | !style="width:600px" | Description |
| |- | | |- |
| | Copy-wxnow=0 | | | ComportName=xxxxxx |
| | [FTP site] | | | Station Settings → Instromet Settings |
| | Release 3.12.0 | | | Serial port name |
| | ^ (disabled) | | | /dev/ttyUSB0 (on Linux), COM1 (on Microsoft Windows) |
| | Internet Settings → Standard File Settings | | | Only required if your station is connected via a real, or virtual, serial port |
| | wxnow.txt → Copy | | |- |
| | 0 (disabled)
| | |ImetBaudRate=19200 |
| | Simple tick or not | | | Station Settings → Instromet Settings |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy that file to your local web server
| | | Serial Baud Rate (DavisBaudRate) |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | | 19200 |
| |- | | | Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value |
| | CopyMoonImage=0 | | |- |
| | [FTP site] | | | "SyncDavisClock=0" and "ClockSettingHour=4" |
| | Release 3.12.0
| | | Station Settings → Instromet Advanced Options |
| | ^
| | | "Sychronise Station Clock" and "Clock sync hour" |
| | Internet Settings → Moon Image
| | | Tick box not selected, data box set to 4 |
| | Copy Moon image file | | | Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations. |
| | 0 (disabled) | | |
| | Simple tick or not | | *Simple tick or not |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy moon image file to your local web server (need to select "Generate Moon Image" too) | | ** Tick (value shown as 1 in Cumulus.ini) for MX to attempt to sychronise the Instromet Station Clock with your computer time. This ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time! |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | ** Don't tick (value shown as 0 in Cumulus.ini) if you don't want MX to attempt to keep station clock in line with computer clock |
| | * Box taking an integer |
| | ** The hour of the day when, if enabled, Cumulus will set the Instromet clock to within a minute of the same time as the computer. This will happen at a default time of 04:00 each day, (4 a.m.) unless the setting box is edited |
| |- | | |- |
| | Create-airquality=0 | | | ImetUpdateLogPointer=1 |
| | [FTP site] | | | Station Settings → Instromet Advanced Options |
| | Release 3.10.0
| | | Update logger pointer |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | airquality.json → Generate | |
| | 1 (enabled) | | | 1 (enabled) |
| | Simple tick or not | | | Simple tick or not |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the airquality.json file | | * Tick (value shown as 1 in Cumulus.ini) for MX to update the memory pointer to the last record after every 30 data reads |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | * Don't tick to disable this action |
| |- | | |- |
| | Create-alldailydegdaydata=0 | | |ImetWaitTime=500 |
| | [FTP site] | | | Station Settings → Instromet Advanced Options |
| | Release 3.10.0 | | | Delay between sending data read commands |
| | ^ | | | 500 |
| | Internet Settings → Graph File Settings | | | Specifies the time in milliseconds that Cumulus waits after one read, before it does the next read from an Instromet station. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too. |
| | alldailydegdaydata.json → Generate | | |- |
| | 1 (enabled) | | | ImetReadDelay=500 |
| | Simple tick or not | | | Station Settings → Instromet Advanced Options |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailydegdaydata.json]] file
| | | Delay after sending a command before trying to read data from the serial port |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | | 500 |
| |- | | | Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too. |
| | Create-alldailyhumdata=0
| | |} |
| | |
| | |
| | ===LaCrosse stations=== |
| | |
| | |
|
| |
|
| | [FTP site] | | {{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station |
| | Release 3.10.0 | | |
| | ^ | | |
| | Internet Settings → Graph File Settings
| | {| class="wikitable" border="1" |
| | alldailyhumdata.json → Generate
| | |- |
| | 1 (enabled) | | !style="width:30px" | Parameter Line Entry |
| | Simple tick or not | | !style="width:100px" | Shown on Settings page? |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyhumdata.json]] file
| | !style="width:100px" | File Section |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | !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 |
| | |- |
| | | LCMaxWind=X |
| | | Shown only if La Crosse was selected as station type |
| | | [Station] |
| | | 3.12.0 |
| | | Depends on release: |
| | * (Version 1.8.8 Build 874 to release 3.11.4) Need to edit manually in file directly |
| | * (Release 3.12.0 onwards) Station Settings → Common Options → Advanced Options |
| | | La Crosse max wind speed |
| | | ??? |
| | | It is setting for the La Crosse max wind speed, where X is the maximum (before calibrated by any definitions in Offsets) wind speed in m/s that you want to allow. The value you supply should be in metres/second, regardless of what wind unit you are using in Cumulus |
| | |} |
| | |
| | It is assumed that [[Cumulus.ini_(Cumulus_1)#La_Crosse_specific:|most parameters remain same]] |
| | |
| | ===Oregon Scientific WM918/WMR928 Settings=== |
| | |
| | The Oregon Scientific code has not changed since the earliest beta MX (3.0.0) builds based on moving compiled code from Cumulus 1. |
| | |
| | It appears very few current Cumulus users own these obsolete models, so all these settings have to be added directly into the file, you can't edit them in the admin interface, and they will be missing from any configuration file created by any MX release. |
| | |
| | * Introduced for legacy Cumulus, and unchanged by MX |
| | * File Section is [Station], these settings need to be manually entered into file below that section heading |
| | {| class="wikitable" border="1" |
| | |- |
| | !style="width:30px" | Parameter Line Entry |
| | !style="width:100px" | External to MX edit |
| | !style="width:20px" | Default |
| | !style="width:300px" | Description |
| |- | | |- |
| | Create-alldailypressdata=0 | | |style="background:lightgray;"|[Station] |
| | [FTP site] | | | |
| | Release 3.10.0 | | | |
| | ^ | | |style="background:lightgray;"|Section name - the following parameters appear in Station section |
| | Internet Settings → Graph File Settings | | |- |
| | alldailypressdata.json → Generate | | |Humidity98Fix=0 |
| | 1 (enabled) | | | Stop MX and add this into file |
| | Simple tick or not | | |0 (disable) |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailypressdata.json]] file | | |Applies to weather station types that never report more than 98% relative humidity. |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | *0 = Disabled (default) |
| |- | | *1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98%. Normally only useful for Oregon Scientific stations. |
| | Create-alldailyraindata=0 | | |- |
| | [FTP site] | | |LogExtraSensors=0 |
| | Release 3.10.0 | | | Stop MX and add this into file |
| | ^ | | |0 (disable) |
| | Internet Settings → Graph File Settings | | |This setting determines whether MX looks for readings from extra temperature probes etc. |
| | alldailyraindata.json → Generate | | *0=Disabled (default) |
| | 1 (enabled) | | *1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors.. |
| | Simple tick or not | | |- |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailyraindata.json]] file
| | |WMR928TempChannel=N |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | | Stop MX and add this into file |
| | |(by default no extra sensors) |
| | |for WMR-928 stations (and other serial stations using the same protocol, eg WMR-968) to use an 'extra' channel (see previous parameter) as your main temperature sensor, set N to the required channel |
| | |- |
| | |WMR200TempChannel=N |
| | | Stop MX and add this into file |
| | |(by default no extra sensors) |
| | |for WMR200 stations (and any other Oregon Scientific USB stations which work with Cumulus, e.g. WMR100) to use an 'extra' channel as your main temperature sensor, set N to the required channel |
| | |} |
| | |
| | ==Units, Derivative Options, and Decimal Places== |
| | |
| | For altitude units, please see [[#Location]]. |
| | |
| | * File Section is [Station] |
| | * Edit on Station Settings page (except where indicated in bold as another page) |
| | {| class="wikitable" border="1" |
| | |- |
| | !style="width:30px" | Parameter Line Entry |
| | !style="width:100px" | Introduced |
| | !style="width:100px" | MX Section |
| | !style="width:60px" | Label on Settings page |
| | !style="width:20px" | Default |
| | !style="width:300px" | Description |
| |- | | |- |
| | Create-alldailysolardata=0 | | | AirQualityDecimals=1 |
| | [FTP site]
| | | Release 3.9.2 |
| | Release 3.10.0 | | | Units → Advanced Options (Here be dragons!) |
| | ^ | | | Air Quality decimals |
| | Internet Settings → Graph File Settings
| | | 1 (displayed as blank) |
| | alldailysolardata.json → Generate | | | Number of decimal places for all outputs |
| | 1 (enabled) | | |- |
| | Simple tick or not | | | AvgBearingMinutes=10 |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailysolarydata.json]] file
| | | Legacy Cumulus |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
| | | Common Options → Advanced Options (Here be dragons!) |
| |- | | | Average Bearing Minutes |
| | Create-alldailytempdata=0 | | | 10 (minutes) |
| | [FTP site]
| | | This parameter's value is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing |
| | Release 3.10.0
| | |- |
| | ^ | | | AvgSpeedMinutes=10 |
| | Internet Settings → Graph File Settings | | | Legacy Cumulus |
| | alldailytempdata.json → Generate | | | Common Options → Advanced Options (Here be dragons!) |
| | 1 (enabled) | | | Average Speed Minutes |
| | Simple tick or not | | | 10 (minutes) |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempdata.json]] file
| | | This parameter's value is the number of minutes over which Cumulus averages out reported current wind speeds |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | |- |
| |- | | | CalculatedDP=0 |
| | Create-alldailywinddata=0 | | | Legacy Cumulus |
| | [FTP site]
| | | Common Options |
| | Release 3.10.0
| | | Calculate dew point |
| | ^ | | | Unticked (shown as 0 in Cumulus.ini) |
| | Internet Settings → Graph File Settings | | | Simple tick or not: |
| | alldailywinddata.json → Generate | | * Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate dew point from temperature and humidity supplied by station |
| | 1 (enabled) | | * Don't tick (value shown as 0 in Cumulus.ini) action depends on '''Calibration settings''' |
| | Simple tick or not | | ** If Cumulus has non-default multiplier and/or offset settings for temperature or humidity, Cumulus will calculate dew-point. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point. |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailywinddata.json]] file
| | ** If station provides dew point, then that will be used provided no multiplier/offsets have been specified for temperature or humidity |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |- | |
| | Create-alltempsumdata=0 | |
| | [FTP site] | |
| | Release 3.10.0 | |
| | ^ | |
| | Internet Settings → Graph File Settings | |
| | alldailytempsumdata.json → Generate
| |
| | 1 (enabled)
| |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[alldailytempsumdata.json]] file | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | |
| |-
| |
| | Create-availabledata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^ (once only)
| |
| | Internet Settings → Graph File Settings
| |
| | availabledata.json → Generate
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[availabledata.json]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | |
| |- | | |- |
| | Create-dailyrain=0 | | | CalculatedWC=1 |
| | [FTP site] | | | Legacy Cumulus |
| | Release 3.10.0 | | | Common Options |
| | ^ | | | Calculate wind chill |
| | Internet Settings → Graph File Settings | | | Unticked (shown as 0 in Cumulus.ini) |
| | dailyrain.json → File Transfer
| | | Simple tick or not: |
| | 1 (enabled)
| | * Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate wind chill from temperature and wind speed |
| | Simple tick or not | | ** Note that there is a maximum temperature, and minimum wind speed, for Cumulus to make the calculation, see [[Wind_chill]] page |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailyrain.json]] file | | * Don't tick (value shown as 0 in Cumulus.ini) action depends on other items: |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | ** If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill |
| |-
| | ** If station does NOT make a wind chill value available to Cumulus, Cumulus MX reports an error if you have not ticked this setting, (that is different to how the setting worked with the legacy software). |
| | Create-dailytemp=0
| | ** If station provides wind chill, then that value will be used provided no multiplier/offsets have been specified for temperature or wind speed. |
| | [FTP site]
| | |- |
| | Release 3.10.0
| | | ChillHourSeasonStart= |
| | ^
| | | Legacy Cumulus |
| | Internet Settings → Graph File Settings
| | | Chill Hours |
| | dailytemp.json → File Transfer
| | | Chill Season Starts |
| | 1 (enabled)
| | | Default depends on release |
| | Simple tick or not
| | * (up to 3.11.4) 10 = October |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file | | * (from 3.12.0) 4 in Southern hemisphere, 10 in Northern hemisphere |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | | The value to enter is the month number (1=January, 12=December) and the Cumulative Chill Hours Count is reset to zero on the first of the selected month |
| |- | | |- |
| | Create-graphconfig=0 | | | ChillHourThreshold= |
| | [FTP site] | | | Legacy Cumulus |
| | Release 3.10.0 | | | Chill Hours |
| | ^ (once only) | | | Chill Hours |
| | Internet Settings → Graph File Settings | | | Default depends on Temperature Units |
| | graphconfig.json → Generate
| | * Either 45 degrees Fahrenheit (equivalent to 7.22 <sup>o</sup>Celsius) |
| | 1 (enabled)
| | * Or 7 degrees Celsius (equivalent to 44.6 <sup>o</sup>Fahrenheit) |
| | Simple tick or not | | | Chill Hours are incremented by the number of (fractional) hours that the air temperature is below the threshold. In practice, Cumulus simply detects if the current temperature is below the threshold and adds an increment equivalent to the (interval) time passed since the last temperature reading. |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[graphconfig.json]] file
| | * You can put in any value you want, with a decimal place if required |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | * Some people have put in the freezing-point temperature (0<sup>o</sup>C or 32 <sup>o</sup>F) and they relabel "chill hours" to "frost hours" |
| |- | | |- |
| | Create-humdata=0 | | | CloudBaseInFeet=0 |
| | [FTP site] | | | Legacy Cumulus |
| | Release 3.10.0 | | | (As at 3.11.4, can only adjust in the file) |
| | ^ | | | |
| | Internet Settings → Graph File Settings | | | 0 (default in MX is metres) |
| | humdata.json → Generate
| | | Select units used for reporting theoretical cloud base: |
| | 1 (enabled)
| | * 0 = metres (default if file created by MX) |
| | Simple tick or not | | * 1 = feet (default if file created by legacy software) |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[humdata.json]] file
| | |- |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | | ErrorLogSpikeRemoval=1 |
| |- | | | Legacy Cumulus |
| | Create-pressdata=0 | | | '''Calibration Settings''' → Final tick box |
| | [FTP site] | | | Log spike and limit violations to error log |
| | Release 3.10.0 | | | 1 (default in MX is enabled) |
| | ^ | | | Log spike and limit violations to error log (in MX this is in [[MXdiags folder]]): |
| | Internet Settings → Graph File Settings | | * 1 = do log (default if file created by MX) |
| | pressdat.json → Generate
| | * 0 = don't log (default if file created by legacy software) |
| | 1 (enabled)
| | |- |
| | Simple tick or not | | | HourlyForecast=1 |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[pressdata.json]] file | | | Legacy Cumulus |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | | Forecast |
| |- | | | Update forecast hourly |
| | Create-raindata=0 | | | 1 (default in MX is enabled) |
| | [FTP site] | | | When Cumulus derives its Zambretti forecast |
| | Release 3.10.0 | | |
| | ^
| | Simple tick or not: |
| | Internet Settings → Graph File Settings
| | * Tick (value shown as 1 in Cumulus.ini) then MX will derive a Zambretti forecast just once an hour, on the hour |
| | raindata.json → Generate | | * Don't tick (value shown as 0 in Cumulus.ini) to derive a forecast every time MX does a process of the pressure reading |
| | 1 (enabled) | |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[raindata.json]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | |
| |- | |
| | Create-solardata=0 | |
| | [FTP site] | |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings | |
| | solardata.json → Generate | |
| | 1 (enabled) | |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[solardata.json]] file | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor) | |
| |- | | |- |
| | Create-tempdata=1 | | | Humidity98Fix=0 |
| | [FTP site]
| | | Legacy Cumulus |
| | Release 3.10.0
| | | Common Options |
| | ^ | | | Max humidity |
| | Internet Settings → Graph File Settings | | | 0 (disable) |
| | dailytemp.json → Generate | | | For any weather station that never reports a relative humidity greater than 98% |
| | 1 (enabled) | | |
| | Simple tick or not | | Simple tick or not: |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file | | * Tick (value shown as 1 in Cumulus.ini) then if weather station reading is 98%, process that as 100% for all outputs from MX |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | * Don't tick (value shown as 0 in Cumulus.ini) to always report what weather station reports for relative humidity |
| |- | | |- |
| | Create-sunhours=0 | | | PeakGustMinutes=10 |
| | [FTP site]
| | | Legacy Cumulus |
| | Release 3.10.0
| | | Common Options → Advanced Options (Here be dragons!) |
| | ^ | | | Peak wind gust time |
| | Internet Settings → Graph File Settings | | | 10 (minutes) |
| | dailytemp.json → Generate | | | MX waits until a gust has been measured for number of minutes specified by value of parameter, before checking whether previous gust extreme record have been exceeded |
| | 1 (enabled) | | |- |
| | Simple tick or not | | | PressDecimals=1 |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[dailytemp.json]] file
| | | Release 3.9.2 |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
| | | Units → Advanced Options (Here be dragons!) |
| |- | | | Pressure decimals |
| | Create-tempdata=0 | | | Default depends on Pressure Units (displayed as blank) |
| | [FTP site]
| | * default is 1 if units are hPa or mb |
| | Release 3.10.0 | | * default is 2 if units are inches of mercury |
| | ^ | | | Number of decimal places for all outputs |
| | Internet Settings → Graph File Settings
| | |- |
| | tempdata.json → Generate | | | PressureUnit=1 |
| | 1 (enabled) | | | Legacy Cumulus |
| | Simple tick or not
| | | Units |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[tempdata.json]] file | | | Pressure |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| | | Depends on release: |
| |- | | # Legacy to 3.11.4: 0 (mbar) |
| | Create-wdirdata=0 | | # 3.12.0 onwards: 1 (hPa) |
| | [FTP site] | | |
| | Release 3.10.0 | | | Drop-down: |
| | ^ | | * 0 = millibar (mb) |
| | Internet Settings → Graph File Settings | | * 1 = hectoPascals (hPa) |
| | wdirdata.json → Generate
| | * 2 = inches of mercury (in Hg) |
| | 1 (enabled)
| | |- |
| | Simple tick or not | | | RainDayThreshold= |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[wdirdata.json]] file | | | Legacy Cumulus |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | | Common Options → Advanced Options |
| |- | | | Rain day threshold |
| | Create-websitedata=0 | | | Default is -1 which depends on Rainfall Units AND station type |
| | [FTP site] | | * -1 = normally 0.2 if units are millimetres |
| | Release 3.10.0 | | * -1 = normally 0.01 if units are inches |
| | ^ | | * Otherwise enter a value in your selected units |
| | Internet Settings → Graph File Settings | | | For derivatives like count of consecutive wet/dry days, any daily rainfall less than this threshold will be ignored. |
| | websitedata.json → Generate
| |
| | 1 (enabled)
| |
| | Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]] | |
|
| |
|
| Simple tick or not
| | (If rainfall is measured in tips, usually set to just over one tip, as first tip of day might be result of less that one tip accumulated on earlier days or because of dew) |
| * Tick (value shown as 1 in Cumulus.ini) for MX to process the '''websitedataT.json''' file into websitedata.json
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Create-winddata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | winddata.json → Generate
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[winddata.json]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |- | | |- |
| | Create-wxnow=0 | | | RainDecimals=1 |
| | [FTP site]
| | | Release 3.9.2 |
| | Release 3.10.0 | | | Units → Advanced Options (Here be dragons!) |
| | ^ (disabled)
| | | Rainfall decimals |
| | (depends on release) | | | Default depends on Rainfall Units (displayed as blank) |
| * (releases 3.10.0 to 3.11.4) Internet Settings → Web/FTP Settings
| | * default is 1 if units are millimetres |
| * (release 3.12.0 on) Internet Settings → Standard File Settings
| | * default is 2 if units are inches |
| | wxnow.txt → Generate | | | Number of decimal places for all outputs |
| | 0 (disabled) | |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate a [[wsnow.txt]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | DeleteBeforeUpload=0
| |
| | [FTP site]
| |
| | legacy Cumulus
| |
| | (always)
| |
| | (depends on release)
| |
| * (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings | |
| * (release 3.12.0 on) Internet Settings → Web Site → General Settings | |
| | Delete before upload
| |
| | 0 (disabled)
| |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to delete existing file (with same name) on the web server before it creates the new file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (this is the option appropriate to most servers)
| |
| |- | | |- |
| | Directory= | | | RainSeasonStart=1 |
| | [FTP site]
| |
| | Legacy Cumulus | | | Legacy Cumulus |
| | (always) | | | Annual Rainfall |
| | Internet Settings → Web/FTP Site
| | | Start of rainfall season |
| | Remote FTP Directory | | | 1 (Jan) |
| | (blank) | | | Drop-down |
| | Directory (including path) on your server to which FTP (if 'Enabled' is enabled) will upload the files. | | * 1 = January |
| *value is left Blank, default, the root position specified by ftp server | | * 2 = February |
| *A path from the starting point as the position specified by ftp server | | * 3 = March |
| | ... |
| | * 9 = September |
| | * 10 = October |
| | * 11 = November |
| | * 12 = December |
| | |
| | Added in late 2010 because Cumulus users in Israel said they do not total rainfall from January. |
|
| |
|
| Not used for ExtraRemoteNN parameters
| | It was welcomed by people outside Israel, it turned out growers are often interested in a growing season rainfall total |
| |- | | |- |
| | DisableEPSV=0 | | | RainUnit=0 |
| | [FTP site] | | | Legacy Cumulus |
| | Beta Release 3.0.0 build 3045 | | | Units |
| | No | | | Rain |
| | Still Change directly in file as at release 3.11.x
| | | 0 (mm) |
| | (n/a ) | | | Drop-down: |
| | 0 | | * 0 = millimetres |
| | *0 = Disabled (default)
| | * 1 = inches |
| *1 = Enabled, to use Extended Passive FTP-mode | |
| |- | | |- |
| | DisableFtpsExplicit=0 | | | RoundWindSpeed=0 |
| | [FTP site] | | | Legacy Cumulus |
| | Release 3.4.0 - Build 3064 | | | Common Options |
| | No | | | Rounding of wind speed |
| | Change directly in file as at release 3.11.x
| | | 0 (no) |
| | (n/a )
| | | Simple tick or not, (only applicable if any reported wind speed would otherwise include decimal places): |
| | 0 | | * Tick (value shown as 1 in Cumulus.ini) then Cumulus will round all the wind speeds it reports to nearest integer |
| | (change value following attribute)
| | * Don't tick (value shown as 0 in Cumulus.ini) then Cumulus will report wind speeds to the precision defined in "WindSpeedDecimals", "WindSpeedAvgDecimals", and "WindRunDecimals", parameters |
| *0 = Disabled (default) use FTPS Explicit mode
| |
| *1 = Enabled, to use FTPS Implicit mode
| |
| |-
| |
| | Enabled=1
| |
| | [FTP site]
| |
| | Release 3.12.0
| |
| | (always) Controls whether ^ settings have "File Transfer" option enabled
| |
| | Internet Settings → Interval Configuration
| |
| | Enable file transfer of standard files
| |
| | 1 (enabled)
| |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to enable file transfer of standard files (see rows marked ^ for further selections) | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | |
| |- | | |- |
| | EnableLocalCopy=0 | | | SunshineHrsDecimals=2 |
| | [FTP site]
| | | Release 3.8.0 |
| | Release 3.12.0 | | | Units → Advanced Options (Here be dragons!) |
| | (always) Controls whether ^ settings have "Copy" option enabled | | | Sunshine hours decimals |
| | Internet Settings → Interval Configuration
| | | 2 (displayed as blank) |
| | 0 (disabled)
| | | Select a number of decimal places to overwrite the default |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to enable copying of files (see rows marked ^ for further selections)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |- | | |- |
| | EnableRealtime=1 | | | TempDecimals=1 |
| | [FTP site] | | | Release 3.9.2 |
| | Legacy Cumulus | | | Units → Advanced Options (Here be dragons!) |
| | (always) | | | Temperature decimals |
| | Internet Settings → Realtime Settings | | | 1 (displayed as blank) |
| | Enable Realtime | | | Select a number of decimal places to overwrite the default |
| | |- |
| | | TempUnit=0 |
| | | Legacy Cumulus |
| | | Units |
| | | Temperature |
| | | 0 (<sup>o</sup>C |
| | | Drop-down: |
| | * 0 = Celsius |
| | * 1 = Fahrenheit |
| | |- |
| | | UseCumulusForecast=0 |
| | | Legacy Cumulus |
| | | Forecast |
| | | Use Cumulus Forecast |
| | 0 (disabled) | | | 0 (disabled) |
| | Simple tick or not | | | Simple tick or not: |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate a timer that will permit real time actions | | * Tick (value shown as 1 in Cumulus.ini) then Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, or as an alternative to the one supplied by your station. Please see [[Forecast_webtag]] for details. |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | * Don't tick (value shown as 0 in Cumulus.ini) then MX will not do any forecasting, so it will return "not available" unless your weather station provides an alternative forecast |
| |- | | |- |
| | Ftp-airquality=0 | | | UseCumulusPresstrendstr=0 |
| | [FTP site] | | | Legacy Cumulus |
| | Release 3.10.0 | | | Common Options |
| | ^ | | | Cumulus pressure trend names |
| | Internet Settings → Graph File Settings | | | 0 (depends on weather station type) |
| | airquality.json → File Transfer
| | | Simple tick or not: |
| | 1 (enabled)
| | * Tick (value shown as 1 in Cumulus.ini) then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]]. |
| | Simple tick or not | | * Don't tick (value shown as 0 in Cumulus.ini) then effect depends on whether your weather station supplies pressure trends |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the airquality.json file to your local web server (need to select "Generate" too) | | ** If your station does supply pressure trends, then MX will use those |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor) | | ** If your station does not supply pressure trends, then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]]. |
| |- | | |- |
| | Ftp-alldailydegdaydata=0 | | | UseSpeedForAvgCalc=0 |
| | [FTP site] | | | Legacy Cumulus |
| | Release 3.10.0 | | | Common Options |
| | ^ | | | Use speed for average calculation |
| | Internet Settings → Graph File Settings | | | 0 (disable) |
| | alldailydegdaydata.json → File Transfer
| | | Simple tick or not: |
| | 1 (enabled)
| | * Tick (value shown as 1 in Cumulus.ini) then MX will use what the weather station supplies as "wind speed" to calculate the average wind speed. |
| | Simple tick or not | | * Don't tick (value shown as 0 in Cumulus.ini) then MX will use what the weather station supplies as "latest wind speed" to calculate the average wind speed |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the alldailydegdaydata.json file to your local web server (need to select "Generate" too) | | Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details. |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | | |- |
| |- | | | UseZeroBearing=1 |
| | Ftp-alldailyhumdata=0 | | | Legacy Software |
| | [FTP site] | | | Common Options |
| | Release 3.10.0 | | | Use bearing zero when calm |
| | ^ | | | 1 (enable) |
| | Internet Settings → Graph File Settings
| | | Simple tick or not: |
| | alldailyhumdata.json → File Transfer
| | * Tick (value shown as 1 in Cumulus.ini) then MX will report a wind bearing of zero when the wind is calm |
| | 1 (enabled) | | * Don't tick (value shown as 0 in Cumulus.ini) then MX will continue to report the last wind bearing when the wind stops blowing |
| | Simple tick or not | |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too) | |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable | |
| |-
| |
| | Ftp-alldailypressdata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | alldailypressdata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-alldailyraindata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | alldailyraindata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-alldailysolardata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | alldailysolardata.json → File Transfer
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
| |
| |-
| |
| | Ftp-alldailytempdata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | alldailytempdata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailytempdata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-alldailywinddata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | alldailywinddata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alldailywinddata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-alltempsumdata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | alltempsumdata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[alltempsumdata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-availabledata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^ (once only)
| |
| | Internet Settings → Graph File Settings
| |
| | availabledata.json → File Transfer
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[availabledata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-dailyrain=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | dailyrain.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-dailytemp=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | dailyrain.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-graphconfig=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^ (once only)
| |
| | Internet Settings → Graph File Settings
| |
| | graphconfig.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[graphconfig.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-humdata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | humdata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[humdata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-pressdata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | pressdata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[pressdata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-raindata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | raindata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[raindata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-solardata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | solardata.json → File Transfer
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[solardata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
| |
| |-
| |
| | Ftp-sunhours=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | sunhours.json → File Transfer
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[sunhours.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
| |
| |-
| |
| | Ftp-tempdata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | tempdata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[tempdata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-wdirdata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | wdirdata.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[wdirdata.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-websitedata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Standard File Settings
| |
| | websitedata.json → File Transfer
| |
| | 0 (disabled)
| |
| | Relates to asking MX to process the [[websitedataT.json]] file in [[web folder]]
| |
| | |
| Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the resulting websitedata.json to your local web server
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-winddata=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Graph File Settings
| |
| | dailyrain.json → File Transfer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[dailyrain.json]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | Ftp-wxnow=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^ (disabled)
| |
| | (depends on release)
| |
| * (release 3.10.0 to 3.11.4) Internet Settings → Web/FTP Settings
| |
| * (release 3.12.0 on) Internet Settings → Standard File Settings
| |
| | wxnow.txt → File Transfer
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer that file to your local web server
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | ForumURL=
| |
| | [Web Site]
| |
| | Legacy Cumulus
| |
| | (always)
| |
| | (depends on release)
| |
| * (releases 3.0.0 to 3.11.4) Internet Settings → Web Site
| |
| * (release 3.12.0 on) Internet Settings → Miscellaneous
| |
| | Forum URL
| |
| | (blank)
| |
| | Left blank to allow you to choose format
| |
| | |
| 3.10.0 Default web pages use "<a href=\"https://cumulus.hosiene.co.uk/index.php\">forum</a>"
| |
| | |
| Some alternative URL examples:
| |
| *https://cumulus.hosiene.co.uk/index.php (for above example in default web pages)
| |
| *https://cumulus.hosiene.co.uk
| |
| *https://cumulus.hosiene.co.uk/search.php?search_id=active_topics
| |
| |-
| |
| | FTPlogging=0
| |
| | [FTP site]
| |
| | Legacy Cumulus
| |
| | FTP logging
| |
| | Depends on release installed:
| |
| # (Releases 3.1.0 to 3.10.5) Internet Settings → → Web Settings → General Settings
| |
| # (Releases 3.11.0 to 3.11.4) Program Settings → Program General Options
| |
| # (Release 3.12.0 onwards) Program Settings → Logging Options
| |
| | (n/a)
| |
| | (n/a)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX in standard FTP mode add output to [[ftplog.txt]].
| |
| to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable updates to '''ftplog.txt'''
| |
| For other types of file transfer (STTP, FTPS), any extra diagnostic information appears in latest log in [[MXdiags folder]]
| |
| |-
| |
| | FTPRename=1
| |
| | [FTP site]
| |
| | Legacy Cumulus
| |
| | (always)
| |
| | (depends on release)
| |
| * (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings
| |
| * (release 3.12.0 on) Internet Settings → Web Site → General Settings
| |
| | FTP rename
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name (this is the option appropriate to most servers)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| The chief advantage of using rename is that it minimises the time that the web server cannot serve a file (while it is being updated)
| |
| |-
| |
| | Host=
| |
| | [FTP site]
| |
| | Legacy Cumulus
| |
| | (always)
| |
| | Internet Settings → Web/FTP Site
| |
| | Host name
| |
| | (blank)
| |
| | This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site.
| |
| |-
| |
| | IncludeMoonImage=1
| |
| | [FTP site]
| |
| | Release 3.5.0
| |
| | (always)
| |
| | Internet Settings → Moon Image
| |
| | Upload Moon image file
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer moon image file to your local web server (need to select "Generate Moon Image" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| |IntervalFtpEnabled=1
| |
| | [FTP site]
| |
| | Release 3.12.0
| |
| | ??
| |
| | Internet Settings → Interval Settings
| |
| | Enable file transfer update interval
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file transfer actions
| |
| * Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected '''LocalCopyEnabled''' (see below)
| |
| |-
| |
| | ListWebTags=0
| |
| | [Station]
| |
| | Legacy Cumulus
| |
| | Only from Release 3.12.0
| |
| | Depends on release:
| |
| * (3.5.1 to 3.11.4) Manual edit of file
| |
| * (3.12.0 onwards) Station settings → Common Options → Advanced options
| |
| | 0
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to create ''WebTags.txt'' file when Cumulus is restarted (contains an unordered list of all the tag names your Cumulus build will recognise and process)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | LocalCopyEnabled=0
| |
| | [FTP site]
| |
| | Release 3.12.0
| |
| | (always)
| |
| | Internet Settings → Interval Configuration
| |
| | Enable local copy update interval
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file copy actions
| |
| * Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected file transfer '''IntervalFtpEnabled''' (see previous)
| |
| |-
| |
| | LocalCopyFolder=
| |
| | [FTP site]
| |
| | Release 3.12.0
| |
| | (always)
| |
| | Internet Settings → Interval Configuration
| |
| | (blank)
| |
| | Folder (including path) to which MX will copy the standard files (see rows marked ^ for further selections) if 'EnableLocalCopy' is enabled
| |
| |-
| |
| | Password=
| |
| | [FTP site]
| |
| | Legacy Cumulus
| |
| | (always)
| |
| | Internet Settings → Web/FTP Site
| |
| | Password
| |
| | (blank)
| |
| | The password for your FTP/SFTP/FTPS connection (masked out on settings page, shown in plain text in file)
| |
| |-
| |
| | Port=21
| |
| | [FTP site]
| |
| | Legacy Cumulus
| |
| | (always)
| |
| | Internet Settings → Web/FTP Site
| |
| | FTP port
| |
| | 21 (plain FTP)
| |
| |you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative protocol and/or alternative ports.
| |
| |-
| |
| | RealtimeFTPEnabled=0
| |
| | [FTP site]
| |
| | Legacy Cumulus
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | Enable realtime FTP
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to be able to do file transfers at real-time interval
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | RealtimeGaugesTxtCopy=0
| |
| | [FTP site]
| |
| | Release 3.12.0
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | realtimegauges.txt
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[SteelSeries_Gauges|realtimegauges.txt]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | RealtimeGaugesTxtCreate=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | realtimegauges.txt → Generate
| |
| | 0
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[SteelSeries_Gauges|realtimegauges.txt]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | RealtimeGaugesTxtFTP=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | realtimegauges.txt → File Transfer
| |
| | 0
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[SteelSeries_Gauges|realtimegauges.txt]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | RealtimeInterval=45000
| |
| | [FTP site]
| |
| | Legacy Cumulus
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | Realtime interval
| |
| | 45000 milliseconds (45 seconds)
| |
| | Enter interval time in seconds (decimals allowed), stored in file converted to milliseconds
| |
| |-
| |
| | RealtimeTxtCopy=0
| |
| | [FTP site]
| |
| | Release 3.12.0
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | realtime.txt
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[realtime.txt]] file to your local web server (need to select "Generate" too)
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | RealtimeTxtCreate=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | realtime.txt → Generate
| |
| | 0
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to generate the [[realtime.txt]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | RealtimeTxtFTP=0
| |
| | [FTP site]
| |
| | Release 3.10.0
| |
| | ^
| |
| | Internet Settings → Realtime Settings
| |
| | realtime.txt → File Transfer
| |
| | 0
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[realtime.txt]] file
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to disable
| |
| |-
| |
| | RecordSetTimeoutHrs=24
| |
| | [Station]
| |
| | Release 3.5.1
| |
| | Only from Release 3.12.0
| |
| | Depends on release:
| |
| * (3.5.1 to 3.11.4) Manual edit of file
| |
| * (3.12.0 onwards) '''Two places''':
| |
| *# Station setings → General Settings → Advanced options
| |
| *# Station settings → Common Options → Advanced options
| |
| | Depends on where changed (respectively):
| |
| # New record timeout
| |
| # Record set timeout
| |
| | 24
| |
| | Number of hours before the following web tags are reset: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet, LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet, HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet
| |
| |-
| |
| | Sslftp=
| |
| | [FTP site]
| |
| | MX beta
| |
| | (always)
| |
| | Internet Settings → Web/FTP Site
| |
| | Select the FTP Protocol to use
| |
| | 0
| |
| | Drop down list:
| |
| * 0 = FTP (plain old FTP) - default
| |
| * 1 = Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) for FTP (FTPS)
| |
| * 2 = Use Secure Shell Home (SSH) for FTP (SFTP)
| |
| |-
| |
| | SshFtpAuthentication=Password
| |
| | [FTP site]
| |
| | Release 3.8.2 - build 3092
| |
| | Only if SFTP selected above
| |
| | Internet Settings → Web/FTP Site
| |
| | SFTP Authentication method
| |
| | Password
| |
| |Drop down list:
| |
| * 0 = Password
| |
| * 1 = Pre-shared key
| |
| * 2 = Password or pre-shared key
| |
| |-
| |
| | SshFtpPskFile=
| |
| | [FTP site]
| |
| | Release 3.8.2 - build 3092
| |
| | only if 1 or 2 selected in previous setting
| |
| | Internet Settings → Web/FTP Site
| |
| | Pre-shared Private Key file for SFTP
| |
| | (blank)
| |
| | Filename for your private PSK file, include the full path if the file is not in same folder as CumulusMX.exe
| |
| |-
| |
| | UpdateInterval=60
| |
| | [FTP site]
| |
| | legacy software
| |
| | ^
| |
| | Internet Settings → Interval Settings
| |
| | Web interval
| |
| | 60
| |
| | Interval between standard web updates in minutes
| |
| |-
| |
| | Username=
| |
| | [FTP site]
| |
| | legacy software
| |
| | (always)
| |
| | Internet Settings → Web/FTP Site
| |
| | Username
| |
| | (blank)
| |
| | the user name for connecting to your server
| |
| |-
| |
| | UTF8encode=
| |
| | [FTP site]
| |
| | legacy software
| |
| | (always)
| |
| | (depends on release)
| |
| * (releases 3.0.0 to 3.11.4) Internet Settings → Web Settings → General Settings
| |
| * (release 3.12.0 on) Internet Settings → Web Site → General Settings
| |
| | UTF-8 encoding
| |
| | Default depends on release:
| |
| * (Legacy versions and MX up to 3.9.7) 0 (ISO 8859-1 character set)
| |
| * (Release 3.10.0 on) 1 (UTF-8 encoding enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to use [[Reports_folder#Encoding|'''UTF-8''' encoding]] in all [[:Category:JSON Files|.json files]]
| |
| * Don't tick (value shown as 0 in Cumulus.ini) and MX will create its .json files using '''ISO 8859-1 character set''', ''please note that this encoding is incompatible with [[New_Default_Web_Site_Information#Installing_the_new_template_for_new_users|web pages]] included in '''webfiles''' folder''; so if you upgrade from an earlier release, you may need to change this setting
| |
| |-
| |
| |WebcamURL=
| |
| | [Web Site]
| |
| | Legacy Software
| |
| | (always)
| |
| | (depends on release)
| |
| * (releases 3.0.0 to 3.11.4) Internet Settings → Web Site
| |
| * (release 3.12.0 on) Internet Settings → Miscellaneous
| |
| | Webcam URL
| |
| | (blank)
| |
| | Can be used to add a link to any other web page, you have on any web server. In default web pages will be labelled as "web cam", but for your own web pages, this might lead to a home or blog page.
| |
| |}
| |
| | |
| ==Program Start-up Options==
| |
| | |
| * Introduced release 3.9.4 - b3099
| |
| * File Section is [Program]
| |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:160px" | MX Section
| |
| !style="width:160px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:600px" | Description
| |
| |-
| |
| |StartupPingHost=
| |
| | Program Settings → Program Start-up Options
| |
| |Host to PING on program start-up
| |
| |None (no remote host)
| |
| | Add a hostname or IP to address to ping at startup. Cumulus waits until the ping is successful before trying to read from your station. Leave blank to disable
| |
| |-
| |
| |StartupPingEscapeTime=999
| |
| | Program Settings → Program Start-up Options
| |
| |PING escape time (mins)
| |
| |999 (minutes)
| |
| |Specify a time after which if no ping response is received carry on starting Cumulus MX anyway
| |
| |-
| |
| |StartupDelaySecs=0
| |
| | Program Settings → Program Start-up Options
| |
| |Start-up Delay (secs)
| |
| |zero (no delay)
| |
| |Add a delay before the Cumulus tries to start reading the station.
| |
| |-
| |
| |StartupDelayMaxUptime=300
| |
| | Program Settings → Program Start-up Options
| |
| |Max system uptime to apply the start-up delay
| |
| |300 (seconds equivalent to 5 minutes)
| |
| |The time that has passed sice MX was started (up-time) is compared against the (max delay time) figure here.
| |
| *If max delay time less than up-time, the delay specified in previous parameter will NOT be applied
| |
| *If up-time less than this max delay time, then MX will apply any delay specified in previous parameter
| |
| *If this parameter is set to zero, then MX will always apply any delay specified in previous parameter
| |
| |}
| |
| | |
| ==Proxy==
| |
| | |
| This is a continuation of an experimental legacy Cumulus software feature, please see [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=728 here for request] and see [[Cumulus.ini_(Cumulus_1)#Proxies|here]] for potential content. I have not seen any evidence that this feature ever came out of beta, and nobody has ever commented on its use, so I see no reason to do any further documentation.
| |
| | |
| ==Station specific alternatives==
| |
| | |
| A number of settings are shown only for specific station types, and so the following tables are grouped here.
| |
| | |
| Since MX is being developed by someone who uses a Davis station, a lot of "Labels on the Settings Screens" mention "Davis" even if you have selected a different station, because the code was written by copy and paste!
| |
| | |
| ===Selecting the weather station type determines which options are shown===
| |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:100px" | File Section
| |
| !style="width:100px" | Introduced
| |
| !style="width:100px" | MX Section
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:800px" | Description
| |
| |-
| |
| |Type= -1
| |
| | [Station]
| |
| | 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0)
| |
| | Station Settings → General Settings
| |
| | Station type
| |
| | -1 (not yet defined)
| |
| | Drop-down
| |
| * -1 = "Select Station", shown before a selection from those below is made
| |
| * 0 = Davis Vantage Pro station
| |
| * 1 = Davis Vantage Pro2 or Vue station
| |
| * 2 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wireless connection (e.g. WMR-928 station)
| |
| * 3 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wired connection (e.g. WM-918 station)
| |
| * 4 = Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
| |
| '''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.
| |
| * 5 = Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] ('''without''' solar measurement sensors (with or without solar recharging))
| |
| * 6 = For all La Crosse WS23xx models e.g. WS2300
| |
| * 7 = Fine Offset/Watson/MyDel etc '''with Solar Sensors''' as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]].
| |
| * 8 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR100
| |
| * 9 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR200
| |
| * 10 = Instromet (with optional extra solar sensors or without)
| |
| * 11 = Davis WLL
| |
| * 12 = Ecowitt GW1000 and Froggit DP1500 (and any equivalents)
| |
| | |
| '''Selection made here determines what MX sections appear on the Station Settings page
| |
| |-
| |
| | Model=
| |
| | [Station]
| |
| | Early legacy version
| |
| | Station Settings → General Settings
| |
| | Station model
| |
| | (empty)
| |
| |The weather station model description that you want output by the web tag <#stationtype>
| |
| |}
| |
| | |
| ===Airlink===
| |
| | |
| The details in this sub-section need to be checked by someone who uses the relevant hardware.
| |
| | |
| * Introduced Release
| |
| * File Section is [AirLink]
| |
| * Not Shown on Settings page?
| |
| IsWllNode=0
| |
| WLv2ApiKey=
| |
| WLv2ApiSecret=
| |
| AutoUpdateIpAddress=1
| |
| In-Enabled=0
| |
| In-IPAddress=0.0.0.0
| |
| In-WLStationId=-1
| |
| In-Hostname=
| |
| Out-Enabled=0
| |
| Out-IPAddress=0.0.0.0
| |
| Out-WLStationId=-1
| |
| Out-Hostname=
| |
| AQIformula=0
| |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:100px" | Shown on Settings page?
| |
| !style="width:100px" | MX Section
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:600px" | Description
| |
| |-
| |
| |
| |
| |}
| |
| | |
| ===Davis===
| |
| | |
| Two Wiki sub-sections, that need to be checked by by somebody who uses the relevant functionality:
| |
| | |
| | |
| ====Davis VP/VP2/Vue====
| |
| | |
| | |
| {{Template:WorkInProgressBanner}} This table does not yet have all details in it.
| |
| * Introduced for leagacy Cumulus
| |
| * File Section is [Station]
| |
| * Only "Shown on Settings page" if either "Type=0" or "Type=1"
| |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:120px" | Default
| |
| !style="width:800px" | Description
| |
| |-
| |
| |style="background:lightgray;"|[Station]
| |
| |
| |
| |
| |
| |style="background:lightgray;"|Section name - the following parameters appear in Station section
| |
| |-
| |
| |VP2SleepInterval=500
| |
| |
| |
| |500 (milli-seconds)
| |
| |the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds.
| |
| * if you suspect that data is being missed, reduce number
| |
| *For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
| |
| |-
| |
| |VPClosedownTime=x
| |
| |
| |
| |(default not yet documented)
| |
| | x is the number of seconds after the start of the re-connect attempts that you want the program to close itself
| |
| |-
| |
| |DavisCalcAltPress=1
| |
| |
| |
| |1
| |
| |Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude
| |
| | |
| CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.
| |
| *0 = Use SLP supplied by Davis
| |
| *1 = Convert the SP Davis supplies to AP using the altitude you have supplied.
| |
| |-
| |
| |SyncDavisClock=0
| |
| |
| |
| |0
| |
| |When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
| |
| *0 = Disabled, default (as deselected on the Station Configuration Screen)
| |
| *1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
| |
| |-
| |
| |ClockSettingHour=4
| |
| |
| |
| |4
| |
| |Controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
| |
| *4 = 04:00 (default value)
| |
| *0-23 = 00:00 to 23:00
| |
| |-
| |
| |VP2ConnectionType=1
| |
| |
| |
| |
| |
| |Weather station connection type
| |
| *0 = serial (see next parameter to specify COM port)
| |
| *(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
| |
| *2 = TCP/IP (see later parameters to specify ports)
| |
| Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
| |
| |-
| |
| |VP2TCPPort=22222
| |
| |
| |
| | 2222
| |
| |Communications port used if VP type has TCP/IP selected.
| |
| |-
| |
| |VP2IPAddr=0.0.0.0
| |
| |
| |
| | 0.0.0.0
| |
| |Weather station IP address if VP type has TCP/IP selected.
| |
| |-
| |
| |VP2PeriodicDisconnectInterval=0
| |
| |
| |
| |0 (disable)
| |
| |When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.
| |
| | |
| Set it to zero to disable, if you are not using the Weatherlink site.
| |
| |-
| |
| |LogExtraSensors=0
| |
| |
| |
| |0
| |
| |This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
| |
| |-
| |
| |UseDavisLoop2=1
| |
| |
| |
| |1 (use Loop2)
| |
| |The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
| |
| *1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default. The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
| |
| *0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.
| |
| | |
| Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.
| |
| |-
| |
| |DavisIPResponseTime=500
| |
| |
| |
| |500
| |
| |The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger, see Cumulus MX forum where times up to 2000ms are suggested.
| |
| |-
| |
| |ForceVPBarUpdate=0
| |
| |
| |
| |0 (normal)
| |
| | Added in build 3042 (January 2017).
| |
| | |
| The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
| |
| |-
| |
| |DavisIncrementPressureDP=0
| |
| |
| |
| |1
| |
| |(from version 3.0.0 build 3042)
| |
| * 0= Pressure values shown to 1 decimal places when reported in mb/hPa, shown to 2 decimal places for inHg
| |
| * 1= Pressure values shown to 2 decimal places when reported in mb/hPa, shown to 3 decimal places for inHg
| |
| |-
| |
| |VPrainGaugeType=0
| |
| |
| |
| |1
| |
| |Specifies the units selected on your Vantage Pro Rain Gauge.
| |
| *0 = Metric Rain Adapter fitted, a 0.2mm gauge
| |
| *1 = Imperial gauge without adapter, a 0.01" gauge.
| |
| Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur.
| |
| |-
| |
| |DataLogging=0
| |
| |
| |
| |0
| |
| |(Build 3018 onwards).
| |
| *0 (default) = Cumulus MX will not add extra logging.
| |
| *1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large.
| |
| I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards).
| |
| |-
| |
| |AutoUpdateIpAddress=1
| |
| |
| |
| |1
| |
| |default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
| |
| |-
| |
| |ZeroConfig
| |
| |
| |
| |(default not known)
| |
| |set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
| |
| |}
| |
| | |
| ====Davis WeatherLink Live====
| |
| | |
| {{Template:WorkInProgressBanner}} This table has not been populated yet
| |
| * Introduced in a MX beta build
| |
| * File Section is [WLL]
| |
| * Only "Shown on Settings page" if "Type=11"
| |
| | |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:300px" | Description
| |
| |-
| |
| |style="background:lightgray;"|[Station]
| |
| |
| |
| |
| |
| |style="background:lightgray;"|Section name - the following parameters appear in Station section
| |
| |-
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |}
| |
| | |
| ===EasyWeather (Reading File instead of connecting to a Weather Station)===
| |
| | |
| This sub-section is based on what applied for the legacy software, assuming nothing has changed for MX.
| |
| | |
| * Introduced in a Legacy version
| |
| * File Section is [Station]
| |
| * MX Section is "EasyWeather File Settings"
| |
| * Only "Shown on Settings page" if "Type=4"
| |
| | |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:120px" | Default
| |
| !style="width:800px" | Description
| |
| |-
| |
| | EWInterval=10
| |
| | File Read Interval
| |
| | 10 (minutes between new line becoming available in file)
| |
| | Cumulus needs to know how often to read a new record from the easyweather.dat file. Enter any number in box.
| |
| *0= Default, meaning not applicable
| |
| *n= any positive decimal value representing Easyweather version 6.2, or earlier, logging interval in minutes (used for reading single latest observations from [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather]] software output). Note to specify seconds, use decimal minutes, e.g. 30 seconds = 0.5
| |
| |-
| |
| | EWFile=
| |
| | Filename
| |
| | (empty)
| |
| | * Full file path/name for [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat or EasyWeatherPlus.dat]]
| |
| * (empty) (i.e. attribute and equals sign, but no value) '''Note:''' If you want to run Cumulus without an attached weather station (because your station has a fault or because you have a second PC), it is possible to run Cumulus with station '''Type=4''' but with the default of no file specified in this parameter. The full Cumulus directory structure and its files including those in the ''data'' sub-directory are needed (kept from when your station was working or copied from the PC with the station). Although only the old observations can be accessed, (no new ones are being added), this does allow analysis of the old observations via all Cumulus features
| |
| | |
| See [[FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads|FAQ here]] for reduced functionality using Cumulus 1 in this way.
| |
| |-
| |
| | EWminpressureMB=900
| |
| | Minimum Pressure Value
| |
| | 900
| |
| | Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
| |
| |-
| |
| | EWmaxpressureMB=1200
| |
| | Maximum Pressure Value
| |
| | 1200
| |
| | Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars)
| |
| |-
| |
| | EWMaxRainTipDiff=40
| |
| | Rain Tip Difference
| |
| | Default=30 tips in Cumulus 1, MX default is 40 tips
| |
| | This configurable threshold is the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips.
| |
| | |
| For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds.
| |
| | |
| This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>.
| |
| |-
| |
| | EWpressureoffset=x.y
| |
| | Pressure Offset
| |
| | 9999
| |
| | The pressure that Cumulus MX processes is equal to what read in the file plus the value set for this parameter. Normally used to convert the station pressure to the equivalent Sea Level Pressure.
| |
| |}
| |
| | |
| ===Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific===
| |
| | |
| {{Template:WorkInProgressBanner}} An Ecowitt user needs to check/update this sub-section, it is understood significant changes are included in 3.12.0 beta builds, but the forum does not give away any details
| |
| | |
| * Introduced in release 3.2.0
| |
| * File Section is [GW100]
| |
| * MX Section is "Ecowitt GW1000 Settings"
| |
| * Only "Shown on Settings page" if "Type=12"
| |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:100px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:600px" | Description
| |
| |-
| |
| |AutoUpdateIpAddress=1
| |
| |Auto-discovery
| |
| |1 (selected)
| |
| |Should MX attempt to discover IP address
| |
| *0=Disable
| |
| *1=Enable
| |
| |-
| |
| |IPAddress=
| |
| |IP address
| |
| |(no default)
| |
| | stores the IP address of your GW1000 WiFi logger
| |
| |-
| |
| |MACAddress=
| |
| |MAC addresss
| |
| |(no default)
| |
| |Populated by MX when auto-discovery enabled
| |
| |}
| |
| | |
| | |
| ===Fine Offset Stations===
| |
| | |
| * Introduced in a Legacy version
| |
| * File Section is [Station]
| |
| * MX Section is "Fine Offset Settings"
| |
| * Only "Shown on Settings page" if either "Type=5" or "Type=7"
| |
| | |
| | |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:100px" | Introduced
| |
| !style="width:100px" | Shown on Settings page?
| |
| !style="width:100px" | MX Section
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:300px" | Description
| |
| |-
| |
| | FOReadAvoidPeriod=3
| |
| | MX release ??
| |
| | Only if Fine Offset selected
| |
| | Station Settings → Fine Offset Advanced Settings
| |
| | Read Avoid Period
| |
| | 3 (seconds)
| |
| | If previous setting enabled, MX will avoid reading the circular memory from the number of seconds specified before it expects Fine Offset to be writing to the circular memory, to the number of seconds specified after it expects Fine Offset to be writing to the circular memory
| |
| | |
| (One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor)
| |
| |-
| |
| | ??
| |
| | MX release ??
| |
| | Only if Fine Offset selected
| |
| | Station Settings → Fine Offset Advanced Settings
| |
| | Set the Fine Offset Logger interval to match Cumulus MX interval
| |
| | 0 (disabled)
| |
| | Simple tick or not - labelled as "Experimental - use with caution"
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to attempt to "update the Davis interval" (I said copy and paste was used from Davis section!) to match the interval MX is using.
| |
| * Don't tick (value shown as 0 in Cumulus.ini) for no effect on your weather station
| |
| |-
| |
| | FineOffsetReadTime=150
| |
| | MX release ??
| |
| | Only if Fine Offset selected
| |
| | Station Settings → Fine Offset Advanced Settings
| |
| | Request/Read Delay
| |
| | 150 (milliseconds)
| |
| | Adjust time (in milliseconds) between request for read, and actual attempt to read data via USB
| |
| |-
| |
| | ProductID=-1
| |
| | MX release ??
| |
| | Only if Fine Offset selected
| |
| | Station Settings → Fine Offset Advanced Settings
| |
| | USB Product Id (PID)
| |
| | -1 (default setting)
| |
| | Advanced setting if you don't want to leave it to MX to find your HID
| |
| |-
| |
| | SyncFOReads=0
| |
| | Legacy Cumulus
| |
| | Only if Fine Offset selected
| |
| | Station Settings → Fine Offset Settings
| |
| | Synchronise Reads
| |
| | 0 (disabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
| |
| * Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data
| |
| | |
| # The parameter was added for legacy releases, to try to reduce the occurrence of "lock-up" issues.
| |
| # MX uses a different way to interrogate Fine Offset stations, originally ticking this could result in more reads being skipped, than actually processed, potentially updating just a few times a day, so it was best disabled!
| |
| # The MX code relating to this parameter was rewritten 1n 3.11.0, but the developer labels this as an "attempt", so it may still be best to try to manage without enabling this setting
| |
| |-
| |
| | VendorID=-1
| |
| | MX release ??
| |
| | Only if Fine Offset selected
| |
| | Station Settings → Fine Offset Advanced Settings
| |
| | USB Vendor Id (PID)
| |
| | -1 (default setting)
| |
| | Advanced setting if you don't want to leave it to MX to find your HID
| |
| |}
| |
| | |
| ===Instromet Settings===
| |
| | |
| | |
| {{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station
| |
| | |
| * Introduced in a Legacy version
| |
| * File Section is [Station]
| |
| * MX Section is "Instromet Settings" or "Instromet Advanced Options" as indicated
| |
| * Only "Shown on Settings page" if either "Type=5" or "Type=7"
| |
| | |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:300px" | MX Section
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:600px" | Description
| |
| |-
| |
| | ComportName=xxxxxx
| |
| | Station Settings → Instromet Settings
| |
| | Serial port name
| |
| | /dev/ttyUSB0 (on Linux), COM1 (on Microsoft Windows)
| |
| | Only required if your station is connected via a real, or virtual, serial port
| |
| |-
| |
| |ImetBaudRate=19200
| |
| | Station Settings → Instromet Settings
| |
| | Serial Baud Rate (DavisBaudRate)
| |
| | 19200
| |
| | Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value
| |
| |-
| |
| | "SyncDavisClock=0" and "ClockSettingHour=4"
| |
| | Station Settings → Instromet Advanced Options
| |
| | "Sychronise Station Clock" and "Clock sync hour"
| |
| | Tick box not selected, data box set to 4
| |
| | Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
| |
| | |
| *Simple tick or not
| |
| ** Tick (value shown as 1 in Cumulus.ini) for MX to attempt to sychronise the Instromet Station Clock with your computer time. This ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time!
| |
| ** Don't tick (value shown as 0 in Cumulus.ini) if you don't want MX to attempt to keep station clock in line with computer clock
| |
| * Box taking an integer
| |
| ** The hour of the day when, if enabled, Cumulus will set the Instromet clock to within a minute of the same time as the computer. This will happen at a default time of 04:00 each day, (4 a.m.) unless the setting box is edited
| |
| |-
| |
| | ImetUpdateLogPointer=1
| |
| | Station Settings → Instromet Advanced Options
| |
| | Update logger pointer
| |
| | 1 (enabled)
| |
| | Simple tick or not
| |
| * Tick (value shown as 1 in Cumulus.ini) for MX to update the memory pointer to the last record after every 30 data reads
| |
| * Don't tick to disable this action
| |
| |-
| |
| |ImetWaitTime=500
| |
| | Station Settings → Instromet Advanced Options
| |
| | Delay between sending data read commands
| |
| | 500
| |
| | Specifies the time in milliseconds that Cumulus waits after one read, before it does the next read from an Instromet station. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
| |
| |-
| |
| | ImetReadDelay=500
| |
| | Station Settings → Instromet Advanced Options
| |
| | Delay after sending a command before trying to read data from the serial port
| |
| | 500
| |
| | Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
| |
| |}
| |
| | |
| | |
| ===LaCrosse stations===
| |
| | |
| | |
| | |
| {{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station
| |
| | |
| | |
| {| 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
| |
| |-
| |
| | LCMaxWind=X
| |
| | Shown only if La Crosse was selected as station type
| |
| | [Station]
| |
| | 3.12.0
| |
| | Depends on release:
| |
| * (Version 1.8.8 Build 874 to release 3.11.4) Need to edit manually in file directly
| |
| * (Release 3.12.0 onwards) Station Settings → Common Options → Advanced Options
| |
| | La Crosse max wind speed
| |
| | ???
| |
| | It is setting for the La Crosse max wind speed, where X is the maximum (before calibrated by any definitions in Offsets) wind speed in m/s that you want to allow. The value you supply should be in metres/second, regardless of what wind unit you are using in Cumulus
| |
| |}
| |
| | |
| It is assumed that [[Cumulus.ini_(Cumulus_1)#La_Crosse_specific:|most parameters remain same]]
| |
| | |
| ===WM918/WMR928 Settings===
| |
| | |
| Oregon Scientific specific
| |
| | |
| {{Template:WorkInProgressBanner}} This table has not been populated yet, needs a contributor who uses this type of weather station
| |
| | |
| * Introduced for legacy Cumulus
| |
| * File Section is [Station]
| |
| | |
| | |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:100px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:300px" | Description
| |
| |-
| |
| |style="background:lightgray;"|[Station]
| |
| |
| |
| |
| |
| |style="background:lightgray;"|Section name - the following parameters appear in Station section
| |
| |-
| |
| |Humidity98Fix=0
| |
| |
| |
| |0 (disable)
| |
| |Applies to weather station types that never report more than 98% relative humidity.
| |
| *0 = Disabled (default)
| |
| *1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98%. Normally only useful for Oregon Scientific stations.
| |
| |-
| |
| |LogExtraSensors=0
| |
| |
| |
| |0 (disable)
| |
| |This setting determines whether MX looks for readings from extra temperature probes etc.
| |
| *0=Disabled (default)
| |
| *1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors..
| |
| |-
| |
| |WMR928TempChannel=N
| |
| |
| |
| |(no default)
| |
| |for WMR-928 stations (and other serial stations using the same protocol, eg WMR-968) to use an 'extra' channel (see previous parameter) as your main temperature sensor, set N to the required channel
| |
| |-
| |
| |WMR200TempChannel=N
| |
| |
| |
| |(no default)
| |
| |for WMR200 stations (and any other Oregon Scientific USB stations which work with Cumulus, e.g. WMR100) to use an 'extra' channel as your main temperature sensor, set N to the required channel
| |
| |}
| |
| | |
| ==Units, Derivative Options, and Decimal Places==
| |
| | |
| For altitude units, please see [[#Location]].
| |
| | |
| * File Section is [Station]
| |
| * Edit on Station Settings page (except where indicated in bold as another page)
| |
| {| class="wikitable" border="1"
| |
| |-
| |
| !style="width:30px" | Parameter Line Entry
| |
| !style="width:100px" | Introduced
| |
| !style="width:100px" | MX Section
| |
| !style="width:60px" | Label on Settings page
| |
| !style="width:20px" | Default
| |
| !style="width:300px" | Description
| |
| |-
| |
| | AirQualityDecimals=1
| |
| | Release 3.9.2
| |
| | Units → Advanced Options (Here be dragons!)
| |
| | Air Quality decimals
| |
| | 1 (displayed as blank)
| |
| | Number of decimal places for all outputs
| |
| |-
| |
| | AvgBearingMinutes=10
| |
| | Legacy Cumulus
| |
| | Common Options → Advanced Options (Here be dragons!)
| |
| | Average Bearing Minutes
| |
| | 10 (minutes)
| |
| | This parameter's value is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing
| |
| |-
| |
| | AvgSpeedMinutes=10
| |
| | Legacy Cumulus
| |
| | Common Options → Advanced Options (Here be dragons!)
| |
| | Average Speed Minutes
| |
| | 10 (minutes)
| |
| | This parameter's value is the number of minutes over which Cumulus averages out reported current wind speeds
| |
| |-
| |
| | CalculatedDP=0
| |
| | Legacy Cumulus
| |
| | Common Options
| |
| | Calculate dew point
| |
| | Unticked (shown as 0 in Cumulus.ini)
| |
| | Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate dew point from temperature and humidity supplied by station
| |
| * Don't tick (value shown as 0 in Cumulus.ini) action depends on '''Calibration settings'''
| |
| ** If Cumulus has non-default multiplier and/or offset settings for temperature or humidity, Cumulus will calculate dew-point. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
| |
| ** If station provides dew point, then that will be used provided no multiplier/offsets have been specified for temperature or humidity
| |
| |-
| |
| | CalculatedWC=1
| |
| | Legacy Cumulus
| |
| | Common Options
| |
| | Calculate wind chill
| |
| | Unticked (shown as 0 in Cumulus.ini)
| |
| | Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate wind chill from temperature and wind speed
| |
| ** Note that there is a maximum temperature, and minimum wind speed, for Cumulus to make the calculation, see [[Wind_chill]] page
| |
| * Don't tick (value shown as 0 in Cumulus.ini) action depends on '''Calibration settings'''
| |
| ** If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill
| |
| ** If station provides wind chill, then that will be used provided no multiplier/offsets have been specified for temperature or wind speed
| |
| Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
| |
| |-
| |
| | ChillHourSeasonStart=
| |
| | Legacy Cumulus
| |
| | (TO BE DETERMINED)
| |
| |
| |
| | Default depends on release
| |
| * (up to 3.11.4) 10 = October
| |
| * (from 3.12.0) 4 in Southern hemisphere, 10 in Northern hemisphere
| |
| | The value to enter is the month number (1=January, 12=December) and the Cumulative Chill Hours Count is reset to zero on the first of the selected month
| |
| |-
| |
| | ChillHourThreshold=
| |
| | Legacy Cumulus
| |
| | (TO BE DETERMINED)
| |
| |
| |
| | Default depends on Temperature Units
| |
| * Either 45 degrees Fahrenheit (equivalent to 7.22 <sup>o</sup>Celsius)
| |
| * Or 7 degrees Celsius (equivalent to 44.6 <sup>o</sup>Fahrenheit)
| |
| | Chill Hours are incremented by the number of (fractional) hours that the air temperature is below the threshold. In practice, Cumulus simply detects if the current temperature is below the threshold and adds an increment equivalent to the (interval) time passed since the last temperature reading.
| |
| * You can put in any value you want, with a decimal place if required
| |
| * Some people have put in the freezing-point temperature (0<sup>o</sup>C or 32 <sup>o</sup>F) and they relabel "chill hours" to "frost hours"
| |
| |-
| |
| | CloudBaseInFeet=0
| |
| | Legacy Cumulus
| |
| | (As at 3.11.4, can only adjust in the file)
| |
| |
| |
| | 0 (default in MX is metres)
| |
| | Select units used for reporting theoretical cloud base:
| |
| * 0 = metres (default if file created by MX)
| |
| * 1 = feet (default if file created by legacy software)
| |
| |-
| |
| | ErrorLogSpikeRemoval=1
| |
| | Legacy Cumulus
| |
| | '''Calibration Settings''' → Final tick box
| |
| | Log spike and limit violations to error log
| |
| | 1 (default in MX is enabled)
| |
| | Log spike and limit violations to error log (in MX this is in [[MXdiags folder]]):
| |
| * 1 = do log (default if file created by MX)
| |
| * 0 = don't log (default if file created by legacy software)
| |
| |-
| |
| | HourlyForecast=1
| |
| | Legacy Cumulus
| |
| | Forecast
| |
| | Update forecast hourly
| |
| | 1 (default in MX is enabled)
| |
| | When Cumulus derives its Zambretti forecast
| |
| | |
| Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then MX will derive a Zambretti forecast just once an hour, on the hour
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to derive a forecast every time MX does a process of the pressure reading
| |
| |-
| |
| | Humidity98Fix=0
| |
| | Legacy Cumulus
| |
| | (TO BE DETERMINED)
| |
| | n/a
| |
| | 0 (disable)
| |
| | For any weather station that never reports a relative humidity greater than 98%
| |
| | |
| Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then if weather station reading is 98%, process that as 100% for all outputs from MX
| |
| * Don't tick (value shown as 0 in Cumulus.ini) to always report what weather station reports for relative humidity
| |
| |-
| |
| | PeakGustMinutes=10
| |
| | Legacy Cumulus
| |
| | Common Options → Advanced Options (Here be dragons!)
| |
| | Peak wind gust time
| |
| | 10 (minutes)
| |
| | MX waits until a gust has been measured for number of minutes specified by value of parameter, before checking whether previous gust extreme record have been exceeded
| |
| |-
| |
| | PressDecimals=1
| |
| | Release 3.9.2
| |
| | Units → Advanced Options (Here be dragons!)
| |
| | Pressure decimals
| |
| | Default depends on Pressure Units (displayed as blank)
| |
| * default is 1 if units are hPa or mb
| |
| * default is 2 if units are inches of mercury
| |
| | Number of decimal places for all outputs
| |
| |-
| |
| | PressureUnit=1
| |
| | Legacy Cumulus
| |
| | Units
| |
| | Pressure
| |
| | Depends on release:
| |
| # Legacy to 3.11.4: 0 (mbar)
| |
| # 3.12.0 onwards: 1 (hPa)
| |
| | |
| | Drop-down:
| |
| * 0 = millibar (mb)
| |
| * 1 = hectoPascals (hPa)
| |
| * 2 = inches of mercury (in Hg)
| |
| |- | | |- |
| | RainDayThreshold= | | | UVDecimals=1 |
| | Legacy Cumulus
| | | Release 3.9.2 |
| | (TO BE DETERMINED)
| |
| | n/a
| |
| | (TO BE DETERMINED)
| |
| | For derivatives like count of consecutive wet/dry days, any daily rainfall less than this threshold will be ignored.
| |
| | |
| (If rainfall is measured in tips, usually set to just over one tip, as first tip of day might be result of less that one tip accumulated on earlier days or because of dew)
| |
| |-
| |
| | RainDecimals=1
| |
| | Release 3.9.2 | |
| | Units → Advanced Options (Here be dragons!) | | | Units → Advanced Options (Here be dragons!) |
| | Rainfall decimals | | | Ultra Violet decimals |
| | Default depends on Rainfall Units (displayed as blank) | | | 1 (displayed as blank) |
| * default is 1 if units are millimetres
| | | Select a number of decimal places to overwrite the default |
| * default is 2 if units are inches
| |
| | Number of decimal places for all outputs | |
| |- | | |- |
| | RainSeasonStart=1 | | | Wind10MinAverage=0 |
| | Legacy Cumulus | | | Legacy Cumulus |
| | Annual Rainfall | | | Common Options |
| | Start of rainfall season | | | Calculate average wind speed |
| | 1 (Jan) | | | 0 (disable) |
| | Drop-down | | | Simple tick or not: |
| * 1 = January | | * Tick (value shown as 1 in Cumulus.ini) then MX will calculate an average wind speed (over ten minutes) as defined by "UseSpeedForAvgCalc" parameter |
| * 2 = February
| | * Don't tick (value shown as 0 in Cumulus.ini) then MX will use whatever the weather station provides as an average wind speed |
| * 3 = March
| | Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details. |
| ...
| |
| * 9 = September | |
| * 10 = October
| |
| * 11 = November
| |
| * 12 = December
| |
| | |
| Added in late 2010 because Cumulus users in Israel said they do not total rainfall from January.
| |
| | |
| It was welcomed by people outside Israel, it turned out growers are often interested in a growing season rainfall total
| |
| |- | | |- |
| | RainUnit=0 | | | WindRunDecimals=1 |
| | Legacy Cumulus
| |
| | Units
| |
| | Rain
| |
| | 0 (mm)
| |
| | Drop-down:
| |
| * 0 = millimetres
| |
| * 1 = inches
| |
| |-
| |
| | RoundWindSpeed=0
| |
| | Legacy Cumulus
| |
| | Common Options
| |
| | Rounding of wind speed
| |
| | 0 (no)
| |
| | Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then MX will round all the wind speeds it reports to nearest integer
| |
| * Don't tick (value shown as 0 in Cumulus.ini) then MX will report wind speeds to the precision defined in "WindSpeedDecimals" parameter
| |
| |-
| |
| | SunshineHrsDecimals=2
| |
| | Release 3.8.0
| |
| | Units → Advanced Options (Here be dragons!)
| |
| | Sunshine hours decimals
| |
| | 2 (displayed as blank)
| |
| | Select a number of decimal places to overwrite the default
| |
| |-
| |
| | TempDecimals=1
| |
| | Release 3.9.2 | | | Release 3.9.2 |
| | Units → Advanced Options (Here be dragons!) | | | Units → Advanced Options (Here be dragons!) |
| | Temperature decimals | | | Wind run decimals |
| | 1 (displayed as blank) | | | 1 (displayed as blank) |
| | Select a number of decimal places to overwrite the default | | | Select a number of decimal places to overwrite the default |
| |- | | |- |
| | TempUnit=0 | | | WindSpeedAvgDecimals= |
| | Legacy Cumulus | | | Release 3.8.3 |
| | Units | | | Units → Advanced Options (Here be dragons!) |
| | Temperature
| | | Wind speed average decimals |
| | 0 (<sup>o</sup>C
| | | (displayed as blank) |
| | Drop-down: | | | Select a number of decimal places to overwrite the default. (NOTE: If the weather station does not provide an average wind speed, or if the user requires a change of units from how the weather station reports it, then CMX will calculate it to 1 decimal place by default; otherwise average wind speed will default to integer, or to one decimal place, depending how it is provided by the station). |
| * 0 = Celsius
| |
| * 1 = Fahrenheit
| |
| |-
| |
| | UseCumulusForecast=0
| |
| | Legacy Cumulus
| |
| | Forecast
| |
| | Use Cumulus Forecast | |
| | 0 (disabled)
| |
| | Simple tick or not: | |
| * Tick (value shown as 1 in Cumulus.ini) then Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, or as an alternative to the one supplied by your station. Please see [[Forecast_webtag]] for details.
| |
| * Don't tick (value shown as 0 in Cumulus.ini) then MX will not do any forecasting, so it will return "not available" unless your weather station provides an alternative forecast
| |
| |-
| |
| | UseCumulusPresstrendstr=0
| |
| | Legacy Cumulus
| |
| | Common Options
| |
| | Cumulus pressure trend names
| |
| | 0 (depends on weather station type)
| |
| | Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]].
| |
| * Don't tick (value shown as 0 in Cumulus.ini) then effect depends on whether your weather station supplies pressure trends
| |
| ** If your station does supply pressure trends, then MX will use those
| |
| ** If your station does not supply pressure trends, then MX will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast, but can be modified using [[strings.ini]].
| |
| |-
| |
| | UseSpeedForAvgCalc=0
| |
| | Legacy Cumulus
| |
| | Common Options
| |
| | Use speed for average calculation
| |
| | 0 (disable)
| |
| | Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then MX will use what the weather station supplies as "wind speed" to calculate the average wind speed.
| |
| * Don't tick (value shown as 0 in Cumulus.ini) then MX will use what the weather station supplies as "latest wind speed" to calculate the average wind speed
| |
| Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details.
| |
| |-
| |
| | UseZeroBearing=1
| |
| | Legacy Software
| |
| | Common Options
| |
| | Use bearing zero when calm
| |
| | 1 (enable)
| |
| | Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then MX will report a wind bearing of zero when the wind is calm
| |
| * Don't tick (value shown as 0 in Cumulus.ini) then MX will continue to report the last wind bearing when the wind stops blowing
| |
| |-
| |
| | UVDecimals=1
| |
| | Release 3.9.2
| |
| | Units → Advanced Options (Here be dragons!)
| |
| | Ultra Violet decimals
| |
| | 1 (displayed as blank)
| |
| | Select a number of decimal places to overwrite the default
| |
| |- | | |- |
| | Wind10MinAverage=0 | | | WindSpeedDecimals= |
| | Legacy Cumulus
| |
| | Common Options
| |
| | Calculate average wind speed
| |
| | 0 (disable)
| |
| | Simple tick or not:
| |
| * Tick (value shown as 1 in Cumulus.ini) then MX will calculate an average wind speed (over ten minutes) as defined by "UseSpeedForAvgCalc" parameter
| |
| * Don't tick (value shown as 0 in Cumulus.ini) then MX will use whatever the weather station provides as an average wind speed
| |
| Please see [[Wind_measurement#Weather_Stations_and_Cumulus]] for more details.
| |
| |-
| |
| | WindRunDecimals=1
| |
| | Release 3.9.2
| |
| | Units → Advanced Options (Here be dragons!)
| |
| | Wind run decimals
| |
| | 1 (displayed as blank)
| |
| | Select a number of decimal places to overwrite the default
| |
| |-
| |
| | WindSpeedAvgDecimals=1
| |
| | Release 3.8.3 | | | Release 3.8.3 |
| | Units → Advanced Options (Here be dragons!) | | | Units → Advanced Options (Here be dragons!) |
| | Wind speed average decimals | | | Wind speed average decimals |
| | 1 (displayed as blank) | | | (displayed as blank) |
| | Select a number of decimal places to overwrite the default | | | Select a number of decimal places to overwrite the default which depends both on the weather station type and what units have been selected by user (speeds are normally reported as integers unless metres per second are reporting unit, because most sensors are not precise enough to give any decimal places in other units) |
| |-
| |
| | WindSpeedDecimals=2
| |
| | Release 3.8.3
| |
| | Units → Advanced Options (Here be dragons!)
| |
| | Wind speed average decimals
| |
| | 2 (displayed as blank)
| |
| | Select a number of decimal places to overwrite the default
| |
| |- | | |- |
| | WindUnit=0 | | | WindUnit=0 |
| Line 4,900: |
Line 3,492: |
| | (displayed as blank) | | | (displayed as blank) |
| | Enter a 4 digit year: | | | Enter a 4 digit year: |
| * Legacy Releases (1.7.12 5 July 2008) and MX up to 3.11.4 (build 3133 25 May 2021): The year-to-date amount in previous parameter is added to the current (seasonal) rain if the year specified in this parameter matches the current year. | | * Legacy Releases (1.7.12 from 5 July 2008) and MX up to 3.11.4 (build 3133 from 25 May 2021): The year-to-date amount in previous parameter is added to the current (seasonal) rain if the year specified in this parameter matches the current year. |
| ** If your rain season starts in January (default) then set this to the calendar year when you first use Cumulus (in a particular location). | | ** If your rain season starts in January (default) then set this to the calendar year when you first use Cumulus (in a particular location). |
| ** If your rain year starts in any other month, set this to this year if your first season starts this year, and set this to last year if your second season has started and you don't want the previous value added to your second season | | ** If your rain year starts in any other month, set this to the current calendar year during your first season (remember to change the year mid-season when reach 1 January), and delete the year when your second season starts as you don't want the previous value added to your second season |
| * From Release 3.12.0 (?? July 2021), the current calendar year is compared against (current month - season start month + 1) year, so you enter the year in which your first season starts (be that last calendar year or this calendar year) | | * From Release 3.12.0 (29 July 2021), the current calendar year is compared against (current month - season start month + 1) year, so you enter the year in which your first season would start had it been a full season (be that last calendar year or this calendar year) |
| |} | | |} |
