1,123
edits
SteelSeries Gauges: Difference between revisions
Updated to v2.1.0, added VWS details
No edit summary |
(Updated to v2.1.0, added VWS details) |
||
| Line 1: | Line 1: | ||
{{AddOnBanner|name=SteelSeries Gauges|type=Web Page|author=Mark Crossley|contact='mcrossley' via the forum|updated= | {{AddOnBanner|name=SteelSeries Gauges|type=Web Page|author=Mark Crossley|contact='mcrossley' via the forum|updated=25 Jan 2013|version=2.1.0}} | ||
[[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 41: | Line 41: | ||
4. If required edit the "gauges.js", the key items are at the top: | 4. If required edit the "gauges.js", the key items are at the top: | ||
- The | - 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. | ||
- 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' page. (users with 'old' browsers will be redirected to this page) | ||
| Line 53: | Line 53: | ||
showSolarGauge : false, | showSolarGauge : false, | ||
6. If you have installed to a web folder different from your Cumulus 'root' you will also need to edit the "gauges-ss. | 6. If you have installed to a web folder different from your Cumulus 'root' you will also need to edit the "gauges-ss.htm" file, and amend the relative path to your Cumulus "weatherstyle.css" file. | ||
7. Copy (or move) the folders 'css' and 'scripts' and their contents (the files that are contained in the ZIP file) to the folder where your "gauges-ss.htm" file is located (probably the same folder where all your other Cumulus HTM files are located). | 7. Copy (or move) the folders 'css' and 'scripts' and their contents (the files that are contained in the ZIP file) to the folder where your "gauges-ss.htm" file is located (probably the same folder where all your other Cumulus HTM files are located). | ||
| Line 59: | Line 59: | ||
=== 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. So if you copy these gauges to a folder called 'gauges-ss' in the root of your website, | 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". | |||
== What Next? == | == What Next? == | ||
| Line 132: | Line 133: | ||
The SteelSeries code will clip your images if they exceed the gauge background area, I suggest you size the images similar to your desired gauge size. The code will resize the image to fit the whole background, so it you want to retain the aspect ratio make your images square! | The SteelSeries code will clip your images if they exceed the gauge background area, I suggest you size the images similar to your desired gauge size. The code will resize the image to fit the whole background, so it you want to retain the aspect ratio make your images square! | ||
== | == Removing a Wind Rose 'gauge' == | ||
From release 2.0 I have integrated the Wind Rose 'gauge' into the standard 'package' | From release 2.0 I have integrated the Wind Rose 'gauge' into the standard 'package', from v2.1.0 it is enabled by default. To disable the Wind Rose you have to make the following changes... | ||
1. Edit gauges-ssT.htm and | 1. Edit gauges-ssT.htm/gauges-ss-basic.htm and delete the 'radar' scripts towards the end of the document | ||
<script src="scripts/windrose.js"></script> | <script src="scripts/windrose.js"></script> | ||
<script src="scripts/RGraph.common.core.min.js"></script> | <script src="scripts/RGraph.common.core.min.js"></script> | ||
| Line 150: | Line 145: | ||
2. Edit gauges.js, and change... | 2. Edit gauges.js, and change... | ||
showRoseGauge : | showRoseGauge : true, | ||
To... | To... | ||
showRoseGauge : | showRoseGauge : false, | ||
That's it, the Wind Rose should now | That's it, the Wind Rose should now be removed from your page. | ||
Note for VWS users the Wind Rose will be automatically disabled, but these users should still remove the scripts from the HTML as above to reduce the page load times. | |||
== Altering the gauge 'layout' on the page == | == Altering the gauge 'layout' on the page == | ||
| Line 181: | Line 177: | ||
Once you are happy with your web page I recommend that you minimise all your scripts, and possibly concatenate them - if you do this though, ensure that you maintain the script load order. Concatenation is not as big a speed up as it used to be as most modern browsers no longer 'block' when downloading a script file. | Once you are happy with your web page I recommend that you minimise all your scripts, and possibly concatenate them - if you do this though, ensure that you maintain the script load order. Concatenation is not as big a speed up as it used to be as most modern browsers no longer 'block' when downloading a script file. | ||
== Weather Display Users == | == Weather Display Users == | ||
| Line 200: | Line 197: | ||
The value for Humidex is set to Celsius by default. You may want to change this tag from %humidexcelsius% to %humidexfaren% if you use Fahrenheit as your temperature scale. (there is no WD tag to report the value in your default scale). This and the forecast tag (see above) are the only things you should have to edit in the ccr file. | The value for Humidex is set to Celsius by default. You may want to change this tag from %humidexcelsius% to %humidexfaren% if you use Fahrenheit as your temperature scale. (there is no WD tag to report the value in your default scale). This and the forecast tag (see above) are the only things you should have to edit in the ccr file. | ||
== Virtual Weather Station (VWS) Users == | |||
These files will work with VWS if you have setup VWS to upload the WeatherFlash conditions files (wflash.txt, wflash2.txt). You do not have to purchase WeatherFlash to use these scripts, but | |||
just have to set up VWS to upload the files via HTTP or FTP methods. See VWS, Internet, WeatherFlash dialog for setup and use either Server File or Active Server Page to perform the upload with | |||
an interval of 10 seconds or so. | |||
You need to switch the following value in gauges.js: | |||
weatherProgram : 0, | |||
To... | |||
weatherProgram : 2, | |||
=== steelseriesVWSjson.php === | |||
Configure the steelseriesVWSjson.php file settings area near the top of the file for the location of the WeatherFlash Data/ directory (using relative file addressing), and for your | |||
other preferences (units, timezone, etc.). | |||
In scripts/gauges.js, | |||
* change the weatherProgram variable to 2 to indicate VWS is being used. | |||
* change the imgPathURL to the relative URL location of the VWS vwsNNN.jpg graphs. | |||
* change the realTimeURL_VWS to the relative URL path of the steelseriesVWSjson.php script | |||
In gauges-ss-basic.htm, | |||
* remove the wind rose scripts by deleting the following lines... | |||
<script src="scripts/windrose.js"></script> | |||
<script src="scripts/RGraph.common.core.min.js"></script> | |||
<script src="scripts/RGraph.radar.min.js"></script> | |||
Note that VWS does *not* produce data for all the entries to be displayed. | |||
The following are missing due to this lack of VWS supplied data: | |||
* windrose display: the display will be disabled by default. | |||
* rain chart: the time of last rain is 'n/a'. | |||
* all-time min/max barometer pressure: the Barometer gauge will not show red areas up to the all record low pressure and from the record high pressure to the max of the gauge. | |||
* some gauges show only current values as the min/max values are not computed by VWS. | |||
* the humidex number is not provided by VWS, but computed by the steelseriesVWSjson.php script instead, so there is no humidex graph available. | |||
(Thanks to Ken True of saratoga-weather.org for the VWS support script) | |||
= SteelSeries FAQ = | = SteelSeries FAQ = | ||
| Line 208: | Line 246: | ||
= Downloads = | = Downloads = | ||
The gauges can be downloaded from here: [http://wiki.sandaysoft.com/files/Steelseries/gauges-ss-v2-0 | The gauges can be downloaded from here: [http://wiki.sandaysoft.com/files/Steelseries/gauges-ss-v2-1-0.zip Download here] | ||
= Release History = | = Release History = | ||
The latest version of the gauges is 2.0 | The latest version of the gauges is 2.1.0, a full version history can be [[SteelSeries_Versions|found here]]. | ||
[[Category:WebTools]] | [[Category:WebTools]] | ||