demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-25 14:55:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

[Konnected] Refreshed readme to include latest changes (#13294)

Browse Source 
* Refreshed readme to include latest changes

Signed-off-by: Haavar Valeur <haavar@haavar.com>
This commit is contained in:
Haavar Valeur 2022-08-20 14:02:05 -07:00 committed by GitHub
parent ac23965c7d
commit d8c07ebde7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
bundles/org.openhab.binding.konnected/README.md
View File

@ -1,13 +1,13 @@
# Konnected Binding # Konnected Binding
This binding is for interacting with the [Konnected Alarm Panel](https://konnected.io/). This binding is for interacting with a [Konnected Alarm Panel](https://konnected.io/).
A module which interfaces with existing home security sensors. 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 ESP8266 (Wi-Fi) or ESP32 (Pro) device. 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. 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 ## 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 ## Discovery
@ -16,13 +16,21 @@ The binding will then create things for each module discovered which can be adde
## Thing Configuration ## Thing Configuration
The binding attempts to discover The Konnected Alarm Panels via the UPnP service. 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 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. 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. 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 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. 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. 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 *.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 switch : switch-wifi "Front Door" [channel_zone=1]
Type actuator : actuator-wifi "Siren" [channel_zone=1, momentary = 50, times = 2, pause = 50] Type actuator : actuator-wifi "Siren" [channel_zone=1, momentary = 50, times = 2, pause = 50]
Type humidity : humidity-wifi "DHT - Humidity" [channel_zone=1] 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"] 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 switch : switch-pro "Front Door" [channel_zone=1]
Type actuator : actuator-pro "Siren" [channel_zone=1, momentary = 50, times = 2, pause = 50] Type actuator : actuator-pro "Siren" [channel_zone=1, momentary = 50, times = 2, pause = 50]
Type humidity : humidity-pro "DHT - Humidity" [channel_zone=1] Type humidity : humidity-pro "DHT - Humidity" [channel_zone=1]