Cumulus.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (view source)

Revision as of 12:49, 21 July 2021

2,797 bytes added ,  12:49, 21 July 2021
m
→‎Optional Report Settings: Revert description back taking out text about editing a file that is part of release
m (→‎Optional Report Settings: Revert description back taking out text about editing a file that is part of release)
(7 intermediate revisions by the same user not shown)
Line 1,910: Line 1,910:
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
!style="width:600px" | Description
|-
| StartDate=
| (with warning: "Here be dragons!")
| Station Settings → 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.
|-
| NoSensorCheck=0
| (not yet on a settings page)
| (not known)
| (not known)
| 0 (normal)
| Boolean:
* 0 = MX will stop if any of the minimum set of sensors listed below fails
* 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails
Minimum set of sensors:
# Current air temperature
# Current Relative Humidity
# At least one wind speed
# Current air pressure (absolute or sea-level)
Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these).
|-
| UseDataLogger=1
| (probably determined by station type)
| (not known)
| (not known)
| 1 (enabled)
|Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if your weather station has its own storage, so MX can do a catch up when it first starts and read any "archive data"
* Don't tick (value shown as 0 in Cumulus.ini) if your weather station has no storage, and therefore MX cannot capture any readings when it is not running
|-
|-
| DataLogInterval=2
| DataLogInterval=2
Line 1,965: Line 1,933:
* Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files.
* Don't tick (value shown as 0 in Cumulus.ini) if you have nothing to log to Extra Sensor Files.
|-
|-
| RolloverHour=0
| NoSensorCheck=0
| (not yet on a settings page)
| (not known)
| (not known)
| 0 (normal)
| Boolean:
* 0 = MX will stop if any of the minimum set of sensors listed below fails
* 1 = MX will continue to run, even if any of the minimum set of sensors listed below fails
 
Minimum set of sensors:
# Current air temperature
# Current Relative Humidity
# At least one wind speed
# Current air pressure (absolute or sea-level)
Cumulus will stop processing any information from a weather station unless the above 4 source values are being supplied and reveal they are being updated (failure is set is after a total of 6 unsuccessful consecutive attempts to read each of these).
|-
| RainDayThreshold=-1
| (with warning: "Here be dragons!")
| legacy cumulus
| Only from Release 3.12.0
| Depends on release:
* (3.5.1 to 3.11.4) Manual edit of file
* (3.12.0 onwards) Station settings → Common Options → Advanced options
|-1 (that represents 0.2 mm or 0.01 inches)
| The amount of rainfall that must be collected before MX treats today as a wet day
 
''The intention is this will represent more than one tip,as the first tip might contain some rain from an earlier day''
|-
| RolloverHour=0
| (Always)
| (Always)
| Station settings → Log Rollover
| Station settings → Log Rollover
Line 1,974: Line 1,970:
* 1 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time
* 1 = MX will do [[MX_Basic_info#MX_End_of_Day_Process|an end of day process]] when the time (on Weather Station if it provides time) reaches 9 a.m. local standard/winter time
|-
|-
| Use10amInSummer=1
| SnowDepthHour=0
| (Always)
| (with warning: "Here be dragons!")
| Station settings → Log Rollover
| legacy cumulus
| Use 10am in Summer
| Only from Release 3.12.0
| 1 (normal)
| Depends on release:
| Tick box:
* (3.5.1 to 3.11.4) Manual edit of file
* 0 = If "Daylight Saving Time" (DST) applies in Summer, MX is to use 9 am local time
* (3.12.0 onwards) Station settings → Common Options → Advanced options
| Snow depth hour
| 0 (midnight)
| Spin selector of 0 to 23: Defines hour from which entries in [[Weather Diary]] for current calendar day are used. Prior to this hour the weather diary will be searched for Calendar yesterday
|-
| StartDate=
| (with warning: "Here be dragons!")
| Station Settings → Common Options → Advanced Options
| Records Began date
| (Set when you first use Cumulus)
| Format used is determined by locale used for running MX.  If this date is edited, keep to same format. MX generally (see [[Calculate_Missing_Values#CreateMissing.exe]] for exceptions) ignores any data file entries prior to this date.
|-
| UseDataLogger=1
| (probably determined by station type)
| (not known)
| (not known)
| 1 (enabled)
|Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if your weather station has its own storage, so MX can do a catch up when it first starts and read any "archive data"
* Don't tick (value shown as 0 in Cumulus.ini) if your weather station has no storage, and therefore MX cannot capture any readings when it is not running
|-
| Use10amInSummer=1
| (Always)
| Station settings → Log Rollover
| Use 10am in Summer
| 1 (normal)
| Tick box:
* 0 = If "Daylight Saving Time" (DST) applies in Summer, MX is to use 9 am local time
* 1 = Normal behaviour:
* 1 = Normal behaviour:
** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
** If rollover time is midnight, then rolls over at midnight local time, regardless of whether DST is in operation or not
Line 2,450: Line 2,473:
| NOAA Reports Settings → FTP Options
| NOAA Reports Settings → FTP Options
| destination folder  
| destination folder  
| (empty)
| Depends on release:
| Where you want MX to use as destination folder on your FTP server
* (3.1.0 to 3.11.4) blank
*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)
* (3.12.0 onwards) to match change in default web site script specification of '''Reports''' folder
* 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:
| Specify the destination folder for file transfer to, on your FTP server
<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.
*Leave at default (for your release) and MX will work with the default web pages script supplied (at same release)
* Specify a folder relative to FTP root, and MX will upload reports to that folder instead (you are then responsible for writing any script on your web site to find each report and do any processing).
|-
|-
| HeatingThreshold=15.5
| HeatingThreshold=15.5
Line 3,697: Line 3,721:
* 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" 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:
# 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
|IntervalFtpEnabled=1
Line 3,725: Line 3,732:
* 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 3,848: Line 3,867:
* 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) Station settings &rarr; Common Options &rarr; Advanced options
| 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 4,422: Line 4,452:
| Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.  For Cumulus 1, the default was 200 milli-seconds, so you might try that too.  
| Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.  For Cumulus 1, the default was 200 milli-seconds, so you might try that too.  
|}
|}
===La Crosse stations===
{{Template:WorkInProgressBanner}} The following table has some gaps to fill in
{| 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]]


===WM918/WMR928 Settings===
===WM918/WMR928 Settings===
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/9430...9505"

Navigation menu