Difference between revisions of "WXonline"

From HSYCO
Jump to navigation Jump to search
Line 61: Line 61:
 
|R
 
|R
 
|HSYCO can't connect to the panel
 
|HSYCO can't connect to the panel
 +
 +
|-
 +
 +
|rowspan="3" |location
 +
|<location>
 +
|R
 +
|the target location is set to <location> (e.g. “New York, NY, United States”)
 +
|-
 +
|<woeid>
 +
|W
 +
|set the location to the specified WOEID
 +
|-
 +
|refresh
 +
|W
 +
|refresh the weather data for the current location
 +
 +
|-
 +
 +
|condition
 +
|<condition>
 +
|R
 +
|the current weather condition (refer to the conditions table for a complete list of possible values)
 +
 +
|-
 +
 +
|rowspan="2" |condition.clear
 +
|1
 +
|R
 +
|the current condition is categorized as “clear”
 +
|-
 +
|0
 +
|R
 +
|the current condition is not categorized as “clear”
 +
 +
|-
 +
 +
|rowspan="2" |condition.precipitation
 +
|1
 +
|R
 +
|the current condition is categorized as “precipitation”
 +
|-
 +
|0
 +
|R
 +
|the current condition is not categorized as “precipitation”
 +
 +
|-
 +
 +
|rowspan="2" |condition.storm
 +
|1
 +
|R
 +
|the current condition is categorized as “storm”
 +
|-
 +
|0
 +
|R
 +
|the current condition is not categorized as “storm”
 +
 +
|-
 +
 +
|rowspan="2" |condition.partly_cloudy
 +
|1
 +
|R
 +
|the current condition is categorized as “partly cloudy”
 +
|-
 +
|0
 +
|R
 +
|the current condition is not categorized as "partly cloudy”
 +
 +
|-
 +
 +
|rowspan="2" |condition.low_visibility
 +
|1
 +
|R
 +
|the current condition is categorized as “low visibility”
 +
|-
 +
|0
 +
|R
 +
|the current condition is not categorized as “low visibility”
 +
 +
|-
 +
 +
|temp.c
 +
|<val>
 +
|R
 +
|the reported current temperature corresponds to <val> (expressed in °C)
 +
 +
|-
 +
 +
|temp.f
 +
|<val>
 +
|R
 +
|the reported current temperature corresponds to <val> (expressed in °F)
 +
 +
|-
 +
 +
|humidity
 +
|<val>
 +
|R
 +
|the reported current humidity percentage corresponds to <val>
 +
 +
|-
 +
 +
|wind.speed
 +
|<val>
 +
|R
 +
|the reported current wind speed corresponds to <val>
 +
 +
|-
 +
 +
|wind.dir
 +
|<val>
 +
|R
 +
|the reported current wind direction corresponds to <val> (expressed in degrees)
 +
 +
|-
 +
 +
|forecast.day.<n>
 +
(<n> = 1 or 2)
 +
|<day>
 +
|R
 +
|the week day identified by <n> corresponds to <day> (i.e. “mon”, "tue", "wed", ...)
 +
 +
|-
 +
 +
|forecast.temp.low.c.<n>
 +
(<n> = 1 or 2)
 +
|<val>
 +
|R
 +
|the forecasted lowest temperature for day <n> is <val> (expressed in °C)
 +
 +
|-
 +
 +
|forecast.temp.low.f.<n>
 +
(<n> = 1 or 2)
 +
|<val>
 +
|R
 +
|the forecasted lowest temperature for day <n> is <val> (expressed in °F)
 +
 +
|-
 +
 +
|forecast.temp.high.c.<n>
 +
(<n> = 1 or 2)
 +
|<val>
 +
|R
 +
|the forecasted highest temperature for day <n> is <val> (expressed in °C)
 +
 +
|-
 +
 +
|forecast.temp.high.f.<n>
 +
(<n> = 1 or 2)
 +
|<val>
 +
|R
 +
|the forecasted highest temperature for day <n> is <val> (expressed in °F)
 +
 +
|-
 +
 +
|forecast.condition.<n>
 +
(<n> = 1 or 2)
 +
|<condition>
 +
|R
 +
|the forecasted weather condition for day <n> corresponds to <condition> (refer to the conditions table for a complete list of possible values)
 +
 +
|-
 +
 +
|rowspan="2" |forecast.condition.clear.<n>
 +
|1
 +
|R
 +
|the forecasted condition for day <n> is categorized as "clear"
 +
|-
 +
|0
 +
|R
 +
|the forecasted condition for day <n> is not categorized as "clear"
 +
 +
|-
 +
 +
|rowspan="2" |forecast.condition.precipitation.<n>
 +
|1
 +
|R
 +
|the forecasted condition for day <n> is categorized as "precipitation"
 +
|-
 +
|0
 +
|R
 +
|the forecasted condition for day <n> is not categorized as "precipitation"
 +
 +
|-
 +
 +
|rowspan="2" |forecast.condition.storm.<n>
 +
|1
 +
|R
 +
|the forecasted condition for day <n> is categorized as "storm"
 +
|-
 +
|0
 +
|R
 +
|the forecasted condition for day <n> is not categorized as "storm"
 +
 +
|-
 +
 +
|rowspan="2" |forecast.condition.partly_cloudy.<n>
 +
|1
 +
|R
 +
|the forecasted condition for day <n> is categorized as "partly cloudy"
 +
|-
 +
|0
 +
|R
 +
|the forecasted condition for day <n> is not categorized as "partly cloudy"
 +
 +
|-
 +
 +
|rowspan="2" |forecast.condition.low_visibility.<n>
 +
|1
 +
|R
 +
|the forecasted condition for day <n> is categorized as "low visibility"
 +
|-
 +
|0
 +
|R
 +
|the forecasted condition for day <n> is not categorized as "low visibility"
  
 
|}
 
|}

Revision as of 11:07, 8 January 2014

This driver provides weather information and forecasts retrieved from the Yahoo! Weather service.

N.B. The information provided by this driver must be used in compliance with Yahoo!'s Terms of Use.

HSYCO Configuration

Options

ID Default Values Description
gui true true enable support for the UI object and UISET actions
false disable UI support
pollinterval 10 n > 0 the data acquisition interval, in minutes
location <woeid> WOEID of the target location

The 'location' option is required. To obtain the WOEID of the desired location, go to the Yahoo! Weather home page and enter the location name in the search field. The WOEID will be at the end of the URL for the forecast page for that location. For example, if you search for Los Angeles, the forecast page for that city is "http://weather.yahoo.com/united-states/california/los-angeles-2442047". The WOEID is 2442047.

Datapoints

ID Value R/W Description
connection online R connection established
offline R HSYCO can't connect to the panel
location <location> R the target location is set to <location> (e.g. “New York, NY, United States”)
<woeid> W set the location to the specified WOEID
refresh W refresh the weather data for the current location
condition <condition> R the current weather condition (refer to the conditions table for a complete list of possible values)
condition.clear 1 R the current condition is categorized as “clear”
0 R the current condition is not categorized as “clear”
condition.precipitation 1 R the current condition is categorized as “precipitation”
0 R the current condition is not categorized as “precipitation”
condition.storm 1 R the current condition is categorized as “storm”
0 R the current condition is not categorized as “storm”
condition.partly_cloudy 1 R the current condition is categorized as “partly cloudy”
0 R the current condition is not categorized as "partly cloudy”
condition.low_visibility 1 R the current condition is categorized as “low visibility”
0 R the current condition is not categorized as “low visibility”
temp.c <val> R the reported current temperature corresponds to <val> (expressed in °C)
temp.f <val> R the reported current temperature corresponds to <val> (expressed in °F)
humidity <val> R the reported current humidity percentage corresponds to <val>
wind.speed <val> R the reported current wind speed corresponds to <val>
wind.dir <val> R the reported current wind direction corresponds to <val> (expressed in degrees)
forecast.day.<n>

(<n> = 1 or 2)

<day> R the week day identified by <n> corresponds to <day> (i.e. “mon”, "tue", "wed", ...)
forecast.temp.low.c.<n>

(<n> = 1 or 2)

<val> R the forecasted lowest temperature for day <n> is <val> (expressed in °C)
forecast.temp.low.f.<n>

(<n> = 1 or 2)

<val> R the forecasted lowest temperature for day <n> is <val> (expressed in °F)
forecast.temp.high.c.<n>

(<n> = 1 or 2)

<val> R the forecasted highest temperature for day <n> is <val> (expressed in °C)
forecast.temp.high.f.<n>

(<n> = 1 or 2)

<val> R the forecasted highest temperature for day <n> is <val> (expressed in °F)
forecast.condition.<n>

(<n> = 1 or 2)

<condition> R the forecasted weather condition for day <n> corresponds to <condition> (refer to the conditions table for a complete list of possible values)
forecast.condition.clear.<n> 1 R the forecasted condition for day <n> is categorized as "clear"
0 R the forecasted condition for day <n> is not categorized as "clear"
forecast.condition.precipitation.<n> 1 R the forecasted condition for day <n> is categorized as "precipitation"
0 R the forecasted condition for day <n> is not categorized as "precipitation"
forecast.condition.storm.<n> 1 R the forecasted condition for day <n> is categorized as "storm"
0 R the forecasted condition for day <n> is not categorized as "storm"
forecast.condition.partly_cloudy.<n> 1 R the forecasted condition for day <n> is categorized as "partly cloudy"
0 R the forecasted condition for day <n> is not categorized as "partly cloudy"
forecast.condition.low_visibility.<n> 1 R the forecasted condition for day <n> is categorized as "low visibility"
0 R the forecasted condition for day <n> is not categorized as "low visibility"
Retrieved from "http://wiki.hsyco.com/3.3.0/index.php?title=WXonline&oldid=678"