BETA webtags

From CumulusWiki
Jump to: navigation, search

Additional webtags available in the BETA version of Cumulus 3.0.0

These are special markers placed in a file which Cumulus can then process and replace with the actual values. Typically you would use this to build your own website by having an HTML template file with your layout, static text and graphics. In the position on the page you wish Cumulus to insert the relevant data place a webtag in the form:

<#tagname>

Assuming you have asked Cumulus to process the file, it will replace the tag with the current value of the item the tag represents just before the file is uploaded to the internet.

Note: When you put a tag into your HTML, be careful that whatever program you are using to develop your web pages doesn't change the angle brackets to slightly different symbols -- this is a common cause of failure!

Also note that web tags are case sensitive, use them exactly as they appear here.

Time and Date Format Code Changes

The table below details the differences in the time/date format codes between Cumulus v1 and Cumulus MX Note that this also applies to the NOAA report file formats. The characters which can be used now are listed on the following two pages:

http://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx - 'standard' strings

http://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx - 'custom' strings

Cumulus v1 Code Description Cumulus MX Code
c Windows Short Date and Long Time format. G (or construct from custom formats)
d Day of month as a number without a leading zero (1-31). Same
dd Day as a number with a leading zero (01-31). Same
ddd Day as an abbreviation (Sun-Sat) using Windows Locale. Same
dddd Day as a full name (Sunday-Saturday) using Windows Locale. Same
ddddd Displays the date using the format given by the Windows Short Date format. d (or construct from custom formats)
dddddd Date in Windows Long Date format. D (or construct from custom formats)
m Month as a number without a leading zero (1-12). M
mm Month as a number with a leading zero (01-12). MM
mmm Month as an abbreviation (Jan-Dec) using Windows Locale. MMM
mmmm Month as a full name (January-December) using Windows Locale. MMMM
yy Year as a two-digit number (00-99). Same
yyyy Year as a four-digit number (0000-9999). Same
h Hour without a leading zero (0-23). h for 12-hour clock (1-12), H for 24-hour clock (0-23)
hh Hour with a leading zero (00-23). hh for 12-hour clock (1-12), HH for 24-hour clock (0-23)
n Minute without a leading zero (0-59). m
nn Minute with a leading zero (00-59). mm
s Second without a leading zero (0-59). Same
ss Second with a leading zero (00-59). Same
z Millisecond without a leading zero (0-999). No equivalent
zzz Millisecond with a leading zero (000-999). f (tenths), ff (hundredths), fff (ms) etc.
t Date in Windows Short Time format. Same
tt\ Date in Windows Long Time format. T
am/pm am/pm specifier can use lower, upper, or mixed case tt (Windows am/pm format)
a/p The a/p specifier can use lower, upper, or mixed case. t (Windows a/p format)
ampm Windows AM or PM string. tt
/ Date separator character given by the Windows Date Separator. Same
: Time separator character given by the Windows Time Separator. Same
'xx' Characters enclosed in single quotation marks are displayed as such, and do not affect formatting. Same

The Tags

Below is a list of the additional webtags available in this beta version. These webtags will be transferred to the main page when the beta version becomes 'live'

Units

webtag Function
no new tags

Date & Time

webtag Function
no new tags

Current Conditions

webtag Function
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

Today

webtag Function Time
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

Yesterday

webtag Function Time
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

Monthly

webtag Function Time Date
Temperature & Humidity
no new tags
Pressure
no new tags
Wind
no new tags
Rainfall
no new tags
Miscellaneous
no new tags

Yearly

webtag Function Time Date
Temperature & Humidity
no new tags
Pressure
no new tags
Wind
no new tags
Rainfall
no new tags
Miscellaneous
no new tags

All Time

webtag Function Time
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

Recent History

There are a set of tags for 'recent historical data', giving data values from 1 minute ago, up to 1 week ago, in 1 minute intervals. Note that the values are initialised from the log files when Cumulus starts, so they will initially have a resolution according to the logger interval you have set in Cumulus and/or your station. You'll get the nearest value if you ask for one for which there is currently no exact match.

You specify how old you want the value to be by using parameters on the web tags for number of days, hours, and minutes. For example, <#RecentOutsideTemp m=1> will give the temperature one minute ago, <#RecentOutsideTemp h=1> will give the temperature one hour ago (as will <#RecentOutsideTemp m=60>), and <#RecentOutsideTemp d=1> will give the temperature one day ago. <#RecentOutsideTemp d=1 h=1 m=1> will give the temperature one day, one hour and one minute ago. All values supplied for parameters must be whole numbers. If you don't supply any parameters, the result is undefined.

webtag Function
no new tags

Monthly All Time Records

There are a set of tags for monthly all-time highs and lows, in other words the highest and lowest values for a particular month of the year. For example, the highest ever temperature in July. Each Value tag has an optional parameter "mon=N" where N is the index of the month of the year that you want the value for (January=1 and so on). For example, <#ByMonthTempH mon=7> will give you the highest ever temperature in July.

If you don't supply a parameter (or supply an invalid value) the current month will be used. You can customise the date and time formats using the 'format' parameter on the web tag, see below. To supply more than one parameter, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>


webtag Function Date/Time
Temperature & Humidity
no new tags
Pressure
no new tags
Rainfall
no new tags
Miscellaneous
no new tags

Miscellaneous

webtag Function
no new tags

Day/Night/Sun/Moon

webtag Function
no new tags

Alarms

There are a set of tags for the Cumulus alarm states. They give a value of '1' if the alarm has been set and the alarm condition is currently met; otherwise '0'.

webtag Function
no new tags

Records

There are a set of tags for the Cumulus record states. They give a value of '1' if the record has been exceeded; otherwise '0'.

webtag Function
No new tags

Extra Sensors

These webtags are for additional sensors supported by Cumulus

webtag Function
no new tags

Special

OS WMR Series

There are a set of tags for the WMR928, WR100/200 extra sensors:

webtag Function
no new tags

WMR928

There are a set of tags for the WMR928 extra sensors:

webtag Function
no new tags

Davis

There are a set of tags for the Davis PWS:

webtag Function
no new tags

Fine Offset

The following tags are specific to the Fine Offset series of PWS

webtag Function
no new tags

System

Special tags returning information about the system hosting Cumulus:

webtag Function
no new tags


No Commas

There are a set of tags where the decimal comma has been replaced with a full stop, where necessary, for use with gauges etc which don't like the commas. They all correspond to the same tag with 'RC' removed.

<No new tags>