Updated external content (Jenkins build 1079)

pull/1969/head
openHAB Build Server 2022-08-09 18:23:21 +00:00
parent 630055a4b1
commit 647834c032
6 changed files with 266 additions and 58 deletions

File diff suppressed because one or more lines are too long

View File

@ -17,12 +17,12 @@ install: auto
This binding is for interacting with the [Konnected Alarm Panel](https://konnected.io/). This binding is for interacting with the [Konnected Alarm Panel](https://konnected.io/).
A module which interfaces with existing home security sensors. A module which interfaces with existing home security sensors.
Konnected is an open-source firmware and software that runs on a NodeMCU ESP8266 device. Konnected is an open-source firmware and software that runs on a NodeMCU ESP8266 (Wi-Fi) or ESP32 (Pro) device.
The Konnected hardware is specifically designed for an alarm panel installation, but the general purpose firmware/software can be run on any ESP8266 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 one type of thing module, which represents a Konnected Alarm Panel. 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.
## Discovery ## Discovery
@ -43,24 +43,14 @@ The blink setting will disable the transmission LED on the Konnected Alarm Panel
## Channels ## Channels
The auto discovered thing adds two default 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 | Channel Id | Channel Type | Description |
|---------|------------|--------------|----------------------------------------------------------|
| 1 | Zone_6 | Switch | A Switch channel for zone 6 |
| 2 | Out | Actuator | The Channel for the Out Pin on the Konnected Alarm Panel |
One channel for Zone 6 which is a sensor type channel, and one channel for the out pin that is an actuator type channel.
These channels represent the two pins on the Konnected Alarm Panel whose type cannot be changed.
For zones 1-5, you will need to add channels for the remaining zones that you have connected and configure them with the appropriate configuration parameters for each channel.
| Channel Type | Item Type | Config Parameters | Description | | Channel Type | Item Type | Config Parameters | Description |
|--------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Switch | Switch | Zone Number | This is the channel type for sensors or other read only devices | | Switch-(wifi/pro) | Switch | Zone Number | This is the channel type for sensors or other read only devices |
| Actuator | 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 | | 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 | 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 | | 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 | Number:Dimensionless | Zone Number | This is the channel type for the humidity sensor on a connected DHT22 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. 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. Then you need to link the corresponding item to the channel.
@ -73,6 +63,11 @@ A beep/blink switch is like a momentary switch that repeats either a specified n
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. 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. 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. DSB1820 temperature probes.
These are one wire devices which can all be Konnected to the same "Zone" on the Konnected Alarm Panel. 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. 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.
@ -86,8 +81,11 @@ A channel should be added for each probe, as indicated above and configured with
*.items *.items
``` ```
Contact Front_Door_Sensor "Front Door" {channel="konnected:module:generic:switch"} Switch Front_Door_Sensor "Front Door" {channel="konnected:wifi-module:generic:switch-wifi"}
Switch Siren "Siren" {channel="konnected:module:generic:actuator"} Switch Siren "Siren" {channel="konnected:wifi-module:generic:actuator-wifi"}
Switch Front_Door_Sensor_Pro "Front Door" {channel="konnected:pro-module:generic:switch-pro"}
Switch Siren_Pro "Siren" {channel="konnected:pro-module:generic:actuator-pro"}
``` ```
*.sitemap *.sitemap
@ -100,12 +98,20 @@ Switch item=Siren label="Alarm Siren" icon="Siren" mappings=[ON="Open", OFF="Clo
*.things *.things
``` ```
Thing konnected:module:generic "Konnected Module" [ipAddress="http://192.168.30.153:9586", macAddress="1586517"]{ Thing konnected:wifi-module:generic "Konnected Module" [ipAddress="http://192.168.30.153:9586", macAddress="1586517"]{
Type switch : switch "Front Door" [channel_zone=1] Type switch : switch-wifi "Front Door" [channel_zone=1]
Type actuator : actuator "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 "DHT - Humidity" [channel_zone=1] Type humidity : humidity-wifi "DHT - Humidity" [channel_zone=1]
Type temperature : temperature "DHT Temperature" [channel_zone=1, tempsensorType = true, pollinterval = 1] Type temperature : temperature-wifi "DHT Temperature" [channel_zone=1, tempsensorType = true, pollinterval = 1]
Type temperature : temperature "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"]{
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]
Type temperature : temperature-pro "DHT Temperature" [channel_zone=1, tempsensorType = true, pollinterval = 1]
Type temperature : temperature-pro "DS18B20 Temperature" [channel_zone=1, tempsensorType = false, pollinterval = 1, ds18b20_address = "XX:XX:XX:XX:XX:XX:XX"]
} }
``` ```

View File

@ -3,7 +3,7 @@ id: mystrom
label: myStrom label: myStrom
title: myStrom - Bindings title: myStrom - Bindings
type: binding type: binding
description: "This extension adds support for the myStrom devices. Currently only the smart plug is implemented." description: "This extension adds support for the myStrom devices."
since: 3x since: 3x
logo: images/addons/mystrom.png logo: images/addons/mystrom.png
install: auto install: auto
@ -15,16 +15,18 @@ install: auto
# myStrom Binding # myStrom Binding
This extension adds support for the myStrom devices. Currently only the smart plug is implemented. This extension adds support for the myStrom devices.
As of today only the Smart Plug, Bulb and the Motionsensor are implemented.
## Supported Things ## Supported Things
This bundle adds the following thing types: This bundle adds the following thing types:
| Thing | ThingTypeID | Description | | Thing | ThingTypeID | Description |
| ------------------ | ----------- | -------------------------------------------------- | | ----------------------| ----------- | -------------------------------------------------- |
| myStrom Smart Plug | mystromplug | A myStrom smart plug | | myStrom Smart Plug | mystromplug | A myStrom smart plug |
| myStrom Bulb | mystrombulb | A myStrom bulb | | myStrom Bulb | mystrombulb | A myStrom bulb |
| myStrom Motion Sensor | mystrompir | A myStrom bulb |
According to the myStrom API documentation all request specific to the myStrom Bulb are also work on the LED strip. According to the myStrom API documentation all request specific to the myStrom Bulb are also work on the LED strip.
@ -41,6 +43,7 @@ The following parameters are valid for all thing types:
| --------- | ------- | -------- | ------------------ | -------------------------------------------------------------------------- | | --------- | ------- | -------- | ------------------ | -------------------------------------------------------------------------- |
| hostname | string | yes | localhost | The IP address or hostname of the myStrom smart plug | | hostname | string | yes | localhost | The IP address or hostname of the myStrom smart plug |
| refresh | integer | no | 10 | Poll interval in seconds. Increase this if you encounter connection errors | | refresh | integer | no | 10 | Poll interval in seconds. Increase this if you encounter connection errors |
| apiToken | string | no | | Specifies the API Token, if required. |
## Properties ## Properties
@ -67,12 +70,14 @@ Disabling/enabling the thing can be used to update the properties.
| ---------------- | -------------------- | --------- | --------------------------------------------------------------------- |-------------------------------------| | ---------------- | -------------------- | --------- | --------------------------------------------------------------------- |-------------------------------------|
| switch | Switch | false | Turn the device on or off | mystromplug, mystrombulb | | switch | Switch | false | Turn the device on or off | mystromplug, mystrombulb |
| power | Number:Power | true | The currently delivered power | mystromplug, mystrombulb | | power | Number:Power | true | The currently delivered power | mystromplug, mystrombulb |
| temperature | Number:Temperature | true | The temperature at the plug | mystromplug | | temperature | Number:Temperature | true | The temperature at the plug | mystromplug, mystrompir |
| color | Color | false | The color we set the bulb to (mode 'hsv') | mystrombulb | | color | Color | false | The color we set the bulb to (mode 'hsv') | mystrombulb |
| colorTemperature | Dimmer | false | The color temperature of the bulb in mode 'mono' (percentage) | mystrombulb | | colorTemperature | Dimmer | false | The color temperature of the bulb in mode 'mono' (percentage) | mystrombulb |
| brightness | Dimmer | false | The brightness of the bulb in mode 'mono' | mystrombulb | | brightness | Dimmer | false | The brightness of the bulb in mode 'mono' | mystrombulb |
| ramp | Number:Time | false | Transition time from the lights current state to the new state. [ms] | mystrombulb | | ramp | Number:Time | false | Transition time from the lights current state to the new state. [ms] | mystrombulb |
| mode | String | false | The color mode we want the Bulb to set to (rgb, hsv or mono) | mystrombulb | | mode | String | false | The color mode we want the Bulb to set to (rgb, hsv or mono) | mystrombulb |
| light | Dimmer | true | The brightness of the Room. | mystrompir |
| motion | Switch | true | Motionstatus of the sensor | mystrompir |
## Full Example ## Full Example

View File

@ -41,7 +41,7 @@ Also check out the [Shelly Manager](doc/ShellyManager.md), which
## Supported Devices ## Supported Devices
### Generation 1: ### Generation 1
| thing-type | Model | Vendor ID | | thing-type | Model | Vendor ID |
|--------------------|--------------------------------------------------------|-----------| |--------------------|--------------------------------------------------------|-----------|

View File

@ -3,23 +3,21 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0" xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd"> xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<!-- This is the Konnected Thing-Type --> <!-- This is the Konnected Wifi Thing-Type -->
<thing-type id="module" extensible="switch,actuator,temperature,humidity"> <thing-type id="wifi-module" extensible="switch-wifi,actuator-wifi,temperature-wifi,humidity-wifi">
<label>The Konnected Alarm Panel</label> <label>The Konnected Alarm Panel</label>
<description>The Konnected Module</description> <description>The Konnected Wi-Fi Alarm Panel</description>
<channels>
<channel id="Zone_6" typeId="switch">
<label>Zone 6</label>
<description>Zone 6 Sensor</description>
</channel>
<channel id="Out" typeId="actuator">
<label>The out Pin</label>
</channel>
</channels>
<config-description-ref uri="thing-type:konnected:module"/> <config-description-ref uri="thing-type:konnected:module"/>
</thing-type> </thing-type>
<!-- This is the Konnected Alarm Panel Pro Thing-Type -->
<thing-type id="pro-module" extensible="switch-pro,actuator-pro,temperature-pro,humidity-pro">
<label>The Konnected Alarm Panel Pro</label>
<description>The Konnected Alarm Panel Pro</description>
<config-description-ref uri="thing-type:konnected:module"/>
</thing-type>
<!-- Zone Channel Type --> <!-- Zone Channel Type -->
<channel-type id="switch"> <channel-type id="switch-wifi">
<item-type>Switch</item-type> <item-type>Switch</item-type>
<label>Switch</label> <label>Switch</label>
<description>This zone is a read only switch type zone</description> <description>This zone is a read only switch type zone</description>
@ -36,7 +34,7 @@
<option value="4">4</option> <option value="4">4</option>
<option value="5">5</option> <option value="5">5</option>
<option value="6">6</option> <option value="6">6</option>
<option value="7">Out</option> <option value="alarm_out">Alarm/Out</option>
</options> </options>
</parameter> </parameter>
<parameter name="onvalue" type="text"> <parameter name="onvalue" type="text">
@ -51,7 +49,7 @@
</parameter> </parameter>
</config-description> </config-description>
</channel-type> </channel-type>
<channel-type id="temperature"> <channel-type id="temperature-wifi">
<item-type>Number:Temperature</item-type> <item-type>Number:Temperature</item-type>
<label>Temperature</label> <label>Temperature</label>
<description>This zone measures temperature</description> <description>This zone measures temperature</description>
@ -67,7 +65,7 @@
<option value="4">4</option> <option value="4">4</option>
<option value="5">5</option> <option value="5">5</option>
<option value="6">6</option> <option value="6">6</option>
<option value="7">Out</option> <option value="alarm_out">Alarm/Out</option>
</options> </options>
</parameter> </parameter>
<parameter name="tempsensorType" type="boolean"> <parameter name="tempsensorType" type="boolean">
@ -84,7 +82,7 @@
</parameter> </parameter>
</config-description> </config-description>
</channel-type> </channel-type>
<channel-type id="humidity"> <channel-type id="humidity-wifi">
<item-type>Number:Dimensionless</item-type> <item-type>Number:Dimensionless</item-type>
<label>Humidity</label> <label>Humidity</label>
<description>This zone measures humidity</description> <description>This zone measures humidity</description>
@ -100,12 +98,12 @@
<option value="4">4</option> <option value="4">4</option>
<option value="5">5</option> <option value="5">5</option>
<option value="6">6</option> <option value="6">6</option>
<option value="7">Out</option> <option value="alarm_out">Alarm/Out</option>
</options> </options>
</parameter> </parameter>
</config-description> </config-description>
</channel-type> </channel-type>
<channel-type id="actuator"> <channel-type id="actuator-wifi">
<item-type>Switch</item-type> <item-type>Switch</item-type>
<label>Actuator</label> <label>Actuator</label>
<description>This zone is an actuator</description> <description>This zone is an actuator</description>
@ -121,7 +119,7 @@
<option value="4">4</option> <option value="4">4</option>
<option value="5">5</option> <option value="5">5</option>
<option value="6">6</option> <option value="6">6</option>
<option value="7">Out</option> <option value="alarm_out">Alarm/Out</option>
</options> </options>
</parameter> </parameter>
<parameter name="onvalue" type="text"> <parameter name="onvalue" type="text">
@ -148,4 +146,144 @@
</parameter> </parameter>
</config-description> </config-description>
</channel-type> </channel-type>
<channel-type id="switch-pro">
<item-type>Switch</item-type>
<label>Switch</label>
<description>This zone is a read only switch type zone</description>
<state readOnly="true"/>
<config-description>
<parameter name="zone" type="text" required="true">
<label>Zone Number</label>
<description>The zone number of the channel.</description>
<default>4</default>
<options>
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
<option value="4">4</option>
<option value="5">5</option>
<option value="6">6</option>
<option value="7">7</option>
<option value="8">8</option>
<option value="9">9</option>
<option value="10">10</option>
<option value="11">11</option>
<option value="12">12</option>
</options>
</parameter>
<parameter name="onvalue" type="text">
<label>On Value</label>
<description>The value that will be treated by the binding as the on value. For sensors that activate with a high
value, leave at the default of 1 and sensors that activate with a low value set to 0.</description>
<default>1</default>
<options>
<option value="0">0</option>
<option value="1">1</option>
</options>
</parameter>
</config-description>
</channel-type>
<channel-type id="actuator-pro">
<item-type>Switch</item-type>
<label>Actuator</label>
<description>This zone is an actuator</description>
<config-description>
<parameter name="zone" type="text" required="true">
<label>Zone Number</label>
<description>The zone number of the channel.</description>
<default>2</default>
<options>
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
<option value="4">4</option>
<option value="5">5</option>
<option value="6">6</option>
<option value="7">7</option>
<option value="8">8</option>
<option value="alarm1">Alarm1</option>
<option value="out1">Output1</option>
<option value="alarm2_out2">Alarm2/Out2</option>
</options>
</parameter>
<parameter name="onvalue" type="text">
<label>On Value</label>
<description>The value that will be treated by the binding as an on command. For actuators that activate with a high
command set to 1 and actuators that activate with a low value set to 0.</description>
<default>1</default>
<options>
<option value="0">0</option>
<option value="1">1</option>
</options>
</parameter>
<parameter name="momentary" type="integer">
<label>Momentary</label>
<description>The duration of the pulse in milliseconds</description>
</parameter>
<parameter name="pause" type="integer">
<label>Pause</label>
<description>The time between pulses in milliseconds</description>
</parameter>
<parameter name="times" type="integer">
<label>Times</label>
<description>The number of times to repeat or `-1` for an infinitely repeating pulse</description>
</parameter>
</config-description>
</channel-type>
<channel-type id="temperature-pro">
<item-type>Number:Temperature</item-type>
<label>Temperature</label>
<description>This zone measures temperature</description>
<state readOnly="true"/>
<config-description>
<parameter name="zone" type="text">
<label>Zone Number</label>
<description>The Zone Number of the channel.</description>
<options>
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
<option value="4">4</option>
<option value="5">5</option>
<option value="6">6</option>
<option value="7">7</option>
<option value="8">8</option>
</options>
</parameter>
<parameter name="tempsensorType" type="boolean">
<label>DHT22</label>
<description>Is the sensor a dht22 or a ds18b20? Set to true for dht22 sensor</description>
</parameter>
<parameter name="pollinterval" type="integer">
<label>Poll Interval</label>
<description>The interval in minutes to poll the sensor.</description>
</parameter>
<parameter name="ds18b20_address" type="text">
<label>DS18b20 Address</label>
<description>This is the unique address of the sensor on the one wire bus.</description>
</parameter>
</config-description>
</channel-type>
<channel-type id="humidity-pro">
<item-type>Number:Dimensionless</item-type>
<label>Humidity</label>
<description>This zone measures humidity</description>
<state readOnly="true"/>
<config-description>
<parameter name="zone" type="text" required="true">
<label>Zone Number</label>
<description>The zone number of the channel.</description>
<options>
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
<option value="4">4</option>
<option value="5">5</option>
<option value="6">6</option>
<option value="7">7</option>
<option value="8">8</option>
</options>
</parameter>
</config-description>
</channel-type>
</thing:thing-descriptions> </thing:thing-descriptions>

View File

@ -41,6 +41,10 @@
<description>Specifies the refresh interval in seconds.</description> <description>Specifies the refresh interval in seconds.</description>
<default>10</default> <default>10</default>
</parameter> </parameter>
<parameter name="apiToken" type="text">
<label>API Token</label>
<description>Specifies the API token, if required (optional).</description>
</parameter>
</config-description> </config-description>
</thing-type> </thing-type>
@ -86,10 +90,65 @@
<description>Specifies the refresh interval in seconds.</description> <description>Specifies the refresh interval in seconds.</description>
<default>10</default> <default>10</default>
</parameter> </parameter>
<parameter name="apiToken" type="text">
<label>API Token</label>
<description>Specifies the API token, if required (optional).</description>
</parameter>
</config-description> </config-description>
</thing-type> </thing-type>
<thing-type id="mystrompir">
<label>myStrom Motion Sensor</label>
<channels>
<channel id="motion" typeId="system.motion"/>
<channel id="temperature" typeId="system.indoor-temperature"></channel>
<channel id="light" typeId="system.brightness"></channel>
</channels>
<properties>
<property name="mac"/>
<property name="version"/>
<property name="type"/>
<property name="ssid"/>
<property name="ip"/>
<property name="mask"/>
<property name="gw"/>
<property name="dns"/>
<property name="static"/>
<property name="connected"/>
</properties>
<representation-property>mac</representation-property>
<config-description>
<parameter name="hostname" type="text">
<label>Hostname</label>
<description>The hostname or IP address of the myStrom sensor.</description>
<context>network-address</context>
<default>localhost</default>
</parameter>
<parameter name="refresh" type="integer" unit="s" min="1">
<label>Refresh Interval</label>
<description>Specifies the refresh interval in seconds.</description>
<default>10</default>
</parameter>
<parameter name="apiToken" type="text">
<label>API Token</label>
<description>Specifies the API token, if required (optional).</description>
</parameter>
<parameter name="backoffTime" type="integer" unit="s" min="1">
<default>10</default>
<label>Backoff Time</label>
<description>Specifies the minimum frequency between successive motion detections in seconds.</description>
</parameter>
<parameter name="ledEnable" type="boolean">
<default>true</default>
<label>LED Enabled</label>
<description>Enables the status LED on the device.</description>
</parameter>
</config-description>
</thing-type>
<channel-type id="power-channel"> <channel-type id="power-channel">
<item-type>Number:Power</item-type> <item-type>Number:Power</item-type>