Cumulus Wiki

Cumulus.ini (preserving history): Difference between revisions

Page Discussion

Cumulus.ini (preserving history) (view source)

Revision as of 08:25, 26 March 2020

1,751 bytes added ,  26 March 2020
m
→‎Section: Station: Made clear what also applies to MX and what does not
m (→‎Section: MainForm: Resequence to emphasise Cumulus 1 only)
m (→‎Section: Station: Made clear what also applies to MX and what does not)
 
=== 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. Note difference between Cumulus 1 (here) and Cumulus MX [[Cumulus.ini_(Beta)|(here)]].
{| class="wikitable" border="1"
|-
*9=[[WMR100-200_Protocol|WMR200]]
*10=Instromet (with optional extra solar sensors or without)
 
Additional values available in MX - see [[Cumulus.ini_(Beta)#Section:_Station|(here)]].
|-
|Model="your Model description"
|The weather station model description -that you choosewant whatoutput text appears for this on (from version 1.9.x) 'Display' settings screen within Configuration menu -by the fieldweb is at the bottom left of thattag screen).<#stationtype>
{{Version badge 1}} - you choose what text appears for this on (from version 1.9.x) 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
[[File:Badge vMx.png]] - this does not appear in the station settings, stop MX, and add it directly into Cumulus.ini within this [Station] section.
|-
|Port=0
|{{Version badge 1}}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.
[[File:Badge vMx.png]] This parameter is ignored by MX, it uses a different parameter - see [[Cumulus.ini_(Beta)#Section:_Station|(here)]].
|-
|Latitude=0
|You are advised ''not'' to directly edit this parameter in the file, but to enter the settings via the screen provide in software where you type Latitude (unsigned) Degrees, Minutes, Seconds and select 'N' or 'S' 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
|Set{{Version badge 1}}Do this in the Station Configuration Screen SettingsLocation block. ▼
[[File:Badge vMx.png]] Exactly same entries, enter using station settings by expanding location section.
Value in this parameter is Latitude in Decimal Degrees based on what you have entered, Positive for North, Negative for South
|-
|Longitude=0
|You are advised ''not'' to directly edit this parameter in the file, but to type Longitude (unsigned) Degrees, Minutes, Seconds and select 'E' or 'W' 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
The place to do this is as described for Latitude depending on Cumulus flavour.
Value in this parameter is Longitude in Decimal Degrees based on what you have entered, Positive for East, Negative for West
|-
|LatTxt=
|You are advised ''not'' to directly edit this parameter in the file, butit to type Latitude Degrees, Minutes, Seconds in the Station Configuration Screen Location block.contains Latitude in text string format of hemisphere D, M and S. HTML ampersand codes are used for spaces and unit characters.
|-
|LonTxt=
|You are advised ''not'' to directly edit this parameter in the file, it contains Longitude in text string format of hemisphere degrees, minutes and seconds. HTML ampersand codes are used for spaces and DMS characters.
|-
|Altitude=0
|your station altitude (default is zero) as entered in thesame Stationplace Configurationas Screenother Location blockparameters. 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.
*0 = metres Above Sea Level
*1 = feet ASL
|-
|Wind10MinAverage=0
|Selected inon thesame Stationscreen Configurationas Screenother Settings blockparameters.
*0 = Disabled (default), Cumulus will display the value supplied by the station. This is a 10 minute average for Davis stations, but an average over a shorter period for Oregon Scientific and Fine Offset stations, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*1 = Enabled, Cumulus will calculate and display a N-minute average wind speed where N is defined by the previous parameter if present, otherwise defaults to 10, the international standard duration used to calculate average wind speeds.
|-
|UseSpeedForAvgCalc=0
|Selected inon thesame Stationscreen Configurationas Screenother Settings blockparameters.
*0 = Disabled (default), Cumulus will display the average wind speed value supplied by the station, see [[FAQ#Cumulus_is_showing_a_different_wind_speed_compared_to_my_console]].
*1 = Enabled, Cumulus will use the longer-term 'speed' values in the average speed calculation. The preceding 'Wind10MinAverage' option must be enabled for this parameter to have any effect.
|-
|RoundWindSpeed=0
|Selected inon thesame Stationscreen Configurationas Screenother Settings blockparameters.
*0 = Disabled (default), Cumulus will display the wind speed value to the precision used by the station.
*1 = Enabled, this setting causes wind speeds to be rounded to the nearest integer.
|-
|UseZeroBearing=0
|Selected on same screen as other parameters.
▲|Set this in the Station Configuration Screen Settings block.
*0 = Disabled, Cumulus displays the current bearing read from the station (i.e. the last direction the wind was blowing from before it became calm). Note that the average wind bearing will always display zero bearing if there has been no wind for the last N minutes (where N is defined by previous parameter if present but defaults to 10), as the average bearing takes wind speed into account.
*1 = Enabled, Cumulus display a bearing of zero (and '---' for the compass point) when the wind is calm (note when not calm, bearing is 360 for true North)
|-
|CalculatedDP=0
|Selected inon thesame Stationscreen Configurationas Screenother Settings blockparameters.
*0 = Disabled, Cumulus will display the dew point value supplied by the station.
*1 = Enabled, Cumulus will calculate the dew point instead. This avoids the restriction in the Oregon Scientific stations where the dew point can never be below freezing point.
|-
|CalculatedWC=0
|Selected inon thesame Stationscreen Configurationas Screenother Settings blockparameters.
*0 = Disabled
*1 = Enabled, Cumulus will calculate the wind chill instead of using the value supplied by the station. You should set this if you have specified any calibration values for wind and/or temperature, so that Cumulus can also apply those adjustments to the wind chill.
|-
|RolloverHour=0
|Log roll over time as selected on the Stationsame Configurationscreen Screenas other parameters
*0 = midnight
*9 = 9am/10am
|-
|Use10amInSummer=1
|Daylight saving correction for 9am roll over, Selected on same screen as other parameters.
*0 = Use 9am in summer (use 10am not checked on Station Configuration Screen)
*1 = Use 10am in summer selected on Station Configuration Screen
|-
|WarnMultiple=0
|Set as 'Stop 2nd instance' in the Station Configuration Screen Program Settings block. Controls behavoirbehaviour for Multiple Instances of Cumulus running on PC. Requires a Cumulus restart if value toggled, before new behavoirbehaviour will take effect.
*0 = Disabled, (default) Multiple instances allowed.
*1 = Enabled, prevents multiple instances of Cumulus from running.
Not available in earliest builds of any Cumulus flavour.
|-
|ConfirmClose=0
|{{Version badge 1}}Selected in the Station Configuration Screen Program Settings block. Toggles Confirmation 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)
Ignored by MX.
|-
|CloseOnSuspend=1
|{{Version badge 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.
*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)
Ignored by MX
|-
|DataLogInterval=2
|Selected in the Station Configuration Screen [[Cumulus_Screenshots#Station|Data log interval]] block on the right hand side and defines frequency offor loggedCumulus informationto log weather readings and derived figures in the [[Monthly_log_files]] and, when applicable, in [[Extra_Sensor_Files]].
*0 = 1 min
*1 = 5 mins
*4 = 20 mins
*5 = 30 mins
Notes:
*Some weather station types do not have an in-built logger, so Cumulus cannot read any archive data from them, and they don't have a station console logging interval, to determine what this Cumulus logging interval should be.
*For a Davis station MUST set Cumulus logging interval to match your station console logging interval. (Otherwise you may activate the 'feature' in the Davis stations where they send the entire contents of the data logger when Cumulus asks for the data since it was last running). See Readme.txt. For other station types, normally set so matches station console logging interval, but this is not mandatory.
*For some station Types, Cumulus only reads latest readings while it is running, and missing station readings are not captured if Cumulus is restarted.
*For other makes as ''Cumulus on restarting is able (see next parameter) to read logged data from your station'' you can choose to match Cumulus and station logging intervals, then the frequency of logged information will be same regardless of whether Cumulus is running continuously or restarted (this improves accuracy of any averages calculated).
*Some Cumulus users set 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, but have 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. In this case, the frequency of logged information will change between the periods Cumulus is running and the catch-up readings from station logger when it is restarted, and all averages calculated will be less accurate if Cumulus is not running all the time.
|-
|UseDataLogger=1
|{{Version badge 1}}Cumulus 1.x.y: Selected in the Station Configuration Screen Settings block.
[[File:Badge vMx.png]]Cumulus MX: This parameter (attribute=value) is added directly to the file in the [stationStation] section if you want to change the default, it does not appear on the settings screen.▼
 
▲Cumulus MX: This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on the settings screen.
*0 = Disabled, at start-up, Cumulus will not download data from the station's data logger (if it has one) but just start with next observations.
*1 = Enabled (Default), at start-up Cumulus will download data from the station's data logger (if it has one) to catch up from the point where Cumulus was last shut down. See last parameter for advice re station logging interval.
*2 = km/h
*3 = kts
These are the labels that Cumulus applies on its screens and web pages, most weather stations workcan only output in one unit (e.g. dm/s for Fine Offset). andIf sothat is not the unit selected here, Cumulus will ensure the values are converted to anythat ofselected from the 4 listed during processing.
|-
|PressureUnit=0
*1 = hPa
*2 = in
These are the labels that Cumulus applies on its screens and web pages, most weather stations workcan only output in one unit (e.g. hPa for Fine Offset). andIf sothat is not the unit selected here, Cumulus will ensure the values are converted to anythat selected offrom the 3 listed during processing
|-
|RainUnit=0
*0 = mm
*1 = in
These are the labels that Cumulus applies on its screens and web pages, most weather stations workcan only output in one unit (e.g. dm for Fine Offset). If that is not the unit selected here, Cumulus andwill soensure the values are converted to either of the 2 listed during processing
|-
|TempUnit=0
*0 = Celsius
*1 = Fahrenheit
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 12 bit 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). andIf sothat is not the unit selected here, Cumulus will ensure the values are converted to either of the 2 listed during processing
|-
|LocName=
|LocationA '''Name''' for the location (as entered on the Station settingssame screen withinas '''Configuration'''other menuparameters) - used for title of tab in browser and main heading on each standard web page
|-
|LocDesc=
|LocationA '''Description''' for the location (as entered on the Stationsame settingsscreen Screenas within '''Configuration'''other menuparameters) - inserted after 'Welcome to ' on 'Now' web page.
|-
|StartDate=13/08/2009
|This parameter is automatically inserted into cumulusCumulus.ini and given a value when Cumulus is first run. By default this will be set to the date of initial installation of the Cumulus application (whichever flavour). See [[FAQ#I_have_inserted_pre-Cumulus_data_making_.27Records_began_on.27_date_wrong]]
|-
|CreateWxnowTxt=0
|This parameter (attribute=value) is added directly to the file in the [station] section, it does not appear on a configuration screen. If the parameter is not included in the file, the default value is assumed.
*0= (default) turn off creation of WebTags.txt file (stored in main Cumulus folder)
*1= create WebTags.txt file when Cumulus is restarted (contains an unordered list of all the web tags your Cumulus canbuild will recognise and process)
|-
|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 earlierearly Cumulus 1 version)'''; seeLater Cumulus 1 builds and all 2 and MX builds use [[today.ini] to track date/time. This date/time (regardless of whether this parameter is present) is available on your website by using [[Webtags#Miscellaneous|
<#LastDataReadT>]] for similar functionality
|-
|RainSeasonStart=1
|Selected in the Stationsame Configurationsettings Screenpage Settingsas blockother parameters. The month (1 to 12) of the year that is used as the start of the annual 'rain season'. Default = 1 meaning January.
|-
|YTD[[FAQ#My_monthly_and.2For_annual_rainfall_totals_are_wrong|rain]]=0
|Selected in the Stationsame Configurationsettings Screenpage Settingsas blockother parameters. 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 Stationsame Configurationsettings Screenpage Settingsas blockother parameters. The year for which the previous parameter (YTDrain) is to be applied. Default is 0 meaning not applied to any year. Note if you selected a month other than January in "RainSeasonStart" parameter, you will need to change this "YTDrainyear" when the calendar year changes during your first 'rain season' and change it to 0 when you reach the same "RainSeasonStart" month and start your second 'rain season'.
|-
|RainDayThreshold=-1
|-
|UseCumulusForecast=0
|FromSelected in the Stationsame Configurationsettings Screenpage Forecastas blockother parameters, if selected Cumulus will generate a simple weather Zambretti forecast, if your station does not supply a forecast, 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.
*0 = Disabled (default)
*1 = Enabled
|-
|HourlyForecast=0
|FromSelected in the Station Configuration Screensame Forecastsettings blockpage 'updateas hourly'other parameterparameters, applies only if Cumulus is set (see previous parameter) to generate a forecast (see [[FAQ#My_forecast_says_.22Not_available.22]]),
*0 = Disabled, (default) Cumulus will use Zambretti Forecaster every time it updates the web pages.
*1 = Enabled, this setting causes the forecast to be updated only once an hour (on the hour).
|-
|UseCumulusPresstrendstr=0
|SetSelected in the Stationsame Configurationsettings Screenpage Settingsas blockother parameters. 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).
*0 = Disabled
*1 = Enabled
|-
|FCpressinMB=1
|Forecast pressure unit as selected Selected in the '''Forecast''' block in the bottom right of ''Station''same settings screenpage offas '''Configuration'''other menuparameters. The units you use here are not related to the units you use for pressure (PressureUnit=x parameter earlier) in Cumulus; the option is given here simply as a convenience for the next two parameters.
*0 = inches of mercury
*1 = mb
|-
|FClowpress=950
|Low Pressure extreme limit (in units specified by previous parameter). as enteredSelected in the '''Forecast'''same blocksettings inpage theas bottomother rightparameters ofin ''Station'' settings screen offthe '''ConfigurationForecast''' menuarea, using either millibars or inches of mercury. Default is 950mb
|-
|FChighpress=1050
|High Pressure extreme limit as entered in the same Forecast blockarea as last 2 parameters. Default is 1050mb
|-
|CloudBaseInFeet=1
|Cloud base measurement unit as selected in the displaysame screen withinas configurationother menuparameters
*0 = metres
*1 = feet (default)
|-
|Logging=1
|This parameter (attribute=value) isdetermines addedif directlywhen toyou thenext file,start Cumulus it doeswill notsend appearenhanced on a configuration screen. Addinformation to cumulus.inithe [Station[debug]] sectionfile. toSet haveit Cumulusto start1 with [[debug]]to loggingenable onthis.
Debugging can also be switched on while you are running Cumulus of any flavour. By default, enhanced debugging will stop when you exit Cumulus and the value will be reset to 0.
|-
|SpecialLog=1
|This optional parameter (attribute=value) is added directly to the file, it does not appear on a configuration screen. If the parameter is not included in the file, the default of no special log is assumed. Add this entry to start updating a file called 'speciallog.txt' in the data folder with the following fields:
 
date(dd/mm/yy),time(hh:mm),inside temp,inside humidity,inside dewpointdew point,outside temp,outside humidity,outside dewpointdew point
 
See [https://cumulus.hosiene.co.uk/viewtopic.php?f=5&t=15040 forum]
Sfws
5,838

edits

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