Cumulus.ini (preserving history) and Software: Difference between pages

From Cumulus Wiki
(Difference between pages)
Jump to navigationJump to search
 
 
Line 1: Line 1:
{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}


= Cumulus MX =
=History of this page=


== Current Release ==
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.


Note: '''Cumulus MX is strictly for non-commercial, non-government use only.'''
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]]
It contains products produced by [https://www.highcharts.com Highsoft] which are not free for commercial and governmental use.


===Source download===
Anybody using the legacy software (e.g. 1.9.4) should now go to [[Cumulus.ini_(Cumulus_1)|this page]]


*[https://github.com/cumulusmx/CumulusMX Cumulus MX Current Source Code] This code base is updated for all releases resulting from development by M Crossley.
The past history for both those two new pages remains available via the history tab on this page.


===Latest build distribution download===
=Content of this page=


*[https://github.com/cumulusmx/CumulusMX/releases/download/b3132/CumulusMXDist3132.zip Cumulus MX v3.11.3 build 3132, 19-May-2021] Cumulus MX, a cross platform version of Cumulus which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X. (M Crossley update)
This page has been emptied ready for new content to reflect how MX works from 3.10.1 onwards.
:'''NOTE: On Linux/RPi/macOS, Release v3.9.1 or later requires Mono version 5 or 6. Mono v4 is subject to random crashes.'''<br /><br />


===Raspberry Pi Image===
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).


*There is also a pre-built disk image file for your first installation onto a Raspberry Pi
Settings are now arranged according to the menu selections, as that is the way you change them.
**This contains the lite version of the Raspberry pi operating system, plus all you need for a MX installation.
** It can be downloaded from here: [//{{SERVERNAME}}/Downloads/rpi-CMX-3.10.5.zip rPi Cumulus MX 3.10.5]
***The instructions for using this image can be found here: [[Raspberry_Pi_Image|Raspberry Pi Image]]
*** Please note, this image may not contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link above, as none of the other components in the image need to be upgraded.


==Older releases==
Consequently, the revised tables have to explain which section settings are in the file.


It is always possible that a new release introduces a bug, and you decide to regress to an earlier release. Find link to earlier MX release distributions on [[Main Page]], and for earlier Raspberry Pi images simply change the file name above to represent earlier release.
=The Cumulus.ini file=


= Help with ‘Stable’ MX releases =
'''Cumulus.ini''' is a text file containing initialization parameters used by the Cumulus MX software application.


Please read the announcement for the latest MX release in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 the forum] before installing it.
When Cumulus MX is run for very first time, the file does not exist, as it is not included in the release distribution.


We strongly advise updating to the latest version, if only for the fact that later versions offer more functionality, and may fix any bugs in an earlier
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).
release.

==File contents==

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.

== Add new parameters to file==

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).

==Remove redundant parameters from file==

Best done after, not before, you [[Updating MX to new version|upgrade]] MX, as installing a new release might add/remove parameters to/from Cumulus.ini.
==Upgrading==
If you have been using Cumulus for a while, there might be parameters that are now obsolete left in file, and as newer parameters are appended at end that might make the parameter order look strange. You can start afresh with a new file anytime.

You must do this while Cumulus MX running (to preserve existing settings)...
# Rename your existing '''Cumulus.ini''' to say '''Cumulus.ini.sav''' (this keeps the file, but stops MX finding it)
# In Cumulus go to one of the settings screens - say Alarms - and click the Update Alarms button (i.e. any action that makes MX save settings to its configuration file)
# Cumulus should create a brand new Cumulus.ini file,
#This will have all the settings you have chosen
#They will now be in the order MX is expecting
#Any redundant MX (or legacy Cumulus) settings will no longer exist (MX does not know them any more, so it cannot create them).

A major change is likely in the <nowiki>'''[Station]'''</nowiki> section as that is seeing a lot of changes as MX is developed.
The most dramatic change may happen in <nowiki>'''[FTP Site]'''</nowiki> as any changes to the list of parameters for '''Extra Web Files''' are reproduced 100 times.

=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 &#9654;to expand, click &#9660; to collapse''' styling.
|}

===Program Start-up Options===


{| 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]
|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]
|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===

==Station 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 &#9654;to expand, click &#9660; to collapse''' styling.
|}

===General Settings - Station type and Log interval===

===General Settings - Log Rollover===

===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"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | 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.
|-
|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
|Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude

CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.
*0 = Use SLP supplied by Davis
*1 = Convert the SP Davis supplies to AP using the altitude you have supplied.
|-
|SyncDavisClock=0
|
|0
|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).
*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!
|-
|ClockSettingHour=4
|
|4
|Controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*4 = 04:00 (default value)
*0-23 = 00:00 to 23:00
|-
|VP2ConnectionType=1
|
|
|Weather station connection type
*0 = serial (see next parameter to specify COM port)
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
*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.


You can install a new release of MX directly over your existing version.
Set it to zero to disable, if you are not using the Weatherlink site.
*Important, please read all of the release notes (in the appropriate forum announcement threads) for the builds since the version you are upgrading from.
|-
*If you are currently running an old release of MX, you might want to check [[Updating MX to new version]] page, as that has some advice about whether it is best to upgrade in multiple steps.
|LogExtraSensors=0
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page
|
|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.


Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software which have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software.
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).


If you need any help with Cumulus MX, please first consult, in this Wiki, the [[:Category:Cumulus MX]] page for pointers to articles that may help. If you cannot answer your questions from those links, then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have answers.
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====


= Other utilities =
Oregon Scientific specific
{{Template:WorkInProgressBanner}}


== Utility for Fine Offset Stations ==
{| 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
|}


*[//{{SERVERNAME}}/Downloads/SetLogger.zip Set Logger Interval] A utility by Steve Loft to adjust the internal logging interval on Fine Offset stations
====EasyWeather File Settings====


====Instromet Settings====


== Weather Display Converter ==


This utility was provided by Steve to convert Weather Display log files to Cumulus format.
{{Template:WorkInProgressBanner}}


At time of writing this here, the functionality in MX was limited. You may need to manually recreate records, etc. using Cumulus 1.
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | 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
|
|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
|
| 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
|
|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
|
|0 (disable)
|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.
|}


Please read the readme file in the zip.
====Davis WeatherLink Live====


There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about this converter here].
{{Template:WorkInProgressBanner}}


[https://cumuluswiki.org/a/File:WDconverter.zip WDConverter.zip]
{| 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
|-


== WeatherLink Converter ==
====Ecowittt GW1000 Settings====


This utility was provided by Steve to convert WeatherLink log files to Cumulus format.
Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|style="background:lightgray;"|[GW100]
|
|
|style="background:lightgray;"|Section name
|-
|AutoUpdateIpAddress=1
|Auto-discovery
|1 (selected)
|Should MX attempt to discover IP address
*0=Disable
*1=Enable
|-
|IPAddress=
|IP address
|(no default)
| stores the IP address of your GW1000 WiFi logger
|-
|MACAddress=
|MAC addresss
|(no default)
|Populated by MX when auto-discovery enabled
|}


Please read the readme file in the zip.
====Solar====


There is a [https://cumulus.hosiene.co.uk/viewtopic.php?t=11349 forum thread about this converter here].
{| 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)
|}


[https://cumuluswiki.org/a/File:WLconverter.zip WLconverter.zip]


== Create Missing ==
===Common Options===


A utility, by Mark Crossley, to create missing entries in your '''dayfile.txt'''.
===Forecast===


You may use this:
===Annual Rainfall===
# to add additional new fields for derivatives that are missing from existing extreme records (in [[:Category:Log Files|'''.ini''']] files) created with old versions of Cumulus,
#or to create a whole new [[dayfile.txt| daily summary file]] if you are starting afresh with monthly based data imported into [[Standard log files]] from another program.


The v1.0.2 download dated 11 Mar 2021 [https://github.com/cumulusmx/CreateMissing/releases/download/v1.0.2/CreateMissing-v1.0.2.zip is here.]
===Growing Degree Days===


More information can be [https://github.com/cumulusmx/CreateMissing/blob/master/README.md found here.]
===Annual Temperature Sum===


===Graphs===
== ExportToMySQL ==


A utility, by Mark Crossley, to export Cumulus MX monthly and dayfile logs to a MySQL database.
===Display Options===


The v1.3.0 download dated 27 Apr 2021 (for 7 May release of MX 3.11.0) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.3.0/ExportToMySQL-v1.3.0.zip is here.]
==Internet Settings==


More information can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.]
===Web/FTP Site===


''This replaces the "ExportMySQL.exe" utility included by Steve Loft in his MX beta distributions.''
===Web/FTP Settings===


== Third Party Contributions by Cumulus Users ==
===Email Server Settings===


For files, and add-on's, contributed by Cumulus users, see these Categories:
===External Programs===
# [[:Category:3rd Party Apps]] - contributions for various devices,
# [[:Category:AddOns]] - adding extra functionality,
# [[:Category:WebTools]] - for your web server, and
# [[:Category:User_Contributions]] - key contributions from the user community


=Current MX Developed from =
===MQTT===


Cumulus 3 (MX) software was developed as a beta with limited functionality by Steve Loft.
MQTT (Message Queuing Telemetry Transport) is a machine-to-machine (M2M), also known as "Internet of Things", connectivity protocol.
*Steve Loft previously developed Cumulus 2 (where he tested using the C# language, now used for MX)
* Steve Loft created the original Cumulus software (now known as legacy cumulus 1) just for his use, before making it generally available, he then developed it over the next decade to include requirements suggested by thousands of users.
*Steve Loft, the author of Cumulus/Cumulus MX has since fully retired, and stopped providing support, or updates, to Cumulus 1 or Cumulus MX software.


==Steve's final beta MX==
This section was introduced by release 3.5.0 (build 3071)


You can download below the final beta release as made available by Steve Loft, and also his subsequent final source code.
{| 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
|}


If you are able to understand his source code (linked below), and compare it to the latest source code (linked above), you can appreciate the transformation that has taken place in recent years.


*[//{{SERVERNAME}}/Downloads/CumulusMXDist3043.zip Cumulus MX v3.0.0 beta build 3043, 20-Jan-2017] Cumulus MX, a cross platform version of Cumulus which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X (Steve Loft - final release).
===Moon Image===
*[//{{SERVERNAME}}/Downloads/CumulusMXSource.zip subsequent updated Cumulus MX Source Code] from Steve Loft. He made the following comments, as he handed the project over to "the community":
**This version of the code is post b3043 as it includes some changes that Steve had made, but not yet released.
**Offered completely '''without support''' in the hope that it might be useful.
**The code is very badly structured due to the 'Frankenstein' way it was cobbled together from various places. Some of it is a machine translation of parts of Cumulus 1.


===Proxies===


== Legacy releases ==
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.


See [[Downloads| downloads page]] for full details.
HTTPProxyName=


=== Cumulus 1 ===
HTTPProxyPort=


The installer for Cumulus 1 is available here *[//{{SERVERNAME}}/Downloads/CumulusSetup.exe Cumulus 1099 installer].
HTTPProxyUser=


*[//{{SERVERNAME}}/Downloads/cumulus.1099.2.zip Cumulus 1.9.4 build 1099.2 patch] Patched version of one file (Cumulus.exe),
HTTPProxyPassword=
**modifies the drop-down year selectors, (on "this period" screens, for NOAA reports, and for Snow Index).
*The new year drop-down selectors will make it easier to choose date entries up to the year 2030 (updated 28 Jan 2020).
*Note this is not the full installation package, just one file to replace the suite of files created by the installer, a patched .exe.
**Without the patch, you can still enter any year,but you have to over-type with the full year yourself.


==== Special Variants ====


*[//{{SERVERNAME}}/Downloads/CumulusSetup1100.zip Cumulus 1.9.4 build 1100 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 115200 baud, you should use build 1100
*[//{{SERVERNAME}}/Downloads/CumulusSetup1101.zip Cumulus 1.9.4 build 1101 setup] '''Use ONLY if you are an Instromet user''', and your logger operates at 19200 baud, you should use build 1101
*'''NOTE:''' '''These Cumulus 1.9.4 variants will not have any updates in the future.'''
*In 2020, some of the menu items with year drop-down selectors will not display years beyond 2020.
**You can manually over-type any selection boxes with any year you like,you are not limited to those in drop-down
**For example, this will happen on manual generation of NOAA-style reports.
**This does not affect any automatic generation of NOAA reports.


It is '''STRONGLY RECOMMENDED''' that users of Cumulus '''1.9.4 variants''' migrate to Cumulus MX, which has ongoing support by mcrossley. The baud rate can be selected within MX as a configuration setting.


=== Legacy Resources ===


*[//{{SERVERNAME}}/Downloads/Cumulus%20basic%20installation%20guide.pdf Cumulus installation guide] Instructions for installing Cumulus 1
*[//{{SERVERNAME}}/Downloads/readme.txt Cumulus readme.txt] Please read this before installing or updating Cumulus
*[//{{SERVERNAME}}/Downloads/Cumulus.chm Cumulus help file] The Cumulus 1 help file (this also gets installed when Cumulus is installed)
*[//{{SERVERNAME}}/Downloads/CumulusRealtime.zip Cumulus Realtime] An obsolete Silverlight application for displaying 2 extra dials showing real time wind data on the standard Cumulus (with temperature and rainfall in histogram style) gauges page for a web site (no longer developed or supported)
*[//{{SERVERNAME}}/Downloads/CumulusFR.chm Cumulus help file in French] The Cumulus 1 help file translated into French


== Cumulus 2 ==


The software for Cumulus 2 is no longer available.
[[Category:Cumulus Files]]

Revision as of 09:31, 19 May 2021

Cumulus MX

Current Release

Note: Cumulus MX is strictly for non-commercial, non-government use only. It contains products produced by Highsoft which are not free for commercial and governmental use.

Source download

Latest build distribution download

NOTE: On Linux/RPi/macOS, Release v3.9.1 or later requires Mono version 5 or 6. Mono v4 is subject to random crashes.

Raspberry Pi Image

  • There is also a pre-built disk image file for your first installation onto a Raspberry Pi
    • This contains the lite version of the Raspberry pi operating system, plus all you need for a MX installation.
    • It can be downloaded from here: rPi Cumulus MX 3.10.5
      • The instructions for using this image can be found here: Raspberry Pi Image
      • Please note, this image may not contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, upgrading is done using main software download link above, as none of the other components in the image need to be upgraded.

Older releases

It is always possible that a new release introduces a bug, and you decide to regress to an earlier release. Find link to earlier MX release distributions on Main Page, and for earlier Raspberry Pi images simply change the file name above to represent earlier release.

Help with ‘Stable’ MX releases

Please read the announcement for the latest MX release in the forum before installing it.

We strongly advise updating to the latest version, if only for the fact that later versions offer more functionality, and may fix any bugs in an earlier release.

Upgrading

You can install a new release of MX directly over your existing version.

  • Important, please read all of the release notes (in the appropriate forum announcement threads) for the builds since the version you are upgrading from.
  • If you are currently running an old release of MX, you might want to check Updating MX to new version page, as that has some advice about whether it is best to upgrade in multiple steps.
  • If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read Migrating from Cumulus 1 to MX page; and if you need more justification read Compare legacy Cumulus and MX page

Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software which have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software.

If you need any help with Cumulus MX, please first consult, in this Wiki, the Category:Cumulus MX page for pointers to articles that may help. If you cannot answer your questions from those links, then use the correct MX support forum to see if others have answers.


Other utilities

Utility for Fine Offset Stations

  • Set Logger Interval A utility by Steve Loft to adjust the internal logging interval on Fine Offset stations


Weather Display Converter

This utility was provided by Steve to convert Weather Display log files to Cumulus format.

At time of writing this here, the functionality in MX was limited. You may need to manually recreate records, etc. using Cumulus 1.

Please read the readme file in the zip.

There is a forum thread about this converter here.

WDConverter.zip

WeatherLink Converter

This utility was provided by Steve to convert WeatherLink log files to Cumulus format.

Please read the readme file in the zip.

There is a forum thread about this converter here.

WLconverter.zip

Create Missing

A utility, by Mark Crossley, to create missing entries in your dayfile.txt.

You may use this:

  1. to add additional new fields for derivatives that are missing from existing extreme records (in .ini files) created with old versions of Cumulus,
  2. or to create a whole new daily summary file if you are starting afresh with monthly based data imported into Standard log files from another program.

The v1.0.2 download dated 11 Mar 2021 is here.

More information can be found here.

ExportToMySQL

A utility, by Mark Crossley, to export Cumulus MX monthly and dayfile logs to a MySQL database.

The v1.3.0 download dated 27 Apr 2021 (for 7 May release of MX 3.11.0) is here.

More information can be found here.

This replaces the "ExportMySQL.exe" utility included by Steve Loft in his MX beta distributions.

Third Party Contributions by Cumulus Users

For files, and add-on's, contributed by Cumulus users, see these Categories:

  1. Category:3rd Party Apps - contributions for various devices,
  2. Category:AddOns - adding extra functionality,
  3. Category:WebTools - for your web server, and
  4. Category:User_Contributions - key contributions from the user community

Current MX Developed from

Cumulus 3 (MX) software was developed as a beta with limited functionality by Steve Loft.

  • Steve Loft previously developed Cumulus 2 (where he tested using the C# language, now used for MX)
  • Steve Loft created the original Cumulus software (now known as legacy cumulus 1) just for his use, before making it generally available, he then developed it over the next decade to include requirements suggested by thousands of users.
  • Steve Loft, the author of Cumulus/Cumulus MX has since fully retired, and stopped providing support, or updates, to Cumulus 1 or Cumulus MX software.

Steve's final beta MX

You can download below the final beta release as made available by Steve Loft, and also his subsequent final source code.

If you are able to understand his source code (linked below), and compare it to the latest source code (linked above), you can appreciate the transformation that has taken place in recent years.

  • Cumulus MX v3.0.0 beta build 3043, 20-Jan-2017 Cumulus MX, a cross platform version of Cumulus which runs on Windows, Linux (including the Raspberry Pi) and Mac OS X (Steve Loft - final release).
  • subsequent updated Cumulus MX Source Code from Steve Loft. He made the following comments, as he handed the project over to "the community":
    • This version of the code is post b3043 as it includes some changes that Steve had made, but not yet released.
    • Offered completely without support in the hope that it might be useful.
    • The code is very badly structured due to the 'Frankenstein' way it was cobbled together from various places. Some of it is a machine translation of parts of Cumulus 1.


Legacy releases

See downloads page for full details.

Cumulus 1

The installer for Cumulus 1 is available here *Cumulus 1099 installer.

  • Cumulus 1.9.4 build 1099.2 patch Patched version of one file (Cumulus.exe),
    • modifies the drop-down year selectors, (on "this period" screens, for NOAA reports, and for Snow Index).
  • The new year drop-down selectors will make it easier to choose date entries up to the year 2030 (updated 28 Jan 2020).
  • Note this is not the full installation package, just one file to replace the suite of files created by the installer, a patched .exe.
    • Without the patch, you can still enter any year,but you have to over-type with the full year yourself.

Special Variants

  • Cumulus 1.9.4 build 1100 setup Use ONLY if you are an Instromet user, and your logger operates at 115200 baud, you should use build 1100
  • Cumulus 1.9.4 build 1101 setup Use ONLY if you are an Instromet user, and your logger operates at 19200 baud, you should use build 1101
  • NOTE: These Cumulus 1.9.4 variants will not have any updates in the future.
  • In 2020, some of the menu items with year drop-down selectors will not display years beyond 2020.
    • You can manually over-type any selection boxes with any year you like,you are not limited to those in drop-down
    • For example, this will happen on manual generation of NOAA-style reports.
    • This does not affect any automatic generation of NOAA reports.

It is STRONGLY RECOMMENDED that users of Cumulus 1.9.4 variants migrate to Cumulus MX, which has ongoing support by mcrossley. The baud rate can be selected within MX as a configuration setting.

Legacy Resources

  • Cumulus installation guide Instructions for installing Cumulus 1
  • Cumulus readme.txt Please read this before installing or updating Cumulus
  • Cumulus help file The Cumulus 1 help file (this also gets installed when Cumulus is installed)
  • Cumulus Realtime An obsolete Silverlight application for displaying 2 extra dials showing real time wind data on the standard Cumulus (with temperature and rainfall in histogram style) gauges page for a web site (no longer developed or supported)
  • Cumulus help file in French The Cumulus 1 help file translated into French

Cumulus 2

The software for Cumulus 2 is no longer available.

Retrieved from "https://www.cumuluswiki.org/index.php?title=Cumulus.ini_(preserving_history)&oldid=8947"