Cumulus Wiki

Mcrossley

Joined 22 September 2010

User:Mcrossley (view source)

Revision as of 22:09, 7 April 2011

12,290 bytes added ,  22:09, 7 April 2011
no edit summary
mNo edit summary
No edit summary
Line 1: Line 1:
'''A TEST PAGE FOR LAYOUT PRESENTATION'''
== Webtags available in Cumulus 1.9.1 ==
 
== 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:
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 13: Line 11:
=Time/Date 'format' Parameter=
=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.
From 1.9.1 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.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 110: Line 108:
=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 webtags available in the current version of Cumulus.
 
==Units==
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|<#tempunit>
|Unit of temperature being used (Set in Cumulus as [http://en.wikipedia.org/wiki/Centigrade Centigrade] or [http://en.wikipedia.org/wiki/Fahrenheit Fahrenheit])
|-
|<#pressunit>
|Unit of measure for pressure. Possible values: mb, hPa, in
|-
|<#rainunit>
|Unit of measure for rain fall (e.g mm or inches)
|-
|<#windunit>
|Unit of measure for wind speed. Possible values: mph, m/s, km/h, kts
|-
|<#windrununit>
|Unit of measure for wind run (distance)
|}


==Date & Time==
==Date & Time==
Line 118: Line 138:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|colspan="2"|no new tags
|<#date>
|The current date
|-
|<#time>
|The current time and date. Example result: 18:30 on 30 December 2009.  If you simply wish the time, use a combination of the day, month, year tags (below)
|-
|<#timehhmmss>
|The current time. Example format: 18:30:27
|-
| <#day>
| The current day as a 2-digit number. Example format: 14 
|-
| <#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. Example format: 05
|-
|<#monthname>
|The current month as a word. Example format: August
|-
|<#shortmonthname>
|The current month as a shortened word. Example format: Aug
|-
|<#year>
|The current year as a 4-digit number. Example format: 2009
|-
|<#shortyear>
|The current year as a 2-digit number. Example format: 09
|-
|<#hour>
|The current hour as a 2-digit number. Example format: 23
|-
|<#minute>
|The current minute as a 2-digit number. Example format: 59
|}
|}


Line 132: Line 189:
|<#apptemp>
|<#apptemp>
|The apparent temperature
|The apparent temperature
|-
|<#avgtemp>
|Average temperature so far today
|-
|<#temp>
|The outside temperature
|-
|<#intemp>
|The inside temperature
|-
|<#temptrend>
|The change in temperature over the last hour
|-
|<#temptrendtext>
|Temperature change over the last hour - Rising/Falling/Steady
|-
|<#temptrendenglish>
|Simple description of temperature change over the last hour - Rising/Falling/Steady.  Useful for Javascript coding.
|-
|<#heatindex>
|Current [[heat index]]
|-
|<#humidex>
|Current [http://en.wikipedia.org/wiki/Humidex Humidex]
|-
|<#hum>
|The outside [http://en.wikipedia.org/wiki/Humidity humidity]
|-
|<#inhum>
|The inside humidity
|-
|<#dew>
|The outside dew point
|-
|<#wchill>
|The current [[wind chill]] temperature
|-
|-
|colspan="2" style="background:lightgray;"|Rainfall
|colspan="2" style="background:lightgray;"|Rainfall
|-
|-
|colspan="2"|no new tags
|<#rfall>
|The total rainfall so far today
|-
|<#rrate>
|The current rainfall rate
|-
|<#rhour>
|The rainfall in the last hour
|-
|<#rmidnight>
|The total rainfall since midnight. Useful if you don't use midnight as your start of day
|-
|<#LastRainTipISO>
|Date/time of last rain gauge tip (e.g 2010-09-06 06:09)
|-
|-
|colspan="2" style="background:lightgray;"|Pressure
|colspan="2" style="background:lightgray;"|Pressure
|-
|-
|colspan="2"|no new tags
|<#press>
|The [http://en.wikipedia.org/wiki/Sea_level_pressure sea level pressure]
|-
|<#presstrend>
|The pressure trend in words - values can be set in the 'strings.ini' file
|-
|<#presstrendval>
|The pressure trend in figures
|-
|<#presstrendenglish>
| a singe word description for the pressure trend - Rising/Falling/Steady.  Useful for developing Javascript coding on your webpage.
|-
|<#altimeterpressure>
|Altimeter pressure. Pressure corrected to sea level using altitude only. Same as sea-level pressure for non-Davis stations.
|-
|-
|colspan="2" style="background:lightgray;"|Wind
|colspan="2" style="background:lightgray;"|Wind
|-
|-
|colspan="2"|no new tags
|<#wspeed>
|the 10-minute average, if you have Cumulus set to calculate a 10-minute average. Otherwise, it's the latest 'wind' value from the console (i.e. the current speed as determined by the station). Corresponds to 'average' on the Cumulus main screen.
|-
|<#wgust>
|The highest wind reading in the last 10 minutes. Corresponds to 'gust' on the Cumulus main screen.
|-
|<#wlatest>
|Latest wind speed reading from console.  Corresponds to 'latest' on the Cumulus main screen.
|-
|<#bearing>
|The current wind bearing
|-
|<#avgbearing>
|Average wind bearing over last 10 minutes. Range 1-360, 0=Calm
|-
|<#wdir>
|Average wind bearing over last 10 minutes as a [http://en.wikipedia.org/wiki/Compass compass] point - e.g. ESE
|-
|<#currentwdir>
|Current wind bearing as a compass point - e.g. ESE
|-
|<#wdirdata>
|Comma separated list of recent wind bearing readings (up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex
|-
|<#wspddata>
|Comma separated list of recent wind speed readings (up to 3600 entries). This is a circular buffer; to find the most recent value use nextwindindex
|-
|<#nextwindindex>
|The index of the entries in wdirdata and wspddata which Cumulus is going to use next - i.e. the latest entry used is one less than this; but don't forget to allow for the wrap around!
|-
|<#windrun>
|The total wind run today so far
|-
|<#beaufort>
|The current wind speed on the [http://en.wikipedia.org/wiki/Beaufort_scale Beaufort scale] (e.g. F8)
|-
|<#beaudesc>
|The current wind speed Beaufort description (e.g. "Gale")
|}
|}


Line 155: Line 311:
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|<#tempTH>
|Today's highest temperature
|<#TtempTH>
|-
|<#tempTL>
|Today's lowest temperature
|<#TtempTL>
|-
|-
|<#apptempTH>
|<#apptempTH>
Line 189: Line 353:
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
|-
|<#rrateTM>
|Today's maximum rain rate
|<#TrrateTM>
|-
|-
|<#hourlyrainTH>
|<#hourlyrainTH>
Line 196: Line 364:
|colspan="3" style="background:lightgray;"|Pressure
|colspan="3" style="background:lightgray;"|Pressure
|-
|-
|colspan="3"|no new tags
|<#pressTH>
|Today's highest pressure reading
|<#TpressTH>
|-
|<#pressTL>
|Today's lowest pressure reading
|<#TpressTL>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|colspan="3"|no new tags
|<#windTM>
|Today's maximum (average) wind speed
|<#TwindTM>
|-
|<#wgustTM>
|Today's maximum wind gust
|<#TwgustTM>
|-
|<#bearingTM>
|The wind bearing at the time of today's high gust (<#wgustTM>)
|<#TwgustTM>
|-
|<#Tbeaufort>
|Today's highest wind speed, expressed in the Beaufort scale
|<#TwindTM>
|}
|}


Line 212: Line 400:
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|<#tempYH>
|Yesterday's highest temperature
|<#TtempYH>
|-
|<#tempYL>
|Yesterday's lowest temperature
|<#TtempYL>
|-
|-
|<#apptempYH>
|<#apptempYH>
Line 246: Line 442:
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
|-
|<#rfallY>
|The total rainfall for yesterday
|n/a
|-
|<#rrateYM>
|Yesterday's maximum rain rate
|<#TrrateYM>
|-
|-
|<#hourlyrainYH>
|<#hourlyrainYH>
Line 253: Line 457:
|colspan="3" style="background:lightgray;"|Pressure
|colspan="3" style="background:lightgray;"|Pressure
|-
|-
|colspan="3"|no new tags
|<#pressYH>
|Yesterday's highest pressure reading
|<#TpressYH>
|-
|<#pressYL>
|Yesterday's highest pressure reading
|<#TpressYL>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|colspan="3"|no new tags
|<#windrunY>
|The total wind run for yesterday
|n/a
|-
|<#windYM>
|Yesterday's maximum (average) wind speed
|<#TwindYM>
|-
|<#wgustYM>
|Yesterday's maximum wind gust
|<#TwgustYM>
|-
|<#bearingYM>
|The wind bearing at the time of yesterday's high gust
|<#TwgustYM>
|-
|<#Ybeaufort>
|Yesterday's highest wind speed, expressed in the Beaufort scale
|<#TwindYM>
|}
|}


Line 308: Line 536:
|<#MonthDewPointL>
|<#MonthDewPointL>
|This months low dew point
|This months low dew point
|<#MonthDewPointpLT>
|<#MonthDewPointLT>
|<#MonthDewPointLD>
|<#MonthDewPointLD>
|-
|-
|<#MonthMinTempH>
|<#MonthMinTempH>
|This months highest daily minimum temperature
|This months highest daily minimum temperature
|N/A
|n/a
|<#MonthMinTempHD>
|<#MonthMinTempHD>
|-
|-
|<#MonthMaxTempL>
|<#MonthMaxTempL>
|This months lowest daily minimum temperature
|This months lowest daily minimum temperature
|N/A
|n/a
|<#MonthMaxTempLD>
|<#MonthMaxTempLD>
|-
|-
Line 356: Line 584:
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
|-
|<#rmonth>
|The total rainfall so far this month
|n/a
|n/a
|-
|-
|<#MonthRainRateH>
|<#MonthRainRateH>
Line 369: Line 602:
|<#MonthDailyRainH>
|<#MonthDailyRainH>
|This months greatest daily rain
|This months greatest daily rain
|N/A
|n/a
|<#MonthDailyRainHD>
|<#MonthDailyRainHD>
|}
|}
Line 426: Line 659:
|<#YearMinTempH>
|<#YearMinTempH>
|This years highest daily minimum temperature
|This years highest daily minimum temperature
|N/A
|n/a
|<#YearMinTempHD>
|<#YearMinTempHD>
|-
|-
|<#YearMaxTempL>
|<#YearMaxTempL>
|This years lowest daily minimum temperature
|This years lowest daily minimum temperature
|N/A
|n/a
|<#YearMaxTempLD>
|<#YearMaxTempLD>
|-
|-
Line 469: Line 702:
|-
|-
|colspan="4" style="background:lightgray;"|Rainfall
|colspan="4" style="background:lightgray;"|Rainfall
|-
|<#ryear>
|The total rainfall so far this year
|n/a
|-
|-
|<#YearRainRateH>
|<#YearRainRateH>
Line 482: Line 719:
|<#YearDailyRainH>
|<#YearDailyRainH>
|This years high daily rain
|This years high daily rain
|N/A
|n/a
|<#YearDailyRainHD>
|<#YearDailyRainHD>
|-
|-
|<#YearMonthlyRainH>
|<#YearMonthlyRainH>
|This years high monthly rain
|This years high monthly rain
|N/A
|n/a
|<#YearMonthlyRainHD>
|<#YearMonthlyRainHD>
|}
|}
Line 500: Line 737:
|-
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|<#tempH>
|All time high temperature
|<#TtempH>
|-
|<#tempL>
|All time low temperature
|<#TtempL>
|-
|<#mintempH>
|All time high minimum temperature
|<#TmintempH>
|-
|<#maxtempL>
|All time low maximum temperature
|<#TmaxtempL>
|-
|-
|<#apptempH>
|<#apptempH>
Line 528: Line 781:
|All time low humidity
|All time low humidity
|<#ThumL>
|<#ThumL>
|-
|<#wchillH>
|All time greatest wind chill (i.e. lowest temperature)
|<#TwchillH>
|-
|-
|colspan="3" style="background:lightgray;"|Rainfall
|colspan="3" style="background:lightgray;"|Rainfall
|-
|-
|colspan="3"|no new tags
|<#rrateM>
|All time high rain rate
|<#TrrateM>
|-
|<#rfallH>
|All time high daily rain
|<#TrfallH>
|-
|<#rfallhH>
|All time high hourly rain
|<#TrfallhH>
|-
|<#rfallmH>
|All time high monthly rain
|<#TrfallmH>
|-
|-
|colspan="3" style="background:lightgray;"|Pressure
|colspan="3" style="background:lightgray;"|Pressure
|-
|-
|colspan="3"|no new tags
|<#pressH>
|All time high pressure
|<#TpressH>
|-
|<#pressL>
|All time low pressure
|<#TpressL>
|-
|-
|colspan="3" style="background:lightgray;"|Wind
|colspan="3" style="background:lightgray;"|Wind
|-
|-
|colspan="3"|no new tags
|<#gustM>
|All time high wind gust
|<#TgustM>
|-
|<#wspeedH>
|All time high average wind speed
|<#TwspeedH>
|}
|}


Line 560: Line 843:
|<#ErrorLight>
|<#ErrorLight>
|1 if the 'error' light is flashing, 0 if not
|1 if the 'error' light is flashing, 0 if not
|-
|<#version>
|The version of Cumulus in use
|-
|<#build>
|The build of Cumulus in use
|-
|<#realtimeinterval>
|The realtime update interval in seconds
|-
|<#interval>
|The web site update interval in minutes
|-
|<#rollovertime>
|The time that the logs rollover to the next day: 'Midnight', '9 am' or '10 am'
|-
|<#update>
|The date and time of the last web site update
|-
|<#stationtype>
|The type of station in use
|-
|<#latitude>
|The station [http://en.wikipedia.org/wiki/Latitude latitude]
|-
|<#longitude>
|The station [http://en.wikipedia.org/wiki/Longitude longitude]
|-
|<#altitude>
|The station [http://en.wikipedia.org/wiki/Altitude altitude]
|-
|<#location>
|The station location
|-
|<#longlocation>
|Longer description of the station location
|-
|<#forum>
|URL of the forum
|-
|<#webcam>
|URL of the webcam
|-
|<#graphperiod>
|The number of hours displayed by the graphs
|-
|[[Forecast_webtag|<#forecast>]]
|The current forecast
|-
|<#forecastnumber>
|The number relating to the current forecast entry in the [[strings.ini]] file.  If your station is not providing it's own forecast and Cumulus is not calculating one then 0 (zero) is returned
|-
|<#battery>
|The console battery condition (Only available for the Davis weather stations)
|-
|<#txbattery>
|The transmitter battery condition (Only available for the Davis weather stations)
|-
|<#cloudbase>
|Calculated [http://en.wikipedia.org/wiki/Cloud_base cloud base]
|-
|<#ET>
|Today's [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration]. Note that Fine Offset stations with solar sensors do not supply an evapotranspiration value, and by a quirk of the way the tag gets its value, for those stations this tag gives the light level in Lux.
|-
|<#UV>
|Current [http://en.wikipedia.org/wiki/Uv_index UV index]
|-
|<#SolarRad>
|Current [http://en.wikipedia.org/wiki/Solar_radiation solar radiation]
|-
|<#SensorContactLost>
|1 if the station has lost contact with its remote sensors "Fine Offset only" 0 if contact has been established
|-
|<#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
|-
|<#currcond>
|Represents the value entered on the screen within Cumulus for the Current Weather condition, or the value as held in the [[currentconditions.txt]] file
|}
|}


Line 568: Line 929:
!style="width:150px" | webtag
!style="width:150px" | webtag
!style="width:600px" | Function
!style="width:600px" | Function
|-
|<#sunrise>
|Current sunrise time at the station
|-
|<#sunset>
|Current sunset time at the station
|-
|<#daylength>
|Length of day in hours and minutes (sunrise to sunset)
|-
|<#tomorrowdaylength>
|A string giving the difference between the length of day light today and tomorrow.
Note.  This tag has been shown to generate inaccurate results and will probably be removed from Cumulus but is here for reference only.
|-
|<#dawn>
|Start of Civil Twilight at the station
|-
|<#dusk>
|End of Civil Twilight at the station
|-
|<#daylightlength>
|Length of daylight in hours and minutes (dawn to dusk)
|-
|<#moonphase>
|Current [[Lunar phase|phase of the moon]]
|-
|<#moonrise>
|Current moonrise time at the station
|-
|<#moonset>
|Current moonset time at the station
|-
|<#isdaylight>
|A flag to indicate if the location for the station is in 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.
|-
|-
|<#SunshineHours>
|<#SunshineHours>
Line 595: Line 990:
!style="width:150px" |webtag
!style="width:150px" |webtag
!style="width:600px" | Function
!style="width:600px" | Function
|-
|<#LowTempAlarm>
|Low temperature alarm
|-
|<#HighTempAlarm>
|High temperature alarm
|-
|<#TempChangeUpAlarm>
|Temperature increase alarm
|-
|<#TempChangeDownAlarm>
|Temperature decrease alarm
|-
|<#LowPressAlarm>
|Low pressure alarm
|-
|<#HighPressAlarm>
|High pressure alarm
|-
|<#PressChangeUpAlarm>
|Pressure increase alarm
|-
|<#PressChangeDownAlarm>
|Pressure decrease alarm
|-
|<#HighRainTodayAlarm>
|High rain today alarm
|-
|<#HighRainRateAlarm>
|High rainfall rate alarm
|-
|<#HighWindGustAlarm>
|High wind gust alarm
|-
|<#HighWindSpeedAlarm>
|High wind speed alarm
|}
==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"
|-
!style="width:150px" |webtag
!style="width:600px" | Function
|-
|<#recordsbegandate>
|The date that the all time records began
|-
|<#newrecord>
|1 if 'new record' light is flashing, 0 if not
|-
|-
|<#TempRecordSet>
|<#TempRecordSet>
Line 683: Line 1,129:
!style="width:600px" | Function
!style="width:600px" | Function
|-
|-
|colspan="2"|no new tags
|<#ExtraTemp1>
|Extra temperature channel 1
|-
|<#ExtraTemp2>
|Extra temperature channel 2
|-
|<#ExtraTemp3>
|Extra temperature channel 3
|-
|<#ExtraDP1>
|Extra dew point channel 1
|-
|<#ExtraDP2>
|Extra dew point channel 2
|-
|<#ExtraDP3>
|Extra dew point channel 3
|-
|<#ExtraHum1>
|Extra humidity channel 1
|-
|<#ExtraHum2>
|Extra humidity channel 2
|-
|<#ExtraHum3>
|Extra humidity channel 3
|}
 
===System===
 
Special tags returning information about the system hosting Cumulus:
 
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | 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"
|}
|}


Line 690: Line 1,204:


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.
<#RCdew> <#RCheatindex> <#RChum> <#RCinhum> <#RCintemp> <#RCpress> <#RCpressTH>
<#RCpressTL> <#RCrfall> <#RCrrate> <#RCrrateTM> <#RCtemp> <#RCtempTH> <#RCtempTL>
<#RCwchill> <#RCwgust> <#RCwgustTM> <#RCwspeed>
Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/1374"