BETA webtags

From Cumulus Wiki
Revision as of 13:54, 9 September 2011 by Mcrossley (talk | contribs)
Jump to navigationJump to search

Additional webtags available in the BETA version of Cumulus 1.9.2

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.

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'

Date & Time

webtag Function
<#timeUTC> The current UTC date/time rather than local date/time

Current Conditions

webtag Function
Temperature & Humidity
<#wetbulb> Estimated wet bulb temperature, currently only available via web tag
Rainfall
<#r24hour> Amount of rain in the last 24 hours
Pressure
no new tags
Wind
no new tags
Miscellaneous
<#cloudbasevalue> Current calculated cloud base without units
<#cumulusforecast> Always gives Cumulus (Zambretti) forecast, even if the <#forecast> tag provides a station forecast
<#wsforecast> Always gives station forecast (if available)

Today

webtag Function Time
Temperature & Humidity
<#temprange> The temperature range (max - min) so far today n/a
Rainfall
no new tags
Pressure
no new tags
Wind
<#domwindbearing> Today's dominant wind direction in degrees n/a
<#domwinddir> Today's dominant wind direction as compass point n/a
Miscellaneous
<#heatdegdays> Today's heating degree days n/a
<#cooldegdays> Today's cooling degree days n/a

Yesterday

webtag Function Time
Temperature & Humidity
<#temprangeY> The temperature range (max - min) yesterday n/a
Rainfall
no new tags
Pressure
no new tags
Wind
<#domwindbearingY> Yesterday's dominant wind direction in degrees n/a
<#domwinddirY> Yesterday's dominant wind direction as compass point n/a
Miscellaneous
<#heatdegdaysY> Yesterday's heating degree days n/a
<#cooldegdaysY> Yesterday's cooling degree days n/a

Monthly

webtag Function Time Date
Temperature & Humidity
<#MonthHighDailyTempRange> High Daily Temp Range n/a <#MonthHighDailyTempRangeD>
<#MonthLowDailyTempRange> Low Daily Temp Range n/a <#MonthLowDailyTempRangeD>
Pressure
no new tags
Wind
<#MonthWindRunH> High Daily Wind Run n/a <#MonthWindRunHD>
Rainfall
no new tags
Miscellaneous
<#MonthLongestDryPeriod> Longest dry period ending this month (days) n/a <#MonthLongestDryPeriodD>
<#MonthLongestWetPeriod> Longest period of rain every day, ending this month (days) n/a <#MonthLongestWetPeriodD>

Yearly

webtag Function Time Date
Temperature & Humidity
<#YearHighDailyTempRange> High Daily Temp Range n/a <#YearHighDailyTempRangeD>
<#YearLowDailyTempRange> Low Daily Temp Range n/a <#YearLowDailyTempRangeD>
Pressure
no new tags
Wind
<#YearWindRunH> High Daily Wind Run n/a <#YearWindRunHD>
Rainfall
no new tags
Miscellaneous
<#YearLongestDryPeriod> Longest period without rain ending this year (days) n/a <#YearLongestDryPeriodD>
<#YearLongestWetPeriod> Longest period of rain every day ending this year (days) n/a <#YearLongestWetPeriodD>

All Time

webtag Function Time
Temperature & Humidity
<#LowDailyTempRange> All time low daily temperature range <#TLowDailyTempRange>
<#HighDailyTempRange> All time high daily temperature range <#THighDailyTempRange>
Rainfall
no new tags
Pressure
no new tags
Wind
<#windrunH> All time high daily wind run <#TwindrunH>
Miscellaneous
<#LongestDryPeriod> All time longest dry period (days) <#TLongestDryPeriod>
<#LongestWetPeriod> All time longest wet period (days) <#TLongestWetPeriod>

Miscellaneous

webtag Function
<#chillhours> The number of 'chill hours' so far this season.
<#ConsecutiveRainDays> The number of days up to (but not including) today where it has rained every day. The threshold amount of rain required to determine a rain day is configurable via the RainDayThreshold setting in cumulus.ini, the units for the threshold are the same as your rain units
<#ConsecutiveDryDays> The number of days up to (but not including) today since it last rained. The threshold amount of rain required to determine a rain day is configurable via the RainDayThreshold setting in cumulus.ini the units for the threshold are the same as your rain units
<#WindRoseData> A comma-separated list of the wind 'totals' used to draw the wind rose (8 or 16 values)
<#WindRosePoints> The number of items in <#WindRoseData> (i.e. 8 or 16)
<#WindSampleCount> The number of wind samples making up the wind rose (etc) data (up to 3600)
<#LatestNOAAMonthlyReport> Gives file name of latest auto-saved NOAA monthly report
<#LatestNOAAYearlyReport> Gives file name of latest auto-saved NOAA yearly report

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 alarms

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
<#HighWindrunRecordSet> 1 if the all time high wind run is currently flashing, 0 if not

Special

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
<#DavisTotalPacketsReceived> Total number of data packets received
<#DavisTotalPacketsMissed> Number of missed data packets
<#DavisNumberOfResynchs> Number of times the console resynchronised with the transmitter
<#DavisMaxInARow> Longest streak of consecutive packets received
<#DavisNumCRCerrors> Number of packets received with CRC errors
<#THWindex> A derived temperature using Temperature/Humidity/Wind values
<#THSWindex> A derived temperature using Temperature/Humidity/Solar/Wind values

Fine Offset

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

webtag Function
<#Light> Current Lux value

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.