OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated external content (Jenkins build 226)

pull/1569/head
openHAB Build Server 2021-01-29 15:51:19 +00:00
parent 199aa1fe2c
commit 9647f9e343
170 changed files with 17774 additions and 7833 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.vuepress/thing-types.json
View File

File diff suppressed because one or more lines are too long

27
_addons_automation/pidcontroller/readme.md
View File

@ -36,20 +36,17 @@ This module triggers whenever the `input` or the `setpoint` changes or the `loop
Every trigger calculates the P, the I and the D part and sums them up to form the `output` value.
This is then transferred to the action module.
| Name | Type | Description | Required |
|--------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `input` | Item | Name of the input [Item](https://www.openhab.org/docs/configuration/items.html) (e.g. temperature sensor value) | Y |
| `setpoint` | Item | Name of the setpoint Item (e.g. desired room temperature) | Y |
| `kp` | Decimal | P: [Proportional Gain](#proportional-p-gain-parameter) Parameter | Y |
| `ki` | Decimal | I: [Integral Gain](#integral-i-gain-parameter) Parameter | Y |
| `kd` | Decimal | D: [Derivative Gain](#derivative-d-gain-parameter) Parameter | Y |
| `kdTimeConstant` | Decimal | D-T1: [Derivative Gain Time Constant](#derivative-time-constant-d-t1-parameter) in sec. | Y |
| `outputLowerLimit` | Decimal | The output of the PID controller will be max this value | Y |
| `outputUpperLimit` | Decimal | The output of the PID controller will be min this value | Y |
| `loopTime` | Decimal | The interval the output value will be updated in milliseconds. Note: the output will also be updated when the input value or the setpoint changes. | Y |
| Name | Type | Description | Required |
|------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `input` | Item | Name of the input [Item](https://www.openhab.org/docs/configuration/items.html) (e.g. temperature sensor value) | Y |
| `setpoint` | Item | Name of the setpoint Item (e.g. desired room temperature) | Y |
| `kp` | Decimal | P: [Proportional Gain](#proportional-p-gain-parameter) Parameter | Y |
| `ki` | Decimal | I: [Integral Gain](#integral-i-gain-parameter) Parameter | Y |
| `kd` | Decimal | D: [Derivative Gain](#derivative-d-gain-parameter) Parameter | Y |
| `kdTimeConstant` | Decimal | D-T1: [Derivative Gain Time Constant](#derivative-time-constant-d-t1-parameter) in sec. | Y |
| `commandItem` | String | Send a String "RESET" to this item to reset the I and the D part to 0. | N |
| `loopTime` | Decimal | The interval the output value will be updated in milliseconds. Note: the output will also be updated when the input value or the setpoint changes. | Y |
The purpose of the limit parameters are to keep the output value and the integral value in a reasonable range, if the regulation cannot meet its setpoint.
E.g. the window is open and the heater doesn't manage to heat up the room.
The `loopTime` should be max a tenth of the system response.
E.g. the heating needs 10 min to heat up the room, the loop time should be max 1 min.
@ -90,8 +87,8 @@ The bigger this parameter, the faster the drifting.
A value of 0 disables the I part.
A value of 1 adds the current setpoint deviation (error) to the output each second.
E.g. the setpoint is 25°C and the measured value is 20°C, the output will be set to 5 after 1 sec.
A value of 1 adds the current setpoint deviation (error) to the output each `loopTime` (in milliseconds).
E.g. (`loopTimeMs=1000`) the setpoint is 25°C and the measured value is 20°C, the output will be set to 5 after 1 sec.
After 2 sec the output will be 10.
If the output is the opening of a valve in %, you might want to set this parameter to a lower value (`ki=0.1` would result in 30% after 60 sec: 5\*0.1\*60=30).

10
_addons_bindings/amazonechocontrol/readme.md
View File

@ -180,7 +180,7 @@ It will be configured at runtime by using the save channel to store the current
| radioStationId | String | R/W | echo, echoshow, echospot, wha | Start playing of a TuneIn radio station by specifying its id or stops playing if an empty string was provided
| radio | Switch | R/W | echo, echoshow, echospot, wha | Start playing of the last used TuneIn radio station (works after the radio station started after the openHAB start)
| amazonMusicTrackId | String | R/W | echo, echoshow, echospot, wha | Start playing of an Amazon Music track by its id or stops playing if an empty string was provided
| amazonMusicPlayListId | String | W | echo, echoshow, echospot, wha | Write Only! Start playing of an Amazon Music playlist by specifying its id or stops playing if an empty string was provided. Selection will only work in PaperUI
| amazonMusicPlayListId | String | W | echo, echoshow, echospot, wha | Write Only! Start playing of an Amazon Music playlist by specifying its id or stops playing if an empty string was provided.
| amazonMusic | Switch | R/W | echo, echoshow, echospot, wha | Start playing of the last used Amazon Music song (works after at least one song was started after the openHAB start)
| remind | String | R/W | echo, echoshow, echospot | Write Only! Speak the reminder and sends a notification to the Alexa app (Currently the reminder is played and notified two times, this seems to be a bug in the Amazon software)
| nextReminder | DateTime | R | echo, echoshow, echospot | Next reminder on the device
@ -363,7 +363,7 @@ sitemap amazonechocontrol label="Echo Devices"
// Change the <YOUR_DEVICE_MAC> Place holder with the MAC address shown, if Alexa is connected to the device
Selection item=Echo_Living_Room_BluetoothMAC mappings=[ ''='Disconnected', '<YOUR_DEVICE_MAC>'='Bluetooth Device 1', '<YOUR_DEVICE_MAC>'='Bluetooth Device 2']
// These are only view of the possible options. Enable ShowIDsInGUI in the binding configuration and look in drop-down-box of this channel in the Paper UI Control section
// These are only view of the possible options.
Selection item=Echo_Living_Room_PlayAlarmSound mappings=[ ''='None', 'ECHO:system_alerts_soothing_01'='Adrift', 'ECHO:system_alerts_atonal_02'='Clangy']
Switch item=Echo_Living_Room_Bluetooth
@ -461,11 +461,11 @@ The polling interval configured in the Account Thing to get the state is specifi
|--------------------------|---------------------------------------------------------------------------|
| id | The id of the device or device group |
The only possibility to find out the id is by using the discover function in the PaperUI. You can use then the id, if you want define the Thing in a file.
The only possibility to find out the id is by using the discover function in the UI. You can use then the id, if you want define the Thing in a file.
#### Channels
The channels of the smarthome devices will be generated at runtime. Check in the paperUI thing configurations, which channels are created.
The channels of the smarthome devices will be generated at runtime. Check in the UI thing configurations, which channels are created.
| Channel Type ID | Item Type | Access Mode | Thing Type | Description
|--------------------------|-----------|-------------|-------------------------------|------------------------------------------------------------------------------------------
@ -520,7 +520,7 @@ Switch Arm_State "State" { channel="amazonechocontrol:smartHomeDevice:account1:s
Switch Group_State "On/Off" { channel="amazonechocontrol:smartHomeDeviceGroup:account1:smartHomeDeviceGroup1:powerState" }
```
The only possibility to find out the id for the smartHomeDevice and smartHomeDeviceGroup Things is by using the discover function in the PaperUI.
The only possibility to find out the id for the smartHomeDevice and smartHomeDeviceGroup Things is by using the discover function.
#### smarthome.sitemap:

389
_addons_bindings/androiddebugbridge/readme.md Normal file
View File

@ -0,0 +1,389 @@
---
id: androiddebugbridge
label: Android Debug Bridge
title: Android Debug Bridge - Bindings
type: binding
description: "This binding allows to connect to android devices through the adb protocol."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Android Debug Bridge Binding
This binding allows to connect to android devices through the adb protocol.
The device needs to have **usb debugging enabled** and **allow debugging over tcp**, some devices allow to enable this in the device options but others need a previous connection through adb or even be rooted.
If you are not familiar with adb I suggest you to search "How to enable adb over wifi on \<device name\>" or something like that.
## Supported Things
This binding was tested on the Fire TV Stick (android version 7.1.2, volume control not working) and Nexus5x (android version 8.1.0, everything works nice), please update this document if you tested it with other android versions to reflect the compatibility of the biding.
## Discovery
As I can not find a way to identify android devices in the network the discovery will try to connect through adb to all the reachable ip in the defined range, you could customize the discovery process through the binding options. **Your device will prop a message requesting you to authorize the connection, you should check the option "Always allow connections from this device" (or something similar) and accept**.
## Binding Configuration
| Config | Type | description |
|----------|----------|------------------------------|
| discoveryPort | int | Port used on discovery to connect to the device through adb |
| discoveryReachableMs | int | Milliseconds to wait while discovering to determine if the ip is reachable |
| discoveryIpRangeMin | int | Used to limit the number of IPs checked while discovering |
| discoveryIpRangeMax | int | Used to limit the number of IPs checked while discovering |
## Thing Configuration
| ThingTypeID | description |
|----------|------------------------------|
| android | Android device |
| Config | Type | description |
|----------|----------|------------------------------|
| ip | String | Device ip address |
| port | int | Device port listening to adb connections (default: 5555) |
| refreshTime | int | Seconds between device status refreshes (default: 30) |
| timeout | int | Command timeout in seconds (default: 5) |
| mediaStateJSONConfig | String | Expects a JSON array. Allow to configure the media state detection method per app. Described in the following section |
## Media State Detection
You can configure different modes to detect when the device is playing media depending on the current app.
The available modes are:
* idle: assert not playing, avoid command execution.
* media_state: detect play status by dumping the media_session service. This is the default for not configured apps
* audio: detect play status by dumping the audio service.
* wake_lock: detect play status by comparing the power wake lock state with the values provided in 'wakeLockPlayStates'
The configuration depends on the application, device and version used.
This is a sample of the mediaStateJSONConfig thing configuration:
`[{"name": "com.amazon.tv.launcher", "mode": "idle"},{"name": "org.jellyfin.androidtv", "mode": "wake_lock", "wakeLockPlayStates": [2,3]},{"name": "com.amazon.firetv.youtube", "mode": "wake_lock", "wakeLockPlayStates": [2]}]`
## Channels
| channel | type | description |
|----------|--------|------------------------------|
| key-event | String | Send key event to android device. Possible values listed below |
| text | String | Send text to android device |
| media-volume | Dimmer | Set or get media volume level on android device |
| media-control | Player | Control media on android device |
| start-package | String | Run application by package name |
| stop-package | String | Stop application by package name |
| current-package | String | Package name of the top application in screen |
| wake-lock | Number | Power wake lock value |
| screen-state | Switch | Screen power state |
#### Available key-event values:
* KEYCODE_0
* KEYCODE_1
* KEYCODE_11
* KEYCODE_12
* KEYCODE_2
* KEYCODE_3
* KEYCODE_3D_MODE
* KEYCODE_4
* KEYCODE_5
* KEYCODE_6
* KEYCODE_7
* KEYCODE_8
* KEYCODE_9
* KEYCODE_A
* KEYCODE_ALL_APPS
* KEYCODE_ALT_LEFT
* KEYCODE_ALT_RIGHT
* KEYCODE_APOSTROPHE
* KEYCODE_APP_SWITCH
* KEYCODE_ASSIST
* KEYCODE_AT
* KEYCODE_AVR_INPUT
* KEYCODE_AVR_POWER
* KEYCODE_B
* KEYCODE_BACK
* KEYCODE_BACKSLASH
* KEYCODE_BOOKMARK
* KEYCODE_BREAK
* KEYCODE_BRIGHTNESS_DOWN
* KEYCODE_BRIGHTNESS_UP
* KEYCODE_BUTTON_1
* KEYCODE_BUTTON_10
* KEYCODE_BUTTON_11
* KEYCODE_BUTTON_12
* KEYCODE_BUTTON_13
* KEYCODE_BUTTON_14
* KEYCODE_BUTTON_15
* KEYCODE_BUTTON_16
* KEYCODE_BUTTON_2
* KEYCODE_BUTTON_3
* KEYCODE_BUTTON_4
* KEYCODE_BUTTON_5
* KEYCODE_BUTTON_6
* KEYCODE_BUTTON_7
* KEYCODE_BUTTON_8
* KEYCODE_BUTTON_9
* KEYCODE_BUTTON_A
* KEYCODE_BUTTON_B
* KEYCODE_BUTTON_C
* KEYCODE_BUTTON_L1
* KEYCODE_BUTTON_L2
* KEYCODE_BUTTON_MODE
* KEYCODE_BUTTON_R1
* KEYCODE_BUTTON_R2
* KEYCODE_BUTTON_SELECT
* KEYCODE_BUTTON_START
* KEYCODE_BUTTON_THUMBL
* KEYCODE_BUTTON_THUMBR
* KEYCODE_BUTTON_X
* KEYCODE_BUTTON_Y
* KEYCODE_BUTTON_Z
* KEYCODE_C
* KEYCODE_CALCULATOR
* KEYCODE_CALENDAR
* KEYCODE_CALL
* KEYCODE_CAMERA
* KEYCODE_CAPS_LOCK
* KEYCODE_CAPTIONS
* KEYCODE_CHANNEL_DOWN
* KEYCODE_CHANNEL_UP
* KEYCODE_CLEAR
* KEYCODE_COMMA
* KEYCODE_CONTACTS
* KEYCODE_COPY
* KEYCODE_CTRL_LEFT
* KEYCODE_CTRL_RIGHT
* KEYCODE_CUT
* KEYCODE_D
* KEYCODE_DEL
* KEYCODE_DPAD_CENTER
* KEYCODE_DPAD_DOWN
* KEYCODE_DPAD_DOWN_LEFT
* KEYCODE_DPAD_DOWN_RIGHT
* KEYCODE_DPAD_LEFT
* KEYCODE_DPAD_RIGHT
* KEYCODE_DPAD_UP
* KEYCODE_DPAD_UP_LEFT
* KEYCODE_DPAD_UP_RIGHT
* KEYCODE_DVR
* KEYCODE_E
* KEYCODE_EISU
* KEYCODE_ENDCALL
* KEYCODE_ENTER
* KEYCODE_ENVELOPE
* KEYCODE_EQUALS
* KEYCODE_ESCAPE
* KEYCODE_EXPLORER
* KEYCODE_F
* KEYCODE_F1
* KEYCODE_F10
* KEYCODE_F11
* KEYCODE_F12
* KEYCODE_F2
* KEYCODE_F3
* KEYCODE_F4
* KEYCODE_F5
* KEYCODE_F6
* KEYCODE_F7
* KEYCODE_F8
* KEYCODE_F9
* KEYCODE_FOCUS
* KEYCODE_FORWARD
* KEYCODE_FORWARD_DEL
* KEYCODE_FUNCTION
* KEYCODE_G
* KEYCODE_GRAVE
* KEYCODE_GUIDE
* KEYCODE_H
* KEYCODE_HEADSETHOOK
* KEYCODE_HELP
* KEYCODE_HENKAN
* KEYCODE_HOME
* KEYCODE_I
* KEYCODE_INFO
* KEYCODE_INSERT
* KEYCODE_J
* KEYCODE_K
* KEYCODE_KANA
* KEYCODE_KATAKANA_HIRAGANA
* KEYCODE_L
* KEYCODE_LANGUAGE_SWITCH
* KEYCODE_LAST_CHANNEL
* KEYCODE_LEFT_BRACKET
* KEYCODE_M
* KEYCODE_MANNER_MODE
* KEYCODE_MEDIA_AUDIO_TRACK
* KEYCODE_MEDIA_CLOSE
* KEYCODE_MEDIA_EJECT
* KEYCODE_MEDIA_FAST_FORWARD
* KEYCODE_MEDIA_NEXT
* KEYCODE_MEDIA_PAUSE
* KEYCODE_MEDIA_PLAY
* KEYCODE_MEDIA_PLAY_PAUSE
* KEYCODE_MEDIA_PREVIOUS
* KEYCODE_MEDIA_RECORD
* KEYCODE_MEDIA_REWIND
* KEYCODE_MEDIA_SKIP_BACKWARD
* KEYCODE_MEDIA_SKIP_FORWARD
* KEYCODE_MEDIA_STEP_BACKWARD
* KEYCODE_MEDIA_STEP_FORWARD
* KEYCODE_MEDIA_STOP
* KEYCODE_MEDIA_TOP_MENU
* KEYCODE_MENU
* KEYCODE_META_LEFT
* KEYCODE_META_RIGHT
* KEYCODE_MINUS
* KEYCODE_MOVE_END
* KEYCODE_MOVE_HOME
* KEYCODE_MUHENKAN
* KEYCODE_MUSIC
* KEYCODE_MUTE
* KEYCODE_N
* KEYCODE_NAVIGATE_IN
* KEYCODE_NAVIGATE_NEXT
* KEYCODE_NAVIGATE_OUT
* KEYCODE_NAVIGATE_PREVIOUS
* KEYCODE_NOTIFICATION
* KEYCODE_NUM
* KEYCODE_NUMPAD_0
* KEYCODE_NUMPAD_1
* KEYCODE_NUMPAD_2
* KEYCODE_NUMPAD_3
* KEYCODE_NUMPAD_4
* KEYCODE_NUMPAD_5
* KEYCODE_NUMPAD_6
* KEYCODE_NUMPAD_7
* KEYCODE_NUMPAD_8
* KEYCODE_NUMPAD_9
* KEYCODE_NUMPAD_ADD
* KEYCODE_NUMPAD_COMMA
* KEYCODE_NUMPAD_DIVIDE
* KEYCODE_NUMPAD_DOT
* KEYCODE_NUMPAD_ENTER
* KEYCODE_NUMPAD_EQUALS
* KEYCODE_NUMPAD_LEFT_PAREN
* KEYCODE_NUMPAD_MULTIPLY
* KEYCODE_NUMPAD_RIGHT_PAREN
* KEYCODE_NUMPAD_SUBTRACT
* KEYCODE_NUM_LOCK
* KEYCODE_O
* KEYCODE_P
* KEYCODE_PAGE_DOWN
* KEYCODE_PAGE_UP
* KEYCODE_PAIRING
* KEYCODE_PASTE
* KEYCODE_PERIOD
* KEYCODE_PICTSYMBOLS
* KEYCODE_PLUS
* KEYCODE_POUND
* KEYCODE_POWER
* KEYCODE_PROFILE_SWITCH
* KEYCODE_PROG_BLUE
* KEYCODE_PROG_GREEN
* KEYCODE_PROG_RED
* KEYCODE_PROG_YELLOW
* KEYCODE_Q
* KEYCODE_R
* KEYCODE_REFRESH
* KEYCODE_RIGHT_BRACKET
* KEYCODE_RO
* KEYCODE_S
* KEYCODE_SCROLL_LOCK
* KEYCODE_SEARCH
* KEYCODE_SEMICOLON
* KEYCODE_SETTINGS
* KEYCODE_SHIFT_LEFT
* KEYCODE_SHIFT_RIGHT
* KEYCODE_SLASH
* KEYCODE_SLEEP
* KEYCODE_SOFT_LEFT
* KEYCODE_SOFT_RIGHT
* KEYCODE_SOFT_SLEEP
* KEYCODE_SPACE
* KEYCODE_STAR
* KEYCODE_STB_INPUT
* KEYCODE_STB_POWER
* KEYCODE_STEM_1
* KEYCODE_STEM_2
* KEYCODE_STEM_3
* KEYCODE_STEM_PRIMARY
* KEYCODE_SWITCH_CHARSET
* KEYCODE_SYM
* KEYCODE_SYSRQ
* KEYCODE_SYSTEM_NAVIGATION_DOWN
* KEYCODE_SYSTEM_NAVIGATION_LEFT
* KEYCODE_SYSTEM_NAVIGATION_RIGHT
* KEYCODE_SYSTEM_NAVIGATION_UP
* KEYCODE_T
* KEYCODE_TAB
* KEYCODE_THUMBS_DOWN
* KEYCODE_THUMBS_UP
* KEYCODE_TV
* KEYCODE_TV_ANTENNA_CABLE
* KEYCODE_TV_AUDIO_DESCRIPTION
* KEYCODE_TV_AUDIO_DESCRIPTION_MIX_DOWN
* KEYCODE_TV_AUDIO_DESCRIPTION_MIX_UP
* KEYCODE_TV_CONTENTS_MENU
* KEYCODE_TV_DATA_SERVICE
* KEYCODE_TV_INPUT
* KEYCODE_TV_INPUT_COMPONENT_1
* KEYCODE_TV_INPUT_COMPONENT_2
* KEYCODE_TV_INPUT_COMPOSITE_1
* KEYCODE_TV_INPUT_COMPOSITE_2
* KEYCODE_TV_INPUT_HDMI_1
* KEYCODE_TV_INPUT_HDMI_2
* KEYCODE_TV_INPUT_HDMI_3
* KEYCODE_TV_INPUT_HDMI_4
* KEYCODE_TV_INPUT_VGA_1
* KEYCODE_TV_MEDIA_CONTEXT_MENU
* KEYCODE_TV_NETWORK
* KEYCODE_TV_NUMBER_ENTRY
* KEYCODE_TV_POWER
* KEYCODE_TV_RADIO_SERVICE
* KEYCODE_TV_SATELLITE
* KEYCODE_TV_SATELLITE_BS
* KEYCODE_TV_SATELLITE_CS
* KEYCODE_TV_SATELLITE_SERVICE
* KEYCODE_TV_TELETEXT
* KEYCODE_TV_TERRESTRIAL_ANALOG
* KEYCODE_TV_TERRESTRIAL_DIGITAL
* KEYCODE_TV_TIMER_PROGRAMMING
* KEYCODE_TV_ZOOM_MODE
* KEYCODE_U
* KEYCODE_UNKNOWN
* KEYCODE_V
* KEYCODE_VOICE_ASSIST
* KEYCODE_VOLUME_DOWN
* KEYCODE_VOLUME_MUTE
* KEYCODE_VOLUME_UP
* KEYCODE_W
* KEYCODE_WAKEUP
* KEYCODE_WINDOW
* KEYCODE_X
* KEYCODE_Y
* KEYCODE_YEN
* KEYCODE_Z
* KEYCODE_ZENKAKU_HANKAKU
* KEYCODE_ZOOM_IN
* KEYCODE_ZOOM_OUT
## Full Example
### Sample Thing
```
Thing androiddebugbridge:android:xxxxxxxxxxxx [ ip="192.168.1.10" port=5555 refreshTime=30 ]
```
### Sample Items
```
Group androidDevice "Android TV"
String device_SendKey "Send Key" (androidDevice) { channel="androiddebugbridge:android:xxxxxxxxxxxx:key-event" }
String device_CurrentApp "Current App" (androidDevice) { channel="androiddebugbridge:android:xxxxxxxxxxxx:current-package" }
```

82
_addons_bindings/bluetooth.govee/readme.md Normal file
View File

@ -0,0 +1,82 @@
---
id: bluetooth.govee
label: Govee
title: Govee - Bindings
type: binding
description: "This extension adds support for [Govee](https://www.govee.com/) Bluetooth Devices."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Govee
This extension adds support for [Govee](https://www.govee.com/) Bluetooth Devices.
## Supported Things
Only two thing types are supported by this extension at the moment.
| Thing Type ID | Description | Supported Models |
|------------------------|-------------------------------------------|-------------------------------------------------------------|
| goveeHygrometer | Govee Thermo-Hygrometer | H5051,H5071 |
| goveeHygrometerMonitor | Govee Thermo-Hygrometer w/ Warning Alarms | H5052,H5072,H5074,H5075,H5101,H5102,H5177,H5179,B5175,B5178 |
## Discovery
As any other Bluetooth device, Govee devices are discovered automatically by the corresponding bridge.
## Thing Configuration
Govee things have the following configuration parameters:
| Thing | Parameter | Required | Default | Description |
|-----------------------------|-------------------------|----------|---------|-----------------------------------------------------------------------------------|
| all | address | yes | | The Bluetooth address of the device (in format "XX:XX:XX:XX:XX:XX") |
| all | refreshInterval | | 300 | How often, in seconds, the sensor data of the device should be refreshed |
| goveeHygrometer<sup>1</sup> | temperatureCalibration | no | | Offset to apply to temperature<sup>2</sup> sensor readings |
| goveeHygrometer<sup>1</sup> | humidityCalibration | no | | Offset to apply to humidity sensor readings |
| goveeHygrometerMonitor | temperatureWarningAlarm | | false | Enables warning alarms to be broadcast when temperature is out of specified range |
| goveeHygrometerMonitor | temperatureWarningMin | | 0 | The lower safe temperature<sup>2</sup> threshold <sup>3</sup> |
| goveeHygrometerMonitor | temperatureWarningMax | | 0 | The upper safe temperature<sup>2</sup> threshold <sup>3</sup> |
| goveeHygrometerMonitor | humidityWarningAlarm | | false | Enables warning alarms to be broadcast when humidity is out of specified range |
| goveeHygrometerMonitor | humidityWarningMin | | 0 | The lower safe humidity threshold <sup>3</sup> |
| goveeHygrometerMonitor | humidityWarningMax | | 0 | The upper safe humidity threshold <sup>3</sup> |
1. Available to both `goveeHygrometer` and `goveeHygrometerMonitor` thing types.
2. In °C
3. Only applies if alarm feature is enabled
## Channels
Govee things have the following channels in addition to the default bluetooth channels:
| Thing | Channel ID | Item Type | Description |
|-----------------------------|------------------|------------------------|----------------------------------------------------------------|
| goveeHygrometer<sup>1</sup> | temperature | Number:Temperature | The measured temperature |
| goveeHygrometer<sup>1</sup> | humidity | Number:Dimensionless | The measured relative humidity |
| goveeHygrometer<sup>1</sup> | battery | Number:Dimensionless | The measured battery percentage |
| goveeHygrometerMonitor | temperatureAlarm | Switch | Indicates if current temperature is out of range. <sup>2</sup> |
| goveeHygrometerMonitor | humidityAlarm | Switch | Indicates if current humidity is out of range. <sup>2</sup> |
1. Available to both `goveeHygrometer` and `goveeHygrometerMonitor` thing types.
2. Only applies if warning alarms are enabled in the configuration.
## Example
demo.things:
```
bluetooth:goveeHygrometer:hci0:beacon "Govee Temperature Humidity Monitor" (bluetooth:bluez:hci0) [ address="12:34:56:78:9A:BC" ]
```
demo.items:
```
Number:Temperature temperature "Room Temperature [%.1f %unit%]" { channel="bluetooth:goveeHygrometer:hci0:beacon:temperature" }
Number:Dimensionless humidity "Humidity [%.0f %unit%]" { channel="bluetooth:goveeHygrometer:hci0:beacon:humidity" }
Number:Dimensionless battery "Battery [%.0f %unit%]" { channel="bluetooth:goveeHygrometer:hci0:beacon:battery" }
```

184
_addons_bindings/boschshc/readme.md Normal file
View File

@ -0,0 +1,184 @@
---
id: boschshc
label: BoschSHC
title: BoschSHC - Bindings
type: binding
description: "Binding for the Bosch Smart Home Controller."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# BoschSHC Binding
Binding for the Bosch Smart Home Controller.
- [BoschSHC Binding](#boschshc-binding)
- [Supported Things](#supported-things)
- [Bosch In-Wall switches & Bosch Smart Plugs](#bosch-in-wall-switches--bosch-smart-plugs)
- [Bosch TwinGuard smoke detector](#bosch-twinguard-smoke-detector)
- [Bosch Window/Door contacts](#bosch-windowdoor-contacts)
- [Bosch Motion Detector](#bosch-motion-detector)
- [Bosch Shutter Control in-wall](#bosch-shutter-control-in-wall)
- [Bosch Thermostat](#bosch-thermostat)
- [Bosch Climate Control](#bosch-climate-control)
- [Limitations](#limitations)
- [Discovery](#discovery)
- [Binding Configuration](#binding-configuration)
- [Getting the device IDs](#getting-the-device-ids)
- [Thing Configuration](#thing-configuration)
- [Item Configuration](#item-configuration)
## Supported Things
### Bosch In-Wall switches & Bosch Smart Plugs
**Thing Type ID**: `in-wall-switch`
| Channel Type ID | Item Type | Description |
|--------------------|---------------|----------------------------------------------|
| power-switch | Switch | Current state of the switch. |
| power-consumption | Number:Power | Current power consumption (W) of the device. |
| energy-consumption | Number:Energy | Energy consumption of the device. |
### Bosch TwinGuard smoke detector
**Thing Type ID**: `twinguard`
| Channel Type ID | Item Type | Description |
|--------------------|----------------------|---------------------------------------------------------------------------------------------------|
| temperature | Number:Temperature | Current measured temperature. |
| temperature-rating | String | Rating of the currently measured temperature. |
| humidity | Number:Dimensionless | Current measured humidity. |
| humidity-rating | String | Rating of current measured humidity. |
| purity | Number:Dimensionless | Purity of the air (ppm). Range from 500 to 5500 ppm. A higher value indicates a higher pollution. |
| purity-rating | String | Rating of current measured purity. |
| air-description | String | Overall description of the air quality. |
| combined-rating | String | Combined rating of the air quality. |
### Bosch Window/Door contacts
**Thing Type ID**: `window-contact`
| Channel Type ID | Item Type | Description |
|-----------------|-----------|------------------------------|
| contact | Contact | Contact state of the device. |
### Bosch Motion Detector
**Thing Type ID**: `motion-detector`
| Channel Type ID | Item Type | Description |
|-----------------|-----------|--------------------------------|
| latest-motion | DateTime | The date of the latest motion. |
### Bosch Shutter Control in-wall
**Thing Type ID**: `shutter-control`
| Channel Type ID | Item Type | Description |
|-----------------|---------------|------------------------------------------|
| level | Rollershutter | Current open ratio (0 to 100, Step 0.5). |
### Bosch Thermostat
**Thing Type ID**: `thermostat`
| Channel Type ID | Item Type | Description |
|-----------------------|----------------------|------------------------------------------------|
| temperature | Number:Temperature | Current measured temperature. |
| valve-tappet-position | Number:Dimensionless | Current open ratio of valve tappet (0 to 100). |
### Bosch Climate Control
**Thing Type ID**: `climate-control`
| Channel Type ID | Item Type | Description |
|----------------------|--------------------|-------------------------------|
| temperature | Number:Temperature | Current measured temperature. |
| setpoint-temperature | Number:Temperature | Desired temperature. |
## Limitations
- Discovery of Things
- Discovery of Bridge
## Discovery
Configuration via configuration files or UI (see below).
## Bridge Configuration
You need to provide the IP address and the system password of your Bosch Smart Home Controller.
The IP address of the controller is visible in the Bosch Smart Home Mobile App (More -> System -> Smart Home Controller) or in your network router UI.
The system password is set by you during your initial registration steps in the _Bosch Smart Home App_.
A keystore file with a self signed certificate is created automatically.
This certificate is used for pairing between the Bridge and the Bosch SHC.
*Press and hold the Bosch Smart Home Controller Bridge button until the LED starts blinking after you save your settings for pairing*.
## Getting the device IDs
Bosch IDs for found devices are displayed in the openHAB log on bootup (`OPENHAB_FOLDER/userdata/logs/openhab.log`)
Example:
```
2020-08-11 12:42:49.490 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.495 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-RoomClimateControl- id=roomClimateControl_hz_1
2020-08-11 12:42:49.497 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-VentilationService- id=ventilationService
2020-08-11 12:42:49.498 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Großes Fenster id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.501 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-IntrusionDetectionSystem- id=intrusionDetectionSystem
2020-08-11 12:42:49.502 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.502 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.503 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung Haus id=hdm:ICom:819410185:HC1
2020-08-11 12:42:49.503 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-RoomClimateControl- id=roomClimateControl_hz_6
2020-08-11 12:42:49.504 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=PhilipsHueBridgeManager id=hdm:PhilipsHueBridge:PhilipsHueBridgeManager
2020-08-11 12:42:49.505 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.506 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.507 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Central Heating id=hdm:ICom:819410185
```
## Thing Configuration
You define your Bosch devices by adding them either to a `.things` file in your `$OPENHAB_CONF/things` folder like this:
```
Bridge boschshc:shc:1 [ ipAddress="192.168.x.y", password="XXXXXXXXXX" ] {
Thing in-wall-switch bathroom "Bathroom" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
Thing in-wall-switch bedroom "Bedroom" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
Thing in-wall-switch kitchen "Kitchen" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
Thing in-wall-switch corridor "Corridor" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
Thing in-wall-switch livingroom "Living Room" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
Thing in-wall-switch coffeemachine "Coffee Machine" [ id="hdm:HomeMaticIP:3014F711A0000XXXXXXXXXXXX" ]
Thing twinguard tg-corridor "Twinguard Smoke Detector" [ id="hdm:ZigBee:000d6f000XXXXXXX" ]
Thing window-contact window-kitchen "Window Kitchen" [ id="hdm:HomeMaticIP:3014F711A00000XXXXXXXXXX" ]
Thing window-contact entrance "Entrance door" [ id="hdm:HomeMaticIP:3014F711A00000XXXXXXXXXX" ]
Thing motion-detector motion-corridor "Bewegungsmelder" [ id="hdm:ZigBee:000d6f000XXXXXXX" ]
}
```
Or by adding them via UI: Settings -> Things -> "+" -> Bosch Smart Home Binding.
## Item Configuration
You define the items which should be linked to your Bosch devices via a `.items` file in your `$OPENHAB_CONF/items` folder like this:
```
Switch Bosch_Bathroom "Bath Room" { channel="boschshc:in-wall-switch:1:bathroom:power-switch" }
Switch Bosch_Bedroom "Bed Room" { channel="boschshc:in-wall-switch:1:bedroom:power-switch" }
Switch Bosch_Kitchen "Kitchen" { channel="boschshc:in-wall-switch:1:kitchen:power-switch" }
Switch Bosch_Corridor "Corridor" { channel="boschshc:in-wall-switch:1:corridor:power-switch" }
Switch Bosch_Living_Room "Living Room" { channel="boschshc:in-wall-switch:1:livingroom:power-switch" }
Switch Bosch_Lelit "Lelit" { channel="boschshc:in-wall-switch:1:coffeemachine:power-switch" }
```
Or by adding them via UI: Settings -> Items -> "+".

1
_addons_bindings/deconz/readme.md
View File

@ -184,6 +184,7 @@ Other devices support
| effect | String | R/W | Effect selection. Allowed commands are set dynamically | `colorlight` |
| effectSpeed | Number | W | Effect Speed | `colorlight` |
| lock | Switch | R/W | Lock (ON) or unlock (OFF) the doorlock| `doorlock` |
| ontime | Number:Time | W | Timespan for which the light is turned on | all lights |
| position | Rollershutter | R/W | Position of the blind | `windowcovering` |
| heatsetpoint | Number:Temperature | R/W | Target Temperature in °C | `thermostat` |
| valve | Number:Dimensionless | R | Valve position in % | `thermostat` |

2
_addons_bindings/dsmr/readme.md
View File

@ -350,7 +350,7 @@ Number:Energy MeterDeliveryTariff1 "Total electricity delivered to the resident
## Determine M-Bus channel
By manually trigger the discovery process, e.g. via PaperUI, you can use the logging to find out a M-Bus channel. Look for the following logfile line:
By manually trigger the discovery process, you can use the logging to find out a M-Bus channel. Look for the following logfile line:
`<Timestamp> [INFO ] [<class>] - New compatible meter: [Meter type: M3_V5_0, channel: 1, Meter type: ELECTRICITY_V5, channel: 0]`
Here you find the ThingTypeID (it is stated only in capitals) and the M-Bus channel. The above example would lead to the following Thing definition

6
_addons_bindings/dwdpollenflug/readme.md
View File

@ -40,9 +40,9 @@ This can be used for `region` things you may add manually.
### Region
| Parameter | Default | Required | Description |
| ---------- | :-----: | :------: | -------------------------------------------------------------------------------------------------------- |
| `regionID` | - | yes | In PaperUI just select the region you want to display data for. For files-configuration see table below. |
| Parameter | Default | Required | Description |
| ---------- | :-----: | :------: | ------------------------------------------------------------------- |
| `regionID` | - | yes | The id of the region. The available options are in the table below. |
#### Manual region or partregion selection ####

4
_addons_bindings/enocean/readme.md
View File

@ -129,7 +129,7 @@ To pair an EnOcean device with its openHAB thing representation, you have to dif
### Sensors
To pair a sensor with its thing, you first have to start the discovery scan for this binding in PaperUI.
To pair a sensor with its thing, you first have to start the discovery scan for this binding.
Then press the "teach-in" button of the sensor.
The sensor sends a teach-in message which contains the information about the EEP and the EnOceanId of the sensor.
If the EEP is known by this binding the thing representation of the device is created.
@ -138,7 +138,7 @@ The corresponding channels are created dynamically, too.
### Actuators
If the actuator supports UTE teach-in, the corresponding thing can be created and paired automatically.
First you have to **start the discovery scan for a gateway** in PaperUI.
First you have to **start the discovery scan for a gateway**.
Then press the teach-in button of the actuator.
If the EEP of the actuator is known, the binding sends an UTE teach-in response with a new SenderId and creates a new thing with its channels.

4
_addons_bindings/fmiweather/readme.md
View File

@ -43,10 +43,6 @@ The binding automatically discovers weather stations and forecasts for nearby pl
## Thing Configuration
Typically there is no need to manually configure things unless you prefer to use textual configuration, or if you want to have observation or forecast for a specific location.
In case you are using textual configuration, you need to use quotes around text parameters. In PaperUI this is not necessary.
### `observation` thing configuration
| Parameter | Type | Required | Description | Example |

2
_addons_bindings/fsinternetradio/readme.md
View File

@ -49,7 +49,7 @@ If your radio is not discovered, please try to access its API via: `http://<radi
If you get a 404 error, maybe a different port than the standard port 80 is used by your radio; try scanning the open ports of your radio.<br/>
If you get a result like `FS_OK 1902014387`, your radio is supported.
If this is the case, please [add your model to this documentation](https://github.com/openhab/openhab-addons/edit/master/bundles/org.openhab.binding.fsinternetradio/README.md) and/or provide discovery information in [this thread](https://community.openhab.org/t/internet-radio-i-need-your-help/2131).
If this is the case, please [add your model to this documentation](https://github.com/openhab/openhab-addons/edit/main/bundles/org.openhab.binding.fsinternetradio/README.md) and/or provide discovery information in [this thread](https://community.openhab.org/t/internet-radio-i-need-your-help/2131).
## Binding Configuration

185
_addons_bindings/haywardomnilogic/readme.md Normal file
View File

@ -0,0 +1,185 @@
---
id: haywardomnilogic
label: Hayward Omnilogic
title: Hayward Omnilogic - Bindings
type: binding
description: "The Hayward Omnilogic binding integrates the Omnilogic pool controller using the Hayward API."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Hayward Omnilogic Binding
The Hayward Omnilogic binding integrates the Omnilogic pool controller using the Hayward API.
The Hayward Omnilogic API interacts with Hayward's cloud server requiring a connection with the Internet for sending and receiving information.
## Supported Things
The table below lists the Hayward OmniLogic binding thing types:
| Things | Description | Thing Type |
|------------------------------|---------------------------------------------------------------------------------|---------------|
| Hayward OmniLogix Connection | Connection to Hayward's Server | bridge |
| Backyard | Backyard | backyard |
| Body of Water | Body of Water | bow |
| Chlorinator | Chlorinator | chlorinator |
| Colorlogic Light | Colorlogic Light | colorlogic |
| Filter | Filter control | filter |
| Heater Equipment | Actual heater (i.e. gas, solar, electric) | heater |
| Pump | Auxillary pump control (i.e. spillover) | pump |
| Relay | Accessory relay control (deck jet sprinklers, lights, etc.) | relay |
| Virtaul Heater | A Virtual Heater that can control all of the heater equipment based on priority | virtualHeater |
## Discovery
The binding will automatically discover the Omnilogic pool things from the cloud server using your Hayward Omnilogic credentials.
## Thing Configuration
Hayward OmniLogic Connection Parameters:
| Property | Default | Required | Description |
|----------------------|----------------------------------------------------------------|----------|----------------------------------------------|
| Host Name | https://app1.haywardomnilogic.com/HAAPI/HomeAutomation/API.ash | Yes | Host name of the Hayward API server |
| User Name | None | Yes | Your Hayward User Name (not email address) |
| Password | None | Yes | Your Hayward User Password |
| Telemetry Poll Delay | 12 | Yes | Telemetry Poll Delay (10-60 seconds) |
| Alarm Poll Delay | 60 | Yes | Alarm Poll Delay (0-120 seconds, 0 disabled) |
## Channels
### Backyard Channels
| backyardAirTemp | Number:Temperature | Backyard air temp sensor reading | R |
|-----------------|--------------------|----------------------------------|:-:|
| backyardStatus | String | Backyard status | R |
| backyardState | String | Backyard state | R |
| backyardAlarm1 | String | Backyard alarm #1 | R |
| backyardAlarm2 | String | Backyard alarm #2 | R |
| backyardAlarm3 | String | Backyard alarm #3 | R |
| backyardAlarm4 | String | Backyard alarm #4 | R |
| backyardAlarm5 | String | Backyard alarm #5 | R |
### Body of Water Channels
| Channel Type ID | Item Type | Description | Read Write |
|-----------------|--------------------|------------------------------------|:----------:|
| bowFlow | Switch | Body of Water flow sensor feedback | R |
| bowWaterTemp | Number:Temperature | Body of Water temperature | R |
### Chlorinator Channels
| Channel Type ID | Item Type | Description | Read Write |
|-----------------------|----------------------|----------------------------------------------------------|:----------:|
| chlorEnable | Switch | Chlorinator enable | R/W |
| chlorOperatingMode | String | Chlorinator operating mode | R |
| chlorTimedPercent | Number:Dimensionless | Chlorinator timed percent | R/W |
| chlorOperatingState | Number | Chlorinator operating state | R |
| chlorScMode | String | Chlorinator super chlorinate mode | R |
| chlorError | Number | Chlorinator error | R |
| chlorAlert | String | Chlorinator alert | R |
| chlorAvgSaltLevel | Number:Dimensionless | Chlorinator average salt level in Part per Million (ppm) | R |
| chlorInstantSaltLevel | Number:Dimensionless | Chlorinator instant salt level in Part per Million (ppm) | R |
| chlorStatus | Number | Chlorinator K1/K2 relay status | R |
### Colorlogic Light Channels
| Channel Type ID | Item Type | Description | Read Write |
|----------------------------|-----------|-------------------------------|:----------:|
| colorLogicLightEnable | Switch | Colorlogic Light enable | R/W |
| colorLogicLightState | String | Colorlogic Light state | R |
| colorLogicLightCurrentShow | String | Colorlogic Light current show | R/W |
### Filter Channels
| Channel Type ID | Item Type | Description | Read Write |
|---------------------|----------------------|------------------------|:----------:|
| filterEnable | Switch | Filter enable | R/W |
| filterValvePosition | String | Filter valve position | R |
| filterSpeed | Number:Dimensionless | Filter speed in % | R/W |
| filterState | String | Filter state | R |
| filterLastSpeed | Number:Dimensionless | Filter last speed in % | R |
### Heater Channels
| Channel Type ID | Item Type | Description | Read Write |
|-----------------|-----------|---------------|:----------:|
| heaterState | Number | Heater state | R |
| heaterEnable | Switch | Heater enable | R |
### Pump Channels
| Channel Type ID | Item Type | Description | Read Write |
|-----------------|----------------------|-----------------|:----------:|
| pumpEnable | Switch | Pump enable | R |
| pumpSpeed | Number:Dimensionless | Pump speed in % | R |
### Relay Channels
| Channel Type ID | Item Type | Description | Read Write |
|-----------------|-----------|-------------|:----------:|
| relayState | Switch | Relay state | R/W |
### Virtual Heater Channels
| Channel Type ID | Item Type | Description | Read Write |
|-----------------------|--------------------|-------------------------|:----------:|
| heaterEnable | Number | Heater enable | R |
| heaterCurrentSetpoint | Number:Temperature | Heater Current Setpoint | R/W |
## Full Example
After installing the binding, you will need to manually add the Hayward Connection thing and enter your credentials.
All pool items can be autmatically discovered by scanning the bridge
Goto the inbox and add the things.
### demo.items:
```text
Group gPool "Pool" ["Location"]
Group gHaywardChlorinator "Hayward Chlorinator" (gPool) ["Equipment"]
Switch HaywardChlorinator_Power "Power" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorEnable" }
String HaywardChlorinator_OperatingMode "Operating Mode" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorOperatingMode" }
Number:Dimensionless HaywardChlorinator_SaltOutput "Salt Output (%)" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorTimedPercent" }
String HaywardChlorinator_scMode "scMode" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorScMode" }
Number HaywardChlorinator_ChlorinatorError "Chlorinator Error" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorError" }
String HaywardChlorinator_ChlorinatorAlert "Chlorinator Alert" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorAlert" }
Number:Dimensionless HaywardChlorinator_AverageSaltLevel "Average Salt Level" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorAvgSaltLevel" }
Number:Dimensionless HaywardChlorinator_InstantSaltLevel "Instant Salt Level" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorInstantSaltLevel" }
Number HaywardChlorinator_Status "Status" (gHaywardChlorinator) ["Point"] { channel="haywardomnilogic:chlorinator:3766402f00:34:chlorStatus" }
Group gHaywardBackyard "Hayward Backyard" (gPool) ["Equipment"]
Number:Temperature HaywardBackyard_AirTemp "Air Temp" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardAirTemp" }
String HaywardBackyard_Status "Status" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardStatus" }
String HaywardBackyard_State "State" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardState" }
String HaywardBackyard_BackyardAlarm1 "Alarm" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardAlarm1" }
String HaywardBackyard_BackyardAlarm2 "Alarm" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardAlarm2" }
String HaywardBackyard_BackyardAlarm3 "Alarm" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardAlarm3" }
String HaywardBackyard_BackyardAlarm4 "Alarm" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardAlarm4" }
String HaywardBackyard_BackyardAlarm5 "Alarm" (gHaywardBackyard) ["Point"] { channel="haywardomnilogic:backyard:3766402f00:35940:backyardAlarm5" }
Group gHaywardGas "Hayward Gas" (gPool) ["Equipment"]
Number HaywardGas_HeaterState "Heater State" (gHaywardGas) ["Point"] { channel="haywardomnilogic:heater:3766402f00:33:heaterState" }
Switch HaywardGas_HeaterEnable "Heater Enable" (gHaywardGas) ["Point"] { channel="haywardomnilogic:heater:3766402f00:33:heaterEnable" }
Group gHaywardJets "Hayward Jets" (gPool) ["Equipment"]
Switch HaywardJets_Power "Power" (gHaywardJets) ["Point"] { channel="haywardomnilogic:relay:3766402f00:37:relayState" }
Group gHaywardPool "Hayward Pool" (gPool) ["Equipment"]
Switch HaywardPool_FlowSensor "Flow Sensor" (gHaywardPool) ["Point"] { channel="haywardomnilogic:bow:3766402f00:30:bowFlow" }
Number:Temperature HaywardPool_WaterTemp "Water Temp" (gHaywardPool) ["Point"] { channel="haywardomnilogic:bow:3766402f00:30:bowWaterTemp" }
Group gHaywardPoolLight "Hayward Pool Light" (gPool) ["Equipment"]
Switch HaywardPoolLight_Power "Power" (gHaywardPoolLight) ["Point"] { channel="haywardomnilogic:colorlogic:3766402f00:38:colorLogicLightEnable" }
String HaywardPoolLight_LightState "Light State" (gHaywardPoolLight) ["Point"] { channel="haywardomnilogic:colorlogic:3766402f00:38:colorLogicLightState" }
String HaywardPoolLight_CurrentShow "Current Show" (gHaywardPoolLight) ["Point"] { channel="haywardomnilogic:colorlogic:3766402f00:38:colorLogicLightCurrentShow" }
```

31
_addons_bindings/homematic/readme.md
View File

@ -148,24 +148,12 @@ Callback network address of the system runtime, default is auto-discovery
- **bindAddress**
The address the XML-/BINRPC server binds to, default is value of "callbackHost"
- **callbackPort** (DEPRECATED, use "binCallbackPort" resp. "xmlCallbackPort")
Callback port of the binding's server, default is 9125 and counts up for each additional bridge
- **xmlCallbackPort**
Callback port of the binding's XML-RPC server, default is 9125 and counts up for each additional bridge
- **binCallbackPort**
Callback port of the binding's BIN-RPC server, default is 9126 and counts up for each additional bridge
- **aliveInterval** (DEPRECATED, not necessary anymore)
The interval in seconds to check if the communication with the Homematic gateway is still alive. If no message receives from the Homematic gateway, the RPC server restarts (default = 300)
- **reconnectInterval** (DEPRECATED, not necessary anymore)
The interval in seconds to force a reconnect to the Homematic gateway, disables "aliveInterval"! (0 = disabled, default = disabled).
If you have no sensors which sends messages in regular intervals and/or you have low communication, the "aliveInterval" may restart the connection to the Homematic gateway to often.
The "reconnectInterval" disables the "aliveInterval" and reconnects after a fixed period of time.
Think in hours when configuring (one hour = 3600)
- **timeout**
The timeout in seconds for connections to a Homematic gateway (default = 15)
@ -198,6 +186,11 @@ If set to true, devices are automatically unpaired from the gateway when their c
If set to true, devices are automatically factory reset when their corresponding things are removed.
Due to the factory reset, the device will also be unpaired from the gateway, even if "unpairOnDeletion" is set to false! (default = false)
- **bufferSize**
If a large number of devices are connected to the gateway, the default buffersize of 2048 kB may be too small for communication with the gateway.
In this case, e.g. the discovery fails.
With this setting the buffer size can be adjusted. The value is specified in kB.
The syntax for a bridge is:
```java
@ -231,7 +224,7 @@ Bridge homematic:bridge:occu [ gatewayAddress="..."]
## Thing Configuration
Things are all discovered automatically, you can handle them in PaperUI.
Things are all discovered automatically.
If you really like to manually configure a thing:
@ -247,13 +240,6 @@ If you are using Homegear, you have to add the prefix `HG-` for each type.
The `HG-` prefix is only needed for Things, not for Items or channel configs.
This is necessary, because the Homegear devices supports more datapoints than Homematic devices.
```java
Thing HG-HM-LC-Dim1T-Pl-2 JEQ0999999
```
As additional parameters you can define a name and a location for each thing.
The `Name` will be used to identify the thing in the Paper UI lists, the `Location` will be used in the Control section of PaperUI to sort the things.
```java
Thing HG-HM-LC-Dim1T-Pl-2 JEQ0999999 "Name" @ "Location"
```
@ -691,6 +677,11 @@ Var_1.sendCommand(RefreshType.REFRESH)
**Note:** adding new and removing deleted variables from the GATEWAY-EXTRAS thing is currently not supported.
You have to delete the thing, start a scan and add it again.
**`openhab.log` contains an exception with message: `Buffering capacity 2097152 exceeded` resp. discovery detects no devices**
In case of problems in the discovery or if above mentioned error message appears in `openhab.log`, the size for the transmission buffer for the communication with the gateway is too small.
The problem can be solved by increasing the `bufferSize` value in the bridge configuration.
### Debugging and Tracing
If you want to see what's going on in the binding, switch the log level to DEBUG in the Karaf console

4
_addons_bindings/http/readme.md
View File

@ -49,6 +49,10 @@ Authentication might fail if redirections are involved as headers are stripper p
*Note:* If you rate-limit requests by using the `delay` parameter you have to make sure that the time between two refreshes is larger than the time needed for one refresh cycle.
**Attention:** `baseUrl` (and `stateExtension`/`commandExtension`) should not use escaping (e.g. `%22` instead of `"` or `%2c` instead of `,`).
URLs are properly escaped by the binding itself before the request is sent.
Using escaped strings in URL parameters may lead to problems with the formatting (see below).
## Channels
Each item type has its own channel-type.

62
_addons_bindings/hue/readme.md
View File

@ -80,16 +80,9 @@ They are presented by the following ZigBee Device ID and _Thing type_:
The Hue Dimmer Switch has 4 buttons and registers as a Non-Colour Controller switch, while the Hue Tap (also 4 buttons) registers as a Non-Colour Scene Controller in accordance with the ZLL standard.
Also, Hue bridge support CLIP Generic Status Sensor and CLIP Generic Flag Sensor. These sensors save state for rules and calculate what actions to do. CLIP Sensor set or get by JSON through IP.
The type of a specific device can be found in the configuration section for things in the PaperUI.
It is part of the unique thing id which could look like:
```
hue:0210:00178810d0dc:1
```
The thing type is the second string behind the first colon and in this example it is **0210**.
Also, Hue bridge support CLIP Generic Status Sensor and CLIP Generic Flag Sensor.
These sensors save state for rules and calculate what actions to do.
CLIP Sensor set or get by JSON through IP.
Finally, the Hue binding also supports the groups of lights and rooms set up on the Hue bridge.
@ -180,28 +173,29 @@ The group type also have an optional configuration value to specify the fade tim
The devices support some of the following channels:
| Channel Type ID | Item Type | Description | Thing types supporting this channel |
|-------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| switch | Switch | This channel supports switching the device on and off. | 0000, 0010, group |
| color | Color | This channel supports full color control with hue, saturation and brightness values. | 0200, 0210, group |
| brightness | Dimmer | This channel supports adjusting the brightness value. Note that this is not available, if the color channel is supported. | 0100, 0110, 0220, group |
| color_temperature | Dimmer | This channel supports adjusting the color temperature from cold (0%) to warm (100%). | 0210, 0220, group |
| alert | String | This channel supports displaying alerts by flashing the bulb either once or multiple times. Valid values are: NONE, SELECT and LSELECT. | 0000, 0100, 0200, 0210, 0220, group |
| effect | Switch | This channel supports color looping. | 0200, 0210, 0220 |
| dimmer_switch | Number | This channel shows which button was last pressed on the dimmer switch. | 0820 |
| illuminance | Number:Illuminance | This channel shows the current illuminance measured by the sensor. | 0106 |
| light_level | Number | This channel shows the current light level measured by the sensor. **Advanced** | 0106 |
| dark | Switch | This channel indicates whether the light level is below the darkness threshold or not. | 0106 |
| daylight | Switch | This channel indicates whether the light level is below the daylight threshold or not. | 0106 |
| presence | Switch | This channel indicates whether a motion is detected by the sensor or not. | 0107 |
| enabled | Switch | This channel activated or deactivates the sensor | 0107 |
| temperature | Number:Temperature | This channel shows the current temperature measured by the sensor. | 0302 |
| flag | Switch | This channel save flag state for a CLIP sensor. | 0850 |
| status | Number | This channel save status state for a CLIP sensor. | 0840 |
| last_updated | DateTime | This channel the date and time when the sensor was last updated. | 0820, 0830, 0840, 0850, 0106, 0107, 0302 |
| battery_level | Number | This channel shows the battery level. | 0820, 0106, 0107, 0302 |
| battery_low | Switch | This channel indicates whether the battery is low or not. | 0820, 0106, 0107, 0302 |
| scene | String | This channel activates the scene with the given ID String. The ID String of each scene is assigned by the Hue bridge. | bridge, group |
| Channel Type ID | Item Type | Description | Thing types supporting this channel |
|-----------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| switch | Switch | This channel supports switching the device on and off. | 0000, 0010, group |
| color | Color | This channel supports full color control with hue, saturation and brightness values. | 0200, 0210, group |
| brightness | Dimmer | This channel supports adjusting the brightness value. Note that this is not available, if the color channel is supported. | 0100, 0110, 0220, group |
| color_temperature | Dimmer | This channel supports adjusting the color temperature from cold (0%) to warm (100%). | 0210, 0220, group |
| color_temperature_abs | Number | This channel supports adjusting the color temperature in Kelvin. **Advanced** | 0210, 0220, group |
| alert | String | This channel supports displaying alerts by flashing the bulb either once or multiple times. Valid values are: NONE, SELECT and LSELECT. | 0000, 0100, 0200, 0210, 0220, group |
| effect | Switch | This channel supports color looping. | 0200, 0210, 0220 |
| dimmer_switch | Number | This channel shows which button was last pressed on the dimmer switch. | 0820 |
| illuminance | Number:Illuminance | This channel shows the current illuminance measured by the sensor. | 0106 |
| light_level | Number | This channel shows the current light level measured by the sensor. **Advanced** | 0106 |
| dark | Switch | This channel indicates whether the light level is below the darkness threshold or not. | 0106 |
| daylight | Switch | This channel indicates whether the light level is below the daylight threshold or not. | 0106 |
| presence | Switch | This channel indicates whether a motion is detected by the sensor or not. | 0107 |
| enabled | Switch | This channel activated or deactivates the sensor | 0107 |
| temperature | Number:Temperature | This channel shows the current temperature measured by the sensor. | 0302 |
| flag | Switch | This channel save flag state for a CLIP sensor. | 0850 |
| status | Number | This channel save status state for a CLIP sensor. | 0840 |
| last_updated | DateTime | This channel the date and time when the sensor was last updated. | 0820, 0830, 0840, 0850, 0106, 0107, 0302 |
| battery_level | Number | This channel shows the battery level. | 0820, 0106, 0107, 0302 |
| battery_low | Switch | This channel indicates whether the battery is low or not. | 0820, 0106, 0107, 0302 |
| scene | String | This channel activates the scene with the given ID String. The ID String of each scene is assigned by the Hue bridge. | bridge, group |
To load a hue scene inside a rule for example, the ID of the scene will be required.
You can list all the scene IDs with the following console commands: `hue <bridgeUID> scenes` and `hue <groupThingUID> scenes`.
@ -379,12 +373,12 @@ end
```
The optional `<EVENT>` represents one of the button events that are generated by the Hue Dimmer Switch.
If ommited the rule gets triggered by any key action and you can determine the event that triggered it with the `receivedEvent.getEvent()` method.
If ommited the rule gets triggered by any key action and you can determine the event that triggered it with the `receivedEvent` method.
Be aware that the events have a '.0' attached to them, like `2001.0` or `34.0`.
So, testing for specific events looks like this:
```php
if (receivedEvent.getEvent() == "1000.0")) {
if (receivedEvent == "1000.0")) {
//do stuff
}
```

11
_addons_bindings/irobot/readme.md
View File

@ -46,7 +46,7 @@ known, however, whether the password is eternal or can change during factory res
| channel | type | description | Read-only |
|---------------|--------|----------------------------------------------------|-----------|
| command | String | Command to execute: clean, spot, dock, pause, stop | N |
| command | String | Command to execute: clean, cleanRegions, spot, dock, pause, stop | N |
| cycle | String | Current mission: none, clean, spot | Y |
| phase | String | Current phase of the mission; see below. | Y |
| battery | Number | Battery charge in percents | Y |
@ -66,6 +66,7 @@ known, however, whether the password is eternal or can change during factory res
| always_finish | Switch | Whether to keep cleaning if the bin becomes full | N |
| power_boost | String | Power boost mode: "auto", "performance", "eco" | N |
| clean_passes | String | Number of cleaning passes: "auto", "1", "2" | N |
| last_command | String | Json string containing the parameters of the last executed command | N |
Known phase strings and their meanings:
@ -151,6 +152,14 @@ Error codes. Data type is string in order to be able to utilize mapping to human
| 75 | Navigation problem |
| 76 | Hardware problem detected |
## Cleaning specific regions
You can clean one or many specific regions of a given map by sending the following String to the command channel:
```
cleanRegions:<pmapId>;<region_id1>,<region_id2>,..
```
The easiest way to determine the pmapId and region_ids is to monitor the last_command channel while starting a new mission for the specific region with the iRobot-App.
## Known Problems / Caveats
1. Sending "pause" command during missions other than "clean" is equivalent to sending "stop"

58
_addons_bindings/knx/readme.md
View File

@ -16,7 +16,7 @@ install: auto
# KNX Binding
The openHAB KNX binding allows to connect to [KNX Home Automation](https://www.knx.org/) installations.
The openHAB KNX binding allows to connect to [KNX Home Automation](https://www.knx.org/) installations.
Switching lights on and off, activating your roller shutters or changing room temperatures are only some examples.
To access your KNX bus you either need a gateway device which is connected to the KNX bus and allows computers to access the bus communication.
@ -32,7 +32,7 @@ There is an *ip* bridge to connect to KNX IP Gateways, and a *serial* bridge for
## Binding Configuration
The binding itself does not require any special configuration.
The binding itself does not require any special configuration.
## Bridges
@ -224,11 +224,11 @@ Only add parameters to the Bridge and Thing configuration if you know exactly wh
knx.things:
```xtend
Bridge knx:ip:bridge [
Bridge knx:ip:bridge [
type="ROUTER",
autoReconnectPeriod=60 //optional, do not set <30 sec.
] {
Thing device knx_device "knx_device_name" @ "knx_device_group_in_paperui" [
Thing device knx_device "knx_device_name" @ "knx_device_group" [
//readInterval=3600 //optional, only used if reading values are present
] {
//Items configurations
@ -241,12 +241,12 @@ Bridge knx:ip:bridge [
knx.things:
```xtend
Bridge knx:ip:bridge [
Bridge knx:ip:bridge [
type="TUNNEL",
ipAddress="192.168.0.111",
autoReconnectPeriod=60 //optional, do not set <30 sec.
] {
Thing device knx_device "knx_device_name" @ "knx_device_group_in_paperui" [
Thing device knx_device "knx_device_name" @ "knx_device_group" [
//readInterval=3600 //optional, only used if reading values are present
] {
//Items configurations
@ -258,14 +258,14 @@ Bridge knx:ip:bridge [
```xtend
//TUNNEL
Bridge knx:ip:bridge [
type="TUNNEL",
ipAddress="192.168.0.10",
portNumber=3671,
Bridge knx:ip:bridge [
type="TUNNEL",
ipAddress="192.168.0.10",
portNumber=3671,
localIp="192.168.0.11",
readingPause=50,
responseTimeout=10,
readRetriesLimit=3,
readingPause=50,
responseTimeout=10,
readRetriesLimit=3,
autoReconnectPeriod=60,
localSourceAddr="0.0.0"
] {
@ -286,14 +286,14 @@ Bridge knx:ip:bridge [
}
//ROUTER
Bridge knx:ip:bridge [
type="ROUTER",
ipAddress="224.0.23.12",
portNumber=3671,
Bridge knx:ip:bridge [
type="ROUTER",
ipAddress="224.0.23.12",
portNumber=3671,
localIp="192.168.0.11",
readingPause=50,
responseTimeout=10,
readRetriesLimit=3,
readingPause=50,
responseTimeout=10,
readRetriesLimit=3,
autoReconnectPeriod=60,
localSourceAddr="0.0.0"
] {}
@ -323,7 +323,7 @@ sitemap knx label="KNX Demo Sitemap" {
Slider item=demoDimmer
Text item=demoString
Text item=demoDatetime
}
}
}
```
@ -333,11 +333,11 @@ sitemap knx label="KNX Demo Sitemap" {
control.things:
```xtend
Bridge knx:serial:bridge [
serialPort="/dev/ttyAMA0",
readingPause=50,
responseTimeout=10,
readRetriesLimit=3,
Bridge knx:serial:bridge [
serialPort="/dev/ttyAMA0",
readingPause=50,
responseTimeout=10,
readRetriesLimit=3,
autoReconnectPeriod=60
] {
Thing device generic {
@ -350,9 +350,9 @@ Bridge knx:serial:bridge [
}
}
Bridge hue:bridge:bridge "Philips Hue Bridge" [
ipAddress="...",
userName="..."
Bridge hue:bridge:bridge "Philips Hue Bridge" [
ipAddress="...",
userName="..."
] {
Thing 0210 1 "Color Lamp" [ lightId="1" ]
}

2
_addons_bindings/miele/readme.md
View File

@ -70,7 +70,7 @@ Thing coffeemachine coffeemachine [uid="001d63fffe020505#190"]
## Channels
The definition of the channels in use can best be checked in the [source repository](https://github.com/openhab/openhab-addons/tree/master/bundles/org.openhab.binding.miele/src/main/resources/OH-INF/thing).
The definition of the channels in use can best be checked in the [source repository](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.miele/src/main/resources/OH-INF/thing).
## Example

BIN
_addons_bindings/miio/doc/miioBindingConfig.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 57 KiB

BIN
_addons_bindings/miio/doc/miioBindingConfig2.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 78 KiB

12048
_addons_bindings/miio/readme.md
View File

File diff suppressed because it is too large Load Diff

2
_addons_bindings/modbus/readme.md
View File

@ -1280,7 +1280,7 @@ Check thing status for errors in configuration or communication.
Enable `DEBUG` or `TRACE` (even more verbose) logging for the loggers named:
* `org.openhab.binding.modbus`
* `org.openhab.io.transport.modbus`
* `org.openhab.core.io.transport.modbus`
* `net.wimpi.modbus`
Consult [openHAB logging documentation](https://www.openhab.org/docs/administration/logging.html#defining-what-to-log) for more information.

2
_addons_bindings/mqtt.generic/readme.md
View File

@ -301,4 +301,4 @@ Any outgoing value transformation will **always** result in a __string__ value.
## Troubleshooting
* If you get the error "No MQTT client": Please update your installation.
* If you use the Mosquitto broker: Please be aware that there is a relatively low setting for retained messages. At some point messages will just not being delivered anymore: Change the setting.
* If you use the Mosquitto broker: Please be aware that there is a relatively low setting for retained messages. If at some point messages stop being delivered change the setting.

9
_addons_bindings/mqtt.homeassistant/readme.md
View File

@ -24,6 +24,15 @@ The mapping is structured like this:
| Component+Node | Channel Group | homeassistant/component/node/object|
| -> Component Features | Channel | state/topic/defined/in/comp/config |
## Requirements
The HomeAssistant MQTT requires two transformations to be installed:
* JINJA-Transformations
* JSONPath-Transformations
These can be installed under Settings->Addons->Transformations
## Limitations
* The HomeAssistant Fan Components only support ON/OFF.

4
_addons_bindings/nibeheatpump/readme.md
View File

@ -77,7 +77,7 @@ An Arduino-based solution has been tested with Arduino uno + RS485 and Ethernet
The [ProDiNo](https://www.kmpelectronics.eu/en-us/products/prodinoethernet.aspx) NetBoards are also supported.
A ProDiNo has an Ethernet and RS-485 port on the board.
Arduino code is available [here](https://github.com/openhab/openhab-addons/tree/master/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/Arduino/NibeGW).
Arduino code is available [here](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/Arduino/NibeGW).
Arduino code can be build via Arduino IDE.
For more details see [www.arduino.cc](https://www.arduino.cc/en/Main/Software).
@ -85,7 +85,7 @@ NibeGW configuration (such IP addresses, ports, etc) can be adapted directly by
### Raspberry Pi (or other Linux/Unix based boards)
C code is available [here](https://github.com/openhab/openhab-addons/tree/master/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/RasPi).
C code is available [here](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/RasPi).
To build the C code use:

335
_addons_bindings/omnilink/readme.md Normal file
View File

@ -0,0 +1,335 @@
---
id: omnilink
label: HAI/Leviton OmniLink
title: HAI/Leviton OmniLink - Bindings
type: binding
description: "This binding integrates the [OmniPro and Lumina](http://www.leviton.com/en/products/security-automation/automation-av-controllers/omni-security-systems) line of home automation systems."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# HAI/Leviton OmniLink Binding
This binding integrates the [OmniPro and Lumina](http://www.leviton.com/en/products/security-automation/automation-av-controllers/omni-security-systems) line of home automation systems.
At its core the OmniPro is a hardware board that provides security and access features.
It connects to many other devices through serial ports or wired contacts and exposes them through a single TCP based API.
## Supported Things
The OmniPro/Lumina controller acts as a "bridge" for accessing other connected devices.
| Omni type | Hardware Type | Things |
|:---------------------------|:-------------------------------------------------|:----------------------------------|
| Controller | Omni (Pro II, IIe, LTe), Lumina | `controller` (omni, lumina) |
| Lights | Built-in, UPB, HLC | `unit`, `dimmable`, `upb`, `room` |
| Thermostats | Omnistat, Omnistat2 | `thermostat` |
| Temperature Sensors | 31A00-1/31A00-7 | `temp_sensor` |
| Humidity Sensors | 31A00-2 | `humidity_sensor` |
| Zones | Built-in/Hardwire, GE Wireless | `zone` |
| Audio Zones/Sources | HAI Hi-Fi, Russound, NuVo, Xantech, Speakercraft | `audio_zone`, `audio_source` |
| Consoles | HAI Omni Console, HAI Lumina Console | `console` |
| Areas | Built-in | `area`, `lumina_area` |
| Buttons | Built-in | `button` |
| Flags | Built-in | `flag` |
| Output | Built-in/Hardwire | `output` |
| Access Control Reader Lock | Leviton Access Control Reader | `lock` |
## Discovery
### Controller
Omni and Lumina controllers must be manually added using the IP and port of the controller as well as the 2 encryption keys required for network access.
### Devices
Once a connection can be established to a controller, all connected devices will be automatically discovered and added to the inbox.
## Thing Configuration
An Omni or Lumina controller requires the IP address (`ipAddress`), optional port (`port` defaults to 4369), and 2 encryption keys (`key1`, `key2`).
The hexadecimal pairs in the encryption keys are typically delimited using a colon`:`, but dashes `-`, spaces ` ` or no delimiter may be used.
In the thing file, this looks like:
```
Bridge omnilink:controller:home [ ipAddress="127.0.0.1", port=4369, key1="XXXXXXXXXXXXXXXX", key2="XXXXXXXXXXXXXXXX" ] {
// Add your things here
}
```
The devices are identified by the device number that the OmniLink bridge assigns to them, see the [Full Example](#full-example) section below for a manual configuration example.
## Channels
The devices support some of the following channels:
| Channel Type ID | Item Type | Description | Thing types supporting this channel |
|-----------------------------|----------------------|--------------------------------------------------------------------------------------|-----------------------------------------------------|
| `activate_keypad_emergency` | Number | Activate a burglary, fire, or auxiliary keypad emergency alarm on Omni based models. | `area` |
| `alarm_burglary` | Switch | Indicates if a burglary alarm is active. | `area` |
| `alarm_fire` | Switch | Indicates if a fire alarm is active. | `area` |
| `alarm_gas` | Switch | Indicates if a gas alarm is active. | `area` |
| `alarm_auxiliary` | Switch | Indicates if a auxiliary alarm is active. | `area` |
| `alarm_freeze` | Switch | Indicates if a freeze alarm is active. | `area` |
| `alarm_water` | Switch | Indicates if a water alarm is active. | `area` |
| `alarm_duress` | Switch | Indicates if a duress alarm is active. | `area` |
| `alarm_temperature` | Switch | Indicates if a temperature alarm is active. | `area` |
| `mode` | Number | Represents the area security mode. | `area`, `lumina_area` |
| `disarm` | String | Send a 4 digit user code to disarm the system. | `area` |
| `day` | String | Send a 4 digit user code to arm the system to day. | `area` |
| `night` | String | Send a 4 digit user code to arm the system to night. | `area` |
| `away` | String | Send a 4 digit user code to arm the system to away. | `area` |
| `vacation` | String | Send a 4 digit user code to arm the system to vacation. | `area` |
| `day_instant` | String | Send a 4 digit user code to arm the system to day instant. | `area` |
| `night_delayed` | String | Send a 4 digit user code to arm the system to night delayed. | `area` |
| `home` | String | Send a 4 digit user code to set the system to home. | `lumina_area` |
| `sleep` | String | Send a 4 digit user code to set the system to sleep. | `lumina_area` |
| `away` | String | Send a 4 digit user code to set the system to away. | `lumina_area` |
| `vacation` | String | Send a 4 digit user code to set the system to vacation. | `lumina_area` |
| `party` | String | Send a 4 digit user code to set the system to party. | `lumina_area` |
| `special` | String | Send a 4 digit user code to set the system to special. | `lumina_area` |
| `source_text_{1,2,3,4,5,6}` | String | A line of metadata from this audio source. | `audio_source` |
| `polling` | Switch | Enable or disable polling of this audio source. | `audio_source` |
| `zone_power` | Switch | Power status of this audio zone. | `audio_zone` |
| `zone_mute` | Switch | Mute status of this audio zone. | `audio_zone` |
| `zone_volume` | Dimmer | Volume level of this audio zone. | `audio_zone` |
| `zone_source` | Number | Source for this audio zone. | `audio_zone` |
| `zone_control` | Player | Control the audio zone, e.g. start/stop/next/previous. | `audio_zone` |
| `sysdate` | DateTime | Set controller date/time. | `controller` |
| `last_log` | String | Last log message on the controller, represented in JSON. | `controller` |
| `enable_disable_beeper` | Switch | Enable/Disable the beeper for this/all console(s). | `controller`, `console` |
| `beep` | Switch | Send a beep command to this/all console(s). | `controller`, `console` |
| `press` | Switch | Sends a button event to the controller. | `button` |
| `low_setpoint` | Number | The current low setpoint for this humidity/temperature sensor. | `temp_sensor`, `humidity_sensor` |
| `high_setpoint` | Number | The current high setpoint for this humidity/temperature sensor. | `temp_sensor`, `humidity_sensor` |
| `temperature` | Number:Temperature | The current temperature at this thermostat/temperature sensor. | `thermostat`, `temp_sensor` |
| `humidity` | Number:Dimensionless | The current relative humidity at this thermostat/humidity sensor. | `thermostat`, `humidity_sensor` |
| `freeze_alarm` | Contact | Closed when freeze alarm is triggered by this thermostat. | `thermostat` |
| `comm_failure` | Contact | Closed during a communications failure with this thermostat. | `thermostat` |
| `outdoor_temperature` | Number:Temperature | The current outdoor temperature detected by this thermostat. | `thermostat` |
| `heat_setpoint` | Number:Temperature | The current low/heating setpoint of this thermostat. | `thermostat` |
| `cool_setpoint` | Number:Temperature | The current high/cooling setpoint of this thermostat. | `thermostat` |
| `humidify_setpoint` | Number:Dimensionless | The current low/humidify setpoint for this thermostat. | `thermostat` |
| `dehumidify_setpoint` | Number:Dimensionless | The current high/dehumidify setpoint for this thermostat. | `thermostat` |
| `system_mode` | Number | The current system mode of this thermostat. | `thermostat` |
| `fan_mode` | Number | The current fan mode of this thermostat. | `thermostat` |
| `hold_status` | Number | The current hold status of this thermostat. | `thermostat` |
| `status` | Number | The current numeric status of this thermostat. | `thermostat` |
| `level` | Dimmer | Increase/Decrease the level of this unit/dimmable unit/UPB unit. | `unit`, `dimmable`, `upb` |
| `switch` | Switch | Turn this unit/dimmable unit/flag/output/room on/off. | `unit`, `dimmable`, `upb`, `flag`, `output`, `room` |
| `on_for_seconds` | Number | Turn on this unit for a specified number of seconds. | `unit`, `dimmable`, `upb`, `flag`, `output` |
| `off_for_seconds` | Number | Turn off this unit for a specified number of seconds. | `unit`, `dimmable`, `upb`, `flag`, `output` |
| `on_for_minutes` | Number | Turn on this unit for a specified number of minutes. | `unit`, `dimmable`, `upb`, `flag`, `output` |
| `off_for_minutes` | Number | Turn off this unit for a specified number of minutes. | `unit`, `dimmable`, `upb`, `flag`, `output` |
| `on_for_hours` | Number | Turn on this unit for a specified number of hours. | `unit`, `dimmable`, `upb`, `flag`, `output` |
| `off_for_hours` | Number | Turn off this unit for a specified number of hours. | `unit`, `dimmable`, `upb`, `flag`, `output` |
| `upb_status` | String | Send a UPB status request message for this UPB unit to the controller. | `upb` |
| `value` | Number | Numeric value of this flag. | `flag` |
| `scene_{a,b,c,d}` | Switch | Turn this scene on/off. | `room` |
| `state` | Number | The current state of this room. | `room` |
| `contact` | Contact | Contact state information of this zone. | `zone` |
| `current_condition` | Number | Current condition of this zone. | `zone` |
| `latched_alarm_status` | Number | Latched alarm status of this zone. | `zone` |
| `arming_status` | Number | Arming status of this zone. | `zone` |
| `bypass` | String | Send a 4 digit user code to bypass this zone. | `zone` |
| `restore` | String | Send a 4 digit user code to restore this zone. | `zone` |
### Trigger Channels
The devices support some of the following trigger channels:
| Channel Type ID | Description | Thing types supporting this channel |
|-------------------------------|--------------------------------------------------------------------------------------|-------------------------------------|
| `all_on_off_event` | Event sent when an all on/off event occurs. | `area`, `lumina_area` |
| `phone_line_event` | Event sent when the phone line changes state. | `controller` |
| `ac_power_event` | Event sent when AC trouble conditions are detected. | `controller` |
| `battery_event` | Event sent when battery trouble conditions are detected. | `controller` |
| `dcm_event` | Event sent when digital communicator trouble conditions are detected. | `controller` |
| `energy_cost_event` | Event sent when the cost of energy changes. | `controller` |
| `camera_trigger_event` | Event sent when a camera trigger is detected. | `controller` |
| `upb_link_activated_event` | Event sent when a UPB link is activated. | `controller` |
| `upb_link_deactivated_event` | Event sent when a UPB link is deactivated. | `controller` |
| `activated_event` | Event sent when a button is activated. | `button` |
| `switch_press_event` | Event sent when an ALC, UPB, Radio RA, or Starlite switch is pressed. | `dimmable`, `upb` |
## Full Example
### Example `omnilink.things`
```
Bridge omnilink:controller:home [ ipAddress="127.0.0.1", port=4369, key1="XXXXXXXXXXXXXXXX", key2="XXXXXXXXXXXXXXXX" ] {
Thing area MainArea "Main Area" @ "Home" [ number=1 ]
Thing upb UpKitTable "Table Lights" @ "Upstairs Kitchen" [ number=4 ]
Thing upb UpOfcDesk "Desk Lights" @ "Upstairs Office" [ number=10 ]
Thing thermostat UpstrsThermo "Upstairs Temperature" @ "Upstairs Entry" [ number=1 ]
Thing zone FrontDoor "Front Door" @ "Upstairs Entry" [ number=2 ]
Thing zone GarageDoor "Garage Door" @ "Laundry Room" [ number=3 ]
Thing zone BackDoor "Back Door" @ "Upstairs Kitchen" [ number=4 ]
Thing zone OneCarGarageDo "One Car Garage" @ "Garage" [ number=5 ]
Thing zone TwoCarGarageDo "Two Car Garage" @ "Garage" [ number=6 ]
Thing zone BsmtBackDoor "Back Door" @ "Basement Workout Room" [ number=8 ]
Thing zone MBRDeckDoor "Deck Door" @ "Master Bedroom" [ number=9 ]
Thing zone MBRMotion "Motion" @ "Master Bedroom" [ number=10 ]
Thing zone PorchDoor "Porch Door" @ "Upstairs Office" [ number=11 ]
Thing zone UpOffMotion "Motion" @ "Upstairs Office" [ number=12 ]
Thing zone UpLivMotion "Motion" @ "Upstairs Living Room" [ number=13 ]
Thing zone BsmtWORMotion "Motion" @ "Basement Workout Room" [ number=14 ]
Thing zone GarageMotion "Motion" @ "Garage" [ number=15 ]
Thing console UpstrsConsole "Console" @ "Laundry Room" [ number=1 ]
Thing button MainButton "Button" @ "Home" [ number=1 ]
}
```
### Example `omnilink.items`
```
/*
* Alarms / Areas
*/
Group:Switch:OR(ON, OFF) Alarms "All Alarms [%s]"
String AlarmMode "Alarm [%s]" <alarm> {channel="omnilink:area:home:MainArea:mode" [profile="transform:MAP", function="area-modes.map", sourceFormat="%s"]}
Switch AlarmBurglary "Burglary Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_burglary"}
Switch AlarmFire "Fire Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_fire"}
Switch alarm_gas "Gas Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_gas"}
Switch AlarmAuxiliary "Auxiliary Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_auxiliary"}
Switch AlarmFreeze "Freeze Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_freeze"}
Switch AlarmWater "Water Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_water"}
Switch AlarmDuress "Duress Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_duress"}
Switch AlarmTemperature "Temperature Alarm [%s]" (Alarms) {channel="omnilink:area:home:MainArea:alarm_temperature"}
Number AlarmModeDisarm {channel="omnilink:area:home:MainArea:disarm"}
Number AlarmModeDay {channel="omnilink:area:home:MainArea:day"}
Number AlarmModeNight {channel="omnilink:area:home:MainArea:night"}
Number AlarmModeAway {channel="omnilink:area:home:MainArea:away"}
Number AlarmModeVacation {channel="omnilink:area:home:MainArea:vacation"}
Number AlarmModeDayInstant {channel="omnilink:area:home:MainArea:day_instant"}
Number AlarmModeNightDelayed {channel="omnilink:area:home:MainArea:night_delayed"}
/*
* Lights
*/
Switch UpKitTable "Table Lights [%s]" <switch> {channel="omnilink:upb:home:UpKitTable:level"}
Dimmer UpOfcDesk "Desk Lights [%d]" <slider> {channel="omnilink:upb:home:UpOfcDesk:level"}
/*
* Thermostat
*/
Group UpstrsThermo "Upstairs Thermostat"
Number:Temperature UpstrsThermo_Temp "Temperature [%.1f %unit%]" <temperature> (UpstrsThermo) {channel="omnilink:thermostat:home:UpstrsThermo:temperature"}
Number UpstrsThermo_Status "Status [MAP(therm-status.map):%s]" <heating> (UpstrsThermo) {channel="omnilink:thermostat:home:UpstrsThermo:status"}
Number UpstrsThermo_System "System Mode [MAP(therm-tempmode.map):%s]" <temperature> (UpstrsThermo) {channel="omnilink:thermostat:home:UpstrsThermo:system_mode"}
Number UpstrsThermo_Fan "Fan Mode [MAP(therm-fanmode.map):%s]" <fan> (UpstrsThermo) {channel="omnilink:thermostat:home:UpstrsThermo:fan_mode"}
Number UpstrsThermo_Hold "Hold Mode [MAP(therm-holdmode.map):%s]" <fan> (UpstrsThermo) {channel="omnilink:thermostat:home:UpstrsThermo:hold_mode"}
Number UpstrsThermo_HeatPoint "System HeatPoint [%d]" <temperature_hot> (UpstrsThermo) {channel="omnilink:thermostat:home:UpstrsThermo:heat_setpoint"}
Number UpstrsThermo_CoolPoint "System CoolPoint [%d]" <temperature_cool> (UpstrsThermo) {channel="omnilink:thermostat:home:UpstrsThermo:cool_setpoint"}
/*
* Motion and Doors
*/
Group:Contact:OR(OPEN, CLOSED) Doors "All Doors [%s]"
Contact FrontDoor "Front Door" <door> (Doors) {channel="omnilink:zone:home:FrontDoor:contact"}
Contact GarageDoor "Garage Door" <door> (Doors) {channel="omnilink:zone:home:GarageDoor:contact"}
Contact BackDoor "Back Door" <door> (Doors) {channel="omnilink:zone:home:BackDoor:contact"}
Contact BsmtBackDoor "Back Door" <door> (Doors) {channel="omnilink:zone:home:BsmtBackDoor:contact"}
Contact MBRDeckDoor "Deck Door" <door> (Doors) {channel="omnilink:zone:home:MBRDeckDoor:contact"}
Contact PorchDoor "Porch Door" <door> (Doors) {channel="omnilink:zone:home:PorchDoor:contact"}
Group:Contact:OR(OPEN, CLOSED) GarageDoors "All Garage Doors [%s]"
Contact TwoCarGarageDo "Two Car Garage Door" <garagedoor> (GarageDoors) {channel="omnilink:zone:home:TwoCarGarageDo:contact"}
Contact OneCarGarageDo "One Car Garage Door" <garagedoor> (GarageDoors) {channel="omnilink:zone:home:OneCarGarageDo:contact"}
Group:Contact:OR(OPEN, CLOSED) Motion "All Motion Sensors [%s]"
Contact MBRMotion "Motion" <presence> (Motion) {homekit="MotionSensor", channel="omnilink:zone:home:MBRMotion:contact"}
Contact UpOffMotion "Motion" <presence> (Motion) {homekit="MotionSensor", channel="omnilink:zone:home:UpOffMotion:contact"}
Contact UpLivMotion "Motion" <presence> (Motion) {homekit="MotionSensor", channel="omnilink:zone:home:UpLivMotion:contact"}
Contact BsmtWORMotion "Motion" <presence> (Motion) {homekit="MotionSensor", channel="omnilink:zone:home:BsmtWORMotion:contact"}
Contact GarageMotion "Motion" <presence> (Motion) {homekit="MotionSensor", channel="omnilink:zone:home:GarageMotion:contact"}
/*
* Console
*/
String UpstrsConsole_Beeper "Enable/Disable Beeper [%s]" {channel="omnilink:console:home:UpstrsConsole:enable_disable_beeper"}
Number UpstrsConsole_Beep "Beep Console" {channel="omnilink:console:home:UpstrsConsole:beep"}
/*
* Button
*/
Switch MainButton "Toggle button [%s]" <switch> {channel="omnilink:button:home:MainButton:press"}
/*
* Other OmniPro items
*/
DateTime OmniProTime "Last Time Update [%1$ta %1$tR]" <time> {channel="omnilink:controller:home:sysdate"}
```
### Example `therm-status.map`
```
0=Idle
1=Heating
2=Cooling
```
### Example `therm-tempmode.map`
```
0=Off
1=Heat
2=Cool
3=Auto
5=Emergency heat
```
### Example `therm-fanmode.map`
```
0=Auto
1=On
2=Cycle
```
### Example `therm-holdmode.map`
```
0=Off
1=Hold
2=Vacation hold
```
### Example `area-modes.map`
```
0=Off
1=Day
2=Night
3=Away
4=Vacation
5=Day instant
6=Night delayed
9=Arming day
10=Arming night
11=Arming away
12=Arming vacation
13=Arming day instant
14=Arming night delay
=Unknown
```
### Example `omnilink.rules`
```
rule "Update OmniPro Time"
when
Time cron "0 0 0/1 1/1 * ? *"
then
OmniProTime.sendCommand( new DateTimeType() )
end
```

2
_addons_bindings/openuv/readme.md
View File

@ -74,6 +74,8 @@ The OpenUV Report thing that is retrieved has these channels:
The elevation channel will be used as an input in order to limit API queries to OpenUV. If not used,
the binding will not consider it. When value is provided queries will only be issued if the elevation is > 0°.
Thing can be extended with as many SafeExposure channels as needed for each skin type.
## Examples
demo.things:

126
_addons_bindings/roku/readme.md Normal file
View File

@ -0,0 +1,126 @@
---
id: roku
label: Roku
title: Roku - Bindings
type: binding
description: "This binding connects Roku streaming media players and Roku TVs to openHAB."
since: 3x
logo: images/addons/roku.png
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Roku Binding
This binding connects Roku streaming media players and Roku TVs to openHAB.
The Roku device must support the Roku ECP protocol REST API.
## Supported Things
There are two supported thing types, which represent either a standalone Roku device or a Roku TV.
A supported Roku streaming media player or streaming stick uses the `roku_player` id and a supported Roku TV uses the `roku_tv` id.
The binding functionality is the same for both types, but the Roku TV type adds additional button commands to the button channel dropdown.
Multiple Things can be added if more than one Roku is to be controlled.
## Discovery
Auto-discovery is supported if the Roku can be located on the local network using SSDP.
Otherwise the thing must be manually added.
## Binding Configuration
The binding has no configuration options, all configuration is done at Thing level.
## Thing Configuration
The thing has a few configuration parameters:
| Parameter | Description |
|-----------|------------------------------------------------------------------------------------------------------------|
| hostName | The host name or IP address of the Roku device. Mandatory. |
| port | The port on the Roku that listens for http connections. Default 8060 |
| refresh | Overrides the refresh interval for player status updates. Optional, the default and minimum is 10 seconds. |
## Channels
The following channels are available:
| Channel ID | Item Type | Description |
|-----------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| activeApp | String | A dropdown containing a list of all apps installed on the Roku. The app currently running is automatically selected. The list updates every 10 minutes. |
| button | String | Sends a remote control command the Roku. See list of available commands below. |
| playMode | String | The current playback mode ie: stop, play, pause (ReadOnly). |
| timeElapsed | Number:Time | The total number of seconds of playback time elapsed for the current playing title (ReadOnly). |
| timeTotal | Number:Time | The total length of the current playing title in seconds (ReadOnly). This data is not provided by all streaming apps. |
Some Notes:
* The values for `activeApp`, `playMode`, `timeElapsed` & `timeTotal` refresh automatically per the configured `refresh` interval (10 seconds minimum).
**List of available button commands for Roku streaming devices:**
Home
Rev
Fwd
Play
Select
Left
Right
Up
Down
Back
InstantReplay
Info
Backspace
Search
Enter
FindRemote
**List of additional button commands for Roku TVs:**
ChannelUp
ChannelDown
VolumeUp
VolumeDown
VolumeMute
InputTuner
InputHDMI1
InputHDMI2
InputHDMI3
InputHDMI4
InputAV1
PowerOff
## Full Example
roku.things:
```java
roku:roku_player:myplayer1 "My Roku" [ hostName="192.168.10.1", refresh=10 ]
roku:roku_tv:myplayer1 "My Roku TV" [ hostName="192.168.10.1", refresh=10 ]
```
roku.items:
```java
String Player_ActiveApp "Current App: [%s]" { channel="roku:roku_player:myplayer1:activeApp" }
String Player_Button "Send Command to Roku" { channel="roku:roku_player:myplayer1:button" }
String Player_PlayMode "Status: [%s]" { channel="roku:roku_player:myplayer1:playMode" }
Number:Time Player_TimeElapsed "Elapsed Time: [%d %unit%]" { channel="roku:roku_player:myplayer1:timeElapsed" }
Number:Time Player_TimeTotal "Total Time: [%d %unit%]" { channel="roku:roku_player:myplayer1:timeTotal" }
```
roku.sitemap:
```perl
sitemap roku label="Roku" {
Frame label="My Roku" {
Selection item=Player_ActiveApp icon="screen"
Selection item=Player_Button icon="screen"
Text item=Player_PlayMode
Text item=Player_TimeElapsed icon="time"
Text item=Player_TimeTotal icon="time"
}
}
```

14
_addons_bindings/satel/readme.md
View File

@ -303,7 +303,7 @@ The result of this action is compatible with channels of `event-log` thing and c
Usage:
```
val actions = getActions("satel", "satel:event-log:home")
val actions = getActions("satel", "satel:event-log:home:EventLog")
val eventRec = actions.readEvent(-1)
logInfo("EventLog", eventRec.get("description"))
```
@ -323,9 +323,9 @@ Bridge satel:ethm-1:home [ host="192.168.0.2", refresh=1000, userCode="1234", en
Thing shutter KitchenWindow [ upId=2, downId=3 ]
Thing output Siren [ id=17, wireless=true ]
Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
Thing system System []
Thing event-log EventLog []
}
Thing satel:system:home "System" (satel:ethm-1:home) []
Thing satel:event-log:home "Event log" (satel:ethm-1:home) []
```
@ -342,9 +342,9 @@ Switch BEDROOM_TAMPER "Bedroom PIR tampered" (Satel) { channel="satel:zone:home:
Switch BEDROOM_TAMPER_M "Bedroom PIR tamper memory" (Satel) { channel="satel:zone:home:BedroomPIR:tamper_alarm_memory" }
Switch KITCHEN_LAMP "Kitchen lamp" (Satel) { channel="satel:output:home:KitchenLamp:state" }
Rollershutter KITCHEN_BLIND "Kitchen blind" (Satel) { channel="satel:shutter:home:KitchenWindow:shutter_state" }
Switch SYSTEM_TROUBLES "Troubles in the system" (Satel) { channel="satel:system:home:troubles" }
Switch SYSTEM_TROUBLES "Troubles in the system" (Satel) { channel="satel:system:home:System:troubles" }
String KEYPAD_CHAR ">" <none> (Satel)
String USER_CODE "User code" (Satel) { channel="satel:system:home:user_code" }
String USER_CODE "User code" (Satel) { channel="satel:system:home:System:user_code" }
Switch SIREN_LOBATT "Siren: low battery level" (Satel) { channel="satel:output:home:Siren:device_lobatt" }
Switch SIREN_NOCOMM "Siren: no communication" (Satel) { channel="satel:output:home:Siren:device_nocomm" }
Number:Temperature KITCHEN_TEMP "Kitchen temperature [%.1f °C]" <temperature> (Satel) { channel="satel:atd-100:home:KitchenTemp:temperature" }
@ -394,7 +394,7 @@ rule "Keypad char entered"
when
Item KEYPAD_CHAR changed
then
val org.joda.time.DateTime timeout = now.plusSeconds(20)
val timeout = now.plusSeconds(20)
if (KEYPAD_CHAR.state == "-") {
logInfo("Keypad", "Changing user code")
@ -428,7 +428,7 @@ rule "Send event log"
when
Item Alarms changed to ON
then
val actions = getActions("satel", "satel:event-log:home")
val actions = getActions("satel", "satel:event-log:home:EventLog")
if (null === actions) {
logInfo("EventLog", "Actions not found, check thing ID")
return

12
_addons_bindings/serial/readme.md
View File

@ -122,21 +122,21 @@ demo.things:
Bridge serial:serialBridge:sensors [serialPort="/dev/ttyUSB01", baudRate=57600] {
Thing serialDevice temperatureSensor [patternMatch="20;05;Cresta;ID=2801;.*"] {
Channels:
Type number : temperature [transform="REGEX:.*?TEMP=(.*?);.*"]
Type number : humidity [transform="REGEX:.*?HUM=(.*?);.*"]
Type number : temperature [stateTransformation="REGEX:.*?TEMP=(.*?);.*"]
Type number : humidity [stateTransformation="REGEX:.*?HUM=(.*?);.*"]
}
Thing serialDevice rollershutter [patternMatch=".*"] {
Channels:
Type rollershutter : serialRollo [transform="REGEX:Position:([0-9.]*)", up="Rollo_UP\n", down="Rollo_DOWN\n", stop="Rollo_STOP\n"]
Type switch : roloAt100 [transform="REGEX:s/Position:100/ON/"]
Type rollershutter : serialRollo [stateTransformation="REGEX:Position:([0-9.]*)", upValue="Rollo_UP\n", downValue="Rollo_DOWN\n", stopValue="Rollo_STOP\n"]
Type switch : roloAt100 [stateTransformation="REGEX:s/Position:100/ON/"]
}
Thing serialDevice relay [patternMatch=".*"] {
Channels:
Type switch : serialRelay [on="Q1_ON\n", off="Q1_OFF\n"]
Type switch : serialRelay [onValue="Q1_ON\n", offValue="Q1_OFF\n"]
}
Thing serialDevice myDevice [patternMatch="ID=2341;.*"] {
Channels:
Type string : control [commandTransform="JS:addCheckSum.js", commandFormat="ID=2341;COMMAND=%s;"]
Type string : control [commandTransformation="JS:addCheckSum.js", commandFormat="ID=2341;COMMAND=%s;"]
}
}

31
_addons_bindings/smartthings/doc/Troubleshooting.md
View File

@ -1,37 +1,6 @@
# Smartthings Binding Troubleshooting Guidelines
Below are some recommendations on resolving issues with things not working as expected
## Device specific issues
If the binding is working for some devices but there is one device that doesn't seem to work then verify that the device is supported by checking the following in the PaperUI:
1. Open the PaperUI webpage
2. Select Configuration -> Bindings -> Smartthings
3. Verify that the thing you want to use is included in the list of Supported Things
If the device is listed then create a new topic in the [openHAB Community Add-ons -> Bindings](https://community.openhab.org/c/add-ons/bindings/) website.
## Setting openHAB logs to Debug
You will need to edit the logging configuration file and set the log level for the Smartthings binding to debug.
The following assumes you are running on Linux or Raspbian
Follow these steps on your openHAB server:
1. If logged on to the server: cd /var/lib/openhab2/etc or if using Samba open file explorer to \\\\OPENHABIANPI\openHAB-userdata\etc
2. Edit the file org.ops4j.pax.logging.cfg
* Just ** before ** the line "log4j2.logger.openhab.name = org.openhab" add the following lines:
* log4j2.logger.smartthings.name=org.openhab.binding.smartthings
* log4j2.logger.smartthings.level=DEBUG
* Save the file
3. Restart the server (i.e. sudo systemctl restart openhab2.service)
## Viewing the openHAB logs
Viewing the logs is best done on the openHAB server where you can using the linux command "tail -f" to watch the log messages as they are created
Follow these steps on your openHAB server:
1. cd /var/log/openhab2 or if using Samba open file explorer to \\OPENHABIANPI\openHAB-log
2. The log file you want to see is openhab.log
3. Using unix "tail -f openhab.log"
4. Try the device that isn't working and look for log messages related to the device you are using
## Viewing Smartthings logs
On the Smartthings hub all of the incoming messages and the responses are logged. Looking at these logs can be very informative.

16
_addons_bindings/sonos/readme.md
View File

@ -25,9 +25,12 @@ This happens because of a TTL=1 for ALIVE packets send by Sonos devices, resulti
## Supported Things
All available Sonos (playback) devices are supported by this binding. This includes the One, OneSL, Play:1, Play:3, Play:5, Connect, Connect:Amp, Port, Amp, Playbar, Playbase, Beam and Sub. The Bridge and Boost are not supported, but these devices do only have an auxiliary role in the Sonos network and do not have any playback capability. All supported Sonos devices are registered as an audio sink in the framework.
All available Sonos (playback) devices are supported by this binding.
This includes the One, One SL, Move, Play:1, Play:3, Play:5, Connect, Connect:Amp, Port, Amp, SYMFONISK, Playbar, Playbase, Beam, Arc, Arc SL and Sub.
The Bridge and Boost are not supported, but these devices do only have an auxiliary role in the Sonos network and do not have any playback capability.
All supported Sonos devices are registered as an audio sink in the framework.
When being defined in a \*.things file, the specific thing types One, OneSL, PLAY1, PLAY3, PLAY5, PLAYBAR, PLAYBASE, Beam, CONNECT, CONNECTAMP, Port and Amp should be used.
When being defined in a \*.things file, the specific thing types One, OneSL, Move, PLAY1, PLAY3, PLAY5, SYMFONISK, PLAYBAR, PLAYBASE, Beam, Arc, ArcSL, CONNECT, CONNECTAMP, Port and Amp should be used.
Please note that these thing types are case sensitive (you need to define them **exactly as stated above**).
@ -66,6 +69,7 @@ The devices support the following channels:
| alarm | Switch | W | Set the first occurring alarm either ON or OFF. Alarms first have to be defined through the Sonos Controller app | all |
| alarmproperties | String | R | Properties of the alarm currently running | all |
| alarmrunning | Switch | R | Set to ON if the alarm was triggered | all |
| bass | Number | RW | Set or get the bass level adjustment (value in range -10 / 10) | all |
| clearqueue | Switch | W | Suppress all songs from the current queue | all |
| control | Player | RW | Control the Zone Player, e.g. PLAY/PAUSE/NEXT/PREVIOUS | all |
| coordinator | String | R | UDN of the coordinator for the current group | all |
@ -83,6 +87,7 @@ The devices support the following channels:
| analoglinein | Switch | R | Indicator set to ON when the analog line-in of the Zone Player is connected | Amp |
| digitallinein | Switch | R | Indicator set to ON when the digital line-in of the Zone Player is connected | Amp |
| localcoordinator | Switch | R | Indicator set to ON if the this Zone Player is the Zone Group Coordinator | all |
| loudness | Switch | RW | Enable or disable the loudness | all |
| mute | Switch | RW | Set or get the mute state of the master volume of the Zone Player | all |
| nightmode | Switch | RW | Enable or disable the night mode feature | PLAYBAR, PLAYBASE, Beam, Amp |
| notificationsound | String | W | Play a notification sound by a given URI | all |
@ -108,6 +113,13 @@ The devices support the following channels:
| standalone | Switch | W | Make the Zone Player leave its Group and become a standalone Zone Player | all |
| state | String | R | The State channel contains state of the Zone Player, e.g. PLAYING, STOPPED, ... | all |
| stop | Switch | W | Write `ON` to this channel: Stops the Zone Player player. | all |
| treble | Number | RW | Set or get the treble level adjustment (value in range -10 / 10) | all |
| subwoofer | Switch | RW | Enable or disable the subwoofer | Arc, Arc SL |
| subwoofergain | Number | RW | Set or get the subwoofer gain adjustment (value in range -15 / 15) | Arc, Arc SL |
| surround | Switch | RW | Enable or disable the surround audio | Arc, Arc SL |
| surroundmusicmode | String | RW | Set or get the surround playback mode for music, either 0 for Ambient or 1 for full | Arc, Arc SL |
| surroundmusiclevel | Number | RW | Set or get the surround level adjustment for music (value in range -15 / 15) | Arc, Arc SL |
| surroundtvlevel | Number | RW | Set or get the surround level adjustment for TV (value in range -15 / 15) | Arc, Arc SL |
| tuneinstationid | String | RW | Provide the current TuneIn station id or play the TuneIn radio given by its station id | all |
| volume | Dimmer | RW | Set or get the master volume of the Zone Player | all |
| zonegroupid | String | R | Id of the Zone Group the Zone Player belongs to | all |

28
_addons_bindings/tibber/readme.md
View File

@ -37,6 +37,7 @@ Tibber Default:
|--------------------|-----------------------------------------|-----------|
| Current Total | Current Total Price (energy + tax) | True |
| Starts At | Current Price Timestamp | True |
| Current Level | Current Price Level | True |
| Daily Cost | Daily Cost (last/previous day) | True |
| Daily Consumption | Daily Consumption (last/previous day) | True |
| Daily From | Timestamp (daily from) | True |
@ -118,6 +119,7 @@ demo.items:
```
Number:Dimensionless TibberAPICurrentTotal "Current Total Price [%.2f NOK]" {channel="tibber:tibberapi:7cfae492:current_total"}
DateTime TibberAPICurrentStartsAt "Timestamp - Current Price" {channel="tibber:tibberapi:7cfae492:current_startsAt"}
String TibberAPICurrentLevel "Price Level" {channel="tibber:tibberapi:7cfae492:current_level"}
DateTime TibberAPIDailyFrom "Timestamp - Daily From" {channel="tibber:tibberapi:7cfae492:daily_from"}
DateTime TibberAPIDailyTo "Timestamp - Daily To" {channel="tibber:tibberapi:7cfae492:daily_to"}
Number:Dimensionless TibberAPIDailyCost "Total Daily Cost [%.2f NOK]" {channel="tibber:tibberapi:7cfae492:daily_cost"}
@ -127,22 +129,22 @@ DateTime TibberAPIHourlyTo "Timestamp - Ho
Number:Dimensionless TibberAPIHourlyCost "Total Hourly Cost [%.2f NOK]" {channel="tibber:tibberapi:7cfae492:hourly_cost"}
Number:Energy TibberAPIHourlyConsumption "Total Hourly Consumption [%.2f kWh]" {channel="tibber:tibberapi:7cfae492:hourly_consumption"}
DateTime TibberAPILiveTimestamp "Timestamp - Live Measurement" {channel="tibber:tibberapi:7cfae492:live_timestamp"}
Number:Power TibberAPILivePower "Live Power Consumption [W]" {channel="tibber:tibberapi:7cfae492:live_power"}
Number:Power TibberAPILivePower "Live Power Consumption [%.0f W]" {channel="tibber:tibberapi:7cfae492:live_power"}
Number:Energy TibberAPILiveLastMeterConsumption "Last Meter Consumption [%.2f kWh]" {channel="tibber:tibberapi:7cfae492:live_lastMeterConsumption"}
Number:Energy TibberAPILiveAccumulatedConsumption "Accumulated Consumption [%.2f kWh]" {channel="tibber:tibberapi:7cfae492:live_accumulatedConsumption"}
Number:Dimensionless TibberAPILiveAccumulatedCost "Accumulated Cost [%.2f NOK]" {channel="tibber:tibberapi:7cfae492:live_accumulatedCost"}
String TibberAPILiveCurrency "Currency" {channel="tibber:tibberapi:7cfae492:live_currency"}
Number:Power TibberAPILiveMinPower "Min Power Consumption [W]" {channel="tibber:tibberapi:7cfae492:live_minPower"}
Number:Power TibberAPILiveAveragePower "Average Power Consumption [W]" {channel="tibber:tibberapi:7cfae492:live_averagePower"}
Number:Power TibberAPILiveMaxPower "Max Power Consumption [W]" {channel="tibber:tibberapi:7cfae492:live_maxPower"}
Number:ElectricPotential TibberAPILiveVoltage1 "Live Voltage Phase 1 [V]" {channel="tibber:tibberapi:7cfae492:live_voltage1"}
Number:ElectricPotential TibberAPILiveVoltage2 "Live Voltage Phase 2 [V]" {channel="tibber:tibberapi:7cfae492:live_voltage2"}
Number:ElectricPotential TibberAPILiveVoltage3 "Live Voltage Phase 3 [V]" {channel="tibber:tibberapi:7cfae492:live_voltage3"}
Number:ElectricCurrent TibberAPILiveCurrent1 "Live Current Phase 1 [A]" {channel="tibber:tibberapi:7cfae492:live_current1"}
Number:ElectricCurrent TibberAPILiveCurrent2 "Live Current Phase 2 [A]" {channel="tibber:tibberapi:7cfae492:live_current2"}
Number:ElectricCurrent TibberAPILiveCurrent3 "Live Current Phase 3 [A]" {channel="tibber:tibberapi:7cfae492:live_current3"}
Number:Power TibberAPILivePowerProduction "Live Power Production [W]" {channel="tibber:tibberapi:7cfae492:live_powerProduction"}
Number:Power TibberAPILiveMinPowerproduction "Min Power Production [W]" {channel="tibber:tibberapi:7cfae492:live_minPowerproduction"}
Number:Power TibberAPILiveMaxPowerproduction "Max Power Production [W]" {channel="tibber:tibberapi:7cfae492:live_maxPowerproduction"}
Number:Power TibberAPILiveMinPower "Min Power Consumption [%.0f W]" {channel="tibber:tibberapi:7cfae492:live_minPower"}
Number:Power TibberAPILiveAveragePower "Average Power Consumption [%.0f W]" {channel="tibber:tibberapi:7cfae492:live_averagePower"}
Number:Power TibberAPILiveMaxPower "Max Power Consumption [%.0f W]" {channel="tibber:tibberapi:7cfae492:live_maxPower"}
Number:ElectricPotential TibberAPILiveVoltage1 "Live Voltage Phase 1 [%.0 V]" {channel="tibber:tibberapi:7cfae492:live_voltage1"}
Number:ElectricPotential TibberAPILiveVoltage2 "Live Voltage Phase 2 [%.0 V]" {channel="tibber:tibberapi:7cfae492:live_voltage2"}
Number:ElectricPotential TibberAPILiveVoltage3 "Live Voltage Phase 3 [%.0 V]" {channel="tibber:tibberapi:7cfae492:live_voltage3"}
Number:ElectricCurrent TibberAPILiveCurrent1 "Live Current Phase 1 [%.1 A]" {channel="tibber:tibberapi:7cfae492:live_current1"}
Number:ElectricCurrent TibberAPILiveCurrent2 "Live Current Phase 2 [%.1 A]" {channel="tibber:tibberapi:7cfae492:live_current2"}
Number:ElectricCurrent TibberAPILiveCurrent3 "Live Current Phase 3 [%.1 A]" {channel="tibber:tibberapi:7cfae492:live_current3"}
Number:Power TibberAPILivePowerProduction "Live Power Production [%.0f W]" {channel="tibber:tibberapi:7cfae492:live_powerProduction"}
Number:Power TibberAPILiveMinPowerproduction "Min Power Production [%.0f W]" {channel="tibber:tibberapi:7cfae492:live_minPowerproduction"}
Number:Power TibberAPILiveMaxPowerproduction "Max Power Production [%.0f W]" {channel="tibber:tibberapi:7cfae492:live_maxPowerproduction"}
Number:Energy TibberAPILiveAccumulatedProduction "Accumulated Production [%.2f kWh]" {channel="tibber:tibberapi:7cfae492:live_accumulatedProduction"}
```

17
_addons_bindings/tivo/readme.md
View File

@ -66,7 +66,7 @@ All devices support the following channels:
|-----------------|-----------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| channelSet | Number (1-9999) | Current Channel - Request (SETCH) | Displays the current channel number. When changed, tunes the DVR to the specified channel (unless a recording is in progress on all available tuners). The TiVo must be in Live TV mode for this command to work. |
| channelForce | Number (1-9999) | Current Channel - Forced (FORCECH) | Displays the current channel number. When changed, tunes the DVR to the specified channel, **cancelling any recordings in progress if necessary** i.e. when all tuners are already in use / recording. The TiVo must be in Live TV mode for this command to work. |
| menuTeleport | String | Change Special/Menu Screen (TELEPORT) | Change to one of the following TiVo menu screens: TIVO (Home), LIVE TV, GUIDE, NOW PLAYING (My Shows), NETFLIX. |
| menuTeleport | String | Change Special/Menu Screen (TELEPORT) | Change to one of the following TiVo menu screens: TIVO (Home), LIVETV, GUIDE, NOWPLAYING (My Shows), SEARCH, NETFLIX. |
| irCommand | String | Remote Control Button (IRCOMMAND) | Send a simulated button push from the remote control to the TiVo. See Appendix A in document TCP Remote Protocol 1.1 for supported codes. |
| kbdCommand | String | Keyboard Command (KEYBOARD) | Sends a code corresponding to a keyboard key press to the TiVo e.g. A-Z. See Appendix A in document TCP Remote Protocol 1.1 for supported characters and special character codes. |
| dvrStatus | String | TiVo Status | Action return code / channel information returned by the TiVo. |
@ -112,7 +112,7 @@ sitemap tivo label="Tivo Central" {
Text item=TiVo_Recording label="Recording" icon="screen"
Switch item=TiVo_IRCmd label="Channel" icon="screen" mappings=["CHANNELDOWN"="CH -","CHANNELUP"="CH +"]
Switch item=TiVo_IRCmd label="Media" icon="screen" mappings=["REVERSE"="⏪", "PAUSE"="⏸", "PLAY"="▶", /*(DVD TiVo only!) "STOP"="⏹",*/ "FORWARD"="⏩", "RECORD"="⏺" ]
Switch item=TiVo_MenuScreen label="Menus" icon="screen" mappings=["TIVO"="Home", "LIVETV"="Live Tv", "GUIDE"="Guide", "NOWPLAYING"="My Shows", "NETFLIX"="Netflix" ]
Switch item=TiVo_MenuScreen label="Menus" icon="screen" mappings=["TIVO"="Home", "LIVETV"="Live Tv", "GUIDE"="Guide", "NOWPLAYING"="My Shows", "NETFLIX"="Netflix", SEARCH="Search" ]
Switch item=TiVo_SetChannel label="Fav TV" icon="screen" mappings=[2.1="CBS", 4.1="NBC", 7.1="ABC", 11.1="FOX", 5.2="AntennaTV"]
Switch item=TiVo_IRCmd label="Navigation" icon="screen" mappings=["UP"="˄", "DOWN"="˅", "LEFT"="<", "RIGHT"=">", "SELECT"="Select", "EXIT"="Exit" ]
Switch item=TiVo_IRCmd label="Actions" icon="screen" mappings=["ACTION_A"="Red","ACTION_B"="Green","ACTION_C"="Yellow","ACTION_D"="Blue"]
@ -132,6 +132,8 @@ sitemap tivo label="Tivo Central" {
```
NULL=Unknown
-=Unknown
rec-NULL=Unknown
rec-=Unknown
rec-0=Not Recording
rec-1=Recording
100=HBO
@ -170,11 +172,9 @@ when
then
if (TiVo_KeyboardStr.state != NULL && TiVo_KeyboardStr.state.toString.length > 0) {
// Commands to get us to the TiVo/Home menu and select the search menu using the 'remote' number keys
sendCommand(TiVo_MenuScreen, "TIVO")
Thread::sleep(1500)
sendCommand(TiVo_KbdCmd, "NUM4")
Thread::sleep(1500)
// Command to get us to the TiVo search menu
sendCommand(TiVo_MenuScreen, "SEARCH")
Thread::sleep(1000)
var i = 0
var char txt = ""
@ -203,6 +203,3 @@ then
end
```
* You may need to adjust the two `Thread::sleep(1500)` lines, depending on the performance of your TiVo
* In testing, response times have varied considerably at different times of the day, etc. You may need to increase the delay until there is sufficient time added for the system to respond consistently to the 'remote control' menu commands.

19
_addons_bindings/tplinksmarthome/readme.md
View File

@ -120,6 +120,13 @@ Switching, Brightness and Color is done using the `color` channel.
* LED On/Off
* Wi-Fi signal strength (RSSI)
### KP115 Kasa Wi-Fi Smart Plug with Energy Monitoring - Slim Edition
* Power On/Off
* Energy readings
* LED On/Off
* Wi-Fi signal strength (RSSI)
### KP200 Smart Wi-Fi Power Outlet, 2-Sockets
* Power On/Off Group
@ -306,16 +313,16 @@ All devices support some of the following channels:
| Channel Type ID | Item Type | Description | Thing types supporting this channel |
|---------------------|--------------------------|------------------------------------------------|----------------------------------------------------------------------------------------------------|
| switch | Switch | Power the device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS300, KP100, KP105, KP200, KP303, KP400, RE270K, RE370K |
| switch | Switch | Power the device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS300, KP100, KP105, KP115, KP200, KP303, KP400, RE270K, RE370K |
| brightness | Dimmer | Set the brightness of device or dimmer. | HS220, KB100, KL50, KL60, KL110, KL120, LB100, LB110, LB120, LB200 |
| colorTemperature | Dimmer | Set the color temperature in percentage. | KB130, KL120, KL130, LB120, LB130, LB230 |
| colorTemperatureAbs | Number | Set the color temperature in Kelvin. | KB130, KL120, KL130, LB120, LB130, LB230 |
| color | Color | Set the color of the light. | KB130, KL130, LB130, LB230 |
| power | Number:Power | Actual energy usage in Watt. | HS110, HS300, KLxxx, LBxxx |
| eneryUsage | Number:Energy | Energy Usage in kWh. | HS110, HS300 |
| current | Number:ElectricCurrent | Actual current usage in Ampere. | HS110, HS300 |
| voltage | Number:ElectricPotential | Actual voltage usage in Volt. | HS110, HS300 |
| led | Switch | Switch the status LED on the device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS220, HS300, KP100, KP105, KP303, KP200, KP400 |
| power | Number:Power | Actual energy usage in Watt. | HS110, HS300, KLxxx, KP115, LBxxx, |
| eneryUsage | Number:Energy | Energy Usage in kWh. | HS110, HS300, KP115 |
| current | Number:ElectricCurrent | Actual current usage in Ampere. | HS110, HS300, KP115 |
| voltage | Number:ElectricPotential | Actual voltage usage in Volt. | HS110, HS300, KP115 |
| led | Switch | Switch the status LED on the device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS220, HS300, KP100, KP105, KP115, KP303, KP200, KP400 |
| rssi | Number:Power | Wi-Fi signal strength indicator in dBm. | All |
The outlet devices (HS107, HS300, KP200, KP400) have group channels.

16
_addons_bindings/tr064/readme.md
View File

@ -31,7 +31,8 @@ Two kind of Things are supported:
## Discovery
The gateway device needs to be added manually.
After that, sub-devices are detected automatically.
After that, sub-devices should be detected automatically.
Otherwise go to "Things", click "+" to add a new thing, select the TR-064 binding and click the "Scan" button.
## Thing Configuration
@ -171,6 +172,8 @@ In this case you have to use the `wifi5GHzEnable` channel for switching the gues
| `wanTotalBytesReceived` | `Number:DataAmount` | x | Total Bytes Received |
| `wanTotalBytesSent` | `Number:DataAmount` | x | Total Bytes Sent |
**Note:** AVM Fritzbox devices use 4-byte-unsigned-integers for `wanTotalBytesReceived` and `wanTotalBytesSent`, because of that the counters are reset after around 4GB data.
## `PHONEBOOK` Profile
The binding provides a profile for using the FritzBox phonebooks for resolving numbers to names.
@ -183,6 +186,7 @@ In case the format of the number in the phonebook and the format of the number f
The configured `matchCount` is counted from the right end and denotes the number of matching characters needed to consider this number as matching.
A `matchCount` of `0` is considered as "match everything".
Matching is done on normalized versions of the numbers that have all characters except digits, '+' and '*' removed.
There is an optional configuration parameter called `phoneNumberIndex` that should be used when linking to a channel with item type `StringListType` (like `Call` in the example below), which determines which number to be picked, i.e. to or from.
## Rule Action
@ -219,8 +223,8 @@ Bridge tr064:fritzbox:rootuid "Root label" @ "location" [ host="192.168.1.1", us
Thing subdeviceLan LAN "label LAN" [ uuid="uuid:xxxxxxxx-xxxx-xxxx-yyyy-xxxxxxxxxxxx",
macOnline="XX:XX:XX:XX:XX:XX",
"YY:YY:YY:YY:YY:YY"]
Thing subdeviceLan WAN "label WAN" [ uuid="uuid:xxxxxxxx-xxxx-xxxx-zzzz-xxxxxxxxxxxx"]
Thing subdeviceLan WANCon "label WANConnection" [ uuid="uuid:xxxxxxxx-xxxx-xxxx-wwww-xxxxxxxxxxxx"]
Thing subdevice WAN "label WAN" [ uuid="uuid:xxxxxxxx-xxxx-xxxx-zzzz-xxxxxxxxxxxx"]
Thing subdevice WANCon "label WANConnection" [ uuid="uuid:xxxxxxxx-xxxx-xxxx-wwww-xxxxxxxxxxxx"]
}
```
@ -231,3 +235,9 @@ Switch PresXX "[%s]" {channel="tr064:subdeviceLan:rootuid:LAN:macOnline_XX_3AXX_
Switch PresYY "[%s]" {channel="tr064:subdeviceLan:rootuid:LAN:macOnline_YY_3AYY_3AYY_3AYY_3AYY_3AYY"}
```
Example `*.items` file using the `PHONEBOOK` profile for storing the name of a caller in an item. it matches 8 digits from the right of the "from" number (note the escaping of `:` to `_3A`):
```
Call IncomingCallResolved "Caller name: [%s]" { channel="avmfritz:fritzbox:fritzbox:incoming_call" [profile="transform:PHONEBOOK", phonebook="tr064_3Afritzbox_3AfritzboxTR064", phoneNumberIndex="1", matchCount="8"] }
```

219
_addons_bindings/zwave/doc/act/zrf113_0_0.md Normal file
View File

@ -0,0 +1,219 @@
---
layout: documentation
title: ZRF113 - ZWave
---
{% include base.html %}
# ZRF113 Isolated Contact Fixture Module
This describes the Z-Wave device *ZRF113*, manufactured by *ACT - Advanced Control Technologies* with the thing type UID of ```act_zrf113_00_000```.
The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there.
![ZRF113 product image](https://opensmarthouse.org/zwavedatabase/1331/image/)
The ZRF113 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
The ZRF113 Isolated Contact Fixture Module is a component of the HomePro lighting control system. Wire the Isolated Contact Fixture Module according to the diagram above and program it from the Wireless Controller to operate loads.  Inclusion of this Switch on the ZTH100 Wireless Controller menu allows remote ON/OFF control of load connected.
This Isolated Contact Fixture Module is designed to work with other Z-Wave enabled devices. Z-Wave nodes of other types can be included on the network and will also act as repeaters if they support this function.  
As part of a Z-Wave network, the ZRF113 will also act as a wireless repeater to insure that commands intended for another device in the network are received. This is useful when the device would otherwise be out of the radio range of the wireless controller.
There are no field repairable assemblies on this unit.. If service is needed, the unit must be returned where purchased.
DANGER! SHOCK HAZARD. Read and understand these instructions before installing. This device is intended for installation in accordance with the National Electric code and local regulations in the United States, or the Canadian Electrical Code and local regulations in Canada. It is recommended that a qualified electrician perform this installation.
**INSTALLATION**
Wire this module in series with a 20 amp (maximum) load according to the diagram above. If AS101’s are used they must be wired to the same line (or neutral) also wired to the master unit as well as the load being controlled, and not wired to any other neutral. If multiple neutral wires are tied together in one box, separate the neutral wires to preserve the integrity of the ZRF113 circuit. Caution! Do not wire unit “live” (with power on the circuit) and do notallow the yellow wire to contact line voltage, neutral or ground or you will damage the device. See the ZTH100 Wireless Controller operating instructions to include this module under the command of the Wireless Controller.
**NOTE **
If you have trouble adding the ZRF113 to a group it may be that the Home ID and Node ID were not cleared from it after testing. You must first “RESET UNIT” with your controller to remove it from the network. If using the ZTH100 select “SETUP” and scroll to “RESET UNIT”
Although adding it to a group includes it in the network, removing it from a group does not remove it from the network. If removed from a group, it functions only as a repeater.
With the Wireless Controller, the ZRF113 can be switched ON and OFF remotely, and can be included (or excluded) in groups of lights that operate at the same time (a group can also be a single module), and in scenes that set a lighting mood.
Note that the Associations, and possibly other features, vary depending on the release.  The original version 1 units used 4 associations.  This release, release 1.1, uses 2.
**SPECIFICATIONS**
Power: 120 VAC, 50/60 Hz
Signal (Frequency): 908.42 MHz
Maximum Load
   Isolated Contacts: 20 amps maximum General Purpose, 277 VAC, 10 FLA, 60 LRA, 250 VAC,
   Motor: 1 H.P. maximum, 120/240 VAC
   Incandescent: TV8 (Tungsten), 120 VAC, 960W maximum
Range: Up to 100 feet line of sight between the Wireless Controller and /or the closest HomePro Receiver Module
### Inclusion Information
STEP 1.. Prepare the Controller to include a unit to the network by adding it to a group (method of adding a node to the network). Refer to controller instructions. If using a ZTH100, push MENU button, select GROUPS, push OK button, see ADD UNIT TO GROUP displayed, push OK button.
STEP 2. The ZRF113 must be in its permanently installed location. Tap the button on the face of the ZRF113 once. Some Z-Wave products include the module on the release of the button.
STEP 3. You should see an indication on your Controller that the “DEVICE WAS INCLUDED” in the network.
### Exclusion Information
“RESET UNIT” with your controller to remove it from the network. If using the ZTH100 select “SETUP” and scroll to “RESET UNIT”
Although adding it to a group includes it in the network, removing it from a group does not remove it from the network. If removed from a group, it functions only as a repeater.
### General Usage Information
## Channels
The following table summarises the channels available for the ZRF113 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
## Device Configuration
The following table provides a summary of the 2 configuration parameters available in the ZRF113.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Configuration Parameter 1 | Set Ignore Start Level Bit When Transmitting Dim Command |
| 19 | Configuration Parameter 19 | LED Transmission Indication |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 1: Configuration Parameter 1
Set Ignore Start Level Bit When Transmitting Dim Command
The ZRF113 can send Dim commands to Z-Wave enabled dimmers. The Dim command has a start level embedded in it. A dimmer receiving this command will start dimming from that start level. However, the command also has a bit that indicates whether the dimmer should ignore the start level. If the bit is set to 1, the dimmer will ignore the start level and instead start dimming from its current level. To clear this bit, configure this parameter to the value of 0.
NOTE: Each Configuration Parameter can be set to its default by setting the default bit in the Configuration Set command. See your controller’s instructions on how to do this (and if it supports it). All Configuration commands will be reset to their default state when the ZRF113 is excluded from the Z-Wave network by using the controller to reset the node (on the ZTH100 select “SETUP” and scroll to “RESET UNIT”).This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Don't Ignore Dimmer Command Start Level Bit |
| 1 | Ignore Dimmer Command Start Level Bit (Default) |
The manufacturer defined default value is ```1``` (Ignore Dimmer Command Start Level Bit (Default)).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 19: Configuration Parameter 19
LED Transmission Indication
The ZRF113 will flicker its LED when it is transmitting to any of its groups. This flickering can be set to not flicker at all (set to 0), to flicker the entire time it is transmitting (set to 1), or to flicker for only 1 second when it begins transmitting (set to 2). By default, the ZRF113 is set to flicker for only 1 second.
NOTE: Each Configuration Parameter can be set to its default by setting the default bit in the Configuration Set command. See your controller’s instructions on how to do this (and if it supports it). All Configuration commands will be reset to their default state when the ZRF113 is excluded from the Z-Wave network by using the controller to reset the node (on the ZTH100 select “SETUP” and scroll to “RESET UNIT”).This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | No Flicker |
| 1 | Flicker while transmitting |
| 2 | Flicker for 1 second (Default) |
The manufacturer defined default value is ```2``` (Flicker for 1 second (Default)).
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Switch All Mode
Set the mode for the switch when receiving SWITCH ALL commands.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Exclude from All On and All Off groups |
| 1 | Include in All On group |
| 2 | Include in All Off group |
| 255 | Include in All On and All Off groups |
This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The ZRF113 supports 3 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Association group 1 supports 5 nodes.
### Group 2: Group 2
Auxilliary Switch 2 Tap
If you associate a Z-Wave device into Group 2, you can turn that device on and off by tapping the top or bottom of the auxiliary switch twice. You can brighten or dim devices by tapping the top or bottom of the auxiliary switch once and then holding the switch down. The load attached to the ZRF113 is not affected.
A NOTE ABOUT DIMMERS IN A GROUP: If you combine Z-Wave enabled dimmers and other types of ZWave devices in a group, place a Z-Wave enabled dimmer into the empty group first to ensure that the dimming operates correctly.
Association group 2 supports 5 nodes.
### Group 3: Group 3
Auxilliary Switch 3 Tap
If you associate a Z-Wave device into Group 3, you can turn that device on and off by tapping the top or bottom of the auxiliary switch three times . You can brighten or dim devices by tapping the top or bottom of the auxiliary switch twice and then hold the top down for brighten or bottom for dim (bottom only if AS001). The load attached to the ZRF113 is not affected.
A NOTE ABOUT DIMMERS IN A GROUP: If you combine Z-Wave enabled dimmers and other types of ZWave devices in a group, place a Z-Wave enabled dimmer into the empty group first to ensure that the dimming operates correctly.
Association group 3 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| |
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_BASIC_WINDOW_COVERING_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_ASSOCIATION_V1| |
| COMMAND_CLASS_VERSION_V1| |
### Documentation Links
* [Please allow me access to add a device to the Z-Wave DB](https://opensmarthouse.org/zwavedatabase/1331/reference/ZRF113-S100_instr.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1331).

3
_addons_bindings/zwave/doc/aeotec/zwa009_0_0.md
View File

@ -5,7 +5,7 @@ title: ZWA009 - ZWave
{% include base.html %}
# ZWA009 Small sensor that offers monitoring of temperature, humidity, dew and mold.
# ZWA009 Temperature and Humidity Sensor
This describes the Z-Wave device *ZWA009*, manufactured by *Aeotec Limited* with the thing type UID of ```aeotec_zwa009_00_000```.
The device is in the category of *Sensor*, defining Device used to measure something.
@ -401,6 +401,7 @@ The ZWA009 supports 6 association groups.
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Lifeline
Association group 1 supports 5 nodes.
### Group 2: Temperature High Trigger

22
_addons_bindings/zwave/doc/dlink/dchz120_0_0.md
View File

@ -131,14 +131,9 @@ Setting the BASIC command value to turn on the light.
* 0: Turn off the light.
* 1 - 100: For dimmers 1 to 100 means the light level.
* 255: Turns on the light. (Default) 
The following option values may be configured, in addition to values in the range 1 to 100 -:
Values in the range 1 to 100 may be set.
| Value | Description |
|--------|-------------|
| 0 | Off |
| 255 | On |
The manufacturer defined default value is ```255``` (On).
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
@ -150,11 +145,7 @@ Set the sensitivity for the PIR (Passive Infrared Sensor).
* 1 - 99 = 1 means the lowest sensitivity, 99 means the highest sensitivity
High sensitivity means can detected long distance, but if there is more noise signal in the environment, it will re-trigger too frequency.  
The following option values may be configured, in addition to values in the range 1 to 99 -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```80```.
@ -171,12 +162,7 @@ When the event triggers and the environment illumination is lower than the thres
* 100 means turn off illumination detected function. And always turn on the light.  
Notice: In none test mode, only the value in 1 to 99 will enable the illumination detected function and update the illumination value.  
The following option values may be configured, in addition to values in the range 1 to 99 -:
| Value | Description |
|--------|-------------|
| 0 | Disable, Light OFF |
| 100 | Disable, Light ON |
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```99```.

130
_addons_bindings/zwave/doc/fibaro/fgs214_0_0.md
View File

@ -30,50 +30,34 @@ The device is a Security Enabled Z-Wave Plus product and  a  Security  Enable
### Inclusion Information
Fibaro Switch must be placed within the range of Home Center
controller, as adding mode requires direct communication with the
controller.
Fibaro Switch must be placed within the range of Home Center controller, as adding mode requires direct communication with the controller.
Find key no. 1 which allows to switch circuit 1 on, in accordance
with the diagram
During the installation it is recommended to use a
momentary key connected to S1.
Find key no. 1 which allows to switch circuit 1 on, in accordance with the diagram
During the installation it is recommended to use a momentary key connected to S1.
Add Fibaro Switch to the network by pushing three times key no. 1
or push-button B located inside the housing of the device. For
toggle switch perform 3 position changes.
Add Fibaro Switch to the network by pushing three times key no. 1 or push-button B located inside the housing of the device. For toggle switch perform 3 position changes.
The controller indicates when the device is correctly added to the
network.
The controller indicates when the device is correctly added to the network.
**CAUTION**
Fibaro Switch cancels the "learning" mode after
key no. 1 is pressed once. Therefore, pressing key
no. 1 four times will not add the devices to the
network. The same applies to push-button B.
Fibaro Switch cancels the "learning" mode after key no. 1 is pressed once. Therefore, pressing key no. 1 four times will not add the devices to the network. The same applies to push-button B.
### Exclusion Information
Find key no. 1 which allows to switch circuit 1 on, in accordance
with the diagram
During removing it is recommended to use a
momentary key connected to S1.
Find key no. 1 which allows to switch circuit 1 on, in accordance with the diagram
During removing it is recommended to use a momentary key connected to S1.
Remove Fibaro Switch from the network by pushing three times key no. 1
or push-button B located inside the housing of the device. For
toggle switch perform 3 position changes.
Remove Fibaro Switch from the network by pushing three times key no. 1 or push-button B located inside the housing of the device. For toggle switch perform 3 position changes.
The controller indicates when the device is correctly removed from the
network.
The controller indicates when the device is correctly removed from the network.
### General Usage Information
#
7: Operating the device
# Operating the device
7.1: Controlling channels with inputs
**Controlling channels with inputs
**
Momentary switch (parameter 20 set to 0):
1x click – change the state of the channel to the opposite one
@ -95,32 +79,46 @@ By default outputs are set as NO (normally open).  It means the contacts will b
The built-in LED light shows current device status.
After powering the device:
- Green – device added to a Z-Wave network (non-secure, S0, S2 non-authenticated),
- Magenta – device added to a Z-Wave network (Security S2 Authenticated),
- Red – device not added to a Z-Wave network.
* Green – device added to a Z-Wave network (non-secure, S0, S2 non-authenticated),
* Magenta – device added to a Z-Wave network (Security S2 Authenticated),
* Red – device not added to a Z-Wave network.
Update:
- Blinking cyan – update in progress,
- Green – update successful,
- Red – update not successful.
* Blinking cyan – update in progress,
* Green – update successful,
* Red – update not successful.
Menu:
- Blinking green – entering the menu (added as non-secure, S0, S2 non-authenticated),
- Blinking magenta – entering the menu (added as Security S2 Authenticated),
- Blinking red – entering the menu (not added to a Z-Wave network),
- Magenta – test Z-Wave network range,
- Yellow – reset to factory defaults.
* Blinking green – entering the menu (added as non-secure, S0, S2 non-authenticated),
* Blinking magenta – entering the menu (added as Security S2 Authenticated),
* Blinking red – entering the menu (not added to a Z-Wave network),
* Magenta – test Z-Wave network range,
* Yellow – reset to factory defaults.
7.3: Menu
Menu allows to perform Z-Wave network actions. In order to use the menu:
1. Press and hold the maintenance button to enter the menu.
2. LED will signal adding status for 3 seconds (see 7.2: Visual indications), then turn off for another 3 seconds.
3. Release the button when device signals desired position with colour:
- Magenta – test Z-Wave network range
- Yellow – reset to factory defaults
4. Quickly click the button to confirm.
1. Press and hold the maintenance button to enter the menu.
2. LED will signal adding status for 3 seconds (see 7.2: Visual indications), then turn off for another 3 seconds.
3. Release the button when device signals desired position with colour:
* Magenta – test Z-Wave network range
* Yellow – reset to factory defaults
1. Quickly click the button to confirm.
7.4: Resetting to factory defaults
@ -128,13 +126,14 @@ Reset procedure allows to restore the device back to its factory settings, which
Resetting the device is not the recommended way of removing the device from the Z-Wave network. Use reset procedure only if the primary controller is missing or inoperable. Certain device removal can be achieved by the procedure of removing described.
1. Press and hold the maintenance button to enter the menu.
2. Release button when the device glows yellow.
3. Quickly click the button to confirm.
4. After few seconds the device will be restarted, which is signalled with red LED colour.
#
8: Z-Wave range test
1. Press and hold the maintenance button to enter the menu.
2. Release button when the device glows yellow.
3. Quickly click the button to confirm.
4. After few seconds the device will be restarted, which is signalled with red LED colour.
# 8: Z-Wave range test
@ -142,22 +141,23 @@ The device has a built in Z-Wave network main controller’s range tester.  To
To test the main controller’s range:
1. Press and hold the maintenance button to enter the menu.
2. Release button when the device glows magenta.
3. Quickly click the button to confirm.
4. Visual indicator will indicate the Z-Wave network’s range (range signaling modes described below).
5. To exit Z-Wave range test, press the button briefly.
1. Press and hold the maintenance button to enter the menu.
2. Release button when the device glows magenta.
3. Quickly click the button to confirm.
4. Visual indicator will indicate the Z-Wave network’s range (range signaling modes described below).
5. To exit Z-Wave range test, press the button briefly.
Z-Wave range tester signalling modes:
- Visual indicator pulsing green - the device attempts to establish a direct communication with the main controller. If a direct communication attempt fails, the device will try to establish a routed communication, through other modules, which will be signalled by visual indicator pulsing yellow.
- Visual indicator glowing green - the device communicates with the main controller directly.  (Visual indicator pulsing yellow - the device tries to establish a routed communication with the main controller through other modules (repeaters).
- Visual indicator glowing yellow - the device communicates with the main controller through the other modules. After 2 seconds the device will retry to establish a direct communication with the main controller, which will be signalled with visual indicator pulsing green.
- Visual indicator pulsing violet - the device does communicate at the maximum distance of the Z-Wave network. If connection proves successful it will be confirmed with a yellow glow. It’s not recommended to use the device at the range limit.
- Visual indicator glowing red - the device is not able to connect to the main controller directly or through another Z-Wave network device (repeater).
Communication mode of the device may switch between direct and one using routing, especially if the device is on the limit of the direct range.
#
* Visual indicator pulsing green - the device attempts to establish a direct communication with the main controller. If a direct communication attempt fails, the device will try to establish a routed communication, through other modules, which will be signalled by visual indicator pulsing yellow.
* Visual indicator glowing green - the device communicates with the main controller directly.  (Visual indicator pulsing yellow - the device tries to establish a routed communication with the main controller through other modules (repeaters).
* Visual indicator glowing yellow - the device communicates with the main controller through the other modules. After 2 seconds the device will retry to establish a direct communication with the main controller, which will be signalled with visual indicator pulsing green.
* Visual indicator pulsing violet - the device does communicate at the maximum distance of the Z-Wave network. If connection proves successful it will be confirmed with a yellow glow. It’s not recommended to use the device at the range limit.
* Visual indicator glowing red - the device is not able to connect to the main controller directly or through another Z-Wave network device (repeater).Communication mode of the device may switch between direct and one using routing, especially if the device is on the limit of the direct range.
## Channels

12
_addons_bindings/zwave/doc/fibaro/fgs223_0_0.md
View File

@ -54,9 +54,11 @@ The following table summarises the channels available for the FGS223 -:
| Switch 1 | switch_binary1 | switch_binary | Switch | Switch |
| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number |
| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number |
| Meter reset | meter_reset1 | meter_reset | Energy | Switch |
| Switch 2 | switch_binary2 | switch_binary | Switch | Switch |
| Electric meter (kWh) 2 | meter_kwh2 | meter_kwh | Energy | Number |
| Electric meter (watts) 2 | meter_watts2 | meter_watts | Energy | Number |
| Meter reset | meter_reset2 | meter_reset | Energy | Switch |
### Electric meter (kWh)
Indicates the energy consumption (kWh).
@ -135,6 +137,11 @@ Indicates the instantaneous power consumption.
The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Meter reset
Reset the meter.
The ```meter_reset1``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category.
### Switch 2
Switch the power on and off.
@ -150,6 +157,11 @@ Indicates the instantaneous power consumption.
The ```meter_watts2``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Meter reset
Reset the meter.
The ```meter_reset2``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category.
## Device Configuration

12
_addons_bindings/zwave/doc/fibaro/fgwdeu111_0_0.md
View File

@ -548,17 +548,9 @@ Available values:
4 – Key pressed 3 times
8 – Key hold down and key released
The following option values may be configured, in addition to values in the range 0 to 15 -:
Values in the range 0 to 15 may be set.
| Value | Description |
|--------|-------------|
| 0 | no scenes |
| 1 | Key pressed once |
| 2 | Key pressed twice |
| 4 | Key pressed 3 times |
| 8 | Key held down and released |
The manufacturer defined default value is ```0``` (no scenes).
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```.

174
_addons_bindings/zwave/doc/futurehome/hizpushbtn4fh_0_0.md Normal file
View File

@ -0,0 +1,174 @@
---
layout: documentation
title: Z-Push Button 4 (FH) - ZWave
---
{% include base.html %}
# Z-Push Button 4 (FH) Wall Mounted Switch
This describes the Z-Wave device *Z-Push Button 4 (FH)*, manufactured by *Future Home AS* with the thing type UID of ```futurehome_hizpushbtn4fh_00_000```.
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![Z-Push Button 4 (FH) product image](https://opensmarthouse.org/zwavedatabase/1342/image/)
The Z-Push Button 4 (FH) supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.
The Z-Push Button 4 (FH) does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. Refer to the *Wakeup Information* section below for further information.
## Overview
Heatit Z-Push Button 4 is a battery operated wall switch with 4 push buttons. The switch enables you to control the Z-Wave- products in your smart home system. Managing your Z-Wave products becomes easy and practical. The switch can be set up to control scenarios or work in associations with other Z-Wave products.
Heatit Z-Push Button 4 can control up to 2 seperate association groups with up to 10 products or up to 8 scenarios through your gateway.
**Functions:**
* Battery operated wall switch
* Fits Gira System 55, Elko RS-16 and Schneider Exxact
* Controls 4 separate groups and up to 20 units
* Controls up to 16 scenarios via your gateway
* LED-diode
* Easy to install with screws or double-sided tape
* Supports encryption modes S0, S2 Authenticated Class, S2 Unauthenticated Class
### Inclusion Information
**Step 1.** Make sure the remote control does not belong to any Z-Wave network, short press on any button, if LED indicator does not turn on, the remote control does not belong to any network, then continue to step 2, if LED indicator turns on, it means the remote control has already been added to a network, please first set the remote control to removing mode (see exclusion information), then continue to step 2.
**Step 2.** Set primary controller/gateway into adding mode.
**Step 3.** Press and hold down both buttons I and O of Group 2 our 3 seconds, LED indicator, the remote control will be set to adding mode, and waiting to be added, after 10s LED indicator blinks 6 times quickly to indicate successful adding.
### Exclusion Information
There are two removing methods.
**Method 1:** Removing from the primary controller/gateway as follows:
1. Set the primary controller/gateway into removing mode.
2. Press and hold down both buttons I and O of Group 2 over 3 seconds, LED indicator turns on, the remote control will be set to removing mode, and waiting to be removed, after 7s LED indicator blinks 4 times quickly to indicate successful removing.
**Method 2:** Factory reset the remote control will force the remote control to be removed from a network.
A factory reset is done by press and holding down buttons I and O of Group 2 together for over 10 seconds, LED indicator turns on and then blinks 4 times quickly to indicate successful factory reset.
_Note: Factory reset is not recommended for removing, please use this procedure only if the primary controller/gateway is missing or otherwise inoperable._
### Wakeup Information
The Z-Push Button 4 (FH) does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour.
The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The remote control is under sleepy mode for most of the time to save battery power. It can not receive wireless commands under sleepy mode. Before the gateway interacts data with the remote, the remote control shall be activated manually first. Short press any button to activate the remote control for 3s, and press and hold down **I** and **O** buttons of the Group 2 together over 1 second to activate the remote control for 7s.
### General Usage Information
## Channels
The following table summarises the channels available for the Z-Push Button 4 (FH) -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Scene Number | scene_number | scene_number | | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -:
| Event ID | Event Description |
|----------|--------------------|
| 0 | Single key press |
| 1 | Key released |
| 2 | Key held down |
| 3 | Double keypress |
| 4 | Tripple keypress |
| 5 | 4 x keypress |
| 6 | 5 x keypress |
### Battery Level
Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.
The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category.
This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.
## Device Configuration
The device has no configuration parameters defined.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The Z-Push Button 4 (FH) supports 3 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
1. Send Command Class "Device Reset Locally Notification V1" to associated devices of the group to report factory reset information when factory reset the remote control.
2. When remote control battery power value changes, send Command Class "Battery Report V1" to associated devices of this group to report power value information.
3. Short press or press and hold any button to send scene activation command to the associated devices of this group using Command Class "Central Scene Notification V3".
Association group 1 supports 5 nodes.
### Group 2: Launch 1
Short press I/O button of Group 2 to send ON/OFF command to associated devices of the group using Command Class "Basic Set V2".
Press and hold down I/O button Group 2 to send light intensity increase/decrease command to associated devices of this group using Command Class "Multilevel V4"
Association group 2 supports 5 nodes.
### Group 3: Launch 2
Short press I/O button of Group 3 to send ON/OFF command to associated devices of the group using Command Class "Basic Set V2".
Press and hold down I/O button Group 3 to send light intensity increase/decrease command to associated devices of this group using Command Class "Multilevel V4"
Association group 3 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [Installers manual - English](https://opensmarthouse.org/zwavedatabase/1342/reference/manual-heatit-z-push-button-4--fw-1-26-ver2019-a-eng.pdf)
* [Product Sheet - Eng.](https://opensmarthouse.org/zwavedatabase/1342/reference/fdv-heatit-z-push-button-4-eng.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1342).

248
_addons_bindings/zwave/doc/ge/zw3010_0_0.md Normal file
View File

@ -0,0 +1,248 @@
---
layout: documentation
title: ZW3010 - ZWave
---
{% include base.html %}
# ZW3010 In-Wall Smart Dimmer ZW3010 / 39351
This describes the Z-Wave device *ZW3010*, manufactured by *Jasco Products* with the thing type UID of ```ge_zw3010_00_000```.
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![ZW3010 product image](https://opensmarthouse.org/zwavedatabase/1341/image/)
The ZW3010 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
### Inclusion Information
Once the controller is ready to add your device, press and release the top or bottom of the smart fan control switch (rocker) to add it in the network.
### Exclusion Information
Once the controller is ready to add your device, press and release the top or bottom of the switch (rocker) to add it in the network.
### General Usage Information
## Factory Reset
Quickly press ON (top) button three times, then immediately press the OFF (Bottom) button three times. The LED will flash ON/OFF five times when completed successfully.
**Note**: This should only be used if your network’s primary controller is missing or otherwise inoperable.
## Channels
The following table summarises the channels available for the ZW3010 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -:
| Event ID | Event Description |
|----------|--------------------|
| 0 | Single key press |
| 1 | Key released |
| 2 | Key held down |
| 3 | Double keypress |
| 4 | Tripple keypress |
| 5 | 4 x keypress |
| 6 | 5 x keypress |
## Device Configuration
The following table provides a summary of the 7 configuration parameters available in the ZW3010.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 3 | LED Status | LED Status |
| 6 | Dim up/down rate | Dim up/down rate |
| 16 | Switch Mode | Switch Mode |
| 19 | Alternate Exclusion | Alternate Exclusion |
| 30 | Minimum Dim Threshold | Minimum Dim Threshold |
| 31 | Maximum Brightness Threshold | Maximum Brightness Threshold |
| 32 | Default Brightness Level | Default Brightness Level |
### Parameter 3: LED Status
LED Status
The following option values may be configured, in addition to values in the range 0 to 3 -:
| Value | Description |
|--------|-------------|
| 0 | Device is ON, LED is OFF; device is OFF, LED is ON |
| 1 | Device is ON, LED is ON; device is OFF, LED is OFF |
| 2 | LED always OFF |
| 3 | LED always ON |
The manufacturer defined default value is ```0``` (Device is ON, LED is OFF; device is OFF, LED is ON).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 6: Dim up/down rate
Dim up/down rate
Adjust the speed at which the ramps to a specific value other than 0 and FF
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Quickly |
The manufacturer defined default value is ```0``` (Quickly).
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Parameter 16: Switch Mode
Switch Mode
Turn your dimmer into an On/Off switch with switch mode
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Dimmer Mode |
| 1 | Switch Mode |
The manufacturer defined default value is ```0``` (Dimmer Mode).
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 19: Alternate Exclusion
Alternate Exclusion
Never accidentally remove a device with alternate exclusion.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Normal, Press Any Button on the device |
| 1 | Alternate |
The manufacturer defined default value is ```0``` (Normal, Press Any Button on the device).
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Parameter 30: Minimum Dim Threshold
Minimum Dim Threshold
Set the minimum dimmer threshold when manually or remotely controlled
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_30_1``` and is of type ```INTEGER```.
### Parameter 31: Maximum Brightness Threshold
Maximum Brightness Threshold
Set the maximum brightness threshold when manually or remotely controlled
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_31_1``` and is of type ```INTEGER```.
### Parameter 32: Default Brightness Level
Default Brightness Level
Set the default brightness level that the dimmer will turn on when being controlled manually
0 = Default
1 - 99 = percentage
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_32_1``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The ZW3010 supports 3 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Z-Wave Plus Lifeline, Multilevel Switch Report
Association group 1 supports 5 nodes.
### Group 2: Basic Set Local Load
Support Basic Set and is controlled with the local load
Supports Basic Set and is controlled with local load
Association group 2 supports 5 nodes.
### Group 3: Basic Set Double Press
Supports Basic Set and is controlled by double pressing the On or Off button
Basic Set and is controlled by double pressing the ON or OFF button
Association group 3 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_APPLICATION_STATUS_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [Manual](https://opensmarthouse.org/zwavedatabase/1341/reference/39351_QSG_v4.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1341).

100
_addons_bindings/zwave/doc/heltun/heht01_0_0.md
View File

@ -176,7 +176,7 @@ The ```time_offset``` channel is of type ```time_offset``` and supports the ```N
## Device Configuration
The following table provides a summary of the 72 configuration parameters available in the HE-HT01.
The following table provides a summary of the 64 configuration parameters available in the HE-HT01.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
@ -245,14 +245,6 @@ Detailed information on each parameter can be found in the sections below.
| 145 | Humidity difference | Humidity difference to send to controller, % |
| 146 | Light sensor difference | Light sensor values difference to send to controller, % |
| 171 | Basic set action | Mode to switch to on Basic |
| 1001 | DELETE ME | Manually set time minute |
| 1002 | DELETE ME | Temperature difference to send to controller, value x10 |
| 1003 | DELETE ME | Active display brightness level. |
| 1004 | DELETE ME | Inactive display brightness level. |
| 1005 | DELETE ME | Auto LCD brightness control |
| 1006 | DELETE ME | Auto bright level 1 |
| 1007 | DELETE ME | Auto bright level 2 |
| 1008 | DELETE ME | Auto bright level 3 |
### Parameter 1: Frequency Region
@ -1101,96 +1093,6 @@ The manufacturer defined default value is ```1``` (COM).
This parameter has the configuration ID ```config_171_1``` and is of type ```INTEGER```.
### Parameter 1001: DELETE ME
Manually set time minute
Values in the range 0 to 59 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_1001_1``` and is of type ```INTEGER```.
### Parameter 1002: DELETE ME
Temperature difference to send to controller, value x10
Centigrade value * 10
e.g. 22.5 = 225
Values in the range 1 to 10 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_1002_1``` and is of type ```INTEGER```.
### Parameter 1003: DELETE ME
Active display brightness level.
Active display brightness level. Must be greater than or equal param 23
Values in the range 1 to 4 may be set.
The manufacturer defined default value is ```4```.
This parameter has the configuration ID ```config_1003_1``` and is of type ```INTEGER```.
### Parameter 1004: DELETE ME
Inactive display brightness level.
Inactive display brightness level. Must be less than or equal param 22
Values in the range 1 to 4 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_1004_1``` and is of type ```INTEGER```.
### Parameter 1005: DELETE ME
Auto LCD brightness control
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_1005_1``` and is of type ```INTEGER```.
### Parameter 1006: DELETE ME
Auto bright level 1
Auto brightness level 1 max lumens
Values in the range 0 to 5000 may be set.
The manufacturer defined default value is ```30```.
This parameter has the configuration ID ```config_1006_1``` and is of type ```INTEGER```.
### Parameter 1007: DELETE ME
Auto bright level 2
Auto brightness level 2 max lumens
Values in the range 0 to 5000 may be set.
The manufacturer defined default value is ```200```.
This parameter has the configuration ID ```config_1007_1``` and is of type ```INTEGER```.
### Parameter 1008: DELETE ME
Auto bright level 3
Auto brightness level 3 max lumens
Values in the range 0 to 5000 may be set.
The manufacturer defined default value is ```3000```.
This parameter has the configuration ID ```config_1008_1``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.

4
_addons_bindings/zwave/doc/homeseer/hsfls100_0_0.md
View File

@ -33,6 +33,10 @@ Press the Link button 3 times within 1.5 seconds to put the unit into inclusion
Press the Link button 3 times within 1.5 seconds to put the unit into exclusion mode.
### General Usage Information
## Channels
The following table summarises the channels available for the HS-FLS100+ -:

3
_addons_bindings/zwave/doc/homeseer/hswd200511_5_11.md
View File

@ -466,7 +466,7 @@ This parameter has the configuration ID ```config_27_1``` and is of type ```INTE
Set blink frequency when displaying custom status
The following option values may be configured, in addition to values in the range 0 to 255 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -655,7 +655,6 @@ Association group 2 supports 5 nodes.
### Documentation Links
* [HS-WD200+ Product Manual](https://opensmarthouse.org/zwavedatabase/1040/reference/HS-WD200-Manual-5a.pdf)
* [HS-WD200+ Product Manual (Updated)](https://opensmarthouse.org/zwavedatabase/1040/reference/HS-WS200-Manual-v7a.pdf)
---

6
_addons_bindings/zwave/doc/homeseer/hsws200_5_7.md
View File

@ -7,7 +7,7 @@ title: HS-WS200+ - ZWave
# HS-WS200+ Scene Capable Wall Switch
This describes the Z-Wave device *HS-WS200+*, manufactured by *[HomeSeer Technologies](http://www.homeseer.com/)* with the thing type UID of ```homeseer_hsws200_05_007```.
This version of the device is limited to firmware version 5.7
This version of the device is limited to firmware versions 5.7 to 5.11
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
@ -28,6 +28,10 @@ Tap the paddle of your HomeSeer switch to begin the inclusion process. This will
Put your Z-Wave controller into exclusion mode. Tap the paddle of your HomeSeer switch.
### General Usage Information
## Channels
The following table summarises the channels available for the HS-WS200+ -:

570
_addons_bindings/zwave/doc/inovelli/lzw45_0_0.md Normal file
View File

@ -0,0 +1,570 @@
---
layout: documentation
title: LZW45 - ZWave
---
{% include base.html %}
# LZW45 Red Series - RGBTW Lightstrip
This describes the Z-Wave device *LZW45*, manufactured by *Inovelli* with the thing type UID of ```inovelli_lzw45_00_000```.
The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc..
![LZW45 product image](https://opensmarthouse.org/zwavedatabase/1346/image/)
The LZW45 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
The LZW45 Inovelli RGBTW Smart LED Strip is the first Z-Wave enabled individually addressable lightstrip that works with many different hubs and gateways and allows remote control from anywhere in the world.
### Inclusion Information
Tap A button (rectangle) 3x
### Exclusion Information
Tap A button (rectangle) 3x
### General Usage Information
## Channels
The following table summarises the channels available for the LZW45 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Meter reset | meter_reset | meter_reset | Energy | Switch |
| Color Control | color_color | color_color | ColorLight | Color |
| Color Temperature | color_temperature | color_temperature | ColorLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Electric meter (watts)
Indicates the instantaneous power consumption.
The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (kWh)
Indicates the energy consumption (kWh).
The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Meter reset
Reset Meter
Reset the meter.
The ```meter_reset``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category.
### Color Control
The color channel allows to control the color of a light.
It is also possible to dim values and switch the light on and off.
The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category.
### Color Temperature
The color temperature channel allows to set the color
temperature of a light from 0 (cold) to 100 (warm).
The ```color_temperature``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -:
| Event ID | Event Description |
|----------|--------------------|
| 0 | Single key press |
| 1 | Key released |
| 2 | Key held down |
| 3 | Double keypress |
| 4 | Tripple keypress |
| 5 | 4 x keypress |
| 6 | 5 x keypress |
## Device Configuration
The following table provides a summary of the 20 configuration parameters available in the LZW45.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | # of Pixels | When individually addressable LEDs are used, this parameter tells the controller the number of pixels that are attached. |
| 2 | Dimming Speed | This changes the speed in which the lightstrip dims up or down. |
| 3 | Ramp Rate | This changes the speed in which the lightstrip turns on or off. |
| 4 | Minimum Level | The minimum level that the strip can be dimmed to. |
| 5 | Maximum Level | The maximum level that the strip can be dimmed to. |
| 6 | Auto Off Timer | Automatically turns the strip off after this many seconds. |
| 7 | Default Level (Local) | Default level for the strip when it is powered on from the local switch. |
| 8 | Default Level (Z-Wave) | Default level for the dimmer when it is powered on from a Z-Wave command (i.e. BasicSet(0xFF). |
| 9 | Default Color | Byte(3-2): Values between 2700-6500 represent a color temperature. Byte(1-0): Values between 1-360 represent the color on the Hue color wheel. The value of 361 represents a random color and a value of 0 represents the previous color. |
| 10 | State after power Restored | The state the switch should return to once power is restored after power failure. |
| 17 | Active Power Reports | The power level change that will result in a new power report being sent. |
| 18 | Periodic Power & Energy Reports | Time period between consecutive power & energy reports being sent (in seconds). |
| 19 | Active Energy Reports | Energy reports Energy level change which will result in sending a new energy report. |
| 21 | Quick Strip Effect | Turn on a quick effect that is similar to the LED notifications on our dimmers and switches. |
| 22 | Custom Effect Parameter 1 | A custom effect with up to 4 actions can be turned on with correct input for parameters 22-24, 30. (Color/Transition) |
| 23 | Custom Effect Parameter 2 | A custom effect with up to 4 actions can be turned on with correct input for parameters 22- 24, 30. (Level) |
| 24 | Custom Effect Parameter 3 | A custom effect with up to 4 actions can be turned on with correct input for parameters 22- 24, 30. (Duration) |
| 30 | Custom Effect Parameter 4 | A custom effect with up to 4 actions can be turned on with correct input for parameters 22- 24, 30. (Iterations/Scale) |
| 31 | Pixel Effect | Turn on an effect that utilizes the individually addressable LEDs. |
| 51 | Disable Physical On/Off Delay | The 700ms delay that occurs after pressing the physical button to turn the switch on/off is removed. |
### Parameter 1: # of Pixels
When individually addressable LEDs are used, this parameter tells the controller the number of pixels that are attached.
When individually addressable LEDs are used, this parameter tells the controller the number of pixels that are attached. 0 - Automatic recognition of pixels. 1..130 - Manually set the number of pixels.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Auto |
The manufacturer defined default value is ```0``` (Auto).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Dimming Speed
This changes the speed in which the lightstrip dims up or down.
This changes the speed in which the lightstrip dims up or down. A setting of 0 should turn the light immediately on or off (almost like an on/off switch). Increasing the value should slow down the transition speed. 0 - Instant, 1 - Fast .. 98 - Slow
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Instant |
| 1 | Fast |
| 98 | Slow |
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Ramp Rate
This changes the speed in which the lightstrip turns on or off.
This changes the speed in which the lightstrip turns on or off. For example, when a user sends the switch a basicSet(value: 0xFF) or basicSet(value: 0x00), this is the speed in which those actions take place. A setting of 0 should turn the light immediately on or off (almost like an on/off switch). Increasing the value should slow down the transition speed. A setting of 99 should keep this in sync with parameter 2. 0 - Instant. 1 - Fast .. 98 - Slow. 99 - Keep in sync with parameter 2
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Instant |
| 1 | Fast |
| 98 | Slow |
| 99 | Sync with Parameter 2 |
The manufacturer defined default value is ```99``` (Sync with Parameter 2).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Minimum Level
The minimum level that the strip can be dimmed to.
The minimum level that the strip can be dimmed to. Useful when the user has an LED strip that does not turn on or flickers at a lower level.
Values in the range 1 to 45 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Maximum Level
The maximum level that the strip can be dimmed to.
The maximum level that the strip can be dimmed to. Useful when the user has an LED strip that reaches its maximum level before the dimmer value of 99.
Values in the range 55 to 99 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Auto Off Timer
Automatically turns the strip off after this many seconds.
Automatically turns the strip off after this many seconds. When the strip is turned on a timer is started that is the duration of this setting. When the timer expires, the strip is turned off. 0 - Auto off is disabled
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disabled |
The manufacturer defined default value is ```0``` (Disabled).
This parameter has the configuration ID ```config_6_2``` and is of type ```INTEGER```.
### Parameter 7: Default Level (Local)
Default level for the strip when it is powered on from the local switch.
Default level for the strip when it is powered on from the local switch. A setting of 0 means that the switch will return to the level that it was on before it was turned off. 0 - Previous
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Previous |
The manufacturer defined default value is ```0``` (Previous).
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Default Level (Z-Wave)
Default level for the dimmer when it is powered on from a Z-Wave command (i.e. BasicSet(0xFF).
Default level for the dimmer when it is powered on from a Z-Wave command (i.e. BasicSet(0xFF). A setting of 0 means that the switch will return to the level that it was on before it was turned off. 0 - Previous
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Previous |
The manufacturer defined default value is ```0``` (Previous).
This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```.
### Parameter 9: Default Color
Byte(3-2): Values between 2700-6500 represent a color temperature. Byte(1-0): Values between 1-360 represent the color on the Hue color wheel. The value of 361 represents a random color and a value of 0 represents the previous color.
Byte(3-2): Values between 2700-6500 represent a color temperature. Byte(1-0): Values between 1-360 represent the color on the Hue color wheel. The value of 361 represents a random color and a value of 0 represents the previous color.
Values in the range 0 to 6500 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_9_4``` and is of type ```INTEGER```.
### Parameter 10: State after power Restored
The state the switch should return to once power is restored after power failure.
The state the switch should return to once power is restored after power failure. 0 - Off. 1 - Default Color / Level (Parameter 9). 2 - Previous
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Off |
| 1 | Default Color/Level (P9) |
| 2 | Previous |
The manufacturer defined default value is ```2``` (Previous).
This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```.
### Parameter 17: Active Power Reports
The power level change that will result in a new power report being sent.
The power level change that will result in a new power report being sent. The value is a percentage of the previous report. 0 = disabled.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disabled |
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```.
### Parameter 18: Periodic Power & Energy Reports
Time period between consecutive power & energy reports being sent (in seconds).
Time period between consecutive power & energy reports being sent (in seconds). The timer is reset after each report is sent
Values in the range 0 to 32767 may be set.
The manufacturer defined default value is ```3600```.
This parameter has the configuration ID ```config_18_2``` and is of type ```INTEGER```.
### Parameter 19: Active Energy Reports
Energy reports Energy level change which will result in sending a new energy report.
Energy reports Energy level change which will result in sending a new energy report. Available settings: 0 - energy reports disabled, 1-127 (0.01-1.27 kWh) - report triggering threshold,
Default setting: 10 (0.1 kWh)
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Parameter 21: Quick Strip Effect
Turn on a quick effect that is similar to the LED notifications on our dimmers and switches.
Turn on a quick effect that is similar to the LED notifications on our dimmers and switches.
See website for details.
Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_21_4``` and is of type ```INTEGER```.
### Parameter 22: Custom Effect Parameter 1
A custom effect with up to 4 actions can be turned on with correct input for parameters 22-24, 30. (Color/Transition)
A custom effect with up to 4 actions can be turned on with correct input for parameters 22-24, 30. This parameter controls the color and transition of those actions. See website for details.
Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_22_4``` and is of type ```INTEGER```.
### Parameter 23: Custom Effect Parameter 2
A custom effect with up to 4 actions can be turned on with correct input for parameters 22- 24, 30. (Level)
A custom effect with up to 4 actions can be turned on with correct input for parameters 22-24, 30. This parameter controls the level of those actions. See website for details.
Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_23_4``` and is of type ```INTEGER```.
### Parameter 24: Custom Effect Parameter 3
A custom effect with up to 4 actions can be turned on with correct input for parameters 22- 24, 30. (Duration)
A custom effect with up to 4 actions can be turned on with correct input for parameters 22-24, 30. This parameter controls the duration of those actions. See website for details.
Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_24_4``` and is of type ```INTEGER```.
### Parameter 30: Custom Effect Parameter 4
A custom effect with up to 4 actions can be turned on with correct input for parameters 22- 24, 30. (Iterations/Scale)
A custom effect with up to 4 actions can be turned on with correct input for parameters 22-24, 30. This parameter controls the number of iterations, the end effect, and the scale of the duration in parameter 24. See website for details.
Values in the range 0 to 32768 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_30_4``` and is of type ```INTEGER```.
### Parameter 31: Pixel Effect
Turn on an effect that utilizes the individually addressable LEDs.
Turn on an effect that utilizes the individually addressable LEDs. Listed Below.
Byte 0 = Effect, Byte 1 = Level
1. Static
2. Blink
3. Breath
4. Color Wipe
5. Color Wipe Reverse Inverse
6. Color Wipe Random
7. Random Color
8. Single Dynamic
9. Multi Dynamic
10. Rainbow
11. Rainbow Cycle
12. Scan
13. Dual Scan
14. Fade
15. Running Lights
16. Twinkle
17. Twinkle Random
18. Twinkle Fade
19. Twinkle Fade Random
20. Sparkle
21. Flash Sparkle
22. Hyper Sparkle
23. Strobe
24. Blink Rainbow
25. Chase White
26. Chase Color
27. Chase Random
28. Chase Rainbow
29. Chase Flash
30. Chase Flash Random
31. Chase Rainbow White
32. Chase Blackout
33. Chase Blackout Rainbow
34. Color Sweep Random
35. Running Color
36. Running Red Blue
37. Running Random
38. Larson Scanner
39. Comet
40. Fireworks
41. Fireworks Random
42. Merry Christmas
43. Circus Combustus
44. Halloween
45. Aurora
Values in the range 0 to 32767 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_31_2``` and is of type ```INTEGER```.
### Parameter 51: Disable Physical On/Off Delay
The 700ms delay that occurs after pressing the physical button to turn the switch on/off is removed.
The 700ms delay that occurs after pressing the physical button to turn the switch on/off is removed. Consequently this also removes the following scenes: 2x, 3x, 4x, 5x tap. Still working are the 1x tap, held, released, and the level up/down scenes.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Yes |
| 1 | No |
The manufacturer defined default value is ```1``` (No).
This parameter has the configuration ID ```config_51_1``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The LZW45 supports 4 association groups.
### Group 1: Group 1
Lifeline
Members of this group will receive unsolicited messages related to the status of the switch.
Association group 1 supports 5 nodes.
### Group 2: Group 2
Basic Set
Sends On & Off commands to associated devices. (1. Single press UP button sends BasicSet (0xFF) and 2. Single press Down sends BasicSet (0x00)
Association group 2 supports 5 nodes.
### Group 3: Group 3
Switch Multilevel Set
Sends set level commands to associated devices when the up/down  button is pressed.
(1. Hold & Release Up or Down button sends SwitchMultiLevelSet which keeps associated devices in sync with this device. 2. Single press Up button sends SwitchMultiLevelSet(0xFF) and 4. Single press Down button sends SwitchMultiLevelSet(0x00)
Association group 3 supports 5 nodes.
### Group 4: Group 4
Switch Multilevel Set
Sends start / stop level change to associated devices.
(1. Hold Up button sends SW\_MULTILEVEL\_START\_LEVEL\_CHANGE (Up)
2: Hold Down button sends SW\_MULTILEVEL\_START\_LEVEL\_CHANGE (Down) 3.
Release Either button sends SW\_MULTILEVEL\_STOP\_LEVEL\_CHANGE
Association group 4 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_APPLICATION_STATUS_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_METER_V3| |
| COMMAND_CLASS_SWITCH_COLOR_V3| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_PROTECTION_V2| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_INDICATOR_V3| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [manual](https://opensmarthouse.org/zwavedatabase/1346/reference/LZW45_Manual_Lightstrip_Controller_Kit.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1346).

2
_addons_bindings/zwave/doc/qubino/zmnhmd_0_0.md
View File

@ -5,7 +5,7 @@ title: ZMNHMD - ZWave
{% include base.html %}
# ZMNHMD Water meter and leakage detector with valve control
# ZMNHMD Smart leak protector
This describes the Z-Wave device *ZMNHMD*, manufactured by *[Goap](http://www.qubino.com/)* with the thing type UID of ```qubino_zmnhmd_00_000```.
The device is in the category of *Valve*, defining Valves used to control water or gas. e.g. a flow stop valve..

16
_addons_bindings/zwave/doc/qubino/zmnhyd_0_0.md
View File

@ -55,6 +55,7 @@ The following table summarises the channels available for the ZMNHYD -:
| Electric meter (amps) | meter_current | meter_current | Energy | Number |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Reset Power Consumption | meter_reset | meter_reset | Energy | Switch |
| Alarm (power) | alarm_power | alarm_power | Energy | Switch |
### Switch
@ -82,6 +83,11 @@ Indicates the instantaneous power consumption.
The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Reset Power Consumption
Reset the meter.
The ```meter_reset``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category.
### Alarm (power)
Indicates if a power alarm is triggered.
@ -111,8 +117,8 @@ Detailed information on each parameter can be found in the sections below.
| 40 | Treshold Change in Power for reporting | Change of power consumption [Watt] reporting threshold |
| 41 | Threshold time for power reporting | Threshold time for power reporting [Seconds] |
| 42 | Power Consumption Reporting Time Threshold | Power Consumption Reporting Time Threshold [Seconds] |
| 50 | Down value | Down value [watt] |
| 51 | Up value | Upper power threshold used in parameter no. 52 |
| 50 | Down value | Lower power threshold [watt] used in parameter no. 52 |
| 51 | Up value | Upper power threshold [watt] used in parameter no. 52 |
| 52 | Action in case of exceeding defined power values | Action in case of exceeding defined power values (parameters 50 and 51) |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
@ -257,7 +263,7 @@ This parameter has the configuration ID ```config_42_2``` and is of type ```INTE
### Parameter 50: Down value
Down value [watt]
Lower power threshold [watt] used in parameter no. 52
Lower power threshold used in parameter no. 52.
Values:
@ -283,7 +289,7 @@ This parameter has the configuration ID ```config_50_2``` and is of type ```INTE
### Parameter 51: Up value
Upper power threshold used in parameter no. 52
Upper power threshold [watt] used in parameter no. 52
Values
* default value 50 : 50 W
@ -407,6 +413,8 @@ Association group 5 supports 5 nodes.
### Documentation Links
* [Qubino Smart Plug 16A extended manual](https://opensmarthouse.org/zwavedatabase/822/reference/Qubino-Smart-Plug-16A-PLUS-extended-manual-eng-2-2-2.pdf)
* [Qubino Smart Plug 16A extended manual V2.6](https://opensmarthouse.org/zwavedatabase/822/reference/qubino-smart-plug-16a-plus-extended-manual-eng-V2.6_2019-04-10.pdf)
* [Qubino Smart Plug 16A extended manual V2.7](https://opensmarthouse.org/zwavedatabase/822/reference/qubino-smart-plug-16a-plus-extended-manual-eng-V2.7_2019-05-09.pdf)
---

435
_addons_bindings/zwave/doc/sunricher/veggplug2_0_0.md Normal file
View File

@ -0,0 +1,435 @@
---
layout: documentation
title: ROB_100-017-0 - ZWave
---
{% include base.html %}
# ROB_100-017-0 ROBB Smart Wallplug 3680Watt
This describes the Z-Wave device *ROB_100-017-0*, manufactured by *[Sunricher](www.sunricher.com)* with the thing type UID of ```sunricher_veggplug2_00_000```.
The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there.
![ROB_100-017-0 product image](https://opensmarthouse.org/zwavedatabase/1339/image/)
The ROB_100-017-0 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
Zwave Smart Plug. The Device supports metering functions (voltage, current, energy consumption and power). It also supports thermostat's Heat mode, Energy Heat mode, OFF mode. The device cannot act as as network controller (primary or secondary) and wil allways need a Z-Wave network controller to be included into a Z-Wave network.
### Inclusion Information
1. Set the primary controller into inclusion mode (Please refer to your primary controllers manual on how to turn your controller into inclusion).
2. Power on the smart plug, make sure it does not belong to any Z-Wave network. There are two methods to set the smart plug into inclusion mode:
3. Repower the smart plug, it will be set into inclusion mode automatically, and wait to be included.
b) Triple press the action button on the smart plug, it will set the plug into inclusion mode. The LED indicator will flash white fast then stay solid white for 3 seconds to indicate successful inclusion. lf there is no Z-Wave network available, the LED indicator will flash white fast for 30 seconds and the plug will quit inclusion mode automatically.
(Note: When using S2 encryption mode to include the device, an encrypted key will need to be generated. The LED indicator may not flash, please wait and do not unplug the device.)
### Exclusion Information
There are two exclusion methods:
Method l : Exclusion from the primary controller as follows:
1. Set the primary controller into exclusion mode (Please refer to your primary controllers manual on howto set your controller into exclusion).
2. Triple press the action button, the smart plug will be set to exclusion mode, the LED indicator will flash white fast and then flash white slowly 3 times to indicate successful exclusion. lf exclusion fails, the LED indicator will flash fast for 30 seconds and the plug will quit exclusion mode automatically.
There are 3 methods for the smart plug to exit out of “exclusion mode". Once it exits “exclusion mode", the LED light will stop the fast fade-in and fade-out.
1. Automatically exits after successful exclusion.
2. Exits after 6 second timeout.
3. Repowering on the smart plug.
Method 2: A "Factory reset" of the smart plug will force the device to be excluded from a network (please refer to the part “Factory Reset” of this manual).
(Note: A "Factory reset" is not recommended for exclusion. Please use this procedure only if the primary controller is missing or otherwise inoperable.)
Factory Reset:
Press and hold the action button for over 10 seconds, the LED indicator should stay solid white for 3 seconds to indicate successfull factory reset. Release the action button, the smart plug will restart automatically. If the LED indicator flashes yellow slowly, the device was not included to any network in the first place.
### General Usage Information
## Channels
The following table summarises the channels available for the ROB_100-017-0 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Scene Number | scene_number | scene_number | | Number |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Electric meter (amps) | meter_current | meter_current | Energy | Number |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number |
| Alarm (power) | alarm_power | alarm_power | Energy | Switch |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
### Electric meter (kWh)
Indicates the energy consumption (kWh).
The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (amps)
Indicates the instantaneous current consumption.
The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (watts)
Indicates the instantaneous power consumption.
The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (volts)
Indicates the instantaneous voltage.
The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Alarm (power)
Indicates if a power alarm is triggered.
The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
The following state translation is provided for this channel to the ```Switch``` item type -:
| Value | Label |
|-------|-----------|
| OFF | OK |
| ON | Alarm |
## Device Configuration
The following table provides a summary of the 13 configuration parameters available in the ROB_100-017-0.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 7 | Device operating mode | Defines operating modes: either "switch mode" or "thermostat mode". |
| 8 | Report state changes while in thermostat mode | Whether to report setpoint and mode changes. |
| 9 | Temperature compensation value | Temperature compensation in 0.1 °Celsius per unit point. |
| 10 | Over temperature protection | Temperature setpoint for automatic relay shutoff, or "0" to disable. |
| 11 | Temperature change reporting threshold | Temperature change in degrees Celsius at wich to report a temperature change to the gateway. |
| 12 | Periodic temperature reporting interval | Sets the interval (in seconds) for temperature reporting. |
| 13 | Power change threshold | Report power changes over or under the threshold value (W). |
| 14 | Voltage change absolute threshold | Report voltage changes over or under the threshold value (V). |
| 15 | Current change absolute threshold | Report current changes over or under the threshold value (A). |
| 17 | Time interval for energy reporting | Time interval in seconds to report voltage, current, power and energy consumption values. |
| 18 | Device state after a power reset | The state to which the wallplug should be set after a powerfailure. |
| 19 | Report state changes while in switch mode | Whether to report mode changes, power resetting or factory resets. |
| 20 | Current protection | Set the threshold for current protection (in Ampère), or disable. |
### Parameter 7: Device operating mode
Defines operating modes: either "switch mode" or "thermostat mode".
Switch mode enables the control of the relay output directly by basic set or binary set.
Thermostat mode will control the relay output automatically according to the temperature value set.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_7_0``` and is of type ```INTEGER```.
### Parameter 8: Report state changes while in thermostat mode
Whether to report setpoint and mode changes.
When configured as thermostat mode: if thermostat setpoint or mode changes, whether te report actively.
0 - do not report.
1 - report actively.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_8_0``` and is of type ```INTEGER```.
### Parameter 9: Temperature compensation value
Temperature compensation in 0.1 °Celsius per unit point.
Sets the temperature compensation to none: 0.
Sets the temperature compensation to a defined value in 0.1 °Celsius. For example a value of -5 will compensate by -0.5 °Celsius.
Values in the range -50 to 50 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_9_0``` and is of type ```INTEGER```.
### Parameter 10: Over temperature protection
Temperature setpoint for automatic relay shutoff, or "0" to disable.
Whether to enable over temperature protection. When temperature achieves the set value, the relay output will be forced to off.
0: disable over temperature protection .
30 - 60: set a threshold, unit is 1 Celcius degree.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 50 may be set.
The manufacturer defined default value is ```36```.
This parameter has the configuration ID ```config_10_0``` and is of type ```INTEGER```.
### Parameter 11: Temperature change reporting threshold
Temperature change in degrees Celsius at wich to report a temperature change to the gateway.
Temperature change report threshold. Report to the gateway when change value is lower or higher than the threshold
0: disable reporting.
2 - 50: set a threshold‚ unit is 0.1 °Celsius.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```6```.
This parameter has the configuration ID ```config_11_0``` and is of type ```INTEGER```.
### Parameter 12: Periodic temperature reporting interval
Sets the interval (in seconds) for temperature reporting.
Time interval for periodical temperature report. Unit is seconds.
0: disable reporting.
10 - 65535 time interval for periodical temperature report.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 10 to 65535 may be set.
The manufacturer defined default value is ```300```.
This parameter has the configuration ID ```config_12_0``` and is of type ```INTEGER```.
### Parameter 13: Power change threshold
Report power changes over or under the threshold value (W).
Power change absolute threshold. Unit is W. Report when power change value lower or higher than the threshold.
Value:
0: disable reporting.
1 - 255: absolute threshold.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_13_0``` and is of type ```INTEGER```.
### Parameter 14: Voltage change absolute threshold
Report voltage changes over or under the threshold value (V).
Voltage change absolute threshold. Unit is V. Report when voltage change value lower or higher than the threshold.
Value:
0: disable reporting.
1 - 255: absolute threshold.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_14_0``` and is of type ```INTEGER```.
### Parameter 15: Current change absolute threshold
Report current changes over or under the threshold value (A).
Current change absolute threshold. Unit is 0‚1A. Report when current change value lower or higher than the threshold.
Value:
0: disable reporting
1 - 255: absolute threshold
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_15_0``` and is of type ```INTEGER```.
### Parameter 17: Time interval for energy reporting
Time interval in seconds to report voltage, current, power and energy consumption values.
Time interval for periodically active report of voltage value, current value, power value, energy consumption, unit is seconds.
60-2678400 (31 days)‚unit is S, it stands for time interval of 60s to 2678400s.
Values in the range 60 to 2678400 may be set.
The manufacturer defined default value is ```600```.
This parameter has the configuration ID ```config_17_0``` and is of type ```INTEGER```.
### Parameter 18: Device state after a power reset
The state to which the wallplug should be set after a powerfailure.
Device state after a power reset.
Switch Mode:
00: turn off relay
01: turn on relay
02: save relay state before power reset
Thermostat mode:
00: HVAC OFF
01: HVAC ON
02: save HVAC state before power reset
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_18_0``` and is of type ```INTEGER```.
### Parameter 19: Report state changes while in switch mode
Whether to report mode changes, power resetting or factory resets.
Enable/disable to send SWITCH\_BINARY\_REPORT to the Lifeline when the plug state changes while in "Switch mode", reset power of the plug and factory reset the plug
0: disable to send
1: enable to send
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_19_0``` and is of type ```INTEGER```.
### Parameter 20: Current protection
Set the threshold for current protection (in Ampère), or disable.
Enable/disable current protection threshold function
0: disable current protection.
10 - 16: threshold in Ampère.
The following option values may be configured, in addition to values in the range 0 to 16 -:
| Value | Description |
|--------|-------------|
| 0 | disable current protection |
| 10 | |
| 11 | |
| 12 | |
| 13 | |
| 14 | |
| 15 | |
| 16 | |
The manufacturer defined default value is ```0``` (disable current protection).
This parameter has the configuration ID ```config_20_0``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The ROB_100-017-0 supports 1 association group.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
1. Smart plug Factory Reset, send Command Class "Device Reset Locally Notification CC" to associated devices of this group to report factory reset information when factory reset the smart plug.
2. Smart plug over current, over temperature, send Command Class "NOTIFICATION\_REPORT\_CC“ to associated devices of this group to report overload information.
3. When smart plug state changes, send Command Class “SWITCH\_BINARY\_REPORT CC" to associated devices of this group to report state information.
4. METER_REPORT.
5. Send "SENSOR\_MULTILEVEL\_REPORT" to report temperature.
6. Report when thermostat setpoint er mode changes.
Association group 1 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SCENE_ACTIVATION_V1| |
| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| |
| COMMAND_CLASS_METER_V3| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V8| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_SECURITY_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [User manual](https://opensmarthouse.org/zwavedatabase/1339/reference/RobbShop-SmartPlug_ROB_100-017-0-0.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1339).

84
_addons_bindings/zwave/doc/technisat/03009497_0_0.md
View File

@ -95,7 +95,7 @@ The following state translation is provided for this channel to the ```Switch```
## Device Configuration
The following table provides a summary of the 4 configuration parameters available in the 0300/9497.
The following table provides a summary of the 7 configuration parameters available in the 0300/9497.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
@ -103,12 +103,17 @@ Detailed information on each parameter can be found in the sections below.
| 1 | Central scene notification | Enable/Disable Central scene notifcations for 2x-5x press |
| 2 | Wattage meter | Interval Current wattage meter report in 10s |
| 3 | Energy meter report | Interval of active energy meter report in minutes |
| 4 | Manual shutter calibration | Function of switch position T1 (up) and T2 (down) |
| 4 | Operation mode of T1 and T2 | Function of switch position T1 (up) and T2 (down) |
| 5 | Extension connector switch type | Configuration of switch type connected to extension connector S |
| 6 | Extension connector central scenes | Central Scene mapping of extension input S |
| 7 | Dimming curve selection | Select Dimming curve selection |
### Parameter 1: Central scene notification
Enable/Disable Central scene notifcations for 2x-5x press
0 - disable, 1 - enable
**** - disable, 
**1** - enable
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
@ -143,17 +148,76 @@ The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_3_2``` and is of type ```INTEGER```.
### Parameter 4: Manual shutter calibration
### Parameter 4: Operation mode of T1 and T2
Function of switch position T1 (up) and T2 (down)
Manual shutter calibration (shutter will move up, down and up again)
**** -T1 turns output L1 on, T2 turn output L1 off
0 - idle, 1 - start a manual shutter calibration
**1** - T1 and T2 toggle output L1
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | T1 turns output L1 on, T2 turn output L1 off |
| 1 | T1 and T2 toggle output L1 |
The manufacturer defined default value is ```0``` (T1 turns output L1 on, T2 turn output L1 off).
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Extension connector switch type
Configuration of switch type connected to extension connector S
**0 **- a toggle switch type is connected to extension connector S
**1 **- a push button switch type is connected to extension connector SThis is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | a toggle switch type is connected to extension connector S |
| 1 | a push button switch type is connected to extension connector S |
The manufacturer defined default value is ```0``` ( a toggle switch type is connected to extension connector S).
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Extension connector central scenes
Central Scene mapping of extension input S
**1 - **map extension input S to central scene of T1
**2**: map extension input S to central scene of T2
**3**: map extension input S to own central sceneThis is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 1 to 3 -:
| Value | Description |
|--------|-------------|
| 1 | map extension input S to central scene of T1 |
| 2 | map extension input S to central scene of T2 |
| 3 | map extension input S to own central scene |
The manufacturer defined default value is ```1``` (map extension input S to central scene of T1).
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Parameter 7: Dimming curve selection
Select Dimming curve selection
**** - select dimming curve 1
**1** - select dimming curve 2This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
## Association Groups
@ -165,6 +229,7 @@ The 0300/9497 supports 2 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
The lifeline group reports the device's status.
- Device Reset Locally Notification
- Central Scene notification
- Meter Report
@ -173,9 +238,10 @@ The Lifeline association group reports device status to a hub and is not designe
Association group 1 supports 1 node.
### Group 2: Switch State
### Group 2: Basic SET
- Basic Set
Sends basic set commands to associated devices, according to the current state of the device.
Z-Wave devices control other Z-Wave devices. The relationship between one device controlling another device is called association. In order to control a different device, the controlling device needs to maintain a list of devices that will receive controlling commands. These lists are called association groups and they are always related to certain events (e.g. button pressed, sensor triggers, ...). In case the event happens all devices stored in the respective association group will receive the same wireless command wireless command, typically a 'Basic Set' Command.
Association group 2 supports 10 nodes.

12
_addons_bindings/zwave/doc/zooz/zen30_0_0.md
View File

@ -268,7 +268,7 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG
Auto Turn-Off Timer for Dimmer
Use this parameter to set the time after which you want the dimmer to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -283,7 +283,7 @@ This parameter has the configuration ID ```config_8_4``` and is of type ```INTEG
Auto Turn-On Timer for Dimmer
Use this parameter to set the time after which you want the dimmer to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -298,7 +298,7 @@ This parameter has the configuration ID ```config_9_4``` and is of type ```INTEG
Auto Turn-Off Timer for Relay
Use this parameter to set the time after which you want the relay to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -313,7 +313,7 @@ This parameter has the configuration ID ```config_10_4``` and is of type ```INTE
Auto Turn-On Timer for Relay
Use this parameter to set the time after which you want the relay to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -351,7 +351,7 @@ This parameter has the configuration ID ```config_12_1``` and is of type ```INTE
Ramp Rate Control for Dimmer
Adjust the ramp rate for the dimmer (fade-in / fade-out effect for ON/OFF operation). Values correspond to the number of seconds it takes for the dimmer to reach full brightness or turn OFF when operated manually.
The following option values may be configured, in addition to values in the range 0 to 99 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -486,7 +486,7 @@ This parameter has the configuration ID ```config_22_1``` and is of type ```INTE
Default Brightness Level ON for Dimmer
Set custom brightness level (in %) for the dimmer to come on to at single tap
The following option values may be configured, in addition to values in the range 0 to 99 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

371
_addons_bindings/zwave/doc/zooz/zen71_0_0.md Normal file
View File

@ -0,0 +1,371 @@
---
layout: documentation
title: ZEN71 - ZWave
---
{% include base.html %}
# ZEN71 Paddle Switch (On/Off)
This describes the Z-Wave device *ZEN71*, manufactured by *[Zooz](http://www.getzooz.com/)* with the thing type UID of ```zooz_zen71_00_000```.
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![ZEN71 product image](https://opensmarthouse.org/zwavedatabase/1340/image/)
The ZEN71 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
Z-Wave on/off paddle switch, 700 series, operating in compatibility mode.
### Inclusion Information
1.  Put hub in inclusion mode
2.  Tap UP three (3) times
### Exclusion Information
1.  Bring hub close to switch, if possible
2.  Put hub in exclusion mode
3.  Tap DOWN three (3) times
### General Usage Information
**MANUAL CONTROL**
**Upper Paddle:**
1 x tap: load on; Scene 1, attribute 00
2 x tap: Scene 1, attribute 03
3 x tap: enter inclusion (pairing) mode (only if the switch is not included to the hub); Scene 1, attribute 04
4 x tap: Scene 1, attribute 05
5 x tap: Scene 1, attribute 06
6 x tap: change LED indicator mode (see parameter 2)
held: Scene 1, attribute 01
released: Scene 1, attribute 02
**Lower Paddle:**
1 x tap: load off; Scene 2, attribute 00
2 x tap: Scene 2, attribute 03
3 x tap: enter exclusion (unpairing) mode; Scene 2, attribute 04
4 x tap: Scene 2, attribute 05
5 x tap: Scene 2, attribute 06
held: Scene 2, attribute 01
released: Scene 2, attribute 02
held for 10 seconds (LED indicator starts blinking): enter the setting menu >> 5 x tap down for factory reset; 5 x tap up to change LED bulb mode (see parameter 11); 2 x tap down to enable the range test tool.
All ZEN71 switches can be updated via OTA firmware updates, here is how to do that. You can request a firmware update file here, please include your **order number** for verification!
## Channels
The following table summarises the channels available for the ZEN71 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Scene Number | scene_number | scene_number | | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -:
| Event ID | Event Description |
|----------|--------------------|
| 0 | Single key press |
| 1 | Key released |
| 2 | Key held down |
| 3 | Double keypress |
| 4 | Tripple keypress |
| 5 | 4 x keypress |
| 6 | 5 x keypress |
## Device Configuration
The following table provides a summary of the 11 configuration parameters available in the ZEN71.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | On/Off Paddle Orientation | Reverse default on/off operation or set to toggle mode |
| 2 | LED Indicator Control | Adjust LED function |
| 3 | Auto Turn-Off Timer | How long the switch remains on |
| 5 | Auto Turn-On Timer | How long the switch remains off |
| 8 | On Off Status After Power Failure | How switch reacts to power failures |
| 9 | Enable/Disable Scene Control | Whether scene control functionality is enabled |
| 11 | Smart Bulb Mode: Enable/Disable Paddle | Allow or disallow local control (paddle) |
| 12 | 3-Way Switch Type | Two options for type of 3-way switch |
| 13 | Reporting Behavior for Parameter 11 | Set reporting behavior for disabled physical control |
| 15 | LED Brightness Level | How bright the LED is |
| 16 | Association Reports | How the switch reports paddle control |
### Parameter 1: On/Off Paddle Orientation
Reverse default on/off operation or set to toggle mode
Choose if you want the upper paddle to turn the light on or turn the light off when tapped.
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Upper paddle turns the light on, lower paddle turns it off (default) |
| 1 | Upper paddle turns the light off, lower paddle turns it on |
| 2 | Any paddle turns light on/off |
The manufacturer defined default value is ```0``` (Upper paddle turns the light on, lower paddle turns it off (default)).
This parameter has the configuration ID ```config_1_0``` and is of type ```INTEGER```.
### Parameter 2: LED Indicator Control
Adjust LED function
Choose if you want the LED indicator to turn on when the switch (light) is on or off, or if you want it to remain on or off at all times.
NOTE: tap the upper paddle 6 times quickly to change this mode.
The following option values may be configured, in addition to values in the range 0 to 3 -:
| Value | Description |
|--------|-------------|
| 0 | LED indicator is on when switch is off, LED indicator is off when swit |
| 1 | LED indicator is on when switch is on, LED indicator is off when switc |
| 2 | LED indicator is always OFF |
| 3 | LED indicator is always ON |
The manufacturer defined default value is ```0``` (LED indicator is on when switch is off, LED indicator is off when swit).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Auto Turn-Off Timer
How long the switch remains on
Use this parameter to enable or disable the auto turn-off timer function (the time after which you want the switch to automatically turn off once it has been turned on).
Values other than 0, up to 65535, are the timer length, in minutes.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_3_4``` and is of type ```INTEGER```.
### Parameter 5: Auto Turn-On Timer
How long the switch remains off
Use this parameter to enable or disable the auto turn-on timer function (the time after which you want the switch to automatically turn on once it has been turned off).
Values other than 0, up to 65535, are the timer length, in minutes.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_5_4``` and is of type ```INTEGER```.
### Parameter 8: On Off Status After Power Failure
How switch reacts to power failures
Set the on off status for the switch after power failure.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Forced to OFF (regardless of state prior to power outage) |
| 1 | Forced to ON (regardless of state prior to power outage) |
| 2 | Remembers and restores on/off status after power failure (default) |
The manufacturer defined default value is ```2``` (Remembers and restores on/off status after power failure (default)).
This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```.
### Parameter 9: Enable/Disable Scene Control
Whether scene control functionality is enabled
Enable or disable scene control functionality for quick double tap triggers.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Scene control disabled (default) |
| 1 | Scene control enabled |
The manufacturer defined default value is ```0``` (Scene control disabled (default)).
This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```.
### Parameter 11: Smart Bulb Mode: Enable/Disable Paddle
Allow or disallow local control (paddle)
Enable or disable local on/off control. If enabled, you’ll only be able to control the connected light via Z-Wave. Scenes and other functionality will still be available through paddles.
NOTE: tap the upper paddle 10 times quickly to change this mode. NOTE: hold the lower paddle for 10 seconds until the LED indicator starts blinking, then within 2 seconds, tap the upper paddle 5 times quickly to change this mode. The LED indicator will stay solid green for 3 seconds to confirm the change.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Physical paddle control disabled |
| 1 | Physical paddle control enabled (default) |
| 2 | Physical paddle and Z-Wave control disabled |
The manufacturer defined default value is ```1``` (Physical paddle control enabled (default)).
This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```.
### Parameter 12: 3-Way Switch Type
Two options for type of 3-way switch
Choose the type of 3-way switch you want to use with this switch in a 3-way set-up.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Regular mechanical 3-way on/off switch (default) |
| 1 | Momentary switch, click once to change status (light on or off) |
The manufacturer defined default value is ```0``` (Regular mechanical 3-way on/off switch (default)).
This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```.
### Parameter 13: Reporting Behavior for Parameter 11
Set reporting behavior for disabled physical control
Whether to ignore status and not change LED state when physical control (11) disabled.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Switch always reports status and changes LED state (default) |
| 1 | No status or LED state change when physical control disabled |
The manufacturer defined default value is ```0``` (Switch always reports status and changes LED state (default)).
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 15: LED Brightness Level
How bright the LED is
Choose the LED indicator's brightness level.
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Bright (100%) |
| 1 | Medium (60%) (default) |
| 2 | Low (30%) |
The manufacturer defined default value is ```1``` (Medium (60%) (default)).
This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```.
### Parameter 16: Association Reports
How the switch reports paddle control
Choose how the switch reports its status back to the hub.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Z-Wave control = binary; paddle control = basic set |
| 1 | Z-Wave control and paddle control = binary |
The manufacturer defined default value is ```1``` (Z-Wave control and paddle control = binary).
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The ZEN71 supports 1 association group.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Association group 1 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_INDICATOR_V3| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [Device manual for ZEN21, substantially similar; electronic version of ZEN71 manual not yet available (2021-01-10)](https://opensmarthouse.org/zwavedatabase/1340/reference/zooz-z-wave-plus-on-off-switch-zen21-ver3-manual.pdf)
* [Config Parameters](https://opensmarthouse.org/zwavedatabase/1340/reference/ZEN71_On_Off_Switch_700_Advanced_Settings.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1340).

9
_addons_ios/alexa-skill/readme.md
View File

@ -1,7 +1,7 @@
---
layout: documentation
title: Amazon Alexa Smart Home Skill
source: https://github.com/openhab/openhab-alexa/blob/master/USAGE.md
source: https://github.com/openhab/openhab-alexa/blob/main/USAGE.md
description: "Alexa is an intelligent personal assistant developed by Amazon and designed to run on smart speakers and devices such as the Amazon Echo and Dot."
---
@ -68,7 +68,12 @@ The skill connects your openHAB setup through the [myopenHAB.org](http://myopenH
## Requirements
* [openHAB Cloud Connector](https://www.openhab.org/addons/integrations/openhabcloud/) configured using myopenHAB.org
::: tip
This integration relies on the cloud connector addon.
More information can be found in the corresponding [docs page](https://www.openhab.org/link/openhabcloud).
:::
* openHAB Cloud Connector configured using myopenHAB.org
* Amazon account
* Amazon Echo, Amazon Echo Dot or compatible Alexa device

BIN
_addons_ios/openhabcloud/contrib/doc/cfg.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 60 KiB

8
_addons_ios/openhabcloud/readme.md
View File

@ -25,6 +25,12 @@ The openHAB Cloud service (and thus the connector to it) is useful for different
* It serves as a connector to Google Cloud Messaging (GCM) and Apple Push Notifications (APN) for pushing notifications to mobile phone apps.
* It brings integration possibilities with services that require an OAuth2 authentication against a web server, such as IFTTT or Amazon Alexa Skills.
## Installation via UI
* Open the openHAB web portal and login as an administrator.
* Click on Settings, followed by Misc (in the Add-ons section)
* Using the + button on the bottom right you can install the openHAB Cloud Add-on
## UUID and Secret
To authenticate with the openHAB Cloud service the add-on generates two values when the add-on is installed.
@ -45,7 +51,7 @@ Location of UUID and Secret:
## Configuration
After installing this add-on, you will find configuration options in the Paper UI under _Configuration->Services->IO->openHAB Cloud_:
After installing this add-on, you will find configuration options in the openHAB portal under _Settings -> Other Services -> openHAB Cloud_:
![Configuration](contrib/doc/cfg.png)

2
_addons_persistences/influxdb/readme.md
View File

@ -52,6 +52,8 @@ This is very easy and you will find good documentation on it on the
## Configuration
This service can be configured in the file `services/influxdb.cfg`.
| Property | Default | Required | Description |
|------------------------------------|-------------------------|----------|------------------------------------------|
| version | V1 | No | InfluxDB database version V1 for 1.X and V2 for 2.x|

3
_addons_transformations/map/readme.md
View File

@ -14,7 +14,8 @@ install: auto
# Map Transformation Service
Transforms the input by mapping it to another string. It expects the mappings to be read from a file which is stored under the `transform` folder.
Transforms the input by mapping it to another string. It expects the mappings to be read from a file which is stored under the `transform` folder.
The file name must have the `.map` extension.
This file should be in property syntax, i.e. simple lines with "key=value" pairs.
The file format is documented [here](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html#load-java.io.Reader-).

284
_addons_uis/habpanel/doc/habpanel.md Normal file
View File

@ -0,0 +1,284 @@
---
layout: documentation
title: HABPanel
source: https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui.habpanel/doc/habpanel.md
---
{% include base.html %}
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
# Designing dashboard interfaces with HABPanel
The [HABPanel]({{base}}/addons/ui/habpanel/readme.html) user interface is installed by default when choosing any initial setup package, and allows the creation of user-friendly dashboards, particularly suited for (e.g. wall-mounted) tablets. These dashboards can be designed interactively in the embedded designer, rather than using configuration files.
Despite being similar, HABPanel's dashboards and [sitemaps]({{base}}/configuration/sitemaps.html) are separate concepts, and can be designed independently as they aren't related to each other; however, they rely and act on [items]({{base}}/concepts/items.html) which must therefore be [defined]({{base}}/configuration/items.html) first. The [demo setup package]({{base}}/configuration/packages.html#demo-package-sample-setup), available for installation when starting openHAB for the first time, defines a series of sample items and configures HABPanel with a comprehensive set of dashboards to showcase a possible end result. It's the same as the one installed on the [openHAB Demo Server](https://demo.openhab.org/){:target="_blank"}, and it may be modified without risk of breaking anything: it's the best playground to discover HABPanel's features.
## Concepts
HABPanel has its own terminology of entities presented below:
![HABPanel concepts](images/habpanel_concepts.png)
- The **Panel Registry** is the central storage used by HABPanel on a given openHAB instance, it contains several **Panel Configurations**;
- A **Panel Configuration** is a container holding a **Panel** along with its **Settings** and the definition of **Custom Widgets**. Each device HABPanel runs on (desktop browser, tablet...) has an active panel configuration and displays the panel associated with it;
- A **Panel** is a set of **Dashboards** (or pages) which can be presented to end users, who can also easily switch between them using the menu.
- A **Dashboard** is comprised of discrete **Widgets** positioned on the dashboard's surface at design time. There are several types of built-in *standard widgets*, configured separately, and the administrator can also develop (or import) *custom widgets*.
## About data persistence
By default, when running HABPanel on a new browser or device, a tutorial will be displayed allowing the user to start from scratch, or switch to an previously defined panel configuration. **Until a panel configuration is created (or chosen), HABPanel will run in "local storage" mode for this device: the settings will be retained in the browser's local storage only and nothing will be persisted on the server.** By contrast, when an active panel configuration is set, each change performed on the device will update the panel configuration on the server. This allows the sharing of panel configuration among devices, because other browsers and devices using this panel configuration will pick up the changes with a page refresh - this is useful for instance to design a panel comfortably on a computer, then use it on a tablet.
To switch from the local storage to a server-hosted panel configuration, go to the Settings page from the main menu or the side drawer (see below). A list of panel configurations will be presented in the _Current storage configuration_ section; if only the _"Local storage"_ option is available, click on the **Save the current configuration to a new panel configuration** link, give it a name to identify it (avoid spaces or special characters), and it should be added to the list. The radio button is also automatically checked, meaning it is now the active panel configuration.
Even when there is an active panel configuration, HABPanel uses the browser's storage to sync a locally-managed copy. With the **Edit the local panel configuration (experts only)** link under the _"Local storage"_ storage configuration option in the settings screen, the raw structure of the panel configuration can be inspected, modified, and exported or imported from/to a .json file. It is also an alternative way to backup, restore and share the configuration.
HABPanel uses service configuration variables to store its data on the openHAB server. They can be accessed using Paper UI (_Configuration > Services > UI > HABPanel > Configure_) or in the openHAB Karaf console:
```
openhab> config:edit org.openhab.habpanel
openhab> config:property-get <property>
```
The following properties are defined:
- `panelsRegistry`: contains the entire registry serialized in JSON, it is maintained by the application and shouldn't be modified directly (editing it by hand, while possible, is strongly discouraged);
- `lockEditing`: when enabled, all HABPanel instances will hide their editing features (a page refresh is necessary). When panels are complete and stable, it is advisable to turn on this setting so they cannot be easily modified by end users;
- `initialPanelConfig`: if this option is unset and no prior local configuration is detected, the tutorial will be displayed until some dashboards are added or a panel configuration is selected. This setting allows to bypass the tutorial and switch directly to the existing panel configuration with the given name.
## Major interface elements and features
### The main menu
The main menu is HABPanel's home page. It contains tiles linking to the panel's dashboards, and an icon to switch between the run mode and the edit mode (if available).
![Main menu - run mode](images/habpanel_main-menu-run.png)
Use the gears icon in the top-right corner to switch between the two modes.
![Main menu - edit mode](images/habpanel_main-menu-edit.png)
When in edit mode, several features are available:
* Add a new empty dashboard with the **Add new dashboard** link;
* Go to the settings screen (for instance, to switch from local storage to a server-managed panel configuration) by clicking on the **Advanced settings** link;
* Adjust the number of columns for the grid of main menu tiles with the slider, from 1 (the default) to 6;
* Drag the arrow icons in the top-left corner of each tile to move it;
* Resize tiles with the chevron (triangle) in the bottom-right corner of each tile;
* Configure the tiles and the dashboards themselves with the gears icons in the top-right corner of each tile;
* Enter the dashboard designer by clicking inside a tile.
The configuration dialog when clicking on a tile's gear icon contains the following settings:
| Setting | Description
|---------|-------------|
| Name | The name of the dashboard, also displayed on the tile
| Background URL | The URL of a background image *for the main menu tile*
| Backdrop Icon | Iconset and icon displayed on the tile as a Backdrop
| Center backdrop horizontally | When unchecked, the backdrop is aligned to the right of the tile; when checked, it is centered
| Icon | Icon associated with the dashboard, currently only used in the side drawer
| Size (icon) | _(currently unused)_
| Title Text Color | Color for the name of the dashboard on the tile
| Advanced tab | Contains settings currently unstable or unsupported, for advanced users only
| Custom widgets tab | This [experimental feature](https://community.openhab.org/t/new-display-options-incl-experimental-custom-widgets-everywhere/34140/1) allows certain parts of a dashboard to be replaced by a custom widget (see _Custom Widgets_ below): the main menu tile, the drawer menu and the dashboard item - use with caution
It also contains a **Delete** button which will delete the entire dashboard and its contents - this happens immediately and cannot be undone!
### The side drawer
![Side drawer](images/habpanel_side-drawer.png)
The side drawer can be accessed from any screen by a swipe or drag to the right (on most elements where there isn't a conflict with this gesture), or with the "hamburger icon" ☰ in the top-left corner.
It is comprised of three parts:
1. A **header** - clicking on it returns to the main menu. Note: if defined, the title of the panel is displayed instead of the default "HABPanel" label, it is configured in the settings (see below);
2. A **list of dashboards** for quick switching between dashboards without going back to the main menu - they are presented in the order of the menu (sorted by row, then by column);
3. A **footer** displaying the current date & time and featuring a link to the settings screen (if available).
### The dashboard designer
![Dashboard designer](images/habpanel_dashboard-designer.png)
The dashboard designer is where widgets can be added, positioned, resized and configured. Placeholders are displayed where actual widgets would be on the running dashboard.
To add a widget, use the **Add widget** button and choose among the list of standard widgets, or eventual custom widgets in the panel configuration.
See below for a description of the standard widgets.
![Add widget menu](images/habpanel_add-widget.png)
Use the header of a widget placeholder (with the four-arrow icon and the widget type) to move the widget. Moving a widget over other widgets do not push them away to make room (contrary to the main menu tiles), so ensure there is sufficient room for your widget before moving it.
![Widget placeholder features](images/habpanel_dashboard-designer-placeholder-menu.png)
When hovering over a placeholder (or tapping inside it if on a touch interface), a chevron appears in the bottom-right corner allowing to resize it.
Use the ellipsis icon **⁝** to bring up the widget's contextual menu, offering the following options:
- **Edit...:** Displays the configuration dialog for the widget. The options available in the dialog depend on the type of the widget and are detailed in the Widgets section;
- **Copy/move to...**: Displays a dialog allowing to clone the widget with its configuration, to the current dashboard or another, or move it to another dashboard (the target widget will retain its size of the source widget but it will be placed where there is available room, use the target dashboard's designer to find it and reposition it);
- **Delete**: Deletes the widget.
Modifications to the dashboard are not saved automatically, use the **Save** button in the header to commit the changes to the panel configuration (or local storage). The **Run** button also saves, then runs the dashboard.
### Running dashboards
![A running dashboard](images/habpanel_running-dashboard.png)
When a dashboard is running, widgets can be interacted with, and server-sent events are received when items' states are updated, so widgets update automatically in HABPanel.
The icons in the top-right corner perform the following:
- the **speech balloon** activates the speech recognition feature and send the results as text to openHAB's default human language interpreter. This implies [some configuration on the server]({{base}}/configuration/multimedia.html#human-language-interpreter), and this icon might not be displayed if the browser doesn't support voice recognition ([mainly only in Chrome and other webkit variants currently](http://caniuse.com/#feat=speech-recognition){:target="_blank"}). It can also be configured in the panel configuration to appear on the bottom of the screen;
- the **refresh** button forces HABPanel to retrieve the current state of all items;
- the **fullscreen** button tells the browser to go fullscreen, if supported.
Tip: while running a dasboard, append `?kiosk=on` to the URL in the web browser to switch to "kiosk mode"; in this mode, the header, hamburger menu and toolbar will be hidden and the side drawer will be disabled - therefore there will be no easy way for an end user to switch to another screen (except with button widgets configured for that purpose). This mode is useful to display a full-screen, bare-bones UI for a fixed tablet.
## Additional features and settings
Apart from the storage configuration discussed above, the settings screen contains several settings kept as part of the panel configuration (meaning they are set separately):
| Setting | Description
|---------|-------------|
| Panel name | An user-friendly name for the panel. It will be displayed in the header of the side drawer.
| Theme | HABPanel comes with a number of built-in themes, with this setting a different theme may applied to the panel. Themes are not user-modifiable.
| Background image | Sets the specified URL as background image for the whole panel. *Tip: the background image works best with the 'translucent' theme!*
| Additional stylesheet | Reference the relative URL of an additional CSS file which will be included and can be used to override the styles defined by the theme. For additional information on how you can customize HABPanel's styles, go to: [HABPanel Development & Advanced Features: Start Here!](https://community.openhab.org/t/habpanel-development-advanced-features-start-here/30755/1)
| Drawer heading image | Reference the URL of an image (expected width: 265 pixels) which will replace the header in the side drawer
| Hide the drawer's footer | Check to remove the bottom black part of the side drawer containing the date & time
| Hide toolbar buttons (speak/refresh/fullscreen) | Check those boxes to hide the corresponding button in the default dashboard header top-right corner
| Show a clock in the header | If checked, a clock will be displayed in the main menu and the dashboards
| Header clock format (shown if "Show a clock in the header" is checked) | Use an [AngularJS' date filter format string](https://docs.angularjs.org/api/ng/filter/date) to customize the clock format in the header. The default is `HH:mm`
| Prevent scrolling (when not editing) | When enabled, it is impossible to scroll the dashboard on a tablet (and it prevents the "elastic" bouncing effect on iOS/Safari)
| Manage > (custom widgets) | Goes to the list of custom widget definitions for the active panel configuration
| Voice | Selects a voice from the detected list for text-to-speech*
| Speak the new value of the following item when it changes | When the selected String item change to a new text, HABPanel will use the browser's text-to-speech engine and the selected voice to read it aloud*
| Display a floating speech button at the bottom of the screen | Use an alternative style for the Speak (voice input) button in dashboards
| When this item changes to a dashboard's name, switch to it | This allows controlling the currently displayed dashboard by an openHAB item (useful with rules and as a side-effect to commands)
*Note: the text-to-speech functionality featured in HABPanel is unrelated to the [TTS services]({{base}}/configuration/multimedia.html#text-to-speech) defined on the openHAB server, and they are not compatible (this is why a String item is required and the `say()` function cannot be used). However, HABPanel will play audio streamed through the ['webaudio' sink]({{base}}/configuration/multimedia.html#audio), including spoken text.
## Widgets
### Standard widgets
The following built-in widgets are available:
#### Dummy (dummy)
![Dummy widget](images/habpanel_widget-dummy.png)
The so-called dummy widget (whose name is explained by historical reasons - it evolved from the first developed widget) displays the current state of an item without any interactivity, along with a label and an optional icon.
#### Switch (switch)
![Switch widget](images/habpanel_widget-switch.png)
The switch widget is a simple widget to control a Switch item as defined in openHAB - it reports its state and is able to toggle it between ON and OFF.
#### Label (label)
![Label widget](images/habpanel_widget-label.png)
The label widget is straightforward: it simply displays a fixed text and has a few appeareance options (color, font). It can for example be used as a header for a group of widgets below it.
#### Button (button)
![Button widget](images/habpanel_widget-button.png)
The button widget can be clicked (or tapped) and will perform an action, like sending commands to an item or navigating to another dashboard. It can also adjust its colors depending on the state of the underlying item.
Multiple buttons are often used together to present different options for an item.
#### Slider (slider)
![Slider widget](images/habpanel_widget-slider.png)
The slider widget can reflect the state of, and update, numerical items within a range of values. Several options are available to alter its appearance and behavior.
#### Knob (knob)
![Knob widget](images/habpanel_widget-knob.png)
The knob widget is similar in essence to the slider, but in a rotary fashion. It also offers extensive configurability over its appearance and behavior.
#### Selection (selection)
![Selection widget](images/habpanel_widget-selection.png)
The selection widget displays the current state of an item, much like a dummy widget, except it opens a menu or a grid of automatically or manually configured choices for sending commands to this item. Various display options are available.
#### Color picker (colorpicker)
![Color picker widget](images/habpanel_widget-colorpicker.png)
The color picker widget offers several ways of displaying and updating the state of an openHAB Color item (or group).
#### Image (image)
![Image widget](images/habpanel_widget-image.png)
The image widget can display an image, directly or via an openHAB String item, and can refresh it at regular intervals.
#### Frame (frame)
![Frame widget](images/habpanel_widget-frame.png)
The frame widget displays an external web page in a HTML `<iframe>`.
#### Clock (clock)
![Clock widget](images/habpanel_widget-clock.png)
The clock widget displays an analog or digital clock. It can also be used to display the current date.
#### Chart (chart)
![Chart widget](images/habpanel_widget-chart.png)
The chart widget can leverage openHAB persistence services to plot numerical series over a time period. It can also display server-generated chart images (default or rrd4j variants).
#### Timeline (timeline)
![Timeline widget](images/habpanel_widget-timeline.png)
The timeline widget is the chart widget's counterpart for non-numerical items. It can display multiple "swimlanes" of items with color-coded slices representing their state changes during the selected period. Hovering or tapping inside a color slice displays details on the state of the item at the time.
#### Template (template)
The template widget allows an user-configured AngularJS HTML template to be rendered and hosted inside the widget boundaries; it exposes several helper functions and other facilities to retrieve and update openHAB's items from the template's markup.
With only a few web development skills required, you can easily start developing your own widgets and share them to community. It is nonetheless rather complex, so the best information has been compiled in this community wiki topic: [HABPanel Development & Advanced Features: Start Here!](https://community.openhab.org/t/habpanel-development-advanced-features-start-here/30755). You can also [learn by example in the forum's HABPanel category](https://community.openhab.org/c/apps-services/habpanel) or seek the help of the community.
Templates are defined inline, for each particular instance, and thus are not optimized for sharing and re-use. For those cases, developing a _custom widget_ is more appropriate.
### Custom widgets
Custom widgets are similar to (and based on) the template widget but are designed to be reused, shared, and configured. A custom widget is an AngularJS template with an associated set of configuration settings. It can be added to dashboards and configured individually, like a built-in widget. Definitions of custom widgets are stored in the registry at the panel configuration level; this means they are specific to a panel configuration and each panel configuration has its own custom widgets (see the _Concepts_ section above).
For more information, please read the [community thread about this feature](https://community.openhab.org/t/custom-widgets-feature-walkthrough/16670/1).
#### Managing custom widgets
The list of custom widgets either via the dashboard designer (click/tap the gears icon in the _Add Widget_ dropdown menu), or with the _Manage_ button in the settings screen.
From the list, custom widgets can be created from scratch, or imported from a previously exported .json file or a GitHub repository. Members of the openHAB community also present their custom widgets on the forum: the _Get widgets from the openHAB community_ link brings up a filtered lists of custom widgets from the community.
Widgets can also come from [an openHAB addon or OSGi bundle](https://community.openhab.org/t/new-feature-globally-provisioned-widgets-i-e-with-osgi-bundles/26994): those are "globally-provisioned widgets". They cannot be modified or deleted (but can be cloned and then modified), and are available to all panel configurations.
The context menu **⁝** can be used to perform operations on the widget: globally-provisioned widgets can only be cloned, and manually defined or imported widgets can be exported or deleted. Widgets imported from GitHub can also be updated and include a link to repository's Readme file.
#### The widget designer
Upon clicking on a custom widget definition, the widget designer opens. It contains three tabs:
- **Code:** This tab is an editor for the template's code. You can use the Ctrl-S (or Cmd-S) keyboard shortcut to save the widget while editing the code;
- **Settings:** This tab hosts the widget's general settings and configuration settings structure to be defined.
Click on the **Add setting** to add a new configuration setting. Each configuration setting must have a type, a technical ID, and other optional attributes. Each type of setting determines the UI element presented in the dashboard designer when configuring instances of the custom widget.
Use the arrow buttons to move configuration settings up or down, and the trash bin icon to remove them.
When instantiated, the value of configuration settings are set in the template's scope as `config.<setting_id>` (except those of type Icon which define an additional value, the iconset name, as `config.<setting_id>_iconset`);
- **Preview:** Upon switching to this tab, a test instance of the widget is rendered in an otherwise blank testbed dashboard. Use the sliders to resize the widget in order to preview it at different sizes. If it defines configuration settings, they must likely be set for this preview using the gears icon: this will bring up the widget instance's configuration dialog as it would appear in the dashboard designer.
Don't forget to save the changes with the **Save** button.

396
_thing_types/org.openhab.binding.androiddebugbridge/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,396 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="androiddebugbridge"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="android">
<label>Android Device Thing</label>
<description>Android Device Thing for Android Debug Bridge Binding</description>
<channels>
<channel id="key-event" typeId="key-event-channel"/>
<channel id="text" typeId="text-channel"/>
<channel id="media-volume" typeId="system.volume"/>
<channel id="media-control" typeId="system.media-control"/>
<channel id="start-package" typeId="start-package-channel"/>
<channel id="stop-package" typeId="stop-package-channel"/>
<channel id="stop-current-package" typeId="stop-current-package-channel"/>
<channel id="current-package" typeId="current-package-channel"/>
<channel id="wake-lock" typeId="wake-lock-channel"/>
<channel id="screen-state" typeId="screen-state-channel"/>
</channels>
<representation-property>serial</representation-property>
<config-description>
<parameter name="ip" type="text" required="true">
<context>network-address</context>
<label>IP Address</label>
<description>Device ip address.</description>
</parameter>
<parameter name="port" type="integer" required="true" min="0" max="65535">
<label>Port</label>
<description>Device port listening to adb connections.</description>
<default>5555</default>
</parameter>
<parameter name="refreshTime" type="integer" min="10" max="120" unit="s" required="true">
<label>Refresh Time</label>
<description>Seconds between device status refreshes.</description>
<default>30</default>
</parameter>
<parameter name="timeout" type="integer" min="1" max="15" unit="s" required="true">
<label>Command Timeout</label>
<description>Command timeout seconds.</description>
<default>5</default>
</parameter>
<parameter name="mediaStateJSONConfig" type="text">
<label>Media State Config</label>
<description>JSON config that allows to modify the media state detection strategy for each app. Refer to the binding
documentation.</description>
</parameter>
</config-description>
</thing-type>
<channel-type id="key-event-channel">
<item-type>String</item-type>
<label>Send Key Event</label>
<description>Send key event to android device</description>
<state>
<options>
<option value="7">KEYCODE_0</option>
<option value="8">KEYCODE_1</option>
<option value="227">KEYCODE_11</option>
<option value="228">KEYCODE_12</option>
<option value="9">KEYCODE_2</option>
<option value="10">KEYCODE_3</option>
<option value="206">KEYCODE_3D_MODE</option>
<option value="11">KEYCODE_4</option>
<option value="12">KEYCODE_5</option>
<option value="13">KEYCODE_6</option>
<option value="14">KEYCODE_7</option>
<option value="15">KEYCODE_8</option>
<option value="16">KEYCODE_9</option>
<option value="29">KEYCODE_A</option>
<option value="284">KEYCODE_ALL_APPS</option>
<option value="57">KEYCODE_ALT_LEFT</option>
<option value="58">KEYCODE_ALT_RIGHT</option>
<option value="75">KEYCODE_APOSTROPHE</option>
<option value="187">KEYCODE_APP_SWITCH</option>
<option value="219">KEYCODE_ASSIST</option>
<option value="77">KEYCODE_AT</option>
<option value="182">KEYCODE_AVR_INPUT</option>
<option value="181">KEYCODE_AVR_POWER</option>
<option value="30">KEYCODE_B</option>
<option value="4">KEYCODE_BACK</option>
<option value="73">KEYCODE_BACKSLASH</option>
<option value="174">KEYCODE_BOOKMARK</option>
<option value="121">KEYCODE_BREAK</option>
<option value="220">KEYCODE_BRIGHTNESS_DOWN</option>
<option value="221">KEYCODE_BRIGHTNESS_UP</option>
<option value="188">KEYCODE_BUTTON_1</option>
<option value="197">KEYCODE_BUTTON_10</option>
<option value="198">KEYCODE_BUTTON_11</option>
<option value="199">KEYCODE_BUTTON_12</option>
<option value="200">KEYCODE_BUTTON_13</option>
<option value="201">KEYCODE_BUTTON_14</option>
<option value="202">KEYCODE_BUTTON_15</option>
<option value="203">KEYCODE_BUTTON_16</option>
<option value="189">KEYCODE_BUTTON_2</option>
<option value="190">KEYCODE_BUTTON_3</option>
<option value="191">KEYCODE_BUTTON_4</option>
<option value="192">KEYCODE_BUTTON_5</option>
<option value="193">KEYCODE_BUTTON_6</option>
<option value="194">KEYCODE_BUTTON_7</option>
<option value="195">KEYCODE_BUTTON_8</option>
<option value="196">KEYCODE_BUTTON_9</option>
<option value="96">KEYCODE_BUTTON_A</option>
<option value="97">KEYCODE_BUTTON_B</option>
<option value="98">KEYCODE_BUTTON_C</option>
<option value="102">KEYCODE_BUTTON_L1</option>
<option value="104">KEYCODE_BUTTON_L2</option>
<option value="110">KEYCODE_BUTTON_MODE</option>
<option value="103">KEYCODE_BUTTON_R1</option>
<option value="105">KEYCODE_BUTTON_R2</option>
<option value="109">KEYCODE_BUTTON_SELECT</option>
<option value="108">KEYCODE_BUTTON_START</option>
<option value="106">KEYCODE_BUTTON_THUMBL</option>
<option value="107">KEYCODE_BUTTON_THUMBR</option>
<option value="99">KEYCODE_BUTTON_X</option>
<option value="100">KEYCODE_BUTTON_Y</option>
<option value="101">KEYCODE_BUTTON_Z</option>
<option value="31">KEYCODE_C</option>
<option value="210">KEYCODE_CALCULATOR</option>
<option value="208">KEYCODE_CALENDAR</option>
<option value="5">KEYCODE_CALL</option>
<option value="27">KEYCODE_CAMERA</option>
<option value="115">KEYCODE_CAPS_LOCK</option>
<option value="175">KEYCODE_CAPTIONS</option>
<option value="167">KEYCODE_CHANNEL_DOWN</option>
<option value="166">KEYCODE_CHANNEL_UP</option>
<option value="28">KEYCODE_CLEAR</option>
<option value="55">KEYCODE_COMMA</option>
<option value="207">KEYCODE_CONTACTS</option>
<option value="278">KEYCODE_COPY</option>
<option value="113">KEYCODE_CTRL_LEFT</option>
<option value="114">KEYCODE_CTRL_RIGHT</option>
<option value="277">KEYCODE_CUT</option>
<option value="32">KEYCODE_D</option>
<option value="67">KEYCODE_DEL</option>
<option value="23">KEYCODE_DPAD_CENTER</option>
<option value="20">KEYCODE_DPAD_DOWN</option>
<option value="269">KEYCODE_DPAD_DOWN_LEFT</option>
<option value="271">KEYCODE_DPAD_DOWN_RIGHT</option>
<option value="21">KEYCODE_DPAD_LEFT</option>
<option value="22">KEYCODE_DPAD_RIGHT</option>
<option value="19">KEYCODE_DPAD_UP</option>
<option value="268">KEYCODE_DPAD_UP_LEFT</option>
<option value="270">KEYCODE_DPAD_UP_RIGHT</option>
<option value="173">KEYCODE_DVR</option>
<option value="33">KEYCODE_E</option>
<option value="212">KEYCODE_EISU</option>
<option value="6">KEYCODE_ENDCALL</option>
<option value="66">KEYCODE_ENTER</option>
<option value="65">KEYCODE_ENVELOPE</option>
<option value="70">KEYCODE_EQUALS</option>
<option value="111">KEYCODE_ESCAPE</option>
<option value="64">KEYCODE_EXPLORER</option>
<option value="34">KEYCODE_F</option>
<option value="131">KEYCODE_F1</option>
<option value="140">KEYCODE_F10</option>
<option value="141">KEYCODE_F11</option>
<option value="142">KEYCODE_F12</option>
<option value="132">KEYCODE_F2</option>
<option value="133">KEYCODE_F3</option>
<option value="134">KEYCODE_F4</option>
<option value="135">KEYCODE_F5</option>
<option value="136">KEYCODE_F6</option>
<option value="137">KEYCODE_F7</option>
<option value="138">KEYCODE_F8</option>
<option value="139">KEYCODE_F9</option>
<option value="80">KEYCODE_FOCUS</option>
<option value="125">KEYCODE_FORWARD</option>
<option value="112">KEYCODE_FORWARD_DEL</option>
<option value="119">KEYCODE_FUNCTION</option>
<option value="35">KEYCODE_G</option>
<option value="68">KEYCODE_GRAVE</option>
<option value="172">KEYCODE_GUIDE</option>
<option value="36">KEYCODE_H</option>
<option value="79">KEYCODE_HEADSETHOOK</option>
<option value="259">KEYCODE_HELP</option>
<option value="214">KEYCODE_HENKAN</option>
<option value="3">KEYCODE_HOME</option>
<option value="37">KEYCODE_I</option>
<option value="165">KEYCODE_INFO</option>
<option value="124">KEYCODE_INSERT</option>
<option value="38">KEYCODE_J</option>
<option value="39">KEYCODE_K</option>
<option value="218">KEYCODE_KANA</option>
<option value="215">KEYCODE_KATAKANA_HIRAGANA</option>
<option value="40">KEYCODE_L</option>
<option value="204">KEYCODE_LANGUAGE_SWITCH</option>
<option value="229">KEYCODE_LAST_CHANNEL</option>
<option value="71">KEYCODE_LEFT_BRACKET</option>
<option value="41">KEYCODE_M</option>
<option value="205">KEYCODE_MANNER_MODE</option>
<option value="222">KEYCODE_MEDIA_AUDIO_TRACK</option>
<option value="128">KEYCODE_MEDIA_CLOSE</option>
<option value="129">KEYCODE_MEDIA_EJECT</option>
<option value="90">KEYCODE_MEDIA_FAST_FORWARD</option>
<option value="87">KEYCODE_MEDIA_NEXT</option>
<option value="127">KEYCODE_MEDIA_PAUSE</option>
<option value="126">KEYCODE_MEDIA_PLAY</option>
<option value="85">KEYCODE_MEDIA_PLAY_PAUSE</option>
<option value="88">KEYCODE_MEDIA_PREVIOUS</option>
<option value="130">KEYCODE_MEDIA_RECORD</option>
<option value="89">KEYCODE_MEDIA_REWIND</option>
<option value="273">KEYCODE_MEDIA_SKIP_BACKWARD</option>
<option value="272">KEYCODE_MEDIA_SKIP_FORWARD</option>
<option value="275">KEYCODE_MEDIA_STEP_BACKWARD</option>
<option value="274">KEYCODE_MEDIA_STEP_FORWARD</option>
<option value="86">KEYCODE_MEDIA_STOP</option>
<option value="226">KEYCODE_MEDIA_TOP_MENU</option>
<option value="82">KEYCODE_MENU</option>
<option value="117">KEYCODE_META_LEFT</option>
<option value="118">KEYCODE_META_RIGHT</option>
<option value="69">KEYCODE_MINUS</option>
<option value="123">KEYCODE_MOVE_END</option>
<option value="122">KEYCODE_MOVE_HOME</option>
<option value="213">KEYCODE_MUHENKAN</option>
<option value="209">KEYCODE_MUSIC</option>
<option value="91">KEYCODE_MUTE</option>
<option value="42">KEYCODE_N</option>
<option value="262">KEYCODE_NAVIGATE_IN</option>
<option value="261">KEYCODE_NAVIGATE_NEXT</option>
<option value="263">KEYCODE_NAVIGATE_OUT</option>
<option value="260">KEYCODE_NAVIGATE_PREVIOUS</option>
<option value="83">KEYCODE_NOTIFICATION</option>
<option value="78">KEYCODE_NUM</option>
<option value="144">KEYCODE_NUMPAD_0</option>
<option value="145">KEYCODE_NUMPAD_1</option>
<option value="146">KEYCODE_NUMPAD_2</option>
<option value="147">KEYCODE_NUMPAD_3</option>
<option value="148">KEYCODE_NUMPAD_4</option>
<option value="149">KEYCODE_NUMPAD_5</option>
<option value="150">KEYCODE_NUMPAD_6</option>
<option value="151">KEYCODE_NUMPAD_7</option>
<option value="152">KEYCODE_NUMPAD_8</option>
<option value="153">KEYCODE_NUMPAD_9</option>
<option value="157">KEYCODE_NUMPAD_ADD</option>
<option value="159">KEYCODE_NUMPAD_COMMA</option>
<option value="154">KEYCODE_NUMPAD_DIVIDE</option>
<option value="158">KEYCODE_NUMPAD_DOT</option>
<option value="160">KEYCODE_NUMPAD_ENTER</option>
<option value="161">KEYCODE_NUMPAD_EQUALS</option>
<option value="162">KEYCODE_NUMPAD_LEFT_PAREN</option>
<option value="155">KEYCODE_NUMPAD_MULTIPLY</option>
<option value="163">KEYCODE_NUMPAD_RIGHT_PAREN</option>
<option value="156">KEYCODE_NUMPAD_SUBTRACT</option>
<option value="143">KEYCODE_NUM_LOCK</option>
<option value="43">KEYCODE_O</option>
<option value="44">KEYCODE_P</option>
<option value="93">KEYCODE_PAGE_DOWN</option>
<option value="92">KEYCODE_PAGE_UP</option>
<option value="225">KEYCODE_PAIRING</option>
<option value="279">KEYCODE_PASTE</option>
<option value="56">KEYCODE_PERIOD</option>
<option value="94">KEYCODE_PICTSYMBOLS</option>
<option value="81">KEYCODE_PLUS</option>
<option value="18">KEYCODE_POUND</option>
<option value="26">KEYCODE_POWER</option>
<option value="288">KEYCODE_PROFILE_SWITCH</option>
<option value="186">KEYCODE_PROG_BLUE</option>
<option value="184">KEYCODE_PROG_GREEN</option>
<option value="183">KEYCODE_PROG_RED</option>
<option value="185">KEYCODE_PROG_YELLOW</option>
<option value="45">KEYCODE_Q</option>
<option value="46">KEYCODE_R</option>
<option value="285">KEYCODE_REFRESH</option>
<option value="72">KEYCODE_RIGHT_BRACKET</option>
<option value="217">KEYCODE_RO</option>
<option value="47">KEYCODE_S</option>
<option value="116">KEYCODE_SCROLL_LOCK</option>
<option value="84">KEYCODE_SEARCH</option>
<option value="74">KEYCODE_SEMICOLON</option>
<option value="176">KEYCODE_SETTINGS</option>
<option value="59">KEYCODE_SHIFT_LEFT</option>
<option value="60">KEYCODE_SHIFT_RIGHT</option>
<option value="76">KEYCODE_SLASH</option>
<option value="223">KEYCODE_SLEEP</option>
<option value="1">KEYCODE_SOFT_LEFT</option>
<option value="2">KEYCODE_SOFT_RIGHT</option>
<option value="276">KEYCODE_SOFT_SLEEP</option>
<option value="62">KEYCODE_SPACE</option>
<option value="17">KEYCODE_STAR</option>
<option value="180">KEYCODE_STB_INPUT</option>
<option value="179">KEYCODE_STB_POWER</option>
<option value="265">KEYCODE_STEM_1</option>
<option value="266">KEYCODE_STEM_2</option>
<option value="267">KEYCODE_STEM_3</option>
<option value="264">KEYCODE_STEM_PRIMARY</option>
<option value="95">KEYCODE_SWITCH_CHARSET</option>
<option value="63">KEYCODE_SYM</option>
<option value="120">KEYCODE_SYSRQ</option>
<option value="281">KEYCODE_SYSTEM_NAVIGATION_DOWN</option>
<option value="282">KEYCODE_SYSTEM_NAVIGATION_LEFT</option>
<option value="283">KEYCODE_SYSTEM_NAVIGATION_RIGHT</option>
<option value="280">KEYCODE_SYSTEM_NAVIGATION_UP</option>
<option value="48">KEYCODE_T</option>
<option value="61">KEYCODE_TAB</option>
<option value="287">KEYCODE_THUMBS_DOWN</option>
<option value="286">KEYCODE_THUMBS_UP</option>
<option value="170">KEYCODE_TV</option>
<option value="242">KEYCODE_TV_ANTENNA_CABLE</option>
<option value="252">KEYCODE_TV_AUDIO_DESCRIPTION</option>
<option value="254">KEYCODE_TV_AUDIO_DESCRIPTION_MIX_DOWN</option>
<option value="253">KEYCODE_TV_AUDIO_DESCRIPTION_MIX_UP</option>
<option value="256">KEYCODE_TV_CONTENTS_MENU</option>
<option value="230">KEYCODE_TV_DATA_SERVICE</option>
<option value="178">KEYCODE_TV_INPUT</option>
<option value="249">KEYCODE_TV_INPUT_COMPONENT_1</option>
<option value="250">KEYCODE_TV_INPUT_COMPONENT_2</option>
<option value="247">KEYCODE_TV_INPUT_COMPOSITE_1</option>
<option value="248">KEYCODE_TV_INPUT_COMPOSITE_2</option>
<option value="243">KEYCODE_TV_INPUT_HDMI_1</option>
<option value="244">KEYCODE_TV_INPUT_HDMI_2</option>
<option value="245">KEYCODE_TV_INPUT_HDMI_3</option>
<option value="246">KEYCODE_TV_INPUT_HDMI_4</option>
<option value="251">KEYCODE_TV_INPUT_VGA_1</option>
<option value="257">KEYCODE_TV_MEDIA_CONTEXT_MENU</option>
<option value="241">KEYCODE_TV_NETWORK</option>
<option value="234">KEYCODE_TV_NUMBER_ENTRY</option>
<option value="177">KEYCODE_TV_POWER</option>
<option value="232">KEYCODE_TV_RADIO_SERVICE</option>
<option value="237">KEYCODE_TV_SATELLITE</option>
<option value="238">KEYCODE_TV_SATELLITE_BS</option>
<option value="239">KEYCODE_TV_SATELLITE_CS</option>
<option value="240">KEYCODE_TV_SATELLITE_SERVICE</option>
<option value="233">KEYCODE_TV_TELETEXT</option>
<option value="235">KEYCODE_TV_TERRESTRIAL_ANALOG</option>
<option value="236">KEYCODE_TV_TERRESTRIAL_DIGITAL</option>
<option value="258">KEYCODE_TV_TIMER_PROGRAMMING</option>
<option value="255">KEYCODE_TV_ZOOM_MODE</option>
<option value="49">KEYCODE_U</option>
<option value="0">KEYCODE_UNKNOWN</option>
<option value="50">KEYCODE_V</option>
<option value="231">KEYCODE_VOICE_ASSIST</option>
<option value="25">KEYCODE_VOLUME_DOWN</option>
<option value="164">KEYCODE_VOLUME_MUTE</option>
<option value="24">KEYCODE_VOLUME_UP</option>
<option value="51">KEYCODE_W</option>
<option value="224">KEYCODE_WAKEUP</option>
<option value="171">KEYCODE_WINDOW</option>
<option value="52">KEYCODE_X</option>
<option value="53">KEYCODE_Y</option>
<option value="216">KEYCODE_YEN</option>
<option value="54">KEYCODE_Z</option>
<option value="211">KEYCODE_ZENKAKU_HANKAKU</option>
<option value="168">KEYCODE_ZOOM_IN</option>
<option value="16">KEYCODE_ZOOM_OUT</option>
</options>
</state>
</channel-type>
<channel-type id="text-channel">
<item-type>String</item-type>
<label>Send Text</label>
<description>Send text to android device</description>
</channel-type>
<channel-type id="start-package-channel">
<item-type>String</item-type>
<label>Start Package</label>
<description>Run application by package name</description>
</channel-type>
<channel-type id="stop-package-channel">
<item-type>String</item-type>
<label>Stop Package</label>
<description>Stop application by package name</description>
</channel-type>
<channel-type id="stop-current-package-channel">
<item-type>Switch</item-type>
<label>Stop Current Package</label>
<description>Stops the top application in screen when receives an OFF command</description>
</channel-type>
<channel-type id="current-package-channel">
<item-type>String</item-type>
<label>Current Package</label>
<description>Package name of the top application in screen</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="wake-lock-channel" advanced="true">
<item-type>Number</item-type>
<label>Wake Lock</label>
<description>Power Wake Lock State</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="screen-state-channel" advanced="true">
<item-type>Switch</item-type>
<label>Screen State</label>
<description>Screen Power State</description>
<state readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

190
_thing_types/org.openhab.binding.bluetooth.govee/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,190 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="bluetooth"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="goveeHygrometer">
<supported-bridge-type-refs>
<bridge-type-ref id="roaming"/>
<bridge-type-ref id="bluegiga"/>
<bridge-type-ref id="bluez"/>
</supported-bridge-type-refs>
<label>Govee Hygrometer</label>
<description>Govee Thermo-Hygrometer</description>
<channels>
<channel id="rssi" typeId="rssi"/>
<channel id="battery" typeId="system.battery-level"/>
<channel id="temperature" typeId="govee-temperature"/>
<channel id="humidity" typeId="system.atmospheric-humidity"/>
</channels>
<representation-property>address</representation-property>
<config-description>
<parameter-group name="calibration">
<label>Calibration</label>
<description>Sensor calibration settings.</description>
<advanced>true</advanced>
</parameter-group>
<parameter name="address" type="text" required="true">
<label>Address</label>
<description>Bluetooth address in XX:XX:XX:XX:XX:XX format</description>
</parameter>
<parameter name="refreshInterval" type="integer" unit="s" required="true">
<label>Refresh Interval</label>
<description>The frequency at which battery, temperature, and humidity data will refresh</description>
<default>300</default>
<advanced>true</advanced>
</parameter>
<parameter name="temperatureCalibration" type="decimal" min="-1.6" max="1.6" groupName="calibration"
unit="Cel">
<label>Temperature Calibration</label>
<description>Adds offset to reported temperature</description>
<advanced>true</advanced>
</parameter>
<parameter name="humidityCalibration" type="decimal" min="-9" max="9" groupName="calibration" unit="%">
<label>Humidity Calibration</label>
<description>Adds offset to reported humidity</description>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
<thing-type id="goveeHygrometerMonitor">
<supported-bridge-type-refs>
<bridge-type-ref id="roaming"/>
<bridge-type-ref id="bluegiga"/>
<bridge-type-ref id="bluez"/>
</supported-bridge-type-refs>
<label>Govee Monitoring Hygrometer</label>
<description>Govee Thermo-Hygrometer w/ Warning Alarms</description>
<channels>
<channel id="rssi" typeId="rssi"/>
<channel id="battery" typeId="system.battery-level"/>
<channel id="temperature" typeId="govee-temperature"/>
<channel id="temperatureAlarm" typeId="govee-temperature-alarm"/>
<channel id="humidity" typeId="system.atmospheric-humidity"/>
<channel id="humidityAlarm" typeId="govee-humidity-alarm"/>
</channels>
<representation-property>address</representation-property>
<config-description>
<parameter-group name="calibration">
<label>Calibration</label>
<description>Sensor calibration settings.</description>
<advanced>true</advanced>
</parameter-group>
<parameter-group name="alarms">
<label>Alarm</label>
<description>Alarm settings.</description>
<advanced>true</advanced>
</parameter-group>
<parameter name="address" type="text" required="true">
<label>Address</label>
<description>Bluetooth address in XX:XX:XX:XX:XX:XX format</description>
</parameter>
<parameter name="refreshInterval" type="integer" unit="s" required="true">
<label>Refresh Interval</label>
<description>The frequency at which battery, temperature, and humidity data will refresh</description>
<default>300</default>
<advanced>true</advanced>
</parameter>
<parameter name="temperatureCalibration" type="decimal" min="-1.6" max="1.6" groupName="calibration"
unit="Cel">
<label>Temperature Calibration</label>
<description>Adds offset to reported temperature</description>
<advanced>true</advanced>
</parameter>
<parameter name="temperatureWarningAlarm" type="boolean" groupName="alarms" required="true">
<label>Broadcast Temperature Warning</label>
<description>If enabled, the Govee device will notify openHAB if temperature is out of the specified range</description>
<default>false</default>
<advanced>true</advanced>
</parameter>
<parameter name="temperatureWarningMin" type="decimal" min="-20" max="60" step="0.2" groupName="alarms"
unit="Cel" required="true">
<label>Min Warning Temperature</label>
<description>Sets the lowest acceptable temperature value before a warning should be issued</description>
<default>0</default>
<advanced>true</advanced>
</parameter>
<parameter name="temperatureWarningMax" type="decimal" min="-20" max="60" step="0.2" groupName="alarms"
unit="Cel" required="true">
<label>Max Warning Temperature</label>
<description>Sets the highest acceptable temperature value before a warning should be issued</description>
<default>0</default>
<advanced>true</advanced>
</parameter>
<parameter name="humidityCalibration" type="decimal" min="-9" max="9" groupName="calibration" unit="%">
<label>Humidity Calibration</label>
<description>Adds offset to reported humidity</description>
<advanced>true</advanced>
</parameter>
<parameter name="humidityWarningAlarm" type="boolean" groupName="alarms" required="true">
<label>Broadcast Humidity Warning</label>
<description>If enabled, the Govee device will notify openHAB if humidity is out of the specified range</description>
<default>false</default>
<advanced>true</advanced>
</parameter>
<parameter name="humidityWarningMin" type="decimal" min="0" max="100" step="0.1" groupName="alarms"
unit="%" required="true">
<label>Min Warning Humidity</label>
<description>Sets the lowest acceptable humidity value before a warning should be issued</description>
<default>0</default>
<advanced>true</advanced>
</parameter>
<parameter name="humidityWarningMax" type="decimal" min="0" max="100" step="0.1" groupName="alarms"
unit="%" required="true">
<label>Max Warning Humidity</label>
<description>Sets the highest acceptable humidity value before a warning should be issued</description>
<default>0</default>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
<channel-type id="govee-temperature">
<item-type>Number:Temperature</item-type>
<label>Current Measured Temperature</label>
<category>Temperature</category>
<state readOnly="true" pattern="%.1f %unit%"/>
</channel-type>
<channel-type id="govee-temperature-alarm">
<item-type>Switch</item-type>
<label>Temperature Warning Alarm</label>
<description>
If temperature warnings are enabled, then this alarm indicates whether the current temperature is out of
range.
</description>
<category>Alarm</category>
</channel-type>
<channel-type id="govee-humidity-alarm">
<item-type>Switch</item-type>
<label>Humidity Warning Alarm</label>
<description>
If humidity warnings are enabled, then this alarm indicates whether the current humidity is out of range.
</description>
<category>Alarm</category>
</channel-type>
</thing:thing-descriptions>

262
_thing_types/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,262 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="boschshc"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Bosch Bridge -->
<bridge-type id="shc">
<label>Smart Home Controller</label>
<description>The Bosch SHC Bridge representing the Bosch Smart Home Controller.</description>
<config-description-ref uri="thing-type:boschshc:bridge"/>
</bridge-type>
<thing-type id="in-wall-switch">
<supported-bridge-type-refs>
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>
<label>In-wall Switch</label>
<description>Bosch In-wall switch for light control</description>
<channels>
<channel id="power-switch" typeId="system.power"/>
<channel id="power-consumption" typeId="power-consumption"/>
<channel id="energy-consumption" typeId="energy-consumption"/>
</channels>
<config-description-ref uri="thing-type:boschshc:device"/>
</thing-type>
<thing-type id="twinguard">
<supported-bridge-type-refs>
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>
<label>TwinGuard</label>
<description>Bosch TwinGuard environmental sensor</description>
<channels>
<channel id="temperature" typeId="temperature"/>
<channel id="temperature-rating" typeId="temperature-rating"/>
<channel id="humidity" typeId="humidity"/>
<channel id="humidity-rating" typeId="humidity-rating"/>
<channel id="purity" typeId="purity"/>
<channel id="air-description" typeId="air-description"/>
<channel id="purity-rating" typeId="purity-rating"/>
<channel id="combined-rating" typeId="combined-rating"/>
</channels>
<config-description-ref uri="thing-type:boschshc:device"/>
</thing-type>
<thing-type id="window-contact">
<supported-bridge-type-refs>
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>
<label>Window/Door Contact</label>
<description>Bosch Contact for windows and doors</description>
<channels>
<channel id="contact" typeId="contact"/>
</channels>
<config-description-ref uri="thing-type:boschshc:device"/>
</thing-type>
<thing-type id="motion-detector">
<supported-bridge-type-refs>
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>
<label>Motion Detector</label>
<description>Bosch Motion Detector</description>
<channels>
<channel id="latest-motion" typeId="latest-motion"/>
</channels>
<config-description-ref uri="thing-type:boschshc:device"/>
</thing-type>
<thing-type id="shutter-control">
<supported-bridge-type-refs>
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>
<label>Shutter Control</label>
<description>Bosch Shutter Control</description>
<channels>
<channel id="level" typeId="level"/>
</channels>
<config-description-ref uri="thing-type:boschshc:device"/>
</thing-type>
<thing-type id="thermostat">
<supported-bridge-type-refs>
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>
<label>Thermostat</label>
<description>Bosch Thermostat</description>
<channels>
<channel id="temperature" typeId="temperature"/>
<channel id="valve-tappet-position" typeId="valve-tappet-position"/>
</channels>
<config-description-ref uri="thing-type:boschshc:device"/>
</thing-type>
<thing-type id="climate-control">
<supported-bridge-type-refs>
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>
<label>Climate Control</label>
<description>Bosch Climate Control. This is a virtual device which is automatically created for all rooms that have
thermostats in it.</description>
<channels>
<channel id="temperature" typeId="temperature"/>
<channel id="setpoint-temperature" typeId="setpoint-temperature"/>
</channels>
<config-description-ref uri="thing-type:boschshc:device"/>
</thing-type>
<channel-type id="temperature">
<item-type>Number:Temperature</item-type>
<label>Temperature</label>
<description>Current measured temperature.</description>
<state min="0" max="40" step="0.5" pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="temperature-rating">
<item-type>String</item-type>
<label>Temperature Rating</label>
<description>Rating of the currently measured temperature.</description>
<state readOnly="true">
<options>
<option value="GOOD">Good Temperature</option>
<option value="MEDIUM">Medium Temperature</option>
<option value="BAD">Bad Temperature</option>
</options>
</state>
</channel-type>
<channel-type id="humidity">
<item-type>Number:Dimensionless</item-type>
<label>Humidity</label>
<description>Current measured humidity.</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="humidity-rating">
<item-type>String</item-type>
<label>Humidity Rating</label>
<description>Rating of current measured humidity.</description>
<state readOnly="true">
<options>
<option value="GOOD">Good Humidity</option>
<option value="MEDIUM">Medium Humidity</option>
<option value="BAD">Bad Humidity</option>
</options>
</state>
</channel-type>
<channel-type id="energy-consumption">
<item-type>Number:Energy</item-type>
<label>Energy consumption (Wh)</label>
<description>Energy consumption of the device.</description>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="power-consumption">
<item-type>Number:Power</item-type>
<label>Power consumption (W)</label>
<description>Current power consumption of the device.</description>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="purity">
<item-type>Number:Dimensionless</item-type>
<label>Purity</label>
<description>Purity of the air. A higher value indicates a higher pollution.</description>
<state min="500" max="5500" pattern="%.1f ppm" readOnly="true"/>
</channel-type>
<channel-type id="air-description">
<item-type>String</item-type>
<label>Description</label>
<description>Overall description of the air quality.</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="purity-rating">
<item-type>String</item-type>
<label>Purity Rating</label>
<description>Rating of the air purity.</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="combined-rating">
<item-type>String</item-type>
<label>Combined Rating</label>
<description>Combined rating of the air quality.</description>
<state readOnly="true">
<options>
<option value="GOOD">Good Quality</option>
<option value="MEDIUM">Medium Quality</option>
<option value="BAD">Bad Quality</option>
</options>
</state>
</channel-type>
<channel-type id="contact">
<item-type>Contact</item-type>
<label>Window/Door contact</label>
<description>A window and door contact.</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="latest-motion">
<item-type>DateTime</item-type>
<label>Latest motion</label>
<description>Timestamp of the latest motion.</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="level">
<item-type>Rollershutter</item-type>
<label>Level</label>
<description>Current open ratio (0 to 100).</description>
<state min="0" max="100" step="0.5" readOnly="false"/>
</channel-type>
<channel-type id="valve-tappet-position">
<item-type>Number:Dimensionless</item-type>
<label>Valve Tappet Position</label>
<description>Current open ratio (0 to 100).</description>
<state min="0" max="100" step="1" readOnly="true"/>
</channel-type>
<channel-type id="setpoint-temperature">
<item-type>Number:Temperature</item-type>
<label>Setpoint Temperature</label>
<description>Desired temperature.</description>
<state min="5" max="30" step="0.5" pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

8
_thing_types/org.openhab.binding.buienradar/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -60,10 +60,10 @@
</parameter>
<parameter name="exponentialBackoffRetryBaseInSeconds" type="integer" required="true" min="1" unit="s">
<label>Exponential Backoff Base for Retries</label>
<description>Exponential back-off base value for retries in seconds. For example, when this is 2 seconds, will retry
at 2, 4, 8, 16, 32, 64 seconds.</description>
<default>5</default>
<label>Doubling Backoff Base for Retries</label>
<description>Doubling back-off base value for retries in seconds. For example, when this is 30 seconds, will retry
at 30, 60, 120, 240 seconds.</description>
<default>30</default>
</parameter>
</config-description>

11
_thing_types/org.openhab.binding.deconz/src/main/resources/OH-INF/thing/light-thing-types.xml
View File

@ -44,6 +44,7 @@
<description>A light that can be turned on or off.</description>
<channels>
<channel typeId="onoff" id="switch"/>
<channel typeId="ontime" id="ontime"/>
</channels>
<representation-property>uid</representation-property>
@ -60,6 +61,7 @@
<category>Lightbulb</category>
<channels>
<channel typeId="brightness" id="brightness"/>
<channel typeId="ontime" id="ontime"/>
<channel id="alert" typeId="alert"></channel>
</channels>
@ -78,6 +80,7 @@
<channels>
<channel typeId="brightness" id="brightness"/>
<channel typeId="ct" id="color_temperature"/>
<channel typeId="ontime" id="ontime"/>
<channel id="alert" typeId="alert"></channel>
</channels>
@ -95,6 +98,7 @@
<category>Lightbulb</category>
<channels>
<channel typeId="color" id="color"/>
<channel typeId="ontime" id="ontime"/>
<channel id="alert" typeId="alert"></channel>
</channels>
@ -113,6 +117,7 @@
<channels>
<channel typeId="color" id="color"/>
<channel typeId="ct" id="color_temperature"/>
<channel typeId="ontime" id="ontime"/>
<channel id="alert" typeId="alert"></channel>
</channels>
@ -181,6 +186,12 @@
<state pattern="%d K" min="15" max="100000" step="100"/>
</channel-type>
<channel-type id="ontime">
<item-type>Number:Time</item-type>
<label>On Time</label>
<description>Time that the light stays on before switched off automatically (0=forever)</description>
</channel-type>
<channel-type id="effect">
<item-type>String</item-type>
<label>Effect Channel</label>

76
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/backyard.xml Normal file
View File

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="backyard" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Backyard</label>
<description>The Hayward Backyard</description>
<channels>
<channel id="backyardAirTemp" typeId="airTemp"/>
<channel id="backyardStatus" typeId="backyardstatus"/>
<channel id="backyardState" typeId="backyardstate"/>
<channel id="backyardAlarm1" typeId="alarm"/>
<channel id="backyardAlarm2" typeId="alarm"/>
<channel id="backyardAlarm3" typeId="alarm"/>
<channel id="backyardAlarm4" typeId="alarm"/>
<channel id="backyardAlarm5" typeId="alarm"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="airTemp">
<item-type>Number:Temperature</item-type>
<label>Air Temp</label>
<description>Air Temp</description>
<state pattern="%1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="backyardstatus">
<item-type>String</item-type>
<label>Status</label>
<description>Status</description>
<state readOnly="true">
<options>
<option value="1">Normal</option>
<option value="2">Alarm</option>
<option value="3">Expired</option>
<option value="4">Lost Link</option>
<option value="5">Service Mode</option>
</options>
</state>
</channel-type>
<channel-type id="backyardstate">
<item-type>String</item-type>
<label>State</label>
<description>State</description>
<state readOnly="true">
<options>
<option value="0">Powered Off</option>
<option value="1">Normal</option>
<option value="2">Service Mode</option>
<option value="3">Config Mode</option>
<option value="4">Timed Service Mode</option>
</options>
</state>
</channel-type>
<channel-type id="alarm">
<item-type>String</item-type>
<label>Alarm</label>
<description>Alarm</description>
<state readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

40
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/bow.xml Normal file
View File

@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="bow" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Body of Water</label>
<description>The Hayward Body of Water</description>
<channels>
<channel id="bowFlow" typeId="waterFlow"/>
<channel id="bowWaterTemp" typeId="waterTemp"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="waterFlow">
<item-type>system.power</item-type>
<label>Flow Sensor</label>
<description>Flow Sensor</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="waterTemp">
<item-type>Number:Temperature</item-type>
<label>Water Temp</label>
<description>Water Temp</description>
<state pattern="%1f %unit%" readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

40
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/bridge.xml Normal file
View File

@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- The bridge to communicate with Hayward's server -->
<bridge-type id="bridge">
<label>Hayward OmniLogix Connection</label>
<description>Connection to Hayward's Server</description>
<config-description>
<parameter name="endpointUrl" type="text" required="true">
<context>url</context>
<label>Endpoint URL</label>
<default>https://app1.haywardomnilogic.com/HAAPI/HomeAutomation/API.ashx</default>
<description>The URL of the Hayward API Server</description>
</parameter>
<parameter name="username" type="text" required="true">
<label>User Name</label>
<description>The username to connect to the server.</description>
</parameter>
<parameter name="password" type="text" required="true">
<context>password</context>
<label>Password</label>
<description>The password to connect to the server.</description>
</parameter>
<parameter name="telemetryPollTime" type="integer" min="10" max="60" unit="s" required="true">
<label>Telemetry Poll Delay</label>
<default>12</default>
<description>How often to request telemetry data from Hayward Server</description>
</parameter>
<parameter name="alarmPollTime" type="integer" min="0" max="120" unit="s" required="true">
<label>Alarm Poll Delay</label>
<default>60</default>
<description>How often to request alarm data from Hayward Server. Enter 0 to disable.</description>
</parameter>
</config-description>
</bridge-type>
</thing:thing-descriptions>

103
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/chlorinator.xml Normal file
View File

@ -0,0 +1,103 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="chlorinator" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Chlorinator</label>
<description>Chlorinator</description>
<channels>
<channel id="chlorEnable" typeId="system.power"/>
<channel id="chlorOperatingMode" typeId="chlorOperatingMode"/>
<channel id="chlorTimedPercent" typeId="timedPercent"/>
<channel id="chlorScMode" typeId="scMode"/>
<channel id="chlorError" typeId="chlorError"/>
<channel id="chlorAlert" typeId="chlorAlert"/>
<channel id="chlorAvgSaltLevel" typeId="avgSaltLevel"/>
<channel id="chlorInstantSaltLevel" typeId="instantSaltLevel"/>
<channel id="chlorStatus" typeId="status"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="chlorOperatingMode">
<item-type>String</item-type>
<label>Operating Mode</label>
<description>Operating Mode</description>
<state readOnly="true">
<options>
<option value="0">Off</option>
<option value="1">Timed Percent</option>
<option value="2">ORP Autosense</option>
</options>
</state>
</channel-type>
<channel-type id="timedPercent">
<item-type>Number:Dimensionless</item-type>
<label>Salt Output (%)</label>
<description>Current salt output setting for the chlorinator (%).</description>
<state min="0" max="100" step="1.0" pattern="%1f %unit%" readOnly="false"/>
</channel-type>
<channel-type id="scMode">
<item-type>String</item-type>
<label>scMode</label>
<description>scMode</description>
<state readOnly="true">
<options>
<option value="0">Off</option>
<option value="1">Super Chlorinating</option>
</options>
</state>
</channel-type>
<channel-type id="chlorError">
<item-type>Number</item-type>
<label>Chlorinator Error</label>
<state readOnly="true"/>
</channel-type>
<channel-type id="chlorAlert">
<item-type>String</item-type>
<label>Chlorinator Alert</label>
<description>Chlorinator Alert</description>
<state readOnly="true">
<options>
<option value="0">None</option>
<option value="16">Low T-Cell Temperature</option>
</options>
</state>
</channel-type>
<channel-type id="avgSaltLevel">
<item-type>Number:Dimensionless</item-type>
<label>Average Salt Level</label>
<description>Average Salt Level</description>
<state pattern="%1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="instantSaltLevel">
<item-type>Number:Dimensionless</item-type>
<label>Instant Salt Level</label>
<description>Instant Salt Level</description>
<state pattern="%1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="status">
<item-type>Number</item-type>
<label>Status</label>
<description>Status</description>
<state pattern="%1f" readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

67
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/colorlogic.xml Normal file
View File

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="colorlogic" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Color Logic Light</label>
<description>Color Logic Light</description>
<channels>
<channel id="colorLogicLightEnable" typeId="system.power"/>
<channel id="colorLogicLightState" typeId="lightState"/>
<channel id="colorLogicLightCurrentShow" typeId="currentShow"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="lightState">
<item-type>String</item-type>
<label>Light State</label>
<description>Light State</description>
<state readOnly="true">
<options>
<option value="0">Off</option>
<option value="1">On</option>
<option value="4">15 Sec White Light</option>
<option value="7">Powering Off</option>
</options>
</state>
</channel-type>
<channel-type id="currentShow">
<item-type>String</item-type>
<label>Current Show</label>
<description>Current Show</description>
<state readOnly="false">
<options>
<option value="0">Voodoo Lounge</option>
<option value="1">Deep Blue Sea</option>
<option value="2">Royal Blue</option>
<option value="3">Afternoon Sky</option>
<option value="4">Aqua Green</option>
<option value="5">Emerald</option>
<option value="6">Cloud White</option>
<option value="7">Warm Red</option>
<option value="8">Flamingo</option>
<option value="9">Vivid Violet</option>
<option value="10">Sangria</option>
<option value="11">Twilight</option>
<option value="12">Tranquility</option>
<option value="13">Gemstone</option>
<option value="14">USA</option>
<option value="15">Mardi Gras</option>
<option value="16">Cool Cabaret</option>
</options>
</state>
</channel-type>
</thing:thing-descriptions>

83
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/filter.xml Normal file
View File

@ -0,0 +1,83 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="filter" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Filter</label>
<description>Filter Equipment</description>
<channels>
<channel id="filterEnable" typeId="system.power"/>
<channel id="filterValvePosition" typeId="valvePosition"/>
<channel id="filterSpeed" typeId="filterSpeed"/>
<channel id="filterState" typeId="filterState"/>
<channel id="filterLastSpeed" typeId="filterLastSpeed"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
<property name="Min Pump Percent"></property>
<property name="Max Pump Percent"></property>
<property name="Min Pump RPM"></property>
<property name="Max Pump RPM"></property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="valvePosition">
<item-type>String</item-type>
<label>Valve Position</label>
<description>Valve Position</description>
<state readOnly="true">
<options>
<option value="0">Off</option>
<option value="1">Pool Only</option>
<option value="2">Spa Only</option>
<option value="3">Spill Over</option>
</options>
</state>
</channel-type>
<channel-type id="filterSpeed">
<item-type>Number:Dimensionless</item-type>
<label>Filter Speed</label>
<description>Filter Speed in %</description>
<state min="0" max="100" step="1.0" pattern="%1f %unit%" readOnly="false"/>
</channel-type>
<channel-type id="filterState">
<item-type>String</item-type>
<label>Filter State</label>
<description>Filter State</description>
<state readOnly="true">
<options>
<option value="0">Off</option>
<option value="1">Running</option>
<option value="2">Priming</option>
<option value="3">Waiting to Turn Off</option>
<option value="4">Waiting to Turn Off Manual</option>
<option value="5">Heater Extend</option>
<option value="6">Heater Cool Down</option>
<option value="7">Suspended</option>
<option value="8">CSAD Extend</option>
<option value="9">Filter Superchlorinate</option>
<option value="10">Filter Force Priming</option>
<option value="11">Filter Waiting for Pump to Turn Off</option>
</options>
</state>
</channel-type>
<channel-type id="filterLastSpeed">
<item-type>Number:Dimensionless</item-type>
<label>Last Speed</label>
<description>Last Speed</description>
<state pattern="%1f %unit%" readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

39
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/heater.xml Normal file
View File

@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="heater" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Heater</label>
<description>Heater</description>
<channels>
<channel id="heaterState" typeId="state"/>
<channel id="heaterEnable" typeId="enable"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="state">
<item-type>Number</item-type>
<label>Heater State</label>
<description>Heater State</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="enable">
<item-type>system.power</item-type>
<label>Heater Enable</label>
<description>Heater Enable</description>
<state readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

37
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/pump.xml Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="pump" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Pump</label>
<description>Pump</description>
<channels>
<channel id="pumpEnable" typeId="system.power"/>
<channel id="pumpSpeed" typeId="pumpSpeed"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
<property name="Min Pump Percent"></property>
<property name="Max Pump Percent"></property>
<property name="Min Pump RPM"></property>
<property name="Max Pump RPM"></property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="pumpSpeed">
<item-type>Number:Dimensionless</item-type>
<label>Pump Speed in %</label>
<description>Pump Speed</description>
<state min="0" max="100" step="1.0" pattern="%1f %unit%" readOnly="false"/>
</channel-type>
</thing:thing-descriptions>

25
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/relay.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="relay" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Relay</label>
<description>Relay</description>
<channels>
<channel id="relayState" typeId="system.power"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
</thing:thing-descriptions>

39
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/sensor.xml Normal file
View File

@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="sensor" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Sensor</label>
<description>Sensor</description>
<channels>
<channel id="sensorData" typeId="data"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="bow">
<item-type>Number</item-type>
<label>Body of Water</label>
<description>The Body of Water ID</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="data">
<item-type>Number</item-type>
<label>Data</label>
<description>Sensor Data</description>
<state readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

34
_thing_types/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/virtualHeater.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="haywardomnilogic"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<thing-type id="virtualHeater" listed="false">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Virtual Heater</label>
<description>Virtual Heater</description>
<channels>
<channel id="virtualHeaterEnable" typeId="system.power"/>
<channel id="virtualHeaterCurrentSetpoint" typeId="currentSetpoint"/>
</channels>
<properties>
<property name="Vendor">Hayward</property>
</properties>
<representation-property>systemID</representation-property>
</thing-type>
<channel-type id="currentSetpoint">
<item-type>Number:Temperature</item-type>
<label>Current Setpoint</label>
<description>Current Setpoint</description>
<category>Temperature</category>
<state min="65" max="90" step="1.0" pattern="%1f %unit%" readOnly="false"/>
</channel-type>
</thing:thing-descriptions>

7
_thing_types/org.openhab.binding.homematic/src/main/resources/OH-INF/thing/bridge.xml
View File

@ -120,7 +120,12 @@
<advanced>true</advanced>
<default>false</default>
</parameter>
<parameter name="bufferSize" type="integer" min="0">
<label>Buffer Size</label>
<description>Size of the response buffer retrieved from the gateway (default 2048 kB)</description>
<default>2048</default>
<advanced>true</advanced>
</parameter>
</config-description>
</bridge-type>

2
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/ColorLight.xml
View File

@ -13,7 +13,7 @@
<description>A dimmable light with changeable colors.</description>
<channels>
<channel id="color" typeId="color"/>
<channel id="color" typeId="system.color"/>
<channel id="alert" typeId="alert"/>
<channel id="effect" typeId="effect"/>
</channels>

5
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/ColorTemperatureLight.xml
View File

@ -13,8 +13,9 @@
<description>A dimmable light with tunable color temperature.</description>
<channels>
<channel id="color_temperature" typeId="color_temperature"/>
<channel id="brightness" typeId="brightness"/>
<channel id="color_temperature" typeId="system.color-temperature"/>
<channel id="color_temperature_abs" typeId="system.color-temperature-abs"/>
<channel id="brightness" typeId="system.brightness"/>
<channel id="alert" typeId="alert"/>
<channel id="effect" typeId="effect"/>
</channels>

2
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/DimmableLight.xml
View File

@ -13,7 +13,7 @@
<description>A dimmable light.</description>
<channels>
<channel id="brightness" typeId="brightness"/>
<channel id="brightness" typeId="system.brightness"/>
<channel id="alert" typeId="alert"/>
</channels>

2
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/DimmablePlug.xml
View File

@ -13,7 +13,7 @@
<description>An outlet that can be dimmed.</description>
<channels>
<channel id="brightness" typeId="brightness"/>
<channel id="brightness" typeId="system.brightness"/>
</channels>
<representation-property>uniqueId</representation-property>

5
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/ExtendedColorLight.xml
View File

@ -13,8 +13,9 @@
<description>A dimmable light with changeable colors and tunable color temperature.</description>
<channels>
<channel id="color" typeId="color"/>
<channel id="color_temperature" typeId="color_temperature"/>
<channel id="color" typeId="system.color"/>
<channel id="color_temperature" typeId="system.color-temperature"/>
<channel id="color_temperature_abs" typeId="system.color-temperature-abs"/>
<channel id="alert" typeId="alert"/>
<channel id="effect" typeId="effect"/>
</channels>

9
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/Group.xml
View File

@ -13,10 +13,11 @@
<description>A group of lights or a room that could be switched on and off.</description>
<channels>
<channel id="switch" typeId="switch"/>
<channel id="color_temperature" typeId="color_temperature"/>
<channel id="brightness" typeId="brightness"/>
<channel id="color" typeId="color"/>
<channel id="switch" typeId="system.power"/>
<channel id="color_temperature" typeId="system.color-temperature"/>
<channel id="color_temperature_abs" typeId="system.color-temperature-abs"/>
<channel id="brightness" typeId="system.brightness"/>
<channel id="color" typeId="system.color"/>
<channel id="alert" typeId="alert"/>
<channel id="scene" typeId="scene"/>
</channels>

2
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/OnOffLight.xml
View File

@ -13,7 +13,7 @@
<description>A light that could be switched on and off.</description>
<channels>
<channel id="switch" typeId="switch"/>
<channel id="switch" typeId="system.power"/>
<channel id="alert" typeId="alert"/>
</channels>

2
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/OnOffPlug.xml
View File

@ -13,7 +13,7 @@
<description>An outlet that could be switched on and off.</description>
<channels>
<channel id="switch" typeId="switch"/>
<channel id="switch" typeId="system.power"/>
</channels>
<representation-property>uniqueId</representation-property>

50
_thing_types/org.openhab.binding.hue/src/main/resources/OH-INF/thing/channels.xml
View File

@ -3,34 +3,6 @@
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">
<!-- Color Channel -->
<channel-type id="color">
<item-type>Color</item-type>
<label>Color</label>
<description>The color channel allows to control the color of a light.
It is also possible to dim values and switch the
light on and off.
</description>
<category>ColorLight</category>
<tags>
<tag>Lighting</tag>
</tags>
</channel-type>
<!-- Brightness Channel -->
<channel-type id="brightness">
<item-type>Dimmer</item-type>
<label>Brightness</label>
<description>The brightness channel allows to control the brightness of a light.
It is also possible to switch the
light on and off.
</description>
<category>Light</category>
<tags>
<tag>Lighting</tag>
</tags>
</channel-type>
<channel-type id="last_updated">
<item-type>DateTime</item-type>
<label>Last Updated</label>
@ -147,18 +119,6 @@
</event>
</channel-type>
<!-- Switch Channel -->
<channel-type id="switch">
<item-type>Switch</item-type>
<label>Switch</label>
<description>The switch channel allows to switch the light on and off.
</description>
<category>Light</category>
<tags>
<tag>Lighting</tag>
</tags>
</channel-type>
<!-- Temperature Channel -->
<channel-type id="temperature">
<item-type>Number:Temperature</item-type>
@ -168,16 +128,6 @@
<state readOnly="true" pattern="%.1f %unit%"/>
</channel-type>
<!-- Color Temperature Channel -->
<channel-type id="color_temperature">
<item-type>Dimmer</item-type>
<label>Color Temperature</label>
<description>The color temperature channel allows to set the color
temperature of a light from 0 (cold) to 100 (warm).
</description>
<category>ColorLight</category>
</channel-type>
<!-- Alert Channel -->
<channel-type id="alert" advanced="true">
<item-type>String</item-type>

2
_thing_types/org.openhab.binding.ihc/src/main/resources/OH-INF/thing/controller.xml
View File

@ -4,7 +4,7 @@
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="controller"
extensible="switch, contact, number, dimmmer, datetime, string, rollershutter, pulse-output, rf-device-battery-level, rf-device-signal-strength, push-button-trigger">
extensible="switch, contact, number, dimmer, datetime, string, rollershutter, rf-device-low-battery, rf-device-signal-strength, push-button-trigger">
<label>IHC / ELKO Controller</label>
<description></description>

9
_thing_types/org.openhab.binding.irobot/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -10,6 +10,7 @@
<channels>
<channel id="command" typeId="command"/>
<channel id="last_command" typeId="lastCommand"/>
<channel id="cycle" typeId="cycle"/>
<channel id="phase" typeId="phase"/>
<channel id="battery" typeId="battery"/>
@ -255,4 +256,12 @@
</state>
</channel-type>
<channel-type id="lastCommand" advanced="true">
<item-type>String</item-type>
<label>Last Command</label>
<description>The last command which has been received by the iRobot</description>
<state readOnly="true">
</state>
</channel-type>
</thing:thing-descriptions>

7
_thing_types/org.openhab.binding.jablotron/src/main/resources/OH-INF/thing/channels.xml
View File

@ -125,6 +125,13 @@
<state readOnly="true"/>
</channel-type>
<!-- pgm_state -->
<channel-type id="pgm_state">
<item-type>Switch</item-type>
<label>Programmable Gate State</label>
<description>A channel used for controlling the PGM state</description>
</channel-type>
<!-- alarm_state -->
<channel-type id="alarm_state">
<item-type>String</item-type>

2
_thing_types/org.openhab.binding.mqtt.generic/src/main/resources/OH-INF/thing/channels.xml
View File

@ -84,7 +84,7 @@
</channel-type>
<channel-type id="trigger">
<item-type>Trigger</item-type>
<kind>trigger</kind>
<label>Trigger</label>
<description></description>
<config-description-ref uri="thing-type:mqtt:trigger_channel"></config-description-ref>

163
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/area.xml Normal file
View File

@ -0,0 +1,163 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Omni Area Thing -->
<thing-type id="area">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Omni Area</label>
<description>An Omni area configured in the controller.</description>
<channels>
<channel id="activate_keypad_emergency" typeId="omni_activate_keypad_emergency"/>
<channel id="alarm_burglary" typeId="area_alarm"/>
<channel id="alarm_fire" typeId="area_alarm"/>
<channel id="alarm_gas" typeId="area_alarm"/>
<channel id="alarm_auxiliary" typeId="area_alarm"/>
<channel id="alarm_freeze" typeId="area_alarm"/>
<channel id="alarm_water" typeId="area_alarm"/>
<channel id="alarm_duress" typeId="area_alarm"/>
<channel id="alarm_temperature" typeId="area_alarm"/>
<channel id="mode" typeId="omni_area_mode"/>
<channel id="disarm" typeId="area_command"/>
<channel id="day" typeId="area_command"/>
<channel id="night" typeId="area_command"/>
<channel id="away" typeId="area_command"/>
<channel id="vacation" typeId="area_command"/>
<channel id="day_instant" typeId="area_command"/>
<channel id="night_delayed" typeId="area_command"/>
<channel id="all_on_off_event" typeId="all_on_off_event"/>
</channels>
<properties>
<property name="name"/>
</properties>
<representation-property>number</representation-property>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Area Number</label>
<description>The area number.</description>
</parameter>
</config-description>
</thing-type>
<!-- Lumina Area Thing -->
<thing-type id="lumina_area">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Lumina Area</label>
<description>An Lumina area configured in the controller.</description>
<channels>
<channel id="mode" typeId="lumina_area_mode"/>
<channel id="home" typeId="area_command"/>
<channel id="sleep" typeId="area_command"/>
<channel id="away" typeId="area_command"/>
<channel id="vacation" typeId="area_command"/>
<channel id="party" typeId="area_command"/>
<channel id="special" typeId="area_command"/>
<channel id="all_on_off_event" typeId="all_on_off_event"/>
</channels>
<properties>
<property name="name"/>
</properties>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Area Number</label>
<description>The area number.</description>
</parameter>
</config-description>
</thing-type>
<!-- Area channels -->
<channel-type id="area_alarm">
<item-type>Switch</item-type>
<label>Area Alarm</label>
<description>Indicates if an alarm is active.</description>
<category>Alarm</category>
<state readOnly="true"/>
</channel-type>
<channel-type id="omni_area_mode">
<item-type>Number</item-type>
<label>Security Mode</label>
<description>Represents the area security mode.</description>
<category>Alarm</category>
<state readOnly="true">
<options>
<option value="0">Off</option>
<option value="1">Day</option>
<option value="2">Night</option>
<option value="3">Away</option>
<option value="4">Vacation</option>
<option value="5">Day instant</option>
<option value="6">Night delayed</option>
<option value="9">Arming day</option>
<option value="10">Arming night</option>
<option value="11">Arming away</option>
<option value="12">Arming vacation</option>
<option value="13">Arming day instant</option>
<option value="14">Arming night delayed</option>
</options>
</state>
</channel-type>
<channel-type id="area_command">
<item-type>String</item-type>
<label>Security Command</label>
<description>Sends a 4 digit user code to activate the area command.</description>
<category>Alarm</category>
</channel-type>
<channel-type id="omni_activate_keypad_emergency">
<item-type>Number</item-type>
<label>Activate Keypad Emergency</label>
<description>Activate a burglary, fire, or auxiliary keypad emergency alarm on Omni based models.</description>
<category>Alarm</category>
<state>
<options>
<option value="1">Burglary</option>
<option value="2">Fire</option>
<option value="3">Auxiliary</option>
</options>
</state>
</channel-type>
<channel-type id="lumina_area_mode">
<item-type>Number</item-type>
<label>Security Mode</label>
<description>Represents the area security mode.</description>
<category>Alarm</category>
<state readOnly="true">
<options>
<option value="1">Home</option>
<option value="2">Sleep</option>
<option value="3">Away</option>
<option value="4">Vacation</option>
<option value="5">Party</option>
<option value="6">Special</option>
<option value="9">Setting home</option>
<option value="10">Setting sleep</option>
<option value="11">Setting away</option>
<option value="12">Setting vacation</option>
<option value="13">Setting party</option>
<option value="14">Setting special</option>
</options>
</state>
</channel-type>
<channel-type id="all_on_off_event">
<kind>trigger</kind>
<label>All On/Off Event</label>
<description>Event sent when an all on/off event occurs.</description>
<event>
<options>
<option value="OFF">Off</option>
<option value="ON">On</option>
</options>
</event>
</channel-type>
</thing:thing-descriptions>

55
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/audio-source.xml Normal file
View File

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Audio Source Thing -->
<thing-type id="audio_source">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Audio Source</label>
<description>An audio source configured in the controller.</description>
<channels>
<channel id="source_text_1" typeId="audio_source_text"/>
<channel id="source_text_2" typeId="audio_source_text"/>
<channel id="source_text_3" typeId="audio_source_text"/>
<channel id="source_text_4" typeId="audio_source_text"/>
<channel id="source_text_5" typeId="audio_source_text"/>
<channel id="source_text_6" typeId="audio_source_text"/>
<channel id="polling" typeId="audio_source_polling"/>
</channels>
<properties>
<property name="name"/>
</properties>
<representation-property>number</representation-property>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Audio Source Number</label>
<description>The audio source number.</description>
</parameter>
<parameter name="autostart" type="boolean" required="false">
<label>Autostart Polling</label>
<description>Autostart polling of audio source on creation of thing.</description>
<default>true</default>
</parameter>
</config-description>
</thing-type>
<!-- Audio Source Channels -->
<channel-type id="audio_source_text">
<item-type>String</item-type>
<label>Source Data</label>
<description>A line of metadata from this audio source.</description>
<category>Text</category>
</channel-type>
<channel-type id="audio_source_polling">
<item-type>Switch</item-type>
<label>Audio Source Polling</label>
<description>Enable or disable polling of this audio source.</description>
<category>Switch</category>
</channel-type>
</thing:thing-descriptions>

72
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/audio-zone.xml Normal file
View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Audio Zone Thing -->
<thing-type id="audio_zone">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Audio Zone</label>
<description>An audio zone configured in the controller.</description>
<channels>
<channel id="zone_power" typeId="audio_zone_power"/>
<channel id="zone_mute" typeId="audio_zone_mute"/>
<channel id="zone_volume" typeId="audio_zone_volume"/>
<channel id="zone_source" typeId="audio_zone_source"/>
<channel id="zone_control" typeId="audio_zone_control"/>
</channels>
<properties>
<property name="name"/>
</properties>
<representation-property>number</representation-property>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Audio Zone Number</label>
<description>The audio zone number.</description>
</parameter>
</config-description>
</thing-type>
<!-- Audio Zone Channels -->
<channel-type id="audio_zone_power">
<item-type>Switch</item-type>
<label>Audio Zone Power</label>
<description>Power status of this audio zone.</description>
<category>Switch</category>
</channel-type>
<channel-type id="audio_zone_mute">
<item-type>Switch</item-type>
<label>Audio Zone Mute</label>
<description>Mute status of this audio zone.</description>
<category>Switch</category>
</channel-type>
<channel-type id="audio_zone_volume">
<item-type>Dimmer</item-type>
<label>Audio Zone Volume</label>
<description>Volume level of this audio zone.</description>
<category>Slider</category>
<state min="0" max="100"/>
</channel-type>
<channel-type id="audio_zone_source">
<item-type>Number</item-type>
<label>Source</label>
<description>Source for this audio zone.</description>
<category>MediaControl</category>
<state min="1" max="100"/>
</channel-type>
<channel-type id="audio_zone_control">
<item-type>Player</item-type>
<label>Control</label>
<description>Control the audio zone, e.g. start/stop/next/previous.</description>
<category>MediaControl</category>
</channel-type>
</thing:thing-descriptions>

172
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/bridge.xml Normal file
View File

@ -0,0 +1,172 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- OmniLink Controller Bridge -->
<bridge-type id="controller">
<label>OmniLink Controller</label>
<description>An OmniLink controller.</description>
<channels>
<channel id="sysdate" typeId="sysDate"/>
<channel id="enable_disable_beeper" typeId="console_enable_disable_beeper">
<label>Console Beepers</label>
</channel>
<channel id="beep" typeId="console_beep">
<label>Beep Consoles</label>
</channel>
<channel id="last_log" typeId="last_log"/>
<channel id="phone_line_event" typeId="phone_line_event"/>
<channel id="ac_power_event" typeId="ac_power_event"/>
<channel id="battery_event" typeId="battery_event"/>
<channel id="dcm_event" typeId="dcm_event"/>
<channel id="energy_cost_event" typeId="energy_cost_event"/>
<channel id="camera_trigger_event" typeId="camera_trigger_event"/>
<channel id="upb_link_activated_event" typeId="upb_link_activated_event"/>
<channel id="upb_link_deactivated_event" typeId="upb_link_deactivated_event"/>
</channels>
<properties>
<property name="model number"/>
<property name="major version"/>
<property name="minor version"/>
<property name="revision"/>
<property name="phone number"/>
</properties>
<config-description>
<parameter name="ipAddress" type="text" required="true">
<context>network-address</context>
<label>IP or Host Name</label>
<description>The IP or host name of the controller.</description>
</parameter>
<parameter name="port" type="integer" required="true">
<label>Port</label>
<description>The port of the controller.</description>
<default>4369</default>
</parameter>
<parameter name="key1" type="text" required="true">
<label>Key 1</label>
<description>The first network encription key.</description>
</parameter>
<parameter name="key2" type="text" required="true">
<label>Key 2</label>
<description>The second network encription key.</description>
</parameter>
<parameter name="logPollingInterval" type="integer" required="true">
<label>Log Polling Interval</label>
<description>The interval to poll for new log messages on the controller.</description>
<default>1</default>
</parameter>
</config-description>
</bridge-type>
<!-- Controller Channels -->
<channel-type id="sysDate">
<item-type>DateTime</item-type>
<label>Date/Time</label>
<description>Set controller date/time.</description>
<category>Time</category>
<state pattern="%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS"/>
</channel-type>
<channel-type id="last_log">
<item-type>String</item-type>
<label>Last Log Entry</label>
<description>Last log message on the controller, represented in JSON.</description>
<category>Text</category>
</channel-type>
<channel-type id="upb_link_activated_event">
<kind>trigger</kind>
<label>UPB Link</label>
<description>Event sent when a UPB link is activated.</description>
</channel-type>
<channel-type id="upb_link_deactivated_event">
<kind>trigger</kind>
<label>UPB Link</label>
<description>Event sent when a UPB link is deactivated.</description>
</channel-type>
<channel-type id="phone_line_event">
<kind>trigger</kind>
<label>Phone Line Event</label>
<description>Event sent when the phone line changes state.</description>
<event>
<options>
<option value="ON_HOOK">On Hook</option>
<option value="OFF_HOOK">Off Hook</option>
<option value="DEAD">Dead</option>
<option value="RING">Ring</option>
</options>
</event>
</channel-type>
<channel-type id="ac_power_event">
<kind>trigger</kind>
<label>AC Power Event</label>
<description>Event sent when AC trouble conditions are detected.</description>
<event>
<options>
<option value="OFF">Off</option>
<option value="RESTORED">Restored</option>
</options>
</event>
</channel-type>
<channel-type id="battery_event">
<kind>trigger</kind>
<label>Battery Event</label>
<description>Event sent when battery trouble conditions are detected.</description>
<event>
<options>
<option value="LOW">Low</option>
<option value="OK">OK</option>
</options>
</event>
</channel-type>
<channel-type id="dcm_event">
<kind>trigger</kind>
<label>DCM Event</label>
<description>Event sent when digital communicator trouble conditions are detected.</description>
<event>
<options>
<option value="TROUBLE">Trouble</option>
<option value="OK">OK</option>
</options>
</event>
</channel-type>
<channel-type id="energy_cost_event">
<kind>trigger</kind>
<label>Energy Cost Event</label>
<description>Event sent when the cost of energy changes.</description>
<event>
<options>
<option value="LOW">Trouble</option>
<option value="MID">Mid</option>
<option value="HIGH">High</option>
<option value="CRITCAL">Critical</option>
</options>
</event>
</channel-type>
<channel-type id="camera_trigger_event">
<kind>trigger</kind>
<label>Camera Trigger Event</label>
<description>Event sent when a camera trigger is detected.</description>
<event>
<options>
<option value="1">Camera 1</option>
<option value="2">Camera 2</option>
<option value="3">Camera 3</option>
<option value="4">Camera 4</option>
<option value="5">Camera 5</option>
<option value="6">Camera 6</option>
</options>
</event>
</channel-type>
</thing:thing-descriptions>

45
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/button.xml Normal file
View File

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Button Thing -->
<thing-type id="button">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Button</label>
<description>A button configured in the controller.</description>
<channels>
<channel id="press" typeId="button_press"/>
<channel id="activated_event" typeId="button_activated"/>
</channels>
<properties>
<property name="name"/>
<property name="area"/>
</properties>
<representation-property>number</representation-property>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Button Number</label>
<description>The button number.</description>
</parameter>
</config-description>
</thing-type>
<!-- Button Channels -->
<channel-type id="button_press">
<item-type>Switch</item-type>
<label>Button Press</label>
<description>Sends a button event to the controller.</description>
<category>Switch</category>
</channel-type>
<channel-type id="button_activated">
<kind>trigger</kind>
<label>Button Activated</label>
<description>Event sent when a button is activated.</description>
</channel-type>
</thing:thing-descriptions>

58
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/console.xml Normal file
View File

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Console Thing -->
<thing-type id="console">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Console</label>
<description>A console configured in the controller.</description>
<channels>
<channel id="enable_disable_beeper" typeId="console_enable_disable_beeper"/>
<channel id="beep" typeId="console_beep"/>
</channels>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Console Number</label>
<description>The console number.</description>
</parameter>
</config-description>
</thing-type>
<!-- Console Channels -->
<channel-type id="console_enable_disable_beeper">
<item-type>String</item-type>
<label>Enable/Disable Console Beeper</label>
<description>Enable/Disable the beeper for this/all console(s).</description>
<category>Switch</category>
<command>
<options>
<option value="OFF">Off</option>
<option value="ON">On</option>
</options>
</command>
</channel-type>
<channel-type id="console_beep">
<item-type>Number</item-type>
<label>Beep Console</label>
<description>Send a beep command to this/all console(s).</description>
<category>SoundVolume</category>
<state>
<options>
<option value="0">Off</option>
<option value="1">Indefinitely</option>
<option value="2">1 time</option>
<option value="3">2 times</option>
<option value="4">3 times</option>
<option value="5">4 times</option>
<option value="6">5 times</option>
</options>
</state>
</channel-type>
</thing:thing-descriptions>

57
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/humidity-sensor.xml Normal file
View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Humidity Thing -->
<thing-type id="humidity_sensor">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Humidity Sensor</label>
<description>A humidity sensor configured in the controller.</description>
<channels>
<channel id="humidity" typeId="sensor_humidity"/>
<channel id="low_setpoint" typeId="sensor_humidity_low_setpoint"/>
<channel id="high_setpoint" typeId="sensor_humidity_high_setpoint"/>
</channels>
<properties>
<property name="name"/>
<property name="area"/>
</properties>
<representation-property>number</representation-property>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Humidity Sensor Number</label>
<description>The humidity sensor number.</description>
</parameter>
</config-description>
</thing-type>
<!-- Humidity Channels -->
<channel-type id="sensor_humidity">
<item-type>Number:Dimensionless</item-type>
<label>Humidity</label>
<description>The current relative humidity at this humidity sensor.</description>
<category>Humidity</category>
<state readOnly="true" min="0" max="100" pattern="%d %%"/>
</channel-type>
<channel-type id="sensor_humidity_low_setpoint">
<item-type>Number:Dimensionless</item-type>
<label>Low SetPoint</label>
<description>The current low setpoint for this humidity sensor.</description>
<category>Humidity</category>
<state min="0" max="100" pattern="%d %%"/>
</channel-type>
<channel-type id="sensor_humidity_high_setpoint">
<item-type>Number:Dimensionless</item-type>
<label>High SetPoint</label>
<description>The current high setpoint for this humidity sensor.</description>
<category>Humidity</category>
<state min="0" max="100" pattern="%d %%"/>
</channel-type>
</thing:thing-descriptions>

38
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/lock.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="omnilink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<!-- Lock Thing -->
<thing-type id="lock">
<supported-bridge-type-refs>
<bridge-type-ref id="controller"/>
</supported-bridge-type-refs>
<label>Lock</label>
<description>An access control reader lock configured in the controller.</description>
<channels>
<channel id="switch" typeId="lock_switch"/>
</channels>
<properties>
<property name="name"/>
<property name="area"/>
</properties>
<representation-property>number</representation-property>
<config-description>
<parameter name="number" type="integer" required="true">
<label>Lock Number</label>
<description>The lock number.</description>
</parameter>
</config-description>
</thing-type>
<!-- Lock Channels -->
<channel-type id="lock_switch">
<item-type>Switch</item-type>
<label>Lock/Unlock</label>
<description>Lock or unlock this lock.</description>
<category>Switch</category>
</channel-type>
</thing:thing-descriptions>

Some files were not shown because too many files have changed in this diff Show More