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

← Older edit

The Alternative Interface (ai.cmx) (view source)

Revision as of 09:44, 10 November 2024

1,443 bytes removed , 10 November

m

Remove unwanted content

NeilThomas

338

edits

Revision as of 13:21, 9 August 2022 (view source) NeilThomas (talk \| contribs) m (→‎Download the latest version) ← Older edit		Latest revision as of 09:44, 10 November 2024 (view source) NeilThomas (talk \| contribs) m (Remove unwanted content) Tags: Mobile edit Mobile web edit
(95 intermediate revisions by 2 users not shown)
{{TOCright}} == AnThe Alternative ~~(additional)~~ Interface == [[Category:Cumulus MX]] === Overview === The Alternative Interface (AI) is currently provided as an '''addition''' to the existing Interface for CumulusMX. ~~Following the release of the responsive default website for CumulusMX, I am now looking at the development of the main CumulusMX Interface.~~ 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). Although the main focus of the Interface is to manage your weather station, it also provides your initial view of the data that you are collecting. As such I feel that it should also use the same up-to-date features as the supplied public default website. In the near future it may replace the existing Interface but this is still under discussion. Like the public website supplied with CumulusMX, the AI uses colour themes and, wherever possible, is fully responsive. This should make it easier to use on tablets and phones as well as the more traditional desktop/laptop screen. 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. Like the supplied Interface, the AI includes all the required pages to manage your weather station but also provides some additional information, especially on the dashboard page. It also provides 30+ themes that can be applied to it and the default public website, it required. ====The AI for CumulusMX Version 4+==== ~~=== How it fits with the existing inteface ===~~ In this version ALL the features of the included Interface work as expected with some enhancements. The AI has been developed as an '''alternative''' to the existing Interface - it is '''not a replacement'''. The existing Interface '''should always be retained''' as it is this that will be updated by Mark as and when required. === Installation === ~~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 the AI is now included with CumulusMX, there is no need to download it unless an interim upgrade is provided. ~~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. The header area is now better at being responsive on small screens - reducing in size to give you more space for your data. ~~=====Viewing generated data=====~~ The '''Dashboard''' page Shows the '''alarm LEDs''' at the top of the page.<br/>(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. The Temperature, Pressure, Winds & Rain panels will flash when a new record is set For those users with Davis weather stations, you can see '''Packets''' data, '''CRC errors''' and the percentage failure rate.<br/>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''' - No significant cosmetic changes To use the AI, you should now use the url: '''localhost:8998/ai2/''' ~~=====Management and Setup Menus=====~~ The '''Data Logs''' Menu All pages automatically load data when the pages open. The '''Readings Logs''' and '''Extra Data Logs''' pages display the last 7 days of 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). 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.<br/>The original pages are still available but not in the menu. This can be edited to display the original pages if preferred. The four '''Edit Records...''' pages *These are esentially the same except that editing is done using a popup box rather than in-line.<br/>This simply avoids the tables becoming confusing on small screens. The '''AI Settings...''' menu Gives you access to the various theme colour styles available.<br/>Selecting a theme makes it active for the current page '''only'''.<br/>To make it ''permanent'' you need to click the '''Use for all pages''' button. Enables you to change the status of the header and footer from static to scrolling - either or both. *You can now also adjust the gap between the body of the page and the header and footer. ~~----~~ If you access the normal CumulusMX interface from a different computer then use the IP address of the machine running CumulusMX rather than ''localhost''. ~~===Screen Shots===~~ If you run CumulusMX through a different port then use that port rather than 8998. ~~Below are a number of screenshots of various pages.~~ ~~<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.~~ ~~----~~ 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. ~~===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. ==General Features== ~~The following JavaScript files are additions for the AI.~~ '''AI-Charts-Plus.js''': This script handles all buttons on the ''Readings'' and ''Historic'' charts pages. '''AI-Page-Manager.js''': This script is a utility used by all pages to control the layout, obtain the CumulusMX Version data, handle the selected theme and various other utilities.<br/>If you have hidden the 'Davis Stats Panel' on the Dashboard then this script makes sure it is hidden the next time you open the page. '''AI-Configure.js''': This script is only used to configure the AI: Static or scrolling header/footer and gapes between them and the main body. You can also change the colour theme for the site. This is a list of the features that the AI provides This package also includes the gauges.js file in th esteelseries library - it has been modified to make to make the tooltips use the theme, and the datatables editor library again to make use of the themes. * 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. ~~====Things you can change easily====~~ As already mentioned, the ''Header'' and ''Footer'' area of the site is static by default - i.e. they are always on page. To change this use the '''AI-Config.html''' page. It can also be used to make the header and/or footer scroll and change the gap between the body of the page and the header/footer. * If you don't use a Davis station directly connected to your system, you will '''not''' see the 'Davis Stats' panel. ~~==Download the latest version==~~ ~~Download the latest current version: [https://cumuluswiki.org/images/c/c2/Ai.cmx.zip the latest ai.cmx ] (''Updated 9th August 2022 @ 14:20'')~~ * The fonts used are fully responsive. ~~This update accommodates the latest update from Mark - build 3196~~ * Dashboard graphics have been updated. These also appear on other weather data pages. The records pages now include the ability to update directly from the log files as in the default interface. This upload includes the required changes to the weather diary page. It also includes an update to the Alarms Settings page which I had omitted to edit in the last version. * 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'''). ~~==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.~~ * All pages use a feature called flexboxes so can be re-organised simply by changing the order style for each panel. ~~The Extracted package should consist of a single folder - ai.cmx, which can then be copied into the existing Interface folder so it shows as a '''sub-folder'''.~~ * The Utility pages have been combined into one page although the ''Latest Errors'' page is still available. ~~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/ai.cmx/</nowiki>'''. (''Note the trailing backslash'')~~ * 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. 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. * Modifications have been made to the Steel Series Gauge popup tooltips and it now includes the scrolling text graphic. ~~You still have access to the default interface if you want.~~ * 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. ~~PLEASE read the included ''''ReadMe'''' file as this shows how you can change the '''UNITS''' in the DayFile and Data Logs pages.~~ * 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. [[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> ===Editing Data=== [[File:Screenshot Settings Menu.png\|600px\|left\|alt=The Settings Menu\|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. <br><br><br><br><br><br><br><br> ====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.