Cumulus.ini (preserving history): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
| Line 428: | Line 428: | ||
|- |
|- |
||
|FOReadAvoidPeriod=3 |
|FOReadAvoidPeriod=3 |
||
|Sets the |
|Sets the interval (in seconds) during each 48 second 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 takes place, this will give an idea of whether it would be useful to adjust this setting. |
||
*3 = default value |
*3 = default value |
||
|- |
|- |
||
Revision as of 19:04, 21 June 2014
Initial Configurations
The main cumulus.ini configuration file is located in the directory in which you installed Cumulus.exe. It is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up. Cumulus re-writes the contents of the application configuration screens to the file when it shuts down.
A second cumulus.ini may be stored in the reports sub-directory, this only contains a single section and relates to the screen used for NOAA reports.
The parameters listed can change the look of Cumulus, hold basic information about your location, amend the way Cumulus interfaces with your weather station, and hold the settings used to interface with your website and various external websites.
If you are using an old version, then checking the release information may be advisable to identify the sections applicable to your build and the parameters allowed within those sections may be a subset of those listed below.
File Structure
The main file consists of a number of sections, each with a heading delimited by '[ ]', (although the order in the file may be different to that in this article). Parameter lines are in the form 'attribute=value' and grouped by those sections.
Some sections relate to the external websites that Cumulus can optionally supply with updates. These are set by configuration screens and the whole sections will always be present. If you do not use those external services their parameters will be set to the defaults.
Each new version of cumulus may add additional parameters set by revised configuration screens (these initially appear at the end of the relevant section), and/or permit additional parameters to be added manually (these can be inserted anywhere within the section).
Beta builds
If you are using a beta build, there may be changes to the information shown below with additional sections and/or additional parameters (attribute=value) under test. Brief details of such changes will be given in the support forum annoucement for the relevant build. New sections and/or attributes and/or values for beta versions of Cumulus are not listed here until the version becomes 'live' however there is a page that details the additional parameters available in the Beta version once they have become established, but for details of beta tests see the forum.
Editing the file
Initialisation
When Cumulus is run for the very first time, the Station settings screen within the Configuration menu is displayed, so that the basic minimum settings can be entered into Cumulus.ini. Should you accidentally delete Cumulus.ini this would happen again, so it is always best to take a backup of the complete Cumulus directory and sub-directories so nothing is lost in such a situration.
See Setup for further advice, noting in particular that some settings (such as units, date/time formats) should stay unchanged.
Settings controlled by application
Many configuration parameter lines are changed from the various application edit, view, or configuration screens, and so making any amendments using those screens should ensure your replacement values are acceptable. You should never edit these parameter lines directly in the file while Cumulus is running, as when Cumulus shuts down it will replace your amendments to these parameters with the contents of the relevant application Edit/View/Configuration screens.
You can edit them in the file with Cumulus stopped, but beware of selecting invalid values for these parameters, generally it is safer to use the application to edit them (unless you are importing values from another setup), and Cumulus will read the new values when it is next restarted.
Settings independent of application
Some configuration settings can only be applied by editing this file to insert a new parameter line; they do not appear anywhere in the configuration screens. Cumulus does not write these values back out to the file on shut down, so they do not appear with default values - in other words, you need to add them if you want to set them. Make sure you place these additional parameters in the correct section as listed below.
Editing outside Cumulus
- It is best to take a copy of the existing cumulus.ini file before you make any changes (either by using application screens or by editing the file), so you can return to the original if necessary.
- If your system is configured to use a comma for a decimal separator, then you should use a comma in any decimal values that you set in this file.
- You should use a text editor (not a rich text editor nor word processor) to edit this file as only letters, numerical digits, decimal separators and the equals symbol are allowed in any parameter. If you use a spreadsheet program to make use of the manipulation it offers, ensure it is set to output in pure text.
- The parameter lines (attribute=value) can be in any order, but must be in the correct section. You might find it helpful to sort the attributes within a section into alphabetical order, to ensure you have no duplicates and to make it easier to find the particular parameter line you may wish to edit in the future.
File Contents
Introduction
The entries shown in the 'parameter line entry' column include the default value from the configuration screen where applicable, a typical example value where appropriate, or just the attribute and an equals sign where there is no typical value.
Section: Station
See individual parameters for specific instructions on setting them. In many cases this is by using Station Configuration Screen, but if the parameter line does not exist in your file, then insert it using a file editor as per instructions above.
| Parameter Line Entry | Function |
|---|---|
| [Station] | Section name - the following parameters relate to the station configuration. |
| Type=-1 | Station Type as set by the checked radio box in the Station Configuration Screen, Station Type block. For details of Supported_Devices click that link.
NOTE: You can also use Type=4 if you want to run Cumulus 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 EWFile= attribute should be at its default of not having any filename value. |
| Model="your Model description" | The weather station model description - you choose what text appears for this on (from version 1.9) 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen). |
| Port=0 | Selected in the Station Configuration Screen Settings block. Com port in your computer which is connected to your weather station if connected via a serial port. Defaults to port 0. |
| Latitude=0 | You are advised not to directly edit this parameter in the file, but to type Latitude (unsigned) Degrees, Minutes, Seconds and select 'N' or 'S' in the Station Configuration Screen Location block. 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' in the Station Configuration Screen Location block. 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, but to type Latitude Degrees, Minutes, Seconds in the Station Configuration Screen Location block. Latitude in text string format of hemisphere D, M and S. HTML ampersand codes are used for spaces and unit characters. |
| LonTxt= | 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 the Station Configuration Screen Location block. See Cumulus Help for that screen. See next parameter to choose unit. |
| AltitudeInFeet=1 | Altitude measurement unit for value in previous parameter is set in the Station Configuration Screen Location block.
|
| AvgSpeedMinutes=N | This line can be added in the [Station] section of the Cumulus.ini, if you have set the next parameter so that Cumulus does its own calculation of average wind speed.
|
| Wind10MinAverage=0 | Selected in the Station Configuration Screen Settings block.
|
| UseSpeedForAvgCalc=0 | Selected in the Station Configuration Screen Settings block.
Note that there isn't really any point enabling this option for Davis stations, as their 'longer-term speed' is a 10 minute average anyway; neither for La Crosse stations, as they only supply one wind speed anyway. |
| RoundWindSpeed=0 | Selected in the Station Configuration Screen Settings block.
|
| 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 = 10. See next parameter for behavoir when calm. |
| UseZeroBearing=0 | Set this in the Station Configuration Screen Settings block.
|
| CalculatedDP=0 | Selected in the Station Configuration Screen Settings block.
|
| CalculatedWC=0 | Selected in the Station Configuration Screen Settings block.
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 | This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. Purpose is to disable 'calculate Wind chill only if temperature less than 10°C rule'.
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) |
| 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 to 12) |
| RolloverHour=0 | Log roll over time as selected on the Station Configuration Screen
|
| Use10amInSummer=1 | Daylight saving correction for 9am roll over
|
| SnowDepthHour=9 | This line needs to be added in the [Station] section of the Cumulus.ini, it is the 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.
Note this time is independent of your rollover time selections in the two preceding parameters. |
| WarnMultiple=0 | Set as 'Stop 2nd instance' in the Station Configuration Screen Program Settings block. Controls behavoir for Multiple Instances of Cumulus running on PC. Requires a Cumulus restart if value toggled, before new behavoir will take effect.
|
| ConfirmClose=0 | Selected in the Station Configuration Screen Program Settings block. Toggles Confirmation you wish to close Cumulus application after telling it to close
|
| CloseOnSuspend=1 | If this is selected, in the Station Configuration Screen Program Settings block, Cumulus will close if you suspend/standby/hibernate your computer. You should not select the previous parameter 'ConfirmClose' if you use this option.
|
| DataLogInterval=2 | Selected in the Station Configuration Screen Data log interval block on the right hand side and defines frequency of logged information in the Monthly_log_files and, when applicable, in Extra_Sensor_Files.
Notes:
|
| UseDataLogger=1 | Selected in the Station Configuration Screen Settings block.
|
| WindUnit=0 | Wind speed measurement unit Cumulus records in as selected in the Station Configuration Units block
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. dm/s for Fine Offset) and so the values are converted to any of the 4 listed during processing |
| PressureUnit=0 | Pressure_Measurement unit Cumulus records in (as selected in the Station Configuration Units block)
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. hPa for Fine Offset) and so the values are converted to any of the 3 listed during processing |
| RainUnit=0 | Rain_measurement unit Cumulus records in (as selected in the Station Configuration Units block)
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. dm for Fine Offset) and so the values are converted to either of the 2 listed during processing |
| TempUnit=0 | Temperature measurement unit Cumulus records in (as selected in the Station Configuration Units block)
These are the labels that Cumulus applies on its screens and web pages, most weather stations work in one unit (e.g. for Fine Offset a positive integer (a 12bit value) that uses 0 at -40 degrees Celsius/Fahrenheit and 500 at 10 degrees Celsius/50 degrees Fahrenheit; i.e. you get the actual temperature in Celsius by subtracting 400 and dividing by 10) and so the values are converted to either of the 2 listed during processing |
| LocName= | Location Name (as entered on the Station Configuration Screen) |
| LocDesc= | Location Description (as entered on the Station Configuration Screen) |
| 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. See FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong |
| LastLoggerDownload=13/08/2008 12:48:52 | The date/time of the last down load from your weather station (note: no longer used, so only present if you used an earlier Cumulus version); see <#LastDataReadT> and Timestamp for similar functionality |
| RainSeasonStart=1 | Selected in the Station Configuration Screen Settings block.
The month (1 to12) of the year that is used as the start of the annual 'rain season'. Default = 1 = January. |
| YTDrain=0 | Selected in the Station Configuration Screen Settings block. Year to date correction if starting part way through rainfall year (see previous parameter). Value is entered in your current Rain_measurement units. Default is 0. |
| YTDrainyear=0 | Selected in the Station Configuration Screen Settings block. The year for which the previous parameter (YTDrain) is to be applied. Default is 0 meaning not applied to any year. |
| RainDayThreshold=-1 | This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. 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 | From the Station Configuration Screen Forecast block, if selected Cumulus will generate a simple weather forecast, if your station does not supply one, or as an alternative to the one supplied by your station. See the Forecast webtag for more information. See next parameter for interval between forecast updates.
|
| HourlyForecast=0 | From the Station Configuration Screen Forecast block 'update hourly' parameter, applies only if Cumulus is set (see previous parameter) to generate a forecast (see FAQ#My_forecast_says_.22Not_available.22),
|
| UseCumulusPresstrendstr=0 | Set in the Station Configuration Screen Settings block. If selected Cumulus will generate the name for the current pressure trend, e.g. "Falling", "Rising quickly" etc, instead of the one supplied by your station. The names used are those in the UK Shipping Forecast. Note that some stations do not supply this anyway, so setting this has no effect (Cumulus always generates the names for those stations).
|
| FCpressinMB=1 | Forecast pressure unit as selected in Station Configuration Forecast block
|
| FClowpress=950 | Low Pressure extreme limit as entered in the Station Configuration Forecast block. Default is 950mb |
| FChighpress=1050 | High Pressure extreme limit as entered in the Station Configuration Forecast block. Default is 1050mb |
| CloudBaseInFeet=1 | Cloud base measurement unit as selected in the display screen within configuration menu
|
| 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. 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. |
| Logging=1 | Add to cumulus.ini [Station] section to have Cumulus start with debug logging on |
| ListWebTags=1 | Add this entry to make Cumulus create (each time it is restarted) a file called webtags.txt that contains an unsorted list of all the webtags that Cumulus supports |
| ErrorLogSpikeRemoval=0 | ??keeps the number of messages in the error log window to a maximum of 256? |
| 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)
|
| NoSensorCheck=1 | This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen.
The option (for 'incomplete' stations) to disable the sensor check described in this FAQ
|
Davis family specific:
| Parameter Line Entry | Function |
|---|---|
| [Station] | Section name - the following parameters relate to the station configuration. |
| 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)
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). Value X is an integer from 0 to 5 with the following meanings:
|
| 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
|
| SyncDavisClock=0 | When set, at start-up, Cumulus will set the Davis VP/VP2 clock to the same time as the PC
|
| VP2ConnectionType=0 | Weather station connection type as selected in the Station Configuration Screen VP type block
|
| VP2TCPPort=22222 | Set this in the Station Configuration Screen VP2 TCP/IP Settings block. Comunications port used if VP type has TCP/IP selected. Default is 2222 |
| VP2IPAddr=0.0.0.0 | Set this in the Station Configuration Screen VP2 TCP/IP Settings block. Weather station IP address if VP type has TCP/IP selected. Default is 0.0.0.0 |
| VP2SleepInterval=x | where x is sleepinterval in milliseconds.
This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. See note in readme.txt about VP2SleepInterval - in current release it is around line 50. This parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. See FAQ#My_Davis_station_shows_a_higher_maximum_wind_speed_than_Cumulus This is the period which Cumulus waits between reads of the data from Davis stations. 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. |
| 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 | Set this in the Station Configuration Screen Settings block with the Discon period value. Causes Cumulus to disconnect for the specified number of seconds, once a minute, on the minute (or as close as possible) to allow the Weatherlink IP to connect to the Davis Weatherlink site. Set it to zero to disable, if you are not using the Weatherlink site. |
| DavisCalcAltPress=1 | 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. The station does not provide this value directly, nor the station pressure, so Cumulus 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.
|
| LogExtraSensors=0 | This is set in the settings frame 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 need to select this for Solar/UV sensors. |
Introduced for problems with Fine Offset family:
- These parameters apply to Fine Offset stations and their clones, but a few may be more widely applicable
- Some parameters are set on screens, other attributes do not appear in the file unless they are added using an external editor, but the values still have a recommended default value as explained below.
- As Cumulus does not check station type before applying any of these settings, ensure for Davis stations (these do not have spike problems) the spike removal filters are set to the defaults shown below.
- However, spike removal correction may be implemented for La Crosse stations using the EW filter settings below.
- Stations not recognised by Cumulus may be set to create an EasyWeather_Format file requiring the first two parameters below.
| Parameter Line Entry | Function |
|---|---|
| [Station] | Section name - the following parameters relate to the station configuration. |
| EWInterval=0 | This parameter is entered in the Station Configuration Screen Settings block.
|
| EWFile= | This is set in the settings frame on the Station settings screen off the configuration menu.
Note: If you want to run Cumulus without an attached weather station (because your station has a fault or because you have a second PC), it is possible to run Cumulus with station Type=4 but with the default of no file specified in this parameter. The full directory structure and its files including those in the data sub-directory are needed (kept from when your station was working or copied from the PC with the station). |
| LogExtraSensors=0 | This is set in the settings frame on the Station settings screen off the configuration menu.
|
| RestartIfUnplugged=0 | This is set in the settings frame on the Station settings screen off the configuration menu.
|
| EWdisablecheckinit=0 | Add this line to cumulus.ini [Station] section if application gets stuck when Cumulus starts up connected to a Fine Offset (clone) station (added Cumulus version 1.9.2, build 1011).
|
| EWduplicatecheck=0 | Add this line to cumulus.ini [Station] section if application gets stuck in the download stage.
Introduced in version 1.8.5 (b.630) to deal with certain bytes being given the same value in first and second line. For example one problem is that "55 AA" repeats at the start of the second line of data. Those bytes are only supposed to appear at the start of the first line (or so I am told).
|
| SyncFOReads=0 | This is set in the settings frame on the Station settings screen off the configuration menu.
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.
|
| FOReadAvoidPeriod=3 | Sets the interval (in seconds) during each 48 second 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 takes place, this will give an idea of whether it would be useful to adjust this setting.
|
| ReportLostSensorContact=0 | Add this line to cumulus.ini [Station] section
Option to turn off reporting of 'lost sensor contact' for Fine Offset stations. (added Cumulus 1.9.4 b.1070)
|
| EWpressureoffset=x.y | Add this line to cumulus.ini [Station] section
Got a pressure problem with a Fine Offset station when the pressure 'offset' that Cumulus reads is garbage, so Cumulus just uses zero? Tell Cumulus what offset to use, by using an external text editor to insert this parameter where x.y is the difference between your station (absolute) and sea-level (relative) pressures, in mb or hPa. |
| EWminpressureMB=900 | Add this line to cumulus.ini [Station] section
Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars) |
| EWmaxpressureMB=1200 | Add this line to cumulus.ini [Station] section
Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars) |
| EWmaxHourlyRain=999 | This is set in the spike removal frame on the Calibration settings screen off the configuration menu. An hourly rain rate 'spike removal' filter for weather stations that do not supply rain rate so cumulus has to calculate it; changes in calculated value between one calculation and the next greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus when it calculates the rain rate. Cumulus ignores this parameter for other makes of weather station that supply a rain rate to Cumulus. |
| EWmaxRainRate=999 | This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A rain rate 'spike removal' filter, changes in calculated value between one calculation and the next greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus when it calculates the rain rate. Cumulus ignores this parameter for other makes of weather station that supply a rain rate to Cumulus. |
| EWgustdiff=999.0 | This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A wind gust 'spike removal' filter, changes in calculated value between one calculation and the next greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus. |
| EWwinddiff=999.0 | This is set in the spike removal frame on the Calibration settings screen off the configuration menu.. A wind speed 'spike removal' filter, changes in calculated value between one calculation and the next greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus |
| EWpressurediff=999.0 | This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A pressure change 'spike removal' filter, changes in read value from any station greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus |
| EWTempdiff=999.0 | This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A temperature change 'spike removal' filter, changes in read value from any station greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus. Replace 999.0 with the maximum difference in degrees C you are prepared to accept between successive data readings |
| EWhumiditydiff=999.0 | This is set in the spike removal frame on the Calibration settings screen off the configuration menu. A humidity change 'spike removal' filter, changes in read valuefrom any station greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus |
Oregon Scientific specific:
| Parameter Line Entry | Function |
|---|---|
| [Station] | Section name - the following parameters relate to the station configuration. |
| Humidity98Fix=0 | Selected in the Station Configuration Screen Settings block.
|
| LogExtraSensors=0 | This is set in the settings frame on the Station settings screen off the configuration menu if extra channels are to be used.
(Note this attribute appears in Davis family and Fine Offset family tables above with different usage explanations). |
| WMR928TempChannel=N | This line needs to be added in the [Station] section of the Cumulus.ini file for WMR-928 stations (and other stations using the same protocol, eg WMR-968) to use an 'extra' channel (see previous parameter) as your main temperature sensor, set N to the required channel |
La Crosse specific:
| Parameter Line Entry | Function |
|---|---|
| [Station] | Section name - the following parameters relate to the station configuration. |
| WS2300Sync=1 | This line needs to be added in the [Station] section of the Cumulus.ini. This makes Cumulus check the time that the station is going to communicate with the sensors, and synchronises all of its reads to be 2.5 seconds after that. Experiments have shown that this does not help the bad data situation. |
| LCMaxWind=X | This line needs to be added in the [Station] section of the Cumulus.ini. It is setting for the La Crosse max wind speed, where X is the maximum (uncalibrated) wind speed in m/s that you want to allow. The value you supply should be in metres/second, regardless of what wind unit you are using in Cumulus.(V1.8.8 Build 874 on) |
| WS2300IgnoreStationClock=0 | This line needs to be added in the [Station] section of the Cumulus.ini. Option to ignore the La Crosse station clock on logger download.
|
| RestartIfDataStops=0 | This line needs to be added in the [Station] section of the Cumulus.ini. Option to restart Cumulus if data from La Crosse stations stops. This may fix whatever the problem is; it may not. But it should at least stop the same data being repeatedly logged.
|
| ReportDataStoppedErrors=0 | This line needs to be added in the [Station] section of the Cumulus.ini. Option to turn off reporting of 'data stopped' errors to the Cumulus error log (may be needed with La Crosse stations)
|
Hydreon specific:
| Parameter Line Entry | Function |
|---|---|
| [Station] | Section name - the following parameters relate to the station configuration. |
| RG11port=1 | Specifies the COM port to use for Hydreon RG-11 rain detection devices. 1 = COM1. Set on RG11 screen within configuration menu, see its Help for more information. |
| RG11TBRmode=1 | Specifies the Hydreon RG-11 rain device mode of operation.
|
| RG11tipsize=0.01 | Specifies the tipping bucket size for Hydreon RG-11 rain detection devices. The 'tip size' must be specified in the units that you have configured Cumulus to use for rain. Set on RG11 screen within configuration menu. |
| RG11port2=
RG11TBRmode2= RG11tipsize2= |
Settings to connect a second Hydreon RG-11 rain detection device. Set on RG11 screen within configuration menu.
Note that you must have one RG-11 set to "It's raining" mode and the other to "tipping bucket" mode. Cumulus does not validate this. |
Section: Offsets
Set these parameters using the Configuration menu and Calibration screen, nothing else can be added to this section.
| Parameter Line Entry | Function |
|---|---|
| [Offsets] | Section Name - the following 'attribute=value' parameters are the adjustment factors for your specific sensors |
| PressOffset=Offset_Value | Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus pressure = Measured Pressure + 'Offset_Value' |
| TempOffset=Offset_Value | Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus Outdoor Temperature = Measured Outdoor Temperature + 'Offset_Value' |
| HumOffset=Offset_Value | Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus Humidity = Measured Humidity + 'Offset_Value' |
| WindDirOffset=Offset_Value | Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus Wind Bearing = Measured Wind Bearing + 'Offset_Value' |
| InTempOffset=Offset_Value | Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus Indoor Temperature = Measured Indoor Temperature + 'Offset_Value' |
| WindSpeedMult=1 | Multiplier by which measured Average Wind Speed is to be corrected (default=1).
e.g. Officially in UK the wind speed is measured with sensors at 10m above ground level. If your sensor is not at 10m AGL then a correction multiplier should be applied using the following formula V10/Vh = 1/(0.233 + 0.656*log10(h+4.75)) where "h" is your sensor height in meters so if your anemometer is 5m off the ground, V10/Vh comes out at 1.134 |
| WindGustMult=1 | Multiplier by which measured Wind Gust Speed is to be corrected (default=1). |
| TempMult=1 | Multiplier by which measured Temperature is to be corrected (default=1). |
| HumMult=1 | Multiplier by which measured Humidity is to be corrected (default=1). |
| RainMult=1 | Multiplier by which measured Rainfall (and therefore rainfall rate too) is to be corrected (default=1). |
| UVOffset=Offset_Value | Default 'Offset_Value' is 0 in this parameter used for formula: Cumulus UV level = Measured UV level + 'Offset_Value' |
| UVMult=1 | Multiplier by which measured UV to be corrected (default=1). |
Section: Web Site
All parameters edited in the Internet Configuration screen Sites/Options tab Web Site block.
| Parameter Line Entry | Function |
|---|---|
| [Web Site] | Section Name - the following parameters relate to your website |
| ForumURL=http://sandaysoft.com/forum/ | A website forum URL |
| WebcamURL=http://www.sanday.org.uk/webcam/webcam.php | URL for your Webcam |
Section: FTP Site
See individual entries for how to edit these parameters.
| Parameter Line Entry | Function |
|---|---|
| [FTP site] | Section Name - the following parameters relate to your website FTP parameters |
| Host= | Selected in the Internet Configuration screen Sites/Options tab. This is either the name or the IP address of the ftp server to which you connect when you upload pages to your web site. You probably used it with an external FTP program when you followed the instructions in the Cumulus help, Readme.txt or Simple_Website_setup.
Leave blank if you are not using ftp, but simply creating the output files on your pc. |
| Port=21 | Selected in the Internet Configuration screen Sites/Options tab. Port used for FTP upload, default =21 |
| Username= | Select in the Internet Configuration screen Sites/Options tab your web site FTP login Username |
| Password= | Shows your web site FTP login password as entered in the Internet Configuration Screen (note: this is not encrypted) |
| Directory= | Selected in the Internet Configuration screen Sites/Options tab. Directory (including path) on your server to which FTP will upload the files. Starting point is the position specified by ftp server (see Host above) |
| AutoUpdate=0 | Set in the Internet Configuration Screen Web Settings block.
|
| UpdateInterval=15 | Set in the Internet Configuration screen Sites/Options tab Web Settings block in Interval box. The interval in minutes at which you wish auto updates (either FTP to your website or output to a directory on your pc) to occur. Default 15 minutes. |
| IncludeSTD=1 | Selected in the Internet Configuration Files Tab screen
|
| IncludeSTDImages=1 | Selected in the Internet Configuration Files Tab screen
|
| EnableRealtime=0 | Set in the Internet Configuration screen Sites/Options tab Web Settings block.
The realtime.txt file contains various weather parameters and is used by the CumulusRealtime.swf (shock wave flash) real time wind gauges (as on the supplied 'gauges' web page).
|
| RealtimeInterval=3000 | Set in the Internet Configuration screen Sites/Options tab Web Settings block. The time in seconds between uploads of the realtime.txt file. |
| RealtimeFTPEnabled=0 | Selected in the Internet Configuration screen Sites/Options tab Web Settings block
|
| RealtimeTxtFTP=0 | Selected in the Internet Configuration screen Sites/Options tab Web Settings block
When set to 1 Cumulus will upload the realtime.txt to your web site during realtime processing. The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect. |
| ActiveFTP=0 | Set in the Internet Configuration Screen Sites/Options tab Web Settings block
|
| FTPRename=0 | Selected in the Internet Configuration screen Sites/Options tab Web Settings block
|
| DeleteBeforeUpload=0 | Selected in Internet Configuration Screen Sites/Options tab Web Settings block
|
| ResizeGraphs=0 | Selected in the Internet Congfiguration Screen Web graphs block.
|
| GraphHeight=300 | Graph height, default is 300 (pixels) - see previous parameter |
| GraphWidth=750 | Graph width, default is 750 (pixels) - see ResizeGraphs parameter |
| ImageFolder= | Set in Internet Configuration Screen Files tab. Path and file name in LOCAL folder to which the generated image files are also copied at each web update interval, either the 'normal' interval, or the 'realtime' interval, depending on next parameter. Used if you want backups of generated images. See Cumulus Help. |
| ImageCopyRealtime=0 | Set in Internet Configuration Screen Files tab.
|
| ExtraLocal[0-9]= | Set in Internet Configuration Screen Files tab. Path and file name on local computer for alternate files #0 through #9. See cumulus Help for details of how to specify reading current monthly log here. |
| ExtraLocal[10-99]= | Path and file name on local computer for alternate file #10 through #99. These additional files can only be selected by adding parameter lines to the configuration file, they are not visible in the Internet Configuration screen Files tab. |
| ExtraRemote[0-9]= | Path and file name on web server for alternate files #0 through #9. Set in Internet Configuration Screen Files tab. See cumulus Help for details of how to specify creating current monthly log here. |
| ExtraRemote[10-99]= | Path and file name on web server for alternate file #10 through #99. These additional paths/files can only be selected by adding parameter lines to the configuration file, they are not visible in the Internet Configuration screen Files tab. |
| ExtraProcess[0-9]=0 | Set in Internet Configuration Screen Files tab.
|
| ExtraProcess[10-99]=0 | Set in this config file only.
|
| UTF8encode=1 | Selected in Internet Configuration Screen Sites/Options tab Web Settings block.
|
| ExtraUTF[0-9]=0 | Set in Internet Configuration Screen Files tab.
|
| ExtraUTF[10-99]=0 | Set in this config file only.
|
| ExtraBinary[0-9]=0 | Set in Internet Configuration Screen Files tab.
|
| ExtraBinary[10-99]=0 | Set in this config file only.
|
| ExtraRealtime[0-9]=0 | Set in Internet Configuration Screen Files tab. If you select this for any files, you will also need to select the Realtime option.
|
| ExtraRealtime[10-99]=0 | Set in this config file only. If you select this for any files, you will also need to select the Realtime option.
|
| ExtraFTP[0-9]=1 | Set in Internet Configuration Screen Files tab.
Not intended for standard Cumulus web pages (tick box at top of screen, missing files will be ignored), nor for NOAA reports (FTF for them set up in NOAA Setup within Configuration menu). |
| ExtraFTP[10-99]=1 | Set in this config file only.
|
| ExternalProgram= | The name (including path) of a command-line program to be run at the 'normal' web update interval, after all of the processing has been performed. |
| ExternalParams= | The corresponding 'paramaters' for 'ExternalProgram' used to specify any parameters to be passed to the command. |
| RealtimeProgram= | The name (including path) of a command-line program to be run at the 'realtime' web update interval, after all of the processing has been performed. |
| RealtimeParams= | The corresponding 'paramaters' for 'RealtimeProgram' used to specify any parameters to be passed to the command. |
| DailyProgram= | The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed. |
| DailyParams= | The corresponding 'paramaters' for 'DailyProgram' used to specify any parameters to be passed to the command. |
| MaxFTPconnectRetries=3 | Set in this config file only. Allow configurable max FTP connect retries (default is retry up to 3 times) |
Section: Display
Set these parameters using Configuration menu and either Display or Colours screens as seen on link and indicated below.
| Parameter Line Entry | Function |
|---|---|
| [Display] | Section heading - the following parameters affect how the main screen looks. |
| Heading=My Weather | Title Heading on the Main Screen. Set in the Display Configuration Screen General block |
| SavePosition=0 | Set in the Display Configuration Screen General block.
|
| StartMinimised=0 | Set in the Display Configuration Screen General block.
|
| MinimizeToTray=0 | Set in the Display Configuration Screen General block
|
| ForecastCentred=0 | Set in the Display Configuration Screen General block.
|
| ShowCurrentConditions=0 | Set in the Display Configuration Screen General block
|
| FontColour=4227327 | Set on the colour setting screen in the Configuration menu. Decimal code for the screen font color |
| BackColour=12632256 | Set on the colour setting screen in the Configuration menu. Decimal code for the application background color |
| HeadingColour=10485760 | Set on the colour setting screen in the Configuration menu. Decimal code for the screen heading color |
| ClockDigitColour=4227327 | Set on the colour setting screen in the Configuration menu. Decimal code for the figures on clock in top right corner of main screen |
| ClockColour=16777201 | Set on the colour setting screen in the Configuration menu. Decimal code for the main screen clock background color |
| TwelveHourClock=0 | Set by left click on clock on main screen
|
| DisplaySolarData=0 | Set by Display solar/extra data item in the Display Configuration Screen General block.
|
| WMR928Channel1Caption=Extra channel 1 | Set in the Display Configuration Screen WMR928 extra channel captions block. Note that the extra channel data for WMR928 stations is only displayed on the main screen if Display solar/extra data is Set in the Display Configuration Screen General block (see previous parameter). This parameter defines the caption to be used when Cumulus reads observations from the extra sensor. |
| WMR928Channel2Caption=Extra channel 2 | See previous parameter. |
| WMR928Channel3Caption=Extra channel 3 | See 'WMR928Channel1Caption=Extra channel 1' parameter |
| SnowUnitText=cm | Set in the Display Configuration Screen General block. Snow measurement unit. Default is cm. Can be any unit (or other text) you like, remember all snow depth observations must be entered as an integer (without any decimal part)! |
| DisplayCloudBase=0 | Set in the Display Configuration Screen General block.
|
| DisplayHumidex=0 | Set in the Display Configuration Screen General block
|
| LegendSymbolWidth=3 | Set in the Display Configuration Screen Graph block. The width of the plot lines in graph legends |
| ChartLineWidth=2 | Set in the Display Configuration Screen Graph block. The width of the plot lines in the graph body |
| WindGaugeRange=50 | Set in the Display Configuration Screen General block. Value represents the default full scale deflection of the top of the 3 wind plots in the wind speed units you have selected. Default value is 50 in that unit. |
| WindGaugeArcColour=16773091 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeAnimated=1 | Set in the Display Configuration Screen. Animate the Wind Gauge pointer movement
|
| WindGaugeAnimationFactor=2 | Set in the Display Configuration Screen. This sets the speed of the wind gauge animation. Lower values correspond to a faster animation speed. Be careful not to set the animation too slow, particularly with stations which update frequently (e.g. Davis) as the animation will never catch up, and will use significant CPU time. |
| WindGaugeTickColour=9841920 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeFontColour=9841920 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeInnerCircleColour=16765615 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeNeedleColour=128 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeInnerCentreColourFrom=16765615 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeInnerCentreColourTo=16765615 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeOuterCentreColourFrom=16765357 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeOuterCentreColourTo=16711680 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeOuterCircleColour=16765615 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeOuterRimColour=9470064 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeAverageSectorColour=32768 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugePeakSectorColour=33023 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeNeedleShineColourFrom=1049273 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| WindGaugeNeedleShineColourTo=328090 | Set on the colour setting screen in the Configuration menu. Decimal code for the upper of the 3 wind plots |
| CompassColour=12632256 | Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots |
| CompassTickColour=16711680 | Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots |
| CompassLabelColour=16777215 | Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots |
| CompassBearingColour=0 | Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots |
| CompassCurrentPointerColour=255 | Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots |
| CompassAveragePointerColour=16711680 | Set on the colour setting screen in the Configuration menu. Decimal code for the middle of the 3 wind plots |
| WindRoseColour=8388608 | Set on the colour setting screen in the Configuration menu. Decimal code for the wind rose shading that represents duration and intensity of wind in different directions |
| WindRoseLabelColour=0 | Set on the colour setting screen in the Configuration menu. Decimal code for the wind rose compass points |
| WindRoseAxesColour=8388608 | Set on the colour setting screen in the Configuration menu. Decimal code for the circle and radii of lower of the 3 wind plots |
| WindRoseTransparency=50 | Set on the colour setting screen in the Configuration menu. |
| NumWindRosePoints=16 | Set in the Display Configuration Screen Graphs block
The number of points to plot on the Wind Rose diagram (choose 8 for Fine Offset stations) |
| TransparentGauges=0 | Set on the colour setting screen in the Configuration menu. The square backgrounds of the three wind gauges on the Cumulus main screen
|
| LogFTPErrors=1 | Set in the Display Configuration Screen General block
|
| DigitBackground=0 | Set on the colour setting screen in the Configuration menu. Decimal code for the colour to be used for background to displayed observations on main screen |
| LabelColour=0 | Set on the colour setting screen in the Configuration menu. Decimal code for the Parameter labels on main screen - default black. Note alarm conditions can change label colour (see next 2 parameters). |
| AlarmColour=255 | Set on the colour setting screen in the Configuration menu. Decimal code for the Parameter labels on main screen - default red - when an alarm is set for that parameter |
| PastAlarmColour=16711680 | Set on the colour setting screen in the Configuration menu. Decimal code for the Parameter labels on main screen - default blue - when an alarm is cleared for that parameter |
| PanelHeadingFontColour=0 | Set on the colour setting screen in the Configuration menu. Decimal code for the heading at the top of each panel with observations |
| PanelLineColour=0 | Set on the colour setting screen in the Configuration menu. Decimal code for the heading at the top of each panel with observations |
| PanelBorderColour=8421504 | Set on the colour setting screen in the Configuration menu. Decimal code for the edging of each panel with observations |
| PanelGradientColourFrom=16777215 | Set on the colour setting screen in the Configuration menu. Decimal code for the panel background |
| PanelGradientColourTo=13226453 | Set on the colour setting screen in the Configuration menu. Decimal code for the panel background |
| DisplayBeaufortDesc=1 | Set in the Display Configuration Screen General block
|
| DisplayBarometerTrendText=1 | Set in the Display Configuration Screen General block
|
| UpdateAtStartup=1 | Set in the Display Configuration Screen General block
|
| IndependentGraphsWindow=0 | Set in the Display Configuration Screen Graphs block
|
Section: Graphs
Set many of these parameters using Configuration menu and either Display (Graphs block) or Colours screens. 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.
| Parameter Line Entry | Function |
|---|---|
| [Graphs] | Section Name - the following parameters relate to your graph settings |
| GraphHours=12 | The number of hours data to be displayed in temperature (outdoor, heat index, wind chill, dewpoint and apparent temperature), humidity, rainfall rate, rainfall, pressure, solar radiation, UV index, wind speed and wind direction graphs.
You can enter any multiple of 12 from the Display Settings Screen, and you can also edit cumulus.ini and set this item to any other value. But note that setting it to a non-standard value is unsupported (i.e. if it causes problems, I probably won't fix them) and if you change any display settings, the value will get reset to a supported value (so you'll need to edit cumulus.ini again). |
| ChartMaxDays=7 | How many days of values to plot on the daily min/average/max temperature, daily sunshine, and daily rain charts (default=7) |
| Background=12632256 | Decimal value for the Graph and Chart background colour. |
| WindColour=65535 | Decimal value for the 10 minute average wind speed plot colour |
| GustColour=8421376 | Decimal value for the Wind Gust plot colour |
| RainColour=9527753 | Decimal value for the Rain plot colour |
| RainTodayColour=9527753 | Decimal value for the Rain Today plot colour |
| TempColour=9527753 | Decimal value for the Outside Temperature plot colour |
| HeatIndexColour=16711680 | Decimal value for the Heat Index plot colour |
| AppTempColour=8388736 | Decimal value for the Apparent Temperature plot colour |
| PressColour=9527753 | Decimal value for the Pressure plot colour |
| WindDirColour=255 | Decimal value for the Wind Direction plot colour |
| DewPointColour=255 | Decimal value for the Dew Point plot colour |
| WindChillColour=32768 | Decimal value for the Wind Chill plot colour |
| MinTempColour=16711680 | Decimal value for the Minimum Temperature chart plot colour |
| MaxTempColour=255 | Decimal value for the Maximum Temperature chart plot colour |
| AvgTempColour=32768 | Decimal value for the Average Temperature chart plot colour |
| DailyRainColour=32768 | Decimal value for the Daily Rain chart plot colour |
| InsideTempColour=0 | Decimal value for the Inside Temperature plot colour |
| InsideHumColour=255 | Decimal value for the Inside Humidity plot colour |
| OutsideHumColour=16711680 | Decimal value for the Outside Humidity plot colour |
| Graph3D=0 | 3D or normal graph selection as selected in the Display Configuration Graphs block
|
| PlotLatestGust=0 | Plot Latest Gust selection as selected in the Display Configuration Graphs block
|
| OriginIsSouth=0 | Wind Direction Graph Y Axis origin
|
| ShowFreezingLine=0 | Draw a horizontal line on the temperature graph at 0°C/32°F |
| TempVisible=1 | Select whether to plot the outside air temperature on the temperature graph
|
| HIVisible=0 | Select whether to plot the heat index on the temperature graph
|
| DPVisible=1 | Select whether to plot the dewpoint values on the temperature graph
|
| WCVisible=1 | Select whether to plot the wind chill values on the temperature graph
|
| AppTempVisible=1 | Select whether to plot the apparent temperature values on the temperature graph
|
| InHumVisible=1 | Select whether to plot the indoor humidity values on the humidity graph
|
| OutHumVisible=1 | Select whether to plot the outdoor humidity values on the humidity graph
|
| GraphGradientEnabled=0 | Use gradient shading on the graph background
|
| GradientStart=12632256 | |
| GradientMiddle=16777215 | |
| GradientEnd=8421504 | |
| SAGintempcolour=32768 | (Select-A-Graph) |
| SAGouttempcolour=255 | |
| SAGpressurecolour=16711680 | |
| SAGraintotalcolour=8388608 | |
| SAGrainratecolour=16776960 | |
| SAGgustcolour=16711935 | |
| SAGpeakgustcolour=65280 | |
| SAGspeedcolour=8388736 | |
| SAGinhumcolour=32896 | |
| SAGouthumcolour=8388608 | |
| SAGheatindexcolour=128 | |
| SAGwindchillcolour=8421504 | |
| SAGwinddircolour=0 | |
| SAGdewpointcolour=8421376 | |
| SAGsolarradcolour=65535 | |
| SAGmaxsolarradcolour=16711935 | |
| SAGapptempcolour=0 | |
| SAGuvindexcolour=65280 | |
| SAGintempaxis=L | (Select-A-Graph) |
| SAGouttempaxis=L | |
| SAGpressureaxis=L | |
| SAGraintotalaxis=L | |
| SAGrainrateaxis=L | |
| SAGgustaxis=L | |
| SAGpeakgustaxis=L | |
| SAGspeedaxis=L | |
| SAGinhumaxis=L | |
| SAGouthumaxis=L | |
| SAGheatindexaxis=L | |
| SAGwindchillaxis=L | |
| SAGwinddiraxis=L | |
| SAGdewpointaxis=L | |
| SAGsolarradaxis=L | |
| SAGmaxsolarradaxis=L | |
| SAGapptempaxis=L | |
| SAGuvindexaxis=L | |
| SAG3D=0 | |
| SAGgradientback=0 | |
| SAGleftgrid=1 | |
| SAGrightgrid=1 |
Section: Alarms
Set these using the Edit menu, Alarms screen.
| Parameter Line Entry | Function |
|---|---|
| [Alarms] | Section Name - the following parameters relate to your alarm settings |
| alarmlowtemp=0 | Select in Edit Alarms Screen
|
| LowTempAlarmSet=0 | Setting for low temperature alarm point (degrees) |
| LowTempAlarmSound=0 | Alarm Action
|
| LowTempAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name of sound file for Low Temperature alarm |
| alarmhightemp=0 | Select in Edit Alarms Screen
|
| HighTempAlarmSet=0 | Degrees above which alarm will occur. |
| HighTempAlarmSound=0 | Alarm Action
|
| HighTempAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name of sound file for High Temperature alarm |
| alarmlowpress=0 | Select in Edit Alarms Screen |
| LowPressAlarmSet=0 | Pressure below which you wish Low Pressure alarm to occur |
| LowPressAlarmSound=0 | Alarm Action
|
| LowPressAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name for sound file to play for Low Pressure Alarm |
| alarmhighpress=0 | Select in Edit Alarms Screen
|
| HighPressAlarmSet=0 | Pressure above which you wish High Pressure alarm to occur |
| HighPressAlarmSound=0 | Alarm Action
|
| HighPressAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name for the sound file used for the High Pressure Alarm |
| alarmhighraintoday=0 | Select in Edit Alarms Screen
|
| HighRainTodayAlarmSet=0 | Rain level above which alarm to occur |
| HighRainTodayAlarmSound=0 | Alarm Action
|
| HighRainTodayAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name for the sound file used for the High Rain Today Alarm |
| alarmhighrainrate=0 | Select in Edit Alarms Screen
|
| HighRainRateAlarmSet=0 | Rain rate above which you wish alarm to occur |
| HighRainRateAlarmSound=0 | Alarm Action
|
| HighRainRateAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name for the sound file used for the High Rain Rate Alarm |
| alarmhighgust=0 | Select in Edit Alarms Screen
|
| HighGustAlarmSet=0 | Gust speed above which you wish alarm to occur |
| HighGustAlarmSound=0 | Alarm Action
|
| HighGustAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name for the sound file used for the High Gust Alarm |
| alarmhighwind=0 | Select in Edit Alarms Screen
|
| HighWindAlarmSet=0 | Average Wind speed above which alarm to occur |
| HighWindAlarmSound=0 | Alarm Action
|
| HighWindAlarmSoundFile=C:\Cumulus\alert.wav | Path and file name for the sound file used for the High Wind Alarm |
| SensorAlarmSet=0 | Select in Edit Alarms Screen
|
| SensorAlarmSound=0 | Alarm Action
|
| SensorAlarmSoundFile=C:\Program Files\Cumulus\alert.wav | Path and file name for the sound file used for the Sensor Contact lost Alarm |
| alarmtempchange=0 | Select in Edit Alarms Screen
|
| TempChangeAlarmSet=0 | Temperature change value to trigger the alarm |
| TempChangeAlarmSound=0 | Alarm Action
|
| TempChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav | Path and file name for the sound file used for the Temperature Change Alarm |
| alarmpresschange=0 | Select in Edit Alarms Screen
|
| PressChangeAlarmSet=0 | Pressure change value to trigger the alarm |
| PressChangeAlarmSound=0 | Alarm Action
|
| PressChangeAlarmSoundFile=C:\Program Files\Cumulus\alert.wav | Path and file name for the sound file used for the Pressure Change Alarm |
Sections dealing with interfaces to external sites
Section: WUnderground
Set in the Internet Configuration Screen sites/Options tab
| Parameter Line Entry | Function |
|---|---|
| [Wunderground] | Section Name - Parameters for your Weather Underground site |
| ID= | Your Weather Underground station identifier (note: not your user name). |
| Password= | Your Weather Underground password. (note: not encrypted) |
| Enabled=0 | Set if you wish to upload to your Weather Underground site
|
| RapidFire=0 | 'rapid fire' mode.
|
| Interval=15 | Time in minutes between uploads to Weather Underground. (default = 15) |
| SendUV=0 | Current UV value
|
| SendSR=0 | Solar Radiation
|
| SendAverage=0 | Causes average wind speed and directon to be sent rather than instantaneous/gust speed and direction.
|
| CatchUp=1 | If possible send missing historic data to the server on startup
|
Set by editing this section of cumulus.ini with Cumulus stopped (from build 1095)
| Parameter Line Entry | Function |
|---|---|
| [Wunderground] | Section Name - Parameters for your Weather Underground site |
| SendSoilTemp1=0 | Soil Temperature 1
|
| SendSoilTemp2=0 | Soil Temperature 2
|
| SendSoilTemp3=0 | Soil Temperature 3
|
| SendSoilTemp4=0 | Soil Temperature 4
|
| SendSoilMoisture1=0 | Soil Moisture 1
|
| SendSoilMoisture2=0 | Soil Moisture 2
|
| SendSoilMoisture3=0 | Soil Moisture 3
|
| SendSoilMoisture4=0 | Soil Moisture 4
|
| SendLeafWetness1=0 | Leaf Wetness 1
|
| SendLeafWetness2=0 | Leaf Wetness 2
|
Section: Twitter
Set in the Internet Configuration Screen sites/Options tab
| Parameter Line Entry | Function |
|---|---|
| [Twitter] | Section Name - the following parameters relate to your Twitter site parameters |
| User= | your Twitter login username |
| Password= | your Twitter login password (note: this is not encrypted) |
| Enabled=0 | Set in Internet Configuration Screen Twitter block
|
| Interval=60 | interval in minutes that Tweats will be sent. |
| OauthToken= | Twitter inserted authentication token parameter - you can delete this line with Cumulus stopped |
| OauthTokenSecret= | Twitter inserted authentication token parameter - you can delete this line with Cumulus stopped |
Section: PWSweather
Set in the Internet Configuration Screen sites/Options tab
| Parameter Line Entry | Function |
|---|---|
| [PWSweather] | Section Name - the following parameters relate to your PWS weather site parameters |
| ID= | Your PWS Weather station identifier (note: not your user name) |
| Password= | your PWS weather site login password (note: this is not encrypted) |
| Enabled=0 | Select in Internet Configuration Screen PWS Weather block
|
| Interval=15 | Interval in minutes that updates will be sent to your PWS weather site |
| SendUV=0 | Current Ultra Violet level
|
| SendSR=0 | Solar Radiation level
|
| CatchUp=1 | If possible send missing historic data to the server on startup
|
Section: APRS
Set in the Internet Configuration Screen sites/Options tab
| Parameter Line Entry | Function |
|---|---|
| [APRS] | Section Name - the following parameters relate to your APRS weather site parameters |
| ID= | Your APRS identifier |
| pass=-1 | your APRS password (Note: not encrypted) |
| server=cwop.aprs.net | The APRS server to use |
| port=14580 | The port number to use on the APRS server. |
| Enabled=0 | Select in Internet Configuration Screen APRS Settings block |
| Interval=9 | Time in minutes between uploads to the APRS server |
| APRSHumidityCutoff=1 | For Oregon Scientific, so it doesn't report humidity to APRS when the temperature is below -10°C |
| SendSR=0 | Solar Radiation level
|
Section: WOW
Set in the Internet Configuration Screen sites/Options tab
| Parameter Line Entry | Function |
|---|---|
| [WOW] | Section Name - the following parameters relate to your WOW weather site parameters |
| ID= | Your WOW station ID |
| Password= | your WOW password (Note: not encrypted) |
| Enabled=1 | Updates enabled/disabled |
| Interval=15 | Time in mimutes between uploads to the WOW server |
| SendUV=0 | Current Ultra Violet level
|
| SendSR=0 | Solar Radiation level
|
| CatchUp=1 | If possible send missing historic data to the WOW server on startup
|
Section: Weatherbug
Set in the Internet Configuration Screen sites/Options tab
| Parameter Line Entry | Function |
|---|---|
| [Weatherbug] | Section Name - the following parameters relate to your Weatherbug weather site parameters |
| ID= | Your Weatherbug station ID |
| Password= | your Weatherbug password (Note: not encrypted) |
| Enabled=1 | Updates enabled/disabled |
| Interval=15 | Time in mimutes between uploads to the Weatherbug server |
| SendUV=0 | Current Ultra Violet level
|
| SendSR=0 | Solar Radiation level
|
| CatchUp=1 | If possible send missing historic data to the server on startup
|
Section: xAP
Set in the Internet Configuration Screen sites/Options tab
| Parameter Line Entry | Function |
|---|---|
| [xAP] | Section Name - the following parameters are used if you have enabled xAP in the Station Configuration xAP Settings block |
| Enabled=0 | When set, Cumulus will periodically send out xAP weather reports. See http://www.xapautomation.org/ for more details
|
| UID=4375 | Sets the UID for xAP messages. You should only need to change this if you have more than one instance of Cumulus running on a network. |
| Port=3639 | IP port your computer uses to send data to xAP |
Section: NOAA
All these can be set in the NOAA Setup Screen in Configuration menu. You might select to close Cumulus, and edit the 'Norm' 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).
| Parameter Line Entry | Function |
|---|---|
| [NOAA] | Section Name - the following parameters are set from the NOAA Setup dialog in Cumulus |
| Name= | Your NOAA Station name |
| City= | NOAA location city |
| State= | NOAA location state/county/province or the equivalent in your nation |
| 12hourformat=0 | Use 12 or 24 hour time format in the reports
|
| HeatingThreshold= | The temperature which is to be used to calculate heating degree days |
| CoolingThreshold= | The temperature which is to be used to calculate cooling degree days |
| MaxTempComp1=27 | The value used in the reports for the counts of days with max temperatures above the specified temperature. |
| MaxTempComp2=27 | The value used in the reports for the counts of days with max temperatures below the specified temperature. |
| MinTempComp1=0 | The value used in the reports for the counts of days with min temperatures below the specified temperature. |
| MinTempComp2=-18 | The value used in the reports for the counts of days with min temperatures below the specified temperature. |
| RainComp1=0.2 | The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount. |
| RainComp2=2 | The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount. |
| RainComp3=20 | The value used in the reports for the counts of days with rain totals greater than (or equal to) the specified amount. |
| AutoSave=0 | If set, when Cumulus does the end of day reset, it will auto create NOAA-style reports for the month and year corresponding to the day which has just ended. |
| NOAAUseUTF8=0 | (Added in Cumulus 1.9.4 beta build 1078) Specifies the 'Character set' in which NOAA reports are generated whether automatically (by Cumulus just after rollover) or manually (by selecting Save in NOAA Monthly/Annual Reports screen within Edit menu).
|
| NOAATempNorm[Jan-Dec]= | Long term temperature averages for each month, used for 'departure from the norm' calculations. |
| NOAARainNorm[Jan-Dec]= | Long term rainfall averages for each month, used for 'departure from the norm' calculations. |
| AutoFTP=0 | If set, when Cumulus does the first FTP upload after the daily reset, it will also upload the latest auto-created monthly and yearly NOAA-style reports. Note that you must already have regular (non-realtime) FTP configured. |
| MonthFileFormat="NOAAMO"mmyy".txt" | Defines the format of the filename used for the monthly reports, using date formatting characters (see Webtags#Time.2FDate_.27format.27_Parameter). The default uses a 2 digit number for the month, but you may prefer the full month name or an abbreviation in your language. Note that any characters which are not date formatting characters should be in double quotes. |
| YearFileFormat="NOAAYR"yyyy".txt" | Defines the format of the filename used for the yearly reports, using date formatting characters (see Webtags#Time.2FDate_.27format.27_Parameter). Note that any characters which are not date formatting characters should be in double quotes. |
| FTPDirectory= | The FTP directory into which Cumulus will attempt to upload the latest NOAA-style reports. You must give the full path from the point of login, and do not supply a trailing 'slash'. Note that the directory must actually exist on the server. |
Section: Solar
Set mostly in solar block at foot of Station Settings screen of Configuration menu.
| Parameter Line Entry | Function |
|---|---|
| [Solar] | 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. |
Section: MainForm
This is an optional section if you have set 'Save main window position' on Display settings screen. This section appears in the main cumulus.ini (found in same directory as cumulus.exe) where it stores the position of the main Cumulus screen on your monitor. Cumulus updates this section of the main cumulus.ini on closing, after you move the screen around on your monitor. An equivalent section also appears in a shorter cumulus.ini stored in the reports sub-directory where it stores the position of your last saved NOAA screen.
| Parameter Line Entry | Function |
|---|---|
| [MainForm] | Section name - the following parameters relate to the Cumulus screen position. |
| Left=100 | The last saved Cumulus main screen position, in pixels from the left-hand edge of the screen. |
| Top=50 | The last saved Cumulus main screen position, in pixels from the top edge of the screen |
