Full list of Webtags: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Full list of Webtags (view source)

Revision as of 13:08, 27 February 2024

3,460 bytes added ,  27 February
m
→‎Statistics
m (→‎Yesterday: added <#tempMidnightYH>, <#TtempMidnightYH>, <#tempMidnightYL>, <#TtempMidnightYL> from 3.18.0 - b3190 update, <#tempMidnightRangeY> from 3.19.1 - b3194 update)
(37 intermediate revisions by 2 users not shown)
Line 2: Line 2:
   |__TOC__
   |__TOC__
   |}
   |}
This page has been updated until CMX version 3.27.1
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|general format for Webtags]]. 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.
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|general format for Webtags]]. 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.


Line 31: Line 33:
|<#temptrend>
|<#temptrend>
|The average rate of change in temperature over the last three hours. Trend = (temp now - temp 3hrs ago) / 3 (the calculation selected for this trend matches the standard-based calculation for <#presstrendval> despite the naming inconsistency)
|The average rate of change in temperature over the last three hours. Trend = (temp now - temp 3hrs ago) / 3 (the calculation selected for this trend matches the standard-based calculation for <#presstrendval> despite the naming inconsistency)
|-
|<#temptrendsigned>
|signed string value of temperature trend
|-
|-
|<#temptrendtext>
|<#temptrendtext>
Line 85: Line 90:
|-
|-
|<#r24hourH>
|<#r24hourH>
|The rainfall in the last 24 hours
|All time high total rainfall in a 24-hour period
|-
|-
|<#Tr24hourH>
|<#Tr24hourH>
Line 127: Line 132:
|<#presstrendval>
|<#presstrendval>
|The average rate of pressure change over the last three hours.  Trend = (pressure now - pressure 3hrs ago) / 3  
|The average rate of pressure change over the last three hours.  Trend = (pressure now - pressure 3hrs ago) / 3  
|-
|<#presstrendsigned>
|signed string value of pressure trends
|-
|-
|<#presstrend>
|<#presstrend>
Line 139: Line 147:
|<#altimeterpressure>
|<#altimeterpressure>
|Altimeter pressure. Pressure corrected to sea level using the station's altitude only. Same as sea-level pressure for non-Davis stations.
|Altimeter pressure. Pressure corrected to sea level using the station's altitude only. Same as sea-level pressure for non-Davis stations.
|-
|<#stationpressure>
|station pressure (the absolute pressure reading)
|-
|-
|colspan="2" style="background:lightgray;"|Wind
|colspan="2" style="background:lightgray;"|Wind
Line 286: Line 297:
|Extra dew point channel 1 - 10
|Extra dew point channel 1 - 10
|-
|-
|<#ExtraHum1 - 8>
|<#ExtraHum1 - 10>
|Extra humidity channel 1 - 10
|Extra humidity channel 1 - 10
|-
|-
Line 414: Line 425:
==== WH45 CO₂ sensor ====
==== WH45 CO₂ sensor ====


Available from release 3.9.5.
Available from release 3.9.5. From 3.27.0 the webtags as below are valid. The previous webtags with the minus sign i.s.o. underscores are deprecated.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 422: Line 433:
|-
|-
| <#CO2>
| <#CO2>
| The actual CO<sub>2</sub>concentration in ppm
| The actual CO<sub>2</sub> concentration in ppm
|-
|-
| <#CO2-pm2p5>
| <#CO2_24h>
| The CO<sub>2</sub> concentration in ppm as a moving average over 24 hours
|-
| <#CO2_pm2p5>
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<sup>3</sup> or less
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<sup>3</sup> or less
|-
|-
| <#CO2-pm2p5-24h>
| <#CO2_pm2p5_24h>
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<sup>3</sup>, or less, 24 hours moving average
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<sup>3</sup>, or less, 24 hours moving average
|-
|-
| <#CO2-pm10>
| <#CO2_pm10>
| Air Quality expressed in terms of particulate matter of 10 μm/m<sup>3</sup>, or less (includes the 2.5 figure)
| Air Quality expressed in terms of particulate matter of 10 μm/m<sup>3</sup>, or less (includes the 2.5 figure)
|-
|-
| <#CO2-pm10-24h>
| <#CO2_pm10_24h>
| Air Quality expressed in terms of particulate matter of 10 μm/m<sup>3</sup>, or less, 24 hours moving average  
| Air Quality expressed in terms of particulate matter of 10 μm/m<sup>3</sup>, or less, 24 hours moving average  
|-
|-
| <#CO2-temp><sup>See note</sup>
| <#CO2_temp><sup>See note</sup>
| Temperature as reported by Air Quality monitor.  
| Temperature as reported by Air Quality monitor.  
|-
|-
| <#CO2-hum>
| <#CO2_hum>
| Relative Humidity as reported by Air Quality monitor
| Relative Humidity as reported by Air Quality monitor
|}
|}


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


==== WN34 soil and water sensor ====
==== WN34 soil and water sensor ====
Line 461: Line 475:
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)
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)


This sub-section applies only to those using Ecowitt GW1000 (also Froggit DS1500, and other equivalents, see [[Supported Devices]]) an interface unit that picks up various external sensors and sends the data via an application programming interface to CumulusMX which then generates the following web tags:
This sub-section applies only to those using Ecowitt GW1000 and possibly other devices (also Froggit DS1500, and other equivalents, see [[Supported Devices]]) an interface unit that picks up various external sensors and sends the data via an application programming interface to CumulusMX which then generates the following web tags:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 470: Line 484:
|<#GW1000FirmwareVersion>
|<#GW1000FirmwareVersion>
|GW1000 firmware version string
|GW1000 firmware version string
|-
|<#EcowittFirmwareVersion>
|Ecowitt firmware version string
|-
|<#EcowittReception>
|Reception signal strength for the Ecowitt devices in use
|-
|<#EcowittCameraUrl>
|The URL for the HTTPS GET command to get the camera picture and timelapse
|-
|}
|}


Line 570: Line 594:
|Dew Point
|Dew Point
| <#RecentDewPoint h=25> reports the dew point temperature just over a day ago
| <#RecentDewPoint h=25> reports the dew point temperature just over a day ago
|-
|<#RecentApparent>
|Apparent
| <#RecentApparent m30> reports the dew point temperature half an hour ago
|-
|-
|<#RecentHeatIndex>
|<#RecentHeatIndex>
Line 627: Line 655:
|colspan="3" style="background:lightgray;"|Indoor Temperature & Humidity tags
|colspan="3" style="background:lightgray;"|Indoor Temperature & Humidity tags
|-
|-
|colspan="3" | (to do)
|<#RecentIndoorTemp>
|Indoor Temperature
|  Parameters as with other Recent webtags
|-
|<#RecentIndoorHumidity>
|Indoor Temperature
|  Parameters as with other Recent webtags
|-
|-
|colspan="3" style="background:lightgray;"|Outdoor Temperature & Humidity tags
|colspan="3" style="background:lightgray;"|Outdoor Temperature & Humidity tags
Line 645: Line 679:
|colspan="3" style="background:lightgray;"|Air Quality tags
|colspan="3" style="background:lightgray;"|Air Quality tags
|}
|}
NOTE: 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)


=Today=
=Today=
Line 713: Line 745:
|<#temprange>
|<#temprange>
|The temperature range (<#tempTH> - <#tempTL>) so far today (Cumulus calculates all these tags using Celsius values, but outputs them in your chosen units)
|The temperature range (<#tempTH> - <#tempTL>) so far today (Cumulus calculates all these tags using Celsius values, but outputs them in your chosen units)
|n/a
|-
|<#tempMidnightTH>
|Today's highest temperature since midnight
|<#TtempMidnightTH>
|-
|<#tempMidnightTL>
|Today's lowest temperature since midnight
|<#TtempMidnightTL>
|-
|<#tempMidnightRangeT>
|The temperature range (max - min) so far today from midnight (Cumulus calculates all these tags using Celsius values, but outputs them in your chosen units)
|n/a
|n/a
|-
|-
Line 799: Line 843:
|<#bearingTM>
|<#bearingTM>
|The wind bearing at the time of today's high gust (<#wgustTM>) in degrees
|The wind bearing at the time of today's high gust (<#wgustTM>) in degrees
|<#TwgustTM>
|-
|<#directionTM>
|The wind bearing at the time of today's high gust (<#wgustTM>) in as a compass point (e.g. "NNE")
|<#TwgustTM>
|<#TwgustTM>
|-
|-
Line 1,020: Line 1,068:
|<#bearingYM>
|<#bearingYM>
|The wind bearing at the time of yesterday's high gust
|The wind bearing at the time of yesterday's high gust
|<#TwgustYM>
|-
|<#directionYM>
|The wind direction at the time of yesterday's high gust as a compass point (e.g. "NNW")
|<#TwgustYM>
|<#TwgustYM>
|-
|-
Line 1,073: Line 1,125:
|}
|}


=Yearly=
=Records=
==Yearly==


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,236: Line 1,289:
|-
|-
|colspan="4" style="background:lightgray;"|Solar
|colspan="4" style="background:lightgray;"|Solar
|-
|<#AnnualET>
|Year's total [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration], if not on the station can be calculated by CMX.
|n/a
|n/a
|-
|-
| <#SunshineHoursYear>
| <#SunshineHoursYear>
Line 1,243: Line 1,301:
|}
|}


=All Time=
==All Time==


The default formats are:
The default formats are:
Line 1,326: Line 1,384:
|<#ThumL>
|<#ThumL>
|-
|-
|<#wchillH>
|<#wchillL>
|All time greatest wind chill (i.e. lowest temperature, but highest wind speed)  
|All time greatest wind chill (i.e. lowest temperature, but highest wind speed)  
|<#TwchillH>
|<#TwchillL>
|NOTE: These were misnamed ''wchillH'' which names have been deprecated.
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
Line 1,381: Line 1,440:
|}
|}


=Monthly=
==Monthly==


The web tags in the date column default output dates in the format "dd MMMM". 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.  
The web tags in the date column default output dates in the format "dd MMMM". 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.  
Line 1,507: Line 1,566:
|n/a
|n/a
|<#MonthWindRunHD>  
|<#MonthWindRunHD>  
|-
|<#windrunmonth>
|This month's Wind Run so far
|n/a
|n/a
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
Line 1,548: Line 1,612:
|}
|}


=Monthly All Time Records=
==Monthly All Time Records==


'''These tag names represent extreme record values (and corresponding time-stamps) for any particular month (1 =January, and so on, to 12 =December) in all years''' (HAR To place somewhere)
'''These tag names represent extreme record values (and corresponding time-stamps) for any particular month (1 =January, and so on, to 12 =December) in all years''' (HAR To place somewhere)
Line 1,688: Line 1,752:
|Longest Wet Period
|Longest Wet Period
|<#ByMonthLongestWetPeriodT>
|<#ByMonthLongestWetPeriodT>
|}
=Statistics=
This section is quite small but may enlarge so it has become a separate chapter.
{| class="wikitable" border="1"
|-
!style="width:300px" | Webtag name
!style="width:750px" | Function
|-
|<#ByMonthTempAvg mon=[1-12]>
|Mean for requested month over the entire history. Omit the month parameter for the current month
|-
|<#MonthTempAvg m=[1-12] y=[YYYY]>
|Mean for the requested specific month. Omit the parameters for the current month
|-
|<#YearTempAvg y=[YYYY]>
|Mean for the requested year. Omit the year parameter for the current year
|}
|}


Line 1,785: Line 1,867:
|<#ProgramUpTimeMs>
|<#ProgramUpTimeMs>
|How long Cumulus has been running in milliseconds
|How long Cumulus has been running in milliseconds
|-
|<#CpuName>
|Name of the processors or n/a
|-
|-
|<#CpuCount>
|<#CpuCount>
Line 1,794: Line 1,879:
|<#AllocatedMemory>
|<#AllocatedMemory>
|Amount of memory allocated to Cumulus, e.g. "60.69 MB"
|Amount of memory allocated to Cumulus, e.g. "60.69 MB"
|-
|<#MemoryStatus>
|Memory status or n/a
|-
|<#DisplayMode>
|Display mode or n/a
|-
|<#DiskSize>
|The size of the disk CumulusMX resides on or n/a
|-
|<#DiskFree>
|The free space on the disk CumulusMX resides on or n/a
|-
|-
|}
|}
Line 1,960: Line 2,057:
|<#PressChangeDownAlarm>  
|<#PressChangeDownAlarm>  
|Pressure decrease alarm
|Pressure decrease alarm
|-
|<#IsRainingAlarm>
|"It's Raining" alarm triggered either via a Hydreon RG-11 device, or rain rate > 0
|-
|-
|<#HighRainTodayAlarm>  
|<#HighRainTodayAlarm>  
Line 1,975: Line 2,075:
|<#DataStopped>
|<#DataStopped>
|1 if the station has apparently stopped sending data to Cumulus, otherwise 0
|1 if the station has apparently stopped sending data to Cumulus, otherwise 0
|-
|<#BatteryLowAlarm>
|Alarm for WLL (Console [if you have an API key] & Tx), VP2 (Console & Tx), GW1000 (Tx)
|-
|-
|<#DataSpikeAlarm>
|<#DataSpikeAlarm>
Line 2,123: Line 2,226:
|-
|-
|<#LatestError>
|<#LatestError>
| This tag and the next 3 are in CumulusMX, none of them are actually used.
| This tag and the next 5 are in CumulusMX containing the latest error information.
|-
|-
|<#LatestErrorEnc>
| See previous tag for use in PHP scripts.
|-
|-
|<#LatestErrorJsEnc>
| See previous tag for use in javascript.
|-
|-
|<#LatestErrorDate>
|<#LatestErrorDate>
|See previous tag
|See previous tags
|-
|-
|<#LatestErrorTime>
|<#LatestErrorTime>
|See previous tag
|See previous tags
|-
|-
|<#ErrorLight>
|<#ErrorLight>
Line 2,233: Line 2,344:
|<#LatestNOAAYearlyReport>
|<#LatestNOAAYearlyReport>
|Gives file name of latest auto-saved NOAA yearly report
|Gives file name of latest auto-saved NOAA yearly report
|-
|<#MySqlRealtimeTime>
|time of last real-time table insert
|-
|<#MySqlIntervalTime>
|time of last interval data table insert
|-
|-
| <#Option_useApparent>
| <#Option_useApparent>
Line 2,300: Line 2,417:
|<#StormRainStart>
|<#StormRainStart>
|The console reported date of the start of the 'storm' (see previous webtag).
|The console reported date of the start of the 'storm' (see previous webtag).
|-
|<#StationFreeMemory>
|Shows the station free memory for Davis WLC, Ecowitt GW1100/20000 (using HTTP also using Ecowitt API)
|-
|<#StationRuntime>
| Shows the station uptime in seconds for Davis WLL/WLC, Ecowitt GW1100/20000 (using HTTP)
|}


'''Note:''' that the console does not report start time, so the webtag cannot report time.  It appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTip> might help
'''Note:''' that the console does not report start time, so the webtag cannot report time.  It appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTip> might help
|}


==Davis WLL ==
==Davis WLL ==
Line 2,334: Line 2,457:
|Percentage of good multicast packets received
|Percentage of good multicast packets received
|}
|}
'''Note''': See also the '''Davis''' table for <#StationFreeMemory> and <#StationRuntime>


==Fine Offset==
==Ecowitt && Fine Offset==


The following tags are specific to the Fine Offset series  
The following tags are specific to the Fine Offset series  
Line 2,350: Line 2,474:
|1 if the station has lost contact with its remote sensors "Fine Offset only"  
|1 if the station has lost contact with its remote sensors "Fine Offset only"  
0 if contact has been established
0 if contact has been established
|-
|<#ExtraStationFreeMemory>
|to avoid clashes with the main station and a Ecowitt HTTP station used for extra sensors
|}
|}
'''Note''': See also the '''Davis''' table for <#StationFreeMemory> and <#StationRuntime>


[[Category:Cumulus_MX]]
[[Category:Cumulus_MX]]
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/11032...11586"

Navigation menu