Full list of Webtags: Difference between revisions

This list only contains the tag names. Tag names are the basic entity when asking a value. Check the [[Webtags#Using_Webtags|Usage of webtags]] and don't forget tag names are only part of the [[Webtags#General Format for Web Tags]]. 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. If you find such occurrence you may notify or modify.  

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. CumulusMX makes current values available for a standard range of sensors where the same web tags apply across a range of weather station models. Current values from some [[#Extra Sensors|extra]] temperature and relative humidity sensors (see [[Extra temperatures]]) from particular weather station models are offered as well.

The tags in this first list are grouped for historical reasons and remain grouped.

|}

The extra sensors functionality in Cumulus only supports processing for current spot values as read from the sensors. Periodically spot extra sensor values are logged, see the [[Extra_Sensor_Files|Extra Sensor Files]] page for information about log files from where you can extract the past spot values. The logging can be compared to the Standard Logfiles.

These web tags hold current values for additional sensors supported by CumulusMX. For Oregon Scientific model like WMR-200 with USB connection, please refer to [[#Web tags mentioning (outside) temperature]] because any of the extra temperature tags below can be redirected to '''<#temp>''', and consequently also have web tags reporting daily extremes and longer period extreme records.

|}

Available from version 3.9.0. You can configure two Airlink devices which have fixed identification as Indoor and Outdoor. There are a similar set of tags for each device.

|}

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 this Wiki. See also [https://www.wxforum.net/index.php?board=111.0 WXForum.net].

Available from release 3.9.5.

'''Note''': This temperature 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. This correction is responsibility of the user and is subject to a lot of discussion. 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.  

Cumulus MX can support the Ecowitt WN34 (other model types exist and are reported here as if WN34) soil and water temperature sensors. They are reported as "User Temperature 1" to "User Temperature 8".

|}

Below are described the tags resulting from ''Ecowitt Air quality (WH41,WH43,WH45)'', Ecowitt leak sensor (WH55), lighting detector (WH57), and extra temperature sensors (WN34)

|}

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.  

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

|}

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

|}

{| class="wikitable" border="1"

|}

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)

|}

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

|}

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.

|}

Apply to Cumulus 1 and MX, no optional input nor output parameters.

|}

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

{| class="wikitable" border="1"

|}

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

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

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

|}

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.  

|}

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

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

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

From '''release 3.5.4''' build 3075, most web tags (one notable exception is indoor temperature <#intemp> where rc parameter not available until release 3.6.8 build 3084), that produce decimal number output now support the "'''rc=y'''" option. e.g. <tt><#tempYH rc=y></tt> will report yesterday's highest temperature using a full stop to separate decimal part where the locale would normally use a comma.

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

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

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

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

<#RCRecentOutsideTemp>, <#RCRecentWindSpeed>, <#RCRecentWindGust>, <#RCRecentWindLatest>, <#RCRecentWindChill>, <#RCRecentDewPoint>, <#RCRecentHeatIndex>, <#RCRecentPressure>, <#RCRecentRainToday>, <#RCRecentUV>

There are other derivatives that can be calculated similarly from a set of simultaneous values, as described below the recent history section.

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!

|}

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.

|}

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

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

|}

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

// Change the English words 'days, ', ' hours, ', and 'minutes' to the equivalents in your language</pre>

[[File:badge v1.png]]There are a set of tags available in Cumulus 1 for various alarm states. In Cumulus 1, the main page will change the colour of the relevant element when an alarm condition is entered or left. You can add sounds, and enable disable each alarm parameter on the Main Cumulus screen, Edit menu.

|}

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

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

*'''NN''' can be set to any reasonable integer representing hours (for the default set the number '''NN''' to '24').

{| class="wikitable" border="1"

|}

'''Please be aware that the tags available are not the same in all versions.  

|}

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

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