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

2,510 bytes added ,  10:13, 4 September 2021
m
no edit summary
mNo edit summary
(7 intermediate revisions by 2 users not shown)
Line 18: Line 18:


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>=Essential Background Reading=
</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.
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.
Line 141: Line 143:


For just a taste, there you can discover:
For just a taste, there you can discover:
* A score of [[Webtags/Parameters#Input_modification_Parameters|input modification parameters
* A score of [[Webtags/Parameters#Input_modification_Parameters|input modification parameters]]
** For  example, find which attribute is used with a value between 1 and 12, so the same tag name can give values for 12 different months)
** For  example, find which attribute is used with a value between 1 and 12, so the same tag name can give values for 12 different months)
* If your locale normally (in real numbers) uses an integer part, then a comma, and then the decimal part, you should be aware that some computer scripts, and some external servers where you might want to send data, insist on a decimal point, instead of a decimal comma:
* If 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:
Line 147: Line 149:
** 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.
** 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
* 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 [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates|here]]
* 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? ==
Line 767: Line 769:


[[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 776: 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 830: Line 829:
|-
|-
|<#AirQuality1>
|<#AirQuality1>
| Air quality index (24 hour) 1
| Air quality in μm/m<small>3</small> or less
|-
|-
|<#AirQuality2>
|<#AirQuality2>
| Air quality index (24 hour) 2
| 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>
Line 866: Line 873:
===Using input/output modification parameters with recent history tag names===
===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. All, except the first tag name listed, can take optional
'''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"
{| class="wikitable" border="1"
|-
|-
!style="width:15px" | Tag names
!style="width:150px" | Tag names
!style="width:200px" | Mandatory Input Modification Parameters
!style="width:200px" | Mandatory Input Modification Parameters
!style="width:200px" | Optional Output Modification Parameters
!style="width:200px" | Optional Output Modification Parameters
|-
|-
| <#RecentTS>
| <#RecentTS> (see [[#Table of Recent History tag names available]]
| Please see table at [[Webtags/Parameters#Input_modification_Parameters]]
| Mandatory parameters as table at [[Webtags/Parameters#Input_modification_Parameters]]
| Please see tables starting at [[Webtags/Parameters#Multiple_Output_Format_Modifier_parameters_for_times_and_dates]]
| 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 next table
| All other tag names in [[#Available in 1.9.3, 1.9.4, and all MX releases]] and [[#Available in MX only]]
| Please see table at [[Webtags/Parameters#Input_modification_Parameters]]
| Mandatory parameters as table at [[Webtags/Parameters#Input_modification_Parameters]]
| Depends on release you are using:
| Whether you can modify the way these values are output depends on release you are using:
* From release 3.10.5: Please see table at [[Webtags/Parameters#Output_Modification_Parameter_for_changing_any_decimal_comma_into_a_decimal_point]] and [[Webtags/Parameters#Two_Output_.28format_modifier.29_parameters_for_decimal_places]]
* 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.
* For legacy Cumulus, and earlier MX releases, no output format modification parameters are available, instead see [[#No_Commas]] section on this page.
|}
|}
Line 886: Line 895:
=== Table of Recent History tag names available ===
=== Table of Recent History tag names available ===


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


Although as [[Recent history]] page explains, the history is intended to cover every minute in last 7 days, some entries may be at less frequent intervals, and when clocks change some entries will be missing altogether.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 898: 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 906: 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>
| [[File:Badge v1.png]] 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>
| [[File:Badge v1.png|File]] 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 937: 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 950: 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 982: Line 986:
|UV Index  
|UV Index  
| d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
| d=n (where n runs 0 to 6) days ago; h=n (where n is any number of hours ago); m=n (where n is any number of minutes ago)
|}
====Available in MX only====
Please note this section has NOT yet been updated for recent MX releases, it appears from [[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
|}
|}


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

Navigation menu