BETA webtags: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
(→‎Records: missing dry/wet and temp range tags added)
(Moved all 1.9.2 beta tags to 'live' page)
Line 1: Line 1:
== Additional webtags available in the BETA version of Cumulus 1.9.2 ==
== Additional webtags available in the BETA version of Cumulus X.X.X ==
 
'''======================================================='''
 
'''THERE IS CURRENTLY NO BETA VERSION OF CUMULUS AVAILABLE'''
 
'''======================================================='''


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:
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:
Line 21: Line 27:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#tempunitnodeg>
|colspan="2"|no new tags
|The temperature units being used, without a degree symbol, i.e. "F" or "C"
|}
|}


Line 31: Line 36:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#timeUTC>
|colspan="2"|no new tags
|The current UTC date/time rather than local date/time
|}
|}


Line 44: Line 48:
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#wetbulb>
|colspan="2"|no new tags
|Estimated [http://en.wikipedia.org/wiki/Wet_bulb wet bulb] temperature, currently only available via web tag
|-
|-
|colspan="2" style="background:lightgray;"|Rainfall
|colspan="2" style="background:lightgray;"|Rainfall
|-
|-
|<#r24hour>
|colspan="2"|no new tags
|Amount of rain in the last 24 hours
|-
|-
|colspan="2" style="background:lightgray;"|Pressure
|colspan="2" style="background:lightgray;"|Pressure
Line 58: Line 60:
|colspan="2" style="background:lightgray;"|Wind
|colspan="2" style="background:lightgray;"|Wind
|-
|-
|<#beaufortnumber>
|colspan="2"|no new tags
|The current wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|-
|-
|colspan="2" style="background:lightgray;"|Miscellaneous
|colspan="2" style="background:lightgray;"|Miscellaneous
|-
|-
|<#cloudbasevalue>
|colspan="2"|no new tags
|Current calculated cloud base without units
|-
|<#cloudbaseunit>
|The units used for cloudbase value, i.e. "ft" or "m"
|-
|<#cumulusforecast>
|Always gives Cumulus (Zambretti) forecast, even if the <#forecast> tag provides a station forecast
|-
|<#wsforecast>
|Always gives station forecast (if available)
|}
|}


Line 86: Line 77:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#temprange>
|colspan="3"|no new tags
|The temperature range (max - min) so far today
|n/a
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
Line 100: Line 89:
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|<#domwindbearing>
|colspan="3"|no new tags
|Today's dominant wind direction in degrees
|n/a
|-
|<#domwinddir>
|Today's dominant wind direction as compass point
|n/a
|-
|<#Tbeaufortnumber>
|Today's high wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|<#TwindTM>
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|<#heatdegdays>
|colspan="3"|no new tags
|Today's heating degree days
|n/a
|-
|<#cooldegdays>
|Today's cooling degree days
|n/a
|}
|}


Line 133: Line 106:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#temprangeY>
|colspan="3"|no new tags
|The temperature range (max - min) yesterday
|n/a
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
Line 147: Line 118:
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|<#domwindbearingY>
|colspan="3"|no new tags
|Yesterday's dominant wind direction in degrees
|n/a
|-
|<#domwinddirY>
|Yesterday's dominant wind direction as compass point
|n/a
|-
|<#windrunY>
|Yesterday's total wind run
|n/a
|-
|<#Ybeaufortnumber>
|Yesterday's high wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|<#TwindYM>
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|<#heatdegdaysY>
|colspan="3"|no new tags
|Yesterday's heating degree days
|n/a
|-
|<#cooldegdaysY>
|Yesterday's cooling degree days
|n/a
|}
|}


Line 185: Line 136:
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#MonthHighDailyTempRange>
|colspan="4"|no new tags
|High Daily Temp Range
|n/a
|<#MonthHighDailyTempRangeD>
|-
|<#MonthLowDailyTempRange>
|Low Daily Temp Range
|n/a
|<#MonthLowDailyTempRangeD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|colspan="4" style="background:lightgray;"|Pressure
Line 201: Line 144:
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#MonthWindRunH>
|colspan="4"|no new tags
|High Daily Wind Run
|n/a
|<#MonthWindRunHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
Line 212: Line 152:
|colspan="4" style="background:lightgray;"|Miscellaneous
|colspan="4" style="background:lightgray;"|Miscellaneous
|-
|-
|<#MonthLongestDryPeriod>
|colspan="4"|no new tags
|Longest dry period ending this month (days)
|n/a
|<#MonthLongestDryPeriodD>
|-
|<#MonthLongestWetPeriod>
|Longest period of rain every day, ending this month (days)
|n/a
|<#MonthLongestWetPeriodD>
|}
|}


Line 234: Line 166:
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#YearHighDailyTempRange>
|colspan="4"|no new tags
|High Daily Temp Range
|n/a
|<#YearHighDailyTempRangeD>
|-
|<#YearLowDailyTempRange>
|Low Daily Temp Range
|n/a
|<#YearLowDailyTempRangeD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|colspan="4" style="background:lightgray;"|Pressure
Line 250: Line 174:
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#YearWindRunH>
|colspan="4"|no new tags
|High Daily Wind Run
|n/a
|<#YearWindRunHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
Line 261: Line 182:
|colspan="4" style="background:lightgray;"|Miscellaneous
|colspan="4" style="background:lightgray;"|Miscellaneous
|-
|-
|<#YearLongestDryPeriod>
|colspan="4"|no new tags
|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>
|}
|}


Line 282: Line 195:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#LowDailyTempRange>
|colspan="3"|no new tags
|All time low daily temperature range
|<#TLowDailyTempRange>
|-
|<#HighDailyTempRange>
|All time high daily temperature range
|<#THighDailyTempRange>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
Line 300: Line 207:
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|<#windrunH>
|colspan="3"|no new tags
|All time high daily wind run
|<#TwindrunH>
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|<#LongestDryPeriod>
|colspan="3"|no new tags
|All time longest dry period (days)
|<#TLongestDryPeriod>
|-
|<#LongestWetPeriod>
|All time longest wet period (days)
|<#TLongestWetPeriod>
|}
|}


Line 322: Line 221:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#chillhours>
|colspan="2"|no new tags
|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
|}
|}


Line 354: Line 231:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#MoonAge>
|colspan="2"|no new tags
|Current '''approximate''' age of the Moon in days (0-29)
|}
|}


Line 377: Line 253:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#HighWindrunRecordSet>
|colspan="2" |No new tags
|1 if the all time high wind run is currently flashing, 0 if not
|-
|<#LongestDryPeriodRecordSet>
|1 if the all-time longest dry period light is currently flashing, 0 if not
|-
|<#LongestWetPeriodRecordSet>
|1 if the all-time longest wet period light is currently flashing, 0 if not
|-
|<#HighTempRangeRecordSet>
|1 if the all-time high daily temperature range light is currently flashing, 0 if not
|-
|<#LowTempRangeRecordSet>
|1 if the all-time low daily temperature range light is currently flashing, 0 if not
|}
|}


Line 416: Line 279:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#DavisTotalPacketsReceived>
|colspan="2"|no new tags
|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
|}
|}


Line 446: Line 290:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#Light>
|colspan="2"|no new tags
|Current Lux value
|}
|}


Revision as of 21:44, 5 October 2011

Additional webtags available in the BETA version of Cumulus X.X.X

=======================================================

THERE IS CURRENTLY NO BETA VERSION OF CUMULUS AVAILABLE

=======================================================

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'

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

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 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
No new tags

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

Retrieved from "https://www.cumuluswiki.org/index.php?title=BETA_webtags&oldid=1664"