Cumulus Wiki - User contributions [en]

Realtime.txt

2010-04-03T13:08:36Z

Ag0044: Grammar & spelling

[[file:CumulusInternetSettingsScreen.png|thumb]]
Although not technically a 'log file' it is automatically produced by Cumulus and follows a similar format to the other Log files.
 
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 updated frequently.
 
Using Cumulus you decide how often to update the file -- for example every 15 seconds. This is then uploaded to your website and used to produce near instant readings.
 
To set how often the file is produced by Cumulus, click on the 'Configuration' menu then 'Internet' (Click the thumbnail opposite)

Notes:
*The realtime.txt file is NOT a log file and is constantly replaced. It does not therefore contain any historic data.
*The 'interval' sets how often Cumulus produces ''and'' uploads to the website

=Special note to Fine Offset/EasyWeather users=
Weather stations which come shipped with the EasyWeather software (generally known as FineOffset or Watson) should consider the realtime updating with care. The station only updates every 48 seconds, so sending realtime information to your website every 5 seconds is very wasteful. It may be better for a figure 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=

In order to provide near real-time updates, Cumulus uploads a very small file at regular intervals. Typically this is 15 seconds buy depends on your setting above.

Most internet providers now place a limit on the amount of Bandwidth you can consume each month. Bandwidth is a figure representing the data you can upload and download. Doing such a regular upload will impact on your allowance.

The file Cumulus uploads is less than 1024 bytes in size, but for the calculation we will assume 1024 bytes

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 webserver.

=Where is the file used=

The realtime.txt is used by:
*the '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]]

=Format of the file=

{| class="wikitable" border="1"
|-
!style="width:60px" | Field #
!style="width:80px" | Example
!style="width:450px" | Description
|-
|-
|1
|19/08/09
|date (always dd/mm/yy)
|-
|2
|16:03:45
|time(always hh:mm:ss)
|-
|3
|8.4
|outside temperature
|-
|4
|84
|[http://en.wikipedia.org/wiki/Relative_humidity relative humidity]
|-
|5
|5.8
|[http://en.wikipedia.org/wiki/Dewpoint dewpoint]
|-
|6
|24.2
|wind speed (average)
|-
|7
|33.0
|latest wind speed reading
|-
|8
|261
|wind bearing (degrees)
|-
|9
|0.0
|current rain rate (per hour)
|-
|10
|1.0
|rain today
|-
|11
|999.7
|barometer
|-
|12
|W
|wind direction
|-
|13
|6
|wind speed ([http://en.wikipedia.org/wiki/Beaufort_scale beaufort])
|-
|14
|km/h
|wind units - m/s, mph, km/h, kts
|-
|15
|C
|temperature units - degree C, degree F
|-
|16
|hPa
|pressure units - MB, hPa, in
|-
|17
|mm
|rain units - mm, in
|-
|18
|146.6
|wind run (today)
|-
|19
| +0.1
|pressure trend value
|-
|20
|85.2
|monthly rainfall
|-
|21
|588.4
|yearly rainfall
|-
|22
|11.6
|yesterday's rainfall
|-
|23
|20.3
|inside temperature
|-
|24
|57
|inside [http://en.wikipedia.org/wiki/Humidity humidity]
|-
|25
|3.6
|[http://en.wikipedia.org/wiki/Wind_chill wind chill]
|-
|26
| -0.7
|temperature trend value
|-
|27
|10.9
|today's high temp
|-
|28
|12:00
|time of today's high temp (hh:mm)
|-
|29
|7.8
|today's low temp
|-
|30
|14:41
|time of today's low temp (hh:mm)
|-
|31
|37.4
|today's high wind speed (average)
|-
|32
|14:38
|time of today's high wind speed (average) (hh:mm)
|-
|33
|44.0
|today's high wind gust
|-
|34
|14:28
|time of today's high wind gust (hh:mm)
|-
|35
|999.8
|today's high pressure
|-
|36
|16:01
|time of today's high pressure (hh:mm)
|-
|37
|998.4
|today's low pressure
|-
|38
|12:06
|time of today's low pressure (hh:mm)
|-
|39
|1.8.7
|Cumulus version
|-
|40
|819
|Cumulus build number
|-
|41
|36.0
|10-minute high gust
|-
|42
|10.3
|heat index
|-
|43
|10.5
|[http://en.wikipedia.org/wiki/Humidex humidex]
|-
|44
|13
|[http://en.wikipedia.org/wiki/Uv_index UV Index]
|-
|45
|0.2
|[http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration] today
|-
|46
|14
|[http://en.wikipedia.org/wiki/Solar_radiation solar radiation] W/m2
|-
|47
|260
|10-minute average wind bearing (degrees)
|-
|48
|2.3
|rainfall last hour
|-
|49
|3
|The number of the current forecast as per [[strings.ini]]. If the forecast is not being provided by the station and not being generated by Cumulus a value of 0 (zero) is returned
|-
|50
|1
|Flag to indicate that the location of the station is currently in daylight (1 = yes, 0 = No)
|-
|51
|1
|If the station has lost contact with its remote sensors "Fine Offset only", a Flag number is given (1 = Yes, 0 = No)
|}

=Example of the file=

''(this is one complete line, although it may appear on this page as two or more due to screen width restrictions)''

<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</tt>

[[Category:Log Files]]

Dayfile.txt

2010-04-03T13:01:17Z

Ag0044: Grammar & spelling

Cumulus maintains a daily file of the highs and lows of each day, as well as a few other nuggets of information. The data contained in the file are used to build the graphs.

The file is called <tt>dayfile.txt</tt> which can be viewed in a text editor or imported into various database systems or spreadsheets to manipulate as you wish.

Tip -- take a copy of the file to work on it elsewhere.

==Format of the file==

* Date in the form dd/mm/yy
* Highest wind gust,
* Bearing of highest wind gust
* Time of highest wind gust
* Minimum temperature
* Time of minimum temperature
* Maximum temperature
* Time of maximum temperature
* Minimum sea level pressure
* Time of minimum pressure
* Maximum sea level pressure
* Time of maximum pressure
* Maximum rainfall rate
* Time of maximum rainfall rate
* Total rainfall for the day
* [[Average temperature]] for the day
* Total wind run
* Highest Average Wind Speed
* Time of Highest Avg. Wind speed

The last two entries were added from v 1.8.9 build 907

==Example of the file==

An extract of a few lines of the dayfile.txt

<pre>25/01/10,11.0,270,22:56,-1.3,18:59,5.3,11:14,1032.7,00:04,1038.6,23:55,3.6,06:39,0.3,1.6,39.6,5.6,23:52

26/01/10,14.5,248,14:46,1.5,00:00,6.7,14:19,1034.5,23:59,1039.3,10:16,0.0,00:00,0.0,3.8,116.5,11.1,23:26

27/01/10,25.5,315,02:56,2.6,23:07,8.5,04:42,1020.0,23:58,1034.6,00:00,3.6,14:30,2.4,5.8,112.4,10.7,04:15

28/01/10,7.2,315,01:59,1.7,22:54,4.6,17:09,998.2,23:34,1020.3,00:01,3.6,02:46,9.0,2.9,41.6,7.1,02:09

29/01/10,9.1,248,01:14,-2.1,17:43,1.7,00:00,997.1,16:15,999.3,23:54,3.6,00:31,0.3,-0.1,7.9,5.0,01:21</pre>

[[Category:Log Files]]

SFTP

2010-02-02T00:57:46Z

Ag0044: Grammar & spelling

Many ISPs now only support [http://en.wikipedia.org/wiki/Simple_File_Transfer_Protocol SFTP] due to the open, unsecure nature of standard FTP

As Cumulus does not currently support SFTP an external SFTP application must be used

[http://winscp.net WINSCP] can be used

Looking at http://winscp.net/eng/docs/script_upload_single_file, winSCP can be used to script SFTP

You have to run it by hand once, to allow the SSH key to be trusted, then it works on its own

The following script works well
option batch abort
option confirm off
open User:pass@server
put "localpath\realtime.txt" /remotepath
exit

*change User:pass@server to your username, password and server name combination

*change localpath\realtime.txt to the local path on your PC

*change /remotepath to the remote path on the web server (as seen when you SFTP to the web site)

User talk:Daj

2010-01-18T08:21:41Z

Ag0044:

Edit this page and add any comments you have for me. End your comments with <nowiki>~~~~</nowiki> which will auto add your username and the date and time. Remember, this is a public area so everyone can see anything you add. If you prefer, send me a [http://sandaysoft.com/forum/ucp.php?i=pm&mode=compose private message] via the forum (user daj)

----

I'm just a beginner with Cumulus, I know a little bit about computers, and I'm pedantic. In my early learning about Cumulus, I was looking through some of the pages on this wiki - clicking "Random Page" - and I noticed that some pages had typos and errors in the English ("there" when it should be "their", "it's" when it should be "its" and so on).

So, I'm not volunteering as a Cumulus expert (I've still got a lot of learning to do), but as one of the wiki pedants (maybe the first?). Rather than jumping in and making corrections, how do people feel about having their words "re-organised"? I'm happy to discuss with authors before making any changes.

Rory

[[User:Ag0044|Ag0044]] 08:21, 18 January 2010 (UTC)