Cumulus.ini (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
 
(41 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}
[[Category:Configuration Files]]
This page has been renamed from "Cumulus.ini" to preserve the early history of that page.
 
The information that was on this old Cumulus.ini page has been moved into separate pages for Cumulus 1, MX early releases, and MX latest releases.


=History of this page=
=History of this page=


From release 3.10.1, the way that settings are changed, and the settings available have changed so much, that information previously on this page was misleading.
This page has proved the most complicated of all those in the Wiki to maintain:
 
# Settings change extremely often
Anybody using an earlier MX release (3.0.0 to 3.9.7) should now go to [[Cumulus.ini(MX_3.0.0_to_3.9.7)|this page]]
#* Therefore it is a lot of effort to keep the documentation up to date
 
#* It is obviously easiest if an update is made here as soon as the settings change, sometimes that happens (perhaps by developer doing an update here)
Anybody using the legacy software (e.g. 1.9.4) should now go to [[Cumulus.ini_(Cumulus_1)|this page]]
# The design of configuration menus/screens/pages to edit the settings periodically changes
 
#* This means information about how to change settings often depends upon which release someone is using
The past history for both those two new pages remains available via the history tab on this page.
#** In turn that means, either Cumulus users of latest release, or those using an earlier release, will struggle with the documentation
# Developers often provide limited information about settings,
#* Sometimes new settings are mentioned in an answer in a forum post, and do not get mentioned as a change in release announcements
#** This means that finding accurate information to update this page requires an awful lot of research that is very time consuming


=Content of this page=
The above observations applied for the legacy software, when Cumulus 2, and then 3 (MX), came along the documentation was originally split.  When MX started (in 2019 to early 2020) to try to replicate much of what Cumulus 1 offered, it made sense to reuse what was written on this page for Cumulus 1, instead of duplicating it on a second page.


This page has been emptied ready for new content to reflect how MX works from 3.10.1 onwards.
Then from mid 2020 to early 2021, there was rapid development of MX by the new developer, and MX began to increasingly diverge more and more from the legacy configuration, this page reflected that by introducing sub-sections (Cumulus 1 only, MX only, and both). 
From early 2021 onwards that 3 sub-section design for this page failed because new MX releases began to diverge from earlier MX releases. In other words, parameters that had existed at an early MX release, were no longer used by later releases. It was possible, but increasingly more and more difficult, to track new parameters to add that were added at particular releases, so the documentation got more and more obsolete.  


The biggest change in 3.10.1 was to revise where settings are changed, and how the web pages used to change settings can vary what they show based on an earlier selection on that page. A related change is that all settings are made via the [[MX Administrative Interface|Admin interface]]. (In earlier releases, "read-only" settings were made directly in the "Cumulus.ini" file, while "read-write" settings were made either in the file or via the interface).
To sum up, it was impossible for this page to show information for the legacy software, for early MX releases, and for later MX releases. The response was to move off this page anaything not relevant to the latest MX release, and to restructure this page based on how MX settings are altered, rather than where a parameter appears in the file.


Settings are now arranged according to the menu selections, as that is the way you change them.
Consequently, the revised tables have to explain which section settings are in the file.
=The Cumulus.ini file=
'''Cumulus.ini''' is a text file containing initialization parameters used by the Cumulus MX software application.
When Cumulus MX is run for very first time, the file does not exist, as it is not included in the release distribution.
When MX is restarted, it reads the ''Cumulus.ini'' that now exists. The settings it finds tell it what options you have selected and which sections of the MX code apply for your selections of weather station type (input) and for your selections of what processing it should do, and where you want it to send weather data to (output).
The file is a simple text file. It is divided into sections with section names in square brackets (e.g. [Station]).  These sections can appear in any order, by default new sections are appended after all previous sections.
Within each section, there are parameters. Each parameter is in format '''Attribute=Value''', and appears on a line to itself. The parameters, within a section, can be in any order, by default new parameters are appended at end of the relevant section.
If a new release of MX adds new parameters, then they will be automatically added to Cumulus.ini when you access that setting.
Some parameters have a default value, and you need to find the appropriate setting to change that value. However, others have an initial illegal value, and you are forced to give these parameter a valid setting before MX will allow you to save settings (and these "missing" values will stop MX doing any weather data processing).
=The settings pages in admin interface=
Please see [[MX_Administrative_Interface#Changing_Settings]] for basic information, including how to load the admin interface.
==Program settings==
===Accessibility===
{| class="wikitable" border="1"
|-
!style="width:30px" | Section
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|[Program]
|EnableAccessibility=0
|Enable accessibility features
|0 (disable)
|Determines styling of settings pages:
*Set to 1 to make this (and other pages) appear in a '''button selection''' style (more friendly on an accessibility basis).
*Leave it at zero for a  '''Click ▶to expand,  click ▼ to collapse''' styling.
|}


===Program Start-up Options===
==Steve Loft Era==


<big>The configuration file content relating to the legacy software (e.g. 1.9.4) has been moved to [[Cumulus.ini_(Cumulus_1)|legacy page]]</big>


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Section
!style="width:400px" | Legacy Software 1.x.y releases
!style="width:30px" | Parameter Line Entry
!style="width:200px" | Beta builds of legacy software
!style="width:100px" | Label on Settings page
!style="width:200px" | Cumulus 2 alpha releases
!style="width:20px" | Default
!style="width:300px" | MX beta 3.0.0
!style="width:600px" | Description
|-
|[Program]
|StartupPingHost=
|Host to PING on program start-up
|None (disable)
| Add a hostname or IP to address to ping at startup. Cumulus waits until the ping is successful before trying to read from your station. Leave blank to disable
|-
|[Program]
|StartupPingEscapeTime=999
|PING escape time (mins)
|999 (minutes)
|Specify a time after which if no ping response is received carry on starting Cumulus MX anyway
|-
|-
|[Program]
| This page was created for the legacy Cumulus 1 software (up to 1.9.4). If you look at the history tab of this page, user‎ '''Shamrockspider''' created this page at 12:55 on 27 August 2009 for the purpose of '''Documenting the cumulus.ini file content and its function.'''
|StartupDelaySecs=0
|Start-up Delay (secs)
|zero (disable)
|Add a delay before the Cumulus tries to start reading the station.
|-
|[Program]
|StartupDelayMaxUptime=300
|Max system uptime to apply the start-up delay
|300 (seconds)
|The time that has passed sice MX was started (up-time) is compared against the (max delay time) figure here.
*If max delay time less than up-time, the delay specified in previous parameter will NOT be applied
*If up-time less than this max delay time, then MX will apply any delay specified in previous parameter
*If this parameter is set to zero, then MX will always apply any delay specified in previous parameter
|}


===Program General Options===
Back in 2009, the file was fairly simple, and therefore documentating it was also fairly easy. 


==Station Settings==
Some settings were in [[Cumulus_Screenshots#Configuration_Menu_Screens|configuration screens]], and the file was arranged so that those settings were stored under a heading that generally (not in every case, for historic reasons) reflected the screen name. Documenting these was comparitively easy, the setting could be found easily and its allowed values could be easily tested.


===Accessibility===
A lot of extra settings were added to the file, but not added to the configuration screens. Documenting these was particularly difficult as only some got mentioned in release announcements, so the others were hard to discover, and allowed values were not always clear.
| Each time a beta version of Cumulus 1 was available, any parameters specific to that beta appeared in [[Cumulus.ini_(Beta)]], and only moved to the main page when that beta finished, and became the main release.
| The same beta page, [[Cumulus.ini_(Beta)]], was briefly used for Cumulus 2.
| Finally, that beta page, [[Cumulus.ini_(Beta)]], was used for all the changes in Cumulus 3 (the MX beta):
*Some of the parameters for Cumulus 1 were not used by MX beta
*Some of the parameters for Cumulus 1 were used by MX beta
*Beta MX only added 3 new parameters


This was the position when Steve Loft ceased his involvement with Cumulus. This page contained all parameters used for Cumulus 1, some of these were used by MX beta too.


{| class="wikitable" border="1"
The beta page contained some Cumulus 1 beta parameters that were still under development and the parameters that were only used by MX.
|-
!style="width:30px" | Section
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|[Program]
|EnableAccessibility=0
|Enable accessibility features
|0 (disable)
|Determines styling of settings pages:
*Set to 1 to make this (and other pages) appear in a '''button selection''' style (more friendly on an accessibility basis).
*Leave it at zero for a  '''Click &#9654;to expand,  click &#9660; to collapse''' styling.
|}
|}


===General Settings - Station type and Log interval===
== Mark Crossley era==


===General Settings - Log Rollover===
* Cumulus.ini content has changed drastically, and therefore the documentation page called "Cumulus.ini"  has also had to change drastically
 
* There was a period when it was possible for one page to document both the legacy Cumulus 1.9.4 and all MX releases, but that has long gone.
===General Settings - Units ===
 
===General Settings - Location===
 
===General Settings - Advanced Options===
 
===Station specific alternatives===
 
====Fine Offset Settings====
 
====Davis VP/VP2/Vue====
 
{{Template:WorkInProgressBanner}}


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:300px" | MX beta releases 3.0.0 to MX release 3.4.6
!style="width:100px" | Label on Settings page
!style="width:250px" | MX releases 3.6.0 to 3.7.0
!style="width:20px" | Default
!style="width:400px" | MX releases 3.8.0 to 3.9.7
!style="width:300px" | Description
!style="width:200px" | MX releases 3.10.0 to 3.11.4
|-
!style="width:250px" | MX release 3.12.0 onwards
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|VP2SleepInterval=500
|
|500 (milli-seconds)
|the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds.
* if you suspect that data is being missed, reduce number
*For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
|-
|VPClosedownTime=x
|
|(default not yet documented)
| x is the number of seconds after the start of the re-connect attempts that you want the program to close itself
|-
|-
|DavisCalcAltPress=1
|
|
|1
* Until MX release 3.4.6, people using MX needed to refer to the page now called [[Cumulus.ini_(Cumulus_1)]], which was called "Cumulus.ini" at the time, and the  beta page, [[Cumulus.ini_(Beta)]], as MX still used most of the parameters that the legacy software used and just a few new parameters. The latter still contained information from the last Cumulus 1 beta relating to Proxies section of Cumulus.ini, as that had not been finalised.
|Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude
* When Mark Crossley brought MX out of beta, he started adding new features to MX:
 
** Some features represented  functionality in the legacy software that MX had lacked, these used parameters that had been used for the legacy software
CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.  
** For other new features, like interfaces with new weather station types and new sensors, he created new parameters, and the beta page began to rival the legacy page in the number of parameters it covered
*0 = Use SLP supplied by Davis
* The information about MX on the beta page stayed there until April 2020
*1 = Convert the SP Davis supplies to AP using the altitude you have supplied.
|-
|SyncDavisClock=0
|
|
|0  
* Release 3.6.0 was when the functionality of MX first started to exceed the functionality of the legacy software
|When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
* Between April and June 2020, information on the beta page was slowly moved across to the main page, it took some time as it needed to be verified because as MX developed configuration file content was changing
*0 = Disabled, default (as deselected on the Station Configuration Screen)
* Suddenly, a lot of people were migrating from the legacy software to MX
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
* To help people migrating, from June 2020, all settings (for both the legacy software and MX) were covered on a single "Cumulus.ini" page
|-
* As people migrated, they could see on that single page clearly which parameters in their '''Cumulus.ini''' file were still valid, and what new parameters were needed when they migrated
|ClockSettingHour=4
* For those using MX, the page was recording the new  parameters that were being added to the file as MX developed
* Now the history of all the changes at that time can be viewed on this page, as this was originally the page that once held that combined information.
|
|
|4
* From release 3.8.0, the pace of change in MX was so fast, and the contributors to the Wiki so few, the page then called "Cumulus.ini" (with its previous content) stopped being maintained.
|Controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*# The main problem was somebody needed to do a lot of research, and devote a lot of time, to track what the developer was changing.
*4 = 04:00 (default value)
*# There was a second problem, it was clear that it was too complicated to use the same page to describe configuration for the legacy software, older MX releases, and the latest MX  release
*0-23 = 00:00 to 23:00
* Consequently, the "Cumulus.ini" page had to change, and the first move meant accepting MX and the legacy software could not be documented any more on the same page
|-
** A new page was created [[Cumulus.ini_(Cumulus_1)]], and all the information specific to the legacy software was split off from this page
|VP2ConnectionType=1
* This still left the problem that this page, at that time called "Cumulus.ini", had information that related to a release that had been superseded
** Another new page was created,  [[Cumulus.ini (MX_3.0.0_to_3.7.0)]], and all the MX information was moved there.
* Finally, this old "Cumulus.ini" paqe, with the attached history, but without any parameter information in the main page, was renamed to its current name, so it has preserved the history of the old page that had been split into two new pages, neither of which had the past history
|
|
* At release 3.10.0, the settings pages in the admin interface were given a significant makeover, and huge numbers of new settings were created, while many others became redundant
* It was clear the old [[Cumulus.ini (MX_3.0.0_to_3.7.0)|MX "Cumulus.ini"]] page was badly designed for the way 3.10.0 operated
* That old page was already out of date as it had not been updated for 3.8.0 changes
* It became obvious it was easier to start a new page that would would be based around 3.10.0 MX release, but would incorporate changes from 3.8.0 onwards, and would ignore anything that was now redundant
* The other change was a redesign of the page, so it focussed on explaining how to change the settings using the admin interface, rather than just documenting what each parameter in the file was used for
|  
|  
|Weather station connection type
* As MX was developed, its settings pages were being redesigned, and so where you changed particular parameters in the file was modified making the documentation that already existed obsolete for people using latest release, but still valid for people who were using an older release.
*0 = serial (see next parameter to specify COM port)
* As release 3.12.0 was planned to add many, many more parameters to the Cumulus.ini file, and the Settings pages get another redesign, it was decided the documenting of the changes in 3.8.0, 3.9.2, and 3.10.0 would be delayed until it became clearer what might change in 3.12.0
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
* The new [[Cumulus.ini]] page to cover all these recent releases was created in June 2021, a year after the last big change to a page with that name.
*2 = TCP/IP (see later parameters to specify ports)
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
|-
|VP2TCPPort=22222
|
| 2222
|Communications port used if VP type has TCP/IP selected.
|-
|VP2IPAddr=0.0.0.0
|
| 0.0.0.0
|Weather station IP address if VP type has TCP/IP selected.
|-
|VP2PeriodicDisconnectInterval=0
|
|0 (disable)
|When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.
 
Set it to zero to disable, if you are not using the Weatherlink site.
|-
|LogExtraSensors=0
|
|0
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
|-
|UseDavisLoop2=1
|
|1 (use Loop2)
|The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
*1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default. The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
*0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.
 
Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.
|-
|DavisIPResponseTime=500
|
|500
|The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger, see Cumulus MX forum where times up to 2000ms are suggested.
|-
|ForceVPBarUpdate=0
|
|0 (normal)
| Added in build 3042 (January 2017).
 
The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|-
|DavisIncrementPressureDP=0
|
|1
|(from version 3.0.0 build 3042)
* 0= Pressure values shown to 1 decimal places when reported in mb/hPa, shown to 2 decimal places for inHg
* 1= Pressure values shown to 2 decimal places when reported in mb/hPa, shown to 3 decimal places for inHg
|-
|VPrainGaugeType=0
|
|1
|Specifies the units selected on your Vantage Pro Rain Gauge.
*0 = Metric Rain Adapter fitted, a 0.2mm gauge
*1 = Imperial gauge without adapter, a 0.01" gauge.
Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur.
|-
|DataLogging=0
|
|0
|(Build 3018 onwards).
*0 (default) = Cumulus MX will not add extra logging.
*1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large.
I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards).
|-
|AutoUpdateIpAddress=1
|
|1
|default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
|-
|ZeroConfig
|
|(default not known)
|set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|}
|}


====WM918/WMR928 Settings====
=Original content of this page=
 
Oregon Scientific specific
{{Template:WorkInProgressBanner}}
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|Humidity98Fix=0
|
|0 (disable)
|Applies to weather station types that never report more than 98% relative humidity.
*0 = Disabled (default)
*1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98%.  Normally only useful for Oregon Scientific stations.
|-
|LogExtraSensors=0
|
|0 (disable)
|This setting determines whether MX looks for readings from extra temperature probes etc.
*0=Disabled (default)
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors..
|-
|WMR928TempChannel=N
|
|(no default)
|for WMR-928 stations (and other serial 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
|-
|WMR200TempChannel=N
|
|(no default)
|for WMR200 stations (and any other Oregon Scientific USB stations which work with Cumulus, e.g. WMR100) to use an 'extra' channel as your main temperature sensor, set N to the required channel
|}
 
====EasyWeather File Settings====
 
====Instromet Settings====
 
 
{{Template:WorkInProgressBanner}}
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|style="background:lightgray;"|Section name - the following parameters relate to the station configuration.
|-
|ImetWaitTime=200
|This parameter (attribute=value) if you need to change it from its '''default of 200 ms''' is added directly to the file, it does not appear on a configuration screen.
Specifies the time in milliseconds that Cumulus allows for a response from an Instromet station. If you are having problems with reading from an Instromet station, try inserting this line into the ''Station'' section using a value of 500. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command.
|-
|ImetBaudRate=19200
|The default value is 19200. Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value
|-
|SyncDavisClock=0
|Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
When set, at Cumulus start-up and at 04:00 each day, Cumulus will set the Instromet clock to within a minute of the same time as the PC
*0 = Disabled, default as deselected on the Station Configuration Screen
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time!
|-
|LogExtraSensors=0
|If you have 'extra sensors' selected, the wet bulb reading will be used as an extra temperature sensor. Otherwise it is used as 'wet bulb' and the humidity will be calculated from that and the dry bulb sensor.
*0=Disabled (default). For a wet bulb sensor, Cumulus will output the humidity, not the temperature shown by the wet bulb.
*1= Enabled - Used for optional Sunshine hours or extra temperature sensors on Instromet stations. For a wet bulb sensor, Cumulus will output the temperature it shows, but not calculate the humidity.
|}
 
====Davis WeatherLink Live====
 
{{Template:WorkInProgressBanner}}
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
 
====Ecowittt GW1000 Settings====
 
{{Template:WorkInProgressBanner}}
 
Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|IPAddress=
|There is no default value, stores the IP address of your GW1000 WiFi logger, set via the station settings page.
|}
 
====Solar====
 
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
|-
|style="background:lightgray;"|[Solar]
|style="background:lightgray;"|Section Name - the following parameters are set as described above
|-
|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
|this parameter applies 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 correct folder i.e. the ''' program root folder''' in MX (i.e. same folder as where "Cumulus.ini" is stored).
|-
|SolarCalc=1
|The value is set in the MX user interface when the solar calculation method is set.
*0 (default) = Ryan-Stolzenbach calculation, which uses the RStransfactor entry to tune the output.
*1 = Bras calculation, which uses the BrasTurbidity entry below to tune the output.
|-
|BrasTurbidity=2.0
|The value is set in the MX user interface when the solar calculation method is set.
*2.0 (default) = Perfect clear sky
*decimal value = The normal range is 2 (Clear sky) to 5 (Smoggy)
|}
 
 
===Common Options===
 
===Forecast===
 
===Annual Rainfall===
 
===Growing Degree Days===
 
===Annual Temperature Sum===
 
===Graphs===
 
===Display Options===
 
==Internet Settings==
 
===Web/FTP Site===
 
===Web/FTP Settings===
 
===Email Server Settings===
 
===External Programs===
 
===MQTT===
 
MQTT (Message Queuing Telemetry Transport) is a machine-to-machine (M2M), also known as "Internet of Things", connectivity protocol.
 
This section was introduced by release 3.5.0 (build 3071)
 
{| class="wikitable" border="1"
|-
!style="width:150px" | Parameter Line Entry
!style="width:600px" | Function
!style="width:150px" | Where to Edit
|-
|style="background:lightgray;"|[MQTT]
|style="background:lightgray;"|Cumulus.ini Section Name
|style="background:lightgray;"|Settings Section Name
|-
|Server=
|Note there is no default. This text box is to enter your server name or the IPv4 or IPv6 address to find your server
|MQTT section
|-
|Username=
|This is optional.This text box is to enter the username if one is needed for updating your server
|MQTT section
|-
|Password=
|This is optional. This text box is to enter any password needed for that username
|MQTT section
|-
|Port=1883
|Note default. To edit which port is used to connect to your server
|MQTT section
|-
|UseTLS=0
|Transport Layer Security (TLS), and its now-deprecated predecessor, Secure Sockets Layer (SSL), are cryptographic protocols designed to provide communications security over a computer network. This tick box on settings screen indicates whether TLS support is required,
*default is not (0),
*set to 1 if modern security protocol is being used
|MQTT section tick box
|-
|IPversion=0
|Mandatory - This parameter must be added to this Cumulus.ini section, it cannot be edited on a screen.
*0=default,
*4=IPv4,
*6=IPv6
|In file only
|-
|EnableDataUpdate=0
|This provides an easy way to stop/start the updating without losing other settings. Default is unticked as most people do not use this functionality.
|tick box in '''Send message on data update''' section
|-
|UpdateTopic=CumulusMX/DataUpdate
|This feature in the '''Send message on data update''' section is where you specify the name to give to the update message
|'''Send message on data update''' section
|-
|UpdateTemplate=DataUpdateTemplate.txt
|In the CumulusMX/mqtt folder there is a default template with a file name specified by the default value of this parameter. In that default file <tt>{"time":"<#timehhmmss>","windspeed":<#wlatest rc=y>,"winddir":<#bearing>}</tt> will send wind readings in case for example you want to close something when it is windy. If you create your own file, you can put its name here.
|'''Send message on data update''' section
|-
|EnableInterval=0
|This tick box provides an easy way to stop/start this type of updating without losing other settings. Default is unticked as most people do not use this functionality.
|tick box in '''Send message at fixed intervals''' section
|-
|IntervalTime=600
|This text box is where you enter the time between messages in seconds, the default is 600 meaning every ten minutes.
|'''Send message at fixed intervals''' section
|-
|IntervalTopic=CumulusMX/Interval
|This text box is where you specify the name to give to the fixed interval update message
|'''Send message at fixed intervals''' section
|-
|IntervalTemplate=IntervalTemplate.txt
|In the CumulusMX/mqtt folder there is a default template with a file name specified by the default value of this parameter. In that default file <tt>{"time":"<#timehhmmss>","temp":<#temp rc=y>,"humidity":<#hum>}</tt> will send temperature and humidity readings in case for example you want to open something when it feels uncomfortable. If you create your own file, you can put its name here.
|'''Send message at fixed intervals''' section
|}
 
 
===Moon Image===
 
===Proxies===
 
Cumulus 1.9.4 beta build 1061 introduces these. Currently, search the forum using the term 'proxies' for more details. They will be described here when 1.9.4 becomes a full release, currently they are being tested.
 
HTTPProxyName=
 
HTTPProxyPort=
 
HTTPProxyUser=


HTTPProxyPassword=  
==How this page used to be laid out, and why==


For both [[Cumulus.ini_(Cumulus_1)|Cumulus 1]] and [[Cumulus.ini (MX_3.0.0_to_3.7.0)|early MX releases]], the content on this page was arranged assuming people were editing the file directly.


Therefore, the file was described by working through the sections on the file, and explaining the parameters that could go in each section.


For the longer sections, parameters might be split into separate tables to make it easier.


Before release 3.10.1, there were two types of parameters in Cumulus.ini.
#"read-only" settings were made directly in the "Cumulus.ini" file, there was no way to adjust these parameters using the settings screens/pages
#"read-write" settings could be changed in two ways, either by editing the file with Cumulus stopped, or by finding the parameter on a setting screen (for MX, these are in admin interface).


:You will see in the two pages split off from this page  ([[Cumulus.ini_(Cumulus_1)]] and [[Cumulus.ini (MX_3.0.0_to_3.7.0)]]), how the parameters had to identify themselves as read-only or read-write.


==Why has this original "Cumulus.ini" page been renamed, cleared of old content, and made historic?==


[[Category:Cumulus Files]]
#One big change in 3.10.1 is that (almost) all settings are now made via the [[MX Administrative Interface|Admin interface]]. 
#*Therefore it makes no sense any more to organise this page how someone editing the file directly might want. 
#*The replacement [[Cumulus.ini]] page is now organised by how you change settings in the admin interface (i.e. similar to how settings have been explained in [[MX_Administrative_Interface#Changing_Settings]]).
#Another change is that some of the settings that used to be made on the “Station Settings” page, are now made on different pages in that interface.
#Yet another change is that what you pick in some settings can affect what settings are shown later on the admin interface page. 
#*You could say the settings pages have become intelligent. 
#*For example, when you select a weather station type it ensures only parameters that relate to that weather station type are shown.
#*As another example, you can opt in or out of the default web site design, so that determines which parameters relating to web sites are shown.
#A final change is that some parameters are grouped as “Advanced”, so that novices can avoid those.

Latest revision as of 07:20, 15 June 2021

This page has been renamed from "Cumulus.ini" to preserve the early history of that page.

The information that was on this old Cumulus.ini page has been moved into separate pages for Cumulus 1, MX early releases, and MX latest releases.

History of this page

This page has proved the most complicated of all those in the Wiki to maintain:

  1. Settings change extremely often
    • Therefore it is a lot of effort to keep the documentation up to date
    • It is obviously easiest if an update is made here as soon as the settings change, sometimes that happens (perhaps by developer doing an update here)
  2. The design of configuration menus/screens/pages to edit the settings periodically changes
    • This means information about how to change settings often depends upon which release someone is using
      • In turn that means, either Cumulus users of latest release, or those using an earlier release, will struggle with the documentation
  3. Developers often provide limited information about settings,
    • Sometimes new settings are mentioned in an answer in a forum post, and do not get mentioned as a change in release announcements
      • This means that finding accurate information to update this page requires an awful lot of research that is very time consuming

The above observations applied for the legacy software, when Cumulus 2, and then 3 (MX), came along the documentation was originally split. When MX started (in 2019 to early 2020) to try to replicate much of what Cumulus 1 offered, it made sense to reuse what was written on this page for Cumulus 1, instead of duplicating it on a second page.

Then from mid 2020 to early 2021, there was rapid development of MX by the new developer, and MX began to increasingly diverge more and more from the legacy configuration, this page reflected that by introducing sub-sections (Cumulus 1 only, MX only, and both). From early 2021 onwards that 3 sub-section design for this page failed because new MX releases began to diverge from earlier MX releases. In other words, parameters that had existed at an early MX release, were no longer used by later releases. It was possible, but increasingly more and more difficult, to track new parameters to add that were added at particular releases, so the documentation got more and more obsolete.

To sum up, it was impossible for this page to show information for the legacy software, for early MX releases, and for later MX releases. The response was to move off this page anaything not relevant to the latest MX release, and to restructure this page based on how MX settings are altered, rather than where a parameter appears in the file.


Steve Loft Era

The configuration file content relating to the legacy software (e.g. 1.9.4) has been moved to legacy page

Legacy Software 1.x.y releases Beta builds of legacy software Cumulus 2 alpha releases MX beta 3.0.0
This page was created for the legacy Cumulus 1 software (up to 1.9.4). If you look at the history tab of this page, user‎ Shamrockspider created this page at 12:55 on 27 August 2009 for the purpose of Documenting the cumulus.ini file content and its function.

Back in 2009, the file was fairly simple, and therefore documentating it was also fairly easy.

Some settings were in configuration screens, and the file was arranged so that those settings were stored under a heading that generally (not in every case, for historic reasons) reflected the screen name. Documenting these was comparitively easy, the setting could be found easily and its allowed values could be easily tested.

A lot of extra settings were added to the file, but not added to the configuration screens. Documenting these was particularly difficult as only some got mentioned in release announcements, so the others were hard to discover, and allowed values were not always clear.

Each time a beta version of Cumulus 1 was available, any parameters specific to that beta appeared in Cumulus.ini_(Beta), and only moved to the main page when that beta finished, and became the main release. The same beta page, Cumulus.ini_(Beta), was briefly used for Cumulus 2. Finally, that beta page, Cumulus.ini_(Beta), was used for all the changes in Cumulus 3 (the MX beta):
  • Some of the parameters for Cumulus 1 were not used by MX beta
  • Some of the parameters for Cumulus 1 were used by MX beta
  • Beta MX only added 3 new parameters

This was the position when Steve Loft ceased his involvement with Cumulus. This page contained all parameters used for Cumulus 1, some of these were used by MX beta too.

The beta page contained some Cumulus 1 beta parameters that were still under development and the parameters that were only used by MX.

Mark Crossley era

  • Cumulus.ini content has changed drastically, and therefore the documentation page called "Cumulus.ini" has also had to change drastically
  • There was a period when it was possible for one page to document both the legacy Cumulus 1.9.4 and all MX releases, but that has long gone.
MX beta releases 3.0.0 to MX release 3.4.6 MX releases 3.6.0 to 3.7.0 MX releases 3.8.0 to 3.9.7 MX releases 3.10.0 to 3.11.4 MX release 3.12.0 onwards
  • Until MX release 3.4.6, people using MX needed to refer to the page now called Cumulus.ini_(Cumulus_1), which was called "Cumulus.ini" at the time, and the beta page, Cumulus.ini_(Beta), as MX still used most of the parameters that the legacy software used and just a few new parameters. The latter still contained information from the last Cumulus 1 beta relating to Proxies section of Cumulus.ini, as that had not been finalised.
  • When Mark Crossley brought MX out of beta, he started adding new features to MX:
    • Some features represented functionality in the legacy software that MX had lacked, these used parameters that had been used for the legacy software
    • For other new features, like interfaces with new weather station types and new sensors, he created new parameters, and the beta page began to rival the legacy page in the number of parameters it covered
  • The information about MX on the beta page stayed there until April 2020
  • Release 3.6.0 was when the functionality of MX first started to exceed the functionality of the legacy software
  • Between April and June 2020, information on the beta page was slowly moved across to the main page, it took some time as it needed to be verified because as MX developed configuration file content was changing
  • Suddenly, a lot of people were migrating from the legacy software to MX
  • To help people migrating, from June 2020, all settings (for both the legacy software and MX) were covered on a single "Cumulus.ini" page
  • As people migrated, they could see on that single page clearly which parameters in their Cumulus.ini file were still valid, and what new parameters were needed when they migrated
  • For those using MX, the page was recording the new parameters that were being added to the file as MX developed
  • Now the history of all the changes at that time can be viewed on this page, as this was originally the page that once held that combined information.
  • From release 3.8.0, the pace of change in MX was so fast, and the contributors to the Wiki so few, the page then called "Cumulus.ini" (with its previous content) stopped being maintained.
    1. The main problem was somebody needed to do a lot of research, and devote a lot of time, to track what the developer was changing.
    2. There was a second problem, it was clear that it was too complicated to use the same page to describe configuration for the legacy software, older MX releases, and the latest MX release
  • Consequently, the "Cumulus.ini" page had to change, and the first move meant accepting MX and the legacy software could not be documented any more on the same page
    • A new page was created Cumulus.ini_(Cumulus_1), and all the information specific to the legacy software was split off from this page
  • This still left the problem that this page, at that time called "Cumulus.ini", had information that related to a release that had been superseded
  • Finally, this old "Cumulus.ini" paqe, with the attached history, but without any parameter information in the main page, was renamed to its current name, so it has preserved the history of the old page that had been split into two new pages, neither of which had the past history
  • At release 3.10.0, the settings pages in the admin interface were given a significant makeover, and huge numbers of new settings were created, while many others became redundant
  • It was clear the old MX "Cumulus.ini" page was badly designed for the way 3.10.0 operated
  • That old page was already out of date as it had not been updated for 3.8.0 changes
  • It became obvious it was easier to start a new page that would would be based around 3.10.0 MX release, but would incorporate changes from 3.8.0 onwards, and would ignore anything that was now redundant
  • The other change was a redesign of the page, so it focussed on explaining how to change the settings using the admin interface, rather than just documenting what each parameter in the file was used for
  • As MX was developed, its settings pages were being redesigned, and so where you changed particular parameters in the file was modified making the documentation that already existed obsolete for people using latest release, but still valid for people who were using an older release.
  • As release 3.12.0 was planned to add many, many more parameters to the Cumulus.ini file, and the Settings pages get another redesign, it was decided the documenting of the changes in 3.8.0, 3.9.2, and 3.10.0 would be delayed until it became clearer what might change in 3.12.0
  • The new Cumulus.ini page to cover all these recent releases was created in June 2021, a year after the last big change to a page with that name.

Original content of this page

How this page used to be laid out, and why

For both Cumulus 1 and early MX releases, the content on this page was arranged assuming people were editing the file directly.

Therefore, the file was described by working through the sections on the file, and explaining the parameters that could go in each section.

For the longer sections, parameters might be split into separate tables to make it easier.

Before release 3.10.1, there were two types of parameters in Cumulus.ini.

  1. "read-only" settings were made directly in the "Cumulus.ini" file, there was no way to adjust these parameters using the settings screens/pages
  2. "read-write" settings could be changed in two ways, either by editing the file with Cumulus stopped, or by finding the parameter on a setting screen (for MX, these are in admin interface).
You will see in the two pages split off from this page (Cumulus.ini_(Cumulus_1) and Cumulus.ini (MX_3.0.0_to_3.7.0)), how the parameters had to identify themselves as read-only or read-write.

Why has this original "Cumulus.ini" page been renamed, cleared of old content, and made historic?

  1. One big change in 3.10.1 is that (almost) all settings are now made via the Admin interface.
    • Therefore it makes no sense any more to organise this page how someone editing the file directly might want.
    • The replacement Cumulus.ini page is now organised by how you change settings in the admin interface (i.e. similar to how settings have been explained in MX_Administrative_Interface#Changing_Settings).
  2. Another change is that some of the settings that used to be made on the “Station Settings” page, are now made on different pages in that interface.
  3. Yet another change is that what you pick in some settings can affect what settings are shown later on the admin interface page.
    • You could say the settings pages have become intelligent.
    • For example, when you select a weather station type it ensures only parameters that relate to that weather station type are shown.
    • As another example, you can opt in or out of the default web site design, so that determines which parameters relating to web sites are shown.
  4. A final change is that some parameters are grouped as “Advanced”, so that novices can avoid those.
Retrieved from "https://www.cumuluswiki.org/index.php?title=Cumulus.ini_(preserving_history)&oldid=9245"