BETA webtags: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

BETA webtags (view source)

Revision as of 11:37, 10 February 2019

4,871 bytes added ,  11:37, 10 February 2019
→‎Day/Night/Sun/Moon
 
(98 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Additional webtags available in the BETA version of Cumulus 1.9.1 ==
== Additional webtags available in the BETA version of Cumulus 3.0.0 ==
 


These are special markers placed in a file which Cumulus can then process and replace with the actual values.  Typically you would use this to build your own website by having an HTML template file with your layout, static text and graphics.  In the position on the page you wish Cumulus to insert the relevant data place a webtag in the form:
These are special markers placed in a file which Cumulus can then process and replace with the actual values.  Typically you would use this to build your own website by having an HTML template file with your layout, static text and graphics.  In the position on the page you wish Cumulus to insert the relevant data place a webtag in the form:
Line 9: Line 10:
''Note: When you put a tag into your HTML, be careful that whatever program you are using to develop your web pages doesn't change the angle brackets to slightly different symbols -- this is a common cause of failure!''
''Note: When you put a tag into your HTML, be careful that whatever program you are using to develop your web pages doesn't change the angle brackets to slightly different symbols -- this is a common cause of failure!''


Also note that web tags are case sensitive, use them exactly as they appear here.


=The Tags=
=Time and Date Format Code Changes=
 
The table below details the differences in the time/date format codes between Cumulus v1 and Cumulus MX
Below is a list of the additional webtags available in this beta version. These webtags will be transferred to the main page when the beta version becomes 'live'
Note that this also applies to the NOAA report file formats. The characters which can be used now are listed on the following two pages:


http://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx - 'standard' strings


==Time==
http://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx - 'custom' strings


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" | webtag
!style="width:75px" | Cumulus v1 Code
!style="width:600px" | Function
!style="width:400px" | Description
!style="width:230px" | Cumulus MX Code
|-
|c
|Windows Short Date and Long Time format.
|G (or construct from custom formats)
|-
|d
|Day of month as a number without a leading zero (1-31).
|Same
|-
|dd
|Day as a number with a leading zero (01-31).
|Same
|-
|ddd
|Day as an abbreviation (Sun-Sat) using Windows Locale.
|Same
|-
|dddd
|Day as a full name (Sunday-Saturday) using Windows Locale.
|Same
|-
|ddddd
|Displays the date using the format given by the Windows Short Date format.
|d (or construct from custom formats)
|-
|dddddd
|Date in Windows Long Date format.
|D (or construct from custom formats)
|-
|m
|Month as a number without a leading zero (1-12).
|M
|-
|mm
|Month as a number with a leading zero (01-12).
|MM
|-
|mmm
|Month as an abbreviation (Jan-Dec) using Windows Locale.
|MMM
|-
|-
|<#ThumTH>
|mmmm
|Time of today's high humidity
|Month as a full name (January-December) using Windows Locale.
|MMMM
|-
|-
|<#ThumTL>
|yy
|Time of today's low humidity
|Year as a two-digit number (00-99).
|Same
|-
|-
|<#ThumYH>
|yyyy
|Time of yesterday's high humidity
|Year as a four-digit number (0000-9999).
|Same
|-
|-
|<#ThumYL>
|h
|Time of yesterday's low humidity
|Hour without a leading zero (0-23).
|h for 12-hour clock (1-12), H for 24-hour clock (0-23)
|-
|-
|<#ThumH>
|hh
|Date/time of all time high humidity
|Hour with a leading zero (00-23).
|hh for 12-hour clock (1-12), HH for 24-hour clock (0-23)
|-
|-
|<#ThumL>
|n
|Date/time of all time low humidity
|Minute without a leading zero (0-59).
|m
|-
|-
|<#TapptempTH>
|nn
|Time of today's high apparent temperature
|Minute with a leading zero (00-59).
|mm
|-
|-
|<#TapptempTL>
|s
|Time of today's low apparent temperature
|Second without a leading zero (0-59).
|Same
|-
|-
|<#TapptempYH>
|ss
|Time of yesterday's high apparent temperature
|Second with a leading zero (00-59).
|Same
|-
|-
|<#TapptempYL>
|z
|Time of yesterday's low apparent temperature
|Millisecond without a leading zero (0-999).
|No equivalent
|-
|-
|<#TapptempH>
|zzz
|Date/time of all time high apparent temperature
|Millisecond with a leading zero (000-999).
|f (tenths), ff (hundredths), fff (ms) etc.
|-
|-
|<#TapptempL>
|t
|Date/time of all time low apparent temperature
|Date in Windows Short Time format.
|Same
|-
|-
|<#TheatindexTH>
|tt\
|Time of today's high heat index
|Date in Windows Long Time format.
|T
|-
|-
|<#TheatindexYH>
|am/pm
|Time of yesterday's high heat index
|am/pm specifier can use lower, upper, or mixed case
|tt (Windows am/pm format)
|-
|-
|<#TheatindexH>
|a/p
|Date/time of all time high heat index
|The a/p specifier can use lower, upper, or mixed case.
|t (Windows a/p format)
|-
|-
|<#TwchillTL>
|ampm
|Time of today's low wind chill
|Windows AM or PM string.
|tt
|-
|-
|<#TwchillYL>
|/
|Time of yesterday's low wind chill
|Date separator character given by the Windows Date Separator.
|Same
|-
|-
|<#ThourlyrainTH>
|:
|Time of today's high rainfall rate
|Time separator character given by the Windows Time Separator.
|Same
|-
|-
|<#ThourlyrainYH>
|'xx'
|Time of yesterday's high rainfall rate
|Characters enclosed in single quotation marks are displayed as such, and do not affect formatting.
|Same
|}
|}


==Temperature==
=The Tags=


Below is a list of the additional webtags available in this beta version.  These webtags will be transferred to the main page when the beta version becomes 'live'
==Units==
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2"|no new tags
|}
 
==Date & Time==
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#apptemp>
|colspan="2"|no new tags
|The apparent temperature
|}
 
==Current Conditions==
 
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#apptempTH>
|colspan="2"|no new tags
|Today's high apparent temperature
|-
|-
|<#apptempTL>
|colspan="2" style="background:lightgray;"|Rainfall
|Today's low apparent temperature
|-
|-
|<#apptempYH>
|colspan="2"|no new tags
|Yesterday's high apparent temperature
|-
|-
|<#apptempYL>
|colspan="2" style="background:lightgray;"|Pressure
|Yesterday's low apparent temperature
|-
|-
|<#apptempH>
|colspan="2"|no new tags
|All time high apparent temperature
|-
|-
|<#apptempL>
|colspan="2" style="background:lightgray;"|Wind
|All time low apparent temperature
|-
|-
|<#heatindexTH>
|colspan="2"|no new tags
|Today's high heat index
|-
|-
|<#heatindexYH>
|colspan="2" style="background:lightgray;"|Miscellaneous
|Yesterday's high heat index
|-
|-
|<#heatindexH>
|colspan="2"|no new tags
|All time high heat index
|}
 
==Today==
 
{| class="wikitable" border="1"
|-
|-
|<#humTH>
!style="width:150px" | webtag
|Today's highest humidity
!style="width:450px" | Function
!style="width:150px" | Time
|-
|-
|<#humTL>
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|Today's lowest humidity
|-
|-
|<#humYH>
|colspan="3"|no new tags
|High humidity yesterday
|-
|-
|<#humYL>
|colspan="3" style="background:lightgray;"|Rainfall
|Low humidity yesterday
|-
|-
|<#humH>
|colspan="3"|no new tags
|All time high humidity
|-
|-
|<#humL>
|colspan="3" style="background:lightgray;"|Pressure
|All time low humidity
|-
|-
|<#wchillTL>
|colspan="3"|no new tags
|Today's low wind chill
|-
|-
|<#wchillYL>
|colspan="3" style="background:lightgray;"|Wind
|Yesterday's low wind chill
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|colspan="3"|no new tags
|}
|}


==Pressure==
==Yesterday==


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
!style="width:150px" | webtag
!style="width:600px" | Function
!style="width:450px" | Function
!style="width:150px" | Time
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Rainfall
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Pressure
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Wind
|-
|colspan="2"|no new tags
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|colspan="3"|no new tags
|}
|}


==Rain==
==Monthly==


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
!style="width:150px"|webtag
!style="width:600px" | Function
!style="width:300px"|Function
!style="width:150px"|Time
!style="width:150px"|Date
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|colspan="4"|no new tags
|-
|colspan="4" style="background:lightgray;"|Pressure
|-
|colspan="4"|no new tags
|-
|colspan="4" style="background:lightgray;"|Wind
|-
|colspan="4"|no new tags
|-
|-
|<#hourlyrainTH>
|colspan="4" style="background:lightgray;"|Rainfall
|Today's highest rainfall rate
|-
|-
|<#hourlyrainYH>
|colspan="4"|no new tags
|Yesterday's highest rainfall rate
|}
 
==Wind==
 
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
|colspan="4" style="background:lightgray;"|Miscellaneous
!style="width:600px" | Function
|-
|-
|colspan="4"|no new tags
|}
|}


==Monthly==
==Yearly==


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 183: Line 290:
!style="width:150px"|Date
!style="width:150px"|Date
|-
|-
|<#MonthTempH>
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|This months high temperature
|<#MonthTempHT>
|<#MonthTempHD>
|-
|-
|<#MonthTempL>
|colspan="4"|no new tags
|This months low temperature
|<#MonthTempLT>
|<#MonthTempLD>
|-
|-
|<#MonthHeatIndexH>
|colspan="4" style="background:lightgray;"|Pressure
|This months high heat index
|<#MonthHeatIndexHT>
|<#MonthHeatIndexHD>
|-
|-
|<#MonthWChillL>
|colspan="4"|no new tags
|This months low wind chill
|<#MonthWChillLT>
|<#MonthWChillLD>
|-
|-
|<#MonthAppTempH>
|colspan="4" style="background:lightgray;"|Wind
|This months high apparent temperature
|<#MonthAppTempHT>
|<#MonthAppTempHD>
|-
|-
|<#MonthAppTempL>
|colspan="4"|no new tags
|This months low apparent temperature
|<#MonthAppTempLT>
|<#MonthAppTempLD>
|-
|-
|<#MonthMinTempH>
|colspan="4" style="background:lightgray;"|Rainfall
|This months highest daily minimum temperature
|N/A
|<#MonthMinTempHD>
|-
|-
|<#MonthMaxTempL>
|colspan="4"|no new tags
|This months lowest daily minimum temperature
|N/A
|<#MonthMaxTempLD>
|-
|-
|<#MonthPressH>
|colspan="4" style="background:lightgray;"|Miscellaneous
|This months high pressure
|<#MonthPressHT>
|<#MonthPressHD>
|-
|-
|<#MonthPressL>
|colspan="4"|no new tags
|This months low pressure
|}
|<#MonthPressLT>
 
|<#MonthPressLD>
==All Time==
 
{| class="wikitable" border="1"
|-
|-
|<#MonthHumH>
!style="width:150px" | webtag
|This months high humidty
!style="width:300px" | Function
|<#MonthHumHT>
!style="width:150px" | Time
|<#MonthHumHD>
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Rainfall
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Pressure
|-
|-
|<#MonthHumL>
|colspan="3"|no new tags
|This months low humidty
|<#MonthHumLT>
|<#MonthHumLD>
|-
|-
|<#MonthGustH>
|colspan="3" style="background:lightgray;"|Wind
|This months high wind gust
|<#MonthGustHT>
|<#MonthGustHD>
|-
|-
|<#MonthWindH>
|colspan="3"|no new tags
|This months high wind speed
|<#MonthWindHT>
|<#MonthWindHD>
|-
|-
|<#MonthRainRateH>
|colspan="3" style="background:lightgray;"|Miscellaneous
|This months high rainfall rate
|-
|<#MonthRainRateHT>
|colspan="3"|no new tags
|<#MonthRainRateHD>
|}
 
==Recent History==
 
There are a set of tags for 'recent historical data', giving data values from 1 minute ago, up to 1 week ago, in 1 minute intervals. Note that the values are initialised from the log files when Cumulus starts, so they 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 one for which there is currently no exact match.
 
You specify how old you want the value to be by using parameters on the web tags for number of days, hours, and minutes. 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.
 
{| class="wikitable" border="1"
|-
|-
|<#MonthHourlyRainH>
!style="width:150px" | webtag
|This months high hourly rain
!style="width:600px" | Function
|<#MonthHourlyRainHT>
|<#MonthHourlyRainHD>
|-
|-
|<#MonthDailyRainH>
|colspan="2"|no new tags
|This months high daily rain
|N/A
|<#MonthDailyRainHD>
|}
|}


==Yearly==
==Monthly All Time Records==
 
There are a set of tags for monthly all-time highs and lows, in other words the highest and lowest values for a particular month of the year. For example, the highest ever temperature in July. Each Value tag has an optional parameter "mon=N" where N is the index of the month of the year that you want the value for (January=1 and so on). For example, <#ByMonthTempH mon=7> will give you the highest ever temperature in July.
 
If you don't supply a parameter (or supply an invalid value) the current month will be used. You can customise the date and time formats using the 'format' parameter on the web tag, see below. To supply more than one parameter, separate them with spaces, e.g. <#ByMonthTempHT mon=7 format=hh:nn>
 


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 275: Line 365:
!style="width:150px"|webtag
!style="width:150px"|webtag
!style="width:300px"|Function
!style="width:300px"|Function
!style="width:150px"|Time
!style="width:150px"|Date/Time
!style="width:150px"|Date
|-
|-
|<#YearTempH>
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|This years high temperature
|<#YearTempHT>
|<#YearTempHD>
|-
|-
|<#YearTempL>
|colspan="3"|no new tags
|This years low temperature
|<#YearTempLT>
|<#YearTempLD>
|-
|-
|<#YearHeatIndexH>
|colspan="3" style="background:lightgray;"|Pressure
|This years high heat index
|<#YearHeatIndexHT>
|<#YearHeatIndexHD>
|-
|-
|<#YearWChillL>
|colspan="3"|no new tags
|This years low wind chill
|<#YearWChillLT>
|<#YearWChillLD>
|-
|-
|<#YearAppTempH>
|colspan="3" style="background:lightgray;"|Rainfall
|This years high apparent temperature
|<#YearAppTempHT>
|<#YearAppTempHD>
|-
|-
|<#YearAppTempL>
|colspan="3"|no new tags
|This years low apparent temperature
|<#YearAppTempLT>
|<#YearAppTempLD>
|-
|-
|<#YearMinTempH>
|colspan="3" style="background:lightgray;"|Miscellaneous
|This years highest daily minimum temperature
|N/A
|<#YearMinTempHD>
|-
|-
|<#YearMaxTempL>
|colspan="3"|no new tags
|This years lowest daily minimum temperature
|}
|N/A
 
|<#YearMaxTempLD>
==Miscellaneous==
 
{| class="wikitable" border="1"
|-
|-
|<#YearPressH>
!style="width:150px" |webtag
|This years high pressure
!style="width:600px" | Function
|<#YearPressHT>
|<#YearPressHD>
|-
|-
|<#YearPressL>
|colspan="2"|no new tags
|This years low pressure
|}
|<#YearPressLT>
 
|<#YearPressLD>
==Day/Night/Sun/Moon==
These are updated each hour (b3047 or later = every 10 minutes) to refer to current time-zone
{| class="wikitable" border="1"
|-
|-
|<#YearHumH>
!style="width:150px" | webtag
|This years high humidty
!style="width:600px" | Function
|<#YearHumHT>
|<#YearHumHD>
|-
|-
|<#YearHumL>
|<#MoonAge>
|This years low humidty
|Current '''approximate''' age of the Moon in days (0-29)
|<#YearHumLT>
b3047 adds the 'dp' and 'rc' parameters
|<#YearHumLD>
Supports an optional 'dp' parameter, if supplied the result is returned to the specified number of decimal places. E.g
<#MoonAge> gives "11"
<#MoonAge dp=3> gives "11.234"
 
If the "dp" parameter is supplied, then also supplying "rc=y" in addition will cause any decimal comma to be converted to a decimal point.
|-
|-
|<#YearGustH>
|<#MoonPercent>
|This years high wind gust
|Current percentage of moon visible (negative value indicates 'waning')
|<#YearGustHT>
b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|<#YearGustHD>
|-
|-
|<#YearWindH>
|<#MoonPercentAbs>
|This years high wind speed
|Current percentage of moon visible (always positive)
|<#YearWindHT>
b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|<#YearWindHD>
|}
 
==Alarms==
 
There are a set of tags for the Cumulus alarm states. They give a value of '1' if the alarm has been set and the alarm condition is currently met; otherwise '0'.
{| class="wikitable" border="1"
|-
|-
|<#YearRainRateH>
!style="width:150px" |webtag
|This years high rainfall rate
!style="width:600px" | Function
|<#YearRainRateHT>
|<#YearRainRateHD>
|-
|<#YearHourlyRainH>
|This years high hourly rain
|<#YearHourlyRainHT>
|<#YearHourlyRainHD>
|-
|<#YearDailyRainH>
|This years high daily rain
|N/A
|<#YearDailyRainHD>
|-
|-
|<#YearMonthlyRainH>
|colspan="2"|no new tags
|This years high monthly rain
|N/A
|<#YearMonthlyRainHD>
|}
|}


==Miscellaneous==
==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'.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 376: Line 438:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#SunshineHours>
|colspan="2" |The individual 'record set' tags such as <#TempRecordSet> etc do not work (because the interface currently has no indicators for new records). The <#newrecord> tag does work, but works differently, it turns itself off automatically after 24 hours.
|Hours of sunshine so far today
|}
 
==Extra Sensors==
 
These webtags are for additional sensors supported by Cumulus
 
{| class="wikitable" border="1"
|-
|-
|<#YSunshineHours>
!style="width:150px"|webtag
|Total hours of sunshine yesterday
!style="width:600px"|Function
|-
|-
|<#CurrentSolarMax>
|colspan="2"|no new tags
|Current theoretical maximum solar radiation
|}
 
==Special==
 
===OS WMR Series===
 
There are a set of tags for the WMR928, WR100/200 extra sensors:
 
{| class="wikitable" border="1"
|-
|-
|<#IsSunny>
!style="width:150px" | webtag
|Returns 1 if the sun is shining, otherwise 0
!style="width:600px" | Function
|-
|-
|<#LatestError>
|colspan="2"|no new tags
|Displays the last error from the Cumulus error log
|}
 
===WMR928===
 
There are a set of tags for the WMR928 extra sensors:
 
{| class="wikitable" border="1"
|-
|-
|<#LatestErrorDate>
!style="width:150px" | webtag
|The date of the latest error logged to the error log window, using the system short date format. Gives dashes when latest error is reset
!style="width:600px" | Function
|-
|<#LatestErrorTime>
|The time of the latest error logged to the error log window, using the system short time format. Gives dashes when latest error is reset
|-
|-
|<#ErrorLight>
|colspan="2"|no new tags
|1 if the 'error' light is flashing, 0 if not
|}
|}


==Day/Night/Sun/Moon==
===Davis===
 
There are a set of tags for the Davis PWS:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 408: Line 488:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|colspan="2"|no new tags
|}
|}


==Alarms==
===Fine Offset===
The following tags are specific to the Fine Offset series of PWS


There are a set of tags for the Cumulus alarm states. They give a value of '1' if the alarm has been set and the alarm condition is currently met; otherwise '0'.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
!style="width:150px" | webtag
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|colspan="2"|no new tags
|}
|}


==Special tags==
===System===


===WMR928===
Special tags returning information about the system hosting Cumulus:
 
There are a set of tags for the WMR928 extra sensors:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 431: Line 511:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|colspan="2"|no new tags
|}
|}


Line 437: Line 518:


There are a set of tags where the decimal comma has been replaced with a full stop, where necessary, for use with gauges etc which don't like the commas. They all correspond to the same tag with 'RC' removed.
There are a set of tags where the decimal comma has been replaced with a full stop, where necessary, for use with gauges etc which don't like the commas. They all correspond to the same tag with 'RC' removed.
<No new tags>
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/1175...4516"

Navigation menu