Webtags

From Cumulus Wiki
Revision as of 20:23, 17 August 2009 by Daj (talk | contribs) (Created page with '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…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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!


The Tags

Below are a list of the webtags available. There are currently 167 webtags


Time

webtag Function
<#date> The current date
<#time> The current time. Example format: 18:30
<#day> The current day as a 2-digit number. Example format: 14
<#dayname> The current day as a word. For example, Monday
<#shortdayname> The current day as a shortened word. Example format: Mon
<#month> The current month as a 2-digit number. Example format: 05
<#monthname> The current month as a word. Example format: August
<#shortmonthname> The current month as a shortened word. Example format: Aug
<#year> The current year as a 4-digit number. Example format: 2009
<#shortyear> The current year as a 2-digit number. Example format: 09
<#hour> The current hour as a 2-digit number. Example format: 23
<#minute> The current minute as a 2-digit number. Example format: 59
<#rollovertime> The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
<#TtempTH> Time of Today's temperate high
<#TtempTL> Time of Today's temperate low
<#TtempYH> Time of Yesterday's temperate high
<#TtempYL> Time of Yesterday's temperate low
<#TtempH> Date and Time or all time temperature High
<#TtempL> Date and Time or all time temperature Low
<#TmintempH> Date and Time of all time high minimum temperature
<#TmaxtempL> Date and Time of all time low maximum temperature
<#TpressTH> Time of Today's highest pressure reading
<#TpressTL> Time of Today's lowest pressure reading
<#TpressYH> Time of Yesterday's highest pressure reading
<#TpressYL> Time of Yesterday's lowest pressure reading
<#TpressH> Date and Time or all time pressure High
<#TpressL> Date and Time or all time pressure Low
<#TwindTM> Time of Today's maximum wind speed
<#TwindYM> Time of Yesterday's maximum wind speed
<#TwgustTM> Time of Today's maximum wind gust
<#TwgustYM> Time of Yesterday's maximum wind gust
<#TgustM> Time and Date of all time high wind gust
<#TwspeedH> Time and Date of all time high average wind speed
<#TwchillH> Time and Date of all time highest wind chill
<#TrrateTM> Time of Today's maximum rain rate
<#TrrateYM> Time of Yesterday's maximum rain rate
<#TrrateM> Date and Time of all time high rain rate
<#TrfallH> Date and Time of all time high daily rain
<#TrfallhH> Date and Time of all time high hourly rain
<#TrfallmH> Date and Time of all time high monthly rain
<#recordsbegandate> The date that the all time records began
<#realtimeinterval> The realtime update interval in seconds
<#rollovertime> The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'


Temperature

webtag Function
<#temp> The outside temperature
<#intemp> The inside temperature
<#temptrend> The change in temperature over the last hour
<#temptrendtext> Temperature change over the last hour - Rising/Falling/Steady
<#tempTH> Today's highest temperature
<#tempTL> Today's lowest temperature
<#tempYH> Yesterday's highest temperature
<#tempYL> Yesterday's lowest temperature
<#tempH> All time high temperature
<#tempL> All time low temperature
<#mintempH> All time high minimum temperature
<#maxtempL> All time low maximum temperature
<#heatindex> Current heat index
<#humidex> Current Humidex
<#hum> The outside humidity
<#inhum> The inside humidity
<#tempunit> Unit of temperature being used (Set in Cumulus as Centigrade or Fahrenheit)


Pressure

webtag Function
<#press> The sea level pressure
<#presstrend> The pressure trend in words
<#presstrendval> The pressure trend in figures
<#pressTH> Today's highest pressure reading
<#pressTL> Today's lowest pressure reading
<#pressYH> Yesterday's highest pressure reading
<#pressYL> Yesterday's highest pressure reading
<#pressH> All time high pressure
<#pressL> All time low pressure
<#pressunit> Unit of measure for pressure


Rain

webtag Function
<#rrate> The current rainfall rate
<#rhour> The rainfall in the last hour
<#rfall> The total rainfall so far today
<#rfallY> The total rainfall for yesterday
<#rmidnight> The total rainfall since midnight. Useful if you don't use midnight as your start of day
<#rmonth> The total rainfall so far this month
<#ryear> The total rainfall so far this year
<#rrateM> All time high rain rate
<#rfallH> All time high daily rain
<#rfallhH> All time high hourly rain
<#rfallmH> All time high monthly rain
<#rrateTM> Today's maximum rain rate
<#rrateYM> Yesterday's maximum rain rate
<#dew> The outside dew point
<#rainunit> Unit of measure for rain fall (e.g mm or inches)


Wind

webtag Function
<#wspeed> The current wind speed reading
<#wgust> The current wind gust reading
<#wchill> The current wind chill temperature
<#wlatest> Latest wind speed reading from console
<#bearing> The current wind bearing
<#avgbearing> Average wind bearing over last 10 minutes
<#wdir> Average wind bearing as a compass point - e.g. ESE
<#wdirdata> Comma separated list of recent wind bearing readings (up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex
<#wspddata> Comma separated list of recent wind speed readings (up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex
<#nextwindindex> The index of the entries in wdirdata and wspddata which Cumulus is going to use next - i.e. the latest entry used is one less than this; but don't forget to allow for the wrap around!
<#windrun> The total wind run today so far
<#windrunY> The total wind run for yesterday (new to Version 1.8.4)
<#bearingTM> Today's mean wind bearing
<#bearingYM> Yesterday's mean wind bearing
<#windTM> Today's maximum wind speed
<#windYM> Yesterday's maximum wind speed
<#wgustTM> Today's maximum wind gust
<#wgustYM> Yesterday's maximum wind gust
<#gustM> All time high wind gust
<#wspeedH> All time high average wind speed
<#wchillH> All time greatest wind chill (i.e. lowest temperature)
<#windunit> Unit of measure for wind speed
<#windrununit> Unit of measure for wind run (distance)
<#beaufort> The current wind speed on the Beaufort scale (e.g. F8)
<#beaudesc> The current wind speed Beaufort description (e.g. "Gale")
<#Tbeaufort> Today's highest wind speed, expressed in the Beaufort scale
<#Ybeaufort> Yesterday's highest wind speed, expressed in the Beaufort scale


Miscellaneous

webtag Function
<#version> The version of Cumulus in use
<#build> The build of Cumulus in use
<#interval> The web site update interval in minutes
<#update> The date and time of the last web site update
<#stationtype> The type of station in use
<#latitude> The station latitude
<#longitude> The station longitude
<#altitude> The station altitude
<#location> The station location
<#longlocation> Longer description of the station location
<#forum> URL of the forum
<#webcam> URL of the webcam
<#graphperiod> The number of hours displayed by the graphs
<#forecast> The current forecast
<#battery> The battery condition (Only available for the Davis weather stations)
<#cloudbase> Calculated cloud base
<#ET> Today's evapotranspiration
<#UV> Current UV index
<#SolarRad> Current solar radiation


Day/Night/Sun/Moon

webtag Function
<#sunrise> Current sunrise time at the station
<#sunset> Current sunset time at the station
<#daylength> Length of day in hours and minutes (sunrise to sunset)
<#tomorrowdaylength> A string giving the difference between the length of day today and tomorrow
<#dawn> Start of Civil Twilight at the station (new to version 1.8.6)
<#dusk> End of Civil Twilight at the station (new to version 1.8.6)
<#daylightlength> Length of daylight in hours and minutes (dawn to dusk) (new to version 1.8.6)
<#moonphase> Current phase of the moon
<#moonrise> Current moonrise time at the station
<#moonset> Current moonset time at the station


Special tags

WMR928

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

webtag Function
<#ExtraTemp1> Extra temperature channel 1
<#ExtraTemp2> Extra temperature channel 2
<#ExtraTemp3> Extra temperature channel 3
<#ExtraDP1> Extra dew point channel 1
<#ExtraDP2> Extra dew point channel 2
<#ExtraDP3> Extra dew point channel 3
<#ExtraHum1> Extra humidity channel 1
<#ExtraHum2> Extra humidity channel 2
<#ExtraHum3> Extra humidity channel 3


No Comma's

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.

<#RCdew> <#RCheatindex> <#RChum> <#RCinhum> <#RCintemp> <#RCpress> <#RCpressTH>
<#RCpressTL> <#RCrfall> <#RCrrate> <#RCrrateTM> <#RCtemp> <#RCtempTH> <#RCtempTL>
<#RCwchill> <#RCwgust> <#RCwgustTM> <#RCwspeed>