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

pull/764/head
CloudBees DEV@Cloud 2018-06-14 17:27:26 +02:00
parent 4dbed93a12
commit 5ca31006ac
37 changed files with 2486 additions and 255 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
_addons_actions/nma/readme.md
View File

@ -1,40 +0,0 @@
---
id: nma
label: NotifyMyAndroid
title: NotifyMyAndroid - Actions
type: action
description: "Sends push messages to your Android devices."
source: https://github.com/openhab/openhab1-addons/blob/master/bundles/action/org.openhab.action.nma/README.md
since: 1x
install: auto
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# NotifyMyAndroid Actions
Sends push messages to your Android devices.
## Actions
- `notifyMyAndroid(String event, String description)`: Send a message to the pre-configured api key (account) and use the configured or default values for the other parameters. Event is the notification title, and description the details.
- `notifyMyAndroid(String event, String description, int priority)`: Send a message to a the pre-configured api key (account) with priority level (-2 to 2, from very low to emergency) and use the configured or default values for the other parameters.
- `notifyMyAndroid(String apiKey, String event, String description)`: Send a message to another api key than the configured or use this method if you have not configured a default api key
- `notifyMyAndroid(String apiKey, String event, String description, int priority)`: Send a message to another api key than the configured or use this method if you have not configured a default api key
- `notifyMyAndroid(String apiKey, String event, String description, int priority, String url)`: Send a message to another api key than the configured or use this method if you have not configured a default api key
- `notifyMyAndroid(String apiKey, String event, String description, int priority, String url, boolean html)`: Send a message overwriting all configured parameters and using the specified values.
## Configuration
This action service can be configured via the `services/nma.cfg` file.
| Property | Default | Required | Description |
|-----------------|--------------------------------------------------|:------------------------------------------------:|----------------------------------------------------------------------------------------------------|
| timeout | 10000 | No | Timeout for the communication with the NMA service |
| developerKey | | No | An optional developer key from NMA |
| apiKey | | if using action calls without `apiKey` parameter | Default API key to send messages to. API keys can be created in your account's dashboard. |
| appName | openHAB | No | Application name which NMA will show |
| defaultPriority | 0 | No | Priority to use for messages if not specified otherwise. Can range from -2 (lowest) to 2 (highest) |
| defaultUrl | https://www.notifymyandroid.com/publicapi/notify | No | URL to attach to NMA messages by default if not specified otherwise. Can be left empty. |

15
_addons_actions/xmpp/readme.md
View File

@ -30,11 +30,11 @@ The XMPP Action service can be configured in `services/xmpp.cfg`.
| Property | Default | Required | Description |
|--------------|---------------|:--------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| username | | | The username of the XMPP account used by openHAB. Most services will require that you use only the localpart of the account's JID. For example if your accounts JID is `myuser@example.org`, then only configure `myuser`. |
| username | | | The username of the XMPP account used by openHAB. Most services will require that you use only the localpart of the account's JID. For example if your account's JID is `myuser@example.org`, then only configure `myuser`. |
| password | | | The password of the XMPP account used by openHAB |
| servername | | | The XMPP service to use, e.g. `jabber.de`. A list of public XMPP services can be found at https://xmpp.net/directory.php |
| securitymode | `disabled` | No | The Security mode used for the XMPP connection. Can be either `required` or `disabled`. Defaults to `disabled`, which means that TLS will not be used. Warning: If you change this to non-disabled, then you must make sure that your TLS server certificate can be validated, otherwhise the connection will fail. |
| tlspin | | | The TLS Pin used to verify the XMPP service's certificate. Set this in case openHAB's default `SSLContext` is unable to verfiy it (e.g. because the XMPP service uses a self-signed certificate). The PIN value is bascially the hash of the certificate in hexadecimal notation. You have to set `securitymode` to `required` to enable TLS for XMPP connections. For information on how to generate the PIN visit https://github.com/Flowdalic/java-pinning . Example: `tlspin=CERTSHA256:83:F9:17:1E:06:A3:13:11:88:89:F7:D7:93:02:BD:1B:7A:20:42:EE:0C:FD:02:9A:BF:8D:D0:6F:FA:6C:D9:D3` |
| tlspin | | | The TLS Pin used to verify the XMPP service's certificate. Set this in case openHAB's default `SSLContext` is unable to verify it (e.g. because the XMPP service uses a self-signed certificate). The PIN value is basically the hash of the certificate in hexadecimal notation. Set `securitymode` to `required` to enable TLS for XMPP connections. PIN generation is [discussed in detail here](https://github.com/Flowdalic/java-pinning) or see [this example](#Example_Generate_PIN). Example: `tlspin=CERTSHA256:83:F9:17:1E:06:A3:13:11:88:89:F7:D7:93:02:BD:1B:7A:20:42:EE:0C:FD:02:9A:BF:8D:D0:6F:FA:6C:D9:D3` |
| proxy | | | The XMPP Proxyserver to use, e.g. `gmail.com` |
| port | `5222` | | The server port to use |
| consoleusers | | | A comma-separated list of users that are allowed to use the XMPP console |
@ -59,3 +59,14 @@ password=mysecret
# check you openhab.log to found the address after you send something via Hangouts to your openHAB account
consoleusers=**cryptic**@public.talk.google.com,myname@gmail.com
```
## Example: Generate PIN
Assuming the PEM-encoded certificate is in a file called `jabber.crt` (it is PEM encoded if it contains the lines `BEGIN CERTIFICATE` and `END CERTIFICATE` with lots of dashes in them) this shell invocation prints the required value for the `tlspin=` configuration setting:
```bash
$ echo "CERTSHA256:$(openssl x509 -in "jabber.crt" -noout -fingerprint -sha256 | sed 's/.*=//')"
CERTSHA256:D8:8E:B1:....:7D:84
```
You then copy the whole last line into `tlspin`.

20
_addons_bindings/fsinternetradio/readme.md
View File

@ -31,6 +31,7 @@ Successfully tested are internet radios:
* [Revo SuperConnect](https://revo.co.uk/products/)
* [Sangean WFR-28C](http://sg.sangean.com.tw/products/product_category.asp?cid=2)
* [Roku SoundBridge M1001](https://soundbridge.roku.com/soundbridge/index.php)
* [Dual IR 3a](https://www.dual.de/produkte/digitalradio/radio-station-ir-3a/)
But in principle, all internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/) should be supported because they share the same API.
So It is very likely that other internet radio models of the same manufacturers do also work.
@ -80,17 +81,14 @@ All devices support some of the following channels:
The radio mode depends on the internet radio model (and its firmware version!).
This list is just an example how the mapping looks like for some of the devices, please try it out and adjust your sitemap for your particular radio.
| Radio mode | Hama IR110 | Medion MD87180 | Medion MD 86988 | Technisat DigitRadio 580 |
|------------|------------|----------------|-----------------|--------------------------|
| 0 | Internet Radio | Internet Radio | Internet Radio | Internet Radio |
| 1 | Spotify | Music Player (USB, LAN) | Music Player | Spotify |
| 2 | Player | DAB Radio | FM Radio | (not used) |
| 3 | AUX in | FM Radio | AUX in | Music Player |
| 4 | - | AUX in | - | DAB Radio |
| 5 | - | - | - | FM Radio |
| 6 | - | - | - | AUX in |
| 7 | - | - | - | CD |
| 8 | - | - | - | Bluetooth |
| Radio Mode | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
|--------------------------|----------------|-------------------------|-----------|--------------|-----------|----------|-----------|----|-----------|
| Hama IR110 | Internet Radio | Spotify | Player | AUX in | - | - | - | - | - |
| Medion MD87180 | Internet Radio | Music Player (USB, LAN) | DAB Radio | FM Radio | AUX in | - | - | - | - |
| Medion MD 86988 | Internet Radio | Music Player | FM Radio | AUX in | - | - | - | - | - |
| Technisat DigitRadio 580 | Internet Radio | Spotify | - | Music Player | DAB Radio | FM Radio | AUX in | CD | Bluetooth |
| Dual IR 3a | Internet Radio | Spotify | - | Music Player | DAB Radio | FM Radio | Bluetooth | - | - |
## Full Example

26
_addons_bindings/innogysmarthome/readme.md
View File

@ -196,11 +196,33 @@ Bridge innogysmarthome:bridge:mybride "innogy SmartHome Controller" [ refreshtok
}
```
## Items configuration
You can then configure your items in your *.items config files as usual, for example:
```
Contact myWindowContact "Kitchen" <window> {channel="innogysmarthome:WDS:mybridge:myWindowContact:contact"}
Switch myWindowContactBattery "Battery low" <battery> {channel="innogysmarthome:WDS:mybridge:myWindowContact:battery_low"}
Contact myWindowContact "Kitchen" <window> {channel="innogysmarthome:WDS:mybridge:myWindowContact:contact"}
Switch myWindowContactBattery "Battery low" <battery> {channel="innogysmarthome:WDS:mybridge:myWindowContact:battery_low"}
Number myHeatingTemp "Bath [%.1f °C]" <temperature> {channel="innogysmarthome:RST:mybridge:myHeating:temperature"}
Number myHeatingModeTempTarget "Settemp bath [%.1f °C]" <temperature> {channel="innogysmarthome:RST:mybridge:myHeating:set_temperature"}
String myHeatingMode "Mode bath [%s]" <temperature> {channel="innogysmarthome:RST:mybridge:myHeating:operation_mode"}
Number myHeatingHumidity "Bath [%.1f %%]" <humidity> {channel="innogysmarthome:RST:mybridge:myHeating:humidity"}
```
## Sitemap configuration
The site configuration works a usual. One special example
```
sitemap default label="Home" {
Frame {
Text item=myHeatingTemp label="Temperature"
Text item=myHeatingHumidity label="Humidity"
Switch item=myHeatingMode label="Mode" mappings=[Manu="Manual", Auto="Auto"]
Setpoint item=myHeatingModeTempTarget label="Target temperature" minValue=16 maxValue=25 step=1
}
}
```

63
_addons_bindings/kodi/readme.md
View File

@ -78,30 +78,33 @@ Thing kodi:kodi:myKodi "Kodi" @ "Living Room" [ipAddress="192.168.1.100", port=9
The Kodi thing supports the following channels:
| Channel Type ID | Item Type | Description |
|------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| mute | Switch | Mute/unmute your playback |
| volume | Dimmer | Read or control the volume of your playback |
| control | Player | Control the Kodi player, e.g. `PLAY`, `PAUSE`, `NEXT`, `PREVIOUS`, `FASTFORWARD`, `REWIND` |
| stop | Switch | Write `ON` to this channel: Stops the Kodi player. If this channel is `ON`, the player is stopped, otherwise Kodi is in another state (see control channel) |
| title | String | Title of the currently played song/movie/tv episode |
| showtitle | String | Title of the currently played tv-show; empty for other types |
| album | String | Album name of the currently played song |
| artist | String | Artist name of the currently played song or director of the currently played movie |
| playuri | String | Plays the file with the provided URI |
| playfavorite | String | Plays or opens the favorite with the provided title (channel's state options contains available favorites) |
| pvr-open-tv | String | Opens the PVR TV channel with the provided name (channel's state options contains available PVR TV channels) |
| pvr-open-radio | String | Opens the PVR Radio channel with the provided name (channel's state options contains available PVR Radio channels) |
| pvr-channel | String | Title of the currently played PVR channel |
| shownotification | String | Shows the provided notification message on the screen |
| input | String | Allows to control Kodi. Valid values are: `Up`, `Down`, `Left`, `Right`, `Select`, `Back`, `Home`, `ContextMenu`, `Info`, `ShowOSD`, `ShowPlayerProcessInfo`, `SendText` and `ExecuteAction` |
| inputtext | String | This channel emulates a keyboard input |
| inputaction | String | Send a predefined action to the Kodi Player to control the UI and/or perform other tasks. Valid values are: `left`, `right`, `up`, `down`, `pageup`, `pagedown`, `select`, `highlight`, `parentdir`, `parentfolder`, `back`, `menu`, `previousmenu`, `info`, `pause`, `stop`, `skipnext`, `skipprevious`, `fullscreen`, `aspectratio`, `stepforward`, `stepback`, `bigstepforward`, `bigstepback`, `chapterorbigstepforward`, `chapterorbigstepback`, `osd`, `showsubtitles`, `nextsubtitle`, `cyclesubtitle`, `playerdebug`, `codecinfo`, `playerprocessinfo`, `nextpicture`, `previouspicture`, `zoomout`, `zoomin`, `playlist`, `queue`, `zoomnormal`, `zoomlevel1`, `zoomlevel2`, `zoomlevel3`, `zoomlevel4`, `zoomlevel5`, `zoomlevel6`, `zoomlevel7`, `zoomlevel8`, `zoomlevel9`, `nextcalibration`, `resetcalibration`, `analogmove`, `analogmovex`, `analogmovey`, `rotate`, `rotateccw`, `close`, `subtitledelayminus`, `subtitledelay`, `subtitledelayplus`, `audiodelayminus`, `audiodelay`, `audiodelayplus`, `subtitleshiftup`, `subtitleshiftdown`, `subtitlealign`, `audionextlanguage`, `verticalshiftup`, `verticalshiftdown`, `nextresolution`, `audiotoggledigital`, `number0`, `number1`, `number2`, `number3`, `number4`, `number5`, `number6`, `number7`, `number8`, `number9`, `smallstepback`, `fastforward`, `rewind`, `play`, `playpause`, `switchplayer`, `delete`, `copy`, `move`, `screenshot`, `rename`, `togglewatched`, `scanitem`, `reloadkeymaps`, `volumeup`, `volumedown`, `mute`, `backspace`, `scrollup`, `scrolldown`, `analogfastforward`, `analogrewind`, `moveitemup`, `moveitemdown`, `contextmenu`, `shift`, `symbols`, `cursorleft`, `cursorright`, `showtime`, `analogseekforward`, `analogseekback`, `showpreset`, `nextpreset`, `previouspreset`, `lockpreset`, `randompreset`, `increasevisrating`, `decreasevisrating`, `showvideomenu`, `enter`, `increaserating`, `decreaserating`, `setrating`, `togglefullscreen`, `nextscene`, `previousscene`, `nextletter`, `prevletter`, `jumpsms2`, `jumpsms3`, `jumpsms4`, `jumpsms5`, `jumpsms6`, `jumpsms7`, `jumpsms8`, `jumpsms9`, `filter`, `filterclear`, `filtersms2`, `filtersms3`, `filtersms4`, `filtersms5`, `filtersms6`, `filtersms7`, `filtersms8`, `filtersms9`, `firstpage`, `lastpage`, `guiprofile`, `red`, `green`, `yellow`, `blue`, `increasepar`, `decreasepar`, `volampup`, `volampdown`, `volumeamplification`, `createbookmark`, `createepisodebookmark`, `settingsreset`, `settingslevelchange`, `stereomode`, `nextstereomode`, `previousstereomode`, `togglestereomode`, `stereomodetomono`, `channelup`, `channeldown`, `previouschannelgroup`, `nextchannelgroup`, `playpvr`, `playpvrtv`, `playpvrradio`, `record`, `togglecommskip`, `showtimerrule`, `leftclick`, `rightclick`, `middleclick`, `doubleclick`, `longclick`, `wheelup`, `wheeldown`, `mousedrag`, `mousemove`, `tap`, `longpress`, `pangesture`, `zoomgesture`, `rotategesture`, `swipeleft`, `swiperight`, `swipeup`, `swipedown`, `error`, `noop` |
| systemcommand | String | This channel allows to send commands to `shutdown`, `suspend`, `hibernate`, `reboot` Kodi |
| mediatype | String | The media type of the current file. Valid return values are: `unknown`, `channel`, `episode`, `movie`, `musicvideo`, `picture`, `radio`, `song`, `video` |
| thumbnail | Image | The URL to the thumbnail of the current file |
| fanart | Image | The URL to the fanart of the current file |
| playnotification | String | Plays the notification sound by a given URI |
| Channel Type ID | Item Type | Description |
|-----------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| mute | Switch | Mute/unmute your playback |
| volume | Dimmer | Read or control the volume of your playback |
| control | Player | Control the Kodi player, e.g. `PLAY`, `PAUSE`, `NEXT`, `PREVIOUS`, `FASTFORWARD`, `REWIND` |
| stop | Switch | Write `ON` to this channel: Stops the Kodi player. If this channel is `ON`, the player is stopped, otherwise Kodi is in another state (see control channel) |
| title | String | Title of the currently played song/movie/tv episode |
| showtitle | String | Title of the currently played tv-show; empty for other types |
| album | String | Album name of the currently played song |
| artist | String | Artist name of the currently played song or director of the currently played movie |
| playuri | String | Plays the file with the provided URI |
| playfavorite | String | Plays or opens the favorite with the provided title (channel's state options contains available favorites) |
| pvr-open-tv | String | Opens the PVR TV channel with the provided name (channel's state options contains available PVR TV channels) |
| pvr-open-radio | String | Opens the PVR Radio channel with the provided name (channel's state options contains available PVR Radio channels) |
| pvr-channel | String | Title of the currently played PVR channel |
| shownotification | String | Shows the provided notification message on the screen |
| input | String | Sends a key stroke to Kodi to navigate in the UI. Valid commands are: `Back`, `ContextMenu`, `Down`, `Home`, `Info`, `Left`, `Right`, `Select`, `ShowCodec`, `ShowOSD`, `ShowPlayerProcessInfo` and `Up`. `ExecuteAction` and `SendText` should be used with the dedicated channels `inputaction` and `inputtext`. |
| inputtext | String | Sends a generic input (unicode) text to Kodi. |
| inputaction | String | Sends a predefined action to Kodi to control the UI and/or perform other tasks. Valid commands are: `left`, `right`, `up`, `down`, `pageup`, `pagedown`, `select`, `highlight`, `parentdir`, `parentfolder`, `back`, `menu`, `previousmenu`, `info`, `pause`, `stop`, `skipnext`, `skipprevious`, `fullscreen`, `aspectratio`, `stepforward`, `stepback`, `bigstepforward`, `bigstepback`, `chapterorbigstepforward`, `chapterorbigstepback`, `osd`, `showsubtitles`, `nextsubtitle`, `cyclesubtitle`, `playerdebug`, `codecinfo`, `playerprocessinfo`, `nextpicture`, `previouspicture`, `zoomout`, `zoomin`, `playlist`, `queue`, `zoomnormal`, `zoomlevel1`, `zoomlevel2`, `zoomlevel3`, `zoomlevel4`, `zoomlevel5`, `zoomlevel6`, `zoomlevel7`, `zoomlevel8`, `zoomlevel9`, `nextcalibration`, `resetcalibration`, `analogmove`, `analogmovex`, `analogmovey`, `rotate`, `rotateccw`, `close`, `subtitledelayminus`, `subtitledelay`, `subtitledelayplus`, `audiodelayminus`, `audiodelay`, `audiodelayplus`, `subtitleshiftup`, `subtitleshiftdown`, `subtitlealign`, `audionextlanguage`, `verticalshiftup`, `verticalshiftdown`, `nextresolution`, `audiotoggledigital`, `number0`, `number1`, `number2`, `number3`, `number4`, `number5`, `number6`, `number7`, `number8`, `number9`, `smallstepback`, `fastforward`, `rewind`, `play`, `playpause`, `switchplayer`, `delete`, `copy`, `move`, `screenshot`, `rename`, `togglewatched`, `scanitem`, `reloadkeymaps`, `volumeup`, `volumedown`, `mute`, `backspace`, `scrollup`, `scrolldown`, `analogfastforward`, `analogrewind`, `moveitemup`, `moveitemdown`, `contextmenu`, `shift`, `symbols`, `cursorleft`, `cursorright`, `showtime`, `analogseekforward`, `analogseekback`, `showpreset`, `nextpreset`, `previouspreset`, `lockpreset`, `randompreset`, `increasevisrating`, `decreasevisrating`, `showvideomenu`, `enter`, `increaserating`, `decreaserating`, `setrating`, `togglefullscreen`, `nextscene`, `previousscene`, `nextletter`, `prevletter`, `jumpsms2`, `jumpsms3`, `jumpsms4`, `jumpsms5`, `jumpsms6`, `jumpsms7`, `jumpsms8`, `jumpsms9`, `filter`, `filterclear`, `filtersms2`, `filtersms3`, `filtersms4`, `filtersms5`, `filtersms6`, `filtersms7`, `filtersms8`, `filtersms9`, `firstpage`, `lastpage`, `guiprofile`, `red`, `green`, `yellow`, `blue`, `increasepar`, `decreasepar`, `volampup`, `volampdown`, `volumeamplification`, `createbookmark`, `createepisodebookmark`, `settingsreset`, `settingslevelchange`, `stereomode`, `nextstereomode`, `previousstereomode`, `togglestereomode`, `stereomodetomono`, `channelup`, `channeldown`, `previouschannelgroup`, `nextchannelgroup`, `playpvr`, `playpvrtv`, `playpvrradio`, `record`, `togglecommskip`, `showtimerrule`, `leftclick`, `rightclick`, `middleclick`, `doubleclick`, `longclick`, `wheelup`, `wheeldown`, `mousedrag`, `mousemove`, `tap`, `longpress`, `pangesture`, `zoomgesture`, `rotategesture`, `swipeleft`, `swiperight`, `swipeup`, `swipedown`, `error`, `noop`. |
| systemcommand | String | This channel allows to send system commands to `shutdown`, `suspend`, `hibernate` or `reboot` Kodi |
| mediatype | String | The media type of the current file. Valid return values are: `unknown`, `channel`, `episode`, `movie`, `musicvideo`, `picture`, `radio`, `song`, `video` |
| thumbnail | Image | The URL to the thumbnail of the current file |
| fanart | Image | The URL to the fanart of the current file |
| playnotification | String | Plays the notification sound by a given URI |
| currenttime | Number:Time | Current time of currently playing media |
| currenttimepercentage | Number:Dimensionless | Current time of currently playing media |
| duration | Number:Time | Length of currently playing media |
### Channel Configuration
@ -125,7 +128,7 @@ Instead, these will be sent to the `playuri` channel.
A manual setup through a `things/kodi.things` file could look like this:
```
```java
Thing kodi:kodi:myKodi "Kodi" @ "Living Room" [ipAddress="192.168.1.100", port=9090] {
Channels:
Type pvr-open-tv : pvr-open-tv [
@ -138,7 +141,7 @@ Thing kodi:kodi:myKodi "Kodi" @ "Living Room" [ipAddress="192.168.1.100", port=9
demo.items
```
```java
Switch myKodi_mute "Mute" { channel="kodi:kodi:myKodi:mute" }
Dimmer myKodi_volume "Volume [%d]" { channel="kodi:kodi:myKodi:volume" }
Player myKodi_control "Control" { channel="kodi:kodi:myKodi:control" }
@ -159,6 +162,9 @@ String myKodi_systemcommand "Systemcommand" { channel="kodi:
String myKodi_mediatype "Mediatype [%s]" { channel="kodi:kodi:myKodi:mediatype" }
Image myKodi_thumbnail { channel="kodi:kodi:myKodi:thumbnail" }
Image myKodi_fanart { channel="kodi:kodi:myKodi:fanart" }
Number:Time myKodi_currenttime "Current Time [%d %unit%]" { channel="kodi:kodi:myKodi:currenttime" }
Number:Dimensionless myKodi_ctp "Current Time [%d %unit%]" { channel="kodi:kodi:myKodi:currenttimepercentage" }
Number:Time myKodi_duration "Duration [%d %unit%]" { channel="kodi:kodi:myKodi:duration" }
String myKodi_playnotification "Play notification URI" { channel="kodi:kodi:myKodi:playnotification" }
```
@ -166,7 +172,7 @@ String myKodi_playnotification "Play notification URI" { channel="kodi:
demo.sitemap
```
```perl
sitemap demo label="myKodi"
{
Frame label="myKodi" {
@ -187,6 +193,9 @@ sitemap demo label="myKodi"
Text item=myKodi_mediatype
Image item=myKodi_thumbnail
Image item=myKodi_fanart
Text item=myKodi_currenttime
Text item=myKodi_ctp
Text item=myKodi_duration
}
}
```

9
_addons_bindings/kostalinverter/readme.md
View File

@ -44,14 +44,15 @@ Thing kostalinverter:kostalinverter:inverter [ url="http://192.168.0.128" ]
If the thing goes online then the connection to the web interface is successful.
In case it is offline you should see an error message.
You optionally can define a `userName` and a `password` parameter if the access to the webinterface is protected and a desired `refreshInterval` (the time interval between updates, default 60 seconds).
## Items
demo.items:
```
Number SolarPower "Solar power [%.2f Watt]" <energy> (gGF) { channel="kostalinverter:kostalinverter:inverter:acPower" }
Number SolarEnergyDay "Solar day energy[%.2f kwh]" <energy> (gGF) { channel="kostalinverter:kostalinverter:inverter:dayEnergy" }
Number SolarTotalEnergy "Solar total energy[%.2f kwh]" <energy> (gGF) { channel="kostalinverter:kostalinverter:inverter:totalEnergy" }
String SolarStatus "Solar status [%s]" <energy> (gGF) { channel="kostalinverter:kostalinverter:inverter:status" }
Number:Power SolarPower "Solar power [%.1f %unit%]" <energy> { channel="kostalinverter:kostalinverter:inverter:acPower" }
Number:Energy SolarEnergyDay "Solar day energy [%.3f %unit%]" <energy> { channel="kostalinverter:kostalinverter:inverter:dayEnergy" }
Number:Energy SolarTotalEnergy "Solar total energy [%.3f %unit%]" <energy> { channel="kostalinverter:kostalinverter:inverter:totalEnergy" }
String SolarStatus "Solar status [%s]" <energy> { channel="kostalinverter:kostalinverter:inverter:status" }
```

37
_addons_bindings/meteostick/readme.md
View File

@ -59,30 +59,31 @@ Set mode to one of the following depending on your device and region:
| Option | Description |
|---------|-------------------------------------------|
| channel | Sets the RF channel used for this sensor |
| spoon | Size of rain spoon assembly for this sensor in mm. Default value is 0.254 (0.01") for use with Davis part number 7345.280. Set to 0.2 for use with Davis part number 7345.319 |
## Channels
### Meteostick
| Channel Type ID | Item Type | Description |
|--------------------|-----------|--------------------|
| pressure | Number | Air pressure |
| indoor-temperature | Number | Indoor temperature |
| Channel Type ID | Item Type | Description |
|--------------------|--------------------|--------------------|
| pressure | Number:Pressure | Air pressure |
| indoor-temperature | Number:Temperature | Indoor temperature |
### Davis ISS
| Channel Type ID | Item Type | Description |
|---------------------|-----------|-------------------------------------------------|
| outdoor-temperature | Number | Outside temperature |
| humidity | Number | Humidity |
| wind-direction | Number | Wind direction |
| wind-speed | Number | Wind speed |
| rain-raw | Number | Raw rain counter from the tipping bucket sensor |
| rain-currenthour | Number | The rainfall in the last 60 minutes |
| rain-lasthour | Number | The rainfall in the previous hour |
| solar-power | Number | Solar power from the sensor station |
| signal-strength | Number | Received signal strength |
| low-battery | Number | Low battery warning |
| Channel Type ID | Item Type | Description |
|---------------------|-----------------------|-------------------------------------------------|
| outdoor-temperature | Number:Temperature | Outside temperature |
| humidity | Number | Humidity |
| wind-direction | Number:Angle | Wind direction |
| wind-speed | Number:Speed | Wind speed |
| rain-raw | Number | Raw rain counter from the tipping bucket sensor |
| rain-currenthour | Number:Length | The rainfall in the last 60 minutes |
| rain-lasthour | Number:Length | The rainfall in the previous hour |
| solar-power | Number | Solar power from the sensor station |
| signal-strength | Number | Received signal strength |
| low-battery | Switch | Low battery warning |
#### Rainfall
@ -93,9 +94,9 @@ The rainfall in the previous hour is the rainfall for each hour of the day and i
## Full Example
Things can be defined in the .thing file as follows
Things can be defined in the .things file as follows
```
meteostick:meteostick_bridge:receiver [ port="/dev/tty.usbserial-AI02XA60", mode=1 ]
meteostick:meteostick_davis_iss:iss (meteostick:meteostick_bridge:receiver) [ channel=1 ]
meteostick:meteostick_davis_iss:iss (meteostick:meteostick_bridge:receiver) [ channel=1, spoon=0.2 ]
```

9
_addons_bindings/mihome/readme.md
View File

@ -139,6 +139,15 @@ DateTime MotionSensor_LastMotion "[%1$tY-%1$tm-%1$td %1$tH:%1$tM]" <clock-on> {
Number MotionSensor_Battery <battery> { channel="mihome:sensor_motion:<ID>:batteryLevel" }
Switch MotionSensor_BatteryLow <energy> { channel="mihome:sensor_motion:<ID>:lowBattery" }
// Xiaomi Aqara Motion Sensor
Switch MotionSensor_MotionStatus <motion> { channel="mihome:sensor_motion_aq2:<ID>:motion" }
// minimum 5 seconds - remember that the sensor only triggers every minute to save energy
Number MotionSensor_MotionTimer <clock> { channel="mihome:sensor_motion_aq2:<ID>:motionOffTimer" }
DateTime MotionSensor_LastMotion "[%1$tY-%1$tm-%1$td %1$tH:%1$tM]" <clock-on> { channel="mihome:sensor_motion_aq2:<ID>:lastMotion" }
Number MotionSensor_Battery <battery> { channel="mihome:sensor_motion_aq2:<ID>:batteryLevel" }
Switch MotionSensor_BatteryLow <energy> { channel="mihome:sensor_motion_aq2:<ID>:lowBattery" }
Number MotionSensor_Lux "LUX [%.1f]" <sun> { channel="mihome:sensor_motion_aq2:<ID>:illumination" }
// Xiaomi Plug
Switch Plug_Switch <switch> { channel="mihome:sensor_plug:<ID>:power" }
Switch Plug_Active <switch> { channel="mihome:sensor_plug:<ID>:inUse" }

2
_addons_bindings/mios1/examples/scripts/README.md
View File

@ -8,7 +8,7 @@ NOTE: The rules for generating the Items file may change over time. The output
### OS Requirements
These scripts are intended to be run on a Linux, Unix or macOS system.
These scripts are intended to be run on a Linux, Unix or MacOS X system.
The MiOS openHAB Item file Generator scripts consist of:

97
_addons_bindings/mqtt/readme.md Normal file
View File

@ -0,0 +1,97 @@
---
id: mqtt
label: MQTT
title: MQTT - Bindings
type: binding
description: "MQTT is a machine-to-machine (M2M)/'Internet of Things' connectivity protocol."
since: 1x
logo: images/addons/mqtt.png
install: auto
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# MQTT Binding
MQTT is a machine-to-machine (M2M)/"Internet of Things" connectivity protocol.
It was designed as an extremely lightweight publish/subscribe messaging transport.
MQTT is a server/client architecture.
A server, also called broker is not provided within this binding,
but it allows to detect running brokers and to manage connections.
The hereby configured broker connections make it possible to link MQTT topics to Things and Channels.
## Supported Bridges
* Broker: This bridge represents a MQTT Broker connection, configured and managed by this binding.
* SystemBroker: A system configured broker cannot be changed by this binding and will be listed as read-only system-broker.
## Discovery
A best-effort subnet port scanner allows to find running MQTT brokers in the same network segment.
It scans the localhost and a /8 subnet on each IPv4 network interface for typical MQTT server ports on 1883 and 8883 (SSL).
## Bridge Configuration
Required configuration parameters are:
* __host__: The IP/Hostname of the MQTT broker. Be aware that this binding allows only one bridge / one connection per unique host:port.
* __port__: The optional port of the MQTT broker. If none is provided, the typical ports 1883 and 8883 (SSL) are used. Be aware that this binding allows only one bridge / one connection per unique host:port.
* __secure__: Uses TLS/SSL to establish a secure connection to the broker. Can be "OFF","ON","AUTO". The AUTO setting prefers a secure connection but will fall-back to an insecure one. Default is ON.
Additionally the following parameters can be set:
* __qos__: Quality of Service. Can be 0, 1 or 2. Please read the MQTT specification for details. Defaults to 0.
* __clientID__: Use a fixed client ID. Defaults to empty which means a user ID is generated for this connection.
* __retainMessages__: Retain messages. Defaults to false.
Reconnect parameters are:
* __reconnectTime__: Reconnect time in ms. If a connection is lost, the binding will wait this time before it tries to reconnect. Defaults to 60000 (60s).
* __keepAlive__: Keep alive / heartbeat timer in ms. It can take up to this time to determine if a server connection is lost. A lower value may keep the broker unnecessarily busy for no or little additional value. Defaults to 60000 (60s).
An MQTT last will and testament can be configured:
* __lwtMessage__: An optional last will and testament message. Defaults to empty.
* __lwtTopic__: The last will topic. Defaults to empty and therefore disables the last will.
* __lwtQos__: The optional qos of the last will. Defaults to 0.
* __lwtRetain__: Retain last will message. Defaults to false.
For more security, the following optional parameters can be altered:
* __username__: The MQTT username (since MQTT 3.1). Defaults to empty.
* __password__: The MQTT password (since MQTT 3.1). Defaults to empty.
* __certificatepin__: If this is set: After the next connection has been successfully established, the certificate is pinned. The connection will be refused if another certificate is used. Clear **certificate** to allow a new certificate for the next connection attempt. This option will increase security.
* __publickeypin__: If this is set: After the next connection has been successfully established, the public key of the broker is pinned. The connection will be refused if another public key is used. Clear **publickey** to allow a new public key for the next connection attempt. This option will increase security.
* __certificate__: The certificate hash. If **certificatepin** is set this hash is used to verify the connection. Clear to allow a new certificate pinning on the next connection attempt. If empty will be filled automatically by the next successful connection. An example input would be `SHA-256:83F9171E06A313118889F7D79302BD1B7A2042EE0CFD029ABF8DD06FFA6CD9D3`.
* __publickey__: The public key hash. If **publickeypin** is set this hash is used to verify the connection. Clear to allow a new public key pinning on the next connection attempt. If empty will be filled automatically by the next successful connection. An example input would be `SHA-256:83F9171E06A313118889F7D79302BD1B7A2042EE0CFD029ABF8DD06FFA6CD9D3`.
## Full Example
In a first example a very secure connection to a broker is defined. It pins the returned certificate and public key.
If someone tries a man in the middle attack later on, this broker connection will recognize it and refuse a connection.
Be aware that if your brokers certificate changes, you need to remove the connection entry and add it again. Secure connections are default, if you do not provide the "secure" parameter.
The second connection is a plain, unsecured one. Use this only for local MQTT Brokers.
A third connection uses a username and password for authentication.
The credentials are plain values on the wire, therefore you should only use this on a secure connection.
In a forth connection, the public key pinning is enabled again.
This time, a public key hash is provided to pin the connection to a specific server.
It follows the form "hashname:hashvalue". Valid *hashnames* are SHA-1, SHA-224, SHA-256, SHA-384, SHA-512 and all others listed
in [Java MessageDigest Algorithms](https://docs.oracle.com/javase/9/docs/specs/security/standard-names.html#messagedigest-algorithms).
`mqttConnections.things`:
```xtend
mqtt:broker:mySecureBroker [ host="192.168.0.41",secure="ON", certificatepin=true, publickeypin=true ]
mqtt:broker:myUnsecureBroker [ host="192.168.0.42",secure="OFF" ]
mqtt:broker:myAuthentificatedBroker [ host="192.168.0.43", username="user", password="password" ]
mqtt:broker:pinToPublicKey [ host="192.168.0.44", publickeypin=true, publickey="SHA-256:9a6f30e67ae9723579da2575c35daf7da3b370b04ac0bde031f5e1f5e4617eb8" ]
```

8
_addons_bindings/netatmo/readme.md
View File

@ -266,6 +266,8 @@ Number Netatmo_Wind_Strength "Wind Strength [%.0f KPH]" { channel = "netatmo:NAM
| LowBattery | Switch | Low battery |
| BatteryVP | Number | Battery level |
| RfStatus | Number | Signal strength (0 for no signal, 1 for weak, 2 for average, 3 for good or 4 for excellent) |
| MaxWindStrength | Number:Speed | Maximum wind strength recorded |
| DateMaxWindStrength | DateTime | Timestamp when MaxWindStrength was recorded |
All these channels are read only.
@ -328,6 +330,7 @@ All these channels are read only.
| Temperature | Number:Temperature | Current temperature |
| Sp_Temperature | Number:Temperature | Thermostat temperature setpoint |
| SetpointMode | String | Chosen setpoint_mode (program, away, hg, manual, off, max) |
| Planning | String | Id of the currently active planning when mode = program |
| ThermRelayCmd | Switch | Indicates whether the furnace is heating or not |
| ThermOrientation | Number | Physical orientation of the thermostat module |
| TimeStamp | DateTime | Timestamp when data was measured |
@ -337,7 +340,7 @@ All these channels are read only.
| BatteryVP | Number | Battery level |
| RfStatus | Number | Signal strength (0 for no signal, 1 for weak, 2 for average, 3 for good or 4 for excellent) |
All these channels except Sp_Temperature and SetpointMode are read only.
All these channels except Sp_Temperature, SetpointMode and Planning are read only.
### Welcome Home
@ -410,9 +413,6 @@ Person things are automatically created in discovery process for all known perso
All these channels except welcomePersonAtHome are read only.
Warning : while setting person away using the channel welcomePersonAtHome is fine, the contrary does not seem supported officially by Netatmo API.
# Configuration Examples

4
_addons_bindings/network/readme.md
View File

@ -131,11 +131,11 @@ Linux has three different tools:
* arping of the ip-utils (Ubuntu/Debian: `apt-get install iputils-arping`)
* arping by Thomas Habets (Ubuntu/Debian: `apt-get install arping`)
arping by Thomas Habets runs on Windows and macOS as well.
arping by Thomas Habets runs on Windows and MacOS as well.
Make sure the tool is available in the PATH, or in the same path as the openHAB executable.
On Linux and macOS elevated access permissions may be needed, for instance by making the executable a suid executable (`chmod u+s /usr/sbin/arping`).
On Linux and MacOS elevated access permissions may be needed, for instance by making the executable a suid executable (`chmod u+s /usr/sbin/arping`).
Just test the executable on the command line; if `sudo` is required, grant elevated permissions.
### DHCP Listen

14
_addons_bindings/nibeheatpump/readme.md
View File

@ -3,9 +3,9 @@ id: nibeheatpump
label: Nibe Heatpump
title: Nibe Heatpump - Bindings
type: binding
description: "The Nibe Heatpump binding is used to get live data from from Nibe heat pumps without using expensive MODBUS40 adapter. This binding should be compatible with at least the F1145 and F1245 heat pump models."
since: 1x
install: legacy
description: "The Nibe Heatpump binding is used to get live data from from Nibe heat pumps without using expensive MODBUS40 adapter."
since: 2x
install: auto
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
@ -14,7 +14,8 @@ install: legacy
# Nibe Heatpump Binding
The Nibe Heatpump binding is used to get live data from from Nibe heat pumps without using expensive MODBUS40 adapter. This binding should be compatible with at least the F1145 and F1245 heat pump models.
The Nibe Heatpump binding is used to get live data from from Nibe heat pumps without using expensive MODBUS40 adapter.
This binding should be compatible at least the F750, F1145 and F1245 heat pump models.
The binding support data telegrams (contains max 20 registers) from the heat pump, but binding can also read other registers from the pump.
It's recommend to add most changed variables to telegram, binding will then read all other registers automatically from the pump when channels are linked to item.
@ -32,6 +33,9 @@ This binding supports direct serial port connection (RS-485 adapter needed) to h
| f1x45-serial | Serial port connected F1145 and F1245 Heat Pumps |
| f1x45-udp | UDP connected Nibe F1145 and F1245 Heat Pumps |
| f1x45-simulator | Simulator for Nibe F1145 and F1245 Heat Pumps |
| f750-serial | Serial port connected F750 Heat Pumps |
| f750-udp | UDP connected Nibe F750 Heat Pumps |
| f750-simulator | Simulator for Nibe F750 Heat Pumps |
## Discovery
@ -898,5 +902,3 @@ This binding currently supports following channels for F1x45 pump models:
| 48458 | Number | 50 | 100 | Setting | Max speed circ.pump Heat | |
| 48459 | Number | 0 | 100 | Setting | Speed brine pump cooling | |
| 48487 | Number | 1 | 100 | Setting | Speed circ.pump Cooling | |

4
_addons_bindings/robonect/readme.md
View File

@ -96,7 +96,7 @@ Thing robonect:mower:automower "Mower" @ "Garden" [ host="192.168.2.1", pollInte
Items file `.items`
```java
String mowerName "Mower name" {robonect:mower:automower:name"}
String mowerName "Mower name" {channel="robonect:mower:automower:name"}
Number mowerBattery "Mower battery [%d %%]" <energy> {channel="robonect:mower:automower:battery"}
Number mowerHours "Mower operation hours [%d h]" <clock> {channel="robonect:mower:automower:mowing-hours"}
Number mowerDuration "Duration of current mode" {channel="robonect:mower:automower:status-duration"}
@ -112,7 +112,7 @@ String mowerJobStart "Job start time" {
String mowerJobEnd "Job end time" {channel="robonect:mower:automower:job-end"}
Number mowerErrorCode "Error code" {channel="robonect:mower:automower:error-code"}
String mowerErrorMessage "Error message" {channel="robonect:mower:automower:error-message"}
DateTie mowerErrorDate "Error date [%1$td/%1$tm %1$tH:%1$tM]" {channel="robonect:mower:automower:error-date"}
DateTime mowerErrorDate "Error date [%1$td/%1$tm %1$tH:%1$tM]" {channel="robonect:mower:automower:error-date"}
```
Map transformation for mower status (`robonect_status.map`)

6
_addons_bindings/sonos/readme.md
View File

@ -17,6 +17,12 @@ install: auto
This binding integrates the [Sonos Multi-Room Audio system](http://www.sonos.com).
**Attention:**
You might run into trouble if your control system (the binding) is in another subnet than your Sonos device.
Sonos devices make use of multicast which in most cases needs additional router configuration outside of a single subnet.
If you observe communication errors (COMMUNICATION_ERROR/not registered), you might need to configure your router to increase the TTL of the packets send by your Sonos device.
This happens because of a TTL=1 for ALIVE packets send by Sonos devices, resulting in dropped packets after one hop.
## Supported Things
All available Sonos (playback) devices are supported by this binding. This includes the Play:1, Play:3, Play:5, Connect, Connect:Amp, Playbar, and Sub. The Bridge and Boost are not supported, but these devices do only have an auxiliary role in the Sonos network and do not have any playback capability. All supported Sonos devices are registered as an audio sink in the framework.

2
_addons_bindings/tcp1/readme.md
View File

@ -81,6 +81,6 @@ where `<direction>` is one of the following values:
Here are some examples of valid binding configuration strings:
```
tcp=">[ON:192.168.0.1:3000:'MAP(my.device.map)')], >[OFF:192.168.0.1:3000:'MAP(my.device.map)']" // for a Switch Item where values are converted using the my.device.map
tcp=">[ON:192.168.0.1:3000:'MAP(my.device.map)'], >[OFF:192.168.0.1:3000:'MAP(my.device.map)']" // for a Switch Item where values are converted using the my.device.map
tcp="<[192.168.0.2:3000:'REGEX((.*))']" // for a String Item that captures some state of a remote device that connects to openHAB
```

16
_addons_bindings/zigbee/readme.md
View File

@ -25,6 +25,18 @@ A ZigBee Coordinator is the network controller, and is therefore the heart of th
Coordinators need to be installed manually and the serial port must be set.
#### Examples for coordinators
| Name and Link | Coordinator | Comment |
|----------------------------|-------------|-------------------------------|
|[Texas Instruments CC2531EMK](http://www.ti.com/tool/cc2531emk)|[TI2531](#ti2531-coordinator)|Needs extra hardware and correct firmware (might be hard to find) for flashing.<br>There are also cheap copies of the CC2531 Stick available on eBay, Aliexpress, etc. like [this](https://de.aliexpress.com/item/Drahtlose-Zigbee-CC2531-Sniffer-software-protokoll-analyse-Bareboard-Paket-Protokoll-Analyzer-Modul-Usb-schnittstelle-Dongle-Erfassen/32852226435.html) and a module to flash the firmware like [this](https://de.aliexpress.com/item/SmartRF04EB-CC1110-CC2530-ZigBee-Module-USB-Downloader-Emulator-MCU-M100/32673666126.html)<br>Also CC2530, CC2538 or CC2650 might work with the correct firmware but are not suggested|
|[Bitron Video ZigBee USB Funkstick](http://www.bitronvideo.eu/index.php/produkte/smart-home-produkte/zb-funkstick/)|[Ember](#ember-ezsp-ncp-coordinator)|-|
|[Cortet EM358 USB Stick](https://www.cortet.com/iot-hardware/cortet-usb-sticks/em358-usb-stick)|[Ember](#ember-ezsp-ncp-coordinator)|-|
|[Nortek Security & Control HUSBZB-1](https://nortekcontrol.com/products/2gig/husbzb-1-gocontrol-quickstick-combo/)|[Ember](#ember-ezsp-ncp-coordinator)|Stick contains both Z-Wave and Zigbee|
|[Telegesis ETRX357USB zigbee® USB Stick](https://www.silabs.com/products/wireless/mesh-networking/telegesis-modules-gateways/etrx3-zigbee-usb-sticks)|[Telegesis](#telegesis-etrx3)|-|
|[QIVICON ZigBee-Funkstick](https://www.qivicon.com/de/produkte/produktinformationen/zigbee-funkstick/)|[Telegesis](#telegesis-etrx3)|Only working on Linux devices|
|[Digi XStick](https://www.digi.com/products/xbee-rf-solutions/boxed-rf-modems-adapters/xstick)|[XBee](#xbee-xu-z11-coordinator)|-|
#### TI2531 Coordinator
This is the Texas Instruments ZNP stack. The thing type is ```coordinator_ti2351```.
@ -53,6 +65,10 @@ The Ember EZSP NCP (Network Co-Processor) supports the Silabs EM358 or MightyGec
The thing type is ```coordinator_telegesis```.
#### XBee XU-Z11 Coordinator
The thing type is ```coordinator_xbee```.
### Devices
The following devices have been tested with the binding

3
_addons_bindings/zwave/doc/aeon/zw100_1_10.md
View File

@ -11,6 +11,9 @@ This version of the device is limited to firmware versions above 1.10
The device is in the category of *Sensor*, defining Device used to measure something.
![ZW100 product image](https://www.cd-jackson.com/zwave_device_uploads/778/778_default.jpg)
The ZW100 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.
## Overview

16
_addons_bindings/zwave/doc/defaro/dad101_0_0.md
View File

@ -1,19 +1,19 @@
---
layout: documentation
title: DAD-10 - ZWave
title: DAD-101 - ZWave
---
{% include base.html %}
# DAD-10 Dimmer with sensors support
This describes the Z-Wave device *DAD-10*, manufactured by *[Defaro](http://defaro.ru)* with the thing type UID of ```defaro_dad101_00_000```.
# DAD-101 Dimmer with sensors support
This describes the Z-Wave device *DAD-101*, manufactured by *[Defaro](http://defaro.ru)* with the thing type UID of ```defaro_dad101_00_000```.
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![DAD-10 product image](https://www.cd-jackson.com/zwave_device_uploads/833/833_default.jpg)
![DAD-101 product image](https://www.cd-jackson.com/zwave_device_uploads/833/833_default.jpg)
The DAD-10 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.
The DAD-101 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.
## Overview
@ -34,7 +34,7 @@ Always listening
## Channels
The following table summarises the channels available for the DAD-10 -:
The following table summarises the channels available for the DAD-101 -:
| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
@ -66,7 +66,7 @@ The ```switch_dimmer1``` channel supports the ```Dimmer``` item and is in the ``
## Device Configuration
The following table provides a summary of the 21 configuration parameters available in the DAD-10.
The following table provides a summary of the 21 configuration parameters available in the DAD-101.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
@ -439,7 +439,7 @@ This parameter has the configuration ID ```switchall_mode``` and is of type ```I
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 DAD-10 supports 7 association groups.
The DAD-101 supports 7 association groups.
### Group 1: Lifeline

263
_addons_bindings/zwave/doc/everspring/sp816_0_0.md Normal file
View File

@ -0,0 +1,263 @@
---
layout: documentation
title: SP816 - ZWave
---
{% include base.html %}
# SP816 SP816 Motion Sensor
This describes the Z-Wave device *SP816*, manufactured by *Everspring* with the thing type UID of ```everspring_sp816_00_000```.
The device is in the category of *Motion Detector*, defining Motion sensors/detectors.
![SP816 product image](https://www.cd-jackson.com/zwave_device_uploads/855/855_default.jpg)
The SP816 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.
The SP816 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
## Overview
The SP816 Outdoor Motion Detector is a Z-Wave PlusTM enabled device and is fully compatible with any Z-WaveTM enabled network. The device can be set up in a Z-wave network to communicate directly with other end devices such as lighting controllers, or to report directly to a Z-wave controller (usually a gateway). This motion detector is primarily designed for outdoor lighting control application. It features a PIR motion detector to detect movement in a protected area and a lux sensor for determining brightness of its surroundings. It comes with a built in timer to set the duration for light turn on. The lux level and the timer can be set through knobs on the device itself. If the PIR detects motion when lux level falls below a preset setting, the device will transmit a signal to turn on the outdoor lighting (or indirectly through gateway) and then later turns it off when its timer has elapsed.
### Inclusion Information
The detector supports Auto Inclusion feature where it will automatically enter Inclusion mode when first powered up after a factory reset. 1. Use a screwdriver to detach the rear cover. 2. Put a Z-Wave Controller into inclusion mode. Insert 3 AA-size 1.5V batteries to the battery compartment with the correct polarity. The LED on the device should turns ON.. 4. The Inclusion process should be
### Exclusion Information
The detector supports Auto Inclusion feature where it will automatically enter Inclusion mode when first powered up after a factory reset. 1. Use a screwdriver to detach the rear cover. 2. Put a Z-Wave Controller into inclusion mode. Insert 3 AA-size 1.5V batteries to the battery compartment with the correct polarity. The LED on the device should turns ON.. 4. The Inclusion process should be
### Wakeup Information
For waking up please triple click the tamper switch
## Channels
The following table summarises the channels available for the SP816 -:
| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Binary Sensor | sensor_binary | Door | Switch |
| Alarm (burglar) | alarm_burglar | Door | Switch |
| Alarm (power) | alarm_power | Door | Switch |
| Battery Level | battery-level | Battery | Number |
### Binary Sensor
Indicates if a sensor has triggered.
The ```sensor_binary``` channel 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 |
|-------|-----------|
| ON | Triggered |
| OFF | Untriggered |
### Alarm (burglar)
Indicates if the burglar alarm is triggered.
The ```alarm_burglar``` channel 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 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 |
### 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category.
## Device Configuration
The following table provides a summary of the 6 configuration parameters available in the SP816.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Basic Set Level | Basic Set Level |
| 2 | Enable/Disable Detecting | The Detecting function can be Disabled or Enabled. |
| 3 | Sensitivity Level | 1 Means lowest sensitivity and 10 means highest. |
| 4 | Re-trigger Interval | Adjust the interval of being re-triggered after a trigger |
| 5 | Lux Level | Minimum Lux Level to provoke trigger |
| 6 | On-Off Duration | On-Off Duration |
| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller |
| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications |
### Parameter 1: Basic Set Level
Basic Set Level
When Basic Set Command is sent where contains a value, the receiver will take it for consideration; for instance, if a lamp module is received the Basic Set command of which value is decisive as to how bright of dim level of lamp module shall be.
Example: 0: OFF
1-99: ON (Binary Switch Device)
Dim Level (Multilevel Switch Device)
Function: Basic Set level
Parameter: 1
Number Size: 1
Range: 0-99
Default: 99
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Enable/Disable Detecting
The Detecting function can be Disabled or Enabled.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disabled |
| 1 | Enabled |
The manufacturer defined default value is ```1``` (Enabled).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Sensitivity Level
1 Means lowest sensitivity and 10 means highest.
Values in the range 1 to 10 may be set.
The manufacturer defined default value is ```6```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Re-trigger Interval
Adjust the interval of being re-triggered after a trigger
The Configuration parameter that can be used to adjust the interval of being re-triggered after the detector has been triggered as Configuration Parameter #4. No response will be made during this interval if a movement is presented. The time interval can be set between 5 secs to 3600 secs.
Values in the range 5 to 3600 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_4_2``` and is of type ```INTEGER```.
### Parameter 5: Lux Level
Minimum Lux Level to provoke trigger
Sets minimum Lux Level of ambient illumination necessary for Motion Detector to trigger.
The user can set a detecting percentage of lux level which determines when the light sensor will be activated. If percentage of lux level of ambient illumination falls below this percentage, and a person moves across or within the protected area, the detector will emit Z-Wave ON Command (i.e. Basic Set Command (Value = Basic Set Level)) to controller and activate connected modules and lighting. Percentage can be set between 1% to 100%.
Values in the range 1 to 100 may be set.
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: On-Off Duration
On-Off Duration
The function of on-off duration setting will be useful if the detector is connected with a module or lighting. The duration determines how long the module/lighting should stay ON. For instance, Lamp Module turns off 100 secs after it has been turned on. This parameter can be configured with the value of 5 through 3600, where 5 means 5 second delay and 3600 means 3600 seconds of delay
Values in the range 5 to 255 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Wakeup Interval
The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications.
This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances.
Note that this setting does not affect the devices ability to send sensor data, or notification events.
This parameter has the configuration ID ```wakeup_interval``` and is of type ```INTEGER```.
### Wakeup Node
When sleeping devices wake up, they send a notification to a listening device. Normally, this device is the network controller, and normally the controller will set this automatically to its own address.
In the event that the network contains multiple controllers, it may be necessary to configure this to a node that is not the main controller. This is an advanced setting and should not be changed without a full understanding of the impact.
This parameter has the configuration ID ```wakeup_node``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The SP816 supports 2 association groups.
### Group 1: Reports
This group supports 1 nodes.
### Group 2: Control
This group supports 3 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SENSOR_BINARY_V0| Linked to BASIC|
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ALARM_V4| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_SECURITY_V0| |
### Documentation Links
* [Manual](https://www.cd-jackson.com/zwave_device_uploads/855/SP816-A501112630R-user-manual-20171013.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/855).

209
_addons_bindings/zwave/doc/fibaro/fgd212_0_0.md
View File

@ -18,7 +18,42 @@ The FGD212 supports routing. This allows the device to communicate using other r
## Overview
No device information is provided in the database. Consider [updating the database](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/133) to improve the documentation.
FIBARO Dimmer 2 remotely controlled light dimming module is designed to work with
various types of light sources. It may be connected to two-wire or
three-wire configuration so it can operate with or without neutral
lead. FIBARO Dimmer 2 can switch or dim connected light source
either through radio waves or through the wall switch connected
directly to it.
### Inclusion Information
To add the device to the Z-Wave network:
1\. Place the Dimmer 2 within the direct range of your Z-Wave
controller
2\. Identify switch no. 1 (turns the light on) or the B-button (located
on the device’s housing)
3\. Set the main controller in (security/non-security) add mode (see
the controller’s manual)
4\. Quickly, three times press switch no. 1 or the B-button
5\. Wait for the adding process to end
6\. Successful adding will be confrmed by the Z-Wave controller’s
message
### Exclusion Information
To remove the device from the Z-Wave network:
1\. Place the Dimmer 2 within the direct range of your Z-Wave
controller
2\. Identify switch no. 1 (turns the light on) or the B-button (located
on the device’s housing)
3\. Set the main controller in remove mode (see the controller’s
manual)
4\. Quickly, three times press switch no. 1 or the B-button
5\. Wait for the removing process to end
6\. Successful removing will be confrmed by the Z-Wave controller’s
message
7\. Dimmer 2 will start the calibration process (see „Calibration” on
page 15)
## Channels
@ -158,62 +193,62 @@ Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Minimum brightness level | The parameter is set automatically during the calibration process. The parameter can be changed manually after the calibration. |
| 2 | Maximum brightness level | The parameter is set automatically during the calibration process. The parameter can be changed manually after the calibration. |
| 3 | Incandescence level of dimmable compact fluorescent lamps | Virtual value set as a percentage level between parameters MIN (1%) and MAX. (99%). The Dimmer will set to this value after first switch on. It is required for warming up and switching dimmable compact fluorescent lamps and certain types of light sources. |
| 4 | Incandescence time of dimmable compact fluorescent lamps | This parameter determines the time required for switching compact fluorescent lamps and certain types of light sources. Setting this parameter to 0 will disable the incandescence functionality. Available settings: 0-255 (0s - 25,5s) |
| 5 | Dimming Step at Automatic Control | The parameter defines the percentage of a dimming step at automatic control. 1-99 |
| 6 | Dimming Step Timing at Automatic Control | The parameter defines the time of a dimming step at automatic control. Available settings: 0-255 (0s - 2,55s) |
| 7 | Dimming Step at Manual Control | The parameter defines the percentage of a dimming step at manual control. 1-99 |
| 8 | Dimming Step Timing at Manual Control | The parameter defines the time of a dimming step at manual control. Available settings: 0-255 (0s - 2,55s) |
| 1 | Minimum brightness level | Set automatically during the calibration process |
| 2 | Maximum brightness level | Set automatically during the calibration process. |
| 3 | Incandescence level of dimmable compact fluorescent lamps | Dimmer will set to this value after first switch on. |
| 4 | Incandescence time of dimmable compact fluorescent lamps | Time for switching fluorescent lamps and certain light sources. |
| 5 | Dimming Step at Automatic Control | Percentage of a dimming step at automatic control. |
| 6 | Dimming Step Timing at Automatic Control | Time of a dimming step at automatic control. |
| 7 | Dimming Step at Manual Control | Percentage of a dimming step at manual control. |
| 8 | Dimming Step Timing at Manual Control | Time of a dimming step at manual control. |
| 9 | Saving state before power failure | Saving state before power failure |
| 10 | Timer functionality (auto - off). 0 disables the function | The parameter defines the setting of the timer. Available settings:1-32767 - time to turn off measured in seconds (1s - 9,1h) |
| 10 | Timer functionality (auto - off). 0 disables the function | Setting of the timer. |
| 11 | ALL ON/ALL OFF function | The parameter specifies the available functions. |
| 13 | Force auto-calibration | Changing the value of this parameter to 1 will force the calibration process. During the calibration parameter is set to 1 and switched to 0 upon completion. |
| 14 | Auto-calibration status (read-only parameter) | This parameter determines operating mode of the Dimmer (automatic/manual settings). |
| 15 | Burnt out bulb detection | percentage value of power variation, compared to standard power consumption, measured during the calibration procedure (to be interpreted as load error/burnt out bulb). 1-99, 0 disables the function. |
| 16 | Time delay of a burnt out bulb (parameter 15) or overload (parameter 39) detection | Time of delay (in seconds) for power variation detection, interpreted as a LOAD ERROR or OVERLOAD detection (too much power connected to the Dimmer 2). 0 disables the function. |
| 19 | Forced switch on brightness level | If the parameter is active, switching on the Dimmer 2 (S1 single click) will always set this brightness level. 0 disables the function. |
| 13 | Force auto-calibration | Force the calibration process |
| 14 | Auto-calibration status (read-only parameter) | Mode of the Dimmer (auto/man settings). |
| 15 | Burnt out bulb detection | Percentage value of power variation |
| 16 | Time delay of a burnt out bulb or overload detection | Delay for power variation detection |
| 19 | Forced switch on brightness level | Switching on the Dimmer will always set this brightness level. |
| 20 | Inputs Button/Switch configuration | Binary inputs type configuration |
| 21 | Value sent to associated devices on single click | The value sent to associated devices on single click. |
| 22 | Change [On-Off] bi-stable keys | This function allow user to change \[On-Off\] bi-stable keys (parameter no. 14) (default value 0) |
| 22 | Change [On-Off] bi-stable keys | Allow user to change \[On-Off\] bi-stable keys |
| 23 | Double click option | Double-click set lighting at 100% |
| 24 | Command frames sent in 2nd and 3rd association groups (S1 associations) | Parameter determines, which actions will not result in sending frames to association groups. |
| 25 | Command frames sent in 4th and 5th association groups (S2associations) | Parameter determines, which actions will not result in sending frames to association groups. |
| 26 | The function of 3-way switch | Key no. 2 controls the Dimmer additionally (in 3-way switch mode). Function disabled for parameter 20 set to 2 (roller blind switch). |
| 27 | Associations in Z-Wave network security mode | This parameter defines how commands are sent in specified association groups: as secure or non-secure. Parameter is active only in Z-Wave network security mode. It does not apply to 1st Lifeline group. |
| 24 | Command frames sent in 2nd and 3rd association groups | Actions not resulting in sending frames to association groups |
| 25 | Command frames sent in 4th and 5th association groups | Actions not resulting in sending frames to association groups |
| 26 | The function of 3-way switch | Key no. 2 controls the Dimmer additionally |
| 27 | Associations in Z-Wave network security mode | Param. sent in specified assoc. groups: secure or non-secure |
| 28 | Scene activation functionality | SCENE ID depends on the switch type configuration |
| 29 | Switch functionality of S1 and S2 | Switch S1 and S2 buttons |
| 30 | Load control mode | The parameter defines the used control mode. |
| 31 | Load control mode recognized during auto-calibration | Load control mode recognized during auto-calibration |
| 32 | On/Off mode | This mode is necessary while connecting non-dimmable light sources. Enabling parameter 32 automatically ignores brightening/- dimming time settings. |
| 32 | On/Off mode | Ignore brightening/- dimming time settings. |
| 33 | Dimmability of the load (read only) | Dimmability of the load (read only) |
| 34 | Soft-Start functionality | Time required to warm up the filament of halogen bulb. |
| 35 | Auto-calibration after power on | This parameter determines the trigger of auto-calibration procedure, e.g. power on, load error, etc. |
| 35 | Auto-calibration after power on | Determine the trigger of auto-calibration procedure |
| 37 | Behaviour of the Dimmer after overload or surge | |
| 39 | Power limit - OVERLOAD | Reaching the defined value will result in turning off the load. Parameter 39 is relevant only in a 3-wire connection i or a 2-wire connection for load of cosφ ≥ 0.99. (1 W - 250 W). 0 disables the function. |
| 39 | Power limit - OVERLOAD | Reaching the defined value will result in turning off the load |
| 40 | General Purpose Alarm | The parameter specifies the response to an alarm. |
| 41 | Water Flooding Alarm | The parameter specifies the response to an alarm. |
| 42 | Smoke, CO or CO2 Alarm | The parameter specifies the response to an alarm. |
| 43 | Temperature Alarm | The parameter specifies the response to an alarm. |
| 44 | Time of alarm state | Alarm state may be cancelled earlier, as a result of pushing the wall-switch keys or sending the Z-Wave command frame. Available settings: 1-32767 (1s - 32767s). |
| 44 | Time of alarm state | Alarm state may be cancelled earlier |
| 45 | OVERLOAD alarm report | (load power consumption too high) |
| 46 | LOAD ERROR alarm report | (no load, load failure, burnt out bulb) |
| 47 | OVERCURRENT alarm report | (short circuit, burnt out bulb causing overcurrent) |
| 48 | SURGE alarm report | (Dimmer output overvoltage) |
| 49 | OVERHEAT (critical temperature) and VOLTAGE DROP (low voltage) alarm report | |
| 50 | Active power reports | The parameter defines the power level change that will result in a new power report being sent. The value is a percentage of the previous report. 0 disables the function. |
| 52 | Periodic active power and energy reports | Parameter 52 defines a time period between consecutive reports. Timer is reset and counted from zero after each report (1 sec - 32767 sec). 0 disables the function. |
| 53 | Energy reports | Energy level change which will result in sending a new energy report. Available settings: 1-255 (0,01 - 2,55 kWh). 0 disables the function. |
| 54 | Self-measurement | The Dimmer may include active power and energy used by itself in reports sent to the main controller. |
| 58 | Method of calculating the active power | This parameter defines how to calculate active power. It is useful in a case of 2-wire connection with light sources other than resistive. Note: Parameter 58 is set to 0 after forced auto-calibration |
| 59 | Approximated power at the maximum brightness level | This parameter determines the approximate value of the power that will be reported by the device at its maximum brightness level. Available settings: 0-500 (0-500W). Note: Parameter 59 works only when parameter 58 has a value other than 0. |
| 49 | OVERHEAT and VOLTAGE DROP alarm report | |
| 50 | Active power reports | Power level change resulting in new power report being sent. |
| 52 | Periodic active power and energy reports | Time period between consecutive reports. |
| 53 | Energy reports | Energy level change resulting in sending a new energy report. |
| 54 | Self-measurement | Active power and energy used by itself |
| 58 | Method of calculating the active power | How to calculate active power. |
| 59 | Approximated power at the maximum brightness level | Power reported by the device at its maximum brightness level |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 1: Minimum brightness level
Set automatically during the calibration process
The parameter is set automatically during the calibration process. The parameter can be changed manually after the calibration.
Values in the range 1 to 98 may be set.
The manufacturer defined default value is ```1```.
@ -223,8 +258,8 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG
### Parameter 2: Maximum brightness level
Set automatically during the calibration process.
The parameter is set automatically during the calibration process. The parameter can be changed manually after the calibration.
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```99```.
@ -234,8 +269,8 @@ This parameter has the configuration ID ```config_2_1``` and is of type ```INTEG
### Parameter 3: Incandescence level of dimmable compact fluorescent lamps
Dimmer will set to this value after first switch on.
Virtual value set as a percentage level between parameters MIN (1%) and MAX. (99%). The Dimmer will set to this value after first switch on. It is required for warming up and switching dimmable compact fluorescent lamps and certain types of light sources.
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
@ -245,8 +280,8 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG
### Parameter 4: Incandescence time of dimmable compact fluorescent lamps
Time for switching fluorescent lamps and certain light sources.
This parameter determines the time required for switching compact fluorescent lamps and certain types of light sources. Setting this parameter to 0 will disable the incandescence functionality. Available settings: 0-255 (0s - 25,5s)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
@ -256,8 +291,8 @@ This parameter has the configuration ID ```config_4_2``` and is of type ```INTEG
### Parameter 5: Dimming Step at Automatic Control
Percentage of a dimming step at automatic control.
The parameter defines the percentage of a dimming step at automatic control. 1-99
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
@ -267,8 +302,8 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG
### Parameter 6: Dimming Step Timing at Automatic Control
Time of a dimming step at automatic control.
The parameter defines the time of a dimming step at automatic control. Available settings: 0-255 (0s - 2,55s)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```1```.
@ -278,8 +313,8 @@ This parameter has the configuration ID ```config_6_2``` and is of type ```INTEG
### Parameter 7: Dimming Step at Manual Control
Percentage of a dimming step at manual control.
The parameter defines the percentage of a dimming step at manual control. 1-99
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
@ -289,8 +324,8 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG
### Parameter 8: Dimming Step Timing at Manual Control
Time of a dimming step at manual control.
The parameter defines the time of a dimming step at manual control. Available settings: 0-255 (0s - 2,55s)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```5```.
@ -306,18 +341,18 @@ The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | State NOT saved at power failure, all outputs are set to OFF upon powe |
| 1 | State saved at power failure, all outputs are set to previous state up |
| 0 | State not saved, outputs OFF |
| 1 | State saved, outputs to previous |
The manufacturer defined default value is ```1``` (State saved at power failure, all outputs are set to previous state up).
The manufacturer defined default value is ```1``` (State saved, outputs to previous).
This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```.
### Parameter 10: Timer functionality (auto - off). 0 disables the function
Setting of the timer.
The parameter defines the setting of the timer. Available settings:1-32767 - time to turn off measured in seconds (1s - 9,1h)
Values in the range 0 to 32767 may be set.
The manufacturer defined default value is ```0```.
@ -345,8 +380,8 @@ This parameter has the configuration ID ```config_11_2``` and is of type ```INTE
### Parameter 13: Force auto-calibration
Force the calibration process
Changing the value of this parameter to 1 will force the calibration process. During the calibration parameter is set to 1 and switched to 0 upon completion.
The following option values may be configured -:
| Value | Description |
@ -362,16 +397,16 @@ This parameter has the configuration ID ```config_13_1``` and is of type ```INTE
### Parameter 14: Auto-calibration status (read-only parameter)
Mode of the Dimmer (auto/man settings).
This parameter determines operating mode of the Dimmer (automatic/manual settings).
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | calibration procedure not performed or Dimmer operates on manual setti |
| 0 | No calibration on manual setting |
| 1 | Dimmer operates on auto-calibration settings |
The manufacturer defined default value is ```0``` (calibration procedure not performed or Dimmer operates on manual setti).
The manufacturer defined default value is ```0``` (No calibration on manual setting).
This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```.
This is a read only parameter.
@ -379,8 +414,8 @@ This is a read only parameter.
### Parameter 15: Burnt out bulb detection
percentage value of power variation, compared to standard power consumption, measured during the calibration procedure (to be interpreted as load error/burnt out bulb). 1-99, 0 disables the function.
Percentage value of power variation
Percentage value of power variation, compared to standard power consumption, measured during the calibration procedure (to be interpreted as load error/burnt out bulb). 1-99, 0 disables the function.
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```30```.
@ -388,10 +423,10 @@ The manufacturer defined default value is ```30```.
This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```.
### Parameter 16: Time delay of a burnt out bulb (parameter 15) or overload (parameter 39) detection
### Parameter 16: Time delay of a burnt out bulb or overload detection
Delay for power variation detection
Time of delay (in seconds) for power variation detection, interpreted as a LOAD ERROR or OVERLOAD detection (too much power connected to the Dimmer 2). 0 disables the function.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```5```.
@ -401,8 +436,8 @@ This parameter has the configuration ID ```config_16_2``` and is of type ```INTE
### Parameter 19: Forced switch on brightness level
Switching on the Dimmer will always set this brightness level.
If the parameter is active, switching on the Dimmer 2 (S1 single click) will always set this brightness level. 0 disables the function.
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
@ -435,26 +470,26 @@ The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | 0xFF value is sent, which will set associated devices to their last sa |
| 1 | current Dimmer 2 state is sent, which will synchronize brightness leve |
| 0 | Associated devices to last saved value |
| 1 | Synchronize brightness level |
The manufacturer defined default value is ```0``` (0xFF value is sent, which will set associated devices to their last sa).
The manufacturer defined default value is ```0``` (Associated devices to last saved value).
This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```.
### Parameter 22: Change [On-Off] bi-stable keys
Allow user to change \[On-Off\] bi-stable keys
This function allow user to change \[On-Off\] bi-stable keys (parameter no. 14) (default value 0)
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Device changes status on key status change |
| 1 | Device status depends on key status; ON when the key is ON, OFF when t |
| 0 | Changes status on key status change |
| 1 | Device status depends on key status |
The manufacturer defined default value is ```0``` (Device changes status on key status change).
The manufacturer defined default value is ```0``` (Changes status on key status change).
This parameter has the configuration ID ```config_22_1``` and is of type ```INTEGER```.
@ -475,10 +510,10 @@ The manufacturer defined default value is ```1``` (Enable double click).
This parameter has the configuration ID ```config_23_1``` and is of type ```INTEGER```.
### Parameter 24: Command frames sent in 2nd and 3rd association groups (S1 associations)
### Parameter 24: Command frames sent in 2nd and 3rd association groups
Actions not resulting in sending frames to association groups
Parameter determines, which actions will not result in sending frames to association groups.
The following option values may be configured -:
| Value | Description |
@ -486,7 +521,7 @@ The following option values may be configured -:
| 0 | all actions send to association groups |
| 1 | do not send when switching ON (single click) |
| 2 | do not send when switching OFF (single click) |
| 4 | do not send when changing dimming level (holding and releasing) |
| 4 | Do not send when changing dimming level |
| 8 | do not send on double click |
| 16 | send 0xFF value on double click |
@ -495,10 +530,10 @@ The manufacturer defined default value is ```0``` (all actions send to associati
This parameter has the configuration ID ```config_24_1``` and is of type ```INTEGER```.
### Parameter 25: Command frames sent in 4th and 5th association groups (S2associations)
### Parameter 25: Command frames sent in 4th and 5th association groups
Actions not resulting in sending frames to association groups
Parameter determines, which actions will not result in sending frames to association groups.
The following option values may be configured -:
| Value | Description |
@ -506,7 +541,7 @@ The following option values may be configured -:
| 0 | all actions send to association groups |
| 1 | do not send when switching ON (single click) |
| 2 | do not send when switching OFF (single click) |
| 4 | do not send when changing dimming level (holding and releasing) |
| 4 | do not send when changing dimming level |
| 8 | do not send on double click |
| 16 | send 0xFF value on double click |
@ -517,8 +552,8 @@ This parameter has the configuration ID ```config_25_1``` and is of type ```INTE
### Parameter 26: The function of 3-way switch
Key no. 2 controls the Dimmer additionally
Key no. 2 controls the Dimmer additionally (in 3-way switch mode). Function disabled for parameter 20 set to 2 (roller blind switch).
The following option values may be configured -:
| Value | Description |
@ -533,8 +568,8 @@ This parameter has the configuration ID ```config_26_1``` and is of type ```INTE
### Parameter 27: Associations in Z-Wave network security mode
Param. sent in specified assoc. groups: secure or non-secure
This parameter defines how commands are sent in specified association groups: as secure or non-secure. Parameter is active only in Z-Wave network security mode. It does not apply to 1st Lifeline group.
The following option values may be configured -:
| Value | Description |
@ -593,9 +628,9 @@ The following option values may be configured -:
|--------|-------------|
| 0 | forced leading edge control |
| 1 | forced trailing edge control |
| 2 | control mode selected automatically (based on auto-calibration) |
| 2 | control mode selected automatically |
The manufacturer defined default value is ```2``` (control mode selected automatically (based on auto-calibration)).
The manufacturer defined default value is ```2``` (control mode selected automatically ).
This parameter has the configuration ID ```config_30_1``` and is of type ```INTEGER```.
@ -619,8 +654,8 @@ This is a read only parameter.
### Parameter 32: On/Off mode
Ignore brightening/- dimming time settings.
This mode is necessary while connecting non-dimmable light sources. Enabling parameter 32 automatically ignores brightening/- dimming time settings.
The following option values may be configured -:
| Value | Description |
@ -670,8 +705,8 @@ This parameter has the configuration ID ```config_34_1``` and is of type ```INTE
### Parameter 35: Auto-calibration after power on
Determine the trigger of auto-calibration procedure
This parameter determines the trigger of auto-calibration procedure, e.g. power on, load error, etc.
The following option values may be configured -:
| Value | Description |
@ -679,8 +714,8 @@ The following option values may be configured -:
| 0 | No auto-calibration of the load after power on |
| 1 | Auto-calibration performed after first power on |
| 2 | Auto-calibration performed after each power on |
| 3 | Auto-calibration performed after first power on or after each LOAD ERR |
| 4 | Auto-calibration performed after each power on or after each LOAD ERRO |
| 3 | Auto-calibration performed after first power on/Load error |
| 4 | Auto-calibration performed after power on/LOAD ERROR |
The manufacturer defined default value is ```1``` (Auto-calibration performed after first power on).
@ -695,7 +730,7 @@ The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | device permanently disabled until re-enabling by comand or push-button |
| 0 | Device permanently disabled |
| 1 | three attempts to turn on the load |
The manufacturer defined default value is ```1``` (three attempts to turn on the load).
@ -705,8 +740,8 @@ This parameter has the configuration ID ```config_37_1``` and is of type ```INTE
### Parameter 39: Power limit - OVERLOAD
Reaching the defined value will result in turning off the load
Reaching the defined value will result in turning off the load. Parameter 39 is relevant only in a 3-wire connection i or a 2-wire connection for load of cosφ ≥ 0.99. (1 W - 250 W). 0 disables the function.
Values in the range 0 to 250 may be set.
The manufacturer defined default value is ```250```.
@ -788,8 +823,8 @@ This parameter has the configuration ID ```config_43_1``` and is of type ```INTE
### Parameter 44: Time of alarm state
Alarm state may be cancelled earlier
Alarm state may be cancelled earlier, as a result of pushing the wall-switch keys or sending the Z-Wave command frame. Available settings: 1-32767 (1s - 32767s).
Values in the range 1 to 32767 may be set.
The manufacturer defined default value is ```600```.
@ -861,7 +896,7 @@ The manufacturer defined default value is ```1``` (Send an alarm frame).
This parameter has the configuration ID ```config_48_1``` and is of type ```INTEGER```.
### Parameter 49: OVERHEAT (critical temperature) and VOLTAGE DROP (low voltage) alarm report
### Parameter 49: OVERHEAT and VOLTAGE DROP alarm report
@ -879,8 +914,8 @@ This parameter has the configuration ID ```config_49_1``` and is of type ```INTE
### Parameter 50: Active power reports
Power level change resulting in new power report being sent.
The parameter defines the power level change that will result in a new power report being sent. The value is a percentage of the previous report. 0 disables the function.
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```10```.
@ -890,8 +925,8 @@ This parameter has the configuration ID ```config_50_1``` and is of type ```INTE
### Parameter 52: Periodic active power and energy reports
Time period between consecutive reports.
Parameter 52 defines a time period between consecutive reports. Timer is reset and counted from zero after each report (1 sec - 32767 sec). 0 disables the function.
Values in the range 0 to 32767 may be set.
The manufacturer defined default value is ```3600```.
@ -901,8 +936,8 @@ This parameter has the configuration ID ```config_52_2``` and is of type ```INTE
### Parameter 53: Energy reports
Energy level change resulting in sending a new energy report.
Energy level change which will result in sending a new energy report. Available settings: 1-255 (0,01 - 2,55 kWh). 0 disables the function.
Values in the range 1 to 255 may be set.
The manufacturer defined default value is ```10```.
@ -912,8 +947,8 @@ This parameter has the configuration ID ```config_53_2``` and is of type ```INTE
### Parameter 54: Self-measurement
Active power and energy used by itself
The Dimmer may include active power and energy used by itself in reports sent to the main controller.
The following option values may be configured -:
| Value | Description |
@ -928,8 +963,8 @@ This parameter has the configuration ID ```config_54_1``` and is of type ```INTE
### Parameter 58: Method of calculating the active power
How to calculate active power.
This parameter defines how to calculate active power. It is useful in a case of 2-wire connection with light sources other than resistive. Note: Parameter 58 is set to 0 after forced auto-calibration
The following option values may be configured -:
| Value | Description |
@ -945,8 +980,8 @@ This parameter has the configuration ID ```config_58_1``` and is of type ```INTE
### Parameter 59: Approximated power at the maximum brightness level
Power reported by the device at its maximum brightness level
This parameter determines the approximate value of the power that will be reported by the device at its maximum brightness level. Available settings: 0-500 (0-500W). Note: Parameter 59 works only when parameter 58 has a value other than 0.
Values in the range 0 to 500 may be set.
The manufacturer defined default value is ```0```.
@ -979,22 +1014,22 @@ The FGD212 supports 5 association groups.
This group supports 1 nodes.
### Group 2: Sends BASIC SET command class frame according to the state of the devi
### Group 2: Send BASIC SET command class frame S1
This group supports 10 nodes.
### Group 3: Sends BASIC SET command class frame according to the state of the devi
### Group 3: Sends MULTILEVEL SWITCH command class frame S1
This group supports 10 nodes.
### Group 4: Sends BASIC SET command class frame according to the state of the devi
### Group 4: Sends BASIC SET command class S2
This group supports 10 nodes.
### Group 5: Sends BASIC SET command class frame according to the state of the devi
### Group 5: Sends MULTILEVEL SWITCH command class frame S2
This group supports 10 nodes.

191
_addons_bindings/zwave/doc/inovelli/nzw31_0_0.md Normal file
View File

@ -0,0 +1,191 @@
---
layout: documentation
title: NZW31 - ZWave
---
{% include base.html %}
# NZW31 In-wall Dimming Switch
This describes the Z-Wave device *NZW31*, manufactured by *Inovelli* with the thing type UID of ```inovelli_nzw31_00_000```.
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![NZW31 product image](https://www.cd-jackson.com/zwave_device_uploads/856/856_default.jpg)
The NZW31 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.
## Overview
Inovelli's In-Wall Smart Dimmer not only has the ability to control lights from anywhere in the world, but it acts as a Z-Wave signal repeater, which amplifies your Z-Wave signal, growing the capabilities of your network.
In addition, it has scene control enabled, which allows you to double tap the switch to activate a Z-Wave scene. An example would be a bedtime scene, which turns off all lights, locks the door(s) and sets the temperature to 68 degrees.
Simplifying lives, one smart home product at a time... that's Inovelli.
### Inclusion Information
**Including Steps:**
- This will vary based on the HUB/Gateway you’re using, but you need to go one (1) step before putting your HUB/Gateway in inclusion process — once you are one (1) step away from physically starting the inclusion/pairing process — **THEN STOP!**
- Walk down to your circuit breaker and flip on the power (you will now have 30 seconds to physically start the inclusion process on your HUB/Gateway)
- While next to the breaker, start the inclusion process and your HUB/Gateway will automatically start looking for devices
- Wait for auto-inclusion to do its thing. Your switch will automatically include/pair to your HUB/Gateway
- If successful, your device will flash twice (**NOTE:** Auto-Inclusion will time out after 30 seconds)
- If the switch does not flash within 30 seconds, please use the alternate method of pairing which is pressing the top (UP) button 6x within 2 seconds
- Confirm that your HUB/Gateway shows the switch
Congratulations, you now have a remote controlled switch!
**If you are having issues pairing your device, please ensure your switch is within range of your HUB. 95% of the pairing/including failures stem from this issue. Best practice is to start with Z-Wave products near your HUB and build your network out. The more Z-Wave devices, the more efficient your network.**
### Exclusion Information
- Press the Top (UP) Button on your NZW31 six (6) times within 2 seconds
## Channels
The following table summarises the channels available for the NZW31 -:
| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Dimmer | switch_dimmer | DimmableLight | Dimmer |
| Scene Number | scene_number | | Number |
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel supports the ```Number``` item.
## Device Configuration
The following table provides a summary of the 4 configuration parameters available in the NZW31.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Dimmer Step Configuration | Dimmer Speed Setting (On/Off) |
| 2 | Dimmer Minimum Configuration | Lowest dim setting before turning off |
| 4 | Switch Orientation | Invert On/Off from Top/Bottom |
| 5 | Countdown Timer | Shutoff Timer |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 1: Dimmer Step Configuration
Dimmer Speed Setting (On/Off)
Control the speed with which the dimmer turns on and off.
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Dimmer Minimum Configuration
Lowest dim setting before turning off
Lowest dim setting before turning off
Values in the range 1 to 99 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 4: Switch Orientation
Invert On/Off from Top/Bottom
Invert the switch on/off position.
00 - Up = On, Down = Off
01 - Up = Off, Down = On
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Countdown Timer
Shutoff Timer
Countdown timer.
0x00 - x8000 - 0-32768 Seconds
Values in the range 0 to 32768 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```.
### Switch All Mode
Set the mode for the switch when receiving SWITCH ALL commands.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Exclude from All On and All Off groups |
| 1 | Include in All On group |
| 2 | Include in All Off group |
| 255 | Include in All On and All Off groups |
This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The NZW31 supports 1 association group.
### Group 1: Lifeline
This group supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_APPLICATION_STATUS_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| Linked to BASIC|
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_PROTECTION_V2| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
### Documentation Links
* [NZW31 Manual](https://www.cd-jackson.com/zwave_device_uploads/856/NZW31.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/856).

2
_addons_bindings/zwave/doc/oomi/ft098_0_0.md
View File

@ -5,7 +5,7 @@ title: FT098 - ZWave
{% include base.html %}
# FT098 9W Light bulb supporting 16M colours
# FT098 9W Color Light Bulb
This describes the Z-Wave device *FT098*, manufactured by *[Fantem](http://www.oomi.com/)* with the thing type UID of ```oomi_ft098_00_000```.
The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc..

317
_addons_bindings/zwave/doc/philio/pan061b_1_8.md Normal file
View File

@ -0,0 +1,317 @@
---
layout: documentation
title: PAN06-1B - ZWave
---
{% include base.html %}
# PAN06-1B In Wall Dual Relay(1 Way) Switch Module 2 x 1.5kW
This describes the Z-Wave device *PAN06-1B*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_pan061b_01_008```.
This version of the device is limited to firmware versions above 1.8
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![PAN06-1B product image](https://www.cd-jackson.com/zwave_device_uploads/858/858_default.png)
The PAN06-1B supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.
## Overview
The PAN06 allows controlling two independent loads both wirelessly via Z-Wave and locally utilizing a traditional wall switch. Thanks to its calibration technology the device cannot only be used to switch resistive devices but also works perfectly with many kind of reactive or resistive loads such as fluorescent lights or LEDs.
The device is placed in a wall box right behind the normal switch. The switch is not longer directly
connected to the load but acts as input device for the insert that is controlling the load. This device is
designed for a 3 wire system and needs a neutral wire in the wall box.
### Inclusion Information
1\. Have Z-Wave Controller entered inclusion mode.
2\. Pressing Include button of PAN06 three times within 2 seconds will enter inclusion mode
### Exclusion Information
1\. Have Z-Wave Controller entered exclusion mode.
2\. Pressing Include button of PAN06 three times within 2 seconds will enter exclusion mode
## Channels
The following table summarises the channels available for the PAN06-1B -:
| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Switch | switch_binary | Switch | Switch |
| Scene Number | scene_number | | Number |
| Alarm | alarm_general | Door | Switch |
| Battery Level | battery-level | Battery | Number |
| Switch 1 | switch_binary1 | Switch | Switch |
| Switch 2 | switch_binary2 | Switch | Switch |
| Switch 3 | switch_binary3 | Switch | Switch |
### Switch
Switch the power on and off.
The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel supports the ```Number``` item.
### Alarm
Indicates if an alarm is triggered.
The ```alarm_general``` channel 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 |
### 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category.
### Switch 1
Switch the power on and off.
The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 2
Switch the power on and off.
The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 3
Switch the power on and off.
The ```switch_binary3``` channel supports the ```Switch``` item and is in the ```Switch``` category.
## Device Configuration
The following table provides a summary of the 6 configuration parameters available in the PAN06-1B.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Selected endpoint | Send Basic Command Class |
| 2 | Switch mode | Change the external switch mode |
| 3 | Restore Switch State Mode | Switch state after repowering |
| 4 | Auto OFF Timer | |
| 5 | RF OFF command | RF OFF command mode |
| 6 | Existence of endpoint 3 | |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 1: Selected endpoint
Send Basic Command Class
If Controller not using Multi\_Channel command class to access the endpoint of PAN06, you may configure the endpoint value to react the Basic Command Class
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 1 | Relay 1 |
| 2 | Relay 2 |
| 3 | Relay 1+2 |
The manufacturer defined default value is ```3``` (Relay 1+2).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Switch mode
Change the external switch mode
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 1 | Edge mode |
| 2 | Pulse mode |
| 3 | Edge-Toggle mode |
The manufacturer defined default value is ```1``` (Edge mode).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Restore Switch State Mode
Switch state after repowering
0 : Switch off
1 : Last switch state
2 : Switch on
Whenever the AC power return from lost, PAN06 will restore the switch state which
could be SWITCH OFF、 LAST SWITCH STATE、 SWITCH ON. The default setting is
LAST SWITCH STATE
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Switch OFF |
| 1 | Last Switch state |
| 2 | Switch ON |
The manufacturer defined default value is ```1``` (Last Switch state).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Auto OFF Timer
Values in the range 0 to 32767 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_4_2``` and is of type ```INTEGER```.
### Parameter 5: RF OFF command
RF OFF command mode
Whenever a switch off command, BASIC\_SET 、BINARY\_SWITCH\_SET 、
SWITCH\_ALL\_OFF, is received, it could be interpreted as 4 variety of commands.
3-5-1 Switch Off：It switches to OFF state. The default setting is Switch Off.
3-5-2 Ignore：The switch off command will be ignored.
3-5-3 Switch Toggle：It switches to the inverse of current state.
3-5-4 Switch On：It switches to ON state.
0 : Switch off
1 : Ignore
2 : Switch toggle
3 : Switch on
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Switch OFF |
| 1 | Ignore |
| 2 | Switch toggle |
| 3 | Switch on |
The manufacturer defined default value is ```0``` (Switch OFF).
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Existence of endpoint 3
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 1 | Endpoint 3 exists |
| 2 | No endpoint 3 |
The manufacturer defined default value is ```1``` (Endpoint 3 exists).
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Switch All Mode
Set the mode for the switch when receiving SWITCH ALL commands.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Exclude from All On and All Off groups |
| 1 | Include in All On group |
| 2 | Include in All Off group |
| 255 | Include in All On and All Off groups |
This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The PAN06-1B supports 3 association groups.
### Group 1: Relay 1 + 2
This group supports 1 nodes.
### Group 2: Relay 1
This group supports 1 nodes.
### Group 3: Relay 2
This group supports 1 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_SCENE_ACTIVATION_V1| |
| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V0| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_PROTECTION_V2| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V0| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC|
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC|
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC|
### Documentation Links
* [PAN06-1B Manual](https://www.cd-jackson.com/zwave_device_uploads/858/C50101008V01-PAN06-1-2-3B-manual-20150831.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/858).

22
_addons_bindings/zwave/doc/philio/pan06_0_0.md
View File

@ -5,8 +5,9 @@ title: PAN06 - ZWave
{% include base.html %}
# PAN06 In Wall Dual Relay(1 Way) Switch Module 2x 1.5kW
# PAN06 In Wall Dual Relay (1 Way) Switch Module 2 x 1.5kW
This describes the Z-Wave device *PAN06*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_pan06_00_000```.
This version of the device is limited to firmware versions below 1.7
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
@ -17,7 +18,20 @@ The PAN06 supports routing. This allows the device to communicate using other ro
## Overview
No device information is provided in the database. Consider [updating the database](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/173) to improve the documentation.
The PAN06 allows controlling two independent loads both wirelessly via Z-Wave and locally utilizing a traditional wall switch. Thanks to its calibration technology the device cannot only be used to switch resistive devices but also works perfectly with many kind of reactive or resistive loads such as fluorescent lights or LEDs.
The device is placed in a wall box right behind the normal switch. The switch is not longer directly
connected to the load but acts as input device for the insert that is controlling the load. This device is
designed for a 3 wire system and needs a neutral wire in the wall box.
### Inclusion Information
1\. Have Z-Wave Controller entered inclusion mode
2\. Pressing Include button of PAN06 three times within 1.5 seconds will enter inclusion mode.
### Exclusion Information
1\. Have Z-Wave Controller entered exclusion mode
2\. Pressing Include button of PAN06 three times within 1.5 seconds will enter exclusion mode.
## Channels
@ -77,13 +91,13 @@ Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Selected endpoint | |
| 1 | Selected endpoint | Send Basic Command Class |
| 2 | Switch mode | Change the external switch mode |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 1: Selected endpoint
Send Basic Command Class
If Controller not using Multi\_Channel command class to access the endpoint of PAN06, you may configure the endpoint value to react the Basic Command Class
The following option values may be configured -:

317
_addons_bindings/zwave/doc/philio/pan06_1_8.md Normal file
View File

@ -0,0 +1,317 @@
---
layout: documentation
title: PAN06 - ZWave
---
{% include base.html %}
# PAN06 In Wall Dual Relay (1 Way) Switch Module 2 x 1.5kW
This describes the Z-Wave device *PAN06*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_pan06_01_008```.
This version of the device is limited to firmware versions above 1.8
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![PAN06 product image](https://www.cd-jackson.com/zwave_device_uploads/858/858_default.png)
The PAN06 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.
## Overview
The PAN06 allows controlling two independent loads both wirelessly via Z-Wave and locally utilizing a traditional wall switch. Thanks to its calibration technology the device cannot only be used to switch resistive devices but also works perfectly with many kind of reactive or resistive loads such as fluorescent lights or LEDs.
The device is placed in a wall box right behind the normal switch. The switch is not longer directly
connected to the load but acts as input device for the insert that is controlling the load. This device is
designed for a 3 wire system and needs a neutral wire in the wall box.
### Inclusion Information
1\. Have Z-Wave Controller entered inclusion mode.
2\. Pressing Include button of PAN06 three times within 2 seconds will enter inclusion mode
### Exclusion Information
1\. Have Z-Wave Controller entered exclusion mode.
2\. Pressing Include button of PAN06 three times within 2 seconds will enter exclusion mode
## Channels
The following table summarises the channels available for the PAN06 -:
| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Switch | switch_binary | Switch | Switch |
| Scene Number | scene_number | | Number |
| Alarm | alarm_general | Door | Switch |
| Battery Level | battery-level | Battery | Number |
| Switch 1 | switch_binary1 | Switch | Switch |
| Switch 2 | switch_binary2 | Switch | Switch |
| Switch 3 | switch_binary3 | Switch | Switch |
### Switch
Switch the power on and off.
The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel supports the ```Number``` item.
### Alarm
Indicates if an alarm is triggered.
The ```alarm_general``` channel 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 |
### 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category.
### Switch 1
Switch the power on and off.
The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 2
Switch the power on and off.
The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 3
Switch the power on and off.
The ```switch_binary3``` channel supports the ```Switch``` item and is in the ```Switch``` category.
## Device Configuration
The following table provides a summary of the 6 configuration parameters available in the PAN06.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Selected endpoint | Send Basic Command Class |
| 2 | Switch mode | Change the external switch mode |
| 3 | Restore Switch State Mode | Switch state after repowering |
| 4 | Auto OFF Timer | |
| 5 | RF OFF command | RF OFF command mode |
| 6 | Existence of endpoint 3 | |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 1: Selected endpoint
Send Basic Command Class
If Controller not using Multi\_Channel command class to access the endpoint of PAN06, you may configure the endpoint value to react the Basic Command Class
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 1 | Relay 1 |
| 2 | Relay 2 |
| 3 | Relay 1+2 |
The manufacturer defined default value is ```3``` (Relay 1+2).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Switch mode
Change the external switch mode
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 1 | Edge mode |
| 2 | Pulse mode |
| 3 | Edge-Toggle mode |
The manufacturer defined default value is ```1``` (Edge mode).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Restore Switch State Mode
Switch state after repowering
0 : Switch off
1 : Last switch state
2 : Switch on
Whenever the AC power return from lost, PAN06 will restore the switch state which
could be SWITCH OFF、 LAST SWITCH STATE、 SWITCH ON. The default setting is
LAST SWITCH STATE
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Switch OFF |
| 1 | Last Switch state |
| 2 | Switch ON |
The manufacturer defined default value is ```1``` (Last Switch state).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Auto OFF Timer
Values in the range 0 to 32767 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_4_2``` and is of type ```INTEGER```.
### Parameter 5: RF OFF command
RF OFF command mode
Whenever a switch off command, BASIC\_SET 、BINARY\_SWITCH\_SET 、
SWITCH\_ALL\_OFF, is received, it could be interpreted as 4 variety of commands.
3-5-1 Switch Off：It switches to OFF state. The default setting is Switch Off.
3-5-2 Ignore：The switch off command will be ignored.
3-5-3 Switch Toggle：It switches to the inverse of current state.
3-5-4 Switch On：It switches to ON state.
0 : Switch off
1 : Ignore
2 : Switch toggle
3 : Switch on
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Switch OFF |
| 1 | Ignore |
| 2 | Switch toggle |
| 3 | Switch on |
The manufacturer defined default value is ```0``` (Switch OFF).
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Existence of endpoint 3
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 1 | Endpoint 3 exists |
| 2 | No endpoint 3 |
The manufacturer defined default value is ```1``` (Endpoint 3 exists).
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Switch All Mode
Set the mode for the switch when receiving SWITCH ALL commands.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Exclude from All On and All Off groups |
| 1 | Include in All On group |
| 2 | Include in All Off group |
| 255 | Include in All On and All Off groups |
This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The PAN06 supports 3 association groups.
### Group 1: Relay 1 + 2
This group supports 1 nodes.
### Group 2: Relay 1
This group supports 1 nodes.
### Group 3: Relay 2
This group supports 1 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_SCENE_ACTIVATION_V1| |
| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V0| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_PROTECTION_V2| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V0| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC|
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC|
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC|
### Documentation Links
* [PAN06-1B Manual](https://www.cd-jackson.com/zwave_device_uploads/858/C50101008V01-PAN06-1-2-3B-manual-20150831.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/858).

238
_addons_bindings/zwave/doc/shenzhen/nasab01z_0_0.md Normal file
View File

@ -0,0 +1,238 @@
---
layout: documentation
title: NAS-AB01Z - ZWave
---
{% include base.html %}
# NAS-AB01Z Siren Alarm
This describes the Z-Wave device *NAS-AB01Z*, manufactured by *[Shenzhen Neo Electronics Co., Ltd](http://www.szneo.com/)* with the thing type UID of ```shenzhen_nasab01z_00_000```.
The device is in the category of *Siren*, defining Siren used by Alarm systems.
![NAS-AB01Z product image](https://www.cd-jackson.com/zwave_device_uploads/522/522_default.jpg)
The NAS-AB01Z 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
Siren Alarm with ten different sounds.
### Inclusion Information
The siren alarm can be included to the Z-wave network by pressing on the code button.
1. Disassemble the siren alarm and insert the battery into the siren alarm. Make sure the device is located within the direct range of the controller.
2. Set the controller into the learning mode (see main controller’s operating manual).
3. Quickly, triple click the code button, LED light will flash red.
4. Siren alarm will be detected and included in the Z-Wave network.
5. Wait for the main controller to configure the siren alarm.
### Exclusion Information
1. Make sure the sensor is connected to power source.
2. Set the main controller into the learning mode (see main controller’s operating manual).
3. Quickly, triple click the code button, LED light will flash red for 5 times.
4. Wait for the main controller to delete the sensor.
### Wakeup Information
Press code button once, LED will blink one time.
## Channels
The following table summarises the channels available for the NAS-AB01Z -:
| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Switch | switch_binary | Switch | Switch |
| Siren ON Mode | config_decimal | | Decimal |
| Alarm | alarm_general | Door | Switch |
| Battery Level | battery-level | Battery | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Siren ON Mode
Configure default siren ON mode:
1 = Alarm Music Mode
2 = Door Bell Music
Generic class for configuration parameter.
The ```config_decimal``` channel supports the ```Decimal``` item.
### Alarm
Indicates if an alarm is triggered.
The ```alarm_general``` channel 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 |
### 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category.
## Device Configuration
The following table provides a summary of the 7 configuration parameters available in the NAS-AB01Z.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Configure Alarm music volume | Configure Alarm music volume |
| 2 | Alarm music duration time | Alarm music duration time |
| 3 | Door bell music duration time | Door bell music duration time |
| 4 | Door bell music volume | Door bell music volume |
| 5 | Alarm music index | Alarm music index |
| 6 | Door bell music index | Door bell music index |
| 7 | Default Siren on mode | Default Siren on mode |
### Parameter 1: Configure Alarm music volume
Configure Alarm music volume
Values in the range 1 to 3 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Alarm music duration time
Alarm music duration time
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Door bell music duration time
Door bell music duration time
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Door bell music volume
Door bell music volume
Values in the range 1 to 3 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Alarm music index
Alarm music index
Values in the range 1 to 10 may be set.
The manufacturer defined default value is ```9```.
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Door bell music index
Door bell music index
Values in the range 1 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: Default Siren on mode
Default Siren on mode
This parameter defines the default music index, volume and duration time for siren on.
This parameter can be selected between ALARM MUSIC and DOOR BELL music.
The settings for ALARM MUSIC defines by Param #1, #2, #5.
The settings for DOOR BELL defines by Param #3, #4, #6.
Values in the range 1 to 2 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The NAS-AB01Z supports 3 association groups.
### Group 1: Group 1
This group supports 5 nodes.
### Group 2: Group 2
This group supports 5 nodes.
### Group 3: Group2
This group supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_ASSOCIATION_V1| |
| COMMAND_CLASS_VERSION_V1| |
### Documentation Links
* [NASAB01Z Manual (1)](https://www.cd-jackson.com/zwave_device_uploads/522/15-NAS-AB01Z-UserMan-pdf-3069596.pdf)
* [NASAB01Z Manual (2)](https://www.cd-jackson.com/zwave_device_uploads/522/NAS-AB01Z.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/522).

697
_addons_bindings/zwave/doc/thermofloor/ztrm2_2_6.md Normal file
View File

@ -0,0 +1,697 @@
---
layout: documentation
title: Heatit Z-TRM 2 - ZWave
---
{% include base.html %}
# Heatit Z-TRM 2 Floor thermostat (supports secure inclusion and power measurement)
This describes the Z-Wave device *Heatit Z-TRM 2*, manufactured by *ThermoFloor* with the thing type UID of ```thermofloor_ztrm2_02_006```.
This version of the device is limited to firmware versions above 2.6
The device is in the category of *HVAC*, defining Air condition devices, Fans.
![Heatit Z-TRM 2 product image](https://www.cd-jackson.com/zwave_device_uploads/854/854_default.jpg)
The Heatit Z-TRM 2 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.
## Overview
### FEATURES
- Floor sensor
- Built-in room sensor
- External room sensor
- Temperature limiter
- Weekly program/setback via gateway or pilot wire
- Multilevel sensor command class
- Firmware updates (OTA)
- Power metering
- LED-diode
- Can be used in connection with different NTC-sensors
- Lock mode/child lock
- Calibration
- 8 associations
- Supports encryption mode: S0, S2 Authenticated Class, S2 Unauthenticated Class
### Inclusion Information
To include the thermostat to your home automation gateway, press Center (confirm) for 10 seconds.
The display will show OFF. Press Right (down) 4 times till you see Con in the display.
Now start add device in your home automation software.
Start inclusion mode by pressing Center (confirm) for approximately 2 seconds.
Adding mode is indicated in the display by some 'circling' LED segments in the display until the timeout occurs after 20 seconds or the module has been added in the network.
Confirmation will show Inc in the display. If inclusion fails, Err (error) will appear.
Leave programming mode by choosing ESC in the menu.
Your thermostat is ready for use with default settings.
### Exclusion Information
To exclude the thermostat to your home automation gateway, press Center (confirm) for 10 seconds.
The display will show OFF. Press Right (down) 4 times till you see Con in the display.
Now start excluding device in your home automation software.
Start exclusion mode by pressing Center (confirm) for approximately 2 seconds.
Adding mode is indicated in the display by some 'circling' LED segments in the display until the timeout occurs after 20 seconds or the module has been excluded from the network.
Confirmation will show Ecl in the display. If exclusion fails, Err (error) will appear.
Leave programming mode by choosing ESC in the menu.
## Channels
The following table summarises the channels available for the Heatit Z-TRM 2 -:
| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Switch | switch_binary | Switch | Switch |
| Electric meter (volts) | meter_voltage | Energy | Number |
| Electric meter (watts) | meter_watts | Energy | Number |
| Electric meter (kWh) | meter_kwh | Energy | Number |
| Thermostat mode | thermostat_mode | Temperature | Number |
| Setpoint (furnace) | thermostat_setpoint | Temperature | Number |
| Setpoint (heating) | thermostat_setpoint | Temperature | Number |
| Setpoint (cooling) | thermostat_setpoint | Temperature | Number |
| Switch 1 | switch_binary1 | Switch | Switch |
| Electric meter (volts) 1 | meter_voltage1 | Energy | Number |
| Electric meter (watts) 1 | meter_watts1 | Energy | Number |
| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number |
| Sensor (temperature) 2 | sensor_temperature2 | Temperature | Number |
| Sensor (temperature) 3 | sensor_temperature3 | Temperature | Number |
| Sensor (temperature) 4 | sensor_temperature4 | Temperature | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Electric meter (volts)
Indicates the instantaneous voltage.
The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (watts)
Indicates the instantaneous power consumption.
The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (kWh)
Indicates the energy consumption (kWh).
The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Thermostat mode
Sets the thermostat.
The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category.
The following state translation is provided for this channel to the ```Number``` item type -:
| Value | Label |
|-------|-----------|
| 0 | Off |
| 1 | Heat |
| 2 | Cool |
| 3 | Auto |
| 4 | Aux Heat |
| 5 | Resume |
| 6 | Fan Only |
| 7 | Furnace |
| 8 | Dry Air |
| 9 | Moist Air |
| 10 | Auto Changeover |
| 11 | Heat Economy |
| 12 | Cool Economy |
| 13 | Away |
| 15 | Full Power |
| 31 | Manufacturer Specific |
### Setpoint (furnace)
Sets the thermostate setpoint.
The ```thermostat_setpoint``` channel supports the ```Number``` item and is in the ```Temperature``` category.
### Setpoint (heating)
Sets the thermostate setpoint.
The ```thermostat_setpoint``` channel supports the ```Number``` item and is in the ```Temperature``` category.
### Setpoint (cooling)
Sets the thermostate setpoint.
The ```thermostat_setpoint``` channel supports the ```Number``` item and is in the ```Temperature``` category.
### Switch 1
Switch the power on and off.
The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category.
### Electric meter (volts) 1
Indicates the instantaneous voltage.
The ```meter_voltage1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (watts) 1
Indicates the instantaneous power consumption.
The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (kWh) 1
Indicates the energy consumption (kWh).
The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Sensor (temperature) 2
Indicates the current temperature.
The ```sensor_temperature2``` channel supports the ```Number``` item and is in the ```Temperature``` category. This is a read only channel so will only be updated following state changes from the device.
### Sensor (temperature) 3
Indicates the current temperature.
The ```sensor_temperature3``` channel supports the ```Number``` item and is in the ```Temperature``` category. This is a read only channel so will only be updated following state changes from the device.
### Sensor (temperature) 4
Indicates the current temperature.
The ```sensor_temperature4``` channel supports the ```Number``` item and is in the ```Temperature``` category. This is a read only channel so will only be updated following state changes from the device.
## Device Configuration
The following table provides a summary of the 25 configuration parameters available in the Heatit Z-TRM 2.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Operation mode | Operation mode |
| 2 | Sensor mode | Sensor mode |
| 3 | Floor sensor type | Floor sensor type |
| 4 | Temperature control hysteresis (DIFF I) | Temperature control hysteresis (DIFF I) |
| 5 | Floor minimum temperature limit (FLo) | Floor minimum temperature limit (FLo) |
| 6 | Floor maximum temperature (FHi) | Floor maximum temperature (FHi) |
| 7 | Air minimum temperature limit (ALo) | Air minimum temperature limit (ALo) |
| 8 | Air maximum temperature limet (AHi) | Air maximum temperature limet (AHi) |
| 9 | FP mode P setting (PLo) | FP mode P setting (PLo) |
| 10 | Heating mode setpoint (CO) | Heating mode setpoint (CO) |
| 11 | Energy saving mode setpoint (ECO) | Energy saving mode setpoint (ECO) |
| 12 | P setting | P setting |
| 13 | Cooling setpoint (COOL) | Cooling setpoint (COOL) |
| 14 | Room sensor calibration | Room sensor calibration |
| 15 | Floor sensor calibration | Floor sensor calibration |
| 16 | External sensor calibration | External sensor calibration |
| 17 | Temperature display | Temperature display |
| 18 | Button brightness - dimmed state | Button brightness - dimmed state |
| 19 | Button brightness - active state | Button brightness - active state |
| 20 | Display brightness - dimmed state | Display brightness - dimmed state |
| 21 | Display brightness - active state | Display brightness - active state |
| 22 | Temperature report interval | Temperature report interval |
| 23 | Temperature report hysteresis | Temperature report hysteresis |
| 24 | Meter report interval | Meter report interval |
| 25 | Meter report delta value | Meter report delta value |
### Parameter 1: Operation mode
Operation mode
1\. Value = 0, Off (default)
2\. Value = 1, Heating mode
3\. Value = 2, Cooling mode (not implemented)
4\. Value = 11, Energy saving mode
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Off. (default) |
| 1 | Heating mode |
| 2 | Cooling mode (not implemented) |
| 11 | Energy saving heating mode |
The manufacturer defined default value is ```0``` (Off. (default)).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Sensor mode
Sensor mode
1\. Value = 0, F-mode, floor sensor mode
2\. Value = 1, A-mode, internal room sensor mode (default)
3\. Value = 2, AF-mode, internal sensor and floor sensor mode
4\. Value = 3, A2-mode, external room sensor mode
5\. Value = 4, P-mode, power regulator mode
6\. Value = 5, FP-mode, floor sensor and power regulator mode
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | F-mode, floor sensor mode |
| 1 | A-mode, internal room sensor mode (default) |
| 2 | AF-mode, internal sensor and floor sensor mode |
| 3 | A2-mode, external room sensor mode |
| 4 | P-mode, power regulator mode |
| 5 | FP-mode, floor sensor and power regulator mode |
The manufacturer defined default value is ```1``` (A-mode, internal room sensor mode (default)).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Floor sensor type
Floor sensor type
1\. Value = 0, 10K-NTC (default)
2\. Value = 1, 12K-NTC
3\. Value = 2, 15K-NTC
4\. Value = 3, 22K-NTC
5\. Value = 4, 33K-NTC
6\. Value = 5, 47K-NTC
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | 10K-NTC (default) |
| 1 | 12K-NTC |
| 2 | 15K-NTC |
| 3 | 22K-NTC |
| 4 | 33K-NTC |
| 5 | 47K-NTC |
The manufacturer defined default value is ```0``` (10K-NTC (default)).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Temperature control hysteresis (DIFF I)
Temperature control hysteresis (DIFF I)
1\. Value = 0 - 30, 0.3C - 3.0C (default is 0.5C)
2\. Value = 1, Mode 1: level-controlled input
3\. Value = 2, Mode 2: falling-edge controlled input
4\. Value = 3, Mode 3: raising-edge controlled input (standard)
When using a water-based heating, the recommended hysteresis is a minimum of 1.0C
The following option values may be configured, in addition to values in the range 0 to 30 -:
| Value | Description |
|--------|-------------|
| 1 | Mode 1: level-controlled input |
| 2 | Mode 2: falling-edge controlled input |
| 3 | Mode 3: raising-edge controlled input (standard) |
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Floor minimum temperature limit (FLo)
Floor minimum temperature limit (FLo)
1\. Value = 50 - 400, 5.0C - 40.0C, default = 5.0C
Values in the range 50 to 400 may be set.
The manufacturer defined default value is ```50```.
This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```.
### Parameter 6: Floor maximum temperature (FHi)
Floor maximum temperature (FHi)
1\. Value = 50 - 400, 5.0C - 40.0C, default = 40.0C)
Values in the range 50 to 400 may be set.
The manufacturer defined default value is ```400```.
This parameter has the configuration ID ```config_6_2``` and is of type ```INTEGER```.
### Parameter 7: Air minimum temperature limit (ALo)
Air minimum temperature limit (ALo)
1\. Value = 50 - 400, 5.0C - 40.0C, default = 5.0C
Values in the range 50 to 400 may be set.
The manufacturer defined default value is ```50```.
This parameter has the configuration ID ```config_7_2``` and is of type ```INTEGER```.
### Parameter 8: Air maximum temperature limet (AHi)
Air maximum temperature limet (AHi)
1\. Value = 50 - 400, 5.0C - 40.0C, default = 40.0C)
Values in the range 50 to 400 may be set.
The manufacturer defined default value is ```400```.
This parameter has the configuration ID ```config_8_2``` and is of type ```INTEGER```.
### Parameter 9: FP mode P setting (PLo)
FP mode P setting (PLo)
1\. Value = 0 - 9, default = 0
Values in the range 0 to 9 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```.
### Parameter 10: Heating mode setpoint (CO)
Heating mode setpoint (CO)
1\. Value = 50 - 400, 5.0C - 40.0C, default = 21.0C
Values in the range 50 to 400 may be set.
The manufacturer defined default value is ```210```.
This parameter has the configuration ID ```config_10_2``` and is of type ```INTEGER```.
### Parameter 11: Energy saving mode setpoint (ECO)
Energy saving mode setpoint (ECO)
1\. Value = 50 - 400, 5.0C - 40.0C, default = 18.0C
Values in the range 50 to 400 may be set.
The manufacturer defined default value is ```180```.
This parameter has the configuration ID ```config_11_2``` and is of type ```INTEGER```.
### Parameter 12: P setting
P setting
1\. Value = 0 - 10, default = 2
Values in the range 0 to 10 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```.
### Parameter 13: Cooling setpoint (COOL)
Cooling setpoint (COOL)
1\. Value = 50 - 400, 5.0C - 40.0C, default = 21.0C
Values in the range 50 to 400 may be set.
The manufacturer defined default value is ```210```.
This parameter has the configuration ID ```config_13_2``` and is of type ```INTEGER```.
### Parameter 14: Room sensor calibration
Room sensor calibration
1\. Value = -40 - 40, -4.0V - 4.0C, default = 0.0C
Values in the range -40 to 40 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```.
### Parameter 15: Floor sensor calibration
Floor sensor calibration
1\. Value = -40 - 40, -4.0C - 4.0C, default = 0.0C
Values in the range -40 to 40 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```.
### Parameter 16: External sensor calibration
External sensor calibration
1\. Value = -40 - 40, -4.0C - 4.0C, default = 0.0C
Values in the range -40 to 40 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 17: Temperature display
Temperature display
1\. Value = 0, Display setpoint temperature (default)
2\. Value = 1, Display calculated temperature
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Display setpoint temperature (default) |
| 1 | Display calculated temperature |
The manufacturer defined default value is ```0``` (Display setpoint temperature (default)).
This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```.
### Parameter 18: Button brightness - dimmed state
Button brightness - dimmed state
1\. Value = 0 - 100, 0% - 100%, default = 50%
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```50```.
This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```.
### Parameter 19: Button brightness - active state
Button brightness - active state
1\. Value = 0 - 100, 0% - 100%, default = 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_19_1``` and is of type ```INTEGER```.
### Parameter 20: Display brightness - dimmed state
Display brightness - dimmed state
1\. Value = 0 - 100, 0% - 100%, default = 50%
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```50```.
This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```.
### Parameter 21: Display brightness - active state
Display brightness - active state
1\. Value = 0 - 100, 0% - 100%, default = 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_21_1``` and is of type ```INTEGER```.
### Parameter 22: Temperature report interval
Temperature report interval
1\. Value = 0, Reporting of temperature disabled
2\. Value = 1 - 32767, 1s - 32767s, default = 60s
Time interval between consecutive temperature reports.
Temperature reports can also be sent as a result of polling.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Reporting of temperature disabled |
The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_22_2``` and is of type ```INTEGER```.
### Parameter 23: Temperature report hysteresis
Temperature report hysteresis
1\. Value = 1 - 100, 0.1C - 10.0C, default = 1.0C
The temperature report will be sent if there is a difference in temperature from the previous value reported,
defined in this parameter (hysteresis).
Temperature reports can also be sent as a result of polling.
Values in the range 1 to 100 may be set.
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_23_1``` and is of type ```INTEGER```.
### Parameter 24: Meter report interval
Meter report interval
1\. Value = 0, Reporting of metering values is disabled
2\. Value = 1 - 32767, 1s - 32767s, default = 60s
Time interval between consecutive meter reports.
Meter reports can also be sent as a result of polling.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Reporting of metering values is disabled |
The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_24_2``` and is of type ```INTEGER```.
### Parameter 25: Meter report delta value
Meter report delta value
1\. Value = 0 - 255, 0kWh - 25.5kWh, default = 1.0kWh
Delta value in kWh between consecutive meter reports.
Meter reports can also be sent as a result of polling.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_25_1``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The Heatit Z-TRM 2 supports 5 association groups.
### Group 1: Thermostat device 0
Main thermostat device
This group supports 7 nodes.
### Group 2: Thermostat device 0
The main thermostat device
This group supports 7 nodes.
### Group 3: Thermostat device 0
The main thermostat device
This group supports 7 nodes.
### Group 4: Thermostat device 0
The main thermostat device
This group supports 7 nodes.
### Group 5: Thermostat device 0
The main thermostat device
This group supports 7 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_METER_V3| |
| COMMAND_CLASS_THERMOSTAT_MODE_V1| |
| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_METER_V3| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V0| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V0| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
#### Endpoint 4
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V0| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V0| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
### Documentation Links
* [Product Sheet](https://www.cd-jackson.com/zwave_device_uploads/854/Heatit-ztrm2.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/854).

5
_addons_bindings/zwave/doc/vision/zd2105_0_0.md
View File

@ -8,6 +8,11 @@ title: ZD2105 - ZWave
# ZD2105 Recessed Door Window Sensor
This describes the Z-Wave device *ZD2105*, manufactured by *[Vision Security](http://www.visionsecurity.com.tw/)* with the thing type UID of ```vision_zd2105_00_000```.
The device is in the category of *Door*, defining Door sensors.
![ZD2105 product image](https://www.cd-jackson.com/zwave_device_uploads/420/420_default.jpg)
The ZD2105 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.
The ZD2105 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.

35
_addons_bindings/zwave/doc/vision/zse40_0_0.md
View File

@ -19,7 +19,39 @@ The ZSE40 does not permanently listen for messages sent from the controller - it
## Overview
No device information is provided in the database. Consider [updating the database](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/307) to improve the documentation.
- 4 smart sensors in 1 compact device
- 7 levels of motion sensitivity to choose from
- 3 modes for motion / temp led indicator notifications
- Built-in tamper protection
- Low battery alerts
- Z-Wave Plus with improved 500 chip for faster and safer wireless communication
- Security enabled Z-Wave device – requires a security enabled gateway controller for full functionality
### Inclusion Information
1. Install the batteries and bring the 4-in-1 sensor as close to your Z-Wave gateway controller as possible
2. Put your Z-Wave controller in inclusion/pairing mode
3. Press and release the Z-Wave button TWICE quickly. The sensor will enter secure inclusion mode.
4. A new 4-in-1 sensor should appear on your controller's device list
If you are unable to include the Z-Wave sensor to your controller, please try one of the following: -
- Bring the 4-in-1 sensor closer to your Z-Wave controller
- Press and release the Z-Wave button quickly several times once you put the controller in the inclusion mode to ensure the command has gone through
- Put your controller in the EXCLUSION mode and press and release the Z-Wave button, then try adding it to your network again
### Exclusion Information
1. Bring the 4-in-1 sensor as close to your Z-Wave gateway controller as possible
2. Put your Z-Wave controller in exclusion/unpairing mode
3. Press and release the Z-Wave button TWICE quickly
4. The device should disappear from your controller's device list.
The led indicator will flash 3 times when you take the batteries out and put them back in to indicate the device has been successfully excluded. Please repeat the process following all steps carefully if the led indicator blinks only once when you reinsert the batteries.
### Wakeup Information
Use the Wake Up command to set wake-up interval for the sensor (from 10 minutes to 1 week) to report back to the controller. You can also press and release the Z-Wave button once to wake up the device manually.
## Channels
@ -261,6 +293,7 @@ This group supports 5 nodes.
* [Zwave technical manual](https://www.cd-jackson.com/zwave_device_uploads/307/ZSE40-tech-info.pdf)
* [Updated user manual](https://www.cd-jackson.com/zwave_device_uploads/307/ZOOZ-4-IN-1-Z-WAVE-SENSOR-ZSE40-USER-MANUAL--1-.pdf)
* [User Manual (German)](https://www.cd-jackson.com/zwave_device_uploads/307/4-IN-1-MULTISENSOR-Z-WAVE-MANUAL-DE.pdf)
---

2
_addons_bindings/zwave/readme.md
View File

@ -26,7 +26,7 @@ The binding uses a standard Z-Wave serial stick to communicate with the Z-Wave d
## Supported Things
The ZWave binding provides support for a large number of devices (currently 740 from 110 manufacturers).
The ZWave binding provides support for a large number of devices (currently 744 from 109 manufacturers).
See the [full list of supported things](doc/things.md).

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

@ -1,17 +1,3 @@
---
id: alexa-skill
label: Amazon Alexa Skill
title: Amazon Alexa Skill - System Integrations
type: io
description: "An intelligent voice guided personal assistant. Amazon Alexa became famous by the Amazon Echo speaker but is also available through independent solutions. The certified openHAB Alexa skill allows to naturally control the openHAB smart home by voiced commands."
since: 2x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Amazon Alexa Skill
An intelligent voice guided personal assistant. Amazon Alexa became famous by the Amazon Echo speaker but is also available through independent solutions. The certified openHAB Alexa skill allows to naturally control the openHAB smart home by voiced commands.

28
_addons_ios/mycroft-skill/readme.md
View File

@ -1,17 +1,3 @@
---
id: mycroft-skill
label: Mycroft AI Skill
title: Mycroft AI Skill - System Integrations
type: io
description: "[Mycroft AI](https://mycroft.ai/) is the world’s first open source voice enabled assistant."
since: 2x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Mycroft AI Skill
[Mycroft AI](https://mycroft.ai/) is the world’s first open source voice enabled assistant.
@ -30,7 +16,17 @@ The skill currently supportes the English (U.S.) and English (U.K.) languages bu
### Skill Installation
The openHAB skill has to be installed on your Mycroft instance, please refer to the [official documentation](https://docs.mycroft.ai/skills.and.features/adding.skills) to learn how to install a skill.
The openHAB skill has to be installed on your Mycroft instance, please refer to the [official documentation](https://mycroft.ai/documentation/msm/) to learn how to install a skill.
From 18.2.5b mycroft-core release it is possible to install the skill using the voice command:
- *"Hey Mycroft, install openhab"*
or via the [msm](https://mycroft.ai/documentation/msm/) command:
```shell
msm install openhab
```
To manually install the skill:
Clone the [skill repository](https://github.com/openhab/openhab-mycroft.git) into the Mycroft skills directory,
then trigger installation of needed dependencies:
@ -43,7 +39,7 @@ cd skill-openhab
pip install -r requirements.txt
```
If on [picroft](https://docs.mycroft.ai/development/installation/raspberry.pi), use the skills directory `/opt/mycroft/skills` and skip the `workon mycroft` command.
If on [picroft](https://mycroft.ai/documentation/picroft/), use the skills directory `/opt/mycroft/skills` and skip the `workon mycroft` command.
### Skill Configuration

2
_addons_voices/mactts/readme.md
View File

@ -3,7 +3,7 @@ id: mactts
label: MacOS Text-to-Speech
title: MacOS Text-to-Speech - Voices
type: voice
description: "The macOS Text-to-Speech (TTS) service uses the macOS 'say' command for producing spoken text."
description: "The MacOS Text-to-Speech (TTS) service uses the MacOS 'say' command for producing spoken text."
since: 2x
logo: images/addons/mactts.png
install: auto

4
_addons_voices/marytts/readme.md
View File

@ -40,3 +40,7 @@ marytts:bits1hsmm bits1-hsmm (de)
The MaryTTS service produces audio streams using WAV containers and PCM (signed) codec with 16bit depth.
The sample frequency depends on the chosen voice and ranges from 16kHz to 48kHz.
## Log files
The log messages of Mary TTS are not bundled with the openHAB log messages in the `openhab.log` file of your log directory but are stored in their own log file at `server.log` of your log directory.

2
concepts/units-of-measurement.md
View File

@ -27,7 +27,7 @@ This is:
|---------------|----------------------------|------------------------|
| Length | Meter (m) | Inch (in) |
| Temperature | Celsius (°C) | Fahrenheit (°F) |
| Pressure | Hektopascal (hPa) | Inch of mercury (inHg) |
| Pressure | Hectopascal (hPa) | Inch of mercury (inHg) |
| Speed | Kilometers per hour (km/h) | Miles per hour (mph) |
| Intensity | Irradiance (W/m2) | Irradiance (W/m2) |
| Dimensionless | Abstract unit one (one) | Abstract unit one (one)|

2
installation/openhabian.md
View File

@ -103,7 +103,7 @@ You will see the following welcome screen:
![openHABian login screen](images/openHABian-SSH-MotD.png)
➜ Continue at the ["openHABian Configuration Tool"](#openhabian-config) chapter below!
➜ Continue at the ["openHABian Configuration Tool"](#openhabian-configuration-tool) chapter below!
### Pine A64