5,838
edits
Category:Cumulus MX: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Library software
| (3 intermediate revisions by the same user not shown) | |||
| Line 289: | Line 289: | ||
Talking about command windows, if you want to check that the port is open for listening (i.e. able to access the admin interface) type <tt>netstat -an | findstr 8998</tt> into the command window. | Talking about command windows, if you want to check that the port is open for listening (i.e. able to access the admin interface) type <tt>netstat -an | findstr 8998</tt> into the command window. | ||
The admin interface URL '''http://*:8998/''' needs to have that wildcard "*" replaced by a precise location if we are to access the admin interface. The missing part of the URL depends on how your local network is set up. If you are accessing the admin interface on the same device as that running MX (and you don't have another web server on that device) the "*" can be replaced by "localhost", i.e. '''http://localhost:8998/''' will be used to load the admin interface into your browser. In the more general case when you want to access the admin interface from anywhere on your local wired and wireless interface, then the "*" needs to be replaced by a string of 4 numbers representing what is called a IPv4 address (w.x.y.z) of the device you have installed MX on. | |||
Look at your hub or router (this should have come with instructions on how to access its settings in your browser) and on one screen it should show what devices are connected to your LAN and wifi. Look for the IPv4 address | Look at your hub or router (this should have come with instructions on how to access its settings in your browser) and on one screen it should show what devices are connected to your LAN and wifi. Look for the IPv4 address, for example 192.168.1.64, it has assigned to the device where MX is running. That is what should replace the "*". However, there is one more complication, either the Windows networking settings may change, or else your hub or router may reconfigure, both can happen at any time and both can assign a different IPv4 address to the device running MX. | ||
To give your Computer a fixed address for the MX admin interface, | |||
#first find the network card via Network and Sharing Centre (Control Panel), | |||
#then click on Change Adapter Settings, | |||
#then Right click on Ethernet or WiFi Adapter, | |||
#next select Properties | |||
# In the window that opens, right click on Internet Protocol Version 4 (TCP/IP 4), | |||
#Next select properties | |||
# Onn that pop up screen tell the computer to "use the following IP address" | |||
#Fill out the form with | |||
#* a subnet mask of 255.255.255.0 and | |||
#*gateway address between 192.168.1.1 and 192.168.1.254 (depending on the address of your hub/router). | |||
==== Setting up for either manual or automatic running ==== | ==== Setting up for either manual or automatic running ==== | ||
| Line 628: | Line 641: | ||
= Library software = | = Library software = | ||
Cumulus MX uses '''library''' software (i.e. software written by others and made available by the provider and often also by other content delivery nodes or 'cdn') for a lot of the standard functionality. The library software | For most Cumulus users, this whole section can be skipped, but I have included it for those few users who have a technical slant and might want to understand more. | ||
Cumulus MX uses '''library''' software (i.e. software written by others and made available by the provider and often also by other content delivery nodes or 'cdn') for a lot of the standard functionality. The library software for the admin interface and the separate library software for the standard web pages are both mostly included in the distribution zip, although some is used via a link to a cdn. | |||
Many of the libraries included by MX are very obsolete. However, Mark Crossley, the current developer, said the following on 30 Sept 2019: | Many of the libraries included by MX are very obsolete. However, Mark Crossley, the current developer, said the following on 30 Sept 2019: | ||
| Line 634: | Line 649: | ||
Just to mention the other side of this balance. It is difficult to code an addition to MX that works with these obsolete versions of libraries. All documentation provided by providers of the libraries relates to current versions of the packages (and what is documented to work now often will not work with obsolete versions). The documentation for the packages that are no longer supported is only available in archive sites if available at all. | Just to mention the other side of this balance. It is difficult to code an addition to MX that works with these obsolete versions of libraries. All documentation provided by providers of the libraries relates to current versions of the packages (and what is documented to work now often will not work with obsolete versions). The documentation for the packages that are no longer supported is only available in archive sites if available at all. | ||
==Library Software for the MX engine== | |||
The distribution zip contains various '''.dll''' files and these are the libraries used by MX itself. | |||
===Devart=== | |||
The two files used are both related to the database functionality of MX. | |||
===FluentFTP=== | |||
As the name suggests, this is used by MX for controlling the file transfer functionality. This component has been updated at certain MX releases, see the announcements for details. | |||
===Linq=== | |||
Language INtegrated Query is used to work with sequences of items and pick the ones that are needed, putting them into output format required. MX uses two files in connection with preparing output for Twitter. There is a third Linq file for other processing. | |||
===MQTT=== | |||
When MX added capability to talk to other devices using the MQTT protocol, it added this component for that optional functionality. | |||
===Newtonsoft=== | |||
This component is used for processing JSON strings. It is a very popular choice for developers, and used therefore very widely. However, '''SystemText''' has superseded it, so MX is using an obsolete method. | |||
===Renci SSH=== | |||
This component is server connection software, it is what processes the host name, password, and so on. | |||
===SQLite3=== | |||
This is used for all interactions with the [[Weather Diary|weather diary]]. | |||
===HTTP=== | |||
These files handle the optional HTTP functionality. | |||
===Unosquare=== | |||
The EmbedIO file is open-source software that handles the web-sockets functionality of MX. The Swan file is open-source software that handles JSON formatting and threading of tasks in MX. | |||
== Library software for admin interface == | == Library software for admin interface == | ||
As the following sections reveal, MX uses external libraries rather than writing its own code whenever possible. | |||
*However, that does not mean MX is good at meeting development standards. | |||
*MX only implements small parts of the functionality of most libraries, the minimum to make a feature work, not all the features available to make it work well | |||
*MX does not use the latest versions of libraries | |||
*MX does not attempt to obey guidance for good user interaction, and although validation is being added, many parts of MX do depend on user understanding what is valid | |||
*MX does not make provision for screen readers and other accessibility aids. | |||
===Alpaca=== | ===Alpaca=== | ||
| Line 645: | Line 707: | ||
===Bootstrap=== | ===Bootstrap=== | ||
#Also known by some as ''Twitter Bootstrap'' which gives a clue as to its origins as an internal tool for those building Twitter, that company still keep making updates as it is now the most popular styling library of all those available widely. | #Also known by some as ''Twitter Bootstrap'' which gives a clue as to its developer and to its origins as an internal tool for those building Twitter, that company still keep making updates as it is now the most popular styling library of all those available widely. | ||
*The simplest way to think about this package is as a standard set of styling promoting easy responsive (means adapts to screen dimensions) web site design. | *The simplest way to think about this package is as a standard set of styling promoting easy responsive (means adapts to screen dimensions) web site design. | ||
*To give just a few examples, it defines a standard way to represent buttons, form components, lists, navigation, and breadcrumbs. | *To give just a few examples, it defines a standard way to represent buttons, form components, lists, navigation, and breadcrumbs. | ||
*MX uses Bootstrap version 3.3.7 (http://getbootstrap.com), | *MX uses Bootstrap version 3.3.7, which is very restricted in what it offers | ||
** | **Bootstrap version 5 is available (http://getbootstrap.com), so MX is using an obsolete library | ||
*MX does not implement colouring text according to what it represents (primary, secondary, information, warning etc.) | ** Bootstrap version 4.5.0 (Bootstrap 4 released as alpha in August 2015, beta in August 2017, and with fully working releases frequently from January 2018) was very widely praised for its improved functionality, and ability to work with latest jQuery and multiple modern devices/browsers. | ||
*MX does not implement key features of Bootstrap like colouring text according to what it represents (primary, secondary, information, warning etc.) | |||
===dataTables=== | ===dataTables=== | ||
#When MX sends out multiple lines of a log file to view or edit, the application programming interface (api) that transfers the information from the MX engine sends it in dataTables format for display on the web page in the admin interface. | #When MX sends out multiple lines of a log file to view or edit, the application programming interface (api) that transfers the information from the MX engine sends it in dataTables format for display on the web page in the admin interface. | ||
#Thus dataTables does all the work of providing the ability to move between multiple pages needed | #Thus dataTables does all the work of providing the ability to present the data in a HTML table, the functionality to move between multiple pages needed (as MX sends only up to 10 lines of a log file at a time to the admin interface). | ||
#The free version of dataTables used by MX lacks the most useful functionality that needs a subscription licence. For example, editing functionality requires a subscription. | #The free version of dataTables used by MX lacks the most useful functionality that needs a subscription licence. For example, its editing functionality requires a subscription. | ||
===altEditor=== | ===altEditor=== | ||
*This is an editing tool that can read what is in dataTables, create what it calls a modal (a pop-up dialog) where rows can be added, edited or deleted individually. | *This is an editing tool that can read what is in dataTables, create what it calls a modal (a pop-up dialog) where rows can be added, edited, or deleted individually. | ||
** MX when it added editing of log files at version 3.4.5 - Build 3069 (Friday 13 March 2020) adopted this software as it was free (although Mark Crossley said in his release notice: '''"The main thrust of this release is to add some log file editing capability to Cumulus MX. It works on all three log file types, but it is fairly basic at present. You can edit or delete lines in the files. The editing has to be done via pop-up dialog.''' | ** MX when it added editing of log files at version 3.4.5 - Build 3069 (Friday 13 March 2020) adopted this software as it was free (although Mark Crossley said in his release notice: '''"The main thrust of this release is to add some log file editing capability to Cumulus MX. It works on all three log file types, but it is fairly basic at present. You can edit or delete lines in the files. The editing has to be done via pop-up dialog.''' | ||
**'''I only found two libraries that support JQuery dataTables editing, one is very comprehensive - but costs $$$ - the other is free. The free version does not currently support in-line editing of the table which is a shame.''' | **'''I only found two libraries that support JQuery dataTables editing, one is very comprehensive - but costs $$$ - the other is free. The free version does not currently support in-line editing of the table which is a shame.''' | ||
