Alltime.ini - Revision history

Sfws: typo

2021-06-08T15:46:45Z

typo

← Older revision		Revision as of 15:46, 8 June 2021
Line 2:		Line 2:


	= ~~{{Version badge 1}}~~ Which Cumulus 1 build are you using? =		= Which Cumulus 1 build are you using? =

			{{Version badge 1}}

	Cumulus maintains a number of 'all time records' for the station -- highs and lows and their timestamps for many of the readings. For ''more information'' on this file see in the '''Cumulus help''' file, in the section “The Data log files”.		Cumulus maintains a number of 'all time records' for the station -- highs and lows and their timestamps for many of the readings. For ''more information'' on this file see in the '''Cumulus help''' file, in the section “The Data log files”.
Line 34:		Line 35:


	= ~~[[File:Badge vMx.png]]~~ Cumulus MX =		= Cumulus MX =
			[[File:Badge vMx.png]]

	The alltime.ini file is located in the "data" sub-folder of the path where your CumulusMX.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit this '''alltime.ini''' file as described below.		The alltime.ini file is located in the "data" sub-folder of the path where your CumulusMX.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit this '''alltime.ini''' file as described below.

Sfws: Update category

2021-06-08T14:20:23Z

Update category

← Older revision		Revision as of 14:20, 8 June 2021
Line 1:		Line 1:
	The file now known as alltime.ini was originally in a ~~different~~ format as alltime.rec.		This page is about the file where all-time extreme records are tracked. The file now known as '''alltime.ini''', was originally in a binary format when it was named '''alltime.rec''' (and this latter file will be described first).

⚫	<div style="background: LemonChiffon;padding:5px; margin:2px;">
⚫	[[File:Crystal Clear info.png\|40px]] This page was written for the (legacy) Cumulus 1 software. It has been partially updated to cover MX, but that was for a MX release that is no longer latest!

		⚫	= {{Version badge 1}} Which Cumulus 1 build are you using? =
⚫	Please can a contributor ~~redesign this page and~~ update content, so it is more friendly for those using latest release, while still helping those using older MX releases and the legacy Cumulus software.
⚫	</div>


	= Introduction =

	Cumulus maintains a number of 'all time records' for the station -- highs and lows and their timestamps for many of the readings. For ''more information'' on this file see in the '''Cumulus help''' file, in the section “The Data log files”.		Cumulus maintains a number of 'all time records' for the station -- highs and lows and their timestamps for many of the readings. For ''more information'' on this file see in the '''Cumulus help''' file, in the section “The Data log files”.

		⚫	== Up to Build 920 (version 1.8.9) ==
⚫	==Which build are you using? ==

			The highs and lows were stored in a database file ('''alltime.rec'''), this was efficient for Cumulus 1 to read and update.
⚫	=== Up to Build 920 (version 1.8.9) ===

	~~The~~ ~~highs and lows were stored in a database~~ file ~~(alltime.rec), this~~ was ~~efficient for Cumulus 1 to read and update, but being~~ in binary code ~~made~~ it hard for any corrections to be made outside Cumulus.		As the file format was in binary code, it was hard for any corrections to be made outside Cumulus.

	Build 920 (28 Feb 2010) initiated the use of a log of changes to the "alltime.rec" records, called [[alltimelog.txt]], which can be found in the '''data''' folder. An entry is added to this file every time an all-time record changes, with details of the old and new records. This log can then be used to 'backtrack' if spurious data causes an all-time record to be broken incorrectly. ~~It is also a useful log of when records were actually broken.~~		Build 920 (28 Feb 2010) initiated the use of a log of changes to the "alltime.rec" records, called [[alltimelog.txt]], which can be found in the '''data''' folder. That file was in text format and it was easier to see changes to all-time extreme records there. It is also a useful log of when records were actually broken. An entry is added to this file every time an all-time record changes, with details of the old and new records. This log can then be used to 'backtrack' if spurious data causes an all-time record to be broken incorrectly.

	Builds 921, 922, and 923 were never released, so in fact the next change was seen in the next public release as described next.		Builds 921, 922, and 923 were never released, so in fact the next change was seen in the next public release as described next.

	=== From Build 924 (4 March 2010 beta version 1.8.9) ===		== From Build 924 (4 March 2010 beta version 1.8.9) ==

	Starting with Build 924 (still version 1.8.9~~, as said above in-between beta builds were never formally released~~) the Cumulus highs and lows and their timestamps are stored in a text file "alltime.ini" which can be easily edited if needed. The first time you run Build 924, or later build, of Cumulus 1 it will convert any '''alltime.rec''' file it finds in the data folder into an '''alltime.ini''' file and use that .ini file going forward.		Starting with Build 924 (still version 1.8.9) the Cumulus highs and lows and their timestamps are stored in a text file "alltime.ini" which can be easily edited if needed.

			The first time you run Build 924, if will look for a "cumulus\data\alltime.rec" file. If it finds that file, it will read it, converting the database records into the text format used by '''alltime.ini''' file, which it creates.
⚫	Although there were no changes to this file in the next few builds, ~~there were some issues, so then~~ another change was made as described next.

			If it does not find a "cumulus\data\alltime.rec" file, or it it finds both "cumulus\data\alltime.rec" file and '''alltime.ini''' file, then it simply uses the latter file whenever it needs to update an all-time extreme record.
⚫	=== From build 927 (8 March 2020 beta version 1.8.9)===

	~~The~~ ~~alltime.ini~~ ~~file~~ is ~~now~~ ~~explicitly~~ ~~located~~ in ~~the~~ ~~"data"~~ ~~sub-~~folder of the ~~path~~ where ~~your~~ ~~Cumulus.exe~~ is ~~installed.~~ If ~~you~~ ~~cannot~~ find the file [[FAQ#I_can.E2.80.99t_find_my_data_files.21\|see this FAQ]].		There was a major issue with this change, some people installed Cumulus 1 into a write protected folder (C:\Program Files) and in this case with build 924 Microsoft Windows might create the new file in a folder where writing was permitted, meaning Cumulus could not find the file when it tried to read/update it. Please [[FAQ#I_can.E2.80.99t_find_my_data_files.21\|see this FAQ]].

		⚫	Although there were no changes to this file in the next few builds, another change was made as described next.
	=== Cumulus MX ===

		⚫	== From build 927 (8 March 2020 beta version 1.8.9)==
⚫	The alltime.ini file is located in the "data" sub-folder of the path where your ~~Cumulus~~.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit this '''alltime.ini''' file as described below.

			The alltime.ini file is now explicitly located in the "data" sub-folder of the path where your Cumulus.exe is installed, to stop Microsoft Windows relocating it.


			= [[File:Badge vMx.png]] Cumulus MX =

		⚫	The alltime.ini file is located in the "data" sub-folder of the path where your CumulusMX.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit this '''alltime.ini''' file as described below.

	Just as the sections in the file varied with different Cumulus 1 versions, so in MX a new [FeelsLike] section was added by version 3.6.0.		Just as the sections in the file varied with different Cumulus 1 versions, so in MX a new [FeelsLike] section was added by version 3.6.0.

⚫	== Format of the file ==
	The format consists of a number of sections (section title is delimited by square brackets [...]), with each section having a number of properties (consisting of attribute name, an equals sign and a value) each on a separate line. Blank lines can be added for readability, they are ignored in these .ini type log files.

			== Important Note==
	[[File:Badge vMx.png]]Decimal formatting always uses a period/full stop in Cumulus MX. Cumulus MX shows date/time in ISO 8601 format of "yyyy-MM-ddTHH:mm:ss" (using the net specifiers that MX uses).

		⚫	<div style="background: LemonChiffon;padding:5px; margin:2px;">
		⚫	[[File:Crystal Clear info.png\|40px]] This page was written for the (legacy) Cumulus 1 software. It has been partially updated to cover MX, but that was for a MX release that is no longer latest!

		⚫	Please can a contributor update content, so it is more friendly for those using latest release, while still helping those using older MX releases and the legacy Cumulus software.
		⚫	</div>

		⚫	= Format of the file =

			This is as described at [[:Category:Ini_Files]], where some differences between the legacy Cumulus and MX are noted. Therefore if you use decimal commas and are migrating this '''alltime.ini''' file from Cumulus 1 to MX, you need to do an edit so all the values entries are converted to use a full stop as decimal separator.
	[[File:Badge v1.png]]Date, Time and Decimal formatting is as per your regional settings on the PC running Cumulus.

	Thus if you want to swap from Cumulus 1 to Cumulus MX, and you previously used a comma as your decimal separator (e.g.12,3) you will copy your existing Cumulus 1 "data" folder to within your MX installation, but you then need to manually edit your '''alltime.ini''' file so all the values entries are converted to use a full stop as decimal separator. The following table shows just one section from the file, that dealing with wind, as an example of the two formats with the Cumulus 1 side showing use of the comma that MX will not accept.		The following table shows just one section from the file, that dealing with wind, as an example of the two formats with the Cumulus 1 side showing use of the comma that MX will not accept.

	You do not need to edit the date/time entries as MX can read those in Cumulus 1 format, they will only change in "alltime.ini" when a new all-time extreme occurs and MX rewrites the file.		You do not need to edit the date/time entries as MX can read those in Cumulus 1 format, they will only change in "alltime.ini" when a new all-time extreme occurs and MX rewrites the file.
Line 163:		Line 172:


	[[Category:~~Log~~ Files]]		[[Category:Ini Files]]

Sfws at 10:23, 6 April 2021

2021-04-06T10:23:24Z

← Older revision		Revision as of 10:23, 6 April 2021
Line 1:		Line 1:
	The file now known as alltime.ini was originally in a different format as alltime.rec.		The file now known as alltime.ini was originally in a different format as alltime.rec.

⚫	== Introduction ==
			<div style="background: LemonChiffon;padding:5px; margin:2px;">
			[[File:Crystal Clear info.png\|40px]] This page was written for the (legacy) Cumulus 1 software. It has been partially updated to cover MX, but that was for a MX release that is no longer latest!

			Please can a contributor redesign this page and update content, so it is more friendly for those using latest release, while still helping those using older MX releases and the legacy Cumulus software.
			</div>


		⚫	= Introduction =

	Cumulus maintains a number of 'all time records' for the station -- highs and lows and their timestamps for many of the readings. For ''more information'' on this file see in the '''Cumulus help''' file, in the section “The Data log files”.		Cumulus maintains a number of 'all time records' for the station -- highs and lows and their timestamps for many of the readings. For ''more information'' on this file see in the '''Cumulus help''' file, in the section “The Data log files”.

			==Which build are you using? ==

	=== Up to Build 920 (version 1.8.9) ===		=== Up to Build 920 (version 1.8.9) ===

	The highs and lows were stored in a database file (alltime.rec), this was efficient for Cumulus 1 to read and update, but being in binary code made it hard for any corrections to be made outside Cumulus.		The highs and lows were stored in a database file (alltime.rec), this was efficient for Cumulus 1 to read and update, but being in binary code made it hard for any corrections to be made outside Cumulus.
	Build 920 (28 Feb 2010) initiated the use of a log of changes to the "alltime.rec" records, called [[alltimelog.txt]], which can be found in the '''data''' folder. An entry is added to this file every time an all-time record changes, with details of the old and new records. This log can then be used to 'backtrack' if spurious data causes an all-time record to be broken incorrectly. It is also a useful log of when records were actually broken.		Build 920 (28 Feb 2010) initiated the use of a log of changes to the "alltime.rec" records, called [[alltimelog.txt]], which can be found in the '''data''' folder. An entry is added to this file every time an all-time record changes, with details of the old and new records. This log can then be used to 'backtrack' if spurious data causes an all-time record to be broken incorrectly. It is also a useful log of when records were actually broken.
Line 64:		Line 75:

	== Editing this log file ==		== Editing this log file ==

			For full details see [[Correcting Extremes]] page.

	It is possible that rogue values read from your weather station will cause this log file to show an incorrect extreme. As mentioned earlier, there is a log of changes to the "alltime.ini" records, called [[alltimelog.txt]], so look at that to see when your rogue value was processed and what was the previous extreme that you should reset to in "alltime.ini".		It is possible that rogue values read from your weather station will cause this log file to show an incorrect extreme. As mentioned earlier, there is a log of changes to the "alltime.ini" records, called [[alltimelog.txt]], so look at that to see when your rogue value was processed and what was the previous extreme that you should reset to in "alltime.ini".

Sfws: /* Editing alltime.ini within Cumulus */

2020-06-09T15:07:09Z

Editing alltime.ini within Cumulus

← Older revision		Revision as of 15:07, 9 June 2020
Line 79:		Line 79:
	For Cumulus MX the editor is found in the admin interface.		For Cumulus MX the editor is found in the admin interface.

	Both Cumulus editors allow you to read from the [[dayfile.txt\|daily log]] or the [[~~Monthly_log_files~~]], in case you created rogue values there first as advised above. ~~In the cumulus 1 editor you can click to copy figures across, in the MX editor you can only manually overwrite with the revised figure.~~		*Both Cumulus editors allow you to read from the [[dayfile.txt\|daily log]] or the monthly [[Standard_log_files]], in case you created rogue values there first as advised above.
			**In the cumulus 1 editor you can click to copy figures across,
			**in the MX editor you can only manually overwrite with the revised figure.

	=== Editing alltime.ini outside Cumulus ===		=== Editing alltime.ini outside Cumulus ===

Sfws: /* Editing alltime.ini within Cumulus */

2020-05-18T15:29:20Z

Editing alltime.ini within Cumulus

← Older revision		Revision as of 15:29, 18 May 2020
Line 71:		Line 71:
	=== Editing alltime.ini within Cumulus ===		=== Editing alltime.ini within Cumulus ===

	~~Expanding~~ ~~what~~ it ~~says in FAQ: [[FAQ#How_do_I_correct_my_all-time_.28or_monthly.29_records.3F]], the stored~~ values ~~can be~~ corrected ~~using~~ the ~~''All~~ ~~time~~ ~~records'' screen on the '''Edit''' menu and this Cumulus editor allows you to read from the [[dayfile.txt\|~~daily log]] or ~~the [[Monthly_log_files]]. Therefore~~, ~~normally~~ ~~any rogue values are corrected in these source files, and~~ resulting lows and highs copied across to ~~the~~ all time log using the in-built editor. However, you can also just edit any low, high or timestamp manually looking at [[Alltimelog.txt]] for current and previous values.		Remember, normally any rogue values are corrected in the monthly or daily log files first, and then resulting lows and highs are copied across to this all time log file using the in-built editor. However, you can also just edit any low, high or timestamp in this log file manually after looking at [[Alltimelog.txt]] for current and previous values.

			Both Cumulus 1 and MX have internal editors for this file.

			Expanding what it says in FAQ: [[FAQ#How_do_I_correct_my_all-time_.28or_monthly.29_records.3F]], the stored values can be corrected in Cumulus 1 using the ''All time records'' screen on the '''Edit''' menu.

			For Cumulus MX the editor is found in the admin interface.

			Both Cumulus editors allow you to read from the [[dayfile.txt\|daily log]] or the [[Monthly_log_files]], in case you created rogue values there first as advised above. In the cumulus 1 editor you can click to copy figures across, in the MX editor you can only manually overwrite with the revised figure.

	=== Editing alltime.ini outside Cumulus ===		=== Editing alltime.ini outside Cumulus ===

Sfws: /* How alltime.ini is used */

2020-05-18T15:21:56Z

How alltime.ini is used

← Older revision		Revision as of 15:21, 18 May 2020
Line 59:		Line 59:
	== How alltime.ini is used ==		== How alltime.ini is used ==

	If you restart Cumulus during the day it will read this file at startup, so it can resume tracking extremes of the key parameters starting from latest stored values in alltime.ini. Equally, if you close Cumulus during the day it will write the final values for highs and lows and their timestamps to alltime.ini as part of the close down process.		If you restart Cumulus 1 during the day it will read this file at startup, so it can resume tracking extremes of the key parameters starting from latest stored values in alltime.ini. Equally, if you close Cumulus 1 during the day it will write the final values for highs and lows and their timestamps to alltime.ini as part of the close down process. Remember, while Cumulus 1 is running, the values shown in the table will usually be up to date, but there may be some time lag as it can hold values in an internal memory.


			For Cumulus MX, the developers have not documented how it works, and I have not examined the code to this detail, but I believe it reads this file at start up and updates the file when necessary as it processes the various reads from your weather station. I saw no evidence of it being featured in the close down process.

	== Editing this log file ==		== Editing this log file ==
	It is possible that rogue values read from your weather station will cause this log file to show an incorrect extreme. As mentioned earlier, there is a log of changes to the "alltime.ini" records, called [[alltimelog.txt]], so look at that to see when your rogue value was processed and what was the previous extreme that you should reset to in "alltime.ini".		It is possible that rogue values read from your weather station will cause this log file to show an incorrect extreme. As mentioned earlier, there is a log of changes to the "alltime.ini" records, called [[alltimelog.txt]], so look at that to see when your rogue value was processed and what was the previous extreme that you should reset to in "alltime.ini".

Sfws: /* Cumulus MX */

2020-05-18T15:14:38Z

Cumulus MX

← Older revision		Revision as of 15:14, 18 May 2020
Line 22:		Line 22:
	=== Cumulus MX ===		=== Cumulus MX ===

	The alltime.ini file is located in the "data" sub-folder of the path where your Cumulus.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit this '''alltime.ini''' file as described ~~in next section~~.		The alltime.ini file is located in the "data" sub-folder of the path where your Cumulus.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit this '''alltime.ini''' file as described below.

	Just as the sections in the file varied with different Cumulus 1 versions, so in MX a new [FeelsLike] section was added by version 3.6.0.		Just as the sections in the file varied with different Cumulus 1 versions, so in MX a new [FeelsLike] section was added by version 3.6.0.

Sfws: /* Cumulus MX */

2020-05-18T15:14:13Z

Cumulus MX

← Older revision		Revision as of 15:14, 18 May 2020
Line 22:		Line 22:
	=== Cumulus MX ===		=== Cumulus MX ===

	The alltime.ini file is located in the "data" sub-folder of the path where your Cumulus.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit ~~each~~ '''.ini''' file as described in next section.		The alltime.ini file is located in the "data" sub-folder of the path where your Cumulus.exe is installed. If you are moving to MX from Cumulus 1, you can copy the contents of the Cumulus 1 "data" folder into the MX "data" folder, but you will need to edit this '''alltime.ini''' file as described in next section.

	Just as the sections in the file varied with different Cumulus 1 versions, so in MX a new [FeelsLike] section was added by version 3.6.0.		Just as the sections in the file varied with different Cumulus 1 versions, so in MX a new [FeelsLike] section was added by version 3.6.0.

Sfws: /* From Build 924 (4 March 2010 beta version 1.8.9) */

2020-05-18T15:13:31Z

From Build 924 (4 March 2010 beta version 1.8.9)

← Older revision		Revision as of 15:13, 18 May 2020
Line 13:		Line 13:

	Starting with Build 924 (still version 1.8.9, as said above in-between beta builds were never formally released) the Cumulus highs and lows and their timestamps are stored in a text file "alltime.ini" which can be easily edited if needed. The first time you run Build 924, or later build, of Cumulus 1 it will convert any '''alltime.rec''' file it finds in the data folder into an '''alltime.ini''' file and use that .ini file going forward.		Starting with Build 924 (still version 1.8.9, as said above in-between beta builds were never formally released) the Cumulus highs and lows and their timestamps are stored in a text file "alltime.ini" which can be easily edited if needed. The first time you run Build 924, or later build, of Cumulus 1 it will convert any '''alltime.rec''' file it finds in the data folder into an '''alltime.ini''' file and use that .ini file going forward.

			Although there were no changes to this file in the next few builds, there were some issues, so then another change was made as described next.

	=== From build 927 (8 March 2020 beta version 1.8.9)===		=== From build 927 (8 March 2020 beta version 1.8.9)===

Sfws: /* From Build 924 (4 March 2010 beta version 1.8.9) */

2020-05-18T15:12:00Z

From Build 924 (4 March 2010 beta version 1.8.9)

← Older revision		Revision as of 15:12, 18 May 2020
Line 12:		Line 12:
	=== From Build 924 (4 March 2010 beta version 1.8.9) ===		=== From Build 924 (4 March 2010 beta version 1.8.9) ===

	Starting with Build 924 (version 1.8.9) the Cumulus highs and lows and their timestamps are stored in a text file "alltime.ini" which can be easily edited if needed. The first time you run Build 924, or later build, of Cumulus 1 it will convert any '''alltime.rec''' file it finds in the data folder into an '''alltime.ini''' file and use that .ini file going forward.		Starting with Build 924 (still version 1.8.9, as said above in-between beta builds were never formally released) the Cumulus highs and lows and their timestamps are stored in a text file "alltime.ini" which can be easily edited if needed. The first time you run Build 924, or later build, of Cumulus 1 it will convert any '''alltime.rec''' file it finds in the data folder into an '''alltime.ini''' file and use that .ini file going forward.

	=== From build 927 (8 March 2020 beta version 1.8.9)===		=== From build 927 (8 March 2020 beta version 1.8.9)===