5,838
edits
Cumulus.ini: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
no edit summary
m (→Optional Web Server: try again to get right: "FTP logging") |
mNo edit summary |
||
| (47 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 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. 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> | ||
{{Template:WorkInProgressBanner}} | {{Template:WorkInProgressBanner}} | ||
| Line 20: | 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"?= | |||
[[Category:Configuration Files]] | [[Category:Configuration Files]] | ||
| Line 29: | Line 31: | ||
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 by this new page. | ||
==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 145: | Line 153: | ||
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. | ||
<big>Please see [[First Run of MX]] for how to set up settings when you first use MX.</big> | |||
==What happens if I upgrade MX?== | ==What happens if I upgrade MX?== | ||
| Line 271: | Line 258: | ||
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 1,910: | Line 1,895: | ||
!style="width:20px" | Default | !style="width:20px" | Default | ||
!style="width:600px" | Description | !style="width:600px" | Description | ||
|- | |- | ||
| DataLogInterval=2 | | DataLogInterval=2 | ||
| Line 1,957: | Line 1,910: | ||
|- | |- | ||
| LogExtraSensors=0 | | LogExtraSensors=0 | ||
| (Depends on station type) | | (Depends on station type) Only from Release 3.12.0 | ||
| Station settings → Common Options | | Station settings → Common Options | ||
| Extra sensors | | Extra sensors | ||
| Line 1,965: | Line 1,918: | ||
* Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files. | * Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files. | ||
|- | |- | ||
| RolloverHour=0 | | NoSensorCheck=0 | ||
| (not yet on a settings page) | |||
| (not known) | |||
| (not known) | |||
| 0 (normal) | |||
| Boolean: | |||
* 0 = MX will stop if any of the minimum set of sensors listed below fails | |||
* 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails | |||
Minimum set of sensors: | |||
# Current air temperature | |||
# Current Relative Humidity | |||
# At least one wind speed | |||
# Current air pressure (absolute or sea-level) | |||
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). | |||
|- | |||
| RainDayThreshold=-1 | |||
| (with warning: "Here be dragons!") | |||
| Depends on release: | |||
* (3.5.1 to 3.11.4) Manual edit of file | |||
* (3.12.0 onwards) Station settings → Common Options → Advanced options | |||
| Rain day threshold | |||
| -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 | |||
''The intention is this will represent more than one tip, as the first tip might contain some rain from an earlier day'' | |||
|- | |||
| RolloverHour=0 | |||
| (Always) | | (Always) | ||
| Station settings → Log Rollover | | Station settings → Log Rollover | ||
| Line 1,973: | Line 1,953: | ||
* 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 | * 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 | ||
* 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 | * 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 | ||
|- | |||
| SnowDepthHour=0 | |||
| (with warning: "Here be dragons!") | |||
| Depends on release: | |||
* (3.5.1 to 3.11.4) Manual edit of file | |||
* (3.12.0 onwards) Station settings → Common Options → Advanced options | |||
| Snow depth hour | |||
| 0 (midnight) | |||
| 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 | |||
|- | |||
| StartDate= | |||
| (with warning: "Here be dragons!") | |||
| Station Settings → Common Options → Advanced Options | |||
| Records Began date | |||
| (Set when you first use 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. | |||
|- | |||
| UseDataLogger=1 | |||
| (probably determined by station type) | |||
| (not known) | |||
| (not known) | |||
| 1 (enabled) | |||
|Simple tick or not | |||
* 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" | |||
* 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 | |||
|- | |- | ||
| Use10amInSummer=1 | | Use10amInSummer=1 | ||
| Line 1,980: | Line 1,985: | ||
| 1 (normal) | | 1 (normal) | ||
| Tick box: | | Tick box: | ||
* 0 = If "Daylight Saving Time" (DST) applies in Summer, MX is to use 9 am local time | * 0 = If "Daylight Saving Time" (DST) applies in Summer, | ||
** 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 | |||
* 1 = Normal behaviour: | * 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 rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not | ||
| Line 1,986: | Line 1,993: | ||
|} | |} | ||
==Debugging== | |||
* Available from beta MX. | * Available from beta MX. | ||
* File Section is [ | * File Section is [Station] | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:30px" | Parameter Line Entry | !style="width:30px" | Parameter Line Entry | ||
!style="width: | !style="width:300px" | MX Section | ||
!style="width:60px" | Label on Settings page | !style="width:60px" | Label on Settings page | ||
!style="width:20px" | Default | !style="width:20px" | Default | ||
!style="width:600px" | Description | !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) | |||
| 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 | |||
* 0 = 1 | # (Release 3.12.0 onwards) Program Settings → Logging Options | ||
* 1 | | 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) | ||
| 10 ( | | Simple tick or not | ||
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display solar data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) | |||
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data | |||
|- | |- | ||
| | | DisplayUvData=0 | ||
| ( | | ??? 3.10.0 ??? | ||
| | | Display UV-I data | ||
| | | Unticked (shown as 0 in Cumulus.ini) | ||
| Simple tick or not | |||
* Tick (value shown as 1 in Cumulus.ini) if you want MX to display ultra-violet intensity data in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) | |||
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display UV intensity data | |||
|- | |- | ||
| | | NumWindRosePoints=16 | ||
| | | Legacy Cumulus | ||
| | | Number of wind rose points | ||
| | | 16 | ||
| ( | | Drop-down determining if weather station bearing supplied by weather station is to be converted to 8 or 16 compass directions (i.e. whether to include or exclude (in English) NNE, ENE, ESE, SSE, SSW, WSW, WNW, and NNW | ||
* 8 points | |||
* 16 points | |||
Despite what it says in the hint on the settings page, leave at default whichever weather station type you use, unless this actually causes you a problem. The parameter was introduced by Steve Loft. Davis wind vanes use a potentiometer to measure wind direction so send Cumulus a bearing that can vary continuously between 1 and 360 degrees. Fine Offset wind vanes use magnetic switches that depend on the magnet under the moving part selecting two switches in the fixed part for the vane being exactly in-between compass directions, and selecting one switch for the main 8 directions and slightly away from the main directions; so they have a bias against sending Cumulus the in-between directions. | |||
|- | |- | ||
| | | UseApparent=1 | ||
| ( | | ??? MX 3.6.0 or 3.10.0 ??? | ||
| | | Use Apparent Temperature | ||
| | | Ticked (shown as 1 in Cumulus.ini) | ||
| Simple tick or not | |||
| | * Tick (value shown as 1 in Cumulus.ini) if you want MX to display apparent temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus prior to release 3.6.0 | ||
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to display feels like temperature in tables shown on the [[New_Default_Web_Site_Information|web pages]] provided in [[Webfiles folder|webfiles folder]] (from release 3.10.0 onwards) for consistency with Cumulus from release 3.6.0 | |||
|} | |||
==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" | |||
|- | |- | ||
| | !style="width:30px" | Parameter Line Entry | ||
!style="width:100px" | Label on Settings page | |||
| | !style="width:20px" | Default | ||
| | !style="width:800px" | Description | ||
|- | |- | ||
| | |style="background:lightgray;"|[FTP site] | ||
| | | | ||
| | | | ||
| | |style="background:lightgray;"|Section name | ||
| | |||
| | |||
|- | |- | ||
| | |ExtraLocal0= to ExtraLocal99= | ||
|Local File Name | |||
| | |(empty) | ||
| | |You can enter: | ||
* A relative path name, with respect to the "CumulusMX" root folder | |||
| | ** 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] | ||
** 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 | |||
** e.g. '''/home/pi/documents/myFile''' | |||
** e.g. '''C:\Users\Public\Documents\working.txt''' | |||
*You can place any of the following special tags into the entry | |||
** These should be typed as shown on their own | |||
*** '''<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 e.g. ExtraLocal3=<currentlogfile> | ||
| | |||
| | |||
|- | |- | ||
| | |ExtraRemote0= to ExtraRemote99= | ||
| | |Destination Filename | ||
| | |(empty) | ||
| | |Defines where MX is to upload file to | ||
| | * 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 | ||
*** e.g. httpdocs/dayfile.txt | |||
*** 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 | |||
|- | |- | ||
| | |ExtraProcess0= to ExtraProcess99= | ||
| | |Process | ||
| | |0 | ||
| | |Simple tick or not | ||
* 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 | ||
| | |||
|- | |- | ||
| | |ExtraRealtime0= to ExtraRealtime99= | ||
| | |Realtime | ||
| | |0 | ||
| | |Simple tick or not | ||
*Tick (value shown as 1 in Cumulus.ini) if | |||
*# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there | |||
* | *# Uploads the file to destination specified at interval defined | ||
* 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]]) | |||
|- | |- | ||
| | |ExtraFTP0= to ExtraFTP99= | ||
|FTP | |||
| | |1 | ||
| | |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]] | ||
* 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 | |||
|- | |- | ||
| | |ExtraUTF0= to ExtraUTF99= | ||
| | |UTF-8 | ||
| | |1 | ||
| | |Please see [[Reports_folder#Encoding|technical guidance on encoding]] | ||
| ( | *Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters | ||
| | *If unticked (0 appears in file), then iso-8859-1 encoding is used | ||
|} | |- | ||
|ExtraBinary0= to ExtraBinary99= | |||
== | |Binary | ||
|0 | |||
* | |Simple tick or not | ||
* File Section is [Station] | *Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png) | ||
{| class="wikitable" border="1" | * 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== | |||
* Introduced for legacy Cumulus | |||
* File Section is [Station] | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
!style="width:30px" | Parameter Line Entry | !style="width:30px" | Parameter Line Entry | ||
!style="width: | !style="width:100px" | MX Section | ||
!style="width:60px" | Label on Settings page | !style="width:60px" | Label on Settings page | ||
!style="width:20px" | Default | !style="width:20px" | Default | ||
!style="width:600px" | Description | !style="width:600px" | Description | ||
|- | |- | ||
| | | Altitude=0 | ||
| | | Station Settings → Location | ||
| Altitude | |||
| 0 | |||
| The height above mean sea level where the (pressure) sensor is positioned | |||
| | |||
| 0 | |||
| | |||
|- | |- | ||
| | | AltitudeInFeet=1 | ||
| | | Station Settings → Location | ||
# | | Altitude Units | ||
# | | Default depends on release: | ||
# Legacy until 3.11.4: 1 (labelled as feet) | |||
# From 3.12.0: 0 (labelled metres) | |||
| Radio Setting | |||
| | * feet (value shown as 1 in Cumulus.ini) | ||
| | * metres (value shown as 0 in Cumulus.ini) | ||
| | |- | ||
| LocName= | |||
| Station Settings → Location | |||
| Name | |||
| (empty) | |||
| A short name for the location | |||
|- | |||
| LocDesc= | |||
| Station Settings → Location | |||
| Description | |||
| (empty) | |||
| A longer description for the location | |||
|- | |||
| "Latitude=0" and "LatTxt=" | |||
| Station Settings → Location → Latitude | |||
| "Degrees", "Minutes", "Seconds", and "Hemisphere → North or South" | |||
| (blank) | |||
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file | |||
|- | |||
| "Longitude=0" and "LongTxt=" | |||
| Station Settings → Location → Longitude | |||
| "Degrees", "Minutes", "Seconds", and "Hemisphere → East or West" | |||
| (blank) | |||
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file | |||
|} | |} | ||
* File Section is | ==Optional Report Settings== | ||
* File Section is [NOAA] | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:30px" | Parameter Line Entry | !style="width:30px" | Parameter Line Entry | ||
!style="width:100px" | Introduced | !style="width:100px" | Introduced | ||
!style="width:100px" | MX Section | |||
!style="width:60px" | Label on Settings page | !style="width:60px" | Label on Settings page | ||
!style="width:20px" | Default | !style="width:20px" | Default | ||
!style="width: | !style="width:300px" | Description | ||
|- | |- | ||
| | | 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 | * 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]] | ||
* Don't tick (value shown as 0 in Cumulus.ini) | * Don't tick (value shown as 0 in Cumulus.ini) for no copy action | ||
|- | |- | ||
| | | AutoFTP=0 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → FTP Options | ||
| | | Auto transfer NOAA report files | ||
| 0 (disable) | |||
| Simple tick or not | | Simple tick or not | ||
* Tick (value shown as 1 in Cumulus.ini) | * 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) | * Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process | ||
|- | |- | ||
| | | AutoSave=1 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings | ||
| | | Create NOAA files after daily rollover | ||
| | |0 | ||
* | | Simple tick or not | ||
* Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required | |||
|- | |- | ||
| | | City= | ||
| | | First with Cumulus 2 | ||
| NOAA Reports Settings → Site Details | |||
| City | |||
| | | (empty) | ||
| Enter here your hamlet, village, town, or city, name | |||
| | |||
|- | |- | ||
| CoolingThreshold=22 | |||
| First with Cumulus 2 | |||
| NOAA Reports Settings → Thresholds | |||
| Cooling threshold | |||
| 65<sup>o</sup> F or 18.3<sup>o</sup>C | |||
| [[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. | |||
|- | |- | ||
| | | CopyDirectory= | ||
| | | Release 3.12.0 | ||
| | | NOAA Reports Settings → Report Options | ||
| | | Copy Directory | ||
| (empty) | |||
| The folder on the web server you host to which reports are to be copied | |||
|- | |- | ||
| | | FTPDirectory= | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → FTP Options | ||
| | | destination folder | ||
| Depends on release: | |||
* (3.1.0 to 3.11.4) blank | |||
* | * (3.12.0 onwards) to match change in default web site script specification of '''Reports''' folder | ||
* | | 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). | |||
* | |||
* | |||
|- | |- | ||
| | | HeatingThreshold=15.5 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| | | Heating threshold | ||
| 65<sup>o</sup> F or 18.3<sup>o</sup>C | |||
|[[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. | |||
|- | |- | ||
| | | MaxTempComp1=22 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| | | Max temp comparison 1 | ||
| (empty) | |||
| 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 | |||
|- | |- | ||
| | | MaxTempComp2=0 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| | | Max temp comparison 2 | ||
| (empty) | |||
| 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 | |||
|- | |- | ||
| | | MinTempComp1=15.5 | ||
| | | First with Cumulus 2 | ||
|1 | | NOAA Reports Settings → Thresholds | ||
| | | Min temp comparison 1 | ||
| (empty) | |||
| 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 | |||
|- | |- | ||
| | | MinTempComp2=0 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| | | Min temp comparison 2 | ||
| (empty) | |||
| 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 | |||
|- | |- | ||
| | | MonthFileFormat='NOAAMO'MMyy'.txt' | ||
| First with Cumulus 2 | |||
| NOAA Reports Settings → Output Files | |||
| Monthly filename format | |||
| 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''') | |||
| Here you specify the filename template for MX to use when reading, or writing, monthly reports | |||
| | |||
| | |||
| | |||
| | |||
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. | |||
|- | |- | ||
| Name=Personal Weather Station | |||
| First with Cumulus 2 | |||
| NOAA Reports Settings → Site Details | |||
| Site Name | |||
| (empty) | |||
| What you would like to see in report title for your station name | |||
|- | |- | ||
| | | NOAAUseUTF8=1 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Report Options | ||
| | | Use UTF-8 encoding | ||
| | | 1 (UTF-8) | ||
| Please see [[Reports_folder#Encoding]] | |||
* 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 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 | |||
|- | |- | ||
| | | RainComp1=0.5 | ||
| First with Cumulus 2 | |||
| NOAA Reports Settings → Thresholds | |||
| Rain comparison 1 | |||
| | |||
| | |||
| | |||
| (empty) | | (empty) | ||
| | | 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 | ||
|- | |- | ||
| | | RainComp2= | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| Rain comparison 2 | |||
| (empty) | | (empty) | ||
| | | The report will count the number of days when the daily rainfall exceeds this threshold. | ||
|- | |- | ||
| | | RainComp3= | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| ( | | Rain comparison 3 | ||
| The | | (empty) | ||
| The report will count the number of days when the daily rainfall exceeds this threshold. | |||
|- | |||
| State= | |||
| First with Cumulus 2 | |||
| NOAA Reports Settings → Site Details | |||
| State | |||
| (empty) | |||
| Enter here your local authority area or region (state in USA) | |||
|- | |- | ||
| | | UseDotDecimal=0 | ||
| | | Release 3.9.5 - b3100 | ||
| | | NOAA Reports Settings → Report Options | ||
| ( | | Use a 'dot' decimal point | ||
| | | 0 (disable) | ||
| Formatting real numbers for when NOAA report parsed by a script | |||
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 | ||
|- | |- | ||
| UseMinMaxAvg=0 | |||
| Release 3.12.0 | | Release 3.12.0 | ||
| NOAA Reports Settings → | | NOAA Reports Settings → Report Options | ||
| | | Use WHO average or Integrated average | ||
| 0 ( | | 0 (integrated average) | ||
| Simple tick or not | | Simple tick or not | ||
* Tick (value shown as 1 in Cumulus.ini) if | * 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) | * 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’ | ||
| First with Cumulus 2 | | First with Cumulus 2 | ||
| NOAA Reports Settings → | | NOAA Reports Settings → Output Files | ||
| | | Yearly filename format | ||
| | | 'NOAAYR'yyyy'.txt' | ||
| | | Here you specify the filename template for MX to use when reading, or writing, yearly reports | ||
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. | |||
|- | |- | ||
| | |12hourformat=0 | ||
| | | ??? | ||
| NOAA Reports Settings | | NOAA Reports Settings → Output Files | ||
| | |Time format | ||
|0 | |0 (24 hour) | ||
| | | How times are output on reports | ||
* | * 24 Hour (value shown as 0 in Cumulus.ini) | ||
* | * 12 Hour (value shown as 1 in Cumulus.ini) | ||
| | |} | ||
===Normal Mean Temperatures=== | |||
* File Section is [NOAA] | |||
* 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=== | |||
* File Section is [NOAA] | |||
Rainfall equivalents of mean temperature described above | |||
==Optional Structured Query Language Settings== | |||
SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey. | |||
MX uses two types of SQL. One type is for SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type stores data in rows that are numbered, and columns that are named. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifyimg content, but that gets translated into a row number to actually determine what is updated. | |||
The file section '''[MySQL]''' is about a different type of database (i.e. Maria database, or Oracle MySQL) these implement a relational database that has to satisfy the rule that all data appears in a table with rows and columns. The columns have a particular order, but there is no control over the order of rows, so you can't specify a row number, you either specify a primary key that identifies a particular row, or you specify that what is returned from query should be sorted in an ascending/descending order of the value in a specified column. | |||
Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings: | |||
{| class="wikitable" border="1" | |||
|- | |||
!style="width:30px" | Executable | |||
!style="width:100px" | Function | |||
!style="width:300px" | Description | |||
|- | |- | ||
| | | CumulusMX.exe | ||
| | | Data Logs menu | ||
| | | An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default. | ||
|- | |- | ||
! rowspan="7" |CumulusMX.exe | |||
| | | Settings menu → MySQL settings → General Options | ||
| | | An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option. | ||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Realtime.txt Upload | ||
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]]. | |||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Dayfile.txt Upload | ||
| An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table. | |||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Monthly log file Upload | ||
| An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]]. | |||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Custom Upload - seconds interval | ||
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed. | |||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Custom Upload - minutes interval | ||
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed. | |||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Custom Upload - at rollover | ||
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur. | |||
| | |||
|- | |- | ||
| | | ExportToMySQL.exe | ||
| | | parameters to utility | ||
| | | Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table) | ||
| | |} | ||
WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MARIA db syntax. | |||
Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags: | |||
<pre> | |||
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....); | |||
BEGIN NOT ATOMIC | |||
IF '<#web tag>' = '---' THEN | |||
simpler query to run if something not numeric; | |||
ELSE | |||
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>'; | |||
END IF | |||
END; | |||
</pre> | |||
* Introduced in Cumulus MX 3.0.0 beta | |||
* File Section is [MySQL] | |||
* MX page is Settings menu → MySQL settings | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| | !style="width:30px" | Parameter Line Entry | ||
| | !style="width:100px" | MX Section | ||
| | !style="width:60px" | Label on Settings page | ||
| | !style="width:20px" | Default | ||
!style="width:600px" | Description | |||
| | |||
|- | |- | ||
| | | BufferOnFailure=0 | ||
| | | General Options | ||
| Buffer commands on failure | |||
| | | 0 = ignore errors | ||
| | | Simple tick or not | ||
| | *Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped) | ||
* Tick (value shown as 1 in Cumulus.ini) | * Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors | ||
* | |||
|- | |- | ||
| | | CustomMySqlMinutesCommandString= | ||
| | | Custom Upload - minutes interval | ||
| | | "SQL command" only shown if next parameter is ticked | ||
| (empty) | | (empty) | ||
| | | See "predetermined SQL" example above | ||
|- | |- | ||
| | | CustomMySqlMinutesEnabled=0 | ||
| | | Custom Upload - minutes interval | ||
| | | Custom Minutes Enabled | ||
| | | 0 = don't display other options | ||
| ( | | Simple tick or not | ||
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings | |||
|- | |- | ||
| | | CustomMySqlMinutesIntervalIndex=6 | ||
| | | Custom Upload - minutes interval | ||
| | | Interval: | ||
| | | 6 = 10 minutes | ||
| Drop-down list of predetermined intervals: | |||
* 0 = 1 minute | |||
* 1 = 2 minutes | |||
* 2 = 3 minutes | |||
* 3 = 4 minutes | |||
* 4 = 5 minutes | |||
* 5 = 6 minutes | |||
* 6 = 10 minutes | |||
* 7 = 12 minutes | |||
* 8 = 20 minutes | |||
* 9 = 30 minutes | |||
* 10 = 1 hour (60 minutes) | |||
|- | |||
| CustomMySqlRolloverCommandString= | |||
| Custom Upload - at rollover | |||
| "SQL command" only shown if next parameter is ticked | |||
| (empty) | | (empty) | ||
| | | See "predetermined SQL" example above | ||
|- | |||
| CustomMySqlRolloverEnabled=0 | |||
| Custom Upload - at rollover | |||
| Custom Rollover Enabled | |||
| 0 = don't display other options | |||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings | |||
|- | |- | ||
| | | CustomMySqlSecondsCommandString= | ||
| | | Custom Upload - seconds interval | ||
| | | "SQL command" only shown if next parameter is ticked | ||
| (empty) | | (empty) | ||
| | | See "predetermined SQL" example above | ||
|- | |||
| CustomMySqlSecondsEnabled=0 | |||
| Custom Upload - seconds interval | |||
| Custom Seconds Enabled | |||
| 0 = don't display other options | |||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings | |||
|- | |||
| CustomMySqlSecondsInterval=10 | |||
| Custom Upload - seconds interval | |||
| Interval (seconds): | |||
| 10 | |||
| A number field, takes 1 to 59 | |||
|- | |- | ||
| | | Database= | ||
| | | Server details | ||
| | | Database name: | ||
| | | (empty) | ||
| A text field where you enter the name of the database your tables are to be created/updated in | |||
| | |||
|- | |- | ||
| | | DayfileMySqlEnabled=0 | ||
| | | Dayfile.txt upload | ||
| Dayfile Enabled | |||
| | | 0 | ||
| 0 | |||
| Simple tick or not | | Simple tick or not | ||
* Tick (value shown as 1 in Cumulus.ini) if you want | *Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table | ||
* Don't tick (value shown as 0 in Cumulus.ini) if | * Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt | ||
|- | |- | ||
| | | DayfileTable= | ||
| | | Dayfile.txt upload | ||
| | | Table name | ||
| | | Dayfile | ||
| | | Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but the option to update table when you edit "dayfile.txt" will fail (and if set to do so, keep failing as it repeats). | ||
|- | |- | ||
| | | Host=Localhost | ||
| | | Server details | ||
| | | Host name | ||
| | | (empty) | ||
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost". | |||
| | |||
|- | |- | ||
| MonthlyMySqlEnabled=0 | |||
| Monthly logfile upload | |||
| Monthly Log Enabled | |||
| 0 | |||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table. | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file | |||
|- | |||
| MonthlyTable= | |||
| Monthly logfile upload | |||
| Table name | |||
| Monthly | |||
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but the option to update table when you edit "MMMyyyyLog.txt" will fail (and if set to do so, keep failing as it repeats). | |||
|- | |- | ||
| | | Pass= | ||
| Server details | |||
| Password | |||
| (empty) | |||
| Set to whatever password is used for update access with the database user name (see below) | |||
| | |||
| | |||
| | |||
|- | |- | ||
| | | Port=3306 | ||
| Server details | |||
| Port number | |||
| 3306 | |||
| The port related to the host name (defined above) for update access to your database server | |||
| | |||
| | |||
| | |||
|- | |- | ||
| | | RealtimeMySql1MinLimit=0 | ||
| Realtime.txt upload | |||
| Limit Inserts: | |||
| 0 = false | |||
| Simple tick or not | |||
| | *Tick (value shown as 1 in Cumulus.ini) | ||
* Don't tick (value shown as 0 in Cumulus.ini) | |||
See explanation beside and below setting | |||
|- | |- | ||
| | | RealtimeMySqlEnabled=0 | ||
| Realtime.txt upload | |||
| Real time Enabled | |||
| 0 = don't display other options | |||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table. | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file | |||
| | |||
|- | |- | ||
| | | RealtimeRetention= | ||
| Realtime.txt upload | |||
| '''Data Retention value''' and '''Data Retention unit''' | |||
| "7" and "Days" | |||
| The value field will take any number, the unit field is a dropdown: | |||
* Seconds | |||
* Minutes | |||
* Hours | |||
* Days | |||
* Weeks | |||
* Months | |||
Taken together, these determine the period for which rows are kept in the table named in "RealtimeTable", any row older than this specification will be deleted as part of the automatic SQL | |||
|- | |- | ||
| <pre> | | RealtimeTable=Realtime | ||
| Realtime.txt upload | |||
| Table name | |||
| Realtime | |||
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself. | |||
|- | |||
| UpdateOnEdit=1 | |||
| General Options | |||
| Update MySQL on Edit | |||
| 1 = update the table when edit the file | |||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) | |||
* Don't tick (value shown as 0 in Cumulus.ini) | |||
Please see begining of previous table for explanation and warning about how all defaults must be set for this to work | |||
|- | |||
| User= | |||
| Server details | |||
| User name | |||
| (empty) | |||
| Database access user name, that matches with password described earlier | |||
|} | |||
==Optional Third-party Upload Settings== | |||
{| class="wikitable" border="1" | |||
|- | |||
!style="width:30px" | Parameter Line Entry | |||
!style="width:30px" | File Section | |||
!style="width:60px" | MX Section | |||
!style="width:80px" | Action on Settings page | |||
!style="width:20px" | Default | |||
|- | |||
| <pre>ID= | |||
pass=-1 | |||
server=cwop.aprs.net | |||
port=14580 | |||
Enabled=0 | |||
Interval=9 | |||
SendSR=0 | |||
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 | |||
|- | |||
| <pre>User= | |||
Password= | |||
Language=en | |||
Enabled=0 | Enabled=0 | ||
Interval= | Interval=900 | ||
SendUV=0 | SendUV=0 | ||
SendSR=0 | SendSR=0 | ||
SendSoilTemp=0 | |||
SendIndoor=0 | |||
SendSoilMoisture=0 | SendSoilMoisture=0 | ||
SendLeafWetness=0 | SendLeafWetness=0 | ||
SendAirQuality=0</pre> | |||
| [ | | [Awekas] | ||
| | | AWEKAS | ||
| Tick "Enabled" to see list of parameters so you can edit them | | Tick "Enabled" to see list of parameters so you can edit them | ||
| Defaults are as shown in list of parameters | | Defaults are as shown in list of parameters | ||
|- | |- | ||
| <pre>Enabled=0 | | <pre>Enabled=0 | ||
CatchUp=1 | |||
APIkey= | |||
StationId= | |||
Interval=15</pre> | |||
| [ | | [OpenWeatherMap] | ||
| | | OpenWeatherMap | ||
| Tick "Enabled" to see list of parameters so you can edit them | | Tick "Enabled" to see list of parameters so you can edit them | ||
| Defaults are as shown in list of parameters | | Defaults are as shown in list of parameters | ||
|- | |- | ||
| <pre> | | <pre>ID= | ||
Password= | |||
Enabled=0 | Enabled=0 | ||
Interval=15 | Interval=15 | ||
SendUV=0 | SendUV=0 | ||
SendSR=0 | |||
CatchUp=1</pre> | CatchUp=1</pre> | ||
| [ | | [PWSweather] | ||
| | | PWS Weather | ||
| Tick "Enabled" to see list of parameters so you can edit them | | Tick "Enabled" to see list of parameters so you can edit them | ||
| Defaults are as shown in list of parameters | | Defaults are as shown in list of parameters | ||
|- | |- | ||
| <pre> | | <pre>User= | ||
Password= | Password= | ||
Enabled=0 | Enabled=0 | ||
Interval=15 | Interval=60 | ||
OauthToken=unknown | |||
OauthTokenSecret=unknown | |||
TwitterSendLocation=1</pre> | |||
| [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 | |||
|- | |||
| <pre>Wid= | |||
Key= | |||
Enabled=0 | |||
Interval=10 | |||
SendUV=0 | |||
SendSR=0 | |||
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 | |||
StationUID= | |||
Password= | |||
Interval=1 | |||
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= | |||
StationIdx=0 | |||
Enabled=0 | |||
Interval=15 | |||
SendUV=0 | |||
CatchUp=1</pre> | |||
| [Windy] | |||
| Windy.com | |||
| Tick "Enabled" to see list of parameters so you can edit them | |||
| Defaults are as shown in list of parameters | |||
|- | |||
| <pre>ID= | |||
Password= | |||
Enabled=0 | |||
Interval=15 | |||
SendUV=0 | SendUV=0 | ||
SendSR=0 | SendSR=0 | ||
| Line 3,022: | Line 3,120: | ||
| 0 (disabled) | | 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 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 | * Don't tick (value shown as 0 in Cumulus.ini) to disable | ||
|- | |- | ||
| Line 3,692: | Line 3,790: | ||
| (always) | | (always) | ||
| Internet Settings → Moon Image | | Internet Settings → Moon Image | ||
| Upload Moon image file | | (FTP) Upload Moon image file | ||
| 0 (disabled) | | 0 (disabled) | ||
| Simple tick or not | | 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) | * 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 | * Don't tick (value shown as 0 in Cumulus.ini) to disable | ||
|- | |- | ||
| IntervalFtpEnabled=1 | |||
|IntervalFtpEnabled=1 | |||
| [FTP site] | | [FTP site] | ||
| Release 3.12.0 | | Release 3.12.0 | ||
| Line 3,726: | Line 3,807: | ||
* Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected '''LocalCopyEnabled''' (see below) | * Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected '''LocalCopyEnabled''' (see below) | ||
|- | |- | ||
| LocalCopyEnabled=0 | | 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] | | [FTP site] | ||
| Release 3.12.0 | | Release 3.12.0 | ||
| Line 3,744: | Line 3,837: | ||
| (blank) | | (blank) | ||
| Folder (including path) to which MX will copy the standard files (see rows marked ^ for further selections) if 'EnableLocalCopy' is enabled | | Folder (including path) to which MX will copy the standard files (see rows marked ^ for further selections) if 'EnableLocalCopy' is enabled | ||
|- | |||
| MoonImageEnabled=1 | |||
| [Graphs] | |||
| Release 3.5.0 | |||
| (always) | |||
| Internet Settings → Moon Image | |||
| Generate Moon Image | |||
| ^ Default controlled by selection of default web site | |||
| Simple tick or not | |||
* 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) if you don't need MX to create a "moon.png" | |||
|- | |||
| MoonImageSize= | |||
| [Graphs] | |||
| Release 3.5.0 | |||
| (always) | |||
| Internet Settings → Moon Image | |||
| Image size | |||
| ??? | |||
| Enter a size (in pixels) for the generated moon image (according to space on your web page) | |||
|- | |- | ||
| Password= | | Password= | ||
| Line 3,848: | Line 3,961: | ||
* Tick (value shown as 1 in Cumulus.ini) for MX to file transfer the [[realtime.txt]] file | * 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 | * 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= | | Sslftp= | ||
| Line 3,966: | Line 4,094: | ||
*If this parameter is set to zero, then MX will always 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== | ==Station specific alternatives== | ||
| Line 3,973: | Line 4,105: | ||
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! | 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! | ||
=== Solar=== | |||
Cumulus MX is unable to work out if you have a solar sensor, so these options are always displayed. | |||
{| 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) | |||
(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" | ||
| Line 4,019: | Line 4,218: | ||
===Airlink=== | ===Airlink=== | ||
The details in this sub-section need to be checked by someone who uses the relevant hardware. | |||
* Introduced Release | * Introduced Release | ||
| Line 4,050: | Line 4,251: | ||
===Davis=== | ===Davis=== | ||
Two Wiki sub-sections: | Two Wiki sub-sections, that need to be checked by by somebody who uses the relevant functionality: | ||
| Line 4,057: | Line 4,258: | ||
{{Template:WorkInProgressBanner}} This table does not yet have all details in it. | {{Template:WorkInProgressBanner}} This table does not yet have all details in it. | ||
* Introduced for | * Introduced for legacy Cumulus | ||
* File Section is [Station] | * File Section is [Station] | ||
* Only "Shown on Settings page" if either "Type=0" or "Type=1" | * Only "Shown on Settings page" if either "Type=0" or "Type=1" | ||
| Line 4,220: | Line 4,421: | ||
===EasyWeather (Reading File instead of connecting to a Weather Station)=== | ===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 | * Introduced in a Legacy version | ||
| Line 4,274: | Line 4,476: | ||
===Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific=== | ===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 | * Introduced in release 3.2.0 | ||
| Line 4,306: | Line 4,510: | ||
===Fine Offset Stations=== | ===Fine Offset Stations=== | ||
* Introduced in a Legacy version | * Introduced in a Legacy version | ||
| Line 4,319: | Line 4,520: | ||
|- | |- | ||
!style="width:30px" | Parameter Line Entry | !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:60px" | Label on Settings page | ||
!style="width:20px" | Default | !style="width:20px" | Default | ||
!style="width:300px" | Description | !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 | | SyncFOReads=0 | ||
| Legacy Cumulus | |||
| Only if Fine Offset selected | |||
| Station Settings → Fine Offset Settings | |||
| Synchronise Reads | | Synchronise Reads | ||
| 0 (disabled) | | 0 (disabled) | ||
| Line 4,329: | Line 4,572: | ||
* 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 | * 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 | * 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 | ||
| | |||
|} | |} | ||
| Line 4,359: | Line 4,589: | ||
{{Template:WorkInProgressBanner}} The following table has some gaps to fill in | {{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 | * Introduced in a Legacy version | ||
| Line 4,419: | Line 4,649: | ||
|} | |} | ||
===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]] | |||
===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" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:30px" | Parameter Line Entry | !style="width:30px" | Parameter Line Entry | ||
!style="width:100px" | | !style="width:100px" | External to MX edit | ||
!style="width:20px" | Default | !style="width:20px" | Default | ||
!style="width:300px" | Description | !style="width:300px" | Description | ||
| Line 4,442: | Line 4,703: | ||
|- | |- | ||
|Humidity98Fix=0 | |Humidity98Fix=0 | ||
| | | Stop MX and add this into file | ||
|0 (disable) | |0 (disable) | ||
|Applies to weather station types that never report more than 98% relative humidity. | |Applies to weather station types that never report more than 98% relative humidity. | ||
| Line 4,449: | Line 4,710: | ||
|- | |- | ||
|LogExtraSensors=0 | |LogExtraSensors=0 | ||
| | | Stop MX and add this into file | ||
|0 (disable) | |0 (disable) | ||
|This setting determines whether MX looks for readings from extra temperature probes etc. | |This setting determines whether MX looks for readings from extra temperature probes etc. | ||
| Line 4,456: | Line 4,717: | ||
|- | |- | ||
|WMR928TempChannel=N | |WMR928TempChannel=N | ||
| | | Stop MX and add this into file | ||
|(no | |(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 | |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 | |WMR200TempChannel=N | ||
| | | Stop MX and add this into file | ||
|(no | |(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 | |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 | ||
|} | |} | ||
| Line 4,521: | Line 4,782: | ||
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate wind chill from temperature and wind speed | * 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 | ** 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 | * Don't tick (value shown as 0 in Cumulus.ini) action depends on other items: | ||
** If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill | ** 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 | ** 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). | ||
** If station provides wind chill, then that value will be used provided no multiplier/offsets have been specified for temperature or wind speed. | |||
|- | |- | ||
| ChillHourSeasonStart= | | ChillHourSeasonStart= | ||
| Legacy Cumulus | | Legacy Cumulus | ||
| | | Chill Hours | ||
| | | Chill Season Starts | ||
| Default depends on release | | Default depends on release | ||
* (up to 3.11.4) 10 = October | * (up to 3.11.4) 10 = October | ||
| Line 4,537: | Line 4,798: | ||
| ChillHourThreshold= | | ChillHourThreshold= | ||
| Legacy Cumulus | | Legacy Cumulus | ||
| | | Chill Hours | ||
| | | Chill Hours | ||
| Default depends on Temperature Units | | Default depends on Temperature Units | ||
* Either 45 degrees Fahrenheit (equivalent to 7.22 <sup>o</sup>Celsius) | * Either 45 degrees Fahrenheit (equivalent to 7.22 <sup>o</sup>Celsius) | ||
| Line 4,577: | Line 4,838: | ||
| Humidity98Fix=0 | | Humidity98Fix=0 | ||
| Legacy Cumulus | | Legacy Cumulus | ||
| | | Common Options | ||
| | | Max humidity | ||
| 0 (disable) | | 0 (disable) | ||
| For any weather station that never reports a relative humidity greater than 98% | | For any weather station that never reports a relative humidity greater than 98% | ||
| Line 4,617: | Line 4,878: | ||
| RainDayThreshold= | | RainDayThreshold= | ||
| Legacy Cumulus | | Legacy Cumulus | ||
| | | Common Options → Advanced Options | ||
| | | Rain day threshold | ||
| | | Default is -1 which depends on Rainfall Units AND station type | ||
* -1 = normally 0.2 if units are millimetres | |||
* -1 = normally 0.01 if units are inches | |||
* Otherwise enter a value in your selected units | |||
| For derivatives like count of consecutive wet/dry days, any daily rainfall less than this threshold will be ignored. | | For derivatives like count of consecutive wet/dry days, any daily rainfall less than this threshold will be ignored. | ||
