Cumulus Wiki

Realtime.txt: Difference between revisions

Realtime.txt (view source)

Revision as of 16:24, 8 June 2021

16 bytes added ,  16:24, 8 June 2021
m
Update category
m (Update category)
Line 1: Line 1:
<big>'''This page describes a file used only by (the legacy) Cumulus 1.x.y.'''


''It does not document any file of same name in MX; as that file is NOT used by any standard MX feature. Instead MX offers you the ability to automatically update a database table on your web site, adding a new row each time this file would be generated, that row contains the same set of values, with rows for both current and historic data.''
{{Template:WorkInProgressBanner}}{{Template:Version badge Mx}}[[Category:Cumulus MX]][[Category:Cumulus Files]][[Category:MX txt Files]][[Category:Cumulus 1]]


Are you willing to contribute to this documentation, which is for you, and add a section describing how the file content is different in MX, and how it might be used there?</big>
This page was created for Cumulus 1, it has had some updates for MX, but not been kept up to date.
[[Category:Cumulus 1]]


= Introduction =
= Introduction =
Line 14: Line 12:
** Although this file is technically not a 'log file', it is optionally automatically produced by Cumulus, and follows a similar format to the other Log files.
** Although this file is technically not a 'log file', it is optionally automatically produced by Cumulus, and follows a similar format to the other Log files.


[[Image:CumulusInternetSettingsScreen.png|thumb]] This is the legacy screen that controls production of this file. Standard Cumulus only uses this file for the optional real-time wind gauges (see [[#Where is the file used]]). It exists as one way that current Cumulus derivatives can be supplied to [[Category:User Contributions|third party additions]], and its content can be tailored to the needs of whatever you choose.  
 
== Where is the file used in Cumulus 1 ==
[[File:Badge v1.png]]: the following applies only to the legacy Cumulus.
 
The realtime.txt is used only in Cumulus 1 in the following areas:
*the 2 wind graphics at the bottom of the standard 'gauges' page on the website produced by Cumulus
*[[CumulusRealtime]] -- the new application developed in [http://silverlight.net/ SilverLight]
*The [[WeatherConsole]] and [[Sidebar gadget]] [[:Category:AddOns|addons]]
 
==Enabling this file in Cumulus 1==
[[File:Badge v1.png]]: the following applies only to the legacy Cumulus.
 
[[Image:CumulusInternetSettingsScreen.png|thumb]] This is the legacy screen that controls production of this file. Standard Cumulus 1 only uses this file for the optional real-time wind gauges (see [[#Where is the file used]]). It exists as one way that current Cumulus derivatives can be supplied to [[Category:User Contributions|third party additions]], and its content can be tailored to the needs of whatever you choose.  
*The 'interval' sets how often Cumulus produces the file, to set that interval, click on the 'Configuration' menu then 'Internet', then set parameter labelled 'Realtime interval' by entering an integer number of seconds.
*The 'interval' sets how often Cumulus produces the file, to set that interval, click on the 'Configuration' menu then 'Internet', then set parameter labelled 'Realtime interval' by entering an integer number of seconds.
*Optionally the file can be uploaded to your [[Website_setup|externally-hosted web site]], if you want this (and it is usual) select all 3 selectors:
*Optionally the file can be uploaded to your [[Website_setup|externally-hosted web site]], if you want this (and it is usual) select all 3 selectors:
Line 36: Line 46:
On top of your internet connection bandwidth restrictions, you may also have bandwidth caps on your web server so this same figure should be considered for your web server.
On top of your internet connection bandwidth restrictions, you may also have bandwidth caps on your web server so this same figure should be considered for your web server.


= Where is the file used =
= Recreating the file using web tags in C1 =
[[File:Badge v1.png]]: the following applies only to the legacy Cumulus.
 
'''Note:''' that the built-in realtime.txt always uses a 'dot' decimal character (and so is JavaScript/PHP 'safe'), any web tag version will use your host computers localisation for decimals. [There are some [[Webtags#No_Commas|<#RCxxx>]] web tags available but they do not cover all the required values].
 
= Recreating the file using web tags in MX =
[[File:Badge vMx.png]] The following applies only to MX.
 
 
'''Note:''' ''from b3075 onwards, all decimal tags now support the "rc=y" parameter - see below.''
 
To ensure decimal compatibility across systems use a js construct such as:
 
  var rt = realtime.split(" ");
  var temp = +rt[2].replace(',','.');
 
when referring to decimal values in the constructed file.
 
 
For releases after b3074 web tags now accept the "rc=y" parameter, so if your locale uses a comma decimal you must add this parameter to all the web tags that produce decimal values


The realtime.txt is used only in Cumulus 1 in the following areas:
''(this is one complete line, although it may appear on this page as two or more due to screen width restrictions)''  
*the 2 wind graphics at the bottom of the standard 'gauges' page on the website produced by Cumulus
*[[CumulusRealtime]] -- the new application developed in [http://silverlight.net/ SilverLight]
*The [[WeatherConsole]] and [[Sidebar gadget]] [[:Category:AddOns|addons]]


:<code><#date format=dd/mm/yy> <#timehhmmss> <#temp rc=y> <#hum> <#dew rc=y> <#wspeed rc=y> <#wlatest rc=y> <#bearing> <#rrate rc=y> <#rfall rc=y> <#press rc=y> <#currentwdir> <#beaufortnumber> <#windunit> <#tempunitnodeg> <#pressunit> <#rainunit> <#windrun rc=y> <#presstrendval rc=y> <#rmonth rc=y> <#ryear rc=y> <#rfallY rc=y> <#intemp rc=y> <#inhum> <#wchill rc=y> <#temptrend rc=y> <#tempTH rc=y> <#TtempTH> <#tempTL rc=y> <#TtempTL> <#windTM rc=y> <#TwindTM> <#wgustTM rc=y> <#TwgustTM> <#pressTH rc=y> <#TpressTH> <#pressTL rc=y> <#TpressTL> <#version> <#build> <#wgust rc=y> <#heatindex rc=y> <#humidex rc=y> <#UV rc=y> <#ET rc=y> <#SolarRad> <#avgbearing> <#rhour rc=y> <#forecastnumber> <#isdaylight> <#SensorContactLost> <#wdir> <#cloudbasevalue> <#cloudbaseunit> <#apptemp rc=y> <#SunshineHours rc=y> <#CurrentSolarMax> <#IsSunny> <#feelslike rc=y></code>


= List of fields in the file =
= List of fields in the file =
Line 355: Line 382:
<br> <tt>18/10/08 16:03:45 8.4 84 5.8 24.2 33.0 261 0.0 1.0 999.7 W 6 mph C mb mm 146.6 +0.1 85.2 588.4 11.6 20.3 57 3.6 -0.7 10.9 12:00 7.8 14:41 37.4 14:38 44.0 14:28 999.8 16:01 998.4 12:06 1.8.2 448 36.0 10.3 10.5 13 0.2 14 260 2.3 3 1 1 NNW 2040 ft 12.3 11.1 420.1 1 13.6</tt>  
<br> <tt>18/10/08 16:03:45 8.4 84 5.8 24.2 33.0 261 0.0 1.0 999.7 W 6 mph C mb mm 146.6 +0.1 85.2 588.4 11.6 20.3 57 3.6 -0.7 10.9 12:00 7.8 14:41 37.4 14:38 44.0 14:28 999.8 16:01 998.4 12:06 1.8.2 448 36.0 10.3 10.5 13 0.2 14 260 2.3 3 1 1 NNW 2040 ft 12.3 11.1 420.1 1 13.6</tt>  


== Recreating the file using web tags  ==
'''Note:''' that the built-in realtime.txt always uses a 'dot' decimal character (and so is JavaScript/PHP 'safe'), any web tag version will use your host computers localisation for decimals. [There are some #RCxxx webtags available but they do not cover all the required values]
'''Note:''' ''from b3075 onwards, all decimal tags now support the "rc=y" parameter - see below.''
To ensure decimal compatibility across systems use a js construct such as:
  var rt = realtime.split(" ");
  var temp = +rt[2].replace(',','.');
when referring to decimal values in the constructed file.


=== Alternative content ===
=== Alternative content ===
Line 379: Line 393:
''(this is one complete line, although it may appear on this page as two or more due to screen width restrictions)''  
''(this is one complete line, although it may appear on this page as two or more due to screen width restrictions)''  


:<code><#date format=dd/mm/yy> <#timehhmmss> <#temp> <#hum> <#dew> <#wspeed> <#wlatest> <#bearing> <#rrate> <#rfall> <#press> <#currentwdir> <#beaufortnumber> <#windunit> <#tempunitnodeg> <#pressunit> <#rainunit> <#windrun> <#presstrendval> <#rmonth> <#ryear> <#rfallY> <#intemp> <#inhum> <#wchill> <#temptrend> <#tempTH> <#TtempTH> <#tempTL> <#TtempTL> <#windTM> <#TwindTM> <#wgustTM> <#TwgustTM> <#pressTH> <#TpressTH> <#pressTL> <#TpressTL> <#version> <#build> <#wgust> <#heatindex> <#humidex> <#UV> <#ET> <#SolarRad> <#avgbearing> <#rhour> <#forecastnumber> <#isdaylight> <#SensorContactLost> <#wdir> <#cloudbasevalue> <#cloudbaseunit> <#apptemp> <#SunshineHours> <#CurrentSolarMax> <#IsSunny> <#feelslike></code>  
:<code><#date format=dd/mm/yy> <#timehhmmss> <#temp> <#hum> <#dew> <#wspeed> <#wlatest> <#bearing> <#rrate> <#rfall> <#press> <#currentwdir> <#beaufortnumber> <#windunit> <#tempunitnodeg> <#pressunit> <#rainunit> <#windrun> <#presstrendval> <#rmonth> <#ryear> <#rfallY> <#intemp> <#inhum> <#wchill> <#temptrend> <#tempTH> <#TtempTH> <#tempTL> <#TtempTL> <#windTM> <#TwindTM> <#wgustTM> <#TwgustTM> <#pressTH> <#TpressTH> <#pressTL> <#TpressTL> <#version> <#build> <#wgust> <#heatindex> <#humidex> <#UV> <#ET> <#SolarRad> <#avgbearing> <#rhour> <#forecastnumber> <#isdaylight> <#SensorContactLost> <#wdir> <#cloudbasevalue> <#cloudbaseunit> <#apptemp> <#SunshineHours> <#CurrentSolarMax> <#IsSunny> <#feelslike></code>
 
 
 
For releases after b3074 now accept the "rc=y" parameter, so if your locale uses a comma decimal you must add this parameter to all the web tags that produce decimal values
 
''(this is one complete line, although it may appear on this page as two or more due to screen width restrictions)''
 
:<code><#date format=dd/mm/yy> <#timehhmmss> <#temp rc=y> <#hum> <#dew rc=y> <#wspeed rc=y> <#wlatest rc=y> <#bearing> <#rrate rc=y> <#rfall rc=y> <#press rc=y> <#currentwdir> <#beaufortnumber> <#windunit> <#tempunitnodeg> <#pressunit> <#rainunit> <#windrun rc=y> <#presstrendval rc=y> <#rmonth rc=y> <#ryear rc=y> <#rfallY rc=y> <#intemp rc=y> <#inhum> <#wchill rc=y> <#temptrend rc=y> <#tempTH rc=y> <#TtempTH> <#tempTL rc=y> <#TtempTL> <#windTM rc=y> <#TwindTM> <#wgustTM rc=y> <#TwgustTM> <#pressTH rc=y> <#TpressTH> <#pressTL rc=y> <#TpressTL> <#version> <#build> <#wgust rc=y> <#heatindex rc=y> <#humidex rc=y> <#UV rc=y> <#ET rc=y> <#SolarRad> <#avgbearing> <#rhour rc=y> <#forecastnumber> <#isdaylight> <#SensorContactLost> <#wdir> <#cloudbasevalue> <#cloudbaseunit> <#apptemp rc=y> <#SunshineHours rc=y> <#CurrentSolarMax> <#IsSunny> <#feelslike rc=y></code>
 
[[Category:Cumulus Files]]
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/9090"