Cumulus.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (view source)

Revision as of 05:39, 13 September 2022

3,690 bytes added ,  05:39, 13 September 2022
m
Minor clarifications in response to forum post
m (Minor clarifications in response to forum post)
 
(55 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 10: Line 10:
=Purpose of Cumulus.ini file=
=Purpose of Cumulus.ini file=


This is a text file containing initialization parameters. {{Template:Version badge Mx}}This page covers those used by the Cumulus MX software application.
This is a text file containing initialization parameters. {{Template:Version badge Mx}}This page covers those used by the Cumulus MX software applica3.2.0 to 3.5.4tion.


For MX there can only to be one '''Cumulus.ini''' file, and it must be stored in the same folder as the executable "CumulusMX.exe".   
For MX there can only to be one '''Cumulus.ini''' file, and it must be stored in the same folder as the executable "CumulusMX.exe".   
Line 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"?==
 
 
= Why does this Wiki now contain multiple pages describing "Cumulus.ini"?=


[[Category:Configuration Files]]
[[Category:Configuration Files]]
Line 28: Line 30:
# Even more dramatic changes to the MX configuration have been happening since 3.8.0, with the biggest changes at 3.9.2, 3.10.0, and 3.12.0; therefore, <big>the decision was taken to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new empty page!</big>
# Even more dramatic changes to the MX configuration have been happening since 3.8.0, with the biggest changes at 3.9.2, 3.10.0, and 3.12.0; therefore, <big>the decision was taken to abandon maintaining the page previously called "Cumulus.ini", and start again with a brand new empty page!</big>


All the pages, previously called "Cumulus.ini", can be found from the owning [[:Category:Configuration Files|category]].  The original page was preserved at [[Cumulus.ini_(preserving_history)]] so look there for its editing history.  That page also expands on the above summary of why that old page was replaced by this new page.
 
All the pages, previously called "Cumulus.ini", can be found from the owning [[:Category:Configuration Files|category]].  The original page was preserved at [[Cumulus.ini_(preserving_history)]] so look there for its editing history.  That page also expands on the above summary of why that old page was replaced.
 
You will also note that this page does not cover all settings in detail, and find some links to further pages within some sections below
 
==Need to install MX 3.12.0 ==
 
If you are using Cumulus 1 or a release of MX earlier than 3.12.0, be aware that the content of "Cumulus.ini" is totally different to the file for later MX releases. (It might have been better had the file been given a new name in release 3.12.0).
 
The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from [https://github.com/cumulusmx/CumulusMX/releases/download/b3141/CumulusMXDist3141.zip here] and runs that release for a while before upgrading to the latest release [https://github.com/cumulusmx/CumulusMX here].


== Simplifications ==
== Simplifications ==
Line 145: Line 156:
The MX software offers much functionality and flexibility.  Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting.
The MX software offers much functionality and flexibility.  Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting.


==First run of MX==
<big>Please see [[First Run of MX]] for how to set up settings when you first use MX.</big>
 
This Wiki page does not explain how to start using MX, please see [[MX on Linux]], [[MX on Windows OS]], and [[MX Administrative Interface]] as appropriate.
 
The key fact relevant here is that no Cumulus release distribution contains a '''Cumulus.ini''' file. So when you first use the software,  you will need to use the [[MX_Administrative_Interface#Changing_Settings|admin interface]] to enter all settings (some have defaults that might be right for you) as described later in this page, and that will lead to creation of the main configuration file.
 
# If you start Cumulus MX without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this: [[File:MX first start.PNG]]
# As you can see, it is running, but it does not know what station type, so it cannot connect to it, and will not do anything more.
# At this stage, MX creates a very basic Cumulus.ini with the default settings (shown below).
#Open the [[MX Administrative Interface|admin interface]], and select the station settings if necessary: [[File:MX_station_settings.png|800px|center]]
# At the very minimum, you must select a station type and units (as shown in image here)
# Optionally, move down the page, entering more settings,
#* The settings that are displayed to you vary depending on the station type you have selected (and the particular MX release), so there is not a screenshot to show you the other settings for your station type.
# Optionally, move to other settings pages accessed from the menu seen in the image, these cover the optional functionality of MX, so the pages you need to visit depends on what functionality you wish to use.
# Optionally, use [[Samplestring.ini]] file as a guide to create a [[Strings.ini|strings.ini]] file (look up the cross reference if you want to do this now, but you can leave it to later) where you can tailor a number of texts that Cumulus produces.
#* The advantage of creating your '''strings.ini''' file now, is that it is read when MX starts, and we will shortly restart MX.
# Closing MX is the action that will create the main configuration file.
# MX must be stopped correctly, because it has to do a number of actions after it receives a request to close:
#* If you have a screen attached to the device running the MX engine, you can click in that screen and terminate Cumulus MX by typing '''C''' while holding down the control key (or equivalent if you are using an apple mac).
#* If you are connecting to MX from a remote device, then type into that remote session the control '''C'''.
#* Otherwise do whatever is needed to end the MX executable on your installation.
# Restart Cumulus MX, it will read your new settings (in '''Cumulus.ini''' and the optional '''strings.ini''') on re-starting, it will find the weather station, and start reading the weather data from it. On this first access to your weather station, it will not read any archive data (there is a way to modify [[today.ini]] so it can read what is in the separate logger), but from now (until you stop it) it will read (and from time to time log) the live data while MX remains running.


==What happens if I upgrade MX?==
==What happens if I upgrade MX?==
Line 271: Line 261:


As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file.  You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page.
As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file.  You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page.


=Tables listing Settings=
=Tables listing Settings=
Line 300: Line 288:
|}
|}


== Alarms and Email Settings ==
== Alarms (and emails) ==
 
 
{{Template:WorkInProgressBanner}} Please will somebody who uses this functionality complete this section, alarms have changed dramatically since 3.8.0 with introduction of email messages
{| 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:300px" | Description
|-
|
|
|
|
|
|}
[SMTP]
Enabled=0
ServerName=
Port=587
SSLOption=1
RequiresAuthentication=0
User=
Password=
Logging=0


[Alarms]
The Alarm settings seem to frequently be changed by new MX releases, so have been moved to a separate [[Alarms|wiki page]] where hopefully it will be easier for somebody to keep the content updated in future.
alarmlowtemp=0
LowTempAlarmSet=0
LowTempAlarmSound=0
LowTempAlarmSoundFile=alarm.mp3
alarmhightemp=0
HighTempAlarmSet=0
HighTempAlarmSound=0
HighTempAlarmSoundFile=alarm.mp3
alarmtempchange=0
TempChangeAlarmSet=0
TempChangeAlarmSound=0
TempChangeAlarmSoundFile=alarm.mp3
alarmlowpress=0
LowPressAlarmSet=0
LowPressAlarmSound=0
LowPressAlarmSoundFile=alarm.mp3
alarmhighpress=0
HighPressAlarmSet=0
HighPressAlarmSound=0
HighPressAlarmSoundFile=alarm.mp3
alarmpresschange=0
PressChangeAlarmSet=0
PressChangeAlarmSound=0
PressChangeAlarmSoundFile=alarm.mp3
alarmhighraintoday=0
HighRainTodayAlarmSet=0
HighRainTodayAlarmSound=0
HighRainTodayAlarmSoundFile=alarm.mp3
alarmhighrainrate=0
HighRainRateAlarmSet=0
HighRainRateAlarmSound=0
HighRainRateAlarmSoundFile=alarm.mp3
alarmhighgust=0
HighGustAlarmSet=0
HighGustAlarmSound=0
HighGustAlarmSoundFile=alarm.mp3
alarmhighwind=0
HighWindAlarmSet=0
HighWindAlarmSound=0
HighWindAlarmSoundFile=alarm.mp3
SensorAlarmSet=0
SensorAlarmSound=0
SensorAlarmSoundFile=alarm.mp3
DataStoppedAlarmSet=0
DataStoppedAlarmSound=0
DataStoppedAlarmSoundFile=alarm.mp3
BatteryLowAlarmSet=0
BatteryLowAlarmSound=0
BatteryLowAlarmSoundFile=alarm.mp3
DataSpikeAlarmSet=0
DataSpikeAlarmSound=0
DataSpikeAlarmSoundFile=alarm.mp3


==Charts==
==Charts==
Line 659: Line 567:
!style="width:600px" | Description
!style="width:600px" | Description
|-
|-
| StartDate=
| DataLogInterval=2
| (with warning: "Here be dragons!")
| (Always)
| Station Settings &rarr; Advanced Options
| Station settings &rarr; General Settings
| Records Began date
| Log interval
| (Set when you first use Cumulus)
| 2 (10 minutes)
| 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.
| Drop-down:
* 0 = 1 minute between MX logs into the one to three [[Monthly_log_files]] (i.e. [[Standard log files]], and optionally [[Extra Sensor Files]], [[Air_Link_Log.txt]])
* 1 = 5 minutes between MX logging lines
* 2 = 10 minutes between MX logging lines
* 3 = 15 minutes between MX logging lines
* 4 = 20 minutes between MX logging lines
* 5 = 30 minutes between MX logging lines
|-
| LogExtraSensors=0
| (Depends on station type) Only from Release 3.12.0
| Station settings &rarr; Common Options
| Extra sensors
| 0 (disabled)
|Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if your weather station can output readings to be logged in [[Extra Sensor Files]]
* Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files.
|-
|-
| NoSensorCheck=0
| NoSensorCheck=0
Line 682: Line 605:
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).
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).
|-
|-
| UseDataLogger=1
| RainDayThreshold=-1
| (probably determined by station type)
| (with warning: "Here be dragons!")
| (not known)
| Depends on release:
| (not known)
* (3.5.1 to 3.11.4) Manual edit of file
| 1 (enabled)
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; Advanced options
|Simple tick or not
| Rain day threshold
* 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"
| -1 (that represents 0.2 mm or 0.01 inches)
* 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
| 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''
|-
|-
| DataLogInterval=2
| RolloverHour=0
| (Always)
| (Always)
| Station settings &rarr; General Settings
| Station settings &rarr; Log Rollover
| Log interval
| Time
| 2 (10 minutes)
| 0 (midnight)
| Drop-down:
| Radio type selection:
* 0 = 1 minute between MX logs into the one to three [[Monthly_log_files]] (i.e. [[Standard log files]], and optionally [[Extra Sensor Files]], [[Air_Link_Log.txt]])
* 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 = 5 minutes between MX logging lines
* 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
* 2 = 10 minutes between MX logging lines
|-
* 3 = 15 minutes between MX logging lines
| SnowDepthHour=0
* 4 = 20 minutes between MX logging lines
| (with warning: "Here be dragons!")
* 5 = 30 minutes between MX logging lines
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; 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 &rarr; Common Options &rarr; 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.
|-
|-
| LogExtraSensors=0
| UseDataLogger=1
| (Depends on station type)
| (probably determined by station type)
| Station settings &rarr; Common Options
| (not known)
| Extra sensors
| (not known)
| 0 (disabled)
| 1 (enabled)
|Simple tick or not
|Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if your weather station can output readings to be logged in [[Extra Sensor Files]]
* 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 you have nothing to log to Extra Sensor Files.
* 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
|-
|-
| RolloverHour=0
| Use10amInSummer=1
| (Always)
| (Always)
| Station settings &rarr; Log Rollover
| Station settings &rarr; Log Rollover
| Time
| Use 10am in Summer
| 0 (midnight)
| 1 (normal)
| Radio type selection:
* 0 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches midnight
* 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
|-
| Use10amInSummer=1
| (Always)
| Station settings &rarr; Log Rollover
| Use 10am in Summer
| 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 734: Line 664:
|}
|}


==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
==Extra Web Files==
* 7 = 12 minutes
 
* 8 = 20 minutes
There are 100 occurrences of each parameter in Cumulus.ini, and therefore each parameter has a base name followed by numbers 0 to 99.
* 9 = 30 minutes
 
* 10 = 1 hour (60 minutes)
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.
|-
 
| CustomMySqlMinutesEnabled=0
'''You MUST restart MX after any changes in this section, before the new settings take effect.'''
| (always)
 
| MySQL Settings
{| class="wikitable" border="1"
| Custom Minutes Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| Enable the optional functionality to run SQL at a selected interval in minutes
|-
| CustomMySqlSecondsCommandString=
| only if "Custom Seconds Enabled"
| MySQL Settings &rarr; Monthly log file upload
| SQL command
| (blank)
| SQL to be obeyed at the interval defined in "CustomMySqlSecondsInterval"
|-
| CustomMySqlSecondsInterval=10
| only if "Custom Seconds Enabled"
| MySQL Settings &rarr; Monthly log file upload
| Interval
| 10 (seconds)
| Time between custom SQL uploads
|-
|-
| CustomMySqlSecondsEnabled=0
!style="width:30px" | Parameter Line Entry
| (always)
!style="width:100px" | Label on Settings page
| MySQL Settings
!style="width:20px" | Default
| Custom Minutes Enabled
!style="width:800px" | Description
| Not ticked (shown as 0 in Cumulus.ini)
| Enable the optional functionality to run SQL at a selected interval in seconds
|-
|-
| Database=
|style="background:lightgray;"|[FTP site]
| when section opened
|
| MySQL Settings &rarr; Server Details
|
| Database name
|style="background:lightgray;"|Section name  
| (blank)
| The name given to the database that includes the table(s) you want to update
|-
|-
| DayfileMySqlEnabled=0
|ExtraLocal0= to ExtraLocal99=
| (always)
|Local File Name
| MySQL Settings
|(empty)
| Dayfile 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 "DayfileTable" 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]
| DayfileTable=Dayfile
** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
| when "Dayfile Enabled" is ticked and the next section is opened
* A full path name for a file on the computer running MX
| MySQL Settings &rarr; Dayfile.txt upload
** e.g. '''/home/pi/documents/myFile'''
| Table name
** e.g. '''C:\Users\Public\Documents\working.txt'''
| Dayfile
*You can place any of the following special tags into the entry
| Enables you to choose the name for the database table to be updated when "DayfileMySqlEnabled" is ticked
** These should be typed as shown on their own
|-
*** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports 
| Host=
***  '''<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>
| when section opened
| MySQL Settings &rarr; Server Details
| Host name
| (blank)
| Enter the database server name or Internet Protocol address
|-
| MonthlyMySqlEnabled=0
| (always)
| MySQL Settings
| Monthly Log Enabled
| Not ticked (shown as 0 in Cumulus.ini)
| Enable the automatic upload to the table named in "MonthlyTable" within the database named in "Database"
|-
| MonthlyTable=Monthly
| when "Dayfile Enabled" is ticked and the next section is opened
| MySQL Settings &rarr; Monthly log file upload
| Table name
| Monthly
| Enables you to choose the name for the database table to be updated when "MonthlyMySqlEnabled" is ticked
|-
| Pass=
| when section opened
| MySQL Settings &rarr; Server Details
| Password
| (blank)
| Enter the password needed to access the database server specified in "Host"
|-
|-
| Port=3306
|ExtraRemote0= to ExtraRemote99=
| when section opened
|Destination Filename
| MySQL Settings &rarr; Server Details
|(empty)
| Port
|Defines where MX is to upload file to
| 3306
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
| Enter the port used to access the database server
**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
|-
|-
| RealtimeMySql1MinLimit=0
|ExtraProcess0= to ExtraProcess99=
| When section opened
|Process
| MySQL Settings &rarr; Raltime.txt upload
|0
| Limit real time table inserts to once a minute 
|Simple tick or not
| Not ticked (shown as 0 in Cumulus.ini)
* 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'''
| Enable the optional functionality to limit database uploads, if your real time interval has been set to less than 60 seconds
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
|-
| 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=
| When section opened
| MySQL Settings &rarr; Raltime.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
|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
|}
 
==Debugging==
 
* Available from beta MX.
* File Section is [Station]
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
|ExtraUTF0= to ExtraUTF99=
!style="width:300px" | MX Section
|UTF-8
!style="width:60px" | Label on Settings page
|1
!style="width:20px" | Default
|Please see [[Reports_folder#Encoding|technical guidance on encoding]]
!style="width:600px" | Description
*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
|-
|-
| Logging=1
|ExtraBinary0= to ExtraBinary99=
| Depends on release installed:
|Binary
# Alternatives:
|0
#* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
|Simple tick or not
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
# (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
|ExtraEOD0= to ExtraEOD99=
| Depends on release installed:
|End of Day
# Alternatives:
|0
#* (Releases 3.0.0 to 3.9.8) Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: DataLogging = 1, then restart Cumulus MX.
|Simple tick or not
#* (Releases 3.1.0 to 3.9.3) Station Settings &rarr Options
*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]]
# (Release 3.9.4 to 3.11.4) Program Settings &rarr; Program General Options
* 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]])
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
| Debug logging
| 0 (disabled)
| This adds extra information about both data transfers initiated from MX, and all the internal MX processes.
|}
|}


== Display Options ==
== Location==
 
* Introduced for legacy Cumulus
* File Section is [Station]


* File Section is '''[Display]'''
* MX Section is '''Station Settings &rarr; Display Options'''
{| 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" | 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
|-
|-
| DisplaySolarData=0
| Altitude=0
| ??? 3.10.0 ???
| Station Settings &rarr; Location
| Display Solar data
| Altitude
| Unticked (shown as 0 in Cumulus.ini)
| 0
| Simple tick or not
| The height above mean sea level where the (pressure) sensor is positioned
* 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
| AltitudeInFeet=1
| ??? 3.10.0 ???
| Station Settings &rarr; Location
| Display UV-I data 
| Altitude Units
| Unticked (shown as 0 in Cumulus.ini)  
| Default depends on release:
| Simple tick or not
# Legacy until 3.11.4: 1 (labelled as feet)
* 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)
# From 3.12.0: 0 (labelled metres)
* 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
| Radio Setting
* feet  (value shown as 1 in Cumulus.ini)
* metres (value shown as 0 in Cumulus.ini)
|-
|-
| NumWindRosePoints=16
| LocName=
| Legacy Cumulus
| Station Settings &rarr; Location
| Number of wind rose points
| Name
| 16
| (empty)
| 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
| A short name for the location
* 8 points
|-
* 16 points
| LocDesc=
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.
| Station Settings &rarr; Location
| Description
| (empty)
| A longer description for the location
|-
| "Latitude=0" and "LatTxt="
| Station Settings &rarr; Location &rarr; Latitude
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; 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
|-
|-
| UseApparent=1
| "Longitude=0" and "LongTxt="
| ??? MX 3.6.0 or 3.10.0 ???
| Station Settings &rarr; Location &rarr; Longitude
| Use Apparent Temperature
| "Degrees", "Minutes", "Seconds", and "Hemisphere &rarr; East or West"
| Ticked (shown as 1 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 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.
==Optional Report Settings==
 
The settings interface presents the rows on multiple pages, the rows are not numbered, so you have to do some counting to work out which row in the admin interface page corresponds with which parameter in Cumulus.ini file.


* 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" | 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
**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
|0
|Simple tick or not
| 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'''
* 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 you want local file uploaded with existing content
* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required
|-
|-
|ExtraRealtime0= to ExtraRealtime99=
| City=
|Realtime
| 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
| (empty)
*# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there
| Enter here your hamlet, village, town, or city, name
*# 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=
| CoolingThreshold=22
|FTP
| First with Cumulus 2
|1
| NOAA Reports Settings &rarr; Thresholds
|Simple tick or not
| Cooling threshold
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
* 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
| [[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.
|-
|-
|ExtraUTF0= to ExtraUTF99=
| CopyDirectory=
|UTF-8
| Release 3.12.0
|1
| NOAA Reports Settings &rarr; Report Options
|Please see [[Reports_folder#Encoding|technical guidance on encoding]]
| Copy Directory
*Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters
| (empty)
*If unticked (0 appears in file), then iso-8859-1 encoding is used
| The folder on the web server you host to which reports are to be copied
|-
|-
|ExtraBinary0= to ExtraBinary99=
| FTPDirectory=
|Binary
| First with Cumulus 2
|0
| NOAA Reports Settings &rarr; FTP Options
|Simple tick or not
| destination folder
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
| Depends on release:
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
* (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).
|-
|-
|ExtraEOD0= to ExtraEOD99=
| HeatingThreshold=15.5
|End of Day
| 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 to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
* 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]])
|[[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.
|}
 
== Location==
 
* Introduced for legacy Cumulus
* File Section is [Station]
 
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
| MaxTempComp1=22
!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 1
!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 first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit
|-
|-
| Altitude=0
| MaxTempComp2=0
| Station Settings &rarr; Location
| First with Cumulus 2
| Altitude
| NOAA Reports Settings &rarr; Thresholds
| 0
| Max temp comparison 2
| The height above mean sea level where the (pressure) sensor is positioned
| (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
|-
|-
| AltitudeInFeet=1
| MinTempComp1=15.5
| Station Settings &rarr; Location
| First with Cumulus 2
| Altitude Units
| NOAA Reports Settings &rarr; Thresholds
| Default depends on release:
| Min temp comparison 1
# 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
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| NOAA Reports Settings &rarr; Report Options
| Auto Copy 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) if your report is to be copied to copy directory during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
* Tick (value shown as 1 in Cumulus.ini) for 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) for no copy action
* 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
|-
|-
| AutoFTP=0
| RainComp1=0.5
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| NOAA Reports Settings &rarr; Thresholds
| Auto transfer NOAA report files
| Rain comparison 1
| 0 (disable)
| (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) to enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed)
* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
|-
|-
| AutoSave=1
| RainComp2=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings  
| NOAA Reports Settings &rarr; Thresholds
| Create NOAA files after daily rollover
| Rain comparison 2
|0
| (empty)
| Simple tick or not
| The report will count the number of days when the daily rainfall exceeds this 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=
| RainComp3=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Site Details
| NOAA Reports Settings &rarr; Thresholds
| City
| Rain comparison 3
| (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
| State=
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Site Details
| Cooling threshold
| State
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
| (empty)
| [[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.
| Enter here your local authority area or region (state in USA)
|-
| UseDotDecimal=0
| Release 3.9.5 - b3100
| NOAA Reports Settings &rarr; 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
|-
|-
| CopyDirectory=
| UseMinMaxAvg=0
| Release 3.12.0
| Release 3.12.0
| NOAA Reports Settings &rarr; Report Options
| NOAA Reports Settings &rarr; Report Options
| Copy Directory
| Use WHO average or Integrated average
| (empty)
| 0 (integrated average)
| The folder on the web server you host to which reports are to be copied
| 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
|-
|-
| FTPDirectory=
| YearFileFormat='NOAAYR'yyyy'.txt’
| First with Cumulus 2
| First with Cumulus 2
| NOAA Reports Settings &rarr; FTP Options
| NOAA Reports Settings &rarr; Output Files
| destination folder
| Yearly filename format
| (empty)
| 'NOAAYR'yyyy'.txt'
| Where you want MX to use as destination folder on your FTP server
| Here you specify the filename template for MX to use when reading, or writing, yearly reports
*Leave blank and MX will use wherever has been specified in main internet settings (this fits how the default web site is designed to work)
 
* Specify a folder relative to FTP root, and MX will upload reports to that folder instead (if you use any files from default web site, then you will need to amend the JavaScript file:
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.  
<code>let rptPath = '';  // Your path should have a trailing "/", eg. 'Reports/'</code> by putting your folder name in, an example is given for the case when “/Reports” is a sub folder off the main upload destination, note how you don’t include a leading slash, but you must add a trailing one.
|-
|-
| HeatingThreshold=15.5
|12hourformat=0
| First with Cumulus 2
| ???
| NOAA Reports Settings &rarr; Thresholds
| NOAA Reports Settings &rarr; Output Files
| Heating threshold
|Time format
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
|0 (24 hour)
|[[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.
| How times are output on reports
|-
* 24 Hour (value shown as 0 in Cumulus.ini)
| MaxTempComp1=22
* 12 Hour (value shown as 1 in Cumulus.ini)
| First with Cumulus 2
|}
| NOAA Reports Settings &rarr; Thresholds
 
| Max temp comparison 1
 
| (empty)
===Normal Mean Temperatures===
| 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
 
|-
* File Section is [NOAA]
| MaxTempComp2=0
* The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
| First with Cumulus 2
* There is one box labelled for each month on the settings screens
| NOAA Reports Settings &rarr; Thresholds
* All the defaults are (blank)
| Max temp comparison 2
* 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
| (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
===Normal Precipitation===
 
* File Section is [NOAA]
Rainfall equivalents of mean temperature described above
 
 
==Optional Structured Query Language Settings==
 
MX uses a software package called "MySqlConnect" to run SQL queries.
 
Since the text that appeared here was added, documenting plans for the future 3.12.0 release, there have been a number of changes, and now a future release (3.20.0) is expected to make more drastic changes. Therefore the content has been moved to a [[MySqlConnect|new "MySqlConnect" page]] where it is hoped somebody will find it easier to update the content as MX develops.
 
 
==Optional Third-party Upload Settings==
 
 
{| class="wikitable" border="1"
|-
|-
| MinTempComp1=15.5
!style="width:30px" | Parameter Line Entry
| First with Cumulus 2
!style="width:30px" | File Section
| NOAA Reports Settings &rarr; Thresholds
!style="width:60px" | MX Section
| Min temp comparison 1
!style="width:80px" | Action on Settings page
| (empty)
!style="width:20px" | Default
| 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
| <pre>ID=
| First with Cumulus 2
pass=-1
| NOAA Reports Settings &rarr; Thresholds
server=cwop.aprs.net
| Min temp comparison 2
port=14580
| (empty)
Enabled=0
| 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
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
|-
|-
| MonthFileFormat='NOAAMO'MMyy'.txt'
| <pre>User=
| First with Cumulus 2
Password=
| NOAA Reports Settings &rarr; Output Files
Language=en
| Monthly filename format
Enabled=0
| 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''')
Interval=900
| Here you specify the filename template for MX to use when reading, or writing, monthly reports
SendUV=0
 
SendSR=0
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid.
  SendSoilTemp=0
|-
SendIndoor=0
| Name=Personal Weather Station
SendSoilMoisture=0
| First with Cumulus 2
SendLeafWetness=0
| NOAA Reports Settings &rarr; Site Details
SendAirQuality=0</pre>
| Site Name
| [Awekas]
| (empty)
| AWEKAS
| What you would like to see in report title for your station name
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
|-
| NOAAUseUTF8=1
| <pre>Enabled=0
| First with Cumulus 2
CatchUp=1
| NOAA Reports Settings &rarr; Report Options
APIkey=
| Use UTF-8 encoding
StationId=
| 1 (UTF-8)
Interval=15</pre>
| Please see [[Reports_folder#Encoding]]
| [OpenWeatherMap]
* 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
| OpenWeatherMap
* 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
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
|-
| RainComp1=0.5
| <pre>ID=
| First with Cumulus 2
Password=
| NOAA Reports Settings &rarr; Thresholds
Enabled=0
| Rain comparison 1
Interval=15
| (empty)
SendUV=0
| 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
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
|-
|-
| RainComp2=
| <pre>User=
| First with Cumulus 2
Password=
| NOAA Reports Settings &rarr; Thresholds
Enabled=0
| Rain comparison 2
Interval=60
| (empty)
OauthToken=unknown
| The report will count the number of days when the daily rainfall exceeds this threshold.
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
|-
|-
| RainComp3=
| <pre>Wid=
| First with Cumulus 2
Key=
| NOAA Reports Settings &rarr; Thresholds
Enabled=0
| Rain comparison 3
Interval=10
| (empty)
SendUV=0
| The report will count the number of days when the daily rainfall exceeds this threshold.
SendSR=0
|-
SendAQI=0
| State=
SendSoilMoisture=0
| First with Cumulus 2
SoilMoistureSensor=0
| NOAA Reports Settings &rarr; Site Details
SendLeafWetness=0
| State
LeafWetnessSensor=0</pre>
| (empty)
| [WeatherCloud]
| Enter here your local authority area or region (state in USA)
| WeatherCloud
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
|-
| UseDotDecimal=0
| <pre>Enabled=0
| Release 3.9.5 - b3100
StationUID=
| NOAA Reports Settings &rarr; Report Options
Password=
| Use a 'dot' decimal point
Interval=1
| 0 (disable)
SendRain=0</pre>
| Formatting real numbers for when NOAA report parsed by a script
| [WindGuru]
 
| Windguru
Simple tick or not
| Tick "Enabled" to see list of parameters so you can edit them
* Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma
| Defaults are as shown in list of parameters
* Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale
|-
|-
| UseMinMaxAvg=0
| <pre>APIkey=
| Release 3.12.0
StationIdx=0
| NOAA Reports Settings &rarr; Report Options
Enabled=0
| Use WHO average or Integrated average
Interval=15
| 0 (integrated average)
SendUV=0
| Simple tick or not
CatchUp=1</pre>
* Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2
| [Windy]
* 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
| Windy.com
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
|-
| YearFileFormat='NOAAYR'yyyy'.txt’
| <pre>ID=
| First with Cumulus 2
Password=
| NOAA Reports Settings &rarr; Output Files
Enabled=0
| Yearly filename format
Interval=15
| 'NOAAYR'yyyy'.txt'
SendUV=0
| Here you specify the filename template for MX to use when reading, or writing, yearly reports
SendSR=0
CatchUp=1</pre>
| [WOW]
| Met Office WOW
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|}
 
==Optional Web Server==
 
There are two sub-sections below, because the settings for the optional web functionality are split between '''Station Settings''' and  '''Internet Settings'''.
 
 
=== Display Options controlling what appears on default web pages ===


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.
* File Section is '''[Display]'''
|-
* MX Section is '''Station Settings &rarr; Display Options'''
|12hourformat=0
{| class="wikitable" border="1"
| ???
| NOAA Reports Settings &rarr; Output Files
|Time format
|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 Third-party Upload Settings==
 
 
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:30px" | File Section
!style="width:100px" | Introduced
!style="width:60px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:80px" | Action on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
|-
|-
| <pre>ID=
| DisplaySolarData=0
pass=-1
| ??? 3.10.0 ???
server=cwop.aprs.net
| Display Solar data
port=14580
| Unticked (shown as 0 in Cumulus.ini)
Enabled=0
| Simple tick or not
Interval=9
* 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)
SendSR=0
* Don't tick (value shown as 0 in Cumulus.ini) if you want MX to suppress the table cells that would display solar data
APRSHumidityCutoff=0</pre>
|-
| [APRS]
| DisplayUvData=0
| APRS/CWOP
| ??? 3.10.0 ???
| Tick "Enabled" to see list of parameters so you can edit them
| Display UV-I data 
| Defaults are as shown in list of parameters
| 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
|-
|-
| <pre>User=
| NumWindRosePoints=16
Password=
| Legacy Cumulus
Language=en
| Number of wind rose points
Enabled=0
| 16
Interval=900
| 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
SendUV=0
* 8 points
SendSR=0
* 16 points
SendSoilTemp=0
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.
  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
| UseApparent=1
CatchUp=1
| ??? MX 3.6.0 or 3.10.0 ???
APIkey=
| Use Apparent Temperature
StationId=
| Ticked (shown as 1 in Cumulus.ini)
Interval=15</pre>
| Simple tick or not
| [OpenWeatherMap]
* 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
| OpenWeatherMap
* 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
| Tick "Enabled" to see list of parameters so you can edit them
|}
| Defaults are as shown in list of parameters
 
|-
 
| <pre>ID=
=== File transfer and Copy Options controlling transfer of data to default web pages ===
Password=
 
Enabled=0
The settings listed in table below changed dramatically at both 3.10.0 and 3.12.0 releases, but they have gradually evolved throughout the development of MX.
Interval=15
 
SendUV=0
From 3.12.0, MX can optionally ''either'' '''copy''' files to a [[Your Own Server|web server you host]] ''or'' '''file transfer''' files to a [[Webspace|commercial web server]].
SendSR=0
 
CatchUp=1</pre>
To implement (and customise) this web server functionality, there are many settings as listed alphabetically in this table.  The ''Internet settings'' page simplifies making settings by providing selections that amend multiple settings in a bulk operation:
| [PWSweather]
* Some settings (marked ^ in table) are only displayed if you select '''I want to use the supplied default web site'''.
| PWS Weather
** For these settings, the "Generate" option is enabled in nearly all (see any qualifier) settings
| Tick "Enabled" to see list of parameters so you can edit them
** If you select "Enable file copy of standard files" (default is disabled) then those settings have their "Copy" option enabled in nearly all (see any qualifier) cases, and their "FTP Transfer" option deselected (instead of defaults shown in table)
| Defaults are as shown in list of parameters
** If you deselect "Enable file transfer of standard files" (default is enabled) then those settings have their "Copy" option disabled, and their "FTP Transfer" option enabled in nearly all (see any qualifier) cases (as per defaults shown in table)
* '''The default selections assume you have air quality, and solar, sensors; so you may need to disable some of the defaults the above selections have made'''
* If you don't select '''I want to use the supplied default web site''', then all the settings marked ^ are disabled
** This is what you want if you do not use the MX optional web server functionality
** If you have a customised  web site, you may want to select '''I want to use the supplied default web site'''  to see the settings that would otherwise all be disabled, and then pick any options that would be useful to you.
{| class="wikitable" border="1"
|-
|-
| <pre>User=
!style="width:30px" | Parameter Line Entry
Password=
!style="width:100px" | File Section
Enabled=0
!style="width:100px" | Introduced
Interval=60
!style="width:100px" | Shown on Settings page?
OauthToken=unknown
!style="width:100px" | MX Section
OauthTokenSecret=unknown
!style="width:60px" | Label on Settings page
TwitterSendLocation=1</pre>
!style="width:20px" | Default
| [Twitter]
!style="width:600px" | Description
| 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=
| ActiveFTP=0
Key=
| [FTP site]
Enabled=0
| Legacy Cumulus
Interval=10
| No
SendUV=0
| Change directly in file as at release 3.11.x
SendSR=0
| (n/a )
SendAQI=0
| (n/a)
SendSoilMoisture=0
| *0 = Disabled (default)
SoilMoistureSensor=0
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
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
| Copy-airquality=0
StationUID=
| [FTP site]
Password=
| Release 3.12.0
Interval=1
| ^
SendRain=0</pre>
| Internet Settings &rarr;  Graph File Settings
| [WindGuru]
| airquality.json &rarr; Copy
| Windguru
| 0 (disabled)
| Tick "Enabled" to see list of parameters so you can edit them
| Simple tick or not
| Defaults are as shown in list of parameters
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too)
|-
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
| <pre>APIkey=
|-  
StationIdx=0
| Copy-alldailydegdaydata=0
Enabled=0
| [FTP site]
Interval=15
| Release 3.12.0
SendUV=0
| ^
CatchUp=1</pre>
| Internet Settings &rarr; Graph File Settings
| [Windy]
| alldailydegdaydata.json &rarr; Copy
| Windy.com
| 0 (disabled)
| Tick "Enabled" to see list of parameters so you can edit them
| Simple tick or not
| Defaults are as shown in list of parameters
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailydegdaydata.json]] file to your local web server (need to select "Generate" too)
|-
* Don't tick (value shown as 0 in Cumulus.ini) to disable
| <pre>ID=
|-
Password=
| Copy-alldailyhumdata=0
Enabled=0
| [FTP site]
Interval=15
| Release 3.12.0
SendUV=0
| ^
SendSR=0
| Internet Settings &rarr;  Graph File Settings
CatchUp=1</pre>
| alldailyhumdata.json &rarr; Copy
| [WOW]
| 0 (disabled)
| Met Office WOW
| Simple tick or not
| Tick "Enabled" to see list of parameters so you can edit them
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too)
| Defaults are as shown in list of parameters
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|}
|-  
 
| Copy-alldailypressdata=0
==Optional Web Server==
 
The settings listed here changed dramatically at both 3.10.0 and 3.12.0 releases, but they have gradually evolved throughout the development of MX.
 
FRom 3.12.0, MX can optionally either copy files to a web server you host or file transfer files to a commercial web server.
 
To implement (and customise) this web server functionality, there are many settings as listed alphabetically in this table.  The Internet settings page simplifies making settings by providing selections that amend multiple settings in a bulk operation:
* Some settings (marked ^ in table) are only displayed if you select '''I want to use the supplied default web site'''.
** For these settings, the "Generate" option is enabled in nearly all (see any qualifier) settings
** If you select "Enable file copy of standard files" (default is disabled) then those settings have their "Copy" option enabled in nearly all (see any qualifier) cases, and their "FTP Transfer" option deselected (instead of defaults shown in table)
** If you deselect "Enable file transfer of standard files" (default is enabled) then those settings have their "Copy" option disabled, and their "FTP Transfer" option enabled in nearly all (see any qualifier) cases (as per defaults shown in table)
* '''The default selections assume you have air quality, and solar, sensors; so you may need to disable some of the defaults the above selections have made'''
* If you don't select '''I want to use the supplied default web site''', then all the settings marked ^ are disabled
** This is what you want if you do not use the MX optional web server functionality
** If you have a customised  web site, you may want to select '''I want to use the supplied default web site'''  to see the settings that would otherwise all be disabled, and then pick any options that would be useful to you.
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | File Section
!style="width:100px" | Introduced
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| ActiveFTP=0
| [FTP site]
| [FTP site]
| Legacy Cumulus
| Release 3.12.0
| No
| Change directly in file as at release 3.11.x
| (n/a )
| (n/a)
| *0 = Disabled (default)
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
|-
| Copy-airquality=0
| [FTP site]
| Release 3.12.0
| ^
| ^
| Internet Settings &rarr;  Graph File Settings
| Internet Settings &rarr;  Graph File Settings
| airquality.json &rarr; Copy
| alldailypressdata.json &rarr; Copy
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the airquality.json file to your local web server (need to select "Generate" too)
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have an air quality sensor)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-  
|-  
| Copy-alldailydegdaydata=0
| Copy-alldailyraindata=0
| [FTP site]
| [FTP site]
| Release 3.12.0
| Release 3.12.0
| ^
| ^
| Internet Settings &rarr; Graph File Settings
| Internet Settings &rarr; Graph File Settings
| alldailydegdaydata.json &rarr; Copy
| alldailyraindata.json &rarr; Copy
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailydegdaydata.json]] file to your local web server (need to select "Generate" too)
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-  
|-  
| Copy-alldailyhumdata=0
| Copy-alldailysolardata=0
| [FTP site]
| [FTP site]
| Release 3.12.0
| Release 3.12.0
| ^
| ^
| Internet Settings &rarr;  Graph File Settings
| Internet Settings &rarr;  Graph File Settings
| alldailyhumdata.json &rarr; Copy
| alldailysolardata.json &rarr; Copy
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyhumdata.json]] file to your local web server (need to select "Generate" too)
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-  
|-
| Copy-alldailypressdata=0
| Copy-alldailytempdata=0
| [FTP site]
| [FTP site]
| Release 3.12.0
| Release 3.12.0
| ^
| ^
| Internet Settings &rarr;  Graph File Settings
| Internet Settings &rarr;  Graph File Settings
| alldailypressdata.json &rarr; Copy
| alldailytempdata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailypressdata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailyraindata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr;  Graph File Settings
| alldailyraindata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailyraindata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable
|-
| Copy-alldailysolardata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr;  Graph File Settings
| alldailysolardata.json &rarr; Copy
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to copy the [[alldailysolardata.json]] file to your local web server (need to select "Generate" too)
* Don't tick (value shown as 0 in Cumulus.ini) to disable (e.g. if you don't have a solar sensor)
|-
| Copy-alldailytempdata=0
| [FTP site]
| Release 3.12.0
| ^
| Internet Settings &rarr;  Graph File Settings
| alldailytempdata.json &rarr; Copy
| 0 (disabled)
| 0 (disabled)
| Simple tick or not
| Simple tick or not
Line 1,770: Line 1,552:
| 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 2,399: Line 2,181:
| [FTP site]
| [FTP site]
| Legacy Cumulus
| Legacy Cumulus
| No
| FTP logging
| Change directly in file as at release 3.11.x
| Depends on release installed:
# (Releases 3.1.0 to 3.10.5) Internet Settings &rarr;  &rarr; Web Settings &rarr; General Settings
# (Releases 3.11.0 to 3.11.4) Program Settings &rarr; Program General Options
# (Release 3.12.0 onwards) Program Settings &rarr; Logging Options
| (n/a)
| (n/a)
| (n/a)
| (n/a)
| *0 = Disabled (default)
| Simple tick or not
*1 = Enabled, Cumulus will for standard FTP mode add output to [[ftplog.txt]].
* Tick (value shown as 1 in Cumulus.ini) for MX in standard FTP mode add output to [[ftplog.txt]].
to issue instruction to the web server so it creates the new file with a new name and then renames it to the required name  (this is the option appropriate to most servers)
* Don't tick (value shown as 0 in Cumulus.ini) to disable updates to '''ftplog.txt'''
For other types of file transfer (STTP, FTPS), any extra diagnostic information appears in latest log in [[MXdiags folder]]
|-
|-
| FTPRename=1
| FTPRename=1
Line 2,434: Line 2,222:
| (always)
| (always)
| Internet Settings &rarr; Moon Image
| Internet Settings &rarr; 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
|-
|-
|  Parameter attribute depends on release:
| IntervalFtpEnabled=1
# AutoUpdate=0
# IntervalEnabled=1
| [FTP site]
| For respective parameter attribute:
# Legacy to 3.11.4, as deprecated in 3.12.0
# Introduced release 3.10.0, takes over from 3.12.0
| ^
| Internet Settings &rarr; Interval Settings
| Enable web update interval
| Default depends on respective attribute:
# 0 (disabled) for legacy web pages
# 1 (enabled) for new default web pages
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to generate a timer that will permit standard interval actions
* Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or no standard interval uploading required
|-
|IntervalFtpEnabled=1
| [FTP site]
| [FTP site]
| Release 3.12.0
| Release 3.12.0
Line 2,467: Line 2,238:
* Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file transfer actions
* Tick (value shown as 1 in Cumulus.ini) for MX to make standard interval file transfer actions
* Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected '''LocalCopyEnabled''' (see below)
* Don't tick (value shown as 0 in Cumulus.ini) if either no web server, or have selected '''LocalCopyEnabled''' (see below)
|-
| ListWebTags=0
| [Station]
| Legacy Cumulus
| Only from Release 3.12.0
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) Station settings &rarr; Common Options &rarr; 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
| LocalCopyEnabled=0
Line 2,486: Line 2,269:
| (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 &rarr; 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 &rarr; Moon Image
| Image size
| ???
| Enter a size (in pixels) for the generated moon image (according to space on your web page)
|-
|-
| Password=
| Password=
Line 2,503: Line 2,306:
| FTP port
| FTP port
| 21 (plain FTP)
| 21 (plain FTP)
|you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative protocol and/or alternative ports.
|you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative protocol and/or alternative ports.
|-
|-
| RealtimeFTPEnabled=0
| RealtimeFTPEnabled=0
Line 2,590: Line 2,393:
* 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 &rarr; General Settings &rarr; Advanced options
*# Station settings &rarr; Common Options &rarr; 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 2,600: Line 2,418:
| Drop down list:
| Drop down list:
* 0 = FTP (plain old FTP) - default
* 0 = FTP (plain old FTP) - default
* 1 = Use SSL/TLS for FTP (FTPS)
* 1 = Use SSL/TLS (deprecated Secure Sockets Layer and replacement Transport Layer Security) for FTP (FTPS)
* 2 = Use Secure Shell Home (SSH) for FTP (SFTP)
* 2 = Use Secure Shell Home (SSH) for FTP (SFTP)
|-
|-
Line 2,642: Line 2,460:
| the user name for connecting to your server
| the user name for connecting to your server
|-
|-
| UTF8encode=1
| UTF8encode=
| [FTP site]
| [FTP site]
| legacy software
| legacy software
Line 2,650: Line 2,468:
* (release 3.12.0 on)  Internet Settings &rarr; Web Site &rarr; General Settings
* (release 3.12.0 on)  Internet Settings &rarr; Web Site &rarr; General Settings
| UTF-8 encoding
| UTF-8 encoding
| 1 (enabled)
| Default depends on release:
* (Legacy versions and MX up to 3.9.7) 0 (ISO 8859-1 character set)
* (Release 3.10.0 on) 1 (UTF-8 encoding enabled)
| Simple tick or not
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to use [[Reports_folder#Encoding|'''UTF-8''' encoding]] in all [[:Category:JSON Files|.json files]]  
* Tick (value shown as 1 in Cumulus.ini) for MX to use [[Reports_folder#Encoding|'''UTF-8''' encoding]] in all [[:Category:JSON Files|.json files]]  
* Don't tick (value shown as 0 in Cumulus.ini) and MX will create its .json files using '''ISO 8859-1 character set''', and that is incompatible with [[New_Default_Web_Site_Information#Installing_the_new_template_for_new_users|web pages]] included in ''webfiles'' folder.
* Don't tick (value shown as 0 in Cumulus.ini) and MX will create its .json files using '''ISO 8859-1 character set''', ''please note that this encoding is incompatible with [[New_Default_Web_Site_Information#Installing_the_new_template_for_new_users|web pages]] included in '''webfiles''' folder''; so if you upgrade from an earlier release, you may need to change this setting
|-
|-
|WebcamURL=
|WebcamURL=
Line 2,706: Line 2,526:
*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 2,713: Line 2,537:
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"
{| class="wikitable" border="1"
|-
|-
Line 2,724: Line 2,550:
!style="width:800px" | Description
!style="width:800px" | Description
|-
|-
|Type= -1  
| SolarCalc=0
| [Station]
| [Solar]
| 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0)
| 3.13
| Station Settings &rarr; General Settings
| 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===
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | File Section
!style="width:100px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:800px" | Description
|-
|Type= -1  
| [Station]
| 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0)
| Station Settings &rarr; General Settings
| Station type  
| Station type  
| -1 (not yet defined)
| -1 (not yet defined)
Line 2,759: Line 2,650:


===Airlink===
===Airlink===
The details in this sub-section need to be checked by someone who uses the relevant hardware.


* Introduced Release
* Introduced Release
Line 2,790: Line 2,683:
===Davis===
===Davis===


Two Wiki sub-sections:
Two Wiki sub-sections, that need to be checked by by somebody who uses the relevant functionality:




Line 2,797: Line 2,690:


{{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 2,960: Line 2,853:
===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 3,014: Line 2,908:


===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 3,046: Line 2,942:


===Fine Offset Stations===
===Fine Offset Stations===
{{Template:WorkInProgressBanner}} This table has not been populated yet


* Introduced in a Legacy version
* Introduced in a Legacy version
Line 3,059: Line 2,952:
|-
|-
!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
|-
| SyncFOReads=0
| Synchronise Reads
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
* Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data
Selecting this parameter has given some problems in earlier MX builds, so the code has recently been rewritten.
|-
|-
| FOReadAvoidPeriod=3
| FOReadAvoidPeriod=3
| MX release ??
| Only if Fine Offset selected
| Station Settings &rarr; Fine Offset Advanced Settings
| Read Avoid Period
| Read Avoid Period
| 3 (seconds)
| 3 (seconds)
Line 3,077: Line 2,968:


(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)
(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
{{Template:WorkInProgressBanner}}
| Station Settings &rarr; Fine Offset Advanced Settings
There are a number of settings in a MX sub-section called "Fine Offset Advanced Options". These are new settings, and have not been documented yet.
| 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 &rarr; 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 &rarr; Fine Offset Advanced Settings
| USB Product Id (PID)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|-
| SyncFOReads=0
| Legacy Cumulus
| Only if Fine Offset selected
| Station Settings &rarr; Fine Offset Settings
| Synchronise Reads
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
* Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data


{| class="wikitable" border="1"
# 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!
!style="width:30px" | Parameter Line Entry
# 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
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|-
|
| VendorID=-1
| MX release ??
| Only if Fine Offset selected
| Station Settings &rarr; 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 3,099: Line 3,021:




{{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 3,159: Line 3,081:
|}
|}


===WM918/WMR928 Settings===


Oregon Scientific specific
===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 &rarr; Common Options &rarr; 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]]


{{Template:WorkInProgressBanner}} This table has not been populated yet
===Oregon Scientific WM918/WMR928 Settings===


* Introduced for legacy Cumulus
The Oregon Scientific code has not changed since the earliest beta MX (3.0.0) builds based on moving compiled code from Cumulus 1. 
* File Section is [Station]


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" | Label on Settings page
!style="width:100px" | External to MX edit
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
Line 3,182: Line 3,135:
|-
|-
|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 3,189: Line 3,142:
|-
|-
|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 3,196: Line 3,149:
|-
|-
|WMR928TempChannel=N
|WMR928TempChannel=N
|
| Stop MX and add this into file
|(no default)
|(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 default)
|(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 3,261: Line 3,214:
* 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 3,277: Line 3,230:
| 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 3,317: Line 3,270:
| 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 3,357: Line 3,310:
| 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.


Line 3,406: Line 3,362:
| Rounding of wind speed
| Rounding of wind speed
| 0 (no)
| 0 (no)
| Simple tick or not:
| Simple tick or not, (only applicable if any reported wind speed would otherwise include decimal places):
* Tick (value shown as 1 in Cumulus.ini) then MX will round all the wind speeds it reports to nearest integer
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will round all the wind speeds it reports to nearest integer
* Don't tick (value shown as 0 in Cumulus.ini) then MX will report wind speeds to the precision defined in "WindSpeedDecimals" parameter
* Don't tick (value shown as 0 in Cumulus.ini) then Cumulus will report wind speeds to the precision defined in "WindSpeedDecimals", "WindSpeedAvgDecimals", and "WindRunDecimals", parameters
|-
|-
| SunshineHrsDecimals=2
| SunshineHrsDecimals=2
Line 3,496: Line 3,452:
| Select a number of decimal places to overwrite the default
| Select a number of decimal places to overwrite the default
|-
|-
| WindSpeedAvgDecimals=1
| WindSpeedAvgDecimals=
| Release 3.8.3
| Release 3.8.3
| Units &rarr; Advanced Options (Here be dragons!)
| Units &rarr; Advanced Options (Here be dragons!)
| Wind speed average decimals
| Wind speed average decimals
| 1 (displayed as blank)
| (displayed as blank)
| Select a number of decimal places to overwrite the default
| Select a number of decimal places to overwrite the default. (NOTE: If the weather station does not provide an average wind speed, or if the user requires a change of units from how the weather station reports it,  then CMX will calculate it to 1 decimal place by default; otherwise average wind speed will default to integer, or to one decimal place, depending how it is provided by the station).
|-
|-
| WindSpeedDecimals=2
| WindSpeedDecimals=
| Release 3.8.3
| Release 3.8.3
| Units &rarr; Advanced Options (Here be dragons!)
| Units &rarr; Advanced Options (Here be dragons!)
| Wind speed average decimals
| Wind speed average decimals
| 2 (displayed as blank)
| (displayed as blank)
| Select a number of decimal places to overwrite the default
| Select a number of decimal places to overwrite the default which depends both on the weather station type and what units have been selected by user (speeds are normally reported as integers unless metres per second are reporting unit, because most sensors are not precise enough to give any decimal places in other units)
|-
|-
| WindUnit=0
| WindUnit=0
Line 3,536: Line 3,492:
| (displayed as blank)
| (displayed as blank)
| Enter a 4 digit year:
| Enter a 4 digit year:
* Legacy Releases (1.7.12 5 July 2008) and MX up to 3.11.4 (build 3133 25 May 2021): The year-to-date amount in previous parameter is added to the current (seasonal) rain if the year specified in this parameter matches the current year.  
* Legacy Releases (1.7.12 from 5 July 2008) and MX up to 3.11.4 (build 3133 from 25 May 2021): The year-to-date amount in previous parameter is added to the current (seasonal) rain if the year specified in this parameter matches the current year.  
** If your rain season starts in January (default) then set this to the calendar year when you first use Cumulus (in a particular location).   
** If your rain season starts in January (default) then set this to the calendar year when you first use Cumulus (in a particular location).   
** If your rain year starts in any other month, set this to this year if your first season starts this year, and set this to last year if your second season has started and you don't want the previous value added to your second season
** If your rain year starts in any other month, set this to the current calendar year during your first season (remember to change the year mid-season when reach 1 January), and delete the year when your second season starts as you don't want the previous value added to your second season
* From Release 3.12.0 (?? July 2021), the current calendar year is compared against  (current month - season start month + 1) year, so you enter the year in which your first season starts (be that last calendar year or this calendar year)
* From Release 3.12.0 (29 July 2021), the current calendar year is compared against  (current month - season start month + 1) year, so you enter the year in which your first season would start had it been a full season (be that last calendar year or this calendar year)
|}
|}
Sfws
5,838

edits

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

Navigation menu