forked from eclipse-archived/smarthome
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request eclipse-archived#320 from kaikreuzer/yahoo-docs
added readme for Yahoo weather binding
- Loading branch information
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
51 changes: 51 additions & 0 deletions
51
addons/binding/org.eclipse.smarthome.binding.yahooweather/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# YahooWeather Binding | ||
|
||
This binding uses the [Yahoo Weather service](https://developer.yahoo.com/weather/) for providing current weather information. | ||
|
||
_Note:_ The Yahoo Weather API is provided by Yahoo free of charge for personal, non-commercial uses, but it requires attribution and the acceptance of their terms of use. | ||
By using this binding, you confirm that you agree with this - please read the details on [https://developer.yahoo.com/weather/](https://developer.yahoo.com/weather/). | ||
|
||
## Supported Things | ||
|
||
There is exactly one supported thing, which represents the weather service. It has the id ```weather```. | ||
|
||
## Discovery | ||
|
||
The binding supports discovery, which does a geo location lookup based on the current IP address (using [freegeoip.net](http://freegeoip.net)). | ||
|
||
## Thing Configuration | ||
|
||
Besides the location (as ```location``` as a [WOEID](https://en.wikipedia.org/wiki/WOEID) number), the second configuration parameter is ```refresh``` which defines the refresh interval in seconds. | ||
|
||
## Channels | ||
|
||
The weather information that is retrieved is available as these channels: | ||
|
||
| Channel Type ID | Item Type | Description | | ||
|-----------------|------------------------|------------- | | ||
| temperature | Number | The current temperature in degrees celsius | | ||
| humidity | Number | The current humidity in % | | ||
| pressure | Number | The current pressure in millibar (hPa) | | ||
|
||
|
||
## Full Example | ||
|
||
demo.things: | ||
``` | ||
yahooweather:weather:berlin [ location="638242" ] | ||
``` | ||
|
||
demo.items: | ||
``` | ||
Number Temperature "Outside Temperature" { channel="yahooweather:weather:berlin:temperature" } | ||
``` | ||
|
||
demo.sitemap: | ||
``` | ||
sitemap demo label="Main Menu" | ||
{ | ||
Frame { | ||
Text item=Temperature | ||
} | ||
} | ||
``` |