5,838
edits
Realtime.txt: Difference between revisions
m
no edit summary
m (Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)") |
mNo edit summary |
||
| 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.'' | |||
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> | |||
[[Category:Cumulus 1]] | |||
= Introduction = | = Introduction = | ||
*'''realtime.txt''' is a text file with a single line of ''space'' separated values. | |||
*It contains a list of key values of the sensors, and is re-created frequently. | |||
*After creation, it is usually set to upload to your website, and used to produce near instant readings. | |||
*The realtime.txt file is NOT a log file and is constantly replaced. It does not therefore contain any historic data. | |||
** 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. | |||
*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 | *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 | ||
| Line 15: | Line 22: | ||
*The uploading interval is the same as the file creation interval. | *The uploading interval is the same as the file creation interval. | ||
== Special note to Fine Offset/EasyWeather users == | |||
Weather stations which come shipped with the EasyWeather software should consider the real-time updating with care. | |||
The station only updates every 48 (solar is only updated every 60) seconds, so aim for a real-time interval of around 30 seconds, that way a visitor knows not to expect updates too often but you also allow Cumulus to catch up to two updates within a minute (depending on when the first and second 48 second update came to Cumulus). | |||
== Bandwidth Considerations == | == Bandwidth Considerations == | ||
| Line 26: | Line 34: | ||
During a month (31 days) the upload process will consume roughly 175 Mbytes of bandwidth -- this is a tiny consideration as usually bandwidth restrictions from your provider start in the Gigabytes (Gb) range, not Megabytes (Mb). | During a month (31 days) the upload process will consume roughly 175 Mbytes of bandwidth -- this is a tiny consideration as usually bandwidth restrictions from your provider start in the Gigabytes (Gb) range, not Megabytes (Mb). | ||
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 | 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 = | = Where is the file used = | ||
| Line 35: | Line 43: | ||
*The [[WeatherConsole]] and [[Sidebar gadget]] [[:Category:AddOns|addons]] | *The [[WeatherConsole]] and [[Sidebar gadget]] [[:Category:AddOns|addons]] | ||
= List of fields in the file = | = List of fields in the file = | ||
Remember that which | Remember that which fields you see, depends on which version of Cumulus you are running. The list below represents the final 1.9.4 version of Cumulus. | ||
{| border="1" class="wikitable" | {| border="1" class="wikitable" | ||
|- | |- | ||