Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This page was last updated for the MX release in July 2020; that is no longer latest!
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this page, it may even need a redesign for more recent releases!
</div>
[[File:Badge vMx.png]] This page now only applies if you are using Cumulus MX.
[[File:Badge vMx.png]] This page now only applies if you are using Cumulus MX.


If you are using Cumulus 1, all the information is now on [[Cumulus.ini (Cumulus 1)]] page.
The information for the legacy Cumulus has been moved to the new [[Cumulus.ini (Cumulus 1)]] page.


[[Category: Configuration_Files]]
[[Category: Configuration_Files]]
Line 445: Line 452:
<big>THE FOLLOWING SUB-SECTIONS NEEDS TO BE REWRITTEN - MX has changed, and the sub-sections below reflect older releases where some parameters were read-only (not set with admin interface) and some were read-write (set within admin interface)</big>
<big>THE FOLLOWING SUB-SECTIONS NEEDS TO BE REWRITTEN - MX has changed, and the sub-sections below reflect older releases where some parameters were read-only (not set with admin interface) and some were read-write (set within admin interface)</big>


The following list of options and allowed values is taken from '''StationOptions.json''' for release 3.10., certain settings determine which other settings are shown:
The difficulty is ensuring this Wiki page continues to help people whichever MX release they are using - the alternative is to split this page and have references to other pages (one for early MX releases, one for 3.10.1 onwards)
<pre> Select Station :  "Davis Vantage Pro",  "Davis Vantage Pro2/Vue",  "Davis WeatherLink Live",
                        "Oregon Scientific WMR-928",  "Oregon Scientific WM-918", "Oregon Scientific WMR100",  "Oregon Scientific WMR200",
                        "EasyWeather",
                        "Fine Offset", "Fine Offset with Solar Sensors",
                        "Instromet",
                        "Ecowitt GW1000",
                        "LaCrosse WS2300"
  "loginterval":  "1 minute", "5 minutes", "10 minutes", "15 minutes", "20 minutes",  "30 minutes"
  "logrollover": "9am",  "Use 10am in Summer"
  "units":  "wind":  "Metres per second (m/s)",  "Miles per hour (mph)",  "Kilometres per hour (km/h)",  "Knots (kts)"
            "pressure": "Milli-bar (mbar)",      "Hectopascal (hPa)",    "Inches of mercury (inHg)"
            "temp": "Celsius",  "Fahrenheit"
            "rain": "Millimetres",  "Inches"
"advanced": "Here be dragons! Only alter these settings if you understand what they do.",
              "tempdp","pressdp","raindp","winddp", "windavgdp", "windrundp", "airqulaitydp", "sunshinedp", "uvdp"
"Location": "A short name for the location", "A longer description of the location",  "Latitude",  "Longitude"
  "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
                    "Records Began Date"
 
WEATHER STATION DEPENDENT
"davisvp2": "Serial",  "TCP/IP", "Your station serial port (real or virtual)","Period to disconnect once a minute from IP loggers to allow them to upload to WeatherLink.com. Time in seconds"
      "advanced":  "Here be dragons! Only alter these settings if you understand what they do.",
                    "Synchronise station clock","Read Davis reception stats", "Set the Davis Logger interval to match Cumulus MX interval", "Enable use of the LOOP2 data packets (UseDavisLoop2)", "Davis VP 1-minute barometer update (ForceVPBarUpdate)","Time to wait after establishing a connection to an IP logger before sending commands","TCP/IP port for your logger. Default is 22222",  "Serial port speed in bps",
"daviswll": "Auto-Discovery","api", "Select the ISS transmitter ID for your Wind sensor", "Select the ISS transmitter ID for your Temperature/Humidity sensor", "Select the ISS transmitter ID for your Rain sensor", Select the ISS transmitter ID for your Solar sensor", Select the ISS transmitter ID for your UV sensor", "select the transmitter ID for your extra temperature sensor #1, #2, #3, #4", "Select the transmitter ID for your extra soil moisture sensor #1, #2, #3, #4", "Select the index within the transmitter ID for your soil moisture leaf sensor #1, #2, #3, #4", Select the transmitter ID for your extra leaf sensor #1,#2", "Select the transmitter ID for your extra temperature/humidity sensor #1, #2, #3, #4, #5, #6, #7, #8", "Is sensor #1 a combined temperature/humidity sensor?"
    "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
                "raingaugetype": "Auto",  "Metric (0.2 mm)*",  "Imperial (0.01 in)*", "Metric (0.1 mm)",  "Imperial (0.001 in)"
                "The UDP multicast port used by the WLL, this will normally be discovered from the WLL"
"gw1000":  "Auto-Discovery",  "ipv4",  "macaddress"
"fineoffset":  "Synchronise Reads",
      "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
              "readtime", "vid", "pid"
"easyw": "How often to read the EasyWeather data file in minutes", "filename" "minpressmb", "maxpressmb", "raintipdiff", "pressoffset"
"imet": "comportname", "baudrate"
        "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
              "syncstationclock",  "syncclockhour",  "updatepointer","waittime", "readdelay"
"wmr928": "comportname"
"LaCrosse": "Use computer clock instead of LaCrosse station clock for archive data"
 
"Options": "Use bearing zero when calm"", "Calculate average wind speed", "Use speed for average calculation", "Use 100% for 98% humidity", "Calculate dew point", "Cumulus pressure trend names", "Round wind speeds to the nearest whole number", "Display and log extra sensors, if fitted", "Make Cumulus MX run even if you do not have the minimum sensors required (temp, press, wind)"
      "advanced":  "Here be dragons! Only alter these settings if you understand what they do.",
                    "Period of time in minutes to average out wind bearings", "Period of time in minutes to average out wind speeds", "Period of time in minutes to record the peak gust speed"
"Forecast": "Use the Zambretti forecast generated by Cumulus", "If using the Cumulus forecast, update only once an hour rather than every data update", "The low pressure extreme for your location", "The high pressure extreme for your location", "The units that you have used for the pressure extremes"
  "Solar": "Select the algorithm to use for solar irradiation calculations", "The percentage of the current theoretical solar value above which the sun should be considered to be shining (default = 75)", "The minimum solar reading for the sun to be considered to be shining (default = 0)", "The R-S transmission factor of the solar radiation through the atmosphere (0.70 - 0.91, default 0.80)", "The Bras turbidity factor (1.00=clear, 5.00=smoggy, default = 2.00)"
  "AnnualRainfall": "Enter a rainfall amount to be added to the total for the year when you started using Cumulus - for the period for which you have no Cumulus data",  "Enter the year to apply the correct to (normally this year or last year) as a four digit number. Leave as zero to disable", "Select the month from which the annual total is to be calculated",
  "Graphs": "The number of hours shown on the minute-by-minute graphs", "The number of days shown on the daily graphs"; SHOW/HIDE: "Outdoor Temperature", "Indoor Temperature", "Heat Index", "Dew Point", "Wind Chill", "Apparent Temperature" , "Feels Like", "Humidex", "Daily Maximum Temperature", "Daily Average Temperature", "Daily Minimum Temperature", "Outdoor Humidity", "Indoor Humidity", "UV Index", "Solar Irradiation",  "Sunshine Hours"
  "DisplayOptions": "Enabling this option will display Apparent temperature on the default web site/Disabling this option will display Feels Like temperature on the default web site", "Display Solar data", "Display UV-I data", "The number of cardinal points to display on the Wind Rose",
</pre>


=== Spike Removal ===
=== Spike Removal ===


Which parameters are available from this section depends on release of MX being used, and which type of staion you use.
Which parameters are available from this section depends on release of MX being used, and which type of station you use.




Line 1,013: Line 973:
*2 Minimum value
*2 Minimum value
*3 = default value
*3 = default value
Sets the interval (in seconds) during each 48 (or 60 for some models in Cumulus 1) second of station logging period when Cumulus will avoid reading the station data to try and minimise lock ups. If the clock drifts more than this value in 24 hours, then Cumulus may cause the station to lock up when reading the data. The actual station clock drift gets logged to the diags file when the re-synchronise (see last parameter) takes place, this will give an idea of whether it would be useful to adjust this setting.
Sets the interval (in seconds) when Cumulus will avoid reading the station data to try and minimise lock ups. If the clock drifts more than this value in 24 hours, then Cumulus may cause the station to lock up when reading the data. The actual station clock drift gets logged to the diags file when the re-synchronise (see last parameter) takes place, this will give an idea of whether it would be useful to adjust this setting.
 
Note: I have not been able to find any interval that works. In my experience, if you use this setting, MX skips every attempt to read from the weather station, As MX is coded to make an attempt every 60 seconds, but is also coded to skip every 60 seconds plus or minus the setting here.


MX applies both 48 and 60 second avoidances regardless of model.
MX applies both 48 and 60 second avoidances regardless of model.
Line 1,203: Line 1,165:
(Note this attribute appears in [[#Davis_family_specific|Davis family]], [[#Oregon_Scientific_specific:|Oregon Scientific specific]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above with different usage explanations).
(Note this attribute appears in [[#Davis_family_specific|Davis family]], [[#Oregon_Scientific_specific:|Oregon Scientific specific]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above with different usage explanations).
|}
|}
=== Section: Limits ===
New from release 3.?.?
'''Somebody needs to insert the relevant table here'''


=== Section: Offsets ===
=== Section: Offsets ===


It is believed the following table contains parameters that apply for all MX releases, except where indicated as build 3045 onwards.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,295: Line 1,264:
|}
|}


=== Section: FTP site ===


The parameters listed here are set either on [[MX_Administrative_Interface#Internet_Settings|Internet Settings page]] or on [[MX_Administrative_Interface#Extra_Web_Files|Extra Web Files page]].


=== Section: FTP site ===
<big>'''The following table requires a lot of updating as it does not cover all the parameters that the latest version has in this section of the configuration file'''</big>
 
NOTE: For MX, the word site should be in lower case as shown in left-hand column heading and above.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,308: Line 1,277:
|style="background:lightgray;"|[FTP site]  
|style="background:lightgray;"|[FTP site]  
|style="background:lightgray;"|Section Name - the following parameters relate to your website FTP parameters
|style="background:lightgray;"|Section Name - the following parameters relate to your website FTP parameters
|-
|colspan="2" style="background:pink;"|The following parameters are only available from release 3.10.1 onwards.
|-
|IntervalEnabled=?
|<big>This parameter is just included as an example, somebody needs to enter the default and list the other new parameters</big>
|-
|?
|?
|-
|colspan="2" style="background:pink;"|The following parameters are those available at release 3.6.0 (where a parameter is not available at all earlier releases, the first version using it is shown)
|-
|-
|DailyProgram=  
|DailyProgram=  
Line 1,527: Line 1,506:
=== Section: Graphs ===
=== Section: Graphs ===


All settings in this table are controlled in the '''Graphs''' section at the bottom of the '''Station Settings''' page. Note that some are not iun all releases.
'''The following table required editing to bring it up to date, as further parameters were added at release 3.10.1.''' There are also some parameters (e.g. relating to moon) that do not apply to early releases, but nobody has indicated the starting version.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,602: Line 1,581:
=== Section: Alarms ===
=== Section: Alarms ===


[[File:Badge vMx.png]]For MX, there is a default path "\CumulusMX\interface\sounds". '''Edit''' on '''Settings''' tab, '''Alarms''' screen.
For MX, there is a default path "\CumulusMX\interface\sounds". '''Edit''' on '''Settings''' tab, '''Alarms''' screen.


{{Version badge 1}}Set these using the '''Edit''' menu, ''Alarms'' screen. The default path and file is '''\Cumulus\alert.wav''' for all the file parameters.  (Previously this article incorrectly showed "C:\Program Files\Cumulus\alert.wav" for some, but that has been removed now this applies to MX as well)
<big>The parameters shown may not be available in all releases, and '''there are more parameters in later releases''' that have not yet been added to this table.</big>
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
5,838

edits

Navigation menu