1,965
edits
Full list of Webtags: Difference between revisions
m
no edit summary
mNo edit summary |
|||
|
This page is the new ''Full list of Webtags'' page. This page
This page is Work in Progress until this message is deleted.
NOTE: Please note this section has NOT yet been updated for recent MX releases, it appears from [[cumulusmx.db|RecentData table in cumulusmx.db]] that the list here is not complete for MX. However, no release announcement has been found listing tag names not shown here (i.e. apparent temperature, indoor temperature and humidity, air quality)
=Today=
|<#IsSunny>
|Returns 1 if the sun is shining, otherwise 0 (Solar sensor needed)
|}
= System =
Special tags returning information about the device hosting CumulusMX
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:450px" |Applicability
|-
|<#OsVersion>
|OS version, e.g. "Windows 7 x64 build 7600"
|-
|<#OsLanguage>
|OS language, e.g. "English"
|-
|<#SystemUpTime>
|How long the system has been up, e.g. "8 hours 21 minutes"
|-
|<#ProgramUpTime>
|How long Cumulus has been running, e.g. "7 hours 55 minutes"
|-
|<#CpuCount>
|Number of processors, e.g. "4"
|-
|<#AllocatedMemory>
|Amount of memory allocated to Cumulus, e.g. "18.76 MB"
NOTE: produces 0.0
|-
|}
=Units=
No optional input nor output parameters.
{| class="wikitable" border="1"
|-
!style="width:150px" | Webtag name
!style="width:600px" | Function
|-
|<#tempunit>
|Unit of temperature being used (Set in Cumulus as [http://en.wikipedia.org/wiki/Centigrade Celsius] or [http://en.wikipedia.org/wiki/Fahrenheit Fahrenheit]) values "&deg;C" or "&deg;F"
|-
| <#tempunitnoenc>
|JavaScript encoded of previous web tag that is HTML encoded (i.e. without '''&''' and without '''°''')
|-
|<#tempunitnodeg>
|The temperature units being used, without a degree symbol, i.e. "F" or "C"
|-
|<#pressunit>
|Unit of measure for pressure. Possible values: "mb", "hPa", "in"
|-
|<#rainunit>
|Unit of measure for rain fall. Possible values: "mm" or "inches"
|-
|<#windunit>
|Unit of measure for wind speed. Possible values: "m/s", "mph", "km/h", "kts"
|-
|<#windrununit>
|Unit of measure for wind run (distance). Possible values: "km", "miles", "km", "nm" (for wind speeds in m/s, mph, km/h, kts)
|-
|<#cloudbaseunit>
|The units used for cloudbase value. Possible values: "ft" or "m"
|}
=Date & Time=
The default format depends on the locale you use to run Cumulus.
When format is fixed it is noted.
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:600px" | Function
|-
|<#date>
|The current date.
|-
|<#metdate>
|The current meteorological date.
*If you use midnight rollover, this returns same date as <#date> (above), but with a different default format.
*If using a 9am/10am rollover:
**After rollover time on current calendar date, this is same as <#date>, but with a different default format.
**Between midnight and 9am/10am the <#metdate> will return the date associated with previous calendar day, but will still return current time
|-
|<#timeUTC>
|The current UTC date/time rather than local date/time. Example result: 18:30 on 30 December 2009. If you want the local date and time, use next tag (below).
|-
|<#time>
|The current time and date. Example result: 18:30 on 30 December 2009. If you simply wish the time, use next tag (below).
|-
|<#timehhmmss>
|The current time (without date). Example format: 18:30:27. You can use output format specifiers to change the way the time is output, but any date specifiers are ignored.
|-
|<#minute>
|The current time, just the minutes. Fixed format: 07 (cannot use output format modifiers)
|-
|<#hour>
|The current time, just the hour. Fixed format: 07 (cannot use output format modifiers)
|-
|<#day>
| The current day as a 2-digit number. Fixed format: 07 (cannot use output format modifiers)
|-
|<#dayname>
| The current day as a word. For example, Monday
|-
|<#shortdayname>
| The current day as a shortened word. Example format: Mon
|-
|<#month>
|The current month as a 2-digit number. Fixed format: 07 (cannot use output format modifiers)
|-
|<#monthname>
|The current month as a word. Example format: July
|-
|<#shortmonthname>
|The current month as a shortened word. Example format: Jul
|-
|<#year>
|The current year as a 4-digit number. Example format: 2009 (cannot use output format modifiers)
|-
|<#shortyear>
|The current year as a 2-digit number. Example format: 09 (cannot use output format modifiers)
|-
|<#rollovertime>
|The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
|-
|<#metdateyesterday>
|The previous meteorological date. The default format depends on the locale you use to run Cumulus
*If you use midnight rollover, this returns same date as <#date>, but with a different default format.
*If using a 9am/10am rollover:
**After rollover time on current calendar date, this is same as <#yesterday> (below), but with a different default format.
**Between midnight and 9am/10am the date output by <#metdateyesterday> will be the calendar day before that returned by <#yesterday>, but the time returned is actual local time.
|-
|<#yesterday>
|Yesterday's date.
|-
|<#update>
|The date and time of the last web site update.
|-
|<#timeJavaScript>
| The JavaScript '''Date''' object contains the number of milliseconds since 00:00:00.000 UTC on 1st January 1970, that date and time is known as the UNIX Epoch. In JavaScript, you can use <code>Math.floor(new Date().getTime()/1000.0)</code> This getTime method returns the time in milliseconds. The web tag returns an integer (currently with 13 digits) representing the number of milliseconds since the UNIX epoch when the web tag was processed. It can be used in a script where you wish to re-express other times output by Cumulus MX into UTC (Coordinated Universal Time). Mac OS X uses 00:00:00.000 UTC on 1st January 2001 as the starting time and date for its millisecond count, so that is considerably lower.
Note that UTC is calculated using 9192631770 times a particular transition time for Caesium 133 as a basis for 1 second. GMT (Greenwich Mean Time) is calculated on the basis that 1 second is 1/86400 of the time taken for a whole (day) rotation of the Earth. UT1 (or solar time) is calculated from various space measurements. Periodically, leap seconds are added to UTC to realign it with UT1, but these leap seconds are not added to the count of milliseconds represented by this web tag.
Do be aware that some devices will use a 32 bit signed integer to represent this number, and that will stop working on 19 January 2038, the year 2038 problem for computing world.
|-
|<#timeUnix>
| Unix tracks the number of seconds since the UNIX epoch. So this web tag can be used when you do not want the millisecond accuracy of the previous web tag. Like previous web tag this relates to UTC, so see details for that tag to find out more.
|-
|<#LastDataReadT>
|The date/time data was last read from the station.
|-
|<#DaysSince30Dec1899>
|Day count (gives whole and fractional part) Example: 41250.6523310301
|-
|<#recordsbegandate>
|Date when records began.
|-
|<#DaysSinceRecordsBegan>
|Day count since Cumulus records started
|}
|}
= Miscellaneous =
All tags are available in all flavours, as far as I know, although ''their output might vary'', and which input/output parameters they permit might vary between Cumulus 1 and MX.
{| class="wikitable" border="1"
|-
!style="width:150px" |Web tag_name
!style="width:900px" | Function
|-
|<#LatestError>
| This tag and the next 3 are in CumulusMX, none of them are actually used.
|-
|<#LatestErrorDate>
|See previous tag
|-
|<#LatestErrorTime>
|See previous tag
|-
|<#ErrorLight>
|1 if the 'error' light is flashing, 0 if not
|-
|<#version>
|The version of Cumulus in use
|-
|<#build>
|The build of Cumulus in use
|-
|<#NewBuildAvailable>
|This gets the value 0 or 1 and is checked on start-up and once a day thereafter at a random time
|-
|<#NewBuildNumber>
|It is checked on start-up and once a day thereafter at a random time. Displays the latest public release build number - eg. b3089
|-
|<#realtimeinterval>
|The real time update interval in seconds (integer)
|-
|<#interval>
|The web site update interval in minutes (integer)
|-
|<#rollovertime>
|The time that the logs rollover to the next day: will always return one of these: 'Midnight', '9 am' or '10 am'
This is the end of the meteorological day, so if during Daylight Saving Time rolover is at "10 am", then on the day DST ends it will return to "9 am" ensuring every meteorological day is exactly 24 hours long. If the time is "Midnight" (or during DST it is "9 am"), then days will be 23 or 25 hours long just on day clocks change, 24 hours otherwise.
|-
|<#update>
|The date and time of the last web site update.
|-
|<#LastDataReadT>
|The date/time data was last read from the station.
|-
|<#stationtype>
|The weather station [https://cumuluswiki.org/a/Cumulus.ini#Section:_Station model] description.
|-
|<#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 />
<#latitude> gives "N 59& deg;&nbsp;14&#39;&nbsp;33&quot;" for N 59 14 33<br />
<#latitude dp=5> gives "59.24250"
If the "dp" parameter is supplied, then supplying "rc=y" in addition will cause any decimal comma to be converted to a decimal point.
|-
| <#latitudeJsEnc>
|JavaScript encoded of previous web tag that is HTML encoded
|-
|<#longitude>
|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.
|-
| <#longitudeJsEnc>
|JavaScript encoded of previous web tag that is HTML encoded
|-
|<#altitude>
|The station [http://en.wikipedia.org/wiki/Altitude altitude] value (web tag outputs web encoded format containing figure, '&nbsp;' and units) in either feet or metres just as you entered during setup e.g. '123&nbsp;m'
|-
| <#altitudenoenc>
|JavaScript encoded of previous web tag that is HTML encoded
|-
|<#location>
|The station location (as you entered during setup)
|-
| <#locationJsEnc>
|JavaScript encoded of previous web tag that is plain text
|-
| <#locationenc>
|HTML encoded version of previous web tag that is JavaScript encoded
|-
|<#longlocation>
|Longer description of the station location (as you entered during setup)
|-
| <#longlocationJsEnc>
|JavaScript encoded of previous web tag that is plain text
|-
| <#longlocationenc>
|HTML encoded version of previous web tag that is JavaScript encoded
|-
|<#forum>
|URL of the forum (as you entered during setup) encoded into a web page menu item by adding colons
|-
| <#forumurl>
|Same as previous, but just URL, without any additional colons
|-
|<#webcam>
|URL of the webcam (as you entered during setup) encoded into a web page menu item by adding colons. Default is blank. Can be used to link to any other web page that you host (Cumulus does not verify that it is a web cam, that is just a label, and the label can be changed on each standard web page individually)
|-
| <#webcamurl>
|Same as previous, but just URL, without any additional colons
|-
|<#graphperiod>
|The number of hours displayed by the graphs, as set using '''Configuration''' menu, ''Display'' settings screen 'Detailed Chart Period'
|-
|<#dailygraphperiod>
|The number of days displayed by the graphs, as set using '''Configuration''' menu, ''Display'' settings screen 'Daily Chart Period'
|-
|<#LatestNOAAMonthlyReport>
|Gives file name of latest auto-saved NOAA monthly report
|-
|<#LatestNOAAYearlyReport>
|Gives file name of latest auto-saved NOAA yearly report
|-
| <#Option_useApparent>
| Whether user prefers to see Apparent Temperature or Feels Like Temperature
|-
| <#Option_showSolar>
| Whether user wants to show Solar data or does not not have a solar sensor
|-
| <#Option_showUV>
| Whether user wants to show Ultra Violet data or does not not have a UV sensor
|}
=Special tags=
==Davis==
| |||