5,838
edits
Realtime.txt: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
Add link to category listing other Cumulus files
m (Add link to category listing other Cumulus files) |
|||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Version badge Mx}}{{Version badge 1}}This Wiki page applies to both Cumulus flavours. | |||
[[Category:Cumulus Files]] [[Category:MX_txt_Files]] | |||
This Wiki page describes one of the [[:Category:Cumulus Files|files]] that Cumulus can optionally generate. | |||
= List of fields in the file = | = List of fields in the file = | ||
The list below represents the MX field list. | The list below represents the MX field list. | ||
| Line 315: | Line 320: | ||
Cumulus optionally generates this file, it represents one way that current Cumulus derivatives can be supplied to any [[:Category:User Contributions|third party additions]] you use, or your own external purposes. | Cumulus optionally generates this file, it represents one way that current Cumulus derivatives can be supplied to any [[:Category:User Contributions|third party additions]] you use, or your own external purposes. | ||
Three examples taken from third party [[:Category:AddOns|addons]]: | |||
* [[CumulusRealtime|developing real time]] functionality. This add-on is by the author of Cumulus, Steve Loft, and involves 2 extra wind graphics added at the bottom of the example 'gauges' page in the web template set produced by Cumulus 1, it was developed using [http://silverlight.net/ SilverLight] and uses data obtained by reading this file | |||
* [[WeatherConsole]] | * [[WeatherConsole]] | ||
* [[Sidebar gadget]] | * [[Sidebar gadget]] | ||
There are two key points to understand about the source for generation of the file: | There are two key points to understand about the source for generation of the file: | ||
#First is that a [[Cumulus template file]] is held internally in the Cumulus code that can generate this file with some standard content as [[#List of fields in the file|listed | #First is that a [[Cumulus template file]] is held internally in the Cumulus code that can generate this file with some standard content as [[#List of fields in the file|listed in table above]] | ||
# Second is that this internal template, regardless of any locale (or region) settings, always generates the file so that it is readable by [[PHP#Incorporating_Script|script languages]] that expect a full stop to separate the integer part of any real number from the decimal part of that real number. | # Second is that this internal template, regardless of any locale (or region) settings, always generates the file so that it is readable by [[PHP#Incorporating_Script|script languages]] that expect a full stop to separate the integer part of any real number from the decimal part of that real number. | ||
Information about the default generated file: | Information about the default generated file: | ||
* As hinted above, the generation of the file requires you to set various options, see [[#Generation of this file]] | * As hinted above, the generation of the file requires you to set various options, see [[#Generation of this file]] | ||
* There is no functionality, included in any Cumulus software that you download, that requires this file to exist | |||
* The '''realtime.txt''' is generated as a text file with a single line of ''space'' separated values. | * The '''realtime.txt''' is generated as a text file with a single line of ''space'' separated values. | ||
* The file contains a list of key values of the sensors | * The file contains a list of key values of the sensors | ||
| Line 337: | Line 342: | ||
Some users, and some third-party supplied web pages, require fewer, or more, fields than those provided in the standard '''realtime.txt''' file. | Some users, and some third-party supplied web pages, require fewer, or more, fields than those provided in the standard '''realtime.txt''' file. | ||
Arranging this is easy, the content of | Arranging this is easy, the content of a file, that Cumulus uploads to an external site for you, can be tailored to the needs of whatever you choose. | ||
All you need to do is create your own [[Cumulus template file]], sometimes called ''realtime-xT.txt'' (to indicate it is an e''X''tra file, a ''T''emplate file and is related to ''realtime''.txt), you can place this file in the [[web folder]], and ask Cumulus to process that file for you: | All you need to do is create your own [[Cumulus template file]], sometimes called ''realtime-xT.txt'' (to indicate it is an e''X''tra file, a ''T''emplate file and is related to ''realtime''.txt), you can place this file in the [[web folder]], and ask Cumulus to process that file for you: | ||
* [[File:Badge v1.png]] | * [[File:Badge v1.png]] Legacy software versions: | ||
*# Create the template file picking the web tags you want to include from: | *# Create the template file picking the web tags you want to include from: | ||
*#* If you use decimal commas, the list [[Webtags#CURRENT_CONDITIONS:|here]] | *#* If you use decimal commas, the list [[Webtags#CURRENT_CONDITIONS:|here]] | ||
*#* If you use decimal points, the list [[Webtags#Current_Conditions|here]] | *#* If you use decimal points, the list [[Webtags#Current_Conditions|here]] | ||
*# Arrange for the processing and uploading by using the Cumulus Configuration | *# Arrange for the processing and uploading by using the Cumulus menu selections: '''Configuration''' → ''Internet'' → '''Files''' tab dialog. [[File:Cumulus Internet Settings Files.png|Right]] | ||
*#* Type in the name you have used for your template file in ''Local Filename'' | *#* Type in the name you have used for your template file in ''Local Filename'' | ||
*#* Tick the ''Process?'' checkbox, | *#* Tick the ''Process?'' checkbox, | ||
| Line 350: | Line 355: | ||
*#* Finally, supplying a remote path and filename that you want created remotely, you can call it "realtime.txt" after the path name if you like | *#* Finally, supplying a remote path and filename that you want created remotely, you can call it "realtime.txt" after the path name if you like | ||
* [[File:Badge vMx.png]] From build 3075 onwards, all decimal web tags now support the "rc=y" modification parameter. | * [[File:Badge vMx.png]] From build 3075 onwards, all decimal web tags now support the "rc=y" modification parameter. | ||
*# Create the template file based on the list of web tags in the code snippet below. If you are unsure what they represent, look [[Webtags#Current_Conditions|here]]. | *# Create the template file based on the list of web tags in the code snippet [[#MX web tags|below]]. If you are unsure what they represent, look [[Webtags#Current_Conditions|here]]. | ||
*# Arrange for the processing and uploading by using the '''Extra web files''' page in the [[MX_Administrative_Interface#Extra_Web_Files|interface]], follow the instructions in that link, ticking the ''Process?'' checkbox, and the '' | *# Arrange for the processing and uploading by using the '''Extra web files''' page in the [[MX_Administrative_Interface#Extra_Web_Files|interface]], follow the instructions in that link, [[File:Extra web settings.png|Right]] ticking the ''Process?'' checkbox, the ''Real Time?'' checkbox, and the '''UTF8''' checkbox (as shown in first row in image) | ||
| Line 385: | Line 390: | ||
==Enabling generation of this file in Cumulus 1== | ==Enabling generation of this file in Cumulus 1== | ||
The legacy screen that controls production of this file, | The legacy screen that controls production of this file, is obtained by a click on the 'Configuration' menu then 'Internet', once the ''Internet Settings'' screen appears, you should be looking at the '''Sites/Options''' tab. That screen's original look (as Steve Loft included here) is in the larger image. | ||
*The 'interval' sets how often Cumulus produces the file, to set that interval, | When he developed Cumulus 1 further, with two extra real-time boxes to tick to respectively, generate, and upload, the file, Steve Loft did not update the screen shots he included in this Wiki. [[Image:CumulusInternetSettingsScreen.png|Right]] | ||
However, the smaller image (below) shows a later version of part of the original image; | |||
[[File:Web settings.JPG|left]] and you will see the new set of three tick boxes in the lower part of that smaller image: | |||
*The 'Realtime interval' sets how often Cumulus produces the file, to set that interval, 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: | ||
**Enable Realtime | **Enable Realtime | ||
**Enable Realtime FTP | **Enable Realtime FTP | ||
**Realtime.txt FTP | **Realtime.txt FTP (Note in the smaller image this is not ticked, as not creating the file is the default) | ||
*The uploading interval is the same as the file creation interval. | *The uploading interval is the same as the file creation interval. | ||
<br> | |||
<br> | |||
== Bandwidth Considerations == | == Bandwidth Considerations == | ||
| Line 404: | Line 417: | ||
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. | ||
= Special note to Fine Offset/EasyWeather users = | = Special note to Fine Offset/EasyWeather users = | ||
