Cumulus Wiki

Webtags (preserving history): Difference between revisions

Webtags (preserving history) (view source)

Revision as of 15:25, 29 April 2022

73 bytes removed ,  15:25, 29 April 2022
m
Note added in "Web tags mentioning (outside) temperature"
m (Note added in "Web tags mentioning (outside) temperature")
Line 55: Line 55:


If you are using your own web templates, or other [[Customised templates|own Cumulus template files]] such as [[Php_webtags|XML or PHP data files]], then you make the decision on which tag names are used for the data to your web server.
If you are using your own web templates, or other [[Customised templates|own Cumulus template files]] such as [[Php_webtags|XML or PHP data files]], then you make the decision on which tag names are used for the data to your web server.
====Getting release 3.12.0 or later to list tag names when it starts====
Please use the admin interface.
Go to '''Program settings → General options'''
Tick ''List web tags''.
The next time that MX is restarted,  it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.
Go to '''Program settings → General options''', untick ''List web tags'' to stop Cumulus continuing to produce new versions of that file next time it is restarted.


====Getting legacy Cumulus, or MX releases up to 3.11.4, to list tag names when starting====
====Getting legacy Cumulus, or MX releases up to 3.11.4, to list tag names when starting====
Line 69: Line 83:


[[File:Badge vMx.png]] MX bug: The inclusion of a web tag in the list produced by this instruction, does not mean that web tag is actually populated with valid information. See https://cumulus.hosiene.co.uk/viewtopic.php?p=153096#p153096 for an example.
[[File:Badge vMx.png]] MX bug: The inclusion of a web tag in the list produced by this instruction, does not mean that web tag is actually populated with valid information. See https://cumulus.hosiene.co.uk/viewtopic.php?p=153096#p153096 for an example.
====Getting release 3.12.0 or later to list tag names when it starts====
Please use the admin interface.
Go to '''Program settings → General options'''
Tick ''List web tags''.
The next time that MX is restarted,  it will create a file called WebTags.txt in the same folder as where the executable is found. That file will list all the tags your build of Cumulus can currently generate. This list only contains the tag_names, it does not indicate what parameters they can take, nor does it include the brackets the tag name is surrounded by when you quote it in a template file for Cumulus to process.
Go to '''Program settings → General options''', untick ''List web tags'' to stop Cumulus continuing to produce new versions of that file next time it is restarted.


==What is a web tag? ==
==What is a web tag? ==
Line 120: Line 121:
=====Inconsistency in use of "Y"=====
=====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.
The character "Y" has been selected to denote yesterday in tag names.  The inconsistency is where it appears.   


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


The legacy tag names for this year and this month were all introduced together by Steve in one release, with consistency in how they were named then, "Month" or "Year" was used as a prefix (this was after he had started using "Y" as a prefix for his new yesterday tag names) e.g. <#YearLongestDryPeriod>.
The 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>, instead of following Steve by using a prefix.
The development of MX however, broke this consistency, as Mark adds "Year" as a suffix, e.g. <#SunshineHoursYear>, instead of following Steve by using a prefix.


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


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




Line 174: Line 174:


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


==Input Modification Parameters and Output Modification Parameters==
==Input Modification Parameters and Output Modification Parameters==
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/10359"