mirror of
https://github.com/openhab/openhab-addons.git
synced 2025-01-10 15:11:59 +01:00
110 lines
8.4 KiB
Markdown
110 lines
8.4 KiB
Markdown
# Konnected Binding
|
|
|
|
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 things, the Konnected Alarm Panel and the Konnected Alarm Panel Pro.
|
|
|
|
## Discovery
|
|
|
|
The binding will auto discover The Konnected Alarm Panels which are attached to the same network as the server running openHAB via UPnP.
|
|
The binding will then create things for each module discovered which can be added.
|
|
|
|
## 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 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.
|
|
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.
|
|
|
|
## Channels
|
|
|
|
You will need to add channels for the zones that you have connected and configure them with the appropriate configuration parameters for each channel.
|
|
|
|
| Channel Type | Item Type | Config Parameters | Description |
|
|
|--------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| Switch-(wifi/pro) | Switch | Zone Number | This is the channel type for sensors or other read only devices |
|
|
| Actuator-(wifi/pro) | Switch | Zone Number, Momentary, Pause, Times | This is the channel type for devices whose state can be turned on an off by the Konnected Alarm Panel |
|
|
| Temperature-(wifi/pro) | Number:Temperature | Zone Number, DHT22, Poll Interval, DS18b20 Address | This is the channel for sensors which measure temperature (DHT22 and DS18B20). The DHT22 setting should be set to true when the channel is monitoring a zone connected to a DHT22 sensor and false if the zone is connected to a DS1820B sensor |
|
|
| Humidity-(wifi/pro) | Number:Dimensionless | Zone Number | This is the channel type for the humidity sensor on a connected DHT22 sensor |
|
|
|
|
You will need to configure each channel with the appropriate zone number corresponding to the zone on The Konnected Alarm Panel.
|
|
Then you need to link the corresponding item to the channel.
|
|
|
|
Switches and actuators can be configured as high or low level triggered.
|
|
This is done though setting the parameter onValue to 1 for high level trigger or 0 for low level trigger.
|
|
The default setting is high level triggered (1).
|
|
It may for example be useful to set channel to low level trigger when using a low level trigger relay board, to avoid inverting the switch logic.
|
|
|
|
For the actuator type channels you can also add configuration parameters times, pause and momentary which will be added to the payload that is sent to the Konnected Alarm Panel.
|
|
These parameters will tell the module to pulse the actuator for certain time period.
|
|
A momentary switch actuates a switch for a specified time (in milliseconds) and then reverts it back to the off state.
|
|
This is commonly used with a relay module to actuate a garage door opener, or with a door bell to send a momentary trigger to sound the door bell.
|
|
A beep/blink switch is like a momentary switch that repeats either a specified number of times or indefinitely.
|
|
This is commonly used with a piezo buzzer to make a "beep beep" sound when a door is opened, or to make a repeating beep pattern for an alarm or audible warning.
|
|
It can also be used to blink lights.
|
|
|
|
A note about the Alarm Panel Pro.
|
|
Zones 1-8 can be configured for any Channel-Types.
|
|
Zones 9-12, out1, alarm1 and out2/alarm2 can only be configured as an actuator.
|
|
For more information, see: <https://help.konnected.io/support/solutions/articles/32000028978-alarm-panel-pro-inputs-and-outputs>
|
|
|
|
DSB1820 temperature probes.
|
|
These are one wire devices which can all be Konnected to the same "Zone" on the Konnected Alarm Panel.
|
|
As part of its transmission the module will include an unique "address" property of each sensor probe that will be logged to the debug log when received.
|
|
This needs to be added to the channel if there are multiple probes connected.
|
|
The default behavior in absence of this configuration will be to simply log the address of the received event.
|
|
A channel should be added for each probe, as indicated above and configured with the appropriate address.
|
|
|
|
## Full Example
|
|
|
|
*.items
|
|
|
|
```java
|
|
Switch Siren "Siren" {channel="konnected:wifi-module:generic:siren"}
|
|
Switch Back_Door_Sensor "Back Door" {channel="konnected:pro-module:generic:backd"}
|
|
```
|
|
|
|
*.sitemap
|
|
|
|
```perl
|
|
Switch item=Back_Door_Sensor label="Back Door" icon="door" mappings=[OPEN="Open", CLOSED="Closed"]
|
|
Switch item=Siren label="Alarm Siren" icon="Siren" mappings=[ON="Open", OFF="Closed"]
|
|
```
|
|
|
|
*.things
|
|
|
|
```java
|
|
Thing konnected:wifi-module:generic "Konnected Module" [baseUrl="http://192.168.30.153:9586", macAddress="1586517"]{
|
|
Type switch-wifi : frontd "Front Door" [zone="1"]
|
|
Type actuator-wifi : siren "Siren" [zone="2", momentary = 50, times = 2, pause = 50]
|
|
Type humidity-wifi : bedhum "Bedroom Humidity (DHT22)" [zone="3"]
|
|
Type temperature-wifi: bedtemp "Bedroom Temperature (DHT22)" [zone="3", dht22 = true, pollInterval = 1]
|
|
Type temperature-wifi: lrtemp "Living Room Temperature (DS18B20)" [zone="4", dht22 = false, pollInterval = 1, ds18b20Address = "XX:XX:XX:XX:XX:XX:XX"]
|
|
}
|
|
|
|
Thing konnected:pro-module:generic "Konnected Module" [baseUrl="http://192.168.30.154:9586", macAddress="1684597", callbackUrl="https://openhab/konnected"]{
|
|
Type switch-pro : backd "Back Door" [zone="1"]
|
|
Type actuator-pro : chime "Chime" [zone="2", momentary = 50, times = 2, pause = 50]
|
|
Type humidity-pro : kitchhum "Kitchen Humidity (DHT22)" [zone="3"]
|
|
Type temperature-pro : kitchtemp "Kitchen Temperature (DHT22)" [zone="3", dht22 = true, pollInterval = 1]
|
|
Type temperature-pro : outhum "Outside Temperature (DS18B20)" [zone="4", dht22 = false, pollInterval = 1, ds18b20Address = "XX:XX:XX:XX:XX:XX:XX"]
|
|
}
|
|
```
|