Cumulus Wiki

Cumulus.ini (preserving history): Difference between revisions

Cumulus.ini (preserving history) (view source)

Revision as of 11:47, 14 June 2013

4,125 bytes added ,  11:47, 14 June 2013
m
Adding cross-references missed before
m (Adding cross-references missed before)
Line 1: Line 1:
The cumulus.ini [[:Category:Configuration Files| configuration file]] is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up.
The cumulus.ini [[:Category:Configuration Files| configuration file]] is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up.
It is located in the directory in which you installed Cumulus and is updated whenever you change any configuration parameters from the application configuration pages. Cumulus also re-writes the file when it shuts down, so if you want to edit the file yourself, make sure Cumulus is stopped. Note that some configuration settings can only be applied by editing this file; they do not appear anywhere in the configuration screens. Cumulus does not write these values back out to the file, so they do not appear with default values - in other words, you need to ''add'' them if you want to set them. 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.
It is located in the directory in which you installed Cumulus and is updated whenever you change any configuration parameters from the application configuration pages. Cumulus also re-writes the contents of the application configuration pages to the file when it shuts down, so if you want to edit the file yourself, make sure Cumulus is stopped.  
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.  
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.


== Section: Station ==
== Section: Station ==
Line 18: Line 20:
*2=WMR-928
*2=WMR-928
*3=WM-918
*3=WM-918
*4=EasyWeather (using .dat file)
*4=[[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather]] (using .dat file)
*5=Fine Offset/Watson/MyDel etc
*5=Fine Offset/Watson/MyDel etc
*6=WS2300
*6=WS2300
*7=Fine Offset with Solar Sensors
*7=Fine Offset with Solar Sensors
*8=WMR100
*8=[[WMR100-200_Protocol|WMR100]]
*9=WMR200
*9=[[WMR100-200_Protocol|WMR200]]
|-
|-
|Model="yourModel"  
|Model="yourModel"  
Line 98: Line 100:
|
|
SnowDepthHour=9
SnowDepthHour=9
|Snow lying/falling roll over time (time when yesterday's values in log.xml are forgotten)
|[[Weather_Diary|Snow lying/falling]] roll over time (time when yesterday's values in log.xml are forgotten)
*0 = midnight
*0 = midnight
*9 = 9am
*9 = 9am
Line 130: Line 132:
*4 = 20 mins
*4 = 20 mins
*5 = 30 mins
*5 = 30 mins
Note: This can be set to match your station logging interval, then if you restart Cumulus and ''if Cumulus is able to read logged data from your station'' the frequency of logged information in your [[Monthly_log_files]] will be unchanged between the periods Cumulus is running and the periods when it is stopped.  Some Cumulus users set their station logging interval at a longer time so that the station does not overwrite the memory locations over the longest period they might be away from it, but this Cumulus logging interval to be one of the two shorter times so they retain the maximum measurement detail in case of any need to correct rogue measurements.
|-
|-
|WindUnit=0  
|WindUnit=0  
|Wind measurement unit Cumulus records in as selected in the Station Configuration Units block
|[[Wind_measurement#Wind_Speed|Wind speed measurement unit]] Cumulus records in as selected in the Station Configuration Units block
*0 = m/s
*0 = m/s
*1 = mph
*1 = mph
Line 139: Line 142:
|-
|-
|PressureUnit=0  
|PressureUnit=0  
|Pressure measurement unit Cumulus records in as selected in the Station Configuration Units block
|[[Pressure_Measurement]] unit Cumulus records in (as selected in the Station Configuration Units block)
*0 = mb
*0 = mb
*1 = hPa
*1 = hPa
*2 = in
*2 = in
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  
|RainUnit=0  
|Rain measurement unit Cumulus records in as selected in the Station Configuration Units block
|[[Rain_measurement]] unit Cumulus records in (as selected in the Station Configuration Units block)
*0 = mm
*0 = mm
*1 = in
*1 = in
|-
|-
|TempUnit=0  
|TempUnit=0  
|Temperature measurement unit Cumulus records in as selected in the Station Configuration Units block
|[[Temperature_(and_humidity)_measurement#Temperature_Scales|Temperature measurement unit]] Cumulus records in (as selected in the Station Configuration Units block)
*0 = Centigrade
*0 = Celsius
*1 = Fahrenheit
*1 = Fahrenheit
|-
|-
|LocName=  
|LocName=  
|Location Name as entered on in the Station Configuration Screen
|Location Name (as entered on the Station Configuration Screen)
|-
|-
|LocDesc=  
|LocDesc=  
|Location Description as entered in the Station Configuration Screen
|Location Description (as entered on the Station Configuration Screen)
|-
|-
|StartDate=13/08/2009  
|StartDate=13/08/2009  
|The date at which your records commenced.  By default this will set to the date of initial installation of the application.
|By default this will be set to the date of initial installation of the Cumulus application. See [[Monthly_log_files#Importing_pre-Cumulus_data]]
|-
|-
|LastLoggerDownload=13/08/2008 12:48:52  
|LastLoggerDownload=13/08/2008 12:48:52  
|The date/time of the last down load from your weather station (note: no longer used)
|The date/time of the last down load from your weather station '''(note: no longer used)'''; see [[Webtags#Miscellaneous|
<#LastDataReadT>]] and [[Today.ini|Timestamp]]
|-
|-
|YTDrain=0  
|YTD[[FAQ#My_monthly_and.2For_annual_rainfall_totals_are_wrong|rain]]=0  
|Year to date correction if starting part way through year as entered in the Station Configuration Screen. Default is 0.
|Year to date correction if starting part way through year as entered in the Station Configuration Screen. Value is entered in your current [[Rain_measurement]] units. Default is 0.
|-
|-
|YTDrainyear=0  
|YTDrainyear=0  
|The year for which the YTDrain is to be applied. Default is 0
|The year for which the YTDrain is to be applied. Default is 0 meaning not applied to any year.
|-
|-
|EWInterval=0  
|EWInterval=0  
|Easyweather interval in minutes as entered in the Station Configuration Screen Settings block.
|Easyweather interval in minutes as entered in the Station Configuration Screen Settings block. Default is 0 meaning not applicable as not reading [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat]] file.
|-
|-
|EWFile=  
|EWFile=  
|Easyweather.dat file path/name as entered in the Station Configuration Screen Settings block.
|[[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat]] file path/name as entered in the Station Configuration Screen Settings block.
|-
|-
|UseDataLogger=1  
|UseDataLogger=1  
Line 233: Line 238:
|CloudBaseInFeet=1  
|CloudBaseInFeet=1  
|Cloud base measurement unit
|Cloud base measurement unit
*0 = meters
*0 = metres
*1 = feet (default)
*1 = feet (default)
|-
|-
Line 243: Line 248:
|-
|-
|RTdisconnectcount=60
|RTdisconnectcount=60
|Option periodically disconnect the realtime FTP connection, the theory being that it will not get stuck if the servier dies, and wil keep trying to reconnect.  
|Option toperiodically disconnect the realtime FTP connection, the theory being that it will not get stuck if the server dies, and will keep trying to reconnect.  
Enter this line in the [Station] section of the Cumulus.ini
Enter this line in the [Station] section of the Cumulus.ini
The '60' is an example; it represents the number of realtime ftp uploads between disconnections - so 60 would give an hour if 1 minute realtime interval selected.
The '60' is an example; it represents the number of realtime ftp uploads between disconnections - so 60 would give an hour if 1 minute realtime interval selected.
Line 276: Line 281:
|-
|-
|ListWebTags=1
|ListWebTags=1
|Add this entry to make Cumulus create a file called webtags.txt that contains an unsorted list of all the webtags that Cumulus supports
|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
|-
|-
|EWmaxHourlyRain=999
|EWmaxHourlyRain=999
|An hourly rain rate 'spike' filter, changes in value greater than the value specified here will be ignored by Cumulus
|An hourly rain rate 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|-
|EWmaxRainRate=999
|EWmaxRainRate=999
|A rain rate 'spike' filter, changes in value greater than the value specified here will be ignored by Cumulus
|A rain rate 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|-
|EWpressurediff=999
|EWpressurediff=999
|A pressure change 'spike' filter, changes in value greater than the value specified here will be ignored by Cumulus
|A pressure change 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|-
|EWhumiditydiff=999
|EWhumiditydiff=999
|A humidity change 'spike' filter, changes in value greater than the value specified here will be ignored by Cumulus
|A humidity change 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|-
|EWgustdiff=999
|EWgustdiff=999
|A wind gust 'spike' filter, changes in value greater than the value specified here will be ignored by Cumulus
|A wind gust 'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|-
|EWwinddiff=999
|EWwinddiff=999
|A wind speed  'spike' filter, changes in value greater than the value specified here will be ignored by Cumulus
|A wind speed  'spike' filter, ''changes in value'' greater than the value specified here (set in calibration screen of configuration menu) will be ignored by Cumulus
|-
|-
|RestartIfDataStops=0
|RestartIfDataStops=0
Line 315: Line 320:
|-
|-
|RainDayThreshold=-1
|RainDayThreshold=-1
|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 units.
|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
|NoFlashWetDryDayRecords=1
Line 418: Line 423:
|-
|-
|Host=  
|Host=  
|This is the name (or the IP address) of the ftp server which you connect to when you upload pages to your web site
|This is the name (or the IP address) of the ftp server which you connect to when you upload pages to your web site.  Leave blank if you are not using ftf, but simply creating the output files on your pc.
|-
|-
|Port=21  
|Port=21  
Line 430: Line 435:
|-
|-
|Directory=  
|Directory=  
|Directory (including path) on your server to which FTP will upload the files
|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  
|AutoUpdate=0  
|Set in the Internet Configuration Screen Web Settings block.
|Set in the Internet Configuration Screen Web Settings block.
*0 = Disabled
*0 = Disabled
*1 = Enabled, Cumulus will automatically upload your updated web pages to your web site at regular intervals (as specified by the 'Update Interval')  
*1 = Enabled, Cumulus will automatically upload your processed web pages to your web site at regular intervals (as specified by the 'Update Interval') using FTP to the directory as specified in 'Directory'.
|-
|-
|ActiveFTP=0
|UpdateInterval=15
|Set in the Internet Configuration Screen Web Settings block.
|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
*0 = Disabled
*1 = Enabled, (default) the standard web files provided with Cumulus will be processed and uploaded at each web update.
|-
|IncludeSTDImages=1
|Selected in the Internet Configuration Files Tab screen
*0 = Disabled
*0 = Disabled
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
*1 = Enabled,(default) the standard image files generated by Cumulus (graphs, etc) will be uploaded at each web update to a subfolder of the 'Directory' you specified called 'images'.  
|-
|-
|EnableRealtime=0  
|EnableRealtime=0  
|Set in the Internet Configuration Screen Web Settings block.
|Set in the Internet Configuration screen ''Sites/Options tab'' Web Settings block.
*0 = Disabled
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).  
*1 = Enabled, Cumulus will upload a file called [[realtime.txt]] to your web site, at the interval specified by Realtime Interval (see below). This file contains various weather parameters and is used by the CumulusRealtime.swf real time wind gauges (as on the supplied 'gauges' web page. If you don't have this option selected, but do have the 'auto update' option set (and a suitable interval configured), Cumulus will still create the realtime.txt file at the specified Interval (not the Realtime Interval) so that you can specify it as an extra file to upload during the 'normal' upload, or use it for any other purpose on your PC.
*0 = Disabled (default) If you have the 'auto update' option set (and a suitable interval configured), Cumulus will create the realtime.txt file at the specified normal update Interval (not the Realtime Interval) so that you can specify it as an extra file to upload during the 'normal' upload, or use it for any other purpose on your PC.
*1 = Enabled, Cumulus will create the realtime.txt file,  and upload it to your web site, at the interval specified by Realtime Interval (see below).  
|-
|-
|RealtimeInterval=3000  
|RealtimeInterval=3000  
|Set in the Internet Configuration Screen Web Settings block. The time in seconds between uploads of the realtime.txt file.
|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
|RealtimeFTPEnabled=0
|When set to 1 Cumulus will establish an FTP connection to your web site, so that the realtime.txt file, and any other files you specify, can be uploaded when realtime processing takes place. The 'EnableRealtime' setting must be set to 1 for this setting to have any effect.
|Selected in the Internet Configuration screen ''Sites/Options tab'' Web Settings block
*0 = Disabled (default)
*1 = Enabled, Cumulus will establish an FTP connection to your web site, so that the realtime.txt file, and any other files you specify, can be uploaded when realtime processing takes place. The 'EnableRealtime' setting must be set to 1 for this setting to have any effect.
|-
|-
|RealtimeTxtFTP=0
|RealtimeTxtFTP=0
|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.
|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.
|-
|-
|UpdateInterval=15
|ActiveFTP=0
|Set in the Internet Configuration Screen Web Settings block.  The interval in minutes at which you wish auto updates to occur.
|Set in the Internet Configuration Screen ''Sites/Options tab'' Web Settings block
|-
*0 = Disabled (default)
|IncludeSTD=1
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
|Selected in the Internet Configuration Files Tab screen
*0 = Disabled
*1 = Enabled, (default) the standard web files provided with Cumulus will be processed and uploaded at each web update.
|-
|IncludeSTDImages=1
|Selected in the Internet Configuration Files Tab screen
*0 = Disabled
*1 = Enabled,(default) the standard image files generated by Cumulus (graphs, etc) will be uploaded at each web update.  
|-
|-
|FTPRename=0  
|FTPRename=0  
|Selected in the Internet Configuration Files Tab screen
|Selected in the Internet Configuration screen ''Sites/Options tab'' Web Settings block
*0 = Disabled
*0 = Disabled default,
*1 = Enabled,
*1 = Enabled, the new update is loaded using temporary names, files are renamed on the sever afterwards
|-
|-
|DeleteBeforeUpload=0  
|DeleteBeforeUpload=0  
|Selected in Internet Configuration Screen Sites/Options tab Web Settings block
|Selected in Internet Configuration Screen ''Sites/Options tab'' Web Settings block
*0 = Disabled default
*0 = Disabled default
*1 = Enabled, files are deleted from sever before the new update is loaded
*1 = Enabled, files are deleted from sever before the new update is loaded
Line 491: Line 500:
|-
|-
|ImageFolder=  
|ImageFolder=  
|Path and file name of folder to which the image files are copied at each web update interval, either the 'normal' interval, or the 'realtime' interval, depending on whether or not the 'realtime?' box is ticked.
|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  
|ImageCopyRealtime=0  
|Selected in the Internet Configuration File tab screen
|Set in Internet Configuration Screen Files tab.
*0 = files copied in 'normal' interval each web update (default)
*0 = files copied in 'normal' interval each web update (default)
*1 = files copied in 'real time' interval.  
*1 = files copied in 'real time' interval.  
|-
|-
|ExtraLocal[0-9]=  
|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 current monthly log.
| 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]=  
|ExtraLocal[10-99]=  
Line 505: Line 514:
|-
|-
|ExtraRemote[0-9]=  
|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 current monthly log.
|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]=  
|ExtraRemote[10-99]=  
Line 632: Line 641:
|-
|-
|SnowUnitText=cm  
|SnowUnitText=cm  
|Snow measurement unit. Default is cm
|Snow measurement unit. Default is cm.  Can be any unit you like, but all values must be an integer (without any decimal part)!
|-
|-
|DisplayHumidex=0  
|DisplayHumidex=0  
|Set in the Display Configuration Screen General block
|Set in the Display Configuration Screen General block
*0 = Disabled (default) Heat Index displayed on main screen.
*0 = Disabled (default) [[Heat_index]] displayed on main screen. The heat index is calculated only if the actual temperature in the shade (not in direct sunlight) is above 27 °C (80 °F), so normal temperature shown here for cooler temperatures.
*1 = Enabled, calculated Humidex value to be displayed on the main screen instead of Heat Index. Note that Cumulus displays degrees C or F for Humidex, whereas strictly speaking it is unitless. This is for the convenience of those who use Fahrenheit but would still prefer to see Humidex displayed, where it might be confusing to show the unconverted value.
*1 = Enabled, calculated [[Humidex]] value to be displayed on the main screen instead of Heat Index. Note that Cumulus displays degrees C or F for Humidex, whereas strictly speaking it is unitless. This is for the convenience of those who use Fahrenheit but would still prefer to see Humidex displayed, where it might be confusing to show the unconverted value.
|-
|-
|LegendSymbolWidth=3
|LegendSymbolWidth=3
Line 646: Line 655:
|-
|-
|ShowCurrentConditions=0
|ShowCurrentConditions=0
|
|*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 its value changes
|-
|-
|NumWindRosePoints=16
|NumWindRosePoints=16
Line 661: Line 671:
|-
|-
|WindGaugeAnimated=1
|WindGaugeAnimated=1
|Anitmate the Wind Gauge pointer movement
|Animate the Wind Gauge pointer movement
*0 = Disabled,
*0 = Disabled,
*1 = Enabled (default)
*1 = Enabled (default)
Line 702: Line 712:
|-
|-
|LabelColour=0
|LabelColour=0
|
|Parameter labels on main screen - default black. Note alarm conditions can change label colour (see next 2 parameters).
|-
|AlarmColour=255
|Parameter labels on main screen - default red - when an alarm is set for that parameter
|-
|PastAlarmColour=16711680
|Parameter labels on main screen - default blue - when an alarm is cleared for that parameter
|-
|-
|PanelHeadingFontColour=0
|PanelHeadingFontColour=0
Line 714: Line 730:
|-
|-
|PanelGradientColourFrom=16777215
|PanelGradientColourFrom=16777215
|
|-
|AlarmColour=255
|
|-
|PastAlarmColour=16711680
|
|
|-
|-
Line 838: Line 848:
|}
|}


== Section: Twitter ==
== Section: [[Twitter.txt|Twitter]] ==
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 950: Line 960:
|-
|-
|style="background:lightgray;"|[WOW]  
|style="background:lightgray;"|[WOW]  
|style="background:lightgray;"|Section Name - the following parameters relate to your [http://wow.metoffice.gov.uk/|WOW] weather site parameters
|style="background:lightgray;"|Section Name - the following parameters relate to your [http://wow.metoffice.gov.uk/WOW| WOW] weather site parameters
|-
|-
|ID=
|ID=
Line 987: Line 997:
|-
|-
|style="background:lightgray;"|[Weatherbug]
|style="background:lightgray;"|[Weatherbug]
|style="background:lightgray;"|Section Name - the following parameters relate to your [http://wow.metoffice.gov.uk/|WOW] weather site parameters
|style="background:lightgray;"|Section Name - the following parameters relate to your [http://weather.weatherbug.com| Weatherbug] weather site parameters
|-
|-
|ID=
|ID=
Line 1,624: Line 1,634:


== Section: MainForm ==
== 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.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Sfws
5,838

edits

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