[All addons] Review all readme.md files for V3 changes. (#9439)

Signed-off-by: Matthew Skinner <matt@pcmus.com>

* modbus.e3dc: newlines added and remove broken anchor.

Signed-off-by: Matthew Skinner <matt@pcmus.com>

* modbus.stie..:remove multiple newlines.

Signed-off-by: Matthew Skinner <matt@pcmus.com>

* modbus.sunspec: remove multiple newlines.


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Nanoleaf: remove PaperUI.


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Neato: Remove openhab 2


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Nibe: remove PaperUI.


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* NibeUplink: Remove PaperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Niko: Remove PaperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Nuki: Remove Paper UI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* OneWire: Remove multiple newlines.


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* OpenUV: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* OpenWebNet: Remove paperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Pentair: remove openhab2 path


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Fix typo


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* RFXCOM: remove PaperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Russound: Remove PaperUI.


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Samsung: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Siemens: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Samsung Smartthings: remove openhab 2 mention.


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Somfy myLink: remove paperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Somfy Tahoma: remove paperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Sonos: Remove paperui ref


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Spotify: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Tankerkönig: remove java8 and paperUI references.


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Tellstick: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Tibber: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Velbus: remove paperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Vitotronic: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* VolvoOnCall: remove paperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* WiFi LED: remove paperui


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* WlanThermo: remove paperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* XmlTV: remove openhab2 path


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Z-Way: Remove paperUI


Signed-off-by: Matthew Skinner <matt@pcmus.com>

* Update bundles/org.openhab.binding.nanoleaf/README.md

Signed-off-by: Matthew Skinner <matt@pcmus.com>

Co-authored-by: Fabian Wolter <github@fabian-wolter.de>

* MagentaTV: Fix typo

Signed-off-by: Matthew Skinner <matt@pcmus.com>

* MagentaTV: Change to userId


Signed-off-by: Matthew Skinner <matt@pcmus.com>

Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
This commit is contained in:
Matthew Skinner 2020-12-21 00:43:48 +11:00 committed by GitHub
parent 4f0caf1a1f
commit ea3446f50e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
40 changed files with 136 additions and 229 deletions

View File

@ -25,11 +25,11 @@ The binding provides device discovery, sending keys for the remote and also rece
## Auto Discovery
UPnP will be used to discover receivers on the local network and discover the nessesary parameters.
UPnP will be used to discover receivers on the local network and discover the necessary parameters.
The receiver needs to be powered on to get discovered.
Once the receiver is discovered it can be added from the Inbox.
Make sure to set the U in the Thing configuration after adding the new thing, see section Thing Configuration.
Make sure to set `userId` in the Thing configuration after adding the new thing, see section Thing Configuration.
Note:
The binding uses the network settings in openHAB's system configuration to determine the local IP address.
@ -126,11 +126,12 @@ For security reasons the credentials are automatically deleted from the thing co
Please note:
- POWER is a toggle button, not an on/off switch. The binding tries to detect and maintain the correct state, but due to device limitations this is not always possible. Make sure the receiver's and binding's state are in sync when OH is restarted (binidng assume state OFF).
- POWER is a toggle button, not an on/off switch.
The binding tries to detect and maintain the correct state, but due to device limitations this is not always possible.
Make sure the receiver's and binding's state are in sync when OH is restarted (binding assumes state is OFF).
- Channels receiving event information get updated when changing the channel or playing a video.
There is no way to read the current status, therefore they don't get initialized on startup nor being updated in real-time.
The player channel supports the following actions:
|Channel |Command |Description |
@ -193,7 +194,6 @@ The player channel supports the following actions:
In addition you could send any key code in the 0xHHHH format., refer to
[Key Codes for Magenta/Huawei Media Receiver](http://support.huawei.com/hedex/pages/DOC1100366313CEH0713H/01/DOC1100366313CEH0713H/01/resources/dsv_hdx_idp/DSV/en/en-us_topic_0094619112.html)
## Full Configuraton Example
### magentatv.things
@ -328,4 +328,3 @@ to switch it ON and
to switch it off.
After an openHAB restart you need to make sure that OH and receiver are in sync, because the binding can't read the power status at startup.

View File

@ -25,9 +25,9 @@ If one or both are empty, no authentication data is provided to the SMTP server
### IMAP Server (`imap`) / POP3 Server (`pop3`)
There is one mandatory parameter: `hostname`, `username`, `password`.
There is one mandatory parameter: `hostname`.
The `hostname` may contain an IP address or a FQDN like `mail.gmail.com`.
For authentication `username` and `password` need to be supplied.
For authentication `username` and `password` also need to be supplied.
The `refresh`, `security`, `port`, `username` and `password` parameters are optional.

View File

@ -1,7 +1,7 @@
# MAX! Binding
This is the binding for the [eQ-3 MAX! Home Solution](http://www.eq-3.de/).
This binding allows you to integrate, view and control the MAX! Thermostats in the openHAB environment
This binding allows you to integrate, view and control the MAX! Thermostats, Ecoswitch and Shuttercontact things.
## Supported Things
@ -10,29 +10,25 @@ This binding support 6 different things types
| Thing | Type | Description |
|----------------|--------|--------------------------------------------------------------------------------------------------------------------|
| bridge | Bridge | This is the MAX! Cube LAN gateway. |
| thermostat | Thing | This is for the MAX! Heating Thermostat. This is also used for the powerplug switch "Zwischenstecker-Schaltaktor". |
| thermostat | Thing | This is for the MAX! Heating Thermostat. This is also used for the power plug switch "Zwischenstecker-Schaltaktor". |
| thermostatplus | Thing | This is for the MAX! Heating Thermostat+. This is the type that can hold the program by itself. |
| wallthermostat | Thing | MAX! Wall Thermostat. |
| ecoswitch | Thing | MAX! Ecoswitch. |
| shuttercontact | Thing | MAX! Shuttercontact / Window Contact. |
Generally one does not have to worry about the thing types as they are automatically defined.
If for any reason you need to manually define the Things and you are not exactly sure what type of thermostat you have, you can choose `thermostat` for both the thermostat and thermostat+, this will not affect their working.
## Discovery
The discovery process for the MAX! binding works in 2 steps.
When the binding is started or when manually triggered, the network is queried for the existence of a MAX! Cube LAN gateway.
When the Cube is found, it will become available in the discovery inbox. Periodically the network is queried again for a Cube.
When the bindings discovery is triggered, the network is queried for the existence of a MAX! Cube LAN gateway.
When the Cube is found, it will become available in the inbox.
Once the Cube is available in openHAB, all the devices connected to it are discovered and added to the discovery inbox.
No scan is needed to trigger this.
After the Cube `bridge` is available in openHAB, all the devices connected to it are discovered and added to the inbox.
## Binding Configuration
In the openHAB2 version of this binding there are no binding wide settings.
All the configuration settings are now per MAX! Cube, hence in case you have multiple Cubes, they can run with alternative settings.
There are no binding wide settings as all configuration settings are now per MAX! Cube, hence in case you have multiple Cubes, they can run with alternative settings.
## Thing Configuration
@ -107,13 +103,13 @@ Please be aware that the actual temperature measure for thermostats is only upda
Hence the temperature you see may be hours old.
In that case you can update the temperature by changing the mode, wait approximately 2 minutes and change the mode back.
There is an experimental mode that does this automatically.
This can be enabled by showing the "advanced settings" (e.g. in HABmin UI).
This can be enabled by ticking "Show advanced".
Then the "Actual Temperature Refresh Rate" can be set.
Minimum refresh rate once/10 minutes, recommended 60min to avoid excessive battery drain.
## New Device Inclusion
When clicking the discovery button for MAX! devices manually in the UI, you will start New Device Inclusion mode for 60seconds.
When clicking the discovery button for MAX! devices manually in the UI, you will start New Device Inclusion mode for 60 seconds.
During this time, holding the _boost_ button on your device will link it to the Cube.
## Device Configuration
@ -128,10 +124,6 @@ _Cube device configurable parameters_
* _ntpServer1_ The hostname for NTP Server 1 used by the Cube to get the time
* _ntpServer2_ The hostname for NTP Server 2 used by the Cube to get the time
## Action Buttons (visible in HABmin)
The Action Buttons are deprecated and will be removed in a future version.
## Thing Actions
Several Thing Actions are available to trigger special actions on the MAX! Cube
@ -144,9 +136,6 @@ On the MAX! devices you can trigger the following action
* `deleteFromCube()`: _Delete Device from Cube_ deletes the device from the MAX! Cube. Device will need to be included again!
Note: In Paper UI there are no action buttons.
You can trigger these actions changing from 'No Action' in the dropdown to the action value.
### Example Rule
demo.rules:

View File

@ -3,8 +3,8 @@
This binding allows your openHAB to communicate with the Xiaomi Smart Home Suite.
It consists of devices communicating over a ZigBee network with a ZigBee - WiFi gateway.
The devices are very affordable and you can get them from your favourite chinese marktes like [AliExpress](https://www.aliexpress.com/) or [GearBest](https://www.gearbest.com).
The sensors run on a coincell battery for over a year.
The devices are very affordable and you can get them from your favourite Chinese markets like [AliExpress](https://www.aliexpress.com/) or [GearBest](https://www.gearbest.com).
The sensors run on a coin cell battery for over a year.
After setup, you can disconnect the gateway from the internet to keep your sensor information private.
@ -70,7 +70,7 @@ Zigbee2Mqtt provides an alternative method to integrate Xiaomi devices.
* In openHAB you should now be able to discover the Xiaomi Gateway
* From now on you don't really need the app anymore. Only if you want to update the gateway firmware or if you want to add devices (see below). But adding devices can also be done without the app (see below)
* Enter the previously noted developer key in openHAB Paper UI -> Configuration -> Things -> Xiaomi Gateway -> Edit -> Developer Key. Save (This is required if you want to be able to send controls to the devices like the light of the gateway)
* Enter the previously noted developer key in openHAB Administration -> Settings -> Things -> Xiaomi Gateway -> Edit -> Developer Key. Save (This is required if you want to be able to send controls to the devices like the light of the gateway)
## Connecting devices to the gateway
@ -88,7 +88,7 @@ There are three ways of connecting supported devices to the gateway:
* With the binding
1. After adding the gateway make sure you have entered the right developer key
2. In Paper UI, go to your Inbox and trigger a discovery for the binding
2. In the UI, go to your Inbox and trigger a discovery for the binding
3. The gateway flashes in blue and you hear a female voice in Chinese, you have 30 seconds to include your new device
4. Follow the instructions for your device to pair it to the gateway
5. You will hear a confirmation message in Chinese

View File

@ -381,7 +381,7 @@ After validation, please share the logfile and json files on the openHAB forum o
Things using the basic handler (miio:basic things) are driven by json 'database' files.
This instructs the binding which channels to create, which properties and actions are associated with the channels etc.
The conf/misc/miio (e.g. in Linux `/opt/openhab2/conf/misc/miio/`) is scanned for database files and will be used for your devices.
The conf/misc/miio (e.g. in Linux `/opt/openhab/conf/misc/miio/`) is scanned for database files and will be used for your devices.
During the start of the binding the exact path used in your system will be printed in the debug log.
Watch for a line containing `Started miio basic devices local databases watch service. Watching for database files at path: …`
If this folder is created after the start of the binding, you may need to restart the binding (or openHAB) to be able to use the local files.

View File

@ -33,9 +33,9 @@ Read the device manual for more information about how to connect your device to
## Thing Configuration
Besides adding bridges through Paper UI, you can also add them manually in your Thing
Besides adding bridges through the UI, you can also add them manually in your Thing
configuration file.
iBox and iBox2 have the version 6, older milight bridges have the version 3.
iBox and iBox2 have the version 6, older Milight bridges have the version 3.
The ID is the MAC address of the bridge in hexadecimal digits.
Bridge milight:bridgeV3:mybridge [ host="192.168.0.70", bridgeid="ACCF23A6C0B4", passwordByte1=0, passwordByte2=0, repeat=2, delayTime=75 ] {
@ -113,10 +113,9 @@ For rgbwLed/rgbwwLed bulbs these channels are supported:
ledlink Sync bulb to this zone within 3 seconds of light bulb socket power on
ledunlink Clear bulb from this zone within 3 seconds of light bulb socket power on
Limitations:
* Only the rgbww bulbs support changing their saturation, for rgbv2Led/rgbwLed the colorpicker will only set the hue and brightness and change to whitemode if the saturation is under a given threshold of 50%.
* Only the rgbww bulbs support changing their saturation, for rgbv2Led/rgbwLed the colorpicker will only set the hue and brightness and change to white mode if the saturation is under a given threshold of 50%.
## Example
@ -129,7 +128,7 @@ Dimmer Light_LivingroomC {channel="milight:whiteLed:ACCF23A6C0B4:1:ledtemperatur
Dimmer RGBW_LivingroomB {channel="milight:rgbwLed:ACCF23A6C0B4:2:ledbrightness"} //Dimmer changing brightness for RGBW bulb in zone 2
Color Light_Party {channel="milight:rgbwLed:ACCF23A6C0B4:1:ledcolor"} //Colorpicker for rgb bulbs
//You have to link the items to the channels of your prefered group e.g. in Paper UI after you have saved your items file.
# You have to link the items to the channels of your prefered group.
//The command types nightMode and whiteMode are stateless and should be configured as pushbuttons as they only support a trigger action:
Switch Light_GroundfloorN {channel="milight:whiteLed:ACCF23A6C0B4:0:lednightmode", autoupdate="false"} //Activate the NightMode for all bulbs

View File

@ -68,7 +68,9 @@ Depending on the thing type, different channels are provided:
### Example Thing Definition
The easiest method to add Minecraft servers, players, and signs is use the automatic discovery through Paper UI. However, you can manualy define the objects using thing configuration files. Players and signs are connected through Minecraft server [bridges](https://www.openhab.org/docs/configuration/things.html#defining-bridges-using-files).
The easiest method to add Minecraft servers, players, and signs is use the automatic discovery.
You can also manually define the objects using thing configuration files.
Players and signs are connected through Minecraft server [bridges](https://www.openhab.org/docs/configuration/things.html#defining-bridges-using-files).
```xtend
Bridge minecraft:server:myminecraftserver "Minecraft server for Friends" @ "Minecraft" [ hostname="192.168.1.100", port=10692 ] {

View File

@ -2,13 +2,13 @@
<img align="right" src="./doc/E3DC_logo.png"/>
Integrates the Home Power Plants from E3/DC GmbH into openHAB. See [E3DC Website](https://www.e3dc.com/) to find more informations about the device.
Integrates the Home Power Plants from E3/DC GmbH into openHAB.
See [E3DC Website](https://www.e3dc.com/) to find more informations about the device.
The Power Plant handles all your Electrical Energy Resources like Photovoltaic Producers, Battery Storage, Wallbox Power Supply, Household Consumption and even more.
E3DC devices are integrated into the Modbus Binding.
See chapter [Thing Configuration](#thing-configuration) how to set them up or check the [full example Things](#things) for manual setup.
## Supported Things
First you need a Bridge which establishes the basic connection towards your E3DC device
@ -21,12 +21,12 @@ First you need a Bridge which establishes the basic connection towards your E3DC
## Discovery
There's no discovery. Modbus registers are available for all devices.
There's no discovery.
Modbus registers are available for all devices.
## Thing Configuration
As mentioned earlier in the [Binding Description](#e3dc-binding) the needed Things can be found in the **Modbus Binding** and have to be added manually without Discovery
The needed Things can be found in the **Modbus Binding** and have to be added manually without Discovery
<img align="right" src="./doc/E3DC_Modbus_Settings.png"/>
@ -151,7 +151,8 @@ Some of the Wallbox Settings can be changed. See the Access column if the actual
## Full Example
Following example provides the full configuration. If you enter the correct Connection Data, IP Address, Device ID and Port number in the thing configuration you should be fine.
Following example provides the full configuration.
If you enter the correct Connection Data, IP Address, Device ID and Port number in the thing configuration you should be fine.
### Things
@ -306,8 +307,9 @@ Setup and configured everything the right way? Congratulations, you've now the r
### Persistence
You can see in the example item configuration, that I added some items to the "persist". Feel free to choose your own group name but this opens the possibility
to store the items in a database. See following *.persist file configuration how this can be established.
You can see in the example item configuration, that I added some items to the "persist".
Feel free to choose your own group name but this opens the possibility to store the items in a database.
See following *.persist file configuration how this can be established.
```
Strategies {
@ -325,8 +327,8 @@ Items {
### Visualization
After the timeline is available in your database you can continue with Visualization. I like the Grafana approach and I used the
[InfluxDB & Grafana Tutorial](https://community.openhab.org/t/influxdb-grafana-persistence-and-graphing/13761)
After the timeline is available in your database you can continue with Visualization.
I like the Grafana approach and I used the [InfluxDB & Grafana Tutorial](https://community.openhab.org/t/influxdb-grafana-persistence-and-graphing/13761)
from the Community to set this up.
I prepared my machine and I'm quite pleased with the results.
@ -343,10 +345,11 @@ In the above picture there are two graphs
### Cross Connections
With the above setup you have now a great visualization and overview regarding your electric production and consumption. Now use the Power of openHAB and cross
connect your data. For example you can use the
[OpenweatherMap API Binding](https://www.openhab.org/addons/bindings/openweathermap/)
the cloudiness in Percent. With a modified *.persist file I store the cloudiness forecast also in the database
With the above setup you have now a great visualization and overview regarding your electric production and consumption.
Now use the Power of openHAB and cross connect your data.
For example you can use the [OpenweatherMap API Binding](https://www.openhab.org/addons/bindings/openweathermap/)
the cloudiness in Percent.
With a modified *.persist file I store the cloudiness forecast also in the database
```
Strategies {
@ -367,5 +370,4 @@ Having these values in the timeline you're able to cross check how the forecast
<img style="float: right;" src="doc/GrafanaCloudiness.png">
I personally would like to have
more steering control of the E3DC to react on such forecast e.g. "stop charging the car if it gets too cloudy"
I personally would like to have more steering control of the E3DC to react on such forecast e.g. "stop charging the car if it gets too cloudy"

View File

@ -5,9 +5,6 @@ This extension adds support for the Stiebel Eltron modbus protocol.
An Internet Service Gateway (ISG) with an installed modbus extension is required in order to run this binding.
In case the modbus extension is not yet installed on the ISG, the ISG Updater Tool for the update can be found here: https://www.stiebel-eltron.de/de/home/produkte-loesungen/erneuerbare_energien/regelung_energiemanagement/internet_servicegateway/isg_web/downloads.html
## Supported Things
This bundle adds the following thing types to the Modbus binding.
@ -27,7 +24,6 @@ A typical bridge configuration would look like this:
Bridge modbus:tcp:bridge [ host="10.0.0.2", port=502, id=1 ]
```
## Thing Configuration
You need first to set up a TCP Modbus bridge according to the Modbus documentation.
@ -102,8 +98,6 @@ This group contains about the energy consumption and delivery of the heat pump.
| consumption-water-today | Number:Energy | true | The power consumption for water heating today |
| consumption-water-total | Number:Energy | true | The power consumption for water heating in total |
## Full Example
### Thing Configuration
@ -114,7 +108,6 @@ Bridge modbus:tcp:bridge "Stiebel Modbus TCP"[ host="hostname|ip", port=502, id=
}
```
### Item Configuration
```
@ -154,7 +147,6 @@ Number:Energy stiebel_eltron_consumption_heat_today "Heating power co
Number:Energy stiebel_eltron_consumption_water_today "Water heating power consumption today [%.0f kWh]" { channel="modbus:heatpump:stiebelEltron:energyInformation#consumption_water_today" }
Number:Energy stiebel_eltron_consumption_water_total "Water heating power consumption total [%.3f MWh]" {channel="modbus:heatpump:stiebelEltron:energyInformation#consumption_water_total"}
```
### Sitemap Configuration

View File

@ -8,7 +8,6 @@ It defines how common parameters like AC/DC voltage and current, lifetime produc
SunSpec is supported by several manufacturers like ABB, Fronius, LG, SMA, SolarEdge, Schneider Electric.
For a list of certified products see this page: https://sunspec.org/sunspec-certified-products/
## Supported Things
This bundle adds the following thing types to the Modbus binding.
@ -57,7 +56,6 @@ The following parameters are valid for all thing types:
| refresh | integer | no | 5 | Poll interval in seconds. Increase this if you encounter connection errors |
| maxTries | integer | no | 3 | Number of retries when before giving up reading from this thing. |
## Channels
Channels are grouped into channel groups.
@ -96,7 +94,6 @@ Even if the inverter supports multiple phases this group will appear only once.
Supported by: all inverter things
#### Meters
This group contains summarized values for the power meter over all phases.
@ -122,7 +119,6 @@ This group contains summarized values for the power meter over all phases.
Supported by: all meter things
### AC Phase Specific Group
#### Inverters
@ -155,7 +151,6 @@ acPhaseB: available for meter-split-phase, meter-wye-phase and meter-delta-phase
acPhaseC: available only for meter-wye-phase and meter-delta-phase meters type inverters.
| Channel ID | Item Type | Description |
|--------------------------------|--------------------------|---------------------------------------------------------------------|
| ac-phase-current | Number:ElectricCurrent | Actual current over this line in Watts |
@ -174,7 +169,6 @@ acPhaseC: available only for meter-wye-phase and meter-delta-phase meters type i
| ac-exported-reactive-energy-q3 | Number:Energy | Reactive Energy Exported Quadrant 3 (VARh) |
| ac-exported-reactive-energy-q4 | Number:Energy | Reactive Energy Exported Quadrant 4 (VARh) |
Supported by: all meter things
### DC General Group
@ -190,7 +184,6 @@ DC information is summarized even if the inverter has multiple strings.
Supported by: all inverter things
## Full Example
### Thing Configuration

View File

@ -86,8 +86,8 @@ See [general documentation about serial port configuration](/docs/administration
In the tables below the thing configuration parameters are grouped by thing type.
Things can be configured using Paper UI, or using a `.things` file.
The configuration in this documentation explains the `.things` file, although you can find the same parameters from the Paper UI.
Things can be configured using the UI, or using a `.things` file.
The configuration in this documentation explains the `.things` file, although you can find the same parameters in the UI.
Note that parameter type is very critical when writing `.things` file yourself, since it affects how the parameter value is encoded in the text file.
@ -619,7 +619,7 @@ In this case, boolean input is considered to be either number `0`/`1`, `ON`/`OFF
## Full Examples
Things can be configured via the Paper UI, or using a `things` file like here.
Things can be configured in the UI, or using a `things` file like here.
### Basic Example
@ -1015,14 +1015,14 @@ In extreme cases you might even need more than a poller for a single register so
## Changes From Modbus 1.x Binding
The openHAB 1 Modbus binding is quite different from the openHAB 2 binding.
The biggest difference is that the openHAB 2 binding uses things which can be configured using Paper UI.
The openHAB 1 Modbus binding is quite different from this binding.
The biggest difference is that this binding uses things.
Unfortunately there is no conversion tool to convert old configurations to new thing structure.
Due to the introduction of things, the configuration was bound to be backwards incompatible.
This offered opportunity to simplify some aspects of configuration.
The major differences are configuration logic are:
The major differences in configuration logic are:
### Absolute Addresses Instead Of Relative
@ -1070,7 +1070,6 @@ The new binding supports 32 and 64 bit values types when writing.
Here is a step by step example for a migration from a 1.x configuration to an equivalent 2.x configuration.
It does not cover all features the 1.x configuration offers, but it should serve as an example on how to get it done.
Please note that although you can do all this stuff also using PaperUI, the file based approach is strongly recommended if you need to migrate more than only a handful of Items.
The 1.x modbus configuration to be updated defined 4 slaves:
@ -1202,7 +1201,7 @@ Bridge modbus:tcp:wago [ host="192.168.2.9", port=502, id=1 ] {
}
```
Save this in the `things` subdirectory of your openHAB 2 config.
Save this in the `things` folder.
Watch the file `events.log` as it lists your new added `data` `Things`.
Given that there are no config errors, they quickly change from `INITIALIZING` to `ONLINE`.

View File

@ -11,30 +11,33 @@ The binding uses the [Nanoleaf OpenAPI](https://forum.nanoleaf.me/docs/openapi),
## Supported Things
Currently Nanoleaf's "Light Panels" and "Canvas" devices are supported. Note that only the canvas type does support the touch functionality.
Currently Nanoleaf's "Light Panels" and "Canvas" devices are supported.
Note that only the canvas type does support the touch functionality.
The binding supports two thing types: controller and lightpanel.
The controller thing is the bridge for the individually attached panels/canvas and can be perceived as the nanoleaf device at the wall as a whole (either called "light panels" or "canvas" by Nanoleaf).
With the controller thing you can control channels which affect all panels, e.g. selecting effects or setting the brightness.
The lightpanel (singular) thing controls one of the individual panels/canvas that are connected to each other. Each individual panel has therefore its own id assigned to it.
The lightpanel (singular) thing controls one of the individual panels/canvas that are connected to each other.
Each individual panel has therefore its own id assigned to it.
You can set the **color** for each panel or turn it on (white) or off (black) and in the case of a nanoleaf canvas you can even detect single and double **touch events** related to an individual panel which opens a whole new world of controlling any other device within your openHAB environment.
Note: In case of major changes of a binding (like adding more features to a thing) it becomes necessary to delete your things due to the things not being compatible anymore. Don't worry too much though as they will be easily redetected and nothing really is lost. Just make sure that you delete them and rediscover as described below.
Note: In case of major changes of a binding (like adding more features to a thing) it becomes necessary to delete your things due to the things not being compatible anymore.
Don't worry too much though as they will be easily redetected and nothing really is lost.
Just make sure that you delete them and rediscover as described below.
## Discovery
**Adding the Controller as a Thing**
To add a nanoleaf controller you need to go to your inbox in Paper UI, press the plus sign which **starts a scan** (you can of course use habmin for that as well). Then choose "Nanoleaf Binding".
A controller (also known as bridge) device is discovered automatically through mDNS in the local network.
To add a nanoleaf controller, go to your inbox and start a scan.
Then choose "Nanoleaf Binding".
A controller (bridge) device is discovered automatically using mDNS in your local network.
Alternatively, you can also provide a things file (see below for more details).
After the device is discovered and added as a thing, it needs a valid authentication token that must be obtained by pairing it with your openHAB instance.
Without the token the light panels remain in status OFFLINE.
The binding supports pairing of the device with your openHAB instance as follows:
1. Make sure that the authentication token field in your Nanoleaf controller thing configuration is left empty.
@ -46,10 +49,11 @@ Tip: if you press (2) just before adding the item from the inbox it usually catc
**Adding the invidual light panels as a thing**
After you have added the controller as a thing and it has been successfully paired as described as above, the individual panels connected to it can be discovered by **starting another scan** for the Nanoleaf binding (e.g. from the Inbox in Paper UI).
After you have added the controller as a thing and it has been successfully paired as described as above, the individual panels connected to it can be discovered by **starting another scan** for the Nanoleaf binding.
All connected panels will be added as separate things to the inbox.
Troubleshooting: In seldom cases (in particular together with updating the binding) things or items do not work as expected, are offline or may not be detected. In this case
Troubleshooting: In seldom cases (in particular together with updating the binding) things or items do not work as expected, are offline or may not be detected.
In this case:
- remove the panels (maybe twice by force removing it)
- remove the controller (maybe twice by force removing it)
@ -58,12 +62,11 @@ Troubleshooting: In seldom cases (in particular together with updating the bindi
**Knowing which panel has which id**
Unfortunately it is not easy to find out which panel gets which id while this is pretty important if you have lots of them and you want to assign rules to it.
Don't worry: the binding comes with some helpful support in the background the canvas type (this is only provided for the canvas device because triangles can have weird layouts that are hard to express in a log output)
Unfortunately it is not easy to find out which panel gets which id, and this becomes pretty important if you have lots of them and want to assign rules.
Don't worry as the binding comes with some helpful support in the background the canvas type (this is only provided for the canvas device because triangles can have weird layouts that are hard to express in a log output)
- fire up your browser and open the openHAB server on port 9001 which shows the logs.
- Set up a switch item with the channel panelLayout on the controller (see NanoRetrieveLayout below) and set the switch to true
- look out for something like "Panel layout and ids" in the logs. Below that you will see a panel layout similar to
- look out for something like "Panel layout and ids" in the openHAB logs. Below that you will see a panel layout similar to
Compare the following output with the right picture at the beginning of the article
@ -126,7 +129,6 @@ A lightpanel thing has the following channels:
| singleTap | Switch | [Canvas Only] Is set when the user taps that panel once (1 second pulse) | Yes |
| doubleTap | Switch | [Canvas Only] Is set when the user taps that panel twice (1 second pulse) | Yes |
**color and panelColor**
The color and panelColor channels support full color control with hue, saturation and brightness values.
@ -144,8 +146,6 @@ What might not be obvious and even maybe confusing is the fact that brightness a
- The the first panelColor command is applied to that panel (and of course then all subsequent commands)
- The fact that it is called a static effect does not mean that you cannot create animations. The Rainbow rule below shows a good example for the whole canvas. Just replace the controller item with a panel item and you will get the rainbow effect with an individual panel.
**Touch Support**
Nanoleaf's Canvas introduces a whole new experience by adding touch support to it. This allows single and double taps on individual panels to be detected and then processed via rules to further control any other device!

View File

@ -1,6 +1,8 @@
# Neato Binding
This binding is used to connect your openHAB 2 system with Neato web (where you log in and find Your Neato's). The binding supports discovery via configuring your login and password to a bridge. From the binding, you will get status of your vacuum cleaners and also a command channel where you can control them. Since the binding uses a polling mechanism, there may be some latency depending on your setting regarding refresh time.
This binding is used to connect your openHAB system with Neato web (where you log in and find Your Neato's).
The binding supports discovery via configuring your login and password to a bridge.
From the binding, you will get status of your vacuum cleaners and also a command channel where you can control them. Since the binding uses a polling mechanism, there may be some latency depending on your setting regarding refresh time.
For log in transaction, the binding uses Neato Beehive API and for status and control, the binding uses Nucleao API.
@ -26,7 +28,9 @@ Discovery is used _after_ a bridge has been created and configured with your log
## Thing Configuration
In order to manually create a thing file and not use the discovery routine you will need to know the vacuums serial number as well as the secret used in web service calls. This is a bit difficult to get. The easiest way of getting this information is to use the third party python library that is available at https://github.com/stianaske/pybotvac.
In order to manually create a thing file and not use the discovery routine you will need to know the vacuums serial number as well as the secret used in web service calls.
This is a bit difficult to get.
The easiest way of getting this information is to use the third party python library that is available at https://github.com/stianaske/pybotvac.
Neato Account Config
@ -107,4 +111,3 @@ Frame label="Neato BotVac Connected" {
```
neato:vacuumcleaner:fanndamm [ serial="vacuumcleaner-serial", secret="secret-string"]
```

View File

@ -33,7 +33,7 @@ This binding supports direct serial port connection (RS-485 adapter needed) to h
## Discovery
Discovery is not supported, therefore the binding and things need to be configured via Paper UI or thing files.
Discovery is not supported.
## Prerequisites
@ -111,7 +111,7 @@ No binding configuration required.
## Thing Configuration
Things can be fully configured via Paper UI.
Things can be fully configured via the UI.
The following information is useful when configuring things via thing configuration files.
### UDP connection

View File

@ -302,8 +302,7 @@ Following models/channels are currently available:
### Custom Channels
An arbitrary number of custom channels can be added via paper-ui or file based configuration.
The recommended way is to use paper-ui as this is much easier to use.
An arbitrary number of custom channels can be added via the UI or using file based configuration.
There are three custom channel types available, which allow different scaling of the raw values retrieved from the NIBE API:
- type-number-unscaled

View File

@ -34,7 +34,7 @@ Connected to a bridge, the Niko Home Control Binding supports alloff actions, on
## Binding Configuration
The bridge representing the Niko Home Control IP-interface needs to be added first in the things file or through Paper UI.
The bridge representing the Niko Home Control IP-interface needs to be added first.
A bridge can be auto-discovered or created manually.
An auto-discovered bridge will have an IP-address parameter automatically filled with the current IP-address of the IP-interface.
This IP-address for the discovered bridge will automatically update when the IP-address of the IP-interface changes.
@ -66,19 +66,19 @@ A discovery scan will first discover the Niko Home Control IP-interface or Niko
Default parameters will be used.
Note that this may fail to find the correct Niko Home Control IP-interface when there are multiple IP-interfaces in the network, or when traffic to port 10000 on the openHAB server is blocked.
When the Niko Home Control bridge is added as a thing, from the discovery inbox or manually, system information will be read from the Niko Home Control Controller and will be put in the bridge properties, visible through Paper UI.
When the Niko Home Control bridge is added as a thing, the system information will be read from the Niko Home Control Controller and will update the bridge properties.
Subsequently, all defined actions that can be triggered from a smartphone/tablet in the Niko Home Control I system, respectively all actions in the Niko Home Control II system, will be discovered and put in the inbox.
It is possible to trigger a manual scan for things on the Niko Home Control bridge.
Note that Niko Home Control II will require the token to be set on the bridge before the scan for actions can succeed.
The bridge will remain offline as long as these parameters are not set.
If the Niko Home Control system has locations configured, these will be copied to thing locations and grouped as such in Paper UI.
Locations can subsequently be changed through the thing location parameter in Paper UI.
If the Niko Home Control system has locations configured, these will be copied to thing locations and grouped as such.
Locations can subsequently be changed through the thing location parameter.
## Thing Configuration
Besides using Paper UI to manually configure things or adding automatically discovered things through Paper UI, you can add thing definitions in the things file.
If you wish to use textual config instead of automatic discovery, you can add thing definitions to a things file.
The Thing configuration for the **bridge** uses the following syntax:

View File

@ -13,8 +13,6 @@ This binding allows you to integrate, view, control and configure the Nuki Bridg
It is absolutely recommended to configure static IP addresses for both, the openHAB server and the Nuki Bridge!
You can configure the Nuki Binding either by using Paper UI or manually through text files.
### Nuki Bridge Callback
The Nuki Binding will manage the required callback from the Nuki Bridge to the openHAB server if *manageCallbacks* is set to `true`.

View File

@ -2,13 +2,11 @@
This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on Raspberry Pi.
## Supported Things
Temperature sensors.
Tested successfully with DS18B20 sensor on Raspberry Pi 3.
## Binding Configuration
The binding requires OneWire sensor to be properly connected to Raspberry Pi GPIO bus,
@ -34,7 +32,6 @@ Thing onewiregpio:sensor:livingRoom "Living room" [gpio_bus_file="/sys/bus/w1/de
The devices supports currently one channel - "temperature" which allows to read temperature from OneWire temperature sensor.
## Full Example
sample onewiregpio.things file content:

View File

@ -4,15 +4,9 @@ This binding uses the [OpenUV Index API service](https://www.openuv.io/) for pro
To use this binding, you first need to [register and get your API token](https://www.openuv.io/auth/google).
## Binding Installation
This binding can be installed via the Add-ons section of the Paper UI.
Go to Bindings and search for `OpenUV`. Click on install.
## Discovery
Once a bridge with the api Key has been created, Local UV Index informations can be autodiscovered based on system location.
Once a bridge with the api Key has been created, Local UV Index informations can be auto discovered based on system location.
## Binding Configuration
@ -100,4 +94,3 @@ Number:Angle Elevation "Elevation" {channel="astro:sun:home:position#elev
channel="openuv:uvreport:local:city1:elevation" [profile="follow"] }
```

View File

@ -51,7 +51,7 @@ The following Things and OpenWebNet `WHOs` are supported:
## Discovery
Gateway and Things discovery is supported using PaperUI by pressing the discovery ("+") button form Inbox.
Gateway and Things discovery is supported by this binding.
### BUS/SCS Discovery
@ -88,8 +88,6 @@ If a device cannot be discovered automatically it's always possible to add it ma
### Configuring BUS/SCS Gateway
To add a BUS gateway manually using PaperUI: go to *Inbox > "+" > OpenWebNet > click `ADD MANUALLY`* and then select `BUS Gateway`.
Configuration parameters are:
- `host` : IP address / hostname of the BUS/SCS gateway (`String`, *mandatory*)
@ -105,8 +103,6 @@ Alternatively the BUS/SCS Gateway thing can be configured using the `.things` fi
### Configuring Wireless ZigBee USB Gateway
To add a ZigBee USB Gateway manually using PaperUI: go to *Inbox > "+" > OpenWebNet > click `ADD MANUALLY`* and then select `ZigBee USB Gateway`.
Configuration parameters are:
- `serialPort` : the serial port where the ZigBee USB Gateway is connected (`String`, *mandatory*)
@ -114,9 +110,8 @@ Configuration parameters are:
### Configuring Devices
Devices can be discovered automatically from Inbox after a gateway has been configured and connected.
Devices can be also added manually from PaperUI. For each device it must be configured:
Devices can be discovered automatically after a gateway has been configured and connected.
For any manually added devices, you must configure:
- the associated gateway (`Bridge Selection` menu)
- the `where` config parameter (`OpenWebNet Device Address`):
@ -179,7 +174,6 @@ Items (Light, Dimmer, etc.) will be discovered by Google Assistant/Alexa/HomeKit
```xtend
Switch iLR_switch "Light" <light> (gLivingRoom) [ "Lighting" ] { channel="openwebnet:bus_on_off_switch:mybridge:LR_switch:switch" }
Dimmer iLR_dimmer "Dimmer [%.0f %%]" <DimmableLight> (gLivingRoom) [ "Lighting" ] { channel="openwebnet:bus_dimmer:mybridge:LR_dimmer:brightness" }
/* For Dimmers, use category DimmableLight to have Off/On switch in addition to the Percent slider in PaperUI */
Rollershutter iLR_shutter "Shutter [%.0f %%]" <rollershutter> (gShutters, gLivingRoom) [ "Blinds" ] { channel="openwebnet:bus_automation:mybridge:LR_shutter:shutter" }
```

View File

@ -12,7 +12,7 @@ This binding requires an adapter to interface to the Pentair system bus.
This bus/wire runs between the Pentair control system, indoor control panels, IntelliFlo pumps, etc.
It is a standard RS-485 bus running at 9600,8N1 so any RS-485 adapter should work and you should be able to buy one for under $30.
Pentair does not publish any information on the protocol so this binding was developed using the great reverse-engineering efforts of others made available on the internet.
I have cited sevearl of those in the References section below.
I have cited several of those in the References section below.
### Connecting adapter to your system
@ -24,7 +24,7 @@ An example setup would run the following command: "ser2sock -p 10000 -s /dev/tty
Note: This is the setup utlized for the majority of my testing of this binding.
Note: If you are on a Linux system, the framework may not see a symbolically linked device (i.e. /dev/ttyRS485).
To use a symbolically linked device, add the following line to /etc/default/openhab2, `EXTRA_JAVA_OPTS="-Dgnu.io.rxtx.SerialPorts=/dev/ttyRS485"`
To use a symbolically linked device, add the following line to */etc/default/openhab* `EXTRA_JAVA_OPTS="-Dgnu.io.rxtx.SerialPorts=/dev/ttyRS485"`
Once you have the interface connected to your system, it is best to test basic connectivity.
Note the protocol is a binary protocol (not ASCII text based) and in order to view the communication packets, one must use a program capable of a binary/HEX mode.
@ -56,14 +56,12 @@ This binding supports the following thing types:
| Intelliflo Pump | Thing | Pentair Intelliflo variable speed pump. |
| Intellichlor | Thing | Pentair Intellichlor chlorinator. |
## Binding Configuration
There are no overall binding configurations that need to be set up as all configuration is done at the "Thing" level.
## Thing Configuration
Pentair things can be configured either through the online Paper UI configuration, or manually through a 'pentair.thing' configuration file.
The following table shows the available configuration parameters for each thing.
| Thing | Configuration Parameters |
@ -76,7 +74,7 @@ The following table shows the available configuration parameters for each thing.
| | pollPeriod - Period of time in minutes between the poll command being sent to the IT-100 bridge - Not Required - default=1. |
| | id - ID to use when communciating on Pentair control bus - default = 34. |
Currently automatic discovery is not supported and the binding requires configuration via the Paper UI or a file in the conf/things folder.
Currently automatic discovery is not supported.
Here is an example of a thing configuration file called 'pentair.things':
```

View File

@ -63,9 +63,9 @@ and then you will be able to use /dev/rfxtrx0 as the serial device regardless of
### Manual Configuration
If you have any problems with JD2XX or you don't want to disable FTDI driver on OS X or Linux, you can also configure RFXCOM transceivers/receivers manually.
If you have any problems with JD2XX, or you don't want to disable FTDI driver under OS X or Linux, you can also configure RFXCOM transceivers/receivers manually.
To do that via the Paper UI, manually add the generic RFXCOM device named `RFXCOM USB Transceiver`, with the description "This is universal RFXCOM transceiver bridge for manual configuration purposes".
To do that, manually add the generic RFXCOM device named `RFXCOM USB Transceiver`, with the description "This is universal RFXCOM transceiver bridge for manual configuration purposes".
You will need to specify at least the serial port which has been assigned to the RFXCOM (see notes above).
To configure the serial port within openHAB see the [general documentation about serial port configuration](/docs/administration/serial.html).
@ -86,7 +86,7 @@ To start a TCP server for an RFXCOM device, you can use socat:
socat tcp-listen:10001,fork,reuseaddr file:/dev/ttyUSB0,raw
```
A TCP bridge, for use with socat on a remote host, can only be configured manually either through the Paper UI by adding an "RFXCOM USB Transceiver over TCP/IP" device or in a thing file like this:
A TCP bridge, for use with socat on a remote host, can be configured manually, or by adding an "RFXCOM USB Transceiver over TCP/IP" device or in a thing file like this:
```
Bridge rfxcom:tcpbridge:sunflower [ host="sunflower", port=10001 ] {
@ -196,23 +196,16 @@ The binding uses the following system channels:
| system.battery-level | Number | Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (eg 4 levels) should convert to a percentage to provide a consistent battery level reading. |
| system.low-battery | Switch | Represents a low battery warning with possible values on/off. |
## Full example
### Thing files
Sensors/actuators are easy to configure through the Paper UI.
However, if you used a thing file for your RFXCOM you can also configure them manually there as well, for example:
## Full Example
*.thing
```
Bridge rfxcom:bridge:usb0 [ serialPort="/dev/<device>" ] {
Thing lighting2 100001_1 [ deviceId="100001.1", subType="AC" ]
}
```
### Item files
Items may be created through Paper UI or add using item files in which you add a channel parameter specifying the bridge's name, the thing ID and channel that the item should be linked to, for example:
*.items
```
Switch Switch {channel="rfxcom:lighting2:usb0:100001_1:command"}
```
@ -731,7 +724,7 @@ A Lighting4 device
The support for lighting 4 in RFXCOM is less complete because a lot of different devices use the same chips and can not easily be distinguished.
So some extra configuration can be used for fine tuning the behavior of your Lighting4 devices.
For configuration via the Paper UI three extra fields are available, being the the pulse length and a commmand id for on and off commands.
When configuring, three extra fields are available, being the the pulse length, and a separate command id for both on and off.
If your item is auto-discovered normally the on or off command should be recognized properly.
For a USB attached RFXCOM on Windows the configuration could look like this (note that the `onCommandId`, `offCommandId` and `pulse` are all optional):

View File

@ -22,7 +22,7 @@ Although it seems to work a majority of the times, there have been instances whe
## Device Discovery
The Russound binding does support devices discovery via the Paper UI.
The Russound binding does support discovery.
When you start device discovery, the system will scan all network interfaces and **all IP Addresses in the subnet on each interface** looking for a Russound system device.
If found, the device will be added to the inbox.
Adding the device will then start a scan of the device to discover all the controllers, sources, and zones attached defined on the device.

View File

@ -49,7 +49,6 @@ Thing samsungtv:tv:livingroom [ hostName="192.168.1.10", port=55000, macAddress=
```
Different ports are used in different models. It may be 55000, 8001 or 8002.
Try to scan for new Things in Paper UI to find TV easily.
## Channels
@ -104,4 +103,4 @@ Values are confirmed to work on UE50MU6179.
| YouTube | `YouTube` | YouTube App |
| ZDF Mediathek | `ZDF mediathek` | German public TV broadcasting app |
As part of discovery, log file `/var/log/openhab2/openhab.log` will contain a debug line with installed apps.
To discover all installed apps names, you can enable the DEBUG log output from the binding to see a list.

View File

@ -20,7 +20,7 @@ If the Configuration Parameters are all valid, then the Climatix IC Account Thin
If the sign on succeeds, the Thing will indicate its status as Online, otherwise it will show an error status.
Once the Thing of the type Climatix IC Account has been created and successfully signed on to the cloud server, it will automatically interrogate the server to discover all the respective RDS Smart Thermostat Things associated with that account.
After a short while, all discovered RDS Smart Thermostat Things will be displayed in the Paper UI Inbox.
After a short while, all discovered RDS Smart Thermostat Things will be displayed in the Inbox.
If in future you add new RDS Smart Thermostat devices to your Siemens account (e.g. via the Siemens App) then these new devices will also appear in the Inbox.
## Thing Configuration for "Climatix IC Account"
@ -41,7 +41,7 @@ Note: You must create ONLY ONE Thing of the type Climatix IC Account; duplicate
## Thing Configuration for "RDS Smart Thermostat"
Each RDS Smart Thermostat Thing is identified in the Climatix IC Account by means of a unique Plant Id code.
The Paper UI automatic discovery process determines the Plant Id codes of all connected thermostats automatically.
The automatic discovery determines the Plant Id codes of all connected thermostats automatically.
| Configuration Parameter | Description |
|-------------------------|-------------------------------------------------------------------------------------------------------------|
@ -75,7 +75,6 @@ Bridge siemensrds:climatixic:mybridgename "Climatix IC Account" [ userEmail="ema
```
To manually configure an RDS Smart Thermostat Thing requires knowledge of the "Plant Id" which is a unique code used to identify a specific thermostat device in the Siemens Climatix IC cloud server account.
The Paper UI automatic Discovery service (see above) discovers the "Plant Id" codes during the discovery process.
```
Bridge siemensrds:climatixic:mybridgename "Climatix IC Account" [ userEmail="email@example.com", userPassword="secret", apiKey="32-character-code-provided-by-siemens", pollingInterval=60 ] {

View File

@ -1,6 +1,6 @@
# Samsung Smartthings Binding
This binding integrates the Samsung Smartthings Hub into openHAB. This is implemented as an openHAB 2 binding.
This binding integrates the Samsung Smartthings Hub into openHAB.
## Supported things

View File

@ -13,15 +13,9 @@ This binding has been tested with myLink firmware 5.23.
## Discovery
To start a discovery:
- install this binding
- open Paper UI
- add a new thing in menu Configuration/Things
- choose SomfyMyLink Binding and select Somfy MyLink Bridge
- enter it's IP Address and system id. The system id This can be found in the integration settings -> Control4 section of your My Link app
If the supplied ip address and system id are correct, the automatic discovery starts immediately and detected roller shades appear in Paper UI inbox.
To use auto discovery first setup a Somfy MyLink bridge, then supply its IP address and system id.
The system id can be found in the integration settings -> Control4 section of your My Link app.
Once the Somfy MyLink bridge is ONLINE you can start a scan that will detect and add to your Inbox any discovered roller shades.
## Thing Configuration

View File

@ -46,18 +46,13 @@ Both Somfy Tahoma and Somfy Connexoon gateways have been confirmed working.
To start a discovery, just
- install this binding
- open Paper UI
- add a new thing in menu Configuration/Things
- choose SomfyTahoma Binding and select Somfy Tahoma Bridge
- enter your email (login) and password to the TahomaLink cloud portal
- Add a new Somfy Tahoma bridge thing.
- Configure the bridge with your email (login) and password to the TahomaLink cloud portal.
If the supplied TahomaLink credentials are correct, the automatic discovery starts immediately and detected roller shutters, awnings, switches and action groups appear in Paper UI inbox.
If the supplied TahomaLink credentials are correct, the automatic discovery can be used to scan and detect roller shutters, awnings, switches and action groups that will appear in your Inbox.
## Thing Configuration
To manually configure the thing you have to specify bridge and things in *.things file in conf/addons directory of your openHAB 2.x installation.
To manually link the thing channels to items just use the *.items file in conf/items directory of your openHAB 2.x installation.
To retrieve thing configuration and url parameter, just add the automatically discovered device from your inbox and copy its values from thing edit page. (the url parameter is visible on edit page only)
Please see the example below.

View File

@ -32,7 +32,7 @@ The binding has the following configuration options, which can be set for "bindi
## Thing Configuration
The Sonos Thing requires the UPnP UDN (Unique Device Name) as a configuration value in order for the binding to know how to access it.
All the Sonos UDN have the "RINCON_000E58D8403A0XXXX" format (value to be found via Sonos item in the Paper UI Inbox).
All the Sonos UDN have the "RINCON_000E58D8403A0XXXX" format (value to be found via Sonos item in the Inbox).
Additionally, a refresh interval, used to poll the Sonos device, can be specified (in seconds).
You can use the `notificationVolume` property for setting a default volume (in percent) to be used to play notifications.
In the thing file, this looks e.g. like

View File

@ -20,7 +20,7 @@ Follow instructions under:
When registering your new Spotify Application for openHAB Spotify Bridge you have to specify the allowed "Redirect URIs" aka white-listed addresses.
Here you have to specify the URL to the Bridge Authorization Servlet on your server.
For example if you run your openHAB server on `http://openhabianpi:8080` you should add [http://openhabianpi:8080/connectspotify](http://openhabianpi:8080/connectspotify) as the redirect URIs.
For example if you run your openHAB server on `http://openhab:8080` you should add [http://openhab:8080/connectspotify](http://openhab:8080/connectspotify) as the redirect URIs.
This is important since the authorize process with Spotify takes place using your client web browser and Spotify will have to know the right URLs to your openHAB server for the authorization to be completed.
When you have authorized with Spotify, this Redirect URI is where authorization tokens for your openHAB Spotify Brigde will be sent and they have to be received by the servlet on `/connectspotify`.
@ -30,13 +30,13 @@ When you have authorized with Spotify, this Redirect URI is where authorization
1. Install the binding and make sure the _Spotify Binding_ is listed on your server
1. Complete the Spotify Application Registation if you have not already done so, see above.
1. Make sure you have your Spotify Application _Client ID_ and _Client Secret_ identities available.
1. Go to to your preferred openHAB admin UI and add a new Thing. Select the **"Spotify Player Bridge"**. Choose new Id for the player, unless you like the generated one, put in the _Client ID_ and _Client Secret_ from the Spotify Application registration in their respective fields of the bridge configuration. You can leave the _refreshPeriod_ as is. Save the bridge.
1. Add a new **"Spotify Player Bridge"** thing. Choose new Id for the player, unless you like the generated one, put in the _Client ID_ and _Client Secret_ from the Spotify Application registration in their respective fields of the bridge configuration. You can leave the _refreshPeriod_ as is. Save the bridge.
1. The bridge thing will stay in state _INITIALIZING_ and eventually go _OFFLINE_ - this is fine. You have to authorize this bridge with Spotify.
1. Go to the authorization page of your server. `http://<your openHAB address>:8080/connectspotify`. Your newly added bridge should be listed there.
1. Press the _"Authorize Player"_ button. This will take you either to the login page of Spotify or directly to the authorization screen. Login and/or authorize the application. If the Redirect URIs are correct you will be returned and the entry should show you are authorized with you Spotify user name/id. If not, go back to your Spotify Application and ensure you have the right Redirect URIs.
1. The binding will be updated with a refresh token and go _ONLINE_. The refresh token is used to re-authorize the bridge with Spotify Connect Web API whenever required.
Now that you have got your bridge _ONLINE_ it is time to discover your devices! Go to Paper UI Inbox and search for Spotify Connect Devices. Any device currently available on your account should show up immediately.
Now that you have got your bridge _ONLINE_ you can now start a scan with the binding to auto discover your devices.
If no devices show up you can start Spotify App on your PC/Mac/iOS/Android and start playing on your devices as you run discovery.
This should make any Spotify Connect devices and Spotify Apps discoverable.

View File

@ -125,26 +125,8 @@ If you receive the error because you are running an old Linux installation which
2.) Download the most recent JDK and install it directly on to your system without using a pre-composed package
On Debian based systems one can use: http://www.webupd8.org/2012/09/install-oracle-java-8-in-ubuntu-via-ppa.html
3.) Update the cacerts store by importing the missing certificate
Note: Using this version, loaded certificates will expire!
If you still want to import the missing certificate, the example below may help:
Check which Java package you have installed:
```java
>> sudo dpkg -l | grep java
>> ii oracle-java8-jdk 8u65 armhf Java™ Platform, Standard Edition 8 Development Kit
```
Find the ca-store of your JDK
```java
>> sudo dpkg -L oracle-java8-jdk | grep cacerts
>> /usr/lib/jvm/jdk-8-oracle-arm32-vfp-hflt/jre/lib/security/cacerts
```
Check which CA has validated the certificate
Navigate to https://creativecommons.tankerkoenig.de/
@ -156,7 +138,7 @@ Export the certificate of the certificate authority
Import the certificate to the CA-store which you have found
```java
>> cd /usr/lib/jvm/jdk-8-oracle-arm32-vfp-hflt/jre/lib/security
>> cd /usr/lib/jvm/jdk-11-oracle-arm32-vfp-hflt/jre/lib/security
>> keytool -import -keystore cacerts -alias LetsEncrypt -file ca.crt
```

View File

@ -45,8 +45,7 @@ The binding itself requires no configuration.
## Thing Configuration
Only the bridges require manual configuration.
It is preferable that devices and sensors are discovered automatically; let the discovery/inbox initially configure them.
You can add them either with karaf: `inbox approve <thingId>` or by using the inbox of the Paper UI.
It is preferable that devices and sensors are discovered automatically; let the discovery initially configure them.
### Dimmers & switches

View File

@ -71,8 +71,7 @@ Note: Tibber HomeId is retrieved from [www.developer.com](https://developer.tibb
* Sign in (Tibber user account) and "load" personal token.
* Copy query from below and paste into the Tibber API Explorer, and run query.
* If Tibber Pulse is connected, the Tibber API Explorer will report "true" for "realTimeConsumptionEnabled"
* Copy HomeId from Tibber API Explorer, without quotation marks, and paste into Paper UI configuration
* Copy HomeId from Tibber API Explorer, without quotation marks, and use this in the bindings configuration.
```
{
@ -87,16 +86,15 @@ Note: Tibber HomeId is retrieved from [www.developer.com](https://developer.tibb
}
```
If user have multiple HomeIds / Pulse, separate Things have to be created for the different/desired HomeIds in Paper UI.
If user have multiple HomeIds / Pulse, separate Things have to be created for the different/desired HomeIds.
## Thing Configuration
When Tibber Binding is installed, Tibber API should be autodiscovered in Paper UI.
When Tibber Binding is installed, Tibber API should be auto discovered.
Retrieve personal token and HomeId from description above, and initialize/start Binding from Paper UI.
Retrieve personal token and HomeId from description above, and initialize/start a scan with the binding.
Tibber API will be autodiscovered if provided input is correct.
Tibber API will be auto discovered if provided input is correct.
## Full Example

View File

@ -12,7 +12,6 @@ Pushbutton, temperature sensors and input module states are retrieved and made a
## Supported Things
A Velbus configuration module (e.g. VMBRSUSB) or a network server (e.g. [VelServer](https://github.com/StefCoene/velserver/wiki/TCP-server-for-Velbus)) is required as a "bridge" for accessing any other Velbus devices.
The supported Velbus devices are:
@ -21,7 +20,7 @@ The supported Velbus devices are:
vmb1bl, vmb1bls, vmb1dm, vmb1led, vmb1ry, vmb1ryno, vmb1rynos, vmb1rys, vmb1ts, vmb2bl, vmb2ble, vmb2pbn, vmb4an, vmb4dc, vmb4ry, vmb4ryld, vmb4ryno, vmb6in, vmb6pbn, vmb7in, vmb8ir, vmb8pb, vmb8pbu, vmbdme, vmbdmi, vmbdmir, vmbel1, vmbel2, vmbel4, vmbelo, vmbgp1, vmbgp2, vmbgp4, vmbgp4pir, vmbgpo, vmbgpod, vmbmeteo, vmbpirc, vmbpirm, vmbpiro
```
The type of a specific device can be found in the configuration section for things in the Paper UI.
The type of a specific device can be found in the configuration section for things in the UI.
It is part of the unique thing id which could look like:
```
@ -41,7 +40,7 @@ The discovery scan will also retrieve the channel names of the Velbus devices.
## Thing Configuration
The Velbus bridge needs to be added first in the things file or through Paper UI.
The Velbus bridge needs to be added first.
For the Velbus Serial Bridge it is necessary to specify the serial port device used for communication.
On Linux systems, this will usually be either `/dev/ttyS0`, `/dev/ttyUSB0` or `/dev/ttyACM0` (or a higher number than `0` if multiple devices are present).

View File

@ -35,13 +35,12 @@ Note: The mapping of things and channels to the heating system addresses must be
## Discovery
The binding discovers the adapter with broadcast and put the found `vitotronic:bridge` into the inbox.
The binding discovers the adapter with broadcast and puts any `vitotronic:bridge` found into the inbox.
For automatic detection the adapter and **openHAB** must be on the same LAN.
The discovery itself must be start in the Paper UI.
If the bridge isn't on the same LAN the bridge can also add manually.
If the bridge isn't on the same LAN, you will need to add manually.
In this case the `IP-Address` and the `adapterID` is required.
Íf the `vitotronic:bridge` added a second discovery will be start.
It discovers all things, define in the adapter and put found things into the inbox.
After the `vitotronic:bridge` is ONLINE, start a second discovery.
It discovers all things, and places them in the inbox.
## Binding Configuration

View File

@ -31,15 +31,11 @@ Once the bridge created, you will be able to launch discovery of the vehicles at
The 'VolvoOnCall API' bridge uses the owner's email address and password in order to access the VOC Remote API.
| Parameter | Name | Description | Required |
|-----------------|------------------|---------------------------------------------------------|----------|
| vin | Vin | Vehicle Identification Number of the car | yes |
| refreshinterval | Refresj Interval | Interval in minutes to refresh the data (default=10) | yes |
## Channels
All numeric channels use the [UoM feature](https://openhab.org/blog/2018/02/22/units-of-measurement.html).
@ -47,7 +43,6 @@ This means you can easily change the desired unit e.g. miles/h instead of km/h j
#####Thing properties
Some of the channels are only available for specific cars and models.
Availability of specific action can be found in PaperUI -> Configuration -> Things -> <your car thing> -> SHOW PROPERTIES
Following channels are currently available:
@ -100,7 +95,6 @@ Following channels are currently available:
| lasttrip#startPosition | Location | Last trip start location | |
| lasttrip#endPosition | Location | Last trip end location | |
## Events
| Channel Type ID | Options | Description |

View File

@ -19,7 +19,7 @@ Other LD*** devices might work but probably need some small adaptations.
## Discovery
The LED WiFi Controllers can be discovered by triggering a search in openHAB's inbox.
The LED WiFi Controllers can be auto discovered.
Your device needs to be connected to your local network (i.e. by using the WiFi PBC connection method or the native App shipped with the device).
Read the device manual for more information about how to connect your device to your network.
@ -29,7 +29,6 @@ No binding configuration required.
## Thing Configuration
The Thing can be configured through the Paper UI.
Use the configuration if you have devices of type LD382 or LD686, want to enable color fading,
or if the device discovery does not find your LED controller automatically.
@ -57,8 +56,8 @@ The polling period is a parameter only used by the CLASSIC driver and specifies
### Device Discovery
If the automatic discovery fails, you have to set the IP address and the port of your device manually. Make sure that the
device protocol matches your device type.
If the automatic discovery fails, you have to set the IP address and the port of your device manually.
Make sure that the device protocol matches your device type.
## Channels

View File

@ -20,8 +20,8 @@ This binding supports the following version of WlanThermo:
## Discovery
There is no auto-discovery of WlanThermo Things.
Things must be created manually, e.g. via PaperUI.
There is no auto-discovery for WlanThermo Things.
Things must be created manually.
## Thing Configuration

View File

@ -75,7 +75,7 @@ Once the XmlTV bridge to a file is created, you can add all known channels by se
### xmltv.things
```
Bridge xmltv:xmltvfile:france "XmlTV" @ "TV" [filePath="/etc/openhab2/scripts/tvguide.xml"]
Bridge xmltv:xmltvfile:france "XmlTV" @ "TV" [filePath="/etc/openhab/scripts/tvguide.xml"]
{
Thing channel france2 "France 2" @ "TV" [channelId="C4.api.telerama.fr", offset=0, refresh=60]
}

View File

@ -78,7 +78,7 @@ Only the Z-Way server can be configured textual:
```
Bridge zway:zwayServer:192_168_2_42 [ zwayServerIpAddress="localhost", zwayServerPort=8083, zwayServerProtocol="http", zwayServerUsername="admin", zwayServerPassword="admin", pollingInterval=3600 ] {
// associated things have to be created with the Paper UI
// associated things have to be created with the UI
}
```