Skip to content

Commit

Permalink
Merge pull request eclipse-archived#320 from kaikreuzer/yahoo-docs
Browse files Browse the repository at this point in the history
added readme for Yahoo weather binding
  • Loading branch information
kaikreuzer committed May 25, 2015
2 parents 6b5fe30 + 2a4a813 commit 5662880
Showing 1 changed file with 51 additions and 0 deletions.
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
}
}
```

0 comments on commit 5662880

Please sign in to comment.