Webtags

From Cumulus Wiki
Revision as of 10:22, 31 July 2020 by Mcrossley (talk | contribs) (Davis WLL)


What is a web tag?

Put simply, a web tag is included in a Cumulus template file to indicate where Cumulus should insert values when it produces an output file. The concept of processing templates is explained in another article. The output file can be a web page, a JavaScript file, a PHP script, or a eXtensible Mark-up Language (XML) file.

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.

Contents

GENERAL TIP

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

An example of the output for an early MX version 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).

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

ListWebTags=0

Cumulus Version 1 SpecificIf 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.

What this article covers

At the last count, a 3.5.x version of MX produces nine and a half million web tags! But the file mentioned in previous section contains just 717 items (later versions of MX raise this count by another forty tags or so). How come this discrepancy?

Well each web tag has the general format <#tag_name optional_input_parameter optional_output_parameter> and it is adding these optional parameters that allow 717 tag names to define 9½ million values!

Consequently, this article describes:

  • Over 7 hundred web tags
  • A score of input parameters that modify some of those tags
  • The components that make up output parameters that modify almost all web tags that report a time and/or date
  • The way that some of those date modifiers are used for naming NOAA reports


The tables below are not able to indicate which of the billions of combinations possible are valid or invalid for you.

Applicability by version and build

The tip at the start of this article tells you how to check which tags are available in whatever build of Cumulus you are actually using. Given how often a new release alters either what web tags are available or what parameters can be used with particular web tags, it is not possible for the tables below to tell you precisely how you use web tags at any version.

Because Cumulus 2 is no longer available, it has been ignored in the tables below.

Badge v1.pngThis badge is used to highlight text that applies to Cumulus 1.

  • Use of this badge does NOT mean that all builds of Cumulus 1 are able to use the web tag.
  • There are gaps in the Cumulus 1 documentation, and so it is not usual for the table entry to indicate when a particular web tags started to be available
  • If you are using the final version of Cumulus 1, then the text highlighted by that badge does apply to you.
  • In general, Cumulus 1 will silently ignore any web tag it does not recognise. This means that you might see the raw

web tag remaining after processing, or you might see nothing where the web tag was prior to processing. It also means that if you try to do a numeric calculation on a web tag that Cumulus 1 does not recognise, the calculation will fail, but you might not see an error message.

Badge vMx.pngThis badge is used to highlight text that applies to Cumulus 3 (MX) only.

  • In many cases, it highlights web tags that are not available in Cumulus 1
  • Use of this badge does not mean that all builds of MX are able to use this web tag
  • Some attempt has been made to indicate either which MX build introduced individual tags, or from which build the web tag started giving the correct response (where earlier builds reported incorrect values for that web tag in some cases).
  • MX will raise an error:
    • for any web tag it does not recognise at the version you are running
    • for any input parameter that the token parser is unable to recognise
  • MX treats output parameters differently:
    • any output parameter that it does not recognise at all, is ignored
    • any output parameter in a web tag that does not accept output parameters is also ignored
    • any output parameter in a web tag that does accept output parameters, where the supplied parameter is inconsistent with the content of the web tag, is reported as an error by the token parser
    • an output parameter that specifies only part of the standard output may be reported as an error because of single character rules (for example a tag that reports a time cannot understand format=H, amongst the acceptable formats are format=%H for just hour and format=H:mm for hour and minutes but not seconds.
    • any output parameter that contains incorrectly formatted characters in that output parameter will be treated as an error by the token parser (a common mistake is forgetting spaces are expected to be included with other literal characters by the MX token parser)
    • if you use valid parameters but the wrong parameters, you are likely to be confused by the output (the most common cases result in seeing minutes where a month is wanted, or there is a misunderstanding of the concept where the same character has different meanings when on its own and when with other characters).

NOAA style Report Naming

A brief history of these reports

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 first only in Cumulus 2, they were added to Cumulus 1 in version 1.9.2 (build 1004) released in July 2011, after the abandonment of Cumulus 2.

Encoding

Why does encoding matter?

If you have problems with a web page not displaying the ° symbol correctly, it will be because the character set encoding is either not declared or not consistent.

What encoding does my web page use?

Put simply, most modern web pages start with this:

<!DOCTYPE html>
<!-- the above must be on the first line by itself and tells the browser that HTML 5 applies -->
<html lang="en"><!-- modify this to indicate your language -->
<head>
	<meta charset="UTF-8"><!-- assigns the recommended standard encoding that copes with all international characters -->
...

The last line shown there is critical, it indicates that the web page uses "utf-8" encoding.

You will find that all standard web templates included with MX start as shown above. For Cumulus 1, from build 1094 up the various builds defined for final release, the above code is used. However for earlier builds of Cumulus 1, the standard web pages start as follows:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type" />

The last line there shows how the original web templates (designed by Beth Loft) used the ISO 8859-1 character set. Consequently, the original NOAA reports used ISO-8859-1 encoding and for compatibility with this original setting, the default encoding for NOAA reports is unchanged despite the mismatch with web pages, because Cumulus 1 does not contain any web page to display NOAA reports.

How does MX complicate encodings?

MX complicates the issue, the admin interface does include a web page for displaying reports, (/CumulusMX/interface/noaayearreport.html). This web page includes <meta charset="utf-8">, but the defaults prior to using the web page for editing NOAA settings (/CumulusMX/interface/noaasettings.html) include not using "utf-8" building in an inconsistency because there is nothing in the hints on that page to help you select reasonable settings!

Consistency for encoding

To add just a little more detail here, if you choose to implement a web page to display these Cumulus reports, then the HTML of the web page to display the report, the JavaScript that selects which report to show, and inserts the report into the HTML, and the report itself must all use the same encoding, otherwise you will not get characters like ° displaying correctly.

When did Cumulus 1 change?

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. For backwards compliance, the default selected by Steve Loft is his original ISO-8859-1 encoding, but his recommendation strongly expressed was that users should switch to UTF-8. This choice with the former as default, but the latter as recommended, remains unchanged in MX. The encoding for NOAA reports can be selected on the NOAA Settings screen of either Cumulus 1 or MX, and you are as Steve says strongly advised to reverse the setting.

Relevance to Extra Web Files

Before I go into any more technical detail, this same advice of selecting "UTF-8" applies to any choices on the Extra web files in MX (or Files tab of internet settings in Cumulus 1).

TECHNICAL BIT

With that introduction, you can now choose whether to read the rest of this section which uses more technical terminology.

Let me explain that technical term, essentially 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 particular 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. The general problem is that unless you match the encoding used initially, any retrieval cannot know what character to display for certain combinations of bits.

This means that when you read a file you probably find the letters A to Z where you expect them, but whether you see correct case cannot be guaranteed. Some encodings put capital letters at lower binary values than lower case letters, and some put capitals at higher binary values.

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, 64, or even more bits to use and can include lots more characters and the bigger character sets start including lots of symbols and the biggest add smilies or emotion icons.

Remember, most modern web pages (including the standard web templates provided with both flavours of Cumulus) use UTF-8 encoding. The only problem is MX not defaulting to this for NOAA reports.

The format used for naming reports

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 [NOAA] section of Cumulus.ini.

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 table below as there are obviously a lot more options.

Cumulus Version 1 SpecificDelphi Specifier for Cumulus 1.9.x Badge vMx.pngMono Specifier for Cumulus MX Explanation Setting to use that suits both flavours Example of produced name
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
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).

Template Files

This is the name given by Steve Loft to any files that contain web tags and need to be processed before they actually include values.

When Cumulus processes these files it generates output files where the tags/tokens have been replaced by values. Consequently, a single template will actually generate a different file each time Cumulus processes that template because the part of the content that was web tags is now populated with text (values, times, dates, etc.) and as these values change that make the file different to the previous generated file.

For standard Cumulus, all the output files are web pages which it then uploads to your web site. There is more about processing of files on the Customised templates page, but think of a template as containing text that Cumulus copies from the template file to the web page it is constructing. The processing process is basically a parse, each time it finds what MX calls a token (a web tag complete with any parameters it needs) it looks up the value that it will use to replace that web tag before moving on through the text.

The example web templates provided by Cumulus insert a "T" at the end of the intended web page name before the extension (.htm or .html), so that the template files and generated web pages cannot be confused. The generated file will often have "tmp" added to the end

When writing your own templates, some people will stick to this "T" notation, others will change the extension to "tmpl" or "cum" to indicate they are Cumulus templates. Cumulus does not care what extension is used for any local file specified in the MX Extra Web Files settings or Cumulus 1 Files tab settings.

For Cumulus 1 and MX, there are one template held within the program code, this is what produces the default Realtime.txt. You can define an alternative template with web tags and Cumulus can process that instead of its default template.

For MX only, there are other templates held within the program code (so you cannot edit them), these output in json format. Some are application program interface, and feed information to the admin interface, you can only view these by using the development interface in your browser that lets you see what has been loaded. The rest become the json files that are created in the web folder from where (like the web pages produced after processing the standard web templates), they can be uploaded to your web site.

Web tags available in Cumulus

Those special markers in the file are called web tags, during processing Cumulus will replace them with the actual values. Typically you would use this to build your own website by having an HTML template file with your layout, static text and graphics. In the position on the page you wish Cumulus to insert the relevant data place a web tag in the form (briefly mentioned earlier in this page):

<#tag_name [optional input parameters][optional output parameters]>

Note: When you put a tag into your template, be careful that whatever program you are using to develop your web pages doesn't change the angle brackets to slightly different symbols -- this is a common cause of failure! There are a number of editing tools that are designed for editing programming code and you should use one of those (e.g. Notepad++, Brackets, NoteTab Light, HTML kit, amongst many others), rather than a tool designed for web page design editing (e.g. Dreamweaver, word press, amongst others).

Beta Builds of Cumulus

Cumulus Version 1 SpecificThe additional webtags page was created to hold web tags that were not yet available in any Cumulus 1 formal release, but were available in any Beta version that was under development.

Badge vMx.pngWhen development of Cumulus 1 ceased, Cumulus MX was available as a beta. At that time, this article continued to describe web tags available in the final release of Cumulus 1 (builds 1099, 1100, 1101, 1099.1, and 1099.2). Because the output parameters were different for MX, all the MX web tag information was in beta web tags article. That was fine in early beta versions of MX because they supported only a small subset of the web tags available for Cumulus 1.


However, as MX development continued more and more web tags were available and maintaining two articles, one for each flavour of Cumulus was impossible. Therefore, MX users had to look at two pages, some of their web tags were in this article some were in that article. Confusingly, some web tags were in both articles, because the parameters that could be used with those tags were increased in MX, so the additional parameters were only shown in the beta article, an example was when the moon web tags had parameters added to control the output from build 3047, these were added to the Beta article.

When Mark Crossley brought MX out of Beta, all the web tags that were on that page were moved into this article, and it was made clear which flavours each web tag was available in (excluding Cumulus 2).

The developer of MX new releases normally shares a new version of MX first as beta by sending the distribution in an email to a number of Cumulus users. They respond by email, with the intension any issues can be ironed out before the distribution is made available as a public release. Given the number of weather station types supported and the complexity of options for using Cumulus, this does not always ensure all ways in which MX can be used are tested, especially as the Cumulus Users given the beta test zip might not use all the features that have been modified in a particular development.

Although such releases often add additional web tags, any additional web tags are currently being entered into this article and no new MX web tags had been added to beta article since that move of the earlier ones into this article.

Case sensitivity

The tag_name in the general format above is case sensitive, so please type the tag name exactly as shown in the web tag columns in the tables below.

The optional input parameters always use lower case, so please type them exactly as shown in the sections dealing with input parameters.

The optional output parameters are case insensitive when used in Cumulus 1. But for Cumulus 2 and later, so this includes MX, the output parameters are case sensitive and also dependent on what other output formatters are being used if any, so please read the sections on output parameters and study the examples in the tables carefully.

Inconsistency of web tag names

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. The great inconsistency in the naming, gives rise to a problem as it very easy to spell a tag_name incorrectly as you naturally expect there to be a standard pattern.

You will find yourself frequently having to refer to this article, if you decide to make your own Cumulus templates (see section below for more information). This applies whether those templates are for web pages, to implement Extensible Mark-up Language files, or PHP Hypertext Pre-processor scripts.

When Steve Loft introduced the first web tags as part of developing software for his own use, he did not create a naming standard to ensure consistency in the future. As he introduced further web tags at different times, the names used might be consistent amongst the ones introduced that day, but there was still no naming convention to ensure consistency with tags introduced previously or to help name future tags.

Inconsistency for today, yesterday, this month, this year groups

It would be easier if all tags reporting parameters for today were consistent, let alone consistency in naming between tags for today and yesterday. The tags for this year and this month were introduced in same release, so there is some consistency in how they were named then, but no standard to ensure future tags for this month and this year would be named the same way.

Inconsistency in use of "Y"

  • The character "Y" might be included in a web tag to denote yesterday, or it might denote this year
  • Where the Y is indicating yesterday, it is sometimes a prefix, sometimes a suffix!

Inconsistency in use of "T"

  • Some web tags for today include a "T" as a suffix, some do not.
  • "T" is used in combination with the web tag name for a value, so a similar name is used for the time-stamp tags
    • the T is a prefix sometimes and
    • the T is a suffix sometimes
  • This is particularly confusing and is why you must look up time-stamp tags in the tables in this article.

Choosing script variable names derived from tag names

In the web tag to PHP variable scripts, I have posted, see Php_webtags#Minimised_Upload_size, I have tried to introduce better consistency in the PHP variable names, so "T" is added as a suffix to all "today" variables for example. Some other script authors try to match the inconsistent web tag names, so their script variable names are also inconsistent.

Optional Parameters

Input modification Parameters

Most web tags do not require any input parameters. An input parameter is used where the same web tag can represent a value for a number of different past time instants. Each of those past time instants is represented by a different value for the input parameter. So a combination of web tag name and input parameter lets Cumulus to pick the value you want to see.

There are currently only two types of tags where an input parameter is mandatory:

  • The recent history tags where a separate value exists for potentially every individual minute in last week. These tags need an input parameter specifying how many minutes ago is required. To save entering a very large number for minutes, an input parameter can combine days, hours, and minutes, ago using up to 3 input parameters as explained in linked section.
  • The #Monthly_All_Time_Records where a separate one exists for each particular month (of any year) need input parameter specifying which month. Again see the respective section for full details of input parameter (which is 1 for January to 12 for December, but 0 is also available with a special meaning).

Output modification parameters

These are complex, they vary between Cumulus 1 and later flavours, and what output modifiers can be used varies between web tags.

Consequently, output modifiers will be discussed in a later section headed #Output_.27format.27_Parameter.

The options available include:

  • changing date and/or time format,
  • changing number of decimal places, and
  • removing decimal commas.

Cumulus Templates

Using web tags in templates for creating HTML pages

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

Using web tags in scripts

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

type conversion

  • To use a value from a tag as a floating point number in JavaScript you need to use
    parseFloat(string_variable_name)
    otherwise you will find any attempt to add something to it results in a concatenation because JavaScript uses "+" for two purposes and concatenation takes precedence over arithmetic adding!
  • 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 frequently used in scripts where the web tag being used is not available in all versions of Cumulus, because Cumulus does not implement the concept of null values and often zero is used when a true value is not available because that sensor is not installed for example. 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, adding zero does not prevent the true value of that web tag being assigned to the variable.

Web Tag Differences Between Cumulus 1 and MX builds

Cumulus Version 1 Specific This badge is used when the web tags listed in one of the tables are available in the final 1.9.4 release of Cumulus 1, but not in MX. 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.

Badge vMx.png Cumulus MX provides many, but not all web tags that were available in Cumulus 1. MX adds many more web tags, mostly in support of new weather stations or new sensors. This badge is used against web tags listed in one of the tables that are only available in MX. See tip at top of page for how to check which web tags are available in your build.

A combination of badges appears where certain aspects apply to Cumulus 1 or to MX. No information is given for Cumulus 2 as it is no longer available.

When MX is processing web tags 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, be aware a "token" parser is used to evaluate web tags:

Web tag error
Exception: i=8998 len=106297
inputText.Length=106297
token=<#daylightlength format=H>

This particular error is that when you use a single output format character it does not have same meaning as when there are multiple characters, correct this particular web tag to:

<#daylightlength format=%H>

Please note that where this article makes reference to other pages in the Wiki, the information shown there might be specific to Cumulus 1, as there are differences between the user interface for Cumulus 1 and MX flavours of this software, and the Wiki was originally written before MX existed, so not all pages have been updated.

Output 'format' Parameter

The majority, but not all, of web tags either can use an output format parameter or, in a few cases, really do need an output format parameter.

Output Parameter Differences between Cumulus 1 and Cumulus MX (Cumulus 3)

There are a number of differences between Cumulus 1 (C1) and Cumulus MX (MX). These nearly all involve times and dates, so the next section deals with this.


Output (format modifier) parameters for times and dates

Time/Date format codes are used in two places:

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

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

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

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

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

C1 can work with times in 14.24 format using a full stop ('.') to separate the figures, MX must have colon (':') between hour and minute numbers. But with both flavours you can choose whether 12-hour clock is used with am/pm (in lowercase or capitals) or the 24-hour clock is used. You can choose to include/exclude leading zero for hours. You can only report the hour if you don't care about the minutes, or only report the minutes if you don't need the hour. In most cases you can add seconds to the output, and either milliseconds or microseconds. This does not imply that Cumulus calculates everything every microsecond, in fact many are only calculated once a minute, but the flexibility is there for time outputs.

Some web tags contain dates, or both dates and times, and for these there is flexibility (apart from those with fixed format, these might have ISO, or another format indicator, in their tag name) as to how the date is output. Thus you can choose to include or exclude the year; you can represent month in letters or numbers, and you can vary the order in which elements of the date are shown.

The characters used to represent year, month, day, hour, minute, second, microsecond, do differ between C1 and MX. In Cumulus 1 we are able to use "m" or "M" for two different meanings (minutes or month) depending on context. Similarly, in MX the same character sometimes has two different meanings depending on context, but this applies to lots of characters and the context is whether the character is used on its own or with other characters. Sounds confusing? Well it is complicated.

Explanation

  • Cumulus MX (when running on Windows) uses the .NET software.
  • 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). Please see the Cumulus MX article for more details of their differences and what will change in November 2020.
  • 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 this Microsoft site for format selectors available.
  • The differences come about because Delphi is case-insensitive, while .NET and MONO are case sensitive. Consequently, .NET (and MONO) can use upper and lower case for different items, but Delphi has to use different letters, ignoring case, for each item.

When it causes problems

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 a very simple impact of this for NOAA report naming.

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 even more now? I'm not surprised, but maybe some examples will help before we actually list the available modifiers.

Examples

  • Examples related to case selection
    1. Badge v1.png In Delphi, "nn" means "minutes" for Cumulus 1, Badge vMx.pngbut "minutes" is "mm" for .NET or MONO in Cumulus MX.
    2. 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).
    3. 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).
    4. For 12-hour specifiers, please see the table, as this is far more complicated.
  • Badge vMx.pngYou 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:
    1. 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).
    2. Similarly, <#MonthTempHD format="M"> is a single character format modifier and therefore the 'M' acts as a standard modifier and causes the date for the highest temperature in the month to be returned in the standard day and month format e.g. '22 July' (exact contents for any one date vary by locale).
    3. Whilst <#metdate format="d M"> is not a single character format modifier and therefore both the 'd' and the 'M' are interpreted as custom modifiers and cause the current date to be returned as a digit(s) for the day and a digit(s) month (in a without leading zeroes format) e.g. '6 7' would be returned for 6 July.
    4. 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.
    5. 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'.

In both Cumulus 1 and MX if you want a space character within your output, the output specifiers must be enclosed in double quotes. If that space character is next to a non modifier (e.g. around word "at") then the single quote needing to surround the at should be widened to include the spaces in MX, but Cumulus 1 does not care if single quotes excluded spaces. However, with MX, single quotes enclose multiple characters, but there is an alternative way to deal with some single verbatim characters to cover next.

So let us compare these two alternative ways that MONO and .NET escape any characters that are not being used as format specifiers.

  • In Badge v1.pngDelphi 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 Badge vMx.png.NET or MONO you can still use single quotes (as mentioned above extended to include adjacent spaces),
    • 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 backslash will NOT work 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]), consequently for some characters you must use the literal approach to include them in your format.

List of allowed modifiers for output format parameters

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

Badge vMx.pngRemember that most single character format specifiers have a different meaning to when the same letter appears in a multi-character format. The % shown in front of nearly every single character specifier in the table is not needed if that character is combined with other characters.


Forum reference

For official full details see 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). So "G" does not need a "%" because it is used on its own for a full date-time specifier. But "%d" is needed if only day number is required, but "d M" and "M" will both work to specify day number and month.

My Revised Table of Time and Date Output Modifiers

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.

Cumulus Version 1 SpecificDelphi Specifier for Cumulus 1.9.x Badge vMx.pngMono/.NET Specifier for Cumulus MX Displays Example
c G Displays the date using the format given by the Short Date format, followed by the time using the format given by the Long Time format. The time is not displayed in Cumulus 1 if the date-time value indicates midnight precisely. '22/03/2019 09:47:25' produced by Cumulus Version 1 Specific<#time format=c>Badge vMx.png<#time format=G>
d %d Displays the day as a number without a leading zero (1-31). Badge vMx.pngNote that Cumulus MX requires a ' ' (space), '%' or other modifier to be included, as 'd' on its own returns full 'short date'). 27 produced by Cumulus Version 1 Specific<#metdate format="d">Badge vMx.png<#metdate format="%d">
dd dd Displays the day as a number with a leading zero (01-31). 07 produced by <#metdate format="dd">
ddd ddd Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Locale. 'Wed' produced by <#metdate format="ddd"> (English locale)
dddd dddd Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Locale. 'Friday' produced by <#metdate format="dddd"> (English locale)
ddddd d (as single character format) Displays the date using the format given by the Short Date format. e.g. '22/03/2019' (British Locale) produced by Cumulus Version 1 Specific<#metdate format="ddddd">Badge vMx.png<#metdate format="d">
dddddd D Displays the date using the format given by the Long Date format. e.g. '22 March 2020' (British Locale)
M (or m) %M Displays the month as a number without a leading zero (1-12).
  • Cumulus Version 1 SpecificCumulus 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.
  • Badge vMx.pngCumulus MX: Note that including a ' ' (space) or '%' before the M makes it a custom modifier e.g. '7' is returned for July as any initial zero is suppressed. ('M' on its own returns both Month and Day according to local format e.g. 22 July).
2
MM (or mm) MM Displays the month as a number with a leading zero (01-12).
  • Cumulus Version 1 SpecificCumulus 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"> 'Jun' produced by <#metdate format="MMM"> (English locale)
MMMM (or mmmm) MMMM Displays the month as a full name (January-December) using the strings appropriate to the Locale. 'June' produced by <#metdate format="MMMM"> (English locale)
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).

Cumulus Version 1 SpecificFor 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].

Cumulus Version 1 SpecificFor Cumulus 1, the minutes can be represented by 'mm' only when appearing in combination with 'h'

'10:27 am' produced by Cumulus Version 1 Specific <#LastDataReadT format="h:nn am/pm">Badge vMx.png <#LastDataReadT format="h:mm tt">
H (or H) %H Displays the hour using 24 hour clock without a leading zero (0-23). Badge vMx.pngNote that % is only needed when H is on its own. 7 produced by Cumulus Version 1 Specific<#daylength format=H>

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. Badge vMx.pngNote 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].

Cumulus Version 1 SpecificFor Cumulus 1 the case output for the optional 'am/pm' depends on the case used for that parameter as shown later in this table 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 Cumulus Version 1 Specific <#LastDataReadT format="hh am/pm">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].

Cumulus Version 1 SpecificFor 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 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 Cumulus Version 1 Specific <#LastDataReadT format="h:nn am/pm">Badge vMx.png <#LastDataReadT format="h:mm tt">
n %m Displays the minute without a leading zero (0-59). Badge vMx.png As other examples show, the % is only needed when "m" is on its own. 7 produced by Cumulus Version 1 Specific<#daylength format=n>Badge vMx.png<#daylength format=m>
nn mm Displays the minute with a leading zero (00-59). '07' produced by Cumulus Version 1 Specific<#daylength format=nn>Badge vMx.png<#daylength format=mm>
s %s Displays the second without a leading zero (0-59). Badge vMx.png As other examples show, the % is only needed when "m" is on its own. 9
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 in MX can actually be extended to 'ffffff' for output to a millionth of a second!

09:47:25.000' produced by Cumulus Version 1 Specific<#time format=hh:nn:ss.zzz>Badge vMx.png<#time format=hh:mm:ss.fff>
(not available) 0zzz Displays the offset of any time from UTC in hours and minutes e.g.-07:00
(not available) %K Effectively another way of including time zone as per zzz example, but it can only be used for times not in UTC (if I understand correctly)
t %t Displays the time using the Short Time format. Badge vMx.pngRemember 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. Badge vMx.png Note that this is a full time specifier and "T" does not need a "%" although it is on its own. '09:47:56' (might not use colon in your locale) produced by Cumulus Version 1 Specific<#LastDataReadT format=TT> Badge vMx.png<#LastDataReadT format=T>
am/pm or Am/Pm or AM/PM tt Cumulus Version 1 SpecificUses 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.

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. Badge vMx.pngRemember 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 typical 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. Hyphens are added in this PHP language example '<#LastDataReadT format=yyyy>'.'-'.'<#LastDataReadT format=MM>'.'-'.'<#LastDataReadT format="dd">'

Using HTML tags within format parameters (available in MX only)

Example using a class to change the look of part of the output

<#TapptempH format="dd' 'MMM' 'yyyy'<span class=\'xx\'> at 'HH:mm'</span>'">

the output from this will look like 04 Dec 2018 at 10:12

Note where the quotes are, and where you need to use '\' escape characters.

Example using HTML tags

<#RecentTS d=2 format="h:mm' 'tt'<small>on' d/M/yyyy'</small>'">

This puts the date in a smaller font than the time

Output (format modifier) parameters for decimal places

Cumulus 1 allows use of dp=n modifier (where n represents desired number of decimal places for latitude and longitude e.g. <#latitude dp=5> gives "59.24250". This is also available in MX. MX makes much more usage of these dp parameters. For example in the moon tags <#MoonAge> gives "11" but <#MoonAge dp=3> gives "11.234"

  • dp=i is used for both Cumulus 1 and MX. The value i following the attribute dp is an integer, how many decimal places you want for the output you see. Only available for a limited range of web tags (latitude and longitude, plus in MX <#MoonPercent> and <#MoonPercentAbs>).
  • tc=y is a new parameter only in MX, the attribute tc takes the value 'y' to remove decimal places by truncation instead of using dp=0 which would round to nearest integer. e.g. <#MoonAge tc=y>. At present not available in any other web tags.

Output (format modifier) indicating remove commas

"rc=y" is a new parameter for MX, the attribute rc takes the value 'y' to replace any commas defined by the locale with full stops to separate integer and decimal parts of the output value. It was initially only implemented on a few new web tags (#MoonPercent, #MoonPercentAbs, #MoonAge) for MX versions up to and including 3.5.3. From version 3.6.6 only can all web tags that can output real numbers can now use alternative syntax of <#tag_name rc=y> to replace all commas in the output by a full stop (don't worry, MX does not use a comma for separating off thousands, so it is the decimal comma that becomes a decimal full stop like character when this remove comma specifier is used.


Why would you want to remove decimal commas? Well because the JavaScript language cannot understand decimal commas, and MX has several scripts written in this language, equally some third party alternative web pages rely on ajax to update them (and Ajax uses JavaScript).

Additional text in output format parameters

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

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

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

Badge vMx.pngNote for MX - you can use single quotation marks round spaces and text (e.g. ' on '), 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" i.e. "\t" becomes a tab!


The web tag application programming interface

Badge vMx.png Available from version 3.7.0 (build 3089).

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.

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

Obviously each api request creates a processing overhead on Cumulus so use this feature wisely.

The examples below focus on obtaining current information, but in practice 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. The admin interface uses api techniques for all the information it needs, but each page has an api request for the version and build being used, that is another example of information that changes seldom, but can be useful to other software running on your local network.

"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. Even if you don't understand the meaning of those technical terms, you probably have seen when using a browser a question mark (?) followed by one or [separated by ampersand (&)] more name=value parameters.

The GET approach to using the 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 is used instead of a name=value parameter.

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 this 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 many other web tags.

If you are using the api in a context where it does not matter if decimal commas or decimal points are in the api, simply omit the rc as first item, and just include tag names separated by ampersands.

JavaScript example

I have a script that works with the standard log editor in the admin interface to calculate (and recalculate after any edit) the derived fields from the source fields. To make these calculations work for anyone, I need to find out what units the Cumulus MX user is using. 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, this is what is returned by the api, the selected name can be 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)
  • The object returned has 3 parameters each in attribute=value format
  • We find the value in any parameter by using the object.attribute syntax and assign it to the variable already defined
  • 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

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

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 the 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.
  • 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; POST can handle much longer requests.

here is an example text file with some web tags in it, let us store it in process.txt:

<#time format="yyyy-MM-dd hh:mm:ss">,<#temp rc=y>,<#hum>,<#dew rc=y>,<#RecentFeelsLike rc=y d=1>

The command http: //localhost:8998/api/tags/process.txt would send that text file to the api server, and you would get back the date and time in ISO format, the current temperature with decimal point, the current humidity, the current dew point with decimal point, and what the feels like temperature was one day ago at this time again with decimal point.

The Web Tags for Cumulus

These are available in both Cumulus 1 and MX unless indicated by a version 1 or MX badge.

Here follow tables indicating what web tags/tokens can be used, tables group the web tags available by the basic purpose of the tags listed.

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

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 realtime update interval in seconds (integer)
<#interval> The web site update interval in minutes (integer)
<#rollovertime> The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'

This is the end of the meteorological day, so if during Daylight Saving Time it is "10 am", then on the day DST ends it will return to "9 am" ensuring every meteorological day is exactly 24 hours long. If the time is "Midnight" or during DST it is "9 am", then days will be 23 or 25 hours long just on day clocks change, 24 hours otherwise.

<#update> The date and time of the last web site update
<#LastDataReadT> The date/time data was last read from the station
<#stationtype> The weather station model description (you choose what text appears for this on 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
<#latitude> The station latitude (as you entered during setup).

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

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

<#longitude> The station longitude (as you entered during setup). Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
<#altitude> The station altitude value (webtag outputs web encoded format containing figure, '&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&nbsp;m'
<#location> The station location (as you entered during setup)
<#longlocation> Longer description of the station location (as you entered during setup)
<#forum> URL of the forum (as you entered during setup)

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

<#webcam> URL of the webcam (as you entered during setup). 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)
<#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

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"
<#tempunitnodeg> The temperature units being used, without a degree symbol, i.e. "F" or "C"
<#pressunit> Unit of measure for pressure. Possible values: "mb", "hPa", "in"
<#rainunit> Unit of measure for rain fall. Possible values: "mm" or "inches"
<#windunit> Unit of measure for wind speed. Possible values: "m/s", "mph", "km/h", "kts"
<#windrununit> Unit of measure for wind run (distance). Possible values: "km", "miles", "km", "nm" (for wind speeds in m/s, mph, km/h, kts)
<#cloudbaseunit> The units used for cloudbase value. Possible values: "ft" or "m"

Date & Time

Both Cumulus 1 and MX support all of these, most of these web tags can be used with output parameters.

Web tag_name Function
<#date> The current date
<#time> The current time and date. Example result: 18:30 on 30 December 2009. If you simply wish the time, use next tag (below)
<#timehhmmss> The current time. Example format: 18:30:27
<#timeUTC> The current UTC date/time rather than local date/time
<#minute> The current time, just the minutes. Example format: 07
<#hour> The current time, just the hour. Example format: 07
<#day> The current day as a 2-digit number. Example format: 07
<#dayname> The current day as a word. For example, Monday
<#shortdayname> The current day as a shortened word. Example format: Mon
<#month> The current month as a 2-digit number. Example format: 07
<#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
<#shortyear> The current year as a 2-digit number. Example format: 09
<#metdate> The current meteorological date. After rollover time on current calendar date, this date will be the same as the current date. If using a 9am/10am rollover, then between midnight and 9am/10am the <#metdate> will be the previous calendar day.

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

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

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

<#yesterday> Yesterdays date
<#rollovertime> The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
<#update> The date and time of the last web site update
<#timeJavaScript> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.pngAvailable from version 3.5.2

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> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.pngAvailable from version 3.7.0

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

Current Conditions

The web tags/token shown here are mainly determined by which 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; 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, see derived value section within Recent History tags section for examples.

Web tag_name Function
Temperature
<#temp> The outside (air) temperature
<#intemp> The inside temperature
<#temptrend> The average rate of change in temperature over the last three hours. Trend = (temp_now - temp_3hrs_ago) / 3
<#temptrendtext> Temperature change over the last three hours - Rising/Falling/Steady (values can be set in strings.ini)
<#temptrendenglish> Temperature change over the last three hours - Rising/Falling/Steady (for use by HTML, javascript etc, values can't be changed)
<#TempChangeLastHour> The change in temperature over the last hour
<#heatindex> Current heat index. 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> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.pngNot available in all MX versions. Please see sub-section below 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 'Dewpoint' on Cumulus 1 main screen
Rainfall
<#rfall> The total rainfall so far today
<#rrate> The current rainfall rate
<#rhour> The rainfall in the last hour
<#rmidnight> The total rainfall since midnight. Useful if you don't use midnight as your start of day
<#r24hour> Amount of rain in the last 24 hours
<#LastRainTipISO> Fixed ISO format output giving date and time of last rain gauge tip (e.g 2010-09-06 06:09) The format is a shown, and cannot be modified by locale or addition of parameters.
<#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.
<#presstrend> The pressure trend in words - values can be set in the 'strings.ini' file
<#presstrendenglish> a singe word description for the pressure trend - Rising/Falling/Steady (for use by HTML, javascript etc, values can't be changed)
<#altimeterpressure> Altimeter pressure. Pressure corrected to sea level using the station's altitude only. Same as sea-level pressure for non-Davis stations.
Wind
<#wlatest> Current wind speed reading from console. Corresponds to 'latest' on the Cumulus main screen.
<#bearing> Current wind bearing in degrees
<#currentwdir> Current wind bearing as a compass point - e.g. ESE
<#wspeed> The 10-minute average, if you have Cumulus set to calculate a 10-minute average. Otherwise, it's the latest 'wind' value from the console (i.e. the current speed as determined by the station). Corresponds to 'average' on the Cumulus main screen.
<#avgbearing> Average wind bearing in degrees over last 10 minutes. Range 1-360, 0=Calm
<#wdir> Average wind bearing over last 10 minutes as a compass point - e.g. ESE
<#wgust> The highest wind reading in the last 10 minutes. Corresponds to 'gust' on the Cumulus main screen.
<#wdirdata> Comma separated list of recent wind bearing readings (every x seconds, up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex. Reading interval x varies by station type.
<#wspddata> Comma separated list of recent individual (non-averaged) wind speed (correspond to 'latest' on the Cumulus main screen) readings (every x seconds, up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex. Reading interval x varies by station type.
<#nextwindindex> The index of the entries in wdirdata and wspddata which Cumulus is going to use next - i.e. the latest entry used is one less than this; but don't forget to allow for the wrap around!
<#beaufort> The current wind speed on the Beaufort scale (e.g. F8)
<#beaufortnumber> The current wind speed on the Beaufort scale, without a leading "F", e.g. "6"
<#beaudesc> The current wind speed Beaufort description (e.g. "Gale")
<#BearingRangeFrom> The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini)
<#BearingRangeTo> The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini)
<#BearingRangeFrom10> The 'lowest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
<#BearingRangeTo10> The 'highest' clockwise bearing in the last 10 minutes (or as configured using AvgBearingMinutes in cumulus.ini), rounded down to nearest 10 degrees
<#WindRoseData> A comma-separated list of the wind 'totals' used to draw the wind rose (8 or 16 values)
<#WindRosePoints> The number of items in <#WindRoseData> (i.e. 8 or 16)
<#WindSampleCount> The number of wind samples making up the wind rose (etc) data (up to 3600)
Miscellaneous
<#cloudbase> Calculated cloud base
<#cloudbasevalue> Current calculated cloud base without units
<#UV> Current UV index. Requires your station to have a UV sensor.
<#SolarRad> Current solar radiation. Requires your station to have a solar sensor.
<#Light> Current Current light level in Lux. Requires your station to have a solar sensor. Only applies to Fine Offset stations.
<#forecast> The current forecast
<#forecastenc> The same as <#forecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
<#forecastnumber> The number relating to the current forecast entry in the strings.ini file. If your station is not providing it's own forecast and Cumulus is not calculating one then 0 (zero) is returned. Note: two negative numbers can be returned by Cumulus: -1 (neg 1) = Exceptional Fine, -26 (neg 26) = Exceptional Bad
<#cumulusforecast> Always gives Cumulus (Zambretti) forecast, even if the <#forecast> tag provides a station forecast
<#cumulusforecastenc> The same as <#cumulusforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
<#wsforecast> Always gives station forecast (if available)
<#wsforecastenc> The same as <#wsforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
<#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.

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

Extra Sensors Davis (and a few others)

These web tags hold current values for additional sensors supported by Cumulus. Most of the tags in this section relate to Davis stations, but not exclusively.

Some tags are only available for certain builds, see general tip at top of page to check for the build you are using. In particular Cumulus 1 has fewer channels available.

There are no web tags for past values from extra sensors, see the Extra_Sensor_Files page for information about log files from where you can extract those values.

Web tag_name The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in viewer/editor
<#ExtraTemp1> Extra temperature channel 1
<#ExtraTemp2> Extra temperature channel 2
<#ExtraTemp3> Extra temperature channel 3
... and so on up to <#ExtraTemp10> = Extra temperature channel 10
<#ExtraDP1> Extra dew point channel 1
<#ExtraDP2> Extra dew point channel 2
<#ExtraDP3> Extra dew point channel 3
... and so on up to <#ExtraDP10>
<#ExtraHum1> Extra humidity channel 1
<#ExtraHum2> Extra humidity channel 2
<#ExtraHum3> Extra humidity channel 3
... and so on up to <#ExtraHum10>
<#SoilTemp1> Soil temperature 1
<#SoilTemp2> Soil temperature 2
... and so on up to <#SoilTemp16>
<#SoilMoisture1> Soil moisture 1
<#SoilMoisture2> Soil moisture 2
... and so on up to <#SoilMoisture16>
<#LeafTemp1> Leaf temperature 1
<#LeafTemp2> Leaf temperature 2
<#LeafWetness1> Leaf wetness 1
<#LeafWetness2> Leaf wetness 2

Extra Sensors Ecowitt

Cumulus Version 1 Specific Not available in Cumulus 1.

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

This section applies only to those using Ecowitt GW1000 (Froggit DS1500) 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> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.pngGW1000 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> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png see release announcements for version availability

Air quality 1

... and so on up to <#AirQuality4>
<#LeakSensor1> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png see release announcements for version availability

Leak sensor - 0 or 1

... and so on up to <#LeakSensor4>
<#LightningDistance> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png see release announcements for version availability

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> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png see release announcements for version availability

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

<#LightningStrikesToday> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png see release announcements for version availability

Number of strikes since midnight, default 0

<#UserTemp1> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png see release announcements for version availability

User Temperature 1 support for the Ecowitt WH34 (other model types exist and are reported here as if WH34) soil and water temperature sensors

... and so on up to <#UserTemp8> = User temperature 8


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 elsewhere in this article.

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. Following the table giving the tags actually available, there is a section on how to derive a few more tags.

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

#No_Commas versions of the array are available for use in script.

Input Parameters

You specify which value you want from the array by using parameters on the web tags for number of days ago, hours ago, and minutes ago. The same d, h, and m, parameters are used by Cumulus 1 and MX.

All values supplied for parameters must be whole numbers.

If you don't supply any parameters, the result is undefined for Cumulus 1, and an illegal web tag for MX.

<#RecentOutsideTemp m=1> will give the temperature one minute ago, <#RecentOutsideTemp h=1> will give the temperature one hour ago (as will <#RecentOutsideTemp m=60>).

<#RecentOutsideTemp d=1> will give the temperature one day ago. Please note: Some Cumulus users say that using <#RecentOutsideTemp d=1 m=1> is more reliable at getting the temperature at a similar time the day before, the extra minute apparently gives better results when you might not be using Cumulus all the time, or your weather station might have some drift on when it supplies readings. See which works best for you.

<#RecentOutsideTemp d=1 h=1 m=1> will give the temperature one day, one hour and one minute ago.

Please note that parameters specify time-stamped array element to retrieve based on counting back from current local time so the result for any period including when clocks change may not be quite what you anticipated.


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

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
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 (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> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png Available from version 3.6.11 (b.3087) onwards.

Feels Like Temperature

<#RecentFeelsLike h=12 m=1> reports the feel like temperature 12 hours ago
<#RecentHumidex> Cumulus Version 1 Specific Not available in Cumulus 1.

Badge vMx.png Available from version 3.7.0 (build 3089) onwards.

Canadian Humidity Index (humidex) Dimensionless - no units

<#RecentHumidex h=3> reports humidex 3 hours 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
<#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. Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
<#RecentWindDir> Wind Direction (instantaneous) <#RecentWindDir m=10> will tell you which direction the wind was blowing from 10 minutes ago
<#RecentWindAvgDir> Wind Direction (average) <#RecentWindAvgDir d=6> will say what the calculated average wind direction was at this time at the start of the week
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)

Other weather derivatives

Although Humidex, 'Apparent Temperature', 'Feels Like temperature' and others listed in Current Conditions section, are not available at all versions, 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. Note that Cumulus 1 and MX do not always use identical formula, and although MX added Feels Like it has changed the formula a few times.

The relevant formulae using JavaScript, adjust for other languages, for some of these are shown below:

Canadian Humidity Index

If you are in USA and use Fahrenheit instead of Celsius, you will need to omit the 5/9 term, but as the index is dimensionless no other conversion is needed. This example is for 3 hours ago, change the input parameters to suit your need.

Cumulus 1:

H = <#RecentOutsideTemp h=3> + 5/9 * (6.1094 * Math.exp(5417.753 *(1/273.16 - 1/ (273.16 + <#RecentDewPoint h=3> )))-10);

Cumulus MX:

svp = 6.112 * Math.exp((17.62 * <#RecentOutsideTemp h=3) / (243.12 + parseFloat(<#RecentOutsideTemp h=3))); H = (5/9 * (<#RecentHumidity h=3> /100 * svp - 10)) + <#RecentOutsideTemp h=3;

Apparent Temperature and Feels Like

Note this apparent temperature formula uses Celsius for temperature and metres per second for wind speed. You will need to do the appropriate conversions from the quoted recent history tags if you use different units. The Australian Apparent temperature formula is same for Cumulus 1 and MX:

var actualVaporPress = <#RecentHumidity h=3>/100) * 6.105 * Math.exp(17.27 * <#RecentOutsideTemp h=3>) / (237.7 + parseFloat(<#RecentOutsideTemp h=3>)))); var appTempDegC = parseFloat(<#RecentOutsideTemp h=3) + (0.33 * actualVaporPress) - (0.7 * <#RecentWindSpeed h=3>) - 4;

Feels Like was implemented as a recent history web tag at version 3.6.11 (see Feels Like section below Current condition web tags) for the gradual introduction of feels like elsewhere. For earlier MX versions, and if you are using Cumulus 1, you can calculate it:

The formulas below use Celsius for temperature and km per hour for wind speed. Again, you will need to do the appropriate conversions from the quoted recent history tags if you use different units.

Calculation from recent history tags is much more complicated because there are 3 different calculations: Feels Like reports exactly same as wind chill for temperatures below 10°C or 50°F so the WC here should equal <#RecentWindChill h=3>:

if(<#RecentWindSpeed h=3> < 4.828) 	WC =  <#RecentOutsideTemp h=3>; 
else{
	wind_pow =  Math.pow(<#RecentWindSpeed h=3>,	 0.16);
	WC = (13.12 + 0.1625 * <#RecentOutsideTemp h=3>) - (11.37 * wind_pow) + (0.3965 * <#RecentOutsideTemp h=3> * wind_pow);// Brackets used to ensure "+" is interpreted as addition not concatenation
} 

For temperatures above 20°C or 68°F Feels Like uses a different way to calculate apparent temperature that it uses at these higher temperatures (this formula only used for 3.6.10 onwards):

var actualVaporPress = <#RecentHumidity h=3>/100) * 6.112* Math.exp((17.62 * <#RecentOutsideTemp h=3>)/(243.12 + <#RecentOutsideTemp h=3>)) / 10.0;   // Not same as at build 3084
		/* uses kilometres per hour for wind speed 	*/
	/*  What Cumulus MX will use to calculate apparent temperature for feels like is changed very slightly */
			if(<#RecentWindSpeed h=3> > 72) <#RecentWindSpeed h=3> =72;
			AT= (1.04 * <#RecentOutsideTemp h=3>) + (2 * actualVaporPress) - (0.1805553 * <#RecentWindSpeed h=3>) - 2.7;

For in-between temperatures it uses a more complicated merge of the two formulas for AT and WC as defined above:

app_temp_mult		= (<#RecentOutsideTemp h=3> - 10) / 10;
wind_chill_mult 	= 1 - app_temp_mult;

FL= AT * app_temp_mult + WC * wind_chill_mult;

Today

Many of these web tags are used on the supplied todayT.htm template, and the supplied todayyest.html page within the MX admin interface.

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

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) 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>
<#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>
<#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
<#snowfalling> Returns 1 if there is an entry in the Weather Diary for Today and the Snow Falling check box is ticked. Returns 0 otherwise.

Cumulus Version 1 Specific Not available in Cumulus 1. Badge vMx.png Available from version 3.1.1 - build 3054.

<#snowdepth> If there is an entry in the Weather Diary for Today, returns the value set there. Returns 0 otherwise.

Cumulus Version 1 Specific 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. Badge vMx.png Available from version 3.1.1 - build 3054 when weather diary editor was added to MX

<#snowlying> Returns 1 if there is an entry in the Weather Diary for Today and the Snow Lying check box is ticked. Returns 0 otherwise.

Cumulus Version 1 SpecificAlthough this tag is not available in Cumulus 1, you can check if <#snowdepth> is non zero for same answer Badge vMx.png Available from version 3.1.1 - build 3054

Pressure
<#pressTH> Today's highest pressure reading <#TpressTH>
<#pressTL> Today's lowest pressure reading <#TpressTL>
Wind
<#windTM> Today's maximum (average) wind speed <#TwindTM>
<#wgustTM> Today's maximum wind gust <#TwgustTM>
<#bearingTM> The wind bearing at the time of today's high gust (<#wgustTM>) in degrees <#TwgustTM>
<#Tbeaufort> Today's highest wind speed, expressed in the Beaufort scale <#TwindTM>
<#Tbeaufortnumber> Today's high wind speed on the Beaufort scale, without a leading "F", e.g. "6" <#TwindTM>
<#windrun> The total wind run so far today N/A
<#domwindbearing> Today's dominant wind direction in degrees n/a
<#domwinddir> Today's dominant wind direction as compass point n/a
<#Tbeaudesc> Beaufort 'description' for today's high wind speed n/a
Miscellaneous
<#ET> Today's evapotranspiration. Applies only to Davis stations, equipped with a solar sensor.

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

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

Yesterday

Note that the Y indicating yesterday is sometimes a prefix, sometimes a suffix (with H for High, L for Low), web tags are not named consistently!

Many of these web tags are used on the supplied yesterdayT.htm template, and the supplied todayyest.html page within the MX admin interface.

For web tags that refer to a particular time of day, there is a corresponding web tag that can give the time of day. Please note none of the time web tags can be modified by output parameters to give a date, but they can be changed from the default time format that is 'h:mm'.

Web tag_name Function Time
Temperature & Humidity
<#tempYH> Yesterday's highest temperature <#TtempYH>
<#tempYL> Yesterday's lowest temperature <#TtempYL>
<#avgtempY> Yesterday's average temperature n/a
<#temprangeY> The temperature range (max - min) yesterday n/a
<#apptempYH> Yesterday's high apparent temperature <#TapptempYH>
<#apptempYL> Yesterday's low apparent temperature <#TapptempYL>
<#feelslikeYH> Badge vMx.png Available from version 3.6.10 (NOT AVAILABLE IN CUMULUS 1)

Yesterday's high feels like temperature

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

Yesterday's low feels like temperature

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

Yesterday's low Canadian Humidity Index

<#ThumidexYH>
<#heatindexYH> Yesterday's high heat index <#TheatindexYH>
<#wchillYL> Yesterday's greatest wind chill (i.e. lowest temperature) <#TwchillYL>
<#dewpointYL> Yesterday's lowest dew point <#TdewpointYL>
<#dewpointYH> Yesterday's highest dew point <#TdewpointYH>
<#humYH> High humidity yesterday <#ThumYH>
<#humYL> Low humidity yesterday <#ThumYL>
Rainfall
<#rfallY> The total rainfall for yesterday according to the connected weather station n/a
<#RG11RainYest> The total rainfall for yesterday according to an RG-11 rain sensor configured in "Tipping Bucket" mode n/a
<#rrateYM> Yesterday's maximum rain rate <#TrrateYM>
<#hourlyrainYH> Yesterday's highest hourly rain <#ThourlyrainYH>
Pressure
<#pressYH> Yesterday's highest pressure reading <#TpressYH>
<#pressYL> Yesterday's lowest pressure reading <#TpressYL>
Wind
<#windYM> Yesterday's maximum (average) wind speed <#TwindYM>
<#wgustYM> Yesterday's maximum wind gust <#TwgustYM>
<#bearingYM> The wind bearing at the time of yesterday's high gust <#TwgustYM>
<#Ybeaufort> Yesterday's highest wind speed, expressed in the Beaufort scale <#TwindYM>
<#Ybeaufortnumber> Yesterday's high wind speed on the Beaufort scale, without a leading "F", e.g. "6" <#TwindYM>
<#Ybeaudesc> Beaufort 'description' for yesterday's high wind speed n/a
<#domwindbearingY> Yesterday's dominant wind direction in degrees n/a
<#domwinddirY> Yesterday's dominant wind direction as compass point n/a
<#windrunY> The total wind run for yesterday n/a
Miscellaneous
<#heatdegdaysY> Yesterday's heating degree days n/a
<#cooldegdaysY> Yesterday's cooling degree days n/a
<#SunshineHoursY> 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>

Monthly

This table shows the web tags used on the thismonthT.htm web page,and the records.html page (accessed by penultimate tab) in the admin interface.

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 greatest daily rain n/a <#MonthDailyRainHD>
<#MonthLongestDryPeriod> Longest dry period ending this month (days) n/a <#MonthLongestDryPeriodD>
<#MonthLongestWetPeriod> Longest period of rain every day, ending this month (days) n/a <#MonthLongestWetPeriodD>

Yearly

This table shows the web tags used on the "thisyearT.htm" web page, and the records.html page (accessed by final tab) in the admin interface.

Because the rainfall this year does not appear on thisyearT.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 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. Although, some web tags represent seasonal derivatives, i.e. where you define the month from which they start counting, this does not apply to any listed in this group.


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>

All Time

The web tags in the date/time column have the default format as seen on "records.htm" in the standard web pages.

These are also available in the admin interface on "records.html" where they appear in the first tab, although the format used there is different and not able to be edited (any time is shown after the date).

  • 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 [[#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.

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 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. To supply both optional input, and optional output parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. In that example, the highest ever temperature in July is returned in the value after processing by Cumulus.

Each Monthly All Time Records web 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). The corresponding date/time web tags are formatted like the all time records directly above this section. You can customise the date and time formats using the output 'format' parameter on the web tag.

If you don't supply an input parameter (or supply an invalid value like zero) the current month will be used. This is useful if you want to write a template that will always supply values for the current month and don't want to use a script to enter the correct input parameter by processing with that script before Cumulus processes the template.


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) <#ByMonthFeelsLikeTempHT>
<#ByMonthFeelsLikeTempL> Badge vMx.pngLow Feels Like Temperature (available from 3.6.10) <#ByMonthFeelsLikeTempLT>
<#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

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

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

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

<#dawn> Start of last Civil Twilight at the station as at last midnight UTC
<#dusk> End of next Civil Twilight at the station as at last midnight UTC
<#daylightlength> Length of daylight in hours and minutes (dawn to dusk)
<#isdaylight> A flag to indicate if the location for the station is in civil daylight or not, based on the dawn and dusk times.

Possible values are 0 or 1, where 1 notes that it is currently within the hours of daylight.

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

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

<#moonphase> Current phase of the moon in words, eg "New Moon" etc. The names used can be altered in strings.ini.
<#MoonAge> Current approximate age of the Moon in days (0-29.53)

MX b3047 adds the 'dp' and 'rc' parameters Supports an optional 'dp' parameter, if supplied the result is returned to the specified number of decimal places. E.g <#MoonAge> gives "11" <#MoonAge dp=3> gives "11.234" If the "dp" parameter is supplied, then also supplying "rc=y" in addition will cause any decimal comma to be converted to a decimal point.

<#moonrise> Current moonrise time at the station (if moon rises on current calendar day)
<#moonset> Current moonset time at the station (if moon sets on current calendar day)
<#MoonPercent> Current percentage of moon visible (negative value indicates 'waning')

MX b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above

<#MoonPercentAbs> Current percentage of moon visible (always positive)

MX b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above

<#SunshineHours> Hours of sunshine so far today (Solar sensor needed)
<#YSunshineHours> Total hours of sunshine yesterday (Solar sensor needed)
<#CurrentSolarMax> Current theoretical maximum solar radiation
<#IsSunny> Returns 1 if the sun is shining, otherwise 0 (Solar sensor needed)

Alarms

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

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.
  • Cumulus Version 1 SpecificIn Cumulus 1.x.x:
    • 1 if 'new record' light is flashing,
    • 0 if not
  • Badge vMx.pngIn Cumulus MX: 1 from when new record is set until
    • either all records have cleared
    • or until next rollover is completed,
  • 0 otherwise
<#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

OS WMR Series

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

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

Davis

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.
<#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.
<#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.
<#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.
<#DavisNumberOfResynchs> 1.9.2 onwards and MX Number of times the console resynchronised with the transmitter
<#DavisFirmwareVersion> 1.9.2 onwards and MX The console 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' (the console does not report start time, but it appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTipISO> in a script might help), but standard Cumulus date/time formatting can be applied to that date.

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

No Commas

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. 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. Some computer languages like JavaScript will not accept a comma being used for this purpose, and Cumulus 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 all correspond to the same tag with 'RC' removed.

CURRENT CONDITIONS:

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


From version 3.5.4 build 3075, all web tags (except indoor temperature <#intemp> where rc parameter not available until version 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.

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