Webtags

From CumulusWiki
Jump to: navigation, search

The webtags available in the version/build you are using are listed in the Cumulus Help provided with that build.

Webtags available in Cumulus

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>

Note: When you put a tag into your template, 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!

Webtags are case sensitive, so please type them exactly as shown in the web tag columns on this page, or with parameter modifiers added as examples that are also shown on this page.

Using web tags in templates for creating HTML pages

  • You can create a template file that has a structure of HTML elements with Cumulus web tags to represent the information you want included.
  • If you ask Cumulus to process that template file, it will create a HTML page from the template, and during that file creation replace the tag with the current value of the item the tag represents.
  • You also need to tell Cumulus that the resulting HTML file is to be uploaded to the internet (or copied to a local web server).

Using web tags in scripts

Badge v1.pngThe web page references appearing below apply to Cumulus 1, not Cumulus MX.

  • You can also use the tags within script, this might be a PHP script, or JavaScript either embedded in HTML, or in external files, to transfer the values represented by the tags to the server for further processing.
  • As JavaScript can not understand a real number that has the integer and decimal parts separated by a comma, but your computer may be set to use that representation in standard tags, there are special versions of many tags to use in script - see tags with commas removed section.
  • Note that if a PHP or Javascript file contains any Cumulus web tags then you must ask Cumulus to process the script file.
  • JavaScript processing code can be embedded in a template that is already being processed into HTML. (This technique has been used in the standard 'monthlyrecordT.htm' template).
  • Alternatively embed a bit of JavaScript assignment code in HTML, that is already been processed, to convert the tags to a collection of string variables and use those variable names in any external script called from the HTML file. (This technique has been used in the standard 'gaugesT.htm' template).
  • To use the value from a tag as an integer in JavaScript assigning code you need to use a
integer_variable_name=parseInt(string_variable_name,10)
type conversion
  • Alternatively, in most script languages, apply '*1', i.e. multiply by one, to implicitly convert the tag from string to base 10 number.

Differences for Webtags in MX builds

Badge vMx.png The web tags listed below are those available in the latest official (finalised version) release of Cumulus 1.9.x. However, Cumulus MX provides equivalent tags, with only minor differences.

Beta Builds of Cumulus

There is a page that details the additional webtags available in any Cumulus Beta version that is currently under development.

Time/Date 'format' Parameter

Time/Date format codes are used in two places:

  1. As part of report names for NOAA style reports (see Cumulus.ini#Section:_NOAA)
  2. As part of web-tags that report either times or dates or both a date and a time

From version 1.9.1 most web-tags that report any form of time or date will accept an optional 'format' parameter, e.g. (Cumulus 1 only): <#YearTempHT format=hh:nn>.

This allows you to override the default display format for that item, using the format specifiers in the table below.

Although, in theory, you can specify date formatting to times, and vice versa, this will not always yield a sensible result. It is best to look at the default format (in most, but not all, cases this reveals whether date and time information are both available):

  • The time-stamps for today, and yesterday, only contain time information, so only time-based format instructions should be applied to them. You can use date format parameters on (for example) <#metdate>, and <#metdateyesterday> and that may give you your desired date information to augment the time-stamps.
  • Almanac times such as sun-rise, moon-rise, are also only times, and time-based format instructions can generally be applied to them. However, be aware these are calculated as at midnight GMT and for some of your calendar days, the times may be reported (in default format) as '--' if for example the moon does not rise that day.

Additional text

You should put anything that is additional, to the defined format modifier specification below, into single quotation marks to prevent it being interpreted as a date or time format modifier:

  1. For example, the word "on" contains the character "n", which for Cumulus versions 1.9.1 to 1.9.4 will be interpreted as a time format modifier unless you put it into single quotation marks. Example of valid Cumulus 1 syntax: <#TtempH format="'at' hh: mm 'on' dd / mm / yyyy">.
  2. You can include HTML tags (but they cannot have any attributes because both single and double quote characters have defined meanings) and special characters as quoted text within the 'format' parameter.
    Example of valid syntax: <#TapptempH format="'at 'h:nn' 'am/pm '<small>on' d/m/yyyy'</small>'">.

Note for Cumulus 1 - if your format has any spaces in it, you must enclose the whole format parameter value in double quotes, for example (Cumulus 1.9.x): <#YearTempHT format="hh nn">. Consequently, you cannot include double quote characters in any other position (see here for work-around).

Differences between Cumulus 1 and Cumulus MX (Cumulus 3):

  • Cumulus MX uses the .NET date and time format characters that are not exactly the same as the Delphi ones that Cumulus 1 uses. For Cumulus MX see this Microsoft site for format selectors. The differences come about because Delphi is case-insensitive, and .Net is case sensitive, so .Net can use upper and lower case for different items, where Delphi has to use different letters.
    1. For example, in Delphi, "nn" means "minutes" for Cumulus 1, but "minutes" is "mm" for .Net in Cumulus MX.
    2. e.g. the hour in 24-hour format, is "hh" (although 'HH' would be treated same) in Delphi (Cumulus 1) and in .Net it must be "HH" (Cumulus MX).
  • You might be put off by references for .Net (Cumulus MX) to single/standard characters and custom modifiers:
    1. For example <#MonthTempHD format="d"> is a single character format modifier, therefore the 'd' acts as a standard modifier, and causes a date of 22 July 2014 for the highest temperature in the month to be returned in the standard short date format e.g. '22/07/2014' (exact contents for any one date vary by locale).
    2. Similarly <#MonthTempHD format="M"> is a single character format modifier and therefore the 'M' acts as a standard modifier and causes the date for the highest temperature in the month to be returned in the standard day and month format e.g. '22 July' (exact contents for any one date vary by locale).
    3. Whilst <#metdate format="d M"> is not a single character format modifier and therefore both the 'd' and the 'M' are interpreted as custom modifiers and cause the current date to be returned as a digit(s) for the day and a digit(s) month (in a without leading zeroes format) e.g. '6 7' would be returned for 6 July.
  • The other change with the "format" parameter is the different way that .Net escapes characters that are not being used as format specifiers. In Delphi you can put the 'verbatim' characters inside single quotes (Cumulus 1); in .Net you can still use single quotes, but alternatively you can escape each verbatim character with a backslash as prefix (Cumulus MX).

For official full details see Cumulus MX forum, the following table is revised for simplicity. (I've abridged the table here and included '%' where necessary to avoid single character versus custom complications).

List of allowed modifiers

Note for Cumulus 1 - where lower (or upper, for easier comparison with MX) case shown, because Delphi is case insensitive, upper (or lower) case (in some cases, indicated by use of italics in brackets) could be used instead (exceptions: a/p, ampm, am/pm, Am/Pm, AM/PM, A/P, AMPM etc display as input)

Delphi Specifier for Cumulus 1.9.x .NET Specifier for Cumulus MX Displays
c G Displays the date using the format given by the Short Date format, followed by the time using the format given by the Long Time format. The time is not displayed in Cumulus 1 if the date-time value indicates midnight precisely.
d %d Displays the day as a number without a leading zero (1-31). Note that Cumulus MX requires a ' ' (space), '%' or other modifier to be included, as 'd' on its own returns full 'short date').
dd dd Displays the day as a number with a leading zero (01-31).
ddd ddd Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Locale.
dddd dddd Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Locale.
ddddd d (as single character format) Displays the date using the format given by the Short Date format.
dddddd D Displays the date using the format given by the Long Date format.
m %M Displays the month as a number without a leading zero (1-12).
  • Cumulus 1.x.y:If the 'm' specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
  • Cumulus MX: Note that including a ' ' (space) or '%' before the M makes it a custom modifier e.g. '7' is returned for July as any initial zero is suppressed. ('M' on its own returns both Month and Day according to local format e.g. 22 July).
MM (or mm) MM Displays the month as a number with a leading zero (01-12).
  • Cumulus 1.x.y:If the 'm' specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
MMM (or mmm) MMM Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Locale.
MMMM (or mmmm) MMMM Displays the month as a full name (January-December) using the strings appropriate to the Locale.
yy yy Displays the year as a two-digit number (00-99).
yyyy yyyy Displays the year as a four-digit number (0000-9999).
(h in combination with am/pm) h Displays the hour (12 hour clock) without a leading zero (1-12).
h H Displays the hour using 24 hour clock without a leading zero (0-23).
(hh in combination with am/pm) hh Displays the hour (12 hour clock) with a leading zero (01-12).
HH (or hh) HH Displays the hour using 24 hour clock with a leading zero (00-23).
n m Displays the minute without a leading zero (0-59).
nn mm Displays the minute with a leading zero (00-59).
s s Displays the second without a leading zero (0-59).
ss ss Displays the second with a leading zero (00-59).
z FFF Displays the millisecond without a leading zero (Cumulus 1:0-999, Cumulus MX: nothing, or 1-999). Note that the system clock in some versions of Windows only has precision to 15 ms.
(not available) ff (or 'f') Displays hundredths of a second (or tenths) with leading zero(s)
zzz fff Displays the millisecond with a leading zero (000-999). Note that the system clock in some versions of Windows only has precision to 15 ms, so requesting thousandths of a second may not return anything useful. The 'fff' modifier can actually be extended to 'ffffff' for a millionth of a second!
t t Displays the time using the Short Time format.
tt T Displays the time using the Long Time format.
am/pm tt 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 for Cumulus 1 can use lower, upper, or mixed case, and the result is displayed accordingly.

a/p t 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 (see above for 12 hour formats) 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 Date Separator.
: : Displays the time separator character given by the Time Separator.
'xy' 'xy' or \x\y Characters enclosed in single quotation marks are displayed as such, and do not affect formatting. In MX each character to be displayed as it was typed can be prefixed by a backslash.

The Tags

Below is a list of the webtags available in the 1.9.4 version of Cumulus. For Cumulus MX the few differences will be made clear when it is formally released.

Units

webtag Function
<#tempunit> Unit of temperature being used (Set in Cumulus as Celsius or Fahrenheit) values "&deg;C" or "&deg;F"
<#tempunitnodeg> The temperature units being used, without a degree symbol, i.e. "F" or "C"
<#pressunit> Unit of measure for pressure. Possible values: "mb", "hPa", "in"
<#rainunit> Unit of measure for rain fall. Possible values: "mm" or "inches"
<#windunit> Unit of measure for wind speed. Possible values: "m/s", "mph", "km/h", "kts"
<#windrununit> Unit of measure for wind run (distance). Possible values: "km", "miles", "km", "nm" (for wind speeds in m/s, mph, km/h, kts)
<#cloudbaseunit> The units used for cloudbase value. Possible values: "ft" or "m"

Date & Time

webtag Function
<#date> The current date
<#time> 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)
<#timehhmmss> The current time. Example format: 18:30:27
<#timeUTC> The current UTC date/time rather than local date/time
<#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
<#metdate> The current meteorological date. After rollover time on current calendar date, this date will be the same as the current date. If using a 9am/10am rollover, then between midnight and 9am/10am the <#metdate> will be the previous calendar day.

Can be used with relevant format parameters to indicate current meteorological day on todayT.htm template page, meteorological month on thismonthT.htm template page, or meteorological year on thisyearT.htm template page

<#metdateyesterday> The previous meteorological date. If using a 9am/10am rollover, then between midnight and 9am/10am the <#metdateyesterday> will be the calendar day before that returned by <#yesterday>, otherwise both return same.

Can be used with relevant format parameters to indicate correct day on yesterdayT.htm template page, and can be used to return latest day stored on dayfile.txt and NOAA report for latest month.

<#yesterday> Yesterdays date
<#rollovertime> The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
<#update> The date and time of the last web site update
<#LastDataReadT> The date/time data was last read from the station
<#DaysSince30Dec1899> Day count (gives whole and fractional part) Example: 41250.6523310301
<#DaysSinceRecordsBegan> Day count since Cumulus records started

Current Conditions

webtag Function
Temperature & Humidity
<#apptemp> The apparent temperature
<#temp> The outside temperature
<#intemp> The inside temperature
<#temptrend> The average rate of change in temperature over the last three hours. Trend = (temp_now - temp_3hrs_ago) / 3
<#temptrendtext> Temperature change over the last three hours - Rising/Falling/Steady (values can be set in strings.ini)
<#temptrendenglish> Temperature change over the last three hours - Rising/Falling/Steady (for use by HTML, javascript etc, values can't be changed)
<#TempChangeLastHour> The change in temperature over the last hour
<#heatindex> Current heat index
<#humidex> Current Humidex
<#hum> The outside humidity
<#inhum> The inside humidity
<#dew> The outside dew point
<#wchill> The current wind chill temperature
<#wetbulb> Estimated wet bulb temperature, currently only available via web tag
<#IsFreezing> If outside temperature is at or below 0°C/32°F. 0=Above freezing, 1=Below freezing
Rainfall
<#rfall> The total rainfall so far today
<#rrate> The current rainfall rate
<#rhour> The rainfall in the last hour
<#rmidnight> The total rainfall since midnight. Useful if you don't use midnight as your start of day
<#r24hour> Amount of rain in the last 24 hours
<#LastRainTipISO> Date/time of last rain gauge tip (e.g 2010-09-06 06:09)
<#MinutesSinceLastRainTip> The number of minutes since the last rain gauge tip, in whole numbers, rounded down
<#IsRaining> For Hydreon RG-11 devices, shows the current rain state. 0=No rain, 1=It's raining
Pressure
<#press> The sea level pressure
<#presstrendval> The average rate of pressure change over the last three hours.
<#presstrend> The pressure trend in words - values can be set in the 'strings.ini' file
<#presstrendenglish> a singe word description for the pressure trend - Rising/Falling/Steady (for use by HTML, javascript etc, values can't be changed)
<#altimeterpressure> Altimeter pressure. Pressure corrected to sea level using the station's altitude only. Same as sea-level pressure for non-Davis stations.
Wind
<#wlatest> Current wind speed reading from console. Corresponds to 'latest' on the Cumulus main screen.
<#bearing> Current wind bearing in degrees
<#currentwdir> Current wind bearing as a compass point - e.g. ESE
<#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.
<#avgbearing> Average wind bearing in degrees over last 10 minutes. Range 1-360, 0=Calm
<#wdir> Average wind bearing over last 10 minutes as a compass point - e.g. ESE
<#wgust> The highest wind reading in the last 10 minutes. Corresponds to 'gust' on the Cumulus main screen.
<#wdirdata> Comma separated list of recent wind bearing readings (every x seconds, up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex. Reading interval x varies by station type.
<#wspddata> Comma separated list of recent individual (non-averaged) wind speed (correspond to 'latest' on the Cumulus main screen) readings (every x seconds, up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex. Reading interval x varies by station type.
<#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!
<#beaufort> The current wind speed on the Beaufort scale (e.g. F8)
<#beaufortnumber> The current wind speed on the Beaufort scale, without a leading "F", e.g. "6"
<#beaudesc> The current wind speed Beaufort description (e.g. "Gale")
<#BearingRangeFrom> The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini)
<#BearingRangeTo> The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini)
<#BearingRangeFrom10> The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
<#BearingRangeTo10> The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
Miscellaneous
<#cloudbase> Calculated cloud base
<#cloudbasevalue> Current calculated cloud base without units
<#UV> Current UV index. Requires your station to have a UV sensor.
<#SolarRad> Current solar radiation. Requires your station to have a solar sensor.
<#Light> Current Current light level in Lux. Requires your station to have a solar sensor. Only applies to Fine Offset stations.
<#forecast> The current forecast
<#forecastenc> The same as <#forecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
<#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. Note: two negative numbers can be returned by Cumulus: -1 (neg 1) = Exceptional Fine, -26 (neg 26) = Exceptional Bad
<#cumulusforecast> Always gives Cumulus (Zambretti) forecast, even if the <#forecast> tag provides a station forecast
<#cumulusforecastenc> The same as <#cumulusforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
<#wsforecast> Always gives station forecast (if available)
<#wsforecastenc> The same as <#wsforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities

Today

webtag Function Time
Temperature & Humidity
<#tempTH> Today's highest temperature <#TtempTH>
<#tempTL> Today's lowest temperature <#TtempTL>
<#avgtemp> The average temperature so far today n/a
<#temprange> The temperature range (<#tempTH> - <#tempTL>) so far today (Cumulus calculates all these tags using Celsius values, but outputs them in your chosen units) n/a
<#apptempTH> Today's high apparent temperature <#TapptempTH>
<#apptempTL> Today's low apparent temperature <#TapptempTL>
<#heatindexTH> Today's high heat index <#TheatindexTH>
<#wchillTL> Today's greatest wind chill (i.e. lowest temperature) <#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
<#rrateTM> Today's maximum rain rate <#TrrateTM>
<#hourlyrainTH> Today's highest hourly rain <#ThourlyrainTH>
<#RG11RainToday> If you have an RG-11 rain sensor configured in "Tipping Bucket" mode, this gives today's rain total so far according to the sensor
Pressure
<#pressTH> Today's highest pressure reading <#TpressTH>
<#pressTL> Today's lowest pressure reading <#TpressTL>
Wind
<#windTM> Today's maximum (average) wind speed <#TwindTM>
<#wgustTM> Today's maximum wind gust <#TwgustTM>
<#bearingTM> The wind bearing at the time of today's high gust (<#wgustTM>) in degrees <#TwgustTM>
<#Tbeaufort> Today's highest wind speed, expressed in the Beaufort scale <#TwindTM>
<#Tbeaufortnumber> Today's high wind speed on the Beaufort scale, without a leading "F", e.g. "6" <#TwindTM>
<#windrun> The total wind run so far today N/A
<#domwindbearing> Today's dominant wind direction in degrees n/a
<#domwinddir> Today's dominant wind direction as compass point n/a
<#Tbeaudesc> Beaufort 'description' for today's high wind speed n/a
Miscellaneous
<#ET> Today's evapotranspiration. Applies only to Davis stations, equipped with a solar sensor.

"The ET value provided to Cumulus by the console and/or DLL is buggy and unreliable. It often shows a negative value. See this FAQ."

N/A
<#heatdegdays> Today's heating degree days n/a
<#cooldegdays> Today's cooling degree days n/a
<#solarTH> Today's high solar radiation value (Solar sensor needed) <#TsolarTH>
<#UVTH> Today's high UV Index (UV sensor needed) <#TUVTH>

Yesterday

webtag Function Time
Temperature & Humidity
<#tempYH> Yesterday's highest temperature <#TtempYH>
<#tempYL> Yesterday's lowest temperature <#TtempYL>
<#avgtempY> Yesterday's average temperature n/a
<#temprangeY> The temperature range (max - min) yesterday n/a
<#apptempYH> Yesterday's high apparent temperature <#TapptempYH>
<#apptempYL> Yesterday's low apparent temperature <#TapptempYL>
<#heatindexYH> Yesterday's high heat index <#TheatindexYH>
<#wchillYL> Yesterday's greatest wind chill (i.e. lowest temperature) <#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
<#rfallY> The total rainfall for yesterday according to the connected weather station n/a
<#RG11RainYest> The total rainfall for yesterday according to an RG-11 rain sensor configured in "Tipping Bucket" mode n/a
<#rrateYM> Yesterday's maximum rain rate <#TrrateYM>
<#hourlyrainYH> Yesterday's highest hourly rain <#ThourlyrainYH>
Pressure
<#pressYH> Yesterday's highest pressure reading <#TpressYH>
<#pressYL> Yesterday's lowest pressure reading <#TpressYL>
Wind
<#windYM> Yesterday's maximum (average) wind speed <#TwindYM>
<#wgustYM> Yesterday's maximum wind gust <#TwgustYM>
<#bearingYM> The wind bearing at the time of yesterday's high gust <#TwgustYM>
<#Ybeaufort> Yesterday's highest wind speed, expressed in the Beaufort scale <#TwindYM>
<#Ybeaufortnumber> Yesterday's high wind speed on the Beaufort scale, without a leading "F", e.g. "6" <#TwindYM>
<#Ybeaudesc> Beaufort 'description' for yesterday's high wind speed n/a
<#domwindbearingY> Yesterday's dominant wind direction in degrees n/a
<#domwinddirY> Yesterday's dominant wind direction as compass point n/a
<#windrunY> The total wind run for yesterday n/a
Miscellaneous
<#heatdegdaysY> Yesterday's heating degree days n/a
<#cooldegdaysY> Yesterday's cooling degree days n/a
<#solarYH> Yesterday's high solar radiation value (Solar sensor needed) <#TsolarYH>
<#UVYH> Yesterday's high UV Index (UV sensor needed) <#TUVYH>

Monthly

NB This table shows time for some daily figures (highest minimum/lowest maximum temperatures are actually associated with a particular time although this is not a standard web tag), by including Cumulus 1.9.y time modifiers, these are not valid in Cumulus MX.

webtag Function Time Date
Temperature & Humidity
<#MonthTempH> This months high temperature <#MonthTempHT> <#MonthTempHD>
<#MonthTempL> This months low temperature <#MonthTempLT> <#MonthTempLD>
<#MonthMinTempH> This months highest daily minimum temperature <#MonthMinTempHD format=hh:nn> <#MonthMinTempHD>
<#MonthMaxTempL> This months lowest daily maximum temperature <#MonthMaxTempLD format=hh:nn> <#MonthMaxTempLD>
<#MonthHighDailyTempRange> High Daily Temp Range n/a <#MonthHighDailyTempRangeD>
<#MonthLowDailyTempRange> Low Daily Temp Range n/a <#MonthLowDailyTempRangeD>
<#MonthHeatIndexH> This months high heat index <#MonthHeatIndexHT> <#MonthHeatIndexHD>
<#MonthWChillL> This months greatest wind chill (i.e. lowest temperature) <#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 <#MonthDewPointLT> <#MonthDewPointLD>
<#MonthHumH> This months highest humidty <#MonthHumHT> <#MonthHumHD>
<#MonthHumL> This months lowest humidty <#MonthHumLT> <#MonthHumLD>
Pressure
<#MonthPressH> This months highest pressure <#MonthPressHT> <#MonthPressHD>
<#MonthPressL> This months lowest pressure <#MonthPressLT> <#MonthPressLD>
Wind
<#MonthGustH> This months highest wind gust <#MonthGustHT> <#MonthGustHD>
<#MonthWindH> This months highest wind speed <#MonthWindHT> <#MonthWindHD>
<#MonthWindRunH> High Daily Wind Run n/a <#MonthWindRunHD>
Rainfall
<#rmonth> The total rainfall so far this month n/a n/a
<#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>
<#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

NB Year runs from roll-over time on 1 January

(Except for <#ryear> where start date can be another month)

webtag Function Time Date
Temperature & Humidity
<#YearTempH> This years highest temperature <#YearTempHT> <#YearTempHD>
<#YearTempL> This years lowest temperature <#YearTempLT> <#YearTempLD>
<#YearHighDailyTempRange> High Daily Temp Range n/a <#YearHighDailyTempRangeD>
<#YearLowDailyTempRange> Low Daily Temp Range n/a <#YearLowDailyTempRangeD>
<#YearHeatIndexH> This years highest heat index <#YearHeatIndexHT> <#YearHeatIndexHD>
<#YearWChillL> This years greatest wind chill (i.e. lowest temperature) <#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 maximum temperature n/a <#YearMaxTempLD>
<#YearHumH> This years high humidty <#YearHumHT> <#YearHumHD>
<#YearHumL> This years low humidty <#YearHumLT> <#YearHumLD>
Pressure
<#YearPressH> This years high pressure <#YearPressHT> <#YearPressHD>
<#YearPressL> This years low pressure <#YearPressLT> <#YearPressLD>
Wind
<#YearGustH> This years high wind gust <#YearGustHT> <#YearGustHD>
<#YearWindH> This years high wind speed <#YearWindHT> <#YearWindHD>
<#YearWindRunH> High Daily Wind Run n/a <#YearWindRunHD>
Rainfall
<#ryear> Annual rainfall total for rainfall season year (i.e. starting month as set on Configuration menu, station screen, Annual rainfall frame) n/a n/a
<#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>
<#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 Date/Time
Temperature & Humidity
<#tempH> All time high temperature <#TtempH>
<#tempL> All time low temperature <#TtempL>
<#mintempH> All time high minimum temperature <#TmintempH>
<#maxtempL> All time low maximum temperature <#TmaxtempL>
<#LowDailyTempRange> All time low daily temperature range <#TLowDailyTempRange>
<#HighDailyTempRange> All time high daily temperature range <#THighDailyTempRange>
<#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>
<#wchillH> All time greatest wind chill (i.e. lowest temperature) <#TwchillH>
Rainfall
<#rrateM> All time high rain rate <#TrrateM>
<#rfallH> All time high daily rain <#TrfallH>
<#rfallhH> All time high hourly rain <#TrfallhH>
<#rfallmH> All time high monthly rain <#TrfallmH>
<#LongestDryPeriod> All time longest dry period (days) <#TLongestDryPeriod>
<#LongestWetPeriod> All time longest wet period (days) <#TLongestWetPeriod>
Pressure
<#pressH> All time high pressure <#TpressH>
<#pressL> All time low pressure <#TpressL>
Wind
<#gustM> All time high wind gust <#TgustM>
<#wspeedH> All time high average wind speed <#TwspeedH>
<#windrunH> All time high daily wind run <#TwindrunH>

Recent History

There are a set of web tags for 'recent historical data', based on an array stored by Cumulus giving data values from 1 minute ago, up to 1 week ago, in 1 minute intervals. (Note that Cumulus uses current time read from the computer to determine which array element used. Hence when clocks go back the value stored for winter time overwrites the value previously stored for same time during summer time for the relevant repeating hour). As Cumulus runs it will add the latest values to the array with full resolution, and shift existing values along so those older than 7 days fall off. #No_Commas versions of the array are available for use in script.

You specify which value you want from the array by using parameters on the web tags for number of days ago, hours ago, and minutes ago. 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. (Again note that parameters specify time-stamped array element to retrieve based on counting back from current local time so the result for any period when clocks change may not be quite what you anticipated).

Although 'Apparent Temperature' is not included as a tag, it can be calculated in a script from recent 'outside temperature', 'wind speed', and 'relative humidity' values (using the same time selection for all).

When Cumulus is re-started the array it sets up will be based on reading the logs, so the contents 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 a time for which there is currently no exact match, and the first tag listed tells you that nearest time. Before build 1098, the recent history array did not initialise correctly from the station logger for the period since Cumulus was last run.

webtag Function
<#RecentTS> Takes parameters like the 'recent data' web tags (e.g. <#RecentOutsideTemp>) and gives the timestamp of the data that will be returned for those web tags with the supplied parameters (it may not have the data for the exact time specified). Format can be specified in the usual way with the 'format' parameter.
<#RecentOutsideTemp> Outside Temperature
<#RecentWindSpeed> Wind Speed
<#RecentWindGust> Wind Gust (reports maximum gust from build 1088 of version 1.9.4)
<#RecentWindLatest> Wind Latest. Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings
<#RecentWindDir> Wind Direction (instantaneous)
<#RecentWindAvgDir> Wind Direction (average)
<#RecentWindChill> Wind Chill
<#RecentDewPoint> Dew Point
<#RecentHeatIndex> Heat Index
<#RecentHumidity> Relative Humidity
<#RecentPressure> Sea-level Pressure
<#RecentRainToday> Daily rain total from last roll-over to specified time
<#RecentSolarRad> Solar Radiation
<#RecentUV> UV Index

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
<#ByMonthTempH> High Temperature <#ByMonthTempHT>
<#ByMonthTempL> Low Temperature <#ByMonthTempLT>
<#ByMonthHeatIndexH> High Heat Index <#ByMonthHeatIndexHT>
<#ByMonthWChillL> Greatest wind chill (i.e. lowest temperature) <#ByMonthWChillLT>
<#ByMonthAppTempH> High Apparent Temperature <#ByMonthAppTempHT>
<#ByMonthAppTempL> Low Apparent Temperature <#ByMonthAppTempLT>
<#ByMonthDewPointH> High Dew Point <#ByMonthDewPointHT>
<#ByMonthDewPointL> Low Dew Point <#ByMonthDewPointLT>
<#ByMonthMinTempH> Highest Daily Minimum Temperature <#ByMonthMinTempHT>
<#ByMonthMaxTempL> Lowest Daily Maximum Temperature <#ByMonthMaxTempLT>
<#ByMonthHighDailyTempRange> High Daily Temp Range <#ByMonthHighDailyTempRangeT>
<#ByMonthLowDailyTempRange> Low Daily Temp Range <#ByMonthLowDailyTempRangeT>
<#ByMonthHumH> High Humidity <#ByMonthHumHT>
<#ByMonthHumL> Low Humidity <#ByMonthHumLT>
Pressure
<#ByMonthPressH> High Pressure <#ByMonthPressHT>
<#ByMonthPressL> Low Pressure <#ByMonthPressLT>
Wind
<#ByMonthGustH> High Wind Gust <#ByMonthGustHT>
<#ByMonthWindH> High Wind Speed <#ByMonthWindHT>
<#ByMonthWindRunH> High Daily Wind Run <#ByMonthWindRunHT>
Rainfall
<#ByMonthRainRateH> High Rain Rate <#ByMonthRainRateHT>
<#ByMonthMonthlyRainH> High Monthly Rainfall <#ByMonthMonthlyRainHT>
<#ByMonthHourlyRainH> High Hourly Rain <#ByMonthHourlyRainHT>
<#ByMonthDailyRainH> High Daily Rain <#ByMonthDailyRainHT>
<#ByMonthLongestDryPeriod> Longest Dry Period <#ByMonthLongestDryPeriodT>
<#ByMonthLongestWetPeriod> Longest Wet Period <#ByMonthLongestWetPeriodT>

Miscellaneous

webtag Function
<#LatestError> Displays the last error from the Cumulus error log. The value is cleared when you click the error light in Cumulus.

Note: This tag displays all errors, even if they do not cause the error light to flash in Cumulus.

<#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
<#version> The version of Cumulus in use
<#build> The build of Cumulus in use
<#realtimeinterval> The realtime update interval in seconds
<#interval> The web site update interval in minutes
<#rollovertime> The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
<#update> The date and time of the last web site update
<#LastDataReadT> The date/time data was last read from the station
<#stationtype> The weather station model description (you choose what text appears for this on 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
<#latitude> The station latitude.

Supports an optional 'dp' parameter, if supplied, instead of the usual web-encoded text format with degrees/minutes/seconds, the result is in decimal degrees to the specified number of decimal places. E.g
<#latitude> gives "N&nbsp;59& deg;&nbsp;14&#39;&nbsp;33&quot;" for N 59 14 33
<#latitude dp=5> gives "59.24250"

If the "dp" parameter is supplied, then supplying "rc=y" in addition will cause any decimal comma to be converted to a decimal point.

<#longitude> The station longitude. Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
<#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, as set using Configuration menu, Display settings screen 'Detailed Chart Period'
<#dailygraphperiod> The number of days displayed by the graphs, as set using Configuration menu, Display settings screen 'Daily Chart Period' (available from build 1098)
<#snowdepth> Today's snow depth as entered manually in the Weather Diary. Normally in Centimeters.Output is purely as a numerical figure I.E 10

Configure in Cumulus.ini the hour when the snowdepth is updated e.g. SnowDepthHour=9 means yesterday's figure applies until 9am.

<#currcond> Represents the value entered on the screen within Cumulus for the Current Weather condition, or the value as held in the currentconditions.txt file. Any reserved HTML characters are encoded as HTML entities
<#currcondenc> The same as <#currcond> but also has characters above code 159 encoded as HTML entities
<#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

These are updated each hour to refer to current time-zone

webtag Function
<#sunrise> Last sunrise time at the station - This sunrise time is calculated by a third party library each midnight UTC, and each hour Cumulus converts it to local time to ensure shown correctly before and after any clock change.
<#sunset> Next sunset time at the station - The sunset/sunrise times are calculated each midnight UTC, and each hour Cumulus converts them to local time to ensure it shows them correctly before and after any clock change.
<#daylength> Length of day in hours and minutes (sunrise to sunset) - The third party library that Cumulus uses each midnight UTC, may take last sunrise from previous day and next sunset from next day, so the calculation may be off by a minute or so compared to true figure for current day.
<#IsSunUp> A flag to indicate if the Sun is above the horizon or not, based on the sunrise and sunset times.

Possible values are 0 or 1, where 1 is when the Sun is above the horizon for the station location.

<#dawn> Start of last Civil Twilight at the station as at last midnight UTC
<#dusk> End of next Civil Twilight at the station as at last midnight UTC
<#daylightlength> Length of daylight in hours and minutes (dawn to dusk)
<#isdaylight> A flag to indicate if the location for the station is in civil 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.

<#tomorrowdaylength> A string giving an approximate predicted difference between the length of daylight (dawn to dusk) yesterday and length of daylight tomorrow.

This web tag is unreliable, and its use is not recommended. Its use is therefore not supported (i.e. you use it at your own risk).

<#moonphase> Current phase of the moon in words, eg "New Moon" etc. The names used can be altered in strings.ini.
<#MoonAge> Current approximate age of the Moon in days (0-29)
<#moonrise> Current moonrise time at the station (if moon rises on current calendar day)
<#moonset> Current moonset time at the station (if moon sets on current calendar day)
<#MoonPercent> Current percentage of moon visible (negative value indicates 'waning')
<#MoonPercentAbs> Current percentage of moon visible (always positive)
<#SunshineHours> Hours of sunshine so far today (Solar sensor needed)
<#YSunshineHours> Total hours of sunshine yesterday (Solar sensor needed)
<#CurrentSolarMax> Current theoretical maximum solar radiation
<#IsSunny> Returns 1 if the sun is shining, otherwise 0 (Solar sensor needed)

Alarms

There are a set of tags for the Cumulus alarm states. They give a value of '1' if an alarm parameter has been selected (Main Cumulus screen, Edit menu) and the alarm condition is still currently met; otherwise '0'.

webtag Function
<#LowTempAlarm> Low temperature alarm
<#HighTempAlarm> High temperature alarm
<#TempChangeUpAlarm> Temperature increase alarm
<#TempChangeDownAlarm> Temperature decrease alarm
<#LowPressAlarm> Low pressure alarm
<#HighPressAlarm> High pressure alarm
<#PressChangeUpAlarm> Pressure increase alarm
<#PressChangeDownAlarm> Pressure decrease alarm
<#HighRainTodayAlarm> High rain today alarm
<#HighRainRateAlarm> High rainfall rate alarm
<#HighWindGustAlarm> High wind gust alarm
<#HighWindSpeedAlarm> High wind speed alarm
<#DataStopped> 1 if the station has apparently stopped sending data to Cumulus, otherwise 0

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

Please remember these are for Cumulus 1.9.x, Cumulus MX only supports the first two.

webtag Function
<#recordsbegandate> The date that Cumulus began tracking all time records (does not prevent earlier record dates being set manually)
<#newrecord> Indicates when any tracked extreme is changed.
  • In Cumulus 1.x.x: 1 if 'new record' light is flashing, 0 if not
  • In Cumulus MX: 1 for 24 hours from when new record set, 0 otherwise
<#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
<#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
<#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
<#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
<#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
<#HighWindrunRecordSet> 1 if the all-time high wind run light is currently flashing, 0 if not

Extra Sensors

These webtags hold current values for additional sensors supported by Cumulus. For past values, see the Extra_Sensor_Files page for information about log files.

webtag The related description can be changed in 'strings.ini'
<#ExtraTemp1> Extra temperature channel 1
<#ExtraTemp2> Extra temperature channel 2
<#ExtraTemp3> Extra temperature channel 3
... and so on up to <#ExtraTemp10> = Extra temperature channel 10
<#ExtraDP1> Extra dew point channel 1
<#ExtraDP2> Extra dew point channel 2
<#ExtraDP3> Extra dew point channel 3
... and so on up to <#ExtraDP10>
<#ExtraHum1> Extra humidity channel 1
<#ExtraHum2> Extra humidity channel 2
<#ExtraHum3> Extra humidity channel 3
... and so on up to <#ExtraHum10>
<#SoilTemp1> Soil temperature 1
<#SoilTemp2> Soil temperature 2
... and so on up to <#SoilTemp4>
<#SoilMoisture1> Soil moisture 1
<#SoilMoisture2> Soil moisture 2
... and so on up to <#SoilMoisture4>
<#LeafTemp1> Leaf temperature 1
<#LeafTemp2> Leaf temperature 2
<#LeafWetness1> Leaf wetness 1
<#LeafWetness2> Leaf wetness 2

Special tags

OS WMR Series

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

webtag Function
n/a Now incorporated into the Extra Sensors section above

Davis

Most of the following web tags are available in Cumulus MX from build 3019, Storm tags from 3021:

All (see note for THSWindex) of the following web tags for the Davis PWS are available in Cumulus 1.x.x; which updates the values of the reception tags every 15 minutes:

web tag Applicability Function
<#DavisTotalPacketsReceived> 1.x.x and MX Total number of data packets received
<#DavisTotalPacketsMissed> 1.x.x and MX Number of missed data packets
<#DavisMaxInARow> 1.x.x and MX Longest streak of consecutive packets received
<#DavisNumCRCerrors> 1.x.x and MX Number of packets received with CRC errors
<#DavisFirmwareVersion> 1.x.x and MX The console firmware version
<#DavisNumberOfResynchs> 1.x.x and MX Number of times the console resynchronised with the transmitter
<#THWindex> 1.9.x A derived temperature using Temperature/Humidity/Wind values read from Davis DLL in Cumulus 1.9.x.
  • The THW Index uses humidity and temperature (like Heat Index), but includes the cooling effects of wind (like wind chill).
  • Available from 1.9.2 Build 1009 (Aug 2011).
<#THSWindex> (1.9.x and) MX A heat stress indicator using Temperature/Humidity/Solar/Wind values.
  • The THSW Index uses humidity and temperature (like the Heat Index), but also includes the heating effects of sunshine, and the cooling effects of wind.
  • Therefore requires Davis station with solar sensor.

Approx calculation: Decrease heat index by 1 unit for each 1 mph increase in wind speed, and for each, either 3 Langley increase in solar radiation, or 10% increase in cloud cover.

IMPORTANT NOTES:

  1. Although this tag is available in Cumulus 1.9.x, there is an issue somewhere in the Davis code that prevents Cumulus 1 obtaining the value (so tag always displays zero).
  2. Search the forum for several discussions about "THSW".
  3. Cumulus MX reads "LOOP2" packets, and the correct value for this tag can be read there and displayed on 'Now' template.
<#battery> 1.x.x and MX The console battery condition in volts. eg "4.82v"
<#txbattery>

<#txbattery channel=1>

1.x.x and MX The transmitter battery condition, by default it returns the status of all transmitters.

Cumulus 1.x.x Only: The optional 'channel' parameter returns the status for a particular transmitter, up to channel=8. The channel result is just the string "ok" or "LOW" for a low battery

<#StormRain> 1.x.x and MX The console 'storm rain' current amount (build 1090 onwards for Cumulus 1; 3021 onwards for MX)
<#StormRainStart> 1.x.x and MX The console reported date of the start of the 'storm' (the console does not report start time, but it appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTipISO> in a script might help), but standard Cumulus date/time formatting can be applied to that date.

Fine Offset

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

webtag Function
<#Light> Current Lux value "Fine Offset only"
<#SensorContactLost> 1 if the station has lost contact with its remote sensors "Fine Offset only"

0 if contact has been established

System

Special tags returning information about the system hosting Cumulus:

These apply to Cumulus 1.x.x only; (see Cumulus MX forum)

webtag Function
<#OsVersion> OS version, e.g. "Windows 7 x64 build 7600"
<#OsLanguage> OS language, e.g. "English"
<#SystemUpTime> How long the system has been up, e.g. "8 hours 21 minutes"
<#ProgramUpTime> How long Cumulus has been running, e.g. "7 hours 55 minutes"
<#CpuName> CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
<#CpuCount> Number of processors, e.g. "4"
<#MemoryStatus> Free and total system RAM, e.g. "4619/8191 MB (free/total)"
<#DisplayMode> Screen display mode, e.g. "1680x1050, 32 bit"
<#AllocatedMemory> Amount of memory allocated to Cumulus, e.g. "18.76 MB"
<#DiskSize> Size of disk on which Cumulus is running, e.g. "931.51 GB"
<#DiskFree> Free space on disk on which Cumulus is running, e.g. "515.36 GB"

No Commas

There are a set of tags where the decimal comma has been replaced with a full stop, where necessary, for use with scripts (used for plotting 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> <#RCwlatest> <#RCdewpointTH>
<#RCdewpointTL> <#RCwchillTL> <#RCheatindexTH> <#RCapptempTH> <#RCapptempTL>
<#RCRecentOutsideTemp> <#RCRecentWindSpeed> <#RCRecentWindGust> <#RCRecentWindLatest>
<#RCRecentWindChill> <#RCRecentDewPoint> <#RCRecentHeatIndex> <#RCRecentPressure>
<#RCRecentRainToday> <#RCRecentUV>