The Alternative Interface (ai.cmx)

From Cumulus Wiki
Revision as of 13:54, 12 December 2023 by NeilThomas (talk | contribs) (→‎Overview)
Jump to navigationJump to search

An Alternative (additional) Interface

Overview

The AI version 2.0.1 is here. This is a major upgrade involving a complete rewrite of the HTML and Javascript. It is specifically aimed at CumulusMX Version 3.28.0 build 3269. It will NOT work with previous versions of CumulusMX due to changes being made by Mark to the API. Any errors in the last release of version 1 have been corrected and new features included.

AI2 for v3.28.01 build 32693. Updated 12/121/2023 @ 13:54

Notes

This now includes the correct calibration settings page. As well as a pdf information file I have included a ReadMe.txt file in the zip for the AI2. This details most of the changes and provided information on any changes you might want to make.

Remember, extract it to a location away from CumulusMX/Interface and then extract and copy the AI2.zip file into the interface folder. If you already have an old AI2 folder, I recommend renaming it, upgrading and then deleting it when happy.

Features of AI2

Dark Mode has been implemented and a number of dark mode themes included to match the original. Please note that these themes are no longer compatible with the default website.

All pages use flex-boxes so can be re-organised simply by changing the order style for each panel.

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.

Page layouts have been improved and those pages with multiple panels can now be re-arranged by changing their order style in the html files.

There are six master fixed width panel classes:

  • ow-oneCol: This creates a full width flex panel that still accepts children but arranges them as rows only.
  • ow-twoCol: This creates a two column layout on wide screens that automatically degrades to one column on smaller screens.
  • ow-threeCol: As it's name suggests create three columns on large screens and reduces down to two then one column.
  • ow-fourCol: As above but initially four columns.
  • ow-fiveCol & ow-sixCol: They do what they imply.

ISSUES

Please note that neither 'General Settings' or 'Advanced option' on the Internet settings ~ web/FTP' page don't expand. Please use the default interface for this if required. All other features work as required.

How it fits with the existing inteface

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.

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.

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.
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.
    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
    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.

Screen Shots

Below are a number of screenshots of various pages.

  • The Dashboard showing some version 3 developments ideas

    The Dashboard showing some version 3 developments ideas

  • A sample of the carts page - note all charts are zoomable and any buttons always spread across the width of the page

    A sample of the carts page - note all charts are zoomable and any buttons always spread across the width of the page

  • The Today verses Yesterday page. All panels can be re-ordered as required.

    The Today verses Yesterday page. All panels can be re-ordered as required.

  • The 'Edit Data Logs' page showing rows hovered and rows selected.

    The 'Edit Data Logs' page showing rows hovered and rows selected.

  • This is the same page showing the edit popup.

    This is the same page showing the edit popup.

  • The Alarms settings page.

    The Alarms settings page.

  • The extra Webfiles page. Note I put a heading in the first entry of every page to identify role of upload.

    The extra Webfiles page. Note I put a heading in the first entry of every page to identify role of upload.

  • Showing the combined diary and current conditions editor.

    Showing the combined diary and current conditions editor.

  • Showing the weather records.

    Showing the weather records.

  • Version 2 of this page enables you to re-order each block to suite your weather station resources

    Version 2 of this page enables you to re-order each block to suite your weather station resources

  • Build 3 showing the new AI Settings page

    Build 3 showing the new AI Settings page

All the above are taken from my current Version 2 of the Interface except the last two.

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.

Some of the html and associated js files have been renamed to satisfy my OCD nature.

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.

Known Issues

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.

Installation

Once you have downloaded the zip file, extract it somewhere other than your CumulusMX installation. This will avoid accidentally overwriting your existing Interface contents.

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.

You are then ready to start using it. If you use the url: http://localhost:8998/ to run your normal interface, you can simply add the folder name to the end like so: http://localhost:8998/ai2/. (Note the trailing backslash)

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.

You still have access to the default interface if you want.

PLEASE read the included 'ReadMe' file as this shows how you can change the UNITS in the DayFile and Data Logs pages.

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