forked from mcrossley/SteelSeries-Weather-Gauges
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ReadMe.txt
1279 lines (1078 loc) · 57.5 KB
/
ReadMe.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
SteelSeries JavaScript gauges
=============================
Created by Mark Crossley July 2011
Version 2.6.4
Updated: 12 December 2017
+-------------------------------------------------------+
| |
| Please read the more comprehensive notes on the Wiki: |
| http://wiki.sandaysoft.com/a/SteelSeries_Gauges |
| |
| And the FAQ on the Wiki: |
| http://wiki.sandaysoft.com/a/SteelSeries_FAQ |
| |
| Released under GNU GENERAL PUBLIC LICENSE |
| Version 2, June 1991 |
| See the enclosed License file |
| |
+------------------------------------------------------ +
Setting Up For Cumulus Users
============================
Some brief notes for Cumulus users (but other users should skim this as well):
Copy "weather_server\cumulus\realtimegaugesT.txt" to your Cumulus\web folder.
Copy "weather_server\cumulus\gauges-ssT.htm" to your Cumulus\web folder.
Configure Cumulus Internet|Files to:
realtime file:-
Local filename = <path>\Cumulus\web\realtimegaugesT.txt
Remote filename = <website_root_path>/realtimegauges.txt
Process = Yes
Realtime = Yes
FTP = Yes (unless you are local hosting)
gauges HTML file:-
Local filename = <path>\Cumulus\web\gauges-ssT.htm
Remote filename = <website_root_path>/gauges-ss.htm
Process = Yes
Realtime = No
FTP = Yes (unless you are local hosing)
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 file name.
If required edit the "gauges.js", the key items are at the top:
The relative 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 old 'gauges' page.
- users with 'old' browsers will be redirected to this page.
If you do not require the UV/Solar Index gauges, then change the lines
showUvGauge : true,
showSolarGauge : true,
to
showUvGauge : false,
showSolarGauge : false,
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.
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, the relative path of the Cumulus css file is one folder back in the
path. You would then enter the path as "../weatherstyle.css".
Copy (or move) the folders 'web_server\css' and 'web_server\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).
What Next?
----------
After you get your new gauges page up and running, you will probably want to make it the
default gauges page on your web site. So assuming you are running the 'standard' Cumulus
web pages (if not then you can figure all this stuff out for yourself), you will need to
edit all the Cumulus supplied template files.
These files reside in your "<path_to_cumulus>\cumulus\web" folder. You will need to edit
each xxxxxT.htm file, and near the bottom change the link from "gauges.htm" to "gauges-ss.htm"
(also include the path if you have installed the SS gauges into a sub-folder from you main
Cumulus web site).
Next time Cumulus updates your web site, the links on all your existing pages should now
point to the new SS gauges.
It is as well to leave the original Cumulus gauges page on your site, the new page will direct
any really old incompatible browsers back to the original page.
If you decide on a different 'standard' gauge size, then you need to edit the gauges-ss.css
file. By default all the gauges use the ".gaugeSizeStd" class, simply change the width and height
settings there.
You can also remove any HTML elements associated with gauges you will not use as well, again
this is not mandatory, the script will remove them dynamically for you.
Browser Redirects
-----------------
If you want to redirect browsers that do not have scripting enabled, then you will have to
do this in the HTML file itself. In the header section add the following code:
<noscript>
<meta http-equiv="refresh" content="3; url=index.htm"/>
</noscript>
Obviously with the url changed to where ever you want redirect pointing.
Changing Languages
------------------
To switch statically, you need to edit the "gauges.js" file, and change the line 12
var strings = LANG.EN,
to
var strings = LANG.XX,
(where XX is the desired language code).
To add a new translation, edit the "language.js" file and copy one of the existing sections
e.g. English, to the end of the file, changing all the LANG.EN values to LANG.XX (where XX is
the code for the new language), and editing all the strings. The zip file contains a
language.js file with English, French, German, Dutch, Swedish, Danish, Finnish, Norwegian, Italian,
Spanish, and Catalan translations to get you going.
If you are only going to use one language, then deleting the unused language options and the
changeLang() function from the language.js file will speed up the page load time slightly.
To switch languages dynamically, you need to add script code to your page which sets the LANG
object to equal the desired language then call the changeLang() function.
e.g.
// Dynamic script to change the default language to German
changeLang(LANG.DE);
This will re-label all the gauges, and update the text/radio buttons etc on the web page.
However, changing the language for the gauges DOES NOT translate the displayed forecast
as the text of the message is being supplied by your weather station/software.
NOTE: If your forecast messages use accented characters (or any character not in the basic 103
characters in the LCD font), then I recommend that you disable the digital font on the status/forecast
display. Set the following in gauges.js:
digitalForecast : false,
Weather Display users have different options for the forecast message to be used. By default the
ccrlocal file uses the Davis VP %vpforecasttext% tag. Change this to what suits you best:
%vpforecasttext% Davis VP forecast
%forecasticonword% Words for the (Davis?) forecast icon
%dailywarning/forecast% forecast from input daily weather
Adding Logo's/Custom Images to the Gauge Backgrounds
----------------------------------------------------
The supplied code contains some commented out instructions to add a small logo to the temperature
gauge, and a larger image to the DewPoint gauge. These will probably be removed by most people,
they are added to demonstrate how to use this feature. See the comments in gauges.js about
removing/adding these logos.
In order to let the gauge background appear through your images you should make them
semi-transparent, which means saving them as PNG files.
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!
Forecast Messages
-----------------
By default for Cumulus the <#forecastenc> message is displayed which shows either the Cumulus
generated forecast or the external station generated forecast depending on how Cumulus is configured.
Starting with version 1.9.2 Cumulus has additional forecast message options:
<#cumulusforecastenc> - Always displays the Cumulus generated Zambretti forecast
<#wsforecastenc> - Always displays the external weather station forecast
If you wish to use one of these options, then you should edit the "realtimegaugesT.txt" file
and replace the '<#forecastenc>' tag with the one of your choice.
You can of course opt not to display the forecast at all, but display any data available from
your weather programs 'tags'.
Removing a Wind Rose and Other Optional Gauges
----------------------------------------------
From release 2.0 I have integrated the Wind Rose 'gauge' into the standard 'package', from v2.1.0 it is enabled
by default. From version 2.5.0 there is also an optional Cloud Base gauge, again enabled by default.
To disable the Wind Rose you have to make the following changes...
1. Edit gauges-ssT.htm/gauges-ss-basic.htm/gauges-ss-basic-inc.php and delete the 'radar' scripts
towards the end of the document.
<script src="scripts/RGraph.common.core.min.js"></script>
<script src="scripts/RGraph.rose.min.js"></script>
2. Edit gauges.js, and change...
showRoseGauge : true,
To...
showRoseGauge : false,
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.
To disable the other optional gauges, just edit gauges.js and change the following entries to 'false'...
showCloudGauge : true,
showUvGauge : true,
showSolarGauge : true,
Altering the gauge 'layout' on the page
---------------------------------------
It is easy to 'move' the gauges around the page to create alternative layouts. By default, there are
four rows of gauges laid out like this (letter = optional gauge)...
* * *
* * r r: Wind Rose
* * *
u s c u: UV-I, s: Solar, c: Cloudbase
To move the gauges you just need to edit the HTML file and move <div>'s (and their contents) with a
class="gauge". Each 'row' is contained within a <div> with a class="row". If you do re-order the
gauges, then DO NOT change the "tip_N" numbers, each number is associated with a particular gauge not
it's position on the page.
Altering the gauge sizes on the page
------------------------------------
From version 2.2.0 the sizes of the gauges is controlled via CSS and longer coded in the gauges.js
script. By default all the gauge canvas tags are set to pick up their size from the ".gaugeSizeStd"
class in gauges-ss.css file. To change the size of all the gauges, simply edit this class and set the
width & height to your required size - the width and height should always be the same.
You can easily have different sized gauges on the same page, in the gauges-ss.css I have created two
additional classes ".gaugeSizeSml" and ".gaugeSizeLrg", (again you can edit the width/height values
of these classes to whatever you want), to assign one of these alternative sizes to a gauge, edit
the HTML and change (for example)...
<canvas id="canvas_baro" class="gaugeSizeStd"></canvas>
to
<canvas id="canvas_baro" class="gaugeSizeLrg"></canvas>
This would change the Barometer from a 221 pixel gauge, to 261 pixels (using the default values).
Weather Display Users
=====================
These files will work with WD if you switch the following value in gauges.js:
weatherProgram : 0,
To...
weatherProgram : 1,
This will make the script use the WD customclientraw.json file rather than the Cumulus realtimegauges.json file.
A template for this file suitable for processing by WD is provided in the zip file - weather_server/weather_display/customclientrawlocal.txt
To process the customclientrawlocal.txt, in WD you need to:
* in control panel, webfiles/web page setup, real time ftp setup
* see the custom client raw file setup...and tick to create that
* make sure the needed customclientrawlocal.txt is in the clientraw folder location
For Weather Display you should use the provided HTML files gauges-ss-basic.htm, or gauges-ss-basic-inc.php. The file
gauges-ssT.htm is designed to be 'processed' by Cumulus before uploading to the web site.
customclientrawlocal.txt
------------------------
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).
The value for Cloudbase is set to metres by default. You may want to change this tag
from %cloudheightmeters% to %cloudheightfeet%, remember to also change the value for
"cloudbaseunit":"m" to "cloudbaseunit":"ft"
These 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 set-up 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.
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, time zone, 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/RGraph.common.core.min.js"></script>
<script src="scripts/RGraph.rose.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:
* wind rose 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)
WeatherCat Users
================
Please see the WeatherCat wiki page for instructions: http://wiki.trixology.com/index.php/Steel_Series_Gauges
Meteobridge Users
=================
Some features of the gauges page are not available, when you configure the program type to "4" the
script automatically disables the Wind Rose gauge and the pop-up graphs.
(Thanks to Ken True of saratoga-weather.org for the Meteobridge support script)
WView Users
===========
In order to use the wind rose features, you may need to tweak your installation to produce the required
data. The supplied file uses the tag <!--dayWindRoseList-->. Please see this thread...
https://groups.google.com/d/msg/wview/Yxdy5IS0R6U/RhFv4eUBd-MJ
WeeWX Users
===========
Please refer to the separate readme.txt in the weather_server\WeeWX folder.
What is 'Long Polling'
======================
HTTP long polling is a technique for only downloading data from the server when it is updated. An outline
of the process is below, because it requires action on the web servers part, it requires something like PHP
to be running on the web server.
1. The client requests the webpage from the server using regular http.
2. The webpage executes javascript which requests the realtime from the server.
3. The server does not immediately respond with the requested file but waits until the file is updated.
4. When there is new data available, the server responds with the new file.
5. The client receives the new data and immediately sends another request to the server, re-starting the process at step 3.
Configuring Long Polling
------------------------
Standard long polling is only available for those web sites running PHP. The steps involved are:
1. First establish the web site using the standard realtime text file for your weather software.
2. Edit the long polling PHP file 'realtimegauges-longpoll.php', and set the name and path of your realtime file on the web server:
$RealtimeFilename = $_SERVER['DOCUMENT_ROOT'].'/realtimegauges.txt';
3. Upload the long polling PHP file 'realtimegauges-longpoll.php' to your web server.
4. Edit the gauges.js script on your web server, and enable long polling:
config = {
...
longPoll : true, // if enabled, use long polling and PHP generated data !!only enable if you understand how this is implemented!!
Then set the path to the long polling PHP file:
...
realTimeURL_LongPoll: './utils/realtimegauges-longpoll.php', //*** ALL Users: Change to your location of the PHP long poll realtime file ***
Check that the realtime update interval is set correctly to your realtime interval:
...
realtimeInterval : 5, //*** Download data interval, set to your realtime data update interval in seconds
Test it out, it should download the JSON data when the page loads, then every time the file is updated on the server.
It is important that you also correctly configure the realtim upload interval, as this is used to determine if the next
download request should be queued immediately or delayed a while. PHP by default has a maximum 30 second runtime for
scripts, so we do not want to wait for a response longer than that - the script sets the max wait time to 20 seconds.
Cloud Base Gauge
===================
The cloud base gauge performs some rounding of the displayed values to prevent the display bouncing around too much.
If the display is in metres, then values below 1000 m are rounded to 10 m, above 1000 m, they are rounded to 50 m.
If the display is in feet, then values below 2000 ft are rounded to 50 ft, above 2000 ft, they are rounded to 100 ft.
Release History
=======================
2.6.4
Updated to be more http/https friendly
Uplifts JQuery version to 3.2.1 from obsolete 1.11
* gauges.js
* gauges-ss-basic-inc.php
* gauges-ss-basic.htm
2.6.3
Updated
* gauges.js
* gauges-ss-basic-inc.php
* gauges-ss-basic.htm
- Added rel="noopener" to progam html links
2.6.2
* Updated gauges.js
- Solar gauge: Fixed the "over theoretical" sector not displaying correctly above the default gauge max scale value.
- Solar gauge: Added sector to indicate 'sun is shining'.
- Wind gauge: Added animation to rescaling.
- UV gauge: Added rescaling back to default and animation.
- Rain gauge: Added rescaling back to default.
2.6.1
* Updated gauges.js
- Fixed the odometer label colour not changing with the background colour.
2.6.0
* Updated gauges.js
- *Really* fixed scaling issues with rain gauge ;)
- Added support for Weather Link/WL.com as a data source [Note requires a Saratoga template module]
- Added title to Windrose odometer
* Updated language.js/language.min.js
- Added strings for mile, km, n_mile (nautical mile), used for WindRose odometer title
2.5.19
* Updated gauges.js
- Added tweak to rain gauge to fix constant redraws due to maxValue/maxScale mismatch when using default niceScale.
2.5.18
* Updated gauges.js
- Added CS tweak for WD users who normally use wxgraphs for the popup images, changes aspect ratio.
- Now obeys the various default scale ranges in gaugeGlobals.[gauge]ScaleDef[Min|Max][unit] settings
2.5.17
* Updated gauges.js
- Added new config item "showWindMetar" to enable the METAR substring for wind on the direction gauge,
the default is now disabled (was enabled). Previously you could only disable it by not showing any
wind variation on the gauge.
2.5.16
* Updated gauges.js
- Minor code style/format changes
- Fixed the display of todays high/low decimal places the singleBaro.update() function
- Fixed an issue with the Ajax timeout error handling
- Amended the hPa to inchesHg conversion to use 3 decimals for inches
- Amended the popup tooltip positioning and sizing to try and keep it on-screen better on tiny displays
- Added config.roundCloudbaseVal to enable/disable cloud base rounding for display
* Updated gauges-ssT.htm, index.html.tmpl, gauges-ssT.htx, steelseriesVWSjson.php
- Fixed the demo HTML templates to use double quotes for element ids
* Updated steelseriesVWSjson.php
- Added no cache header
- Cosmetic changes
* Updated gauge-data.txt.tmpl (Changes via pull request 3 from gjr80)
- humidex calc now (correctly) uses dewpoint in degree K
- removed redunant code in humidex and apptemp calcs
* Updated language.js language.min.js
- Minor change to Norwegian 'meters' -> 'meter'
2.5.15
* Updated gauges.js
- Removed deprecated RegExp.$1, and .selector code, plus other changes around the popups to make them compatible with JQuery 3.0
2.5.14
* Updated gauges.js
- Reversed style change which named all functions. Back to anonymous functions.
2.5.13
* Updated gauges.js
- Switched to using ESLINT and some stylistic changes to code and layout
- Fix to Cloudbase autoscaling
2.5.12
* Updated gauges.js
- Auto-disable wind variantion for MeteoBridge users
- Uplift weewx data template version to 13
* Updated gauge-data.txt.tmpl
- Now uses non-localised units for more robust data conversions
- Corrected dew point calculation
- Improved rain in mm calculation
2.5.11
* Updated gauge-data.txt.tmpl
- Fixes some data issues for WeeWx users
2.5.10
* Updated gauges.js
- Improved rainrate and rainfall coloured sections for imperial units, they are now calculated from the metric units
* Updated the SteelSeries library (steelseries.js, steelseries.min.js, steelseries_tween.min.js)
- Updated from version 0.14.13 to 0.14.16
2.5.9
* Updated gauges.js
- Applied fix for WView (lack of cloudbase unit)
* Updated customclientraw.txtx (for WView)
- Added cloudbase value/unit, incremented version to 11
2.5.8
* Updated gauges.js
- Applied fix 2.5.7 to the temperature gauge as well, doh!
- Fixed HTTP GET timeout errors when using long polling with real time intervals >= 30 seconds
- Fixed broken code that prevented the page timing out when a valid password was supplied to the 'pageUpdate' URL parameter
2.5.7
* Updated gauges.js
- Fix to the dewpoint gauge, now handles invalid values for today's hi/lo's more sensibly
2.5.6
* Updated language.js/language.min.js
- Improved/added missing German translation from wurzelmac
2.5.5
* Updated gauges.js
- Fixed UTF-8 corruption of °C & °F introduced in 2.5.4
- Changed WeatherCat cloudbase graph from pressure1.jpg to cloudbase1.jpg
- Added gaugeGlobal values for the direction gauge average pointer type and colour
2.5.4
* Updated gauges.js
- Internal changes to support Cumulus MX dashboard
- More error checking added for missing gauges on HTML page, it will now tolerate the removal of the LED,
timer, status display etc.
- Enables the cloudbase gauge for WeatherCat - Must be running WC version 2.10 or later
* Updated realtimegaugesWC.txt, added cloudbase
2.5.3
* Updated steelseries.js/steelseries.min.js/steelseries_tween.min.js
- Moved to version 0.14.13 - Bug fixes affecting the wind direction gauge
2.5.2
* Updated gauges.js to fix language switch in Saratoga SS gauge template file.
- Also requires a change to the Saratoga template file, the initial call to changeLang() needs to be changed to:
print "<script type=\"text/javascript\">
$(document).ready(function () {
changeLang(LANG.$toLang); // change SteelSeries language\n
});</script>\n";
2.5.1
* Updated WD customclientrawlocal.txt to fix cloudbasevalue key, now version 12.
* Updated WeeWX gauge-data.txt.tmpl to fix cloudbasevalue key, now version 12.
* Updated gauges.js to mandate WD & WeeWX JSON version 12 files.
2.5.0
* Adds support for WView
- New files: gauges-ss-basic.htx, customclientraw.txtx, pre-generate.sh
* Adds support for WeeWX
- New files: index.htm.tmpl, skin.conf, gauge-data.txt.tmpl
* Rearranged the archive file to make it bit easier to understand
- New folder "web_server", contains all the files for uploading to your web server
- New folder "weather_server", sub-folders contain the files to be processed by the respective weather package.
* Added option for 'long polling'
- For people with PHP driven web sites, this downloads the data file each time it is updated on the web server
rather than at a fixed polling interval.
- Currently only works with a realtimegauges.txt file
- Experimental versions available for Cumulus, and Saratoga templates using PHP variables.
* Updated gauges.js
- Added optional cloud base gauge.
- Fixed a typo that was preventing the humidity graph updating (no cache defeat).
- Added optional 'wind rose' data to the wind direction gauge (enabled by default).
- Added optional 'sun shining' LED to solar gauge (enabled by default).
- Implemented the missing code for the rain/rainrate gauge default maximum values
- Fixed windspeed default unit radio button behaviour
- Added indoor humidity lo/hi for WeatherCat, Weather Display, VWS
- Moved Wind Rose code from separate windrose.js file into the main gauges.js file.
- Changed all the gauge updates to be event driven.
- A one second timer tick event:- 'gauges.clockTick'
- An Ajax data update event:- 'gauges.dataUpdated'
- A graphs need refresh event:- 'gauges.graphUpdate'
You could make use of these events outside the gauge code to update other page elements.
- Reorganised code to keep 'most' of a single gauges logic within the gauge singleton definition.
- Added option to not display the graphs in the pop-ups when running on a phone.
* Updated language.js/language.min.js
- Added cloud base gauge strings.
- Added Czech translation
* Updated realtime JSON files to include cloud base and indoor humidity lo/hi
- Cmumulus: realtimegaugesT.txt, version 12.
- Weather Display: customclientraw.txt, version 11.
- VWS: steelseriesVWSjson.php, version 1.04/11.
* Updated HTML to include cloud base gauge and UoM selection, update to JQuery library version 1.10.2
- gauges-ss-basic.htm
- gauges-ssT.htm
- gauge-ss-basic-inc.php
* Removed windrose.js file from package
* Updated gauges.css
- Minor sytling updates
* Updated steelseries.js/steelseries.min.js/steelseries_tween.min.js
- Moved to version 0.14.12
* Added a realtimeGaugesTMX.txt file for the new Cumulus MX program.
* Source for the scripts and download package moved to GitHub
- Latest download: https://github.com/mcrossley/SteelSeries-Weather-Gauges/archive/master.zip
- GitHub page: https://github.com/mcrossley/SteelSeries-Weather-Gauges/
2.4.4
* Updated language.js/language.min.js
- Added missing Swedish translation strings.
* Updated gauges.js
- Fixed rainfall rate gauge starting from zero at each refresh for high rate values.
2.4.3
* Updated gauges.js
- Changed UV level thresholds from integer boundaries to 1 dp rounded boundaries. UVI is normally
quoted as a rounded integer value, so if we are displaying decimals we should use n.5 as the transition.
- Added missing unit conversion for today's maximum hourly rain rate.
* Updated language.js/language.min.js
- Changed English UV "Little Risk" wording to "Moderate Risk" to fall in-line with many recommended wordings.
Other translations need looking at.
2.4.2
* Updated gauges.js
- Fixed rain gauge autoscaling between 0.5 and 1.0 when using Inches!
2.4.1
* Updated gauges.js
- Fixed rain rate gauge autoscaling between 0.5 and 1.0 when using Inches
2.4.0
* Updated gauges.js
- Added global gauge option fullScaleDeflectionTime to control pointer 'speed'
- Changed the UV gauge to use new gradient scale colours by default
- Added Today's High value to the UV gauge
- Changed rain gauge to always use blue LEDs - line 653
- Fixed the 0.5" rain gauge code introduced in version 2.3.1
- Applied fix for VWS not supplying the correct value for max rain rate today
* Updated the realtime JSON files to include today's high UV value
- Cumulus - realtimegaugesT.txt - v11
- Weather Display - customeclientrawlocal.txt - v10
- Weather Cat - realtimegaugesWC.txt - v12
- Meteobridge - see Ken True's web site for updated script - v10
2.3.2
* Only WeatherCat users need to update from v2.3.1 unless you want the additional Portuguese translation
* WeatherCat version 1.2 or later is required to run this update
* Updated gauges.js
- Fixed handling of current theoretical solar radiation in doSolar() for WC users
- Made realtimegauges JSON file weather program dependent so updates to the JSON file for one program can
be made independently of the others
* Updated realtimegaugesWC.txt
- Added tag value for CurrentSolarMax to replace "N/A"
- Version uplifted to 11
* Updated language.js/language.min.js
- Added Portuguese translation by 'Werk_AG'
2.3.1
* Updated gauges.js
- Fixed wind direction variability calculation to cope with full 360 direction changes in the last 10 minutes
- Change wind direction METAR variability speed threshold from USA based 6kts to European 3kts (line 1783
if you want to change it back)
- Added full wind data to the METAR string
- Fixed the solar gauge, today's max indicator being shown with programs that do not supply this value
- Added missing code to refresh the solar graph periodically
- Added fix for WeatherCat not providing current theoretical solar max value
- Added new user configurable options for the rain and rain-rate gauges default max scale values
- Reset the inch rain and rain-rate gauges default max scale value from 1.0 to 0.5 inches, and when the max
scale is less than 1.0in, use two decimal places.
* Updated gauges-ss-basic.htm
- Fixed two HTML5 errors
* Updated realtimegaugesT.txt (ver 10) (Cumulus)
- Added missing today's solar max value
* Updated realtimegaugesWC.txt (ver 10) (WeatherCat)
- Moved today's max value from current theoretical max to today's max
* Updated src/steelseries.js
- New library version v0.14.3 - Fixes script exception/crash in Firefox v21+
- Also updated src/steelseries.min.js & steelseries_tween.min.js
* Removed jquery-1.8.2.min.js from the distribution
2.3.0
* Updated gauges.js
- Added support for Meteobridge.
* Updated windrose.js
- Fixed 'blurry' appearance of the rose plot at some gauge sizes.
2.2.3
* Updated gauges.js
- Fixed bug in handling WeatherCat wind speeds in Knots
* Updated steelseries.js, steelseries.min.js, steelseries_tween.min.js
- Now up to SS v0.14.0 (adds support for user LED's)
* Updated windrose.js
- Minor tweaks
2.2.2
* Updated gauges.js
- Fixed mph & knots wind unit handling for WeatherCat users only
* Updated languages.js
- Netherlands strings updated
2.2.1
* Updated gauges-ssT.htm
- Fixed typo in <span id="lang_longtitude"> -> <span id="lang_longitude">
* Updated gauges.js
- Fixed automatic gauge resizing on 'mobile' devices.
2.2.0
* Updated gauges.js
- Added support for WeatherCat
- Changed gauge shadow default to 30% black, and added gauge.shadowColour parameter
- All gauges now take their size from the HTML/CSS, this means they can easily be indiviually resized
- Moved solarGaugeScaleMax from 'config' to 'gauge' where it more logically belongs with the other scale values
* Updated gauges-ss.css
- Added classes gaugeSizeSml, gaugeSizeStd, gaugeSizeLrg
* Updated windrose.js
- Now picks up gauge shadow colour from gauges.gauge.shadowColour
- Gauge shadow code now picked up from gauges.js
- Internal renaming of variables from radar to rose
* Added file gauges-ss-basic-inc.php
- Provides a page to integrate with Ken True's popular Saratoga web site templates
* Update gauges-ssT.htm, gauges-ss-basic.htm, gauges-ss-basic-inc.php
- All gauge sizes (width/height) now replaced with class="gaugeSizeStd"
- Amended the status LCD panel and timer LCD panel sizes to match sizes previously set in the gauges.js script
- Changed rose script from RGraph.radar.min.js to RGraph.radar.min.js
* Updated steelseries.js, steelseries.min.js, steelseries_tween.min.js
- Now up to SS v 0.13.0
* Removed RGraph.radar.js/Rgraph.radar.min.js
- Added RGraph.rose.js/RGraph.rose.min.js
2.1.1
* Updated windrose.js
- Made the compass point symbols slightly larger and darker.
- Fixed problems with the odometer positioning on some pages.
* Updated language.js/language.min.js
- Completed Greek, Finnish, & Norwegan translations.
- Updated Spanish & Catalan translations.
* Renamed the combined steelseries & tween file from "steelseries.min.js" to "steelseries_tween.min.js"
- No functional changes
* Updated gauges-ssT.htm & gauges-ss-basic.htm
- To pick up renamed steelseries_tween.min.js file
- No functional changes
* Updated gauges.js
- Fixed wind run display units handling when source data is non-metric and the browser does not have a cookie set.
- Added in 'missing' code to make the LED flash red when the page timeout occurs.
2.1.0
* New file gauges-ss-basic.htm
- This is a minimal html page to display the gauges, suitable for including in an existing page via an <iframe>
tag, or including in PHP scripts.
* Updated gauges.js
- Made the Wind rose enabled by default.
- Added option to disable the Wind Run odometer on the Wind Rose.
- Changes to support Wind Run odometer.
- Added support for VWS.
* Updated windrose.js
- Changes to support the Wind Run odometer.
* Updated gauges.css
- Changes to support the Wind Run odometer.
* Updated gauges-ssT.htm
- Windrose radar scripts are now enabled by default
* Updated realtimegaugesT.txt & customclientrawlocal.txt
- Added "windrun" = wind run today - for odometer
* Updated languages.js/languages.min.js
- Added - windruntoday: "Wind run today" - translations required please!
* New file steelseriesVWSjson.php
- Generates the JSON data for VWS users
* Removed file weatherstyle.css
- This is used by the Cumulus template(gauges-ssT.htm) and was only included for WD users, Cumulus users
would already have this file. I expect WD & VWS users to use the gauges-ss-basic.htm which does not
use this style sheet.
2.0.4
* Updated gauges.js
- Fixed check/redirect for browsers not supporting canvas, this had been broken by the 2.0 changes.
* Updated steelseries.min.js
- Now version 0.12.1 - fixes with WindDir gauge when setting average value=360, implements configurable time
for full scale pointer deflection.
* Renamed gauges-ssT.html to gauges-ssT.htm to match the rest of the Cumulus template files
2.0.3
* Updated gauges.js
- Internal structural change to the LED handling
- Removes RGraph attribution from HTML if the Wind Rose is not used
- Added onClick event to the status LED to restart page updates after a timeout
- Added gauge drop shadows
* Updated gauges-ssT.html
- Changed default canvas size from 251 to match the 'scripted' size of 221
- Added RGraph attribution (required by licencing terms)
* Updated steelseries.js (and .min)
- Latest 0.12.0 build from Github
* Updated windrose.js
- Fixed display issues on resizing by resizing rose canvas object on the main page
- Added gauge drop shadows
* Updated language.js
- French translation now complete, thanks Jacques
- Change page timeout text to read '...click status LED to restart' instead of '...refresh browser'
* Updated gauges-ss.css
- Added some elements from weatherstyle.css to reduce dependency on weatherstyle.css
2.0.2
* Updated gauges.js
- Fixed WD problems when using windspeed units of km/h
- Changed barometer scale to use 1 decimal place on the kPa scale
* Updated gauges-ss.css
- Added 'content' class definitionS
2.0.1
* Updated gauges.js
- Fixed syntax error that affected WD users
2.0.0
* Much of the code rewritten and/or reformatted
- Most things now contained in a 'gauges' object to avoid polluting the global namespace with
numerous variables etc.
- Load orders changed to speed up initial page load/display
* Updated gauges.js
- Added ability to select the display units:
Temp: °C, °F
Rain: mm, inch
Wind: km/h, m/s, mph, knots
Baro: hPa, mb, inHg, kPa
- Added (optional) cookie handling to preserve end user unit preferences across sessions
- Added variables to set the default min/max values for gauges
- Changed the temperature gauge scaling logic so both gauges always use the same range (except
for the indoor temperature)
- Default units are now 'metric': °C, mm, hPa, km/h
- Fixed bug in getord() routine
- Added config.dewDisplayType setting to control initial 'dew' gauge display
- Added smaller gauge size option for 'mobile' devices
* Updated Language handling, all languages now use a single (English by default) template HTML file,
calling changeLang(LANG.newLanguage) now updates the HTML as well as the gauges.
* Updated realtimeGaugesT.txt & customclientrawlocal.txt
- Added todays dominant wind direction
* Added Danish, Norwegian, and Italian translations
* Changed gauges-ssT.html to use <div>'s for the layout rather than tables.
* Removed ddimgtooltip.css - now incorporated into gauges-ss.css
* Removed ddimgtooltip.js - now incorporated into gauges.js
* Removed tween.min.js - now incorporated into steelseries.min.js
* Updated realtimeGaugesT.txt and ccrT.txt files to ver8 - added dominant wind direction
* Updated steelseries.js
- Updated to v0.11.14
* Added optional Wind Rose 'gauge', this also adds the following scripts. The Wind Rose is not enabled by
default, and the scripts will not downloaded by the page.
- windrose.js
- RGraph.common.core.min.js
- RGraph.radar.min.js
1.6.6
* Updated languages.js
- Added Danish translation - thanks Henrik - but no template HTML file
- Added Finnish translation - thanks Timo
* Updated gauges.js
- Fixed the humidty graph being downloaded every realtime update.
* Added gauges-ssT-fi.htm
- Finnish translation
1.6.5
* Updated gauges.js
- Fixed last rain date calculation
- Added g_weatherProgram variable to indentify Cumulus or Weather Display
- Added g_tipImgs array for WD using wxgraphs
- Fixed temperature gauge not displaying temperature range colour sections on range change.
- Fixed WD baro pressure trend - WD is supplying a 3 hour value, so needed to be divided by 3.
- Added localisation of baro trend text
- Added extended temperature trend strings "slowly/quickly/rapidly"
- Added support for kPa pressure units
- Change default gauge scale number orientation to horizontal
- Changed WindDir gauge labels to NOT be coloured by default: drawDir() -> "useColorLabels : false"
* Updated realtimeGaugesT.txt
- Removed pressure trend text - localised string now derived from trend value
* Updated customclientrawlocal.txt
- Removed pressure trend text - localised string now derived from trend value
- Changed forecast tag to use the Davis VP forecast by default
- Changed todays max gust direction to use the new tag %maxgstdirectiondegree%
* Updated language.js
- Added additional strings for barometer/temperature trends
- Fixed some NL translations
* Updated steelseries.js (& .min)
- Updated to v0.11.1
- WindDirection, added initialisation parameter 'useColorLabels', default = false
* General
- Removed any extraneous BOM characters for UTF-8 encoded files (.html .js .css)
1.6.4
* Updated gauges.js
- Fixed temperature gauges (out & dew) not displaying the min/max shaded area
1.6.3
* Updated gauges.js
- Fixed wind max. avg. speed
- Added g_showPopupDataGraphs variable to switch off graphs from the popup data
- Added different graph image options for each gauge option (dew point, apparent,
etc., out and in humidity)
* Updated language.js
- Dutch translations now complete
* Updated ddimagestooltip.js (and min)
- Removed explicit graph file names, now they are only specified in gauges.js
1.6.2
* Updated gauges.js
- Fixed max gust today indicator on wind gauge
- Fixed baro look-n-feel for 'mb' stations
- Fixed Solar gauge area drawing when value > theoretical
- Changed Cumulus 'in' pressure units to 'inHg'
- Change UV readings to recognise level 0 as unique
- Added back links to Cumulus/Weather Display websites
* Updated languages.js
- French translations now complete
- Added additional UV level 0 text
1.6.1
* Updated realtimegaugesT.txt
- fixed typo for SolarRad
1.6.0
* Updated gauges.js
- Made the script more friendly for Weather Display. It now parses all numeric values before
use and strips out non-numeric data such as units etc.
- Added support for optional Solar Radiation Gauge
- Moved changeLang() function to language.js
* Added customclientrawlocal.txt
- This is the Weather Display equivalent of realtimegaugesT.txt
* Updated realtimegaugesT.txt
- Removed temptrendtext
- Added Solar values
- Updated version to 6
* Updated languages.js
- Added strings for rising/falling/steady, these will now appear localised on the pop-up data rather
than in the station language
- Added strings for Solar gauge
- Added changeLang() function
* Updated gauges-ssT.htm (and variants)
- Made them more program agnostic
- Added Solar Rad. gauge
* Updated ddimgtooltip.js
- Added support for Solar gauge
* Updated steelseries.js
- Made WindDirection LCD label colours match the pointer colours
1.5.4
* Updated gauges.js
- Added WindDirection LCD titles to the changeLang() function
- Increased default page timeout from 10 to 20 minutes
* Updated steelseries.js
- Now version 0.10.2; adds the setLcdTitleStrings() method to the WindDirection gauge
1.5.3
* Updated gauges.js
- Setting g_pageUpdateLimit = 0 disables the page update time limits
- Removed the old redundant no HTML5 support code
1.5.2
* Updated gauges.js
- Fixes script 'hangs' when the realtimegauges.txt file is zero length (e.g. when it is being
updated on the server during the download), and retry after 2 seconds.
- Added a page timeout counter, this stops page updates after a specfied time - default 10 minutes
You can over ride this with a parameter and password in the URL (default = 'its-me'), for example:
http://www.sometwhere.com/gauges-ss.htm?pageUpdate=its-me
- Fixed the browser redirect on no HTML5 Canvas support, it has been broken for a few releases.
* Updated language.js
- Added page timeout string
- Restructured to reduce size a little
- Removed canvas features not supported string
* Updated gauges-ssT.htm
- Added 'no script' message
* Updated this ReadMe.txt with information about browser redirects for script disabled
1.5.1
* Updated SteelSeries library
- v0.9.17 - fixes sector/area drawing issues with Chrome Dev release 19
* Updated gauges-ss.css
- Added references to external ttf, svg, and eot font files for backward compatibility with browsers
that do not support the woff font embedded in the css file.
- Changed gauge table style so it is centered horizontally on page.
* Updated gauges-ssT.htm (+ all translations)
- Changed html so gauges are always centered horizontally on page
* Adds 'font' folder back in to archive
- A subset of the original font files included
* Updated gauges.js
- minor changes to attempt to fix missing zero values on the rain gauges
1.5.0
* REQUIRES Cumulus 1.9.2 build *1029* or later
* Updated gauges.js
- Moved popup initialiastion into gauges.js and after gauge initialisation, this
speeds up the page display at the expense of the popup images not being available immediately after
page load.
- Changed launch of init() from onLoad to onDomReady - in supported browsers.
* Updated ddimgtooltips.js (+ minimised version)