BETA webtags

From Cumulus Wiki
Revision as of 10:35, 25 February 2011 by Mcrossley (talk | contribs) (→‎Monthly)
Jump to navigationJump to search

Additional webtags available in the BETA version of Cumulus 1.9.1

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!

Time/Date 'format' Parameter

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.

Specifier Displays
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.
d Displays the day as a number without a leading zero (1-31).
dd Displays the day as a number with a leading zero (01-31).
ddd Displays the day as an abbreviation (Sun-Sat) using the strings appropriate to the Windows Locale.
dddd Displays the day as a full name (Sunday-Saturday) using the strings appropriate to the Windows Locale.
ddddd Displays the date using the format given by the Windows Short Date format.
dddddd Displays the date using the format given by the Windows Long Date format.
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.
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.
mmm Displays the month as an abbreviation (Jan-Dec) using the strings appropriate to the Windows Locale.
mmmm Displays the month as a full name (January-December) using the strings appropriate to the Windows Locale.
yy Displays the year as a two-digit number (00-99).
yyyy Displays the year as a four-digit number (0000-9999).
h Displays the hour without a leading zero (0-23).
hh Displays the hour with a leading zero (00-23).
n Displays the minute without a leading zero (0-59).
nn Displays the minute with a leading zero (00-59).
s Displays the second without a leading zero (0-59).
ss Displays the second with a leading zero (00-59).
z Displays the millisecond without a leading zero (0-999).
zzz Displays the millisecond with a leading zero (000-999).
t Displays the time using the format given by the Windows Short Time format.
tt\ Displays the time using the format given by the Windows Long Time format.
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.
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.
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.
/ Displays the date separator character given by the Windows Date Separator.
: Displays the time separator character given by the Windows Time Separator.
'xx' Characters enclosed in single quotation marks are displayed as such, and do not affect formatting.

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'

Date & Time

webtag Function
no new tags

Current Conditions

webtag Function
Temperature & Humidity
<#apptemp> The apparent temperature
<#avgtemp> Average temperature so far today
Rainfall
no new tags
Pressure
<#altimeterpressure> Altimeter pressure. Pressure corrected to sea level using altitude only. Same as sea-level pressure for non-Davis stations.
Wind
no new tags

Today

webtag Function Time
Temperature & Humidity
<#apptempTH> 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>
Rainfall
<#hourlyrainTH> Today's highest rainfall rate <#ThourlyrainTH>
Pressure
no new tags
Wind
no new tags

Yesterday

webtag Function Time
Temperature & Humidity
<#apptempYH> 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>
Rainfall
<#hourlyrainYH> Yesterday's highest rainfall rate <#ThourlyrainYH>
Pressure
no new tags
Wind
no new tags

Monthly

webtag Function Time Date
Temperature & Humidity
<#MonthTempH> 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 <#MonthDewPointLT> <#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>
Pressure
<#MonthPressH> This months highest pressure <#MonthPressHT> <#MonthPressHD>
<#MonthPressL> This months lowest pressure <#MonthPressLT> <#MonthPressLD>
Wind
<#MonthGustH> This months highest wind gust <#MonthGustHT> <#MonthGustHD>
<#MonthWindH> This months highest wind speed <#MonthWindHT> <#MonthWindHD>
Rainfall
<#MonthRainRateH> This months highest rainfall rate <#MonthRainRateHT> <#MonthRainRateHD>
<#MonthHourlyRainH> This months highest hourly rain <#MonthHourlyRainHT> <#MonthHourlyRainHD>
<#MonthDailyRainH> This months greatest daily rain N/A <#MonthDailyRainHD>

Yearly

webtag Function Time Date
Temperature & Humidity
<#YearTempH> 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>
Pressure
<#YearPressH> This years high pressure <#YearPressHT> <#YearPressHD>
<#YearPressL> This years low pressure <#YearPressLT> <#YearPressLD>
Wind
<#YearGustH> This years high wind gust <#YearGustHT> <#YearGustHD>
<#YearWindH> This years high wind speed <#YearWindHT> <#YearWindHD>
Rainfall
<#YearRainRateH> This years high rainfall rate <#YearRainRateHT> <#YearRainRateHD>
<#YearHourlyRainH> This years high hourly rain <#YearHourlyRainHT> <#YearHourlyRainHD>
<#YearDailyRainH> This years high daily rain N/A <#YearDailyRainHD>
<#YearMonthlyRainH> This years high monthly rain N/A <#YearMonthlyRainHD>

All Time

webtag Function Time
Temperature & Humidity
<#apptempH> All time high apparent temperature <#TapptempH>
<#apptempL> All time low apparent temperature <#TapptempL>
<#heatindexH> All time high heat index <#TheatindexH>
<#dewpointH> All time high dew point <#TdewpointH>
<#dewpointL> All time low dew point <#TdewpointL>
<#humH> All time high humidity <#ThumH>
<#humL> All time low humidity <#ThumL>
Rainfall
no new tags
Pressure
no new tags
Wind
no new tags

Miscellaneous

webtag Function
<#LatestError> 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

webtag Function
<#SunshineHours> Hours of sunshine so far today
<#YSunshineHours> Total hours of sunshine yesterday
<#CurrentSolarMax> Current theoretical maximum solar radiation
<#IsSunny> Returns 1 if the sun is shining, otherwise 0
<#MoonPercent> Current percentage of moon visible (negative value indicates 'waning')
<#MoonPercentAbs> Current percentage of moon visible (always positive)

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 alarms

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
<#TempRecordSet> 1 if the indicator on the temperature tab on the all-time records screen is currently lit, 0 if not
<#WindRecordSet> 1 if the indicator on the wind tab on the all-time records screen is currently lit, 0 if not
<#RainRecordSet> 1 if the indicator on the rain tab on the all-time records screen is currently lit, 0 if not
<#HumidityRecordSet> 1 if the indicator on the humidity tab on the all-time records screen is currently lit, 0 if not
<#PressureRecordSet> 1 if the indicator on the pressure tab on the all-time records screen is currently lit, 0 if not
<#HighTempRecordSet> 1 if the all-time high temperature light is currently flashing, 0 if not
<#LowTempRecordSet> 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

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

webtag Function
no new tags

System

Special tags returning information about the system hosting Cumulus:

webtag Function
<#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"
<#CpuName> 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"


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.