5,838
edits
m (→Section: Station: Minor clarification following forum discussion) |
(Clarifying how to edit the different parameters, adding NOAAUseUTF8=0 and proxies (Someone please check), explaining parameters that nobody had explained after Shamrockspider had set them as '???' in 2009!) |
||
The cumulus.ini [[:Category:Configuration Files| configuration file]] is located in the directory in which you installed Cumulus. It is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up. Parameters are in the form 'attribute=value' and grouped into sections. Cumulus re-writes the contents of the application configuration screens to the file when it shuts down.
==
Many configuration parameters are changed from the various application configuration pages, you should never edit these directly in the file while Cumulus is running, as Cumulus will replace these parameters with the contents of the relevant application Edit/View/Configuration screens to the file when it shuts down. You can edit them in the file with Cumulus stopped, it will read the new values when it restarts, 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).
Note that some configuration settings can only be applied by editing this file to insert them; 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.
'''Note''' also that 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.
== File Contents ==
All installations (using the current version of Cumulus) will contain all the following sections (although the order of sections is inmaterial and probably reflects when you started using Cumulus as new sections have been added at the end by various versions), some relate to the external websites that Cumulus can optionally supply with updates, if you do not use those services those parameters will be set to the defaults. Within a section, newer versions of cumulus may add additional parameters set by revised configuration screens, and permit additional parameters to be added manually.
If you are not using the current version, or you are using a beta build, then checking the release information may be advisable before you make changes. I also strongly advise taking a backup of Cumulus.ini at regular intervals, to ensure you have a version to return to if an edit (within cumulus or externally) causes a problem.
=== 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 does not exist in your file, then insert it using a file editor.
{| class="wikitable" border="1"
|-
*0 = Disabled (default)
*1 = Enabled, this line needs to be added in the [Station] section of the Cumulus.ini
Note that
|-
|ChillHourThreshold=45
|The temperature threshold is specified in the units that you use in Cumulus (see [[Heat/cold_degree_days_and_Chill_hours]])
|-
|ChillHourSeasonStart=10
|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
*0 = midnight
*9 = 9am/10am
|-
|Use10amInSummer=1
|Daylight saving correction for 9am roll over
*0 = Use
*1 = Use 10am in summer selected on Station Configuration Screen
|-
SnowDepthHour=9
|[[Weather_Diary|Snow lying/falling]] roll over time (time when yesterday's values in log.xml are forgotten)
Note this time is independent of your rollover time selections in the two preceding parameters.
*0 = midnight (default)
*9 = 9am, this line needs to be added in the [Station] section of the Cumulus.ini
|-
|ConfirmClose=0
|Confirm you wish to close Cumulus application after telling it to close
*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)
|-
|CloseOnSuspend=1
|If this is selected, on the Station Configuration Screen, Cumulus will close if you suspend/standby/hibernate your computer. You should not select 'Confirm shutdown' if you use this option.
*0 = Disabled, application will not close if you suspend/standby/hibernate your computer (it is highly recommended you close Cumulus manually before your computer is put into suspend/standby/hibernate state)
*1 = Enabled, application will close on suspend/standby/hibernate of your computer (recommended if your computer can go into any of these states when left alone)
|-
|RestartIfUnplugged=0
|Cumulus will restart if it detects that a Fine Offset station is unplugged.
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled as selected on the Station Configuration Screen
|-
|SyncDavisClock=0
|When set, at start-up, Cumulus will set the Davis VP/VP2 clock to the same time as the PC
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled
|-
|}
=== Section:
Set these parameters using the '''Configuration''' menu and ''Calibration'' screen, nothing else can be added to this section.
{| class="wikitable" border="1"
|-
!style="width:150px" | INI Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Offsets]
|style="background:lightgray;"|Section Name - the following parameters are the correction factors for your specific sensors
|-
|PressOffset=0
|Value by which Measured Pressure to be corrected (Add/Subtract)
|-
|TempOffset=0
|Value by which Measured Outdoor Temperature to be corrected (Add/Subtract)
|-
|HumOffset=0
|Value by which Measured Humidity to be corrected (Add/Subtract)
|-
|WindDirOffset=0
|Value by which Measured Wind Direction to be corrected (Add/Subtract)
|-
|InTempOffset=0
|Value by which Measured Indoor Temperature to be corrected (Add/Subtract)
|-
|WindSpeedMult=1
|Multiplier by which measured Average [[Wind_measurement|Wind Speed]] to be corrected. Officially 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.
e.g. if your anemometer is 5m off the ground, V10/Vh comes out at 1.134
|-
|WindGustMult=1
|Multiplier by which measured Wind Gust Speed to be corrected.
|-
|TempMult=1
|Multiplier by which measured Temperature to be corrected.
|-
|HumMult=1
|Multiplier by which measured Humidity to be corrected.
|-
|RainMult=1
|Multiplier by which measured Rainfall to be corrected.
|-
|UVOffset=0
|Value by which measured UV to be corrected (add/subtract).
|-
|UVMult=1
|Multiplier by which measured UV to be corrected
|}
=== Section: Web Site ===
All parameters edited in the Internet Configuration screen ''Sites/Options tab'' Web Site block.
{| class="wikitable" border="1"
|-
|}
=== Section: FTP Site ===
See individual entries for how to edit these parameters.
{| class="wikitable" border="1"
|-
|-
|Host=
|Selected in the Internet Configuration screen ''Sites/Options tab''. This is either the name
''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
|-
|ResizeGraphs=0
|Selected in the Internet
*0 = Disabled (default) Cumulus uploads the default 750 x 300 pixel graphs.
*1 = Cumulus resizes the large graph images when creating them for upload to your web site. Specify the required height and width in the corresponding boxes. Note that the images are simply scaled to the new size; there will be some loss of quality
|}
=== Section: Display ===
Set these parameters using Configuration menu and either ''Display'' or ''Colours'' screens.
{| class="wikitable" border="1"
|-
|-
|LegendSymbolWidth=3
|The width of the plot lines in graph
|-
|WindRoseColour=8388608
|-
|ShowCurrentConditions=0
|Set in the Display Configuration Screen General block
*0 = Disabled, (default)
*1 = Enabled, a box labelled 'Current:' appears at bottom of Cumulus main screen. See [[Webtags_as_boolean_operators_in_HTML#Current_Weather_Conditions]] for possible use of this information, and [[Currentconditions.txt]] for the effect when the contents of the box on main screen changes.
|-
|NumWindRosePoints=16
|Set in the Display Configuration Screen Graphs block
The number of points to plot on the Wind Rose diagram (suggest 8 for FO stations)
|-
|ChartLineWidth=2
|-
|DisplayBeaufortDesc=1
|Set in the Display Configuration Screen General block
If set to 1, the Beaufort description of the current average wind speed will appear in the header of the wind panel on the main screen. If set to 0, it will instead appear as a 'tool tip' for the wind panel.
|-
|DisplayBarometerTrendText=1
|}
=== Section:
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.
{| class="wikitable" border="1"
|-
|-
|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
|-
|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
|-
|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
|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
*0 = Disabled
*1 = Enabled
|-
|HIVisible=0
|Select whether to plot the heat index on the temperature graph
*0 = Disabled
*1 = Enabled
|-
|DPVisible=1
|
*0 = Disabled
*1 = Enabled
|-
|WCVisible=1
|
*0 = Disabled
*1 = Enabled
|-
|AppTempVisible=1
|
*0 = Disabled
*1 = Enabled
|-
|InHumVisible=1
|
*0 = Disabled
*1 = Enabled
|-
|OutHumVisible=1
|
*0 = Disabled
*1 = Enabled
|-
|GraphGradientEnabled=0
|-
|SAGintempcolour=32768
|(Select-A-Graph)
|-
|SAGouttempcolour=255
|-
|SAGintempaxis=L
|(Select-A-Graph)
|-
|SAGouttempaxis=L
|}
=== Section: Alarms ===
Set these using the '''Edit''' menu, ''Alarms'' screen.
{| class="wikitable" border="1"
|-
|}
=== Section:
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
|-
!style="width:600px" | Function
|-
|style="background:lightgray;"|[
|style="background:lightgray;"|Section Name -
|-
|ID=
|Your Weather Underground station identifier (note: not your user name).
|-
|
|Your Weather Underground password. (note: not encrypted)
|-
|
|Set if you wish to upload to your Weather Underground site
*0 = Disabled, (default) no Weather underground site
*1 = Enabled, data sent at the interval specified below
|-
|
|'rapid fire' mode.
*0 = Disabled (default)
*1 = Enabled, You should also tick 'Enabled'. Rapid fire updates occur every 5 seconds.
|-
|Interval=15
|Time in minutes between uploads to Weather Underground. (default = 15)
|-
|SendUV=0
|Current UV value
*0 = Disabled (default) no UV info sent
*1 = Enabled, UV value sent with the data
|-
|SendSR=0
|Solar Radiation
*0 = Disabled (default) no solar data sent
*1 = Enabled, Solar Radiation value sent with data
|-
|SendAverage=0
|Causes average wind speed and directon to be sent rather than instantaneous/gust speed and direction.
*0 = Disabled (default) instantaneous/gust speed data sent
*1 = Enabled, average wind speed sent with data
|-
|
|If possible send missing historic data to the server on startup
*0 = Disabled
*1 = Enabled (default)
|}
=== Section: [[Twitter.txt|Twitter]] ===
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
|-
!style="width:150px" | INI Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Twitter]
|style="background:lightgray;"|Section Name - the following parameters relate to your [[Twitter]] site parameters
|-
|
|your Twitter login username
|-
|Password=
|your Twitter login password ('''note:''' this is not encrypted)
|-
|Enabled=0
|Set in Internet Configuration Screen Twitter block
*0 = Disabled (default)
*1 = Enabled, tweats sent at the specified interval.
|-
|Interval=60
|interval in minutes that Tweats will be sent.
|-
|OauthToken=
|??
|-
|OauthTokenSecret=
|??
|}
==
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
|-
!style="width:150px" | INI Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[PWSweather]
|style="background:lightgray;"|Section Name - the following parameters relate to your [http://www.pwsweather.com/ 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
*0 = Disabled (default) no data sent to PWS
*1 = Enabled, data sent to PWS at the specified interval
|-
|Interval=15
|Interval in minutes that updates will be sent to your PWS weather site
|-
|SendUV=0
|Current Ultra Violet level
*0 = Disabled (default)
*1 = Enabled, UV level sent with normal data
|-
|SendSR=0
|Solar Radiation level
*0 = Disabled (default)
*1 = Enabled, Solar radiation reading sent with normal data
|-
|CatchUp=1
|If possible send missing historic data to the server on startup
*0 = Disabled
*1 = Enabled (default)
|}
=== Section: APRS ===
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
|-
!style="width:150px" | INI Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[APRS]
|style="background:lightgray;"|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
*0 = Disabled (default)
*1 = Enabled, Solar radiation reading sent with normal data
|}
=== Section: WOW ===
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
|-
!style="width:150px" | INI Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[WOW]
|style="background:lightgray;"|Section Name - the following parameters relate to your [http://wow.metoffice.gov.uk/WOW| 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
*0 = Disabled (default)
*1 = Enabled, UV level sent with normal data
|-
|SendSR=0
|Solar Radiation level
*0 = Disabled (default)
*1 = Enabled, Solar radiation reading sent with normal data
|-
|CatchUp=1
|If possible send missing historic data to the WOW server on startup
*0 = Disabled
*1 = Enabled (default)
|}
=== Section: Weatherbug ===
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
|-
!style="width:150px" | INI Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Weatherbug]
|style="background:lightgray;"|Section Name - the following parameters relate to your [http://weather.weatherbug.com| 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
*0 = Disabled (default)
*1 = Enabled, UV level sent with normal data
|-
|SendSR=0
|Solar Radiation level
*0 = Disabled (default)
*1 = Enabled, Solar radiation reading sent with normal data
|-
|CatchUp=1
|If possible send missing historic data to the server on startup
*0 = Disabled
*1 = Enabled (default)
|}
=== Section: xAP ===
Set in the Internet Configuration Screen sites/Options tab
{| class="wikitable" border="1"
|-
|}
=== 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).
{| class="wikitable" border="1"
|-
|-
|State=
|NOAA location state/county/province or the equivalent in your nation
|-
|12hourformat=0
|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 version 1.9.4) 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).
*0 = Usual Cumulus format (default) ?? iso-8859-1 ??
*1 = UTF8 ((UCS Transformation Format—8-bit) format - the dominant character encoding for the World-Wide Web as using one to three bytes it represents most characters in common use covering most languages.
|-
|NOAATempNorm[Jan-Dec]=
|-
|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"
|}
=== Section: Solar ===
Set mostly in solar block at foot of Station Settings screen of Configuration menu.
{| class="wikitable" border="1"
|-
|-
|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.
|-
|SolarMinimum=0
|-
|LuxToWM2=0.0079
|
|-
|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 section also appears in a shorter cumulus.ini stored in the reports sub-directory where it stores the position of your last saved NOAA form. Cumulus updates this section of the main cumulus.ini on closing, after you move the screen around on your monitor, if you have set 'Save main window position' on Display settings screen.
{| class="wikitable" border="1"
|-
|}
=== Section: Proxies ===
HTTPProxyName=
HTTPProxyPort=
HTTPProxyUser=
HTTPProxyPassword=
|
edits