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

5,237 bytes added ,  11:37, 10 February 2019
→‎Day/Night/Sun/Moon
 
(60 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Additional webtags available in the BETA version of Cumulus 1.9.2 ==
== 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 10: Line 11:


Also note that web tags are case sensitive, use them exactly as they appear here.
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
{| class="wikitable" border="1"
|-
!style="width:75px" | Cumulus v1 Code
!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
|-
|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=
=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'
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 21: Line 162:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#timeUTC>
|colspan="2"|no new tags
|The current UTC date/time rather than local date/time
|}
|}


Line 34: Line 174:
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|-
|-
|<#wetbulb>
|colspan="2"|no new tags
|Estimated [http://en.wikipedia.org/wiki/Wet_bulb wet bulb] temperature, currently only available via web tag
|-
|-
|colspan="2" style="background:lightgray;"|Rainfall
|colspan="2" style="background:lightgray;"|Rainfall
Line 51: Line 190:
|colspan="2" style="background:lightgray;"|Miscellaneous
|colspan="2" style="background:lightgray;"|Miscellaneous
|-
|-
|<#cloudbasevalue>
|colspan="2"|no new tags
|Current calculated cloud base without units
|-
|<#cumulusforecast>
|Always gives Cumulus (Zambretti) forecast, even if the <#forecast> tag provides a station forecast
|-
|<#wsforecast>
|Always gives station forecast (if available)
|-
|<#Light>
|Fine Offset Only - Lux value
|}
|}


Line 86: Line 215:
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|<#domwindbearing>
|colspan="3"|no new tags
|Today's dominant wind direction in degrees
|n/a
|-
|<#domwinddir>
|Today's dominant wind direction as compass point
|n/a
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|<#heatdegdays>
|colspan="3"|no new tags
|Today's heating degree days
|n/a
|-
|<#cooldegdays>
|Today's cooling degree days
|n/a
|}
|}


Line 127: Line 244:
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|<#domwindbearingY>
|colspan="2"|no new tags
|Yesterday's dominant wind direction in degrees
|n/a
|-
|<#domwinddirY>
|Yesterday's dominant wind direction as compass point
|n/a
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|<#heatdegdaysY>
|colspan="3"|no new tags
|Yesterday's heating degree days
|n/a
|-
|<#cooldegdaysY>
|Yesterday's cooling degree days
|n/a
|}
|}


Line 165: Line 270:
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#MonthWindRunH>
|colspan="4"|no new tags
|High Daily Wind Run
|n/a
|<#MonthWindRunHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
|-
|colspan="4"|no new tags
|-
|colspan="4" style="background:lightgray;"|Miscellaneous
|-
|-
|colspan="4"|no new tags
|colspan="4"|no new tags
Line 194: Line 300:
|colspan="4" style="background:lightgray;"|Wind
|colspan="4" style="background:lightgray;"|Wind
|-
|-
|<#YearWindRunH>
|colspan="4"|no new tags
|High Daily Wind Run
|N/A
|<#YearWindRunHD>
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
Line 205: Line 308:
|colspan="4" style="background:lightgray;"|Miscellaneous
|colspan="4" style="background:lightgray;"|Miscellaneous
|-
|-
|<#YearLongestDryPeriod>
|colspan="4"|no new tags
|Longest period without rain (days)
|N/A
|<#YearLongestDryPeriodD>
|-
|<#YearLongestWetPeriod>
|Longest period of rain every day (days)
|N/A
|<#YearLongestWetPeriodD>
|}
|}


Line 238: Line 333:
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|<#windrunH>
|colspan="3"|no new tags
|All time high daily wind run
|<#TwindrunH>
|-
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|-
|<#LongestDryPeriod>
|colspan="3"|no new tags
|All time longest dry period (days)
|}
|<#TLongestDryPeriod>
 
==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"
|-
|-
|<#LongestWetPeriod>
!style="width:150px" | webtag
|All time longest wet period (days)
!style="width:600px" | Function
|<#TLongestWetPeriod>
|-
|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" style="background:lightgray;"|Pressure
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Rainfall
|-
|colspan="3"|no new tags
|-
|colspan="3" style="background:lightgray;"|Miscellaneous
|-
|colspan="3"|no new tags
|}
|}


Line 260: Line 391:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#chillhours>
|colspan="2"|no new tags
|The number of 'chill hours' so far this season.
|-
|<#ConsecutiveRainDays>
|The number of days up to (but not including) today where it has rained every day. The threshold amount of rain required to determine a rain day is configurable via the RainDayThreshold setting in cumulus.ini, the units for the threshold are the same as your rain units
|-
|<#ConsecutiveDryDays>
|The number of days up to (but not including) today since it last rained. The threshold amount of rain required to determine a rain day is configurable via the RainDayThreshold setting in cumulus.ini the units for the threshold are the same as your rain units
|}
|}


==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 277: Line 401:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|colspan="2"|no new tags
|<#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
|}
|}


Line 288: Line 427:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|colspan="2" |No new alarms
|colspan="2"|no new tags
|}
|}


Line 299: Line 438:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|<#HighWindrunRecordSet>
|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 all time high wind run is currently flashing, 0 if not
|}
 
==Extra Sensors==
 
These webtags are for additional sensors supported by Cumulus
 
{| class="wikitable" border="1"
|-
!style="width:150px"|webtag
!style="width:600px"|Function
|-
|colspan="2"|no new tags
|}
|}


==Special==
==Special==
===OS WMR Series===
There are a set of tags for the WMR928, WR100/200 extra sensors:
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2"|no new tags
|}


===WMR928===
===WMR928===


There are a set of tags for the WMR928 extra sensors:
There are a set of tags for the WMR928 extra sensors:
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2"|no new tags
|}
===Davis===
There are a set of tags for the Davis PWS:
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2"|no new tags
|}
===Fine Offset===
The following tags are specific to the Fine Offset series of PWS


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 333: 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/1612...4516"

Navigation menu