Cumulus.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (view source)

Revision as of 05:11, 14 June 2022

7,348 bytes added ,  05:11, 14 June 2022
m
no edit summary
m (Oregon Scientific WM918/WMR928 Settings update)
mNo edit summary
(30 intermediate revisions by 4 users not shown)
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 support forum will explain this, as it appears people are losing some settings due to this file rewrite, and have to manually add those lost preferences back.''


=Purpose of Cumulus.ini file=
=Purpose of Cumulus.ini file=
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 31: 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 147: 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.


==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 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,927: Line 1,910:
|-
|-
| LogExtraSensors=0
| LogExtraSensors=0
| (Depends on station type)
| (Depends on station type) Only from Release 3.12.0
| Station settings &rarr; Common Options
| Station settings &rarr; Common Options
| Extra sensors
| Extra sensors
Line 1,953: Line 1,936:
| RainDayThreshold=-1
| RainDayThreshold=-1
| (with warning: "Here be dragons!")
| (with warning: "Here be dragons!")
| legacy cumulus
| Only from Release 3.12.0
| Depends on release:
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; Advanced options
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; Advanced options
|-1 (that represents 0.2 mm or 0.01 inches)
| 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 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''
''The intention is this will represent more than one tip, as the first tip might contain some rain from an earlier day''
|-
|-
| RolloverHour=0
| RolloverHour=0
Line 1,974: Line 1,956:
| SnowDepthHour=0
| SnowDepthHour=0
| (with warning: "Here be dragons!")
| (with warning: "Here be dragons!")
| legacy cumulus
| Only from Release 3.12.0
| Depends on release:
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.5.1 to 3.11.4) Manual edit of file
Line 2,005: 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 2,011: Line 1,993:
|}
|}


==Database==


==Debugging==


* Available from beta MX.
* Available from beta MX.
* File Section is [MySQL]
* 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:100px" | Shown on Settings page?
!style="width:300px" | MX Section
!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
|-
|-
| CustomMySqlMinutesCommandString=
| Logging=1
| only if "Custom Minutes Enabled"
| Depends on release installed:
| MySQL Settings &rarr; Monthly log file upload
# Alternatives:
| SQL command
#* (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.
| (blank)
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
| SQL to be obeyed at the interval defined in "CustomMySqlMinutesIntervalIndex"
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
# (Release 3.12.0 onwards) Program Settings &rarr; 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.
|-
|-
| CustomMySqlMinutesIntervalIndex=6
| DataLogging=1
| only if "Custom Minutes Enabled"
| Depends on release installed:
| MySQL Settings &rarr; Monthly log file upload
# Alternatives:
| Interval
#* (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.
| 6 = 10 minutes
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
| Time between custom SQL uploads:
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
* 0 = 1 minute
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
* 1 = 2 minutes
| Debug logging
* 2 = 3 minutes
| 0 (disabled)
* 3 = 4 minutes
| This adds extra information about both data transfers initiated from MX, and all the internal MX processes.
* 4 = 5 minutes
|}
* 5 = 6 minutes
 
* 6 = 10 minutes
== Display Options ==
* 7 = 12 minutes
 
* 8 = 20 minutes
* File Section is '''[Display]'''
* 9 = 30 minutes
* MX Section is '''Station Settings &rarr; Display Options'''
* 10 = 1 hour (60 minutes)
{| class="wikitable" border="1"
|-
|-
| CustomMySqlMinutesEnabled=0
!style="width:30px" | Parameter Line Entry
| (always)
!style="width:100px" | Introduced
| MySQL Settings
!style="width:60px" | Label on Settings page
| Custom Minutes Enabled
!style="width:20px" | Default
| Not ticked (shown as 0 in Cumulus.ini)
!style="width:600px" | Description
| Enable the optional functionality to run SQL at a selected interval in minutes
|-
|-
| CustomMySqlSecondsCommandString=
| DisplaySolarData=0
| only if "Custom Seconds Enabled"
| ??? 3.10.0 ???
| MySQL Settings &rarr; Monthly log file upload
| Display Solar data
| SQL command
| Unticked (shown as 0 in Cumulus.ini)
| (blank)
| Simple tick or not
| SQL to be obeyed at the interval defined in "CustomMySqlSecondsInterval"
* 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
|-
|-
| CustomMySqlSecondsInterval=10
| DisplayUvData=0
| only if "Custom Seconds Enabled"
| ??? 3.10.0 ???
| MySQL Settings &rarr; Monthly log file upload
| Display UV-I data 
| Interval
| Unticked (shown as 0 in Cumulus.ini)  
| 10 (seconds)
| Simple tick or not
| Time between custom SQL uploads
* 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
| 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=
| NumWindRosePoints=16
| when section opened
| Legacy Cumulus
| MySQL Settings &rarr; Server Details
| Number of wind rose points
| Database name
| 16
| (blank)
| 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
| The name given to the database that includes the table(s) you want to update
* 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.
|-
|-
| DayfileMySqlEnabled=0
| UseApparent=1
| (always)
| ??? MX 3.6.0 or 3.10.0 ???
| MySQL Settings
| Use Apparent Temperature
| Dayfile Enabled
| Ticked (shown as 1 in Cumulus.ini)
| Not ticked (shown as 0 in Cumulus.ini)
| Simple tick or not
| Enable the automatic upload to the table named in "DayfileTable" within the database named in "Database"
* 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"
|-
|-
| DayfileTable=Dayfile
!style="width:30px" | Parameter Line Entry
| when "Dayfile Enabled" is ticked and the next section is opened
!style="width:100px" | Label on Settings page
| MySQL Settings &rarr; Dayfile.txt upload
!style="width:20px" | Default
| Table name
!style="width:800px" | Description
| Dayfile
| Enables you to choose the name for the database table to be updated when "DayfileMySqlEnabled" is ticked
|-
|-
| Host=
|style="background:lightgray;"|[FTP site]
| when section opened
|
| MySQL Settings &rarr; Server Details
|
| Host name
|style="background:lightgray;"|Section name  
| (blank)
| Enter the database server name or Internet Protocol address
|-
|-
| MonthlyMySqlEnabled=0
|ExtraLocal0= to ExtraLocal99=
| (always)
|Local File Name
| MySQL Settings
|(empty)
| Monthly Log Enabled
|You can enter:
| Not ticked (shown as 0 in Cumulus.ini)
* A relative path name, with respect to the "CumulusMX" root folder
| Enable the automatic upload to the table named in "MonthlyTable" within the database named in "Database"
** 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>
|-
|-
| MonthlyTable=Monthly
|ExtraRemote0= to ExtraRemote99=
| when "Dayfile Enabled" is ticked and the next section is opened
|Destination Filename
| MySQL Settings &rarr; Monthly log file upload
|(empty)
| Table name
|Defines where MX is to upload file to
| Monthly
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
| Enables you to choose the name for the database table to be updated when "MonthlyMySqlEnabled" is ticked
**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
| Pass=
*** e.g. public_html/thismonthyear.htm
| when section opened
* If the FTP is not ticked, the file path should be full path for a file on the computer running MX
| MySQL Settings &rarr; Server Details
** 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]]
| Password
** 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]]
| (blank)
*You can place any of the following special tags into the entry
| Enter the password needed to access the database server specified in "Host"
** 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>
| Port=3306
*** 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
| when section opened
** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports
| MySQL Settings &rarr; Server Details
**  '''<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
| Port
| 3306
| Enter the port used to access the database server
|-
| RealtimeMySql1MinLimit=0
| When section opened
| MySQL Settings &rarr; 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
| (always)
| MySQL Settings
| Realtime enabled
| Not ticked (shown as 0 in Cumulus.ini)
| Enable the automatic upload to the table named in "RealtimeTable" within the database named in "Database"
|-
|-
| RealtimeRetention=
|ExtraProcess0= to ExtraProcess99=
| When section opened
|Process
| MySQL Settings &rarr; Raltime.txt upload
|0
| '''Data Retention value''' and '''Data Retention unit'''
|Simple tick or not
| "7" and "Days"
* 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'''
| The value field will take any number, the unit field is a dropdown:
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
* Seconds
* Minutes
* Hours
* Days
* Weeks
* Months
Taken together, these determine the period for which rows are kept in the table named in "RealtimeTable", any row older than this specification will be deleted as part of the automatic SQL
|-
|-
| RealtimeTable=Realtime
|ExtraRealtime0= to ExtraRealtime99=
| When section opened
|Realtime
| MySQL Settings &rarr; Raltime.txt upload
|0
| Table name
|Simple tick or not
| Realtime
*Tick (value shown as 1 in Cumulus.ini) if
| Enables you to choose the name for the database table to be updated when "RealtimeMySqlEnabled" is ticked
*# 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]])
|-
|-
| User=
|ExtraFTP0= to ExtraFTP99=
| when section opened
|FTP
| MySQL Settings &rarr; Server Details
|1
| User name
|Simple tick or not
| (blank)
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
| Enter the username associated with "Pass"
* 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
*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]])
|}
|}


==Debugging==
== Location==


* Available from beta MX.
* Introduced for legacy Cumulus
* File Section is [Station]
* 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:300px" | MX Section
!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
|-
|-
| Logging=1
| Altitude=0
| Depends on release installed:
| Station Settings &rarr; Location
# Alternatives:
| Altitude
#* (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.
| 0
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
| The height above mean sea level where the (pressure) sensor is positioned
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
# (Release 3.12.0 onwards) Program Settings &rarr; 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
| AltitudeInFeet=1
| Depends on release installed:
| Station Settings &rarr; Location
# Alternatives:
| Altitude Units
#* (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.
| Default depends on release:
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
# Legacy until 3.11.4: 1 (labelled as feet)
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
# From 3.12.0: 0 (labelled metres)
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
| Radio Setting
| Debug logging
* feet  (value shown as 1 in Cumulus.ini)
| 0 (disabled)
* metres (value shown as 0 in Cumulus.ini)
| This adds extra information about both data transfers initiated from MX, and all the internal MX processes.
|}
 
== Display Options ==
 
* File Section is '''[Display]'''
* MX Section is '''Station Settings &rarr; Display Options'''
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
| LocName=
!style="width:100px" | Introduced
| Station Settings &rarr; Location
!style="width:60px" | Label on Settings page
| Name
!style="width:20px" | Default
| (empty)
!style="width:600px" | Description
| A short name for the location
|-
|-
| DisplaySolarData=0
| LocDesc=
| ??? 3.10.0 ???
| Station Settings &rarr; Location
| Display Solar data
| Description
| Unticked (shown as 0 in Cumulus.ini)
| (empty)
| Simple tick or not
| A longer description for the location
* 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
| "Latitude=0" and "LatTxt="
| ??? 3.10.0 ???
| Station Settings &rarr; Location &rarr; Latitude
| Display UV-I data 
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; North or South"
| Unticked (shown as 0 in Cumulus.ini)  
| (blank)
| Simple tick or not
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
* 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
| "Longitude=0" and "LongTxt="
| Legacy Cumulus
| Station Settings &rarr; Location &rarr; Longitude
| Number of wind rose points
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; East or West"
| 16
| (blank)
| 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
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
* 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.
 
|-
==Optional Report Settings==
| UseApparent=1
 
| ??? MX 3.6.0 or 3.10.0 ???
* File Section is [NOAA]
| 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"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:100px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:800px" | Description
!style="width:300px" | Description
|-
|-
|style="background:lightgray;"|[FTP site]
| AutoCopy=0
|
| Release 3.12.0
|
| NOAA Reports Settings &rarr; FTP Options
|style="background:lightgray;"|Section name
| Auto Copy NOAA report files
| 0 (disable)
| 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]]
* Don't tick (value shown as 0 in Cumulus.ini) for no copy action
|-
|-
|ExtraLocal0= to ExtraLocal99=
| AutoFTP=0
|Local File Name
| First with Cumulus 2
|(empty)
| NOAA Reports Settings &rarr; FTP Options
|You can enter:
| Auto transfer NOAA report files
* A relative path name, with respect to the "CumulusMX" root folder
| 0 (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)
| Simple tick or not
** 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]
* 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)
** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
* 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=
| AutoSave=1
|Destination Filename
| First with Cumulus 2
|(empty)
| NOAA Reports Settings
|Defines where MX is to upload file to
| Create NOAA files after daily rollover
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
|0
**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
| Simple tick or not
*** e.g. httpdocs/dayfile.txt
* Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality
*** e.g. public_html/thismonthyear.htm
* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required
* 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=
| City=
|Process
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Site Details
|Simple tick or not
| City
* 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'''
| (empty)
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
| Enter here your hamlet, village, town, or city, name
|-
|-
|ExtraRealtime0= to ExtraRealtime99=
| CoolingThreshold=22
|Realtime
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Thresholds
|Simple tick or not
| Cooling threshold
*Tick (value shown as 1 in Cumulus.ini) if
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
*# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there
| [[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.
*# 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=
| CopyDirectory=
|FTP
| Release 3.12.0
|1
| NOAA Reports Settings &rarr; Report Options
|Simple tick or not
| Copy Directory
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
| (empty)
* 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
| The folder on the web server you host to which reports are to be copied
|-
|-
|ExtraUTF0= to ExtraUTF99=
| FTPDirectory=
|UTF-8
| First with Cumulus 2
|1
| NOAA Reports Settings &rarr; FTP Options
|Please see [[Reports_folder#Encoding|technical guidance on encoding]]
| destination folder
*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
* (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).
|-
|-
|ExtraBinary0= to ExtraBinary99=
| HeatingThreshold=15.5
|Binary
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Thresholds
|Simple tick or not
| Heating threshold
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
|[[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.
|-
|-
|ExtraEOD0= to ExtraEOD99=
| MaxTempComp1=22
|End of Day
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; Thresholds
|Simple tick or not
| Max temp comparison 1
*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]]
| (empty)
* 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]])
| 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
|}
 
== Location==
 
* Introduced for legacy Cumulus
* File Section is [Station]
 
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
| MaxTempComp2=0
!style="width:100px" | MX Section
| First with Cumulus 2
!style="width:60px" | Label on Settings page
| NOAA Reports Settings &rarr; Thresholds
!style="width:20px" | Default
| Max temp comparison 2
!style="width:600px" | Description
| (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
|-
|-
| Altitude=0
| MinTempComp1=15.5
| Station Settings &rarr; Location
| First with Cumulus 2
| Altitude
| NOAA Reports Settings &rarr; Thresholds
| 0
| Min temp comparison 1
| The height above mean sea level where the (pressure) sensor is positioned
|-
| AltitudeInFeet=1
| Station Settings &rarr; 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 &rarr; Location
| Name
| (empty)
| (empty)
| A short name for the location
| 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
|-
|-
| LocDesc=
| MinTempComp2=0
| Station Settings &rarr; Location
| First with Cumulus 2
| Description
| NOAA Reports Settings &rarr; Thresholds
| Min temp comparison 2
| (empty)
| (empty)
| A longer description for the location
| 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
|-
|-
| "Latitude=0" and "LatTxt="
| MonthFileFormat='NOAAMO'MMyy'.txt'
| Station Settings &rarr; Location &rarr; Latitude
| First with Cumulus 2
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; North or South"
| NOAA Reports Settings &rarr; Output Files
| (blank)
| Monthly filename format
| The selections made on this Settings Page sub-section will place the appropriate content in the two parameters in the file
| '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
| "Longitude=0" and "LongTxt="
| Station Settings &rarr; Location &rarr; Longitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; 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
|}


==Optional Report Settings==
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.
 
* File Section is [NOAA]
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
| Name=Personal Weather Station
!style="width:100px" | Introduced
| First with Cumulus 2
!style="width:100px" | MX Section
| NOAA Reports Settings &rarr; Site Details
!style="width:60px" | Label on Settings page
| Site Name
!style="width:20px" | Default
| (empty)
!style="width:300px" | Description
| What you would like to see in report title for your station name
|-
|-
| AutoCopy=0
| NOAAUseUTF8=1
| Release 3.12.0
| NOAA Reports Settings &rarr; FTP Options
| Auto Copy NOAA report files
| 0 (disable)
| 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]]
* Don't tick (value shown as 0 in Cumulus.ini) for no copy action
|-
| AutoFTP=0
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| NOAA Reports Settings &rarr; Report Options
| Auto transfer NOAA report files
| Use UTF-8 encoding
| 0 (disable)
| 1 (UTF-8)
| Simple tick or not
| Please see [[Reports_folder#Encoding]]
* 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)
* 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
* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
* 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
|-
|-
| AutoSave=1
| RainComp1=0.5
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings  
| NOAA Reports Settings &rarr; Thresholds
| Create NOAA files after daily rollover
| Rain comparison 1
|0
| (empty)
| Simple tick or not
| 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
* 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=
| RainComp2=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Site Details
| NOAA Reports Settings &rarr; Thresholds
| City
| Rain comparison 2
| (empty)
| (empty)
| Enter here your hamlet, village, town, or city, name
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
|-
| CoolingThreshold=22
| RainComp3=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Thresholds
| Cooling threshold
| Rain comparison 3  
| 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 &rarr; Report Options
| Copy Directory
| (empty)
| (empty)
| The folder on the web server you host to which reports are to be copied
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
|-
| FTPDirectory=
| State=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| NOAA Reports Settings &rarr; Site Details
| destination folder
| State
| Depends on release:
| (empty)
* (3.1.0 to 3.11.4) blank
| Enter here your local authority area or region (state in USA)
* (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
| UseDotDecimal=0
| First with Cumulus 2
| Release 3.9.5 - b3100
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Report Options
| Heating threshold
| Use a 'dot' decimal point
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
| 0 (disable)
|[[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.
| 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
|-
|-
| MaxTempComp1=22
| UseMinMaxAvg=0
| First with Cumulus 2
| Release 3.12.0
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Report Options
| Max temp comparison 1
| Use WHO average or Integrated average
| (empty)
| 0 (integrated average)
| 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
| 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
|-
|-
| MaxTempComp2=0
| YearFileFormat='NOAAYR'yyyy'.txt’
| First with Cumulus 2
| NOAA Reports Settings &rarr; 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
| NOAA Reports Settings &rarr; 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 &rarr; 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
| First with Cumulus 2
| NOAA Reports Settings &rarr; Output Files
| NOAA Reports Settings &rarr; Output Files
| Monthly filename format
| Yearly filename format
| 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''')
| 'NOAAYR'yyyy'.txt'
| Here you specify the filename template for MX to use when reading, or writing, monthly reports
| 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.  e.g. "NOAAMO"MMMyyyy".txt" would also be valid.
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.  
|-
|-
| Name=Personal Weather Station
|12hourformat=0
| First with Cumulus 2
| ???
| NOAA Reports Settings &rarr; Site Details
| NOAA Reports Settings &rarr; Output Files
| Site Name
|Time format
| (empty)
|0 (24 hour)
| What you would like to see in report title for your station name
| 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
|-
|-
| NOAAUseUTF8=1
| CumulusMX.exe
| First with Cumulus 2
| Data Logs menu
| NOAA Reports Settings &rarr; Report Options
| 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.
| 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
! rowspan="7" |CumulusMX.exe
| First with Cumulus 2
| Settings menu &rarr; MySQL settings &rarr; General Options
| NOAA Reports Settings &rarr; Thresholds
| 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.
| Rain comparison 1
| (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=
| Settings menu &rarr; MySQL settings &rarr; Realtime.txt Upload
| First with Cumulus 2
| 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]].
| NOAA Reports Settings &rarr; Thresholds
| Rain comparison 2
| (empty)
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
|-
| RainComp3=
| Settings menu &rarr; MySQL settings &rarr; Dayfile.txt Upload
| First with Cumulus 2
| 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.
| NOAA Reports Settings &rarr; Thresholds
|-
| Rain comparison 3
| Settings menu &rarr; MySQL settings &rarr; Monthly log file Upload
| (empty)
| 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]].
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
| Settings menu &rarr; MySQL settings &rarr; Custom Upload - seconds interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed.
|-
| Settings menu &rarr; MySQL settings &rarr; Custom Upload - minutes interval
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed.
|-
|-
| State=
| Settings menu &rarr; MySQL settings &rarr; Custom Upload - at rollover
| First with Cumulus 2
| 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.
| NOAA Reports Settings &rarr; Site Details
| State
| (empty)
| Enter here your local authority area or region (state in USA)
|-
|-
| UseDotDecimal=0
| ExportToMySQL.exe
| Release 3.9.5 - b3100
| parameters to utility
| NOAA Reports Settings &rarr; Report Options
| Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table)
| Use a 'dot' decimal point
|}
| 0 (disable)
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.
| Formatting real numbers for when NOAA report parsed by a script
 
Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags:
<pre>
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>'  ....);
 
 
BEGIN NOT ATOMIC
IF '<#web tag>' = '---' THEN
simpler query to run if something not numeric;
ELSE
UPDATE table_name_2 SET  column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 =  '<#web tag_name_2 modifier_2>'  ....  WHERE primary_key = '<#primary_key>';
END IF
END;
</pre>
 
* Introduced in Cumulus MX 3.0.0 beta
* File Section is [MySQL]
* MX page is Settings menu &rarr; MySQL settings


Simple tick or not
{| class="wikitable" border="1"
* 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
!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
|-
|-
| UseMinMaxAvg=0
| BufferOnFailure=0
| Release 3.12.0
| General Options
| NOAA Reports Settings &rarr; Report Options
| Buffer commands on failure
| Use WHO average or Integrated average
| 0 = ignore errors
| 0 (integrated average)
| Simple tick or not
| 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
*Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped)
* Don't tick (value shown as 0 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use integrated calculation: Sum of all temperature measurements divided by count of measurements
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors
|-
|-
| YearFileFormat='NOAAYR'yyyy'.txt’
| CustomMySqlMinutesCommandString=
| First with Cumulus 2
| Custom Upload - minutes interval
| NOAA Reports Settings &rarr; Output Files
| "SQL command" only shown if next parameter is ticked
| Yearly filename format
| (empty)
| 'NOAAYR'yyyy'.txt'
| See "predetermined SQL" example above
| 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
| CustomMySqlMinutesEnabled=0
| ???
| Custom Upload - minutes interval
| NOAA Reports Settings &rarr; Output Files
| Custom Minutes Enabled
|Time format
| 0 = don't display other options
|0 (24 hour)
| Simple tick or not
| How times are output on reports
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
* 24 Hour (value shown as 0 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
* 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 Third-party Upload Settings==
 
 
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
| CustomMySqlMinutesIntervalIndex=6
!style="width:30px" | File Section
| Custom Upload - minutes interval
!style="width:60px" | MX Section
| Interval:
!style="width:80px" | Action on Settings page
| 6 = 10 minutes
!style="width:20px" | Default
| Drop-down list of predetermined intervals:
|-
* 0 = 1 minute
| <pre>ID=
* 1 = 2 minutes
pass=-1
* 2 = 3 minutes
server=cwop.aprs.net
* 3 = 4 minutes
port=14580
* 4 = 5 minutes
Enabled=0
* 5 = 6 minutes
Interval=9
* 6 = 10 minutes
SendSR=0
* 7 = 12 minutes
APRSHumidityCutoff=0</pre>
* 8 = 20 minutes
| [APRS]
* 9 = 30 minutes
| APRS/CWOP
* 10 = 1 hour (60 minutes)
| Tick "Enabled" to see list of parameters so you can edit them
|-
| Defaults are as shown in list of parameters
| CustomMySqlRolloverCommandString=
|-
| Custom Upload - at rollover
| <pre>User=
| "SQL command" only shown if next parameter is ticked
  Password=
| (empty)
  Language=en
| See "predetermined SQL" example above
  Enabled=0
|-
  Interval=900
| CustomMySqlRolloverEnabled=0
  SendUV=0
| Custom Upload - at rollover
  SendSR=0
| Custom Rollover Enabled
  SendSoilTemp=0
| 0 = don't display other options
  SendIndoor=0
| Simple tick or not
  SendSoilMoisture=0
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
  SendLeafWetness=0
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
  SendAirQuality=0</pre>
|-
| [Awekas]
| CustomMySqlSecondsCommandString=
| AWEKAS
| Custom Upload - seconds interval
| Tick "Enabled" to see list of parameters so you can edit them
| "SQL command" only shown if next parameter is ticked
| Defaults are as shown in list of parameters
| (empty)
|-
| See "predetermined SQL" example above
| <pre>Enabled=0
|-
  CatchUp=1
| CustomMySqlSecondsEnabled=0
  APIkey=
| Custom Upload - seconds interval
  StationId=
| Custom Seconds Enabled
  Interval=15</pre>
| 0 = don't display other options
| [OpenWeatherMap]
| Simple tick or not
| OpenWeatherMap
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned
| Tick "Enabled" to see list of parameters so you can edit them
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings
| Defaults are as shown in list of parameters
|-
|-
| CustomMySqlSecondsInterval=10
| <pre>ID=
| Custom Upload - seconds interval
  Password=
| Interval (seconds):
  Enabled=0
| 10
  Interval=15
| A number field, takes 1 to 59
  SendUV=0
|-
  SendSR=0
| Database=
  CatchUp=1</pre>
| Server details
| [PWSweather]
| Database name:
| PWS Weather
| (empty)
| Tick "Enabled" to see list of parameters so you can edit them
| A text field where you enter the name of the database your tables are to be created/updated in
| Defaults are as shown in list of parameters
|-
|-
| DayfileMySqlEnabled=0
| <pre>User=
| Dayfile.txt upload
  Password=
| Dayfile Enabled
  Enabled=0
| 0
  Interval=60
| Simple tick or not
  OauthToken=unknown
*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
  OauthTokenSecret=unknown
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt
|-
| DayfileTable=
| Dayfile.txt upload
| Table name
| Dayfile
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal updates and "ExportToMySQl.exe"  will use the table name you define, but the option to update table when you edit "dayfile.txt" will fail (and if set to do so, keep failing as it repeats).
|-
| Host=Localhost
| Server details
| Host name
| (empty)
| Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost".
|-
| MonthlyMySqlEnabled=0
| Monthly logfile upload
| Monthly Log Enabled
| 0
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| MonthlyTable=
| Monthly logfile upload
| Table name
| Monthly
| Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020".  If you change the name here, normal updates and "ExportToMySQl.exe"  will use the table name you define, but the option to update table when you edit "MMMyyyyLog.txt" will fail (and if set to do so, keep failing as it repeats).
|-
| Pass=
| Server details
| Password
| (empty)
| Set to whatever password is used for update access with the database user name (see below)
|-
| Port=3306
| Server details
| Port number
| 3306
| The port related to the host name (defined above) for update access to your database server
|-
| RealtimeMySql1MinLimit=0
| Realtime.txt upload
| Limit Inserts:
| 0 = false
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
See explanation beside and below setting
|-
| RealtimeMySqlEnabled=0
| Realtime.txt upload
| Real time Enabled
| 0 = don't display other options
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table.
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file
|-
| RealtimeRetention=
| Realtime.txt upload
| '''Data Retention value''' and '''Data Retention unit'''
| "7" and "Days"
| The value field will take any number, the unit field is a dropdown:
* Seconds
* Minutes
* Hours
* Days
* Weeks
* Months
Taken together, these determine the period for which rows are kept in the table named in "RealtimeTable", any row older than this specification will be deleted as part of the automatic SQL
|-
| RealtimeTable=Realtime
| Realtime.txt upload
| Table name
| Realtime
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself.
|-
| UpdateOnEdit=1
| General Options
| Update MySQL on Edit
| 1 = update the table when edit the file
| Simple tick or not
*Tick (value shown as 1 in Cumulus.ini)
* Don't tick (value shown as 0 in Cumulus.ini)
Please see begining of previous table for explanation and warning about how all defaults must be set for this to work
|-
| User=
| Server details
| User name
| (empty)
| Database access user name, that matches with password described earlier
|}
 
 
==Optional 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
  Interval=900
  SendUV=0
  SendSR=0
  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
|-
| <pre>Enabled=0
  CatchUp=1
  APIkey=
  StationId=
  Interval=15</pre>
| [OpenWeatherMap]
| OpenWeatherMap
| 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
  SendSR=0
  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
  OauthToken=unknown
  OauthTokenSecret=unknown
  TwitterSendLocation=1</pre>
  TwitterSendLocation=1</pre>
| [Twitter]
| [Twitter]
Line 4,034: Line 4,104:


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 &rarr; Solar
| Solar Calculation Method
|  0=Ryan-Stololzenbach
| Drop-down list:
*  0=Ryan-Stololzenbach
* 1=Bras
|-
| SunThreshold=75
| [Solar]
| 3.13
| Station Settings &rarr; Solar
| Sun Threshold (percent)
| 75
| Enter a number
|-
| SolarMinimum=0
| [Solar]
| 3.13
| Station Settings &rarr; Solar
| Solar minimum (W/m2)
| 30
| Enter a number
|-
| RStransfactorJul=0.80000000000000004
| [Solar]
| 3.14
| Station Settings &rarr; 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 &rarr; 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===
===Selecting the weather station type determines which options are shown===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 4,121: 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 leagacy Cumulus
* 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,645: 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 '''Calibration settings'''
* 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).
Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
** 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
| (TO BE DETERMINED)
| 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,661: Line 4,798:
| ChillHourThreshold=
| ChillHourThreshold=
| Legacy Cumulus
| Legacy Cumulus
| (TO BE DETERMINED)
| 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,701: Line 4,838:
| Humidity98Fix=0
| Humidity98Fix=0
| Legacy Cumulus
| Legacy Cumulus
| (TO BE DETERMINED)
| Common Options
| n/a
| 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,741: Line 4,878:
| RainDayThreshold=
| RainDayThreshold=
| Legacy Cumulus
| Legacy Cumulus
| (TO BE DETERMINED)
| Common Options &rarr; Advanced Options
| n/a
| Rain day threshold
| (TO BE DETERMINED)
| 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.


Sfws
5,838

edits

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

Navigation menu