5,838
edits
Webtags (preserving history): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→The Tags
m (→The Tags) |
|||
|
|}
=The Web Tags for Cumulus =
===System===
Special tags returning information about the Windows device hosting Cumulus. If you are running MX on Linux or Mac OS X, then some of these tags may not work.
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:600px" |Function
|-
|<#OsVersion>
|OS version, e.g. "Windows 7 x64 build 7600"
|-
|<#OsLanguage>
|OS language, e.g. "English"
|-
|<#SystemUpTime>
|How long the system has been up, e.g. "8 hours 21 minutes"
|-
|<#ProgramUpTime>
|How long Cumulus has been running, e.g. "7 hours 55 minutes"
|-
|<#CpuName>
|CPU type, e.g. "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz"
|-
|<#CpuCount>
|Number of processors, e.g. "4"
|-
|<#MemoryStatus>
|Free and total system RAM, e.g. "4619/8191 MB (free/total)"
|-
|<#DisplayMode>
|Screen display mode, e.g. "1680x1050, 32 bit"
|-
|<#AllocatedMemory>
|Amount of memory allocated to Cumulus, e.g. "18.76 MB"
|-
|<#DiskSize>
|Size of disk on which Cumulus is running, e.g. "931.51 GB"
|-
|<#DiskFree>
|Free space on disk on which Cumulus is running, e.g. "515.36 GB"
|}
==Units==
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" | Function
|-
{| class="wikitable" border="1"
|-
!style="width:150px" |Web
!style="width:600px" | Function
|-
==Current Conditions==
These appear on "Now" page (index.htm).
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" | Function
|-
|<#IsRaining>
|For [[Rain_measurement#Optical_Rain_Gauge| Hydreon RG-11 devices]], shows the current rain state. 0=No rain, 1=It's raining
|-
|<#rmonth>
|The total rainfall so far this month
|n/a
|n/a
|-
|<#ryear>
|Annual rainfall total for rainfall season year (i.e. starting month as set on Configuration menu, station screen, Annual rainfall frame)
|n/a
|n/a
|-
|colspan="2" style="background:lightgray;"|Pressure
|<#wsforecastenc>
|The same as <#wsforecast> but with all reserved HTML characters, and those above character code 159, encoded as HTML entities
|}
==Extra Sensors==
These webtags hold current values for additional sensors supported by Cumulus. For past values, see the [[Extra_Sensor_Files]] page for information about log files.
{| class="wikitable" border="1"
|-
!style="width:150px"|Web tag_name
!style="width:600px"|The related description can be changed in 'strings.ini'
|-
|<#ExtraTemp1>
|Extra temperature channel 1
|-
|<#ExtraTemp2>
|Extra temperature channel 2
|-
|<#ExtraTemp3>
|Extra temperature channel 3
|-
|colspan="2"|... and so on up to <#ExtraTemp10> = Extra temperature channel 10
|-
|<#ExtraDP1>
|Extra dew point channel 1
|-
|<#ExtraDP2>
|Extra dew point channel 2
|-
|<#ExtraDP3>
|Extra dew point channel 3
|-
|colspan="2"|... and so on up to <#ExtraDP10>
|-
|<#ExtraHum1>
|Extra humidity channel 1
|-
|<#ExtraHum2>
|Extra humidity channel 2
|-
|<#ExtraHum3>
|Extra humidity channel 3
|-
|colspan="2"|... and so on up to <#ExtraHum10>
|-
|<#SoilTemp1>
|Soil temperature 1
|-
|<#SoilTemp2>
|Soil temperature 2
|-
|colspan="2"|... and so on up to <#SoilTemp16>
|-
|<#SoilMoisture1>
|Soil moisture 1
|-
|<#SoilMoisture2>
|Soil moisture 2
|-
|colspan="2"|... and so on up to <#SoilMoisture16>
|-
|<#LeafTemp1>
|Leaf temperature 1
|-
|<#LeafTemp2>
|Leaf temperature 2
|-
|<#LeafWetness1>
|Leaf wetness 1
|-
|<#LeafWetness2>
|Leaf wetness 2
|-
|<#AirQuality1>
|Air quality (currently only GW1000 stations)
|-
|colspan="2"|... and so on up to <#AirQuality4>
|-
|<#LeakSensor1>
|Leak sensor - 0 or 1 (currently only GW1000 stations)
|-
|colspan="2"|... and so on up to <#LeakSensor4>
|-
|<#LightningDistance>
|Distance to last strike (same units as wind run - miles/km/nm)
(currently only GW1000 stations)
|-
|<#LightningTime>
|Time of last strike (format customisable)
(currently only GW1000 stations)
|-
|<#LightningStrikesToday>
|Number of strikes since midnight
(currently only GW1000 stations)
|}
==Recent History==
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. (Note that Cumulus uses current time read from the computer to determine which array element used. 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). 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. [[#No_Commas]] versions of the array are available for use in script.
=== Input Parameters ===
You specify which value you want from the array by using parameters on the web tags for number of days ago, hours ago, and minutes ago. For example, <#RecentOutsideTemp m=1> will give the temperature one minute ago, <#RecentOutsideTemp h=1> will give the temperature one hour ago (as will <#RecentOutsideTemp m=60>), and <#RecentOutsideTemp d=1> will give the temperature one day ago. <#RecentOutsideTemp d=1 h=1 m=1> will give the temperature one day, one hour and one minute ago. All values supplied for parameters must be whole numbers. If you don't supply any parameters, the result is undefined. (Again note that parameters specify time-stamped array element to retrieve based on counting back from current local time so the result for any period when clocks change may not be quite what you anticipated).
=== Other weather derivatives ===
Although 'Apparent Temperature' is not included as a tag, it can be [[FAQ#What_formula_does_Cumulus_use_for_Apparent_Temperature.3F | calculated]] in a script from recent 'outside temperature', 'wind speed', and 'relative humidity' values (using the same time selection for all).
=== During catch-up ===
When Cumulus is re-started the array it sets up will be based on reading the logs, so the contents will initially have a resolution according to the logger interval you have set in Cumulus and/or your station. You'll get the nearest value if you ask for a time for which there is currently no exact match, and the first tag listed tells you that nearest time.
=== Variations between Builds/Versions ===
Before build 1098, the recent history array did not initialise correctly from the station logger for the period since Cumulus was last run.
The input parameters are same for Cumulus 1 and Cumulus MX, they always use lower case d, h or m.
=== Table of tags available ===
{| class="wikitable" border="1"
|-
!style="width:150px" | Web tag_name
!style="width:600px" | Function
!style="width:600px" | Parameters example
|-
|<#RecentTS>
|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
|-
|<#RecentOutsideTemp>
|Outside Temperature
| <#RecentOutsideTemp h=3 m=1> <#tempunit> will display the temperature at the start of the period for which <#temptrend> is calculated
|-
|<#RecentWindSpeed>
|Wind Speed
| <#RecentWindSpeed m=10> will display the wind speed 10 minutes ago
|-
|<#RecentWindGust>
|Wind Gust (reports maximum gust from build 1088 of version 1.9.4
| <#RecentWindGust d=1 m=1> will report the wind gust at approximately the same time yesterday
|-
|<#RecentWindLatest>
|Wind Latest. Note: Wind 'Speed', 'Gust' and 'Latest' have the usual Cumulus meanings
| 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)
|-
|<#RecentWindDir>
|Wind Direction (instantaneous)
| <#RecentWindDir m=10> will tell you which direction the wind was blowing from 10 minutes ago
|-
|<#RecentWindAvgDir>
|Wind Direction (average)
|<#RecentWindAvgDir d=6> will say what the calculated average wind direction was at this time at the start of the week
|-
|<#RecentWindChill>
|Wind Chill
| <#RecentWindChill d=48 m=1> reports the wind chill temperature 2 days ago
|-
|<#RecentDewPoint>
|Dew Point
| <#RecentDewPoint h=25> reports the dew point temperature just over a day ago
|-
|<#RecentHeatIndex>
|Heat Index
| <#RecentHeatIndex m=121> reports the heat index about 2 hours ago
|-
|<#RecentHumidity>
|Relative Humidity
| 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)
|-
|<#RecentPressure>
|Sea-level Pressure
| <#RecentPressure h=3 m=1> gives the sea level pressure when <#presstrendval> started tracking the pressure
|-
|<#RecentRainToday>
|Daily rain total from last roll-over to specified time
| 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)
|-
|<#RecentSolarRad>
|Solar Radiation
| 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)
|-
|<#RecentUV>
|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)
|}
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:450px" | Function
!style="width:150px" | Time
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:450px" | Function
!style="width:150px" | Time
==Monthly==
This table shows the web tags used on the "thismonthT.htm" web page, the rainfall this month does not appear on that page, it is shown on [[#current|index.htm]].
The web tags in the date column output dates in the format "dd MMMM" (same for Cumulus 1 and Cumulus MX), this can be changed using the [[#Time.2FDate_.27format.27_Parameter|formats described above.
NB This table shows time of extremes for two daily figures (highest minimum/lowest maximum temperatures as of course these are actually associated with a particular time although a standard web tag was not provided for that), by including Cumulus 1.9.y time modifiers, and the slightly different way of specifying minutes in time modifiers in Cumulus MX.
{| class="wikitable" border="1"
|-
!style="width:150px"|
!style="width:300px"|Function
!style="width:150px"|Time
|-
|colspan="4" style="background:lightgray;"|Rainfall
|-
|<#MonthRainRateH>
==Yearly==
The default format for web tags in the date column is (like the monthly web tags) "dd MMMM" (same for Cumulus 1 and Cumulus MX), this can be changed using the [[#Time.2FDate_.27format.27_Parameter|formats described above.
NB Year runs from roll-over time on 1 January for all web tags listed here
{| class="wikitable" border="1"
|-
!style="width:150px"|
!style="width:300px"|Function
!style="width:150px"|Time
|-
|colspan="4" style="background:lightgray;"|Rainfall
|-
|<#YearRainRateH>
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:300px" | Function
!style="width:150px" | Date/Time
|All time high daily wind run
|<#TwindrunH>
|}
{| class="wikitable" border="1"
|-
!style="width:150px"|
!style="width:300px"|Function
!style="width:150px"|Date/Time
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" | Function
|-
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" | Function
|-
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" |Function
|-
|}
== Extreme Records ==
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).
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" |Function
|-
|}
==Special tags==
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" |Function
|-
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:120px" |Applicability
!style="width:600px" |Function
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" | Function
|-
{| class="wikitable" border="1"
|-
!style="width:150px" |
!style="width:600px" |Function
|-
|<#GW1000FirmwareVersion>
|GW1000 firmware version string
|}
| |||
