MX Administrative Interface - Revision history

NeilThomas: /* Charts */

2024-10-31T16:46:01Z

Charts

← Older revision		Revision as of 16:46, 31 October 2024
Line 55:		Line 55:
	===Charts===		===Charts===

	[[Highcharts - Recent\|Recent]], Selectachart, Select-a-~~Periodand~~ [[Highcharts - Historic\|historic]] graphs		[[Highcharts - Recent\|Recent]], Selectachart, Select-a-Period and [[Highcharts - Historic\|historic]] graphs

	===Today/yesterday===		===Today/yesterday===

NeilThomas: /* Charts */

2024-10-31T16:45:41Z

Charts

← Older revision		Revision as of 16:45, 31 October 2024
Line 55:		Line 55:
	===Charts===		===Charts===

	[[Highcharts - Recent\|Recent]], Selectachart, ~~and~~ [[Highcharts - Historic\|historic]] graphs		[[Highcharts - Recent\|Recent]], Selectachart, Select-a-Periodand [[Highcharts - Historic\|historic]] graphs

	===Today/yesterday===		===Today/yesterday===

NeilThomas: /* Dashboard */

2024-10-31T16:44:32Z

Dashboard

← Older revision		Revision as of 16:44, 31 October 2024
Line 43:		Line 43:
	===Dashboard===		===Dashboard===

	Mix of ~~tables~~ and gauges to show current conditions, and alarms		Mix of panels of text and gauges to show current conditions, and alarms

	===Now===		===Now===

NeilThomas: /* How to see and use the Admin Interface */

2024-10-31T16:41:10Z

How to see and use the Admin Interface

← Older revision		Revision as of 16:41, 31 October 2024
Line 31:		Line 31:
	Having set the station type, and other settings, you will need stop Cumulus MX and start it again.		Having set the station type, and other settings, you will need stop Cumulus MX and start it again.

	If you have chosen to download and use the alternative Admin Interface (AI) it will be available using the url: <tt>http://localhost:8998/~~ai.cmx~~/</tt>. All the information on this page also applies to the AI. For other information on the AI visit the [[Alternative_Interface\|Alternative Interface]] page.		If you have chosen to download and use the alternative Admin Interface (AI) it will be available using the url: <tt>http://localhost:8998/ai2/</tt>. All the information on this page also applies to the AI. For other information on the AI visit the [[Alternative_Interface\|Alternative Interface]] page.

	=What does the admin interface contain?=		=What does the admin interface contain?=

NeilThomas: /* How to see and use the Admin Interface */

2021-12-31T11:36:59Z

How to see and use the Admin Interface

← Older revision		Revision as of 11:36, 31 December 2021
Line 30:		Line 30:

	Having set the station type, and other settings, you will need stop Cumulus MX and start it again.		Having set the station type, and other settings, you will need stop Cumulus MX and start it again.

			If you have chosen to download and use the alternative Admin Interface (AI) it will be available using the url: <tt>http://localhost:8998/ai.cmx/</tt>. All the information on this page also applies to the AI. For other information on the AI visit the [[Alternative_Interface\|Alternative Interface]] page.

	=What does the admin interface contain?=		=What does the admin interface contain?=

Sfws: /* The MQTT interface */ Corrected link

2021-07-22T19:28:32Z

The MQTT interface: Corrected link

← Older revision		Revision as of 19:28, 22 July 2021
Line 98:		Line 98:
	== The MQTT interface ==		== The MQTT interface ==

	Until this section is written, please see [[Cumulus.ini#MQTT]] for the information you can put into settings, and where to enter it.		Until this section is written, please see [[Cumulus.ini (MX 3.0.0 to 3.7.0)#MQTT]] for the information you can put into settings, and where to enter it.

	== The Data Log Viewing and Editing interface ==		== The Data Log Viewing and Editing interface ==

Sfws: /* NOAA report settings */ update link

2021-07-21T02:39:27Z

NOAA report settings: update link

← Older revision		Revision as of 02:39, 21 July 2021
Line 621:		Line 621:
	[[File:NOAA settings.png\|right \| 200 px]]		[[File:NOAA settings.png\|right \| 200 px]]

	The various settings available on this screen are explained [[Cumulus.ini#~~Section:_NOAA~~\|here]].		The various settings available on this screen are explained [[Cumulus.ini#Optional_Report_Settings\|here]].

	Just a quick reminder here that while Cumulus 1 is case insensitive for the code for the different ways to specify a month, MX only accepts upper case ('MM' for digits, 'MMM' for 3 letter month etc.), read more about [[Reports_folder#NOAA_style_Report_Naming\|the naming here]].		Just a quick reminder here that while Cumulus 1 is case insensitive for the code for the different ways to specify a month, MX only accepts upper case ('MM' for digits, 'MMM' for 3 letter month etc.), read more about [[Reports_folder#NOAA_style_Report_Naming\|the naming here]].

Sfws: /* Changing Settings */

2021-06-15T05:21:56Z

Changing Settings

← Older revision		Revision as of 05:21, 15 June 2021
Line 213:		Line 213:
	If you attempt to set these settings by directly editing the file where they are stored, there is a danger of either making a typo or of choosing an illegal value for a particular attribute.		If you attempt to set these settings by directly editing the file where they are stored, there is a danger of either making a typo or of choosing an illegal value for a particular attribute.

	For older MX releases, some '''read only''' settings can not be found in any of the setting screens, for these MX cannot set the values, it can only read them. As MX cannot set the values, you need to edit the [[Cumulus.ini(MX_3.0.0_to_3.9.7~~)\|Cumulus~~.~~ini file (up to 3.9.7~~)]] directly, and the referenced Wiki page identifies read-only settings that can only be adjusted by adding parameters directly in the file. The configuration article lists the read-write settings as well, and tells you what values are accepted for those attributes, and also explains some of the differences in the settings available between Cumulus 1 and MX.		For older MX releases, some '''read only''' settings can not be found in any of the setting screens, for these MX cannot set the values, it can only read them. As MX cannot set the values, you need to edit the [[Cumulus.ini (MX_3.0.0_to_3.7.0)]] directly, and the referenced Wiki page identifies read-only settings that can only be adjusted by adding parameters directly in the file. The configuration article lists the read-write settings as well, and tells you what values are accepted for those attributes, and also explains some of the differences in the settings available between Cumulus 1 and MX.

	'''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (The developer has not provided a list anywhere of which settings do, and which do not, take effect immediently, although sometimes a release notice mentions this for a new setting) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the read-write settings in [[Cumulus.ini]], and when you restart it it uses the read-only, and read-write, settings it reads from that file.		'''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (The developer has not provided a list anywhere of which settings do, and which do not, take effect immediently, although sometimes a release notice mentions this for a new setting) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the read-write settings in [[Cumulus.ini]], and when you restart it it uses the read-only, and read-write, settings it reads from that file.

Sfws: Making clearer which sections are out of date

2021-05-24T12:09:00Z

Making clearer which sections are out of date

← Older revision		Revision as of 12:09, 24 May 2021
Line 1:		Line 1:

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

⚫	Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for ~~each~~ section.

⚫	~~For example~~ recent releases have totally changed the content of all settings pages in the admin interface.

⚫	~~Consequently~~, the whole page may even need either a replacement (set of) ~~page(s)~~, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
⚫	</div>



Line 15:		Line 6:

	This Wiki page has the title "MX administrative interface". That name is fully descriptive of the purpose of the functionality documented on this page. In subsequent references this is shortened to "admin interface".		This Wiki page has the title "MX administrative interface". That name is fully descriptive of the purpose of the functionality documented on this page. In subsequent references this is shortened to "admin interface".

			Put simply this means the various pages you see in a browser that allow you to look at weather data and change settings.

	When Steve Loft made his original cumulus software (legacy cumulus 1) available for others to use, it was natural for him to use "user interface" as a collective term for all the [[Cumulus_Screenshots\|various screens]] that he included with that software.		When Steve Loft made his original cumulus software (legacy cumulus 1) available for others to use, it was natural for him to use "user interface" as a collective term for all the [[Cumulus_Screenshots\|various screens]] that he included with that software.
Line 206:		Line 199:
	Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for these sections, they may even need a redesign so it can correctly cover both past and more recent releases!		Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for these sections, they may even need a redesign so it can correctly cover both past and more recent releases!
	</div>		</div>
	All settings are stored in [[Cumulus.ini]], so when you stop and restart MX, it can continue without you entering settings again.		All settings are stored in [[Cumulus.ini]], so when you stop and restart MX, it can continue without you entering settings again. On that linked page, the settings are explained for each settings page, explaining which entry in the configuration file is affected.

	Adjusting the majority of the settings is best done using these MX "admin interface" screens simply because for some settings the interface does validation (whilst editing the file directly could introduce invalid settings), you will see that '''Settings''' is the penultimate option in the navigation bar, and it has a drop down for the various settings screens that are now described. [[File:Settings Menu.png\|right]]		Adjusting the majority of the settings is best done using these MX "admin interface" screens simply because for some settings the interface does validation (whilst editing the file directly could introduce invalid settings), you will see that '''Settings''' is the penultimate option in the navigation bar, and it has a drop down for the various settings screens that are now described. [[File:Settings Menu.png\|right]]
Line 220:		Line 213:
	If you attempt to set these settings by directly editing the file where they are stored, there is a danger of either making a typo or of choosing an illegal value for a particular attribute.		If you attempt to set these settings by directly editing the file where they are stored, there is a danger of either making a typo or of choosing an illegal value for a particular attribute.

	~~There~~ ~~are~~ ~~however~~ some '''read only''' settings ~~that~~ can not be found in any of the setting screens, for these MX cannot set the values, it can only read them. As MX cannot set the values, you need to edit the [[Cumulus.ini]] file directly, and the referenced Wiki page identifies read-only settings that can only be adjusted by adding parameters directly in the file. The configuration article lists the read-write settings as well, and tells you what values are accepted for those attributes, and also explains some of the differences in the settings available between Cumulus 1 and MX.		For older MX releases, some '''read only''' settings can not be found in any of the setting screens, for these MX cannot set the values, it can only read them. As MX cannot set the values, you need to edit the [[Cumulus.ini(MX_3.0.0_to_3.9.7)\|Cumulus.ini file (up to 3.9.7)]] directly, and the referenced Wiki page identifies read-only settings that can only be adjusted by adding parameters directly in the file. The configuration article lists the read-write settings as well, and tells you what values are accepted for those attributes, and also explains some of the differences in the settings available between Cumulus 1 and MX.

	'''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (The developer has not provided a list anywhere of which settings do, and which do not, take effect immediently, although sometimes a release notice mentions this for a new setting) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the read-write settings in [[Cumulus.ini]], and when you restart it it uses the read-only, and read-write, settings it reads from that file.		'''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (The developer has not provided a list anywhere of which settings do, and which do not, take effect immediently, although sometimes a release notice mentions this for a new setting) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the read-write settings in [[Cumulus.ini]], and when you restart it it uses the read-only, and read-write, settings it reads from that file.
Line 791:		Line 784:
	# Now move down the screen and click the '''Save''' button, and wait for MX to pop up '''Settings Saved''' message.		# Now move down the screen and click the '''Save''' button, and wait for MX to pop up '''Settings Saved''' message.

	===== Another table ~~unpdated~~ at an interval measured in seconds =====		===== Another table updated at an interval measured in seconds =====

	*6. ''Custom upload - seconds interval''		*6. ''Custom upload - seconds interval''
Line 801:		Line 794:

	=== Alarms ===		=== Alarms ===


		⚫	<div style="background: LemonChiffon;padding:5px; margin:2px;">
		⚫	[[File:Crystal Clear info.png\|40px]] This section was last updated for the MX release in July 2020; 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 section,

		⚫	recent releases have totally changed the content of all settings pages in the admin interface,

		⚫	consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
		⚫	</div>


	This is identical to Cumulus 1 functionality, apart from using a new default location for the files "\CumulusMX\interface\sounds", and the list of alarms available is extended in MX compared to Cumulus 1.		This is identical to Cumulus 1 functionality, apart from using a new default location for the files "\CumulusMX\interface\sounds", and the list of alarms available is extended in MX compared to Cumulus 1.
Line 809:		Line 814:

	=== FTP Now ===		=== FTP Now ===


			<div style="background: LemonChiffon;padding:5px; margin:2px;">
			[[File:Crystal Clear info.png\|40px]] This section was last updated for the MX release in July 2020; 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 section,

			recent releases have totally changed the content of all settings pages in the admin interface,

			consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
			</div>


	This is similar to the option in the file menu of Cumulus 1 to do an update now. Depending on which build of MX you are using, the functionality varies. On latest build it does whatever updates are set up to happen at normal updating interval whether these are by FTP to your web site, or by copying files between local and remote filenames with path (although both could be on same device).		This is similar to the option in the file menu of Cumulus 1 to do an update now. Depending on which build of MX you are using, the functionality varies. On latest build it does whatever updates are set up to happen at normal updating interval whether these are by FTP to your web site, or by copying files between local and remote filenames with path (although both could be on same device).

Sfws: /* What does the admin interface contain? */

2021-05-23T09:18:40Z

What does the admin interface contain?

← Older revision		Revision as of 09:18, 23 May 2021
Line 44:		Line 44:
	The admin interface web pages that Mark has either added, or redesigned significantly, are those that allow you to edit the data log (.txt) files, to edit the extreme record (.ini) log files, and to input and modify configuration settings. These have changed a lot as Mark has developed MX, and the documentation of these later may not be kept up to date with the latest changes.		The admin interface web pages that Mark has either added, or redesigned significantly, are those that allow you to edit the data log (.txt) files, to edit the extreme record (.ini) log files, and to input and modify configuration settings. These have changed a lot as Mark has developed MX, and the documentation of these later may not be kept up to date with the latest changes.

			==Weather pages==

			===Dashboard===

			Mix of tables and gauges to show current conditions, and alarms

			===Now===

			Current data in tabular format

			===Gauges===

			Current data in [[SteelSeries Gauges]] format

			===Charts===

			[[Highcharts - Recent\|Recent]], Selectachart, and [[Highcharts - Historic\|historic]] graphs

			===Today/yesterday===

			Data for today-so-far, and yesterday in tabular format

			===Records===

			Data for this month-to-date, this year-to-date, all January months ... all December months, and all-time in tabular format

	== The API interface ==		== The API interface ==

← Older revision		Revision as of 02:39, 21 July 2021
Line 621:		Line 621:
	[[File:NOAA settings.png\|right \| 200 px]]		[[File:NOAA settings.png\|right \| 200 px]]

	The various settings available on this screen are explained [[Cumulus.ini#~~Section:_NOAA~~\|here]].		The various settings available on this screen are explained [[Cumulus.ini#Optional_Report_Settings\|here]].

	Just a quick reminder here that while Cumulus 1 is case insensitive for the code for the different ways to specify a month, MX only accepts upper case ('MM' for digits, 'MMM' for 3 letter month etc.), read more about [[Reports_folder#NOAA_style_Report_Naming\|the naming here]].		Just a quick reminder here that while Cumulus 1 is case insensitive for the code for the different ways to specify a month, MX only accepts upper case ('MM' for digits, 'MMM' for 3 letter month etc.), read more about [[Reports_folder#NOAA_style_Report_Naming\|the naming here]].