BETA webtags: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
(→‎Special tags: Added 'System' tags)
 
(90 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!''


=Time/Date 'format' Parameter=
Also note that web tags are case sensitive, use them exactly as they appear here.
 
=Time and Date Format Code Changes=
The table below details the differences in the time/date format codes between Cumulus v1 and Cumulus MX
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


From 1.9.1 b969 most time webtags will accept an option 'format' parameter, e.g: <#YearTempHT format=hh:nn>. This allows you to override the default display format for that item, using the format specifiers in the table below. Note that if your format has any spaces in it, you must enclose it in double quotes, thus: <#YearTempHT format="hh nn">. Note also that you can specify date formatting to times and vice versa, but this will not always yield a sensible result.
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" | Specifier
!style="width:75px" | Cumulus v1 Code
!style="width:600px" | Displays
!style="width:400px" | Description
!style="width:230px" | Cumulus MX Code
|-
|-
|c
|c
|Displays the date using the format given by the Windows Short Date format, followed by the time using the format given by the Windows Long Time format. The time is not displayed if the date-time value indicates midnight precisely.
|Windows Short Date and Long Time format.
|G (or construct from custom formats)
|-
|-
|d
|d
|Displays the day as a number without a leading zero (1-31).
|Day of month as a number without a leading zero (1-31).
|Same
|-
|-
|dd
|dd
|Displays the day as a number with a leading zero (01-31).
|Day as a number with a leading zero (01-31).
|Same
|-
|-
|ddd
|ddd
|Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Windows Locale.
|Day as an abbreviation (Sun-Sat) using Windows Locale.
|Same
|-
|-
|dddd
|dddd
|Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Windows Locale.
|Day as a full name (Sunday-Saturday) using Windows Locale.
|Same
|-
|-
|ddddd
|ddddd
|Displays the date using the format given by the Windows Short Date format.
|Displays the date using the format given by the Windows Short Date format.
|d (or construct from custom formats)
|-
|-
|dddddd
|dddddd
|Displays the date using the format given by the Windows Long Date format.
|Date in Windows Long Date format.
|D (or construct from custom formats)
|-
|-
|m
|m
|Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
|Month as a number without a leading zero (1-12).
|M
|-
|-
|mm
|mm
|Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
|Month as a number with a leading zero (01-12).
|MM
|-
|-
|mmm
|mmm
|Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Windows Locale.
|Month as an abbreviation (Jan-Dec) using Windows Locale.
|MMM
|-
|-
|mmmm
|mmmm
|Displays the month as a full name (January-December) using the strings appropriate to the Windows Locale.
|Month as a full name (January-December) using Windows Locale.
|MMMM
|-
|-
|yy
|yy
|Displays the year as a two-digit number (00-99).
|Year as a two-digit number (00-99).
|Same
|-
|-
|yyyy
|yyyy
|Displays the year as a four-digit number (0000-9999).
|Year as a four-digit number (0000-9999).
|Same
|-
|-
|h
|h
|Displays the hour without a leading zero (0-23).
|Hour without a leading zero (0-23).
|h for 12-hour clock (1-12), H for 24-hour clock (0-23)
|-
|-
|hh
|hh
|Displays the hour with a leading zero (00-23).
|Hour with a leading zero (00-23).
|hh for 12-hour clock (1-12), HH for 24-hour clock (0-23)
|-
|-
|n
|n
|Displays the minute without a leading zero (0-59).  
|Minute without a leading zero (0-59).
|m
|-
|-
|nn
|nn
|Displays the minute with a leading zero (00-59).
|Minute with a leading zero (00-59).
|mm
|-
|-
|s
|s
|Displays the second without a leading zero (0-59).
|Second without a leading zero (0-59).
|Same
|-
|-
|ss
|ss
|Displays the second with a leading zero (00-59).
|Second with a leading zero (00-59).
|Same
|-
|-
|z
|z
|Displays the millisecond without a leading zero (0-999).  
|Millisecond without a leading zero (0-999).
|No equivalent
|-
|-
|zzz
|zzz
|Displays the millisecond with a leading zero (000-999).
|Millisecond with a leading zero (000-999).
|f (tenths), ff (hundredths), fff (ms) etc.
|-
|-
|t
|t
|Displays the time using the format given by the Windows Short Time format.
|Date in Windows Short Time format.
|Same
|-
|-
|tt\
|tt\
|Displays the time using the format given by the Windows Long Time format.  
|Date in Windows Long Time format.
|T
|-
|-
|am/pm
|am/pm
|Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
|am/pm specifier can use lower, upper, or mixed case
|tt (Windows am/pm format)
|-
|-
|a/p
|a/p
|Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
|The a/p specifier can use lower, upper, or mixed case.
|t (Windows a/p format)
|-
|-
|ampm
|ampm
|Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the Windows AM string for any hour before noon, and the contents of the Windows PM string for any hour after noon.
|Windows AM or PM string.
|tt
|-
|-
|/
|/
|Displays the date separator character given by the Windows Date Separator.
|Date separator character given by the Windows Date Separator.
|Same
|-
|-
|:
|:
|Displays the time separator character given by the Windows Time Separator.  
|Time separator character given by the Windows Time Separator.
|Same
|-
|-
|'xx'
|'xx'
|Characters enclosed in single quotation marks are displayed as such, and do not affect formatting.  
|Characters enclosed in single quotation marks are displayed as such, and do not affect formatting.
|Same
|}
|}


Line 109: Line 146:


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'
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"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2"|no new tags
|}


==Date & Time==
==Date & Time==
Line 128: Line 174:
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#apptemp>
|colspan="2"|no new tags
|The apparent temperature
|-
|<#avgtemp>
|Average temperature so far today
|-
|-
|colspan="2" style="background:lightgray;"|Rainfall
|colspan="2" style="background:lightgray;"|Rainfall
Line 143: Line 185:
|-
|-
|colspan="2" style="background:lightgray;"|Wind
|colspan="2" style="background:lightgray;"|Wind
|-
|colspan="2"|no new tags
|-
|colspan="2" style="background:lightgray;"|Miscellaneous
|-
|-
|colspan="2"|no new tags
|colspan="2"|no new tags
Line 157: Line 203:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#apptempTH>
|colspan="3"|no new tags
|Today's high apparent temperature
|<#TapptempTH>
|-
|<#apptempTL>
|Today's low apparent temperature
|<#TapptempTL>
|-
|<#heatindexTH>
|Today's high heat index
|<#TheatindexTH>
|-
|<#wchillTL>
|Today's lowest wind chill
|<#TwchillTL>
|-
|<#dewpointTH>
|Today's highest dew point
|<#TdewpointTH>
|-
|<#dewpointTL>
|Today's lowest dew point
|<#TdewpointTL>
|-
|<#humTH>
|Today's highest humidity
|<#ThumTH>
|-
|<#humTL>
|Today's lowest humidity
|<#ThumTL>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#hourlyrainTH>
|colspan="3"|no new tags
|Today's highest rainfall rate
|<#ThourlyrainTH>
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|colspan="3" style="background:lightgray;"|Pressure
Line 200: Line 214:
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|colspan="3"|no new tags
|colspan="3"|no new tags
Line 214: Line 232:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#apptempYH>
|colspan="3"|no new tags
|Yesterday's high apparent temperature
|<#TapptempYH>
|-
|<#apptempYL>
|Yesterday's low apparent temperature
|<#TapptempYL>
|-
|<#heatindexYH>
|Yesterday's high heat index
|<#TheatindexYH>
|-
|<#wchillYL>
|Yesterday's lowest wind chill
|<#TwchillYL>
|-
|<#dewpointYL>
|Yesterday's lowest dew point
|<#TdewpointYL>
|-
|<#dewpointYH>
|Yesterday's highest dew point
|<#TdewpointYH>
|-
|<#humYH>
|High humidity yesterday
|<#ThumYH>
|-
|<#humYL>
|Low humidity yesterday
|<#ThumYL>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#hourlyrainYH>
|colspan="3"|no new tags
|Yesterday's highest rainfall rate
|<#ThourlyrainYH>
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|colspan="3" style="background:lightgray;"|Pressure
Line 257: Line 243:
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|colspan="2"|no new tags
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|colspan="3"|no new tags
|colspan="3"|no new tags
Line 272: Line 262:
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#MonthTempH>
|colspan="4"|no new tags
|This months high temperature
|<#MonthTempHT>
|<#MonthTempHD>
|-
|<#MonthTempL>
|This months low temperature
|<#MonthTempLT>
|<#MonthTempLD>
|-
|<#MonthHeatIndexH>
|This months high heat index
|<#MonthHeatIndexHT>
|<#MonthHeatIndexHD>
|-
|<#MonthWChillL>
|This months low wind chill
|<#MonthWChillLT>
|<#MonthWChillLD>
|-
|<#MonthAppTempH>
|This months high apparent temperature
|<#MonthAppTempHT>
|<#MonthAppTempHD>
|-
|<#MonthAppTempL>
|This months low apparent temperature
|<#MonthAppTempLT>
|<#MonthAppTempLD>
|-
|<#MonthDewPointH>
|This months high dew point
|<#MonthDewPointHT>
|<#MonthDewPointHD>
|-
|<#MonthDewPointL>
|This months low dew point
|<#MonthDewPointpLT>
|<#MonthDewPointLD>
|-
|<#MonthMinTempH>
|This months highest daily minimum temperature
|N/A
|<#MonthMinTempHD>
|-
|<#MonthMaxTempL>
|This months lowest daily minimum temperature
|N/A
|<#MonthMaxTempLD>
|-
|<#MonthHumH>
|This months highest humidty
|<#MonthHumHT>
|<#MonthHumHD>
|-
|<#MonthHumL>
|This months lowest humidty
|<#MonthHumLT>
|<#MonthHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|colspan="4" style="background:lightgray;"|Pressure
|-
|-
|<#MonthPressH>
|colspan="4"|no new tags
|This months highest pressure
|<#MonthPressHT>
|<#MonthPressHD>
|-
|<#MonthPressL>
|This months lowest pressure
|<#MonthPressLT>
|<#MonthPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#MonthGustH>
|colspan="4"|no new tags
|This months highest wind gust
|<#MonthGustHT>
|<#MonthGustHD>
|-
|<#MonthWindH>
|This months highest wind speed
|<#MonthWindHT>
|<#MonthWindHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
|-
|-
|<#MonthRainRateH>
|colspan="4"|no new tags
|This months highest rainfall rate
|<#MonthRainRateHT>
|<#MonthRainRateHD>
|-
|-
|<#MonthHourlyRainH>
|colspan="4" style="background:lightgray;"|Miscellaneous
|This months highest hourly rain
|<#MonthHourlyRainHT>
|<#MonthHourlyRainHD>
|-
|-
|<#MonthDailyRainH>
|colspan="4"|no new tags
|This months greatest daily rain
|N/A
|<#MonthDailyRainHD>
|}
|}


Line 385: Line 292:
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#YearTempH>
|colspan="4"|no new tags
|This years highest temperature
|<#YearTempHT>
|<#YearTempHD>
|-
|<#YearTempL>
|This years lowest temperature
|<#YearTempLT>
|<#YearTempLD>
|-
|<#YearHeatIndexH>
|This years highest heat index
|<#YearHeatIndexHT>
|<#YearHeatIndexHD>
|-
|<#YearWChillL>
|This years lowest wind chill
|<#YearWChillLT>
|<#YearWChillLD>
|-
|<#YearAppTempH>
|This years highest apparent temperature
|<#YearAppTempHT>
|<#YearAppTempHD>
|-
|<#YearAppTempL>
|This years lowest apparent temperature
|<#YearAppTempLT>
|<#YearAppTempLD>
|-
|<#YearDewPointH>
|This years highest dew point
|<#YearDewPointHT>
|<#YearDewPointHD>
|-
|<#YearDewPointL>
|This years lowest dew point
|<#YearDewPointLT>
|<#YearDewPointLD>
|-
|<#YearMinTempH>
|This years highest daily minimum temperature
|N/A
|<#YearMinTempHD>
|-
|<#YearMaxTempL>
|This years lowest daily minimum temperature
|N/A
|<#YearMaxTempLD>
|-
|<#YearHumH>
|This years high humidty
|<#YearHumHT>
|<#YearHumHD>
|-
|<#YearHumL>
|This years low humidty
|<#YearHumLT>
|<#YearHumLD>
|-
|-
|colspan="4" style="background:lightgray;"|Pressure
|colspan="4" style="background:lightgray;"|Pressure
|-
|-
|<#YearPressH>
|colspan="4"|no new tags
|This years high pressure
|<#YearPressHT>
|<#YearPressHD>
|-
|<#YearPressL>
|This years low pressure
|<#YearPressLT>
|<#YearPressLD>
|-
|-
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#YearGustH>
|colspan="4"|no new tags
|This years high wind gust
|<#YearGustHT>
|<#YearGustHD>
|-
|<#YearWindH>
|This years high wind speed
|<#YearWindHT>
|<#YearWindHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
|-
|-
|<#YearRainRateH>
|colspan="4"|no new tags
|This years high rainfall rate
|<#YearRainRateHT>
|<#YearRainRateHD>
|-
|-
|<#YearHourlyRainH>
|colspan="4" style="background:lightgray;"|Miscellaneous
|This years high hourly rain
|<#YearHourlyRainHT>
|<#YearHourlyRainHD>
|-
|-
|<#YearDailyRainH>
|colspan="4"|no new tags
|This years high daily rain
|N/A
|<#YearDailyRainHD>
|-
|<#YearMonthlyRainH>
|This years high monthly rain
|N/A
|<#YearMonthlyRainHD>
|}
|}


Line 502: Line 321:
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#apptempH>
|colspan="3"|no new tags
|All time high apparent temperature
|-
|<#TapptempH>
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|<#apptempL>
|colspan="3"|no new tags
|All time low apparent temperature
|<#TapptempL>
|-
|-
|<#heatindexH>
|colspan="3" style="background:lightgray;"|Pressure
|All time high heat index
|<#TheatindexH>
|-
|-
|<#dewpointH>
|colspan="3"|no new tags
|All time high dew point
|<#TdewpointH>
|-
|-
|<#dewpointL>
|colspan="3" style="background:lightgray;"|Wind
|All time low dew point
|<#TdewpointL>
|-
|-
|<#humH>
|colspan="3"|no new tags
|All time high humidity
|<#ThumH>
|-
|-
|<#humL>
|colspan="3" style="background:lightgray;"|Miscellaneous
|All time low humidity
|<#ThumL>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3"|no new tags
|}
 
==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"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2"|no new tags
|}
 
==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"
|-
!style="width:150px"|webtag
!style="width:300px"|Function
!style="width:150px"|Date/Time
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|-
|colspan="3"|no new tags
|colspan="3"|no new tags
Line 538: Line 375:
|colspan="3"|no new tags
|colspan="3"|no new tags
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Rainfall
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|colspan="3"|no new tags
|colspan="3"|no new tags
Line 550: Line 391:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#LatestError>
|colspan="2"|no new tags
|Displays the last error from the Cumulus error log
|-
|<#LatestErrorDate>
|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
|-
|<#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>
|1 if the 'error' light is flashing, 0 if not
|}
|}


==Day/Night/Sun/Moon==
==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"
{| class="wikitable" border="1"
|-
|-
Line 570: Line 401:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#SunshineHours>
|<#MoonAge>
|Hours of sunshine so far today
|Current '''approximate''' age of the Moon in days (0-29)
|-
b3047 adds the 'dp' and 'rc' parameters
|<#YSunshineHours>
Supports an optional 'dp' parameter, if supplied the result is returned to the specified number of decimal places. E.g
|Total hours of sunshine yesterday
<#MoonAge> gives "11"
|-
<#MoonAge dp=3> gives "11.234"
|<#CurrentSolarMax>
 
|Current theoretical maximum solar radiation
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.
|-
|<#IsSunny>
|Returns 1 if the sun is shining, otherwise 0
|-
|-
|<#MoonPercent>
|<#MoonPercent>
|Current percentage of moon visible (negative value indicates 'waning')
|Current percentage of moon visible (negative value indicates 'waning')
b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|-
|-
|<#MoonPercentAbs>
|<#MoonPercentAbs>
|Current percentage of moon visible (always positive)
|Current percentage of moon visible (always positive)
b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|}
|}


Line 597: Line 427:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#TempRecordSet>
|colspan="2"|no new tags
|1 if the indicator on the temperature tab on the all-time records screen is currently lit, 0 if not
|}
 
==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"
|-
|-
|<#WindRecordSet>
!style="width:150px" |webtag
|1 if the indicator on the wind tab on the all-time records screen is currently lit, 0 if not
!style="width:600px" | Function
|-
|-
|<#RainRecordSet>
|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.
|1 if the indicator on the rain tab on the all-time records screen is currently lit, 0 if not
|}
 
==Extra Sensors==
 
These webtags are for additional sensors supported by Cumulus
 
{| class="wikitable" border="1"
|-
|-
|<#HumidityRecordSet>
!style="width:150px"|webtag
|1 if the indicator on the humidity tab on the all-time records screen is currently lit, 0 if not
!style="width:600px"|Function
|-
|-
|<#PressureRecordSet>
|colspan="2"|no new tags
|1 if the indicator on the pressure tab on the all-time records screen is currently lit, 0 if not
|}
 
==Special==
 
===OS WMR Series===
 
There are a set of tags for the WMR928, WR100/200 extra sensors:
 
{| class="wikitable" border="1"
|-
|-
|<#HighTempRecordSet>
!style="width:150px" | webtag
|1 if the all-time high temperature light is currently flashing, 0 if not
!style="width:600px" | Function
|-
|-
|<#LowTempRecordSet>
|colspan="2"|no new tags
|1 if the all-time low temperature light is currently flashing, 0 if not
|-
|<#HighAppTempRecordSet>
|1 if the all-time high apparent temperature light is currently flashing, 0 if not
|-
|<#LowAppTempRecordSet>
|1 if the all-time low apparent temperature light is currently flashing, 0 if not
|-
|<#HighHeatIndexRecordSet>
|1 if the all-time high heat index light is currently flashing, 0 if not
|-
|<#LowWindChillRecordSet>
|1 if the all-time low wind chill light is currently flashing, 0 if not
|-
|<#HighDewPointRecordSet>
|1 if the all-time high dew point light is currently flashing, 0 if not
|-
|<#LowDewPointRecordSet>
|1 if the all-time low dew point light is currently flashing, 0 if not
|-
|<#HighMinTempRecordSet>
|1 if the all-time high minimum temperature light is currently flashing, 0 if not
|-
|<#LowMaxTempRecordSet>
|1 if the all-time low maximum temperature light is currently flashing, 0 if not
|-
|<#HighWindGustRecordSet>
|1 if the all-time high wind gust light is currently flashing, 0 if not
|-
|<#HighWindSpeedRecordSet>
|1 if the all-time high wind speed light is currently flashing, 0 if not
|-
|<#HighRainRateRecordSet>
|1 if the all-time high rain rate light is currently flashing, 0 if not
|-
|<#HighHourlyRainRecordSet>
|1 if the all-time high hourly rain light is currently flashing, 0 if not
|-
|<#HighDailyRainRecordSet>
|1 if the all-time high daily rain light is currently flashing, 0 if not
|-
|<#HighMonthlyRainRecordSet>
|1 if the all-time high monthly rain light is currently flashing, 0 if not
|-
|<#HighHumidityRecordSet>
|1 if the all-time high humidity light is currently flashing, 0 if not
|-
|<#LowHumidityRecordSet>
|1 if the all-time low humidity light is currently flashing, 0 if not
|-
|<#HighPressureRecordSet>
|1 if the all-time high pressure light is currently flashing, 0 if not
|-
|<#LowPressureRecordSet>
|1 if the all-time low pressure light is currently flashing, 0 if not
|}
|}
==Special tags==


===WMR928===
===WMR928===
Line 687: Line 479:
|}
|}


===System===
===Davis===


Special tags returning information about the system hosting Cumulus:
There are a set of tags for the Davis PWS:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 696: Line 488:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#OsVersion>
|colspan="2"|no new tags
|OS version, e.g. "Windows 7 x64 build 7600"
|}
 
===Fine Offset===
The following tags are specific to the Fine Offset series of PWS
 
{| class="wikitable" border="1"
|-
|-
|<#OsLanguage>
!style="width:150px" | webtag
|OS language, e.g. "English"
!style="width:600px" | Function
|-
|-
|<#SystemUpTime>
|colspan="2"|no new tags
|How long the system has been up, e.g. "8 hours 21 minutes"
|}
 
===System===
 
Special tags returning information about the system hosting Cumulus:
 
{| class="wikitable" border="1"
|-
|-
|<#ProgramUpTime>
!style="width:150px" | webtag
|How long Cumulus has been running, e.g. "7 hours 55 minutes"
!style="width:600px" | Function
|-
|-
|<#CpuName>
|colspan="2"|no new tags
|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"
|}
|}


Line 734: 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>

Latest revision as of 11:37, 10 February 2019

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: 

<#tagname>

Assuming you have asked Cumulus to process the file, it will replace the tag with the current value of the item the tag represents just before the file is uploaded to the internet.

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.

Time and Date Format Code Changes

The table below details the differences in the time/date format codes between Cumulus v1 and Cumulus MX 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

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

Cumulus v1 Code Description 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
mmmm Month as a full name (January-December) using Windows Locale. MMMM
yy Year as a two-digit number (00-99). Same
yyyy Year as a four-digit number (0000-9999). Same
h Hour without a leading zero (0-23). h for 12-hour clock (1-12), H for 24-hour clock (0-23)
hh Hour with a leading zero (00-23). hh for 12-hour clock (1-12), HH for 24-hour clock (0-23)
n Minute without a leading zero (0-59). m
nn Minute with a leading zero (00-59). mm
s Second without a leading zero (0-59). Same
ss Second with a leading zero (00-59). Same
z Millisecond without a leading zero (0-999). No equivalent
zzz Millisecond with a leading zero (000-999). f (tenths), ff (hundredths), fff (ms) etc.
t Date in Windows Short Time format. Same
tt\ Date in Windows Long Time format. T
am/pm am/pm specifier can use lower, upper, or mixed case tt (Windows am/pm format)
a/p The a/p specifier can use lower, upper, or mixed case. t (Windows a/p format)
ampm Windows AM or PM string. tt
/ Date separator character given by the Windows Date Separator. Same
: Time separator character given by the Windows Time Separator. Same
'xx' Characters enclosed in single quotation marks are displayed as such, and do not affect formatting. Same

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

webtag Function
no new tags

Date & Time

webtag Function
no new tags

Current Conditions

webtag Function
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

Today

webtag Function Time
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

Yesterday

webtag Function Time
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

Monthly

webtag Function Time Date
Temperature & Humidity
no new tags
Pressure
no new tags
Wind
no new tags
Rainfall
no new tags
Miscellaneous
no new tags

Yearly

webtag Function Time Date
Temperature & Humidity
no new tags
Pressure
no new tags
Wind
no new tags
Rainfall
no new tags
Miscellaneous
no new tags

All Time

webtag Function Time
Temperature & Humidity
no new tags
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags
Miscellaneous
no new tags

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.

webtag Function
no new tags

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>


webtag Function Date/Time
Temperature & Humidity
no new tags
Pressure
no new tags
Rainfall
no new tags
Miscellaneous
no new tags

Miscellaneous

webtag Function
no new tags

Day/Night/Sun/Moon

These are updated each hour (b3047 or later = every 10 minutes) to refer to current time-zone

webtag Function
<#MoonAge> Current approximate age of the Moon in days (0-29)

b3047 adds the 'dp' and 'rc' parameters 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.

<#MoonPercent> Current percentage of moon visible (negative value indicates 'waning')

b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above

<#MoonPercentAbs> Current percentage of moon visible (always positive)

b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above

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

webtag Function
no new tags

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

webtag Function
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.

Extra Sensors

These webtags are for additional sensors supported by Cumulus

webtag Function
no new tags

Special

OS WMR Series

There are a set of tags for the WMR928, WR100/200 extra sensors:

webtag Function
no new tags

WMR928

There are a set of tags for the WMR928 extra sensors:

webtag Function
no new tags

Davis

There are a set of tags for the Davis PWS:

webtag Function
no new tags

Fine Offset

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

webtag Function
no new tags

System

Special tags returning information about the system hosting Cumulus:

webtag Function
no new tags


No Commas

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/index.php?title=BETA_webtags&oldid=4516"