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 499)

pull/1685/head
openHAB Build Server 2021-07-16 13:27:20 +00:00
parent 9be40cf376
commit 633150fd9f
29 changed files with 1099 additions and 449 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

3
_addons_bindings/caddx/readme.md
View File

@ -139,6 +139,9 @@ Caddx Alarm things support a variety of channels as seen below in the following
| panel_primary_keypad_function_without_pin | Switch | Configuration | Primary Keypad Function without PIN |
| panel_secondary_keypad_function | Switch | Configuration | Secondary Keypad Function |
| panel_zone_bypass_toggle | Switch | Configuration | Zone Bypass Toggle |
| panel_ac_fail | Switch | Configuration | AC fail |
| panel_ac_power_on | Switch | Configuration | AC Power on |
| panel_low_battery_memory | Switch | Configuration | Low Battery Memory |
| partition_bypass_code_required | Switch | Partition Condition | Bypass code required |
| partition_fire_trouble | Switch | Partition Condition | Fire trouble |
| partition_fire | Switch | Partition Condition | Fire |

2
_addons_bindings/chromecast/readme.md
View File

@ -71,7 +71,7 @@ Thing chromecast:audiogroup:bathroom [ ipAddress="192.168.0.23", port=42139]
| playuri | String | Can be used to tell the Chromecast to play media from a given url |
| appName | String | Name of currently running application |
| appId | String | ID of currently running application |
| idling | Switch | Read-only indication on weather Chromecast is on idle screen |
| idling | Switch | Read-only indication on whether Chromecast is on idle screen |
| statustext | String | |
| currentTime | Number:Time | Current time of currently playing media |
| duration | Number:Time | Duration of current track (null if between tracks) |

43
_addons_bindings/harmonyhub/readme.md
View File

@ -163,5 +163,44 @@ Example subset of values for the current activity "buttonPress" channels
Mute,VolumeDown,VolumeUp,DirectionDown,DirectionLeft,DirectionRight,DirectionUp,Select,Stop,Play,Rewind,Pause,FastForward,SkipBackward,SkipForward,Menu,Back,Home,SelectGame,PageDown,PageUp,Aspect,Display,Search,Cross,Circle,Square,Triangle,PS,Info,NumberEnter,Hyphen,Number0,Number1,Number2,Number3,Number4,Number5,Number6,Number7,Number8,Number9,PrevChannel,ChannelDown,ChannelUp,Record,FrameAdvance,C,B,D,A,Live,ThumbsDown,ThumbsUp,TiVo,WiiA,WiiB,Guide,Clear,Green,Red,Blue,Yellow,Dot,Return,Favorite,Exit,Sleep
```
A complete list of names for device buttons values can be determined via the REST API for channel-types, <http://YourServer:8080/rest/channel-types>.
Search the JSON for "harmonyhub:device".
A complete list of names for device buttons values can be determined via the REST API for channel-types. The easiest way to do this is through the API explorer:
1. Go to the main UI page for your installation
* This is usually at <http://your-openhab-ip:8080> or, in the case of openhabian, <http://openhabian:8080>
2. Login if you are not already logged in
3. Using the left panel (or three bars on the upper left corner) go to Developer Tools -> API Explorer -> channel-types
4. Click `GET` next to `/channel-types`
5. Click `Try it out`
6. Click `Execute`
7. Search the `Response Body` "harmonyhub:device" and find your device in the JSON output
The valid commands (read: values) will be listed with the device. For example, the response body might show that for `harmonyhub:device:HarmonyHub:lasko_fan` the valid commands are `PowerToggle, Speed, Timer`
{
"parameters": [],
"parameterGroups": [],
"description": "Send a button press to device Harmony Device",
"label": "Send Button Press",
"itemType": "String",
"kind": "STATE",
"stateDescription": {
"readOnly": false,
"options": [
{
"value": "PowerToggle",
"label": "Power Toggle"
},
{
"value": "Speed",
"label": "Speed"
},
{
"value": "Timer",
"label": "Timer"
}
]
},
"tags": [],
"UID": "harmonyhub:device:GreatRoom:lasko_fan:buttonPress",
"advanced": false
}

2
_addons_bindings/insteon/readme.md
View File

@ -872,7 +872,7 @@ Avoid duplicate keys by finding the highest fake product key in the `device_type
### Adding New Device Features
If you can't can't build a new device out of the existing device features (for a complete list see `device_features.xml`) you can add new features by specifying a file (let's call it `my_own_features.xml`) with the "additionalDevices" option in the network config parameters:
If you can't build a new device out of the existing device features (for a complete list see `device_features.xml`) you can add new features by specifying a file (let's call it `my_own_features.xml`) with the "additionalDevices" option in the network config parameters:
additionalFeatures="/usr/local/openhab/rt/my_own_features.xml"

6
_addons_bindings/miio/readme.md
View File

@ -91,7 +91,7 @@ However, for devices that are unsupported, you may override the value and try to
|-----------------|---------|----------|---------------------------------------------------------------------|
| host | text | true | Device IP address |
| token | text | true | Token for communication (in Hex) |
| deviceId | text | true | Device ID number for communication (in Hex) |
| deviceId | text | true | Device Id (typically a number for normal devices) for communication |
| model | text | false | Device model string, used to determine the subtype |
| refreshInterval | integer | false | Refresh interval for refreshing the data in seconds. (0=disabled) |
| timeout | integer | false | Timeout time in milliseconds |
@ -101,11 +101,11 @@ Note: Suggest to use the cloud communication only for devices that require it. I
### Example Thing file
`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="0326xxxx", model="philips.light.bulb", communication="direct" ]`
`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="326xxxx", model="philips.light.bulb", communication="direct" ]`
or in case of unknown models include the model information of a similar device that is supported:
`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId=“0470DDAA”, model="roborock.vacuum.s4", communication="cloud"]`
`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId="326xxxx", model="roborock.vacuum.s4", communication="direct" ]`
# Advanced: Unsupported devices

69
_addons_bindings/opensprinkler/readme.md
View File

@ -3,7 +3,7 @@ id: opensprinkler
label: OpenSprinkler
title: OpenSprinkler - Bindings
type: binding
description: "This binding allows allows basic control of the OpenSprinkler devices."
description: "This binding allows good and flexible control over your OpenSprinkler devices."
since: 3x
logo: images/addons/opensprinkler.png
install: auto
@ -15,32 +15,29 @@ install: auto
# OpenSprinkler Binding
This binding allows allows basic control of the OpenSprinkler devices.
Stations can be controlled to be turned on or off and rain sensor state can be read.
This binding allows good and flexible control over your OpenSprinkler devices.
You can choose to manually start, stop or delay the stand alone watering programs that are stored and run fully from the OpenSprinkler device.
Alternatively you can setup openHAB rules to control everything in more depth by setting up multiple `station` things for each watering zone to gain more in depth control.
By using the internal programs and sensors of the OpenSprinkler device, it can remove the complexity of what happens to the watering if openHAB crashes, is rebooted, or drops out of WiFi range in the middle of your watering rules.
Mixing the two concepts can also be done, the choice is yours.
## Supported Bridges
* HTTP (`http`) - The http bridge allows to communicate with an OpenSprinkler device through the network
* `OpenSprinkler HTTP Bridge` is required to communicate with an OpenSprinkler device through the network and should be added first.
## Supported Things
* OpenSprinkler Station (`station`) - to control a single station of a device, e.g. to turn it on or off
* OpenSprinkler Device (`device`) - for getting device-specific infos, e.g. if rain was detected
* `OpenSprinkler Station` is for gaining advanced controls and status information over a single station (zone) of a device, e.g. to turn it on or off, or the time remaining.
* `OpenSprinkler Device` is for device-specific controls that usually apply to multiple stations or main unit sensors, e.g. if rain was detected.
Recommend that you first add a single `device` thing and then if you need the extra controls, add as many of the `station` things as you wish.
## Discovery
OpenSprinkler devices can be manually discovered by sending a request to every IP on the network.
Discovery needs to be run manually as this is a brute force method of finding devices that can saturate network or device available bandwidth.
OpenSprinkler devices can be discovered by the binding sending requests to every IP on your network.
Due to this method used, it is very slow at finding devices and can saturate network bandwidth.
## Thing Configuration
OpenSprinkler using the HTTP interface
```
Bridge opensprinkler:http:http [hostname="127.0.0.1", port=80, password="opendoor", refresh=60] {
Thing station 01 [stationIndex=1]
}
```
## Bridge ('http') Configuration
- hostname: Hostname or IP address of the OpenSprinkler HTTP API.
- port: Port the OpenSprinkler device is listening on. Usually 80.
@ -51,42 +48,54 @@ Bridge opensprinkler:http:http [hostname="127.0.0.1", port=80, password="opendoo
### Station Thing Configuration
The `station` thing can be used with both bridge and has the following configuration properties:
The `station` thing must be used with a `http` bridge and has the following configuration properties:
- stationIndex: The index of the station to communicate with, starting with 0 for the first station
## Channels
The following channel is supported by the `station` thing.
The following channels are supported by the `station` thing.
| Channel Type ID | Item Type | | Description |
|--------------------|-------------|----|----------------------------------------------------------|
| stationState | Switch | RW | This channel indicates whether station 01 is on or off. |
| stationState | Switch | RW | This channel indicates whether the station is on or off. |
| remainingWaterTime | Number:Time | R | The time the station remains to be open. |
| nextDuration | Number:Time | RW | A configuration item, which time, if linked, will be |
| | | | used as the time the station will be kept open when |
| | | | switched on. It is advised to add persistence for items |
| | | | linked to this channel, the binding does not persist |
| | | | values of it. |
| nextDuration | Number:Time | RW | The amount of time that will be used to keep the station |
| | | | open when next manually switched on. If not set, this |
| | | | value will default to 18 hours which is the maximum time |
| | | | supported. |
| queued | Switch | RW | Indicates that the station is queued to be turned on. |
| | | | The channel cannot be turned on, only turning it off is |
| | | | supported (which removes the station from the queue). |
| ignoreRain | Switch | RW | This channel makes the station ignore the rain delay. |
When using the `nextDuration` channel, it is advised to setup persistence (e.g. MapDB) in order to persist the value through restarts.
The following is supported by the `device` thing, but only when connected using the http interface.
The following channels are supported by the `device` thing.
NOTE: Some channels will only show up if the hardware has the required sensor and is setup correctly.
| Channel Type ID | Item Type | | Description |
|-----------------|------------------------|----|------------------------------------------------------------------------------------|
| rainsensor | Switch | RO | This channel indicates whether rain is detected by the device or not. |
| currentDraw | Number:ElectricCurrent | RO | Shows the current draw of the device. If the device does not have sensors |
| | | | for this metric, the channel will not be available. |
| sensor2 | Switch | RO | This channel is for the second sensor (if your hardware supports it). |
| currentDraw | Number:ElectricCurrent | RO | Shows the current draw of the device. |
| waterlevel | Number:Dimensionless | RO | This channel shows the current water level in percent (0-250%). The water level is |
| | | | calculated based on the weather and influences the duration of the water programs. |
| signalStrength | Number | RO | Shows how strong the WiFi Signal is. |
| flowSensorCount | Number:Dimensionless | RO | Shows the number of pulses the optional water flow sensor has reported. |
| programs | String | RW | Displays a list of the programs that are setup in your OpenSprinkler and when |
| | | | selected will start that program for you. |
| stations | String | RW | Display a list of stations that can be run when selected to the length of time set |
| | | | in the `nextDuration` channel. |
| nextDuration | Number:Time | RW | The time the station will open for when any stations are selected from the |
| | | | `stations` channel. Defaults to 30 minutes if not set. |
| resetStations | Switch | RW | The ON command will stop all stations immediately, including those waiting to run. |
| enablePrograms | Switch | RW | Allow programs to auto run. When OFF, manually started stations will still work. |
| rainDelay | Number:Time | RW | Sets/Shows the amount of time (hours) that rain has caused programs to be delayed. |
## Example
## Textual Example
demo.Things:
demo.things:
```
Bridge opensprinkler:http:http [hostname="127.0.0.1", port=81, password="opendoor"] {

23
_addons_bindings/openwebnet/readme.md
View File

@ -35,14 +35,15 @@ In order for this binding to work, a **BTicino/Legrand OpenWebNet gateway** is n
These gateways have been tested with the binding:
- **IP gateways** or scenario programmers, such as BTicino
[F454](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=006),
[MyHOMEServer1](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=067),
[MyHOME_Screen10](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=001),
[MH201](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=053),
[MH202](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=059),
[F455](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=051),
[MH200N](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=016),
[F453](https://www.homesystems-legrandgroup.com/BtHomeSystems/productDetail.action?lang=EN&productId=027), etc.
[F454](https://catalogue.bticino.com/BTI-F454-EN),
[MyHOMEServer1](https://catalogue.bticino.com/BTI-MYHOMESERVER1-EN),
[MyHOME_Screen10 (MH4893C)](https://catalogue.bticino.com/BTI-MH4893C-EN),
[MyHOME_Screen3,5 (LN4890)](https://catalogue.bticino.com/BTI-LN4890-EN),
[MH201](https://catalogue.bticino.com/BTI-MH201-EN),
[MH202](https://catalogue.bticino.com/BTI-MH202-EN),
[F455](https://www.homesystems-legrandgroup.com/home?p_p_id=it_smc_bticino_homesystems_search_AutocompletesearchPortlet&p_p_lifecycle=0&p_p_state=normal&p_p_mode=view&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_journalArticleId=2481871&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_mvcPath=%2Fview_journal_article_content.jsp),
[MH200N](https://www.homesystems-legrandgroup.com/home?p_p_id=it_smc_bticino_homesystems_search_AutocompletesearchPortlet&p_p_lifecycle=0&p_p_state=normal&p_p_mode=view&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_journalArticleId=2469209&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_mvcPath=%2Fview_journal_article_content.jsp),
[F453](https://www.homesystems-legrandgroup.com/home?p_p_id=it_smc_bticino_homesystems_search_AutocompletesearchPortlet&p_p_lifecycle=0&p_p_state=normal&p_p_mode=view&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_journalArticleId=2703566&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_mvcPath=%2Fview_journal_article_content.jsp), etc.
- **ZigBee USB Gateways**, such as [BTicino 3578](https://catalogo.bticino.it/BTI-3578-IT), also known as Legrand 088328
@ -54,10 +55,10 @@ The following Things and OpenWebNet `WHOs` are supported:
| Category | WHO | Thing Type IDs | Description | Status |
| -------------------- | :----------: | :---------------------------------: | ---------------------------------------------------------------- | ---------------- |
| Gateway Management | `13` | `bus_gateway` | Any IP gateway supporting OpenWebNet protocol should work (e.g. F454 / MyHOMEServer1 / MH202 / F455 / MH200N, ...) | Successfully tested: F454, MyHOMEServer1, MyHOME_Screen10, F455, F452, F453AV, MH201, MH202, MH200N. Some connection stability issues/gateway resets reported with MH202 |
| Gateway Management | `13` | `bus_gateway` | Any IP gateway supporting OpenWebNet protocol should work (e.g. F454 / MyHOMEServer1 / MH202 / F455 / MH200N, ...) | Successfully tested: F454, MyHOMEServer1, MyHOME_Screen10, MyHOME_Screen3,5, F455, F452, F453AV, MH201, MH202, MH200N. Some connection stability issues/gateway resets reported with MH202 |
| Lighting | `1` | `bus_on_off_switch`, `bus_dimmer` | BUS switches and dimmers | Successfully tested: F411/2, F411/4, F411U2, F422, F429. Some discovery issues reported with F429 (DALI Dimmers) |
| Automation | `2` | `bus_automation` | BUS roller shutters, with position feedback and auto-calibration | Successfully tested: LN4672M2 |
| Temperature Control | `4` | `bus_thermo_zone`, `bus_thermo_sensor` | Thermo zones management and temperature sensors (probes). NOTE Central Units (4 or 99 zones) are not fully supported yet. See [Channels - Thermo](#configuring-thermo) for more details. | Successfully tested: H/LN4691, KG4691; thermo sensors: L/N/NT4577 + 3455 |
| Temperature Control | `4` | `bus_thermo_zone`, `bus_thermo_sensor` | Thermo zones management and temperature sensors (probes). NOTE Central Units (4 or 99 zones) are not fully supported yet. See [Channels - Thermo](#configuring-thermo) for more details. | Successfully tested: H/LN4691, HS4692, KG4691; thermo sensors: L/N/NT4577 + 3455 |
| Energy Management | `18` | `bus_energy_meter` | Energy Management | Successfully tested: F520, F521 |
### For ZigBee (Radio)
@ -146,7 +147,7 @@ In BTicino MyHOME Thermoregulation (WHO=4) each **zone** has associated a thermo
Thermo zones can be configured defining a `bus_thermo_zone` Thing for each zone with the following parameters:
- the `where` config parameter (`OpenWebNet Device Address`):
- example BUS/SCS Thermo `zone=1` --> `where="1"`
- example BUS/SCS Thermo zone `1` --> `where="1"`
- the `standAlone` config parameter (`boolean`, default: `true`): identifies if the zone is managed or not by a Central Unit (4 or 99 zones). `standAlone=true` means no Central Unit is present in the system.
Temperature sensors can be configured defining a `bus_thermo_sensor` Thing with the following parameters:

68
_addons_bindings/pushsafer/readme.md Normal file
View File

@ -0,0 +1,68 @@
---
id: pushsafer
label: Pushsafer
title: Pushsafer - Bindings
type: binding
description: "The Pushsafer binding allows you to notify mobile devices of a message using the [Pushsafer API](https://www.pushsafer.com/pushapi)."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Pushsafer Binding
The Pushsafer binding allows you to notify mobile devices of a message using the [Pushsafer API](https://www.pushsafer.com/pushapi).
To get started you first need to register (a free process) to get a Private Key.
Initially you have to register a device with one of the [client apps](https://www.pushsafer.com/apps), to get a device id.
## Supported Things
There is only one Thing available - the `pushsafer-account`.
You are able to create multiple instances of this Thing to broadcast to different devices or groups with push-notification content and setting.
## Thing Configuration
| Configuration Parameter | Type | Description |
|-------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| `apikey` | text | Your private-key to access the Pushsafer [Message API](https://www.pushsafer.com/pushapi). **mandatory** |
| `user` | text | Your username or email address to validate against the Pushsafer Message API. **mandatory** |
| `device` | text | Your device or group id to which device(s) you want to push notifications. **mandatory** |
| `title` | text | The default title of a message (default: `"openHAB"`). |
| `format` | text | The default format (`"none"`, `"HTML"` or `"monospace"`) of a message (default: `none`). |
| `sound` | text | The default notification sound on target device (default: `1`) (see [supported notification sounds](https://www.pushsafer.com/pushapi#api-sound)). |
| `vibration` | text | How often the device should vibrate. empty=device default or a number 1-3. |
| `icon` | text | The default notification icon on target device (default: `1`) (see [supported notification icons](https://www.pushsafer.com/pushapi#api-icon)). |
| `color` | text | The color (hexadecimal) of notification icon (e.g. #FF0000). |
| `url` | text | URL or [URL Scheme](https://www.pushsafer.com/url_schemes) send with notification. |
| `urlTitle` | text | Title of URL. |
| `retry` | integer | The retry parameter specifies how often (in seconds) the Pushsafer servers will send the same notification to the user (default: `300`). **advanced** |
| `expire` | integer | The expire parameter specifies how long (in seconds) your notification will continue to be retried (default: `3600`). **advanced** |
| `confirm` | integer | Integer 10-10800 (10s steps) Time in seconds after which a message should be sent again before it is confirmed. (default: `0`). **advanced** |
| `time2live` | integer | Time in minutes, after a message automatically gets purged (default: `0`). **advanced** |
| `answer` | integer | 1 = enables reply to push notifications (default: `0`). **advanced** |
The `retry` and `expire` parameters are only used for emergency-priority notifications.
## Channels
Currently the binding does not support any Channels.
## Thing Actions
All actions return a `Boolean` value to indicate if the message was sent successfully or not.
The parameter `message` is **mandatory**, the `title` parameter defaults to whatever value you defined in the `title` related configuration parameter.
- `sendPushsaferMessage(String message, @Nullable String title)` - This method is used to send a plain text message.
- `sendPushsaferHtmlMessage(String message, @Nullable String title)` - This method is used to send a HTML message.
- `sendPushsaferMonospaceMessage(String message, @Nullable String title)` - This method is used to send a monospace message.
- `sendPushsaferAttachmentMessage(String message, @Nullable String title, String attachment, @Nullable String contentType, @Nullable String authentication)` - This method is used to send a message with an image attachment. It takes a local path or url to the image attachment (parameter `attachment` **mandatory**), an optional `contentType` to define the content-type of the attachment (default: `"jpeg"`, possible values: `"jpeg"`, `"png"`, `"gif"`) and an optional `authentication` for the given URL to define the authentication if needed (default: `""`, example: `"user:password"`).
- `sendPushsaferURLMessage(String message, @Nullable String title, String url, @Nullable String urlTitle)` - This method is used to send a message with an URL. A supplementary `url` to show with the message and a `urlTitle` for the URL, otherwise just the URL is shown.
- `sendPushsaferPriorityMessage(String message, @Nullable String title, @Nullable Integer priority)` - This method is used to send a priority message. Parameter `priority` is the priority (`-2`, `-1`, `0`, `1`, `2`) to be used (default: `2`).

3
_addons_bindings/telegram/readme.md
View File

@ -25,6 +25,7 @@ As described in the Telegram Bot API (https://core.telegram.org/bots#6-botfather
- On a Telegram client open a chat with BotFather.
- Send `/newbot` to BotFather and fill in all the needed information. The authentication token that is given will be needed in the next steps.
- The token is a combination with double point separated parts of numbers and letters e.g.: 158642643:ABCHL_O-MUovQ1NzrDF5R_nqLbFhPPrg9Jps
2. Create the destination chat
@ -32,7 +33,7 @@ As described in the Telegram Bot API (https://core.telegram.org/bots#6-botfather
3. Get the chatID
- Open a browser and invoke `https://api.telegram.org/bot<token>/getUpdates` (where `<token>` is the authentication token previously obtained)
- Open a browser and invoke `https://api.telegram.org/bot<token>/getUpdates` (where `<token>` is the authentication token previously obtained e.g.: `https://api.telegram.org/bot158642643:ABCHL_O-MUovQ1NzrDF5R_nqLbFhPPrg9Jps/getUpdates`)
- Look at the JSON result to find the value of `id`: that's the chatID.
Note that if using a Telegram group chat, the group chatIDs are prefixed with a dash that must be included in the config (e.g. `-22334455`).

100
_addons_bindings/volvooncall/readme.md
View File

@ -55,59 +55,59 @@ The 'VolvoOnCall API' bridge uses the owner's email address and password in orde
All numeric channels use the [UoM feature](https://openhab.org/blog/2018/02/22/units-of-measurement.html).
This means you can easily change the desired unit e.g. miles/h instead of km/h just in your item definition.
#####Thing properties
Some of the channels are only available for specific cars and models.
Some of the channels are only available for specific cars and models. These properties are added to the Thing
automatically by the binding when an API call is made.
Following channels are currently available:
| Channel Type ID | Item Type | Description | Remark |
|-----------------------------------------------|----------------------|--------------------------------------------------|--------------------------------------------------|
| doors#frontLeft | Contact | Door front left | |
| doors#frontRight | Contact | Door front right | |
| doors#rearLeft | Contact | Door rear left | |
| doors#rearRight | Contact | Door rear right | |
| doors#hood | Contact | Hood | |
| doors#tailgate | Contact | Tailgate | |
| doors#carLocked | Switch | Is the car locked | Can also be used to lock / unlock the car (see thing properties above) |
| windows#frontLeftWnd | Contact | Window front left | |
| windows#frontRightWnd | Contact | Window front right | |
| windows#rearLeftWnd | Contact | Window rear left | |
| windows#rearRightWnd | Contact | Window rear right | |
| odometer#odometer | Number:Length | Odometer value | |
| odometer#tripmeter1 | Number:Length | Trip meter 1 value | |
| odometer#tripmeter2 | Number:Length | Trip meter 2 value | |
| tank#fuelAmount | Number:Volume | Amount of fuel left in the tank | |
| tank#fuelLevel | Number:Dimensionless | Percentage of fuel left in the tank | |
| tank#fuelAlert | Switch | Alert if the amount of fuel is running low | ON when distancy to empty < 100 |
| tank#distanceToEmpty | Number:Length | Distance till tank is empty | |
| position#location | Location | Location of the car | |
| position#locationTimestamp | DateTime | Timestamp of the latest confirmed location | |
| tyrePressure#frontLeftTyre | Number | Tyrepressure front left tyre | Normal / LowSoft |
| tyrePressure#frontRightTyre | Number | Tyrepressure front right tyre | Normal / LowSoft |
| tyrePressure#rearLeftTyre | Number | Tyrepressure rear left tyre | Normal / LowSoft |
| tyrePressure#rearRightTyre | Number | Tyrepressure rear right tyre | Normal / LowSoft |
| other#averageSpeed | Number:Speed | Average speed | |
| other#engineRunning | Switch | Is the car engine running | |
| other#remoteHeater | Switch | Start the car remote heater | Only if property 'remoteHeater' is true (see thing properties above) |
| other#preclimatization | Switch | Start the car preclimatization | Only if property 'preclimatization' is true (see thing properties above) |
| other#brakeFluidLevel | Number | Brake fluid level | Normal / Low / VeryLow |
| other#washerFluidLevel | Number | Washer fluid level | Normal / Low / VeryLow |
| other#serviceWarning | String | Warning if service is needed | |
| other#bulbFailure | Switch | ON if at least one bulb is reported as failed | |
| battery#batteryLevel | Number:Dimensionless | Battery level | Only for Plugin hybrid / Twin Engine models |
| battery#batteryDistanceToEmpty | Number:Length | Distance until battery is empty | Only for Plugin hybrid / Twin Engine models |
| battery#chargeStatus | String | Charging status | Only for Plugin hybrid / Twin Engine models |
| battery#timeToHVBatteryFullyCharged | Number:Time | Time in minutes until the battery is fully charged| Only for Plugin hybrid / Twin Engine models |
| battery#chargingEnd | DateTime | Calculated time when the battery is fully charged| Only for Plugin hybrid / Twin Engine models |
| lasttrip#tripConsumption | Number:Volume | Last trip fuel consumption | |
| lasttrip#tripDistance | Number:Length | Last trip distance | |
| lasttrip#tripStartTime | DateTime | Last trip start time | |
| lasttrip#tripEndTime | DateTime | Last trip end time | |
| lasttrip#tripDuration | Number:Time | Last trip duration | |
| lasttrip#tripStartOdometer | Number:Length | Last trip start odometer | |
| lasttrip#tripStopOdometer | Number:Length | Last trip stop odometer | |
| lasttrip#startPosition | Location | Last trip start location | |
| lasttrip#endPosition | Location | Last trip end location | |
| Channel Type ID | Item Type | Description | Remark |
|-----------------------------------------------|----------------------|----------------------------------------------------|------------------------------------------------|
| doors#frontLeft | Contact | Door front left | |
| doors#frontRight | Contact | Door front right | |
| doors#rearLeft | Contact | Door rear left | |
| doors#rearRight | Contact | Door rear right | |
| doors#hood | Contact | Hood | |
| doors#tailgate | Contact | Tailgate | |
| doors#carLocked | Switch | Is the car locked | Can also be used to lock / unlock the car. Only if property 'lock' is true. |
| windows#frontLeftWnd | Contact | Window front left | |
| windows#frontRightWnd | Contact | Window front right | |
| windows#rearLeftWnd | Contact | Window rear left | |
| windows#rearRightWnd | Contact | Window rear right | |
| odometer#odometer | Number:Length | Odometer value | |
| odometer#tripmeter1 | Number:Length | Trip meter 1 value | |
| odometer#tripmeter2 | Number:Length | Trip meter 2 value | |
| tank#fuelAmount | Number:Volume | Amount of fuel left in the tank | |
| tank#fuelLevel | Number:Dimensionless | Percentage of fuel left in the tank | |
| tank#fuelAlert | Switch | Alert if the amount of fuel is running low | ON when distancy to empty < 100 |
| tank#distanceToEmpty | Number:Length | Distance till tank is empty | |
| position#location | Location | Location of the car | |
| position#locationTimestamp | DateTime | Timestamp of the latest confirmed location | |
| tyrePressure#frontLeftTyre | Number | Tyrepressure front left tyre | Normal / LowSoft |
| tyrePressure#frontRightTyre | Number | Tyrepressure front right tyre | Normal / LowSoft |
| tyrePressure#rearLeftTyre | Number | Tyrepressure rear left tyre | Normal / LowSoft |
| tyrePressure#rearRightTyre | Number | Tyrepressure rear right tyre | Normal / LowSoft |
| other#averageSpeed | Number:Speed | Average speed | |
| other#engineRunning | Switch | Is the car engine running | |
| other#remoteHeater | Switch | Start the car remote heater | Only if property 'remoteHeater' is true |
| other#preclimatization | Switch | Start the car preclimatization | Only if property 'preclimatization' is true |
| other#brakeFluidLevel | Number | Brake fluid level | Normal / Low / VeryLow |
| other#washerFluidLevel | Number | Washer fluid level | Normal / Low / VeryLow |
| other#serviceWarning | String | Warning if service is needed | |
| other#bulbFailure | Switch | ON if at least one bulb is reported as failed | |
| battery#batteryLevel | Number:Dimensionless | Battery level | Only for Plugin hybrid / Twin Engine models |
| battery#batteryDistanceToEmpty | Number:Length | Distance until battery is empty | Only for Plugin hybrid / Twin Engine models |
| battery#chargeStatus | String | Charging status | Only for Plugin hybrid / Twin Engine models |
| battery#timeToHVBatteryFullyCharged | Number:Time | Time in minutes until the battery is fully charged | Only for Plugin hybrid / Twin Engine models |
| battery#chargingEnd | DateTime | Calculated time when the battery is fully charged | Only for Plugin hybrid / Twin Engine models |
| lasttrip#tripConsumption | Number:Volume | Last trip fuel consumption | |
| lasttrip#tripDistance | Number:Length | Last trip distance | |
| lasttrip#tripStartTime | DateTime | Last trip start time | |
| lasttrip#tripEndTime | DateTime | Last trip end time | |
| lasttrip#tripDuration | Number:Time | Last trip duration | |
| lasttrip#tripStartOdometer | Number:Length | Last trip start odometer | |
| lasttrip#tripStopOdometer | Number:Length | Last trip stop odometer | |
| lasttrip#startPosition | Location | Last trip start location | |
| lasttrip#endPosition | Location | Last trip end location | |
## Events

6
_addons_bindings/zwave/doc/bremicker/abuscfa3010_0_0.md
View File

@ -99,7 +99,7 @@ The following table summarises the channels available for the CFA3010 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Door Lock | lock_door | lock_door | Door | Switch |
| Door Sensor | sensor_door | sensor_door | Door | Contact |
| Door Sensor (unsupported) | sensor_door | sensor_door | Door | Contact |
| Alarm (access) | alarm_access | alarm_access | Door | Switch |
| Alarm (power) | alarm_power | alarm_power | Energy | Switch |
| Alarm (system) | alarm_system | alarm_system | | Switch |
@ -116,7 +116,9 @@ The following state translation is provided for this channel to the ```Switch```
| ON | Locked |
| OFF | Unlocked |
### Door Sensor
### Door Sensor (unsupported)
The door sensor is currently not supported and (as far as ABUS feedback is concerned) won't be in the near future.
Indicates if the door/window is open or closed.
The ```sensor_door``` channel is of type ```sensor_door``` and supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device.

424
_addons_bindings/zwave/doc/ring/keypad_0_0.md Normal file
View File

@ -0,0 +1,424 @@
---
layout: documentation
title: Keypad 2nd Gen - ZWave
---
{% include base.html %}
# Keypad 2nd Gen Alarm Keypad 2nd Gen
This describes the Z-Wave device *Keypad 2nd Gen*, manufactured by *Ring* with the thing type UID of ```ring_keypad_00_000```.
The device is in the category of *Battery*, defining Batteries, Energy Storages.
![Keypad 2nd Gen product image](https://opensmarthouse.org/zwavedatabase/1398/image/)
The Keypad 2nd Gen 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.
## Overview
Ring Alarm features a Z-Wave keypad, will act as an arming station for the Ring Alarm system. In addition to smartphone and web apps, the keypad provides users with an alternative interface for their alarm system. The keypad allows the user to arm and disarm their system, view system status and receive visual and audio feedback regarding system status and events. Designed for convenience, the keypad can be mounted on the wall or left on a tabletop. Additionally, a rechargeable battery and AC power option provide users with the flexibility to use the keypad in ways which work best for each individual. This keypad gives users a home arming station without having to worry about wiring, picking the right location, complicated hardware installation or making modifications to their homes.
The keypad will include an interactive button interface, an informational display, a speaker, various LED lights, wall mount option, battery power, AC power option, and additional features to extend control of the Ring Protect system beyond the user’s mobile device and web applications. The keypad is intended to be used as a “dumb” terminal and will be non-programmable for end users.
see https://ring.com/products/alarm-keypad-v2 for further information.
### Inclusion Information
1. Activate inclusion mode on controller
2. hold button 1 on keypad for 3 seconds to enter inclusion mode
3. Device should appear in inbox
### Exclusion Information
1. Initiate exclusion mode on controller
2. hold button 1 on kepad for 3 seconds.
3. buttons on keypad should no longer beep when pressed
### General Usage Information
## Channels
The following table summarises the channels available for the Keypad 2nd Gen -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch |
| Alarm (power) | alarm_power | alarm_power | Energy | Switch |
| Alarm (system) | alarm_system | alarm_system | | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### Alarm (burglar)
Indicates if the burglar alarm is triggered.
The ```alarm_burglar``` channel is of type ```alarm_burglar``` and supports the ```Switch``` item and is in the ```Door``` 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 |
### 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 |
### Alarm (system)
Indicates if a system alarm is triggered.
The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. 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 |
### 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 following table provides a summary of the 22 configuration parameters available in the Keypad 2nd Gen.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Heartbeats | This parameter is the number minutes between heartbeats. Heartbeats are automatic battery reports on a timer after the last event. |
| 2 | Application Level Retries | Number of application level retries attempted for messages either not ACKed or messages encapsulated via supervision get that did not receive a report. |
| 3 | Application Level Retry Base Wait Time Period | The number base seconds used in the calculation for sleeping between retry messages. |
| 4 | Announcement Audio Volume | Announcement Audio Volume (for audio files - should this be lumped into one of the other volume settings?) |
| 5 | Key Tone Volume | Key Tone Volume |
| 6 | Siren Volume | Siren Volume |
| 7 | Long press emergency duration | Long press emergency duration (seconds) This parameter allows a user to configure the duration in seconds for the hold time required to capture a long press . This includes Emergency Buttons + Mode Buttons (Police, Fire, Medical, Disarmed, Home, Away) |
| 8 | Long press number pad duration | Long press number pad duration (seconds) This parameter allows a user to configure the duration in seconds for the hold time required to capture a long press . This includes Number Pad + Check & X (0-9, Check, X) |
| 9 | Proximity Display Timeout | Proximity Display Timeout : Timeout in seconds when proximity is detected and no input is received |
| 10 | Button Press Display Timeout | Button Press Display Timeout : Timeout in seconds when any button is pressed, but a sequence is not completed and buttons are no longer being pressed |
| 11 | Status Change Display Timeout | Status Change Display Timeout: Timeout in seconds when indicator command is received from the hub to change status |
| 12 | Security Mode Brightness | Security Mode Brightness: Adjusts the brightness of the security mode buttons |
| 13 | Key Backlight Brightness | Key Backlight Brightness: Adjusts the brightness of the keypad backlight. Used for Key Backlight LEDs only Available settings: 0-100% |
| 14 | Ambient Light Sensor Level | Ambient Light Sensor Level: Light threshold where keypad will stop backlighting if higher than |
| 15 | Proximity On/OFF | Proximity On/OFF: Turn On and Off the Proximity Detection. |
| 16 | Ramp Time Config | Ramp Time Config: Ramp time in milliseconds to turn the LEDs on/off. Applies to all LEDs on the keypad |
| 17 | Low Battery Threshold | Low Battery Threshold - The percentage level at which the display would turn on the yellow battery indicator (whenever the display is on). |
| 18 | Languages Set | Languages Set: bit number in the languages supported bitmask to set |
| 19 | Warn Battery Threshold | Warn Battery Threshold - The percentage level at which the display would turn on the red battery indicator (whenever the display is on) |
| 20 | Supervisory Report response time | The number of milliseconds waiting for a Supervisory Report response to a Supervisory Get encapsulated command from the device before attempting a retry |
| 21 | System Security Mode Display | System Security Mode Display: (Always, Sometimes, Never). 601 = Always On , 1 - 600 = periodic interval, 0 = Always |
| 22 | Languages Supported (Get) | Languages Supported (Get): returns bitmask of languages supported. Bits set to 1 indicate that the language is supported |
### Parameter 1: Heartbeats
This parameter is the number minutes between heartbeats. Heartbeats are automatic battery reports on a timer after the last event.
Values in the range 0 to 70 may be set.
The manufacturer defined default value is ```70```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Application Level Retries
Number of application level retries attempted for messages either not ACKed or messages encapsulated via supervision get that did not receive a report.
Values in the range 0 to 5 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Application Level Retry Base Wait Time Period
The number base seconds used in the calculation for sleeping between retry messages.
Values in the range 1 to 60 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_3_0``` and is of type ```INTEGER```.
### Parameter 4: Announcement Audio Volume
Announcement Audio Volume (for audio files - should this be lumped into one of the other volume settings?)
Values in the range 0 to 210 may be set.
The manufacturer defined default value is ```7```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Key Tone Volume
Key Tone Volume
Values in the range 0 to 10 may be set.
The manufacturer defined default value is ```6```.
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Siren Volume
Siren Volume
Values in the range 0 to 10 may be set.
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Parameter 7: Long press emergency duration
Long press emergency duration (seconds) This parameter allows a user to configure the duration in seconds for the hold time required to capture a long press . This includes Emergency Buttons + Mode Buttons (Police, Fire, Medical, Disarmed, Home, Away)
Values in the range 2 to 5 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Long press number pad duration
Long press number pad duration (seconds) This parameter allows a user to configure the duration in seconds for the hold time required to capture a long press . This includes Number Pad + Check & X (0-9, Check, X)
Values in the range 2 to 5 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```.
### Parameter 9: Proximity Display Timeout
Proximity Display Timeout : Timeout in seconds when proximity is detected and no input is received
Values in the range 0 to 30 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```.
### Parameter 10: Button Press Display Timeout
Button Press Display Timeout : Timeout in seconds when any button is pressed, but a sequence is not completed and buttons are no longer being pressed
Values in the range 0 to 30 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```.
### Parameter 11: Status Change Display Timeout
Status Change Display Timeout: Timeout in seconds when indicator command is received from the hub to change status
Values in the range 0 to 30 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```.
### Parameter 12: Security Mode Brightness
Security Mode Brightness: Adjusts the brightness of the security mode buttons
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```100```.
This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```.
### Parameter 13: Key Backlight Brightness
Key Backlight Brightness: Adjusts the brightness of the keypad backlight. Used for Key Backlight LEDs only Available settings: 0-100%
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```100```.
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 14: Ambient Light Sensor Level
Ambient Light Sensor Level: Light threshold where keypad will stop backlighting if higher than
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```.
### Parameter 15: Proximity On/OFF
Proximity On/OFF: Turn On and Off the Proximity Detection.
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```.
### Parameter 16: Ramp Time Config
Ramp Time Config: Ramp time in milliseconds to turn the LEDs on/off. Applies to all LEDs on the keypad
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```50```.
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 17: Low Battery Threshold
Low Battery Threshold - The percentage level at which the display would turn on the yellow battery indicator (whenever the display is on).
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```15```.
This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```.
### Parameter 18: Languages Set
Languages Set: bit number in the languages supported bitmask to set
Values in the range 0 to 31 may be set.
The manufacturer defined default value is ```30```.
This parameter has the configuration ID ```config_18_0``` and is of type ```INTEGER```.
### Parameter 19: Warn Battery Threshold
Warn Battery Threshold - The percentage level at which the display would turn on the red battery indicator (whenever the display is on)
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Parameter 20: Supervisory Report response time
The number of milliseconds waiting for a Supervisory Report response to a Supervisory Get encapsulated command from the device before attempting a retry
Values in the range 500 to 5000 may be set.
The manufacturer defined default value is ```1500```.
This parameter has the configuration ID ```config_20_2``` and is of type ```INTEGER```.
### Parameter 21: System Security Mode Display
System Security Mode Display: (Always, Sometimes, Never). 601 = Always On , 1 - 600 = periodic interval, 0 = Always
Values in the range 0 to 601 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_21_2``` and is of type ```INTEGER```.
### Parameter 22: Languages Supported (Get)
Languages Supported (Get): returns bitmask of languages supported. Bits set to 1 indicate that the language is supported
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_22_4``` and is of type ```INTEGER```.
This is a read only parameter.
## 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 Keypad 2nd Gen 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.
Controller Updates
1. Notification Report
   a. See notification CC section for notifications that are sent
2. Entry Control Notification
3. Battery Report
4. Device Reset Locally Notification
Association group 1 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_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_BATTERY_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
* [devicemanual](https://opensmarthouse.org/zwavedatabase/1398/reference/Ring_Alarm_Keypad_Zwave_2nd_Gen.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/1398).

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

@ -60,6 +60,11 @@
<default>16</default>
</parameter>
<parameter name="ignoreZoneStatusTransitions" type="boolean" required="true">
<label>Ignore Zone Status Transitions</label>
<description>Flag specifying if the Zone Status Transitions should be ignored</description>
<default>false</default>
</parameter>
</config-description>
</bridge-type>

14
_thing_types/org.openhab.binding.caddx/src/main/resources/OH-INF/thing/panel.xml
View File

@ -200,6 +200,20 @@
<label>Zone Bypass Toggle</label>
<description>Zone Bypass Toggle</description>
</channel>
<channel id="panel_ac_fail" typeId="panel_flag">
<label>AC fail</label>
<description>AC fail</description>
</channel>
<channel id="panel_ac_power_on" typeId="panel_flag">
<label>AC Power On</label>
<description>AC Power On</description>
</channel>
<channel id="panel_low_battery_memory" typeId="panel_flag">
<label>Low Battery Memory</label>
<description>Low Battery Memory</description>
</channel>
</channels>
</thing-type>

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

@ -24,9 +24,22 @@
<channel id="inverterdatachanneludc" typeId="udc"/>
<channel id="inverterdatadevicestatuserrorcode" typeId="devicestatus_errorcode"/>
<channel id="inverterdatadevicestatusstatuscode" typeId="devicestatus_statuscode"/>
<channel id="powerflowchannelpgrid" typeId="pGrid"/>
<channel id="powerflowchannelpgrid" typeId="pGrid">
<label>Grid Power</label>
</channel>
<channel id="powerflowchannelpload" typeId="pLoad"/>
<channel id="powerflowchannelpakku" typeId="pAkku"/>
<channel id="powerflowchannelpakku" typeId="pAkku">
<label>Charge / Discharge of Battery</label>
</channel>
<channel id="powerflowchannelppv" typeId="pPv">
<label>Current Solar Yield</label>
</channel>
<channel id="powerflowinverter1power" typeId="inverter1Power">
<label>Power Flow (Inverter 1)</label>
</channel>
<channel id="powerflowinverter1soc" typeId="inverter1Soc">
<label>State of Charge (Inverter 1)</label>
</channel>
</channels>
<config-description>
@ -179,22 +192,40 @@
</channel-type>
<channel-type id="pGrid">
<item-type>Number</item-type>
<item-type>Number:Power</item-type>
<label>Grid Power</label>
<description>Grid Power ( + from grid, - to grid )</description>
<state pattern="%.2f W" readOnly="true"></state>
<state pattern="%.2f %unit%" readOnly="true"></state>
</channel-type>
<channel-type id="pLoad">
<item-type>Number</item-type>
<item-type>Number:Power</item-type>
<label>Load Power</label>
<description>Load Power ( + generator, - consumer )</description>
<state pattern="%.2f W" readOnly="true"></state>
<state pattern="%.2f %unit%" readOnly="true"></state>
</channel-type>
<channel-type id="pAkku">
<item-type>Number</item-type>
<item-type>Number:Power</item-type>
<label>Battery Power</label>
<description>Battery Power ( + charge, - discharge )</description>
<state pattern="%.2f W" readOnly="true"></state>
<description>Battery Power ( + discharge, - charge )</description>
<state pattern="%.1f %unit%" readOnly="true"></state>
</channel-type>
<channel-type id="pPv">
<item-type>Number:Power</item-type>
<label>Solar Plant Power</label>
<description>Current Solar Plant Power</description>
<state pattern="%.2f %unit%" readOnly="true"></state>
</channel-type>
<channel-type id="inverter1Power">
<item-type>Number:Power</item-type>
<label>Inverter 1 Power</label>
<description>Inverter 1 Power</description>
<state pattern="%.2f %unit%" readOnly="true"></state>
</channel-type>
<channel-type id="inverter1Soc">
<item-type>Number:Dimensionless</item-type>
<label>Inverter 1 State of Charge</label>
<description>Inverter 1 State of Charge</description>
<state pattern="%.1f %unit%" readOnly="true"></state>
</channel-type>
@ -207,7 +238,7 @@
<channel-type id="meter_location" advanced="true">
<item-type>Number</item-type>
<label>Location</label>
<description>Meter location code</description>
<description>Meter Location Code</description>
<state readOnly="true"></state>
</channel-type>
<channel-type id="meter_ac_current">

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

@ -39,6 +39,8 @@
<label>Insteon Device</label>
<description>Insteon devices such as switches, dimmers, keypads, sensors, etc.</description>
<representation-property>address</representation-property>
<config-description>
<parameter name="address" type="text" required="true">
<label>Address</label>

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

@ -9,12 +9,12 @@
<description>WebOS based smart TV</description>
<channels>
<channel id="power" typeId="powerType"/>
<channel id="mute" typeId="muteType"/>
<channel id="volume" typeId="volumeType"/>
<channel id="power" typeId="system.power"/>
<channel id="mute" typeId="system.mute"/>
<channel id="volume" typeId="system.volume"/>
<channel id="channel" typeId="channelType"/>
<channel id="toast" typeId="toastType"/>
<channel id="mediaPlayer" typeId="mediaPlayerType"/>
<channel id="mediaPlayer" typeId="system.media-control"/>
<channel id="mediaStop" typeId="mediaStopType"/>
<channel id="appLauncher" typeId="appLauncherChannelType"/>
<channel id="rcButton" typeId="rcButtonType"/>
@ -33,24 +33,6 @@
<config-description-ref uri="thing-type:lgwebos:WebOSTV"/>
</thing-type>
<channel-type id="powerType">
<item-type>Switch</item-type>
<label>Power</label>
<description>Via this binding TV can only be powered off, not on.</description>
</channel-type>
<channel-type id="muteType">
<item-type>Switch</item-type>
<label>Mute</label>
<description>Current Mute Setting</description>
<category>SoundVolume</category>
</channel-type>
<channel-type id="volumeType">
<item-type>Dimmer</item-type>
<label>Volume</label>
<description>Current Volume Setting</description>
<category>SoundVolume</category>
<state min="0" max="100" step="1"></state>
</channel-type>
<channel-type id="channelType">
<item-type>String</item-type>
<label>Channel</label>
@ -61,12 +43,6 @@
<label>Toast</label>
<description>Send a message onto the TV screen.</description>
</channel-type>
<channel-type id="mediaPlayerType">
<item-type>Player</item-type>
<label>Media Control</label>
<description>Control media (e.g. audio or video) playback</description>
<category>MediaControl</category>
</channel-type>
<channel-type id="mediaStopType">
<item-type>Switch</item-type>
<label>Stop</label>

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

@ -5,22 +5,24 @@
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<bridge-type id="http">
<label>OpenSprinkler HTTP Interface</label>
<label>OpenSprinkler HTTP Bridge</label>
<description>A connection to a stand alone OpenSprinkler device which communicates over HTTP.</description>
<config-description>
<parameter name="hostname" type="text">
<parameter name="hostname" type="text" required="true">
<label>Hostname</label>
<description>The host name or IP address of the OpenSprinkler Web API interface. It may or may not start with the
protocol, e.g. in order to use https:// instead of the default http://.</description>
<default>localhost</default>
</parameter>
<parameter name="port" type="integer" min="1" max="65535">
<parameter name="port" type="integer" min="1" max="65535" required="true">
<label>Port</label>
<description>Port of the OpenSprinkler Web API interface.</description>
<default>80</default>
<advanced>true</advanced>
</parameter>
<parameter name="password" type="text">
<parameter name="password" type="text" required="true">
<context>password</context>
<label>Password</label>
<description>The admin password used to access the Web API interface.</description>
<default>opendoor</default>
@ -55,12 +57,14 @@
<channel id="queued" typeId="queued"></channel>
<channel id="remainingWaterTime" typeId="remainingWaterTime"></channel>
<channel id="nextDuration" typeId="nextDuration"></channel>
<channel id="ignoreRain" typeId="ignoreRain"></channel>
</channels>
<config-description>
<parameter name="stationIndex" type="integer" required="true">
<label>Station Index</label>
<description>The index of the station, starting with 0, of the station.</description>
<default>0</default>
</parameter>
</config-description>
</thing-type>
@ -74,33 +78,87 @@
<channels>
<channel id="rainsensor" typeId="rainsensor"></channel>
<channel id="sensor2" typeId="sensor2"></channel>
<channel id="waterlevel" typeId="waterlevel"></channel>
<channel id="currentDraw" typeId="currentDraw"></channel>
<channel id="signalStrength" typeId="system.signal-strength"></channel>
<channel id="flowSensorCount" typeId="flowSensorCount"></channel>
<channel id="programs" typeId="programs"></channel>
<channel id="stations" typeId="stations"></channel>
<channel id="nextDuration" typeId="nextDuration"></channel>
<channel id="resetStations" typeId="resetStations"></channel>
<channel id="enablePrograms" typeId="enablePrograms"></channel>
<channel id="rainDelay" typeId="rainDelay"></channel>
</channels>
</thing-type>
<channel-type id="rainsensor">
<item-type>Switch</item-type>
<label>Rain</label>
<label>Rain Sensor</label>
<description>Provides feedback on whether the OpenSprinkler device has detected rain or not.</description>
<category>Sensor</category>
<state readOnly="true"/>
</channel-type>
<channel-type id="sensor2">
<item-type>Switch</item-type>
<label>Sensor 2</label>
<description>Sensor 2 can be setup as a rain, flow or soil moisture sensor.</description>
<category>Sensor</category>
<state readOnly="true"/>
</channel-type>
<channel-type id="waterlevel">
<item-type>Number:Dimensionless</item-type>
<label>Water Level</label>
<description>The current water level in percent</description>
<description>The current watering level in percent</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="flowSensorCount">
<item-type>Number:Dimensionless</item-type>
<label>Flow Sensor Count</label>
<description>A count of how many pulses the water flow sensor has given.</description>
<category>Flow</category>
<state readOnly="true"/>
</channel-type>
<channel-type id="currentDraw">
<item-type>Number:ElectricCurrent</item-type>
<label>Current Draw</label>
<description>The current draw in mA</description>
<category>Energy</category>
<state readOnly="true"/>
</channel-type>
<channel-type id="stationState">
<item-type>Switch</item-type>
<label>Station</label>
<label>Station State</label>
<description>Controls a station on the OpenSprinkler device.</description>
<category>Switch</category>
</channel-type>
<channel-type id="ignoreRain">
<item-type>Switch</item-type>
<label>Station Ignores Rain</label>
<description>The station will ignore forecasted rain.</description>
<category>Switch</category>
</channel-type>
<channel-type id="resetStations">
<item-type>Switch</item-type>
<label>Reset Stations</label>
<description>Resets all stations back to CLOSED.</description>
<category>Switch</category>
</channel-type>
<channel-type id="enablePrograms">
<item-type>Switch</item-type>
<label>Enable Programs</label>
<description>Allow programs to auto run, when OFF, manually started stations still work.</description>
<category>Switch</category>
</channel-type>
<channel-type id="queued">
<item-type>Switch</item-type>
<label>Queued</label>
@ -113,13 +171,39 @@
<item-type>Number:Time</item-type>
<label>Remaining Water Time</label>
<description>Read-only property of the remaining water time of the station.</description>
<category>Time</category>
<state readOnly="true" pattern="%.0f min"/>
</channel-type>
<channel-type id="nextDuration">
<item-type>Number:Time</item-type>
<label>Next Open Duration</label>
<label>Next Duration</label>
<description>The duration the station will be opened the next time it is switched on.</description>
<category>Time</category>
<state readOnly="false" pattern="%.0f min"/>
</channel-type>
<channel-type id="rainDelay">
<item-type>Number:Time</item-type>
<label>Rain Delay</label>
<description>The amount of time in hours to delay the running of any program.</description>
<category>Time</category>
<state readOnly="false" pattern="%.0f h"/>
</channel-type>
<channel-type id="programs">
<item-type>String</item-type>
<label>Run Program</label>
<description>Run a program that is saved inside the OpenSprinkler Device.</description>
<state readOnly="false">
</state>
</channel-type>
<channel-type id="stations">
<item-type>String</item-type>
<label>Open Station</label>
<description>Opens the solenoid of a single station.</description>
<state readOnly="false">
</state>
</channel-type>
</thing:thing-descriptions>

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

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="pushsafer"
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="pushsafer-account">
<label>Pushsafer Account</label>
<description>Provides access to the Pushsafer Messages API.</description>
<representation-property>apikey</representation-property>
<config-description-ref uri="thing-type:pushsafer:pushsafer-account"/>
</thing-type>
</thing:thing-descriptions>

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

@ -151,6 +151,10 @@
<label>Volume</label>
<description>Increase or decrease the volume</description>
<category>SoundVolume</category>
<tags>
<tag>Control</tag>
<tag>SoundVolume</tag>
</tags>
<state pattern="%d" readOnly="false"/>
<autoUpdatePolicy>veto</autoUpdatePolicy>
</channel-type>

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

@ -4,16 +4,14 @@
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">
<channel-type id="power">
<item-type>Switch</item-type>
<label>Power</label>
<description>Power ON/OFF the projector</description>
</channel-type>
<channel-type id="powerstate">
<item-type>String</item-type>
<label>Power State</label>
<description>Current detailed power state of the projector</description>
<tags>
<tag>Status</tag>
<tag>Power</tag>
</tags>
<state readOnly="true"></state>
</channel-type>

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

@ -10,7 +10,7 @@
<description>Ethernet connection to the Sony projector using PJ Talk</description>
<channels>
<channel id="power" typeId="power"/>
<channel id="power" typeId="system.power"/>
<channel id="powerstate" typeId="powerstate"/>
<channel id="input" typeId="input"/>
<channel id="calibrationpreset" typeId="calibrationpreset"/>

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

@ -10,7 +10,7 @@
<description>Serial connection to the Sony projector</description>
<channels>
<channel id="power" typeId="power"/>
<channel id="power" typeId="system.power"/>
<channel id="powerstate" typeId="powerstate"/>
<channel id="input" typeId="input"/>
<channel id="calibrationpreset" typeId="calibrationpreset"/>

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

@ -10,7 +10,7 @@
<description>Serial over IP connection to the Sony projector</description>
<channels>
<channel id="power" typeId="power"/>
<channel id="power" typeId="system.power"/>
<channel id="powerstate" typeId="powerstate"/>
<channel id="input" typeId="input"/>
<channel id="calibrationpreset" typeId="calibrationpreset"/>

2
_thing_types/org.openhab.binding.zwave/src/main/resources/OH-INF/thing/bremicker/abuscfa3010_0_0.xml
View File

@ -21,7 +21,7 @@ Z-Wave controlled door lock<br /> <h1>Overview</h1><p>The ABUS Z-Wave HomeTec CF
</properties>
</channel>
<channel id="sensor_door" typeId="sensor_door">
<label>Door Sensor</label>
<label>Door Sensor (unsupported)</label>
<properties>
<property name="binding:*:OpenClosedType">COMMAND_CLASS_DOOR_LOCK</property>
</properties>

262
_thing_types/org.openhab.binding.zwave/src/main/resources/OH-INF/thing/ring/keypad_0_0.xml Normal file
View File

@ -0,0 +1,262 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="zwave"
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/v1.0.0">
<thing-type id="ring_keypad_00_000" listed="false">
<label>Keypad 2nd Gen Alarm Keypad 2nd Gen</label>
<description><![CDATA[
Alarm Keypad 2nd Gen<br /> <h1>Overview</h1><p>Ring Alarm features a Z-Wave keypad, will act as an arming station for the Ring Alarm system. In addition to smartphone and web apps, the keypad provides users with an alternative interface for their alarm system. The keypad allows the user to arm and disarm their system, view system status and receive visual and audio feedback regarding system status and events. Designed for convenience, the keypad can be mounted on the wall or left on a tabletop. Additionally, a rechargeable battery and AC power option provide users with the flexibility to use the keypad in ways which work best for each individual. This keypad gives users a home arming station without having to worry about wiring, picking the right location, complicated hardware installation or making modifications to their homes.</p><p>The keypad will include an interactive button interface, an informational display, a speaker, various LED lights, wall mount option, battery power, AC power option, and additional features to extend control of the Ring Protect system beyond the user’s mobile device and web applications. The keypad is intended to be used as a “dumb” terminal and will be non-programmable for end users.</p><p>see https://ring.com/products/alarm-keypad-v2 for further information.</p> <br /> <h2>Inclusion Information</h2><ol><li>Activate inclusion mode on controller</li><li>hold button 1 on keypad for 3 seconds to enter inclusion mode</li><li>Device should appear in inbox</li></ol> <br /> <h2>Exclusion Information</h2><ol><li>Initiate exclusion mode on controller</li><li>hold button 1 on kepad for 3 seconds.</li><li>buttons on keypad should no longer beep when pressed</li></ol> <br /> <h2>Wakeup Information</h2><p>Not applicable. Ring Alarm Keypad (LSS) is a Frequently Listening Receiver Slave (FLiRS) device and does not support Wake Up Command Class.</p>
]]></description>
<category>Battery</category>
<!-- CHANNEL DEFINITIONS -->
<channels>
<channel id="alarm_burglar" typeId="alarm_burglar">
<label>Alarm (burglar)</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_ALARM;type=BURGLAR</property>
</properties>
</channel>
<channel id="alarm_power" typeId="alarm_power">
<label>Alarm (power)</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_ALARM;type=POWER_MANAGEMENT</property>
</properties>
</channel>
<channel id="alarm_system" typeId="alarm_system">
<label>Alarm (system)</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_ALARM;type=SYSTEM</property>
</properties>
</channel>
<channel id="battery-level" typeId="system.battery-level">
<properties>
<property name="binding:*:PercentType">COMMAND_CLASS_BATTERY</property>
</properties>
</channel>
</channels>
<!-- DEVICE PROPERTY DEFINITIONS -->
<properties>
<property name="vendor">Ring</property>
<property name="modelId">Keypad 2nd Gen</property>
<property name="manufacturerId">0346</property>
<property name="manufacturerRef">0101:0401</property>
<property name="dbReference">1398</property>
<property name="defaultAssociations">1</property>
</properties>
<!-- CONFIGURATION DESCRIPTIONS -->
<config-description>
<!-- GROUP DEFINITIONS -->
<parameter-group name="configuration">
<context>setup</context>
<label>Configuration Parameters</label>
</parameter-group>
<parameter-group name="association">
<context>link</context>
<label>Association Groups</label>
</parameter-group>
<!-- PARAMETER DEFINITIONS -->
<parameter name="config_1_1" type="integer" groupName="configuration"
min="0" max="70">
<label>1: Heartbeats</label>
<description>This parameter is the number minutes between heartbeats. Heartbeats are automatic battery reports on a timer after the last event.</description>
<default>70</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_2_1" type="integer" groupName="configuration"
min="0" max="5">
<label>2: Application Level Retries</label>
<description>Number of application level retries attempted for messages either not ACKed or messages encapsulated via supervision get that did not receive a report.</description>
<default>1</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_3_0" type="integer" groupName="configuration"
min="1" max="60">
<label>3: Application Level Retry Base Wait Time Period</label>
<description>The number base seconds used in the calculation for sleeping between retry messages.</description>
<default>5</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_4_1" type="integer" groupName="configuration"
min="0" max="210">
<label>4: Announcement Audio Volume</label>
<description>Announcement Audio Volume (for audio files - should this be lumped into one of the other volume settings?)</description>
<default>7</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_5_1" type="integer" groupName="configuration"
min="0" max="10">
<label>5: Key Tone Volume</label>
<description>Key Tone Volume</description>
<default>6</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_6_1" type="integer" groupName="configuration"
min="0" max="10">
<label>6: Siren Volume</label>
<description>Siren Volume</description>
<default>10</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_7_1" type="integer" groupName="configuration"
min="2" max="5">
<label>7: Long press emergency duration</label>
<description>Long press emergency duration (seconds) This parameter allows a user to configure the duration in seconds for the hold time required to capture a long press . This includes Emergency Buttons + Mode Buttons (Police, Fire, Medical, Disarmed, Home, Away)</description>
<default>3</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_8_1" type="integer" groupName="configuration"
min="2" max="5">
<label>8: Long press number pad duration</label>
<description>Long press number pad duration (seconds) This parameter allows a user to configure the duration in seconds for the hold time required to capture a long press . This includes Number Pad + Check &amp; X (0-9, Check, X)</description>
<default>3</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_9_1" type="integer" groupName="configuration"
min="0" max="30">
<label>9: Proximity Display Timeout</label>
<description>Proximity Display Timeout : Timeout in seconds when proximity is detected and no input is received</description>
<default>5</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_10_1" type="integer" groupName="configuration"
min="0" max="30">
<label>10: Button Press Display Timeout</label>
<description>Button Press Display Timeout : Timeout in seconds when any button is pressed, but a sequence is not completed and buttons are no longer being pressed</description>
<default>5</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_11_1" type="integer" groupName="configuration"
min="0" max="30">
<label>11: Status Change Display Timeout</label>
<description>Status Change Display Timeout: Timeout in seconds when indicator command is received from the hub to change status</description>
<default>5</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_12_1" type="integer" groupName="configuration"
min="0" max="100">
<label>12: Security Mode Brightness</label>
<description>Security Mode Brightness: Adjusts the brightness of the security mode buttons</description>
<default>100</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_13_1" type="integer" groupName="configuration"
min="0" max="100">
<label>13: Key Backlight Brightness</label>
<description>Key Backlight Brightness: Adjusts the brightness of the keypad backlight. Used for Key Backlight LEDs only Available settings: 0-100%</description>
<default>100</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_14_1" type="integer" groupName="configuration"
min="0" max="100">
<label>14: Ambient Light Sensor Level</label>
<description>Ambient Light Sensor Level: Light threshold where keypad will stop backlighting if higher than</description>
<default>5</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_15_1" type="integer" groupName="configuration"
min="0" max="1">
<label>15: Proximity On/OFF</label>
<description>Proximity On/OFF: Turn On and Off the Proximity Detection.</description>
<default>1</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_16_1" type="integer" groupName="configuration"
min="0" max="255">
<label>16: Ramp Time Config</label>
<description>Ramp Time Config: Ramp time in milliseconds to turn the LEDs on/off. Applies to all LEDs on the keypad</description>
<default>50</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_17_1" type="integer" groupName="configuration"
min="0" max="100">
<label>17: Low Battery Threshold</label>
<description>Low Battery Threshold - The percentage level at which the display would turn on the yellow battery indicator (whenever the display is on).</description>
<default>15</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_18_0" type="integer" groupName="configuration"
min="0" max="31">
<label>18: Languages Set</label>
<description>Languages Set: bit number in the languages supported bitmask to set</description>
<default>30</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_19_1" type="integer" groupName="configuration"
min="0" max="100">
<label>19: Warn Battery Threshold</label>
<description>Warn Battery Threshold - The percentage level at which the display would turn on the red battery indicator (whenever the display is on)</description>
<default>5</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_20_2" type="integer" groupName="configuration"
min="500" max="5000">
<label>20: Supervisory Report response time</label>
<description>The number of milliseconds waiting for a Supervisory Report response to a Supervisory Get encapsulated command from the device before attempting a retry</description>
<default>1500</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_21_2" type="integer" groupName="configuration"
min="0" max="601">
<label>21: System Security Mode Display</label>
<description>System Security Mode Display: (Always, Sometimes, Never). 601 = Always On , 1 - 600 = periodic interval, 0 = Always</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_22_4" type="integer" groupName="configuration" readOnly="true"
min="0" max="4294967295">
<label>22: Languages Supported (Get)</label>
<description>Languages Supported (Get): returns bitmask of languages supported. Bits set to 1 indicate that the language is supported</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<!-- ASSOCIATION DEFINITIONS -->
<parameter name="group_1" type="text" groupName="association" multiple="true">
<label>1: Lifeline</label>
<description><![CDATA[
Controller Updates<br /> <h1>Overview</h1><p>1. Notification Report<br />   a. See notification CC section for notifications that are sent</p><p>2. Entry Control Notification</p><p>3. Battery Report</p><p>4. Device Reset Locally Notification</p>
]]></description>
<multipleLimit>5</multipleLimit>
</parameter>
<!-- STATIC DEFINITIONS -->
<parameter name="node_id" type="integer" min="1" max="232" readOnly="true" required="true">
<label>Node ID</label>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
</thing:thing-descriptions>

291
_thing_types/org.openhab.binding.zwave/src/main/resources/OH-INF/thing/ring/rkeu_0_0.xml
View File

@ -1,291 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="zwave"
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/v1.0.0">
<thing-type id="ring_rkeu_00_000" listed="false">
<label>Keypad Alarm Keypad EU</label>
<description><![CDATA[
Alarm Keypad EU<br /> <h1>Overview</h1><p>Ring Alarm features a Z-Wave keypad, will act as an arming station for the Ring Alarm system. In addition to smartphone and web apps, the keypad provides users with an alternative interface for their alarm system. The keypad allows the user to arm and disarm their system, view system status and receive visual and audio feedback regarding system status and events. Designed for convenience, the keypad can be mounted on the wall or left on a tabletop. Additionally, a rechargeable battery and AC power option provide users with the flexibility to use the keypad in ways which work best for each individual. This keypad gives users a home arming station without having to worry about wiring, picking the right location, complicated hardware installation or making modifications to their homes.</p><p>The keypad will include an interactive button interface, an informational display, a speaker, various LED lights, wall mount option, battery power, AC power option, and additional features to extend control of the Ring Protect system beyond the user’s mobile device and web applications. The keypad is intended to be used as a “dumb” terminal and will be non-programmable for end users.</p> <br /> <h2>Inclusion Information</h2><p>1: Activate inclusion mode on controller</p><p>2: hold button 1 on keypad for 3 seconds to enter inclusion mode</p><p>3: Device should appear in inbox</p> <br /> <h2>Exclusion Information</h2><p>1: Initiate exclusion mode on controller</p><p>2: hold button 1 on kepad for 3 seconds.</p><p>3: buttons on keypad should no longer beep when pressed</p> <br /> <h2>Wakeup Information</h2><p>press any button on keypad to wake up</p>
]]></description>
<category>RemoteControl</category>
<!-- CHANNEL DEFINITIONS -->
<channels>
<channel id="alarm_heat" typeId="alarm_heat">
<label>Alarm (heat)</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_ALARM;type=HEAT</property>
</properties>
</channel>
<channel id="alarm_burglar" typeId="alarm_burglar">
<label>Alarm (burglar)</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_ALARM;type=BURGLAR</property>
</properties>
</channel>
<channel id="alarm_power" typeId="alarm_power">
<label>Alarm (power)</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_ALARM;type=POWER_MANAGEMENT</property>
</properties>
</channel>
<channel id="alarm_system" typeId="alarm_system">
<label>Alarm (system)</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_ALARM;type=SYSTEM</property>
</properties>
</channel>
<channel id="battery-level" typeId="system.battery-level">
<properties>
<property name="binding:*:PercentType">COMMAND_CLASS_BATTERY</property>
</properties>
</channel>
</channels>
<!-- DEVICE PROPERTY DEFINITIONS -->
<properties>
<property name="vendor">Ring</property>
<property name="modelId">Keypad</property>
<property name="manufacturerId">0346</property>
<property name="manufacturerRef">0101:0202</property>
<property name="dbReference">1353</property>
<property name="defaultAssociations">1</property>
</properties>
<!-- CONFIGURATION DESCRIPTIONS -->
<config-description>
<!-- GROUP DEFINITIONS -->
<parameter-group name="configuration">
<context>setup</context>
<label>Configuration Parameters</label>
</parameter-group>
<parameter-group name="association">
<context>link</context>
<label>Association Groups</label>
</parameter-group>
<!-- PARAMETER DEFINITIONS -->
<parameter name="config_1_2" type="integer" groupName="configuration"
min="70" max="1440">
<label>1: Parameter 1</label>
<description>Battery Report Interval</description>
<default>1440</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_2_1" type="integer" groupName="configuration"
min="1" max="5">
<label>2: Parameter 2</label>
<description><![CDATA[
Z-Wave Sleep Timeout<br /> <h1>Overview</h1><p>Time to wait after receiving ZW for more OTA messages. </p>
]]></description>
<default>1</default>
<options>
<option value="1">1 second</option>
<option value="2">2 seconds</option>
<option value="3">3 seconds</option>
<option value="4">4 seconds</option>
<option value="5">5 seconds</option>
</options>
</parameter>
<parameter name="config_3_1" type="integer" groupName="configuration"
min="0" max="1">
<label>3: Parameter 3</label>
<description>Co-Proc Is Alive</description>
<default>1</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_4_1" type="integer" groupName="configuration"
min="0" max="30">
<label>4: Parameter 4</label>
<description>Proximity Timeout</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_5_1" type="integer" groupName="configuration"
min="0" max="30">
<label>5: Parameter 5</label>
<description>Button Press Timeout</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_6_1" type="integer" groupName="configuration"
min="10" max="60">
<label>6: Parameter 6</label>
<description>Status Change Timeout</description>
<default>10</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_7_1" type="integer" groupName="configuration"
min="0" max="1">
<label>7: Parameter 7</label>
<description>Power Mode</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_8_1" type="integer" groupName="configuration"
min="1" max="15">
<label>8: Parameter 8</label>
<description>Key Backlight Timeout</description>
<default>1</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_9_1" type="integer" groupName="configuration"
min="0" max="100">
<label>9: Parameter 9</label>
<description>Key Backlight Brightness</description>
<default>50</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_10_1" type="integer" groupName="configuration"
min="1" max="8">
<label>10: Parameter 10</label>
<description>Key Tone Volume</description>
<default>4</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_11_1" type="integer" groupName="configuration"
min="0" max="100">
<label>11: Parameter 11</label>
<description>Ambient Light Sensor Level</description>
<default>50</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_12_1" type="integer" groupName="configuration"
min="0" max="10">
<label>12: Parameter 12</label>
<description>Siren Volume</description>
<default>5</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_13_1" type="integer" groupName="configuration"
min="0" max="1">
<label>13: Parameter 13</label>
<description>Proximity On/OFF</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_14_1" type="integer" groupName="configuration"
min="0" max="100">
<label>14: Parameter 14</label>
<description>Proximity Distance</description>
<default>50</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_15_1" type="integer" groupName="configuration"
min="0" max="100">
<label>15: Parameter 15</label>
<description>Extended Battery Life LED Brightness Adjustment</description>
<default>50</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_16_1" type="integer" groupName="configuration"
min="0" max="100">
<label>16: Parameter 16</label>
<description>Reduced Battery Life LED Brightness Adjustment</description>
<default>50</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_17_1" type="integer" groupName="configuration"
min="1" max="100">
<label>17: Parameter 17</label>
<description>Fast Blink Rate</description>
<default>50</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_18_1" type="integer" groupName="configuration"
min="1" max="100">
<label>18: Parameter 18</label>
<description>Slow Blink Rate</description>
<default>25</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_19_2" type="integer" groupName="configuration"
min="500" max="5000">
<label>19: Parameter 19</label>
<description>Supervision Report Timeout. settings</description>
<default>500</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_20_1" type="integer" groupName="configuration"
min="0" max="5">
<label>20: Parameter 20</label>
<description>Number of Re-transmissions Attempts. settings</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_21_1" type="integer" groupName="configuration"
min="1" max="60">
<label>21: Parameter 21</label>
<description>Wait Period Between Re-transmissions Attempts. settings</description>
<default>10</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_22_1" type="integer" groupName="configuration"
min="0" max="31">
<label>22: Parameter 22</label>
<description>Language Used</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_23_4" type="integer" groupName="configuration"
min="0" max="4294967295">
<label>23: Parameter 23</label>
<description>Bit mask data for supported languages</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<parameter name="config_24_4" type="integer" groupName="configuration"
min="0" max="1000">
<label>24: Parameter 24</label>
<description>Audio File Version</description>
<default>0</default>
<limitToOptions>false</limitToOptions>
</parameter>
<!-- ASSOCIATION DEFINITIONS -->
<parameter name="group_1" type="text" groupName="association">
<label>1: Lifeline</label>
<description><![CDATA[
Controller Updates<br /> <h1>Overview</h1><p>1. Notification Report. Keypad will send Notification Report to the associated nodes when AC power / PIR sensor is triggered /system software failure. 2. Entry Control Notification. Keypad will send Entry Control Notification to the associated nodes when the mode button is triggered. 3. Battery Report. Keypad will send Battery Report when the battery level is low and the battery report’s value is 0xFF or Hearbeat. 4. Device Reset Locally Notification<br /></p>
]]></description>
</parameter>
<!-- STATIC DEFINITIONS -->
<parameter name="node_id" type="integer" min="1" max="232" readOnly="true" required="true">
<label>Node ID</label>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
</thing:thing-descriptions>

2
installation/openhabian.md
View File

@ -68,6 +68,8 @@ The included **openHABian Configuration Tool** [`openhabian-config`](#openhabian
### Hardware recommendation
Let's put this first: our current recommendation is to get a RPi 4 with 2 or 4 GB of RAM, a 3A power supply and a 16 GB SD card.
Because of the higher limit of write cycles, an SD card designed for Dashcams is preferable.
Most manufacturers name them with a postfix like "Endurance" (e.g. "SanDisk MAX ENDURANCE" or "Kingston High Endurance").
Also get another 32 GB or larger SD card and a USB card reader to make use of the ["auto backup" feature](openhabian.md#auto-backup).
### Hardware support