The Alternative Interface (ai.cmx): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (Remove unwanted content)
Tags: Mobile edit Mobile web edit
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TOCright}}
{{TOCright}}
== An Alternative (additional) Interface ==
== The Alternative Interface ==
[[Category:Cumulus MX]]


== Overview ==


The Alternative Interface (AI) is currently provided as an '''addition''' to the existing Interface for CumulusMX.
==IMPORTANT NOTICE==


The existing Interface is maintained by Mark and will always provide all the tools needed to manage your installation of your weather station, The '''AI''' can be used as an alternative except immediately after an upgrade that has added new features to the interface as these may not yet be implemented on the AI (although every effort is made to do this).
Due to issues with Alpaca Forms and the AI please DO NOT use any of the following AI pages to configure your station:
Configuration Wizard, Program Setup, Station Setup, Internet Setup,
Third Party Settings, Extra Sensor Settings, Calibration Settings, NOAA Settings,
MySQL Settings, Custom Logs, Custom Alarms, Display Options or
Locale Settings.
This issue has been resolved for the upcoming release of CumulusMX.


In the near future it may replace the existing Interface but this is still under discussion.
== Overview ==

The Alternative Interface (AI) is currently provided as an '''addition''' to the existing Interface for CumulusMX. At the current time, it should '''NOT''' be used as an alternative. In the near future this may be possible.


The AI is built using the same technology as the alternative public website and is intended to be flexible and responsive on all screen resolutions. It is modular and designed so that end users can make changes to the way page content is displayed without too much knowledge of html coding. It comes with themes that allow its colour to be changed to suit your personal preferences and a configuration page so that you can do this easily.
The AI is built using the same technology as the alternative public website and is intended to be flexible and responsive on all screen resolutions. It is modular and designed so that end users can make changes to the way page content is displayed without too much knowledge of html coding. It comes with themes that allow its colour to be changed to suit your personal preferences and a configuration page so that you can do this easily.


====The AI for CumulusMX Version 4+====
The current version is for CumulusMX 3.28.1 and can be downloaded form [https://www.cumuluswiki.org/images/d/d7/AI2.zip AI2 for v3.28.01 build 32693]. Updated December 2023.

In this version ALL the features of the included Interface work as expected with some enhancements.


=== Installation ===
=== Installation ===


As the AI is now included with CumulusMX, there is no need to download it unless an interim upgrade is provided.
Download the above package and extract it to '''somewhere other than your CumulusMX files'''.


To use the AI, you should now use the url: '''localhost:8998/ai2/'''
The package contains a second zip file and documentation which you should read to understand what it does and what you can do with it.


Unzip the second zip file, again away from CumulusMX. This is to ensure that you don't accidentally overwrite critical files in the existing Interface.

You should now have a folder called '''ai2'''. This can be copied as is into the Interface folder so that it is a sub-folder of the Interface folder. You can rename the AI2 folder if you wish.

To use the AI, you should now use the url: '''localhost:8998/ai2/'''

If you renamed the folder then use the new name rather than ''ai2''.
If you access the normal CumulusMX interface from a different computer then use the IP address of the machine running CumulusMX rather than ''localhost''.
If you access the normal CumulusMX interface from a different computer then use the IP address of the machine running CumulusMX rather than ''localhost''.
If you run CumulusMX through a different port then use that port rather than 8998.
If you run CumulusMX through a different port then use that port rather than 8998.


If you already have the AI running on your system then please '''don't''' try to merge the two - keep them separate as files will change with each release and this '''will''' cause you issues. Technically you could simply create new folders for each AI release and run any of them in conjunction with the existing Interface.
If you already have the AI running on your system then please '''don't''' try to merge the two - keep them separate as files will change with each release and this '''will''' cause you issues.


==General Features==
==General Features==
Line 44: Line 32:
This is a list of the features that the AI provides
This is a list of the features that the AI provides
* It has a large number of ''themes'' that can be used to change the colours used throughout the site
* It has a large number of ''themes'' that can be used to change the colours used throughout the site

* The Header and Footer can be fixed (default) or scroll, the footer is always at the bottom of the screen when page content is short and always scrolls on small screens.
* The Header and Footer can be fixed (default) or scroll, the footer is always at the bottom of the screen when page content is short and always scrolls on small screens.

* If you don't use a Davis station directly connected to your system, you will '''not''' see the 'Davis Stats' panel.

* The fonts used are fully responsive.
* The fonts used are fully responsive.
* The menu has been adapted to have fewer top level entries and focus on managing your weather station. It provides a link back to the default Interface if required. ('''See not at top of the page''').


* Dashboard graphics have been updated. These also appear on other weather data pages.
* All pages use a feature called flex-boxes so can be re-organised simply by changing the order style for each panel.

* The menu has been adapted to have fewer top level entries and focus on managing your weather station. It provides a link back to the default Interface if required. ('''See note at top of the page''').

* All pages use a feature called flexboxes so can be re-organised simply by changing the order style for each panel.


* The Utility pages have been combined into one page although the ''Latest Errors'' page is still available.
* The Utility pages have been combined into one page although the ''Latest Errors'' page is still available.

* Modifications have been made to all the Charts pages so that you can zoom in on small data sets. They also latch within the current session so if you move away from the page, and return, the same chart will be displayed.

* Modifications have been made to the Steel Series Gauge popup tooltips and it now includes the scrolling text graphic.

* The Logs pages have fixed regions to display line, date (and time) and scroll sideways rather than break the page layout. Their popup editors have been restyled.

* Font-Awsome icons are available throughout the site.

Significant, but not exhaustive improvements have been added for accessibility. Anyone requiring these features with knowledge of how to improve the AI2 should contact me.
Significant, but not exhaustive improvements have been added for accessibility. Anyone requiring these features with knowledge of how to improve the AI2 should contact me.


== The Menu ==
=== How it fits with the existing inteface ===

As far as possible, the menu has been split between those pages that simply allow you to view information provided by your weather station and those that allow you to edit them.

[[File:Screenshot AI Menu.png|800px|alt=AI Menu|The latest AI Menu]]

===Viewing Data===
[[File:Screenshot Weather Data Menu.png|350px|left|alt=AI Weather Data menu|The mainWeather Data menu]]

====The first three menu items====
There are three top level menu items at the left to enable this.

These are '''Dashboard''', '''Weather Data''' and '''Extra Sensors'''.

The ''Dashboard'' menu item is always visible in both large and small screen, other menu items collapse until you expand the menu with the classic ''hamburger'' item.

The '''Weather data''' menu, as shown on th left, contains links for all other pages that simply allow you to view rather than edit data.

The exceptions are for the NOAA reports pages which can still be used to regenerate the currently displayed or all missing reports.

The ''Extra sensors''' menu provides access for any extra sensors that are attached or 'air linked' to your weather station.


<br><br><br><br><br><br><br><br><br>
The AI has been developed as an '''addition''' to the existing Interface - it is '''not provided as a replacement'''. The existing Interface '''should always be retained''' as it is this that will be updated by Mark as and when required. As changes are made to CumulusMX your only access to them initially will be through the default interface provide by Mark.
===Editing Data===


[[File:Screenshot Settings Menu.png|600px|left|alt=The Settings Menu|The Settings Menu]]
As said above, the AI includes all the same resources needed to view the data being generated by your website; to configure your station and to edit data should errors occur.
As can be seen in the screenshot on the left, there are four top level menu items to the right of the ''diamond''.


These give access to either page that enable you to configure setting for your CumulusMX system or to editing your weather station data.
However, some changes to layout have been made:
*The '''Header''' and '''Footer''' are both fixed by default. This can be changed by you if required.
*The '''Menu''' has been adapted to take less space but includes a button to return to the default '''Interface''' pages.
**I have also moved/duplicated some of the menu entries to other top level menu items.
*The header area is now better at being responsive on small screens - reducing in size to give you more space for your data on small screens.
=====Viewing generated data=====
*The '''Dashboard''' page
**Shows the '''alarm LEDs''' at the top of the page. These can be hidden/re-displayed using the button provided with the page title.
**The '''Sun and Moon''' rise & setting times are displayed in a popup; again using the button in the page title bar.
**For those users with Davis weather stations, you can see '''Packets''' data, '''CRC errors''' and the percentage failure rate. I have found that this last piece of info. is a good indicator for when the battery needs changing. This option toggles across sessions so if you hide them they stay hidden until you choose to view them again.
*The '''Charts''' pages
**All charts can be zoomed, i.e., you can swipe the mouse over parts of the chart to view readings in detail.
**The '''recent''' and '''historic''' charts use buttons that always span a complete line (or lines).
**The '''Select-a-Chart''' groups the buttons in two groups of three pairs, as in the default Interface.
*The '''NOAA''' pages
**Both pages have been amended so that the required report loads when a date is selected.
*'''Extra Sensors'''
**These pages use flex boxes and as such it is possible to rearrange them on the page simply by changing their 'order' number in the html code.
*The '''Data Logs''' pages
**These now all have fixed columns for line number and date (and time).
**All pages automatically load data when the pages open.


These are: '''Logs''', '''Settings''', '''Edit''' and '''Utilities'''.
=====Management and Setup Menus=====
*The '''Readings Logs''' and '''Extra Data Logs''' pages display the current days entries but this can be changed using the popup calendar.<br/>These tables also display metric units for all appropriate data. If you use other units then you will need to edit the three html files. (Details are in the 'readme' file included in the download).
**Some cosmetic changes have been made to the popup editor panel.
*The '''Settings''' Menu<br/>This menu provides access to the same pages as in the default system although some have been redesigned
**The '''MySQL Settings''' page has been made into two columns.
**The '''Alarm Settings''' page has simply been tidied up.
*The '''Edit...''' Menu
**The '''rain editor''' is now much narrower and the shading on read-only entries made more obvious.
*'''Weather Conditions Editor'''
**This is a new page that combines the old ''Current Conditions'' & ''Weather Diary'' pages. The original pages are not included in the latest zip file.
*The four '''Edit Records...''' pages
**These are essentially the same as the default interface. Cosmetic changes have been made to the popups.
*The '''Utilities...''' menu
**This inludes FTP, Purge database, Reload the Dayfile, Custom logs and 'AI Settings'.
**The FTP, Dayfile and Purge Database options load the same page with all options available including the Latest Errors. (The 'Copy to Clipboard' button does what it says).
**Custom Logs loads the same page as the 'Settings' menu.
**'AI Settings...' gives you access to the various theme colour styles available. To view the them on this page use the appropriate button or selecting 'Use for all pages' will make the change permenantly.
**You also have the option to reset the theme to the default.
**It also enables you to change the status of the header and footer from static to scrolling - either or both and adjust the gap between the body of the page and the header and footer.
----


These mirror the same menu items as on the default Interface. One feature of the AI is that the ''Settings'' Menu is a drop down panel with columns. On the mobile menu it reduces to two columns. This makes it easier to access all items even on small screens.
===Screen Shots===
<br><br><br><br><br><br><br><br>
Below are a number of screenshots of various pages.
====The Default Interface====
<gallery>
Screenshot_Dashboard.png|The Dashboard showing some version 3 developments ideas
Screenshot_Charts.png|A sample of the carts page - note all charts are zoomable and any buttons always spread across the width of the page
Screenshot_TodayVYesterday.png|The Today verses Yesterday page. All panels can be re-ordered as required.
Screenshot_Edit_Data_Logs.png|The 'Edit Data Logs' page showing rows hovered and rows selected.
Screenshot_Edit_Data_Logs_2.png|This is the same page showing the edit popup.
</gallery>
<gallery>
Screenshot_Alarm_Settings.png|The Alarms settings page.
Screenshot_Extra_Web_Files.png|The extra Webfiles page. Note I put a heading in the first entry of every page to identify role of upload.
Screenshot_Weather_Diary_Editor.png|Showing the combined diary and current conditions editor.
AI_Weather_Records.png|Showing the weather records.
AI_Extra_Sensors.png|Version 2 of this page enables you to re-order each block to suite your weather station resources
The_AI_Settings_page.png|Build 3 showing the new AI Settings page
</gallery>
All the above are taken from my current Version 2 of the Interface except the last two.
----


Access is provided to this via the last top level menu at the extreme right of the menu (just visible in the screenshot). It will open the Interface in a new Window.
===Technical Changes===
Generally, this has been limited to ensuring that all JavaScript files use the correct URL for '''API''' calls to both read and update settings / data. All modified JavaScript files are included in the '''AI''' package and do not over-write existing files.


==Using the AI Settings Page==
Some of the html and associated js files have been renamed to satisfy my OCD nature.


The AI Settings page enables you to make global changes to the way the Interface looks. Things you can change are:
This package also includes:
*The '''gauges.js''' file in the ''steelseries'' library - it has been modified to make to make the ''tooltips'' use the theme,
*The '''datatables''' and '''datatables editor''' library - again modified to make use of the themes.
*Finally the '''PopupOverley''' library for the same reasons.


*Page Geometry
===Known Issues===
*:Use this to alter the gaps between the Header & Page content, and the Page content & Footer.
At the moment I have not been able to make the AI open the ''Internet Settings'' ~ ''Web/Upload Site'' ~ ''Advanced Settings'' panel. As this is only for very specific issues you may well not need to access it, but if you do, then simply use the default interface until I post a solution.
*:Change the units used to measure those gaps. The site uses the Font Height, the Screen Height or pixels. Pixels are fixed, the others are responsive.
*:Make the Header scroll with the page (Only if the page is long enough)
*:Make the Footer scroll with the page (only on long pages). The Footer will always scroll on small screens.


*The Theme
==Installation==
*:There are approximately 16 light themes
Once you have downloaded the zip file, extract it '''somewhere other''' than your CumulusMX installation. This will avoid accidentally overwriting your existing Interface contents.
*:There are the same number of dark themes
*:There is one '''High Contrast''' theme.


*The Seagull Animation
The Extracted package should consist of a single folder - ai2.cmx, which can then be copied into the existing Interface folder so it shows as a '''sub-folder'''.
*:The default is None (however, the seagull does still fade in at its default position).
*:You can choose:
*::'''Float down the screen''', or
*::'''Slide across the screen'''
*:If you chose an animation you can adjust the speed in seconds
*:Regardless of any animation, you can force the seagull to hide behind page content if preferred.


As you make changes to any of these settings it will be reflected in the current page only. To use the current selection you '''must''' click the bottom '''Use this Configuration'''. To restore the default settings as programmed into the AI use the button '''Restore default'''.
You are then ready to start using it. If you use the url: '''<nowiki>http://localhost:8998/</nowiki>''' to run your normal interface, you can simply add the folder name to the end like so:
'''<nowiki>http://localhost:8998/ai2/</nowiki>'''. (''Note the trailing backslash'')


Beneath these buttons you will see the values used in the CMXConfig object to store these settings. If your browser does '''not''' allow the setting to be stored, you can copy this directly into the ai-pagemanager.js file replacing what is already there.
Of course localhost can be replaced with the IP address of the machine running CumulusMX. Using the IP address of your CumulusMX computer, you can also brows to it from another computer on your ''local'' network.


==Editing pages directly==
You still have access to the default interface if you want.
On the next release of the AI, I will be adding extra pages to the wiki to help you take control of the AI and make changes to suit your needs.


The AI does include a 'development' page that you can use to try out different layouts with the available dates well as making it easy for you to change columns and column orders.
PLEASE read the included ''''ReadMe'''' file as this shows how you can change the '''UNITS''' in the DayFile and Data Logs pages.

Latest revision as of 09:44, 10 November 2024

The Alternative Interface

Overview

The Alternative Interface (AI) is currently provided as an addition to the existing Interface for CumulusMX.

The existing Interface is maintained by Mark and will always provide all the tools needed to manage your installation of your weather station, The AI can be used as an alternative except immediately after an upgrade that has added new features to the interface as these may not yet be implemented on the AI (although every effort is made to do this). 

 In the near future it may replace the existing Interface but this is still under discussion.

The AI is built using the same technology as the alternative public website and is intended to be flexible and responsive on all screen resolutions. It is modular and designed so that end users can make changes to the way page content is displayed without too much knowledge of html coding. It comes with themes that allow its colour to be changed to suit your personal preferences and a configuration page so that you can do this easily.

The AI for CumulusMX Version 4+

In this version ALL the features of the included Interface work as expected with some enhancements.

Installation

As the AI is now included with CumulusMX, there is no need to download it unless an interim upgrade is provided.

To use the AI, you should now use the url: localhost:8998/ai2/ 

If you access the normal CumulusMX interface from a different computer then use the IP address of the machine running CumulusMX rather than localhost.
If you run CumulusMX through a different port then use that port rather than 8998.

If you already have the AI running on your system then please don't try to merge the two - keep them separate as files will change with each release and this will cause you issues.

General Features

This is a list of the features that the AI provides

  • It has a large number of themes that can be used to change the colours used throughout the site
  • The Header and Footer can be fixed (default) or scroll, the footer is always at the bottom of the screen when page content is short and always scrolls on small screens.
  • If you don't use a Davis station directly connected to your system, you will not see the 'Davis Stats' panel.
  • The fonts used are fully responsive.
  • Dashboard graphics have been updated. These also appear on other weather data pages.
  • The menu has been adapted to have fewer top level entries and focus on managing your weather station. It provides a link back to the default Interface if required. (See note at top of the page).
  • All pages use a feature called flexboxes so can be re-organised simply by changing the order style for each panel.
  • The Utility pages have been combined into one page although the Latest Errors page is still available.
  • Modifications have been made to all the Charts pages so that you can zoom in on small data sets. They also latch within the current session so if you move away from the page, and return, the same chart will be displayed.
  • Modifications have been made to the Steel Series Gauge popup tooltips and it now includes the scrolling text graphic.
  • The Logs pages have fixed regions to display line, date (and time) and scroll sideways rather than break the page layout. Their popup editors have been restyled.
  • Font-Awsome icons are available throughout the site.

Significant, but not exhaustive improvements have been added for accessibility. Anyone requiring these features with knowledge of how to improve the AI2 should contact me.

The Menu

As far as possible, the menu has been split between those pages that simply allow you to view information provided by your weather station and those that allow you to edit them.

AI Menu

Viewing Data

AI Weather Data menu

The first three menu items

There are three top level menu items at the left to enable this.

These are Dashboard, Weather Data and Extra Sensors.

The Dashboard menu item is always visible in both large and small screen, other menu items collapse until you expand the menu with the classic hamburger item.

The Weather data menu, as shown on th left, contains links for all other pages that simply allow you to view rather than edit data.

The exceptions are for the NOAA reports pages which can still be used to regenerate the currently displayed or all missing reports.

The Extra sensors' menu provides access for any extra sensors that are attached or 'air linked' to your weather station.










Editing Data

The Settings Menu

As can be seen in the screenshot on the left, there are four top level menu items to the right of the diamond.

These give access to either page that enable you to configure setting for your CumulusMX system or to editing your weather station data.

These are: Logs, Settings, Edit and Utilities.

These mirror the same menu items as on the default Interface. One feature of the AI is that the Settings Menu is a drop down panel with columns. On the mobile menu it reduces to two columns. This makes it easier to access all items even on small screens.







The Default Interface

Access is provided to this via the last top level menu at the extreme right of the menu (just visible in the screenshot). It will open the Interface in a new Window.

Using the AI Settings Page

The AI Settings page enables you to make global changes to the way the Interface looks. Things you can change are:

  • Page Geometry
    Use this to alter the gaps between the Header & Page content, and the Page content & Footer.
    Change the units used to measure those gaps. The site uses the Font Height, the Screen Height or pixels. Pixels are fixed, the others are responsive.
    Make the Header scroll with the page (Only if the page is long enough)
    Make the Footer scroll with the page (only on long pages). The Footer will always scroll on small screens.
  • The Theme
    There are approximately 16 light themes
    There are the same number of dark themes
    There is one High Contrast theme.
  • The Seagull Animation
    The default is None (however, the seagull does still fade in at its default position).
    You can choose:
    Float down the screen, or
    Slide across the screen
    If you chose an animation you can adjust the speed in seconds
    Regardless of any animation, you can force the seagull to hide behind page content if preferred.

As you make changes to any of these settings it will be reflected in the current page only. To use the current selection you must click the bottom Use this Configuration. To restore the default settings as programmed into the AI use the button Restore default.

Beneath these buttons you will see the values used in the CMXConfig object to store these settings. If your browser does not allow the setting to be stored, you can copy this directly into the ai-pagemanager.js file replacing what is already there.

Editing pages directly

On the next release of the AI, I will be adding extra pages to the wiki to help you take control of the AI and make changes to suit your needs.

The AI does include a 'development' page that you can use to try out different layouts with the available dates well as making it easy for you to change columns and column orders.

Retrieved from "https://www.cumuluswiki.org/index.php?title=The_Alternative_Interface_(ai.cmx)&oldid=11861"