Webtags (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Webtags (preserving history) (view source)

Revision as of 10:13, 4 September 2021

6,252 bytes added ,  10:13, 4 September 2021
m
no edit summary
m (→‎General Tip: whoops - removal of text that no longer applied)
mNo edit summary
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Terminology]]
[[Category:Terminology]]
Please be aware some content originally on this page has been moved to other pages.  Old posts on the support forum that used to link directly to the specific material, will instead bring you to this start of the page. Please see [[#Moved content]] for the new links to those items.
Please be aware some content originally on this page has been moved to other pages.  Old posts on the support forum that used to link directly to the specific material, will instead bring you to this start of the page.  


=Essential Background Reading=
The new links to material that has been moved off this page can be found approximately where the material used to be within three sections on this page: [[#Input Modification Parameters and Output Modification Parameters]], [[#The tag name]], and [[#Recent History]].


If you have not used this Wiki page before, or are unsure about using "web tags", there are some concepts that you do need to understand in the sub-sections that follow.
[[File:Badge v1.png]][[Category:Cumulus 1]] This page was created for Cumulus 1. Steve/Beth Loft provided some example [[Cumulus template file|web template files]], but expected Cumulus users to develop their [[Customised templates|own Cumulus template files]] making use of the web tags, listed below, that the software provided.


Early releases of MX also followed that [[Customised templates|web page template files you could customise]] approach, but that has now stopped.
<div style="background: LemonChiffon;padding:5px; margin:2px;">
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]]
[[File:Crystal Clear info.png|40px]]  
<big>From release 3.10.1,


:if you use the [[New_Default_Web_Site_Information|default web site]], then web tags are provided to your web server using the [[WebsitedataT.json]] file, so see those 2 linked pages if you are interested in the default web pages.</big>
USING CURRENT RELEASE OF MX?
 
* Go to <big>[[WebsitedataT.json]]</big> page, instead of this one
<br>
* That page explains the ID names used on the [[New_Default_Web_Site_Information|default web site]] introduced from release 3.10.0
* That page documents each data pair in the file
* That page gives the source web tag for each ID name on the web pages
* That page explains what data is represented by the  ID name, JSON attribute, web tag name


Continue reading this Wiki Page if you are using your own (customised) web pages, using legacy web pages, ''or'' want a definitive list of all available web tags.
Continue reading this Wiki Page if you are using your own (customised) web pages, using legacy web pages, ''or'' want a definitive list of all available web tags.
</div>
</div>
=Essential Background Reading=
If you have not used this Wiki page before, or are unsure about using "web tags", there are some concepts that you do need to understand in the sub-sections that follow.


==What is a web tag? ==
==What is a web tag? ==


Weather values are always changing, so Cumulus needs a way for you to tell Cumuluss to enter the current value for a particular derivative, when it is [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processing templates]].
Weather values are always changing, so Cumulus needs a way for you to tell Cumulus to enter the current value for a particular derivative, when it is [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|processing templates]].


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


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


===The tag names===
===The tag names===


All the "tag_names" that are available in the release range shown below are listed in [[#The Web Tags for Cumulus]] later on this page:
<div style="background: LemonChiffon;padding:5px; margin:2px;">All the "tag_names" that are available for legacy 1.9.4, and for MX up to release '''3.12.0'''</div> are in [[#Full List of Tag Names]] later on this page.
<div style="background: LemonChiffon;padding:5px; margin:2px;">This page currently covers '''tag names''' for legacy 1.9.4, and for MX up to release '''3.12.0'''</div>{{TOCright}}
 
As Cumulus has developed, more tag names have been introduced, the tables showing tag names available, attempt to give an indication of which release introduced them. The information that used to appear on this page for differences between MX and the legacy Cumulus has been moved to a new [[Webtag Applicability|Web tag Applicability page]].


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


If you are using a Oregon Scientific weather station, then you should read [[#Web tags mentioning (outside) temperature]] in the optional reading section.
If you are using a Oregon Scientific weather station, then you should read [[#Web tags mentioning (outside) temperature]] in the optional reading section.
====Inconsistency of tag names====
For both the legacy Cumulus and for MX, it is vital that you use tag names exactly as they are listed.  That would be easy had Steve Loft created a naming standard and stuck to it.  To be fair, when he first created tag names, Cumulus could only report current values and the summary for the day so far; Steve did not anticipate, back then, that later he would add extreme record monitoring. The legacy tag names for this month and this year were all introduced in a single release and they remain consistent apart from what MX added later!  However, they are not consistent with the naming of the all-time extremes introduced much earlier.
This great inconsistency in the naming, gives rise to a problem as it very easy to spell a tag_name incorrectly (and I apologise if any such mistakes creep into the tables) as you naturally expect there to be a standard pattern.  Some tags are all lower-case, some are camel-case, and some start with a capital letter. Have a look yourself at just how much inconsistency is present in the names in the tables below.
=====Inconsistency in use of "Y"=====
The character "Y" has been selected to denote yesterday in tag names.  The inconsistency is where it appears.  In his oldest tag names (e.g. <#rfallY>, <#windrunY>, <#avgtempY>), Steve used this Y as a suffix. In newer tag names (e.g. <#Ybeaufort>, <#YSunshineHours>, <#Ychillhours>), Steve changed to using Y as a prefix.
=====Consistency becomes inconsistency for this month and this year=====
The legacy tag names for this year and this month were all introduced together by Steve in one release, with consistency in how they were named then, "Month" or "Year" was used as a prefix (this was after he had started using "Y" as a prefix for his new yesterday tag names) e.g. <#YearLongestDryPeriod>.
The development of MX broke this consistency, as Mark adds "Year" as a suffix e.g. <#SunshineHoursYear>.
=====Inconsistency in use of "T"=====
I said above, that early versions of Cumulus only had tag names for current values and for today-so-far.  Therefore it could be assumed that <#beaufort>,  <#temp> and <#press> all represented current values while <#avgtemp> and <#rfall> represented today-so-far values just by looking at their names.
The current value tag names could be used as the basic part of tag names with  "TH" and "TL" added as suffixes to represent daily highs and daily lows, (e.g. <#tempTH>, <#tempTL> and <#pressTH>, <#pressTL>), which made a lot of sense.
But that naming convention was broken when the extreme <#Tbeaufort> used "T" as a prefix, not suffix, and did not include a "H". Continuing looking at today-so-far tag names, we discover a prefix "T" is not just used for values, it is also used for time-stamps e.g. <#TtempTH>.
The use of "T" as a prefix for time-stamps continues in the tag names for all-time extreme records. However, when you look at time-stamps for extremes in this-year, the time-stamp denoting "T" is added as a suffix e.g. <#YearTempHT>.


====General Tip====
====General Tip====
''This sub-section applies to releases up to 3.11.4.'' (From 3.12.0, use the admin interface and Program settings → General options, to get to where you change this setting, instead of editing the file as described below).


The tag names available in the release/version/build you are using, can be listed (in Cumulus 1 or Cumulus MX) by adding the following line to [[Cumulus.ini#Section:_Station|Cumulus.ini]] in the [station] section...
The tag names available in the release/version/build you are using, can be listed (in Cumulus 1 or Cumulus MX) by adding the following line to [[Cumulus.ini#Section:_Station|Cumulus.ini]] in the [station] section...
Line 90: Line 128:




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


==Input Modification Parameters and Output Modification Parameters==
==Input Modification Parameters and Output Modification Parameters==


MX has introduced many more of these, so they are no longer listed on this page.
In [[#Scary_statistics]] section of this page, it is explained how less than a thousand [[#Full List of Tag Names|tag names]] (the first part of the [[#General Format for Web Tags]]) become billions of web tags, simply by adding modifiers.
 
The modifiers available used to be listed on this page (so if you select the history tab for this page, you will find references to their introduction and growth), but are now on a new [[Webtags/Parameters|web tag parameters]] page.  Here are some of the advantages achieved by moving them to the new page:
* This page is very long, so it is not easy to navigate this page, even without the parameters
* There would be a lot of repetition if you attempted to say beside each tag name which modification parameters were available.
* Having them on separate pages means you can have two tabs (or two separate browsers) open so you can see both the tag name and the modifier parameter by flicking between tabs, instead of lots of scrolling between different parts of same page.
* The introduction of [[WebsitedataT.json]], which controls what data is available to tables in the web pages provided by MX, means that page, rather than this page is the entry point for MX, and it is easier for that page to reference a separate parameters page
* MX has introduced many more input and output modification parameters, it is easier to maintain a separate page (and easier for reference if you just want to refresh your mind on new modification parameters).


Now to find out what is allowed for the '''input selection parameters''' and '''output modification parameters''', refer to [[Webtags/Parameters|web tag parameters]] page.


For just a taste, there you can discover:
For just a taste, there you can discover:
* A score of input parameters that modify some of those tags (for example, by using one input parameter attribute with a value between 1 and 12, the same web tag names can give values for 12 different months)
* A score of [[Webtags/Parameters#Input_modification_Parameters|input modification parameters]]
* The components that make up output parameters (a guide to how you modify the output format)
** For  example, find which attribute is used with a value between 1 and 12, so the same tag name can give values for 12 different months)
** how to control number of decimal places
* If your locale normally (in real numbers) uses an integer part, then a comma, and then the decimal part, you should be aware that some computer scripts, and some external servers where you might want to send data, insist on a decimal point, instead of a decimal comma:
** how to control whether decimal comma (if used) is replaced by decimal point (useful for some script languages)
** If you have installed a recent MX release, then [[Webtags/Parameters#Output_Modification_Parameter_for_changing_any_decimal_comma_into_a_decimal_point|change decimal comma to decimal point]] with a simple "y" value to another attribute
** the majority modify the output from almost all web tags that report a time and/or date (there are so many ways to represent times and dates this multiples up the available output considerably)
** If you have the legacy Cumulus 1 installed, stay on this page and look at [[#No_Commas]], as you have to use the restricted alternative set of tag names.
* How to [[Webtags/Parameters#Two_Output_.28format_modifier.29_parameters_for_decimal_places|control number of decimal places]] in any real number output
* All about the complex subject of modifying the way a '''duration''', a ''date'', or a '''clock time''' is output by looking at [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates|Multiple_Output_Format_Modifier_parameters_for_times_and_dates]]


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


==Scary statistics==
==Scary statistics==
Line 153: Line 199:


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


Line 228: Line 274:
<br>
<br>


=<big>The Web Tags for Cumulus</big> =
=<big>Full List of Tag Names</big> =
{{Template:WorkInProgressBanner}}
{{Template:WorkInProgressBanner}}


Here follow tables indicating what web tag names are available to be used, tables group them by the basic purpose of the tags listed.
This list only contains the tag_names, don't forget tag_names are only part of the [[#General Format for Web Tags]], for example in a template file you precede the tag name with &lt;, you may need input parameters, you may need output parameters, and you end the full web tag with &gt;.
 
it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.
 
Here follow tables that group the tag names by the basic purpose of the tags listed. There has been confusion in the past of tags appearing in more than one group, can contributors remove any remaining duplication, so future maintenance is easier.


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


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


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


Cumulus 1 and MX offer current values from some extra temperature and relative humidity sensors (see [[Extra temperatures]]) frm particular weather station models (from Davis and Oregon Scientific).
Both Cumulus 1 and MX offer current values from some [[#Extra Sensors|extra]] temperature and relative humidity sensors (see [[Extra temperatures]]) from particular weather station models.


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


==== Feels Like ====
==== Feels Like ====
Line 279: Line 332:
|<#intemp>
|<#intemp>
|The inside temperature
|The inside temperature
|-
|<#TempChangeLastHour>
|The change in outside temperature over the last hour (not available in early versions of Cumulus  1, when this was announced, a temperature change over 24 hours was also proposed, but never implemented)
|-
|-
|<#temptrend>
|<#temptrend>
|The average rate of change in temperature over the last three hours. Trend = (temp_now - temp_3hrs_ago) / 3
|The average rate of change in temperature over the last three hours. Trend = (temp_now - temp_3hrs_ago) / 3 (available in all releases, the calculation selected for this trend matches the standard-based calculation for <#presstrendval> despite the naming inconsistency)
|-
|-
|<#temptrendtext>
|<#temptrendtext>
Line 287: Line 343:
|-
|-
|<#temptrendenglish>
|<#temptrendenglish>
|Temperature change over the last three hours - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed)
|Temperature change over the last three hours - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed). From version 1.8.8 1st December 2009
|-
|-
|<#TempChangeLastHour>
|<#heatindex>
|The change in temperature over the last hour
|-
|<#heatindex>
|Current [[heat index]].  The referenced page in weather terminology section of this Wiki explains it.
|Current [[heat index]].  The referenced page in weather terminology section of this Wiki explains it.
|-
|-
Line 305: Line 358:
|-
|-
|<#feelslike>
|<#feelslike>
|{{Version badge 1}} Not available in Cumulus 1.
|[[File:Badge v1.png]] Not available in Cumulus 1.


[[File:Badge vMx.png]]Not available in all MX versions. Please see [[#Feels_Like|sub-section before this table]] regarding availability by MX versions if you are using a MX version earlier than 3.6.10.
[[File:Badge vMx.png]]Not available in all MX versions. Please see [[#Feels_Like|sub-section before this table]] regarding availability by MX versions if you are using a MX version earlier than 3.6.10.
Line 378: Line 431:
|-
|-
|<#presstrendval>
|<#presstrendval>
|The average rate of pressure change over the last three hours.
|The average rate of pressure change over the last three hours. Trend = (pressure_now - pressure_3hrs_ago) / 3    (Fixed from version 1.7.7 5th March 2008)
|-
|-
|<#presstrend>
|<#presstrend>
Line 384: Line 437:
|-
|-
|<#presstrendenglish>
|<#presstrendenglish>
| a singe word description for the pressure trend - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed)
| a singe word description for the pressure trend - Rising/Falling/Steady (for use by [[Webtags_as_boolean_operators_in_HTML|HTML]], [[Editing_content_of_a_webpage_using_either_HTML_or_Script|javascript]] etc, values can't be changed). From version 1.8.8 1st December 2009
|-
|-
| <#PressChangeLast3Hours>
| <#PressChangeLast3Hours>
Line 423: Line 476:
|-
|-
|<#wspddata>
|<#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.
|Comma separated list of recent individual (non-averaged) wind speed (correspond to 'latest' on the Cumulus main screen) readings (every x seconds, up to 3600 entries). This is a circular buffer; to find the most recent value use '''nextwindindex''' tag. Reading interval x varies by station type.
|-
|-
|<#nextwindindex>
|<#nextwindindex>
Line 711: Line 764:
Ecowitt stations are sold under other names depending on nation,  e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in same way as Fine Offset is used as a generic name for stations sold under a variety of branding, in this Wiki.
Ecowitt stations are sold under other names depending on nation,  e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in same way as Fine Offset is used as a generic name for stations sold under a variety of branding, in this Wiki.


{{Version badge 1}} Not available in Cumulus 1..
[[File:Badge v1.png]]Not available in Cumulus 1.


=====Extra Sensors: Ecowitt WH45 CO₂ sensor=====
=====Extra Sensors: Ecowitt WH45 CO₂ sensor=====


[[File:Badge vMx.png]] Unless otherwise indicated these web tags become available from release 3.9.5.
[[File:Badge vMx.png]] Unless otherwise indicated these web tags become available from release 3.9.5.
<big>THE INFORMATION HERE IS TAKEN FROM RELEASE ANNOUNCEMENTS THAT DO NOT EXPLAIN WHAT THESE WEB TAGS REPORT
PLEASE WOULD SOMEBODY WHO UNDERSTANDS THIS TERMINOLOGY UPDATE THE FOLLOWING TABLE</big>


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 725: Line 774:
!style="width:150px" |Web tag_name
!style="width:150px" |Web tag_name
!style="width:600px" |Function
!style="width:600px" |Function
|-
| <#CO2>
| The actual CO<small>2</small>concentration in ppm
|-
|-
| <#CO2-pm2p5>
| <#CO2-pm2p5>
| Air Quality expressed in terms of particulate matter of 2.5 micrometres or less
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<small>3</small> or less
|-
|-
| <#CO2-pm2p5-24h>
| <#CO2-pm2p5-24h>
| Air Quality expressed in terms of particulate matter of 2.5 μm, or less, Last 24 hours average
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<small>3</small>, or less, 24 hours moving average
 
WILL SOMEBODY WHO KNOWS UPDATE THIS ENTRY AND OTHERS
|-
|-
| <#CO2-pm10>
| <#CO2-pm10>
| Air Quality expressed in terms of particulate matter of 10 μm, or less
| Air Quality expressed in terms of particulate matter of 10 μm/m<small>3</small>, or less (yes, this includes the 2.5 figure)
|-
|-
| <#CO2-pm10-24h>
| <#CO2-pm10-24h>
| Air Quality expressed in terms of particulate matter of 10 μm, or less, Last 24 hours average  
| Air Quality expressed in terms of particulate matter of 10 μm/m<small>3</small>, or less, 24 hours moving average  
 
WILL SOMEBODY WHO KNOWS UPDATE THIS ENTRY AND OTHERS
|-
|-
| <#CO2-temp>
| <#CO2-temp>
| Temperature as reported by Air Quality monitor
| Temperature as reported by Air Quality monitor.
 
Note that this temperature has nothing to do with the temperature as reported by the main weather station. It reflects the temperature of the sensor and would be used in combination with the sensors measured humidity (see next) for correction of the measured PM (particulate matter) value. Determination of how to correct the PM value is highly dependent on the conditions and placement of the sensor. See the specification sheet for the sensor or create some multivariate regression line based on calibration measurements. This is also valid for PM sensors like the AirLink. The normal amateur usage of PM sensors is that the uncorrected values are published.
|-
|-
| <#CO2-hum>
| <#CO2-hum>
Line 757: Line 807:


=====Extra Sensors: Ecowitt Air quality, leak sensors, lighting detector, and extra temperature sensors=====
=====Extra Sensors: Ecowitt Air quality, leak sensors, lighting detector, and extra temperature sensors=====
{{Version badge 1}} Not available in Cumulus 1.
 
[[File:Badge v1.png]] Not available in Cumulus 1.


[[File:Badge vMx.png]] Please see release announcements for when individual web tags became available
[[File:Badge vMx.png]] Please see release announcements for when individual web tags became available
Line 778: Line 829:
|-
|-
|<#AirQuality1>
|<#AirQuality1>
| Air quality 1
| Air quality in μm/m<small>3</small> or less
|-
|<#AirQuality2>
| Air quality in μm/m<small>3</small> or less
|-
|-
|colspan="2"|... and so on up to <#AirQuality4>
|colspan="2"|... and so on up to <#AirQuality4>
|-
|<#AirQualityAvg1>
| 24 hr running average Air quality in μm/m<small>3</small> or less
|-
|<#AirQualityAvg2>
| 24 hr running average Air quality in μm/m<small>3</small> or less
|-
|colspan="2"|... and so on up to <#AirQualityAvg4>
|-
|-
|<#LeakSensor1>
|<#LeakSensor1>
|Leak sensor - 0 or 1  
|Leak sensor 1 - returns false/true as 0 or 1
|-
|<#LeakSensor2>
|Leak sensor 2 - returns false/true as 0 or 1  
|-
|-
|colspan="2"|... and so on up to <#LeakSensor4>
|colspan="2"|... and so on up to <#LeakSensor4>
Line 804: Line 869:
==Recent History==
==Recent History==


There are a set of web tags for 'recent historical data', based on an array stored by Cumulus giving data values from 1 minute ago, up to 1 week ago, in 1 minute intervals. As Cumulus runs it will add the latest values to the array with full resolution, and shift existing values along so those older than 7 days fall off. 
Please refer to the [[Recent history]] page for full information about using the tags in the following two tables, as material once on this page has been moved there.
*The input modification parameters available are listed at [[Webtags/Parameters#Input Modification Parameters for Recent History]].
**To save you looking up the details, these input parameters specify how many minutes ago is required. Instead of entering a very large number for minutes, you can include separate input parameters for days, hours, and minutes, ago.
**Examples appear in the table below, with explanations


Following the table giving the tag names actually available, there is a section on how to derive a few more weather derivatives using a combination of the tag names shown.
===Using input/output modification parameters with recent history tag names===


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


===Warning when Daylight Saving Time starts or ends===
=== Table of Recent History tag names available ===
 
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
* ''when the clocks go back'', one hour has been overwritten; or
* ''when the clocks go forward'', one hour in the array simply does not exist.
 
=== Table of Recent History web tags available ===
 


[[#No_Commas]] versions of the array are available for use in script. If you use MX, the tag names in this table can take a [[Webtags/Parameters#Output Modification Parameter for Removing Commas|rc=y]] parameter.
One tag name is available since 1.9.3 to report the time associated with values you request.


Although as [[Recent history]] page explains, the history is intended to cover every minute in last 7 days, some entries may be at less frequent intervals, and when clocks change some entries will be missing altogether.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 838: Line 909:
|Gives the timestamp of the data that will be returned for any other recent history tag that uses same '''d, h, and m''' parameters
|Gives the timestamp of the data that will be returned for any other recent history tag that uses same '''d, h, and m''' parameters
|<#RecentTS h=3 m=1 format="HH:nn"> for cumulus 1; <#RecentTS h=3 m=1 format="HH:mm"> for cumulus MX
|<#RecentTS h=3 m=1 format="HH:nn"> for cumulus 1; <#RecentTS h=3 m=1 format="HH:mm"> for cumulus MX
|}
====Available in 1.9.3, 1.9.4, and all MX releases====
{| class="wikitable" border="1"
|-
!style="width:150px" | Tag_name
!style="width:600px" | Function
!style="width:600px" | Input Modification Parameters example
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity tags
|colspan="3" style="background:lightgray;"|Temperature & Humidity tags
Line 846: Line 926:
|-
|-
|<#RecentWindChill>
|<#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).
|Wind Chill  
| <#RecentWindChill d=48 m=1> reports the wind chill temperature 2 days ago
| <#RecentWindChill d=48 m=1> reports the wind chill temperature 2 days ago
|-
|<#RecentFeelsLike>
|{{Version badge 1}} Not available in Cumulus 1.
[[File: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>
|{{Version badge 1}} Not available in Cumulus 1.
[[File: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>
|<#RecentDewPoint>
Line 877: Line 941:
| d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
| d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind <br>(Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings see [[Wind measurement]])
|-
|-
|<#RecentWindSpeed>
|<#RecentWindSpeed>
Line 890: Line 954:
|-
|-
|<#RecentWindLatest>
|<#RecentWindLatest>
|Wind Latest. Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings
|Wind Latest.  
| d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
| d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|-
|-
Line 924: Line 988:
|}
|}


=== Other weather derivatives ===
====Available in MX only====


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.
Please note this section has NOT yet been updated for recent MX releases, it appears from [[cumulusmx.db|RecentData table in cumulusmx.db]] that the list here is not complete for MX.  However, no release announcement has been found listing tag names not shown here (i.e. apparent temperature, indoor temperature and humidity, air quality)
{| class="wikitable" border="1"
|-
!style="width:150px" | tag_name
!style="width:150px" | Introduced
!style="width:600px" | Function
!style="width:600px" | Input Modification Parameters example
|-
|colspan="4" style="background:lightgray;"|Indoor Temperature & Humidity tags
|-
|colspan="4" style="background:lightgray;"|Outdoor Temperature & Humidity tags
|-
|<#RecentWindChill>
| Legacy Cumulus version 1.8.5
|Wind Chill  (if temperature is below 10°C or 50 °F, then the new Feels Like now available in MX (next item) will report this same value).
| <#RecentWindChill d=48 m=1> reports the wind chill temperature 2 days ago
|-
|<#RecentFeelsLike>
| Available from version 3.6.11 (build 3087) onwards.
| Feels Like Temperature
| <#RecentFeelsLike h=12 m=1> reports the feel like temperature 12 hours ago
|-
|<#RecentHumidex>
| Available from version 3.7.0 (build 3089) onwards.
| Canadian Humidity Index (humidex) Dimensionless - no units
| <#RecentHumidex h=3> reports humidex 3 hours ago
|-
|colspan="4" style="background:lightgray;"|Air Quality tags
|}


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


==== Canadian Humidity Index ====
Special tags returning information about the Windows device hosting Cumulus 1.


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.
[[File:Badge vMx.png]]''If you are running MX, then most tags do not work.''


Cumulus 1:
{| class="wikitable" border="1"
 
|-
H = <#RecentOutsideTemp h=3> + 5/9 * (6.1094 * Math.exp(5417.753 *(1/273.16 - 1/ (273.16 + <#RecentDewPoint h=3> )))-10);
!style="width:150px" |Web tag_name
 
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|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>:
<pre>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
} </pre>
 
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):
<pre>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;</pre>
 
For in-between temperatures it uses a more complicated merge of the two formulas for AT and WC as defined above:
<pre>app_temp_mult = (<#RecentOutsideTemp h=3> - 10) / 10;
wind_chill_mult = 1 - app_temp_mult;
 
FL= AT * app_temp_mult + WC * wind_chill_mult;</pre>
 
== System ==
 
Special tags returning information about the Windows device hosting Cumulus 1.
 
[[File:Badge vMx.png]]''If you are running MX, then most tags do not work.''
 
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:150px" |Applicability
!style="width:150px" |Applicability
!style="width:600px" |Function
!style="width:600px" |Function
Line 997: Line 1,043:
|-
|-
|<#SystemUpTime>
|<#SystemUpTime>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|How long the system has been up, e.g. "8 hours 21 minutes"  
|How long the system has been up, e.g. "8 hours 21 minutes"  
|-
|-
Line 1,005: Line 1,053:
|-
|-
|<#CpuName>
|<#CpuName>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
|CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
|-
|-
|<#CpuCount>
|<#CpuCount>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|Number of processors, e.g. "4"
|Number of processors, e.g. "4"
|-
|-
|<#MemoryStatus>
|<#MemoryStatus>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|Free and total system RAM, e.g. "4619/8191 MB (free/total)"
|Free and total system RAM, e.g. "4619/8191 MB (free/total)"
|-
|-
|<#DisplayMode>
|<#DisplayMode>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|Screen display mode, e.g. "1680x1050, 32 bit"
|Screen display mode, e.g. "1680x1050, 32 bit"
|-
|-
|<#AllocatedMemory>
|<#AllocatedMemory>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|Amount of memory allocated to Cumulus, e.g. "18.76 MB"
|Amount of memory allocated to Cumulus, e.g. "18.76 MB"
|-
|-
|<#DiskSize>
|<#DiskSize>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|Size of disk on which Cumulus is running, e.g. "931.51 GB"  
|Size of disk on which Cumulus is running, e.g. "931.51 GB"  
|-
|-
|<#DiskFree>
|<#DiskFree>
|{{Version badge 1}}(not available on MX)
| (not available on MX)
 
[[File:Badge v1.png]] only in legacy Cumulus
|Free space on disk on which Cumulus is running, e.g. "515.36 GB"
|Free space on disk on which Cumulus is running, e.g. "515.36 GB"
|}
|}
Line 1,244: Line 1,306:
**Between midnight and 9am/10am the <#metdate> will return the date associated with previous calendar day, but will still return current time   
**Between midnight and 9am/10am the <#metdate> will return the date associated with previous calendar day, but will still return current time   


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


[[File:Badge vMx.png]] Earlier MX releases provide a similar web template set, so these can be customised in same way as for legacy Cumulus above (but note capital "M" must be used for any month formatting). From release 3.10.1 the supplied web pages are web server based, there are no web templates to customise, and the supplied '''.json files''' do not include any meteorological date functionality.
[[File:Badge vMx.png]] Earlier MX releases provide a similar web template set, so these can be customised in same way as for legacy Cumulus above (but note capital "M" must be used for any month formatting). From release 3.10.1 the supplied web pages are web server based, there are no web templates to customise, and the supplied '''.json files''' do not include any meteorological date functionality.
Line 1,313: Line 1,375:
|-
|-
|<#timeJavaScript>
|<#timeJavaScript>
|{{Version badge 1}} Not available in Cumulus 1.
| [[File:Badge vMx.png]]Available from version 3.5.2, so not available in legacy software
 
[[File:Badge vMx.png]]Available 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 <tt>Math.floor(new Date().getTime()/1000.0)</tt> This getTime method returns the time in milliseconds.  The web tag returns an integer (currently with 13 digits) representing the number of milliseconds since the UNIX epoch when the web tag was processed. It can be used in a script where you wish to re-express other times output by Cumulus MX into UTC (Coordinated Universal Time).  Mac OS X uses 00:00:00.000 UTC on 1st January 2001 as the starting time and date for its millisecond count, so that is considerably lower.
The JavaScript '''Date''' object contains the number of miliseconds since 00:00:00.000 UTC on 1st January 1970, that date and time is known as the UNIX Epoch.  In JavaScript, you can use <tt>Math.floor(new Date().getTime()/1000.0)</tt> This getTime method returns the time in milliseconds.  The web tag returns an integer (currently with 13 digits) representing the number of milliseconds since the UNIX epoch when the web tag was processed. It can be used in a script where you wish to re-express other times output by Cumulus MX into UTC (Coordinated Universal Time).  Mac OS X uses 00:00:00.000 UTC on 1st January 2001 as the starting time and date for its millisecond count, so that is considerably lower.
Line 1,324: Line 1,384:
|-
|-
|<#timeUnix>
|<#timeUnix>
|{{Version badge 1}} Not available in Cumulus 1.
| [[File:Badge vMx.png]]Available from version 3.7.0, so not available in legacy software
 
[[File:Badge vMx.png]]Available 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).
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).
Line 1,380: Line 1,438:
If there is no entry in Weather Diary for the day explained above, reports zero.
If there is no entry in Weather Diary for the day explained above, reports zero.


{{Version badge 1}} Input and output is always as integer. Available from very early builds, weather diary input amended from version 1.8.6 14th April 2009 to allow units to be specified on diary edit screen. If you choose to enter as whole millimetres, you can use JavaScript (or another script language) on your web page to divide the web tag by 10 and get centimetres to 1 decimal place on output.  
[[File:Badge vMx.png]] Input is to 2 decimal places. Available from version 3.1.1 - build 3054 when weather diary editor was added to MX.  MX allows output in centimetres with decimal places without any script. You can't change the units shown in admin interface, but your value can be input as inches to 2 decimal places if you ignore "cm" that is displayed in that interface.


[[File:Badge vMx.png]] Input is to 2 decimal places. Available from version 3.1.1 - build 3054 when weather diary editor was added to MX. MX allows output in centimetres with decimal places without any script. You can't change the units shown in admin interface, but your value can be input as inches to 2 decimal places if you ignore "cm" that is displayed in that interface.
[[File:Badge v1.png|Fil]] Input and output is always as integer. Available from very early builds, weather diary input amended from version 1.8.6 14th April 2009 to allow units to be specified on diary edit screen. If you choose to enter as whole millimetres, you can use JavaScript (or another script language) on your web page to divide the web tag by 10 and get centimetres to 1 decimal place on output.  
|-
|-
|<#snowlying>
|<#snowlying>
|{{Version badge 1}}Although this tag is not available in Cumulus 1, your web page can use a script to check if <#snowdepth> is non zero, as that means snow is lying
| [[File:Badge vMx.png]] Available from version 3.1.1 - build 3054.  If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.


[[File:Badge vMx.png]] Available from version 3.1.1 - build 3054.  If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.
[[File:Badge v1.png]] Although this tag is not available in Cumulus 1, your web page can use a script to check if <#snowdepth> is non zero, as that means snow is lying
|-
|-
|<#snowfalling>
|<#snowfalling>
|{{Version badge 1}} Not available in Cumulus 1. There is no web page workaround, unless you write a script that reads [[Weather Diary]] and makes relevant information available on your web server.
| [[File:Badge vMx.png]] Available from version 3.1.1 - build 3054.     If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.


[[File:Badge vMx.png]] Available from version 3.1.1 - build 3054.     If there is no entry in Weather Diary for the day explained above, , this web tag returns Null. Otherwise reports 1 if tick in diary, 0 is unticked.
[[File:Badge v1.png]] Not available in Cumulus 1. There is no web page workaround, unless you write a script that reads [[Weather Diary]] and makes relevant information available on your web server.
|}
|}


===Today.ini===
===Today.ini===


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


Information for these tags is taken from [[today.ini]], hence the sub-section title, although Sunshine Hours can be taken from either [[yesterday.ini]] or "today.ini" depending on (respectively) whether before or after rollover time if that is not midnight.
Where a tag name reports a value specific to a past time in today-so-far, there will also be a tag name that can give the time of day, shown in same row of table below. For those that cover whole day so far, the final column contains "n/a". Please note none of the time tags can be modified by output parameters to give a date, but they can be changed from the default time format that is 'H:mm' (24 hour clock notation without leading zero for hour) for Cumulus 1 and MX.


Many of these web tags were used on the supplied '''todayT.htm''' template in the legacy "/web" folder.  If you are using MX, the today and yesterday page in the [[MX_Administrative_Interface]] shows similar information by using the [[Cumulus_MX_Local_API#Today.2FYesterday_Data|local application programming interface]].
Also as explained earlier, there is some inconsistency in naming with "T" not included in all tag names, "T" is used in conjunction with "H" or "L" as a suffix for extreme values/time-stamps, but a prefix "T" can identify today's value, or prefix "T" can signify a time-stamp.  


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. For those that cover whole day so far, the final column contains "n/a".
In the legacy '''todayT.htm''' template, in the legacy "/web" folder, use was made of a selection of the tag names listed here.


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 MX, the today and yesterday page in the [[MX_Administrative_Interface]] shows similar information by using the [[Cumulus_MX_Local_API#Today.2FYesterday_Data|local application programming interface]].
 
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 the two codes represent different formats for MX; MX insists on 'mm' being used for minutes, but the 'NN' and 'nn' used by Cumulus 1 could be replaced by 'mm' if they followed an hour specifier).
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,603: Line 1,659:
   
   


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 produc
From '''version 3.5.4''' build 3075, most web tags (one notable exception is 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. <tt><#tempYH rc=y></tt> will report yesterday's highest temperature using a full stop to separate decimal part where the locale would normally use a comma.
=== Heading text ===
e decimal number output now support the "'''rc=y'''" option. e.g. <tt><#tempYH rc=y></tt> will report yesterday's highest temperature using a full stop to separate decimal part where the locale would normally use a comma.


==Yesterday==
==Yesterday==
Line 1,762: Line 1,816:
|n/a
|n/a
|-
|-
| <#windAvgY>>
| <#windAvgY>
| [[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
| [[File:Badge vMx.png]] (Available from release 3.12.0 onwards)


Line 1,778: Line 1,832:
|n/a
|n/a
|-
|-
|<#SunshineHoursY>
|<#YSunshineHours>
|Yesterday's hours of sunshine so far. Added in Cumulus 2, then to 1.9.1 build 957, also in MX. From version 3.7.0 takes a parameter "dp=n" so the number of decimal places required can be specified
|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
|n/a
Line 1,791: Line 1,845:
|}
|}


==Monthly==
==Yearly==
 
This table shows most of the web tags used on the "thisyearT.htm" web template.
 
The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.


This table shows the web tags used on the '''thismonthT.htm''' web template.
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.


Because the rainfall this month does not appear on '''thismonthT.htm''' web page, it is shown in [[#Current_Conditions|indexT.htm]] table earlier in this article which is for the web page where it does appear.
Remember that the Year-to-date runs from roll-over time on 1 January for all web tags listed here.  


The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.
The list below does NOT include any web tags that represent seasonal derivatives, i.e. where you define the month from which they start counting. (Cumulative seasonal Chill Hours <#chillhours> and Total seasonal rainfall <#ryear> can both be found in [[Webtags#Current_Conditions|Current Conditions]]). Note, that does not imply both are included in '''indexT.htm'''.


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,805: Line 1,862:
!style="width:150px"|Web tag_name
!style="width:150px"|Web tag_name
!style="width:300px"|Function
!style="width:300px"|Function
!style="width:150px"|Time
!style="width:350px"|Time
!style="width:150px"|Date
!style="width:150px"|Date
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#MonthTempH>
|<#YearTempH>
|This months high temperature
|This year's highest temperature
|<#MonthTempHT>
|<#YearTempHT>
|<#MonthTempHD>
|<#YearTempHD>
|-
|-
|<#MonthTempL>
|<#YearTempL>
|This months low temperature
|This year's lowest temperature
|<#MonthTempLT>
|<#YearTempLT>
|<#MonthTempLD>
|<#YearTempLD>
|-
|-
|<#MonthMinTempH>
|<#YearHighDailyTempRange>
|This months highest daily minimum temperature
|This year's highest Daily Temp Range
|[[File:badge v1.png]]<#MonthMinTempHD format=hh:nn> or <#MonthMinTempHD format=HH:mm> for Cumulus 1, 
[[File:Badge vMx.png]] <#MonthMinTempHD format=HH:mm> for Cumulus MX
|<#MonthMinTempHD>
|-
|<#MonthMaxTempL>
|This months lowest daily maximum temperature
|[[File:badge v1.png]]<#MonthMaxTempLD format=HH:mm> or <#MonthMaxTempLD format=hh:nn> for Cumulus 1,
[[File:Badge vMx.png]]<#MonthMaxTempLD format=HH:mm> for Cumulus MX
|<#MonthMaxTempLD>
|-
|<#MonthHighDailyTempRange>
|High Daily Temp Range
|n/a
|n/a
|<#MonthHighDailyTempRangeD>
|<#YearHighDailyTempRangeD>
|-
|-
|<#MonthLowDailyTempRange>
|<#YearLowDailyTempRange>
|Low Daily Temp Range
|This year's lowest Daily Temp Range
|n/a
|n/a
|<#MonthLowDailyTempRangeD>
|<#YearLowDailyTempRangeD>
|-
|-
|<#MonthHeatIndexH>
|<#YearHeatIndexH>
|This months high USA heat index
|This year's highest USA heat index
|<#MonthHeatIndexHT>
|<#YearHeatIndexHT>
|<#MonthHeatIndexHD>
|<#YearHeatIndexHD>
|-
|-
|<#MonthWChillL>
|<#YearWChillL>
|This months greatest wind chill (i.e. lowest temperature)
|This year's greatest wind chill (i.e. lowest temperature)
|<#MonthWChillLT>
|<#YearWChillLT>
|<#MonthWChillLD>
|<#YearWChillLD>
|-
|-
|<#MonthAppTempH>
|<#YearAppTempH>
|This month's high apparent temperature
|This year's highest apparent temperature
|<#MonthAppTempHT>
|<#YearAppTempHT>
|<#MonthAppTempHD>
|<#YearAppTempHD>
|-
|-
|<#MonthAppTempL>
|<#YearAppTempL>
|This month's low apparent temperature
|This year's lowest apparent temperature
|<#MonthAppTempLT>
|<#YearAppTempLT>
|<#MonthAppTempLD>
|<#YearAppTempLD>
|-
|-
|<#MonthFeelsLikeH>
|<#YearFeelsLikeH>
|This month's highest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]This year's highest feels like temperature (available from 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#MonthFeelsLikeHT>
|<#YearFeelsLikeHT>
|<#MonthFeelsLikeHD>
|<#YearFeelsLikeHD>
|-
|-
|<#MonthFeelsLikeL>
|<#YearFeelsLikeL>
|This months lowest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]This year's lowest feels like temperature (available from 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#MonthFeelsLikeLT>
|<#YearFeelsLikeLT>
|<#MonthFeelsLikeLD>
|<#YearFeelsLikeLD>
|-
|-
|<#MonthHumidexH>
|<#YearHumidexH>
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)


This month's highest Canadian Humidity Index
This year's highest Canadian Humidity Index
|<#MonthHumidexHT>
|<#YearHumidexHT>
|<#MonthHumidexHD>
|<#YearHumidexHD>
|-
|-
|<#MonthDewPointH>
|<#YearDewPointH>
|This month's high dew point
|This year's highest dew point
|<#MonthDewPointHT>
|<#YearDewPointHT>
|<#MonthDewPointHD>
|<#YearDewPointHD>
|-
|-
|<#MonthDewPointL>
|<#YearDewPointL>
|This month's low dew point
|This year's lowest dew point
|<#MonthDewPointLT>
|<#YearDewPointLT>
|<#MonthDewPointLD>
|<#YearDewPointLD>
|-
|-
|<#MonthHumH>
|<#YearMinTempH>
|This month's highest humidity
|This year's highest daily minimum temperature
|<#MonthHumHT>
|Flavour specific mandatory output parameters:
|<#MonthHumHD>
* <#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>
|-
|-
|<#MonthHumL>
|<#YearHumL>
|This month's lowest humidity
|This year's low humidity
|<#MonthHumLT>
|<#YearHumLT>
|<#MonthHumLD>
|<#YearHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|colspan="4" style="background:lightgray;"|Pressure
|-
|-
|<#MonthPressH>
|<#YearPressH>
|This month's highest pressure
|This year's high pressure
|<#MonthPressHT>
|<#YearPressHT>
|<#MonthPressHD>
|<#YearPressHD>
|-
|-
|<#MonthPressL>
|<#YearPressL>
|This month's lowest pressure
|This year's low pressure
|<#MonthPressLT>
|<#YearPressLT>
|<#MonthPressLD>
|<#YearPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#MonthGustH>
|<#YearGustH>
|This month's highest wind gust
|This year's high wind gust
|<#MonthGustHT>
|<#YearGustHT>
|<#MonthGustHD>
|<#YearGustHD>
|-
|-
|<#MonthWindH>
|<#YearWindH>
|This month's highest wind speed
|This year's high wind speed
|<#MonthWindHT>
|<#YearWindHT>
|<#MonthWindHD>
|<#YearWindHD>
|-
|-
|<#MonthWindRunH>
|<#YearWindRunH>
|This month's high Daily Wind Run
| This year's highest Daily Wind Run
|n/a
|n/a
|<#MonthWindRunHD>  
|<#YearWindRunHD>  
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
|-
|-
|<#MonthRainRateH>
|<#YearRainRateH>
|This month's highest rainfall rate
|This year's highest rainfall rate
|<#MonthRainRateHT>
|<#YearRainRateHT>
|<#MonthRainRateHD>
|<#YearRainRateHD>
|-
|-
|<#MonthHourlyRainH>
|<#YearHourlyRainH>
|This month's highest hourly rain
|This year's highest hourly rain
|<#MonthHourlyRainHT>
|<#YearHourlyRainHT>
|<#MonthHourlyRainHD>
|<#YearHourlyRainHD>
|-
|-
|<#MonthDailyRainH>
|<#YearDailyRainH>
|This month's wettest day (greatest daily rain)
|This year's high daily rain
|n/a
|n/a
|<#MonthDailyRainHD>
|<#YearDailyRainHD>
|-
|-
|<#MonthLongestDryPeriod>
|<#YearMonthlyRainH>
|Longest dry period ending this month (days)
|This year's high monthly rain
|n/a
|n/a
|<#MonthLongestDryPeriodD>
|<#YearMonthlyRainHD>
|-
|-
|<#MonthLongestWetPeriod>
|<#YearLongestDryPeriod>
|Longest period of rain every day, ending this month (days)
|Longest period without rain ending this year (days)
|n/a
|n/a
|<#MonthLongestWetPeriodD>
|<#YearLongestDryPeriodD>
|-
|<#YearLongestWetPeriod>
|Longest period of rain every day ending this year (days)
|n/a
|<#YearLongestWetPeriodD>
|-
|-
|colspan="4" style="background:lightgray;"|Solar
|colspan="4" style="background:lightgray;"|Solar
Line 1,959: Line 2,024:
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|-
|-
| <#SunshineHoursMonth>
| <#SunshineHoursYear>
| the total sunshine hours in month-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' and '''m''' or '''r''']] for a past month
| the total sunshine hours in year-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' or '''r''']] for a past year
| n/a
| n/a
| n/a
| n/a
|}
|}


==Yearly==
==All Time==


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


The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.
The output from the web tags shown in the date/time column have the default format that is seen on "records.htm" in the standard web pages:
*The default format for an extreme month is to show the month name in full i.e. format 'MMMM' followed by the year in full.
*For an extreme day it shows the day of the month and the month name in full i.e. format "dd MMMM" (same for Cumulus 1 and Cumulus MX), prefixed with the word 'on' again ending with the year.  
*For the highest/lowest within a day in the year it shows both time and date adding the word "at" before the time, and the word 'on' before the date (i.e. on the standard web page the time comes first, not as seen in admin interface).


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.
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.
 
Remember that the Year-to-date runs from roll-over time on 1 January for all web tags listed here.
 
The list below does NOT include any web tags that represent seasonal derivatives, i.e. where you define the month from which they start counting. (Cumulative seasonal Chill Hours <#chillhours> and Total seasonal rainfall <#ryear> can both be found in [[Webtags#Current_Conditions|Current Conditions]]). Note, that does not imply both are included in '''indexT.htm'''.


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!


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px"|Web tag_name
!style="width:150px" | Web tag_name
!style="width:300px"|Function
!style="width:400px" | Function
!style="width:350px"|Time
!style="width:150px" | Date/Time
!style="width:150px"|Date
|-
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#YearTempH>
|<#tempH>
|This year's highest temperature
|All time high temperature
|<#YearTempHT>
|<#TtempH>
|<#YearTempHD>
|-
|-
|<#YearTempL>
|<#tempL>
|This year's lowest temperature
|All time low temperature  
|<#YearTempLT>
|<#TtempL>
|<#YearTempLD>
|-
|-
|<#YearHighDailyTempRange>
|<#mintempH>
|This year's highest Daily Temp Range
|All time high minimum temperature
|n/a
|<#TmintempH>
|<#YearHighDailyTempRangeD>
|-
|-
|<#YearLowDailyTempRange>
|<#maxtempL>
|This year's lowest Daily Temp Range
|All time low maximum temperature
|n/a
|<#TmaxtempL>
|<#YearLowDailyTempRangeD>
|-
|-
|<#YearHeatIndexH>
|<#LowDailyTempRange>
|This year's highest USA heat index
|All time low daily temperature range
|<#YearHeatIndexHT>
|<#TLowDailyTempRange>
|<#YearHeatIndexHD>
|-
|-
|<#YearWChillL>
|<#HighDailyTempRange>
|This year's greatest wind chill (i.e. lowest temperature)
|All time high daily temperature range
|<#YearWChillLT>
|<#THighDailyTempRange>
|<#YearWChillLD>
|-
|-
|<#YearAppTempH>
|<#apptempH>
|This year's highest apparent temperature
|All time high apparent temperature
|<#YearAppTempHT>
|<#TapptempH>
|<#YearAppTempHD>
|-
|-
|<#YearAppTempL>
|<#apptempL>
|This year's lowest apparent temperature
|All time low apparent temperature
|<#YearAppTempLT>
|<#TapptempL>
|<#YearAppTempLD>
|-
|-
|<#YearFeelsLikeH>
|<#feelslikeH>
|[[File:Badge vMx.png]]This year's highest feels like temperature (available from 3.6.0)   (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]All time high feels like temperature (available from 3.6.0)
|<#YearFeelsLikeHT>
|<#TfeelslikeH>
|<#YearFeelsLikeHD>
|-
|-
|<#YearFeelsLikeL>
|<#feelslikeL>
|[[File:Badge vMx.png]]This year's lowest feels like temperature (available from 3.6.0)   (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]All time low feels like temperature (available from 3.6.0)
|<#YearFeelsLikeLT>
|<#TfeelslikeL>
|<#YearFeelsLikeLD>
|-
|-
|<#YearHumidexH>
|<#humidexH>
|[[File:Badge vMx.png]] (Available from version 3.7.0)   (NOT AVAILABLE IN CUMULUS 1)
|[[File:Badge vMx.png]]All time high Canadian Humidity Index (available from 3.7.0)
 
|<#ThumidexH>
This year's highest Canadian Humidity Index
|<#YearHumidexHT>
|<#YearHumidexHD>
|-
|-
|<#YearDewPointH>
|<#heatindexH>
|This year's highest dew point
|All time high USA heat index
|<#YearDewPointHT>
|<#TheatindexH>
|<#YearDewPointHD>
|-
|-
|<#YearDewPointL>
|<#dewpointH>
|This year's lowest dew point
|All time high dew point
|<#YearDewPointLT>
|<#TdewpointH>
|<#YearDewPointLD>
|-
|-
|<#YearMinTempH>
|<#dewpointL>
|This year's highest daily minimum temperature
|All time low dew point
|Flavour specific mandatory output parameters:
|<#TdewpointL>
* <#YearMinTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMinTempHD format=HH:mm> ''for Cumulus MX''
|<#YearMinTempHD>
|-
|-
|<#YearMaxTempL>
|<#humH>
|This year's lowest daily maximum temperature
|All time high humidity
|Flavour specific mandatory output parameters:
|<#ThumH>
* <#YearMaxTempHD format=HH:nn> ''for Cumulus 1'',
* <#YearMaxTempHD format=HH:mm> ''for Cumulus MX''
 
|<#YearMaxTempLD>
|-
|-
|<#YearHumH>
|<#humL>
|This year's high humidity
|All time low humidity
|<#YearHumHT>
|<#ThumL>
|<#YearHumHD>
|-
|-
|<#YearHumL>
|<#wchillH>
|This year's low humidity
|All time greatest wind chill (i.e. lowest temperature, but highest wind speed)
|<#YearHumLT>
|<#TwchillH>
|<#YearHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#YearPressH>
|<#rrateM>
|This year's high pressure
|All time high rain rate
|<#YearPressHT>
|<#TrrateM>
|<#YearPressHD>
|-
|-
|<#YearPressL>
|<#rfallH>
|This year's low pressure
|All time high daily rain
|<#YearPressLT>
|<#TrfallH>
|<#YearPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|<#rfallhH>
|All time high hourly rain
|<#TrfallhH>
|-
|-
|<#YearGustH>
|<#rfallmH>
|This year's high wind gust
|All time high monthly rain
|<#YearGustHT>
|<#TrfallmH>
|<#YearGustHD>
|-
|-
|<#YearWindH>
|<#LongestDryPeriod>
|This year's high wind speed
|All time longest dry period (days)
|<#YearWindHT>
|<#TLongestDryPeriod>
|<#YearWindHD>
|-
|-
|<#YearWindRunH>
|<#LongestWetPeriod>
This year's highest Daily Wind Run
|All time longest wet period (days)
|n/a
|<#TLongestWetPeriod>
|<#YearWindRunHD>  
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Pressure
|-
|-
|<#YearRainRateH>
|<#pressH>
|This year's highest rainfall rate
|All time high pressure
|<#YearRainRateHT>
|<#TpressH>
|<#YearRainRateHD>
|-
|-
|<#YearHourlyRainH>
|<#pressL>
|This year's highest hourly rain
|All time low pressure
|<#YearHourlyRainHT>
|<#TpressL>
|<#YearHourlyRainHD>
|-
|-
|<#YearDailyRainH>
|colspan="3" style="background:lightgray;"|Wind
|This year's high daily rain
|n/a
|<#YearDailyRainHD>
|-
|-
|<#YearMonthlyRainH>
|<#gustM>
|This year's high monthly rain
|All time high wind gust
|n/a
|<#TgustM>
|<#YearMonthlyRainHD>
|-
|-
|<#YearLongestDryPeriod>
|<#wspeedH>
|Longest period without rain ending this year (days)
|All time high average wind speed
|n/a
|<#TwspeedH>
|<#YearLongestDryPeriodD>
|-
|-
|<#YearLongestWetPeriod>
|<#windrunH>
|Longest period of rain every day ending this year (days)
|All time high daily wind run
|n/a
|<#TwindrunH>
|<#YearLongestWetPeriodD>
|-
|colspan="4" style="background:lightgray;"|Solar
 
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|-
| <#SunshineHoursYear>
| the total sunshine hours in year-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' or '''r''']] for a past year
| n/a
| n/a
|}
|}


==All Time==
==Monthly==


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


The output from the web tags shown in the date/time column have the default format that is seen on "records.htm" in the standard web pages:
Because the rainfall this month does not appear on '''thismonthT.htm''' web page, it is shown in [[#Current_Conditions|indexT.htm]] table earlier in this article which is for the web page where it does appear.
*The 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.
The web tags in the date column output dates in the format "dd MMMM" (for once this is same for Cumulus 1 and Cumulus MX). Should you require a different output format, this can be changed using the [[#Time.2FDate_.27format.27_Parameter|format parameters]] described above. For web tags that represent daily values, there are (obviously) no corresponding time web tags, but for high and low spot values the default 'h:mm' format of the time output can be changed using output parameters. Do make sure that you get the web tag names right and the output form at parameters right.


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | Web tag_name
!style="width:150px"|Web tag_name
!style="width:400px" | Function
!style="width:300px"|Function
!style="width:150px" | Date/Time
!style="width:150px"|Time
!style="width:150px"|Date
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#tempH>
|<#MonthTempH>
|All time high temperature
|This months high temperature
|<#TtempH>
|<#MonthTempHT>
|<#MonthTempHD>
|-
|-
|<#tempL>
|<#MonthTempL>
|All time low temperature  
|This months low temperature
|<#TtempL>
|<#MonthTempLT>
|<#MonthTempLD>
|-
|-
|<#mintempH>
|<#MonthMinTempH>
|All time high minimum temperature  
|This months highest daily minimum temperature
|<#TmintempH>
|[[File:badge v1.png]]<#MonthMinTempHD format=hh:nn> or <#MonthMinTempHD format=HH:mm> for Cumulus 1, 
[[File:Badge vMx.png]] <#MonthMinTempHD format=HH:mm> for Cumulus MX
|<#MonthMinTempHD>
|-
|-
|<#maxtempL>
|<#MonthMaxTempL>
|All time low maximum temperature  
|This months lowest daily maximum temperature
|<#TmaxtempL>
|[[File:badge v1.png]]<#MonthMaxTempLD format=HH:mm> or <#MonthMaxTempLD format=hh:nn> for Cumulus 1,
[[File:Badge vMx.png]]<#MonthMaxTempLD format=HH:mm> for Cumulus MX
|<#MonthMaxTempLD>
|-
|-
|<#LowDailyTempRange>
|<#MonthHighDailyTempRange>
|All time low daily temperature range
|High Daily Temp Range
|<#TLowDailyTempRange>
|n/a
|<#MonthHighDailyTempRangeD>
|-
|-
|<#HighDailyTempRange>
|<#MonthLowDailyTempRange>
|All time high daily temperature range
|Low Daily Temp Range
|<#THighDailyTempRange>
|n/a
|<#MonthLowDailyTempRangeD>
|-
|-
|<#apptempH>
|<#MonthHeatIndexH>
|All time high apparent temperature
|This months high USA heat index
|<#TapptempH>
|<#MonthHeatIndexHT>
|<#MonthHeatIndexHD>
|-
|-
|<#apptempL>
|<#MonthWChillL>
|All time low apparent temperature
|This months greatest wind chill (i.e. lowest temperature)
|<#TapptempL>
|<#MonthWChillLT>
|<#MonthWChillLD>
|-
|-
|<#feelslikeH>
|<#MonthAppTempH>
|[[File:Badge vMx.png]]All time high feels like temperature (available from 3.6.0)
|This month's high apparent temperature
|<#TfeelslikeH>
|<#MonthAppTempHT>
|<#MonthAppTempHD>
|-
|-
|<#feelslikeL>
|<#MonthAppTempL>
|[[File:Badge vMx.png]]All time low feels like temperature (available from 3.6.0)
|This month's low apparent temperature
|<#TfeelslikeL>
|<#MonthAppTempLT>
|<#MonthAppTempLD>
|-
|-
|<#humidexH>
|<#MonthFeelsLikeH>
|[[File:Badge vMx.png]]All time high Canadian Humidity Index (available from 3.7.0)
|This month's highest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)   (NOT AVAILABLE IN CUMULUS 1)
|<#ThumidexH>
|<#MonthFeelsLikeHT>
|<#MonthFeelsLikeHD>
|-
|-
|<#heatindexH>
|<#MonthFeelsLikeL>
|All time high USA heat index
|This months lowest feels like temperature (available from [[File:Badge vMx.png]] 3.6.0)  (NOT AVAILABLE IN CUMULUS 1)
|<#TheatindexH>
|<#MonthFeelsLikeLT>
|<#MonthFeelsLikeLD>
|-
|-
|<#dewpointH>
|<#MonthHumidexH>
|All time high dew point
|[[File:Badge vMx.png]] (Available from version 3.7.0)    (NOT AVAILABLE IN CUMULUS 1)
|<#TdewpointH>
 
This month's highest Canadian Humidity Index
|<#MonthHumidexHT>
|<#MonthHumidexHD>
|-
|-
|<#dewpointL>
|<#MonthDewPointH>
|All time low dew point
|This month's high dew point
|<#TdewpointL>
|<#MonthDewPointHT>
|<#MonthDewPointHD>
|-
|-
|<#humH>
|<#MonthDewPointL>
|All time high humidity
|This month's low dew point
|<#ThumH>
|<#MonthDewPointLT>
|<#MonthDewPointLD>
|-
|-
|<#humL>
|<#MonthHumH>
|All time low humidity
|This month's highest humidity
|<#ThumL>
|<#MonthHumHT>
|<#MonthHumHD>
|-
|-
|<#wchillH>
|<#MonthHumL>
|All time greatest wind chill (i.e. lowest temperature, but highest wind speed)
|This month's lowest humidity
|<#TwchillH>
|<#MonthHumLT>
|<#MonthHumLD>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Pressure
|-
|-
|<#rrateM>
|<#MonthPressH>
|All time high rain rate
|This month's highest pressure
|<#TrrateM>
|<#MonthPressHT>
|<#MonthPressHD>
|-
|-
|<#rfallH>
|<#MonthPressL>
|All time high daily rain
|This month's lowest pressure
|<#TrfallH>
|<#MonthPressLT>
|<#MonthPressLD>
|-
|-
|<#rfallhH>
|colspan="4" style="background:lightgray;"|Wind
|All time high hourly rain
|<#TrfallhH>
|-
|-
|<#rfallmH>
|<#MonthGustH>
|All time high monthly rain
|This month's highest wind gust
|<#TrfallmH>
|<#MonthGustHT>
|<#MonthGustHD>
|-
|-
|<#LongestDryPeriod>
|<#MonthWindH>
|All time longest dry period (days)
|This month's highest wind speed
|<#TLongestDryPeriod>
|<#MonthWindHT>
|<#MonthWindHD>
|-
|-
|<#LongestWetPeriod>
|<#MonthWindRunH>
|All time longest wet period (days)
|This month's high Daily Wind Run
|<#TLongestWetPeriod>
|n/a
|<#MonthWindRunHD>  
|-
|colspan="4" style="background:lightgray;"|Rainfall
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|<#MonthRainRateH>
|This month's highest rainfall rate
|<#MonthRainRateHT>
|<#MonthRainRateHD>
|-
|-
|<#pressH>
|<#MonthHourlyRainH>
|All time high pressure
|This month's highest hourly rain
|<#TpressH>
|<#MonthHourlyRainHT>
|<#MonthHourlyRainHD>
|-
|-
|<#pressL>
|<#MonthDailyRainH>
|All time low pressure
|This month's wettest day (greatest daily rain)
|<#TpressL>
|n/a
|<#MonthDailyRainHD>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|<#MonthLongestDryPeriod>
|Longest dry period ending this month (days)
|n/a
|<#MonthLongestDryPeriodD>
|-
|-
|<#gustM>
|<#MonthLongestWetPeriod>
|All time high wind gust
|Longest period of rain every day, ending this month (days)
|<#TgustM>
|n/a
|<#MonthLongestWetPeriodD>
|-
|-
|<#wspeedH>
|colspan="4" style="background:lightgray;"|Solar
|All time high average wind speed
 
|<#TwspeedH>
[[File:Badge vMx.png]] (Available from release 3.12.0 onwards)
|-
|-
|<#windrunH>
| <#SunshineHoursMonth>
|All time high daily wind run
| the total sunshine hours in month-to-date, or with [[Webtags/Parameters#Input_modification_Parameters|input modification parameters using either '''y''' and '''m''' or '''r''']] for a past month
|<#TwindrunH>
| n/a
| n/a
|}
|}


==Monthly All Time Records==
==Monthly All Time Records==
Line 2,294: Line 2,349:
This table includes web tags that show the values in [[Monthlyalltime.ini]] log file, which was introduced in version 1.9.3 (build 1033, 10 Apr 2012).
This table includes web tags that show the values in [[Monthlyalltime.ini]] log file, which was introduced in version 1.9.3 (build 1033, 10 Apr 2012).


These are a set of tags for monthly all-time highs and lows, in other words the highest and lowest values for a particular month of the year.  To supply both optional input modification, and optional output modification parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. In that example, the highest ever temperature in July is returned in the value after processing by Cumulus.
These are a set of tags for monthly all-time highs and lows, in other words the highest and lowest values for a particular month of the year.   
# The tag names listed here require a [[Webtags/Parameters#Input_modification_Parameters|input modification parameter]].
# The tag names here can optionally take any [[Webtags/Parameters#Output_modification_parameters|output modification parameters]].
# To supply both optional input modification, and optional output modification parameters, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>. In that example, the time (not date) of highest ever temperature in July is returned after processing by Cumulus.


For full details of the input modification parameters, see [[Webtags/Parameters#Input_modification_Parameters|Parameters]] page.
At release 3.6.10 (build 3086), and at release 3.7.0 (build 3089); additional tag names were introduced:
 
* They are marked with a "MX" icon as they are not available in legacy Cumulus 1.  
Additional tags correctly populated from 3.6.10 (build 3086) or 3.7.0 (build 3089) are marked with a "MX" icon as they are not available in Cumulus 1. Please note the 3.6.10 release was available from 24 June 2020, if the date/time shown for those MX only tags is before when you installed that (or a later release), the feels like output may show incorrect values.
* If you have any "feels like temperatures" that appear with a date/time parameter with a date before 24 June 2020, or before you installed the 3.6.10 release (or a later release), then the value web tag may show incorrect values.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,626: Line 2,684:
|<#newrecord>  
|<#newrecord>  
|Indicates when any tracked extreme is changed.
|Indicates when any tracked extreme is changed.
*{{Version badge 1}}In Cumulus 1.x.x:
* [[File:Badge vMx.png]]In Cumulus MX: 1 from when new record is set until
** either all records have cleared
** or until next rollover is completed,
** or (in recent releases) until the number of hours for clearing extreme record notifications has passed
* 0 otherwise
* [[File:Badge v1.png]]In Cumulus 1.x.x:
** 1 if 'new record' light is flashing,  
** 1 if 'new record' light is flashing,  
**0 if not
** 0 if not
*[[File:Badge vMx.png]]In Cumulus MX: 1 from when new record is set until
** either all records have cleared
**or until next rollover is completed,
*0 otherwise
|-
|-
|<#TempRecordSet>
|<#TempRecordSet>
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/9524...9835"

Navigation menu