Skip to content

Commit

Permalink
updated generated content
Browse files Browse the repository at this point in the history
Signed-off-by: Kai Kreuzer <[email protected]>
  • Loading branch information
kaikreuzer committed Jan 9, 2017
1 parent 03b5ac0 commit f14516b
Show file tree
Hide file tree
Showing 7 changed files with 645 additions and 66 deletions.
4 changes: 3 additions & 1 deletion _data/bindings.csv
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,16 @@ pioneeravr,PioneerAVR Configuration,"The binding can auto-discover the Pioneer A
pulseaudio,Pulseaudio,"This binding integrates pulseaudio devices."
rfxcom,RFXCOM,"This binding integrates large number of sensors and actuators from several different manufactures through [RFXCOM transceivers](http://www.rfxcom.com)."
rme,RME,"This binding integrates the RME RainManager rain water pump and management system"
russound,Russound,"This binding provides integration with any Russound system that support the RIO protocol (all MCA systems, all X systems). This binding provides compatibility with RIO Protocol v1.7 (everything but the Media Managment functionality). The protocol document can be found in the Russound Portal ('RIO Protocol for 3rd Party Integrators.pdf'). Please update to the latest firmware to provide full compatibility with this binding. This binding does provide full feedback from the Russound system if events occur outside of openHAB (such as keypad usage)."
samsungtv,Samsung TV,"This binding integrates the [Samsung TV's](http://www.samsung.com)."
silvercrestwifisocket,Silvercrest Wifi Plug,"This binding integrates the Silvercrest Wifi Socket SWS-A1 sold by Lidl."
smaenergymeter,SMA Energy Meter,"This Binding is used to display the measured values of a SMA Energy Meter device. It shows purchased and grid feed-in power and energy."
squeezebox,Logitech Squeezebox,"This binding integrates the [Logitech Media Server](http://www.mysqueezebox.com) and compatible Squeeze players."
systeminfo,Systeminfo,"System information Binding provides operating system and hardware information including:"
tellstick,Tellstick,"This is an openHAB binding for Tellstick devices produced by Telldus, a Swedish company based in Lund."
tesla,Tesla,"This binding integrates the [Tesla Electrical Vehicle](http://www.teslamotors.com)."
toon,Toon,"The Toon bindings shows among others current room temperature, setpoint, energy and gas usage information."
urtsi,Somfy URTSI II,"The addressable Universal RTS Interface II (URTSI II) can be used to communicate between home automation or other third party systems and SOMFY’s RTS Motors and controls. It is capable of individual or group control, and can be operated via infrared remote, RS232 and RS485 serial communication. Once an input is activated, an RTS radio command is sent to the automated window treatment."
vitotronic,vitotronic,"Viessmann heating systems with vitotronic has a optolink Interface for maintenance."
vitotronic,Vitotronic,"Viessmann heating systems with Vitotronic has a optolink Interface for maintenance."
yamahareceiver,Yamahareceiver,"This binding connects openHAB with Yamaha Receivers of product line CX-A5000, RX-A30xx, RX-A20xx, RX-A10xx, RX-Vxxx, RX-Z7, DSP-Z7, RX-S600, HTR-xxxx."
zwave,ZWave,"The ZWave binding supports an interface to a wireless Z-Wave home automation network."
463 changes: 463 additions & 0 deletions addons/bindings/russound/readme.md

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions addons/bindings/silvercrestwifisocket/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: documentation
---

{% include base.html %}

# Silvercrest Wifi Plug Binding

This binding integrates the Silvercrest Wifi Socket SWS-A1 sold by Lidl.

## Supported Things

- Silvercrest Wifi Socket SWS-A1 - [(Owner Manual)](http://www.lidl-service.com/static/118127777/103043_FI.pdf) -- Tested with firmware version: 1.41, 1.60, 1.70


## Discovery

The Discovery of Wifi Sockets is always running in the background. If a command is sent to wifi socket using the android/ios app or if the physical button in the device is pressed, the device will be recognized and will be placed in the Inbox.

## Binding Configuration

The binding does not require any special configuration. The Wifi Socket should be connected to the same wifi network.

## Thing Configuration

To configure a Wifi Socket manually only the mac address is required. You can check the Wifi Socket mac address in your router or using some mobile app.

Wifi Socket thing parameters:

| Parameter ID | Parameter Type | Mandatory | Description | Default |
|--------------|----------------|------|------------------|-----|
| macAddress | text | true | The socket MAC address | |
| hostAddress | text | false | The socket Host address. The binding is capable to discover the host address. | |
| updateInterval | integer | false | Update time interval in seconds to request the status of the socket. | 60 |


E.g.

```
Thing silvercrestwifisocket:wifiSocket:lamp [ macAddress="ACCF23343C50" ]
```

## Channels

The Silvercrest Wifi Socket support the following channel:

| Channel Type ID | Item Type | Description |
|-----------------|------------------------|--------------|
| switch | Switch | Wifi Socket Switch. |
Binary file added addons/bindings/tellstick/doc/tellstick_duo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
183 changes: 125 additions & 58 deletions addons/bindings/tellstick/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,107 +4,174 @@ layout: documentation

{% include base.html %}

#Tellstick Binding
# Tellstick Binding

This is an openHAB binding for Tellstick devices produced by Telldus, a Swedish company based in Lund.

The original Tellstick focused on controlling 433 MHz devices like switches, dimmers and reading sensors from different brands. <br>
Many of the supported devices are cheaper and "low-end" and support have been made by reverse engineer the transmission protocols. <br>
All of these 433 MHz devices is one-way, so some versions of the Tellstick monitoring the air to keep the state of all devices.

The latest versions have also implemented Z-Wave as transmission protocol which open up for more robust transmission due two-ways communication.

All of these 433 MHz devices is one-way, so some versions of the Tellstick monitoring the air to keep the state of all devices.

The latest versions have also implemented Z-Wave as transmission protocol which open up for more robust transmission due two-ways communication.

<p align="center">
<img src="doc/tellstick_duo.jpg" alt="Tellstick Duo with device" width="300px"/>
</p>

## Supported Things

This binding implements two different API:
**1)** *Telldus Core* which is a local only interface supported by USB based device. <br>
**2)** *Telldus Live* which is a REST based cloud service maintained by Telldus. <br>
3) (According to [Telldus](http://developer.telldus.com/blog/2016/01/21/local-api-for-tellstick-znet-lite-beta) are they working with a local REST based API for the new Z-Wave devices. This is currently **NOT** supported by this binding.)
This binding supports the following thing types:

Depending on your Tellstick model different API methods is available:
* *Dimmable Device* - Usually for controlling lamps. `dimmer`
* *Switchable Device* - On/Off only could be lamps or other electronic equipment. `switch`
* *Sensors* - Often temperature-, barometic- and humidity-sensors. `sensor`

<table>
<tr><td><b>Model</b></td> <td><b>Telldus Core</b></td> <td><b>Telldus Live</b></td> <td><b>Verified working with openHAB</b></td></tr>
<tr><td>Tellstick Basic</td><td>X</td><td>X</td></tr>
<tr><td>Tellstick Duo</td><td>X</td><td>X</td><td>X</td></tr>
<tr><td>Tellstick Net</td><td></td><td>X</td></tr>
<tr><td>Tellstick ZNet Lite</td><td></td><td>X</td></tr>
<tr><td>Tellstick ZNet Pro</td><td></td><td>X</td><td>X</td></tr>
</table>
Additionally the binding have two types of bridge things which correspond to available API types:
* *Telldus Core Bridge* - Oldest API, used by USB devices. `telldus-core`
* *Telldus Live Bridge* - Telldus Cloud service, all devices with online access. `telldus-live`

***Switchbased sensors workaround*** <br>
*Some 433MHz magnetic & PIR sensors for example magnetic door sensors are detected as a regular `switch` things instead of a separate type. There is technically no way of distinguish them apart from regulur `switch` things. For using them as sensors only (not paired to a lamp) please consult the workaround in the channel section.*

This binding supports the following thing types:
## Discovery

* Telldus Core Bridge
* Telldus Live Bridge
* Dimmable Device
* Switchable Device
* Sensors
Devices which is added to *Telldus Core* and *Telldus Live* can be discovered by openHAB.

When you add this binding it will try to discover the *Telldus Core Bridge*. If it's installed correct its devices will show up.
If you want to use the *Telldus Live* its bridge, *Telldus Live bridge* need to be added manually.
## Binding Configuration

---
***For USB connected tellsticks only, eg. Basic and DUO*** <br>
*First of all you need to make sure that your JVM is matching your installed Telldus Center. This normally means openHab must run on a 32bit JVM for windows and a 64bit JVM for linux. For windows the binding is hardcoded to look for Telldus Center in Programs Files ("C:/Program Files/Telldus/;C:/Program Files (x86)/Telldus/"). If you have trouble getting the telldus core library to work you can modify the library path using*

#####For Telldus Core only#####
## Thing Configuration

*First of all you need to make sure that your JVM is matching your installed Telldus Center. This normally means openHab must run on a 32bit JVM for windows and a 64bit JVM for linux. For windows the binding is hardcoded to look for Telldus Center in Programs Files ("C:/Program Files/Telldus/;C:/Program Files (x86)/Telldus/"). If you have trouble getting the telldus core library to work you can modify the library path using*
Only the bridges require manual configuration. The devices and sensors should not be added by hand, let the discovery/inbox initially configure these.

## Discovery
### Dimmers & switches

Both Telldus Core and Live devices will be discovered once the bridges are configured.
There is an option to override the resend count of the commands. Use the option `repeat` for that. Default resend count is 2.

## Thing Configuration
### Bridges

```xtend
Bridge tellstick:telldus-core:1 "Tellstick Duo" []
Depending on your tellstick device type there is different ways of using this binding. The binding implements two different API:
**1)** *Telldus Core* which is a local only interface supported by USB based device. <br>
**2)** *Telldus Live* which is a REST based cloud service maintained by Telldus. <br>

Bridge tellstick:telldus-live:2 "Tellstick ZWave" [publicKey="XXX", privateKey="YYYY", token= "ZZZZ", tokenSecret="UUUU"]
```
> Not implemented yet but supported by some new devices: <br>
> **3)** *Local Rest API* is a local API which would work similar to Telldus Live but local.
## Channels
Depending on your Tellstick model different API methods is available:

<table>
<tr><td><b>Model</b></td> <td><b>Telldus Core</b></td> <td><b>Telldus Live</b></td> <td>Local REST API</td> <td><b>Verified working with openHAB</b></td></tr>
<tr><td>Tellstick Basic</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Tellstick Duo</td><td>X</td><td>X</td><td></td><td>X</td></tr>
<tr><td>Tellstick Net v.1</td><td></td><td>X</td><td></td><td></td></tr>
<tr><td>Tellstick Net v.2</td><td></td><td>X</td><td>X</td><td></td></tr>
<tr><td>Tellstick ZNet Lite v.1</td><td></td><td>X</td><td>X</td><td>X</td></tr>
<tr><td>Tellstick ZNet Lite v.2</td><td></td><td>X</td><td>X</td><td></td></tr>
<tr><td><i>Tellstick ZNet Pro (Not released)</i></td><td></td><td>X</td><td>X</td><td></td></tr>
</table>

There are two levels of discovery. When you add this binding it will try to discover the Telldus Core Bridge (this only works if you have Telldus installed and right 32/64 bit version of java).
If you want to use the Telldus Live bridge, then you manually need to add this thing.
When you add either of those all devices and sensors will be discovered and reported in the inbox.
#### Telldus Core Bridge

## Thing Configuration
```
Bridge tellstick:telldus-core:1 "Tellstick Duo" [resendInterval="200"]
```

#####Telldus Core Bridge#####
Optional:

- **libraryPath:** The path to tellduscore.dll/so,
- **libraryPath:** The path to tellduscore.dll/so,
- **resendInterval:** The interval between each transmission of command, default 100ms.

#####Telldus Live Bridge#####
#### Telldus Live Bridge

To configure Telldus Live you have request OAuth tokens from Telldus. Goto this page
http://api.telldus.com/keys/index and request your keys and update the config.

```
Bridge tellstick:telldus-live:2 "Tellstick ZWave" [publicKey="XXX", privateKey="YYYY", token= "ZZZZ", tokenSecret="UUUU"]
```

Required:

- **privateKey:** Private key
- **publicKey:** Public key
- **token:** Token
- **tokenSecret:** Token secret
- **refreshInterval:** How often we should contact Telldus.Live to check for updates

The devices and sensors should not be configured by hand, let the discovery/inbox configure these.
Optional:

- **refreshInterval:** How often we should contact *Telldus Live* to check for updates

## Channels

Actuators (dimmer/switch) support the following channels:
| Channel Type ID | Item Type | Description |
|-----------------|--------------|----------------------------------------------- |
| dimmer | Number | This channel indicates the current dim level |
| state | Switch | This channel indicates whether a device is turned on or off. |
| timestamp | DateTime | This channel reports the last time this device state changed. |
<table>
<tr><td colspan="3">Actuators ([dimmer]/[switch]) support the following channels:</td></tr>
<tr><td><b>Channel Type ID</b></td> <td><b>Item Type</b></td> <td><b>Description</b></td> </tr>
<tr><td>dimmer</td><td>Number</td><td>This channel indicates the current dim level</td></tr>
<tr><td>state</td><td>Switch</td><td>This channel indicates whether a device is turned on or off.</td></tr>
<tr><td>timestamp</td><td>DateTime</td><td>This channel reports the last time this device state changed.</td></tr>
</table>

<table>
<tr><td colspan="3">Sensors ([sensor]) support the following channels:</td></tr>
<tr><td><b>Channel Type ID</b></td> <td><b>Item Type</b></td> <td><b>Description</b></td> </tr>
<tr><td>humidity</td><td>Number</td><td>This channel reports the current humidity in percentage.</td></tr>
<tr><td>temperature</td><td>Number</td><td>This channel reports the current temperature in celsius.</td></tr>
<tr><td>timestamp</td><td>DateTime</td><td> This channel reports the last time this sensor was updates.</td></tr>
</table>

### Switchbased sensor workaround

All switchbased sensors are binary and the goal is to represent them as a `contact` item in openhab. Eg. a door is open or closed and can't be altered by sending a radio signal. To achive that we will create a proxy item which is updated by a rule.


First create another proxy item for every sensor:

Sensors support the following channels:
| Channel Type ID | Item Type | Description |
|-----------------|--------------|----------------------------------------------- |
| humidity | Number | This channel reports the current humidity in percentage |
| temperature | Number | This channel reports the current temperature in celsius |
| timestamp | DateTime | This channel reports the last time this sensor was updates. |
```
Switch front_door_sensor "Front door" <door> {channel="tellstick:switch:1:7:state"}
Contact front_door_proxy "Front door" <door>
```

Then create a rule which updates the proxy item:

```
rule "proxy_front_door_on"
when
Item front_door_sensor changed to ON
then
postUpdate(front_door_proxy, OPEN);
end
rule "proxy_front_door_off"
when
Item front_door_sensor changed to OFF
then
postUpdate(front_door_proxy, CLOSED);
end
```

## Full Example

```xtend
Bridge tellstick:telldus-core:1 "Tellstick Duo" []
### tellstick.things

```
Bridge tellstick:telldus-core:1 "Tellstick Duo" [resendInterval="200"]
Bridge tellstick:telldus-live:2 "Tellstick ZWave" [refresh="10000", publicKey="XXXXXXXX", privateKey="YYYYYY", token= "ZZZZZZZZ", tokenSecret="UUUUUUUUUU"]
```

Devices are preferable discovered automatically.
Add them either with karaf: `inbox approve <thingId>` or in paperUI. The bridges can also be added with PaperUI.

### tellstick.items

List available devices in karaf with `things` or get the channels in paperUI.

```
Slider living_room_ceiling "Living room ceiling" <light> {channel="tellstick:dimmer:1:3:state"}
Switch living_room_table "Living room table" <light> {channel="tellstick:switch:1:3:state"}
Number inside_temperature "Inside temperature [%.1f °C]" <temperature> {channel="tellstick:sensor:1:47_temperaturehumidity_fineoffset:temperature"}
Number inside_humidity "Inside humidity [%.1f RH]" <humidity> {channel="tellstick:sensor:1:47_temperaturehumidity_fineoffset:humidity"}
```
8 changes: 4 additions & 4 deletions addons/bindings/vitotronic/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ layout: documentation

{% include base.html %}

# vitotronic Binding
# Vitotronic Binding

Viessmann heating systems with vitotronic has a optolink Interface for maintenance.
Viessmann heating systems with Vitotronic has a optolink Interface for maintenance.
This interface can use for get/set data in the heating system. [see on openv](http://openv.wikispaces.com)

The vitotronic binding is a solution to bind this interface into openHAB2.
The Vitotronic binding is a solution to bind this interface into openHAB2.
It supports the separation of the heating adaption from the integration in [openHAB2](http://www.openhab.org/).

![Architectur](doc/architecture_vitotronic.jpg)

The adapter transform the address oriented raw interface of the vitotronic to a abstract format.
The adapter transform the address oriented raw interface of the Vitotronic to a abstract format.
The adapter itself is not a part of the openhab2 binding.
[A alpha version is available here](https://github.com/steand/optolink)
[More Information about the adapter](https://github.com/steand/optolink/wiki)
Expand Down
4 changes: 1 addition & 3 deletions addons/uis/basic/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ Features:

* Responsive layout suitable for various screen sizes
* AJAX navigation
* Live update<sup>1</sup>

<sup>1</sup>: as for now, only control states and icons are updated. Visibility changes require a page reload.
* Live update

Configuration:

Expand Down

0 comments on commit f14516b

Please sign in to comment.