Cumulus.ini (MX 3.0.0 to 3.7.0) - Revision history

Sfws: Undo revision 9422 by Sfws (talk)

2021-07-17T08:12:04Z

Undo revision 9422 by Sfws (talk)

← Older revision		Revision as of 08:12, 17 July 2021
Line 1,613:		Line 1,613:
	*1 = Enable sound on alarm		*1 = Enable sound on alarm
	\|-		\|-
			\|LowTempAlarmSoundFile=
	\|LowTempAlarm.SoundFile=
		⚫	\|Path and file name of sound file for Low Temperature alarm
	\| There is incompatibility with Legacy Cumulus, the MX attribute name includes a full stop, but the attribute name in [[Cumulus.ini (Cumulus 1)\|legacy file]] did not

⚫	Path and file name of sound file for Low Temperature alarm
	\|-		\|-
	\|alarmhightemp=0		\|alarmhightemp=0

Sfws: /* Section: Alarms */ Correction, and note about incompatibility with legacy

2021-07-17T07:45:42Z

Section: Alarms: Correction, and note about incompatibility with legacy

← Older revision		Revision as of 07:45, 17 July 2021
Line 1,613:		Line 1,613:
	*1 = Enable sound on alarm		*1 = Enable sound on alarm
	\|-		\|-
			\|LowTempAlarm.SoundFile=
	\|LowTempAlarmSoundFile=
			\| There is incompatibility with Legacy Cumulus, the MX attribute name includes a full stop, but the attribute name in [[Cumulus.ini (Cumulus 1)\|legacy file]] did not
⚫	\|Path and file name of sound file for Low Temperature alarm

		⚫	Path and file name of sound file for Low Temperature alarm
	\|-		\|-
	\|alarmhightemp=0		\|alarmhightemp=0

Sfws: /* Creating Configuration File */

2021-07-12T06:40:26Z

Creating Configuration File

@@ Line 96: / Line 96: @@
 When you download Cumulus MX, ''there is no configuration file included in the download''. So when you first use the software,  you will need to enter some settings, and that will lead to creation of the main configuration file.  How to enter these minimum settings will be described next.
 # At this stage, MX creates a very basic Cumulus.ini with the default settings (shown below).
 #Open the [[MX Administrative Interface|admin interface]], and select the station settings if necessary: [[File:MX_station_settings.png|800px|center]]
-#At the very minimum, you must select a station type and units (as shown in image here)
+# At the very minimum, you must select a station type and units (as shown in image here)
-#Optionally, move down the page, entering more settings, or move to other settings pages accessed from the menu seen in the image
+# Optionally, move down the page, entering more settings,
 ====Default Cumulus.ini====

Sfws: Correct release references

2021-07-12T05:45:30Z

Correct release references

← Older revision		Revision as of 05:45, 12 July 2021
Line 2:		Line 2:
	[[File:Crystal Clear info.png\|40px]] This page was last updated for the MX release in July 2020; that is no longer latest!		[[File:Crystal Clear info.png\|40px]] This page was last updated for the MX release in July 2020; that is no longer latest!

			Information on this page was originally on a page called "Cumulus.ini", it has been moved to this new page because the information now only applies if you are using Cumulus MX beta release 3.0.0 or Mark's releases up to 3.7.0
	Appeal to contributors: Please work through all MX release announcements and work out any updates needed for this page
	</div>		</div>


	[[File:Badge vMx.png]] ~~This~~ ~~page~~ ~~now~~ ~~only~~ ~~applies~~ if ~~you are using~~ ~~Cumulus~~ MX ~~beta~~ ~~release~~ ~~3.0.0~~ or ~~Mark's~~ ~~release~~ up to ~~3.9.7~~.		[[File:Badge vMx.png]] The accuracy/completeness of information on this page is not guaranteed, except for those entries made by the developer.

			For release 3.8.0 and later, you should read the newest [[Cumulus.ini]] page.
	The main [[Cumulus.ini]] page is now only for 3.10.1 onwards.

	The information for the legacy Cumulus has been moved to the new [[Cumulus.ini (Cumulus 1)]] page.		The information for the legacy Cumulus has been moved to the new [[Cumulus.ini (Cumulus 1)]] page.

Sfws: Sfws moved page Cumulus.ini(MX 3.0.0 to 3.9.7) to Cumulus.ini (MX 3.0.0 to 3.7.0): Correcting

2021-06-15T05:13:33Z

Sfws moved page Cumulus.ini(MX 3.0.0 to 3.9.7) to Cumulus.ini (MX 3.0.0 to 3.7.0): Correcting

← Older revision

Revision as of 05:13, 15 June 2021

Sfws: Text replacement - "[[MXDiags" to "[[MXdiags"

2021-05-22T20:56:41Z

Text replacement - "[[MXDiags" to "[[MXdiags"

← Older revision		Revision as of 20:56, 22 May 2021
Line 427:		Line 427:
	Note in particular, that some settings (such as units, date/time formats) must be got right first time. If you do change those later, it is a lot of work because you will need to edit all the other files that Cumulus creates to reflect those changes.		Note in particular, that some settings (such as units, date/time formats) must be got right first time. If you do change those later, it is a lot of work because you will need to edit all the other files that Cumulus creates to reflect those changes.

	For Cumulus MX, if it is being run for the first time and it does not inherit a file, it needs some settings before it can do anything. Consequently, MX just hangs, because unless you look at the Terminal output or the file it creates in [[~~MXDiags_folder~~]], you won't know it is waiting for settings. You need to start up the[[MX_Administrative_Interface\| Administrative Interface]] and go into the various settings pages yourself to select what MX needs to continue to work. You then need to stop MX so it stores those settings and can use them next time it starts.		For Cumulus MX, if it is being run for the first time and it does not inherit a file, it needs some settings before it can do anything. Consequently, MX just hangs, because unless you look at the Terminal output or the file it creates in [[MXdiags_folder]], you won't know it is waiting for settings. You need to start up the[[MX_Administrative_Interface\| Administrative Interface]] and go into the various settings pages yourself to select what MX needs to continue to work. You then need to stop MX so it stores those settings and can use them next time it starts.

	Please note some settings can take immediate effect while MX is running, others only take on their new values when MX is restarted. Don't ever edit the configuration file directly while Cumulus MX is running!		Please note some settings can take immediate effect while MX is running, others only take on their new values when MX is restarted. Don't ever edit the configuration file directly while Cumulus MX is running!
Line 837:		Line 837:
	\|-		\|-
	\|DataLogging=0		\|DataLogging=0
	\|This parameter (attribute=value) is ignored for MX prior to build 3018, it determines if (when you next start Cumulus) it will send enhanced information to a [[~~MXDiags_folder~~]] file about the data coming from your weather station. It is important to record here that, if you subsequently stop Cumulus, this parameter is reset to zero on exit.		\|This parameter (attribute=value) is ignored for MX prior to build 3018, it determines if (when you next start Cumulus) it will send enhanced information to a [[MXdiags_folder]] file about the data coming from your weather station. It is important to record here that, if you subsequently stop Cumulus, this parameter is reset to zero on exit.
	*0 = default of normal output		*0 = default of normal output
	*1 = Set it to 1 to enable the enhanced output to the log that aids debugging if there is a problem		*1 = Set it to 1 to enable the enhanced output to the log that aids debugging if there is a problem

Sfws: /* Section: FTP site */

2021-05-20T11:23:36Z

Section: FTP site

← Older revision		Revision as of 11:23, 20 May 2021
Line 1,264:		Line 1,264:
	=== Section: FTP site ===		=== Section: FTP site ===

			{{Template:WorkInProgressBanner}} MX development has added further parameters in this section, not yet documented below

	The parameters listed here are set either on [[MX_Administrative_Interface#Internet_Settings\|Internet Settings page]] or on [[MX_Administrative_Interface#Extra_Web_Files\|Extra Web Files page]].		The parameters listed here are set either on [[MX_Administrative_Interface#Internet_Settings\|Internet Settings page]] or on [[MX_Administrative_Interface#Extra_Web_Files\|Extra Web Files page]].

Line 1,296:		Line 1,298:
	\|-		\|-
	\|Host=		\|Host=
	\|''Leave blank, "'''Host='''", if you are not using ftp'', but simply creating the output files on your pc with a Copy instruction.		\|For 3.0.0 Steve Loft builds only: ''Leave blank, "'''Host='''", if you are not using ftp'', but simply creating the output files on your pc with a Copy instruction.

	This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site.		This is either the name, or the IP address, of the ftp server to which you connect when you upload pages to your web site.
	\|-		\|-
	\|Port=21		\|Port=21
	\|you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS i.e.FTPS (port=25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative ports.		\|you normally use either standard FTP (port=21), SSH for FTP i.e. SFTP (port=22), or SSL/TLS i.e.FTPS (port=990 normally, may be 25). If you get connection refused, messages in the MXdiags log, then you may need to try alternative ports.
	\|-		\|-
	\|Username=		\|Username=

Sfws: /* Section: Graphs */

2021-05-20T11:00:39Z

Section: Graphs

← Older revision		Revision as of 11:00, 20 May 2021
Line 1,503:		Line 1,503:

	=== Section: Graphs ===		=== Section: Graphs ===
	[[Template:WorkInProgressBanner]]		{{Template:WorkInProgressBanner}}

Sfws: /* Section: Graphs */

2021-05-20T11:00:20Z

Section: Graphs

← Older revision		Revision as of 11:00, 20 May 2021
Line 1,503:		Line 1,503:

	=== Section: Graphs ===		=== Section: Graphs ===
			[[Template:WorkInProgressBanner]]


	'''The following table ~~required~~ editing to bring it up to date, as further parameters ~~were~~ ~~added~~ at ~~release 3.10~~.~~1.'''~~ There are also some parameters (e.g. relating to moon) that do not apply to early releases, but nobody has indicated the starting version.		'''The following table requires checking. ''' It may require editing to bring it up to date, as further parameters may have been added. There are also some parameters (e.g. relating to moon) that do not apply to early releases, but nobody has indicated the starting version.
	{\| class="wikitable" border="1"		{\| class="wikitable" border="1"
	\|-		\|-

Sfws: /* Spike Removal */

2021-05-17T05:20:36Z

Spike Removal

← Older revision		Revision as of 05:20, 17 May 2021
Line 453:		Line 453:
	There are a lot of options in the [Station] section, so they have been sub-divided.		There are a lot of options in the [Station] section, so they have been sub-divided.

	==== Spike Removal ====		===== Spike Removal =====

	Which parameters are available from this section depends on release of MX being used, and which type of station you use.		Which parameters are available from this section depends on release of MX being used, and which type of station you use.