Webtags (preserving history): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Webtags (preserving history) (view source)

Revision as of 20:13, 16 February 2020

7,309 bytes added ,  20:13, 16 February 2020
m
→‎Yearly: match what done in month tags
m (→‎System: added note - apply to Cumulus 1.x.x)
m (→‎Yearly: match what done in month tags)
(48 intermediate revisions by 3 users not shown)
Line 16: Line 16:


=== Using web tags in scripts ===
=== Using web tags in scripts ===
*You can also use the tags within script, either embedded in HTML, or in external files, to transfer the values represented by the tags to the server for further processing.
[[File:badge v1.png]]The web page references appearing below apply to Cumulus 1, not Cumulus MX.
*You can also use the tags within script, this might be a PHP script, or JavaScript either embedded in HTML, or in external files, to transfer the values represented by the tags to the server for further processing.
*As JavaScript can not understand a real number that has the integer and decimal parts separated by a comma, but your computer may be set to use that representation in standard tags, there are special versions of many tags to use in script - see [[#No_Commas|tags with commas removed]] section.
*As JavaScript can not understand a real number that has the integer and decimal parts separated by a comma, but your computer may be set to use that representation in standard tags, there are special versions of many tags to use in script - see [[#No_Commas|tags with commas removed]] section.
*Note that if a script contains any Cumulus web tags then you must [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|ask Cumulus to process]] the script file.
*Note that if a PHP or Javascript file contains any Cumulus web tags then you must [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|ask Cumulus to process]] the script file.
*The whole script can be embedded in a template that is already being processed into HTML. (This technique has been used  in the standard 'monthlyrecordT.htm' template).
*JavaScript processing code can be embedded in a template that is already being processed into HTML. (This technique has been used  in the standard 'monthlyrecordT.htm' template).
*Alternatively embed a bit of script in HTML that is already been processed to convert the tags to a collection of string variables and use those variable names in any external script called from the HTML file. (This technique has been used in the standard 'gaugesT.htm' template).
*Alternatively embed a bit of JavaScript assignment code in HTML, that is already been processed, to convert the tags to a collection of string variables and use those variable names in any external script called from the HTML file. (This technique has been used in the standard 'gaugesT.htm' template).
*Finally, remember that to use the value from a tag as an integer you need to use a  
*To use the value from a tag as an integer in JavaScript assigning code you need to use a  
<pre>integer_variable_name=parseInt(string_variable_name,10)</pre> type conversion (or apply '*1', i.e. multiply by one, to implicitly convert the tag from string to base 10 number).
<pre>integer_variable_name=parseInt(string_variable_name,10)</pre> type conversion
*Alternatively, in most script languages, apply '*1', i.e. multiply by one, to implicitly convert the tag from string to base 10 number.


=== Differences for Webtags in MX builds ===
=== Differences for Webtags in MX builds ===
[[File:Badge vMx.png]] The web tags listed below are those available in the latest official (finalised version) release of Cumulus 1.9.x. However, Cumulus MX provides equivalent tags, with only minor differences.


The web tags listed below are those available in the latest official (finalised version) release of Cumulus 1.9.x. However, Cumulus MX provides equivalent tags, with only minor differences.
One difference is that Alarm tags are not yet in use.


=== Beta Builds of Cumulus 1 ===
=== Beta Builds of Cumulus ===


New webtags for beta builds of Cumulus are not listed here until the version becomes 'live', however there is a page that details the [[BETA webtags|additional webtags]] available in any Cumulus 1 Beta version that is currently under development.
There is a page that details the [[BETA webtags|additional webtags]] available in any Cumulus Beta version that is currently under development.


=Time/Date 'format' Parameter=
=Time/Date 'format' Parameter=
Line 56: Line 59:
*Cumulus MX uses the .NET date and time format characters that are not exactly the same as the Delphi ones that Cumulus 1 uses.  For Cumulus MX see [http://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx this Microsoft site] for format selectors. The differences come about because Delphi is case-insensitive, and .Net is case sensitive, so .Net can use upper and lower case for different items, where Delphi has to use different letters.  
*Cumulus MX uses the .NET date and time format characters that are not exactly the same as the Delphi ones that Cumulus 1 uses.  For Cumulus MX see [http://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx this Microsoft site] for format selectors. The differences come about because Delphi is case-insensitive, and .Net is case sensitive, so .Net can use upper and lower case for different items, where Delphi has to use different letters.  
*#For example, in Delphi, "nn" means "minutes" for Cumulus 1, but "minutes" is "mm" for .Net in Cumulus MX.
*#For example, in Delphi, "nn" means "minutes" for Cumulus 1, but "minutes" is "mm" for .Net in Cumulus MX.
*# e.g. the hour in 24-hour format, is "hh" in Delphi (Cumulus 1) and in .Net it's "HH" (Cumulus MX).
*# e.g. the hour in 24-hour format, is "hh" (although 'HH' would be treated same) in Delphi (Cumulus 1) and in .Net it must be "HH" (Cumulus MX).
 
*You might be put off by references for .Net (Cumulus MX) to single/standard characters and custom modifiers:
*The other change with the "format" parameter is the different way that .Net escapes characters that are not being used as format specifiers. In Delphi you put the 'verbatim' characters inside single quotes (Cumulus 1); in .Net you escape each verbatim character with backslashes (Cumulus MX).  
*#For example ''<#MonthTempHD format="d">'' is a single character format modifier, therefore the 'd' acts as a standard modifier, and causes a date of 22 July 2014 for the highest temperature in the month to be returned in the standard short date format e.g. '22/07/2014' (exact contents for any one date vary by locale).
For full details see [http://sandaysoft.com/forum/viewtopic.php?f=27&t=12908 Cumulus MX forum], the following table is abridged.
*#Similarly ''<#MonthTempHD format="M">'' is a single character format modifier and therefore the 'M' acts as a standard modifier and causes the date for the highest temperature in the month to be returned in the standard day and month format e.g. '22 July' (exact contents for any one date vary by locale).
*#Whilst ''<#metdate format="d M">'' is not a single character format modifier and therefore both the 'd' and the 'M' are interpreted as custom modifiers and cause the current date to be returned as a digit(s) for the day and a digit(s) month (in a without leading zeroes format) e.g. '6 7' would be returned for 6 July.
*The other change with the "format" parameter is the different way that .Net escapes characters that are not being used as format specifiers. In Delphi you can put the 'verbatim' characters inside single quotes (Cumulus 1); in .Net you can still use single quotes, but alternatively you can escape each verbatim character with a backslash as prefix (Cumulus MX).  
For official full details see [https://cumulus.hosiene.co.uk/viewtopic.php?f=27&t=12908 Cumulus MX forum], the following table is revised for simplicity. (I've abridged the table here and included '%' where necessary to avoid single character versus custom complications).


== List of allowed modifiers ==
== List of allowed modifiers ==
 
Note for Cumulus 1 - where lower (or upper, for easier comparison with MX) case shown, because Delphi is case insensitive, upper (or lower) case (in some cases, indicated by use of italics in brackets) could be used instead (exceptions: a/p, ampm, am/pm, Am/Pm, AM/PM, A/P, AMPM etc display as input)
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 71: Line 77:
|c
|c
|G
|G
|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 in Cumulus 1 if the date-time value indicates midnight precisely.
|Displays the date using the format given by the Short Date format, followed by the time using the format given by the Long Time format. The time is not displayed in Cumulus 1 if the date-time value indicates midnight precisely.
|-
|-
|d
|d
|d (with other modifiers)
|%d
|Displays the day as a number without a leading zero (1-31).
|Displays the day as a number without a leading zero (1-31). Note that Cumulus MX requires a ' ' (space), '%' or other modifier to be included, as 'd' on its own returns full 'short date').
|-
|-
|dd
|dd
Line 83: Line 89:
|ddd
|ddd
|ddd
|ddd
|Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Windows Locale.
|Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Locale.
|-
|-
|dddd
|dddd
|dddd
|dddd
|Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Windows Locale.
|Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Locale.
|-
|-
|ddddd
|ddddd
|d (as single character format)
|d (as single character format)
|Displays the date using the format given by the Windows Short Date format.
|Displays the date using the format given by the Short Date format.
|-
|-
|dddddd
|dddddd
|D
|D
|Displays the date using the format given by the Windows Long Date format.
|Displays the date using the format given by the Long Date format.
|-
|-
|m
|m
|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.
|Displays the month as a number without a leading zero (1-12).  
*Cumulus 1.x.y:If the 'm' specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
*Cumulus MX: Note that including a ' ' (space) or '%' before the M makes it a custom modifier e.g. '7' is returned for July as any initial zero is suppressed. ('M' on its own returns both Month and Day according to local format e.g. 22 July).
|-
|-
|mm
|MM (or ''mm'')
|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.
|Displays the month as a number with a leading zero (01-12).  
*Cumulus 1.x.y:If the 'm' specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
|-
|-
|mmm
|MMM (or ''mmm'')
|MMM
|MMM
|Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Windows Locale.
|Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Locale.
|-
|-
|mmmm
|MMMM (or ''mmmm'')
|MMMM
|MMMM
|Displays the month as a full name (January-December) using the strings appropriate to the Windows Locale.
|Displays the month as a full name (January-December) using the strings appropriate to the Locale.
|-
|-
|yy
|yy
Line 121: Line 130:
|Displays the year as a four-digit number (0000-9999).
|Displays the year as a four-digit number (0000-9999).
|-
|-
|(not available)
|('''h''' in combination with ''am/pm'')
|h
|h
|Displays the hour (12 hour clock) without a leading zero (1-12).
|Displays the hour (12 hour clock) without a leading zero (1-12).
Line 129: Line 138:
|Displays the hour using 24 hour clock without a leading zero (0-23).
|Displays the hour using 24 hour clock without a leading zero (0-23).
|-
|-
|(not available)
|('''hh''' in combination with ''am/pm'')
|hh
|hh
|Displays the hour (12 hour clock) with a leading zero (01-12).
|Displays the hour (12 hour clock) with a leading zero (01-12).
|-
|-
|hh
|HH (or ''hh'')
|HH
|HH
|Displays the hour using 24 hour clock with a leading zero (00-23).
|Displays the hour using 24 hour clock with a leading zero (00-23).
Line 154: Line 163:
|-
|-
|z
|z
|(not available)
|FFF
|Displays the millisecond without a leading zero (0-999).
|Displays the millisecond without a leading zero (Cumulus 1:0-999, Cumulus MX: nothing, or 1-999). Note that the system clock in some versions of Windows only has precision to 15 ms.  
|-
|-
|(not available)
|(not available)
Line 163: Line 172:
|zzz
|zzz
|fff
|fff
|Displays the millisecond with a leading zero (000-999).
|Displays the millisecond with a leading zero (000-999). Note that the system clock in some versions of Windows only has precision to 15 ms, so requesting thousandths of a second may not return anything useful. The 'fff' modifier can actually be extended to 'ffffff' for a millionth of a second!
|-
|-
|t
|t
Line 175: Line 184:
|am/pm
|am/pm
|tt
|tt
|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.
|Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour from midnight until before noon, and 'pm' for any hour from noon onwards.
 
The am/pm specifier for Cumulus 1 can use lower, upper, or mixed case, and the result is displayed accordingly.
|-
|-
|a/p
|a/p
|t
|t
|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.
|Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour from midnight until before noon, and 'p' for noon or any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
|-
|-
|ampm
|ampm
|
|(see above for 12 hour formats)
|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.
|Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the Windows AM string for midnight until any hour before noon, and the contents of the Windows PM string for noon or any hour after noon before midnight.
|-
|-
|/
|/
|/
|/
|Displays the date separator character given by the Windows Date Separator.
|Displays the date separator character given by the Date Separator.
|-
|-
|:
|:
|:
|:
|Displays the time separator character given by the Windows Time Separator.  
|Displays the time separator character given by the Time Separator.  
|-
|-
|'xx'
|'xy'
|'xx'
|'xy' or \x\y
|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. In MX each character to be displayed as it was typed can be prefixed by a backslash.
|}
|}


Line 302: Line 313:
|<#DaysSince30Dec1899>  
|<#DaysSince30Dec1899>  
|Day count (gives whole and fractional part) Example: 41250.6523310301
|Day count (gives whole and fractional part) Example: 41250.6523310301
|-
|<#recordsbegandate>
|Date when records began (appears twice on "recordsT.htm" provided, and used to calculate next tag, but ignored for all other Cumulus processing)
|-
|-
|<#DaysSinceRecordsBegan>
|<#DaysSinceRecordsBegan>
Line 359: Line 373:
|-
|-
|<#IsFreezing>
|<#IsFreezing>
|Is outside temperature is at or below 0°C/32°F. 0=Above freezing, 1=Below freezing
|If outside temperature is at or below 0°C/32°F. 0=Above freezing, 1=Below freezing
|-
|-
|colspan="2" style="background:lightgray;"|Rainfall
|colspan="2" style="background:lightgray;"|Rainfall
Line 620: Line 634:
|<#ET>
|<#ET>
|Today's [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration]. Applies only to Davis stations, equipped with a solar sensor.
|Today's [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration]. Applies only to Davis stations, equipped with a solar sensor.
"The ET value provided to Cumulus by the console and/or DLL is buggy and unreliable. It often shows a negative value. See [[FAQ#It.27s_January_1st_and_my_.27rain_since_midnight.27_and.2For_.27last_24_hours_rain.27_and.2For_Evapotranspiration_are_wrong.2Fnegative|this FAQ]]."
|N/A
|N/A
|-
|-
Line 784: Line 799:


==Monthly==
==Monthly==
 
NB This table shows time for some daily figures (highest minimum/lowest maximum temperatures are actually associated with a particular time although this is not a standard web tag), by including Cumulus 1.9.y time modifiers, these are not valid in Cumulus MX.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 855: Line 870:
|-
|-
|<#MonthHumH>
|<#MonthHumH>
|This months highest humidty
|This months highest humidity
|<#MonthHumHT>
|<#MonthHumHT>
|<#MonthHumHD>
|<#MonthHumHD>
|-
|-
|<#MonthHumL>
|<#MonthHumL>
|This months lowest humidty
|This months lowest humidity
|<#MonthHumLT>
|<#MonthHumLT>
|<#MonthHumLD>
|<#MonthHumLD>
Line 927: Line 942:


==Yearly==
==Yearly==
NB Year runs from roll-over time on 1 January


(Except for <#ryear> where start date can be another month)
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 989: Line 1,006:
|<#YearMinTempH>
|<#YearMinTempH>
|This years highest daily minimum temperature
|This years highest daily minimum temperature
|n/a
|<#YearMinTempHD format=HH:MM>
|<#YearMinTempHD>
|<#YearMinTempHD>
|-
|-
|<#YearMaxTempL>
|<#YearMaxTempL>
|This years lowest daily maximum temperature
|This years lowest daily maximum temperature
|n/a
|<#YearMaxTempHD format=HH:MM>
|<#YearMaxTempLD>
|<#YearMaxTempLD>
|-
|-
|<#YearHumH>
|<#YearHumH>
|This years high humidty
|This years high humidity
|<#YearHumHT>
|<#YearHumHT>
|<#YearHumHD>
|<#YearHumHD>
|-
|-
|<#YearHumL>
|<#YearHumL>
|This years low humidty
|This years low humidity
|<#YearHumLT>
|<#YearHumLT>
|<#YearHumLD>
|<#YearHumLD>
Line 1,193: Line 1,210:
==Recent History==
==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.   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.
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.


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


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).
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).
Line 1,382: Line 1,399:
|-
|-
|<#LatestError>
|<#LatestError>
|Displays the last error from the Cumulus error log. The value is cleared when you click the error light in Cumulus.<br />
|Displays the last error from the Cumulus error log. (The value is cleared when you click the error light in Cumulus 1).<br />
Note: This tag displays ''all'' errors, even if they do not cause the error light to flash in Cumulus.
Note: This tag displays ''all'' errors, even if they do not cause the error light to flash in Cumulus 1.
|-
|-
|<#LatestErrorDate>
|<#LatestErrorDate>
Line 1,395: Line 1,412:
|-
|-
|<#version>
|<#version>
|The version of Cumulus in use
|The version of Cumulus in use e.g. '1.9.4'
|-
|-
|<#build>
|<#build>
|The build of Cumulus in use
|The build of Cumulus in use e.g. '10991'
|-
|-
|<#realtimeinterval>
|<#realtimeinterval>
|The realtime update interval in seconds  
|The realtime update interval in seconds (integer)
|-
|-
|<#interval>
|<#interval>
|The web site update interval in minutes
|The web site update interval in minutes (integer)
|-
|-
|<#rollovertime>
|<#rollovertime>
Line 1,416: Line 1,433:
|-
|-
|<#stationtype>
|<#stationtype>
|The weather station [http://wiki.sandaysoft.com/a/Cumulus.ini#Section:_Station model] description (you choose what text appears for this on 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
|The weather station [https://cumuluswiki.wxforum.net/a/Cumulus.ini#Section:_Station model] description (you choose what text appears for this on 'Display' settings screen within Configuration menu - the field is at the bottom left of that screen).
|-
|-
|<#latitude>
|<#latitude>
|The station [http://en.wikipedia.org/wiki/Latitude latitude].
|The station [http://en.wikipedia.org/wiki/Latitude latitude] (as you entered during setup).
Supports an optional 'dp' parameter, if supplied, instead of the usual web-encoded text format with degrees/minutes/seconds, the result is in decimal degrees to the specified number of decimal places. E.g<br />
Supports an optional 'dp' parameter, if supplied, instead of the usual web-encoded text format with degrees/minutes/seconds, the result is in decimal degrees to the specified number of decimal places. E.g<br />
<#latitude> gives "N&amp;nbsp;59& deg;&amp;nbsp;14&amp;#39;&amp;nbsp;33&amp;quot;" for N 59 14 33<br />
<#latitude> gives "N&nbsp;59& deg;&amp;nbsp;14&amp;#39;&amp;nbsp;33&amp;quot;" for N 59 14 33<br />
<#latitude dp=5> gives "59.24250"
<#latitude dp=5> gives "59.24250"


Line 1,427: Line 1,444:
|-
|-
|<#longitude>
|<#longitude>
|The station [http://en.wikipedia.org/wiki/Longitude longitude]. Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
|The station [http://en.wikipedia.org/wiki/Longitude longitude] (as you entered during setup). Supports an optional 'dp' and 'rc' parameters as per the latitude tag.
|-
|-
|<#altitude>
|<#altitude>
|The station [http://en.wikipedia.org/wiki/Altitude altitude]
|The station [http://en.wikipedia.org/wiki/Altitude altitude] value (webtag outputs web encoded format containing figure, '&amp;nbsp;' and units) in either feet or metres just as you entered during setup (so it is more complex to extract number for script arithmetric); e.g. '123&amp;nbsp;m'
|-
|-
|<#location>
|<#location>
|The station location
|The station location (as you entered during setup)
|-
|-
|<#longlocation>
|<#longlocation>
|Longer description of the station location
|Longer description of the station location (as you entered during setup)
|-
|-
|<#forum>
|<#forum>
Line 1,451: Line 1,468:
|-
|-
|<#snowdepth>
|<#snowdepth>
|Today's snow depth as entered manually in the Weather Diary. Normally in Centimeters.Output is purely as a numerical figure I.E 10
|Today's snow depth as entered manually in the Weather Diary (not available in Cumulus MX), see Cumulus 'Help'. Meteorologists express it in Centimeters, but Cumulus 1 does not care what units you use. Output is purely as a numerical integer (e.g. 10).
Configure in [[Cumulus.ini]] the hour when the snowdepth is updated e.g. ''SnowDepthHour=9'' means yesterday's figure applies until 9am.
Configure in [[Cumulus.ini]] the hour when the snowdepth is updated e.g. ''SnowDepthHour=9'' means yesterday's figure applies until 9am.
|-
|-
Line 1,458: Line 1,475:
|-
|-
|<#currcondenc>
|<#currcondenc>
|The same as <#currcond> but also has characters above code 159 encoded as HTML entities
|The same as <#currcond> but also has all characters above (decimal base)code 159 encoded as HTML entities
|-
|-
|<#chillhours>
|<#chillhours>
|The number of 'chill hours' so far this season.
|The number of [[Heat/cold_degree_days_and_Chill_hours#Chill_Hours_and.2For_Air_Frost|'chill hours']] so far this season (threshold temperature and start date are configurable).
|-
|-
|<#ConsecutiveRainDays>
|<#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
|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, meteorologists exclude dew (and other times when single tip of recorder).
|-
|-
|<#ConsecutiveDryDays>
|<#ConsecutiveDryDays>
Line 1,486: Line 1,503:


==Day/Night/Sun/Moon==
==Day/Night/Sun/Moon==
These are updated each hour to refer to current calendar day
These are updated each hour to refer to current time-zone
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,499: Line 1,516:
|-
|-
|<#daylength>
|<#daylength>
|Length of day in hours and minutes (sunrise to sunset) -  The third party library that Cumulus uses each midnight UTC, may take last sunrise from one day and next sunset from an adjacent day, so the calculation is off by a minute.
|Length of day in hours and minutes (sunrise to sunset) -  The third party library that Cumulus uses each midnight UTC, may take last sunrise from previous day and next sunset from next day, so the calculation may be off by a minute or so compared to true figure for current day.
|-
|-
|<#IsSunUp>
|<#IsSunUp>
|A flag to indicate if the Sun is above the horizon or not, based on the sunrise and sunset times. Possible values are 0 or 1, where 1 is when the Sun is above the horizon for the station location.
|A flag to indicate if the Sun is above the horizon or not, based on the sunrise and sunset times.
 
Possible values are 0 or 1, where 1 is when the Sun is above the horizon for the station location.
|-
|-
|<#dawn>
|<#dawn>
|Start of Civil Twilight at the station
|Start of last Civil Twilight at the station as at last midnight UTC
|-
|-
|<#dusk>
|<#dusk>
|End of Civil Twilight at the station
|End of next Civil Twilight at the station as at last midnight UTC
|-
|-
|<#daylightlength>
|<#daylightlength>
Line 1,514: Line 1,533:
|-
|-
|<#isdaylight>
|<#isdaylight>
|A flag to indicate if the location for the station is in civil daylight or not, based on the dawn and dusk times. Possible values are 0 or 1, where 1 notes that it is currently within the hours of daylight.
|A flag to indicate if the location for the station is in civil daylight or not, based on the dawn and dusk times.  
 
Possible values are 0 or 1, where 1 notes that it is currently within the hours of daylight.
 
|-
|-
|<#tomorrowdaylength>
|<#tomorrowdaylength>
|A string giving an approximate predicted difference between the length of daylight (dawn to dusk) today and tomorrow. This web tag is unreliable, and its use is not recommended. Its use is therefore not supported (i.e. you use it at your own risk).
|A string giving an approximate predicted difference between the length of daylight (dawn to dusk) yesterday and length of daylight tomorrow.
 
This web tag is unreliable, and its use is not recommended. Its use is therefore not supported (i.e. you use it at your own risk).
|-
|-
|<#moonphase>
|<#moonphase>
Line 1,523: Line 1,547:
|-
|-
|<#MoonAge>
|<#MoonAge>
|Current '''approximate''' age of the Moon in days (0-29)
|Current '''approximate''' age of the Moon in days (0-29.53)
 
MX 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.
|-
|-
|<#moonrise>
|<#moonrise>
Line 1,533: Line 1,560:
|<#MoonPercent>
|<#MoonPercent>
|Current percentage of moon visible (negative value indicates 'waning')
|Current percentage of moon visible (negative value indicates 'waning')
MX 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)
MX b3047 adds the 'dp' and 'rc' parameters as <#MoonAge> above
|-
|-
|<#SunshineHours>
|<#SunshineHours>
Line 1,552: Line 1,583:
==Alarms==
==Alarms==


There are a set of tags for the Cumulus alarm states. They give a value of '1' if an alarm parameter has been selected (Main Cumulus screen, Edit menu) and the alarm condition is still currently met; otherwise '0'.
[[File:badge v1.png]]There are a set of tags available in Cumulus 1 for various alarm states.  
 
They give a value of '1' if an alarm parameter has been selected (Main Cumulus screen, Edit menu) and the alarm condition is still currently met; otherwise '0'.
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,600: Line 1,633:
==Records==
==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'.
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).


'''Please remember these are for Cumulus 1.9.x, Cumulus MX only supports the first two.'''
'''Please remember these are for Cumulus 1.9.x, Cumulus MX works in a different way both in terms of how tags are set (see various topics in support forum) and how they are cleared (essentially the end of rollover clears records, so daily records are only shown for the few microseconds while rollover is being processed).'''
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,614: Line 1,647:
|Indicates when any tracked extreme is changed.
|Indicates when any tracked extreme is changed.
*In Cumulus 1.x.x: 1 if 'new record' light is flashing, 0 if not
*In Cumulus 1.x.x: 1 if 'new record' light is flashing, 0 if not
*In Cumulus MX: 1 for 24 hours from when new record set, 0 otherwise
*In Cumulus MX: 1 from when new record is set until next rollover is completed, 0 otherwise
|-
|-
|<#TempRecordSet>
|<#TempRecordSet>
Line 1,755: Line 1,788:
|Soil temperature 2
|Soil temperature 2
|-
|-
|colspan="2"|... and so on up to <#SoilTemp4>
|colspan="2"|... and so on up to <#SoilTemp16>
|-
|-
|<#SoilMoisture1>
|<#SoilMoisture1>
Line 1,763: Line 1,796:
|Soil moisture 2
|Soil moisture 2
|-
|-
|colspan="2"|... and so on up to <#SoilMoisture4>
|colspan="2"|... and so on up to <#SoilMoisture16>
|-
|-
|<#LeafTemp1>
|<#LeafTemp1>
Line 1,776: Line 1,809:
|<#LeafWetness2>
|<#LeafWetness2>
|Leaf wetness 2  
|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)
|}
|}


Line 1,794: Line 1,849:


===Davis===
===Davis===
Most of the following web tags are available in Cumulus MX from build 3019, Storm tags from 3021:


There are a set of tags for the Davis PWS, Cumulus updates the values of the reception tags every 15 minutes:
All (see note for THSWindex) of the following web tags for the Davis PWS are available in Cumulus 1.x.x; which updates the values of the reception tags every 15 minutes:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |webtag
!style="width:150px" |web tag
!style="width:120px" |Applicability
!style="width:600px" |Function
!style="width:600px" |Function
|-
|-
|<#DavisTotalPacketsReceived>
!<#DavisTotalPacketsReceived>
|1.x.x and MX
|Total number of data packets received
|Total number of data packets received
|-
|-
|<#DavisTotalPacketsMissed>
!<#DavisTotalPacketsMissed>
|1.x.x and MX
|Number of missed data packets
|Number of missed data packets
|-
|-
|<#DavisMaxInARow>
!<#DavisMaxInARow>
|1.x.x and MX
|Longest streak of consecutive packets received
|Longest streak of consecutive packets received
|-
|-
|<#DavisNumCRCerrors>
!<#DavisNumCRCerrors>
|1.x.x and MX
|Number of packets received with CRC errors
|Number of packets received with CRC errors
|-
|-
|<#DavisFirmwareVersion>
!<#DavisFirmwareVersion>
|1.x.x and MX
|The console firmware version
|The console firmware version
|-
|-
|<#DavisNumberOfResynchs>
!<#DavisNumberOfResynchs>
|1.x.x and MX
|Number of times the console resynchronised with the transmitter
|Number of times the console resynchronised with the transmitter
|-
|-
|<#THWindex>
!<#THWindex>
|A derived temperature using Temperature/Humidity/Wind values.
|1.9.x
|A derived temperature using Temperature/Humidity/Wind values read from Davis DLL in Cumulus 1.9.x.
*The THW Index uses humidity and temperature (like Heat Index), but includes the cooling effects of wind (like wind chill).
*The THW Index uses humidity and temperature (like Heat Index), but includes the cooling effects of wind (like wind chill).
*Available from 1.9.2 Build 1009 (Aug 2011).
*Available from 1.9.2 Build 1009 (Aug 2011).
|-
|-
|<#THSWindex>
!<#THSWindex>
|(1.9.x and) MX
|A heat stress indicator using Temperature/Humidity/Solar/Wind values.
|A heat stress indicator using Temperature/Humidity/Solar/Wind values.
*The THSW Index uses humidity and temperature (like the Heat Index), but also includes the heating effects of sunshine, and the cooling effects of wind.
*The THSW Index uses humidity and temperature (like the Heat Index), but also includes the heating effects of sunshine, and the cooling effects of wind.
Line 1,834: Line 1,899:
#Although this tag is available in Cumulus 1.9.x, there is an issue somewhere in the Davis code that prevents Cumulus 1 obtaining the value (so tag always displays zero).
#Although this tag is available in Cumulus 1.9.x, there is an issue somewhere in the Davis code that prevents Cumulus 1 obtaining the value (so tag always displays zero).
#Search the forum for several discussions about "THSW".
#Search the forum for several discussions about "THSW".
#Cumulus MX reads "LOOP2" packets, and the correct value for this tag can be read there.
#Cumulus MX reads "LOOP2" packets, and the correct value for this tag can be read there and displayed on 'Now' template.
|-
|-
|<#battery>
!<#battery>
|1.x.x and MX
|The console battery condition in volts. eg "4.82v"
|The console battery condition in volts. eg "4.82v"
|-
|-
|<#txbattery>
!<#txbattery>
<#txbattery channel=1>
<#txbattery channel=1>
|1.x.x and MX
|The transmitter battery condition, by default it returns the status of all transmitters.
|The transmitter battery condition, by default it returns the status of all transmitters.
The optional 'channel' parameter returns the status for a particular transmitter, up to channel=8. The channel result is just the string "ok" or "LOW" for a low battery
'''Cumulus 1.x.x Only:''' The optional 'channel' parameter returns the status for a particular transmitter, up to channel=8. The channel result is just the string "ok" or "LOW" for a low battery
|-
|-
|<#StormRain>
!<#StormRain>
|The console 'storm rain' current amount (build 1090 onwards)
|1.x.x and MX
|The console 'storm rain' current amount (build 1090 onwards for Cumulus 1; 3021 onwards for MX)
|-
|-
|<#StormRainStart>
!<#StormRainStart>
|1.x.x and MX
|The console reported '''date''' of the start of the 'storm' (the console does not report start time, but it appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTipISO> in a script might help), but standard Cumulus [[Webtags#Time.2FDate_.27format.27_Parameter| date/time formatting]] can be applied to that date.
|The console reported '''date''' of the start of the 'storm' (the console does not report start time, but it appears a minimum of 2 tips within 3 hours will trigger a storm start, so using <#LastRainTipISO> in a script might help), but standard Cumulus [[Webtags#Time.2FDate_.27format.27_Parameter| date/time formatting]] can be applied to that date.
|}
|}
Line 1,865: Line 1,934:
|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
|}
===Ecowitt GW1000===
There are a set of tags for the Ecowitt WiFi gateway GW1000:
{| class="wikitable" border="1"
|-
!style="width:150px" |webtag
!style="width:600px" |Function
|-
|<#GW1000FirmwareVersion>
|GW1000 firmware version string
|}
|}


Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/3784...4654"

Navigation menu