Webtags (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
 
(379 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Terminology]]
[[Category:Terminology]]
=Some content has been removed from this page=


This Wiki page covers more than just web tags, it lists the way that you can specify the naming format for the NOAA style reports that Cumulus produces.
Please be aware some content originally on this page has been moved to other pages.  Old posts on the support forum that used to link directly to the specific material, will instead bring you to this start of the page.  


Where the old content was cut, new links have been substituted within three sections on this page: [[#Input Modification Parameters and Output Modification Parameters]], [[#The tag name]], and [[#Recent History]].


However, the main purpose of this page is to explain web tags (tokens that Cumulus uses to indicate where when processing a file it should insert values) that apply to all flavours of Cumulus (Cumulus 1, 2, and 3 aka MX), any differences are highlighted as necessary. Remember as Cumulus is developed more and more web tags are made available, if you are not using the latest release, then some of those listed in this article may not be available. In general, Cumulus 1 will silently ignore any web tags it does not recognise, but MX will raise an error for any web tag it does not understand how to process.
=Essential Background Reading=


Please note some items on this page apply to specifying the report name format (NOAA style), but all items refer to what are called '''template files''', those are files that Cumulus (1 or MX) is asked to [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|process]] and that processing involves Cumulus recognising special markers (also known in MX as tokens) placed in the template file.
If you have not used this Wiki page before, or are unsure about using "web tags", there are some concepts that you do need to understand in the sub-sections that follow.


{{TOCright}}
===The tag names===


=GENERAL TIP=
<div style="background: LemonChiffon;padding:5px; margin:2px;">All the "tag_names" that are available for legacy 1.9.4, and for MX up to first beta build release '''3.12.0'''</div>  are in [[#Full List of Tag Names]] later on this page.


The web tags available in the version/build you are using, can be listed (in Cumulus 1 or Cumulus MX) by adding the following line to [[Cumulus.ini#Section:_Station|Cumulus.ini]] in the [station] section...
<big>If you edit this page, to add tag names for later builds, please amend the previous sentence.</big>


ListWebTags=1
If you are using a Oregon Scientific weather station, then you should read [[#Web tags mentioning (outside) temperature]] in the optional reading section.


Then start Cumulus and it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process. An example of the output for MX is at the end of this page (the actual output does not include commas, and has just one item per line, it has been compressed for inclusion in this article).
Do not assume that Cumulus always works according to normal meteorological practice in your nation. For examples, the hours used by Cumulus to report derivatives involving rainfall, or minimum temperature, may vary from figures reported by local meteorological stations.


To stop Cumulus continuing to produce new versions of that file change the line to say ...
===Quick summary of MX and Legacy differences===
 
==Cumulus MX versus original Legacy Cumulus 1==
 
The full information that used to appear on this page for differences between MX and the legacy Cumulus has been moved to a new [[Webtag Applicability|Web tag Applicability page]].  The next subsection just gives a basic summary.
 
[[File:Badge vMx.png]] This page has been updated to include web tags up to version 3.12.0 beta build 3134.  Announcements for new builds of MX generally provide too little information for it to be easy to update this page, that is why it is often out of date.
* Since version 3.10.x, MX has not used web page templates, please see <big>[[WebsitedataT.json]]</big> page, instead of this Wiki page.
*# That page explains the ID names used on the [[New_Default_Web_Site_Information|default web site]] introduced from release 3.10.0
*# That page documents each data pair in the file
*# That page gives the source web tag for each ID name on the web pages
*# That page explains what data is represented by the ID name, JSON attribute, web tag name
* Past MX releases 3.0.0 to 3.9.7 used [[Cumulus template file|web template files]], similar to (but not same as) the legacy software
** This Wiki page remains organised according to the content of those old template files.
 
[[File:Badge v1.png]][[Category:Cumulus 1]] This page was created for Cumulus 1. Steve/Beth Loft provided some example [[Cumulus template file|web template files]], but expected Cumulus users to develop their [[Customised templates|own Cumulus template files]] making use of the web tags, listed below, that the software provided.
 
For tag names available in the release you are using, see the next sub-sections.
 
===What web tags can I use?===
 
Basically, it depends on which web tags are in whatever files are used to transfer weather derivatives to your web server.
 
As Cumulus has developed, more tag names have been introduced, the tables showing tag names available, attempt to give an indication of which release introduced them. You can, see below, ask Cumulus (both MX and legacy) to list all the tag names it recognises, when it is started at whatever build you are running.


ListWebTags=0


{{Version badge 1}}If you are using Cumulus 1, each build of that contains a build specific version of Cumulus Help, and within that help is a list of web tags with basic information on what each tag_name returns.


= NOAA style Report Naming =
====Using release after 3.9.7?====


== A brief history of these reports ==
If you are using the [[New_Default_Web_Site_Information|default web site]], its standard web pages show data as follows:
* Pages with tabular presentation, see [[WebsitedataT.json]].
* Pages with graphs, see [[Cumulus.ini#Optional_Web_Server|Graph File Settings]].
* Page with steel series dials, see  [[Cumulus.ini#Display_Options|Display Options]].


Cumulus 1, 2, and MX, generate climatological reports for both Monthly and Yearly periods. The reports were first added to Cumulus 2 after someone asked for this feature in enhancement request 44. They were based on Weatherlink reports, that in turn were based on climatological reports issued by The US National Oceanic and Atmospheric Administration's National Weather Service (the reason for using NOAA in the naming of the reports). Ken True implemented the Weatherlink reports in his Saragota suite, and Steve Loft took that as his starting point. Although they were tested in Cumulus 2, they were added to Cumulus 1 in version 1.9.2 (build 1004) released in July 2011.  
If you are using your own web templates, or other [[Customised templates|own Cumulus template files]] such as [[Php_webtags|XML or PHP data files]], then you make the decision on which tag names are used for the data to your web server.


== Encoding ==


Let me expain that technical term, essentailly encoding refers to the character set used by any file. A computer uses binary, binary can only be in state 0 or state 1, so a combination of 0 and 1 states needs to be defined for every character you want to represent. What you can include in that character set depends to some extent on how many binary bits are used to be mapped to individual characters; and if more than one byte worth of bits is used the order in which the bits within the multiple bytes are used must be defined for each particualar encoding. With any fixed number of bits available, there will be a limit to how many characters can be defined, and different organisations might select different characters to include. This is what leads to multiple encoding standards. One might use a particular arrangement of bits to represent the degree symbol, while another encoding uses that particular arrangement of bits for a different purpose. This means that when you read a file you might find the letters A to Z where you expect them, but actually some encodings put capital letters at lower binary values than lower case letters, and some put capitals at higher binary values. The general problem is that unless you know the encoding used, you don't know what character to display for certain combinations of bits.
====Getting release 3.12.0 or later to list tag names when it starts====


If you use 7 bits, you have 127 combinations, enough for standard 26 letters in both capitals, and lower case, plus 10 digits (0 to 9), some punctuation, and some control characters (like new line, end of file, and so on). If you use 8 bits, a whole byte, you have 254 combinations, and you can start coping with accented letters, with alphabets that don't have 26 letters, and even add some symbols. Obviously, once you start using more than one byte, you can have 16, 32, or more bits to use and can include lots more characters.
Please use the admin interface.
In April 2014, Steve introduced the choice in Cumulus 1 of either ISO-8859-1 encoding (as he used originally) or UTF-8 encoding (what he migrated his web page templates to) for these reports. This choice remains unchanged in MX. The default selected by Steve Loft is his original ISO-8859-1 encoding, but be aware the encoding you use should match the encoding of any web page used for viewing these reports, and most modern web pages (including the standard web templates provided with both flavours of Cumulus) use UTF-8 encoding. The encoding can be selected on the NOAA Settings screen of either Cumulus 1 or MX.


== The format used for naming ==
Go to '''Program settings → General options'''


The monthly reports have a name in this format '''"NOAAMO"...".txt"'''.  The yearly reports have a name in this format '''"NOAAYR"...".txt"'''. This format with 4 double quotes in all cases is used both in the NOAA settings screen and in the [[Cumulus.ini#Section:_NOAA|[NOAA] section of Cumulus.ini]].
Tick ''List web tags''.


It is between the double quotes where I have placed '...' that Cumulus expects us to use the date output modifiers described. Note that the double quotes must be used at each of the places where they are shown when you define your report naming in the NOAA Settings screen of either Cumulus 1 or MX.  The default selected by Steve Loft is '''MMyyyy''' and '''yyyy''' respectively (expressed in a way that suits both Cumulus 1 and MX) so the inserted part is all numerical. Here is a table showing the main alternative options, for more details about these selectors see the [[Webtags#List_of_allowed_modifiers|table below]]  as there are obviously a lot more options.
The next time that MX is restarted,  it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.  


{| class="wikitable" border="1"
Go to '''Program settings → General options''', untick ''List web tags'' to stop Cumulus continuing to produce new versions of that file next time it is restarted.
|-
!style="width:150px" | {{Version badge 1}}Delphi Specifier for Cumulus 1.9.x
!style="width:150px" | [[File:Badge vMx.png]]Mono Specifier for Cumulus MX
!style="width:600px" | Explanation
!style="width:150px" | Setting to use that suits both flavours
!style="width:600px" | Example of produced name
|-
|colspan="5" style="background:lightgray;"|Yearly report
|-
|YYYY or yyyy
|yyyy
|Note that Cumulus 1 accepts lower or upper case, this is the default mentioned above
|"NOAAYR"yyyy".txt"
|NOAAYR2010.txt
|-
|YY or yy
|yy
|Note that Cumulus 1 accepts lower or upper case, this represents a 2 digit year number alternative format
|"NOAAYR"yy".txt"
|NOAAYR10.txt
|-
|colspan="5" style="background:lightgray;"|Monthly report
|-
|mmyyyy (or MMYYYY)
|MMyyyy
|Note that Cumulus 1 accepts lower or upper case, these are equivalent to default mentioned above, so this is most common for users who first encounter with Cumulus is with MX flavour
|"NOAAMO"MMyyyy".txt"
|NOAAMO032010.txt
|-
|mmyy (or MMyy or mmYY or MMYY)
|MMyy
|Note that Cumulus 1 accepts lower or upper case, this represents a 2 digit year number alternative format, this was the format frequently selected by Cumulus 1 users as it keeps file names as short as possible
|"NOAAMO"MMyy".txt"
|NOAAMO0310.txt
|-
|yyyy-mm (or YYYY-MM)
|yyyy-MM
||Note that Cumulus 1 accepts lower or upper case, this naming format is popular as it results in files being in chronological sequence when listed by file name
|"NOAAMO"yyyy-MM".txt"
|NOAAM2010-03.txt
|-
|MMMyyyy
|MMMyyyy
|Note that Cumulus 1 accepts lower or upper case, this represents an informative naming format using 3 letter month name as defined for your locale on your device, in '''.NET''' or in '''MONO''' so it is used by those who want to quickly spot which report they want to look at.
|"NOAAMO"MMMyyyy".txt"
|NOAAMOMar2010.txt (for English locales)
|}


If you migrate from Cumulus 1 (where case does not matter) to Cumulus MX (where case does matter), from version 3.3.0 onwards the NOAA default monthly name if it reads "NOAAMO'mmyy'.txt" (MX believes "mm" '''means minutes''', not month) is changed into "NOAAMO'MMyy'.txt (which works on both Cumulus 1 and MX).


= Web tags available in Cumulus =
====Getting legacy Cumulus, or MX releases up to 3.11.4, to list tag names when starting====


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:
The tag names available in the release/version/build you are using, can be listed (in Cumulus 1 or Cumulus MX) by adding the following line to [[Cumulus.ini#Section:_Station|Cumulus.ini]] in the [station] section...
<code>ListWebTags=1</code>


<pre><#tag_name [optional input parameters][optional output parameters]></pre>
Then start Cumulus and it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.


''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).
To stop Cumulus continuing to produce new versions of that file change the line to say ...
<code> ListWebTags=0</code>


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.
[[File:Badge v1.png]] If you are using Cumulus 1, each build of that contains a build specific version of Cumulus Help, and within that help is a list of web tags with basic information on what each tag_name returns.


[[File:Badge vMx.png]] MX bug: The inclusion of a web tag in the list produced by this instruction, does not mean that web tag is actually populated with valid information. See https://cumulus.hosiene.co.uk/viewtopic.php?p=153096#p153096 for an example.


=== Beta Builds of Cumulus ===
==What is a web tag? ==


There is a page that detailed the [[BETA webtags|additional webtags]] available in any Cumulus 1 Beta version that was under development. You may see some new web tag features as MX is being developed, appearing on that page, now development of Cumulus 1 has finished and MX is where all development happens.
Weather values are always changing, so Cumulus needs a way for you to tell Cumulus to enter the current value for a particular derivative, when it is [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processing templates]].


== Optional Parameters ==
==General Format for Web Tags==
=== Input modification Parameters ===
Most web tags do not require any input parameters. However, those for [[#Recent_History|individual minutes in last week]] and for [[#Monthly_All_Time_Records|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 [[#Output_.27format.27_Parameter|this later section]]. The options available include changing time format, changing number of decimal places, and removing decimal commas.


== Cumulus Templates ==
In the position, in any (HTML, JSON, PHP, XML) template file, SQL, or Custom HTTP, where Cumulus is to insert the relevant data, place a web tag in the '''general format''' specified here:  <code><#tag_name [optional input selection parameters] [optional output modification parameters]></code>
=== 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  [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|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 ===
===The optional parameters===


*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.
The terminology "optional" is used because some tag names do not accept any parameters, but there are some tag names where a parameter is mandatory. Therefore, check the [[Webtags/Parameters|web tag parameters]] page to learn whether a web tag name you find here requires a mandatory parameter, or to find out which parameters are optionally available.
*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 [[#No_Commas|tags with commas removed]] section.
*Note that if a PHP or JavaScript file contains any Cumulus web tags then you must [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|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
<pre>integer_variable_name=parseInt(string_variable_name,10)</pre> 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.
*Another alternative is to add zero when a web tag is being assigned to a script variable, this is used in scripts where the web tag being used is not available in all versions of Cumulus. Adding 0 means that if the web tag is not recognised, the script is still able to give a variable in its language some value and won't fail because that variable is undefined. If the web tag is available, the true value of that web tag is still assigned to the variable.


== Web Tag Differences Between Cumulus 1 and MX builds ==
The tables of tag names that appear later on this page will seldom give any information about which parameters are mandatory or optional.  There are tables on the other page referenced above that help you to understand what parameters the various tag names accept, explain each of the parameters available, and give examples.
{{Version badge 1}}
This badge is used when either all the web tags listed in one of the tables are available in the final 1.9.4 release of Cumulus 1, or to identify which tags are available when a table includes some that are only available in MX. See [[#GENERAL_TIP|tip]] at top of this page if you use an earlier release than 1.9.x.  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.


[[File:Badge vMx.png]]
There is a basic guide to what these parameters can do, and another link to the new page at [[#Input Modification Parameters and Output Modification Parameters]] later on this page.
Cumulus MX provides all tags available in Cumulus 1 and adds even more. Note they are called tokens in some places. This badge is used when either all the web tags listed in one of the tables are available in the latest MX release,or to identify which tags are available when a table includes some that are only available in MX. See [[#GENERAL_TIP|tip]] at top of page for how to check which web tags/tokens are available in your build.  


Please see [[Cumulus_MX|page introducing Cumulus MX]] for more information regarding the tags missing from Steve Loft's original beta builds of MX. For [[BETA_webtags#Day.2FNight.2FSun.2FMoon|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:
<pre>Web tag error
Exception: i=8998 len=106297
inputText.Length=106297
token=<#daylightlength format=H></pre>
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:
<pre><#daylightlength format=%H></pre>


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.
===Inconsistency of tag names===


=Output 'format' Parameter=
For both the legacy Cumulus and for MX, it is vital that you use tag names exactly as they are listed.  That would be easy had Steve Loft created a naming standard and stuck to it.


=== Output Parameter Differences between Cumulus 1 and Cumulus MX (Cumulus 3) ===
To be fair to Steve, he created the legacy Cumulus for his own use, working in his spare time, alongside a full time job.


There are a number of differences between Cumulus 1 (C1) and Cumulus MX (MX). C1 can work with times in 14.24 format using a full stop to separate the figures, MX must have ':' between hour and minute numbers. The characters used to represent year, month, day, hour, minute, second, microsecond differ betweeb C1 and MX.
Remember, the original design did not anticipate use by others, nor how much extra functionality would be added later.


==== Explanation ====
Early versions of Cumulus could only report current values and the summary for the day so far.  Different web tags for today-so-far were added at different times, hence the names are inconsistent. New web tags for today-so-far added before yesterday tags were considered lack the T suffix (or prefix) later today-so-far tags use.


*Cumulus MX (when running on Windows) uses the '''.NET''' software.
All-time tags were introduced before yesterday, this month and this year; hence all-time tag names assume they are only extreme monitoring.
*If Cumulus MX is running on Linux or Mac OS X, or any other device that uses UNIX derived operating system, then it uses '''Mono''' software for same purposes. (MONO is a operating system independent version of .NET, although they are developed independently, they have common origins).
*The date and time format characters in Mono (and .NET) software framework are not exactly the same as the '''Delphi''' software framework ones that Cumulus 1 uses. 
*For Cumulus MX see [http://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx this Microsoft site] for format selectors available.
*The differences come about because Delphi is case-insensitive, while .NET and MONO are case sensitive, so .NET (and MONO) can use upper and lower case for different items, where Delphi has to use different letters for each item.


==== When it causes problems ====
The legacy tag names for this month and this year were all introduced in a single release and they remain consistent apart from what MX added later!  However, they are not consistent with the naming of the all-time extremes introduced much earlier.


This can cause problems when somebody moves from using Cumulus 1 to using MX. They need to revisit any templates or scripts where they use output modifiers to specify a date and/or time format. We have already explored this for [[Webtags#The_format_used_for_naming|NOAA report naming]].  
This great inconsistency in the naming, gives rise to a problem as it very easy to spell a tag_name incorrectly (and from time to time such mistakes creep into the tables on this Wiki page) as you naturally expect there to be a standard pattern.  Some tags are all lower-case, some are camel-case, and some start with a capital letter. Have a look yourself at just how much inconsistency is present in the names in the tables below.  


For web tags it is much more complicated, not only do we need to select the right case, we also have to cope with MX selectors having different meanings when they are on their own and when they appear with other selectors, finally where you put quotes within these format specifiers varies between Cumulus 1 and MX partly because the reserved characters change and partly because MX introduces the concept of escaping characters.


Confused now? I'm not surprised, but maybe some examples will help before we actually list the available modifiers.
=====Inconsistency in use of "Y"=====


==== Examples ====
The character "Y" has been selected to denote yesterday in tag names.  The inconsistency is where it appears. 


*Examples related to case selection
* Steve used Y as a suffix for most, not all, Cumulus 1 yesterday tags (e.g. <#rfallY>, <#windrunY>, <#YSunshineHours>, <#avgtempY>)
*#[[File:badge v1.png]] In Delphi, "nn" means "minutes" for Cumulus 1, [[File:Badge vMx.png]]but "minutes" is "mm" for .NET or MONO in Cumulus MX.
* Mark uses Y as a prefix, in most, not all, the extra Cumulus MX tags (e.g. <#Ybeaufort>, <#Ychillhours>, <#windAvgY>)
*# The hour in 24-hour format with leading zero, in non case sensitive Delphi (Cumulus 1) 'HH' or 'hh' would be treated as same, but in .NET or MONO it must be "HH" (Cumulus MX).
*# The hour in 24-hour format without leading zero, in non case sensitive Delphi (Cumulus 1) 'H' or 'h' would be treated as same, but in .NET or MONO it must be "%H" (Cumulus MX).
*# For 12-hour specifiers, please see the table, as this is far more complicated.
*[[File:Badge vMx.png]]You might be put off by references within .NET and MONO (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 for 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.
*#Alternatively, ''<#MonthTempHD format="%d">'' is NOT a single character format modifier, therefore the 'd' acts as a custom modifier, and causes a date of 22 July 2014 for the highest temperature in the month to be returned as the day of the month only '22' in all locales.
*#Similarly, ''<#MonthTempHD format="%M">'' is NOT a single character format modifier and therefore the 'M' acts as a custom modifier and causes the same date for the highest temperature in the month to be returned as the month number '7'.


The other change with the "format" parameter is the different way that MONO and .NET  escape any characters that are not being used as format specifiers.
=====Consistency in Cumulus 1, becomes inconsistency in MX, for this month and this year=====
* In [[File:badge v1.png]]Delphi you can put the 'verbatim' characters inside single quotes (Cumulus 1); this is often used to (in English) include words like ' on ' and ' at ' in the formatted output.
*in [[File:Badge vMx.png]].NET or MONO you can still use single quotes, but alternatively you can escape each verbatim character with a backslash as prefix (Cumulus MX).  You may need to use both single quotes and back slashes in some format specifiers, depending whether the characters you want to include can be interpreted as control characters (yes, backslash is also used to escape control characters, so for some characters such as those in "on" and "at" [\n will produce new line not the letter n, \t will produce a tab not the letter t] you must use the literal approach to include them in your format).


==== Using HTML tags within format parameters (available in MX only) ====
The legacy tag names for this year and this month were all introduced together by Steve in one release, with consistency in how they were named then, "Month" or "Year" was used as a prefix (this was after he had started using "Y" as a prefix for his new yesterday tag names) e.g. <#YearLongestDryPeriod>.


'''Example using a class to change the look of part of the output'''
The development of MX however, broke this consistency, as Mark adds "Year" as a suffix, e.g. <#SunshineHoursYear>, instead of following Steve by using a prefix.


<pre><#TapptempH format="dd'&nbsp;'MMM'&nbsp;'yyyy'<span class=\'xx\'> at 'HH:mm'</span>'"></pre>
=====Inconsistency in use of "T"=====
the output from this will look like ''04&nbsp;Dec&nbsp;2018<span class='xx'> at 10:12</span>''


'''Note where the quotes are, and where you need to use '\' escape characters'''.
I said above, that early versions of Cumulus only had tag names for current spot values and for today-so-far daily means/extremes/totals.  Therefore it could be assumed that <#beaufort>,  <#temp> and <#press> all represented current spot values while <#avgtemp> and <#rfall> represented today-so-far values just by looking at their names.


'''Example using HTML tags'''
The current value tag names formed the basic part of tag names, extended for daily extremes with  "TH" and "TL" added as suffixes (to represent daily highs and daily lows), (e.g. <#tempTH>, <#tempTL> and <#pressTH>, <#pressTL>), which made a lot of sense. Adding a "T" for related times, made some sense, except that use of "T" was not done in a consistent manner (e.g. <#TpressTH>, <#Tbeaufort>,  <#TtempTH>, <#YearTempHT>).


<pre><#RecentTS d=2 format="h:mm'&nbsp;'tt'<small>on' d/M/yyyy'</small>'"></pre>
This puts the date in a smaller font than the time


=== Output (format modifier) parameters for decimal places ===
===The functionality that can use web tags===


In the legacy Cumulus software, the only functionality that could use this was [[#Template files can create many types of file|the Cumulus template file]] used to provide data to a web server. That is why Steve Loft, the author of that software named them web tags.
MX has extended the use of these web tags, they can now be inserted into a [[MX_Administrative_Interface#MySQL_settings|SQL commands]], Custom HTTP, [[#The web tag application programming interface|application programming interface]], as well as [[#Template files can create many types of file|template files]].


Cumulus 1 allows use of <tt>dp=n</tt> 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.
The output file can be:
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"
* a [[Customised_templates#HTML_5_-_a_very_quick_guide_to_structure|web page]],
* a  [[Php_webtags#Option_3:_JavaScript_Object_Notation|JavaScript Object Notation (.json) file]]
* a [[Feels_Like#HTML_code_to_translate_web_tags_to_JavaScript_variables_.28as_modified_for_additional_parameters.29|JavaScript file]],
* a [[PHP]] script file, or
*a [[Xml_webtags|eXtensible Mark-up Language (XML)]] file.


*<tt>dp=i</tt> 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 (latitude and longitude, plus in MX <#MoonPercent> and <#MoonPercentAbs>).
=Optional Background Reading=
*<tt>tc=y</tt> is a new parameter only in MX, the attribute '''tc''' takes the value 'y' to remove decimal places by truncation instead of using <tt>dp=0</tt> 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 ===
==Web tags mentioning (outside) temperature==


"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 <tt><#tag_name rc=y></tt> from the next version.
'''For Oregon Scientific weather stations using, either USB connections''' (e.g. WMR-200), or serial connections (e.g. WMR-928), that can have multiple temperature sensors, it is possible to configure which sensor the outdoor temperature (for which daily and longer period extreme records are maintained) is read from, by following this set of instructions originally supplied by Steve Loft:
# Stop Cumulus in the normal way
# Use a text editor to edit the file called ''Cumulus.ini''
# Scroll down to the line that contains '''[Station]'''
# Create a blank line below it by pressing ''Return''
# In that new line, type the command shown in the relevant code box below, type the attribute and equals sign exactly as shown without spaces (regardless of your exact model),
#* USB connections &rarr; <code>WMR200TempChannel=N</code>
#* Serial connections &rarr; <code>WMR928TempChannel=N</code>
# Now edit the value shown after the equals sign, replace ''N'' with the relevant number from the following list:
#* To use the main sensor, replace N with '''0''' (or don't bother with this procedure, as that is default)
#* To use Extra Temp 1 sensor, replace N with '''1'''
#* To use Extra Temp 2 sensor, replace N with '''2'''
#* and so on, up to a possible maximum (check with your weather station, but Cumulus can accept up to 12)
# Save the file, and exit
# Restart Cumulus in the normal way


=== Output (format modifier) parameters for times and dates ===


Time/Date format codes are used in two places:
'''For other weather stations''', the main outdoor temperature sensor is used for what is reported for current value, daily extremes, and longer period extreme recordsThis temperature is also used for calculation of derived values such as Australian Apparent Temperature, Canadian Humidity Index, and USA Heat Index.
# 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.  
'''''Please check release announcements, it is planned that swaping of main Temperature sensor will become available for Ecowitt.'''''


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):
==Input Modification Parameters and Output Modification Parameters==
*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 ===
In [[#Scary_statistics]] section of this page, it is explained how less than a thousand [[#Full List of Tag Names|tag names]] (the first part of the [[#General Format for Web Tags]]) become billions of web tags, simply by adding modifiers.


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:
The modifiers available used to be listed on this page (so if you select the history tab for this page, you will find references to their introduction and growth), but are now on a new [[Webtags/Parameters|web tag parameters]] page.  Here are some of the advantages achieved by moving them to the new page:
* This page is very long, so it is not easy to navigate this page, even without the parameters
* There would be a lot of repetition if you attempted to say beside each tag name which modification parameters were available.
* Having them on separate pages means you can have two tabs (or two separate browsers) open so you can see both the tag name and the modifier parameter by flicking between tabs, instead of lots of scrolling between different parts of same page.
* The introduction of [[WebsitedataT.json]], which controls what data is available to tables in the web pages provided by MX, means that page, rather than this page is the entry point for MX, and it is easier for that page to reference a separate parameters page
* MX has introduced many more input and output modification parameters, it is easier to maintain a separate page (and easier for reference if you just want to refresh your mind on new modification parameters).


#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.<br>  Example of valid syntax: <#TapptempH format="'at 'h:nn'&nbsp;'am/pm '&lt;small&gt;on' d/m/yyyy'&lt;/small&gt;'">.


{{Version badge 1}}'''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 [[Php_webtags#Web_tag_Complications| here for work-around]]).
For just a taste, there you can discover:
* A score of [[Webtags/Parameters#Input_modification_Parameters|input modification parameters]]
** For  example, find which attribute is used with a value between 1 and 12, so the same tag name can give values for 12 different months)
* If your locale normally (in real numbers) uses an integer part, then a comma, and then the decimal part, you should be aware that some computer scripts, and some external servers where you might want to send data, insist on a decimal point, instead of a decimal comma:
** If you have installed a recent MX release, then [[Webtags/Parameters#Output_Modification_Parameter_for_changing_any_decimal_comma_into_a_decimal_point|change decimal comma to decimal point]] with a simple "y" value to another attribute
** If you have the legacy Cumulus 1 installed, stay on this page and look at [[#No_Commas]], as you have to use the restricted alternative set of tag names.
* How to [[Webtags/Parameters#Two_Output_.28format_modifier.29_parameters_for_decimal_places|control number of decimal places]] in any real number output
* All about the complex subject of modifying the way a '''duration''', a ''date'', or a  '''clock time''' is output by looking at [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates|Multiple_Output_Format_Modifier_parameters_for_times_and_dates]]


[[File:Badge vMx.png]]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!
== Why does MX talk about tokens? ==


=== List of allowed modifiers ===
MX uses a [[Cs_Code_Modules#TokenParser.cs|'''token parser''']] to read the web tags and replace them with the correct value, so if diagnostic output refers to tokens, it is saying the attempt to actually work out what content to return to replace the web tag with its tag name and parameters has encountered a problem.
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).


[[File:Badge vMx.png]]Remember that most single character format specifiers have a different meaning to when the same letter appears in a multi-character format.
==Scary statistics==


# The 3.5.0 release of MX defines 9½ million values that can be represented using '''web tags'''!
# At 3.5.0, there are only 717 options for the '''tag_name''' in the general format given above.
# How come this discrepancy?
# That discrepancy is purely because some of those 717 tag names can be associated with input parameters, (and for Oregon Scientific stations,you can select which sensor is used for outside temperature), these modifications affect what value is selected to be output by the web tag leading to the large number
# These millions of web tags can actually produce billions of different outputs!
# How come this second discrepancy?
# Well adding all possible different output parameters generates the billions of different ways to output the millions of values!
The statistics quoted above keep increasing as MX is developed, the last time I checked, there were another forty or so tag names, and lots more parameters, so the alternatives are probably well over ten billion now.


==== Forum reference ====
== Brief history of this page==


For official full details see [https://cumulus.hosiene.co.uk/viewtopic.php?f=39&t=17888 Cumulus MX forum], the following table is revised for simplicity. (I've given a different selection of combinations and included '%' where necessary to avoid single character versus custom complications).
This page was created in August 2009, to list the tags for the (legacy) Cumulus 1 software. Initially, there were going to be further pages to explain individual web tags, e.g. [[Forecast_webtag]]; but that idea was never completed.


==== My Revised Table of time and date output modiufers ====
When MX came out of beta (3.0.0), it has been developing rapidly, as the statistics above suggest, the number of web tag names and input/output modification parameters, to document became too much for one Wiki page, hence the moving of all documentation about modification parameters to a sub-page.  There are still a lot of web tag names to document on this page, and separation into a number of pages was considered, but it is easier to have just one page to refer in answers to questions raised in the forum.


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.
==Still got questions?==
{| class="wikitable" border="1"
 
|-
Full support is available via the support forum at https://cumulus.hosiene.co.uk/viewforum.php?f=40 for the latest MX release. Given that some users may still be running an older MX release, where possible any web tag listed below for MX indicates at which release it first became available.
!style="width:150px" | {{Version badge 1}}Delphi Specifier for Cumulus 1.9.x
 
!style="width:150px" | [[File:Badge vMx.png]]Mono/.NET Specifier for Cumulus MX
There is limited support available for Cumulus 1.9.4, but on this page every attempt is made to indicate which version of the legacy software introduced any web tag listed below.  
!style="width:600px" | Displays
 
!style="width:600px" | Example
==The web tag application programming interface==
|-
 
|c
[[File:Badge vMx.png]] Available from version 3.7.0 (build 3089) released 28 July 2020. It was proposed in January 2015, see Steve Loft [https://cumulus.hosiene.co.uk/viewtopic.php?p=101496#p101496 plan to add a call where you supply a list of items (probably web tag names), and you get back the equivalent data].
|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.
=== Where to use===
|'22/03/2019 09:47:25' produced by {{Version badge 1}}<#time format=c>[[File:Badge vMx.png]]<#time format=G>
 
|-
This is meant for services either on the same computer as Cumulus or on your local network. It is not secure, and should not be available, nor requested, via any external network or the internet.
|d
 
|%d
The [[Cumulus_MX_Local_API|MX Administrative Interface]] uses some application programming interface (api) calls to obtain the data each web page in that interface needs, and if you are making an edit, another api to return the results of any edit made.  
|Displays the day as a number without a leading zero (1-31). [[File:Badge vMx.png]]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 {{Version badge 1}}<#metdate format="d">[[File:Badge vMx.png]]<#metdate format="%d">
If you wanted your '''CumulusMX/interface/todayyest.html''' web page to include something else (e.g. snow falling/lying/depth) you could edit that HTML page to have the extra sub-table you want (you cannot edit the existing rainfall table as that is dynamically created by existing api). Then you could edit the associated JavaScript file '''CumulusMX/interface/js/todayyest.js''' to add a new api call seeking snowdepth, snowfalling, snowlying tags for today (unfortunately there are no tags for yesterday's snow) and to place the returned values into your new sub-table (probably using jQuery to make it easy). In a similar way, you could add anything where today and yesterday tags are available such as UV Index.
|-
 
|dd
In earlier versions of Cumulus if you wanted to make use of values processed by Cumulus, you wrote a script file referencing the web tags you wanted to use, and let Cumulus process that file at an interval set in the settings, then you had to write something to process the results at the relevant interval. Now if you are running other software on your device that runs MX (or a computer or other device linked directly on your personal network), you can request web tags values on demand via an application programming interface ('''api''' hereafter) and don't need to worry about any timing issues.
|dd
 
|Displays the day as a number with a leading zero (01-31).
Obviously each api request creates a processing overhead on Cumulus so use this feature wisely (minimise the information you request and minimise the frequency of requesting it). You can use it for extra current information, but in that usage you might need to repeat the call. Consequently, maybe it is more likely that the api will be used to request information that does not keep changing, such as what units are being used for temperature, rainfall, and wind speed; or perhaps daily, monthly, or yearly, summary figures.  
|07 produced by <#metdate format="dd">
 
|-
Each admin interface web page uses api techniques for all the information it needs. Some api calls are repeated with AJAX requesting updates for the weather information on a frequent basis, but each page has another api request that is issued just once for the version and build being used. To my mind, the design of '''CumulusMX/interface/todayyest.html''' is crazy.  The HTML appears to have a table structure, but that table structure is overwritten by each repeating api. So every time AJAX repeats that api call it returns in json format the whole table definition as well as table cell contents, despite that much of that json (all that HTML defining table header, table rows, table cells, etc.; and the units for each value) does not change and it is only some values and times buried within the json in the api that actually might change (and of those half of them, the yesterday values and times only change once a day).  In some code I wrote (but later abandoned) I made use of the api calls that support the '''CumulusMX/interface/todayyest.html''' web page to get the units I wanted on another interface page, but I only called it once as it returned a lot of other information (as just mentioned) that I did not need. I later found a better way, as in example below, which gives me just what I need and no more.
|ddd
 
|ddd
=== "GET" approach ===
|Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Locale.
 
|'Wed' produced by <#metdate format="ddd"> (English locale)
You may have used GET as an attribute when defining the action of a HTML form.  Equally you might in a script language access the query-string part of a Universal Resource Locator to get parameters for what the script is to supply to the web page. Even if you don't understand the meaning of those technical terms, you probably have seen when using a browser (in the box where a URL is entered) that sometimes the URL seen there has a query-string. You will have seen a question mark (?) followed by one or [separated by ampersand (&)] more '''name=value''' parameters.
|-
Full List of Tag Names
|dddd
The GET approach to using the Cumulus general api works in this way indicating the start of a query-string with a question mark and using ampersands to separate names. The difference is that a tag name (or list of tag names) is used instead of a name=value parameter (or list of name=value parameters). However, when the Cumulus api returns the values they will be in attribute=value format.  Therefore if (like example below) you are coding in JavaScript, what is returned is a JavaScript Object and you extract the values by specifying the Object name and the Attribute name. If that technical terminology confuses you, look at the example.
|dddd
 
|Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Locale.
====Selecting values using GET====
|'Friday' produced by <#metdate format="dddd"> (English locale)
 
|-
Suppose you want to get the values for the following three web tags:
|ddddd
# <#RCtemp>
|d (as single character format)
# <#RChum>
|Displays the date using the format given by the Short Date format.
# <#RCdew>
|e.g. '22/03/2019' (British Locale)
Then the URL with query-string to use is '''http: //localhost:8998/api/tags/process.json?rc&temp&hum&dew'''
|-
 
|dddddd
Obviously, if you have started MX with a port parameter like this:
|D
<pre>sudo mono CumulusMX.exe -port 9999</pre>
|Displays the date using the format given by the Long Date format.
then you change the 8998 port shown in the URL for the api to use the port you have selected e.g. '''http: //localhost:9999/api/tags/process.json?rc&temp&hum&dew'''
|e.g. '22 March 2020' (British Locale)
|-
|M (or ''m'')
|%M
|Displays the month as a number without a leading zero (1-12).  
*{{Version badge 1}}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.
*[[File:Badge vMx.png]]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).  
*{{Version badge 1}}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).
{{Version badge 1}}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].
{{Version badge 1}}For Cumulus 1, the minutes can be represented by 'mm' only when appearing in combination with 'h'
|'10:27 am' produced by {{Version badge 1}} <#LastDataReadT format="h:nn am/pm">[[File:Badge vMx.png]] <#LastDataReadT format="h:mm tt">
|-
|H
|%H
|Displays the hour using 24 hour clock without a leading zero (0-23). [[File:Badge vMx.png]]Note that % is only needed when H is on its own.
|7 produced by {{Version badge 1}}<#daylength format=h>
[[File:Badge vMx.png]]<#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. [[File:Badge vMx.png]]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].
{{Version badge 1}}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
[[File:Badge vMx.png]] 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 {{Version badge 1}} <#LastDataReadT format="hh am/pm">[[File:Badge vMx.png]] <#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].
{{Version badge 1}}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
[[File:Badge vMx.png]] 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 {{Version badge 1}} <#LastDataReadT format="h:nn am/pm">[[File:Badge vMx.png]] <#LastDataReadT format="h:mm tt">
|-
|n
|m
|Displays the minute without a leading zero (0-59).
|7 produced by {{Version badge 1}}<#daylength format=n>[[File:Badge vMx.png]]<#daylength format=m>
|-
|nn
|mm
|Displays the minute with a leading zero (00-59).
|'07' produced by {{Version badge 1}}<#daylength format=nn>[[File:Badge vMx.png]]<#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. [[File:Badge vMx.png]]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 {{Version badge 1}}<#LastDataReadT format=TT> [[File:Badge vMx.png]]<#LastDataReadT format=T>
|-
|am/pm or Am/Pm or AM/PM
|tt
|{{Version badge 1}}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.


[[File:Badge vMx.png]] 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.
[[File:Badge vMx.png]]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 =
The first parameter is '''rc''' to indicate that the tags that follow are to use decimal points not decimal commas, which is how many script languages expect to see values.
Remember that in current version (and some earlier versions) of MX, the above three web tags are exactly same as:
# <#temp rc=y>
# <#hum rc=y>
# <#dew rc=y>


These are available in both Cumulus 1 and MX unless indicated by a version 1 or MX badge.
Since '''rc=y'''  can be applied to several web tags that don't appear in [[Webtags#No_Commas]] table, this shows how the api can access values without commas for all those web tags that report in real numbers and allow that output modifier.


===System===
If you are using the api in a context where it does not matter if decimal commas or decimal points are in the api or for any tags that don't report in real numbers, simply omit the '''rc''' as first item, and just include tag names separated by ampersands.


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.
==== JavaScript example ====


Some people might feel the admin interface could be improved on some of its pages by showing additional information. It is possible from MX 3.7.0 to obtain extra information. 


{| class="wikitable" border="1"
I wanted to improve the log file editing pages, and that was partly by adding validation, and partly by changing the way the editing is done.  For the standard log file editor I wanted to achieve even more, I added a script to calculate (and recalculate after any edit) the derived fields from the source fields.  To make these calculations work for anyone, I needed to find out what units the Cumulus MX user is using. Before 3.7.0 release the snippet of script that obtained the units via various api calls was quite complex (I described above how the api returned lots of unwanted content), but with 3.7.0 my new api call was greatly simplified to what I show below. Please note my revised log file editing scripts did not make it into a public release, and it is only the units obtaining api that I am making available to public here.
|-
 
!style="width:150px" |Web tag_name
Here is the code (with the api call written using jQuery):
!style="width:600px" |Function
<pre>/*    Some new variables connected with new api call (MX 3.7.0)  */
|-
var tempLetter;  // C or F
|<#OsVersion>
var rainUnit; // mm or in
|OS version, e.g. "Windows 7 x64 build 7600"
var windUnit; // any units in style allowed by Cumulus
|-
/*  The one extra api request included to obtain the units used for temperature, rainfall, and wind speed */
|<#OsLanguage>
$.get('./api/tags/process.json?tempunitnodeg&rainunit&windunit', "limit=1", callUnits);
|OS language, e.g. "English"
function callUnits(unitsObject)
|-
{
|<#SystemUpTime>
tempLetter = unitsObject.tempunitnodeg;
|How long the system has been up, e.g. "8 hours 21 minutes"
rainUnit = unitsObject.rainunit;
|-
windUnit = unitsObject.windunit;
|<#ProgramUpTime>
console.log("new api", tempLetter, rainUnit,windUnit);
|How long Cumulus has been running, e.g. "7 hours 55 minutes"
}</pre>
|-
A little bit of explanation might help:
|<#CpuName>
*JavaScript variables generally need to be declared first, I have used 3 separate line each starting with '''var''', but you can list several variables on one line using a comma to separate them
|CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
*In my script it is important to define these variables outside the function as I will explain later
|-
*The jQuery get request takes the api URL as first parameter and the function to deal with the returned result as third parameter
|<#CpuCount>
*The middle parameter is irrelevant in this context as only one object instance is returned, but if the qet was returning multiple results, "limit=1" would only return the first result
|Number of processors, e.g. "4"
*The function takes as its sole parameter an Object (a JavaScript Object is a collection of properties), this is what is returned by the api, an object can be given any variable name
|-
*In JavaScript if a variable is defined outside the function, then given a value inside the function, that value can be accessed by later code outside the function (in my case by code within the other functions for calculating each derived value)
|<#MemoryStatus>
*We are only interested in 3 of the '''property_name = property_value''' items in the Object.
|Free and total system RAM, e.g. "4619/8191 MB (free/total)"
*The JavaScript '''refinement''' syntax (starts with a dot) can be used to find the value for any parameter we name. We assign the variable already defined to the object and its refinement (that specifies the attribute we want).
|-
*The console.log command simply outputs all the items in the list within the brackets into the browser console that in many browsers is displayed by selecting '''F12''' on the keyboard. I included this instead of the lengthy rest of my code that uses the units to do the various calculations correctly.
|<#DisplayMode>
 
|Screen display mode, e.g. "1680x1050, 32 bit"
=== "POST" approach ===
|-
 
|<#AllocatedMemory>
The word "Post" in a computer environment means that the Hypertext Transfer Protocol (HTTP) used by the internet is being asked to transfer information enclosed in the body of the request message. Put slightly less technically in this approach you produce a text file with the details of what tags you want and send it to the api server.  I suppose it is a bit like sending an email, its header (subject, author, date sent) is easy to view, but you need to open it to see what text is in the body.
|Amount of memory allocated to Cumulus, e.g. "18.76 MB"
 
|-
You may have used POST as an attribute when defining the action of a HTML form. In that context the form is sent as the contents of a message to whatever web page is going to process the contents of that form.  
|<#DiskSize>
|{{Version badge 1}}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==
The post approach has a few advantages over get:
*The parameters are not shown in any query-string, so are not obvious to the person looking over your shoulder, nor do they appear in a history list of sites that the browser has visited.
*If you fill out a form online, the post approach will be used as the content needs to be kept secure.
**The get approach may be seen when you are navigating through a web site, and a selection is being remembered.
*The POST approach can handle very long requests and return a lot of information.
**In contrast, a URL with query-string is restricted in total length (the restriction is dependent on a number of other factors, but might be at something like 1000 characters in total), so GET comes with a restriction on how many parameters can be specified.


{| class="wikitable" border="1"
See https://cumulus.hosiene.co.uk/viewtopic.php?p=145050#p145050 for post example
|-
<br>
!style="width:150px" |Web tag_name
 
!style="width:600px" | Function
<br>
|-
 
|<#LatestError>
=<big>Full List of Tag Names</big> =
|Displays the last error from the Cumulus 1 error log. (The value is cleared when you click the error light in Cumulus 1).<br />
{{Template:WorkInProgressBanner}}
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)


|-
This list only contains the tag_names, don't forget tag_names are only part of the [[#General Format for Web Tags]], for example in a template file you precede the tag name with &lt;, you may need input parameters, you may need output parameters, and you end the full web tag with &gt;.
|<#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.
it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.
|-
 
|<#update>
Here follow tables that group the tag names by the basic purpose of the tags listed. There has been confusion in the past of tags appearing in more than one group, can contributors remove any remaining duplication, so future maintenance is easier.
|The date and time of the last web site update
 
There is a table of contents near the top of the page that you might find useful if you are interested in a particular tag group.
 
==Current Conditions==
 
We start with tags that relate to the latest values, as these are the ones that people most often choose to use. The current condition data is also available, for processes external to Cumulus, by using the inbuilt facility to generate [[Realtime.txt|a file]] with such data.
 
Cumulus software makes current values available for a standard range of sensors where the same web tags apply across a range of weather station models.
 
Both Cumulus 1 and MX offer current values from some [[#Extra Sensors|extra]] temperature and relative humidity sensors (see [[Extra temperatures]]) from particular weather station models.
 
Recently, MX has been developed to support further extra sensors (see [[Extra Sensor Files]] page for full list of fields) and web tags have been added to support equivalent current values only.
 
==== Feels Like ====
 
Feels like temperature was first made available, just for current conditions at MX version 3.5.4.  In version 3.6.0. it was extended to add max/min for each day, each month, each year, and all time. In version 3.6.11 it was added to recent history.
 
 
The figures quoted for this derivative vary between versions:
* The first formula was used from MX version 3.5.4 (25 Apr 2020) build 3075 until version 3.6.7 (4 June 2020) build 3083
* The second formula, which was coded incorrectly, and so gave strange results, applied in versions 3.6.8 to 3.6.9 (build 3084, 3085)
* The third, and hopefully final, formula applies from version 3.6.10 (build 3086).
 
A php script for adding feels like as calculated in version 3.6.10 to any standard log line created either without feels like, or with an older (now incorrect) calculation, can be downloaded from [https://cumulus.hosiene.co.uk/viewtopic.php?f=18&t=18096 Create Missing topic on support forum]. Obviously, this calculates from the small sub-set of current conditions that have been logged, and is not as accurate at deriving maximum and minimum as derivation made as each reading is processed by MX (so including all current conditions).
 
The [[Calculate_Missing_Values#CreateMissing.exe| Create Missing utility]] will not correct the older (incorrectly calculated) figures, but will add Feels Like temperature values to any standard log line created by Cumulus 1, by MX prior to release 3.5.4, or if you have imported lines into the log from an external source.
 
===Standard sensors===
 
The web tags shown here are mainly determined by which appeared on the original "Now" legacy web page (index.htm).
 
Consequently, the totals for 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; although you might expect to find them listed in tables for this month and this year, those web pages do not show these derivatives.
Those listed here cover both measurements obtained from a weather station (like air temperature, wind speed and direction, humidity and barometric pressure); and all the derived values (like humidex, feels like, apparent temperature, wind chill, and heat index).
 
Note however, that the derived values calculated for Cumulus 1 and for MX may not agree because of differences in the calculation formulae, see derived value section within Recent History tags section for examples.
{| class="wikitable" border="1"
|-
|-
|<#LastDataReadT>
!style="width:150px" | Web tag_name
|The date/time data was last read from the station
!style="width:600px" | Function
|-
|-
|<#stationtype>
|colspan="2" style="background:lightgray;"|Temperature
|The weather station [https://cumuluswiki.org/a/Cumulus.ini#Section:_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>
|<#temp>
|The station [http://en.wikipedia.org/wiki/Latitude latitude] (as you entered during setup).
|The outside (air) temperature
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<br />
 
<#latitude> gives "N&nbsp;59& deg;&amp;nbsp;14&amp;#39;&amp;nbsp;33&amp;quot;" for N 59 14 33<br />
For Oregon Scientific models like WMR-200 with USB connection or models like WMR-928 with serial connections, please refer to [[#Web tags mentioning (outside) temperature]] because any of the [[#Extra Sensors: Davis models and Oregon Scientific WMR928, WR100/200|extra sensors]] can be reported in '''<#temp>''', and consequently also have web tags reporting daily extremes and longer period extreme records.
<#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>
|<#intemp>
|The station [http://en.wikipedia.org/wiki/Longitude longitude]  (as you entered during setup). Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
|The inside temperature
|-
|-
|<#altitude>
|<#TempChangeLastHour>
|The station [http://en.wikipedia.org/wiki/Altitude altitude] value (webtag outputs web encoded format containing figure, '&amp;nbsp;' 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&amp;nbsp;m'
|The change in outside temperature over the last hour (not available in early versions of Cumulus  1, when this was announced, a temperature change over 24 hours was also proposed, but never implemented)
|-
|-
|<#location>
|<#temptrend>
|The station location (as you entered during setup)
|The average rate of change in temperature over the last three hours. Trend = (temp_now - temp_3hrs_ago) / 3 (available in all releases, the calculation selected for this trend matches the standard-based calculation for <#presstrendval> despite the naming inconsistency)
|-
|-
|<#longlocation>
|<#temptrendtext>
|Longer description of the station location (as you entered during setup)
|Temperature change over the last three hours - Rising/Falling/Steady (values can be set in strings.ini)
|-
|-
|<#forum>
|<#temptrendenglish>
|URL of the forum (as you entered during setup)
|Temperature change over the last three hours - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed). From version 1.8.8 1st December 2009
|-
|-
|<#webcam>
|<#heatindex>
|URL of the webcam (as you entered during setup)
|Current [[heat index]].  The referenced page in weather terminology section of this Wiki explains it.
|-
|-
|<#graphperiod>
|<#humidex>
|The number of hours displayed by the graphs, as set using '''Configuration''' menu, ''Display'' settings screen 'Detailed Chart Period'
|Current [http://en.wikipedia.org/wiki/Humidex Humidex]
|-
|-
|<#dailygraphperiod>
|<#apptemp>
|The number of days displayed by the graphs, as set using '''Configuration''' menu, ''Display'' settings screen 'Daily Chart Period' (available from build 1098)
|The [[Apparent_temperature|apparent]] temperature.  The referenced page in weather terminology section of this Wiki explains it. The formula used is that defined by BOM. Although at temperatures above 20°C (68°F) Feels like reports an "apparent temperature" it uses a different formula.
|-
|-
|<#currcond>
|<#wchill>
|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
|The current [[wind chill]] temperature.  The referenced page in weather terminology section of this Wiki explains it. For temperatures below 10°C (50°F) Feels like reports the same value.
|-
|<#feelslike>
|[[File:Badge v1.png]] Not available in Cumulus 1.
 
[[File:Badge vMx.png]]Not available in all MX versions. Please see [[#Feels_Like|sub-section before this table]] regarding availability by MX versions if you are using a MX version earlier than 3.6.10.
 
The current [[Feels_Like|Feels Like]] temperature.  The referenced page in weather terminology section of this Wiki explains it.
|-
|-
|<#currcondenc>
|<#IsFreezing>
|The same as <#currcond> but also has all characters above (decimal base)code 159 encoded as HTML entities
|If outside temperature is at or below 0°C/32°F. 0=Above freezing, 1=Below freezing
|-
|-
|<#chillhours>
|<#chillhours>
|The number of [[Heat/cold_degree_days_and_Chill_hours#Chill_Hours_and.2For_Air_Frost|'chill hours']] so far this season (threshold temperature and start date are configurable).
|The number of [[Heat/cold_degree_days_and_Chill_hours#Chill_Hours_and.2For_Air_Frost|'chill hours']] so far this season (threshold temperature and start date are configurable).
|-
|-
|<#ConsecutiveRainDays>
|colspan="2" style="background:lightgray;"|Humidity
|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).
|-
|<#hum>
|The outside [http://en.wikipedia.org/wiki/Humidity humidity]
|-
|-
|<#ConsecutiveDryDays>
|<#inhum>
|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
|The inside humidity
|-
|-
|<#WindRoseData>
|<#dew>
|A comma-separated list of the wind 'totals' used to draw the wind rose (8 or 16 values)
|The current dew point
|-
|-
|<#WindRosePoints>
|<#wetbulb>
|The number of items in <#WindRoseData> (i.e. 8 or 16)
|Estimated [http://en.wikipedia.org/wiki/Wet_bulb wet bulb] temperature, can be seen if hover over 'Dew point' on Cumulus 1 main screen
|-
|-
|<#WindSampleCount>
|colspan="2" style="background:lightgray;"|Rainfall
|The number of wind samples making up the wind rose (etc) data (up to 3600)
|-
|-
|<#LatestNOAAMonthlyReport>
|<#rfall>
|Gives file name of latest auto-saved NOAA monthly report
|The total rainfall so far today (reports rain counter now minus rain counter at start of day), start of day counter can be edited using "edit rain today".
|-
|-
|<#LatestNOAAYearlyReport>
|<#rrate>
|Gives file name of latest auto-saved NOAA yearly report
|The current [[Rain_measurement#Rain_Rate|rainfall rate]]
|}
 
==Units==
 
Apply to Cumulus 1 and MX, no optional input nor output parameters.
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
|<#rhour>
!style="width:600px" | Function
|The rainfall in the last hour
|-
|-
|<#tempunit>
|<#rmidnight>
|Unit of temperature being used (Set in Cumulus as [http://en.wikipedia.org/wiki/Centigrade Celsius] or [http://en.wikipedia.org/wiki/Fahrenheit Fahrenheit]) values "&amp;deg;C" or "&amp;deg;F"
|The total rainfall since midnight. Useful if you don't use midnight as your start of day
|-
|-
|<#tempunitnodeg>
|<#r24hour>
|The temperature units being used, without a degree symbol, i.e. "F" or "C"
| Reading recent history records, takes rain counter for latest minute, and substracts rain counter from as close as possible to same time yesterday (if Cumulus was not running at that time yesterday, but historical catch-up has been enabled, then it is from nearest time available yesterday, so for a logging interval of every 30 minutes might be 24 hours and 16 minutes ago)
|-
|-
|<#pressunit>
|<#LastRainTipISO>
|Unit of measure for pressure. Possible values: "mb", "hPa", "in"
|Fixed ISO format output giving date and time of last rain gauge tip (e.g 2010-09-06 06:09) The format is always as shown (cannot use output format modifiers)
|-
|-
|<#rainunit>
|<#LastRainTip>
|Unit of measure for rain fall. Possible values: "mm" or "inches"
| (available from release 3.6.1) Date/time of last rain gauge tip (default format is as set in locale) '''PLEASE NOTE: this web tag WILL accept any date and time output format modifiers'''
|-
|-
|<#windunit>
|<#MinutesSinceLastRainTip>
|Unit of measure for wind speed. Possible values: "m/s", "mph", "km/h", "kts"
|The number of minutes since the last rain gauge tip, in whole numbers, rounded down
|-
|-
|<#windrununit>
|<#IsRaining>
|Unit of measure for wind run (distance). Possible values: "km", "miles", "km", "nm" (for wind speeds in m/s, mph, km/h, kts)
|For [[Rain_measurement#Optical_Rain_Gauge| Hydreon RG-11 devices]], shows the current rain state. 0=No rain, 1=It's raining
|-
|-
|<#cloudbaseunit>
|<#rmonth>
|The units used for cloudbase value. Possible values:  "ft" or "m"
|The total rainfall so far this month
|}
 
==Date & Time==
Both Cumulus 1 and MX support all of these, most of these web tags can be used with output parameters.
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |Web tag_name
|<#ryear>
!style="width:600px" | Function
|Annual rainfall total for rainfall season year (i.e. starting month as set on Configuration menu, station screen,  Annual rainfall frame)
|-
|-
|<#date>
|<#ConsecutiveRainDays>
|The current date
|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).
|-
|-
|<#time>
|<#ConsecutiveDryDays>
|The current time and date. Example result: 18:30 on 30 December 2009. If you simply wish the time, use next tag (below)
|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
|-
|-
|<#timehhmmss>
|colspan="2" style="background:lightgray;"|Pressure
|The current time. Example format: 18:30:27
|-
|-
|<#timeUTC>
|<#press>
|The current UTC date/time rather than local date/time
|The [http://en.wikipedia.org/wiki/Sea_level_pressure sea level pressure]
|-
|-
|<#day>
|<#presstrendval>
| The current day as a 2-digit number. Example format: 14 
|The average rate of pressure change over the last three hours.  Trend = (pressure_now - pressure_3hrs_ago) / 3    (Fixed from version 1.7.7 5th March 2008)
|-
|-
|<#dayname>
|<#presstrend>
| The current day as a word. For example, Monday
|The pressure trend in words - values can be set in the 'strings.ini' file
|-
|-
|<#shortdayname>
|<#presstrendenglish>
| The current day as a shortened word. Example format: Mon
| a singe word description for the pressure trend - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed). From version 1.8.8 1st December 2009
|-
|-
|<#month>
| <#PressChangeLast3Hours>
|The current month as a 2-digit number. Example format: 05
|[[File:Badge vMx.png]] Available from version 3.11.1
|-
 
|<#monthname>
Total Pressure Change since 3 hours ago
|The current month as a word. Example format: August
|-
|-
|<#shortmonthname>
|<#altimeterpressure>
|The current month as a shortened word. Example format: Aug
|Altimeter pressure. Pressure corrected to sea level using the station's altitude only. Same as sea-level pressure for non-Davis stations.
|-
|-
|<#year>
|colspan="2" style="background:lightgray;"|Wind
|The current year as a 4-digit number. Example format: 2009
|-
|-
|<#shortyear>
|<#wlatest>
|The current year as a 2-digit number. Example format: 09
|Current wind speed reading from console.  Corresponds to 'latest' on the Cumulus main screen.
|-
|-
|<#hour>
|<#bearing>
|The current hour as a 2-digit number. Example format: 23
|Current wind bearing in degrees
|-
|-
|<#minute>
|<#currentwdir>
|The current minute as a 2-digit number. Example format: 59
|Current wind bearing as a compass point - e.g. ESE
|-
|-
|<#metdate>
|<#wspeed>
|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.
|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.
 
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>
|<#avgbearing>
|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. 
|Average wind bearing in degrees over last configured interval minutes. Range 1-360, 0=Calm


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.
This is calculated by taking the wind direction and speed for the last 10 minutes (or other interval as configured), calculates the sums of the North/South and East/West vector components, divides the E/W component sum by the N/S component sum, and takes the arctan.
|-
|-
|<#yesterday>
|<#wdir>
|Yesterdays date
|Average wind bearing over last 10 minutes as a [http://en.wikipedia.org/wiki/Compass compass] point - e.g. ESE
|-
|-
|<#rollovertime>
|<#wgust>
|The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
|The highest wind reading in the last 10 minutes. Corresponds to 'gust' on the Cumulus main screen.
|-
|-
|<#update>
|<#WindSampleCount>
|The date and time of the last web site update
|The number of wind samples making up the wind rose (etc) data (up to 3600)
|-
|-
|<#LastDataReadT>
|<#wdirdata>
|The date/time data was last read from the station
|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:
* Oregon:  x=12 seconds (see https://cumulus.hosiene.co.uk/viewtopic.php?p=37#p37) so 12 hours worth in full array
* Davis:  x=2 or 3 seconds (see https://cumulus.hosiene.co.uk/viewtopic.php?p=37#p37) so 2.5 hours worth in full array
* Fine Offset: Cumulus 1 reads the wind data every minute (although station transmits wind data every 40 seconds), so 60 hours worth in full array
* Davis WLL: x=2.5 seconds (see https://cumulus.hosiene.co.uk/viewtopic.php?p=160900#p160900) so 2.5 hours worth in full array
 
|-
|-
|<#DaysSince30Dec1899>  
|<#wspddata>
|Day count (gives whole and fractional part) Example: 41250.6523310301
|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''' tag. Reading interval x varies by station type (see above).
|-
|-
|<#recordsbegandate>
|<#nextwindindex>
|Date when records began (appears twice on "recordsT.htm" provided, and used to calculate next tag, but ignored for all other Cumulus processing)
|The index of the entries in <#wdirdata> and <#wspddata> that 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!
|-
|-
|<#DaysSinceRecordsBegan>
|<#WindRoseData>
|Day count since Cumulus records started
|A comma-separated list of the wind 'totals' used to draw the wind rose (8 or 16 values)
|}
 
==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.
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
|<#WindRosePoints>
!style="width:600px" | Function
|The number of items in <#WindRoseData> (i.e. 8 or 16), as configured on [[Cumulus_Screenshots#Display_and_Colour_screens_as_at_version_1.9.4|display settings screen]]
|-
|-
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|<#beaufort>
|-
|The current wind speed on the [http://en.wikipedia.org/wiki/Beaufort_scale Beaufort scale] (e.g. F8)
|<#apptemp>
|The [[Apparent_temperature|apparent]] temperature
|-
|-
|<#temp>
|<#beaufortnumber>
|The outside temperature
|The current wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|-
|-
|<#intemp>
|<#beaudesc>
|The inside temperature
|The current wind speed Beaufort description (e.g. "Gale")
|-
|-
|<#temptrend>
|<#BearingRangeFrom>
|The average rate of change in temperature over the last three hours. Trend = (temp_now - temp_3hrs_ago) / 3
|The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in [[Cumulus.ini (Cumulus 1)|cumulus.ini]])
|-
|-
|<#temptrendtext>
|<#BearingRangeTo>
|Temperature change over the last three hours - Rising/Falling/Steady (values can be set in strings.ini)
|The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini)
|-
|-
|<#temptrendenglish>
|<#BearingRangeFrom10>
|Temperature change over the last three hours - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed)
|The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
|-
|-
|<#TempChangeLastHour>
|<#BearingRangeTo10>
|The change in temperature over the last hour
|The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
|-
|-
|<#heatindex>
|colspan="2" style="background:lightgray;"|Miscellaneous
|Current [[heat index]]
|-
|-
|<#humidex>
|<#cloudbase>
|Current [http://en.wikipedia.org/wiki/Humidex Humidex]
|Calculated [http://en.wikipedia.org/wiki/Cloud_base cloud base]
|-
|-
|<#hum>
|<#cloudbasevalue>
|The outside [http://en.wikipedia.org/wiki/Humidity humidity]
|Current calculated cloud base without units
|-
|-
|<#inhum>
|<#UV>
|The inside humidity
|Current [http://en.wikipedia.org/wiki/Uv_index UV index]. Requires your station to have a UV sensor.
|-
|-
|<#dew>
|<#SolarRad>
|The outside dew point
|Current [http://en.wikipedia.org/wiki/Solar_radiation solar radiation]. Requires your station to have a solar sensor.
|-
|-
|<#wchill>
|The current [[wind chill]] temperature
|-
|-
|<#feelslike>
|<#Light>
|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:
|Current Current light level in Lux. Requires your station to have a solar sensor. Only applies to Fine Offset stations.
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>
|[[Forecast_webtag|<#forecast>]]
|Estimated [http://en.wikipedia.org/wiki/Wet_bulb wet bulb] temperature, can be seen if hover over 'Dewpoint' on Cumulus 1 main screen
|The current forecast
|-
|-
|<#IsFreezing>
|<#forecastenc>
|If outside temperature is at or below 0°C/32°F. 0=Above freezing, 1=Below freezing
|The same as <#forecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
|-
|-
|colspan="2" style="background:lightgray;"|Rainfall
| <#forecastJsEnc>
|[[File:Badge vMx.png]] Available from version 3.11.0
The current forecast encoded for JavaScript
|-
|-
|<#rfall>
|<#forecastnumber>
|The total rainfall so far today
|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 [[Forecast_webtag|Cumulus]]: -1 (neg 1) = Exceptional Fine, -26 (neg 26) = Exceptional Bad
|-
|-
|<#rrate>
|<#cumulusforecast>
|The current rainfall rate
|Always gives Cumulus (Zambretti) [[Forecast_webtag|forecast]], even if the <#forecast> tag provides a station forecast
|-
|-
|<#rhour>
|<#cumulusforecastenc>
|The rainfall in the last hour
|The same as <#cumulusforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
|-
|-
|<#rmidnight>
| <#cumulusforecastJsEnc>
|The total rainfall since midnight. Useful if you don't use midnight as your start of day
|[[File:Badge vMx.png]] Available from version 3.11.0
The current  Cumulus (Zambretti) forecast  encoded for JavaScript
|-
|<#wsforecast>
|Always gives station forecast (if available)
|-
|-
|<#r24hour>
|<#wsforecastenc>
|Amount of rain in the last 24 hours
|The same as <#wsforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
|-
|-
|<#LastRainTipISO>
| <#wsforecastJsEnc>
|Fixed ISO format output giving date and time of last rain gauge tip (e.g 2010-09-06 06:09) '''PLEASE NOTE: this web tag does NOT accept any format modifiers'''
|[[File:Badge vMx.png]] Available from version 3.11.0
 
The current  station forecast  encoded for JavaScript
|-
|-
|<#LastRainTip>
|<#currcond>
| (available from release 3.6.1) Date/time of last rain gauge tip (as previous tag, but default format is as set in locale, i.e. Mono or Windows control panel) '''PLEASE NOTE: this web tag WILL accept any date and time output format modifiers'''
|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
|-
|-
|<#MinutesSinceLastRainTip>
|<#currcondenc>
|The number of minutes since the last rain gauge tip, in whole numbers, rounded down
|The same as <#currcond> but also has all characters above (decimal base) code 159 encoded as HTML entities for example this would encode any use of symbol for degree.
|}
 
===Extra Sensors===
 
Some tags are only available for certain builds, if the tables below do not say which releases they apply to, see general tip at top of page to check for the build you are using. In particular Cumulus 1 has fewer channels available in its earlier versions, and the final legacy software version 1.9.4 offers just 42 of the 62 extra sensor web tags available in MX.
 
The extra sensors functionality in Cumulus only supports processing for current spot values as read from the sensors, the only processing is to convert the units ready for output, so only current conditions can be reported in web tags.
 
Periodically spot extra sensor values are logged, see the [[Extra_Sensor_Files]] page for information about log files from where you can extract the past spot values.
 
====Extra Sensors: Davis models and Oregon Scientific WMR928, WR100/200 ====
 
These web tags hold current values for additional sensors supported by Cumulus 1 and MX.
 
For Oregon Scientific model like WMR-200 with USB connection, please refer to [[#Web tags mentioning (outside) temperature]] because any of the extra temperature tags below can be redirected to '''<#temp>''', and consequently also have web tags reporting daily extremes and longer period extreme records.
{| class="wikitable" border="1"
|-
|-
|<#IsRaining>
!style="width:150px"|Web tag_name
|For [[Rain_measurement#Optical_Rain_Gauge| Hydreon RG-11 devices]], shows the current rain state. 0=No rain, 1=It's raining
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in viewer/editor
|-
|-
|<#rmonth>
|<#ExtraTemp1 - 10>
|The total rainfall so far this month
|Extra temperature channel 1 to channel 10
|-
|-
|<#ryear>
|<#ExtraDP1 - 10>
|Annual rainfall total for rainfall season year (i.e. starting month as set on Configuration menu, station screen,  Annual rainfall frame)
|Extra dew point channel 1 to channel 10
|-
|-
|colspan="2" style="background:lightgray;"|Pressure
|<#ExtraHum1 - 10>
|Extra humidity channel 1 to channel 10
|-
|-
|<#press>
|<#SoilTemp1 - 16>
|The [http://en.wikipedia.org/wiki/Sea_level_pressure sea level pressure]
|Soil temperature channel 1 to channel 16
|-
|-
|<#presstrendval>
|<#SoilMoisture1 - 16>
|The average rate of pressure change over the last three hours.
|Soil moisture channel 1 to channel 16
|-
|-
|<#presstrend>
|<#LeafTemp1 - 4>
|The pressure trend in words - values can be set in the 'strings.ini' file
|Leaf temperature channel 1 to channel 4
|-
|-
|<#presstrendenglish>
|<#LeafWetness1 - 4>
| a singe word description for the pressure trend - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed)
|Leaf wetness channel 1 to channel 4
|}
 
====Extra Sensors:  Davis AirLink ====
New from version 3.9.0. Not available for earlier MX, not available for Cumulus 1.
 
Note, that you can configure an Indoor or Outdoor (or both) AirLink, most people will use an outdoor. There are a similar set of tags for each device.
 
{| class="wikitable" border="1"
|-
|-
|<#altimeterpressure>
!style="width:150px" |Web tag_name
|Altimeter pressure. Pressure corrected to sea level using the station's altitude only. Same as sea-level pressure for non-Davis stations.
!style="width:600px" |Function
|-
|-
|colspan="2" style="background:lightgray;"|Wind
|colspan="2" style="background:lightgray;"|Particulate Matter
|-
|-
|<#wlatest>
|<#AirLinkPm1[InǀOut]>
|Current wind speed reading from console.  Corresponds to 'latest' on the Cumulus main screen.
|Current particulate matter of 1 μm, or less count
|-
|-
|<#bearing>
|<#AirLinkPm2p5[InǀOut]>
|Current wind bearing in degrees
|Currentparticulate matter of 2.5 μm, or less, count
|-
|-
|<#currentwdir>
|<#AirLinkPm2p5_1hr[InǀOut]>
|Current wind bearing as a compass point - e.g. ESE
|Last hour average particulate matter of 2.5 μm, or less, count
|-
|-
|<#wspeed>
|<#AirLinkPm2p5_3hr[InǀOut]>
|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.
|Last 3 hours average particulate matter of 2.5 μm, or less, count
|-
|-
|<#avgbearing>
|<#AirLinkPm2p5_24hr[InǀOut]>
|Average wind bearing in degrees over last 10 minutes. Range 1-360, 0=Calm
|Last 24 hours average particulate matter of 2.5 μm, or less, count
|-
|-
|<#wdir>
|<#AirLinkPm2p5_Nowcast[InǀOut]>
|Average wind bearing over last 10 minutes as a [http://en.wikipedia.org/wiki/Compass compass] point - e.g. ESE
|The 24 hour "nowcast" weighted average particulate matter of 2.5 μm, or less, count
|-
|-
|<#wgust>
|<#AirLinkPm10[InǀOut]>
|The highest wind reading in the last 10 minutes. Corresponds to 'gust' on the Cumulus main screen.
|Current particulate matter of 10 μm, or less, count
|-
|<#AirLinkPm10_1hr[InǀOut]>
|Last hour average particulate matter of 10 μm, or less, count
|-
|-
|<#wdirdata>
|<#AirLinkPm10_3hr[InǀOut]>
|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.
|Last 3 hours average particulate matter of 10 μm, or less, count
|-
|-
|<#wspddata>
|<#AirLinkPm10_24hr[InǀOut]>
|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.
|Last 24 hours average particulate matter of 10 μm, or less, count
|-
|-
|<#nextwindindex>
|<#AirLinkPm10_Nowcast[InǀOut]>
|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!
|The 24 hour "nowcast" weighted average particulate matter of 10 μm, or less, count
|-
|-
|<#beaufort>
|colspan="2" style="background:lightgray;"|Air Quality Index Values
|The current wind speed on the [http://en.wikipedia.org/wiki/Beaufort_scale Beaufort scale] (e.g. F8)
|-
|-
|<#beaufortnumber>
|<#AirLinkAqiPm2p5[InǀOut]>
|The current wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|Current particulate matter of 2.5 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#beaudesc>
|<#AirLinkAqiPm2p5_1hr[InǀOut]>
|The current wind speed Beaufort description (e.g. "Gale")
|Last hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#BearingRangeFrom>
|<#AirLinkAqiPm2p5_3hr[InǀOut]>
|The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini)
|Last 3 hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#BearingRangeTo>
|<#AirLinkAqiPm2p5_24hr[InǀOut]>
|The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini)
|Last 24 hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#BearingRangeFrom10>
|<#AirLinkAqiPm2p5_Nowcast[InǀOut]>
|The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
|Last 24 hour "nowcast" weighted average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#BearingRangeTo10>
|<#AirLinkAqiPm210[InǀOut]>
|The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
|Current particulate matter of 10 μm, or less value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|colspan="2" style="background:lightgray;"|Miscellaneous
|<#AirLinkAqiPm10_1hr[InǀOut]>
|Last hour average particulate matter of 10 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#cloudbase>
|<#AirLinkAqiPm10_3hr[InǀOut]>
|Calculated [http://en.wikipedia.org/wiki/Cloud_base cloud base]
|Last 3 hour average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#cloudbasevalue>
|<#AirLinkAqiPm10_24hr[InǀOut]>
|Current calculated cloud base without units
|Last 24 hour average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#UV>
|<#AirLinkAqiPm10_Nowcast[InǀOut]>
|Current [http://en.wikipedia.org/wiki/Uv_index UV index]. Requires your station to have a UV sensor.
|Last 24 hour "nowcast" weighted average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#SolarRad>
|colspan="2" style="background:lightgray;"|Stats Values
|Current [http://en.wikipedia.org/wiki/Solar_radiation solar radiation]. Requires your station to have a solar sensor.
|-
|-
|<#AirLinkPct_1hr[InǀOut]>
|Percentage of possible values that were included in the 1 hour averages
|-
|-
|<#Light>
|<#AirLinkPct_3hr[InǀOut]>
|Current Current light level in Lux. Requires your station to have a solar sensor. Only applies to Fine Offset stations.
|Percentage of possible values that were included in the 3 hour averages
|-
|-
|[[Forecast_webtag|<#forecast>]]
|<#AirLinkPct_24hr[InǀOut]>
|The current forecast
|Percentage of possible values that were included in the 24 hour averages
|-
|-
|<#forecastenc>
|<#AirLinkPct_1hr[InǀOut]>
|The same as <#forecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
|Percentage of possible values that were included in the 24 hour weighted averages
|-
|-
|<#forecastnumber>
|colspan="2" style="background:lightgray;"|Sensor Info
|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>
|<#AirLinkFirmwareVersion[InǀOut]>
|Always gives Cumulus (Zambretti) forecast, even if the <#forecast> tag provides a station forecast
|Shows the AirLink firmware version as a date string.
NOTE: This web tag requires a WeatherLink Pro subscription to work
|-
|-
|<#cumulusforecastenc>
|<#AirLinkTemp[InǀOut]>
|The same as <#cumulusforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
|The sensors internal temperatue value
|-
|-
|<#wsforecast>
|<#AirLinkHum[InǀOut]>
|Always gives station forecast (if available)
|The sensors internal humidity value
|-
|-
|<#wsforecastenc>
|<#AirLinkWifiRssi[InǀOut]>
|The same as <#wsforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
|The sensors WiFi signal strength in dB - anything below -90 is considered very poor.
NOTE: This web tag requires a WeatherLink Pro subscription to work
|}
|}


==Extra Sensors==


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.
====Extra Sensors: Ecowitt====
 
Ecowitt stations are sold under other names depending on nation,  e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in same way as Fine Offset is used as a generic name for stations sold under a variety of branding, in this Wiki.
 
[[File:Badge v1.png]]Not available in Cumulus 1.
 
=====Extra Sensors: Ecowitt WH45 CO₂ sensor=====
 
[[File:Badge vMx.png]] Unless otherwise indicated these web tags become available from release 3.9.5.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px"|Web tag_name
!style="width:150px" |Web tag_name
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown on Cumulus screens
!style="width:600px" |Function
|-
|-
|<#ExtraTemp1>
| <#CO2>
|Extra temperature channel 1
| The actual CO<small>2</small>concentration in ppm
|-
|-
|<#ExtraTemp2>
| <#CO2-pm2p5>
|Extra temperature channel 2
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<small>3</small> or less
|-
|-
|<#ExtraTemp3>
| <#CO2-pm2p5-24h>
|Extra temperature channel 3
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<small>3</small>, or less, 24 hours moving average
|-
|-
|colspan="2"|... and so on up to <#ExtraTemp10> = Extra temperature channel 10
| <#CO2-pm10>
| Air Quality expressed in terms of particulate matter of 10 μm/m<small>3</small>, or less (yes, this includes the 2.5 figure)
|-
|-
|<#ExtraDP1>
| <#CO2-pm10-24h>
|Extra dew point channel 1
| Air Quality expressed in terms of particulate matter of 10 μm/m<small>3</small>, or less, 24 hours moving average
|-
|-
|<#ExtraDP2>
| <#CO2-temp>
|Extra dew point channel 2
| Temperature as reported by Air Quality monitor.
 
Note that this temperature has nothing to do with the temperature as reported by the main weather station. It reflects the temperature of the sensor and would be used in combination with the sensors measured humidity (see next) for correction of the measured PM (particulate matter) value. Determination of how to correct the PM value is highly dependent on the conditions and placement of the sensor. See the specification sheet for the sensor or create some multivariate regression line based on calibration measurements. This is also valid for PM sensors like the AirLink. The normal amateur usage of PM sensors is that the uncorrected values are published.
|-
|-
|<#ExtraDP3>
| <#CO2-hum>
|Extra dew point channel 3
| Relative Humidity as reported by Air Quality monitor
|}
 
=====Extra Sensors: Ecowitt WH34 soil and water sensor=====
 
Cumulus MX can support the Ecowitt WH34 (other model types exist and are reported here as if WH34) soil and water temperature sensors.
 
They are reported as "User Temperture 1" to "User Temperature 8", as listed in the table within next sub-section.
 
 
=====Extra Sensors: Ecowitt Air quality, leak sensors, lighting detector, and extra temperature sensors=====
 
[[File:Badge v1.png]] Not available in Cumulus 1.
 
[[File:Badge vMx.png]] Please see release announcements for when individual web tags became available
 
This sub-section applies only to those using Ecowitt GW1000 (also Froggit DS1500, and other equivalents, see [[Supported Devices]]) an interface unit that picks up various external sensors and sends the data via an application programming interface to MX which then generates the following web tags:
{| class="wikitable" border="1"
|-
|-
|colspan="2"|... and so on up to <#ExtraDP10>
!style="width:150px" |Web tag_name
!style="width:600px" |Function
|-
|-
|<#ExtraHum1>
|<#GW1000FirmwareVersion>
|Extra humidity channel 1
|GW1000 firmware version string
|}
 
 
{| class="wikitable" border="1"
|-
|-
|<#ExtraHum2>
!style="width:150px"|Web tag_name
|Extra humidity channel 2
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in the viewer/editor
|-
|-
|<#ExtraHum3>
|<#AirQuality1>
|Extra humidity channel 3
| Air quality in μm/m<small>3</small> or less
|-
|-
|colspan="2"|... and so on up to <#ExtraHum10>
|<#AirQuality2>
| Air quality in μm/m<small>3</small> or less
|-
|-
|<#SoilTemp1>
|colspan="2"|... and so on up to <#AirQuality4>
|Soil temperature 1
|-
|-
|<#SoilTemp2>
|<#AirQualityAvg1>
|Soil temperature 2
| 24 hr running average Air quality in μm/m<small>3</small> or less
|-
|-
|colspan="2"|... and so on up to <#SoilTemp16>
|<#AirQualityAvg2>
| 24 hr running average Air quality in μm/m<small>3</small> or less
|-
|-
|<#SoilMoisture1>
|colspan="2"|... and so on up to <#AirQualityAvg4>
|Soil moisture 1
|-
|-
|<#SoilMoisture2>
|<#LeakSensor1>
|Soil moisture 2
|Leak sensor 1 - returns false/true as 0 or 1  
|-
|colspan="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)
|-
|colspan="2"|... and so on up to <#AirQuality4>
|-
|-
|<#LeakSensor1>
|<#LeakSensor2>
|Leak sensor - 0 or 1 (currently only GW1000 stations with MX)
|Leak sensor 2 - returns false/true as 0 or 1  
|-
|-
|colspan="2"|... and so on up to <#LeakSensor4>
|colspan="2"|... and so on up to <#LeakSensor4>
|-
|-
|<#LightningDistance>
|<#LightningDistance>
|Distance to last strike (same units as wind run - miles/km/nm)
|Distance to last strike (same units as wind run - miles/km/nm) (Returns 0.0 if you don't have a sensor, GW1000 api returns max value you can put in a byte - 0xFF which translates to 158.4 miles = 255 km if have sensor but no strike detected yet, so MX translates that to '----')
(currently only GW1000 stations with MX)
|-
|-
|<#LightningTime>
|<#LightningTime>
|Time of last strike (format customisable)
|Date and Time of last strike (default without output parameters is locale's short time format e.g. 18:02 or 6:02 pm, without date, but tag accepts both date and time output parameters). Returns '----' if you don't have sensor or there has not been a strike since the sensor was installed. (GW1000 api returns FFFF FFFF seconds after midnight on 01 Jan 1970, which translates to 07/02/2106 06:28:15, so MX translates that to '----')
(currently only GW1000 stations with MX)
|-
|-
|<#LightningStrikesToday>
|<#LightningSrikesToday>
|Number of strikes since midnight
|Number of lighting strikes today
(currently only GW1000 stations with MX)
|-
|-
|<#UserTemp1>  
|<#UserTemp1>  
|User Temperature 1
|User Temperature 1
support for the new Ecowitt WH34 soil and water temperature sensors
(currently only GW1000 stations with MX)
|-
|-
|colspan="2"|... and so on up to <#UserTemp8> = User temperature 8
|colspan="2"|... and so on up to <#UserTemp8> = User temperature 8
Line 1,044: Line 881:
==Recent History==
==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.
Please refer to the [[Recent history]] page for full information about using the tags in the following two tables, as material once on this page has been moved there.  


(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).
===Using input/output modification parameters with recent history tag names===


=== Input Parameters ===
'''All tag names listed below, require the mandatory input modification parameters specified in this table.'''
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.
The optional output modification parameters available are as specified in this table, depending on tag name:
{| class="wikitable" border="1"
|-
!style="width:150px" | Tag names
!style="width:200px" | Mandatory Input Modification Parameters
!style="width:200px" | Optional Output Modification Parameters
|-
| <#RecentTS> (see [[#Table of Recent History tag names available]])
| Mandatory parameters as table at [[Webtags/Parameters#Input_modification_Parameters]]
| Optional parameters to modify the time format described in tables starting at [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates]]
|-
| All other tag names in [[#Available in 1.9.3, 1.9.4, and all MX releases]] and [[#Available in MX only]]
| Mandatory parameters as table at [[Webtags/Parameters#Input_modification_Parameters]]
| Whether you can modify the way these values are output depends on release you are using:
* From release 3.10.5: Please see tables at [[Webtags/Parameters#Output_Modification_Parameter_for_changing_any_decimal_comma_into_a_decimal_point]] and [[Webtags/Parameters#Controlling_the_number_of_decimal_places]]
* For legacy Cumulus, and earlier MX releases, no output format modification parameters are available, instead see [[#No_Commas]] section on this page.
|}


All values supplied for parameters must be whole numbers.
=== Table of Recent History tag names available ===


If you don't supply any parameters, the result is undefined for Cumulus 1, and an illegal web tag for MX.  
One tag name is available since 1.9.3 to report the time associated with values you request. 


<#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>).
Although as [[Recent history]] page explains, the history is intended to cover every minute in last 7 days, some entries may be at less frequent intervals, and when clocks change some entries will be missing altogether.
 
{| class="wikitable" border="1"
<#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.
 
 
=== 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 Recent History web tags available ===
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
!style="width:150px" | Web tag_name
!style="width:600px" | Function  
!style="width:600px" | Function  
!style="width:600px" | Parameters example
!style="width:600px" | Parameters example
|-
|colspan="3" style="background:lightgray;"|Time-stamp tag
|-
|-
|<#RecentTS>
|<#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
|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
|<#RecentTS h=3 m=1 format="HH:nn"> for cumulus 1; <#RecentTS h=3 m=1 format="HH:mm"> for cumulus MX
|}
====Available in 1.9.3, 1.9.4, and all MX releases====
{| class="wikitable" border="1"
|-
!style="width:150px" | Tag_name
!style="width:600px" | Function
!style="width:600px" | Input Modification Parameters example
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity tags
|-
|-
|<#RecentOutsideTemp>
|<#RecentOutsideTemp>
Line 1,090: Line 937:
| <#RecentOutsideTemp h=3 m=1>&nbsp;<#tempunit> will display the temperature at the start of the period for which <#temptrend> is calculated
| <#RecentOutsideTemp h=3 m=1>&nbsp;<#tempunit> will display the temperature at the start of the period for which <#temptrend> is calculated
|-
|-
|<#RecentWindSpeed>
|<#RecentWindChill>
|Wind Speed
|Wind Chill
| <#RecentWindSpeed m=10> will display the wind speed 10 minutes ago
| <#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
|-
|-
|<#RecentWindGust>
|<#RecentHeatIndex>
|Wind Gust
|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)
|-
|colspan="3" style="background:lightgray;"|Wind <br>(Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings see [[Wind measurement]])
|-
|<#RecentWindSpeed>
|Wind Speed
| <#RecentWindSpeed m=10> will display the average wind speed 10 minutes ago
|-
|<#RecentWindGust>
|Wind Gust
 
(reports maximum gust from build 1088 of version 1.9.4)
(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
| <#RecentWindGust d=1 m=1> will report the wind gust at approximately the same time yesterday
|-
|-
|<#RecentWindLatest>
|<#RecentWindLatest>
|Wind Latest. Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings
|Wind Latest.  
| 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)
| 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)
|-
|-
Line 1,112: Line 977:
|<#RecentWindAvgDir d=6> will say what the calculated average wind direction was at this time at the start of the week
|<#RecentWindAvgDir d=6> will say what the calculated average wind direction was at this time at the start of the week
|-
|-
|<#RecentWindChill>
|colspan="3" style="background:lightgray;"|Pressure
|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>
|<#RecentPressure>
|Sea-level Pressure
|Sea-level Pressure
| <#RecentPressure h=3 m=1> gives the sea level pressure when <#presstrendval> started tracking the pressure
| <#RecentPressure h=3 m=1> gives the sea level pressure when <#presstrendval> started tracking the pressure
|-
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#RecentRainToday>
|<#RecentRainToday>
|Daily rain total from last roll-over to specified time
|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)
| 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)
|-
|colspan="3" style="background:lightgray;"|Solar & UV
|-
|-
|<#RecentSolarRad>
|<#RecentSolarRad>
Line 1,145: Line 1,000:
|}
|}


====Available in MX only====


=== Other weather derivatives ===
Please note this section has NOT yet been updated for recent MX releases, it appears from [[cumulusmx.db|RecentData table in cumulusmx.db]] that the list here is not complete for MX. However, no release announcement has been found listing tag names not shown here (i.e. apparent temperature, indoor temperature and humidity, air quality)
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.
<pre>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;
}</pre>
 
==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' (24 hour clock notation without leading zero for hour) 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).
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
!style="width:150px" | tag_name
!style="width:450px" | Function
!style="width:150px" | Introduced
!style="width:150px" | Time tag_name
!style="width:600px" | Function  
!style="width:600px" | Input Modification Parameters example
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Indoor Temperature & Humidity tags
|-
|-
|<#tempTH>
|colspan="4" | (to do)
|Today's highest temperature
|<#TtempTH>
|-
|-
|<#tempTL>
|colspan="4" style="background:lightgray;"|Outdoor Temperature & Humidity tags
|Today's lowest temperature
|<#TtempTL>
|-
|-
|<#avgtemp>
|<#RecentWindChill>
|The [[Average_temperature|average]] temperature so far today (calculated from all temperature readings processed by Cumulus)
| Legacy Cumulus version 1.8.5
|n/a
|Wind Chill  (if temperature is below 10°C or 50 °F, then the new Feels Like now available in MX (next item) will report this same value).
| <#RecentWindChill d=48 m=1> reports the wind chill temperature 2 days ago
|-
|-
|<#temprange>
|<#RecentFeelsLike>
|The temperature range (<#tempTH> - <#tempTL>) so far today (Cumulus calculates all these tags using Celsius values, but outputs them in your chosen units)
| Available from version 3.6.11 (build 3087) onwards.
|n/a
| Feels Like Temperature
| <#RecentFeelsLike h=12 m=1> reports the feel like temperature 12 hours ago
|-
|-
|<#apptempTH>
|<#RecentHumidex>
|Today's high apparent temperature
| Available from version 3.7.0 (build 3089) onwards.
|<#TapptempTH>
| Canadian Humidity Index (humidex) Dimensionless - no units
| <#RecentHumidex h=3> reports humidex 3 hours ago
|-
|-
|<#apptempTL>
|colspan="4" style="background:lightgray;"|Air Quality tags
|Today's low apparent temperature
|}
|<#TapptempTL>
 
== System ==
 
Special tags returning information about the Windows device hosting Cumulus 1.
 
[[File:Badge vMx.png]]''If you are running MX, then most tags do not work.''
 
{| class="wikitable" border="1"
|-
|-
|<#feelslikeTH>
!style="width:150px" |Web tag_name
|[[File:Badge vMx.png]] Available from version 3.6.0 Today's high feels like temperature
!style="width:150px" |Applicability
|<#TfeelslikeH>
!style="width:600px" |Function
|-
|-
|<#feelslikeL>
|<#OsVersion>
|[[File:Badge vMx.png]] Available from version 3.6.0 Today's low feels like temperature
|up to 1.9.4, and MX
|<#TfeelslikeL>
|OS version, e.g. "Windows 7 x64 build 7600"
 
Please note this may not return the information you expect!
|-
|-
|<#heatindexTH>
|<#OsLanguage>
|Today's high heat index
|Both leagacy and MX
|<#TheatindexTH>
|OS language, e.g. "English"
|-
|-
|<#wchillTL>
|<#SystemUpTime>
|Today's greatest wind chill (i.e. lowest temperature, highest wind speed)
| (not available on MX)
|<#TwchillTL>
 
[[File:Badge v1.png]] only in legacy Cumulus
|How long the system has been up, e.g. "8 hours 21 minutes"
|-
|-
|<#dewpointTH>
|<#ProgramUpTime>
|Today's highest dew point
|all releases
|<#TdewpointTH>
|How long Cumulus has been running, e.g. "7 hours 55 minutes"
|-
|-
|<#dewpointTL>
|<#CpuName>
|Today's lowest dew point
| (not available on MX)
|<#TdewpointTL>
 
[[File:Badge v1.png]] only in legacy Cumulus
|CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
|-
|-
|<#humTH>
|<#CpuCount>
|Today's highest humidity
| (not available on MX)
|<#ThumTH>
 
[[File:Badge v1.png]] only in legacy Cumulus
|Number of processors, e.g. "4"
|-
|-
|<#humTL>
|<#MemoryStatus>
|Today's lowest humidity
| (not available on MX)
|<#ThumTL>
 
[[File:Badge v1.png]] only in legacy Cumulus
|Free and total system RAM, e.g. "4619/8191 MB (free/total)"
|-
|-
|colspan="3" style="background:lightgray;"|Precipitation
|<#DisplayMode>
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|Screen display mode, e.g. "1680x1050, 32 bit"
|-
|-
|<#rrateTM>
|<#AllocatedMemory>
|Today's maximum rain rate
| (not available on MX)
|<#TrrateTM>
 
[[File:Badge v1.png]] only in legacy Cumulus
|Amount of memory allocated to Cumulus, e.g. "18.76 MB"
|-
|-
|<#hourlyrainTH>
|<#DiskSize>
|Today's highest hourly rain
| (not available on MX)
|<#ThourlyrainTH>
 
[[File:Badge v1.png]] only in legacy Cumulus
|Size of disk on which Cumulus is running, e.g. "931.51 GB"
|-
|-
|<#RG11RainToday>
|<#DiskFree>
|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
| (not available on MX)
| n/a
 
[[File:Badge v1.png]] only in legacy Cumulus
|Free space on disk on which Cumulus is running, e.g. "515.36 GB"
|}
 
== Miscellaneous ==
 
All tags are available in all flavours, as far as I know, although ''their output might vary'', and which input/output parameters they permit might vary between Cumulus 1 and MX.
 
{| class="wikitable" border="1"
|-
|-
|<#snowfalling>
!style="width:150px" |Web tag_name
|Returns 1 if there is an entry in the Weather Diary for Today and the Snow Falling check box is ticked. Returns 0 otherwise.
!style="width:900px" | Function
{{Version badge 1}} Not available in Cumulus 1.
[[File:Badge vMx.png]] Available from version 3.1.1 - build 3054.
|-
|-
|<#snowdepth>
|<#LatestError>
|If there is an entry in the Weather Diary for Today, returns the value set there. Returns 0 otherwise.
|Displays the last error from the Cumulus 1 error log. (The value is cleared when you click the error light in Cumulus 1).<br />
{{Version badge 1}} 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.
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).
[[File:Badge vMx.png]] Available from version 3.1.1 - build 3054 when weather diary editor was added to MX
|-
|-
|<#snowlying>
|<#LatestErrorDate>
|Returns 1 if there is an entry in the Weather Diary for Today and the Snow Lying check box is ticked. Returns 0 otherwise.
|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
{{Version badge 1}}Although this tag is not available in Cumulus 1, you can check if <#snowdepth> is non zero for same answer
[[File:Badge vMx.png]] Available from version 3.1.1 - build 3054
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|<#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
|-
|-
|<#pressTH>
|<#ErrorLight>
|Today's highest pressure reading
|1 if the 'error' light is flashing, 0 if not
|<#TpressTH>
|-
|-
|<#pressTL>
|<#version>
|Today's lowest pressure reading
|The version of Cumulus in use e.g. '1.9.4' or '3.4.1'
|<#TpressTL>  
|-
|<#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)
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|<#NewBuildAvailable>
|'''Only available from release 3.7.0''' onwards, it is checked on start-up and once a day thereafter at a random time
*Returns a boolean value
**0 - MX running the latest build available
**1 - MX is running an earlier build that the latest public release
|-
|-
|<#windTM>
|<#NewBuildNumber>
|Today's maximum (average) wind speed
|'''Only available from release 3.7.0''' onwards, it is checked on start-up and once a day thereafter at a random time
|<#TwindTM>
 
Displays the latest public release build number - eg. b3089
|-
|-
|<#wgustTM>  
|<#realtimeinterval>
|Today's maximum wind gust
|The real time update interval in seconds (integer)
|<#TwgustTM>
|-
|-
|<#bearingTM>
|<#interval>
|The wind bearing at the time of today's high gust (<#wgustTM>) in degrees
|The web site update interval in minutes (integer)
|<#TwgustTM>
|-
|-
|<#Tbeaufort>  
|<#rollovertime>
|Today's highest wind speed, expressed in the Beaufort scale
|The time that the logs rollover to the next day: will always return one of these: 'Midnight', '9 am' or '10 am'
|<#TwindTM>
 
This is the end of the meteorological day, so if during Daylight Saving Time rolover is at "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.
|-
|-
|<#Tbeaufortnumber>
|<#update>
|Today's high wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|The date and time of the last web site update. The default format of the output depends on your locale settings.
|<#TwindTM>
|-
|<#windrun>
|The total wind run so far today
|N/A
|-
|-
|<#domwindbearing>
|<#LastDataReadT>
|Today's dominant wind direction in degrees
|The date/time data was last read from the station. The default format of the output depends on your locale settings.
|n/a
|-
|-
|<#domwinddir>
|<#stationtype>
|Today's dominant wind direction as compass point
|The weather station [https://cumuluswiki.org/a/Cumulus.ini#Section:_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).
|n/a
|-
|-
|<#Tbeaudesc>
|<#latitude>
|Beaufort 'description' for today's high wind speed
|The station [http://en.wikipedia.org/wiki/Latitude latitude] (as you entered during setup).
|n/a
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<br />
<#latitude> gives "N&nbsp;59& deg;&amp;nbsp;14&amp;#39;&amp;nbsp;33&amp;quot;" for N 59 14 33<br />
<#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.
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
| <#latitudeJsEnc>
|[[File:Badge vMx.png]] Available from version 3.11.0
 
JavaScript encoded of previous web tag that is HTML encoded
|-
|-
|<#ET>
|<#longitude>
|Today's [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration]. Applies only to Davis stations, equipped with a solar sensor.
|The station [http://en.wikipedia.org/wiki/Longitude longitude] (as you entered during setup). Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
"The ET value provided to Cumulus by the console and/or DLL is buggy and unreliable. It often shows a negative value. See [[FAQ#It.27s_January_1st_and_my_.27rain_since_midnight.27_and.2For_.27last_24_hours_rain.27_and.2For_Evapotranspiration_are_wrong.2Fnegative|this FAQ]]."
|N/A
|-
|-
|<#heatdegdays>
| <#longitudeJsEnc>
|Today's [[Heat/cold_degree_days_and_Chill_hours|heating degree days]]
|[[File:Badge vMx.png]] Available from version 3.11.0
|n/a
 
JavaScript encoded of previous web tag that is HTML encoded
|-
|-
|<#cooldegdays>
|<#altitude>
|Today's [[Heat/cold_degree_days_and_Chill_hours|cooling degree days]]
|The station [http://en.wikipedia.org/wiki/Altitude altitude] value (web tag outputs web encoded format containing figure, '&amp;nbsp;' and units) in either feet or metres just as you entered during setup (so it is more complex to extract number for script arithmetic); e.g. '123&amp;nbsp;m'
|n/a
|-
|-
|<#solarTH>
| <#altitudenoenc>
|Today's high solar radiation value (Solar sensor needed)
|[[File:Badge vMx.png]] Available from version 3.11.0
|<#TsolarTH>
 
JavaScript encoded of previous web tag that is HTML encoded
|-
|-
|<#UVTH>
|<#location>
|Today's high UV Index (UV sensor needed)
|The station location (as you entered during setup)
|<#TUVTH>
|-
|-
|}
| <#locationJsEnc>
|[[File:Badge vMx.png]] Available from version 3.11.0


==Yesterday==
JavaScript encoded of previous web tag that is plain text
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!
|-
| <#locationenc>
|[[File:Badge vMx.png]] Available from version 3.10.3


Many of these web tags are used on the supplied yesterdayT.htm template, and the supplied todayyest.html page within the MX user interface.
HTML encoded version of previous web tag that is JavaScript encoded
|-
|<#longlocation>
|Longer description of the station location (as you entered during setup)
|-
| <#longlocationJsEnc>
|[[File:Badge vMx.png]] Available from version 3.11.0


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'.
JavaScript encoded of previous web tag that is plain text
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
| <#longlocationenc>
!style="width:450px" | Function
|[[File:Badge vMx.png]] Available from version 3.10.3
!style="width:150px" | Time
 
HTML encoded version of previous web tag that is JavaScript encoded
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|<#forum>
|URL of the forum (as you entered during setup) encoded into a web page menu item by adding colons
For Cumulus 1, this defaults to a Sandaysoft URL that is no longer available, for MX this defaults to the current support forum  (web server site hosted by "Freddie")
|-
|-
|<#tempYH>
| <#forumurl>
|Yesterday's highest temperature
|[[File:Badge vMx.png]] Available from version 3.10.0
|<#TtempYH>
 
Same as previous, but just URL, without any additional colons
|-
|-
|<#tempYL>
|<#webcam>
|Yesterday's lowest temperature
|URL of the webcam (as you entered during setup) encoded into a web page menu item by adding colons. Default is blank. Can be used to link to any other web page that you host (Cumulus does not verify that it is a web can, that is just a label, and the label can be changed on each standard web page individually)
|<#TtempYL>
|-
|-
|<#avgtempY>
| <#webcamurl>
|Yesterday's average temperature
|[[File:Badge vMx.png]] Available from version 3.10.0
|n/a
 
Same as previous, but just URL, without any additional colons
|-
|-
|<#temprangeY>
|<#graphperiod>
|The temperature range (max - min) yesterday
|The number of hours displayed by the graphs, as set using '''Configuration''' menu, ''Display'' settings screen 'Detailed Chart Period'
|n/a
|-
|-
|<#apptempYH>
|<#dailygraphperiod>
|Yesterday's high apparent temperature
|The number of days displayed by the graphs, as set using '''Configuration''' menu, ''Display'' settings screen 'Daily Chart Period' (available from build 1098)
|<#TapptempYH>
|-
|-
|<#apptempYL>
|<#LatestNOAAMonthlyReport>
|Yesterday's low apparent temperature
|Gives file name of latest auto-saved NOAA monthly report
|<#TapptempYL>
|-
|-
|<#feelslikeYH>
|<#LatestNOAAYearlyReport>
|Yesterday's high feels like temperature
|Gives file name of latest auto-saved NOAA yearly report
|<#TfeelslikeYH>
|-
|-
|<#feelslikeYL>
|colspan="2" style="background:lightgray;"|Options
|Yesterday's low feels like temperature
 
|<#TfeelslikeYL>
[[File:Badge vMx.png]] Available from version 3.10.0
|-
|-
|<#heatindexYH>
| <#Option_useApparent>
|Yesterday's high heat index
| Whether user prefers to see Apparent Temperature or Feels Like Temperature
|<#TheatindexYH>
|-
|-
|<#wchillYL>
| <#Option_showSolar>
|Yesterday's greatest wind chill (i.e. lowest temperature)
| Whether user wants to show Solar data or does not not have a solar sensor
|<#TwchillYL>
|-
|-
|<#dewpointYL>
| <#Option_showUV>
|Yesterday's lowest dew point
| Whether user wants to show Ultra Violet data or does not not have a UV sensor
|<#TdewpointYL>
|}
 
==Units==
 
Apply to Cumulus 1 and MX, no optional input nor output parameters.
{| class="wikitable" border="1"
|-
|-
|<#dewpointYH>
!style="width:150px" | Web tag_name
|Yesterday's highest dew point
!style="width:600px" | Function
|<#TdewpointYH>
|-
|-
|<#humYH>
|<#tempunit>
|High humidity yesterday
|Unit of temperature being used (Set in Cumulus as [http://en.wikipedia.org/wiki/Centigrade Celsius] or [http://en.wikipedia.org/wiki/Fahrenheit Fahrenheit]) values "&amp;deg;C" or "&amp;deg;F"
|<#ThumYH>
|-
|-
|<#humYL>
| <#tempunitnoenc>
|Low humidity yesterday
|[[File:Badge vMx.png]] Available from version 3.11.0
|<#ThumYL>
 
JavaScript encoded of previous web tag that is HTML encoded (i.e. without '''&amp;''' and without '''&deg;''')
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|<#tempunitnodeg>
|The temperature units being used, without a degree symbol, i.e. "F" or "C"
|-
|-
|<#rfallY>
|<#pressunit>
|The total rainfall for yesterday according to the connected weather station
|Unit of measure for pressure. Possible values: "mb", "hPa", "in"
|n/a
|-
|-
|<#RG11RainYest>
|<#rainunit>
|The total rainfall for yesterday according to an RG-11 rain sensor configured in "Tipping Bucket" mode
|Unit of measure for rain fall. Possible values: "mm" or "inches"
|n/a
|-
|-
|<#rrateYM>
|<#windunit>
|Yesterday's maximum rain rate
|Unit of measure for wind speed. Possible values: "m/s", "mph", "km/h", "kts"
|<#TrrateYM>
|-
|-
|<#hourlyrainYH>
|<#windrununit>
|Yesterday's highest hourly rain
|Unit of measure for wind run (distance). Possible values: "km", "miles", "km", "nm" (for wind speeds in m/s, mph, km/h, kts)
|<#ThourlyrainYH>
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|<#cloudbaseunit>
|The units used for cloudbase value. Possible values:  "ft" or "m"
|}
 
==Date & Time==
Both Cumulus 1 and MX support all of these, except where marked as MX only, most of these web tags can be used with output parameters.
{| class="wikitable" border="1"
|-
|-
|<#pressYH>
!style="width:150px" |Web tag_name
|Yesterday's highest pressure reading
!style="width:600px" | Function
|<#TpressYH>
|-
|-
|<#pressYL>
|<#date>
|Yesterday's lowest pressure reading
|The current date - format depends on locale you use to run Cumulus
|<#TpressYL>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|<#metdate>
|The current meteorological date. The default format depends on the locale you use to run Cumulus
*If you use midnight rollover, this returns same date as <#date> (above), but with a different default format.
*If using a 9am/10am rollover:
**After rollover time on current calendar date,  this is same as <#date>, but with a different default format.
**Between midnight and 9am/10am the <#metdate> will return the date associated with previous calendar day, but will still return current time 
 
Legacy website: Can be used with relevant format parameters to [[Customised templates|customise]] '''todayT.htm''' template page to display current meteorological day, to customise '''thismonthT.htm''' template page to display meteorological month, and to customise '''thisyearT.htm''' template page to display correct meteorological year. This will be particularly useful on first and last day of month/year when rollover happens at 9 (or 10) a.m. and the month (and maybe year) is different before and after rollover.
 
[[File:Badge vMx.png]] Earlier MX releases provide a similar web template set, so these can be customised in same way as for legacy Cumulus above (but note capital "M" must be used for any month formatting). From release 3.10.1 the supplied web pages are web server based, there are no web templates to customise, and the supplied '''.json files''' do not include any meteorological date functionality.
|-
|-
|<#windYM>
|<#timeUTC>
|Yesterday's maximum (average) wind speed
|The current UTC date/time rather than local date/time.  Example result (actual format depends on locale settings): 18:30 on 30 December 2009. If you want the local date and time, use next tag (below).
|<#TwindYM>
|-
|-
|<#wgustYM>  
|<#time>
|Yesterday's maximum wind gust
|The current time and date. Example result (actual format depends on locale settings): 18:30 on 30 December 2009.  If you simply wish the time, use next tag (below).
|<#TwgustYM>
|-
|-
|<#bearingYM>
|<#timehhmmss>
|The wind bearing at the time of yesterday's high gust
|The current time (without date). Example format: 18:30:27. You can use output format specifiers to change the way the time is output, but any date specifiers are ignored.
|<#TwgustYM>
|-
|-
|<#Ybeaufort>
|<#minute>
|Yesterday's highest wind speed, expressed in the Beaufort scale
|The current time, just the minutes. Fixed format: 07 (cannot use output format modifiers)
|<#TwindYM>
|-
|-
|<#Ybeaufortnumber>
|<#hour>
|Yesterday's high wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|The current time, just the hour. Fixed format: 07 (cannot use output format modifiers)
|<#TwindYM>
|-
|-
|<#Ybeaudesc>
|<#day>
|Beaufort 'description' for yesterday's high wind speed
| The current day as a 2-digit number. Fixed format: 07  (cannot use output format modifiers)
|n/a
|-
|-
|<#domwindbearingY>
|<#dayname>
|Yesterday's dominant wind direction in degrees
| The current day as a word.  For example, Monday  (actual format depends on locale settings)
|n/a
|-
|-
|<#domwinddirY>
|<#shortdayname>
|Yesterday's dominant wind direction as compass point
| The current day as a shortened word. Example format: Mon
|n/a
|-
|-
|<#windrunY>
|<#month>
|The total wind run for yesterday
|The current month as a 2-digit number. Fixed format: 07 (cannot use output format modifiers)
|n/a
|-
|<#monthname>
|The current month as a word. Example format: July
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|<#shortmonthname>
|The current month as a shortened word. Example format: Jul
|-
|-
|<#heatdegdaysY>
|<#year>
|Yesterday's [[Heat/cold_degree_days_and_Chill_hours|heating degree days]]
|The current year as a 4-digit number. Example format: 2009  (cannot use output format modifiers)
|n/a
|-
|-
|<#cooldegdaysY>
|<#shortyear>
|Yesterday's [[Heat/cold_degree_days_and_Chill_hours|cooling degree days]]
|The current year as a 2-digit number. Example format: 09 (cannot use output format modifiers)
|n/a
|-
|-
|<#solarYH>
|<#rollovertime>
|Yesterday's high solar radiation value (Solar sensor needed)
|The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
|<#TsolarYH>
 
PHP code example for testing whether before or after rollover given in next entry.
|-
|-
|<#UVYH>
|<#metdateyesterday>
|Yesterday's high UV Index (UV sensor needed)  
|The previous meteorological date.  The default format depends on the locale you use to run Cumulus
|<#TUVYH>
*If you use midnight rollover, this returns same date as <#date>, but with a different default format.
|}
*If using a 9am/10am rollover:
**After rollover time on current calendar date,  this is same as <#yesterday> (below), but with a different default format.
**Between midnight and 9am/10am the date output by <#metdateyesterday> will be the calendar day before that returned by <#yesterday>, but the time returned is actual local time. 


==Monthly==
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.
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 [[#Current_Conditions|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 [[#Time.2FDate_.27format.27_Parameter|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.
if you use PHP Hypertext preprocessor, you can output different text for before and after rollover, e.g.
 
<pre><?php
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.
if('<#yesterday format=dddd>' == '<#metdateyesterday format=dddd>') echo '(calendar date and meteorological date same)';
{| class="wikitable" border="1"
else echo 'rollover still to happen, these results will be treated as belonging to <#metdate format=dddd>';?></pre>
|-
|-
!style="width:150px"|Web tag_name
|<#yesterday>
!style="width:300px"|Function
|Yesterday's date.  The default format depends on the locale you use to run Cumulus
!style="width:150px"|Time
!style="width:150px"|Date
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|<#update>
|The date and time of the last web site update.  The default format depends on the locale you use to run Cumulus
|-
|<#timeJavaScript>
| [[File:Badge vMx.png]]Available from version 3.5.2, so not available in legacy software
 
The JavaScript '''Date''' object contains the number of miliseconds since 00:00:00.000 UTC on 1st January 1970, that date and time is known as the UNIX Epoch.  In JavaScript, you can use <tt>Math.floor(new Date().getTime()/1000.0)</tt> This getTime method returns the time in milliseconds.  The web tag returns an integer (currently with 13 digits) representing the number of milliseconds since the UNIX epoch when the web tag was processed. It can be used in a script where you wish to re-express other times output by Cumulus MX into UTC (Coordinated Universal Time).  Mac OS X uses 00:00:00.000 UTC on 1st January 2001 as the starting time and date for its millisecond count, so that is considerably lower.
 
Note that UTC is calculated using 9192631770 times a particular transition time for Caesium 133 as a basis for 1 second. GMT (Greenwich Mean Time) is calculated on the basis that 1 second is 1/86400 of the time taken for a whole (day) rotation of the Earth. UT1 (or solar time) is calculated from various space measurements. Periodically, leap seconds are added to UTC to realign it with UT1, but these leap seconds are not added to the count of milliseconds represented by this web tag.
 
Do be aware that some devices will use a 32 bit signed integer to represent this number, and that will stop working on 19 January 2038, the year 2038 problem for computing world.
|-
|-
|<#MonthTempH>
|<#timeUnix>
|This months high temperature
| [[File:Badge vMx.png]]Available from version 3.7.0, so not available in legacy software
|<#MonthTempHT>
 
|<#MonthTempHD>
Unix tracks the number of seconds since the UNIX epoch. So this web tag can be used when you do not want the millisecond accuracy of the previous web tag. Like previous web tag this relates to UTC, so see details for that tag to find out more. This is equivalent in PHP 5 and PHP 7 to '''time();''' (in PHP 8, a parameter is mandatory for time function, so the call changes).
|-
|-
|<#MonthTempL>
|<#LastDataReadT>
|This months low temperature
|The date/time data was last read from the station. Default format for this tag is like this example '''18:30 on 30 December 2009''', but output parameters for both date and time can modify this to include seconds in 1.9.x builds and most MX builds such as per this example  '<#LastDataReadT format="yyyy-MM-dd HH:mm:ss">'.
|<#MonthTempLT>
|<#MonthTempLD>
|-
|-
|<#MonthMinTempH>
|<#DaysSince30Dec1899>  
|This months highest daily minimum temperature
|Day count (gives whole and fractional part) Example: 41250.6523310301
|[[File:badge v1.png]]<#MonthMinTempHD format=hh:nn> or <#MonthMinTempHD format=HH:mm> for Cumulus 1, 
[[File:Badge vMx.png]] <#MonthMinTempHD format=HH:mm> for Cumulus MX
|<#MonthMinTempHD>
|-
|-
|<#MonthMaxTempL>
|<#recordsbegandate>
|This months lowest daily maximum temperature
|Date when records began (appears twice on "recordT.htm" provided in standard web page, and used to calculate next tag, but ignored for all other Cumulus processing). Any output parameters valid for a date can be used here, don't forget differences in modifiers for Cumulus 1 and MX. There is no time associated with this web tag.  The default format is like 30 December 2009, please note although this web tag reports the value associated with [b]StartDate=dd/MM/yyyy[/b] (see [[Cumulus.ini#Section:_Station]]), the format there is short-date format and different to default format for this web tag.
|[[File:badge v1.png]]<#MonthMaxTempLD format=HH:mm> or <#MonthMaxTempLD format=hh:nn> for Cumulus 1,  
  [[File:Badge vMx.png]]<#MonthMaxTempLD format=HH:mm> for Cumulus MX
|<#MonthMaxTempLD>
|-
|-
|<#MonthHighDailyTempRange>
|<#DaysSinceRecordsBegan>
|High Daily Temp Range
|Day count since Cumulus records started
|n/a
|}
|<#MonthHighDailyTempRangeD>
 
==Today==
 
Cumulus allows some control over the time that "Today" begins:
* For the weather diary feature (originally called "The Log" if you have a very old release or look at old posts on the support forum), Cumulus classifies what you enter by a date. The hour of the day, when that date is first applied, is set in the configuration by the '''SnowDepthHour''' (called that as the only tag name available in the legacy Cumulus was for Snow Depth.
**  The default snow depth hour is 9 for the legacy Cumulus and 0 for MX.
* Readings from your weather station are assigned to the "Today" based on 3 options for [[Meteorological day]]
*# starting at 9:00 am, based on winter time, so switching to 10:00 during Daylight Saving (summer) time, or
*# starting at 9:00 am, all year round, or
*# aligned with calendar days, so today starts at midnight
 
The practice for professional meteorologists varies between nations, some of the traditional practices listed below have been abandoned now most weather reading is by machines:
* Generally, Meteorologists report snowfall, and snow days, on a calendar day basis (i.e. midnight to midnight).
* Most frequently, the Lowest temperature for a day is that recorded prior to the start time for Highest temperature.
** This is because Meteorologists in the past took manual observations at one, or more, fixed times during each day (9 a.m. was the most common, and the closest lowest temperature was generally earlier that morning, while the closest highest temperature was generally the following afternoon)
* Sunshine hours were recorded from sunrise to sunset, so assigned to "Today" aligned with calendar day
* The way that total rainfall was reported varied:
** Some nations assigned used days that ended at 9 a.m. so rainfall was recorded against the end date
** Sometimes totals were recorded separately for 9 a.m to 3 p.m, with 3 p.m. to 9 a.m being assigned to next day (again these were manual observation times)
** In other cases, the total for 9 p.m to 9 a.m was recorded separately, and possibly assigned to the day after the total for 9 a.m. to 9 p.m.
 
Cumulus does not support most of these practices. The independence of the start time for weather diary and weather station related web tags means needs to be remembered when labelling web tags from the two tables below.  Steve Loft assumed that you would use 9 a.m. as start time for both, but not care when snow fell, as it often has in the UK, after Summer Time has begun, so weather station tags were by default reporting from 10 a.m. local time and snow as at 9 a.m.
 
In MX, if you choose 9 a.m. (optionally 10 a.m. in summer) for rollover, so all the standard derivative are assigned to the date the meteorological day starts as Today, but the sunshine hours recorded against today will be from midnight on the said date.
 
===Weather Diary===
 
This first table lists all the web tags available for reporting what is recorded in the weather diary. Just to be clear, the web tags shown below, will report data for previous day if the current time is before the snow depth hour setting, and report data for the current day if the current time matches the snow depth hour or is later.
{| class="wikitable" border="1"
|-
|-
|<#MonthLowDailyTempRange>
!style="width:150px" | Web tag_name
|Low Daily Temp Range
!style="width:650px" | Function
|n/a
|<#MonthLowDailyTempRangeD>
|-
|-
|<#MonthHeatIndexH>
|<#snowdepth>
|This months high heat index
|Meteorologists report snow depth in cm, so this is default unit for Cumulus.
|<#MonthHeatIndexHT>
 
|<#MonthHeatIndexHD>
If there is no entry in Weather Diary for the day explained above, reports zero.
 
[[File:Badge vMx.png]] Input is to 2 decimal places. Available from version 3.1.1 - build 3054 when weather diary editor was added to MX.  MX allows output in centimetres with decimal places without any script. You can't change the units shown in admin interface, but your value can be input as inches to 2 decimal places if you ignore "cm" that is displayed in that interface.
 
[[File:Badge v1.png]] Input and output is always as integer. Available from very early builds, weather diary input amended from version 1.8.6 14th April 2009 to allow units to be specified on diary edit screen. If you choose to enter as whole millimetres,  you can use JavaScript (or another script language) on your web page to divide the web tag by 10 and get centimetres to 1 decimal place on output.
|-
|-
|<#MonthWChillL>
|colspan="2" style="background:pink;"|MX only
|This months greatest wind chill (i.e. lowest temperature)
|<#MonthWChillLT>
|<#MonthWChillLD>
|-
|-
|<#MonthAppTempH>
|<#snowlying>
|This months high apparent temperature
| [[File:Badge vMx.png]] Available from version 3.1.1 - build 3054.  If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.
|<#MonthAppTempHT>
 
|<#MonthAppTempHD>
[[File:Badge v1.png]] Although this tag is not available in Cumulus 1, your web page can use a script to check if <#snowdepth> is non zero, as that means snow is lying
|-
|-
|<#MonthAppTempL>
|<#snowfalling>
|This months low apparent temperature
| [[File:Badge vMx.png]] Available from version 3.1.1 - build 3054.    If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.
|<#MonthAppTempLT>
 
|<#MonthAppTempLD>
[[File:Badge v1.png]] Not available in Cumulus 1. There is no web page workaround, unless you write a script that reads [[Weather Diary]] and makes relevant information available on your web server.
|}
 
===Today.ini===
 
As explained earlier, these tag names relate to latest [[Meteorological day]] and they are populated from information held in [[today.ini]], as the sub-section title suggests; except for Sunshine Hours which relate to latest Calendar day and can be taken from either [[yesterday.ini]] or "today.ini" depending on (respectively) whether before or after rollover time if that is not midnight.
 
Where a tag name reports a value specific to a past time in today-so-far, there will also be a tag name that can give the time of day, shown in same row of table below. For those that cover whole day so far, the final column contains "n/a". Please note none of the time 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' (24 hour clock notation without leading zero for hour) for Cumulus 1 and MX.
 
Also as explained earlier, there is some inconsistency in naming with "T" not included in all tag names, "T" is used in conjunction with "H" or "L" as a suffix for extreme values/time-stamps, but a prefix "T" can identify today's value, or prefix "T" can signify a time-stamp.
 
In the legacy '''todayT.htm''' template, in the legacy "/web" folder, use was made of a selection of the tag names listed here.
 
If you are using MX, the today and yesterday page in the [[MX_Administrative_Interface]] shows similar information by using the [[Cumulus_MX_Local_API#Today.2FYesterday_Data|local application programming interface]].
{| class="wikitable" border="1"
|-
|-
|<#MonthFeelsLikeH>
!style="width:150px" | Web tag_name
|This months highest feels like temperature (available from [File:Badge vMx.png]] 3.6.0)
!style="width:650px" | Function
|<#MonthFeelsLikeHT>
!style="width:150px" | Time tag_name
|<#MonthFeelsLikeHD>
|-
|-
|<#MonthFeelsLikeL>
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|This months lowest feels like temperature (available from [File:Badge vMx.png]] 3.6.0)
|<#MonthFeelsLikeLT>
|<#MonthFeelsLikeLD>
|-
|-
|<#MonthDewPointH>
|<#tempTH>
|This months high dew point
|Today's highest temperature
|<#MonthDewPointHT>
|<#TtempTH>
|<#MonthDewPointHD>
|-
|-
|<#MonthDewPointL>
|<#tempTL>
|This months low dew point
|Today's lowest temperature
|<#MonthDewPointLT>
|<#TtempTL>
|<#MonthDewPointLD>
|-
|-
|<#MonthHumH>
|<#avgtemp>
|This months highest humidity
|The [[Average_temperature|average]] temperature so far today (calculated from all temperature readings processed by Cumulus, [[Today.ini|today.ini]] stores a cumulative aggregate and counts the number of values processed, so a division gives this output)
|<#MonthHumHT>
|n/a
|<#MonthHumHD>
|-
|-
|<#MonthHumL>
|<#temprange>
|This months lowest humidity
|The temperature range (<#tempTH> - <#tempTL>) so far today (Cumulus calculates all these tags using Celsius values, but outputs them in your chosen units)
|<#MonthHumLT>
|n/a
|<#MonthHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|<#apptempTH>
|Today's high apparent temperature
|<#TapptempTH>
|-
|-
|<#MonthPressH>
|<#apptempTL>
|This months highest pressure
|Today's low apparent temperature
|<#MonthPressHT>
|<#TapptempTL>
|<#MonthPressHD>
|-
|-
|<#MonthPressL>
|colspan="3" style="background:pink;"|MX only
|This months lowest pressure
|<#MonthPressLT>
|<#MonthPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#feelslikeTH>
|[[File:Badge vMx.png]] Available from version 3.6.10  (NOT AVAILABLE IN CUMULUS 1)
 
Today's high feels like temperature
 
Please see sub-section below current conditions if you are using an earlier 3.6.x version of MX.
|<#TfeelslikeTH>
|-
|-
|<#MonthGustH>
|<#feelslikeTL>
|This months highest wind gust
|[[File:Badge vMx.png]] Available from version 3.6.10    (NOT AVAILABLE IN CUMULUS 1)
|<#MonthGustHT>
 
|<#MonthGustHD>
Today's low feels like temperature
|<#TfeelslikeTL>
|-
|-
|<#MonthWindH>
|<#humidexTH>
|This months highest wind speed
|[[File:Badge vMx.png]] Available from version 3.7.0    (NOT AVAILABLE IN CUMULUS 1)
|<#MonthWindHT>
 
|<#MonthWindHD>
Today's high Canadian Humidity Index
 
Please see sub-section below current conditions if you are using Cumulus 1 or an earlier version of MX.
|<#ThumidexTH>
|-
|-
|<#MonthWindRunH>
|colspan="3" style="background:pink;"|Both legacy and MX
|High Daily Wind Run
|n/a
|<#MonthWindRunHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|<#heatindexTH>
|Today's high heat index
|<#TheatindexTH>
|-
|-
|<#MonthRainRateH>
|<#wchillTL>
|This months highest rainfall rate
|Today's greatest wind chill (i.e. lowest temperature, highest wind speed)
|<#MonthRainRateHT>
|<#TwchillTL>
|<#MonthRainRateHD>
|-
|-
|<#MonthHourlyRainH>
|<#dewpointTH>
|This months highest hourly rain
|Today's highest dew point
|<#MonthHourlyRainHT>
|<#TdewpointTH>
|<#MonthHourlyRainHD>
|-
|<#dewpointTL>
|Today's lowest dew point
|<#TdewpointTL>
|-
|<#humTH>
|Today's highest humidity
|<#ThumTH>
|-
|-
|<#MonthDailyRainH>
|<#humTL>
|This months greatest daily rain
|Today's lowest humidity
|n/a
|<#ThumTL>
|<#MonthDailyRainHD>
|-
|-
|<#MonthLongestDryPeriod>
|colspan="3" style="background:lightgray;"|Precipitation
|Longest dry period ending this month (days)
|n/a
|<#MonthLongestDryPeriodD>
|-
|-
|<#MonthLongestWetPeriod>
|<#rrateTM>
|Longest period of rain every day, ending this month (days)
|Today's maximum rain rate
|n/a
|<#TrrateTM>
|<#MonthLongestWetPeriodD>
|}
 
==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 [[#Current_Conditions|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 [[#Time.2FDate_.27format.27_Parameter|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
 
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px"|Web tag_name
|<#hourlyrainTH>
!style="width:300px"|Function
|Today's highest hourly rain
!style="width:150px"|Time
|<#ThourlyrainTH>
!style="width:150px"|Date
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|<#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
|-
|-
|<#YearTempH>
|colspan="3" style="background:lightgray;"|Pressure
|This years highest temperature
|<#YearTempHT>
|<#YearTempHD>
|-
|-
|<#YearTempL>
|<#pressTH>
|This years lowest temperature
|Today's highest pressure reading
|<#YearTempLT>
|<#TpressTH>  
|<#YearTempLD>
|-
|-
|<#YearHighDailyTempRange>
|<#pressTL>
|High Daily Temp Range
|Today's lowest pressure reading
|n/a
|<#TpressTL>  
|<#YearHighDailyTempRangeD>
|-
|-
|<#YearLowDailyTempRange>
|colspan="3" style="background:lightgray;"|Wind
|Low Daily Temp Range
|n/a
|<#YearLowDailyTempRangeD>
|-
|-
|<#YearHeatIndexH>
|<#windTM>
|This years highest heat index
|Today's maximum (average) wind speed
|<#YearHeatIndexHT>
|<#TwindTM>
|<#YearHeatIndexHD>
|-
|-
|<#YearWChillL>
|<#wgustTM>  
|This years greatest wind chill (i.e. lowest temperature)
|Today's maximum wind gust
|<#YearWChillLT>
|<#TwgustTM>
|<#YearWChillLD>
|-
|-
|<#YearAppTempH>
|<#bearingTM>
|This years highest apparent temperature
|The wind bearing at the time of today's high gust (<#wgustTM>) in degrees
|<#YearAppTempHT>
|<#TwgustTM>
|<#YearAppTempHD>
|-
|-
|<#YearAppTempL>
|<#Tbeaufort>  
|This years lowest apparent temperature
|Today's highest wind speed, expressed in the Beaufort scale
|<#YearAppTempLT>
|<#TwindTM>
|<#YearAppTempLD>
|-
|-
|<#YearFeelsLikeH>
|<#Tbeaufortnumber>
|This years highest feels like temperature (available from 3.6.0)
|Today's high wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|<#YearFeelsLikeHT>
|<#TwindTM>
|<#YearFeelsLikeHD>
|-
|<#windrun>
|The total wind run so far today
|N/A
|-
|-
|<#YearFeelsLikeL>
| <#windAvg>
|This years lowest feels like temperature (available from 3.6.0)
| [[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|<#YearFeelsLikeLT>
 
|<#YearFeelsLikeLD>
The wind run divided by time passed since rollover to express it as an average wind speed
| n/a
|-
|-
|<#YearDewPointH>
|<#domwindbearing>
|This years highest dew point
|Today's dominant wind direction in degrees
|<#YearDewPointHT>
|n/a
|<#YearDewPointHD>
|-
|-
|<#YearDewPointL>
|<#domwinddir>
|This years lowest dew point
|Today's dominant wind direction as compass point
|<#YearDewPointLT>
|n/a
|<#YearDewPointLD>
|-
|-
|<#YearMinTempH>
|<#Tbeaudesc>
|This years highest daily minimum temperature
|Beaufort 'description' for today's high wind speed
|<#YearMinTempHD format=HH:nn> for Cumulus 1, <#YearMinTempHD format=HH:mm> for Cumulus MX
|n/a
|<#YearMinTempHD>
|-
|-
|<#YearMaxTempL>
|colspan="3" style="background:lightgray;"|Miscellaneous
|This years lowest daily maximum temperature
|<#YearMaxTempHD format=HH:nn> for Cumulus 1, <#YearMaxTempHD format=HH:mm> for Cumulus MX
|<#YearMaxTempLD>
|-
|-
|<#YearHumH>
|<#ET>
|This years high humidity
|Today's [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration]. Applies only to Davis stations, equipped with a solar sensor.
|<#YearHumHT>
"The ET value provided to Cumulus by the console and/or DLL is buggy and unreliable. It often shows a negative value. See [[FAQ#It.27s_January_1st_and_my_.27rain_since_midnight.27_and.2For_.27last_24_hours_rain.27_and.2For_Evapotranspiration_are_wrong.2Fnegative|this FAQ]]."
|<#YearHumHD>
|N/A
|-
|-
|<#YearHumL>
|<#heatdegdays>
|This years low humidity
|Today's [[Heat/cold_degree_days_and_Chill_hours|heating degree days]]
|<#YearHumLT>
|n/a
|<#YearHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|<#cooldegdays>
|Today's [[Heat/cold_degree_days_and_Chill_hours|cooling degree days]]
|n/a
|-
|-
|<#YearPressH>
|<#solarTH>
|This years high pressure
|Today's high solar radiation value (Solar sensor needed)
|<#YearPressHT>
|<#TsolarTH>
|<#YearPressHD>
|-
|-
|<#YearPressL>
|<#UVTH>
|This years low pressure
|Today's high UV Index (UV sensor needed)
|<#YearPressLT>
|<#TUVTH>
|<#YearPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#SunshineHours>
|-
|Today's hours of sunshine so far. Added in Cumulus 2, then to 1.9.1 build 957, also available in MX. From version 3.7.0 takes a parameter "dp=n" so the number of decimal places required can be specified
|<#YearGustH>
|n/a
|This years high wind gust
|<#YearGustHT>
|<#YearGustHD>
|-
|-
|<#YearWindH>
|colspan="3" style="background:pink;"|MX only
|This years high wind speed
|<#YearWindHT>
|<#YearWindHD>
|-
|-
|<#YearWindRunH>
|<#LightningStrikesToday>
|High Daily Wind Run
|Number of strikes since midnight, default 0  - Added at 3.2.0 - b3056, but see subsequent release announcements as the handling of lightning was improved gradually over several subsequent releases.
|n/a
 
|<#YearWindRunHD>
(other lightning tags can be found in [[#Current_Conditions|Current Conditions table]])
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
| <#chillhoursToday>
|-
| The incremental chill hours figure since start of today (tag name available from version 3.12.0 beta build 3134, but the coding to process this web tag has a bug at time of adding this note to this Wiki page, as it may incorrectly report 99.99; hopefully a calculation using <#Ychillhours> and <#chillhours> will work better)
|<#YearRainRateH>
 
|This years high rainfall rate
(Compare with Cumulative seasonal Chill Hours at end of today <#chillhours> found in [[#Current_Conditions|Current Conditions table]])
|<#YearRainRateHT>
|}
|<#YearRainRateHD>
 
|-
== No Commas ==
|<#YearHourlyRainH>
 
|This years high hourly rain
'''This section is for those locales where a comma is used instead of a full stop to separate the integer and decimal parts of a number.'''  ''This section on this Wiki page was written for the legacy Cumulus (1.9.4) software.'' Although tag names in this section can be used in Cumulus MX, for backwards compatibility, there is now a better way to ensure that the value output by web tags can be understood by script languages which expect a full stop between the integer and decimal parts of a number.
|<#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==
Note that Cumulus does not use thousand separators, so the only places a comma can be used are as a field separator, or as a decimal separator. Obviously it cannot be used for both. Some computer languages like JavaScript will not accept a comma being used for this purpose.
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.
===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'.
Cumulus MX uses JavaScript Object Notation files for many of its data transfers.
 
From '''release 3.5.4''' build 3075, most web tags (one notable exception is indoor temperature <#intemp> where rc parameter not available until release 3.6.8 build 3084), that produce decimal number output now support the "'''rc=y'''" option. e.g. <tt><#tempYH rc=y></tt> will report yesterday's highest temperature using a full stop to separate decimal part where the locale would normally use a comma.
 
===Legacy Cumulus===
 
Cumulus 1.9.4 uses JavaScript for various tasks, as do various third party web pages.
 
From '''version 1.9.3''' build 1045, Cumulus 1 (and MX) has provided some current conditions web tags, some today web tags, and some recent history web tags in an alternative format where (regardless of locale) the number is always output in a format that uses a decimal point. They are listed in the sub-sections that follow and all correspond to the same tag  name with the letters 'RC' removed that has been listed in respective sections of this Wiki page.
 
====RC CURRENT CONDITIONS:====
 
<#RCtemp>, <#RCdew>, <#RCheatindex>, <#RChum>, <#RCinhum>, <#RCintemp>, <#RCpress>, <#RCrfall>, <#RCrrate>, <#RCwchill>, <#RCwgust>, <#RCwspeed>, <#RCwlatest>
 
====RC TODAY:====
 
<#RCpressTH>,  <#RCpressTL>,  <#RCrrateTM>,  <#RCtempTH>, <#RCtempTL>, <#RCwgustTM>,  <#RCdewpointTH>, <#RCdewpointTL>, <#RCwchillTL>, <#RCheatindexTH>, <#RCapptempTH>, <#RCapptempTL>
 
====RC RECENT HISTORY:====
 
<#RCRecentOutsideTemp>, <#RCRecentWindSpeed>, <#RCRecentWindGust>, <#RCRecentWindLatest>, <#RCRecentWindChill>, <#RCRecentDewPoint>, <#RCRecentHeatIndex>, <#RCRecentPressure>, <#RCRecentRainToday>, <#RCRecentUV>
 
Although 'Apparent Temperature' is not included as a tag, it can be [[FAQ#What_formula_does_Cumulus_use_for_Apparent_Temperature.3F | calculated]] in a script from the RC tags for 'outside temperature', 'wind speed', and 'relative humidity' values. In php language this is <tt>$RCapptempCALC =  round(<#temp> + (0.33 * (<#hum> / 100 * 6.105 * exp (17.27 * <#temp> / (237.7 + <#temp>) ))) - (0.7 * $wspeed) - 4.0, 2);</tt>.
 
There are other derivatives that can be calculated similarly from a set of simultaneous values, as described below the recent history section.
 
==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.
 
If you are using MX, the today and yesterday page in the [[MX_Administrative_Interface]] shows similar information by using the [[Cumulus_MX_Local_API#Today.2FYesterday_Data|local application programming 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'.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
!style="width:150px" | Web tag_name
!style="width:300px" | Function
!style="width:550px" | Function
!style="width:150px" | Date/Time
!style="width:150px" | Time
|-
|colspan="3" style="background:pink;"|Legacy and MX
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#tempH>
|<#tempYH>
|All time high temperature
|Yesterday's highest temperature
|<#TtempH>
|<#TtempYH>
|-
|-
|<#tempL>
|<#tempYL>
|All time low temperature  
|Yesterday's lowest temperature
|<#TtempL>
|<#TtempYL>
|-
|-
|<#mintempH>
|<#avgtempY>
|All time high minimum temperature  
|Yesterday's average temperature
|<#TmintempH>
|n/a
|-
|-
|<#maxtempL>
|<#temprangeY>
|All time low maximum temperature  
|The temperature range (max - min) yesterday
|<#TmaxtempL>
|n/a
|-
|-
|<#LowDailyTempRange>
|<#apptempYH>
|All time low daily temperature range
|Yesterday's high apparent temperature
|<#TLowDailyTempRange>
|<#TapptempYH>
|-
|-
|<#HighDailyTempRange>
|<#apptempYL>
|All time high daily temperature range
|Yesterday's low apparent temperature
|<#THighDailyTempRange>
|<#TapptempYL>
|-
|colspan="3" style="background:pink;"|MX only
|-
|-
|<#apptempH>
| <#Ychillhours>
|All time high apparent temperature
| The Cumulative [[Heat/cold_degree_days_and_Chill_hours#Chill_Hours_and.2For_Air_Frost|Chill Hours]] as recorded at rollover (the end of meteorological yesterday) (Available from release 3.12.0 onwards)
|<#TapptempH>
| n/a
|-
|-
|<#apptempL>
| <#chillhoursYest>
|All time low apparent temperature
| The incremental [[Heat/cold_degree_days_and_Chill_hours#Chill_Hours_and.2For_Air_Frost|Chill Hours]] change yesterday (Available from release 3.12.0 onwards)
|<#TapptempL>
 
(compare with <#chillhoursToday> described in [[#Today.ini]] table)
| n/a
|-
|-
|<#feelslikeH>
|<#feelslikeYH>
|All time high feels like temperature (available from 3.6.0)
|[[File:Badge vMx.png]] Available from version 3.6.10
|<#TfeelslikeH>
 
Yesterday's high feels like temperature
|<#TfeelslikeYH>
|-
|-
|<#feelslikeL>
|<#feelslikeYL>
|All time low feels like temperature (available from 3.6.0)
|Available from version 3.6.10
|<#TfeelslikeL>
 
Yesterday's low feels like temperature
|<#TfeelslikeYL>
|-
|-
|<#heatindexH>
|<#humidexYH
|All time high heat index
|Available from version 3.7.0
|<#TheatindexH>
 
Yesterday's high Canadian Humidity Index
|<#ThumidexYH>
|-
|-
|<#dewpointH>
|colspan="3" style="background:pink;"|Legacy and MX
|All time high dew point
|<#TdewpointH>
|-
|-
|<#dewpointL>
|<#heatindexYH>
|All time low dew point
|Yesterday's high heat index
|<#TdewpointL>
|<#TheatindexYH>
|-
|<#wchillYL>
|Yesterday's greatest wind chill (i.e. lowest temperature)
|<#TwchillYL>
|-
|<#dewpointYL>
|Yesterday's lowest dew point
|<#TdewpointYL>
|-
|-
|<#humH>
|<#dewpointYH>
|All time high humidity
|Yesterday's highest dew point
|<#ThumH>
|<#TdewpointYH>
|-
|-
|<#humL>
|<#humYH>
|All time low humidity
|High humidity yesterday
|<#ThumL>
|<#ThumYH>
|-
|-
|<#wchillH>
|<#humYL>
|All time greatest wind chill (i.e. lowest temperature)
|Low humidity yesterday
|<#TwchillH>
|<#ThumYL>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#rrateM>
|<#rfallY>
|All time high rain rate
|The total rainfall for yesterday according to the connected weather station
|<#TrrateM>
|n/a
|-
|-
|<#rfallH>
|<#RG11RainYest>
|All time high daily rain  
|The total rainfall for yesterday according to an RG-11 rain sensor configured in "Tipping Bucket" mode
|<#TrfallH>
|n/a
|-
|-
|<#rfallhH>
|<#rrateYM>
|All time high hourly rain
|Yesterday's maximum rain rate
|<#TrfallhH>
|<#TrrateYM>
|-
|-
|<#rfallmH>
|<#hourlyrainYH>
|All time high monthly rain  
|Yesterday's highest hourly rain
|<#TrfallmH>
|<#ThourlyrainYH>
|-
|-
|<#LongestDryPeriod>
|colspan="3" style="background:lightgray;"|Pressure
|All time longest dry period (days)
|<#TLongestDryPeriod>
|-
|-
|<#LongestWetPeriod>
|<#pressYH>
|All time longest wet period (days)
|Yesterday's highest pressure reading
|<#TLongestWetPeriod>
|<#TpressYH>  
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|<#pressYL>
|Yesterday's lowest pressure reading
|<#TpressYL>
|-
|-
|<#pressH>
|colspan="3" style="background:lightgray;"|Wind
|All time high pressure
|<#TpressH>
|-
|-
|<#pressL>
|<#windYM>
|All time low pressure
|Yesterday's maximum (average) wind speed
|<#TpressL>
|<#TwindYM>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|<#wgustYM>
|Yesterday's maximum wind gust
|<#TwgustYM>
|-
|-
|<#gustM>
|<#bearingYM>
|All time high wind gust  
|The wind bearing at the time of yesterday's high gust
|<#TgustM>
|<#TwgustYM>
|-
|-
|<#wspeedH>
|<#Ybeaufort>
|All time high average wind speed  
|Yesterday's highest wind speed, expressed in the Beaufort scale
|<#TwspeedH>
|<#TwindYM>
|-
|-
|<#windrunH>
|<#Ybeaufortnumber>
|All time high daily wind run
|Yesterday's high wind speed on the Beaufort scale, without a leading "F", e.g. "6"
|<#TwindrunH>
|<#TwindYM>
|}
 
==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>
 
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px"|Web tag_name
|<#Ybeaudesc>
!style="width:300px"|Function
|Beaufort 'description' for yesterday's high wind speed
!style="width:150px"|Date/Time
|n/a
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|<#domwindbearingY>
|Yesterday's dominant wind direction in degrees
|n/a
|-
|-
|<#ByMonthTempH>
|<#domwinddirY>
|High Temperature
|Yesterday's dominant wind direction as compass point
|<#ByMonthTempHT>
|n/a
|-
|-
|<#ByMonthTempL>
|<#windrunY>
|Low Temperature
|The total wind run for yesterday
|<#ByMonthTempLT>
|n/a
|-
|-
|<#ByMonthHeatIndexH>
|colspan="3" style="background:pink;"|MX only
|High Heat Index
|<#ByMonthHeatIndexHT>
|-
|-
|<#ByMonthWChillL>
| <#windAvgY>
|Greatest wind chill (i.e. lowest temperature)
| [[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|<#ByMonthWChillLT>
 
The wind run yesterday divided by 24 hours to express it as an average wind speed
| n/a
|-
|-
|<#ByMonthAppTempH>
|colspan="3" style="background:pink;"|Legacy and MX
|High Apparent Temperature
|<#ByMonthAppTempHT>
|-
|-
|<#ByMonthAppTempL>
|colspan="3" style="background:lightgray;"|Miscellaneous
|Low Apparent Temperature
|<#ByMonthAppTempLT>
|-
|-
|<#ByMonthFeelsLikeH>
|<#heatdegdaysY>
|High Feels Like Temperature (available from 3.6.0)
|Yesterday's [[Heat/cold_degree_days_and_Chill_hours|heating degree days]]
|<#ByMonthFeelsLikeTempHT>
|n/a
|-
|-
|<#ByMonthFeelsLikeTempL>
|<#cooldegdaysY>
|Low Feels Like Temperature (available from 3.6.0)
|Yesterday's [[Heat/cold_degree_days_and_Chill_hours|cooling degree days]]
|<#ByMonthFeelsLikeTempLT>
|n/a
|-
|<#ByMonthDewPointH>
|High Dew Point
|<#ByMonthDewPointHT>
|-
|-
|<#ByMonthDewPointL>
|<#YSunshineHours>
|Low Dew Point
|Yesterday's hours of sunshine so far. Added in Cumulus 2, then to 1.9.1 build 957, also in MX. From version 3.7.0 takes a parameter "dp=n" so the number of decimal places required can be specified
|<#ByMonthDewPointLT>
|n/a
|-
|-
|<#ByMonthMinTempH>
|<#solarYH>
|Highest Daily Minimum Temperature
|Yesterday's high solar radiation value (Solar sensor needed)
|<#ByMonthMinTempHT>
|<#TsolarYH>
|-
|-
|<#ByMonthMaxTempL>
|<#UVYH>
|Lowest Daily Maximum Temperature
|Yesterday's high UV Index (UV sensor needed)
|<#ByMonthMaxTempLT>
|<#TUVYH>
|-
|}
|<#ByMonthHighDailyTempRange>
 
|High Daily Temp Range
==Yearly==
|<#ByMonthHighDailyTempRangeT>
 
This table shows most of the web tags used on the "thisyearT.htm" web template.
 
The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|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. Do make sure that you get the web tag names right and the output form at parameters right.
 
As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this month group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.
 
Remember that the Year-to-date runs from roll-over time on 1 January for all web tags listed here.
 
The list below does NOT include any web tags that represent seasonal derivatives, i.e. where you define the month from which they start counting. (Cumulative seasonal Chill Hours <#chillhours> and Total seasonal rainfall <#ryear> can both be found in [[Webtags#Current_Conditions|Current Conditions]]). Note, that does not imply both are included in '''indexT.htm'''.
 
 
{| class="wikitable" border="1"
|-
|-
|<#ByMonthLowDailyTempRange>
!style="width:150px"|Web tag_name
|Low Daily Temp Range
!style="width:300px"|Function
|<#ByMonthLowDailyTempRangeT>
!style="width:350px"|Time
!style="width:150px"|Date
|-
|-
|<#ByMonthHumH>
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|High Humidity
|<#ByMonthHumHT>
|-
|-
|<#ByMonthHumL>
|<#YearTempH>
|Low Humidity
|This year's highest temperature
|<#ByMonthHumLT>  
|<#YearTempHT>
|<#YearTempHD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|<#YearTempL>
|This year's lowest temperature
|<#YearTempLT>
|<#YearTempLD>
|-
|-
|<#ByMonthPressH>
|<#YearHighDailyTempRange>
|High Pressure
|This year's highest Daily Temp Range
|<#ByMonthPressHT>
|n/a
|<#YearHighDailyTempRangeD>
|-
|-
|<#ByMonthPressL>
|<#YearLowDailyTempRange>
|Low Pressure
|This year's lowest Daily Temp Range
|<#ByMonthPressLT>
|n/a
|<#YearLowDailyTempRangeD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#YearHeatIndexH>
|This year's highest USA heat index
|<#YearHeatIndexHT>
|<#YearHeatIndexHD>
|-
|-
|<#ByMonthGustH>
|<#YearWChillL>
|High Wind Gust
|This year's greatest wind chill (i.e. lowest temperature)
|<#ByMonthGustHT>
|<#YearWChillLT>
|<#YearWChillLD>
|-
|-
|<#ByMonthWindH>
|<#YearAppTempH>
|High Wind Speed
|This year's highest apparent temperature
|<#ByMonthWindHT>
|<#YearAppTempHT>
|<#YearAppTempHD>
|-
|-
|<#ByMonthWindRunH>
|<#YearAppTempL>
|High Daily Wind Run
|This year's lowest apparent temperature
|<#ByMonthWindRunHT>
|<#YearAppTempLT>
|<#YearAppTempLD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|<#YearFeelsLikeH>
|[[File:Badge vMx.png]]This year's highest feels like temperature (available from 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#YearFeelsLikeHT>
|<#YearFeelsLikeHD>
|-
|-
|<#ByMonthRainRateH>
|<#YearFeelsLikeL>
|High Rain Rate
|[[File:Badge vMx.png]]This year's lowest feels like temperature (available from 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#ByMonthRainRateHT>
|<#YearFeelsLikeLT>
|<#YearFeelsLikeLD>
|-
|-
|<#ByMonthMonthlyRainH>
|<#YearHumidexH>
|High Monthly Rainfall
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)
|<#ByMonthMonthlyRainHT>
 
This year's highest Canadian Humidity Index
|<#YearHumidexHT>
|<#YearHumidexHD>
|-
|-
|<#ByMonthHourlyRainH>
|<#YearDewPointH>
|High Hourly Rain
|This year's highest dew point
|<#ByMonthHourlyRainHT>
|<#YearDewPointHT>
|<#YearDewPointHD>
|-
|-
|<#ByMonthDailyRainH>
|<#YearDewPointL>
|High Daily Rain
|This year's lowest dew point
|<#ByMonthDailyRainHT>
|<#YearDewPointLT>
|<#YearDewPointLD>
|-
|-
|<#ByMonthLongestDryPeriod>
|<#YearMinTempH>
|Longest Dry Period
|This year's highest daily minimum temperature
|<#ByMonthLongestDryPeriodT>
|Flavour specific mandatory output parameters:
* <#YearMinTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMinTempHD format=HH:mm> ''for Cumulus MX''
|<#YearMinTempHD>
|-
|-
|<#ByMonthLongestWetPeriod>
|<#YearMaxTempL>
|Longest Wet Period
|This year's lowest daily maximum temperature
|<#ByMonthLongestWetPeriodT>
|Flavour specific mandatory output parameters:
|}
* <#YearMaxTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMaxTempHD format=HH:mm> ''for Cumulus MX''


==Day/Night/Sun/Moon==
|<#YearMaxTempLD>
These are updated each hour to refer to current time-zone
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
|<#YearHumH>
!style="width:600px" | Function
|This year's high humidity
|<#YearHumHT>
|<#YearHumHD>
|-
|-
|<#sunrise>
|<#YearHumL>
|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.
|This year's low humidity
|<#YearHumLT>
|<#YearHumLD>
|-
|-
|<#sunset>
|colspan="4" style="background:lightgray;"|Pressure
|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>
|<#YearPressH>
|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.
|This year's high pressure
|<#YearPressHT>
|<#YearPressHD>
|-
|-
|<#IsSunUp>
|<#YearPressL>
|A flag to indicate if the Sun is above the horizon or not, based on the sunrise and sunset times.
|This year's low pressure
 
|<#YearPressLT>
Possible values are 0 or 1, where 1 is when the Sun is above the horizon for the station location.
|<#YearPressLD>
|-
|-
|<#dawn>
|colspan="4" style="background:lightgray;"|Wind
|Start of last Civil Twilight at the station as at last midnight UTC
|-
|-
|<#dusk>
|<#YearGustH>
|End of next Civil Twilight at the station as at last midnight UTC
|This year's high wind gust
|<#YearGustHT>
|<#YearGustHD>
|-
|-
|<#daylightlength>
|<#YearWindH>
|Length of daylight in hours and minutes (dawn to dusk)
|This year's high wind speed
|<#YearWindHT>
|<#YearWindHD>
|-
|-
|<#isdaylight>
|<#YearWindRunH>
|A flag to indicate if the location for the station is in civil daylight or not, based on the dawn and dusk times.
| This year's highest Daily Wind Run
 
|n/a
Possible values are 0 or 1, where 1 notes that it is currently within the hours of daylight.
|<#YearWindRunHD>
 
|-
|-
|<#tomorrowdaylength>
|colspan="4" style="background:lightgray;"|Rainfall
|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>
|<#YearRainRateH>
|Current [[Lunar phase|phase of the moon]] in words, eg "New Moon" etc. The names used can be altered in [[Strings.ini#Moon_Phases|strings.ini]].
|This year's highest rainfall rate
|<#YearRainRateHT>
|<#YearRainRateHD>
|-
|-
|<#MoonAge>
|<#YearHourlyRainH>
|Current '''approximate''' age of the Moon in days (0-29.53)
|This year's highest hourly rain
 
|<#YearHourlyRainHT>
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"
|<#YearHourlyRainHD>
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>
|<#YearDailyRainH>
|Current moonrise time at the station (if moon rises on current calendar day)
|This year's high daily rain
|n/a
|<#YearDailyRainHD>
|-
|-
|<#moonset>
|<#YearMonthlyRainH>
|Current moonset time at the station (if moon sets on current calendar day)
|This year's high monthly rain
|n/a
|<#YearMonthlyRainHD>
|-
|-
|<#MoonPercent>
|<#YearLongestDryPeriod>
|Current percentage of moon visible (negative value indicates 'waning')
|Longest period without rain ending this year (days)
 
|n/a
MX b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|<#YearLongestDryPeriodD>
|-
|-
|<#MoonPercentAbs>
|<#YearLongestWetPeriod>
|Current percentage of moon visible (always positive)
|Longest period of rain every day ending this year (days)
|n/a
|<#YearLongestWetPeriodD>
|-
|colspan="4" style="background:lightgray;"|Solar


MX b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|-
|-
|<#SunshineHours>
| <#SunshineHoursYear>
|Hours of sunshine so far today  (Solar sensor needed)
| the total sunshine hours in year-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' or '''r''']] for a past year
|-
| n/a
|<#YSunshineHours>
| n/a
|Total hours of sunshine yesterday  (Solar sensor needed)
|-
|<#CurrentSolarMax>
|[[FAQ#What_is_this_.22Solar_Max.22_value_which_Cumulus_is_displaying.3F | Current theoretical maximum solar radiation]]
|-
|<#IsSunny>
|Returns 1 if the sun is shining, otherwise 0 (Solar sensor needed)
|}
|}


==Alarms==
==All Time==
 
This table lists the web tags that appear in the '''recordsT.htm''' example template that is included in each release since version 1.5.1 10th January 2006.  Additional tags correctly populated from 3.6.10 (build 3086) or 3.7.0 (build 3089) are marked with a "MX" icon as they are not available in Cumulus 1. Please note the 3.6.10 release was available from 24 June 2020, if the date shown for those MX only tags is before when you installed that (or a later release), the output may show incorrect values.
 
The output from the web tags shown in the date/time column have the default format that is seen on "records.htm" in the standard web pages:
*The default format for an extreme month is to show the month name in full i.e. format 'MMMM' followed by the year in full.
*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' again ending with the year.
*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 (i.e. on the standard web page the time comes first, not as seen in admin interface).


[[File:badge v1.png]]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.
You can change the default output on either the standard web template, or in your own file,  by 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. Please see examples section above for advice.


[[File:Badge vMx.png]]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.
Note that unlike the this month and this year web tags, the time and the date are both included in the default format of the standard time-stamp web tags for the 'highest minimum' and 'lowest maximum' temperatures, yet another inconsistency!


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'.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |Web tag_name
!style="width:150px" | Web tag_name
!style="width:600px" |Function
!style="width:400px" | Function
!style="width:150px" | Date/Time
|-
|-
|<#LowTempAlarm>
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|Low temperature alarm
|-
|-
|<#HighTempAlarm>  
|<#tempH>
|High temperature alarm
|All time high temperature
|<#TtempH>
|-
|-
|<#TempChangeUpAlarm>  
|<#tempL>
|Temperature increase alarm
|All time low temperature
|<#TtempL>
|-
|-
|<#TempChangeDownAlarm>  
|<#mintempH>
|Temperature decrease alarm
|All time high minimum temperature
|<#TmintempH>
|-
|-
|<#LowPressAlarm>  
|<#maxtempL>
|Low pressure alarm
|All time low maximum temperature
|<#TmaxtempL>
|-
|-
|<#HighPressAlarm>  
|<#LowDailyTempRange>
|High pressure alarm
|All time low daily temperature range
|<#TLowDailyTempRange>
|-
|-
|<#PressChangeUpAlarm>  
|<#HighDailyTempRange>
|Pressure increase alarm
|All time high daily temperature range
|<#THighDailyTempRange>
|-
|-
|<#PressChangeDownAlarm>  
|<#apptempH>
|Pressure decrease alarm
|All time high apparent temperature
|<#TapptempH>
|-
|<#apptempL>
|All time low apparent temperature
|<#TapptempL>
|-
|-
|<#HighRainTodayAlarm>  
|<#feelslikeH>
|High rain today alarm
|[[File:Badge vMx.png]]All time high feels like temperature (available from 3.6.0)
|<#TfeelslikeH>
|-
|-
|<#HighRainRateAlarm>  
|<#feelslikeL>
|High rainfall rate alarm
|[[File:Badge vMx.png]]All time low feels like temperature (available from 3.6.0)
|<#TfeelslikeL>
|-
|-
|<#HighWindGustAlarm>  
|<#humidexH>
|High wind gust alarm
|[[File:Badge vMx.png]]All time high Canadian Humidity Index (available from 3.7.0)
|<#ThumidexH>
|-
|-
|<#HighWindSpeedAlarm>  
|<#heatindexH>
|High wind speed alarm
|All time high USA heat index
|<#TheatindexH>
|-
|-
|<#DataStopped>
|<#dewpointH>
|1 if the station has apparently stopped sending data to Cumulus, otherwise 0
|All time high dew point
|}
|<#TdewpointH>
 
== 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).
 
=== Differences depending on Cumulus versions ===
 
[[File:Badge v1.png]] Cumulus 1.9.x supports all the web tags listed in table below, with the exception of those relating to "feels like".
 
[[File:Badge vMx.png]] For versions up to 3.5.0 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). From version 3.5.1, Cumulus MX offers all the web tags listed in table below. These will be set from the time of the record until a timeout value (default 24 hours). You can change the default timeout by adding this <tt>RecordSetTimeoutHrs=24</tt> entry to [[Cumulus.ini#Section:_Station|[Station] section in Cumulus.ini]] where the default '24' can be changed to a different number of hours.
 
=== Table of web tags available for extreme records ===
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |Web tag_name
|<#dewpointL>
!style="width:600px" |Function
|All time low dew point
|<#TdewpointL>
|-
|-
|<#recordsbegandate>
|<#humH>
|The date that Cumulus began tracking all time records (does not prevent earlier record dates being set manually)
|All time high humidity
|<#ThumH>
|-
|-
|<#newrecord>  
|<#humL>
|Indicates when any tracked extreme is changed.
|All time low humidity
*In Cumulus 1.x.x: 1 if 'new record' light is flashing, 0 if not
|<#ThumL>
*In Cumulus MX: 1 from when new record is set until next rollover is completed, 0 otherwise
|-
|-
|<#TempRecordSet>
|<#wchillH>
|1 if the indicator on the temperature tab on the all-time records screen is currently lit, 0 if not
|All time greatest wind chill (i.e. lowest temperature, but highest wind speed)
|<#TwchillH>
|-
|-
|<#WindRecordSet>
|colspan="3" style="background:lightgray;"|Rainfall
|1 if the indicator on the wind tab on the all-time records screen is currently lit, 0 if not
|-
|-
|<#RainRecordSet>
|<#rrateM>
|1 if the indicator on the rain tab on the all-time records screen is currently lit, 0 if not
|All time high rain rate
|<#TrrateM>
|-
|-
|<#HumidityRecordSet>
|<#rfallH>
|1 if the indicator on the humidity tab on the all-time records screen is currently lit, 0 if not
|All time high daily rain
|<#TrfallH>
|-
|-
|<#PressureRecordSet>
|<#rfallhH>
|1 if the indicator on the pressure tab on the all-time records screen is currently lit, 0 if not
|All time high hourly rain
|<#TrfallhH>
|-
|-
|<#HighTempRecordSet>
|<#rfallmH>
|1 if the all-time high temperature light is currently flashing, 0 if not
|All time high monthly rain
|<#TrfallmH>
|-
|-
|<#LowTempRecordSet>
|<#LongestDryPeriod>
|1 if the all-time low temperature light is currently flashing, 0 if not
|All time longest dry period (days)
|<#TLongestDryPeriod>
|-
|-
|<#HighTempRangeRecordSet>
|<#LongestWetPeriod>
|1 if the all-time high daily temperature range light is currently flashing, 0 if not
|All time longest wet period (days)
|<#TLongestWetPeriod>
|-
|-
|<#LowTempRangeRecordSet>
|colspan="3" style="background:lightgray;"|Pressure
|1 if the all-time low daily temperature range light is currently flashing, 0 if not
|-
|-
|<#HighAppTempRecordSet>
|<#pressH>
|1 if the all-time high apparent temperature light is currently flashing, 0 if not
|All time high pressure
|<#TpressH>
|-
|-
|<#LowAppTempRecordSet>
|<#pressL>
|1 if the all-time low apparent temperature light is currently flashing, 0 if not
|All time low pressure
|<#TpressL>
|-
|-
|<#HighHeatIndexRecordSet>
|colspan="3" style="background:lightgray;"|Wind
|1 if the all-time high heat index light is currently flashing, 0 if not
|-
|-
|<#LowWindChillRecordSet>
|<#gustM>
|1 if the all-time low wind chill light is currently flashing, 0 if not
|All time high wind gust
|<#TgustM>
|-
|-
|<#HighDewPointRecordSet>
|<#wspeedH>
|1 if the all-time high dew point light is currently flashing, 0 if not
|All time high average wind speed
|<#TwspeedH>
|-
|-
|<#LowDewPointRecordSet>
|<#windrunH>
|1 if the all-time low dew point light is currently flashing, 0 if not
|All time high daily wind run
|<#TwindrunH>
|}
 
==Monthly==
 
This table shows the web tags used on the '''thismonthT.htm''' web template.
 
Because the rainfall this month does not appear on '''thismonthT.htm''' web page, it is shown in [[#Current_Conditions|indexT.htm]] table earlier in this article which is for the web page where it does appear.
 
The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|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. Do make sure that you get the web tag names right and the output form at parameters right.
 
As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this year group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.
 
{| class="wikitable" border="1"
|-
|-
|<#HighMinTempRecordSet>
!style="width:150px"|Web tag_name
|1 if the all-time high minimum temperature light is currently flashing, 0 if not
!style="width:300px"|Function
!style="width:150px"|Time
!style="width:150px"|Date
|-
|-
|<#LowMaxTempRecordSet>
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|1 if the all-time low maximum temperature light is currently flashing, 0 if not
|-
|-
|<#HighWindGustRecordSet>
|<#MonthTempH>
|1 if the all-time high wind gust light is currently flashing, 0 if not
|This months high temperature
|<#MonthTempHT>
|<#MonthTempHD>
|-
|-
|<#HighWindSpeedRecordSet>
|<#MonthTempL>
|1 if the all-time high wind speed light is currently flashing, 0 if not
|This months low temperature
|<#MonthTempLT>
|<#MonthTempLD>
|-
|-
|<#HighRainRateRecordSet>
|<#MonthMinTempH>
|1 if the all-time high rain rate light is currently flashing, 0 if not
|This months highest daily minimum temperature
|[[File:badge v1.png]]<#MonthMinTempHD format=hh:nn> or <#MonthMinTempHD format=HH:mm> for Cumulus 1,
[[File:Badge vMx.png]] <#MonthMinTempHD format=HH:mm> for Cumulus MX
|<#MonthMinTempHD>
|-
|-
|<#HighHourlyRainRecordSet>
|<#MonthMaxTempL>
|1 if the all-time high hourly rain light is currently flashing, 0 if not
|This months lowest daily maximum temperature
|[[File:badge v1.png]]<#MonthMaxTempLD format=HH:mm> or <#MonthMaxTempLD format=hh:nn> for Cumulus 1,  
[[File:Badge vMx.png]]<#MonthMaxTempLD format=HH:mm> for Cumulus MX
|<#MonthMaxTempLD>
|-
|-
|<#HighDailyRainRecordSet>
|<#MonthHighDailyTempRange>
|1 if the all-time high daily rain light is currently flashing, 0 if not
|High Daily Temp Range
|-
|n/a
|<#HighMonthlyRainRecordSet>
|<#MonthHighDailyTempRangeD>
|1 if the all-time high monthly rain light is currently flashing, 0 if not
|-
|-
|<#LongestDryPeriodRecordSet>
|<#MonthLowDailyTempRange>
|1 if the all-time longest dry period light is currently flashing, 0 if not
|Low Daily Temp Range
|n/a
|<#MonthLowDailyTempRangeD>
|-
|-
|<#LongestWetPeriodRecordSet>
|<#MonthHeatIndexH>
|1 if the all-time longest wet period light is currently flashing, 0 if not
|This months high USA heat index
|<#MonthHeatIndexHT>
|<#MonthHeatIndexHD>
|-
|-
|<#HighHumidityRecordSet>
|<#MonthWChillL>
|1 if the all-time high humidity light is currently flashing, 0 if not
|This months greatest wind chill (i.e. lowest temperature)
|<#MonthWChillLT>
|<#MonthWChillLD>
|-
|-
|<#LowHumidityRecordSet>
|<#MonthAppTempH>
|1 if the all-time low humidity light is currently flashing, 0 if not
|This month's high apparent temperature
|<#MonthAppTempHT>
|<#MonthAppTempHD>
|-
|-
|<#HighPressureRecordSet>
|<#MonthAppTempL>
|1 if the all-time high pressure light is currently flashing, 0 if not
|This month's low apparent temperature
|<#MonthAppTempLT>
|<#MonthAppTempLD>
|-
|-
|<#LowPressureRecordSet>
|<#MonthFeelsLikeH>
|1 if the all-time low pressure light is currently flashing, 0 if not
|This month's highest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#MonthFeelsLikeHT>
|<#MonthFeelsLikeHD>
|-
|-
|<#HighWindrunRecordSet>
|<#MonthFeelsLikeL>
|1 if the all-time high wind run light is currently flashing, 0 if not
|This months lowest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|}
|<#MonthFeelsLikeLT>
 
|<#MonthFeelsLikeLD>
==Special tags==
 
===OS WMR Series===
 
There are a set of tags for the WMR928, WR100/200 extra sensors:
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |Web tag_name
|<#MonthHumidexH>
!style="width:600px" |Function
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)
|-
|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:
 
'''Please be aware that the tags available is not the same in all versions and this table has not yet been updated for latest MX version.'''
 
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:


{| class="wikitable" border="1"
This month's highest Canadian Humidity Index
|<#MonthHumidexHT>
|<#MonthHumidexHD>
|-
|-
!style="width:150px" |Web tag_name
|<#MonthDewPointH>
!style="width:120px" |Applicability
|This month's high dew point
!style="width:600px" |Function
|<#MonthDewPointHT>
|<#MonthDewPointHD>
|-
|-
!<#DavisTotalPacketsReceived>
|<#MonthDewPointL>
|1.x.x and MX
|This month's low dew point
|Total number of data packets received
|<#MonthDewPointLT>
|<#MonthDewPointLD>
|-
|-
!<#DavisTotalPacketsMissed>
|<#MonthHumH>
|1.x.x and MX
|This month's highest humidity
|Number of missed data packets
|<#MonthHumHT>
|<#MonthHumHD>
|-
|<#MonthHumL>
|This month's lowest humidity
|<#MonthHumLT>
|<#MonthHumLD>
|-
|-
!<#DavisMaxInARow>
|colspan="4" style="background:lightgray;"|Pressure
|1.x.x and MX
|Longest streak of consecutive packets received
|-
|-
!<#DavisNumCRCerrors>
|<#MonthPressH>
|1.x.x and MX
|This month's highest pressure
|Number of packets received with CRC errors
|<#MonthPressHT>
|<#MonthPressHD>
|-
|-
!<#DavisFirmwareVersion>
|<#MonthPressL>
|1.x.x and MX
|This month's lowest pressure
|The console firmware version
|<#MonthPressLT>
|<#MonthPressLD>
|-
|-
!<#DavisNumberOfResynchs>
|colspan="4" style="background:lightgray;"|Wind
|1.x.x and MX
|Number of times the console resynchronised with the transmitter
|-
|-
!<#THWindex>
|<#MonthGustH>
|1.9.x
|This month's highest wind gust
|A derived temperature using Temperature/Humidity/Wind values read from Davis DLL in Cumulus 1.9.x.
|<#MonthGustHT>
*The THW Index uses humidity and temperature (like Heat Index), but includes the cooling effects of wind (like wind chill).
|<#MonthGustHD>
*Available from 1.9.2 Build 1009 (Aug 2011).
|-
|-
!<#THSWindex>
|<#MonthWindH>
|(1.9.x and) MX
|This month's highest wind speed
|A heat stress indicator using Temperature/Humidity/Solar/Wind values.
|<#MonthWindHT>
*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.
|<#MonthWindHD>
*Therefore requires Davis station with solar sensor.
|-
[http://digitalcommons.unl.edu/cgi/viewcontent.cgi?article=1223&context=animalscinbcr  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.
|<#MonthWindRunH>
 
|This month's high Daily Wind Run
'''IMPORTANT NOTES:'''
|n/a
#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).
|<#MonthWindRunHD>
#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>
|colspan="4" style="background:lightgray;"|Rainfall
|1.x.x and MX
|The console battery condition in volts. eg "4.82v"
|-
|-
!<#txbattery>
|<#MonthRainRateH>
<#txbattery channel=1>
|This month's highest rainfall rate
|1.x.x and MX
|<#MonthRainRateHT>
|The transmitter battery condition, by default it returns the status of all transmitters.
|<#MonthRainRateHD>
'''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>
|<#MonthHourlyRainH>
|1.x.x and MX
|This month's highest hourly rain
|The console 'storm rain' current amount (build 1090 onwards for Cumulus 1; 3021 onwards for MX)
|<#MonthHourlyRainHT>
|<#MonthHourlyRainHD>
|-
|-
!<#StormRainStart>
|<#MonthDailyRainH>
|This month's wettest day (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>
|-
|colspan="4" style="background:lightgray;"|Solar
 
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|-
| <#SunshineHoursMonth>
| the total sunshine hours in month-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' and '''m''' or '''r''']] for a past month
| n/a
| n/a
|}
 
 
==Monthly All Time Records==
 
This table includes web tags that show the values in [[Monthlyalltime.ini]] log file, which was introduced in version 1.9.3 (build 1033, 10 Apr 2012).
 
These 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. 
# The tag names listed here require a [[Webtags/Parameters#Input_modification_Parameters|input modification parameter]].
# The tag names here can optionally take any [[Webtags/Parameters#Output_modification_parameters|output modification parameters]].
# To supply both optional input modification, and optional output modification parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. In that example, the time (not date) of highest ever temperature in July is returned after processing by Cumulus.
 
At release 3.6.10 (build 3086), and at release 3.7.0 (build 3089); additional tag names were introduced:
* They are marked with a "MX" icon as they are not available in legacy Cumulus 1.
* If you have any "feels like temperatures" that appear with a date/time parameter with a date before 24 June 2020, or before you installed the 3.6.10 release (or a later release), then the value web tag may show incorrect values.
{| class="wikitable" border="1"
|-
!style="width:150px"|Web tag_name
!style="width:400px"|Function
!style="width:150px"|Date/Time
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|<#ByMonthTempH>
|High Temperature
|<#ByMonthTempHT>
|-
|<#ByMonthTempL>
|Low Temperature
|<#ByMonthTempLT>
|-
|<#ByMonthHeatIndexH>
|High Heat Index
|<#ByMonthHeatIndexHT>
|-
|<#ByMonthWChillL>
|Greatest wind chill (i.e. lowest temperature and highest wind speed)
|<#ByMonthWChillLT>
|-
|<#ByMonthAppTempH>
|High Apparent Temperature
|<#ByMonthAppTempHT>
|-
|<#ByMonthAppTempL>
|Low Apparent Temperature
|<#ByMonthAppTempLT>
|-
|<#ByMonthFeelsLikeH>
|[[File:Badge vMx.png]]High Feels Like Temperature (available from 3.6.10)
|<#ByMonthFeelsLikeHT>
|-
|<#ByMonthFeelsLikeL>
|[[File:Badge vMx.png]]Low Feels Like Temperature (available from 3.6.10)
|<#ByMonthFeelsLikeLT>
|-
|<#ByMonthHumidexH>
|[[File:Badge vMx.png]]High Canadian Humidity Index (Humidex) - available from version 3.7.0
|<#ByMonthHumidexHT>
|-
|<#ByMonthHumidexL>
|[[File:Badge vMx.png]]Low Canadian Humidity Index (Humidex) - available from version 3.7.0
|<#ByMonthHumidexLT>
|-
|<#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>
|-
|colspan="4" style="background:lightgray;"|Pressure
|-
|<#ByMonthPressH>
|High Pressure
|<#ByMonthPressHT>
|-
|<#ByMonthPressL>
|Low Pressure
|<#ByMonthPressLT>
|-
|colspan="4" style="background:lightgray;"|Wind
|-
|<#ByMonthGustH>
|High Wind Gust
|<#ByMonthGustHT>
|-
|<#ByMonthWindH>
|High Wind Speed
|<#ByMonthWindHT>
|-
|<#ByMonthWindRunH>
|High Daily Wind Run
|<#ByMonthWindRunHT>
|-
|colspan="4" style="background:lightgray;"|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==
In Cumulus 1 most of these are only calculated at UTC zero hours, but are updated each hour to refer to current time-zone.
 
MX is more complicated, but most of these are calculated hourly.
{| class="wikitable" border="1"
|-
!style="width:150px" | Web tag_name
!style="width:900px" | Function
|-
|<#sunrise>
|Last sunrise time at the station - This sunrise time is calculated by a third party library each midnight UTC (in legacy cumulus), 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 (in legacy cumulus), 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 (in legacy cumulus), 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>
| Approximate length of daylight in hours and minutes (dawn to dusk) - if your timezone is UTC or a few hours off that,  the dusk may well be that just passed, and the dawn that to come as at the zero hours UTC when Cumulus 1 does this calculation
|-
|<#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, basically because of the note for <#daylightlength>, and its use was not recommended. Its use is therefore not supported by Steve Loft (i.e. you use it at your own risk) in the legacy Cumulus.
|-
|<#moonphase>
|Current [[Lunar phase|phase of the moon]] in words, eg "New Moon" etc. The names used can be altered in [[Strings.ini#Moon_Phases|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"
 
There is some PHP script code below this table showing how this can be converted to days, hours, minutes, seconds*
 
If the "dp" parameter is supplied, then 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>
| see [[#Today.ini]] Miscellaneous
|-
|<#SunshineHoursY>
|see [[#Yesterday]] Miscellaneous
|-
|<#CurrentSolarMax>
|[[FAQ#What_is_this_.22Solar_Max.22_value_which_Cumulus_is_displaying.3F | Current theoretical maximum solar radiation]]
|-
|<#IsSunny>
|Returns 1 if the sun is shining, otherwise 0 (Solar sensor needed)
|}
<pre>
* Footnote: PHP code extract:
$MoonAgeDays = <#MoonAge dp=0> +0;
$moonDecimalPart = <#MoonAge dp=4> - $MoonAgeDays;
$MoonAgeHours = round($moonDecimalPart * 24, 0);
$MoonAgeMinutes  = round(($moonDecimalPart * 24 * 60) - ($MoonAgeHours * 60), 0);
$MoonAgeSeconds = round(($moonDecimalPart * 24 * 60 * 60) - ($MoonAgeHours * 60 * 60) - ($MoonAgeMinutes * 60), 3);
$MoonAge      =    $MoonAgeDays . '&nbsp;days, ' .  $MoonAgeHours . '&nbsp;hours, '
. $MoonAgeMinutes . '&nbsp;minutes, ' . $MoonAgeSeconds . '&nbsp;seconds';
// Change the English words 'days, ', ' hours, ', and 'minutes' to the equivalents in your language</pre>
 
==Alarms==
 
[[File:badge v1.png]]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.
 
[[File:Badge vMx.png]]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'.
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:600px" |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
|-
|<#DataSpikeAlarm>
|[[File:Badge vMx.png]] Available from version 3.7.0
 
Alarm raised if a data spike is detected, or a data limit exceeded
|-
| <#HttpUploadAlarm>
|[[File:Badge vMx.png]] Available from version 3.11.2
 
Alarm raised if a HTTP upload alarm has been triggered
|-
| <#MySqlUploadAlarm>
|[[File:Badge vMx.png]] Available from version 3.11.2
 
Alarm raised if a MySQL upload alarm has been triggered
|-
| <#UpgradeAlarm>
| Alarm raised if MX upgrade (a newer release) is available
|}
 
== 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).
 
=== Differences depending on Cumulus versions ===
 
[[File:Badge v1.png]] Cumulus 1.9.x supports all the web tags listed in table below, with the exception of those relating to "humidex" and "feels like".
 
[[File:Badge v1.png]] For Cumulus 1 the tags are cleared in one of two ways:
#Generation of a web page where the web tag is set, clears the record for that web tag.
#Viewing of an extreme screen tab clears all records listed on that tab.
 
[[File:Badge vMx.png]] For versions up to 3.5.0 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). From version 3.7.0, Cumulus MX offers all the web tags listed in table below, at earlier versions it offers a subset of those listed.
 
[[File:Badge vMx.png]] For MX these web tags will be set from the time of the record until a timeout value is met (by default each record remains set for 24 hours).
 
'''You can change the default MX timeout''':
*Add a <tt>RecordSetTimeoutHrs=NN</tt> entry to [[Cumulus.ini#Section:_Station|[Station] section in Cumulus.ini]]
*'''NN''' can be set to any reasonable integer representing hours (for the default set the number '''NN''' to '24').
 
=== Table of web tags available for extreme records ===
 
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:600px" |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.
* [[File:Badge vMx.png]]In Cumulus MX: 1 from when new record is set until
** either all records have cleared
** or until next rollover is completed,
** or (in recent releases) until the number of hours for clearing extreme record notifications has passed
* 0 otherwise
* [[File:Badge v1.png]]In Cumulus 1.x.x:
** 1 if 'new record' light is flashing,
** 0 if not
|-
|<#TempRecordSet>
|1 if any temperature-based extreme has been updated, 0 if not
|-
|<#HighTempRecordSet>
|1 if the all-time highest temperature extreme has been updated, 0 if not
|-
|<#LowTempRecordSet>
|1 if the all-time lowest temperature extreme has been updated, 0 if not
|-
|<#HighTempRangeRecordSet>
|1 if the all-time high daily temperature range extreme has been updated, 0 if not
|-
|<#LowTempRangeRecordSet>
|1 if the all-time low daily temperature range extreme has been updated, 0 if not
|-
|<#HighAppTempRecordSet>
|1 if the all-time high apparent temperature extreme has been updated, 0 if not
|-
|<#LowAppTempRecordSet>
|1 if the all-time low apparent temperature extreme has been updated, 0 if not
|-
|<#HighHeatIndexRecordSet>
|1 if the all-time high USA heat index extreme has been updated, 0 if not
|-
|<#HighHumidexRecordSet>
|[[File:Badge vMx.png]]1 if the all-time high Canadian Humidity index extreme has been updated, 0 if not (from version 3.7.0)
|-
|<#LowWindChillRecordSet>
|1 if the all-time greatest wind chill extreme has been updated, 0 if not
|-
|<#HighFeelsLikeRecordSet>
|[[File:Badge vMx.png]]1 if the all-time high feels like temperature extreme has been updated, 0 if not (from version 3.6.0)
|-
|<#LowFeelsLikeRecordSet>
|[[File:Badge vMx.png]]1 if the all-time low feels like temperature extreme has been updated, 0 if not (from version 3.6.0)
|-
|<#HighDewPointRecordSet>
|1 if the all-time high dew point extreme has been updated, 0 if not
|-
|<#LowDewPointRecordSet>
|1 if the all-time low dew point extreme has been updated, 0 if not
|-
|<#HighMinTempRecordSet>
|1 if the all-time high minimum temperature extreme has been updated, 0 if not
|-
|<#LowMaxTempRecordSet>
|1 if the all-time low maximum temperature extreme has been updated, 0 if not
|-
|<#HighWindGustRecordSet>
|1 if the all-time high wind gust extreme has been updated, 0 if not
|-
|<#HighWindSpeedRecordSet>
|1 if the all-time high wind speed extreme has been updated, 0 if not
|-
|<#RainRecordSet>
|1 if any rainfall based extreme has been updated, 0 if not
|-
|<#HighRainRateRecordSet>
|1 if the all-time high rain rate extreme has been updated, 0 if not
|-
|<#HighHourlyRainRecordSet>
|1 if the all-time high hourly rain extreme has been updated, 0 if not
|-
|<#HighDailyRainRecordSet>
|1 if the all-time high daily rain extreme has been updated, 0 if not
|-
|<#HighMonthlyRainRecordSet>
|1 if the all-time high monthly rain  extreme has been updated, 0 if not
|-
|<#LongestDryPeriodRecordSet>
|1 if the all-time longest dry period extreme has been updated, 0 if not
|-
|<#LongestWetPeriodRecordSet>
|1 if the all-time longest wet period extreme has been updated, 0 if not
|-
|<#HumidityRecordSet>
|1 if either the highest or lowest humidity extreme has been updated, 0 if not
|-
|<#HighHumidityRecordSet>
|1 if the all-time high humidity light extreme has been updated, 0 if not
|-
|<#LowHumidityRecordSet>
|1 if the all-time low humidity extreme has been updated, 0 if not
|-
|<#PressureRecordSet>
|1 if either the highest or lowest pressure extreme has been updated, 0 if not
|-
|<#HighPressureRecordSet>
|1 if the all-time high pressure extreme has been updated, 0 if not
|-
|<#LowPressureRecordSet>
|1 if the all-time low pressure extreme has been updated, 0 if not
|-
|<#WindRecordSet>
|1 if any wind speed based extreme has been updated, 0 if not
|-
|<#HighWindrunRecordSet>
|1 if the all-time high wind run extreme has been updated, 0 if not
|}
 
==Special tags==
 
 
 
===Davis===
 
'''Please be aware that the tags available are not the same in all versions.
[[File:Badge vMx.png]]At present this table has not yet been updated for latest MX version.'''
 
All (see note for THSWindex) of the following web tags for the Davis PWS are available from Cumulus 1.9.2. Most of the following web tags are available in Cumulus MX 3.0.0 beta from build 3019, Storm tags from 3021.
 
'''Both flavours update the values of the reception tags every 15 minutes.''' In Cumulus 1 this applies from 1.9.3, in 1.9.2 they were read, and updated, every minute, in earlier versions not available.
 
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:120px" |Applicability
!style="width:600px" |Function
|-
|<#DavisTotalPacketsReceived>
|1.9.2 onwards and MX
|Total number of data packets received. This stat is not supplied by the Davis WLL station.
|-
|<#DavisTotalPacketsMissed>
|1.9.2 onwards and MX
|Number of missed data packets. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats.
|-
|<#DavisMaxInARow>
|1.9.2 onwards and MX
|Longest streak of consecutive packets received. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats.
|-
|<#DavisNumCRCerrors>
|1.9.2 onwards and MX
|Number of packets received with CRC errors. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats.
|-
|<#DavisNumberOfResynchs>
|1.9.2 onwards and MX
|Number of times the console resynchronised with the transmitter. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats
|-
|<#DavisFirmwareVersion>
|1.9.2 onwards and MX
|The console/WLL firmware version
|-
|<#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.
[http://digitalcommons.unl.edu/cgi/viewcontent.cgi?article=1223&context=animalscinbcr  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.8.9 onwards and MX
|The transmitter battery condition, by default it returns the status of all transmitters. (This was displayed from version 1.9.4 to 1.8.9 on the main screen).
'''Cumulus 1.9.3 onwards 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
|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 [[Webtags#Time.2FDate_.27format.27_Parameter| date/time formatting]] can be applied to that date.
|The console reported '''date''' of the start of the 'storm', you can use [[Webtags/Parameters#Which_tag_names_take_date.2Ftime_output_formatting_modifiers|date output format modifiers]]
|}
 
(Note that the console does not report start time, so the web tag cannot report time.  It appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTip> in a MX script might help)
|}
 
===Davis WLL ===
 
New from version 3.6.0. Not available for earlier MX, not available for Cumulus 1.
 
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:600px" |Function
|-
|<#DavisReceptionPercent tx=1>
|WLL transmitter reception percentage (replace 1 by any other transmitter number up to 8)
|-
|<#DavisTxRssi tx=0>
|WLL RSSI of the WiFi connection
|-
|<#DavisTxRssi tx=1>
|WLL RSSI of Transmitter #1  (replace 1 by any other transmitter number up to 8)
|}
 
 
 
 
 


===Fine Offset===
===Fine Offset===
Line 2,426: Line 2,971:
0 if contact has been established
0 if contact has been established
|}
|}
===Ecowitt GW1000===
There are a set of tags for the Ecowitt WiFi gateway GW1000:
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:600px" |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 [[FAQ#What_formula_does_Cumulus_use_for_Apparent_Temperature.3F | calculated]] in a script from the RC tags for 'outside temperature', 'wind speed', and 'relative humidity' values. In php language this is <tt>$RCapptempCALC =  round(<#temp> + (0.33 * (<#hum> / 100 * 6.105 * exp (17.27 * <#temp> / (237.7 + <#temp>) ))) - (0.7 * $wspeed) - 4.0, 2);</tt>.
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. <tt><#tempYH rc=y></tt> 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

Latest revision as of 19:57, 9 November 2022

Some content has been removed from this page

Please be aware some content originally on this page has been moved to other pages. Old posts on the support forum that used to link directly to the specific material, will instead bring you to this start of the page.

Where the old content was cut, new links have been substituted within three sections on this page: #Input Modification Parameters and Output Modification Parameters, #The tag name, and #Recent History.

Essential Background Reading

If you have not used this Wiki page before, or are unsure about using "web tags", there are some concepts that you do need to understand in the sub-sections that follow.

The tag names

All the "tag_names" that are available for legacy 1.9.4, and for MX up to first beta build release 3.12.0

are in #Full List of Tag Names later on this page.

If you edit this page, to add tag names for later builds, please amend the previous sentence.

If you are using a Oregon Scientific weather station, then you should read #Web tags mentioning (outside) temperature in the optional reading section.

Do not assume that Cumulus always works according to normal meteorological practice in your nation. For examples, the hours used by Cumulus to report derivatives involving rainfall, or minimum temperature, may vary from figures reported by local meteorological stations.

Quick summary of MX and Legacy differences

Cumulus MX versus original Legacy Cumulus 1

The full information that used to appear on this page for differences between MX and the legacy Cumulus has been moved to a new Web tag Applicability page. The next subsection just gives a basic summary.

Badge vMx.png This page has been updated to include web tags up to version 3.12.0 beta build 3134. Announcements for new builds of MX generally provide too little information for it to be easy to update this page, that is why it is often out of date.

  • Since version 3.10.x, MX has not used web page templates, please see WebsitedataT.json page, instead of this Wiki page.
    1. That page explains the ID names used on the default web site introduced from release 3.10.0
    2. That page documents each data pair in the file
    3. That page gives the source web tag for each ID name on the web pages
    4. That page explains what data is represented by the ID name, JSON attribute, web tag name
  • Past MX releases 3.0.0 to 3.9.7 used web template files, similar to (but not same as) the legacy software
    • This Wiki page remains organised according to the content of those old template files.

Badge v1.png This page was created for Cumulus 1. Steve/Beth Loft provided some example web template files, but expected Cumulus users to develop their own Cumulus template files making use of the web tags, listed below, that the software provided.

For tag names available in the release you are using, see the next sub-sections.

What web tags can I use?

Basically, it depends on which web tags are in whatever files are used to transfer weather derivatives to your web server.

As Cumulus has developed, more tag names have been introduced, the tables showing tag names available, attempt to give an indication of which release introduced them. You can, see below, ask Cumulus (both MX and legacy) to list all the tag names it recognises, when it is started at whatever build you are running.


Using release after 3.9.7?

If you are using the default web site, its standard web pages show data as follows:

If you are using your own web templates, or other own Cumulus template files such as XML or PHP data files, then you make the decision on which tag names are used for the data to your web server.


Getting release 3.12.0 or later to list tag names when it starts

Please use the admin interface.

Go to Program settings → General options

Tick List web tags.

The next time that MX is restarted, it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.

Go to Program settings → General options, untick List web tags to stop Cumulus continuing to produce new versions of that file next time it is restarted.


Getting legacy Cumulus, or MX releases up to 3.11.4, to list tag names when starting

The tag names available in the release/version/build you are using, can be listed (in Cumulus 1 or Cumulus MX) by adding the following line to Cumulus.ini in the [station] section... ListWebTags=1

Then start Cumulus and it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.

To stop Cumulus continuing to produce new versions of that file change the line to say ... ListWebTags=0

Badge v1.png If you are using Cumulus 1, each build of that contains a build specific version of Cumulus Help, and within that help is a list of web tags with basic information on what each tag_name returns.

Badge vMx.png MX bug: The inclusion of a web tag in the list produced by this instruction, does not mean that web tag is actually populated with valid information. See https://cumulus.hosiene.co.uk/viewtopic.php?p=153096#p153096 for an example.

What is a web tag?

Weather values are always changing, so Cumulus needs a way for you to tell Cumulus to enter the current value for a particular derivative, when it is processing templates.

General Format for Web Tags

In the position, in any (HTML, JSON, PHP, XML) template file, SQL, or Custom HTTP, where Cumulus is to insert the relevant data, place a web tag in the general format specified here: <#tag_name [optional input selection parameters] [optional output modification parameters]>

The optional parameters

The terminology "optional" is used because some tag names do not accept any parameters, but there are some tag names where a parameter is mandatory. Therefore, check the web tag parameters page to learn whether a web tag name you find here requires a mandatory parameter, or to find out which parameters are optionally available.

The tables of tag names that appear later on this page will seldom give any information about which parameters are mandatory or optional. There are tables on the other page referenced above that help you to understand what parameters the various tag names accept, explain each of the parameters available, and give examples.

There is a basic guide to what these parameters can do, and another link to the new page at #Input Modification Parameters and Output Modification Parameters later on this page.


Inconsistency of tag names

For both the legacy Cumulus and for MX, it is vital that you use tag names exactly as they are listed. That would be easy had Steve Loft created a naming standard and stuck to it.

To be fair to Steve, he created the legacy Cumulus for his own use, working in his spare time, alongside a full time job.

Remember, the original design did not anticipate use by others, nor how much extra functionality would be added later.

Early versions of Cumulus could only report current values and the summary for the day so far. Different web tags for today-so-far were added at different times, hence the names are inconsistent. New web tags for today-so-far added before yesterday tags were considered lack the T suffix (or prefix) later today-so-far tags use.

All-time tags were introduced before yesterday, this month and this year; hence all-time tag names assume they are only extreme monitoring.

The legacy tag names for this month and this year were all introduced in a single release and they remain consistent apart from what MX added later! However, they are not consistent with the naming of the all-time extremes introduced much earlier.

This great inconsistency in the naming, gives rise to a problem as it very easy to spell a tag_name incorrectly (and from time to time such mistakes creep into the tables on this Wiki page) as you naturally expect there to be a standard pattern. Some tags are all lower-case, some are camel-case, and some start with a capital letter. Have a look yourself at just how much inconsistency is present in the names in the tables below.


Inconsistency in use of "Y"

The character "Y" has been selected to denote yesterday in tag names. The inconsistency is where it appears.

  • Steve used Y as a suffix for most, not all, Cumulus 1 yesterday tags (e.g. <#rfallY>, <#windrunY>, <#YSunshineHours>, <#avgtempY>)
  • Mark uses Y as a prefix, in most, not all, the extra Cumulus MX tags (e.g. <#Ybeaufort>, <#Ychillhours>, <#windAvgY>)
Consistency in Cumulus 1, becomes inconsistency in MX, for this month and this year

The legacy tag names for this year and this month were all introduced together by Steve in one release, with consistency in how they were named then, "Month" or "Year" was used as a prefix (this was after he had started using "Y" as a prefix for his new yesterday tag names) e.g. <#YearLongestDryPeriod>.

The development of MX however, broke this consistency, as Mark adds "Year" as a suffix, e.g. <#SunshineHoursYear>, instead of following Steve by using a prefix.

Inconsistency in use of "T"

I said above, that early versions of Cumulus only had tag names for current spot values and for today-so-far daily means/extremes/totals. Therefore it could be assumed that <#beaufort>, <#temp> and <#press> all represented current spot values while <#avgtemp> and <#rfall> represented today-so-far values just by looking at their names.

The current value tag names formed the basic part of tag names, extended for daily extremes with "TH" and "TL" added as suffixes (to represent daily highs and daily lows), (e.g. <#tempTH>, <#tempTL> and <#pressTH>, <#pressTL>), which made a lot of sense. Adding a "T" for related times, made some sense, except that use of "T" was not done in a consistent manner (e.g. <#TpressTH>, <#Tbeaufort>, <#TtempTH>, <#YearTempHT>).


The functionality that can use web tags

In the legacy Cumulus software, the only functionality that could use this was the Cumulus template file used to provide data to a web server. That is why Steve Loft, the author of that software named them web tags.

MX has extended the use of these web tags, they can now be inserted into a SQL commands, Custom HTTP, application programming interface, as well as template files.

The output file can be:

Optional Background Reading

Web tags mentioning (outside) temperature

For Oregon Scientific weather stations using, either USB connections (e.g. WMR-200), or serial connections (e.g. WMR-928), that can have multiple temperature sensors, it is possible to configure which sensor the outdoor temperature (for which daily and longer period extreme records are maintained) is read from, by following this set of instructions originally supplied by Steve Loft:

  1. Stop Cumulus in the normal way
  2. Use a text editor to edit the file called Cumulus.ini
  3. Scroll down to the line that contains [Station]
  4. Create a blank line below it by pressing Return
  5. In that new line, type the command shown in the relevant code box below, type the attribute and equals sign exactly as shown without spaces (regardless of your exact model),
    • USB connections → WMR200TempChannel=N
    • Serial connections → WMR928TempChannel=N
  6. Now edit the value shown after the equals sign, replace N with the relevant number from the following list:
    • To use the main sensor, replace N with 0 (or don't bother with this procedure, as that is default)
    • To use Extra Temp 1 sensor, replace N with 1
    • To use Extra Temp 2 sensor, replace N with 2
    • and so on, up to a possible maximum (check with your weather station, but Cumulus can accept up to 12)
  7. Save the file, and exit
  8. Restart Cumulus in the normal way


For other weather stations, the main outdoor temperature sensor is used for what is reported for current value, daily extremes, and longer period extreme records. This temperature is also used for calculation of derived values such as Australian Apparent Temperature, Canadian Humidity Index, and USA Heat Index.

Please check release announcements, it is planned that swaping of main Temperature sensor will become available for Ecowitt.

Input Modification Parameters and Output Modification Parameters

In #Scary_statistics section of this page, it is explained how less than a thousand tag names (the first part of the #General Format for Web Tags) become billions of web tags, simply by adding modifiers.

The modifiers available used to be listed on this page (so if you select the history tab for this page, you will find references to their introduction and growth), but are now on a new web tag parameters page. Here are some of the advantages achieved by moving them to the new page:

  • This page is very long, so it is not easy to navigate this page, even without the parameters
  • There would be a lot of repetition if you attempted to say beside each tag name which modification parameters were available.
  • Having them on separate pages means you can have two tabs (or two separate browsers) open so you can see both the tag name and the modifier parameter by flicking between tabs, instead of lots of scrolling between different parts of same page.
  • The introduction of WebsitedataT.json, which controls what data is available to tables in the web pages provided by MX, means that page, rather than this page is the entry point for MX, and it is easier for that page to reference a separate parameters page
  • MX has introduced many more input and output modification parameters, it is easier to maintain a separate page (and easier for reference if you just want to refresh your mind on new modification parameters).


For just a taste, there you can discover:

  • A score of input modification parameters
    • For example, find which attribute is used with a value between 1 and 12, so the same tag name can give values for 12 different months)
  • If your locale normally (in real numbers) uses an integer part, then a comma, and then the decimal part, you should be aware that some computer scripts, and some external servers where you might want to send data, insist on a decimal point, instead of a decimal comma:
    • If you have installed a recent MX release, then change decimal comma to decimal point with a simple "y" value to another attribute
    • If you have the legacy Cumulus 1 installed, stay on this page and look at #No_Commas, as you have to use the restricted alternative set of tag names.
  • How to control number of decimal places in any real number output
  • All about the complex subject of modifying the way a duration, a date, or a clock time is output by looking at Multiple_Output_Format_Modifier_parameters_for_times_and_dates

Why does MX talk about tokens?

MX uses a token parser to read the web tags and replace them with the correct value, so if diagnostic output refers to tokens, it is saying the attempt to actually work out what content to return to replace the web tag with its tag name and parameters has encountered a problem.

Scary statistics

  1. The 3.5.0 release of MX defines 9½ million values that can be represented using web tags!
  2. At 3.5.0, there are only 717 options for the tag_name in the general format given above.
  3. How come this discrepancy?
  4. That discrepancy is purely because some of those 717 tag names can be associated with input parameters, (and for Oregon Scientific stations,you can select which sensor is used for outside temperature), these modifications affect what value is selected to be output by the web tag leading to the large number
  5. These millions of web tags can actually produce billions of different outputs!
  6. How come this second discrepancy?
  7. Well adding all possible different output parameters generates the billions of different ways to output the millions of values!

The statistics quoted above keep increasing as MX is developed, the last time I checked, there were another forty or so tag names, and lots more parameters, so the alternatives are probably well over ten billion now.

Brief history of this page

This page was created in August 2009, to list the tags for the (legacy) Cumulus 1 software. Initially, there were going to be further pages to explain individual web tags, e.g. Forecast_webtag; but that idea was never completed.

When MX came out of beta (3.0.0), it has been developing rapidly, as the statistics above suggest, the number of web tag names and input/output modification parameters, to document became too much for one Wiki page, hence the moving of all documentation about modification parameters to a sub-page. There are still a lot of web tag names to document on this page, and separation into a number of pages was considered, but it is easier to have just one page to refer in answers to questions raised in the forum.

Still got questions?

Full support is available via the support forum at https://cumulus.hosiene.co.uk/viewforum.php?f=40 for the latest MX release. Given that some users may still be running an older MX release, where possible any web tag listed below for MX indicates at which release it first became available.

There is limited support available for Cumulus 1.9.4, but on this page every attempt is made to indicate which version of the legacy software introduced any web tag listed below.

The web tag application programming interface

Badge vMx.png Available from version 3.7.0 (build 3089) released 28 July 2020. It was proposed in January 2015, see Steve Loft plan to add a call where you supply a list of items (probably web tag names), and you get back the equivalent data.

Where to use

This is meant for services either on the same computer as Cumulus or on your local network. It is not secure, and should not be available, nor requested, via any external network or the internet.

The MX Administrative Interface uses some application programming interface (api) calls to obtain the data each web page in that interface needs, and if you are making an edit, another api to return the results of any edit made.

If you wanted your CumulusMX/interface/todayyest.html web page to include something else (e.g. snow falling/lying/depth) you could edit that HTML page to have the extra sub-table you want (you cannot edit the existing rainfall table as that is dynamically created by existing api). Then you could edit the associated JavaScript file CumulusMX/interface/js/todayyest.js to add a new api call seeking snowdepth, snowfalling, snowlying tags for today (unfortunately there are no tags for yesterday's snow) and to place the returned values into your new sub-table (probably using jQuery to make it easy). In a similar way, you could add anything where today and yesterday tags are available such as UV Index.

In earlier versions of Cumulus if you wanted to make use of values processed by Cumulus, you wrote a script file referencing the web tags you wanted to use, and let Cumulus process that file at an interval set in the settings, then you had to write something to process the results at the relevant interval. Now if you are running other software on your device that runs MX (or a computer or other device linked directly on your personal network), you can request web tags values on demand via an application programming interface (api hereafter) and don't need to worry about any timing issues.

Obviously each api request creates a processing overhead on Cumulus so use this feature wisely (minimise the information you request and minimise the frequency of requesting it). You can use it for extra current information, but in that usage you might need to repeat the call. Consequently, maybe it is more likely that the api will be used to request information that does not keep changing, such as what units are being used for temperature, rainfall, and wind speed; or perhaps daily, monthly, or yearly, summary figures.

Each admin interface web page uses api techniques for all the information it needs. Some api calls are repeated with AJAX requesting updates for the weather information on a frequent basis, but each page has another api request that is issued just once for the version and build being used. To my mind, the design of CumulusMX/interface/todayyest.html is crazy. The HTML appears to have a table structure, but that table structure is overwritten by each repeating api. So every time AJAX repeats that api call it returns in json format the whole table definition as well as table cell contents, despite that much of that json (all that HTML defining table header, table rows, table cells, etc.; and the units for each value) does not change and it is only some values and times buried within the json in the api that actually might change (and of those half of them, the yesterday values and times only change once a day). In some code I wrote (but later abandoned) I made use of the api calls that support the CumulusMX/interface/todayyest.html web page to get the units I wanted on another interface page, but I only called it once as it returned a lot of other information (as just mentioned) that I did not need. I later found a better way, as in example below, which gives me just what I need and no more.

"GET" approach

You may have used GET as an attribute when defining the action of a HTML form. Equally you might in a script language access the query-string part of a Universal Resource Locator to get parameters for what the script is to supply to the web page. Even if you don't understand the meaning of those technical terms, you probably have seen when using a browser (in the box where a URL is entered) that sometimes the URL seen there has a query-string. You will have seen a question mark (?) followed by one or [separated by ampersand (&)] more name=value parameters. Full List of Tag Names The GET approach to using the Cumulus general api works in this way indicating the start of a query-string with a question mark and using ampersands to separate names. The difference is that a tag name (or list of tag names) is used instead of a name=value parameter (or list of name=value parameters). However, when the Cumulus api returns the values they will be in attribute=value format. Therefore if (like example below) you are coding in JavaScript, what is returned is a JavaScript Object and you extract the values by specifying the Object name and the Attribute name. If that technical terminology confuses you, look at the example.

Selecting values using GET

Suppose you want to get the values for the following three web tags:

  1. <#RCtemp>
  2. <#RChum>
  3. <#RCdew>

Then the URL with query-string to use is http: //localhost:8998/api/tags/process.json?rc&temp&hum&dew

Obviously, if you have started MX with a port parameter like this:

sudo mono CumulusMX.exe -port 9999

then you change the 8998 port shown in the URL for the api to use the port you have selected e.g. http: //localhost:9999/api/tags/process.json?rc&temp&hum&dew


The first parameter is rc to indicate that the tags that follow are to use decimal points not decimal commas, which is how many script languages expect to see values. Remember that in current version (and some earlier versions) of MX, the above three web tags are exactly same as:

  1. <#temp rc=y>
  2. <#hum rc=y>
  3. <#dew rc=y>

Since rc=y can be applied to several web tags that don't appear in Webtags#No_Commas table, this shows how the api can access values without commas for all those web tags that report in real numbers and allow that output modifier.

If you are using the api in a context where it does not matter if decimal commas or decimal points are in the api or for any tags that don't report in real numbers, simply omit the rc as first item, and just include tag names separated by ampersands.

JavaScript example

Some people might feel the admin interface could be improved on some of its pages by showing additional information. It is possible from MX 3.7.0 to obtain extra information.

I wanted to improve the log file editing pages, and that was partly by adding validation, and partly by changing the way the editing is done. For the standard log file editor I wanted to achieve even more, I added a script to calculate (and recalculate after any edit) the derived fields from the source fields. To make these calculations work for anyone, I needed to find out what units the Cumulus MX user is using. Before 3.7.0 release the snippet of script that obtained the units via various api calls was quite complex (I described above how the api returned lots of unwanted content), but with 3.7.0 my new api call was greatly simplified to what I show below. Please note my revised log file editing scripts did not make it into a public release, and it is only the units obtaining api that I am making available to public here.

Here is the code (with the api call written using jQuery):

/*    Some new variables connected with new api call (MX 3.7.0)  */
		var tempLetter;  // C or F
		var rainUnit; // mm or in
		var windUnit; // any units in style allowed by Cumulus
/*  The one extra api request included to obtain the units used for temperature, rainfall, and wind speed */
		$.get('./api/tags/process.json?tempunitnodeg&rainunit&windunit', "limit=1", callUnits);
		function callUnits(unitsObject)
		{
			tempLetter = unitsObject.tempunitnodeg;
			rainUnit = unitsObject.rainunit;
			windUnit = unitsObject.windunit;
			console.log("new api", tempLetter, rainUnit,windUnit);
		}

A little bit of explanation might help:

  • JavaScript variables generally need to be declared first, I have used 3 separate line each starting with var, but you can list several variables on one line using a comma to separate them
  • In my script it is important to define these variables outside the function as I will explain later
  • The jQuery get request takes the api URL as first parameter and the function to deal with the returned result as third parameter
  • The middle parameter is irrelevant in this context as only one object instance is returned, but if the qet was returning multiple results, "limit=1" would only return the first result
  • The function takes as its sole parameter an Object (a JavaScript Object is a collection of properties), this is what is returned by the api, an object can be given any variable name
  • In JavaScript if a variable is defined outside the function, then given a value inside the function, that value can be accessed by later code outside the function (in my case by code within the other functions for calculating each derived value)
  • We are only interested in 3 of the property_name = property_value items in the Object.
  • The JavaScript refinement syntax (starts with a dot) can be used to find the value for any parameter we name. We assign the variable already defined to the object and its refinement (that specifies the attribute we want).
  • The console.log command simply outputs all the items in the list within the brackets into the browser console that in many browsers is displayed by selecting F12 on the keyboard. I included this instead of the lengthy rest of my code that uses the units to do the various calculations correctly.

"POST" approach

The word "Post" in a computer environment means that the Hypertext Transfer Protocol (HTTP) used by the internet is being asked to transfer information enclosed in the body of the request message. Put slightly less technically in this approach you produce a text file with the details of what tags you want and send it to the api server. I suppose it is a bit like sending an email, its header (subject, author, date sent) is easy to view, but you need to open it to see what text is in the body.

You may have used POST as an attribute when defining the action of a HTML form. In that context the form is sent as the contents of a message to whatever web page is going to process the contents of that form.

The post approach has a few advantages over get:

  • The parameters are not shown in any query-string, so are not obvious to the person looking over your shoulder, nor do they appear in a history list of sites that the browser has visited.
  • If you fill out a form online, the post approach will be used as the content needs to be kept secure.
    • The get approach may be seen when you are navigating through a web site, and a selection is being remembered.
  • The POST approach can handle very long requests and return a lot of information.
    • In contrast, a URL with query-string is restricted in total length (the restriction is dependent on a number of other factors, but might be at something like 1000 characters in total), so GET comes with a restriction on how many parameters can be specified.

See https://cumulus.hosiene.co.uk/viewtopic.php?p=145050#p145050 for post example


Full List of Tag Names

Crystal Clear info.png This document is 'Work In Progress' so content may not be complete.

Request for help from Wiki Readers

  • Do you understand how MX works?
  • Do you use hardware, or MX functionality, that is not yet documented? Can you begin that documenting?
  • Can you contribute simple text for novice users, examples of what you have done, correction of typing or factual errors, or supply missing details?
  • Will you make this page more useful by bringing content up-to-date as new releases change some information written for older releases?
  • Does any page need a section for novices, so they don't need to read more technical information further down that page?
  • Is there some information on this page, that should be on a separate page? Can you create the new page and move the less relevant information off this page, don't forget this page needs a link to the new page so people who expect to find it here know where it has moved to?

If you plan on contributing to the Wiki, then you will need an account.

  • Please use the Request Account form to apply for an account. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
  • You will find help on how to contribute to this wiki at How to Edit.
  • If you need to consult others, please use the Cumulus Wiki suggestions forum.

Please be aware that information on this page may be incorrect.

This list only contains the tag_names, don't forget tag_names are only part of the #General Format for Web Tags, for example in a template file you precede the tag name with <, you may need input parameters, you may need output parameters, and you end the full web tag with >.

it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.

Here follow tables that group the tag names by the basic purpose of the tags listed. There has been confusion in the past of tags appearing in more than one group, can contributors remove any remaining duplication, so future maintenance is easier.

There is a table of contents near the top of the page that you might find useful if you are interested in a particular tag group.

Current Conditions

We start with tags that relate to the latest values, as these are the ones that people most often choose to use. The current condition data is also available, for processes external to Cumulus, by using the inbuilt facility to generate a file with such data.

Cumulus software makes current values available for a standard range of sensors where the same web tags apply across a range of weather station models.

Both Cumulus 1 and MX offer current values from some extra temperature and relative humidity sensors (see Extra temperatures) from particular weather station models.

Recently, MX has been developed to support further extra sensors (see Extra Sensor Files page for full list of fields) and web tags have been added to support equivalent current values only.

Feels Like

Feels like temperature was first made available, just for current conditions at MX version 3.5.4. In version 3.6.0. it was extended to add max/min for each day, each month, each year, and all time. In version 3.6.11 it was added to recent history.


The figures quoted for this derivative vary between versions:

  • The first formula was used from MX version 3.5.4 (25 Apr 2020) build 3075 until version 3.6.7 (4 June 2020) build 3083
  • The second formula, which was coded incorrectly, and so gave strange results, applied in versions 3.6.8 to 3.6.9 (build 3084, 3085)
  • The third, and hopefully final, formula applies from version 3.6.10 (build 3086).

A php script for adding feels like as calculated in version 3.6.10 to any standard log line created either without feels like, or with an older (now incorrect) calculation, can be downloaded from Create Missing topic on support forum. Obviously, this calculates from the small sub-set of current conditions that have been logged, and is not as accurate at deriving maximum and minimum as derivation made as each reading is processed by MX (so including all current conditions).

The Create Missing utility will not correct the older (incorrectly calculated) figures, but will add Feels Like temperature values to any standard log line created by Cumulus 1, by MX prior to release 3.5.4, or if you have imported lines into the log from an external source.

Standard sensors

The web tags shown here are mainly determined by which appeared on the original "Now" legacy web page (index.htm).

Consequently, the totals for 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; although you might expect to find them listed in tables for this month and this year, those web pages do not show these derivatives.

Those listed here cover both measurements obtained from a weather station (like air temperature, wind speed and direction, humidity and barometric pressure); and all the derived values (like humidex, feels like, apparent temperature, wind chill, and heat index).

Note however, that the derived values calculated for Cumulus 1 and for MX may not agree because of differences in the calculation formulae, see derived value section within Recent History tags section for examples.

Web tag_name Function
Temperature
<#temp> The outside (air) temperature

For Oregon Scientific models like WMR-200 with USB connection or models like WMR-928 with serial connections, please refer to #Web tags mentioning (outside) temperature because any of the extra sensors can be reported in <#temp>, and consequently also have web tags reporting daily extremes and longer period extreme records.

<#intemp> The inside temperature
<#TempChangeLastHour> The change in outside temperature over the last hour (not available in early versions of Cumulus 1, when this was announced, a temperature change over 24 hours was also proposed, but never implemented)
<#temptrend> The average rate of change in temperature over the last three hours. Trend = (temp_now - temp_3hrs_ago) / 3 (available in all releases, the calculation selected for this trend matches the standard-based calculation for <#presstrendval> despite the naming inconsistency)
<#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). From version 1.8.8 1st December 2009
<#heatindex> Current heat index. The referenced page in weather terminology section of this Wiki explains it.
<#humidex> Current Humidex
<#apptemp> The apparent temperature. The referenced page in weather terminology section of this Wiki explains it. The formula used is that defined by BOM. Although at temperatures above 20°C (68°F) Feels like reports an "apparent temperature" it uses a different formula.
<#wchill> The current wind chill temperature. The referenced page in weather terminology section of this Wiki explains it. For temperatures below 10°C (50°F) Feels like reports the same value.
<#feelslike> Badge v1.png Not available in Cumulus 1.

Badge vMx.pngNot available in all MX versions. Please see sub-section before this table regarding availability by MX versions if you are using a MX version earlier than 3.6.10.

The current Feels Like temperature. The referenced page in weather terminology section of this Wiki explains it.

<#IsFreezing> If outside temperature is at or below 0°C/32°F. 0=Above freezing, 1=Below freezing
<#chillhours> The number of 'chill hours' so far this season (threshold temperature and start date are configurable).
Humidity
<#hum> The outside humidity
<#inhum> The inside humidity
<#dew> The current dew point
<#wetbulb> Estimated wet bulb temperature, can be seen if hover over 'Dew point' on Cumulus 1 main screen
Rainfall
<#rfall> The total rainfall so far today (reports rain counter now minus rain counter at start of day), start of day counter can be edited using "edit rain 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> Reading recent history records, takes rain counter for latest minute, and substracts rain counter from as close as possible to same time yesterday (if Cumulus was not running at that time yesterday, but historical catch-up has been enabled, then it is from nearest time available yesterday, so for a logging interval of every 30 minutes might be 24 hours and 16 minutes ago)
<#LastRainTipISO> Fixed ISO format output giving date and time of last rain gauge tip (e.g 2010-09-06 06:09) The format is always as shown (cannot use output format modifiers)
<#LastRainTip> (available from release 3.6.1) Date/time of last rain gauge tip (default format is as set in locale) 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)
<#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
Pressure
<#press> The sea level pressure
<#presstrendval> The average rate of pressure change over the last three hours. Trend = (pressure_now - pressure_3hrs_ago) / 3 (Fixed from version 1.7.7 5th March 2008)
<#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). From version 1.8.8 1st December 2009
<#PressChangeLast3Hours> Badge vMx.png Available from version 3.11.1

Total Pressure Change since 3 hours ago

<#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 configured interval minutes. Range 1-360, 0=Calm

This is calculated by taking the wind direction and speed for the last 10 minutes (or other interval as configured), calculates the sums of the North/South and East/West vector components, divides the E/W component sum by the N/S component sum, and takes the arctan.

<#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.
<#WindSampleCount> The number of wind samples making up the wind rose (etc) data (up to 3600)
<#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 tag. Reading interval x varies by station type (see above).
<#nextwindindex> The index of the entries in <#wdirdata> and <#wspddata> that 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!
<#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), as configured on display settings screen
<#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
<#forecastJsEnc> Badge vMx.png Available from version 3.11.0

The current forecast encoded for JavaScript

<#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
<#cumulusforecastJsEnc> Badge vMx.png Available from version 3.11.0

The current Cumulus (Zambretti) forecast encoded for JavaScript

<#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
<#wsforecastJsEnc> Badge vMx.png Available from version 3.11.0

The current station forecast encoded for JavaScript

<#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 for example this would encode any use of symbol for degree.

Extra Sensors

Some tags are only available for certain builds, if the tables below do not say which releases they apply to, see general tip at top of page to check for the build you are using. In particular Cumulus 1 has fewer channels available in its earlier versions, and the final legacy software version 1.9.4 offers just 42 of the 62 extra sensor web tags available in MX.

The extra sensors functionality in Cumulus only supports processing for current spot values as read from the sensors, the only processing is to convert the units ready for output, so only current conditions can be reported in web tags.

Periodically spot extra sensor values are logged, see the Extra_Sensor_Files page for information about log files from where you can extract the past spot values.

Extra Sensors: Davis models and Oregon Scientific WMR928, WR100/200

These web tags hold current values for additional sensors supported by Cumulus 1 and MX.

For Oregon Scientific model like WMR-200 with USB connection, please refer to #Web tags mentioning (outside) temperature because any of the extra temperature tags below can be redirected to <#temp>, and consequently also have web tags reporting daily extremes and longer period extreme records.

Web tag_name The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in viewer/editor
<#ExtraTemp1 - 10> Extra temperature channel 1 to channel 10
<#ExtraDP1 - 10> Extra dew point channel 1 to channel 10
<#ExtraHum1 - 10> Extra humidity channel 1 to channel 10
<#SoilTemp1 - 16> Soil temperature channel 1 to channel 16
<#SoilMoisture1 - 16> Soil moisture channel 1 to channel 16
<#LeafTemp1 - 4> Leaf temperature channel 1 to channel 4
<#LeafWetness1 - 4> Leaf wetness channel 1 to channel 4

Extra Sensors: Davis AirLink

New from version 3.9.0. Not available for earlier MX, not available for Cumulus 1.

Note, that you can configure an Indoor or Outdoor (or both) AirLink, most people will use an outdoor. There are a similar set of tags for each device.

Web tag_name Function
Particulate Matter
<#AirLinkPm1[InǀOut]> Current particulate matter of 1 μm, or less count
<#AirLinkPm2p5[InǀOut]> Currentparticulate matter of 2.5 μm, or less, count
<#AirLinkPm2p5_1hr[InǀOut]> Last hour average particulate matter of 2.5 μm, or less, count
<#AirLinkPm2p5_3hr[InǀOut]> Last 3 hours average particulate matter of 2.5 μm, or less, count
<#AirLinkPm2p5_24hr[InǀOut]> Last 24 hours average particulate matter of 2.5 μm, or less, count
<#AirLinkPm2p5_Nowcast[InǀOut]> The 24 hour "nowcast" weighted average particulate matter of 2.5 μm, or less, count
<#AirLinkPm10[InǀOut]> Current particulate matter of 10 μm, or less, count
<#AirLinkPm10_1hr[InǀOut]> Last hour average particulate matter of 10 μm, or less, count
<#AirLinkPm10_3hr[InǀOut]> Last 3 hours average particulate matter of 10 μm, or less, count
<#AirLinkPm10_24hr[InǀOut]> Last 24 hours average particulate matter of 10 μm, or less, count
<#AirLinkPm10_Nowcast[InǀOut]> The 24 hour "nowcast" weighted average particulate matter of 10 μm, or less, count
Air Quality Index Values
<#AirLinkAqiPm2p5[InǀOut]> Current particulate matter of 2.5 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm2p5_1hr[InǀOut]> Last hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm2p5_3hr[InǀOut]> Last 3 hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm2p5_24hr[InǀOut]> Last 24 hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm2p5_Nowcast[InǀOut]> Last 24 hour "nowcast" weighted average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm210[InǀOut]> Current particulate matter of 10 μm, or less value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm10_1hr[InǀOut]> Last hour average particulate matter of 10 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm10_3hr[InǀOut]> Last 3 hour average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm10_24hr[InǀOut]> Last 24 hour average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
<#AirLinkAqiPm10_Nowcast[InǀOut]> Last 24 hour "nowcast" weighted average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
Stats Values
<#AirLinkPct_1hr[InǀOut]> Percentage of possible values that were included in the 1 hour averages
<#AirLinkPct_3hr[InǀOut]> Percentage of possible values that were included in the 3 hour averages
<#AirLinkPct_24hr[InǀOut]> Percentage of possible values that were included in the 24 hour averages
<#AirLinkPct_1hr[InǀOut]> Percentage of possible values that were included in the 24 hour weighted averages
Sensor Info
<#AirLinkFirmwareVersion[InǀOut]> Shows the AirLink firmware version as a date string.

NOTE: This web tag requires a WeatherLink Pro subscription to work

<#AirLinkTemp[InǀOut]> The sensors internal temperatue value
<#AirLinkHum[InǀOut]> The sensors internal humidity value
<#AirLinkWifiRssi[InǀOut]> The sensors WiFi signal strength in dB - anything below -90 is considered very poor.

NOTE: This web tag requires a WeatherLink Pro subscription to work


Extra Sensors: Ecowitt

Ecowitt stations are sold under other names depending on nation, e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in same way as Fine Offset is used as a generic name for stations sold under a variety of branding, in this Wiki.

Badge v1.pngNot available in Cumulus 1.

Extra Sensors: Ecowitt WH45 CO₂ sensor

Badge vMx.png Unless otherwise indicated these web tags become available from release 3.9.5.

Web tag_name Function
<#CO2> The actual CO2concentration in ppm
<#CO2-pm2p5> Air Quality expressed in terms of particulate matter of 2.5 μm/m3 or less
<#CO2-pm2p5-24h> Air Quality expressed in terms of particulate matter of 2.5 μm/m3, or less, 24 hours moving average
<#CO2-pm10> Air Quality expressed in terms of particulate matter of 10 μm/m3, or less (yes, this includes the 2.5 figure)
<#CO2-pm10-24h> Air Quality expressed in terms of particulate matter of 10 μm/m3, or less, 24 hours moving average
<#CO2-temp> Temperature as reported by Air Quality monitor.

Note that this temperature has nothing to do with the temperature as reported by the main weather station. It reflects the temperature of the sensor and would be used in combination with the sensors measured humidity (see next) for correction of the measured PM (particulate matter) value. Determination of how to correct the PM value is highly dependent on the conditions and placement of the sensor. See the specification sheet for the sensor or create some multivariate regression line based on calibration measurements. This is also valid for PM sensors like the AirLink. The normal amateur usage of PM sensors is that the uncorrected values are published.

<#CO2-hum> Relative Humidity as reported by Air Quality monitor
Extra Sensors: Ecowitt WH34 soil and water sensor

Cumulus MX can support the Ecowitt WH34 (other model types exist and are reported here as if WH34) soil and water temperature sensors.

They are reported as "User Temperture 1" to "User Temperature 8", as listed in the table within next sub-section.


Extra Sensors: Ecowitt Air quality, leak sensors, lighting detector, and extra temperature sensors

Badge v1.png Not available in Cumulus 1.

Badge vMx.png Please see release announcements for when individual web tags became available

This sub-section applies only to those using Ecowitt GW1000 (also Froggit DS1500, and other equivalents, see Supported Devices) an interface unit that picks up various external sensors and sends the data via an application programming interface to MX which then generates the following web tags:

Web tag_name Function
<#GW1000FirmwareVersion> GW1000 firmware version string


Web tag_name The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in the viewer/editor
<#AirQuality1> Air quality in μm/m3 or less
<#AirQuality2> Air quality in μm/m3 or less
... and so on up to <#AirQuality4>
<#AirQualityAvg1> 24 hr running average Air quality in μm/m3 or less
<#AirQualityAvg2> 24 hr running average Air quality in μm/m3 or less
... and so on up to <#AirQualityAvg4>
<#LeakSensor1> Leak sensor 1 - returns false/true as 0 or 1
<#LeakSensor2> Leak sensor 2 - returns false/true as 0 or 1
... and so on up to <#LeakSensor4>
<#LightningDistance> Distance to last strike (same units as wind run - miles/km/nm) (Returns 0.0 if you don't have a sensor, GW1000 api returns max value you can put in a byte - 0xFF which translates to 158.4 miles = 255 km if have sensor but no strike detected yet, so MX translates that to '----')
<#LightningTime> Date and Time of last strike (default without output parameters is locale's short time format e.g. 18:02 or 6:02 pm, without date, but tag accepts both date and time output parameters). Returns '----' if you don't have sensor or there has not been a strike since the sensor was installed. (GW1000 api returns FFFF FFFF seconds after midnight on 01 Jan 1970, which translates to 07/02/2106 06:28:15, so MX translates that to '----')
<#LightningSrikesToday> Number of lighting strikes today
<#UserTemp1> User Temperature 1
... and so on up to <#UserTemp8> = User temperature 8

Recent History

Please refer to the Recent history page for full information about using the tags in the following two tables, as material once on this page has been moved there.

Using input/output modification parameters with recent history tag names

All tag names listed below, require the mandatory input modification parameters specified in this table.

The optional output modification parameters available are as specified in this table, depending on tag name:

Tag names Mandatory Input Modification Parameters Optional Output Modification Parameters
<#RecentTS> (see #Table of Recent History tag names available) Mandatory parameters as table at Webtags/Parameters#Input_modification_Parameters Optional parameters to modify the time format described in tables starting at Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates
All other tag names in #Available in 1.9.3, 1.9.4, and all MX releases and #Available in MX only Mandatory parameters as table at Webtags/Parameters#Input_modification_Parameters Whether you can modify the way these values are output depends on release you are using:

Table of Recent History tag names available

One tag name is available since 1.9.3 to report the time associated with values you request.

Although as Recent history page explains, the history is intended to cover every minute in last 7 days, some entries may be at less frequent intervals, and when clocks change some entries will be missing altogether.

Web tag_name Function Parameters example
Time-stamp tag
<#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

Available in 1.9.3, 1.9.4, and all MX releases

Tag_name Function Input Modification Parameters example
Temperature & Humidity tags
<#RecentOutsideTemp> Outside Temperature <#RecentOutsideTemp h=3 m=1> <#tempunit> will display the temperature at the start of the period for which <#temptrend> is calculated
<#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)
Wind
(Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings see Wind measurement)
<#RecentWindSpeed> Wind Speed <#RecentWindSpeed m=10> will display the average 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. 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
Pressure
<#RecentPressure> Sea-level Pressure <#RecentPressure h=3 m=1> gives the sea level pressure when <#presstrendval> started tracking the pressure
Rainfall
<#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)
Solar & UV
<#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)

Available in MX only

Please note this section has NOT yet been updated for recent MX releases, it appears from RecentData table in cumulusmx.db that the list here is not complete for MX. However, no release announcement has been found listing tag names not shown here (i.e. apparent temperature, indoor temperature and humidity, air quality)

tag_name Introduced Function Input Modification Parameters example
Indoor Temperature & Humidity tags
(to do)
Outdoor Temperature & Humidity tags
<#RecentWindChill> Legacy Cumulus version 1.8.5 Wind Chill (if temperature is below 10°C or 50 °F, then the new Feels Like now available in MX (next item) will report this same value). <#RecentWindChill d=48 m=1> reports the wind chill temperature 2 days ago
<#RecentFeelsLike> Available from version 3.6.11 (build 3087) onwards. Feels Like Temperature <#RecentFeelsLike h=12 m=1> reports the feel like temperature 12 hours ago
<#RecentHumidex> Available from version 3.7.0 (build 3089) onwards. Canadian Humidity Index (humidex) Dimensionless - no units <#RecentHumidex h=3> reports humidex 3 hours ago
Air Quality tags

System

Special tags returning information about the Windows device hosting Cumulus 1.

Badge vMx.pngIf you are running MX, then most tags do not work.

Web tag_name Applicability Function
<#OsVersion> up to 1.9.4, and MX OS version, e.g. "Windows 7 x64 build 7600"

Please note this may not return the information you expect!

<#OsLanguage> Both leagacy and MX OS language, e.g. "English"
<#SystemUpTime> (not available on MX)

Badge v1.png only in legacy Cumulus

How long the system has been up, e.g. "8 hours 21 minutes"
<#ProgramUpTime> all releases How long Cumulus has been running, e.g. "7 hours 55 minutes"
<#CpuName> (not available on MX)

Badge v1.png only in legacy Cumulus

CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
<#CpuCount> (not available on MX)

Badge v1.png only in legacy Cumulus

Number of processors, e.g. "4"
<#MemoryStatus> (not available on MX)

Badge v1.png only in legacy Cumulus

Free and total system RAM, e.g. "4619/8191 MB (free/total)"
<#DisplayMode> (not available on MX)

Badge v1.png only in legacy Cumulus

Screen display mode, e.g. "1680x1050, 32 bit"
<#AllocatedMemory> (not available on MX)

Badge v1.png only in legacy Cumulus

Amount of memory allocated to Cumulus, e.g. "18.76 MB"
<#DiskSize> (not available on MX)

Badge v1.png only in legacy Cumulus

Size of disk on which Cumulus is running, e.g. "931.51 GB"
<#DiskFree> (not available on MX)

Badge v1.png only in legacy Cumulus

Free space on disk on which Cumulus is running, e.g. "515.36 GB"

Miscellaneous

All tags are available in all flavours, as far as I know, although their output might vary, and which input/output parameters they permit might vary between Cumulus 1 and MX.

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)

<#NewBuildAvailable> Only available from release 3.7.0 onwards, it is checked on start-up and once a day thereafter at a random time
  • Returns a boolean value
    • 0 - MX running the latest build available
    • 1 - MX is running an earlier build that the latest public release
<#NewBuildNumber> Only available from release 3.7.0 onwards, it is checked on start-up and once a day thereafter at a random time

Displays the latest public release build number - eg. b3089

<#realtimeinterval> The real time 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: will always return one of these: 'Midnight', '9 am' or '10 am'

This is the end of the meteorological day, so if during Daylight Saving Time rolover is at "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. The default format of the output depends on your locale settings.
<#LastDataReadT> The date/time data was last read from the station. The default format of the output depends on your locale settings.
<#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;&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.

<#latitudeJsEnc> Badge vMx.png Available from version 3.11.0

JavaScript encoded of previous web tag that is HTML encoded

<#longitude> The station longitude (as you entered during setup). Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
<#longitudeJsEnc> Badge vMx.png Available from version 3.11.0

JavaScript encoded of previous web tag that is HTML encoded

<#altitude> The station altitude value (web tag outputs web encoded format containing figure, '&nbsp;' and units) in either feet or metres just as you entered during setup (so it is more complex to extract number for script arithmetic); e.g. '123&nbsp;m'
<#altitudenoenc> Badge vMx.png Available from version 3.11.0

JavaScript encoded of previous web tag that is HTML encoded

<#location> The station location (as you entered during setup)
<#locationJsEnc> Badge vMx.png Available from version 3.11.0

JavaScript encoded of previous web tag that is plain text

<#locationenc> Badge vMx.png Available from version 3.10.3

HTML encoded version of previous web tag that is JavaScript encoded

<#longlocation> Longer description of the station location (as you entered during setup)
<#longlocationJsEnc> Badge vMx.png Available from version 3.11.0

JavaScript encoded of previous web tag that is plain text

<#longlocationenc> Badge vMx.png Available from version 3.10.3

HTML encoded version of previous web tag that is JavaScript encoded

<#forum> URL of the forum (as you entered during setup) encoded into a web page menu item by adding colons

For Cumulus 1, this defaults to a Sandaysoft URL that is no longer available, for MX this defaults to the current support forum (web server site hosted by "Freddie")

<#forumurl> Badge vMx.png Available from version 3.10.0

Same as previous, but just URL, without any additional colons

<#webcam> URL of the webcam (as you entered during setup) encoded into a web page menu item by adding colons. Default is blank. Can be used to link to any other web page that you host (Cumulus does not verify that it is a web can, that is just a label, and the label can be changed on each standard web page individually)
<#webcamurl> Badge vMx.png Available from version 3.10.0

Same as previous, but just URL, without any additional colons

<#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)
<#LatestNOAAMonthlyReport> Gives file name of latest auto-saved NOAA monthly report
<#LatestNOAAYearlyReport> Gives file name of latest auto-saved NOAA yearly report
Options

Badge vMx.png Available from version 3.10.0

<#Option_useApparent> Whether user prefers to see Apparent Temperature or Feels Like Temperature
<#Option_showSolar> Whether user wants to show Solar data or does not not have a solar sensor
<#Option_showUV> Whether user wants to show Ultra Violet data or does not not have a UV sensor

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 "&deg;C" or "&deg;F"
<#tempunitnoenc> Badge vMx.png Available from version 3.11.0

JavaScript encoded of previous web tag that is HTML encoded (i.e. without & and without °)

<#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, except where marked as MX only, most of these web tags can be used with output parameters.

Web tag_name Function
<#date> The current date - format depends on locale you use to run Cumulus
<#metdate> The current meteorological date. The default format depends on the locale you use to run Cumulus
  • If you use midnight rollover, this returns same date as <#date> (above), but with a different default format.
  • If using a 9am/10am rollover:
    • After rollover time on current calendar date, this is same as <#date>, but with a different default format.
    • Between midnight and 9am/10am the <#metdate> will return the date associated with previous calendar day, but will still return current time

Legacy website: Can be used with relevant format parameters to customise todayT.htm template page to display current meteorological day, to customise thismonthT.htm template page to display meteorological month, and to customise thisyearT.htm template page to display correct meteorological year. This will be particularly useful on first and last day of month/year when rollover happens at 9 (or 10) a.m. and the month (and maybe year) is different before and after rollover.

Badge vMx.png Earlier MX releases provide a similar web template set, so these can be customised in same way as for legacy Cumulus above (but note capital "M" must be used for any month formatting). From release 3.10.1 the supplied web pages are web server based, there are no web templates to customise, and the supplied .json files do not include any meteorological date functionality.

<#timeUTC> The current UTC date/time rather than local date/time. Example result (actual format depends on locale settings): 18:30 on 30 December 2009. If you want the local date and time, use next tag (below).
<#time> The current time and date. Example result (actual format depends on locale settings): 18:30 on 30 December 2009. If you simply wish the time, use next tag (below).
<#timehhmmss> The current time (without date). Example format: 18:30:27. You can use output format specifiers to change the way the time is output, but any date specifiers are ignored.
<#minute> The current time, just the minutes. Fixed format: 07 (cannot use output format modifiers)
<#hour> The current time, just the hour. Fixed format: 07 (cannot use output format modifiers)
<#day> The current day as a 2-digit number. Fixed format: 07 (cannot use output format modifiers)
<#dayname> The current day as a word. For example, Monday (actual format depends on locale settings)
<#shortdayname> The current day as a shortened word. Example format: Mon
<#month> The current month as a 2-digit number. Fixed format: 07 (cannot use output format modifiers)
<#monthname> The current month as a word. Example format: July
<#shortmonthname> The current month as a shortened word. Example format: Jul
<#year> The current year as a 4-digit number. Example format: 2009 (cannot use output format modifiers)
<#shortyear> The current year as a 2-digit number. Example format: 09 (cannot use output format modifiers)
<#rollovertime> The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'

PHP code example for testing whether before or after rollover given in next entry.

<#metdateyesterday> The previous meteorological date. The default format depends on the locale you use to run Cumulus
  • If you use midnight rollover, this returns same date as <#date>, but with a different default format.
  • If using a 9am/10am rollover:
    • After rollover time on current calendar date, this is same as <#yesterday> (below), but with a different default format.
    • Between midnight and 9am/10am the date output by <#metdateyesterday> will be the calendar day before that returned by <#yesterday>, but the time returned is actual local time.

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.

if you use PHP Hypertext preprocessor, you can output different text for before and after rollover, e.g.

<?php
if('<#yesterday format=dddd>' == '<#metdateyesterday format=dddd>') echo '(calendar date and meteorological date same)';
else echo 'rollover still to happen, these results will be treated as belonging to <#metdate format=dddd>';?>
<#yesterday> Yesterday's date. The default format depends on the locale you use to run Cumulus
<#update> The date and time of the last web site update. The default format depends on the locale you use to run Cumulus
<#timeJavaScript> Badge vMx.pngAvailable from version 3.5.2, so not available in legacy software

The JavaScript Date object contains the number of miliseconds since 00:00:00.000 UTC on 1st January 1970, that date and time is known as the UNIX Epoch. In JavaScript, you can use Math.floor(new Date().getTime()/1000.0) This getTime method returns the time in milliseconds. The web tag returns an integer (currently with 13 digits) representing the number of milliseconds since the UNIX epoch when the web tag was processed. It can be used in a script where you wish to re-express other times output by Cumulus MX into UTC (Coordinated Universal Time). Mac OS X uses 00:00:00.000 UTC on 1st January 2001 as the starting time and date for its millisecond count, so that is considerably lower.

Note that UTC is calculated using 9192631770 times a particular transition time for Caesium 133 as a basis for 1 second. GMT (Greenwich Mean Time) is calculated on the basis that 1 second is 1/86400 of the time taken for a whole (day) rotation of the Earth. UT1 (or solar time) is calculated from various space measurements. Periodically, leap seconds are added to UTC to realign it with UT1, but these leap seconds are not added to the count of milliseconds represented by this web tag.

Do be aware that some devices will use a 32 bit signed integer to represent this number, and that will stop working on 19 January 2038, the year 2038 problem for computing world.

<#timeUnix> Badge vMx.pngAvailable from version 3.7.0, so not available in legacy software

Unix tracks the number of seconds since the UNIX epoch. So this web tag can be used when you do not want the millisecond accuracy of the previous web tag. Like previous web tag this relates to UTC, so see details for that tag to find out more. This is equivalent in PHP 5 and PHP 7 to time(); (in PHP 8, a parameter is mandatory for time function, so the call changes).

<#LastDataReadT> The date/time data was last read from the station. Default format for this tag is like this example 18:30 on 30 December 2009, but output parameters for both date and time can modify this to include seconds in 1.9.x builds and most MX builds such as per this example '<#LastDataReadT format="yyyy-MM-dd HH:mm:ss">'.
<#DaysSince30Dec1899> Day count (gives whole and fractional part) Example: 41250.6523310301
<#recordsbegandate> Date when records began (appears twice on "recordT.htm" provided in standard web page, and used to calculate next tag, but ignored for all other Cumulus processing). Any output parameters valid for a date can be used here, don't forget differences in modifiers for Cumulus 1 and MX. There is no time associated with this web tag. The default format is like 30 December 2009, please note although this web tag reports the value associated with [b]StartDate=dd/MM/yyyy[/b] (see Cumulus.ini#Section:_Station), the format there is short-date format and different to default format for this web tag.
<#DaysSinceRecordsBegan> Day count since Cumulus records started

Today

Cumulus allows some control over the time that "Today" begins:

  • For the weather diary feature (originally called "The Log" if you have a very old release or look at old posts on the support forum), Cumulus classifies what you enter by a date. The hour of the day, when that date is first applied, is set in the configuration by the SnowDepthHour (called that as the only tag name available in the legacy Cumulus was for Snow Depth.
    • The default snow depth hour is 9 for the legacy Cumulus and 0 for MX.
  • Readings from your weather station are assigned to the "Today" based on 3 options for Meteorological day
    1. starting at 9:00 am, based on winter time, so switching to 10:00 during Daylight Saving (summer) time, or
    2. starting at 9:00 am, all year round, or
    3. aligned with calendar days, so today starts at midnight

The practice for professional meteorologists varies between nations, some of the traditional practices listed below have been abandoned now most weather reading is by machines:

  • Generally, Meteorologists report snowfall, and snow days, on a calendar day basis (i.e. midnight to midnight).
  • Most frequently, the Lowest temperature for a day is that recorded prior to the start time for Highest temperature.
    • This is because Meteorologists in the past took manual observations at one, or more, fixed times during each day (9 a.m. was the most common, and the closest lowest temperature was generally earlier that morning, while the closest highest temperature was generally the following afternoon)
  • Sunshine hours were recorded from sunrise to sunset, so assigned to "Today" aligned with calendar day
  • The way that total rainfall was reported varied:
    • Some nations assigned used days that ended at 9 a.m. so rainfall was recorded against the end date
    • Sometimes totals were recorded separately for 9 a.m to 3 p.m, with 3 p.m. to 9 a.m being assigned to next day (again these were manual observation times)
    • In other cases, the total for 9 p.m to 9 a.m was recorded separately, and possibly assigned to the day after the total for 9 a.m. to 9 p.m.

Cumulus does not support most of these practices. The independence of the start time for weather diary and weather station related web tags means needs to be remembered when labelling web tags from the two tables below. Steve Loft assumed that you would use 9 a.m. as start time for both, but not care when snow fell, as it often has in the UK, after Summer Time has begun, so weather station tags were by default reporting from 10 a.m. local time and snow as at 9 a.m.

In MX, if you choose 9 a.m. (optionally 10 a.m. in summer) for rollover, so all the standard derivative are assigned to the date the meteorological day starts as Today, but the sunshine hours recorded against today will be from midnight on the said date.

Weather Diary

This first table lists all the web tags available for reporting what is recorded in the weather diary. Just to be clear, the web tags shown below, will report data for previous day if the current time is before the snow depth hour setting, and report data for the current day if the current time matches the snow depth hour or is later.

Web tag_name Function
<#snowdepth> Meteorologists report snow depth in cm, so this is default unit for Cumulus.

If there is no entry in Weather Diary for the day explained above, reports zero.

Badge vMx.png Input is to 2 decimal places. Available from version 3.1.1 - build 3054 when weather diary editor was added to MX. MX allows output in centimetres with decimal places without any script. You can't change the units shown in admin interface, but your value can be input as inches to 2 decimal places if you ignore "cm" that is displayed in that interface.

Badge v1.png Input and output is always as integer. Available from very early builds, weather diary input amended from version 1.8.6 14th April 2009 to allow units to be specified on diary edit screen. If you choose to enter as whole millimetres, you can use JavaScript (or another script language) on your web page to divide the web tag by 10 and get centimetres to 1 decimal place on output.

MX only
<#snowlying> Badge vMx.png Available from version 3.1.1 - build 3054. If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.

Badge v1.png Although this tag is not available in Cumulus 1, your web page can use a script to check if <#snowdepth> is non zero, as that means snow is lying

<#snowfalling> Badge vMx.png Available from version 3.1.1 - build 3054. If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.

Badge v1.png Not available in Cumulus 1. There is no web page workaround, unless you write a script that reads Weather Diary and makes relevant information available on your web server.

Today.ini

As explained earlier, these tag names relate to latest Meteorological day and they are populated from information held in today.ini, as the sub-section title suggests; except for Sunshine Hours which relate to latest Calendar day and can be taken from either yesterday.ini or "today.ini" depending on (respectively) whether before or after rollover time if that is not midnight.

Where a tag name reports a value specific to a past time in today-so-far, there will also be a tag name that can give the time of day, shown in same row of table below. For those that cover whole day so far, the final column contains "n/a". Please note none of the time 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' (24 hour clock notation without leading zero for hour) for Cumulus 1 and MX.

Also as explained earlier, there is some inconsistency in naming with "T" not included in all tag names, "T" is used in conjunction with "H" or "L" as a suffix for extreme values/time-stamps, but a prefix "T" can identify today's value, or prefix "T" can signify a time-stamp.

In the legacy todayT.htm template, in the legacy "/web" folder, use was made of a selection of the tag names listed here.

If you are using MX, the today and yesterday page in the MX_Administrative_Interface shows similar information by using the local application programming interface.

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 (calculated from all temperature readings processed by Cumulus, today.ini stores a cumulative aggregate and counts the number of values processed, so a division gives this output) 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>
MX only
<#feelslikeTH> Badge vMx.png Available from version 3.6.10 (NOT AVAILABLE IN CUMULUS 1)

Today's high feels like temperature

Please see sub-section below current conditions if you are using an earlier 3.6.x version of MX.

<#TfeelslikeTH>
<#feelslikeTL> Badge vMx.png Available from version 3.6.10 (NOT AVAILABLE IN CUMULUS 1)

Today's low feels like temperature

<#TfeelslikeTL>
<#humidexTH> Badge vMx.png Available from version 3.7.0 (NOT AVAILABLE IN CUMULUS 1)

Today's high Canadian Humidity Index

Please see sub-section below current conditions if you are using Cumulus 1 or an earlier version of MX.

<#ThumidexTH>
Both legacy and MX
<#heatindexTH> Today's high heat index <#TheatindexTH>
<#wchillTL> Today's greatest wind chill (i.e. lowest temperature, highest wind speed) <#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
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
<#windAvg> Badge vMx.png (Available from release 3.12.0 onwards)

The wind run divided by time passed since rollover to express it as an average wind speed

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>
<#SunshineHours> Today's hours of sunshine so far. Added in Cumulus 2, then to 1.9.1 build 957, also available in MX. From version 3.7.0 takes a parameter "dp=n" so the number of decimal places required can be specified n/a
MX only
<#LightningStrikesToday> Number of strikes since midnight, default 0 - Added at 3.2.0 - b3056, but see subsequent release announcements as the handling of lightning was improved gradually over several subsequent releases.

(other lightning tags can be found in Current Conditions table)

<#chillhoursToday> The incremental chill hours figure since start of today (tag name available from version 3.12.0 beta build 3134, but the coding to process this web tag has a bug at time of adding this note to this Wiki page, as it may incorrectly report 99.99; hopefully a calculation using <#Ychillhours> and <#chillhours> will work better)

(Compare with Cumulative seasonal Chill Hours at end of today <#chillhours> found in Current Conditions table)

No Commas

This section is for those locales where a comma is used instead of a full stop to separate the integer and decimal parts of a number. This section on this Wiki page was written for the legacy Cumulus (1.9.4) software. Although tag names in this section can be used in Cumulus MX, for backwards compatibility, there is now a better way to ensure that the value output by web tags can be understood by script languages which expect a full stop between the integer and decimal parts of a number.

Note that Cumulus does not use thousand separators, so the only places a comma can be used are as a field separator, or as a decimal separator. Obviously it cannot be used for both. Some computer languages like JavaScript will not accept a comma being used for this purpose.

MX

Cumulus MX uses JavaScript Object Notation files for many of its data transfers.

From release 3.5.4 build 3075, most web tags (one notable exception is indoor temperature <#intemp> where rc parameter not available until release 3.6.8 build 3084), 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.

Legacy Cumulus

Cumulus 1.9.4 uses JavaScript for various tasks, as do various third party web pages.

From version 1.9.3 build 1045, Cumulus 1 (and MX) has provided some current conditions web tags, some today web tags, and some recent history web tags in an alternative format where (regardless of locale) the number is always output in a format that uses a decimal point. They are listed in the sub-sections that follow and all correspond to the same tag name with the letters 'RC' removed that has been listed in respective sections of this Wiki page.

RC CURRENT CONDITIONS:

<#RCtemp>, <#RCdew>, <#RCheatindex>, <#RChum>, <#RCinhum>, <#RCintemp>, <#RCpress>, <#RCrfall>, <#RCrrate>, <#RCwchill>, <#RCwgust>, <#RCwspeed>, <#RCwlatest>

RC TODAY:

<#RCpressTH>, <#RCpressTL>, <#RCrrateTM>, <#RCtempTH>, <#RCtempTL>, <#RCwgustTM>, <#RCdewpointTH>, <#RCdewpointTL>, <#RCwchillTL>, <#RCheatindexTH>, <#RCapptempTH>, <#RCapptempTL>

RC RECENT HISTORY:

<#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, as described below the recent history section.

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.

If you are using MX, the today and yesterday page in the MX_Administrative_Interface shows similar information by using the local application programming 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
Legacy and MX
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>
MX only
<#Ychillhours> The Cumulative Chill Hours as recorded at rollover (the end of meteorological yesterday) (Available from release 3.12.0 onwards) n/a
<#chillhoursYest> The incremental Chill Hours change yesterday (Available from release 3.12.0 onwards)

(compare with <#chillhoursToday> described in #Today.ini table)

n/a
<#feelslikeYH> Badge vMx.png Available from version 3.6.10

Yesterday's high feels like temperature

<#TfeelslikeYH>
<#feelslikeYL> Available from version 3.6.10

Yesterday's low feels like temperature

<#TfeelslikeYL>
<#humidexYH Available from version 3.7.0

Yesterday's high Canadian Humidity Index

<#ThumidexYH>
Legacy and MX
<#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
MX only
<#windAvgY> Badge vMx.png (Available from release 3.12.0 onwards)

The wind run yesterday divided by 24 hours to express it as an average wind speed

n/a
Legacy and MX
Miscellaneous
<#heatdegdaysY> Yesterday's heating degree days n/a
<#cooldegdaysY> Yesterday's cooling degree days n/a
<#YSunshineHours> Yesterday's hours of sunshine so far. Added in Cumulus 2, then to 1.9.1 build 957, also in MX. From version 3.7.0 takes a parameter "dp=n" so the number of decimal places required can be specified n/a
<#solarYH> Yesterday's high solar radiation value (Solar sensor needed) <#TsolarYH>
<#UVYH> Yesterday's high UV Index (UV sensor needed) <#TUVYH>

Yearly

This table shows most of the web tags used on the "thisyearT.htm" web template.

The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, 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. Do make sure that you get the web tag names right and the output form at parameters right.

As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this month group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.

Remember that the Year-to-date runs from roll-over time on 1 January for all web tags listed here.

The list below does NOT include any web tags that represent seasonal derivatives, i.e. where you define the month from which they start counting. (Cumulative seasonal Chill Hours <#chillhours> and Total seasonal rainfall <#ryear> can both be found in Current Conditions). Note, that does not imply both are included in indexT.htm.


Web tag_name Function Time Date
Temperature & Humidity
<#YearTempH> This year's highest temperature <#YearTempHT> <#YearTempHD>
<#YearTempL> This year's lowest temperature <#YearTempLT> <#YearTempLD>
<#YearHighDailyTempRange> This year's highest Daily Temp Range n/a <#YearHighDailyTempRangeD>
<#YearLowDailyTempRange> This year's lowest Daily Temp Range n/a <#YearLowDailyTempRangeD>
<#YearHeatIndexH> This year's highest USA heat index <#YearHeatIndexHT> <#YearHeatIndexHD>
<#YearWChillL> This year's greatest wind chill (i.e. lowest temperature) <#YearWChillLT> <#YearWChillLD>
<#YearAppTempH> This year's highest apparent temperature <#YearAppTempHT> <#YearAppTempHD>
<#YearAppTempL> This year's lowest apparent temperature <#YearAppTempLT> <#YearAppTempLD>
<#YearFeelsLikeH> Badge vMx.pngThis year's highest feels like temperature (available from 3.6.0) (NOT AVAILABLE IN CUMULUS 1) <#YearFeelsLikeHT> <#YearFeelsLikeHD>
<#YearFeelsLikeL> Badge vMx.pngThis year's lowest feels like temperature (available from 3.6.0) (NOT AVAILABLE IN CUMULUS 1) <#YearFeelsLikeLT> <#YearFeelsLikeLD>
<#YearHumidexH> Badge vMx.png (Available from version 3.7.0) (NOT AVAILABLE IN CUMULUS 1)

This year's highest Canadian Humidity Index

<#YearHumidexHT> <#YearHumidexHD>
<#YearDewPointH> This year's highest dew point <#YearDewPointHT> <#YearDewPointHD>
<#YearDewPointL> This year's lowest dew point <#YearDewPointLT> <#YearDewPointLD>
<#YearMinTempH> This year's highest daily minimum temperature Flavour specific mandatory output parameters:
  • <#YearMinTempHD format=HH:nn> for Cumulus 1,
  • <#YearMinTempHD format=HH:mm> for Cumulus MX
<#YearMinTempHD>
<#YearMaxTempL> This year's lowest daily maximum temperature Flavour specific mandatory output parameters:
  • <#YearMaxTempHD format=HH:nn> for Cumulus 1,
  • <#YearMaxTempHD format=HH:mm> for Cumulus MX
<#YearMaxTempLD>
<#YearHumH> This year's high humidity <#YearHumHT> <#YearHumHD>
<#YearHumL> This year's low humidity <#YearHumLT> <#YearHumLD>
Pressure
<#YearPressH> This year's high pressure <#YearPressHT> <#YearPressHD>
<#YearPressL> This year's low pressure <#YearPressLT> <#YearPressLD>
Wind
<#YearGustH> This year's high wind gust <#YearGustHT> <#YearGustHD>
<#YearWindH> This year's high wind speed <#YearWindHT> <#YearWindHD>
<#YearWindRunH> This year's highest Daily Wind Run n/a <#YearWindRunHD>
Rainfall
<#YearRainRateH> This year's highest rainfall rate <#YearRainRateHT> <#YearRainRateHD>
<#YearHourlyRainH> This year's highest hourly rain <#YearHourlyRainHT> <#YearHourlyRainHD>
<#YearDailyRainH> This year's high daily rain n/a <#YearDailyRainHD>
<#YearMonthlyRainH> This year's 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>
Solar

Badge vMx.png (Available from release 3.12.0 onwards)

<#SunshineHoursYear> the total sunshine hours in year-to-date, or with input modification parameters using either y or r for a past year n/a n/a

All Time

This table lists the web tags that appear in the recordsT.htm example template that is included in each release since version 1.5.1 10th January 2006. Additional tags correctly populated from 3.6.10 (build 3086) or 3.7.0 (build 3089) are marked with a "MX" icon as they are not available in Cumulus 1. Please note the 3.6.10 release was available from 24 June 2020, if the date shown for those MX only tags is before when you installed that (or a later release), the output may show incorrect values.

The output from the web tags shown in the date/time column have the default format that is seen on "records.htm" in the standard web pages:

  • The default format for an extreme month is to show the month name in full i.e. format 'MMMM' followed by the year in full.
  • 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' again ending with the year.
  • 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 (i.e. on the standard web page the time comes first, not as seen in admin interface).

You can change the default output on either the standard web template, or in your own file, by using the 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. Please see examples section above for advice.

Note that unlike the this month and this year web tags, the time and the date are both included in the default format of the standard time-stamp web tags for the 'highest minimum' and 'lowest maximum' temperatures, yet another inconsistency!

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>
<#feelslikeH> Badge vMx.pngAll time high feels like temperature (available from 3.6.0) <#TfeelslikeH>
<#feelslikeL> Badge vMx.pngAll time low feels like temperature (available from 3.6.0) <#TfeelslikeL>
<#humidexH> Badge vMx.pngAll time high Canadian Humidity Index (available from 3.7.0) <#ThumidexH>
<#heatindexH> All time high USA 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, but highest wind speed) <#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

This table shows the web tags used on the thismonthT.htm web template.

Because the rainfall this month does not appear on thismonthT.htm web page, it is shown in indexT.htm table earlier in this article which is for the web page where it does appear.

The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, 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. Do make sure that you get the web tag names right and the output form at parameters right.

As another example of inconsistency in how web tags added in different versions are coded, there are two web tags (highest minimum/lowest maximum temperatures) where a standard web tag is not provided by Cumulus (1 or MX) for the associated time-stamp. Consequently, for these 2 (and their corresponding tags in the this year group), there are mandatory output parameters required as shown in the table. Obviously Cumulus 1 lets you use "NN", "nn", "MM", or "mm" for the minutes, but minutes can only be represented in one way in Cumulus MX.

Web tag_name 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 Badge v1.png<#MonthMinTempHD format=hh:nn> or <#MonthMinTempHD format=HH:mm> for Cumulus 1,

Badge vMx.png <#MonthMinTempHD format=HH:mm> for Cumulus MX

<#MonthMinTempHD>
<#MonthMaxTempL> This months lowest daily maximum temperature Badge v1.png<#MonthMaxTempLD format=HH:mm> or <#MonthMaxTempLD format=hh:nn> for Cumulus 1,
Badge vMx.png<#MonthMaxTempLD format=HH:mm> for Cumulus MX
<#MonthMaxTempLD>
<#MonthHighDailyTempRange> High Daily Temp Range n/a <#MonthHighDailyTempRangeD>
<#MonthLowDailyTempRange> Low Daily Temp Range n/a <#MonthLowDailyTempRangeD>
<#MonthHeatIndexH> This months high USA heat index <#MonthHeatIndexHT> <#MonthHeatIndexHD>
<#MonthWChillL> This months greatest wind chill (i.e. lowest temperature) <#MonthWChillLT> <#MonthWChillLD>
<#MonthAppTempH> This month's high apparent temperature <#MonthAppTempHT> <#MonthAppTempHD>
<#MonthAppTempL> This month's low apparent temperature <#MonthAppTempLT> <#MonthAppTempLD>
<#MonthFeelsLikeH> This month's highest feels like temperature (available from Badge vMx.png 3.6.0) (NOT AVAILABLE IN CUMULUS 1) <#MonthFeelsLikeHT> <#MonthFeelsLikeHD>
<#MonthFeelsLikeL> This months lowest feels like temperature (available from Badge vMx.png 3.6.0) (NOT AVAILABLE IN CUMULUS 1) <#MonthFeelsLikeLT> <#MonthFeelsLikeLD>
<#MonthHumidexH> Badge vMx.png (Available from version 3.7.0) (NOT AVAILABLE IN CUMULUS 1)

This month's highest Canadian Humidity Index

<#MonthHumidexHT> <#MonthHumidexHD>
<#MonthDewPointH> This month's high dew point <#MonthDewPointHT> <#MonthDewPointHD>
<#MonthDewPointL> This month's low dew point <#MonthDewPointLT> <#MonthDewPointLD>
<#MonthHumH> This month's highest humidity <#MonthHumHT> <#MonthHumHD>
<#MonthHumL> This month's lowest humidity <#MonthHumLT> <#MonthHumLD>
Pressure
<#MonthPressH> This month's highest pressure <#MonthPressHT> <#MonthPressHD>
<#MonthPressL> This month's lowest pressure <#MonthPressLT> <#MonthPressLD>
Wind
<#MonthGustH> This month's highest wind gust <#MonthGustHT> <#MonthGustHD>
<#MonthWindH> This month's highest wind speed <#MonthWindHT> <#MonthWindHD>
<#MonthWindRunH> This month's high Daily Wind Run n/a <#MonthWindRunHD>
Rainfall
<#MonthRainRateH> This month's highest rainfall rate <#MonthRainRateHT> <#MonthRainRateHD>
<#MonthHourlyRainH> This month's highest hourly rain <#MonthHourlyRainHT> <#MonthHourlyRainHD>
<#MonthDailyRainH> This month's wettest day (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>
Solar

Badge vMx.png (Available from release 3.12.0 onwards)

<#SunshineHoursMonth> the total sunshine hours in month-to-date, or with input modification parameters using either y and m or r for a past month n/a n/a


Monthly All Time Records

This table includes web tags that show the values in Monthlyalltime.ini log file, which was introduced in version 1.9.3 (build 1033, 10 Apr 2012).

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

  1. The tag names listed here require a input modification parameter.
  2. The tag names here can optionally take any output modification parameters.
  3. To supply both optional input modification, and optional output modification parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. In that example, the time (not date) of highest ever temperature in July is returned after processing by Cumulus.

At release 3.6.10 (build 3086), and at release 3.7.0 (build 3089); additional tag names were introduced:

  • They are marked with a "MX" icon as they are not available in legacy Cumulus 1.
  • If you have any "feels like temperatures" that appear with a date/time parameter with a date before 24 June 2020, or before you installed the 3.6.10 release (or a later release), then the value web tag may show incorrect values.
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 and highest wind speed) <#ByMonthWChillLT>
<#ByMonthAppTempH> High Apparent Temperature <#ByMonthAppTempHT>
<#ByMonthAppTempL> Low Apparent Temperature <#ByMonthAppTempLT>
<#ByMonthFeelsLikeH> Badge vMx.pngHigh Feels Like Temperature (available from 3.6.10) <#ByMonthFeelsLikeHT>
<#ByMonthFeelsLikeL> Badge vMx.pngLow Feels Like Temperature (available from 3.6.10) <#ByMonthFeelsLikeLT>
<#ByMonthHumidexH> Badge vMx.pngHigh Canadian Humidity Index (Humidex) - available from version 3.7.0 <#ByMonthHumidexHT>
<#ByMonthHumidexL> Badge vMx.pngLow Canadian Humidity Index (Humidex) - available from version 3.7.0 <#ByMonthHumidexLT>
<#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

In Cumulus 1 most of these are only calculated at UTC zero hours, but are updated each hour to refer to current time-zone.

MX is more complicated, but most of these are calculated hourly.

Web tag_name Function
<#sunrise> Last sunrise time at the station - This sunrise time is calculated by a third party library each midnight UTC (in legacy cumulus), 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 (in legacy cumulus), 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 (in legacy cumulus), 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> Approximate length of daylight in hours and minutes (dawn to dusk) - if your timezone is UTC or a few hours off that, the dusk may well be that just passed, and the dawn that to come as at the zero hours UTC when Cumulus 1 does this calculation
<#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, basically because of the note for <#daylightlength>, and its use was not recommended. Its use is therefore not supported by Steve Loft (i.e. you use it at your own risk) in the legacy Cumulus.

<#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"

There is some PHP script code below this table showing how this can be converted to days, hours, minutes, seconds*

If the "dp" parameter is supplied, then 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> see #Today.ini Miscellaneous
<#SunshineHoursY> see #Yesterday Miscellaneous
<#CurrentSolarMax> Current theoretical maximum solar radiation
<#IsSunny> Returns 1 if the sun is shining, otherwise 0 (Solar sensor needed)
* Footnote: PHP code extract:
	$MoonAgeDays 		= <#MoonAge dp=0> +0;
	$moonDecimalPart 		= <#MoonAge dp=4> - $MoonAgeDays;
	$MoonAgeHours 		= round($moonDecimalPart * 24, 0);
	$MoonAgeMinutes  		= round(($moonDecimalPart * 24 * 60) - ($MoonAgeHours * 60), 0);
	$MoonAgeSeconds		= round(($moonDecimalPart * 24 * 60 * 60) - ($MoonAgeHours * 60 * 60) - ($MoonAgeMinutes * 60), 3);
	$MoonAge       	=    $MoonAgeDays . ' days, ' .   $MoonAgeHours . ' hours, '
				. $MoonAgeMinutes . ' minutes, ' . $MoonAgeSeconds . ' seconds';
	// Change the English words 'days, ', ' hours, ', and 'minutes' to the equivalents in your language

Alarms

Badge v1.pngThere 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.

Badge vMx.pngAlarms 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
<#DataSpikeAlarm> Badge vMx.png Available from version 3.7.0

Alarm raised if a data spike is detected, or a data limit exceeded

<#HttpUploadAlarm> Badge vMx.png Available from version 3.11.2

Alarm raised if a HTTP upload alarm has been triggered

<#MySqlUploadAlarm> Badge vMx.png Available from version 3.11.2

Alarm raised if a MySQL upload alarm has been triggered

<#UpgradeAlarm> Alarm raised if MX upgrade (a newer release) is available

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

Differences depending on Cumulus versions

Badge v1.png Cumulus 1.9.x supports all the web tags listed in table below, with the exception of those relating to "humidex" and "feels like".

Badge v1.png For Cumulus 1 the tags are cleared in one of two ways:

  1. Generation of a web page where the web tag is set, clears the record for that web tag.
  2. Viewing of an extreme screen tab clears all records listed on that tab.

Badge vMx.png For versions up to 3.5.0 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). From version 3.7.0, Cumulus MX offers all the web tags listed in table below, at earlier versions it offers a subset of those listed.

Badge vMx.png For MX these web tags will be set from the time of the record until a timeout value is met (by default each record remains set for 24 hours).

You can change the default MX timeout:

  • Add a RecordSetTimeoutHrs=NN entry to [Station] section in Cumulus.ini
  • NN can be set to any reasonable integer representing hours (for the default set the number NN to '24').

Table of web tags available for extreme records

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.
  • Badge vMx.pngIn Cumulus MX: 1 from when new record is set until
    • either all records have cleared
    • or until next rollover is completed,
    • or (in recent releases) until the number of hours for clearing extreme record notifications has passed
  • 0 otherwise
  • Badge v1.pngIn Cumulus 1.x.x:
    • 1 if 'new record' light is flashing,
    • 0 if not
<#TempRecordSet> 1 if any temperature-based extreme has been updated, 0 if not
<#HighTempRecordSet> 1 if the all-time highest temperature extreme has been updated, 0 if not
<#LowTempRecordSet> 1 if the all-time lowest temperature extreme has been updated, 0 if not
<#HighTempRangeRecordSet> 1 if the all-time high daily temperature range extreme has been updated, 0 if not
<#LowTempRangeRecordSet> 1 if the all-time low daily temperature range extreme has been updated, 0 if not
<#HighAppTempRecordSet> 1 if the all-time high apparent temperature extreme has been updated, 0 if not
<#LowAppTempRecordSet> 1 if the all-time low apparent temperature extreme has been updated, 0 if not
<#HighHeatIndexRecordSet> 1 if the all-time high USA heat index extreme has been updated, 0 if not
<#HighHumidexRecordSet> Badge vMx.png1 if the all-time high Canadian Humidity index extreme has been updated, 0 if not (from version 3.7.0)
<#LowWindChillRecordSet> 1 if the all-time greatest wind chill extreme has been updated, 0 if not
<#HighFeelsLikeRecordSet> Badge vMx.png1 if the all-time high feels like temperature extreme has been updated, 0 if not (from version 3.6.0)
<#LowFeelsLikeRecordSet> Badge vMx.png1 if the all-time low feels like temperature extreme has been updated, 0 if not (from version 3.6.0)
<#HighDewPointRecordSet> 1 if the all-time high dew point extreme has been updated, 0 if not
<#LowDewPointRecordSet> 1 if the all-time low dew point extreme has been updated, 0 if not
<#HighMinTempRecordSet> 1 if the all-time high minimum temperature extreme has been updated, 0 if not
<#LowMaxTempRecordSet> 1 if the all-time low maximum temperature extreme has been updated, 0 if not
<#HighWindGustRecordSet> 1 if the all-time high wind gust extreme has been updated, 0 if not
<#HighWindSpeedRecordSet> 1 if the all-time high wind speed extreme has been updated, 0 if not
<#RainRecordSet> 1 if any rainfall based extreme has been updated, 0 if not
<#HighRainRateRecordSet> 1 if the all-time high rain rate extreme has been updated, 0 if not
<#HighHourlyRainRecordSet> 1 if the all-time high hourly rain extreme has been updated, 0 if not
<#HighDailyRainRecordSet> 1 if the all-time high daily rain extreme has been updated, 0 if not
<#HighMonthlyRainRecordSet> 1 if the all-time high monthly rain extreme has been updated, 0 if not
<#LongestDryPeriodRecordSet> 1 if the all-time longest dry period extreme has been updated, 0 if not
<#LongestWetPeriodRecordSet> 1 if the all-time longest wet period extreme has been updated, 0 if not
<#HumidityRecordSet> 1 if either the highest or lowest humidity extreme has been updated, 0 if not
<#HighHumidityRecordSet> 1 if the all-time high humidity light extreme has been updated, 0 if not
<#LowHumidityRecordSet> 1 if the all-time low humidity extreme has been updated, 0 if not
<#PressureRecordSet> 1 if either the highest or lowest pressure extreme has been updated, 0 if not
<#HighPressureRecordSet> 1 if the all-time high pressure extreme has been updated, 0 if not
<#LowPressureRecordSet> 1 if the all-time low pressure extreme has been updated, 0 if not
<#WindRecordSet> 1 if any wind speed based extreme has been updated, 0 if not
<#HighWindrunRecordSet> 1 if the all-time high wind run extreme has been updated, 0 if not

Special tags

Davis

Please be aware that the tags available are not the same in all versions. Badge vMx.pngAt present this table has not yet been updated for latest MX version.

All (see note for THSWindex) of the following web tags for the Davis PWS are available from Cumulus 1.9.2. Most of the following web tags are available in Cumulus MX 3.0.0 beta from build 3019, Storm tags from 3021.

Both flavours update the values of the reception tags every 15 minutes. In Cumulus 1 this applies from 1.9.3, in 1.9.2 they were read, and updated, every minute, in earlier versions not available.

Web tag_name Applicability Function
<#DavisTotalPacketsReceived> 1.9.2 onwards and MX Total number of data packets received. This stat is not supplied by the Davis WLL station.
<#DavisTotalPacketsMissed> 1.9.2 onwards and MX Number of missed data packets. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats.
<#DavisMaxInARow> 1.9.2 onwards and MX Longest streak of consecutive packets received. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats.
<#DavisNumCRCerrors> 1.9.2 onwards and MX Number of packets received with CRC errors. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats.
<#DavisNumberOfResynchs> 1.9.2 onwards and MX Number of times the console resynchronised with the transmitter. From version 3.6.0 build 3076, optionally add "tx=n" parameter, where n=1-8 and equals the desired transmitter id. The default is n=0 and will return the VP2 stats
<#DavisFirmwareVersion> 1.9.2 onwards and MX The console/WLL firmware version
<#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.8.9 onwards and MX The transmitter battery condition, by default it returns the status of all transmitters. (This was displayed from version 1.9.4 to 1.8.9 on the main screen).

Cumulus 1.9.3 onwards 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', you can use date output format modifiers

(Note that the console does not report start time, so the web tag cannot report time. It appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTip> in a MX script might help)

Davis WLL

New from version 3.6.0. Not available for earlier MX, not available for Cumulus 1.

Web tag_name Function
<#DavisReceptionPercent tx=1> WLL transmitter reception percentage (replace 1 by any other transmitter number up to 8)
<#DavisTxRssi tx=0> WLL RSSI of the WiFi connection
<#DavisTxRssi tx=1> WLL RSSI of Transmitter #1 (replace 1 by any other transmitter number up to 8)




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