YY
|
yy
|
Note that Cumulus 1 accepts lower or upper case, this represents a 2 digit year number
|
"NOAAYR"yy".txt"
|
NOAAYR10.txt
}
Web tags available in Cumulus
Those special markers in the file are called web tags, during processing Cumulus will replace them 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 web tag in the form:
<#tag_name [optional input parameters][optional output parameters]>
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! There are a number of editing tools that are designed for those programming code and you should use one of those (e.g. Notepad++), rather than a tool designed for web page design editing (eg. Dreamweaver).
Web tags are case sensitive, so please type the tag name exactly as shown in the web tag columns on this page. These web tag markers can return values for both readings from your weather station and the what can be derived from those readings. A small number of web tags require lower case input parameters to select which value is shown (e.g. value for one hour ago). Although some web tags will not accept output parameters, others allow you to vary the number of decimal places that are output, or to vary the way that times and dates are output. Some output parameters are case sensitive for Cumulus 1 (all are case sensitive for MX), so do check them carefully.
Optional Parameters
Input modification Parameters
Most web tags do not require any input parameters. However, those for individual minutes in last week and for the highest and lowest values for a particular month of any year do need input parameters specifying how many minutes ago or which month respectively. See the respective sections for full details.
Output modification parameters
These are complex and therefore discussed under the major heading in this later section. The options available include changing time format, changing number of decimal places, and removing decimal commas.
Cumulus Templates
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
- 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.
Web Tag Differences Between Cumulus 1 and MX builds
All the web tags listed in the tables are available in the final 1.9.4 release of Cumulus 1, and indeed in earlier 1.9.x releases. See tip at top of this page if you use an earlier release than that. When Cumulus 1 is processing web tags, it tends to ignore any it cannot understand, so look for gaps in your web pages to find errors.
Cumulus MX provides equivalent tags, although they are called tokens in some places, with only minor differences (highlighted in tables below for latest build) that vary between builds. See tip at top of page for how to check which web tags/tokens are available in your build. Please see page introducing Cumulus MX for more information regarding the tags missing from Steve Loft's original beta builds of MX. For Moon web tags, the key difference is adding parameters to control the output from build 3047. When MX is processing web tokens and finds one it cannot understand, a "*** web tag error - see MXdiags file ***" message will appear in the engine console, and the diagnostic file will include something like this:
Web tag error
Exception: i=8998 len=106297
inputText.Length=106297
token=<#daylightlength format=H>
This particular error is that when you use a single output format character it does not have same meaning as when there are multiple characters, correct this particular token to:
<#daylightlength format=%H>
Please note that where this article makes reference to other pages in the Wiki, the information shown there might be specific to Cumulus 1, as there are differences between the user interface for Cumulus 1 and MX flavours of this software, and the Wiki was originally written before MX existed, so not all pages have been updated.
Output Parameter Differences between Cumulus 1 and Cumulus MX (Cumulus 3)
Cumulus 1 allows use of dp=n modifier (where n represents desired number of decimal places for latitude and longitude e.g. <#latitude dp=5> gives "59.24250". This is also available in MX.
MX makes much more usage of these dp parameters. For example in the moon tags <#MoonAge> gives "11" but <#MoonAge dp=3> gives "11.234"
- Cumulus MX (when running on Windows) 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. If Cumulus MX is running on Linux or Mac OS X, then it uses Mono for date and time formatting, but the same case sensitive rules apply as for .NET.
- For example,
in Delphi, "nn" means "minutes" for Cumulus 1, but "minutes" is "mm" for .Net in Cumulus MX.
- e.g. the hour in 24-hour format, is "HH" (although in Delphi (Cumulus 1)'hh' would be treated same) but in .NET it must be "HH" (Cumulus MX).
You might be put off by references within .NET (Cumulus MX) to single/standard characters and custom modifiers, the following 3 examples may add clarity:
- 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).
- 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).
- 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).
Using HTML tags within format parameters (MX only)
Example using a class to change the look of part of the output
<#TapptempH format="dd' 'MMM' 'yyyy'<span class=\'xx\'> at 'HH:mm'</span>'">
the output from this will look like 04 Dec 2018 at 10:12
Note where the quotes are, and where you need to use '\' escape characters.
Example using HTML tags
<#RecentTS d=2 format="h:mm' 'tt'<small>on' d/M/yyyy'</small>'">
This puts the date in a smaller font than the time
Beta Builds of Cumulus
There is a page that details the additional webtags available in any Cumulus Beta version that is currently under development. The same page is being used to show new web tag features as MX is being developed.
Output 'format' Parameter
Output (format modifier) parameters for decimal places
- dp=i is used for both Cumulus 1 and MX. The value i following the attribute dp is an integer, how many decimal places you want for the output you see. Only available for a limited range of web tags (including in MX <#MoonPercent> and <#MoonPercentAbs>).
- tc=y is a new parameter for MX, the attribute tc takes the value 'y' to remove decimal places by truncation instead of using dp=0 which would round to nearest integer. e.g. <#MoonAge tc=y>. At present not available in any other web tags.
Output (format modifier) indicating remove commas
"rc=y" is a new parameter for MX, the attribute rc takes the value 'y' to replace any commas defined by the locale with full stops to separate integer and decimal parts of the output value. It is only implemented on a few new web tags (#MoonPercent, #MoonPercentAbs, #MoonAge) for MX versions up to and including 3.5.3. At the time of writing it is planned that all web tags that can output real numbers will implement an alternative syntax of <#tag_name rc=y> from the next version.
Output (format modifier) parameters for times and dates
Time/Date format codes are used in two places:
- As part of report names for NOAA style reports (see Cumulus.ini#Section:_NOAA)
- 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:
- 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">.
- 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).
Note for MX - you can use single quotation marks round spaces and text, but you can also use '\' as escape character e.g. for 'on' use \o\n. However for 'at' the only alternative is \a't' because the character t has another meaning and escape followed by a t becomes a tab!
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 curved brackets) could be used instead (exceptions: a/p, ampm, am/pm, Am/Pm, AM/PM, A/P, AMPM etc display as input).
Remember that most single character format specifiers have a different meaning to when the same letter appears in a multi-character format.
In some rows of this table, square brackets [] indicate optional items, they are included just to make it clearer how items can be combined in a single output parameter.
Delphi Specifier for Cumulus 1.9.x
|
Mono Specifier for Cumulus MX
|
Displays
|
Example
|
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.
|
'22/03/2019 09:47:25' produced by <#time format=c> <#time format=G>
|
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').
|
27 produced by <#metdate format="d"> <#metdate format="%d">
|
dd
|
dd
|
Displays the day as a number with a leading zero (01-31).
|
07 produced by <#metdate format="dd">
|
ddd
|
ddd
|
Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Locale.
|
'Wed' produced by <#metdate format="ddd"> (English locale)
|
dddd
|
dddd
|
Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Locale.
|
'Friday' produced by <#metdate format="dddd"> (English locale)
|
ddddd
|
d (as single character format)
|
Displays the date using the format given by the Short Date format.
|
e.g. '22/03/2019' (British Locale)
|
dddddd
|
D
|
Displays the date using the format given by the Long Date format.
|
e.g. '22 March 2020' (British Locale)
|
M (or m)
|
%M
|
Displays the month as a number without a leading zero (1-12).
Cumulus 1.x.y:If the 'M' or 'm' specifier immediately follows an h, hh, HH, or H 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).
|
2
|
MM (or mm)
|
MM
|
Displays the month as a number with a leading zero (01-12).
Cumulus 1.x.y:If the 'm' or 'M' specifier immediately follows an h, H, HH, or hh specifier, the minute rather than the month is displayed.
|
'03' produced by <#LastDataReadT format=MM>
|
MMM (or mmm)
|
MMM
|
Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Locale.produced by <#metdate format="MM">
|
'May' produced by <#metdate format="MMM">
|
MMMM (or mmmm)
|
MMMM
|
Displays the month as a full name (January-December) using the strings appropriate to the Locale.
|
'May' produced by <#metdate format="MMMM">
|
yy
|
yy
|
Displays the year as a two-digit number (00-99).
|
19 produced by <#LastDataReadT format=yy>
|
yyyy
|
yyyy
|
Displays the year as a four-digit number (0000-9999).
|
2019 produced by <#LastDataReadT format=yyyy>
|
h [AM/PM]
|
h [tt]
|
Displays the hour (12 hour clock) without a leading zero (1-12) [optionally in combination with AM/PM]. What "tt" produces depends on locale settings for your device, it might be capitals or it might be lower case (in Windows use Control Panel, not Settings app, to get to these regional additional settings).
For Cumulus 1 the formats for am/pm depend on the case in which you type the parameter as shown later in this table
|
h:mm (or h:nn) [AM/PM]
|
h:mm [tt]
|
Displays the hour (12 hour clock) without a leading zero (1-12) followed by 2 digit minutes [optionally in combination with AM/PM whose case varies as explained in previous entry].
For Cumulus 1, the minutes can be represented by 'mm' only when appearing in combination with 'h'
|
'10:27 am' produced by <#LastDataReadT format="h:nn am/pm"> <#LastDataReadT format="h:mm tt">
|
H
|
%H
|
Displays the hour using 24 hour clock without a leading zero (0-23). Note that % is only needed when H is on its own.
|
7 produced by <#daylength format=h>
<#daylength format=%H>
|
H:mm (or H:nn)
|
H:mm
|
Displays the hour using 24 hour clock without a leading zero (0-23) followed by 2 digit minutes. Note that % is not needed when H is not on its own.
|
'7:27' produced by <#LastDataReadT format="H:mm">
|
HH (or hh)
|
HH
|
Displays the hour using 24 hour clock with a leading zero (00-23).
|
'06' or 19 produced by <#LastDataReadT format=HH>
|
hh (am/pm)
|
hh [tt]
|
Displays the hour (12 hour clock) with a leading zero (01-12) [optionally in combination with am/pm].
For Cumulus 1 the case output for the optional 'am/pm' depends on the case used for that parameter as shown later in this table
For MX, the optional 'tt' displays the contents of the device locale setting for AM string for midnight until any hour before noon, and the contents of the PM string for noon or any hour after noon before midnight
|
'07 am' produced by <#LastDataReadT format="hh am/pm"> <#LastDataReadT format="hh tt">
|
hh:mm (or hh:nn) [am/pm]
|
hh:mm [tt]
|
Displays the hour (12 hour clock) with a leading zero (01-12) followed by 2 digit minutes [optionally in combination with am/pm].
For Cumulus 1, the minutes can be represented by 'mm' only when in combination with 'h', in other contexts 'mm' is interpreted as month number, and the case output for am/pm depends on the case used for that parameter as shown later in this table
For MX, the optional 'tt' displays the contents of the device locale setting for AM string for midnight until any hour before noon, and the contents of the PM string for noon or any hour after noon before midnight
|
'8:27 am' produced by <#LastDataReadT format="h:nn am/pm"> <#LastDataReadT format="h:mm tt">
|
n
|
m
|
Displays the minute without a leading zero (0-59).
|
7 produced by <#daylength format=n> <#daylength format=m>
|
nn
|
mm
|
Displays the minute with a leading zero (00-59).
|
'07' produced by <#daylength format=nn> <#daylength format=mm>
|
s
|
s
|
Displays the second without a leading zero (0-59).
|
ss
|
ss
|
Displays the second with a leading zero (00-59).
|
'06' or 19 produced by <#LastDataReadT format=ss>
|
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. Remember that 't' combined with other specifiers (or preceded by space or '%') has a different meaning - see below.
|
'09:47' produced by <#LastDataReadT format=t> (might not use colon in your locale) for both flavours of Cumulus
|
TT
|
T
|
Displays the time using the Long Time format.
|
'09:47:56' (might not use colon in your locale) produced by <#LastDataReadT format=TT> <#LastDataReadT format=T>
|
am/pm or Am/Pm or AM/PM
|
tt
|
Uses the 12-hour clock for the preceding h or H specifier, and displays 'am' for any hour from midnight until just before noon, and 'pm' for any hour from noon onwards. The am/pm specifier for Cumulus 1 can use lower, upper, or mixed case, and the result is displayed accordingly.
For MX, 'tt' displays the contents of the device locale setting for AM string for midnight until any hour before noon, and the contents of the PM string for noon or any hour after noon before midnight
|
{Version badge 1}} 'am' produced by <#LastDataReadT format=am/pm>, 'AM' produced by <#LastDataReadT format=AM/PM>
|
a/p
|
t
|
Uses the 12-hour clock for the preceding h or H specifier, and displays 'a' for any hour from midnight until before noon, and 'p' for noon or any hour after noon.
{{Version badge 1} The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
Remember that 't' has to be combined with other specifiers (or preceded by space or '%') to display 'a' or 'p' as if it is alone it has a different (short format time) meaning - see above.
|
see previous example
|
ampm
|
(see above for 12 hour formats)
|
This displays the contents of the device locale setting for AM string for midnight until any hour before noon, and the contents of the PM string for noon or any hour after noon before midnight.
{{Version badge 1}Uses the 12-hour clock for the preceding h or H specifier
|
see previous examples
|
/
|
/
|
Displays the date separator character given by the Date Separator. It might not display a slash.
|
'/' for British locale
|
:
|
:
|
Displays the time separator character given by the Time Separator. It might not display a colon.
|
':' for British locale
|
'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.
|
Hypens are added in this PHP language example '<#LastDataReadT format=yyyy>'.'-'.'<#LastDataReadT format=MM>'.'-'.'<#LastDataReadT format="dd">'
|
The Web Tags for Cumulus
These are available in both Cumulus 1 and MX unless indicated by a version 1 or MX badge.
System
Special tags returning information about the Windows device hosting Cumulus. If you are running MX on Linux or Mac OS X, then a few of these tags may not work.
Web tag_name
|
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"
|
Miscellaneous
Web tag_name
|
Function
|
<#LatestError>
|
Displays the last error from the Cumulus 1 error log. (The value is cleared when you click the error light in Cumulus 1).
Note: This tag displays all errors, even if they do not cause the error light to flash in Cumulus 1. Although this tag and the next 3 are in MX, none of them are actually used (as at April 2020).
|
<#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 e.g. '1.9.4' or '3.4.1'
|
<#build>
|
The build of Cumulus in use e.g. '10992' for latest Cumulus 1 patch (Cumulus MX is under development so new builds are released frequently)
|
<#realtimeinterval>
|
The realtime update interval in seconds (integer)
|
<#interval>
|
The web site update interval in minutes (integer)
|
<#rollovertime>
|
The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
This is the end of the meteorological day, so if during Daylight Saving Time it is "10 am", then on the day DST ends it will return to "9 am" ensuring every meteorological day is exactly 24 hours long. If the time is "Midnight" or during DST it is "9 am", then days will be 23 or 25 hours long just on day clocks change, 24 hours otherwise.
|
<#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 (as you entered during setup).
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 59& deg; 14' 33"" 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 (as you entered during setup). Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
|
<#altitude>
|
The station altitude value (webtag outputs web encoded format containing figure, ' ' and units) in either feet or metres just as you entered during setup (so it is more complex to extract number for script arithmetric); e.g. '123 m'
|
<#location>
|
The station location (as you entered during setup)
|
<#longlocation>
|
Longer description of the station location (as you entered during setup)
|
<#forum>
|
URL of the forum (as you entered during setup)
|
<#webcam>
|
URL of the webcam (as you entered during setup)
|
<#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)
|
<#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 all characters above (decimal base)code 159 encoded as HTML entities
|
<#chillhours>
|
The number of 'chill hours' so far this season (threshold temperature and start date are configurable).
|
<#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, meteorologists exclude dew (and other times when single tip of recorder).
|
<#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
|
Units
Apply to Cumulus 1 and MX, no optional input nor output parameters.
Web tag_name
|
Function
|
<#tempunit>
|
Unit of temperature being used (Set in Cumulus as Celsius or Fahrenheit) values "°C" or "°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
Both Cumulus 1 and MX support all of these, most of these web tags can be used with output parameters.
Web tag_name
|
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 next tag (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
|
<#recordsbegandate>
|
Date when records began (appears twice on "recordsT.htm" provided, and used to calculate next tag, but ignored for all other Cumulus processing)
|
<#DaysSinceRecordsBegan>
|
Day count since Cumulus records started
|
Current Conditions
These appear on "Now" page (index.htm).
Rainfall this month and this year are included here for consistency with supplied web templates (indexT.htm, thismonthT.htm, and thisyearT.htm) and with the dashboard 'Now' part of the Cumulus MX user interface.
Web tag_name
|
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
|
<#feelslike>
|
Available only from version 3.5.4: A variant on wind chill, calculated using the JAG/TI formula used in the UK, USA, Canada etc. The official formula of JAG/TI-2000 is:
G(J) = 13,12+0,6215∗T−11,37∗(W∗3,6)0,16+0,3965∗T∗(W∗3,6)0,16(2.3) where air temperature, T, is in °C, is measured at 1.50 metres, and wind speed, W, is in m/s as measured at 10 metres.
MX uses a slightly different formula, it is dependent on temperature, and can be expressed in PHP as:
if($temp_degC < 10)
{
$feels_like = $wind_chill;
}elseif($temp_degC > 20)
{
$feels_like = $apparent_temp;
}else{
$app_temp_mult = ($temp_degC - 10) / 10;
$wind_chill_mult = 1 - $app_temp_mult;
$feels_like = ($apparent_temp * $app_temp_mult) + ($wind_chill * $wind_chill_mult);
}
|
<#wetbulb>
|
Estimated wet bulb temperature, can be seen if hover over 'Dewpoint' on Cumulus 1 main screen
|
<#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) PLEASE NOTE: this web tag does NOT accept any format modifiers
|
<#LastRainTip>
|
(available from release 3.6.1) Date/time of last rain gauge tip (as previous tag) PLEASE NOTE: this web tag WILL accept any date and time output format modifiers
|
<#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
|
<#rmonth>
|
The total rainfall so far this month
|
<#ryear>
|
Annual rainfall total for rainfall season year (i.e. starting month as set on Configuration menu, station screen, Annual rainfall frame)
|
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
|
These web tags hold current values for additional sensors supported by Cumulus. Some tags are only available for certain builds, see general tip at top of page to check for the build you are using.
There are no web tags for past values from extra sensors, see the Extra_Sensor_Files page for information about log files from where you can extract those values.
Web tag_name
|
The related description can be changed in 'strings.ini', but below are default descriptions that will be shown on Cumulus screens
|
<#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 <#SoilTemp16>
|
<#SoilMoisture1>
|
Soil moisture 1
|
<#SoilMoisture2>
|
Soil moisture 2
|
... and so on up to <#SoilMoisture16>
|
<#LeafTemp1>
|
Leaf temperature 1
|
<#LeafTemp2>
|
Leaf temperature 2
|
<#LeafWetness1>
|
Leaf wetness 1
|
<#LeafWetness2>
|
Leaf wetness 2
|
<#AirQuality1>
|
Air quality (currently only GW1000 stations with MX)
|
... and so on up to <#AirQuality4>
|
<#LeakSensor1>
|
Leak sensor - 0 or 1 (currently only GW1000 stations with MX)
|
... and so on up to <#LeakSensor4>
|
<#LightningDistance>
|
Distance to last strike (same units as wind run - miles/km/nm)
(currently only GW1000 stations with MX)
|
<#LightningTime>
|
Time of last strike (format customisable)
(currently only GW1000 stations with MX)
|
<#LightningStrikesToday>
|
Number of strikes since midnight
(currently only GW1000 stations with MX)
|
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. 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.
(Note that Cumulus uses current time read from the computer to determine which array element it stores each value in. 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. Hence even if you use 10am for your rollover time in summer, you will not have access to a whole hour worth of data when the clocks change as either the hour has been overwritten or when the clocks go forward it simply does not exist).
Input Parameters
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. The same d, h, and m, parameters are used by Cumulus 1 and MX.
All values supplied for parameters must be whole numbers.
If you don't supply any parameters, the result is undefined for Cumulus 1, and an illegal web tag for MX.
<#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>).
<#RecentOutsideTemp d=1> will give the temperature one day ago. Please note: Some Cumulus users say that using <#RecentOutsideTemp d=1 m=1> is more reliable at getting the temperature at a similar time the day before, the extra minute apparently gives better results when you might not be using Cumulus all the time, or your weather station might have some drift on when it supplies readings. See which works best for you.
<#RecentOutsideTemp d=1 h=1 m=1> will give the temperature one day, one hour and one minute ago.
Please note that parameters specify time-stamped array element to retrieve based on counting back from current local time so the result for any period including when clocks change may not be quite what you anticipated.
Other weather derivatives
Although 'Apparent Temperature', 'Feels Like temperature' are not included as tags here, they can be calculated in a script from recent 'outside temperature', 'wind speed', and 'relative humidity' values (using the same time selection for all). There are other derivatives that can be calculated similarly from a set of simultaneous values.
This PHP function calculates wind chill, apparent temperature, and feels like temperature. Note you might need to convert the units for the temperature and wind speed for the function from those reported by those recent history tags.
function Calculate_FeelsLike ($temp_degC, $wind_mph, $humidity)
{
$wind_kph = $wind_mph * 1.609344;
if($wind_kph <4.828)
{
$wind_chill = $temp_degC;
}else{
$wind_chill = 13.12 +0.6125 * $temp_degC - 11.37 * pow($wind_kph, 0.16) + 0.3965 * $temp_degC * pow($wind_kph, 0.16);
}
$vapour_pressure = (($humidity / 100) * 6.105) * exp(17.27 * $temp_degC / (237.7 + $temp_degC)) / 10;
$apparent_temp = -2.7 + (1.04 * $temp_degC) + (2 * $vapour_pressure) - ($wind_kph * 01.1805553);
if($temp_degC < 10)
{
$feels_like = $wind_chill;
}elseif($temp_degC > 20)
{
$feels_like = $apparent_temp;
}else{
$app_temp_mult = ($temp_degC - 10) / 10;
$wind_chill_mult = 1 - $app_temp_mult;
$feels_like = ($apparent_temp * $app_temp_mult) + ($wind_chill * $wind_chill_mult);
}
$return_array[0] = $apparent_temp;
$return_array[1] = $feels_like;
$return_array[2] = $wind_chill;
return $return_array;
}
During catch-up
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.
Variations between Builds/Versions
Before build 1098, the recent history array did not initialise correctly from the station logger for the period since Cumulus was last run.
The input parameters are same for Cumulus 1 and Cumulus MX, they always use lower case d, h or m.
The list of tags available has not changed between last Cumulus 1 release and any MX release. Any new derivatives reported elsewhere have not resulted in equivalent new recent history tags.
Table of tags available
Web tag_name
|
Function
|
Parameters example
|
<#RecentTS>
|
Gives the timestamp of the data that will be returned for any other recent history tag that uses same d, h, and m parameters
|
<#RecentTS h=3 m=1 format="HH:nn"> for cumulus 1; <#RecentTS h=3 m=1 format="HH:mm"> for cumulus MX
|
<#RecentOutsideTemp>
|
Outside Temperature
|
<#RecentOutsideTemp h=3 m=1> <#tempunit> will display the temperature at the start of the period for which <#temptrend> is calculated
|
<#RecentWindSpeed>
|
Wind Speed
|
<#RecentWindSpeed m=10> will display the wind speed 10 minutes ago
|
<#RecentWindGust>
|
Wind Gust
(reports maximum gust from build 1088 of version 1.9.4)
|
<#RecentWindGust d=1 m=1> will report the wind gust at approximately the same time yesterday
|
<#RecentWindLatest>
|
Wind Latest. Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings
|
d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|
<#RecentWindDir>
|
Wind Direction (instantaneous)
|
<#RecentWindDir m=10> will tell you which direction the wind was blowing from 10 minutes ago
|
<#RecentWindAvgDir>
|
Wind Direction (average)
|
<#RecentWindAvgDir d=6> will say what the calculated average wind direction was at this time at the start of the week
|
<#RecentWindChill>
|
Wind Chill
|
<#RecentWindChill d=48 m=1> reports the wind chill temperature 2 days ago
|
<#RecentDewPoint>
|
Dew Point
|
<#RecentDewPoint h=25> reports the dew point temperature just over a day ago
|
<#RecentHeatIndex>
|
Heat Index
|
<#RecentHeatIndex m=121> reports the heat index about 2 hours ago
|
<#RecentHumidity>
|
Relative Humidity
|
d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|
<#RecentPressure>
|
Sea-level Pressure
|
<#RecentPressure h=3 m=1> gives the sea level pressure when <#presstrendval> started tracking the pressure
|
<#RecentRainToday>
|
Daily rain total from last roll-over to specified time
|
d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|
<#RecentSolarRad>
|
Solar Radiation
|
d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|
<#RecentUV>
|
UV Index
|
d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|
Today
For web tags that report values that refer to a particular time of day, there is a corresponding web tag that can give the time of day, shown in same row of table below.
Please note none of the time web tags can be modified by output parameters to give a date, but they can be changed from the default time format that is 'h:mm' for Cumulus 1 and MX. If you are using output modifiers to change how the time is reported, be careful to use ones that work for the flavour of Cumulus you are using (H and h are same for Cumulus 1, but not for MX; nn and mm are same for Cumulus 1, but not for MX).
Web tag_name
|
Function
|
Time tag_name
|
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>
|
Precipitation
|
<#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
|
n/a
|
<#snowfalling>
|
Returns 1 if there is an entry in the Weather Diary for Today and the Snow Falling check box is ticked. Returns 0 otherwise.
Not available in Cumulus 1.
Available from version 3.1.1 - build 3054.
|
<#snowdepth>
|
If there is an entry in the Weather Diary for Today, returns the value set there. Returns 0 otherwise.
Available from very early builds, weather diary input amended from version 1.8.6 14th April 2009 to allow units to be specified. Input and output is as integer, enter in millimetres to represent 1 decimal place in centimetres. Meteorologists report this in cm.
Available from version 3.1.1 - build 3054 when weather diary editor was added to MX
|
<#snowlying>
|
Returns 1 if there is an entry in the Weather Diary for Today and the Snow Lying check box is ticked. Returns 0 otherwise.
Although this tag is not available in Cumulus 1, you can check if <#snowdepth> is non zero for same answer
Available from version 3.1.1 - build 3054
|
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
Note that the Y indicating yesterday is sometimes a prefix, sometimes a suffix (with H for High, L for Low), web tags are not named consistently!
Many of these web tags are used on the supplied yesterdayT.htm template, and the supplied todayyest.html page within the MX user interface.
For web tags that refer to a particular time of day, there is a corresponding web tag that can give the time of day. Please note none of the time web tags can be modified by output parameters to give a date, but they can be changed from the default time format that is 'h:mm'.
Web tag_name
|
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
This table shows the web tags used on the "thismonthT.htm" web page, the rainfall this month does not appear on that page, does not appear on that page, it is shown in indexT.htm table earlier on this page.
The web tags in the date column output dates in the format "dd MMMM" (same for Cumulus 1 and Cumulus MX), this can be changed using the format parameters described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters.
NB This table shows time of extremes for two daily figures (highest minimum/lowest maximum temperatures as of course these are actually associated with a particular time although a standard web tag was not provided for that), by including Cumulus time modifiers, and how minutes in time modifiers can be specified in two ways in Cumulus 1 but only in one way in Cumulus MX.
Yearly
This table shows the web tags used on the "thisyearT.htm" web page, the rainfall this season (it need not start on 1 January) does not appear on that page, it is shown on indexT.htm.
The default format for web tags in the date column is (like the monthly web tags) "dd MMMM" (same for Cumulus 1 and Cumulus MX), this can be changed using the format parameters described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters.
NB Year runs from roll-over time on 1 January for all web tags listed here
Web tag_name
|
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
|
<#YearMinTempHD format=HH:nn> for Cumulus 1, <#YearMinTempHD format=HH:mm> for Cumulus MX
|
<#YearMinTempHD>
|
<#YearMaxTempL>
|
This years lowest daily maximum temperature
|
<#YearMaxTempHD format=HH:nn> for Cumulus 1, <#YearMaxTempHD format=HH:mm> for Cumulus MX
|
<#YearMaxTempLD>
|
<#YearHumH>
|
This years high humidity
|
<#YearHumHT>
|
<#YearHumHD>
|
<#YearHumL>
|
This years low humidity
|
<#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
|
<#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
The web tags in the date/time column have the default format seen on "records.htm". So for an extreme month it just shows the month name in full i.e. format 'MMMM'. For an extreme day it shows the day of the month and the month name in full i.e. format "dd MMMM" (same for Cumulus 1 and Cumulus MX), prefixed with the word 'on'. For the highest/lowest within a day in the year it shows both time and date adding the word "at" before the time, and the word 'on' before the date.
You can change the default output using the [[#Time.2FDate_.27format.27_Parameter|formats features described above, but this can involve complicated use of single and double quotes and there are differences between Cumulus 1 and Cumulus MX.
Note that unlike the monthly web tags, the time is included in the default format of the standard web tags for the 'highest minimum' and 'lowest maximum'.
Web tag_name
|
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>
|
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 input 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. The corresponding date/time web tags are formatted like the all time records directly above this section.
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. To supply both input and output parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>
Web tag_name
|
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>
|
Day/Night/Sun/Moon
These are updated each hour to refer to current time-zone
Web tag_name
|
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.53)
MX b3047 adds the 'dp' and 'rc' parameters Supports an optional 'dp' parameter, if supplied the result is returned to the specified number of decimal places. E.g <#MoonAge> gives "11" <#MoonAge dp=3> gives "11.234"
If the "dp" parameter is supplied, then also supplying "rc=y" in addition will cause any decimal comma to be converted to a decimal point.
|
<#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')
MX b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|
<#MoonPercentAbs>
|
Current percentage of moon visible (always positive)
MX b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|
<#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 available in Cumulus 1 for various alarm states. In Cumulus 1, the main page will change the colour of the relevant element when an alarm condition is entered or left. You can add sounds, and enable disable each alarm parameter on the Main Cumulus screen, Edit menu.
Alarms are also available in later MX versions. In MX, the alarm conditions are shown on the bottom of the Dashboard page of the user interface. You can add sounds, and enable/disable each alarm parameter on the Alarms screen within Settings menu.
For both flavours, there are web tags for each alarm condition, they give a value of '1' if the alarm condition is enabled and is still currently met; otherwise '0'.
Web tag_name
|
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
|
Extreme 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'. For daily records (e.g. temperature range), the record cannot be set until the end of the day when rollover starts. The tag is cleared in Cumulus 1 once the record has been viewed (via main screen or web tag).
Please remember these are for Cumulus 1.9.x, Cumulus MX works in a different way both in terms of how tags are set (see various topics in support forum) and how they are cleared (essentially the end of rollover clears records, so daily records are only shown for the few microseconds while rollover is being processed).
Web tag_name
|
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 from when new record is set until next rollover is completed, 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
|
Special tags
OS WMR Series
There are a set of tags for the WMR928, WR100/200 extra sensors:
Web tag_name
|
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_name
|
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:
- 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).
- Search the forum for several discussions about "THSW".
- 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
Web tag_name
|
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
|
Ecowitt GW1000
There are a set of tags for the Ecowitt WiFi gateway GW1000:
Web tag_name
|
Function
|
<#GW1000FirmwareVersion>
|
GW1000 firmware version string
|
No Commas
There are a set of tags for use in those locales that use the comma to separate the integer and decimal parts. In these tags available since version 1.9.3 build 1045, 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.
NOW:
<#RCtemp>, <#RCdew>, <#RCheatindex>, <#RChum>, <#RCinhum>, <#RCintemp>, <#RCpress>, <#RCrfall>, <#RCrrate>, <#RCwchill>, <#RCwgust>, <#RCwspeed>, <#RCwlatest>
TODAY
<#RCpressTH>, <#RCpressTL>, <#RCrrateTM>, <#RCtempTH>, <#RCtempTL>, <#RCwgustTM>, <#RCdewpointTH>, <#RCdewpointTL>, <#RCwchillTL>, <#RCheatindexTH>, <#RCapptempTH>, <#RCapptempTL>
RECENT
<#RCRecentOutsideTemp>, <#RCRecentWindSpeed>, <#RCRecentWindGust>, <#RCRecentWindLatest>, <#RCRecentWindChill>, <#RCRecentDewPoint>, <#RCRecentHeatIndex>, <#RCRecentPressure>, <#RCRecentRainToday>, <#RCRecentUV>
Although 'Apparent Temperature' is not included as a tag, it can be calculated in a script from the RC tags for 'outside temperature', 'wind speed', and 'relative humidity' values. In php language this is $RCapptempCALC = round(<#temp> + (0.33 * (<#hum> / 100 * 6.105 * exp (17.27 * <#temp> / (237.7 + <#temp>) ))) - (0.7 * $wspeed) - 4.0, 2);.
There are other derivatives that can be calculated similarly from a set of simultaneous values.
From version 3.5.4, all web tags that produce decimal number output now support the "rc=y" option. e.g. <#tempYH rc=y> will report yesterday's highest temperature using a full stop to separate decimal part where the locale would normally use a comma.
Example of List Web Tags output for MX
This is from an earlier version than the latest, it appears here simply to show how the web tag option can list tags (although these are separated by comma rather than the new line separator Cumulus uses).
AirQuality1, AirQuality2, AirQuality3, AirQuality4, AirQualityAvg1, AirQualityAvg2, AirQualityAvg3, AirQualityAvg4, AllocatedMemory, altimeterpressure, altitude, apptemp, apptempH, apptempL, apptempTH, apptempTL, apptempYH, apptempYL, avgbearing, avgtemp, avgtempY, battery, bearing, BearingRangeFrom, BearingRangeFrom10, BearingRangeTo, BearingRangeTo10, bearingTM, bearingYM, beaudesc, beaufort, beaufortnumber, build, ByMonthAppTempH, ByMonthAppTempHT, ByMonthAppTempL, ByMonthAppTempLT, ByMonthDailyRainH, ByMonthDailyRainHT, ByMonthDewPointH, ByMonthDewPointHT, ByMonthDewPointL, ByMonthDewPointLT, ByMonthGustH, ByMonthGustHT, ByMonthHeatIndexH, ByMonthHeatIndexHT, ByMonthHighDailyTempRange, ByMonthHighDailyTempRangeT, ByMonthHourlyRainH, ByMonthHourlyRainHT, ByMonthHumH, ByMonthHumHT, ByMonthHumL, ByMonthHumLT, ByMonthLongestDryPeriod, ByMonthLongestDryPeriodT, ByMonthLongestWetPeriod, ByMonthLongestWetPeriodT, ByMonthLowDailyTempRange, ByMonthLowDailyTempRangeT, ByMonthMaxTempL, ByMonthMaxTempLT, ByMonthMinTempH, ByMonthMinTempHT, ByMonthMonthlyRainH, ByMonthMonthlyRainHT, ByMonthPressH, ByMonthPressHT, ByMonthPressL, ByMonthPressLT, ByMonthRainRateH, ByMonthRainRateHT, ByMonthTempH, ByMonthTempHT, ByMonthTempL, ByMonthTempLT, ByMonthWChillL, ByMonthWChillLT, ByMonthWindH, ByMonthWindHT, ByMonthWindRunH, ByMonthWindRunHT, chillhours, cloudbase, cloudbaseunit, cloudbasevalue, ConsecutiveDryDays, ConsecutiveRainDays, cooldegdays, cooldegdaysY, CpuCount, CpuName, cumulusforecast, cumulusforecastenc, currcond, currcondenc, CurrentSolarMax, currentwdir, dailygraphperiod, DataStopped, date, DavisFirmwareVersion, DavisMaxInARow, DavisNumberOfResynchs, DavisNumCRCerrors, DavisTotalPacketsMissed, DavisTotalPacketsReceived, dawn, day, daylength, daylightlength, dayname, DaysSince30Dec1899, DaysSinceRecordsBegan, dew, dewpointH, dewpointL, dewpointTH, dewpointTL, dewpointYH, dewpointYL, DiskFree, DiskSize, DisplayMode, domwindbearing, domwindbearingY, domwinddir, domwinddirY, dusk, ErrorLight, ET, ExtraDP1, ExtraDP10, ExtraDP2, ExtraDP3, ExtraDP4, ExtraDP5, ExtraDP6, ExtraDP7, ExtraDP8, ExtraDP9, ExtraHum1, ExtraHum10, ExtraHum2, ExtraHum3, ExtraHum4, ExtraHum5, ExtraHum6, ExtraHum7, ExtraHum8, ExtraHum9, ExtraTemp1, ExtraTemp10, ExtraTemp2, ExtraTemp3, ExtraTemp4, ExtraTemp5, ExtraTemp6, ExtraTemp7, ExtraTemp8, ExtraTemp9, forecast, forecastenc, forecastnumber, forum, graphperiod, gustM, GW1000FirmwareVersion, heatdegdays, heatdegdaysY, heatindex, heatindexH, heatindexTH, heatindexYH, HighAppTempRecordSet, HighDailyRainRecordSet, HighDailyTempRange, HighDewPointRecordSet, HighHeatIndexRecordSet, HighHourlyRainRecordSet, HighHumidityRecordSet, HighMinTempRecordSet, HighMonthlyRainRecordSet, HighPressAlarm, HighPressureRecordSet, HighRainRateAlarm, HighRainRateRecordSet, HighRainTodayAlarm, HighTempAlarm, HighTempRangeRecordSet, HighTempRecordSet, HighWindGustAlarm, HighWindGustRecordSet, HighWindrunRecordSet, HighWindSpeedAlarm, HighWindSpeedRecordSet, hour, hourlyrainTH, hourlyrainYH, hum, humH, humidex, HumidityRecordSet, humL, humTH, humTL, humYH, humYL, inhum, intemp, interval, isdaylight, IsFreezing, IsRaining, IsSunny, IsSunUp, LastDataReadT, LastRainTipISO, LatestError, LatestErrorDate, LatestErrorTime, LatestNOAAMonthlyReport, LatestNOAAYearlyReport, latitude, LeafTemp1, LeafTemp2, LeafTemp3, LeafTemp4, LeafWetness1, LeafWetness2, LeafWetness3, LeafWetness4, LeakSensor1, LeakSensor2, LeakSensor3, LeakSensor4, Light, LightningDistance, LightningStrikesToday, LightningTime, location, LongestDryPeriod, LongestDryPeriodRecordSet, LongestWetPeriod, LongestWetPeriodRecordSet, longitude, longlocation, LowAppTempRecordSet, LowDailyTempRange, LowDewPointRecordSet, LowHumidityRecordSet, LowMaxTempRecordSet, LowPressAlarm, LowPressureRecordSet, LowTempAlarm, LowTempRangeRecordSet, LowTempRecordSet, LowWindChillRecordSet, maxtempL, MemoryStatus, metdate, metdateyesterday, mintempH, minute, MinutesSinceLastRainTip, month, MonthAppTempH, MonthAppTempHD, MonthAppTempHT, MonthAppTempL, MonthAppTempLD, MonthAppTempLT, MonthDailyRainH, MonthDailyRainHD, MonthDewPointH, MonthDewPointHD, MonthDewPointHT, MonthDewPointL, MonthDewPointLD, MonthDewPointLT, MonthGustH, MonthGustHD, MonthGustHT, MonthHeatIndexH, MonthHeatIndexHD, MonthHeatIndexHT, MonthHighDailyTempRange, MonthHighDailyTempRangeD, MonthHourlyRainH, MonthHourlyRainHD, MonthHourlyRainHT, MonthHumH, MonthHumHD, MonthHumHT, MonthHumL, MonthHumLD, MonthHumLT, MonthLongestDryPeriod, MonthLongestDryPeriodD, MonthLongestWetPeriod, MonthLongestWetPeriodD, MonthLowDailyTempRange, MonthLowDailyTempRangeD, MonthMaxTempL, MonthMaxTempLD, MonthMinTempH, MonthMinTempHD, monthname, MonthPressH, MonthPressHD, MonthPressHT, MonthPressL, MonthPressLD, MonthPressLT, MonthRainRateH, MonthRainRateHD, MonthRainRateHT, MonthTempH, MonthTempHD, MonthTempHT, MonthTempL, MonthTempLD, MonthTempLT, MonthWChillL, MonthWChillLD, MonthWChillLT, MonthWindH, MonthWindHD, MonthWindHT, MonthWindRunH, MonthWindRunHD, MoonAge, MoonPercent, MoonPercentAbs, moonphase, moonrise, moonset, newrecord, nextwindindex, OsLanguage, OsVersion, press, PressChangeDownAlarm, PressChangeUpAlarm, pressH, pressL, pressTH, pressTL, presstrend, presstrendenglish, presstrendval, pressunit, PressureRecordSet, pressYH, pressYL, ProgramUpTime, r24hour, RainRecordSet, rainunit, RcapptempTH, RcapptempTL, Rcdew, RcdewpointTH, RcdewpointTL, Rcheatindex, RcheatindexTH, Rchum, Rcinhum, Rcintemp, Rcpress, RcpressTH, RcpressTL, RCRecentDewPoint, RCRecentHeatIndex, RCRecentOutsideTemp, RCRecentPressure, RCRecentRainToday, RCRecentUV, RCRecentWindChill, RCRecentWindGust, RCRecentWindLatest, RCRecentWindSpeed, Rcrfall, Rcrrate, RcrrateTM, Rctemp, RctempTH, RctempTL, Rcwchill, RcwchillTL, Rcwgust, RcwgustTM, Rcwlatest, Rcwspeed, realtimeinterval, RecentDewPoint, RecentHeatIndex, RecentHumidity, RecentOutsideTemp, RecentPressure, RecentRainToday, RecentSolarRad, RecentTS, RecentUV, RecentWindAvgDir, RecentWindChill, RecentWindDir, RecentWindGust, RecentWindLatest, RecentWindSpeed, recordsbegandate, rfall, rfallH, rfallhH, rfallmH, rfallY, RG11RainToday, RG11RainYest, rhour, rmidnight, rmonth, rollovertime, rrate, rrateM, rrateTM, rrateYM, ryear, SensorContactLost, shortdayname, shortmonthname, shortyear, snowdepth, snowfalling, snowlying, SoilMoisture1, SoilMoisture10, SoilMoisture11, SoilMoisture12, SoilMoisture13, SoilMoisture14, SoilMoisture15, SoilMoisture16, SoilMoisture2, SoilMoisture3, SoilMoisture4, SoilMoisture5, SoilMoisture6, SoilMoisture7, SoilMoisture8, SoilMoisture9, SoilTemp1, SoilTemp10, SoilTemp11, SoilTemp12, SoilTemp13, SoilTemp14, SoilTemp15, SoilTemp16, SoilTemp2, SoilTemp3, SoilTemp4, SoilTemp5, SoilTemp6, SoilTemp7, SoilTemp8, SoilTemp9, SolarRad, solarTH, solarYH, stationtype, StormRain, StormRainStart, sunrise, sunset, SunshineHours, SystemUpTime, TapptempH, TapptempL, TapptempTH, TapptempTL, TapptempYH, TapptempYL, Tbeaudesc, Tbeaufort, Tbeaufortnumber, TdewpointH, TdewpointL, TdewpointTH, TdewpointTL, TdewpointYH, TdewpointYL, temp, TempChangeDownAlarm, TempChangeLastHour, TempChangeUpAlarm, tempH, tempL, temprange, temprangeY, TempRecordSet, tempTH, tempTL, temptrend, temptrendenglish, temptrendtext, tempunit, tempunitnodeg, tempYH, tempYL, TgustM, TheatindexH, TheatindexTH, TheatindexYH, ThighDailyTempRange, ThourlyrainTH, ThourlyrainYH, THSWindex, ThumH, ThumL, ThumTH, ThumTL, ThumYH, ThumYL, THWindex, time, timehhmmss, timeUTC, TlongestDryPeriod, TlongestWetPeriod, TlowDailyTempRange, TmaxtempL, TmintempH, tomorrowdaylength, TpressH, TpressL, TpressTH, TpressTL, TpressYH, TpressYL, TrfallH, TrfallhH, TrfallmH, TrrateM, TrrateTM, TrrateYM, TsolarTH, TsolarYH, TtempH, TtempL, TtempTH, TtempTL, TtempYH, TtempYL, TUVTH, TUVYH, TwchillH, TwchillTL, TwchillYL, TwgustTM, TwgustYM, TwindrunH, TwindTM, TwindYM, TwspeedH, txbattery, update, UV, UVTH, UVYH, version, wchill, wchillH, wchillTL, wchillYL, wdir, wdirdata, webcam, wetbulb, wgust, wgustTM, wgustYM, WindRecordSet, WindRoseData, WindRosePoints, windrun, windrunH, windrununit, windrunY, WindSampleCount, windTM, windunit, windYM, wlatest, wsforecast, wsforecastenc, wspddata, wspeed, wspeedH, Ybeaudesc, Ybeaufort, Ybeaufortnumber, year, YearAppTempH, YearAppTempHD, YearAppTempHT, YearAppTempL, YearAppTempLD, YearAppTempLT, YearDailyRainH, YearDailyRainHD, YearDewPointH, YearDewPointHD, YearDewPointHT, YearDewPointL, YearDewPointLD, YearDewPointLT, YearGustH, YearGustHD, YearGustHT, YearHeatIndexH, YearHeatIndexHD, YearHeatIndexHT, YearHighDailyTempRange, YearHighDailyTempRangeD, YearHourlyRainH, YearHourlyRainHD, YearHourlyRainHT, YearHumH, YearHumHD, YearHumHT, YearHumL, YearHumLD, YearHumLT, YearLongestDryPeriod, YearLongestDryPeriodD, YearLongestWetPeriod, YearLongestWetPeriodD, YearLowDailyTempRange, YearLowDailyTempRangeD, YearMaxTempL, YearMaxTempLD, YearMinTempH, YearMinTempHD, YearMonthlyRainH, YearMonthlyRainHD, YearPressH, YearPressHD, YearPressHT, YearPressL, YearPressLD, YearPressLT, YearRainRateH, YearRainRateHD, YearRainRateHT, YearTempH, YearTempHD, YearTempHT, YearTempL, YearTempLD, YearTempLT, YearWChillL, YearWChillLD, YearWChillLT, YearWindH, YearWindHD, YearWindHT, YearWindRunH, YearWindRunHD, yesterday, YSunshineHours
|