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

Updated external 2.5.x content (Jenkins build 649)

pull/1689/head
openHAB Build Server 2021-01-05 06:06:42 +00:00
parent 5c47c823b2
commit 8c87654963
26 changed files with 1742 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_addons_bindings/zigbee/readme.md
View File

@ -152,7 +152,7 @@ The following coordinators are known to be supported.
| Name and Link | Coordinator | Configuration | Comment |
|----------------------------|-------------|---------------|---------|
|[Texas Instruments CC2531EMK](http://www.ti.com/tool/cc2531emk)|[CC2531](#cc2531-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) including a [connector board](https://de.aliexpress.com/item/CC2531-CC2540-Zigbee-Sniffer-software-protokoll-analyse-Wireless-Board-Bluetooth-BLE-4-0-Dongle-Capture-Modul/32869263224.html)<br>Also CC2530, CC2538 or CC2650 may 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)|115200bps<br>Hardware flow control<br>High RAM||
|[Bitron Video ZigBee USB Funkstick](http://www.bitronvideo.eu/index.php/produkte/smart-home-produkte/zb-funkstick/)|[Ember](#ember-ezsp-ncp-coordinator)|57600bps<br>Software flow control<br>High RAM||
|[Elelabs ELU013/ELR023](https://elelabs.com/shop/)|[Ember](#ember-ezsp-ncp-coordinator)|115200bps<br>Hardware flow control<br>High RAM| Both the stick and the hat can be upgraded without additional hardware, firmware available [here](https://github.com/Elelabs/elelabs-zigbee-ezsp-utility).|
|[Cortet EM358 USB Stick](https://www.cortet.com/iot-hardware/cortet-usb-sticks/em358-usb-stick)|[Ember](#ember-ezsp-ncp-coordinator)|57600bps<br>Software flow control<br>High RAM| |
|[Nortek Security & Control HUSBZB-1](https://nortekcontrol.com/products/2gig/husbzb-1-gocontrol-quickstick-combo/)|[Ember](#ember-ezsp-ncp-coordinator)|57600bps<br>Software flow control<br>High RAM|Stick contains both Z-Wave and ZigBee. |

472
_addons_bindings/zwave/doc/aeotec/zwa009_0_0.md Normal file
View File

@ -0,0 +1,472 @@
---
layout: documentation
title: ZWA009 - ZWave
---
{% include base.html %}
# ZWA009 Small sensor that offers monitoring of temperature, humidity, dew and mold.
This describes the Z-Wave device *ZWA009*, manufactured by *Aeotec Limited* with the thing type UID of ```aeotec_zwa009_00_000```.
The device is in the category of *Sensor*, defining Device used to measure something.
![ZWA009 product image](https://opensmarthouse.org/zwavedatabase/1336/image/)
The ZWA009 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 ZWA009 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. Refer to the *Wakeup Information* section below for further information.
## Overview
Small sensor that offers monitoring of temperature, humidity, dew and mold. Uses a CR2477 battery with up to 2 years' lifespan.
### Inclusion Information
Triple click the intrusion (button on the front) button.
### Exclusion Information
Triple click the intrusion (button on the front) button.
### Wakeup Information
The ZWA009 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.
Click the intrusion (button on the front) button.
### General Usage Information
## Channels
The following table summarises the channels available for the ZWA009 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Binary Sensor | sensor_binary | sensor_binary | | Switch |
| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature |
| Sensor (dew point) | sensor_dewpoint | sensor_dewpoint | Temperature | Number |
| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number |
| Alarm | alarm_general | alarm_general | Alarm | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### Binary Sensor
Indicates if a sensor has triggered.
The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device.
The following state translation is provided for this channel to the ```Switch``` item type -:
| Value | Label |
|-------|-----------|
| ON | Triggered |
| OFF | Untriggered |
### Sensor (temperature)
Indicates the current temperature.
The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category.
### Sensor (dew point)
Indicates the dewpoint.
The ```sensor_dewpoint``` channel is of type ```sensor_dewpoint``` and 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 (relative humidity)
Indicates the current relative humidity.
The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device.
### Alarm
Indicates if an alarm is triggered.
The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` 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 ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category.
This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.
## Device Configuration
The following table provides a summary of the 14 configuration parameters available in the ZWA009.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Minimum Temperature change | This value defines the minimum change of temperature to cause an unsolicited report of humidity to the central controller using Lifeline. |
| 2 | Minimum humidity change | This value defines the minimum change of humidity to cause an unsolicited report of humidity to the central controller using Lifeline. |
| 4 | Periodic Reports | This parameter defines the time interval to send an unsolicited report. If the value is set to 0, there will be no periodic reports sent to the controller. |
| 5 | Temperature Upper Watermark | If the measured temperature surpasses this watermark a BASIC command is sent into Association Group 2. |
| 6 | Temperature Lower Watermark | If the measured temperature dropps below this watermark a BASIC command is sent into Association Group 3. |
| 7 | Humidity Upper Watermark | If the measured relative humidity surpasses this watermark a BASIC command is sent into Association Group 4. |
| 8 | Humidity Lower Watermark | If the measured temperature drops below this relative humidity a BASIC command is sent into Association Group 5. |
| 9 | Low Temperature Trigger Command | This defines what BASIC SET command value shall be sent out into association group 3. |
| 10 | High Temperature Trigger Command | This defines what BASIC SET command value be sent out into association group 2. |
| 11 | Low Humidity Trigger Command | This defines what BASIC SET command value shall be sent out into association group 5. |
| 12 | High Humidity Trigger Command | This defines what BASIC SET command value shall be sent out into association group 4. |
| 13 | Offset value for Mold | This value allows to increase the humidity threshold for ideal mould environment notification by max 10%. |
| 64 | Temperature Scale | This parameter sets the temperature scale. |
| 255 | Reset Parameter | This parameter helps reset configuration parameters and the device to factory defaults. |
| | 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: Minimum Temperature change
This value defines the minimum change of temperature to cause an unsolicited report of humidity to the central controller using Lifeline.
Minimum Temperature change to report.
This value defines the minimum change of temperature to cause an unsolicited report of humidity to the central controller using Lifeline.
If the value is set to 0, there will be no reports sent to the controller, when the temperature changes. However, periodic reports, managed by configuration parameter 4, may still be active.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```20```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Minimum humidity change
This value defines the minimum change of humidity to cause an unsolicited report of humidity to the central controller using Lifeline.
Minimum humidity change to report.
This value defines the minimum change of humidity to cause an unsolicited report of humidity to the central controller using Lifeline.
If the value is set to 0, there will be no reports sent to the controller, when the humidity changes.
However, periodic reports, managed by configuration parameter 4, may still be active.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 20 may be set.
The manufacturer defined default value is ```7```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 4: Periodic Reports
This parameter defines the time interval to send an unsolicited report. If the value is set to 0, there will be no periodic reports sent to the controller.
Periodic Reports.
This parameter defines the time interval to send an unsolicited report.
If the value is set to 0, there will be no periodic reports sent to the controller.
However, reports on temperature/humidity changes, managed by configuration parameters 1 and 2, may still be active.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is ```43200```.
This parameter has the configuration ID ```config_4_2``` and is of type ```INTEGER```.
### Parameter 5: Temperature Upper Watermark
If the measured temperature surpasses this watermark a BASIC command is sent into Association Group 2.
Temperature Upper Watermark value.
This parameter defines a temperature.
If the measured temperature surpasses this watermark a BASIC command is sent into Association Group 2.
The value of BASIC SET is defined by parameter 10.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 1000 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```.
### Parameter 6: Temperature Lower Watermark
If the measured temperature dropps below this watermark a BASIC command is sent into Association Group 3.
Temperature Lower Watermark value.
This parameter defines a temperature.
If the measured temperature dropps below this watermark a BASIC command is sent into Association Group 3.
The value of BASIC SET is defined by parameter 9.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 1000 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_6_2``` and is of type ```INTEGER```.
### Parameter 7: Humidity Upper Watermark
If the measured relative humidity surpasses this watermark a BASIC command is sent into Association Group 4.
Humidity Upper Watermark value.
This parameter defines the relative humidity.
If the measured relative humidity surpasses this watermark a BASIC command is sent into Association Group 4.
The value of BASIC SET is defined by parameter 12.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Humidity Lower Watermark
If the measured temperature drops below this relative humidity a BASIC command is sent into Association Group 5.
Humidity Lower Watermark value.
This parameter defines a relative humidity.
If the measured temperature drops below this relative humidity a BASIC command is sent into Association Group 5.
The value of BASIC SET is defined by parameter 11.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```.
### Parameter 9: Low Temperature Trigger Command
This defines what BASIC SET command value shall be sent out into association group 3.
Low Temperature Trigger BASIC Set Command Value.
This defines what BASIC SET command value shall be sent out into association group 3.
Value meaning:
255 = ON.
0 = OFF.
1 - 100 = Defines a level between 0 - 100% if controlling dimmers.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```.
### Parameter 10: High Temperature Trigger Command
This defines what BASIC SET command value be sent out into association group 2.
High Temperature Trigger BASIC Set Command Value
This defines what BASIC SET command value be sent out into association group 2.
Value meaning:
255 = ON.
0 = OFF.
1 - 100 = Defines a level between 0 - 100% if controlling dimmers.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```.
### Parameter 11: Low Humidity Trigger Command
This defines what BASIC SET command value shall be sent out into association group 5.
Low Humidity Trigger BASIC Set Command Value.
This defines what BASIC SET command value shall be sent out into association group 5.
Value meaning:
255 = ON.
0 = OFF.
1 - 100 = Defines a level between 0 - 100% if controlling dimmers.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```.
### Parameter 12: High Humidity Trigger Command
This defines what BASIC SET command value shall be sent out into association group 4.
High Humidity Trigger BASIC Set Command Value.
This defines what BASIC SET command value shall be sent out into association group 4.
Value meaning:
255 = ON.
0 = OFF.
1 - 100 = Defines a level between 0 - 100% if controlling dimmers.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```.
### Parameter 13: Offset value for Mold
This value allows to increase the humidity threshold for ideal mould environment notification by max 10%.
Offset value for Mold environment notification
This value allows to increase the humidity threshold for ideal mould environment notification by max 10%. (default 0 value will set to trigger at humidity levels above 70%)This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 10 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 64: Temperature Scale
This parameter sets the temperature scale.
Temperature Scale
This parameter sets the temperature scale.
1 = Celsius
2 = Fahrenheit
Values in the range 1 to 2 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_64_0``` and is of type ```INTEGER```.
### Parameter 255: Reset Parameter
This parameter helps reset configuration parameters and the device to factory defaults.
Reset Parameter
This parameter helps reset configuration parameters and the device to factory defaults.
1 = Reset all Parameter settings to their default settings.
1431655765 = Completely factory reset sensor and send device reset locally notification.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 0 to 1431655765 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_255_4``` 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 ZWA009 supports 6 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Lifeline
Association group 1 supports 5 nodes.
### Group 2: Temperature High Trigger
Temperature High Trigger
Association group 2 supports 5 nodes.
### Group 3: Temperature Low Trigger
Temperature Low Trigger
Association group 3 supports 5 nodes.
### Group 4: 5 Humidity High Trigger
5 Humidity High Trigger
Association group 4 supports 5 nodes.
### Group 5: Humidity Low Trigger
Humidity Low Trigger
Association group 5 supports 5 nodes.
### Group 6: Air Temperature
Air Temperature
Association group 6 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_SENSOR_BINARY_V2| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V10| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V8| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_INDICATOR_V3| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [User Guide](https://opensmarthouse.org/zwavedatabase/1336/reference/AerQ_user_Guide.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1336).

4
_addons_bindings/zwave/doc/danfoss/mt02650_0_0.md
View File

@ -38,6 +38,10 @@ The wakeup period does not impact the devices ability to report events or sensor
Short push middle button
### General Usage Information
## Channels
The following table summarises the channels available for the MT02650 -:

4
_addons_bindings/zwave/doc/devolo/mt02648_0_0.md
View File

@ -143,7 +143,7 @@ This parameter has the configuration ID ```config_2_1``` and is of type ```INTEG
PIR sensitivity settings.
0 means disable the PIR motion. 1 means the lowest sensitivity, 99 means the highest sensitivity. High sensitivity means can detected long distance, but if there is more noise signal in the environment, it will re-trigger too frequency. 
The following option values may be configured, in addition to values in the range 0 to 99 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -192,7 +192,7 @@ Bit5: Disable the temperature report after event triggered.
Bit6: Reserve.
Bit7: Disable the back key release into test mode.
The following option values may be configured, in addition to values in the range 0 to 127 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

2
_addons_bindings/zwave/doc/fibaro/fgrgbw442_0_0.md
View File

@ -439,7 +439,7 @@ This parameter has the configuration ID ```config_34_4_000000FF``` and is of typ
Duration of alarm signalization
The following option values may be configured, in addition to values in the range 0 to 32400 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

4
_addons_bindings/zwave/doc/fibaro/fgs224_5_0.md
View File

@ -614,7 +614,7 @@ This parameter determines which actions result in sending scene IDs assigned to
4 – Key pressed 3 times
8 – Key hold down and key released
The following option values may be configured, in addition to values in the range 0 to 15 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -646,7 +646,7 @@ This parameter determines which actions result in sending scene IDs assigned to
8 – Key hold down and key released
15 - all active
The following option values may be configured, in addition to values in the range 0 to 15 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

14
_addons_bindings/zwave/doc/fibaro/fgwp102_3_2.md
View File

@ -119,7 +119,7 @@ Detailed information on each parameter can be found in the sections below.
|-------|-------|-------------|
| 1 | “Always On” mode | Will turn on connected device permanently |
| 2 | Remember device status before the power failure | determines how the Wall Plug will react in the event of power supply failure |
| 3 | Overload safety switch | allows to turn off the controlled device in case of exceeding the defined power. |
| 3 | Overload safety switch | Allows to turn off the controlled device in case of exceeding the defined power. |
| 10 | High priority power report | minimum percentage change in active power |
| 11 | Standard power report | minimum percentage change in active power |
| 12 | Power reporting interval | defines the time interval of sending at most 5 standard power reports |
@ -182,13 +182,13 @@ This parameter has the configuration ID ```config_2_1``` and is of type ```INTEG
### Parameter 3: Overload safety switch
allows to turn off the controlled device in case of exceeding the defined power.
Allows to turn off the controlled device in case of exceeding the defined power.
This function allows to turn off the controlled device in case of exceeding the defined power. Controlled device will be turned off even if “Always On” function is active (parameter 1).
Controlled device can be turned back on via B-button or sending a control frame. By default this function is inactive.
10-30000 (1.0-3000.0W, step 0.1W) - power threshold
The following option values may be configured, in addition to values in the range 10 to 30000 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -255,7 +255,7 @@ This parameter specifies the minimum change in energy consumption (in relation t
1-500 (0.01-5kWh, step 0.01kWh) - threshold
Default: 10 (0.1kWh)
The following option values may be configured, in addition to values in the range 0 to 500 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -272,7 +272,7 @@ defines time period between independent reports sent
This parameter defines time period between independent reports sent when changes in power load have not been recorded or if changes are insignificant. By default reports are sent every hour.
Default: 3600 second (1h)
The following option values may be configured, in addition to values in the range 5 to 32400 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -384,7 +384,7 @@ The value of BASIC SET command frame sent to the devices associated in „On/Off
Available settings: 0-99 or255
Default setting: 255
The following option values may be configured, in addition to values in the range 0 to 255 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -438,7 +438,7 @@ Available settings: 0 - no reaction,
* 1 - turn connected device on
* 2 - turn connected device off
* 5-50 (0.5-5.0s, step 0.1s) - cyclically change device state with set period
The following option values may be configured, in addition to values in the range 5 to 50 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

20
_addons_bindings/zwave/doc/fibaro/fgwpb121_0_0.md
View File

@ -238,7 +238,7 @@ Overload safety switch.
10-18000 - (1.0-1800.0W, step 0.1W) - power threshold.
This function allows to turn off the controlled device in case of exceeding the defined power. Controlled device can be turned back on via button or sending a control frame. By default this function is inactive. 
The following option values may be configured, in addition to values in the range 0 to 18000 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -257,7 +257,7 @@ Power reporting.
1-100 - power change in percent; default 15%.
This parameter determines the minimum percentage change in active power consumption (in relation to the previously reported) that will result in sending new power report. 
The following option values may be configured, in addition to values in the range 0 to 100 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -274,7 +274,7 @@ Energy reporting threshold.
0 - energy reports inactive.
1-500 - (0.01-5kWh, step 0.01kWh) - threshold; default 10 (0.1kWh).
The following option values may be configured, in addition to values in the range 0 to 500 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -293,7 +293,7 @@ Periodic power reporting.
30-32400 - In seconds; default 3600 (1h).
This parameter defines time period between independent reports sent when changes in power load have not been recorded or if changes are insignificant. By default reports are sent every hour.
The following option values may be configured, in addition to values in the range 0 to 32400 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -312,7 +312,7 @@ Periodic energy reporting.
30-32400 - In seconds; default 3600 (1h).
This parameter defines time period between independent reports sent when changes in power load have not been recorded or if changes are insignificant. By default reports are sent every hour.
The following option values may be configured, in addition to values in the range 0 to 32400 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -396,7 +396,7 @@ Command frame sent to devices in 2nd group.
1-99 - forcing level of associated devices.
The value of BASIC SET command frame sent to the devices associated in 2nd group "On/Off (Button)" when turning the device ON using the button.
The following option values may be configured, in addition to values in the range 0 to 255 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -416,7 +416,7 @@ Command frame sent to devices in 2nd group.
1-99 - forcing level of associated devices.
The value of BASIC SET command frame sent to the devices associated in 2nd group "On/Off (Button)" when turning the device OFF using the button.
The following option values may be configured, in addition to values in the range 0 to 255 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -436,7 +436,7 @@ Command frame sent to the devices in 3rd group.
1-99 - forcing level of associated devices.
The value of BASIC SET command frame sent to the devices associated in 3rd group "On/Off (Power)" if power exceeded value of parameter 21.
The following option values may be configured, in addition to values in the range 0 to 255 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -456,7 +456,7 @@ Command frame sent to the devices in 3rd group.
1-99 - forcing level of associated devices.
The value of BASIC SET command frame sent to the devices associated in 3rd group "On/Off (Power)" if power dropped below value of parameter 22.
The following option values may be configured, in addition to values in the range 0 to 255 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -495,7 +495,7 @@ Wall plug response to alarms.
5-50 (0.5-5.0s, step 0.1s) - cyclically change device state with set period.
This parameter defines how the Wall Plug will respond to alarms (device’s status change). In case of values 1 or 2 the Wall Plug is operating normally and LED frame signals an alarm through time defined in parameter 32 or until the alarm is canceled. In case of values 5 to 50 the Wall Plug does not report status change, power changes, ignores BASIC SET command frames. After time defined in parameter 32 or after the alarm cancellation, connected device is set to the previous state.
The following option values may be configured, in addition to values in the range 0 to 50 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

2
_addons_bindings/zwave/doc/fortrezz/mimo2_0_0.md
View File

@ -368,11 +368,13 @@ Association group 1 supports 1 node.
### Group 2: Sensor 1 On Change
Association group 2 supports 2 nodes.
### Group 3: Sensor 2 On Change
Association group 3 supports 2 nodes.
## Technical Information

158
_addons_bindings/zwave/doc/ge/zw1002_0_0.md Normal file
View File

@ -0,0 +1,158 @@
---
layout: documentation
title: ZW1002 - ZWave
---
{% include base.html %}
# ZW1002 Smart Outlet
This describes the Z-Wave device *ZW1002*, manufactured by *Jasco Products* with the thing type UID of ```ge_zw1002_00_000```.
The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there.
![ZW1002 product image](https://opensmarthouse.org/zwavedatabase/1337/image/)
The ZW1002 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
When paired with a compatible hub, the smart outlet controls and schedules plug-in devices through ON/OFF commands and programmed settings. Wirelessly operate lamps, fans, small appliances and more for effortless management of your home. 
### Inclusion Information
1. Follow the instructions for your Z-Wave certified controller to add a device to the Z-Wave network.
2. Once the controller is ready to add your device, press and release the program button to add it in the network.
### Exclusion Information
1. Follow the instructions for your Z-Wave certified controller to remove a device from the Z-Wave network.
2. Once the controller is ready to remove your device, press and release the manual/program button to remove it from the network.
### General Usage Information
## Channels
The following table summarises the channels available for the ZW1002 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Scene Number | scene_number | scene_number | | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
## Device Configuration
The following table provides a summary of the 1 configuration parameters available in the ZW1002.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 3 | LED Light | LED Light |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 3: LED Light
LED Light
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | LED ON when load is ON |
| 1 | LED ON when load is OFF |
| 2 | LED always OFF |
The manufacturer defined default value is ```0``` (LED ON when load is ON).
This parameter has the configuration ID ```config_3_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 ZW1002 supports 3 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Z-Wave Plus Lifeline
Association group 1 supports 5 nodes.
### Group 2: Single Press
Supports Basic Set and is controlled with the local load
Association group 2 supports 5 nodes.
### Group 3: Double Press
Supports Basic Set and is controlled by pressing the On or Off button
Association group 3 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_SCENE_ACTIVATION_V1| |
| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| |
| COMMAND_CLASS_CRC_16_ENCAP_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
### Documentation Links
* [jasco_zw1002_14297_manual](https://opensmarthouse.org/zwavedatabase/1337/reference/14297_qsg_v2.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1337).

18
_addons_bindings/zwave/doc/logic/matrixzba7140_0_0.md
View File

@ -19,17 +19,27 @@ The MATRIX ZBA7140 does not permanently listen for messages sent from the contro
## Overview
MATRIX type ZBA7140 (from hereon called MATRIX ZBA) is a multifunction battery wall controller that can be mounted in a modular wall-box or directly ontothe wall. It is compatible with existing FUGA® frames and wall boxes.MATRIX ZBA has four configurable pushbuttons that can control other Z-Wave devices through the wireless Z-Wave network. These buttons can send ‘ON’, ‘OFF’ and ‘DIM’ commands to the associated Z-Wave devices. These devices could be light dimmers, blinds, sunscreens, etc.MATRIX ZBA can also issue scene activation commands that can be used to activate scenes in the Z-Wave Controller.MATRIX ZBA has four RGB indicator LEDs, one for each pushbutton, that indicates activation of the pushbutton, and when MATRIX ZBA is in inclusion or exclusion mode. These indicators can be configured to a desired indication colour, or they can indicate the battery level when a pushbutton is activated.MATRIX ZBA is equipped with the newest battery-saving 700-series Z-Wave chip that uses up to 65% less power and have improved wireless range. This means that the small coin-cell battery can last between 5 –10years. MATRIX ZBA is estimated toabattery lifetime, at normal use, to approximately 5 years.
MATRIX type ZBA7140 (from hereon called MATRIX ZBA) is a multifunction battery wall controller that can be mounted in a modular wall-box or directly ontothe wall. It is compatible with existing FUGA® frames and wall boxes.
MATRIX ZBA has four configurable pushbuttons that can control other Z-Wave devices through the wireless Z-Wave network. These buttons can send ‘ON’, ‘OFF’ and ‘DIM’ commands to the associated Z-Wave devices. These devices could be light dimmers, blinds, sunscreens, etc.
MATRIX ZBA can also issue scene activation commands that can be used to activate scenes in the Z-Wave Controller.
MATRIX ZBA has four RGB indicator LEDs, one for each pushbutton, that indicates activation of the pushbutton, and when MATRIX ZBA is in inclusion or exclusion mode. These indicators can be configured to a desired indication colour, or they can indicate the battery level when a pushbutton is activated.
MATRIX ZBA is equipped with the newest battery-saving 700-series Z-Wave chip that uses up to 65% less power and have improved wireless range. This means that the small coin-cell battery can last between 5 –10years.
MATRIX ZBA is estimated to have a battery lifetime, at normal use, to approximately 5 years.
### Inclusion Information
MATRIXZBAis a SmartStart enabled product and can be added into a Z-Wave network by scanning the Z-Wave QR Code present on the product with a controller providing SmartStart inclusion. No further action is required and the SmartStart product will be added automatically within 10 minutes of being switched on in the network vicinity.Find the QR code and PIN Code on the back of the module.
MATRIXZBA is a SmartStart enabled product and can be added into a Z-Wave network by scanning the Z-Wave QR Code present on the product with a controller providing SmartStart inclusion. No further action is required and the SmartStart product will be added automatically within 10 minutes of being switched on in the network vicinity.Find the QR code and PIN Code on the back of the module.
Find the full DSK on the product packaging.
Add MATRIX ZBA to a network with Classic Inclusion by pressing once on the switch behind the pushbutton-cover. The LED near pushbutton 1 will start blinking.
Use same procedure for removing MATRIX ZBAwith Classic Exclusion. If MATRIXZBA already belongs to a Z-Wave network, the remove process must be performed before adding it in a new network. Otherwise, the adding of the device will fail.
Use same procedure for removing MATRIX ZBA with Classic Exclusion. If MATRIXZBA already belongs to a Z-Wave network, the remove process must be performed before adding it in a new network. Otherwise, the adding of the device will fail.
### Exclusion Information
@ -44,7 +54,7 @@ The MATRIX ZBA7140 does not permanently listen for messages sent from the contro
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.
MATRIX ZBA is a battery-operated device and is turned into deep sleep state most of the time to save battery. Communication with the device is limited. In order to communicate with the device, a controller is needed in the network. This controller will maintain a mailbox for the battery-operated devices and store commands that can’t be received during deep sleep state. Without such a controller, communication may become impossible and/or the battery lifetime is significantly decreased. This device will wake up every 6 hours and announce the wake-upstate by sending out a so-called Wake Up Notification. The controller can then empty the mailbox. The wake-up interval is a trade-off between maximal battery lifetime and the desired responses of the device. The device will stay awake right after inclusion for 10 seconds allowing the controller to perform certain configuration. It is possible to manually wake up the device by double-activating the button
This device will wake up every 6 hours and announce the wake-upstate by sending out a so-called Wake Up Notification. The controller can then empty the mailbox. The wake-up interval is a trade-off between maximal battery lifetime and the desired responses of the device. The device will stay awake right after inclusion for 10 seconds allowing the controller to perform certain configuration. It is possible to manually wake up the device by double-activating the button
### General Usage Information

2
_addons_bindings/zwave/doc/logic/zif5028_0_0.md
View File

@ -359,7 +359,7 @@ Determines the brightness of the status LED.
</td>
</tr>
</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 99 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

96
_addons_bindings/zwave/doc/merten/506219_0_0.md
View File

@ -57,27 +57,27 @@ The following table summarises the channels available for the 506219 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch 1 | switch_binary | switch_binary | Switch | Switch |
| Switch 2 | switch_binary1 | switch_binary | Switch | Switch |
| Switch 3 | switch_binary2 | switch_binary | Switch | Switch |
| Switch 4 | switch_binary3 | switch_binary | Switch | Switch |
| Switch | switch_binary | switch_binary | Switch | Switch |
| Switch 1 | switch_binary1 | switch_binary | Switch | Switch |
| Switch 2 | switch_binary2 | switch_binary | Switch | Switch |
| Switch 3 | switch_binary3 | switch_binary | Switch | Switch |
### Switch 1
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 2
### Switch 1
Switch the power on and off.
The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 3
### Switch 2
Switch the power on and off.
The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 4
### Switch 3
Switch the power on and off.
The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
@ -86,94 +86,68 @@ The ```switch_binary3``` channel is of type ```switch_binary``` and supports the
## Device Configuration
The following table provides a summary of the 7 configuration parameters available in the 506219.
The following table provides a summary of the 4 configuration parameters available in the 506219.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 0 | Switching/dimming/shutters dual-surface: | |
| 4 | Switching single-surface | |
| 44 | Doorbell function | |
| 52 | LOWER shutter as long as button is pressed | |
| 54 | Move shutter single-surface | direction of movement changes after each switching process |
| 55 | RAISE shutter as long as button is pressed | |
| 60 | Retrieve/save scene | |
| 0 | Button 1 function | |
| 1 | Button 2 function | |
| 2 | Button 3 function | |
| 3 | Button 4 function | |
### Parameter 0: Switching/dimming/shutters dual-surface:
### Parameter 0: Button 1 function
Values in the range 0 to 127 may be set.
The following option values may be configured, in addition to values in the range 0 to 0 -:
The manufacturer defined default value is ```0```.
| Value | Description |
|--------|-------------|
| 0 | Switching/dimming/shutters dual-surface |
| 4 | Switching single-surface |
| 44 | Doorbell function |
| 52 | LOWER shutter as long as button is pressed |
| 54 | Move shutter single-surface |
| 55 | RAISE shutter as long as button is pressed |
| 60 | Retrieve/save scene |
The manufacturer defined default value is ```0``` (Switching/dimming/shutters dual-surface).
This parameter has the configuration ID ```config_0_1``` and is of type ```INTEGER```.
### Parameter 4: Switching single-surface
### Parameter 1: Button 2 function
Values in the range 0 to 127 may be set.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
This parameter has the configuration ID ```config_1_0``` and is of type ```INTEGER```.
### Parameter 44: Doorbell function
### Parameter 2: Button 3 function
Values in the range 0 to 127 may be set.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_44_1``` and is of type ```INTEGER```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 52: LOWER shutter as long as button is pressed
### Parameter 3: Button 4 function
Values in the range 0 to 127 may be set.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_52_1``` and is of type ```INTEGER```.
### Parameter 54: Move shutter single-surface
direction of movement changes after each switching process
Values in the range 0 to 127 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_54_1``` and is of type ```INTEGER```.
### Parameter 55: RAISE shutter as long as button is pressed
Values in the range 0 to 127 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_55_1``` and is of type ```INTEGER```.
### Parameter 60: Retrieve/save scene
Values in the range 0 to 127 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_60_1``` and is of type ```INTEGER```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
## Association Groups

4
_addons_bindings/zwave/doc/nietech/ms10z_0_0.md
View File

@ -96,7 +96,7 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 3 -:
| Value | Description |
|--------|-------------|
@ -114,7 +114,7 @@ This parameter has the configuration ID ```config_2_1``` and is of type ```INTEG
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|

17
_addons_bindings/zwave/doc/philio/pan04_0_0.md
View File

@ -289,7 +289,7 @@ This parameter has the configuration ID ```config_2_2``` and is of type ```INTEG
Which endpoint is addressed by the BASIC command class
If the Controller is not using Multi_Channel command class to access the endpoint of PAN04, you may configure the endpoint value to react the Basic Command Class
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 1 to 3 -:
| Value | Description |
|--------|-------------|
@ -306,7 +306,7 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG
Change the external switch mode
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 1 to 3 -:
| Value | Description |
|--------|-------------|
@ -323,9 +323,9 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG
If threshold of wattage is reached, a meter report will be generated
Values in the range 0 to 65535 may be set.
Values in the range 10 to 1500 may be set.
The manufacturer defined default value is ```750```.
The manufacturer defined default value is ```1500```.
This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```.
@ -334,7 +334,7 @@ This parameter has the configuration ID ```config_5_2``` and is of type ```INTEG
If threshold of kWh is reached, a Meter Report will be generated
Values in the range 0 to 65535 may be set.
Values in the range 1 to 10000 may be set.
The manufacturer defined default value is ```10000```.
@ -345,7 +345,7 @@ This parameter has the configuration ID ```config_6_2``` and is of type ```INTEG
Restore switch state mode
Restores the switch state setting in case the device was disconnected from the power source.
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
@ -362,7 +362,7 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG
Auto Off Timer
Whenever the device switches to on, the auto off timer begin to count down. After the timer decrease to zero, it will switch off automatically.
Values in the range 0 to 65535 may be set.
Values in the range 0 to 32767 may be set.
The manufacturer defined default value is ```0```.
@ -426,16 +426,19 @@ The PAN04 supports 3 association groups.
### Group 1: Relay 1 + 2
Association group 1 supports 1 node.
### Group 2: Relay 1
Association group 2 supports 1 node.
### Group 3: Relay 2
Association group 3 supports 1 node.
## Technical Information

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

@ -426,7 +426,7 @@ Available configuration parameters (data type is 2 Byte DEC)
* 30 – 32535 = 30 s – 32535 s
**NOTE:** the delay time may be prolonged for more then 10s of the time set by the parameter.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 32535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

14
_addons_bindings/zwave/doc/shenzhen/powerplug_0_0.md
View File

@ -36,6 +36,10 @@ This Plug provides line voltage, current load, power consumption and energy cons
2. Set Z‐Wave controller or Z‐Wave gateway into exclusion mode (Refer to the controller or gateway operating manual)
3. Press the button three times within 1.5 second, the device will enter exclusion mode. And the LED will flash on and off with yellow alternately five times within 2 seconds.
### General Usage Information
## Channels
The following table summarises the channels available for the NAS-WR01ZE -:
@ -117,7 +121,7 @@ Detailed information on each parameter can be found in the sections below.
This parameter defines Disable/Enable meter report measure data to controller.
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -167,7 +171,7 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG
This parameter defines the LED indication Function ON/OFF.
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -194,7 +198,7 @@ This parameter has the configuration ID ```config_6_1``` and is of type ```INTEG
Plug state after power-on
Define how will the Plug react after the power supply is back on.  0 = will be off after the power supply is reconnected.  Others = remember relay status
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -210,7 +214,7 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG
Timer plug OFF after time period
Defines if the timer function is enabled/disabled to switch the Plug OFF after the time period, which is defined in parameter 9#.
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -237,7 +241,7 @@ This parameter has the configuration ID ```config_9_2``` and is of type ```INTEG
Enable/Disable top button function
If this parameter is set to ‘1’, users can turn on and off the wall plug by pressing the button on the top of the wall plug. If this parameter is set to ‘0’, the wall plug cannot be turned on and off by pressing the button.
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|

2
_addons_bindings/zwave/doc/steinel/rsledd2_0_0.md
View File

@ -300,7 +300,7 @@ cessed, the transition cannot be interrupted by any motion event in any case.
210 - 254 = Reserved
255 = Lamp/relay is switched off for TIME (cfg 1). It does not wait for a motion event and works normally via current motion evaluation.
The following option values may be configured, in addition to values in the range 0 to 209 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

2
_addons_bindings/zwave/doc/sunricher/9040_0_0.md
View File

@ -169,7 +169,7 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG
Default Fade Time in Seconds
The following option values may be configured, in addition to values in the range 0 to 127 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

217
_addons_bindings/zwave/doc/technisat/03009497_0_0.md Normal file
View File

@ -0,0 +1,217 @@
---
layout: documentation
title: 0300/9497 - ZWave
---
{% include base.html %}
# 0300/9497 Dimmer flush mount compatible to Busch-Jaeger
This describes the Z-Wave device *0300/9497*, manufactured by *Technisat* with the thing type UID of ```technisat_03009497_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.
![0300/9497 product image](https://opensmarthouse.org/zwavedatabase/1332/image/)
The 0300/9497 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
The TechniSat dimmer controls the brightness of a ceiling lamp, for instance, via the rockers. At the same time, the system can also be integrated into a Z-Wave Smart Home system in order to set dazzling lighting accents or to create a special mood with lighting.
What's more, you can determine how much electricity you use and the dimmer can be integrated into complex schemes in smart home systems.
The dimmer can be installed in standard flush-mounted boxes (DIN 49073-1)
### Inclusion Information
Press the upper position of the left button (T1) 3x within a second.
### Exclusion Information
Press and hold the upper position of the left button (T1) for at least 10 seconds when the shutter is in the top position.
### General Usage Information
## Channels
The following table summarises the channels available for the 0300/9497 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Scene Number | scene_number | scene_number | | Number |
| Alarm (power) | alarm_power | alarm_power | Energy | Switch |
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Electric meter (kWh)
Indicates the energy consumption (kWh).
The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (watts)
Indicates the instantaneous power consumption.
The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -:
| Event ID | Event Description |
|----------|--------------------|
| 0 | Single key press |
| 1 | Key released |
| 2 | Key held down |
| 3 | Double keypress |
| 4 | Tripple keypress |
| 5 | 4 x keypress |
| 6 | 5 x keypress |
### Alarm (power)
Indicates if a power alarm is triggered.
The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
The following state translation is provided for this channel to the ```Switch``` item type -:
| Value | Label |
|-------|-----------|
| OFF | OK |
| ON | Alarm |
## Device Configuration
The following table provides a summary of the 4 configuration parameters available in the 0300/9497.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Central scene notification | Enable/Disable Central scene notifcations for 2x-5x press |
| 2 | Wattage meter | Interval Current wattage meter report in 10s |
| 3 | Energy meter report | Interval of active energy meter report in minutes |
| 4 | Manual shutter calibration | Function of switch position T1 (up) and T2 (down) |
### Parameter 1: Central scene notification
Enable/Disable Central scene notifcations for 2x-5x press
0 - disable, 1 - enable
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Disabled |
| 1 | Enabled |
The manufacturer defined default value is ```0``` (disabled).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Wattage meter
Interval Current wattage meter report in 10s
Interval of current wattage meter report in 10 second steps, 30s ... 1day, 0 - disable
Values in the range 0 to 8640 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```.
### Parameter 3: Energy meter report
Interval of active energy meter report in minutes
Interval of active energy meter report in minutes, 10min ... 3 weeks, 0 - disable
Values in the range 0 to 30240 may be set.
The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_3_2``` and is of type ```INTEGER```.
### Parameter 4: Manual shutter calibration
Function of switch position T1 (up) and T2 (down)
Manual shutter calibration (shutter will move up, down and up again)
0 - idle, 1 - start a manual shutter calibration
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```.
## 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 0300/9497 supports 2 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
- Device Reset Locally Notification
- Central Scene notification
- Meter Report
- Multilevel Switch Report
- Notification Report
Association group 1 supports 1 node.
### Group 2: Switch State
- Basic Set
Association group 2 supports 10 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_METER_V3| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V8| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_SECURITY_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [Technical Data Sheet](https://opensmarthouse.org/zwavedatabase/1332/reference/technical_data_sheet_dimmer_flush_mount_bj.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1332).

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

@ -203,7 +203,7 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG
Auto Turn-Off Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -218,7 +218,7 @@ This parameter has the configuration ID ```config_6_4``` and is of type ```INTEG
Auto Turn-On Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -233,7 +233,7 @@ This parameter has the configuration ID ```config_7_4``` and is of type ```INTEG
Auto Turn-Off Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -248,7 +248,7 @@ This parameter has the configuration ID ```config_8_4``` and is of type ```INTEG
Auto Turn-On Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -263,7 +263,7 @@ This parameter has the configuration ID ```config_9_4``` and is of type ```INTEG
Auto Turn-Off Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -278,7 +278,7 @@ This parameter has the configuration ID ```config_10_4``` and is of type ```INTE
Auto Turn-On Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

682
_addons_bindings/zwave/doc/zooz/zen16_1_0.md Normal file
View File

@ -0,0 +1,682 @@
---
layout: documentation
title: ZEN16 - ZWave
---
{% include base.html %}
# ZEN16 Multirelay
This describes the Z-Wave device *ZEN16*, manufactured by *[Zooz](http://www.getzooz.com/)* with the thing type UID of ```zooz_zen16_01_000```.
This version of the device is limited to firmware versions 1.0 to 1.3
The device is in the category of *Battery*, defining Batteries, Energy Storages.
![ZEN16 product image](https://opensmarthouse.org/zwavedatabase/1326/image/)
The ZEN16 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
**Features**
* Powerful dry contact relays to control loads up to 15 A and 20 A
* Perfect for outdoor lighting, pool pumps, garage door, or gas fireplace
* Control up to 3 connected loads independently or together
* Z-Wave or optional wall switch control (toggle or momentary type)
* Built-in timers for each relay to simplify automation
* Remembers and restores on/off status after power failure
* Built-in Z-Wave Plus signal repeater to extend network range
* Powered by 12-24 V DC/AC or USB C port for easy set-up
* Wall mounting and minimal design for clean installation
* S2 security protocol and the latest 500 Z-Wave chip
**Specifications**
* Model Number: ZEN16
* Z-Wave Signal Frequency: 908.42 MHz
* Power: 12-24 V DC/AC or USB C
* Maximum Load: Relay 1: 15A (HP), R2: 15A (HP), R3: 20A (HP)
* Range: Up to 100 feet line of sight
* Operating Temperature: 32-104° F (0-40° C)
* Installation and Use: Indoor only
### Inclusion Information
1. Start Z-Wave inclusion.
2. Quickly press the Z-Wave button 3 times.
The LED indicator will blink to signal communication and remain on for 2 seconds to confirm inclusion.
### Exclusion Information
1. Start Z-Wave inclusion.
2. Quickly press the Z-Wave button 3 times.
The LED indicator will blink to signal communication and remain on for 2 seconds to confirm inclusion.
### General Usage Information
**Manual Control From The Z-Wave Button**
* 3 x tap: enter inclusion (pairing) mode
* 5 x tap: change LED indicator mode (see parameter 5)
## Channels
The following table summarises the channels available for the ZEN16 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
| Binary Sensor | sensor_binary | sensor_binary | | Switch |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Electric meter (kVAh) | meter_kvah | meter_kvah | Energy | Number |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Switch 1 | switch_binary1 | switch_binary | Switch | Switch |
| Switch 2 | switch_binary2 | switch_binary | Switch | Switch |
| Switch 3 | switch_binary3 | switch_binary | Switch | Switch |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
### Binary Sensor
Indicates if a sensor has triggered.
The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device.
The following state translation is provided for this channel to the ```Switch``` item type -:
| Value | Label |
|-------|-----------|
| ON | Triggered |
| OFF | Untriggered |
### Electric meter (kWh)
Indicates the energy consumption (kWh).
The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (kVAh)
Indicates the energy consumption (kVAh).
The ```meter_kvah``` channel is of type ```meter_kvah``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (watts)
Indicates the instantaneous power consumption.
The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Battery Level
Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.
The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category.
This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.
### Switch 1
Switch the power on and off.
The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 2
Switch the power on and off.
The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 3
Switch the power on and off.
The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
## Device Configuration
The following table provides a summary of the 24 configuration parameters available in the ZEN16.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | On Off Status After Power Failure | Set the on off status for the relays after power failure |
| 2 | Switch Type for Relay 1 (Sw1) | Choose the wall switch type you want to connect to the Sw1 terminal |
| 3 | Switch Type for Relay 2 (Sw2) | Choose the wall switch type you want to connect to the Sw2 terminal |
| 4 | Switch Type for Relay 3 (Sw3) | Choose the wall switch type you want to connect to the Sw3 terminal. |
| 5 | LED Indicator Control | LED Indicator Control |
| 6 | Auto Turn-Off Timer for Relay 1 | Auto Turn-Off Timer for Relay 1 |
| 7 | Auto Turn-On Timer for Relay 1 | Auto Turn-On Timer for Relay 1 |
| 8 | Auto Turn-Off Timer for Relay 2 | Auto Turn-Off Timer for Relay 2 |
| 9 | Auto Turn-On Timer for Relay 2 | Auto Turn-On Timer for Relay 2 |
| 10 | Auto Turn-Off Timer for Relay 3 | Auto Turn-Off Timer for Relay 3 |
| 11 | Auto Turn-On Timer for Relay 3 | Auto Turn-On Timer for Relay 3 |
| 12 | Enable/Disable Manual Control for Sw1 | Enable/Disable Manual Control for Sw1 |
| 13 | Enable/Disable Manual Control for Sw2 | Enable/Disable Manual Control for Sw2 |
| 14 | Enable/Disable Manual Control for Sw3 | Enable/Disable Manual Control for Sw3 |
| 15 | Auto Timer-Off Timer Unit for Relay 1 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 1 |
| 16 | Auto Timer-On Timer Unit for Relay 1 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 1 |
| 17 | Auto Timer-Off Timer Unit for Relay 2 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 2 |
| 18 | Auto Timer-On Unit for Relay 2 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 2 |
| 19 | Auto Timer-Off Timer Unit for Relay 3 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 3 |
| 20 | Auto Timer-On Timer Unit for Relay 3 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 3 |
| 21 | Relay 1 - Default Relay State | Decide whether you'd like Relay 1 to be normally open (NO) or normally closed (NC) |
| 22 | Relay 2 - Default Relay State | Decide whether you'd like Relay 2 to be normally open (NO) or normally closed (NC) |
| 23 | Relay 3 - Default Relay State | Decide whether you'd like Relay 3 to be normally open (NO) or normally closed (NC) |
| 24 | DC Motor Mode | Sync Relay 1 and Relay 2 together to prevent them from being activated at the same time |
### Parameter 1: On Off Status After Power Failure
Set the on off status for the relays after power failure
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | ALL relays forced to OFF |
| 1 | ALL relays restore on/off status (default) |
| 2 | ALL relays forced to ON |
| 3 | Relay 1 and 2 restore on/off status, Relay 3 OFF |
| 4 | Relay 1 and 2 restore on/off status, Relay 3 ON |
The manufacturer defined default value is ```1``` (ALL relays restore on/off status (default)).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Switch Type for Relay 1 (Sw1)
Choose the wall switch type you want to connect to the Sw1 terminal
Press and hold the Z-Wave button for 5 seconds to change mode manually
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | Garage door switch |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Switch Type for Relay 2 (Sw2)
Choose the wall switch type you want to connect to the Sw2 terminal
Click-click’n’hold the Z-Wave button for 5 seconds to change mode manually.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | Garage door switch |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Switch Type for Relay 3 (Sw3)
Choose the wall switch type you want to connect to the Sw3 terminal.
Click-click-click’n’hold the Z-Wave button for 5 seconds to change mode manually
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | Garage door switch |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: LED Indicator Control
LED Indicator Control
Choose if you want the LED indicator to turn on when any of the relays are on or if all of them are off, or if you want it to remain on or off at all times.
Click the Z-Wave button 5 times quickly to change mode manually
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | ON when all relays OFF (default) |
| 1 | ON when any relay ON |
| 2 | LED indicator is always OFF |
| 3 | LED indicator is always ON |
The manufacturer defined default value is ```0``` (ON when all relays OFF (default)).
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Auto Turn-Off Timer for Relay 1
Auto Turn-Off Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_6_4``` and is of type ```INTEGER```.
### Parameter 7: Auto Turn-On Timer for Relay 1
Auto Turn-On Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_7_4``` and is of type ```INTEGER```.
### Parameter 8: Auto Turn-Off Timer for Relay 2
Auto Turn-Off Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_8_4``` and is of type ```INTEGER```.
### Parameter 9: Auto Turn-On Timer for Relay 2
Auto Turn-On Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_9_4``` and is of type ```INTEGER```.
### Parameter 10: Auto Turn-Off Timer for Relay 3
Auto Turn-Off Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_10_4``` and is of type ```INTEGER```.
### Parameter 11: Auto Turn-On Timer for Relay 3
Auto Turn-On Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_11_4``` and is of type ```INTEGER```.
### Parameter 12: Enable/Disable Manual Control for Sw1
Enable/Disable Manual Control for Sw1
Enable or disable physical on/off control of Relay 1 from the wall switch connected to Sw1 terminal. If disabled, you’ll only be able to control the connected device via Z-Wave.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
| 1 | Enable (default) |
The manufacturer defined default value is ```1``` (Enable (default)).
This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```.
### Parameter 13: Enable/Disable Manual Control for Sw2
Enable/Disable Manual Control for Sw2
Enable or disable physical on/off control of Relay 2 from the wall switch connected to Sw2 terminal. If disabled, you’ll only be able to control the connected device via Z-Wave.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
| 1 | Enable (default) |
The manufacturer defined default value is ```1``` (Enable (default)).
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 14: Enable/Disable Manual Control for Sw3
Enable/Disable Manual Control for Sw3
Enable or disable physical on/off control of Relay 3 from the wall switch connected to Sw3 terminal. If disabled, you’ll only be able to control the connected device via Z-Wave.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
| 1 | Enable (default) |
The manufacturer defined default value is ```1``` (Enable (default)).
This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```.
### Parameter 15: Auto Timer-Off Timer Unit for Relay 1
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 1
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```.
### Parameter 16: Auto Timer-On Timer Unit for Relay 1
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 1
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 17: Auto Timer-Off Timer Unit for Relay 2
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 2
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```.
### Parameter 18: Auto Timer-On Unit for Relay 2
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 2
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```.
### Parameter 19: Auto Timer-Off Timer Unit for Relay 3
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 3
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Parameter 20: Auto Timer-On Timer Unit for Relay 3
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 3
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```.
### Parameter 21: Relay 1 - Default Relay State
Decide whether you'd like Relay 1 to be normally open (NO) or normally closed (NC)
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Normally open (relay reports off when it's open / switch is off and on |
| 1 | Normally closed (relay reports off when it's open / switch is on and o |
| 2 | Normally closed (relay reports off when it's closed / switch is off an |
The manufacturer defined default value is ```0``` (Normally open (relay reports off when it's open / switch is off and on).
This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```.
### Parameter 22: Relay 2 - Default Relay State
Decide whether you'd like Relay 2 to be normally open (NO) or normally closed (NC)
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Normally open (relay reports off when it's open / switch is off and on |
| 1 | Normally closed (relay reports off when it's open / switch is on and o |
| 2 | Normally closed (relay reports off when it's closed / switch is off an |
The manufacturer defined default value is ```0``` (Normally open (relay reports off when it's open / switch is off and on).
This parameter has the configuration ID ```config_22_1``` and is of type ```INTEGER```.
### Parameter 23: Relay 3 - Default Relay State
Decide whether you'd like Relay 3 to be normally open (NO) or normally closed (NC)
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Normally open (relay reports off when it's open / switch is off and on |
| 1 | Normally closed (relay reports off when it's open / switch is on and o |
| 2 | Normally closed (relay reports off when it's closed / switch is off an |
The manufacturer defined default value is ```0``` (Normally open (relay reports off when it's open / switch is off and on).
This parameter has the configuration ID ```config_23_1``` and is of type ```INTEGER```.
### Parameter 24: DC Motor Mode
Sync Relay 1 and Relay 2 together to prevent them from being activated at the same time
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | DC motor mode disabled (relays will always turn on whenever activated) |
| 1 | DC motor mode enabled (relay checks the status of the other relay afte |
The manufacturer defined default value is ```0``` (DC motor mode disabled (relays will always turn on whenever activated)).
This parameter has the configuration ID ```config_24_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 ZEN16 supports 4 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Association group 1 supports 1 node.
### Group 2: Relay 1
Send BASIC_SET reports when operated manually
Association group 2 supports 5 nodes.
### Group 3: Relay 2
Send BASIC_SET reports when operated manually
Association group 3 supports 5 nodes.
### Group 4: Relay 3
Send BASIC_SET reports when operated manually
Association group 4 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_APPLICATION_STATUS_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| |
| COMMAND_CLASS_CHIMNEY_FAN_V1| |
| COMMAND_CLASS_SCENE_ACTIVATION_V1| |
| COMMAND_CLASS_SCENE_CONTROLLER_CONF_V1| |
| COMMAND_CLASS_SENSOR_BINARY_V1| |
| COMMAND_CLASS_METER_V1| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
### Documentation Links
* [manual](https://opensmarthouse.org/zwavedatabase/1326/reference/zooz-s2-multirelay-zen16-ver1.02-manual_1.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1326).

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

@ -275,7 +275,7 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG
Auto Turn-Off Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -290,7 +290,7 @@ This parameter has the configuration ID ```config_6_4``` and is of type ```INTEG
Auto Turn-On Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -305,7 +305,7 @@ This parameter has the configuration ID ```config_7_4``` and is of type ```INTEG
Auto Turn-Off Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -320,7 +320,7 @@ This parameter has the configuration ID ```config_8_4``` and is of type ```INTEG
Auto Turn-On Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -335,7 +335,7 @@ This parameter has the configuration ID ```config_9_4``` and is of type ```INTEG
Auto Turn-Off Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -350,7 +350,7 @@ This parameter has the configuration ID ```config_10_4``` and is of type ```INTE
Auto Turn-On Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

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

@ -68,7 +68,7 @@ The skill connects your openHAB setup through the [myopenHAB.org](http://myopenH
## Requirements
* [openHAB Cloud Connector](http://docs.openhab.org/addons/ios/openhabcloud/readme.html) configured using myopenHAB.org
* [openHAB Cloud Connector](https://www.openhab.org/addons/integrations/openhabcloud/) configured using myopenHAB.org
* Amazon account
* Amazon Echo, Amazon Echo Dot or compatible Alexa device

4
addons/uis/apps/android.md
View File

@ -104,10 +104,10 @@ then
logInfo("alarm", "Scheduling alarm for {} ({})", newState.toLocaleZone, epoch)
if (timerAlarm !== null) {
logInfo("alarm", "Reschedule alarm")
timerAlarm.reschedule(new DateTime(epoch))
timerAlarm.reschedule(newState.toLocaleZone.zonedDateTime)
} else {
logInfo("alarm", "New alarm")
timerAlarm = createTimer(new DateTime(epoch), [ |
timerAlarm = createTimer(newState.toLocaleZone.zonedDateTime, [ |
// Turn on stuff, e.g. radio or light
logInfo("alarm", "Alarm expired")
timerAlarm = null

116
installation/openhabian.md
View File

@ -6,7 +6,11 @@ source: https://github.com/openhab/openhabian/blob/master/docs/openhabian.md
{% include base.html %}
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
<!-- Attention authors: Do not edit directly. Please add your changes to the source repository -->
::: tip TL;DR
Jump to [install instructions](#Raspberry-Pi-prepackaged-SD-card-image).
:::
# openHABian - Hassle-free openHAB Setup
The Raspberry Pi and other small single-board computers are quite famous platforms for openHAB.
@ -27,7 +31,7 @@ To that end, the project provides two things:
{:toc}
## Features
The following features are provided by the openHABian image out of the box:
Out of the box, the openHABian image provides
- Hassle-free setup without a display or keyboard, connected via Ethernet or [WiFi](#wifi-based-setup-notes)
- the latest stable version of openHAB
@ -48,9 +52,9 @@ The included **openHABian Configuration Tool** [`openhabian-config`](#openhabian
![openHABian-config menu](images/openHABian-config.png)
- Switch openHAB versions 2 vs 3 and select the latest *Release*, *Milestone* or *Snapshot* [*unstable/SNAPSHOT* build](https://www.openhab.org/docs/installation/linux.html#changing-versions) version
- Install and Setup a [reverse proxy](security.html#nginx-reverse-proxy) with password authentication and/or HTTPS access (incl. [Let's Encrypt](https://letsencrypt.org) certificate) for self-controlled remote access
- Install and Setup a [reverse proxy](security.html##running-openhab-behind-a-reverse-proxy) with password authentication and/or HTTPS access (incl. [Let's Encrypt](https://letsencrypt.org) certificate) for self-controlled remote access
- manually set up a WiFi connection
- Setup [Backup](#backup) for your system
- Setup [Backup](#availability-and-backup) for your system
- Easily install and preconfigure [Optional Components](#optional-components) of your choice
- configure Raspberry Pi specific functions
- Prepare the serial port for the use with extension boards like RaZberry, Enocean Pi, ...
@ -58,15 +62,88 @@ The included **openHABian Configuration Tool** [`openhabian-config`](#openhabian
- Move the system partition to an external USB stick or drive
... and much more
## Quick Start
## Hardware
### Hardware recommendation
Let's put this first: our current recommendation is to get a RPi 4 with 2 or 4 GB,
a 3 A power supply and a 16 GB SD card.
Also get another 32 GB or larger SD card and a USB card reader to make use of the
["auto backup" feature](docs/openhabian.md#Auto-Backup).
***
FIRST, check the [README](https://github.com/openhab/openhabian/blob/master/README.md) if your hardware and OS are supported
ATTENTION:<br>
Avoid getting the 8 GB model of RPi 4. 8 GB are a waste of money and it has issues,
you must [disable ZRAM](https://github.com/openhab/openhabian/blob/master/docs/openhabian.md#disable-zram) or use the 64bit image (untested).
***
### Hardware and OS support
As of openHABian version 1.6 and later, all Raspberry Pi models are supported as
hardware. Anything x86 based may work or not. Anything else ARM based such as ODroids,
OrangePis and the like may work or not. NAS servers such as QNAP and Synology
boxes will not work. Support for PINEA64 was dropped in this current release.<br>
We strongly recommend that users choose Raspberry Pi 2, 3 or 4 systems to have
1 GB of RAM or more. RPi 1 and 0/0W only have a single CPU core and 512 MB.
This can be sufficient to run a smallish openHAB setup, but it will
not be enough to run a full-blown system with many bindings and memory consuming
openHABian features/components such as ZRAM, InfluxDB or Grafana.
We do not actively prohibit installation on any hardware, including unsupported
systems, but we might skip or deny to install specific extensions such as those
memory hungry applications named above.
### Raspberry Pi (Prepackaged SD Card Image)
Supporting hardware means testing every single patch and every release. There
are simply too many combinations of SBCs, peripherals and OS flavors that
maintainers do not have available, or, even if they did, the time to spend on
the testing efforts that is required to make openHABian a reliable system.
Let's make sure you understand the implications of these statements: it means
that to run on hardware other than RPi 2/3/4 or (bare metal i.e. not virtualized)
x86 may work but this is **not** supported.
It may work to install and run openHABian on unsupported hardware. If it does
not work, you are welcome to find out what's missing and contribute it back to
the community with a Pull Request. It is sometimes simple things like a naming
string. We'll be happy to include that in openHABian so you can use your box
with openHABian unless there's a valid reason to change or remove it.
However, that does not make your box a "supported" one as we don't have it
available for our further development and testing. So there remains a risk that
future openHABian releases will fail to work on your SBC because we changed a
thing that broke support for your HW - unintentionally so however inevitable.
For ARM hardware that we don't support, you can try any of the [fake hardware parameters](openhabian.md/#fake-hardware-mode)
to 'simulate' RPi hardware and Raspi OS. If that still doesn't work for
you, give [Ubuntu](https://ubuntu.com/download/iot) or [ARMbian](https://www.armbian.com/) a try.
Going beyond what the RPi image provides, as a manually installed set of
scripts, we support running openHABian on x86 hardware on generic Debian.
On ARM, we only support Raspberry Pi OS.
These are what we develop and test openHABian against.
We do **not** actively **support Ubuntu** so no promises but we provide code
"as-is" that is known to run on there. Several optional components though,
such as WireGuard or Homegear, are known to expose problems.
We expect you to use the current stable distribution, 'buster' for Raspberry
Pi OS (ARM) and Debian (x86) and 'focal' for Ubuntu (x86) this is.
To install openHABian on anything older or newer may work or not. If you
encounter issues, you may need to upgrade first or to live with the consequences
of running an OS on the edge of software development.
Either way, please note that you're on your own when it comes to configuring and
installing the HW with the proper OS yourself.
### 64 bit ?
RPi3 and 4 have a 64 bit processor and you may want to run openHAB in 64 bit.
We provide a 64bit version of the image but it is unsupported so use it at your
own risk. Please don't ask for support if it does not work for you.
It's just provided as-is.
Be aware that to run in 64 bit has a major drawback: increased memory usage.
That is not a good idea on a heavily memory constrained platform like a RPi.
Also remember openHABian makes use of Raspberry Pi OS which as per today still
is a 32 bit OS.
We are closely observing development and will adapt openHABian once it will
reliably work on 64 bit.<br/>
On x86 hardware, 64 bit is the standard.
## Raspberry Pi prepackaged SD card image
**Flash, plug, wait, enjoy:**
The provided image is based on the [Raspberry Pi OS Lite](https://www.raspberrypi.org/downloads/raspberry-pi-os/) (previously called Raspbian) standard system.
The provided image is based on the [Raspberry Pi OS Lite](https://www.raspberrypi.org/software/operating-systems/#raspberry-pi-os-32-bit) (previously called Raspbian) standard system.
On first boot, the system will set up openHAB and the mentioned settings and tools.
All packages will be downloaded in their newest version and configured to work without further modifications.
The whole process will take a few minutes, then openHAB and all other needed tools to get started will be ready to use without further configuration steps.
@ -75,7 +152,7 @@ openHABian is designed as a headless system, you will not need a display or a ke
**Setup:**
- [Download the latest "openHABian" SD card image file](https://github.com/openhab/openhabian/releases) (Note: the file is *xz* compressed)
- Write the image to your SD card (e.g. with [Etcher](https://www.balena.io/etcher/), able to directly work with *xz* files)
- Write the image to your SD card (e.g. with [Etcher](https://www.balena.io/etcher/) or official [Raspberry Pi Imager](https://www.raspberrypi.org/software/), both able to directly work with *xz* files
- Insert the SD card into your Raspberry Pi, connect Ethernet ([WiFi also supported](#wifi-based-setup-notes)) and power on.
- Wait approximately **15-45 minutes** for openHABian to do its magic. <br>(You can check the progress in your web-browser [here](http://openhabiandevice).)
- Enjoy!
@ -286,9 +363,9 @@ ZRAM is activated by default on fresh installations on ARM hardware except on a
If you want to disable ZRAM for a different reason, use `zraminstall=disable` in `openhabian.conf` to install without.
#### Debug mode
See [Troubleshooting](#Troubleshooting) section if you run into trouble installing. If you want to turn on debug mode,
See [Troubleshooting](#troubleshooting) section if you run into trouble installing. If you want to turn on debug mode,
edit `openhabian.conf` and set the `debugmode=` parameter to either `off`, `on` or `maximum`.
Mind you that if you intend to open an issue, we need you to provide the output of `debugmode=maximum`.
Mind you that if you intend to open an issue, we need you to provide the output of `debugmode=maximum` so if you're in interactive mode, set your terminal to record output.
#### Auto-backup
You might want to setup openHABian to automatically backup and mirror your internal SD card to an external unit.
@ -354,7 +431,7 @@ You'll find all of these in the [openHABian Configuration Tool](#openhabian-conf
- Tellstick core
## Troubleshooting
If you're having problems to get openHABian to install properly, check out the [debug guide](https://github.com/openhab/openhabian/blob/master/docs/openhabian-DEBUG.md). It's also available on your system as [/opt/openhabian/docs/openhabian-DEBUG.md](openhabian-DEBUG.md).
If you're having problems to get openHABian to install properly, check out the [debug guide](openhabian-DEBUG.md). It's also available on your system as `/opt/openhabian/docs/openhabian-DEBUG.md`.
Do not hesitate to ask for help on the [openHABian community forum](https://community.openhab.org/) when the debug guide doesn't help.
Remember to [mind the rules](https://community.openhab.org/t/how-to-ask-a-good-question-help-us-help-you/58396) please.
@ -365,7 +442,7 @@ If you want to get involved, you found a bug, or just want to see what's planned
<a id="changelog"></a>
### Where can I find a changelog for openHABian?
Official announcements are co-located with the download links [here](https://github.com/openhab/openhabian/releases).
If you want to stay in touch with all the latest code changes under the hood, see the [commit history](https://github.com/openhab/openhabian/commits/master) for openHABian.
If you want to stay in touch with all the latest code changes under the hood, see [commit history](https://github.com/openhab/openhabian/commits/master) for openHABian.
You'll also see commits "fly by" when executing the "Update" function within the openHABian Configuration Tool.
<a id="successful"></a>
@ -377,7 +454,8 @@ Watch the progress on the console or the web interface at https://<yourip>/ or <
Double-check the IP address and name with your router while you wait.
If there is absolutely no output for more than 10 minutes, your installation has failed in the first initialization phase. There probably is a problem
with the way your router or local network are setup.
Read on in the [Troubleshooting](#Troubleshooting) section or move on to the [DEBUG guide](https://github.com/openhab/openhabian/blob/master/docs/openhabian-DEBUG.md).
Read on in the [Troubleshooting](#troubleshooting) section or move on to the [DEBUG guide](openhabian-DEBUG.md).
You can set `debugmode=on` (or even = `maximum`) right on first install, too, to get to see what openHABian is doing.
After a few minutes of boot up time, you can [connect to the SSH console](https://www.raspberrypi.org/documentation/remote-access/ssh/windows.md) of your device.
During the setup process you'll be redirected to the live progress report of the setup (you can Ctrl-C to get into the shell).
@ -415,7 +493,7 @@ You can migrate between versions by selecting the corresponding 4X menu option.
If you want to choose from stable, snapshot or milestone releases, please do so via `openhabian-config` tool (also menu 4X).
Note this will **not** result in any openHABian branch change.
Switching from stable to newer development releases might introduce changes and incompatibilities, so please be sure to make a full openHAB backup first!
Check the Linux installation article for all needed details: [Linux: Changing Versions](https://www.openhab.org/docs/installation/linux.html#changing-versions)
Check the Linux installation article for all needed details: [Linux: Changing Versions](linux.html#changing-versions)
<a id="headache"></a>
#### Where is the graphical user interface?
@ -429,19 +507,15 @@ Its intended use case is to sit in a corner and provide a service reliably 24 ho
You already own a **powerful PC or Mac** to work on.
It would be a shame to have a powerful computer at your fingertips and then have to **restrict yourself** to a very limited graphical frontend on another device, wouldn't you agree?
Moving on.
What we actually want openHABian to be is a **dedicated headless system** to **reliably execute openHAB** and to **expose all interfaces** needed to interact and configure it (PaperUI, BasicUI, HABPanel, openHAB LogViewer, Samba Network Shares, openHABian Configuration Tool, SSH, you-name-it).
What we actually want openHABian to be is a **dedicated, headless system** to **reliably run openHAB** and to **expose all interfaces** needed to interact and configure it (MainUI, HABPanel, openHAB LogViewer, Samba Network Shares, openHABian Configuration Tool, SSH, you-name-it).
If you know how to work with these interfaces, you are set for a way better experience than the alternatives.
The main challenge is to **get used to the Linux command line**, not even a GUI (like Pixel, see below) will relieve you from that in the long run.
If you are not willing to teach yourself a few fundamental Linux skills you will not become happy with any Linux system and should resort to a e.g. Windows machine.
However as you are willing to tinker with smart home technology, I'm sure you are ready to **teach yourself new stuff** and expand your experience.
**If** the above didn't convince you, execute the following commands to get the graphical user interface [Pixel](https://www.raspberrypi.org/blog/introducing-pixel) installed.
You have been warned, if there came any warranty with openHABian to begin with, it would end here.
<a id="faq-other-platforms"></a>
#### Can I use openHABian on ...?
See the [README](https://github.com/openhab/openhabian/blob/master/README.md) for a list of supported HW and OS.
See the [README](https://github.com/openhab/openhabian/blob/master/README.md#hardware-and-os-support) for a list of supported HW and OS.
openHABian is developed for Debian based systems.
If your operating system is based on these or if your hardware supports one, your chances are high openHABian can be used.
Check out the [Manual Setup](#manual-setup) instructions for guidance and consult the [debug guide](openhabian-DEBUG.md) if you run into problems.