Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (preserving history) (view source)

Revision as of 09:54, 7 August 2020

2,167 bytes added ,  09:54, 7 August 2020
m
→‎Section: Offsets
(32 intermediate revisions by the same user not shown)
Line 492: Line 492:
=== Section: Station ===
=== Section: Station ===


See individual parameters for specific instructions on setting them.  
The read-only parameters must be entered directly into the configuration file. Stop Cumulus before editing this file using any plain text editor, not a word processor


{{Version badge 1}}In many cases this is by using Station Configuration Screen in Cumulus 1, but if the parameter line does not exist in your file, then insert it using a file editor as per instructions above.  
{{Version badge 1}}The read-write parameters are set using '''Station Configuration Screen''' in Cumulus 1 (C1).  


[[File:Badge vMx.png]] There is a station settings page in MX. Again, it does not cover every setting, and for some you need to stop MX and edit this file directly.
[[File:Badge vMx.png]] The read-write parameters are set using the '''Station Settings''' page in MX.  
 
 
See individual parameters for specific instructions on setting them. The defaults are shown in left hand column, but be aware that some might have different defaults in C1 and MX, and that this article was first created when only Cumulus 1 was available.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 506: Line 509:
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|style="background:lightgray;"|Section name - the following parameters relate to all weather stations.
|-
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings, for Cumulus 1 edit in Station Configuration Screen
|StartDate=13/08/2009
|This parameter is different to all the others. It is not read-write as you cannot edit it in Cumulus (1 or MX). Unlike other read-only parameters it is automatically inserted into Cumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application (whichever flavour).
This date can be included in a template file, using the tag '''<#recordsbegandate>'''. The tag appears twice in the '''recordT.htm''' template that is provided with Cumulus (1 and MX) and there is a suggestion about changing that at [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|AvgBearingMinutes=N
|This line can be added in the [Station] section of the Cumulus.ini, with this parameter N is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing. Without it, the default sampling time = 10 minutes. Note the max number of wind samples stored by Cumulus is 720, so the maximum effective value for N for Fine Offset stations that are read every 10 seconds is 120 (2 hours) while for Davis stations that are sampled every 2 to 3 seconds the maximum effective value is only about 30 (minutes).
|-
|-
|Type= -1  
|UseWindChillCutOff=1  
|Station Type as set by the checked radio box in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]], Station Type block.  For details of [[Supported_Devices]] click that link.
|If you have not asked Cumulus to calculate wind chill, this parameter is irrelevant as it cannot affect how your weather station calculates wind chill.
*-1= default value, before a selection from those below is made. In Cumulus 1, this causes the configuration screen to be shown so that you start set up. In MX a message appears in the terminal (Windows command) screen saying that station type not known (see [[#Cumulus_MX|#Cumulus_MX section]] above.
*0=Vantage Pro station
*1=Vantage Pro2 station


Following added from version 1.7.0:
If you have asked Cumulus to calculate wind chill ('''CalculatedWC=1'''), regardless of whether you have a weather station that can supply it, then Cumulus will by default only modify the outside temperature if both wind speed and temperature criteria are met. This parameter must be added to the file if you want to disable 'calculate Wind chill only if temperature less than 10°C rule'.
*2=WMR-928 station
*3=WM-918 station
For Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection, if your model is not listed, try WM-918 if your station has wired connections, and WMR-928 if it is wireless.


Added in version 1.7.12:
*   0 = Disabled, Cumulus will use any wind speed of 3 mph or more, to modify the temperature, and determine the wind chill, and Cumulus will ignore the temperature criterion
*4=Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
*    1 = Enabled (default), Cumulus will use both 10°C temperature and 3 mph wind speed criteria to determine if wind chill applies. Outside the criteria,the wind chill field will simply duplicate the outside temperature field.
'''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.  
|-
|ChillHourThreshold=45  '''Fahrenheit only i.e. USA'''


Added in version 1.8.0:
ChillHourThreshold=7 '''Celsius users'''
*5=Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] (without solar measurement sensors (with or without solar recharging))
|The temperature threshold for the calculation of [[Heat/cold_degree_days_and_Chill_hours|Chill Hours]] is specified in the units that you use in Cumulus.
If the parameter is not included in the file, the default varies depending on the units you use.  
*As shown the default is exactly 45 degrees Fahrenheit if Fahrenheit is used.
*The default is exactly 7 degrees Celsius, (note that is not exactly 45<sup>o</sup>F) if you have selected Celcius.
*You can put in any value you want, with a decimal place if required
*Some people have put in the freezing-point temperature (0<sup>o</sup>C and they relabel "chill hours" to "frost hours"
|-
|ChillHourSeasonStart=10
|The season start figure is the calendar month number (1=January to 12= December). The default if this parameter is not specified is October (month 10). On the first day of the month specified here, Cumulus resets the cumulative chill hours that it reports to zero.
|-
|SnowDepthHour=9
|If this parameter is not included in the file, then any snow entries in the [[Weather Diary]] for a particular date will continue to be used {{Version badge 1}} in output by Cumulus 1 until 9am the next morning, when entries for the current date will apply. [[File:Badge vMx.png]]The default for MX is not stated anywhere, but might be the standard rollover time (https://cumulus.hosiene.co.uk/viewtopic.php?f=37&t=17919).
*Allowed values are the integers 0 to 23
*The time is constant year round, in UK "a day of snow" could (before climate change) happen in April despite that being after swapping to summer (daylight saving) time.
#What you enter here is independent of any settings for rollover time
#For meteorological reporting, snow is reported on midnight to midnight days, although snow depth is measured and reported at 9am.
|-
|CreateWxnowTxt=0
|If the parameter is not included in the file, the default value is assumed.


Added in version 1.8.3:
    0= turn off creation of '''wxnow.tx'''t file (stored in main Cumulus folder)
*6=WS2300 (For all La Crosse WS23xx models)
    1= (default) create '''wxnow.txt''' file (an alternative way to get data to CWOP/APRS)
|-
|ListWebTags=0
|If the parameter is not included in the file, the default value is assumed.


Added in version 1.9.1:
    0= (default) turn off creation of WebTags.txt file (stored in main Cumulus folder)
*7=Fine Offset/Watson/MyDel etc with Solar Sensors as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]].
    1= create WebTags.txt file when Cumulus is restarted (contains an unordered list of all the web tags your Cumulus build will recognise and process)
|-
|RainDayThreshold=-1
|If this parameter is not included in the file, the default is '''-1''' and that represents 0.2 mm or 0.01 inches.
#The parameter specifies the threshold value which the daily rainfall has to equal or exceed for the day to be considered a 'rain day'.
#Value is entered in your current [[Rain_measurement]] units.
|-
|NoFlashWetDryDayRecords=1
| * When set to 1 (default) stops new Longest Wet/Dry Period records being 'flashed' in Cumulus 1
* Set to 0 if you are happy to have the record light on your Cumulus 1 main screen flash for each rainfall update
 
[[File:Badge vMx.png]]It is not clear if MX reads this parameter, as it does not show this record on the admin interface dashboard
|-
|FCPressureThreshold=0.1
|It specifies the threshold (in mb per hour averaged over 3-hour period) for a pressure change to count as rising or falling rather than steady when determining the Zambretti forecast. The default is 0.1 mb/hr averaged over the previous three hours. If the parameter is not included in the file, the default value is assumed.
|-
|RTdisconnectcount=infinite
|{{Version badge 1}}By default, the 'realtime' ftp connection stays connected. But you can add '''RTdisconnectcount=N''' to force a disconnection after N realtime ftp uploads. For example, if you set '''RealtimeInterval=60''' there will be 60 seconds between each update and '''RTdisconnectcount=60''' would force a disconnection each hour.


Added in version 1.9.2:
[[File:Badge vMx.png]]There have been changes to FTP handling in MX releases, and it is not clear if this parameter is used by MX
*8=[[WMR100-200_Protocol|WMR100]]
|-
*9=[[WMR100-200_Protocol|WMR200]]
|ErrorLogSpikeRemoval=0
*10=Instromet (with optional extra solar sensors or without)
|This is read-only below version 3.7.0. Because it is now a read-write parameter, please see its entry in next section of this table
|-
|UVdecimals=0
|{{Version badge 1}}(added 1.9.3 build 1038) [[File:Badge vMx.png]] applies at all versions


[[File:Badge vMx.png]]'''Additional values available in MX only:'''
UV values are now displayed and logged as whole numbers by default. You can change this by adding this entry specifying the number of decimal places:
* 0 = Integer Values (default)
* n = Number of decimal places e.g. 1
|-
|NoSensorCheck=0
|By default, Cumulus will stop working if after 6 attempts it cannot read all the standard readings from a weather station:
#temperature
#humidity
#wind speed
#pressure
This parameter allows disabling of that sensor check:
*  0 = Sensor check enabled (default)
*  1 = Sensor check disabled
|-
|SpecialLog=0
|[File:Badge vMx.png]] Not available in MX


Added in version 3.0.0:
{{Version badge 1}}In Cumulus 1 there is an option of whether to record temperature and humidity (both indoor and outside values) in a log:
*11=Davis WLL
* 0 (default) = no special log
* 1 = Add this entry to start updating a file called 'speciallog.txt' in the data folder with the following fields:


Added in version 3.2.0:
date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dew point,outside temp,outside humidity,outside dew point
*12=Ecowitt GW1000 and Froggit DP1500 (and any equivalents)
|-
|Model="your Model description"
|The weather station model description that you want output by the web tag &lt;#stationtype>
{{Version badge 1}} - you choose what text appears for this on (from version 1.9.x) 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).


[[File:Badge vMx.png]] - this does not appear in the station settings, stop MX, and add it directly into Cumulus.ini within this [Station] section.
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
|-
|-
|RecordSetTimeoutHrs=24
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings, for Cumulus 1 edit in Station Configuration Screen
|[[File:Badge vMx.png]]Available in MX version 3.5.1 onwards only, allows the time from when a record is set to when it is cleared to be varied. The web tags: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet,LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet,HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighhHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet will all return 1 from when relevant record is set for the period of time set here (default 24 hours) and then reset to 0.
|-
|-
|Latitude=0
|Type= -1
|You are advised ''not'' to directly edit this parameter in the file, but to enter the settings via the screen provide in software where you type Latitude (unsigned) Degrees, Minutes, Seconds and select 'N' or 'S'.
|Station Type as set by the checked radio box in the [[Cumulus_Screenshots#Configuration_Menu_Screens|Station Configuration Screen]], Station Type block.  For details of [[Supported_Devices]] click that link.
{{Version badge 1}}Do this  in the Station Configuration Screen Location block.  
*-1= default value, before a selection from those below is made. In Cumulus 1, this causes the configuration screen to be shown so that you start set up. In MX a message appears in the terminal (Windows command) screen saying that station type not known (see [[#Cumulus_MX|#Cumulus_MX section]] above.
[[File:Badge vMx.png]] Exactly same entries, enter using station settings by expanding location section.
*0=Vantage Pro station
Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
*1=Vantage Pro2 station
|-
 
|Longitude=0
Following added from version 1.7.0:
|You are advised ''not'' to directly edit this parameter in the file, but to type Longitude (unsigned) Degrees, Minutes, Seconds and select 'E' or 'W'.
*2=WMR-928 station
The place to do this is as described for Latitude depending on Cumulus flavour.
*3=WM-918 station
Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
For Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection, if your model is not listed, try WM-918 if your station has wired connections, and WMR-928 if it is wireless.
|-
 
|LatTxt=  
Added in version 1.7.12:
|You are advised ''not'' to directly edit this parameter in the file, it contains Latitude in text string format of hemisphere D, M and S. HTML ampersand codes are used for spaces and unit characters.
*4=Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
|-
'''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.  
|LonTxt=  
 
|You are advised ''not'' to directly edit this parameter in the file, it contains Longitude in text string format of hemisphere degrees, minutes and seconds. HTML ampersand codes are used for spaces and DMS characters.
Added in version 1.8.0:
|-
*5=Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] (without solar measurement sensors (with or without solar recharging))
|Altitude=0  
 
|your station altitude (default is zero) as entered in same place as other parameters.  See Cumulus Help for that screen. See next parameter to choose unit.
Added in version 1.8.3:
*6=WS2300 (For all La Crosse WS23xx models)
 
Added in version 1.9.1:
*7=Fine Offset/Watson/MyDel etc with Solar Sensors as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]].
 
Added in version 1.9.2:
*8=[[WMR100-200_Protocol|WMR100]]
*9=[[WMR100-200_Protocol|WMR200]]
*10=Instromet (with optional extra solar sensors or without)
 
[[File:Badge vMx.png]]'''Additional values available in MX only:'''
 
Added in version 3.0.0:
*11=Davis WLL
 
Added in version 3.2.0:
*12=Ecowitt GW1000 and Froggit DP1500 (and any equivalents)
|-
|-
|AltitudeInFeet=1
|Model="your Model description"
|Altitude measurement unit for value in previous parameter.
|The weather station model description that you want output by the web tag &lt;#stationtype>
*0 = metres Above Sea Level
{{Version badge 1}} - you choose what text appears for this on (from version 1.9.x) 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
*1 = feet ASL
 
[[File:Badge vMx.png]] - this does not appear in the station settings, stop MX, and add it directly into Cumulus.ini within this [Station] section.
|-
|-
|PeakGustMinutes=N
|RecordSetTimeoutHrs=24
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini.  
|[[File:Badge vMx.png]]Available in MX version 3.5.1 onwards only, allows the time from when a record is set to when it is cleared to be varied. The web tags: TempRecordSet, WindRecordSet, RainRecordSet, HumidityRecordSet, PressureRecordSet, HighTempRecordSet,LowTempRecordSet, HighAppTempRecordSet, LowAppTempRecordSet, HighHeatIndexRecordSet, LowWindChillRecordSet, HighMinTempRecordSet, LowMaxTempRecordSet, HighDewPointRecordSet, LowDewPointRecordSet, HighWindGustRecordSet, HighWindSpeedRecordSet, HighRainRateRecordSet,HighHourlyRainRecordSet, HighDailyRainRecordSet, HighMonthlyRainRecordSet, HighhHumidityRecordSet, HighWindrunRecordSet, LowHumidityRecordSet, HighPressureRecordSet, LowPressureRecordSet, LongestDryPeriodRecordSet, LongestWetPeriodRecordSet, HighTempRangeRecordSet, LowTempRangeRecordSet will all return 1 from when relevant record is set for the period of time set here (default 24 hours) and then reset to 0.
|-
|Latitude=0
|You are advised ''not'' to directly edit this parameter in the file, but to enter the settings via the screen provide in software where you type Latitude (unsigned) Degrees, Minutes, Seconds and select 'N' or 'S'.
{{Version badge 1}}Do this  in the Station Configuration Screen Location block.
[[File:Badge vMx.png]] Exactly same entries, enter using station settings by expanding location section.
Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
|-
|Longitude=0
|You are advised ''not'' to directly edit this parameter in the file, but to type Longitude (unsigned) Degrees, Minutes, Seconds and select 'E' or 'W'.
The place to do this is as described for Latitude depending on Cumulus flavour.
Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
|-
|LatTxt=
|You are advised ''not'' to directly edit this parameter in the file, it contains Latitude in text string format of hemisphere D, M and S. HTML ampersand codes are used for spaces and unit characters.
|-
|LonTxt=
|You are advised ''not'' to directly edit this parameter in the file, it contains Longitude in text string format of hemisphere degrees, minutes and seconds. HTML ampersand codes are used for spaces and DMS characters.
|-
|Altitude=0
|your station altitude (default is zero) as entered in same place as other parameters.  See Cumulus Help for that screen. See next parameter to choose unit.
|-
|AltitudeInFeet=1
|Altitude measurement unit for value in previous parameter.
*0 = metres Above Sea Level
*1 = feet ASL
|-
|PeakGustMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini.  
*With this parameter, N is the number of minutes over which Cumulus calculates its highest wind gust.  
*With this parameter, N is the number of minutes over which Cumulus calculates its highest wind gust.  
*Without this parameter, the default of 10 minutes, the international standard duration, is used.  
*Without this parameter, the default of 10 minutes, the international standard duration, is used.  
Line 608: Line 711:
*0 = Disabled (default), Cumulus will display the wind speed value to the precision used by the station.
*0 = Disabled (default), Cumulus will display the wind speed value to the precision used by the station.
*1 = Enabled, this setting causes wind speeds to be rounded to the nearest integer.
*1 = Enabled, this setting causes wind speeds to be rounded to the nearest integer.
|-
|AvgBearingMinutes=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. This line can be added in the [Station] section of the Cumulus.ini, with this parameter N is the number of minutes over which Cumulus calculates (by treating the wind as a vector and taking into account the speed as well as direction) its average bearing. Without it, the default sampling time = 10 minutes. Note the max number of wind samples stored by Cumulus is 720, so the maximum effective value for N for Fine Offset stations that are read every 10 seconds is 120 (2 hours) while for Davis stations that are sampled every 2 to 3 seconds the maximum effective value is only about 30 (minutes).
See next parameter for behaviour when calm.
|-
|-
|UseZeroBearing=0  
|UseZeroBearing=0  
Line 629: Line 728:
Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
Note that some stations (Fine Offset, for example), do not make a wind chill value available to Cumulus. For these, Cumulus always calculates it.
|-
|-
|UseWindChillCutOff=1
|RolloverHour=0  
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default value is assumed.  Purpose is to disable 'calculate [[Wind chill]] only if temperature less than 10&#176;C rule'.
|Log roll over time as selected on the same screen as other parameters
*0 = Disabled, Cumulus will use any wind speed of 3 mph or more, to modify the temperature, and determine the wind chill ignoring the temperature criterion
*1 = Enabled (default), Cumulus will use both 10&#176;C temperature and  3  mph wind speed criterions to determine if wind chill applies.
Note if your station is a type that supplies wind chill to Cumulus; that ''CalculatedWC=1'' is needed for this setting to have any effect [i.e. you need to set Cumulus (see parameter directly above) to calculate the wind chill as this setting cannot change how your weather station calculates wind chill].
|-
|ChillHourThreshold=45
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The temperature threshold is specified in the units that you use in Cumulus (see [[Heat/cold_degree_days_and_Chill_hours]]).  The default is exactly 45 degrees Fahrenheit (or exactly 7 degrees Celsius, note that is not exactly 45<sup>o</sup>F  depending on which units you use) if the parameter has not been included.
|-
|ChillHourSeasonStart=10
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. The season start figure is the calendar month number (1=January to 12= December).  The default if this parameter is not specified is October (month 10).
|-
|RolloverHour=0  
|Log roll over time as selected on the same screen as other parameters
*0 = midnight
*0 = midnight
*9 = 9am/10am
*9 = 9am/10am
Line 650: Line 737:
*0 = Use 9am in summer (use 10am not checked on Station Configuration Screen)
*0 = Use 9am in summer (use 10am not checked on Station Configuration Screen)
*1 = Use 10am in summer selected on Station Configuration Screen
*1 = Use 10am in summer selected on Station Configuration Screen
|-
|SnowDepthHour=9
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default value is assumed.  This line needs to be added in the [Station] section of the Cumulus.ini, it is the [[Weather_Diary|Snow lying/falling]] roll over time (time when yesterday's values in log.xml are forgotten) - Allowed values are 0 to 23 and represent the time to the nearest hour that snow depth measurements are taken.
*0 = midnight (default)
*9 = 9am,
*13 = 1pm etc.
Note this time is independent of your rollover time selections in the two preceding parameters.
|-
|-
|WarnMultiple=0  
|WarnMultiple=0  
Line 668: Line 748:
*0 = Disabled, application will close immediately
*0 = Disabled, application will close immediately
*1 = Enabled, application will prompt for confirmation that you wish to close it (do not use this if you might suspend/standby/hibernate your computer)
*1 = Enabled, application will prompt for confirmation that you wish to close it (do not use this if you might suspend/standby/hibernate your computer)
Ignored by MX.
[[File:Badge vMx.png]]Ignored by MX.
|-
|-
|CloseOnSuspend=1  
|CloseOnSuspend=1  
Line 728: Line 808:
|LocDesc=  
|LocDesc=  
|A '''Description''' for the location (as entered on the same screen as other parameters) - inserted after 'Welcome to ' on 'Now' web page.
|A '''Description''' for the location (as entered on the same screen as other parameters) - inserted after 'Welcome to ' on 'Now' web page.
|-
|StartDate=13/08/2009
|This parameter is automatically inserted into Cumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application (whichever flavour). See [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|-
|CreateWxnowTxt=0
|This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on a configuration screen. If the parameter is not included in the file, the default value is assumed.
*0= turn off creation of wxnow.txt file (stored in main Cumulus folder)
*1= (default) create wxnow.txt file (an alternative way to get data to CWOP/APRS)
|-
|ListWebTags=0
|This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on a configuration screen. If the parameter is not included in the file, the default value is assumed.
*0= (default) turn off creation of WebTags.txt file (stored in main Cumulus folder)
*1= create WebTags.txt file when Cumulus is restarted (contains an unordered list of all the web tags your Cumulus build will recognise and process)
|-
|-
|LastLoggerDownload=13/08/2008 12:48:52  
|LastLoggerDownload=13/08/2008 12:48:52  
Line 754: Line 821:
|YTDrainyear=0  
|YTDrainyear=0  
|Selected in the same settings page as other parameters.  The year for which the previous parameter (YTDrain) is to be applied. Default is 0 meaning not applied to any year. Note if you selected a month other than January in "RainSeasonStart" parameter,  you will need to change this "YTDrainyear" when the calendar year changes during your first 'rain season' and change it to 0 when you reach the same "RainSeasonStart" month and start your second 'rain season'.
|Selected in the same settings page as other parameters.  The year for which the previous parameter (YTDrain) is to be applied. Default is 0 meaning not applied to any year. Note if you selected a month other than January in "RainSeasonStart" parameter,  you will need to change this "YTDrainyear" when the calendar year changes during your first 'rain season' and change it to 0 when you reach the same "RainSeasonStart" month and start your second 'rain season'.
|-
|RainDayThreshold=-1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default value is assumed.  The threshold value which the daily rainfall has to equal or exceed for the day to be considered a 'rain day'. Default -1 = 0.2mm or 0.01in. Value is entered in your current [[Rain_measurement]] units.
|-
|NoFlashWetDryDayRecords=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  When set to 1 stops new Longest Wet/Dry Period records being 'flashed'
|-
|-
|UseCumulusForecast=0  
|UseCumulusForecast=0  
Line 775: Line 836:
*0 = Disabled
*0 = Disabled
*1 = Enabled
*1 = Enabled
|-
|FCPressureThreshold=0.1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. It specifies the threshold (in mb per hour averaged over 3-hour period) for a pressure change to count as rising or falling rather than steady when determining the Zambretti forecast. The default is 0.1 mb/hr averaged over the previous three hours.  If the parameter is not included in the file, the default value is assumed.
|-
|-
|FCpressinMB=1  
|FCpressinMB=1  
Line 794: Line 852:
*0 = metres
*0 = metres
*1 = feet (default)
*1 = feet (default)
|-
|RTdisconnectcount=N
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. By default, the 'realtime' ftp connection stays connected.  If the parameter is not included in the file, the default value is assumed.  You can make it disconnect periodically by adding an Option to periodically disconnect the realtime FTP connection, the theory being that it will not get stuck if the server dies, and will keep trying to reconnect.
N must be a positive integer. For example set N to '60'; it represents the number of realtime ftp uploads between disconnections - so 60 would give an hour if 1 minute realtime interval selected.
|-
|-
|DataLogging=0
|DataLogging=0
Line 810: Line 864:


[[File:Badge vMx.png]] From version 3.7.0 the default for new installs is now 1. It can be set from the calibration settings screen. It controls the logging of both data spikes and data limits being exceeded. Recommended to be turned on.
[[File:Badge vMx.png]] From version 3.7.0 the default for new installs is now 1. It can be set from the calibration settings screen. It controls the logging of both data spikes and data limits being exceeded. Recommended to be turned on.
|-
|UVdecimals=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
UV values are now displayed and logged as whole numbers by default. You can change this by adding this entry specifying the number of decimal places. (added 1.9.3 build 1038)
*0 = Integer Values (default)
*n = Number of decimal places e.g. 1
|-
|NoSensorCheck=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default value is assumed. 
The option (for 'incomplete' stations) to disable the sensor check described in this [https://cumuluswiki.org/a/FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads FAQ]
*0 = Sensor check enabled (default)
*1 = Sensor check disabled
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus 1 only
|colspan="2" style="background:lightblue;"| Cumulus 1 only
Line 829: Line 871:


[[File:Badge vMx.png]] This parameter is ignored by MX, best to remove it, MX uses a Comport parameter instead, see [[#Parameters_changed|#Parameters_changed section]] above.
[[File:Badge vMx.png]] This parameter is ignored by MX, best to remove it, MX uses a Comport parameter instead, see [[#Parameters_changed|#Parameters_changed section]] above.
|-
|SpecialLog=1
|{{Version badge 1}}This optional parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  If the parameter is not included in the file, the default of no special log is assumed.  Add this entry to start updating a file called 'speciallog.txt' in the data folder with the following fields:
date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dew point,outside temp,outside humidity,outside dew point
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
[[File:Badge vMx.png]] This parameter is ignored by MX
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|colspan="2" style="background:lightblue;"| Cumulus MX only
Line 865: Line 898:
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|-
|ForceVPBarUpdate=0  
|VP2SleepInterval=500
|Set this in the Station Configuration Screen '''Settings''' block. Select to force the Vantage Pro (and Pro2) barometer to update once a minute instead of the default 15 minutes. Note that you may not need this, more recent stations already update every minute
|This read-only parameter is the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds. The default if the parameter has not been added manually to the file is 500 ms; if you suspect that data is being missed, you could add this parameeter, manually reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions. See note in ''readme.txt'' about VP2SleepInterval - in v1.9.3 release it is around line 50. Related FAQ: [[FAQ#My_Davis_station_shows_a_higher_maximum_wind_speed_than_Cumulus]]
*0 = Disabled
|-
*1 = Enabled
|VPClosedownTime=x
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. x is the number of seconds after the start of the re-connect attempts that you want the program to close itself (added v.1.8.5 b.726).
|-
|DavisCalcAltPress=1
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  Davis stations calculate Sea Level Pressure from Station Pressure using a formula based on several parameters such as temperature, humidity, etc, rather than just using altitude as most other stations. CWOP require 'Altimeter Pressure' to be uploaded, i.e. a value calculated simply using altitude.
 
[[File:Badge vMx.png]]'''Note for MX''', use of the LOOP2 (see [[Cumulus.ini_(Beta)#Section:_Station| here]]) means s.l.p. can be obtained from the Davis station.
 
{{Version badge 1}}'''The following note applies to Cumulus 1.x.x:''' The station does not provide this value directly, nor the station pressure, so Cumulus 1.x.x has to read some extra data once a minute in order to do the calculation. This can take several seconds, so it means that a 'normal' data reading may be missed.
 
If you don't use CWOP, or you are happy for Cumulus to send Sea-Level pressure to CWOP (the difference is small unless you are at high altitude), set this value to 0.
Cumulus will then use the Sea-Level Pressure value instead of the Cumulus calculated Altimeter Pressure.
*0 = Disabled
*1 = Enabled (default)
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|-
|ForceVPBarUpdate=0  
|Set this in the Station Configuration Screen '''Settings''' block. Select to force the Vantage Pro (and Pro2) barometer to update once a minute instead of the default 15 minutes. Note that you may not need this, more recent stations already update every minute
*0 = Disabled
*1 = Enabled
|-
|-
|SyncDavisClock=0  
|SyncDavisClock=0  
Line 879: Line 932:
|-
|-
|ClockSettingHour=4
|ClockSettingHour=4
|Configuration file only setting, controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
|Configuration file read-only setting, controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*4 = 04:00 (default value)
*4 = 04:00 (default value)
*0-23 = 00:00 to 23:00
*0-23 = 00:00 to 23:00
Line 897: Line 950:
|Set this in the Station Configuration Screen  '''Davis TCP/IP Settings''' block.
|Set this in the Station Configuration Screen  '''Davis TCP/IP Settings''' block.
Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0
|-
|VP2SleepInterval=500
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
This is the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds. The default is 500 ms; if you suspect that data is being missed, you could try reducing this figure. For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions. See note in ''readme.txt'' about VP2SleepInterval - in v1.9.3 release it is around line 50. Related FAQ: [[FAQ#My_Davis_station_shows_a_higher_maximum_wind_speed_than_Cumulus]]
|-
|VPClosedownTime=x
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. x is the number of seconds after the start of the re-connect attempts that you want the program to close itself (added v.1.8.5 b.726).
|-
|-
|VP2PeriodicDisconnectInterval=0
|VP2PeriodicDisconnectInterval=0
Line 910: Line 956:


Set it to zero to disable, if you are not using the Weatherlink site.
Set it to zero to disable, if you are not using the Weatherlink site.
|-
|-
|DavisCalcAltPress=1
|LogExtraSensors=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  Davis stations calculate Sea Level Pressure from Station Pressure using a formula based on several parameters such as temperature, humidity, etc, rather than just using altitude as most other stations. CWOP require 'Altimeter Pressure' to be uploaded, i.e. a value calculated simply using altitude.
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
 
|-
'''Note for MX''', use of the LOOP2 (see [[Cumulus.ini_(Beta)#Section:_Station| here]]) means s.l.p. can be obtained from the Davis station.
|colspan="2" style="background:lightblue;"|{{Version badge 1}}  Cumulus 1 only: edit in Station Configuration Screen or file as indicated
 
{{Version badge 1}}'''The following note applies to Cumulus 1.x.x:''' The station does not provide this value directly, nor the station pressure, so Cumulus 1.x.x has to read some extra data once a minute in order to do the calculation. This can take several seconds, so it means that a 'normal' data reading may be missed.
 
If you don't use CWOP, or you are happy for Cumulus to send Sea-Level pressure to CWOP (the difference is small unless you are at high altitude), set this value to 0.
Cumulus will then use the Sea-Level Pressure value instead of the Cumulus calculated Altimeter Pressure.
*0 = Disabled
*1 = Enabled (default)
|-
|LogExtraSensors=0
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
|-
|colspan="2" style="background:lightblue;"|{{Version badge 1}}  Cumulus 1 only: edit in Station Configuration Screen or file as indicated
|-
|-
|DavisRainCollectorModel=X
|DavisRainCollectorModel=X
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. (Available from Build 1096 of version 1.9.4)
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. (Available from Build 1096 of version 1.9.4)
Option to specify rain collector model for Davis stations for situations where the Davis DLL is unable to read it from station, and your rain figures in Cumulus are incorrect as a result (can happen when using Virtual VP, for example).
Option to specify rain collector model for Davis stations '''for situations where the Davis DLL is unable to read it from station''' (what it reads from station is default if this parameter is not present), and your rain figures in Cumulus are incorrect as a result (can happen when using Virtual VP, for example).
Value X is an integer from 0 to 5 with the following meanings:
Value X is an integer from 0 to 5 with the following meanings:
*0 = 0.1 inch
*0 = 0.1 inch
Line 945: Line 979:
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
|{{Version badge 1}}This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
|[[File:Badge vMx.png]]This parameter is not available in MX.
Cumulus 1 attempts to restart itself if it has had no data from the station for 60 seconds. Davis stations can use this option explained in the [[#La_Crosse_specific:|La Crosse]] table if Cumulus sometimes fails to read information from the logger. As it says in the help, it may not fix the connection problem, but at least it stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.


This parameter is not available in MX.
{{Version badge 1}}This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
*0 (default) = Cumulus will just stop logging, and processing data, if it has had no data from the Davis station for 60 seconds. As it says in the Cumulus 1 help, use of this parameter may not fix a connection problem. With this default setting a connection problem stops Cumulus logging, so once you have fixed the problem it will download the missing data when you start it up again.
*1 = Cumulus 1 attempts to restart itself if it has had no data from the station for 60 seconds. Davis stations can use this option explained in the [[#La_Crosse_specific:|La Crosse]] table if Cumulus sometimes fails to read information from the logger. Again, this may not fix the problem, but this setting does force Cumulus to have another attempt after making a new connection on start up.
|-
|-
|Port=0
|Port=0
Line 954: Line 989:
Identifies COM Port used if Davis type is serial. Default is 0.
Identifies COM Port used if Davis type is serial. Default is 0.
|-
|-
|colspan="2" style="background:lightblue;"| Only available in Cumulus MX: edit in Station Settings
|colspan="2" style="background:lightblue;"| Only available in Cumulus MX: edit in Station Settings or if read-only directly in file
|-
|-
|UseDavisLoop2=1
|UseDavisLoop2=1
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
|{{Version badge 1}} Not applicable.
 
[[File:Badge vMx.png]]This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
   
   
The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
Line 973: Line 1,010:
|-
|-
|ForceVPBarUpdate=0
|ForceVPBarUpdate=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Added in build 3042 (January 2017). Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Added in build 3042 (January 2017). Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|-
|-
|DavisIncrementPressureDP=0
|DavisIncrementPressureDP=0
|(from version 3.0.0 build 3042) A Cumulus.ini setting to turn off the 'extra' decimal place in pressure values on Davis stations. To limit the pressure to 1 decimal for mb/hPa and 2 for inHg, add this to the [Station] section
|[[File:Badge vMx.png]](from version 3.0.0 build 3042) A Cumulus.ini setting to turn off the 'extra' decimal place in pressure values on Davis stations. To limit the pressure to 1 decimal for mb/hPa and 2 for inHg, add this to the [Station] section
|-
|-
|VPrainGaugeType=0
|VPrainGaugeType=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  The default is to assume that people using MM units to display rain in Cumulus have a Metric Rain Adapter fitted to their rain gauge so it tips for every 0.2mm, and those selecting inches as their unit have the unmodified 0.01" rain gauge. This parameter over-rides that assumption, but note that conversion rounding errors will then occur.
|This read-only parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.  The default is to assume that people using MM units to display rain in Cumulus have a Metric Rain Adapter fitted to their rain gauge so it tips for every 0.2mm, and those selecting inches as their unit have the unmodified 0.01" rain gauge. This parameter over-rides that assumption, but note that conversion rounding errors will then occur.


Specifies the units selected on your Vantage Pro Rain Gauge.  Set to 0 for a 0.2mm gauge and 1 for a 0.01" gauge.
Specifies the units selected on your Vantage Pro Rain Gauge.  Set to 0 for a 0.2mm gauge and 1 for a 0.01" gauge.
Line 986: Line 1,023:
|-
|-
|DataLogging=0
|DataLogging=0
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Default is 0, change to 1 for more detailed Davis logging.
|[[File:Badge vMx.png]]Set in options section of station settings page. Default is 0, change to 1 for more detailed Davis logging.
   
   
*0 (default) = Cumulus MX will not add extra logging.
*0 (default) = Cumulus MX will not add extra logging.
Line 993: Line 1,030:
|-
|-
|AutoUpdateIpAddress=1
|AutoUpdateIpAddress=1
|(read-only, you cannot edit this on station settings screen, you must type it directly into file) default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
|[[File:Badge vMx.png]](read-only, you cannot edit this on station settings screen, you must type it directly into file) default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
|-
|-
|ZeroConfig
|ZeroConfig
|set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|[[File:Badge vMx.png]]set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|}
|}


Line 1,012: Line 1,049:
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|RestartIfUnplugged=0
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|{{Version badge 1}}This is set in the settings frame on the Station settings screen off the configuration menu.
*0 = Disabled, default i.e. deselected on the Station Configuration Screen
*1 = Enabled, Cumulus will restart if it detects that a Fine Offset station is unplugged. '''Note:''' Unless the station has been manually plugged in again, a Cumulus restart has no benefit; normally the station should be checked to be plugged in before Cumulus is ever started and the station then left plugged in.
 
Not applicable to MX
|-
|SyncFOReads=0
|This is set in the settings frame on the Station settings screen off the configuration menu.
*0 = Synchronisation disabled, default (Cumulus reads the memory without taking into account when memory is being updated)
*1 = Re-synchronizes once each day, to avoid reading memory at time of memory update
A Fine Offset station will be writing to its memory every 48 or 60 seconds (depending on model); Cumulus can attempt once a day to identify when this update of memory occurs, and thereafter try not to read the memory at update time, by using what is called a synchronisation mode of operation. See next parameter.
 
Cumulus 1 and MX
|-
|-
|FOReadAvoidPeriod=3
|FOReadAvoidPeriod=3
Line 1,062: Line 1,086:


Tell Cumulus what offset to use, by using an external text editor to insert this parameter where x.y is your pressure offset in  in mb or hPa [i.e. your station (absolute) pressure subtracted from the sea-level (relative) pressure]. Applies to Cumulus 1 and MX.
Tell Cumulus what offset to use, by using an external text editor to insert this parameter where x.y is your pressure offset in  in mb or hPa [i.e. your station (absolute) pressure subtracted from the sea-level (relative) pressure]. Applies to Cumulus 1 and MX.
|}
|-
|RestartIfUnplugged=0
|{{Version badge 1}}This is set in the settings frame on the Station settings screen off the configuration menu.
*0 = Disabled, default i.e. deselected on the Station Configuration Screen
*1 = Enabled, Cumulus will restart if it detects that a Fine Offset station is unplugged. '''Note:''' Unless the station has been manually plugged in again, a Cumulus restart has no benefit; normally the station should be checked to be plugged in before Cumulus is ever started and the station then left plugged in.
 
Not applicable to MX
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|-
|SyncFOReads=0
|Cumulus 1 and MX
*0 = Synchronisation disabled, default (Cumulus reads the memory without taking into account when memory is being updated)
*1 = Re-synchronizes once each day, to avoid reading memory at time of memory update
A Fine Offset station will be writing to its memory every 48 or 60 seconds (depending on model); Cumulus can attempt once a day to identify when this update of memory occurs, and thereafter try not to read the memory at update time, by using what is called a synchronisation mode of operation. See next parameter.
|}


==== Spike Removal ====
==== Spike Removal ====
Line 1,186: Line 1,225:
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors.
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors.
(Note this attribute appears in [[#Davis_family_specific|Davis family]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above and in [[#Instromet_station_specific:|Instromet station specific:]] table below with different usage explanations).
(Note this attribute appears in [[#Davis_family_specific|Davis family]] and [[#Introduced_for_problems_with_Fine_Offset_family:|Fine Offset family]] tables above and in [[#Instromet_station_specific:|Instromet station specific:]] table below with different usage explanations).
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|-
|WMR928TempChannel=N
|WMR928TempChannel=N
Line 1,203: Line 1,244:
|style="background:lightgray;"|[Station]  
|style="background:lightgray;"|[Station]  
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameters listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX unless indicated.
|-
|-
|WS2300Sync=1
|WS2300Sync=1
Line 1,288: Line 1,331:
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX.
|-
|-
|ImetWaitTime=200
|ImetWaitTime=200
|This parameter (attribute=value) if you need to change it from its '''default of 200 ms''' is added directly to the file, it does not appear on a configuration screen.  
|This parameter (attribute=value) if you need to change it from its '''default of 200 ms''' is added directly to the file, it does not appear on a configuration screen.  
Specifies the time in milliseconds that Cumulus allows for a response from an Instromet station. If you are having problems with reading from an Instromet station, try inserting this line into the ''Station'' section using a value of 500. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.
Specifies the time in milliseconds that Cumulus allows for a response from an Instromet station. If you are having problems with reading from an Instromet station, try inserting this line into the ''Station'' section using a value of 500. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus MX stopped. Only Cumulus MX.
|-
|ImetBaudRate=19200
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to manually set this value in Cumulus.ini before running the program.
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Station Settings,  for Cumulus 1 edit in Station Configuration Screen
|-
|-
|SyncDavisClock=0  
|SyncDavisClock=0  
Line 1,305: Line 1,356:
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations. For a wet bulb sensor, Cumulus will output the temperature it shows, but not calculate the humidity.
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations. For a wet bulb sensor, Cumulus will output the temperature it shows, but not calculate the humidity.
(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).
|-
|colspan="2" style="background:lightblue;"| Only Cumulus MX: edit in Station Settings
|-
|ImetBaudRate=19200
|This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to manually set this value in Cumulus.ini before running the program.
|}
|}


Line 1,326: Line 1,371:
|style="background:lightgray;"|[Offsets]  
|style="background:lightgray;"|[Offsets]  
|style="background:lightgray;"|Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors
|style="background:lightgray;"|Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Used in both C1 and MX.
|-
|TempMult2=1.0
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default second order multiplier is 1.0.
"Second order" multiplier by which measured outdoor Temperature is to be corrected, this means that the logged reading can be (TempMult2 X measured-temp X measured_temp) + (TempMult X measured_temp) + TempOffset
|-
|colspan="2" style="background:pink;"|Read-only parameters - The parameter listed below must be entered directly into file with Cumulus stopped. Only MX (build 3045 onwards).
|-
|HumMult2=1.0
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default second order multiplier is 1.0.
"Second order" multiplier by which measured outdoor Humidity is to be corrected, this means that the logged reading can be (HumMult2 X measured_hum X measured_hum) + (HumMult X measured_hum) + HumOffset
|-
|-
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|colspan="3" style="background:lightblue;"| Both Cumulus flavours
|-
|-
|TempOffset=Offset_Value  
|TempOffset=Offset_Value  
|Default 'Offset_Value' is 0 in this parameter, used for quadratic formula shown below
|Default 'Offset_Value' is 0 in this parameter, used for quadratic formula shown for read-only parameter
|-
|-
|TempMult=1  
|TempMult=1  
|First order multiplier by which measured outdoor Temperature is to be corrected (default=1).
|First order multiplier by which measured outdoor Temperature is to be corrected (default=1).
For formula see next item.
For formula see read-only item.
|-
|TempMult2=0.0
|This line needs to be added in the [Offsets] section of the Cumulus.ini, if it is omitted default multiplier is 0.0.
"Second order" multiplier by which measured outdoor Temperature is to be corrected, this means that the logged reading can be (TempMult2 X measured-temp X measured_temp) + (TempMult X measured_temp) + TempOffset
|-
|-
|HumMult=1  
|HumMult=1  
|Multiplier by which measured Humidity is to be corrected (default=1). See formula in next row
|Multiplier by which measured Humidity is to be corrected (default=1). See formula in read-only parameter
|-
|-
|HumOffset=Offset_Value  
|HumOffset=Offset_Value  
|Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus Humidity = measured_Humidity X Humidity_multiplier + 'Offset_Value'
|Default 'Offset_Value' is 0 in this parameter used for formula in MX read-only parameter above
|-
|-
|WetBulbMult=1
|WetBulbMult=1
Line 1,437: Line 1,490:
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|colspan="2" style="background:lightblue;"| Both Cumulus flavours - in MX edit in Internet Settings, see individual entry for Cumulus 1 edits
|-
|-
|Logging=0
|DailyProgram=  
|Determines whether enhanced "debugging" logging takes place where Cumulus 1 or MX makes a detailed record of each action that takes place.
*0 (default) = Cumulus 1 or MX will not add debug logging.
*1 = For '''debug''' logging when Cumulus 1 or MX (re-)starts, add ''Logging=1'' to the station section of Cumulus.ini while Cumulus is stopped.
 
[[File:Badge vMx.png]] In MX only, it can also be set in the admin interface internet settings screen. Note that if set on the admin interface, it only remains set while Cumulus continues to run, and resets to default off when MX re-starts. For MX, if you want debugging output every time it runs, then add "-debug" parameter as explained at [[Cumulus_MX#Parameter_for_adding_debugging|Parameter_for_adding_debugging]]
|-
|DailyProgram=  
|In Cumulus 1, set in the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
|In Cumulus 1, set in the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block.  The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
*default - none
*default - none
Line 1,698: Line 1,744:


=== Section: MySQL ===
=== Section: MySQL ===
Not applicable to Cumulus 1.
[[File:Badge vMx.png]]Only applicable to Cumulus MX.
Cumulus MX uses Cumulus.ini to store the MySQL configuration details.
Cumulus MX uses Cumulus.ini to store the MySQL configuration details.
All details are input on '''The MySQL settings screen'''. Here are the default settings. See [[Cumulus MX]] page for examples of what can be selected.
All details are input on '''The MySQL settings screen'''. Here are the default settings. See [[Cumulus MX]] page for examples of what can be selected.
Line 1,722: Line 1,774:
CustomMySqlSecondsInterval=10
CustomMySqlSecondsInterval=10
CustomMySqlMinutesIntervalIndex=6</pre>
CustomMySqlMinutesIntervalIndex=6</pre>


=== Section: Display ===
=== Section: Display ===
Line 1,991: Line 2,038:
=== Section: Solar ===
=== Section: Solar ===


[[File:Badge vMx.png]] Available from version 3.0.0 only.
{{Version badge 1}}Set mostly in '''solar block''' at foot of ''Station Settings'' screen in Configuration menu.
 
[[File:Badge vMx.png]]Set in '''Solar''' section quite a long way down on ''Station settings'' page in Settings menu


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Parameter Line Entry
!style="width:150px" | Parameter Line Entry
!style="width:800px" | Function  
!style="width:600px" | Function  
|-
|style="background:lightgray;"|[Solar]
|style="background:lightgray;"|Section Name - the following parameters are set as described above
|-
|colspan="2" style="background:lightblue;"| Both Cumulus flavours
|-
|SunThreshold=75
|If you have a solar sensor: Cumulus tries to determine whether the sun is shining by determining whether the current solar radiation value is above a certain percentage of the current theoretical maximum. The value you supply here is used as that percentage. The default value is 75%.
|-
|RStransfactor=0.8
|Cumulus uses the Ryan-Stolzenbach formula to determine the current theoretical maximum solar radiation at your location at the current moment in time. This formula has a factor to allow for the transmission of the radiation through the atmosphere; the default is 0.80.
|-
|SolarMinimum=0
|This setting allows you to specify a minimum solar radiation value which needs to be reached before it can be considered to be sunny. Note that this setting does not replace the calculation using the current theoretical maximum, it specifies an additional condition which has to be met. This setting therefore allows you to cater for the periods at the beginning and end of the day when the theoretical maximum is very low.
|-
|LuxToWM2=0.0079
|Edit cumulus.ini to add this parameter if you have a Fine Offset station with a solar detector. These supply 'Lux' values rather than 'W/m2' values that Davis stations supply. Cumulus attempts to convert from Lux to W/m2 using the supplied multiplication factor. You can add this parameter if you want to use a value other than the default of 0.0079, which is the generally accepted standard conversion factor for sunlight.
|-
|-
|style="background:lightgray;"|[Solar]
|UseBlakeLarsen=0
|style="background:lightgray;"|Section name - the following parameters relate to the solar configuration.
| Called B/l on screen. Set this to 1 if you have a Blake-Larsen Sun Recorder, and you want Cumulus to get today's sunshine hours from it. You need to configure the Blake-Larsen software to put the SRsunshine.dat file into the Cumulus data folder so that Cumulus can read it.
|-
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|colspan="2" style="background:lightblue;"| [[File:Badge vMx.png]] Available from MX version 3.0.0 only
|-
|-
|SolarCalc=1
|SolarCalc=1
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when the solar calculation method is set.
The value is set in the MX user interface when the solar calculation method is set.
*0 (default) = Ryan-Stolzenbach calculation, which uses the RStransfactor entry to tune the output.
*0 (default) = Ryan-Stolzenbach calculation, which uses the RStransfactor entry to tune the output.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
|-
|-
|BrasTurbidity=2.0
|BrasTurbidity=2.0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when the solar calculation method is set.
*2.0 (default) = Perfect clear sky
*2.0 (default) = Perfect clear sky
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
Line 2,017: Line 2,082:
=== Section: Graphs ===
=== Section: Graphs ===


Set many of these parameters using '''Configuration''' menu and either ''Display'' (Graphs block) or ''Colours'' screens.
For individual settings, check whether they apply to Cumulus 1 only, MX only, or to both flavours.
Set the colours of the data lines on graphs/charts and Select whether to plot particular data by using '''View''' menu and ''Graphs'' option, then right click over the relevant graph.
Set the SAG colours and axis position by using '''View''' menu and ''Select-A-Graph'' option, the settings for different observations are at the foot of the screen.


The only settings used in this section by both Cumulus 1 and Cumulus MX are the first 2 - "ChartMaxDays" and "GraphHours.
{{Version badge 1}}In Cumulus 1, in '''Configuration''' menu,  select either ''Display'' (Graphs block) or ''Colours'' screens for most options. Set the colours of the data lines on graphs/charts. Select whether to plot particular data by using '''View''' menu and ''Graphs'' option, then right click over the relevant graph. Set the SAG colours and axis position by using '''View''' menu and ''Select-A-Graph'' option, the settings for different observations are at the foot of the screen.


The next few are only used by Cumulus MX, then the remainder are Cumulus 1 only.
[[File:Badge vMx.png]] All settings in this table are controlled in the '''Graphs''' section at the bottom of the '''Station Settings''' page.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,312: Line 2,375:


=== Section: Alarms ===
=== Section: Alarms ===
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.
[[File:Badge vMx.png]]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)
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,336: Line 2,400:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|LowTempAlarmSoundFile=C:\Cumulus\alert.wav
|LowTempAlarmSoundFile=
|Path and file name of sound file for Low Temperature alarm
|Path and file name of sound file for Low Temperature alarm
|-
|-
Line 2,352: Line 2,416:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighTempAlarmSoundFile=C:\Cumulus\alert.wav
|HighTempAlarmSoundFile=  
|Path and file name of sound file for High Temperature alarm
|Path and file name of sound file for High Temperature alarm
|-
|-
Line 2,366: Line 2,430:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|LowPressAlarmSoundFile=C:\Cumulus\alert.wav
|LowPressAlarmSoundFile=
|Path and file name for sound file to play for Low Pressure Alarm
|Path and file name for sound file to play for Low Pressure Alarm
|-
|-
Line 2,382: Line 2,446:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighPressAlarmSoundFile=C:\Cumulus\alert.wav
|HighPressAlarmSoundFile=  
|Path and file name for the sound file used for the High Pressure Alarm
|Path and file name for the sound file used for the High Pressure Alarm
|-
|-
Line 2,398: Line 2,462:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighRainTodayAlarmSoundFile=C:\Cumulus\alert.wav
|HighRainTodayAlarmSoundFile=
|Path and file name for the sound file used for the High Rain Today Alarm
|Path and file name for the sound file used for the High Rain Today Alarm
|-
|-
Line 2,414: Line 2,478:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighRainRateAlarmSoundFile=C:\Cumulus\alert.wav
|HighRainRateAlarmSoundFile=  
|Path and file name for the sound file used for the High Rain Rate Alarm
|Path and file name for the sound file used for the High Rain Rate Alarm
|-
|-
Line 2,430: Line 2,494:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighGustAlarmSoundFile=C:\Cumulus\alert.wav
|HighGustAlarmSoundFile=
|Path and file name for the sound file used for the High Gust Alarm
|Path and file name for the sound file used for the High Gust Alarm
|-
|-
Line 2,446: Line 2,510:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|HighWindAlarmSoundFile=C:\Cumulus\alert.wav
|HighWindAlarmSoundFile=  
|Path and file name for the sound file used for the High Wind Alarm
|Path and file name for the sound file used for the High Wind Alarm
|-
|-
Line 2,459: Line 2,523:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|SensorAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|SensorAlarmSoundFile=
|Path and file name for the sound file used for the Sensor Contact lost Alarm
|Path and file name for the sound file used for the Sensor Contact lost Alarm
|-
|-
Line 2,475: Line 2,539:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|TempChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|TempChangeAlarmSoundFile=
|Path and file name for the sound file used for the Temperature Change Alarm
|Path and file name for the sound file used for the Temperature Change Alarm
|-
|-
Line 2,491: Line 2,555:
*1 = Enable sound on alarm
*1 = Enable sound on alarm
|-
|-
|PressChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav
|PressChangeAlarmSoundFile=
|Path and file name for the sound file used for the Pressure Change Alarm
|Path and file name for the sound file used for the Pressure Change Alarm
|}
|}
Line 2,806: Line 2,870:
==== Section: xAP ====
==== Section: xAP ====


{{Version badge 1}Set in the Internet Configuration Screen sites/Options tab
{{Version badge 1}}Set in the Internet Configuration Screen sites/Options tab


[[File:Badge vMx.png]]It is in Cumulus.ini for MX, but nobody has told me whether it can be edited within the Admin interface.
[[File:Badge vMx.png]]It is in Cumulus.ini for MX, but nobody has told me whether it can be edited within the Admin interface.
Line 2,831: Line 2,895:


==== Section: WeatherCloud ====
==== Section: WeatherCloud ====
Not available in Cumulus 1


[[File:Badge vMx.png]] Only available from version 3.0.0
[[File:Badge vMx.png]] Only available from version 3.0.0
Line 2,845: Line 2,911:
|-
|-
|Wid=
|Wid=
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when the Weathercloud ID value is set.
The value is set in the MX user interface when the Weathercloud ID value is set.
|-
|-
|Key=
|Key=
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when your Weathercloud API Key value is set.
The value is set in the MX user interface when your Weathercloud API Key value is set.
|-
|-
|Enabled=0
|Enabled=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|This parameter controls whether data is sent to WeatherCloud
*0 = Disable sending of data (default)
*0 (default) = Disable sending of data
*1 = Enable sending of data
*1 = Enable sending of data
|-
|-
|SendUV=0
|SendUV=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when the Include UV value is set.
The value is set in the MX user interface when the Include UV value is set.
*0 = Do not send UV data (default)
*0 = Do not send UV data (default)
*1 = Send UV data
*1 = Send UV data
|-
|-
|SendSR=0
|SendSR=0
|This parameter (attribute=value) can be added directly to the file, it does also appear on the user interface screen.
|The value is set in the MX user interface when the Include Solar Radiation value is set.
The value is set in the MX user interface when the Include Solar Radiation value is set.
*0 = Do not send Solar data (default)
*0 = Do not send Solar data (default)
*1 = Send Solar data
*1 = Send Solar data
|}
|}


==== Section: WLL ====


 
Not available in Cumulus 1
 
==== Section: WLL ====


[[File:Badge vMx.png]] Only available from version 3.0.0
[[File:Badge vMx.png]] Only available from version 3.0.0
Line 2,923: Line 2,984:
|Default value = 0, which transmitter do you want to use as your extra temperature sensor [1-8], set via the station configuration screen.
|Default value = 0, which transmitter do you want to use as your extra temperature sensor [1-8], set via the station configuration screen.
|-
|-
|ExtraHumOnTx[1 to 8]=0
|ExtraHumOnTx[1 to 8]=0
|Default value = 0, does the temperature sensor transmitter [1-8] also have a humidity sensor, set via the station configuration screen.
|Default value = 0, does the temperature sensor transmitter [1-8] also have a humidity sensor, set via the station configuration screen.
|-
|-
|BroadcastDuration=300
|BroadcastDuration=300
|Default value = 300, how long the WLL device is requested to broadcast for before timing out. Only set via the ini file, there should be no need to change this.
|Default value = 300, how long the WLL device is requested to broadcast for before timing out. Only set via the ini file, there should be no need to change this.
|-
|-
|BroadcastPort=22222
|BroadcastPort=22222
|Default value = 22222, what port the WLL device broadcasts on. Only set via the ini file, there should be no need to change this.
|Default value = 22222, what port the WLL device broadcasts on. Only set via the ini file, there should be no need to change this.
|}
|}
 
==== Section: Windy ====
 
Not available in Cumulus 1
 
[[File:Badge vMx.png]] Only available from version 3.0.0 build 3049 onwards. Edit all parameters in the '''Internet settings''' screen, ''Windy.com'' section.
 
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Windy]
|style="background:lightgray;"|Section Name
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|Enabled=0
|This tick box is used if you want to export to Windy.com, default is disabled.
|-
|APIkey=
|Here you enter the API key you are given when you create a Windy account, default is null. If you have an account, this is a very long string, so paste it in carefully!
|-
|StationIdx=0
|If you were uploading more than one station, on the same account, this indicates the index for this upload, default is 0, the first station you define in your account
|-
|Interval=15
|How many minutes between updates (Windy will not allow updates more frequently than every 5 minutes, so that is minimum allowed here)
|-
|SendUV=0
|A tick box to indicate whether you want MX to send UV data, default is no UV readings to send
|-
|CatchUp=1
|When you restart MX, if the weather station allows it, MX will read "catch-up" readings from the station's logger, the default is to send these to Windy.com. Untick this box if you don't want past values to be sent.
|}
 
=== Section: NOAA ===
 
{{Version badge 1}}All these can be set in the '''NOAA Setup Screen''' in Configuration menu. 
 
[[File:Badge vMx.png]]Set these setting on the '''NOAA Settings''' page within Settings menu.


==== Section: Windy ====
You might select to close Cumulus, and edit the 'NOAATempNorm[Jan-Dec]' and 'NOAARainNorm[Jan-Dec]' parameters by using a external editor to manipulate into required format, copy, and paste, the values from another source (as there are a lot of figures to type in).


[[File:Badge vMx.png]] Only available from version 3.0.0 build 3049 onwards. Edit all parameters in the '''Internet settings''' screen, ''Windy.com'' section.
'''Please note:''' because this section of Cumulus.ini uses [[Webtags#Time.2FDate_.27format.27_Parameter|date format]] parameters, you are advised to read [[Webtags#The_format_used_for_naming_reports]].


{| class="wikitable" border="1"
The settings that you use for Cumulus 1 may not be the same as settings you use for MX. If for Cumulus 1, you used capital "M" to represent month it will work for MX too. If for Cumulus 1 you used "NOAAMO'mmyy'.txt" and you then move to MX at any version from version 3.3.0 onwards, it will automatically change your setting to  "NOAAMO'MMyy'.txt" (which works on both Cumulus MX and, if you then revert, also on Cumulus 1).
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Windy]
|style="background:lightgray;"|Section Name
|-
|colspan="2" style="background:lightblue;"| Cumulus MX only
|-
|Enabled=0
|This tick box is used if you want to export to Windy.com, default is disabled.
|-
|APIkey=
|Here you enter the API key you are given when you create a Windy account, default is null. If you have an account, this is a very long string, so paste it in carefully!
|-
|StationIdx=0
|If you were uploading more than one station, on the same account, this indicates the index for this upload, default is 0, the first station you define in your account
|-
|Interval=15
|How many minutes between updates (Windy will not allow updates more frequently than every 5 minutes, so that is minimum allowed here)
|-
|SendUV=0
|A tick box to indicate whether you want MX to send UV data, default is no UV readings to send
|-
|CatchUp=1
|When you restart MX, if the weather station allows it, MX will read "catch-up" readings from the station's logger, the default is to send these to Windy.com. Untick this box if you don't want past values to be sent.
|}


=== Section: NOAA ===
All these can be set in the NOAA Setup Screen in Configuration menu.  You might select to close Cumulus, and edit the 'NOAATempNorm[Jan-Dec]' and 'NOAARainNorm[Jan-Dec]' parameters by using a external editor to manipulate into required format, copy, and paste, the values from another source (as there are a lot of figures to type in).


'''Please note:''' because this section of Cumulus.ini uses [[Webtags#Time.2FDate_.27format.27_Parameter|date format]] parameters, it is not directly exchangeable between Cumulus 1 and Cumulus MX. You will need to update this section using the NOAA Setup Screen in Configuration menu.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 3,047: Line 3,119:
|NOAARainNorm[Jan-Dec]=-1000
|NOAARainNorm[Jan-Dec]=-1000
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|Long term rainfall averages for each month, used for 'departure from the norm' calculations. '-1000' is used to represent Null, a parameter that has not yet been set
|}
=== Section: Solar ===
Set mostly in solar block at foot of Station Settings screen.
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Solar]
|style="background:lightgray;"|Section Name - the following parameters are set from the Solar Setup dialog in Cumulus
|-
|SunThreshold=75
|If you have a solar sensor: Cumulus tries to determine whether the sun is shining by determining whether the current solar radiation value is above a certain percentage of the current theoretical maximum. The value you supply here is used as that percentage. The default value is 75%.
|-
|RStransfactor=0.8
|Cumulus uses the Ryan-Stolzenbach formula to determine the current theoretical maximum solar radiation at your location at the current moment in time. This formula has a factor to allow for the transmission of the radiation through the atmosphere; the default is 0.80.
|-
|SolarMinimum=0
|This setting allows you to specify a minimum solar radiation value which needs to be reached before it can be considered to be sunny. Note that this setting does not replace the calculation using the current theoretical maximum, it specifies an additional condition which has to be met. This setting therefore allows you to cater for the periods at the beginning and end of the day when the theoretical maximum is very low.
|-
|LuxToWM2=0.0079
|Edit cumulus.ini to add this parameter if you have a Fine Offset station with a solar detector. These supply 'Lux' values rather than 'W/m2' values that Davis stations supply. Cumulus attempts to convert from Lux to W/m2 using the supplied multiplication factor. You can add this parameter if you want to use a value other than the default of 0.0079, which is the generally accepted standard conversion factor for sunlight.
|-
|UseBlakeLarsen=0
| Called B/l on screen. Set this to 1 if you have a Blake-Larsen Sun Recorder, and you want Cumulus to get today's sunshine hours from it. You need to configure the Blake-Larsen software to put the SRsunshine.dat file into the Cumulus data folder so that Cumulus can read it.
|}
|}


Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/6976...7049"

Navigation menu