]> git.basschouten.com Git - openhab-addons.git/commitdiff
[Konnected] Refreshed readme to include latest changes (#13294)
authorHaavar Valeur <github.com@haavar.com>
Sat, 20 Aug 2022 21:02:05 +0000 (14:02 -0700)
committerGitHub <noreply@github.com>
Sat, 20 Aug 2022 21:02:05 +0000 (23:02 +0200)
* Refreshed readme to include latest changes

Signed-off-by: Haavar Valeur <haavar@haavar.com>
bundles/org.openhab.binding.konnected/README.md

index 32758622f815ba06a88e9213110031219cdc3ec0..dff17d8317883eb31ced07f2c3566ceeefcd3641 100644 (file)
@@ -1,13 +1,13 @@
 # Konnected Binding
 
-This binding is for interacting with the [Konnected Alarm Panel](https://konnected.io/).
-A module which interfaces with existing home security sensors.
-Konnected is an open-source firmware and software that runs on a NodeMCU ESP8266 (Wi-Fi) or ESP32 (Pro) device.
+This binding is for interacting with a [Konnected Alarm Panel](https://konnected.io/). 
+Konnected Alarm Panels can connect to security sensors directly or interface with existing alarm panels. 
+Konnected is an open-source firmware and software that runs on a NodeMCU
 The Konnected hardware is designed for an alarm panel installation, but the general purpose firmware/software can be run on a generic NodeMCU device.
 
 ## Supported Things
-``
-This binding supports two types of thing modules, which represents the Wi-Fi version of the Konnected Alarm Panel and the Konnected Alarm Panel Pro.
+
+This binding supports two types of things, the Konnected Alarm Panel and the Konnected Alarm Panel Pro.
 
 ## Discovery
 
@@ -16,13 +16,21 @@ The binding will then create things for each module discovered which can be adde
 
 ## Thing Configuration
 
-The binding attempts to discover The Konnected Alarm Panels via the UPnP service.
-The auto-discovery service of the binding will detect the ip address and port of the Konnected Alarm Panel.
+The binding attempts to discover The Konnected Alarm Panels via the UPnP service. 
+The auto-discovery service of the binding will detect the base URL of the Konnected Alarm Panel. 
+When manually adding things, the base URL of the Konnected Alarm Panel will need to be configured. 
+The base URL should include scheme, address and port (for example http://192.168.1.123:9123).
+
 The binding will attempt to obtain the ip address of your openHAB server as configured in the OSGi framework.
-However, if it is unable to determine the ip address it will also attempt to use the network address service to obtain the ip address and port.
+If it is unable to determine the IP address it will also attempt to use the network address service to obtain the IP address and port.
+Auto-discovery of the callback URL will fail if you are using reverse proxies and/or HTTPS for your openHAB server. 
+In this case you will need to configure the callback URL in the advanced configuration section. 
+The callback URL will normally end with /konnected (for example https://192.168.1.2/konnected).
+
 In addition you can also turn off discovery which when this setting is synced to the module will cause the device to no longer respond to UPnP requests as documented.
 https://help.konnected.io/support/solutions/articles/32000023968-disabling-device-discovery
 Please use this setting with caution and do not disable until a static ip address has been provided for your Konnected Alarm Panel via DHCP, router or otherwise.
+
 The blink setting will disable the transmission LED on the Konnected Alarm Panel.
 
 
@@ -83,7 +91,7 @@ Switch item=Siren label="Alarm Siren" icon="Siren" mappings=[ON="Open", OFF="Clo
 *.things
 
 ```
-Thing konnected:wifi-module:generic "Konnected Module" [ipAddress="http://192.168.30.153:9586", macAddress="1586517"]{
+Thing konnected:wifi-module:generic "Konnected Module" [baseUrl="http://192.168.30.153:9586", macAddress="1586517"]{
    Type switch      : switch-wifi      "Front Door"          [channel_zone=1]
    Type actuator    : actuator-wifi    "Siren"               [channel_zone=1, momentary = 50, times = 2, pause = 50]
    Type humidity    : humidity-wifi    "DHT - Humidity"      [channel_zone=1]
@@ -91,7 +99,7 @@ Thing konnected:wifi-module:generic "Konnected Module" [ipAddress="http://192.16
    Type temperature : temperature-wifi "DS18B20 Temperature" [channel_zone=1, tempsensorType = false, pollinterval = 1, ds18b20_address = "XX:XX:XX:XX:XX:XX:XX"]
 }
 
-Thing konnected:pro-module:generic "Konnected Module" [ipAddress="http://192.168.30.154:9586", macAddress="1684597"]{
+Thing konnected:pro-module:generic "Konnected Module" [baseUrl="http://192.168.30.154:9586", macAddress="1684597"]{
    Type switch      : switch-pro      "Front Door"          [channel_zone=1]
    Type actuator    : actuator-pro    "Siren"               [channel_zone=1, momentary = 50, times = 2, pause = 50]
    Type humidity    : humidity-pro    "DHT - Humidity"      [channel_zone=1]