CumulusUtils: Difference between revisions

2,053 bytes added ,  11:24, 18 January 2022
m
Line 50: Line 50:


   WebRoot (Content uploaded by CumulusUtils)
   WebRoot (Content uploaded by CumulusUtils)
     |--- lib (Uploaded by CumulusUtils when in the utils dir)
     |--- lib (JavaScript libraries, uploaded by CumulusUtils during a run)
     |--- css (Uploaded by CumulusUtils when in the utils dir)
     |--- css (css files, uploaded by CumulusUtils during a run)
     |--- CUicons        (Manually copied once during setup)
     |--- CUicons        (required to be manually copied once)


=== Updating CumulusUtils ===
=== Updating CumulusUtils ===
Line 68: Line 68:


To avoid confusion it is left to the user to edit and maintain the files for use either on the website or on the CumulusMX machine.
To avoid confusion it is left to the user to edit and maintain the files for use either on the website or on the CumulusMX machine.
=== Manually installing without FTP ===
NOTE: Not using FTP is disadvised. Because CumulusUtils is datadriven it requires the JSON files and the realtime.txt and realtimegauges.txt from CMX. BEsides those, if you are using the UserAskedData feature of CumulusUtils there will be additional JSON files required for the server and without FTP your will need a way to get them there. There is no copy feature like CMX has as CumulusUtils is designed as a website tool and FTP is implicitely assumed present. However, manual handling can be done but is not supported.
All required installation and generated files are present in the utils directory and copied with FTP to the server during a run of CumulusUtils.
If you don't use FTP you will have to copy manually.
The list of installation files required and their destination is below. The generated Javascript files are included in the table:
{| class="wikitable"
|-
! Distribution File !! Destination !! Remark
|-
| index.html || <webroot>
|-
| gauges.js || <webroot>/lib
|-
| language.js || <webroot>/lib
|-
| HighchartsDefaults.js || <webroot>/lib
|-
| suncalc.js || <webroot>/lib
|-
| tween.min.js || <webroot>/lib
|-
| steelseries.min.js || <webroot>/lib
|-
| RGraph.rose.js || <webroot>/lib
|-
| RGraph.common.core.js || <webroot>/lib
|-
| gauges-ss.css || <webroot>/css
|-
! Generated File !! Destination !! Remark
|-
| cumulusutils.js || <webroot>/lib
|-
| HighchartsLanguage.js || <webroot>/lib
|-
! Realtime Files !! Destination !! Remark
|-
| realtime.txt || <webroot> || Served by CMX
|-
| realtimegauges.txt || <webroot> || Served by CMX
|-
| airlinkrealtime.txt || <webroot> || When device is configured*
|-
| extrasensorsrealtime.txt || <webroot> || When device is configured*
|}
* : these files are generated in the utils directory and need to be configured as Extra Webfiles in CMX with the ticks: Realtime, Process and FTP. Note that the generated file has the webtags and remains local, the processed files contains the values and must be send to the <webroot>.


== Running CumulusUtils ==
== Running CumulusUtils ==