Cumulus Wiki

Cumulus.ini: Difference between revisions

Cumulus.ini (view source)

Revision as of 04:59, 15 June 2021

2,670 bytes added ,  04:59, 15 June 2021
m
→‎Third Party
Line 1: Line 1:
<big>Release 3.12.0 moves various options to new places and creates several new Cumulus.ini options.
<big>Please note this page was created 13 June 2021.  This new page was created to reflect parameters added to Cumulus.ini in releases 3.8.0, 3.9.2, 3.10.0, 3.12.0, and after that.  It excludes all parameters removed since 3.8.0.
Consequently, this page is undergoing a substantial rewrite, and may take a while to fully cover all settings.</big>


[[Category:Configuration Files]]
MX has been developed very dramatically by Mark Crossley (away from the beta begun by Steve Loft) and as a consequence the "Cumulus.ini" file content has considerable differences.  Therefore, the decision was taken to abandon maintaining the page previously called "Cumulus.ini" and start again with a brand new empty page!</big>
{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}


= Important note about this page =
If you are using the final 1.9.4 legacy Cumulus software, or an old release of MX, please go to the owning [[:Category:Configuration Files|category]] to find the links to the relevant former contents of pages previously called "Cumulus.ini".


Please note this page was created 13 June 2021.  This new page is being created to cover Cumulus.ini file for changes in releases 3.10.0, 3.12.0, and so on. It has been written, starting with a blank page, to reflect the contents of the "Cumulus.ini" file as now applies. The rewrite was needed as there has been so many changes in the contents of the file as MX has been developed so dramatically by Mark Crossley away from the beta begun by Steve Loft
If you are interested in the editing history, associated with the page that previously was called "Cumulus.ini", and some information describing how it was previously used, the old page was moved (before this page was created) so that the editing history of that former page is now preserved at [[Cumulus.ini_(preserving_history)]].  That page also expands on the reasons why that old page was replaced by this new page.
 
If you are interested in the editing history, associated with the page that previously was called "Cumulus.ini", and some information describing how it was previously used, the old page was moved (before this page was created) so that it is now preserved at [[Cumulus.ini_(preserving_history)]].  That page also expands on the reasons why that old page was replaced by this new page, and both it, and the owning [[:Category:Configuration Files|category]], have links to other pages that document "Cumulus.ini" for MX releases before 3.10.0, and for the final 1.9.4 legacy Cumulus software.


[[Category:Configuration Files]]
{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}


=Purpose of Cumulus.ini file=
=Purpose of Cumulus.ini file=
Line 78: Line 76:
#SETTINGS THAT TAKE EFFECT IMMEDIATELY ON CLICKING “SAVE”
#SETTINGS THAT TAKE EFFECT IMMEDIATELY ON CLICKING “SAVE”
#SETTINGS THAT ONLY TAKE EFFECT WHEN MX IS RESTARTED
#SETTINGS THAT ONLY TAKE EFFECT WHEN MX IS RESTARTED
''There used to be a third group''. Before '''Release 3.11.2 - build 3131''' a few changes made in the interface were not saved into "Cumulus.ini", and therefore lost when MX was restarted. One example of these former exceptions was on Program Settings page where the former action was that choice for [[MXdiags folder|adding extra debugging information to file in MXDiags folder]] was not saved for subsequent session.


Unfortunately, there is no documentation available from developer on which settings, at any release, do not take effect until MX is restarted.
Unfortunately, there is no documentation available from developer on which settings, at any release, do not take effect until MX is restarted.


A further complication is that in some releases, certain settings that used to require a restart have been changed so they take effect intermediately.   
A further complication is that in some releases, certain settings that used to require a restart have been changed so they take effect intermediately.  It is anticipated this will continue to change as MX develops.


This means that any attempt to document which changes do require a restart is working against a moving target,  so this documentation cannot indicate where a restart is required.  You can play safe, and restart MX each time you finish making edits to settings.
This means that any attempt to document which changes do require a restart is working against a moving target,  so this documentation cannot indicate where a restart is required.  You can play safe, and restart MX each time you finish making edits to settings, or you can read all the support forum announcements, and see if you can find any information about whether a restart is needed.


There used to be a third group. Before '''Release 3.11.2 - build 3131''' a few changes made in the interface were not saved into "Cumulus.ini", and therefore lost when MX was restarted. One example of these former exceptions was on Program Settings page where the former action was that choice for [[MXdiags folder|adding extra debugging information to file in MXDiags folder]] was not saved for subsequent session.


For the current MX release, any change made (on any settings page) will be saved into "Cumulus.ini", and will still apply when MX is restarted. That restart will ensure all settings changed in the last session do take effect, even those that did not take effect before the restart.  
For the current MX release, any change made (on any settings page) will be saved into "Cumulus.ini", and will still apply when MX is restarted. That restart will ensure all settings changed in the last session do take effect, even those that did not take effect before the restart.  
Line 237: Line 236:




{{Template:WorkInProgressBanner}} This table has not been populated yet
{{Template:WorkInProgressBanner}} This table has not been populated yet, alarms have changed dramatically since 3.8.0
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 733: Line 732:
* File Section is [NOAA]
* File Section is [NOAA]
Rainfall equivalents of mean temperature described above
Rainfall equivalents of mean temperature described above
==Optional Third-party Upload Settings==
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | File Section
!style="width:60px" | MX Section
!style="width:60px" | Action on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| <pre>ID=
pass=-1
server=cwop.aprs.net
port=14580
Enabled=0
Interval=9
SendSR=0
APRSHumidityCutoff=0</pre>
| [APRS]
| APRS/CWOP
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>User=
Password=
Language=en
Enabled=0
Interval=900
SendUV=0
SendSR=0
SendSoilTemp=0
SendIndoor=0
SendSoilMoisture=0
SendLeafWetness=0
SendAirQuality=0</pre>
| [Awekas]
| AWEKAS
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Enabled=0
CatchUp=1
APIkey=
StationId=
Interval=15</pre>
| [OpenWeatherMap]
| OpenWeatherMap
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [PWSweather]
| PWS Weather
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>User=
Password=
Enabled=0
Interval=60
OauthToken=unknown
OauthTokenSecret=unknown
TwitterSendLocation=1</pre>
| [Twitter]
| Twitter
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Wid=
Key=
Enabled=0
Interval=10
SendUV=0
SendSR=0
SendAQI=0
SendSoilMoisture=0
SoilMoistureSensor=0
SendLeafWetness=0
LeafWetnessSensor=0</pre>
| [WeatherCloud]
| WeatherCloud
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>Enabled=0
StationUID=
Password=
Interval=1
SendRain=0</pre>
| [WindGuru]
| Windguru
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>APIkey=
StationIdx=0
Enabled=0
Interval=15
SendUV=0
CatchUp=1</pre>
| [Windy]
| Windy.com
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|-
| <pre>ID=
Password=
Enabled=0
Interval=15
SendUV=0
SendSR=0
CatchUp=1</pre>
| [WOW]
| Met Office WOW
| Tick "Enabled" to see list of parameters so you can edit them
| Defaults are as shown in list of parameters
|}


==Optional Web Server==
==Optional Web Server==
Sfws
5,838

edits

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