Migrating from Cumulus 1 to MX - Revision history

Sfws: corrected cross reference that was linking to text that has moved to different page

2022-05-26T09:33:44Z

corrected cross reference that was linking to text that has moved to different page

Sfws: /* dayfile.txt */

2022-04-09T15:31:54Z

dayfile.txt

← Older revision		Revision as of 15:31, 9 April 2022
Line 291:		Line 291:
	When Steve Loft designed Cumulus MX, he was able to learn from his experiences with both Cumulus 1 and Cumulus 2, so he decided to use dates to an ISO specification (ISO 8601 Data elements and interchange formats – Information interchange – Representation of dates and times), but in the local time zone of the particular user, and therefore log files are not [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=15167 backwards compatible].		When Steve Loft designed Cumulus MX, he was able to learn from his experiences with both Cumulus 1 and Cumulus 2, so he decided to use dates to an ISO specification (ISO 8601 Data elements and interchange formats – Information interchange – Representation of dates and times), but in the local time zone of the particular user, and therefore log files are not [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=15167 backwards compatible].

	===dayfile.txt===		==dayfile.txt==

	MX (except early releases) reads the whole of this file as it starts running, so all lines must use exactly the same format.		MX (except early releases) reads the whole of this file as it starts running, so all lines must use exactly the same format.

	====date format issue====		===date format issue===

	For MX (from release 3.5.4 onwards), the date separator specified for the locale when you run MX must be used in all lines of this file. Please see [[Amending_dayfile#Date_Separator_in_MX]] for more detail of what MX expects.		For MX (from release 3.5.4 onwards), the date separator specified for the locale when you run MX must be used in all lines of this file. Please see [[Amending_dayfile#Date_Separator_in_MX]] for more detail of what MX expects.
Line 313:		Line 313:
	It is all a bit technical, if MX expects "/", but you have "-" in some older lines. The complication comes because "-" may be used in value fields too, so you need to find a way of specifying a minus with two digits before it and two digits after it. For this correction you need to select '''Regular expression''' and then set '''Find what''' to "^([\d]{2})-([\d]{2})-" and '''Replace with''' to "$1/$2/". Please check this, as this was copied from a forum post by Mark Crossley and I have not verified it.		It is all a bit technical, if MX expects "/", but you have "-" in some older lines. The complication comes because "-" may be used in value fields too, so you need to find a way of specifying a minus with two digits before it and two digits after it. For this correction you need to select '''Regular expression''' and then set '''Find what''' to "^([\d]{2})-([\d]{2})-" and '''Replace with''' to "$1/$2/". Please check this, as this was copied from a forum post by Mark Crossley and I have not verified it.

	====time-stamp format issue====		===time-stamp format issue===

	The dayfile.txt contains time-stamps following any value that represents a highest or lowest in the day.		The dayfile.txt contains time-stamps following any value that represents a highest or lowest in the day.
Line 323:		Line 323:
	MX will only accept colon ":" separator, all dayfile.txt time-stamps must be in "HH:mm" format. You will need to edit your old lines if any use a different separator.		MX will only accept colon ":" separator, all dayfile.txt time-stamps must be in "HH:mm" format. You will need to edit your old lines if any use a different separator.

	====value format issues====		===value format issues===

	If you moved your Cumulus 1 installation from one windows pc to another, it is just possible that you might have a mix of "decimal comma" and "decimal point" in your values, or you might have changed the field separator (normally ";" or ","). Again, these must be consistent in all dayfile.txt lines for MX, and must match what is defined in the locale used.		If you moved your Cumulus 1 installation from one windows pc to another, it is just possible that you might have a mix of "decimal comma" and "decimal point" in your values, or you might have changed the field separator (normally ";" or ","). Again, these must be consistent in all dayfile.txt lines for MX, and must match what is defined in the locale used.

Sfws: /* Simplest migration */

2022-04-02T06:50:42Z

Simplest migration

← Older revision		Revision as of 06:50, 2 April 2022
Line 87:		Line 87:
	** [[Amending dayfile]] tells you about how MX is far more fussy about the content in [[dayfile.txt]]		** [[Amending dayfile]] tells you about how MX is far more fussy about the content in [[dayfile.txt]]
	** [[:Category:Ini Files\|.ini files]] explains how time-stamps are formatted differently in the extreme tracking files, and how MX prefers decimal points to decimal commas		** [[:Category:Ini Files\|.ini files]] explains how time-stamps are formatted differently in the extreme tracking files, and how MX prefers decimal points to decimal commas

			==Simplest migration==

			There is no harm in trying the following steps, but whether this simple approach works, really does depend on what parts of Cumulus functionality you actually use, and how you had your legacy Cumulus working, as each subsection below explains.

			# Copy the configuration files ('''Cumulus.ini''' and the optional '''strings.ini''') from the directory with Cumulus.exe in it to the directory with CumulusMX.exe in it
			# Copy all the [[:Category:Ini Files\|extreme tracking files]] and the [[:Category:Files with Comma Separated Values\|files with your your data]] in the old [[Data folder]] across to MX folder with same name
			# If you have files in the [[Reports folder]], copy them across to the MX folder of same name

	==File names==		==File names==

Sfws: /* value format issues= */ typo

2022-04-02T05:45:20Z

value format issues=: typo

← Older revision		Revision as of 05:45, 2 April 2022
Line 315:		Line 315:
	MX will only accept colon ":" separator, all dayfile.txt time-stamps must be in "HH:mm" format. You will need to edit your old lines if any use a different separator.		MX will only accept colon ":" separator, all dayfile.txt time-stamps must be in "HH:mm" format. You will need to edit your old lines if any use a different separator.

	====value format issues=====		====value format issues====

	If you moved your Cumulus 1 installation from one windows pc to another, it is just possible that you might have a mix of "decimal comma" and "decimal point" in your values, or you might have changed the field separator (normally ";" or ","). Again, these must be consistent in all dayfile.txt lines for MX, and must match what is defined in the locale used.		If you moved your Cumulus 1 installation from one windows pc to another, it is just possible that you might have a mix of "decimal comma" and "decimal point" in your values, or you might have changed the field separator (normally ";" or ","). Again, these must be consistent in all dayfile.txt lines for MX, and must match what is defined in the locale used.

Sfws: /* Configuration file */ add links

2021-08-29T03:09:46Z

Configuration file: add links

← Older revision		Revision as of 03:09, 29 August 2021
Line 111:		Line 111:

	MX's [[Cumulus.ini]] has different content to the legacy [[Cumulus.ini_(Cumulus_1)\|'''cumulus.ini''']]. From release 3.12.0,many more new settings were added, more settings were removed, and some parameters in the file were renamed. The first cross reference, in listing all the parameters, makes it clear which settings were introduced in the legacy software, and which MX release added new settings, this should help you to grasp how many new settings exist!		MX's [[Cumulus.ini]] has different content to the legacy [[Cumulus.ini_(Cumulus_1)\|'''cumulus.ini''']]. From release 3.12.0,many more new settings were added, more settings were removed, and some parameters in the file were renamed. The first cross reference, in listing all the parameters, makes it clear which settings were introduced in the legacy software, and which MX release added new settings, this should help you to grasp how many new settings exist!

			'''The [[MX_Administrative_Interface#Changing_Settings\|settings pages]] in MX, work differently to the [[Cumulus_Screenshots#Configuration_Menu_Screens\|settings screens]] in Cumulus 1. You need to click ''Save'' and (in many cases) stop and restart MX before changed settings take effect.'''

	Consequently, if you are migrating from the legacy software to MX now, it is best to rename your old '''cumulus.ini'' file so it is is not seen by MX. Let MX create a new configuration file with just the parameters it needs using the various [MX_Administrative_Interface#Changing_Settings\|settings pages in the admin interface]]. That will ensure you don't get muddled by parameters used for Cumulus 1 (but not for MX); and you do have all the parameters you do need, set correctly.		Consequently, if you are migrating from the legacy software to MX now, it is best to rename your old '''cumulus.ini'' file so it is is not seen by MX. Let MX create a new configuration file with just the parameters it needs using the various [MX_Administrative_Interface#Changing_Settings\|settings pages in the admin interface]]. That will ensure you don't get muddled by parameters used for Cumulus 1 (but not for MX); and you do have all the parameters you do need, set correctly.

Sfws: /* Migrating existing data files from legacy Cumulus to a recent build of MX */ Update for 3.10.0 onwards

2021-08-27T19:20:56Z

Migrating existing data files from legacy Cumulus to a recent build of MX: Update for 3.10.0 onwards

Show changes

Sfws: /* "data" folder */

2021-08-07T08:41:53Z

"data" folder

← Older revision		Revision as of 08:41, 7 August 2021
Line 202:		Line 202:
	* See [[#dayfile.txt]] later still on this page, and [[Amending dayfile]] page, for how you can ensure MX can read your existing dayfile.txt file		* See [[#dayfile.txt]] later still on this page, and [[Amending dayfile]] page, for how you can ensure MX can read your existing dayfile.txt file
	* See [[#Line terminators]] earlier on this page for some technical issues if MX is running on a different computer to your Cumulus 1 installation.		* See [[#Line terminators]] earlier on this page for some technical issues if MX is running on a different computer to your Cumulus 1 installation.

			===Standard log files and other log files===

			The [[Speciallog.txt]] file optionally used by the legacy Cumulus 1, is not used by MX.

			The [[Standard_log_files]] and any (optional) [[Extra Sensor Files]], from the legacy software can be transferred to your MX installation, but see [[#Start date]] earlier on this page, and [[Calculate Missing Values]] page to read about extra tasks you may need to do.

			MX extends these [[Monthly log files]] by adding [[Air_Link_Log.txt\|another optional set of files]].

	===Weather Diary===		===Weather Diary===

Sfws at 08:30, 7 August 2021

2021-08-07T08:30:48Z

← Older revision		Revision as of 08:30, 7 August 2021
Line 98:		Line 98:
	==Configuration file==		==Configuration file==

	MX's [[Cumulus.ini]] has different content to the legacy [[Cumulus.ini_(Cumulus_1)\|'''cumulus.ini''']].		MX's [[Cumulus.ini]] has different content to the legacy [[Cumulus.ini_(Cumulus_1)\|'''cumulus.ini''']]. From release 3.12.0,many more new settings were added, more settings were removed, and some parameters in the file were renamed. The first cross reference, in listing all the parameters, makes it clear which settings were introduced in the legacy software, and which MX release added new settings, this should help you to grasp how many new settings exist!

		⚫	Consequently, if you are migrating from the legacy software to MX now, it is best to rename your old '''cumulus.ini'' file so it is is not seen by MX. Let MX create a new configuration file with just the parameters it needs using the various [MX_Administrative_Interface#Changing_Settings\|settings pages in the admin interface]]. That will ensure you don't get muddled by parameters used for Cumulus 1 (but not for MX); and you do have all the parameters you do need, set correctly.

			===Configuration file naming restrictions===

	Cumulus 1 can recognise, in some circumstances, "cumulus1.ini", and other variants, not just "cumulus.ini".		Cumulus 1 can recognise, in some circumstances, "cumulus1.ini", and other variants, not just "cumulus.ini".

			MX only recognises "Cumulus.ini". The Windows operating system is not case sensitive for file names. All other operating systems require the first letter of the filename to be a capital, and the remainder to be lower case as shown.
	MX only recognises "Cumulus.ini".

			===Historical evolution of configuration file===
	The old approach for migration, was to copy across your existing file, and let MX ignore all the parameters that do not apply to it. To add the parameters that MX does need, you would then go to the [[MX_Administrative_Interface#Changing_Settings]] pages and work steadily through ALL the options. For any parameters that were not set by the admin interface (and there were many "read-only" parameters in early releases of MX), one assumed these also existed in Cumulus 1 and so were already in your file.

			The oldest approach for migration from the legacy software, was to copy across to MX your existing configuration file, and let MX ignore all the parameters that do not apply to it. This worked because the early MX releases had few new parameters, and mostly used the majority of the old parameters.
	At releases like 3.3.0 and 3.6.0, amongst others, there were changes to "read-only" parameters for MX. These could not be adjusted through the admin interface, and needed to be entered manually as listed on [[Cumulus.ini (MX 3.0.0 to 3.7.0)]] page. If you choose to migrate to an old MX release, to simplify some data file issues listed below, then refer to that page for the new parameters, and refer to [[Cumulus.ini (Cumulus 1)]] if you need to check if particular parameters were used by the legacy software. However, you should reuse your old file, and just use the admin interface to work through all settings pages and finalise the new settings.

			For any parameters that were not set by the admin interface (and there were many "read-only" parameters in early releases of MX), one assumed these also existed in Cumulus 1 (refer to [[Cumulus.ini (Cumulus 1)]]) and so were already in your file.
⚫	~~Substantial changes to changes were made from release 3.8.0 onwards, hence [[Cumulus.ini]] is a new page applicable from that release.~~ More changes were made in 3.10.0, and subsequent releases, as settings that ~~used~~ ~~to have~~ to be made directly in file were gradually moved to be advanced settings controlled in the admin interface. ~~From~~ ~~release 3.12.0~~,~~many~~ ~~more~~ ~~new~~ ~~settings were~~ added, ~~more~~ settings ~~were~~ ~~removed,~~ ~~and~~ ~~some~~ ~~parameters~~ in ~~the~~ ~~file were renamed.~~

			To add the few new parameters that MX did need (see [[Cumulus.ini (MX 3.0.0 to 3.7.0)]] page), you would then go to the [[MX_Administrative_Interface#Changing_Settings]] pages and work steadily through ALL the options.

			Retaining your old settings as far as possible simplified any migration of data files from your legacy installation into MX, because it ensured you kept to same unit selections, and same extra sensor selections.

			At releases like 3.3.0 and 3.6.0, amongst others, there were changes to "read-only" parameters for MX. These could not be adjusted through the admin interface, and needed to be entered manually into the '''Cumulus.ini''' file, as instructed on [[Cumulus.ini (MX 3.0.0 to 3.7.0)]] page.

			===Subsequent evolution of configuration file===

			Substantial changes to settings available were made from release 3.8.0 onwards. The content of the '''Cumulus.ini''' file changed drastically, with much deviation from the configuration file used in earlier releases (including for the legacy software), hence [[Cumulus.ini]] is a new page describing the settings, and the parameters appearing in the configuration file, applicable from that release.

		⚫	More changes were made in 3.10.0, and subsequent releases, as settings that previously had to be made directly in file were gradually moved to be advanced settings controlled in the admin interface. In addition, these releases, have added many new settings never encountered in your legacy software.

			For example the changes include the (advanced) ability to change the number of decimal places for storing derived values like daily rainfall, sea level pressure, and wind speeds.

			Changes to the [[New Default Web Site Information\|Default Web Site]] (diverging away from the [[Customised templates]] approach in the legacy software) and implementing the option to use (as was available in the legacy software, and the earliest MX beta, but then removed) a copy action instead of a file transfer action for [[Your Own Server]], has led to many,many new settings. Thus the advice has become abandon your old legacy software cumulus.ini file when you move to MX.

⚫	Consequently, if you are migrating from the legacy software to MX now, it is best to rename your old '''cumulus.ini'' file so it is is not seen by MX. Let MX create a new configuration file with just the parameters it needs using the various [MX_Administrative_Interface#Changing_Settings\|settings pages in the admin interface]]. That will ensure you don't get muddled by parameters used for Cumulus 1 (but not for MX); and you do have all the parameters you do need, set correctly.

	==Settings==		===Settings===

	The settings pages in Cumulus 1 and MX work differently:		The settings pages in Cumulus 1 and MX work differently:
	* for Cumulus 1 you choose to save changes by clicking OK,		* for Cumulus 1 you choose to save changes by clicking OK,
	* for MX changes are only saved when you click a '''Save''' button if one is provided.		* for MX changes are only saved when you click a '''Save''' button if one is provided.
			* The alarms page works slightly differently, with an "Update alarms" button.
	* If there is no Save button anywhere on the screen (as in Extra Web Files) then the setting is saved when you move to next field/line.		* If there is no Save button anywhere on the screen (as in Extra Web Files) then the setting is saved to configuration file when you move to next field/line, and acted on when you next restart MX.

	Be aware that you should restart MX after changing settings, as many settings are only read from file when MX starts.		Be aware that you should restart MX after changing many settings. This is because many settings are only written to configuration file, not yet to internal code, and such settings are only read from configuration file when MX starts. The developer is changing the code, so that in more cases edits on the settings pages do update the settings used by the code, as well as the file, but at time of writing there is no list of which settings work like that, and which require a restart.

	===Start date===		===Start date===
Line 133:		Line 153:
	=== Station connections===		=== Station connections===

	You can skip this ~~sub-section~~ if your weather station connects to mX either by ~~uSB~~ or by wireless connection.		You can skip this subsection if your weather station connects to MX either by USB or by wireless connection. It is relevant if your station connects by a serial connection and MX needs to be told which port. It also applies if the serial connection is converted to USB.

	If your weather station used a port to connect to Cumulus 1, that port was set on the settings screen as a number and stored in Cumulus.ini_(Cumulus_1) in the station section as a parameter in the format '''Port=n'''.		If your weather station used a port to connect to Cumulus 1, that port was set on the settings screen as a number and stored in [[Cumulus.ini_(Cumulus_1)]] in the station section as a parameter in the format '''Port=n'''.

	In Cumulus MX, as it runs on various operating systems, the port is specified using text (instead of a number), again you select it within settings, on Station settings page, but within [[Cumulus.ini]] in the station section the parameter is in the format '''Comport=tttttttt'''.		In Cumulus MX, as it runs on various operating systems, the port is specified using text (instead of a number), again you select it within settings, on Station settings page, but within [[Cumulus.ini]] in the station section the parameter is in the format '''Comport=tttttttt'''.

	If your old parameter had a value of '''3''', and you are still using Windows, the new setting would have value of '''COM3'''.		If your old parameter had a value of '''3''', and you are still using Windows, the new setting would have value of '''COM3''', i.e. serial port 3 now requires a "COM" prefix.

	A typical parameter value for other serial connecting devices might be "/dev/~~ttyUSB0~~".		A typical parameter value for other serial connecting devices might be "/dev/ttyUSB3" where the final digit will change depending on the new connection.

	===RG11 Rain gauge===		===RG11 Rain gauge===

Sfws: /* Introduction */

2021-08-06T08:59:56Z

Introduction

← Older revision		Revision as of 08:59, 6 August 2021
Line 3:		Line 3:
	=Introduction=		=Introduction=

	This page was inspired by this [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17749 update from Cumulus 1] forum topic. That post was made in January 2020, and therefore ~~the bulk of the text on this page~~ relates to Version 3.3.0, which was the MX release that was in use at the time.		This page was inspired by this [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17749 update from Cumulus 1] forum topic. That post was made in January 2020, and therefore relates to Version 3.3.0, which was the MX release that was in use at the time.

	<div style="background: LemonChiffon;padding:5px; margin:2px;">		<div style="background: LemonChiffon;padding:5px; margin:2px;">
	[[File:Crystal Clear info.png\|40px]] This page was last partially updated for the MX release in ~~July~~ ~~2020~~; that is no longer latest!		[[File:Crystal Clear info.png\|40px]] This page was last partially updated for the MX release available in June 2021; that is no longer latest!

	Appeal to contributors: Please ~~work through all MX release announcements and~~ work out ~~all the many~~ updates needed for this page, it ~~may even need~~ a ~~redesign~~ for more recent releases!		Appeal to contributors: Please work out any updates needed for this page, so it is kept correct for more recent releases!
	</div>		</div>


	You might want to read the related page at [[My_migration_from_C1_to_MX]] which describes how this worked in practice for release version 3.4.5 (build 3069).		You might want to read the related page at [[My_migration_from_C1_to_MX]] which describes how this worked in practice for release version 3.4.5 (build 3069).


	=Should I migrate to MX or not?=		=Should I migrate to MX or not?=

Sfws at 08:57, 6 August 2021

2021-08-06T08:57:16Z

Show changes

← Older revision		Revision as of 03:09, 29 August 2021
Line 111:		Line 111:

	MX's [[Cumulus.ini]] has different content to the legacy [[Cumulus.ini_(Cumulus_1)\|'''cumulus.ini''']]. From release 3.12.0,many more new settings were added, more settings were removed, and some parameters in the file were renamed. The first cross reference, in listing all the parameters, makes it clear which settings were introduced in the legacy software, and which MX release added new settings, this should help you to grasp how many new settings exist!		MX's [[Cumulus.ini]] has different content to the legacy [[Cumulus.ini_(Cumulus_1)\|'''cumulus.ini''']]. From release 3.12.0,many more new settings were added, more settings were removed, and some parameters in the file were renamed. The first cross reference, in listing all the parameters, makes it clear which settings were introduced in the legacy software, and which MX release added new settings, this should help you to grasp how many new settings exist!

			'''The [[MX_Administrative_Interface#Changing_Settings\|settings pages]] in MX, work differently to the [[Cumulus_Screenshots#Configuration_Menu_Screens\|settings screens]] in Cumulus 1. You need to click ''Save'' and (in many cases) stop and restart MX before changed settings take effect.'''

	Consequently, if you are migrating from the legacy software to MX now, it is best to rename your old '''cumulus.ini'' file so it is is not seen by MX. Let MX create a new configuration file with just the parameters it needs using the various [MX_Administrative_Interface#Changing_Settings\|settings pages in the admin interface]]. That will ensure you don't get muddled by parameters used for Cumulus 1 (but not for MX); and you do have all the parameters you do need, set correctly.		Consequently, if you are migrating from the legacy software to MX now, it is best to rename your old '''cumulus.ini'' file so it is is not seen by MX. Let MX create a new configuration file with just the parameters it needs using the various [MX_Administrative_Interface#Changing_Settings\|settings pages in the admin interface]]. That will ensure you don't get muddled by parameters used for Cumulus 1 (but not for MX); and you do have all the parameters you do need, set correctly.