Cumulus Wiki

Webtags (preserving history): Difference between revisions

Webtags (preserving history) (view source)

Revision as of 19:36, 11 June 2021

685 bytes added ,  19:36, 11 June 2021
m
Resequence
(new section)
m (Resequence)
Line 895: Line 895:
|}
|}


==Extra Sensors Air Quality==
 
 
 
==Extra Sensors Ecowitt==


{{Version badge 1}} Not available in Cumulus 1.
{{Version badge 1}} Not available in Cumulus 1.


[[File:Badge vMx.png]] Unless otherwise indicated these web tags become available from release 3.9.5.
[[File:Badge vMx.png]] Please see release announcements for when individual web tags become available.


<big>THE INFORMATION HERE IS TAKEN FROM RELEASE ANNOUNCEMENTS THAT DO NOT EXPLAIN WHAT THESE WEB TAGS REPORT
This section applies only to those using Ecowitt GW1000 (Froggit DS1500) an interface unit that picks up various external sensors and sends the data via an application programming interface to MX which then generates the following web tags:
 
PLEASE WOULD SOMEBODY WHO UNDERSTANDS THIS TERMINOLOGY UPDATE THE FOLLOWING TABLE</big>


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 910: Line 911:
!style="width:600px" |Function
!style="width:600px" |Function
|-
|-
| <#CO2-pm2p5>
|<#GW1000FirmwareVersion>
| Air Quality expressed in terms of particulate matter of 2.5 micrometres or less
|{{Version badge 1}} Not available in Cumulus 1.
|-
 
| <#CO2-pm2p5-24h>
[[File:Badge vMx.png]]GW1000 firmware version string
| Air Quality expressed in terms of particulate matter of 2.5 μm, or less, as a 24 hour average/total
|}
 


WILL SOMEBODY WHO KNOWS UPDATE THIS ENTRY AND OTHERS
{| class="wikitable" border="1"
|-
|-
| <#CO2-pm10>
!style="width:150px"|Web tag_name
| Air Quality expressed in terms of particulate matter of 10 μm, or less
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in the viewer/editor
|-
|-
| <#CO2-pm10-24h>
|<#AirQuality1>
| Air Quality expressed in terms of particulate matter of 10 μm, or less, as a 24 hour average/total
|{{Version badge 1}} Not available in Cumulus 1.
 
 
WILL SOMEBODY WHO KNOWS UPDATE THIS ENTRY AND OTHERS
[[File:Badge vMx.png]] see release announcements for version availability
 
Air quality 1
|-
|-
| <#CO2-temp>
|colspan="2"|... and so on up to <#AirQuality4>
| Temperature as reported by Air Quality monitor
|-
|-
| <#CO2-hum>
|<#LeakSensor1>
| Relative Humidity as reported by Air Quality monitor
|}


|{{Version badge 1}} Not available in Cumulus 1.


[[File:Badge vMx.png]] see release announcements for version availability


Leak sensor - 0 or 1
|-
|colspan="2"|... and so on up to <#LeakSensor4>
|-
|<#LightningDistance>


|{{Version badge 1}} Not available in Cumulus 1.


[[File:Badge vMx.png]] see release announcements for version availability


Distance to last strike (same units as wind run - miles/km/nm) (Returns 0.0 if you don't have a sensor, GW1000 api returns max value you can put in a byte - 0xFF which translates to 158.4 miles = 255 km if have sensor but no strike detected yet, so MX translates that to '----')
|-
|<#LightningTime>


==Extra Sensors Ecowitt==
|{{Version badge 1}} Not available in Cumulus 1.


{{Version badge 1}} Not available in Cumulus 1.
[[File:Badge vMx.png]] see release announcements for version availability


[[File:Badge vMx.png]] Please see release announcements for when individual web tags become available.
Date and Time of last strike (default without output parameters is locale's short time format e.g. 18:02 or 6:02 pm, without date, but tag accepts both date and time output parameters). Returns '----' if you don't have sensor or there has not been a strike since the sensor was installed. (GW1000 api returns FFFF FFFF seconds after midnight on 01 Jan 1970, which translates to 07/02/2106 06:28:15, so MX translates that to '----')
 
This section applies only to those using Ecowitt GW1000 (Froggit DS1500) an interface unit that picks up various external sensors and sends the data via an application programming interface to MX which then generates the following web tags:
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |Web tag_name
|<#LightningStrikesToday>
!style="width:600px" |Function
|-
|<#GW1000FirmwareVersion>
|{{Version badge 1}} Not available in Cumulus 1.


[[File:Badge vMx.png]]GW1000 firmware version string
|}
{| class="wikitable" border="1"
|-
!style="width:150px"|Web tag_name
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in the viewer/editor
|-
|<#AirQuality1>
|{{Version badge 1}} Not available in Cumulus 1.
|{{Version badge 1}} Not available in Cumulus 1.


[[File:Badge vMx.png]] see release announcements for version availability
[[File:Badge vMx.png]] see release announcements for version availability


Air quality 1
Number of strikes since midnight, default 0
|-
|-
|colspan="2"|... and so on up to <#AirQuality4>
|<#UserTemp1>  
|-
|<#LeakSensor1>


|{{Version badge 1}} Not available in Cumulus 1.
|{{Version badge 1}} Not available in Cumulus 1.
Line 979: Line 972:
[[File:Badge vMx.png]] see release announcements for version availability
[[File:Badge vMx.png]] see release announcements for version availability


Leak sensor - 0 or 1  
User Temperature 1
support for the Ecowitt WH34 (other model types exist and are reported here as if WH34) soil and water temperature sensors
|-
|-
|colspan="2"|... and so on up to <#LeakSensor4>
|colspan="2"|... and so on up to <#UserTemp8> = User temperature 8
|-
|}
|<#LightningDistance>


|{{Version badge 1}} Not available in Cumulus 1.


[[File:Badge vMx.png]] see release announcements for version availability
Ecowitt stations are sold under other names depending on nation,  e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in same way as Fine Offset is used elsewhere in this article.


Distance to last strike (same units as wind run - miles/km/nm) (Returns 0.0 if you don't have a sensor, GW1000 api returns max value you can put in a byte - 0xFF which translates to 158.4 miles = 255 km if have sensor but no strike detected yet, so MX translates that to '----')
==Recent History==
|-
|<#LightningTime>


|{{Version badge 1}} Not available in Cumulus 1.
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. 
*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


[[File:Badge vMx.png]] see release announcements for version availability
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.


Date and Time of last strike (default without output parameters is locale's short time format e.g. 18:02 or 6:02 pm, without date, but tag accepts both date and time output parameters). Returns '----' if you don't have sensor or there has not been a strike since the sensor was installed. (GW1000 api returns FFFF FFFF seconds after midnight on 01 Jan 1970, which translates to 07/02/2106 06:28:15, so MX translates that to '----')
|-
|<#LightningStrikesToday>


|{{Version badge 1}} Not available in Cumulus 1.
===Warning when Daylight Saving Time starts or ends===


[[File:Badge vMx.png]] see release announcements for version availability
Note that Cumulus uses current time, read from the computer, to determine which array element it stores each value in.  


Number of strikes since midnight, default 0
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.
|-
|<#UserTemp1>


|{{Version badge 1}} Not available in Cumulus 1.
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.


[[File:Badge vMx.png]] see release announcements for version availability
=== Table of Recent History web tags available ===


User Temperature 1
support for the Ecowitt WH34 (other model types exist and are reported here as if WH34) soil and water temperature sensors
|-
|colspan="2"|... and so on up to <#UserTemp8> = User temperature 8
|}


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


Ecowitt stations are sold under other names depending on nation,  e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in same way as Fine Offset is used elsewhere in this article.
{| class="wikitable" border="1"
 
|-
==Recent History==
!style="width:150px" | Web tag_name
 
!style="width:600px" | Function  
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. 
!style="width:600px" | Parameters example
*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.
|colspan="3" style="background:lightgray;"|Time-stamp tag
**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.
 
 
===Warning when Daylight Saving Time starts or ends===
 
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.
 
{| class="wikitable" border="1"
|-
!style="width:150px" | Web tag_name
!style="width:600px" | Function  
!style="width:600px" | Parameters example
|-
|colspan="3" style="background:lightgray;"|Time-stamp tag
|-
|-
|<#RecentTS>
|<#RecentTS>
Line 2,674: Line 2,633:
|-
|-
|<#AirLinkPm1[InǀOut]>
|<#AirLinkPm1[InǀOut]>
|Current PM 1.0 count
|Current particulate matter of 1 μm, or less count
|-
|-
|<#AirLinkPm2p5[InǀOut]>
|<#AirLinkPm2p5[InǀOut]>
|Current PM 2.5 count
|Currentparticulate matter of 2.5 μm, or less, count
|-
|-
|<#AirLinkPm2p5_1hr[InǀOut]>
|<#AirLinkPm2p5_1hr[InǀOut]>
|Last hour average PM 2.5 count
|Last hour average particulate matter of 2.5 μm, or less, count
|-
|-
|<#AirLinkPm2p5_3hr[InǀOut]>
|<#AirLinkPm2p5_3hr[InǀOut]>
|Last 3 hours average PM 2.5 count
|Last 3 hours average particulate matter of 2.5 μm, or less, count
|-
|-
|<#AirLinkPm2p5_24hr[InǀOut]>
|<#AirLinkPm2p5_24hr[InǀOut]>
|Last 24 hours average PM 2.5 count
|Last 24 hours average particulate matter of 2.5 μm, or less, count
|-
|-
|<#AirLinkPm2p5_Nowcast[InǀOut]>
|<#AirLinkPm2p5_Nowcast[InǀOut]>
|The 24 hour "nowcast" weighted average PM 2.5 count
|The 24 hour "nowcast" weighted average particulate matter of 2.5 μm, or less, count
|-
|-
|<#AirLinkPm10[InǀOut]>
|<#AirLinkPm10[InǀOut]>
|Current PM 10 count
|Current particulate matter of 10 μm, or less, count
|-
|-
|<#AirLinkPm10_1hr[InǀOut]>
|<#AirLinkPm10_1hr[InǀOut]>
|Last hour average PM 10 count
|Last hour average particulate matter of 10 μm, or less, count
|-
|-
|<#AirLinkPm10_3hr[InǀOut]>
|<#AirLinkPm10_3hr[InǀOut]>
|Last 3 hours average PM 10 count
|Last 3 hours average particulate matter of 10 μm, or less, count
|-
|-
|<#AirLinkPm10_24hr[InǀOut]>
|<#AirLinkPm10_24hr[InǀOut]>
|Last 24 hours average PM 10 count
|Last 24 hours average particulate matter of 10 μm, or less, count
|-
|-
|<#AirLinkPm10_Nowcast[InǀOut]>
|<#AirLinkPm10_Nowcast[InǀOut]>
|The 24 hour "nowcast" weighted average PM 10 count
|The 24 hour "nowcast" weighted average particulate matter of 10 μm, or less, count
|-
|-
|colspan="2" style="background:lightgray;"|AQI Values
|colspan="2" style="background:lightgray;"|Air Quality Index Values
|-
|-
|<#AirLinkAqiPm2p5[InǀOut]>
|<#AirLinkAqiPm2p5[InǀOut]>
|Current PM 2.5 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Current particulate matter of 2.5 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm2p5_1hr[InǀOut]>
|<#AirLinkAqiPm2p5_1hr[InǀOut]>
|Last hour average PM 2.5 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm2p5_3hr[InǀOut]>
|<#AirLinkAqiPm2p5_3hr[InǀOut]>
|Last 3 hour average PM 2.5 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last 3 hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm2p5_24hr[InǀOut]>
|<#AirLinkAqiPm2p5_24hr[InǀOut]>
|Last 24 hour average PM 2.5 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last 24 hour average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm2p5_Nowcast[InǀOut]>
|<#AirLinkAqiPm2p5_Nowcast[InǀOut]>
|Last 24 hour "nowcast" weighted average PM 2.5 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last 24 hour "nowcast" weighted average particulate matter of 2.5 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm210[InǀOut]>
|<#AirLinkAqiPm210[InǀOut]>
|Current PM 10 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Current particulate matter of 10 μm, or less value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm10_1hr[InǀOut]>
|<#AirLinkAqiPm10_1hr[InǀOut]>
|Last hour average PM 10 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last hour average particulate matter of 10 μm, or less, AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm10_3hr[InǀOut]>
|<#AirLinkAqiPm10_3hr[InǀOut]>
|Last 3 hour average PM 10 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last 3 hour average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm10_24hr[InǀOut]>
|<#AirLinkAqiPm10_24hr[InǀOut]>
|Last 24 hour average PM 10 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last 24 hour average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|<#AirLinkAqiPm10_Nowcast[InǀOut]>
|<#AirLinkAqiPm10_Nowcast[InǀOut]>
|Last 24 hour "nowcast" weighted average PM 10 AQI value - allows use of the "dp=n" and "tc=y" parameters
|Last 24 hour "nowcast" weighted average particulate matter of 10 μm, or less AQI value - allows use of the "dp=n" and "tc=y" parameters
|-
|-
|colspan="2" style="background:lightgray;"|Stats Values
|colspan="2" style="background:lightgray;"|Stats Values
Line 2,768: Line 2,727:
NOTE: This web tag requires a WeatherLink Pro subscription to work
NOTE: This web tag requires a WeatherLink Pro subscription to work
|}
|}
==Extra Sensors Air Quality==
{{Version badge 1}} Not available in Cumulus 1.
[[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"
|-
!style="width:150px" |Web tag_name
!style="width:600px" |Function
|-
| <#CO2-pm2p5>
| Air Quality expressed in terms of particulate matter of 2.5 micrometres or less
|-
| <#CO2-pm2p5-24h>
| Air Quality expressed in terms of particulate matter of 2.5 μm, or less, Last 24 hours average
WILL SOMEBODY WHO KNOWS UPDATE THIS ENTRY AND OTHERS
|-
| <#CO2-pm10>
| Air Quality expressed in terms of particulate matter of 10 μm, or less
|-
| <#CO2-pm10-24h>
| Air Quality expressed in terms of particulate matter of 10 μm, or less, Last 24 hours average
WILL SOMEBODY WHO KNOWS UPDATE THIS ENTRY AND OTHERS
|-
| <#CO2-temp>
| Temperature as reported by Air Quality monitor
|-
| <#CO2-hum>
| Relative Humidity as reported by Air Quality monitor
|}




Sfws
5,838

edits

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