User:Mcrossley: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
(→‎Miscellaneous: add #LatestError)
(Alternate layout for new BETA webtags)
Line 1: Line 1:
== Additional webtags available in the BETA version of Cumulus 1.9.1 ==
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 7: Line 9:
''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!''
''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!''


=Time/Date 'format' Parameter==


=The Tags=
From 1.9.1 b969 most time webtags will accept an option 'format' parameter, e.g: <#YearTempHT format=hh:nn>. This allows you to override the default display format for that item, using the format specifiers in the table below. Note that if your format has any spaces in it, you must enclose it in double quotes, thus: <#YearTempHT format="hh nn">. Note also that you can specify date formatting to times and vice versa, but this will not always yield a sensible result.
 
Below are a list of the webtags available. There are currently 192 webtags, based on version 1.9.0 of Cumulus.  Webtags for beta versions of Cumulus are not listed here until the version becomes 'live' however there is a page which details the [[BETA webtags|additional webtags]] available in the Beta version


==Date & Time==
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | webtag
!style="width:150px" | Specifier
!style="width:600px" | Function
!style="width:600px" | Displays
|-
|c
|Displays the date using the format given by the Windows Short Date format, followed by the time using the format given by the Windows Long Time format. The time is not displayed if the date-time value indicates midnight precisely.
|-
|-
|<#date>
|d
|The current date
|Displays the day as a number without a leading zero (1-31).
|-
|-
|<#time>
|dd
|The current time and date. Example result: 18:30 on 30 December 2009.  If you simply wish the time, use a combination of the day, month, year tags (below)
|Displays the day as a number with a leading zero (01-31).
|-
|-
|<#timehhmmss>
|ddd
|The current time. Example format: 18:30:27
|Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Windows Locale.
|-
|-
|<#day>
|dddd
|The current day as a 2-digit number. Example format: 14 
|Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Windows Locale.
|-
|-
|<#dayname>
|ddddd
|The current day as a word. For example, Monday
|Displays the date using the format given by the Windows Short Date format.
|-
|-
|<#shortdayname>
|dddddd
|The current day as a shortened word. Example format: Mon
|Displays the date using the format given by the Windows Long Date format.
|-
|-
|<#month>
|m
|The current month as a 2-digit number. Example format: 05
|Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
|-
|<#monthname>
|The current month as a word. Example format: August
|-
|-
|<#shortmonthname>
|mm
|The current month as a shortened word. Example format: Aug
|Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
|-
|-
|<#year>
|mmm
|The current year as a 4-digit number. Example format: 2009
|Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Windows Locale.
|-
|-
|<#shortyear>
|mmmm
|The current year as a 2-digit number. Example format: 09
|Displays the month as a full name (January-December) using the strings appropriate to the Windows Locale.
|-
|-
|<#hour>
|yy
|The current hour as a 2-digit number. Example format: 23
|Displays the year as a two-digit number (00-99).
|-
|-
|<#minute>
|yyyy
|The current minute as a 2-digit number. Example format: 59
|Displays the year as a four-digit number (0000-9999).
|-
|-
|<#recordsbegandate>
|h
|The date that the all time records began
|Displays the hour without a leading zero (0-23).
|-
|-
|<#realtimeinterval>
|hh
|The realtime update interval in seconds
|Displays the hour with a leading zero (00-23).
|-
|-
|<#rollovertime>
|n
|The time that the logs rollover to the next day. Format: 'Midnight','9 am','10 am'
|Displays the minute without a leading zero (0-59).  
|}
 
==Current Conditions==
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | webtag
|nn
!style="width:600px" | Function
|Displays the minute with a leading zero (00-59).
|-
|-
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|s
|Displays the second without a leading zero (0-59).
|-
|-
|<#temp>
|ss
|The outside temperature
|Displays the second with a leading zero (00-59).
|-
|-
|<#intemp>
|z
|The inside temperature
|Displays the millisecond without a leading zero (0-999).
|-
|-
|<#temptrend>
|zzz
|The change in temperature over the last hour
|Displays the millisecond with a leading zero (000-999).
|-
|-
|<#temptrendtext>
|t
|Temperature change over the last hour. Format:'Rising','Falling','Steady' plus optional 'Quickly','Slowly'
|Displays the time using the format given by the Windows Short Time format.
|-
|-
|<#temptrendenglish>
|tt\
|Simple description of temperature change over the last hour. Format: 'Rising','Falling','Steady'.  Useful for Javascript coding.
|Displays the time using the format given by the Windows Long Time format.  
|-
|-
|<#heatindex>
|am/pm
|Current [[heat index]]
|Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
|-
|-
|<#humidex>
|a/p
|Current [http://en.wikipedia.org/wiki/Humidex Humidex]
|Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
|-
|-
|<#hum>
|ampm
|The outside [http://en.wikipedia.org/wiki/Humidity humidity]
|Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the Windows AM string for any hour before noon, and the contents of the Windows PM string for any hour after noon.
|-
|-
|<#inhum>
|/
|The inside humidity
|Displays the date separator character given by the Windows Date Separator.
|-
|-
|<#dew>
|:
|The outside dew point
|Displays the time separator character given by the Windows Time Separator.
|-
|-
|<#wchill>
|'xx'
|The current [[wind chill]] temperature
|Characters enclosed in single quotation marks are displayed as such, and do not affect formatting.
|}
 
=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==
{| class="wikitable" border="1"
|-
|-
|<#tempunit>
!style="width:150px" | webtag
|Unit of temperature being used (Set in Cumulus as [http://en.wikipedia.org/wiki/Centigrade Centigrade] or [http://en.wikipedia.org/wiki/Fahrenheit Fahrenheit]). Format: '&amp;deg;C','&amp;deg;F'
!style="width:600px" | Function
|-
|-
|colspan="2" style="background:lightgray;"|Rainfall
|}
 
==Current Conditions==
 
{| class="wikitable" border="1"
|-
|-
|<#rrate>
!style="width:150px" | webtag
|The current rainfall rate
!style="width:600px" | Function
|-
|-
|<#rhour>
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|The rainfall in the last hour
|-
|-
|<#rainunit>
|<#apptemp>
|Unit of measure for rain fall. Format: 'mm','in'
|The apparent temperature
|-
|-
|<#LastRainTipISO>
|colspan="2" style="background:lightgray;"|Rainfall
|Date/time of last rain gauge tip (e.g 2010-09-06 06:09)
|-
|-
|colspan="2" style="background:lightgray;"|Pressure
|colspan="2" style="background:lightgray;"|Pressure
|-
|<#press>
|The [http://en.wikipedia.org/wiki/Sea_level_pressure sea level pressure]
|-
|<#presstrend>
|The pressure trend in words. Format:'Rising','Falling',Steady' plus optional 'Quickly','Slowly' - values can be overridden in the 'strings.ini' file
|-
|<#presstrendval>
|The pressure trend in figures
|-
|<#presstrendenglish>
| a singe word description for the pressure trend. Format: 'Rising','Falling','Steady'.  Useful for developing Javascript coding on your webpage.
|-
|<#pressunit>
|Unit of measure for pressure. Format: 'mb','hPa','in'
|-
|-
|colspan="2" style="background:lightgray;"|Wind
|colspan="2" style="background:lightgray;"|Wind
|-
|<#wspeed>
|the 10-minute average, if you have Cumulus set to calculate a 10-minute average. Otherwise, it's the latest 'wind' value from the console (i.e. the current speed as determined by the station). Corresponds to 'average' on the Cumulus main screen.
|-
|<#wgust>
|The highest wind reading in the last 10 minutes. Corresponds to 'gust' on the Cumulus main screen.
|-
|<#wlatest>
|Latest wind speed reading from console.  Corresponds to 'latest' on the Cumulus main screen.
|-
|<#bearing>
|The current wind bearing
|-
|<#avgbearing>
|Average wind bearing over last 10 minutes. Range: 1-360, 0=Calm
|-
|<#wdir>
|Average wind bearing as a [http://en.wikipedia.org/wiki/Compass compass] point - e.g. ESE
|-
|<#currentwdir>
|Current 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!
|-
|<#windunit>
|Unit of measure for wind speed. Format: 'mph','m/s','km/h','kts'
|-
|<#windrununit>
|Unit of measure for wind run (distance). Format: 'miles','km','nm'
|-
|<#beaufort>
|The current wind speed on the [http://en.wikipedia.org/wiki/Beaufort_scale Beaufort scale] (e.g. F8)
|-
|<#beaudesc>
|The current wind speed Beaufort description (e.g. "Gale")
|-
|-
|}
|}
Line 199: Line 148:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#tempTH>
|<#apptempTH>
|Today's highest temperature
|Today's high apparent temperature
|<#TtempTH>
|<#TapptempTH>
|-
|-
|<#tempTL>
|<#apptempTL>
|Today's lowest temperature
|Today's low apparent temperature
|<#TtempTL>
|<#TapptempTL>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|<#heatindexTH>
|Today's high heat index
|<#TheatindexTH>
|-
|-
|<#rfall>
|<#wchillTL>
|The total rainfall so far today
|Today's lowest wind chill
|N/A
|<#TwchillTL>
|-
|-
|<#rmidnight>
|<#dewpointTH>
|The total rainfall since midnight. Useful if you don't use midnight as your start of day
|Today's highest dew point
|N/A
|<#TdewpointTH>
|-
|-
|<#rrateTM>
|<#dewpointTL>
|Today's maximum rain rate
|Today's lowest dew point
|<#TrrateTM>
|<#TdewpointTL>
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|<#humTH>
|Today's highest humidity
|<#ThumTH>
|-
|-
|<#pressTH>
|<#humTL>
|Today's highest pressure reading
|Today's lowest humidity
|<#TpressTH>
|<#ThumTL>
|-
|-
|<#pressTL>
|colspan="3" style="background:lightgray;"|Rainfall
|Today's lowest pressure reading
|<#TpressTL>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|<#hourlyrainTH>
|-
|Today's highest rainfall rate
|<#windrun>
|<#ThourlyrainTH>
|The total wind run today so far
|N/A
|-
|-
|<#bearingTM>
|colspan="3" style="background:lightgray;"|Pressure
|Today's mean wind bearing
|N/A
|-
|-
|<#windTM>
|colspan="3" style="background:lightgray;"|Wind
|Today's maximum (average) wind speed
|<#TwindTM>
|-
|<#wgustTM>
|Today's maximum wind gust
|<#TwgustTM>
|-
|<#Tbeaufort>
|Today's highest wind speed, expressed in the Beaufort scale
|<#TwindTM>
|}
|}


Line 264: Line 201:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#tempYH>
|<#apptempYH>
|Yesterday's highest temperature
|Yesterday's high apparent temperature
|<#TtempYH>
|<#TapptempYH>
|-
|-
|<#tempYL>
|<#apptempYL>
|Yesterday's lowest temperature
|Yesterday's low apparent temperature
|<#TtempYL>
|<#TapptempYL>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|<#heatindexYH>
|Yesterday's high heat index
|<#TheatindexYH>
|-
|-
|<#rfallY>
|<#wchillYL>
|The total rainfall for yesterday
|Yesterday's lowest wind chill
|N/A
|<#TwchillYL>
|-
|-
|<#rrateYM>
|<#dewpointYL>
|Yesterday's maximum rain rate
|Yesterday's lowest dew point
|<#TrrateYM>
|<#TdewpointYL>
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|<#dewpointYH>
|Yesterday's highest dew point
|<#TdewpointYH>
|-
|-
|<#pressYH>
|<#humYH>
|Yesterday's highest pressure reading
|High humidity yesterday
|<#TpressYH>  
|<#ThumYH>
|-
|-
|<#pressYL>
|<#humYL>
|Yesterday's lowest pressure reading
|Low humidity yesterday
|<#TpressYL>
|<#ThumYL>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#windrunY>
|<#hourlyrainYH>
|The total wind run for yesterday
|Yesterday's highest rainfall rate
|N/A
|<#ThourlyrainYH>
|-
|-
|<#bearingYM>
|colspan="3" style="background:lightgray;"|Pressure
|Yesterday's mean wind bearing
|N/A
|-
|-
|<#windYM>
|colspan="3" style="background:lightgray;"|Wind
|Yesterday's maximum (average) wind speed
|<#TwindYM>
|-
|<#wgustYM>
|Yesterday's maximum wind gust
|<#TwgustYM>
|-
|<#Ybeaufort>
|Yesterday's highest wind speed, expressed in the Beaufort scale
|<#TwindYM>
|}
|}


Line 319: Line 248:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | webtag
!style="width:150px"|webtag
!style="width:300px" | Function
!style="width:300px"|Function
!style="width:150px" | Time
!style="width:150px"|Time
!style="width:150px" | Date or Date/Time
!style="width:150px"|Date
|-
|<#MonthTempH>
|This months high temperature
|<#MonthTempHT>
|<#MonthTempHD>
|-
|<#MonthTempL>
|This months low temperature
|<#MonthTempLT>
|<#MonthTempLD>
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|<#MonthHeatIndexH>
|This months high heat index
|<#MonthHeatIndexHT>
|<#MonthHeatIndexHD>
|-
|-
|.
|<#MonthWChillL>
|.
|This months low wind chill
|.
|<#MonthWChillLT>
|.
|<#MonthWChillLD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|<#MonthAppTempH>
|This months high apparent temperature
|<#MonthAppTempHT>
|<#MonthAppTempHD>
|-
|-
|<#rmonth>
|<#MonthAppTempL>
|The total rainfall so far this month
|This months low apparent temperature
|N/A
|<#MonthAppTempLT>
|N/A
|<#MonthAppTempLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|<#MonthDewPointH>
|This months high dew point
|<#MonthDewPointHT>
|<#MonthDewPointHD>
|-
|-
|.
|<#MonthDewPointL>
|.
|This months low dew point
|.
|<#MonthDewPointpLT>
|.
|<#MonthDewPointLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#MonthMinTempH>
|This months highest daily minimum temperature
|N/A
|<#MonthMinTempHD>
|-
|-
|.
|<#MonthMaxTempL>
|.
|This months lowest daily minimum temperature
|.
|N/A
|.
|<#MonthMaxTempLD>
|}
 
==Yearly==
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | webtag
|<#MonthPressH>
!style="width:300px" | Function
|This months highest pressure
!style="width:150px" | Time
|<#MonthPressHT>
!style="width:150px" | Date or Date/Time
|<#MonthPressHD>
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|<#MonthPressL>
|This months lowest pressure
|<#MonthPressLT>
|<#MonthPressLD>
|-
|-
|.
|<#MonthHumH>
|.
|This months highest humidty
|.
|<#MonthHumHT>
|.
|<#MonthHumHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|<#MonthHumL>
|This months lowest humidty
|<#MonthHumLT>
|<#MonthHumLD>
|-
|-
|<#ryear>
|<#MonthGustH>
|The total rainfall so far this year
|This months highest wind gust
|N/A
|<#MonthGustHT>
|N/A
|<#MonthGustHD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|<#MonthWindH>
|This months highest wind speed
|<#MonthWindHT>
|<#MonthWindHD>
|-
|-
|.
|<#MonthRainRateH>
|.
|This months highest rainfall rate
|.
|<#MonthRainRateHT>
|.
|<#MonthRainRateHD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#MonthHourlyRainH>
|This months highest hourly rain
|<#MonthHourlyRainHT>
|<#MonthHourlyRainHD>
|-
|-
|.
|<#MonthDailyRainH>
|.
|This months greatest daily rain
|.
|N/A
|.
|<#MonthDailyRainHD>
|}
|}


==All Time==
==Yearly==


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | webtag
!style="width:150px"|webtag
!style="width:300px" | Function
!style="width:300px"|Function
!style="width:150px" | Time
!style="width:150px"|Time
!style="width:150px" | Date or Date/Time
!style="width:150px"|Date
|-
|<#YearTempH>
|This years highest temperature
|<#YearTempHT>
|<#YearTempHD>
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|<#YearTempL>
|This years lowest temperature
|<#YearTempLT>
|<#YearTempLD>
|-
|-
|<#tempH>
|<#YearHeatIndexH>
|All time high temperature
|This years highest heat index
|N/A
|<#YearHeatIndexHT>
|<#TtempH>
|<#YearHeatIndexHD>
|-
|-
|<#tempL>
|<#YearWChillL>
|All time low temperature
|This years lowest wind chill
|N/A
|<#YearWChillLT>
|<#TtempL>
|<#YearWChillLD>
|-
|-
|<#mintempH>
|<#YearAppTempH>
|All time high minimum temperature  
|This years highest apparent temperature
|N/A
|<#YearAppTempHT>
|<#TmintempH>
|<#YearAppTempHD>
|-
|-
|<#maxtempL>
|<#YearAppTempL>
|All time low maximum temperature
|This years lowest apparent temperature
|N/A
|<#YearAppTempLT>
|<#TmaxtempL>
|<#YearAppTempLD>
|-
|-
|<#wchillH>
|<#YearDewPointH>
|All time greatest wind chill (i.e. lowest temperature)
|This years highest dew point
|N/A
|<#YearDewPointHT>
|<#TwchillH>
|<#YearDewPointHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|<#YearDewPointL>
|This years lowest dew point
|<#YearDewPointLT>
|<#YearDewPointLD>
|-
|-
|<#rrateM>
|<#YearMinTempH>
|All time high rain rate
|This years highest daily minimum temperature
|N/A
|N/A
|<#TrrateM>
|<#YearMinTempHD>
|-
|-
|<#rfallH>
|<#YearMaxTempL>
|All time high daily rain
|This years lowest daily minimum temperature
|N/A
|N/A
|<#TrfallH>
|<#YearMaxTempLD>
|-
|-
|<#rfallhH>
|<#YearPressH>
|All time high hourly rain
|This years high pressure
|N/A
|<#YearPressHT>
|<#TrfallhH>
|<#YearPressHD>
|-
|<#YearPressL>
|This years low pressure
|<#YearPressLT>
|<#YearPressLD>
|-
|<#YearHumH>
|This years high humidty
|<#YearHumHT>
|<#YearHumHD>
|-
|-
|<#rfallmH>
|<#YearHumL>
|All time high monthly rain
|This years low humidty
|N/A
|<#YearHumLT>
|<#TrfallmH>
|<#YearHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|<#YearGustH>
|This years high wind gust
|<#YearGustHT>
|<#YearGustHD>
|-
|-
|<#pressH>
|<#YearWindH>
|All time high pressure
|This years high wind speed
|N/A
|<#YearWindHT>
|<#TpressH>
|<#YearWindHD>
|-
|-
|<#pressL>
|<#YearRainRateH>
|All time low pressure
|This years high rainfall rate
|N/A
|<#YearRainRateHT>
|<#TpressL>
|<#YearRainRateHD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#YearHourlyRainH>
|This years high hourly rain
|<#YearHourlyRainHT>
|<#YearHourlyRainHD>
|-
|-
|<#gustM>
|<#YearDailyRainH>
|All time high wind gust
|This years high daily rain
|N/A
|N/A
|<#TgustM>
|<#YearDailyRainHD>
|-
|-
|<#wspeedH>
|<#YearMonthlyRainH>
|All time high average wind speed
|This years high monthly rain
|N/A
|N/A
|<#TwspeedH>
|<#YearMonthlyRainHD>
|}
|}


==Miscellaneous==
==All Time==


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
!style="width:150px" | webtag
!style="width:600px" | Function
!style="width:300px" | Function
!style="width:150px" | Time
|-
|-
|<#version>
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|The version of Cumulus in use
|-
|-
|<#build>
|<#apptempH>
|The build of Cumulus in use
|All time high apparent temperature
|<#TapptempH>
|-
|-
|<#interval>
|<#apptempL>
|The web site update interval in minutes
|All time low apparent temperature
|<#TapptempL>
|-
|-
|<#update>
|<#heatindexH>
|The date and time of the last web site update
|All time high heat index
|<#TheatindexH>
|-
|-
|<#stationtype>
|<#dewpointH>
|The type of station in use
|All time high dew point
|<#TdewpointH>
|-
|-
|<#latitude>
|<#dewpointL>
|The station [http://en.wikipedia.org/wiki/Latitude latitude]
|All time low dew point
|<#TdewpointL>
|-
|-
|<#longitude>
|<#humH>
|The station [http://en.wikipedia.org/wiki/Longitude longitude]
|All time high humidity
|<#ThumH>
|-
|-
|<#altitude>
|<#humL>
|The station [http://en.wikipedia.org/wiki/Altitude altitude]
|All time low humidity
|<#ThumL>
|}
 
==Miscellaneous==
 
{| class="wikitable" border="1"
|-
|-
|<#location>
!style="width:150px" |webtag
|The station location
!style="width:600px" | Function
|-
|-
|<#longlocation>
|<#LatestError>
|Longer description of the station location
|Displays the last error from the Cumulus error log
|-
|-
|<#forum>
|<#LatestErrorDate>
|URL of the forum
|The date of the latest error logged to the error log window, using the system short date format. Gives dashes when latest error is reset
|-
|-
|<#webcam>
|<#LatestErrorTime>
|URL of the webcam
|The time of the latest error logged to the error log window, using the system short time format. Gives dashes when latest error is reset
|-
|-
|<#graphperiod>
|<#ErrorLight>
|The number of hours displayed by the graphs
|1 if the 'error' light is flashing, 0 if not
|}
 
==Day/Night/Sun/Moon==
 
{| class="wikitable" border="1"
|-
|-
|[[Forecast_webtag|<#forecast>]]
!style="width:150px" | webtag
|The current forecast
!style="width:600px" | Function
|-
|<#forecastnumber>
|The number relating to the current forecast entry in the [[strings.ini]] file.  If your station is not providing it's own forecast and Cumulus is not calculating one then 0 (zero) is returned
|-
|<#cloudbase>
|Calculated [http://en.wikipedia.org/wiki/Cloud_base cloud base]
|-
|<#ET>
|Today's [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration]
|-
|-
|<#UV>
|<#SunshineHours>
|Current [http://en.wikipedia.org/wiki/Uv_index UV index]
|Hours of sunshine so far today
|-
|-
|<#SolarRad>
|<#YSunshineHours>
|Current [http://en.wikipedia.org/wiki/Solar_radiation solar radiation]
|Total hours of sunshine yesterday
|-
|-
|<#snowdepth>
|<#CurrentSolarMax>
|Today's snow depth as entered manually in the Weather Diary. Normally in Centimeters.Output is purely as a numerical figure I.E 10
|Current theoretical maximum solar radiation
|-
|-
|<#currcond>
|<#IsSunny>
|Represents the value entered on the screen within Cumulus for the Current Weather condition, or the value as held in the [[currentconditions.txt]] file
|Returns 1 if the sun is shining, otherwise 0
|-
|-
|<#newrecord>  
|<#MoonPercent>
|1 if 'new record' light is flashing, 0 if not
|Current percentage of moon visible (negative value indicates 'waning')
|-
|-
|<#LatestError>
|<#MoonPercentAbs>
|Displays the last error message in the Cumulus error log
|Current percentage of moon visible (always positive)
|}
|}


==Day/Night/Sun/Moon==
==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'.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | webtag
!style="width:150px" |webtag
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#sunrise>
|<#TempRecordSet>
|Current sunrise time at the station
|1 if the indicator on the temperature tab on the all-time records screen is currently lit, 0 if not
|-
|<#WindRecordSet>
|1 if the indicator on the wind tab on the all-time records screen is currently lit, 0 if not
|-
|-
|<#sunset>
|<#RainRecordSet>
|Current sunset time at the station
|1 if the indicator on the rain tab on the all-time records screen is currently lit, 0 if not
|-
|-
|<#daylength>
|<#HumidityRecordSet>
|Length of day in hours and minutes (sunrise to sunset)
|1 if the indicator on the humidity tab on the all-time records screen is currently lit, 0 if not
|-
|-
|<#tomorrowdaylength>
|<#PressureRecordSet>
|A string giving the difference between the length of day light today and tomorrow.
|1 if the indicator on the pressure tab on the all-time records screen is currently lit, 0 if not
Note.  This tag has been shown to generate inaccurate results and will probably be removed from Cumulus but is here for reference only.
|-
|-
|<#dawn>
|<#HighTempRecordSet>
|Start of Civil Twilight at the station
|1 if the all-time high temperature light is currently flashing, 0 if not
|-
|-
|<#dusk>
|<#LowTempRecordSet>
|End of Civil Twilight at the station
|1 if the all-time low temperature light is currently flashing, 0 if not
|-
|-
|<#daylightlength>
|<#HighAppTempRecordSet>
|Length of daylight in hours and minutes (dawn to dusk)
|1 if the all-time high apparent temperature light is currently flashing, 0 if not
|-
|-
|<#moonphase>
|<#LowAppTempRecordSet>
|Current [[Lunar phase|phase of the moon]]
|1 if the all-time low apparent temperature light is currently flashing, 0 if not
|-
|-
|<#moonrise>
|<#HighHeatIndexRecordSet>
|Current moonrise time at the station
|1 if the all-time high heat index light is currently flashing, 0 if not
|-
|-
|<#moonset>
|<#LowWindChillRecordSet>
|Current moonset time at the station
|1 if the all-time low wind chill light is currently flashing, 0 if not
|-
|-
|<#isdaylight>
|<#HighDewPointRecordSet>
|A flag to indicate if the location for the station is in daylight or not, based on the dawn and dusk times.  Possible values are 0 or 1, where 1 notes that it is currently within the hours of daylight.
|1 if the all-time high dew point light is currently flashing, 0 if not
|}
 
==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'.
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
|<#LowDewPointRecordSet>
!style="width:600px" | Function
|1 if the all-time low dew point light is currently flashing, 0 if not
|-
|-
|<#LowTempAlarm>  
|<#HighMinTempRecordSet>
|Low temperature alarm
|1 if the all-time high minimum temperature light is currently flashing, 0 if not
|-
|-
|<#HighTempAlarm>  
|<#LowMaxTempRecordSet>
|High temperature alarm
|1 if the all-time low maximum temperature light is currently flashing, 0 if not
|-
|-
|<#TempChangeUpAlarm>  
|<#HighWindGustRecordSet>
|Temperature increase alarm
|1 if the all-time high wind gust light is currently flashing, 0 if not
|-
|-
|<#TempChangeDownAlarm>  
|<#HighWindSpeedRecordSet>
|Temperature decrease alarm
|1 if the all-time high wind speed light is currently flashing, 0 if not
|-
|-
|<#LowPressAlarm>  
|<#HighRainRateRecordSet>
|Low pressure alarm
|1 if the all-time high rain rate light is currently flashing, 0 if not
|-
|-
|<#HighPressAlarm>  
|<#HighHourlyRainRecordSet>
|High pressure alarm
|1 if the all-time high hourly rain light is currently flashing, 0 if not
|-
|-
|<#PressChangeUpAlarm>  
|<#HighDailyRainRecordSet>
|Pressure increase alarm
|1 if the all-time high daily rain light is currently flashing, 0 if not
|-
|-
|<#PressChangeDownAlarm>  
|<#HighMonthlyRainRecordSet>
|Pressure decrease alarm
|1 if the all-time high monthly rain light is currently flashing, 0 if not
|-
|-
|<#HighRainTodayAlarm>  
|<#HighHumidityRecordSet>
|High rain today alarm
|1 if the all-time high humidity light is currently flashing, 0 if not
|-
|-
|<#HighRainRateAlarm>  
|<#LowHumidityRecordSet>
|High rainfall rate alarm
|1 if the all-time low humidity light is currently flashing, 0 if not
|-
|-
|<#HighWindGustAlarm>  
|<#HighPressureRecordSet>
|High wind gust alarm
|1 if the all-time high pressure light is currently flashing, 0 if not
|-
|-
|<#HighWindSpeedAlarm>  
|<#LowPressureRecordSet>
|High wind speed alarm
|1 if the all-time low pressure light is currently flashing, 0 if not
|}
|}


==Special tags==
==Special tags==
===Davis===
There are a set of tags specific to the Davis PWS:
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|<#battery>
|The console battery condition
|-
|<#txbattery>
|The transmitter battery condition
|}
===Fine Offset===
There are a set of tags specific to the FO range of PWS:
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|<#sensorcontactlost>
|1 if the station has lost contact with its remote sensors. 0 if contact has been established
|}


===WMR928===
===WMR928===
Line 677: Line 639:
!style="width:600px" | Function
!style="width:600px" | 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
|}
|}


Line 709: Line 645:


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

Revision as of 23:32, 2 February 2011

Additional webtags available in the BETA version of Cumulus 1.9.1

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!

Time/Date 'format' Parameter=

From 1.9.1 b969 most time webtags will accept an option 'format' parameter, e.g: <#YearTempHT format=hh:nn>. This allows you to override the default display format for that item, using the format specifiers in the table below. Note that if your format has any spaces in it, you must enclose it in double quotes, thus: <#YearTempHT format="hh nn">. Note also that you can specify date formatting to times and vice versa, but this will not always yield a sensible result.

Specifier Displays
c Displays the date using the format given by the Windows Short Date format, followed by the time using the format given by the Windows Long Time format. The time is not displayed if the date-time value indicates midnight precisely.
d Displays the day as a number without a leading zero (1-31).
dd Displays the day as a number with a leading zero (01-31).
ddd Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Windows Locale.
dddd Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Windows Locale.
ddddd Displays the date using the format given by the Windows Short Date format.
dddddd Displays the date using the format given by the Windows Long Date format.
m Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
mm Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
mmm Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Windows Locale.
mmmm Displays the month as a full name (January-December) using the strings appropriate to the Windows Locale.
yy Displays the year as a two-digit number (00-99).
yyyy Displays the year as a four-digit number (0000-9999).
h Displays the hour without a leading zero (0-23).
hh Displays the hour with a leading zero (00-23).
n Displays the minute without a leading zero (0-59).
nn Displays the minute with a leading zero (00-59).
s Displays the second without a leading zero (0-59).
ss Displays the second with a leading zero (00-59).
z Displays the millisecond without a leading zero (0-999).
zzz Displays the millisecond with a leading zero (000-999).
t Displays the time using the format given by the Windows Short Time format.
tt\ Displays the time using the format given by the Windows Long Time format.
am/pm Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
a/p Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
ampm Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the Windows AM string for any hour before noon, and the contents of the Windows PM string for any hour after noon.
/ Displays the date separator character given by the Windows Date Separator.
: Displays the time separator character given by the Windows Time Separator.
'xx' Characters enclosed in single quotation marks are displayed as such, and do not affect formatting.

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

Current Conditions

webtag Function
Temperature & Humidity
<#apptemp> The apparent temperature
Rainfall
Pressure
Wind

Today

webtag Function Time
Temperature & Humidity
<#apptempTH> Today's high apparent temperature <#TapptempTH>
<#apptempTL> Today's low apparent temperature <#TapptempTL>
<#heatindexTH> Today's high heat index <#TheatindexTH>
<#wchillTL> Today's lowest wind chill <#TwchillTL>
<#dewpointTH> Today's highest dew point <#TdewpointTH>
<#dewpointTL> Today's lowest dew point <#TdewpointTL>
<#humTH> Today's highest humidity <#ThumTH>
<#humTL> Today's lowest humidity <#ThumTL>
Rainfall
<#hourlyrainTH> Today's highest rainfall rate <#ThourlyrainTH>
Pressure
Wind

Yesterday

webtag Function Time
Temperature & Humidity
<#apptempYH> Yesterday's high apparent temperature <#TapptempYH>
<#apptempYL> Yesterday's low apparent temperature <#TapptempYL>
<#heatindexYH> Yesterday's high heat index <#TheatindexYH>
<#wchillYL> Yesterday's lowest wind chill <#TwchillYL>
<#dewpointYL> Yesterday's lowest dew point <#TdewpointYL>
<#dewpointYH> Yesterday's highest dew point <#TdewpointYH>
<#humYH> High humidity yesterday <#ThumYH>
<#humYL> Low humidity yesterday <#ThumYL>
Rainfall
<#hourlyrainYH> Yesterday's highest rainfall rate <#ThourlyrainYH>
Pressure
Wind

Monthly

webtag Function Time Date
<#MonthTempH> This months high temperature <#MonthTempHT> <#MonthTempHD>
<#MonthTempL> This months low temperature <#MonthTempLT> <#MonthTempLD>
<#MonthHeatIndexH> This months high heat index <#MonthHeatIndexHT> <#MonthHeatIndexHD>
<#MonthWChillL> This months low wind chill <#MonthWChillLT> <#MonthWChillLD>
<#MonthAppTempH> This months high apparent temperature <#MonthAppTempHT> <#MonthAppTempHD>
<#MonthAppTempL> This months low apparent temperature <#MonthAppTempLT> <#MonthAppTempLD>
<#MonthDewPointH> This months high dew point <#MonthDewPointHT> <#MonthDewPointHD>
<#MonthDewPointL> This months low dew point <#MonthDewPointpLT> <#MonthDewPointLD>
<#MonthMinTempH> This months highest daily minimum temperature N/A <#MonthMinTempHD>
<#MonthMaxTempL> This months lowest daily minimum temperature N/A <#MonthMaxTempLD>
<#MonthPressH> This months highest pressure <#MonthPressHT> <#MonthPressHD>
<#MonthPressL> This months lowest pressure <#MonthPressLT> <#MonthPressLD>
<#MonthHumH> This months highest humidty <#MonthHumHT> <#MonthHumHD>
<#MonthHumL> This months lowest humidty <#MonthHumLT> <#MonthHumLD>
<#MonthGustH> This months highest wind gust <#MonthGustHT> <#MonthGustHD>
<#MonthWindH> This months highest wind speed <#MonthWindHT> <#MonthWindHD>
<#MonthRainRateH> This months highest rainfall rate <#MonthRainRateHT> <#MonthRainRateHD>
<#MonthHourlyRainH> This months highest hourly rain <#MonthHourlyRainHT> <#MonthHourlyRainHD>
<#MonthDailyRainH> This months greatest daily rain N/A <#MonthDailyRainHD>

Yearly

webtag Function Time Date
<#YearTempH> This years highest temperature <#YearTempHT> <#YearTempHD>
<#YearTempL> This years lowest temperature <#YearTempLT> <#YearTempLD>
<#YearHeatIndexH> This years highest heat index <#YearHeatIndexHT> <#YearHeatIndexHD>
<#YearWChillL> This years lowest wind chill <#YearWChillLT> <#YearWChillLD>
<#YearAppTempH> This years highest apparent temperature <#YearAppTempHT> <#YearAppTempHD>
<#YearAppTempL> This years lowest apparent temperature <#YearAppTempLT> <#YearAppTempLD>
<#YearDewPointH> This years highest dew point <#YearDewPointHT> <#YearDewPointHD>
<#YearDewPointL> This years lowest dew point <#YearDewPointLT> <#YearDewPointLD>
<#YearMinTempH> This years highest daily minimum temperature N/A <#YearMinTempHD>
<#YearMaxTempL> This years lowest daily minimum temperature N/A <#YearMaxTempLD>
<#YearPressH> This years high pressure <#YearPressHT> <#YearPressHD>
<#YearPressL> This years low pressure <#YearPressLT> <#YearPressLD>
<#YearHumH> This years high humidty <#YearHumHT> <#YearHumHD>
<#YearHumL> This years low humidty <#YearHumLT> <#YearHumLD>
<#YearGustH> This years high wind gust <#YearGustHT> <#YearGustHD>
<#YearWindH> This years high wind speed <#YearWindHT> <#YearWindHD>
<#YearRainRateH> This years high rainfall rate <#YearRainRateHT> <#YearRainRateHD>
<#YearHourlyRainH> This years high hourly rain <#YearHourlyRainHT> <#YearHourlyRainHD>
<#YearDailyRainH> This years high daily rain N/A <#YearDailyRainHD>
<#YearMonthlyRainH> This years high monthly rain N/A <#YearMonthlyRainHD>

All Time

webtag Function Time
Temperature & Humidity
<#apptempH> All time high apparent temperature <#TapptempH>
<#apptempL> All time low apparent temperature <#TapptempL>
<#heatindexH> All time high heat index <#TheatindexH>
<#dewpointH> All time high dew point <#TdewpointH>
<#dewpointL> All time low dew point <#TdewpointL>
<#humH> All time high humidity <#ThumH>
<#humL> All time low humidity <#ThumL>

Miscellaneous

webtag Function
<#LatestError> Displays the last error from the Cumulus error log
<#LatestErrorDate> The date of the latest error logged to the error log window, using the system short date format. Gives dashes when latest error is reset
<#LatestErrorTime> The time of the latest error logged to the error log window, using the system short time format. Gives dashes when latest error is reset
<#ErrorLight> 1 if the 'error' light is flashing, 0 if not

Day/Night/Sun/Moon

webtag Function
<#SunshineHours> Hours of sunshine so far today
<#YSunshineHours> Total hours of sunshine yesterday
<#CurrentSolarMax> Current theoretical maximum solar radiation
<#IsSunny> Returns 1 if the sun is shining, otherwise 0
<#MoonPercent> Current percentage of moon visible (negative value indicates 'waning')
<#MoonPercentAbs> Current percentage of moon visible (always positive)

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
<#TempRecordSet> 1 if the indicator on the temperature tab on the all-time records screen is currently lit, 0 if not
<#WindRecordSet> 1 if the indicator on the wind tab on the all-time records screen is currently lit, 0 if not
<#RainRecordSet> 1 if the indicator on the rain tab on the all-time records screen is currently lit, 0 if not
<#HumidityRecordSet> 1 if the indicator on the humidity tab on the all-time records screen is currently lit, 0 if not
<#PressureRecordSet> 1 if the indicator on the pressure tab on the all-time records screen is currently lit, 0 if not
<#HighTempRecordSet> 1 if the all-time high temperature light is currently flashing, 0 if not
<#LowTempRecordSet> 1 if the all-time low temperature light is currently flashing, 0 if not
<#HighAppTempRecordSet> 1 if the all-time high apparent temperature light is currently flashing, 0 if not
<#LowAppTempRecordSet> 1 if the all-time low apparent temperature light is currently flashing, 0 if not
<#HighHeatIndexRecordSet> 1 if the all-time high heat index light is currently flashing, 0 if not
<#LowWindChillRecordSet> 1 if the all-time low wind chill light is currently flashing, 0 if not
<#HighDewPointRecordSet> 1 if the all-time high dew point light is currently flashing, 0 if not
<#LowDewPointRecordSet> 1 if the all-time low dew point light is currently flashing, 0 if not
<#HighMinTempRecordSet> 1 if the all-time high minimum temperature light is currently flashing, 0 if not
<#LowMaxTempRecordSet> 1 if the all-time low maximum temperature light is currently flashing, 0 if not
<#HighWindGustRecordSet> 1 if the all-time high wind gust light is currently flashing, 0 if not
<#HighWindSpeedRecordSet> 1 if the all-time high wind speed light is currently flashing, 0 if not
<#HighRainRateRecordSet> 1 if the all-time high rain rate light is currently flashing, 0 if not
<#HighHourlyRainRecordSet> 1 if the all-time high hourly rain light is currently flashing, 0 if not
<#HighDailyRainRecordSet> 1 if the all-time high daily rain light is currently flashing, 0 if not
<#HighMonthlyRainRecordSet> 1 if the all-time high monthly rain light is currently flashing, 0 if not
<#HighHumidityRecordSet> 1 if the all-time high humidity light is currently flashing, 0 if not
<#LowHumidityRecordSet> 1 if the all-time low humidity light is currently flashing, 0 if not
<#HighPressureRecordSet> 1 if the all-time high pressure light is currently flashing, 0 if not
<#LowPressureRecordSet> 1 if the all-time low pressure light is currently flashing, 0 if not

Special tags

WMR928

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

webtag Function


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=User:Mcrossley&oldid=1269"