SteelSeries Gauges: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
790 bytes added ,  21:53, 23 October 2018
no edit summary
No edit summary
No edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{AddOnBanner|name=SteelSeries Gauges|type=Web Page|author=Mark Crossley|contact='mcrossley' via the forum|updated=09 June 2013|version=2.4.1}}  
{{AddOnBanner|name=SteelSeries Gauges|type=Web Page|author=Mark Crossley|contact='mcrossley' via the forum|updated=23 October 2018|version=2.7.2}}  
[[Image:gauge.png|left]]
[[Image:gauge.png|left]]
[[Image:Steelseries-sshot-3.jpg|thumb|Default Gauges]]
[[Image:Steelseries-sshot-3.jpg|thumb|Default Gauges]]
Line 13: Line 13:
Each gauge has has an optional pop-up information box that contains some additional text based data for today, and a graph of recent trends for relevant values.
Each gauge has has an optional pop-up information box that contains some additional text based data for today, and a graph of recent trends for relevant values.


Please note that these gauges use HTML5 'features' and so will not run on older browsers, in particular version of Internet Explorer prior to IE9. Also if you are planning on embedding the code in an existing page, then the whole page should be converted to the HTML5 standard.
Please note that these gauges use HTML5 'features' and so will not run on older browsers, in particular versions of Internet Explorer prior to IE9. Also if you are planning on embedding the code in an existing page, then the whole page should be converted to the HTML5 standard.


== Quick Start Guide for Cumulus Users ==
== Quick Start Guide for Cumulus 1 Users (Other software users may want to scan this too) ==


1. Extract all the file in the SteelSeries zip file to a folder on your PC.
1. Extract all the file in the SteelSeries zip file to a folder on your PC.


2. Copy "realtimegaugesT.txt" to your Cumulus web folder.  
2. Copy "realtimegaugesT.txt" to your Cumulus web folder (N.B. The file in the SteelSeries zip is for Cumulus 1, Cumulus MX supplies its own file with this name, but using a slightly different format).  


3. Copy "gauges-ssT.htm" to your Cumulus web folder.  
3. Copy "gauges-ssT.htm" to your Cumulus web folder.  


4. Configure Cumulus Internet | Files to:  
4. On main Cumulus screen, in '''Configuration''' menu, pick ''Internet'' option,  '''Files''' tab and complete a row for each file (again this guide is for Cumulus 1, Cumulus MX automatically uploads realtimegauges as a standard file):  


  realtime file:-
  realtime file:-
Line 31: Line 31:
   Realtime = Yes
   Realtime = Yes
   FTP = Yes (unless you are local hosting)
   FTP = Yes (unless you are local hosting)
  UTF-8 = Yes
   
   
  gauges HTML file:-
  gauges HTML file:-
Line 37: Line 38:
   Process = Yes
   Process = Yes
   Realtime = No
   Realtime = No
   FTP = Yes (unless you are local hosing)  
   FTP = Yes (unless you are local hosting)  
  UTF-8 = Yes


'''''NOTE''': Cumulus does not actually update any data when it processes the web page, it simply replaces the 'static-ish' values such as your station name, location, version etc. If you wish you can edit the .htm file and directly enter the information, then you do not need to get Cumulus to process the file, just copy it once to your web site, removing the 'T' from the filename. OR, you can let Cumulus process and upload the HTML file to your web site a few times, then disable it again.''  
(The standard Cumulus template is Cumulus\web\gaugesT.htm, this uses  "Cumulus\web\gauges-ssT.htm" so you can retain the old one).
'''''NOTE''': Cumulus does not actually update any data when it processes the (gauges-ssT.htm) web template, it simply replaces the 'static-ish' values such as your station name, location, version etc. If you wish you can edit the ''gauges-ssT.htm'' file and directly enter the information, then you do not need to get Cumulus to process the file, just copy it once to your web site, removing the 'T' from the filename. OR, you can let Cumulus process and upload the HTML file to your web site a few times, then remove it from 'files' tab table.''  


5. If required edit the "gauges.js", the key items are at the top:  
5. If required edit the "gauges.js", the key items are at the top:  


  - The path on your website to the "realtimegauges.txt" file.
  - The path on your website to the "realtimegauges.txt" file.
  - The relative path on your website to your 'trend' graphs folder.
  - The relative path on your website to your 'trend' graphs folder (''images'' in standard Cumulus set up).
  - The relative path on your website to your old 'gauges' page. (users with 'old' browsers will be redirected to this page)
  - The relative path on your website to your old 'gauges.htm' page. (users with 'old' browsers will be redirected to this page)


6. If you do not require the UV/Solar Index gauges, then change the lines  
6. If you do not require the UV/Solar Index gauges, then change the lines  
Line 55: Line 58:
   showSolarGauge   : false,
   showSolarGauge   : false,


7. If you are installing to a web folder different from your Cumulus 'root' on your web server, you will also need to edit the "gauges-ss.htm" file, and amend the relative path to your Cumulus "weatherstyle.css" file.  
7. FTP the folders 'css' and 'scripts' and their contents (the files that are contained in the ZIP file) from your PC to the folder where your "gauges-ss.htm" file is located (probably the same folder where all your other Cumulus HTM files are located) on your web server.  


8. FTP the folders 'css' and 'scripts' and their contents (the files that are contained in the ZIP file) from your PC to the folder where your "gauges-ss.htm" file is located (probably the same folder where all your other Cumulus HTM files are located) on your web server.
8. Test the page.
 
9. Test the page.


=== Relative Paths  ===
=== Relative Paths  ===


Are just that, they specify where something is on your web site folder structure relative to the page you are currently displaying.
Are just that, they specify where something is on your web site folder structure relative to the page you are currently displaying.
So if you copy these gauges to a folder called 'gauges-ss' in the root of your website, the relative path of the Cumulus css file is one folder back in the path. You would then enter the path as "../weatherstyle.css".
If you are installing to a web folder different from your Cumulus 'root' on your web server, you will first need to edit the "gauges-ss.htm" file, and amend the relative path to your Cumulus "weatherstyle.css" file. So if you copy these gauges to a folder called 'gauges-ss' in the root of your website, the relative path of the Cumulus css file is one folder back in the path. You would then enter the path as "../weatherstyle.css".


== What Next?  ==
== What Next?  ==
Line 282: Line 283:
= Downloads =
= Downloads =


The gauges can be downloaded from here: [http://wiki.sandaysoft.com/files/Steelseries/gauges-ss-v2-4-1.zip Download here]
The code for the gauges is now on GitHub, it can be [https://github.com/mcrossley/SteelSeries-Weather-Gauges/ viewed here].
The gauges package can be downloaded from here: [https://github.com/mcrossley/SteelSeries-Weather-Gauges/archive/master.zip Download here].




= Release History  =
= Release History  =


The latest version of the gauges is 2.4.1, a full version history can be [[SteelSeries_Versions|found here]].
The latest version of the gauges is 2.7.2, a full version history can be [[SteelSeries_Versions|found here]].




[[Category:SteelSeries]]
[[Category:SteelSeries]]

Navigation menu