User:Mcrossley: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
Nothing to see here at the moment!
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!''


=The Tags=

Below are a list of the webtags available. There are currently 192 webtags, based on version 1.9.0 of Cumulus. Webtags for beta versions of Cumulus are not listed here until the version becomes 'live'

==Date & Time==
{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|<#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
|-
|<#recordsbegandate>
|The date that the all time records began
|-
|<#realtimeinterval>
|The realtime update interval in seconds
|-
|<#rollovertime>
|The time that the logs rollover to the next day. Format: 'Midnight','9 am','10 am'
|}

==Current Conditions==

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|colspan="2" style="background:lightgray;"|Temperature & Humidity
|-
|<#temp>
|The outside temperature
|-
|<#intemp>
|The inside temperature
|-
|<#temptrend>
|The change in temperature over the last hour
|-
|<#temptrendtext>
|Temperature change over the last hour. Format:'Rising','Falling','Steady' plus optional 'Quickly','Slowly'
|-
|<#temptrendenglish>
|Simple description of temperature change over the last hour. Format: '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
|-
|<#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]). Format: '&amp;deg;C','&amp;deg;F'
|-
|colspan="2" style="background:lightgray;"|Rainfall
|-
|<#rrate>
|The current rainfall rate
|-
|<#rhour>
|The rainfall in the last hour
|-
|<#rainunit>
|Unit of measure for rain fall. Format: 'mm','in'
|-
|<#LastRainTipISO>
|Date/time of last rain gauge tip (e.g 2010-09-06 06:09)
|-
|colspan="2" style="background:lightgray;"|Pressure
|-
|<#press>
|The [http://en.wikipedia.org/wiki/Sea_level_pressure sea level pressure]
|-
|<#presstrend>
|The pressure trend in words. Format:'Rising','Falling',Steady' plus optional 'Quickly','Slowly' - values can be overridden in the 'strings.ini' file
|-
|<#presstrendval>
|The pressure trend in figures
|-
|<#presstrendenglish>
| a singe word description for the pressure trend. Format: 'Rising','Falling','Steady'. Useful for developing Javascript coding on your webpage.
|-
|<#pressunit>
|Unit of measure for pressure. Format: 'mb','hPa','in'
|-
|colspan="2" style="background:lightgray;"|Wind
|-
|<#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 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!
|-
|<#windunit>
|Unit of measure for wind speed. Format: 'mph','m/s','km/h','kts'
|-
|<#windrununit>
|Unit of measure for wind run (distance). Format: 'miles','km','nm'
|-
|<#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")
|-
|}

==Today==

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:450px" | Function
!style="width:150px" | Time
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|<#tempTH>
|Today's highest temperature
|<#TtempTH>
|-
|<#tempTL>
|Today's lowest temperature
|<#TtempTL>
|-
|colspan="3" style="background:lightgray;"|Rainfall
|-
|<#rfall>
|The total rainfall so far today
|N/A
|-
|<#rmidnight>
|The total rainfall since midnight. Useful if you don't use midnight as your start of day
|N/A
|-
|<#rrateTM>
|Today's maximum rain rate
|<#TrrateTM>
|-
|colspan="3" style="background:lightgray;"|Pressure
|-
|<#pressTH>
|Today's highest pressure reading
|<#TpressTH>
|-
|<#pressTL>
|Today's lowest pressure reading
|<#TpressTL>
|-
|colspan="3" style="background:lightgray;"|Wind
|-
|<#windrun>
|The total wind run today so far
|N/A
|-
|<#bearingTM>
|Today's mean wind bearing
|N/A
|-
|<#windTM>
|Today's maximum (average) wind speed
|<#TwindTM>
|-
|<#wgustTM>
|Today's maximum wind gust
|<#TwgustTM>
|-
|<#Tbeaufort>
|Today's highest wind speed, expressed in the Beaufort scale
|<#TwindTM>
|}

==Yesterday==

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:450px" | Function
!style="width:150px" | Time
|-
|colspan="3" style="background:lightgray;"|Temperature & Humidity
|-
|<#tempYH>
|Yesterday's highest temperature
|<#TtempYH>
|-
|<#tempYL>
|Yesterday's lowest temperature
|<#TtempYL>
|-
|colspan="3" style="background:lightgray;"|Rainfall
|-
|<#rfallY>
|The total rainfall for yesterday
|N/A
|-
|<#rrateYM>
|Yesterday's maximum rain rate
|<#TrrateYM>
|-
|colspan="3" style="background:lightgray;"|Pressure
|-
|<#pressYH>
|Yesterday's highest pressure reading
|<#TpressYH>
|-
|<#pressYL>
|Yesterday's lowest pressure reading
|<#TpressYL>
|-
|colspan="3" style="background:lightgray;"|Wind
|-
|<#windrunY>
|The total wind run for yesterday
|N/A
|-
|<#bearingYM>
|Yesterday's mean wind bearing
|N/A
|-
|<#windYM>
|Yesterday's maximum (average) wind speed
|<#TwindYM>
|-
|<#wgustYM>
|Yesterday's maximum wind gust
|<#TwgustYM>
|-
|<#Ybeaufort>
|Yesterday's highest wind speed, expressed in the Beaufort scale
|<#TwindYM>
|}

==Monthly==

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:300px" | Function
!style="width:150px" | Time
!style="width:150px" | Date or Date/Time
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|.
|.
|.
|.
|-
|colspan="4" style="background:lightgray;"|Rainfall
|-
|<#rmonth>
|The total rainfall so far this month
|N/A
|N/A
|-
|colspan="4" style="background:lightgray;"|Pressure
|-
|.
|.
|.
|.
|-
|colspan="4" style="background:lightgray;"|Wind
|-
|.
|.
|.
|.
|}

==Yearly==

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:300px" | Function
!style="width:150px" | Time
!style="width:150px" | Date or Date/Time
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|.
|.
|.
|.
|-
|colspan="4" style="background:lightgray;"|Rainfall
|-
|<#ryear>
|The total rainfall so far this year
|N/A
|N/A
|-
|colspan="4" style="background:lightgray;"|Pressure
|-
|.
|.
|.
|.
|-
|colspan="4" style="background:lightgray;"|Wind
|-
|.
|.
|.
|.
|}

==All Time==

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:300px" | Function
!style="width:150px" | Time
!style="width:150px" | Date or Date/Time
|-
|colspan="4" style="background:lightgray;"|Temperature & Humidity
|-
|<#tempH>
|All time high temperature
|N/A
|<#TtempH>
|-
|<#tempL>
|All time low temperature
|N/A
|<#TtempL>
|-
|<#mintempH>
|All time high minimum temperature
|N/A
|<#TmintempH>
|-
|<#maxtempL>
|All time low maximum temperature
|N/A
|<#TmaxtempL>
|-
|<#wchillH>
|All time greatest wind chill (i.e. lowest temperature)
|N/A
|<#TwchillH>
|-
|colspan="4" style="background:lightgray;"|Rainfall
|-
|<#rrateM>
|All time high rain rate
|N/A
|<#TrrateM>
|-
|<#rfallH>
|All time high daily rain
|N/A
|<#TrfallH>
|-
|<#rfallhH>
|All time high hourly rain
|N/A
|<#TrfallhH>
|-
|<#rfallmH>
|All time high monthly rain
|N/A
|<#TrfallmH>
|-
|colspan="4" style="background:lightgray;"|Pressure
|-
|<#pressH>
|All time high pressure
|N/A
|<#TpressH>
|-
|<#pressL>
|All time low pressure
|N/A
|<#TpressL>
|-
|colspan="4" style="background:lightgray;"|Wind
|-
|<#gustM>
|All time high wind gust
|N/A
|<#TgustM>
|-
|<#wspeedH>
|All time high average wind speed
|N/A
|<#TwspeedH>
|}

==Miscellaneous==

{| class="wikitable" border="1"
|-
!style="width:150px" |webtag
!style="width:600px" | Function
|-
|<#version>
|The version of Cumulus in use
|-
|<#build>
|The build of Cumulus in use
|-
|<#interval>
|The web site update interval in minutes
|-
|<#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
|-
|<#cloudbase>
|Calculated [http://en.wikipedia.org/wiki/Cloud_base cloud base]
|-
|<#ET>
|Today's [http://en.wikipedia.org/wiki/Evapotranspiration evapotranspiration]
|-
|<#UV>
|Current [http://en.wikipedia.org/wiki/Uv_index UV index]
|-
|<#SolarRad>
|Current [http://en.wikipedia.org/wiki/Solar_radiation solar radiation]
|-
|<#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
|-
|<#newrecord>
|1 if 'new record' light is flashing, 0 if not
|}

==Day/Night/Sun/Moon==

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!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.
|}

==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'.
{| class="wikitable" border="1"
|-
!style="width:150px" |webtag
!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
|}

==Special tags==

===Davis===

There are a set of tags specific to the Davis PWS:

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|<#battery>
|The console battery condition
|-
|<#txbattery>
|The transmitter battery condition
|}

===Fine Offset===

There are a set of tags specific to the FO range of PWS:

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|<#sensorcontactlost>
|1 if the station has lost contact with its remote sensors. 0 if contact has been established
|}

===WMR928===

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

{| class="wikitable" border="1"
|-
!style="width:150px" | webtag
!style="width:600px" | Function
|-
|<#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
|}


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

<#RCdew> <#RCheatindex> <#RChum> <#RCinhum> <#RCintemp> <#RCpress> <#RCpressTH>
<#RCpressTL> <#RCrfall> <#RCrrate> <#RCrrateTM> <#RCtemp> <#RCtempTH> <#RCtempTL>
<#RCwchill> <#RCwgust> <#RCwgustTM> <#RCwspeed>

Latest revision as of 22:31, 19 December 2012

Nothing to see here at the moment!

Retrieved from "https://www.cumuluswiki.org/index.php?title=User:Mcrossley&oldid=2164"