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

pull/1689/head
openHAB Build Server 2021-01-10 14:40:01 +00:00
parent 8c87654963
commit a59ba31d97
14 changed files with 884 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -810,7 +810,7 @@ Enable/disable the LED blinking.
0 = Enable LED blinking.
1 = Disable LED blinking only when the PIR is triggered.
2 = Completely disable LED for motion, wakeup, and sensor report.  
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 |
|--------|-------------|
@ -968,7 +968,7 @@ This parameter has the configuration ID ```config_201_2``` and is of type ```INT
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 1 to 2 -:
| Value | Description |
|--------|-------------|
@ -1043,7 +1043,7 @@ This parameter has the configuration ID ```config_204_1``` and is of type ```INT
Disable/Enable Configuration Lock (0=Disable, 1=Enable)
Enable/disable Configuration Locked (0 =disable, 1 = enable).
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 |
|--------|-------------|

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

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

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

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

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

@ -164,14 +164,13 @@ The ```time_offset``` channel is of type ```time_offset``` and supports the ```N
## Device Configuration
The following table provides a summary of the 14 configuration parameters available in the FGSD002.
The following table provides a summary of the 13 configuration parameters available in the FGSD002.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Smoke Sensor sensitivity | There are 3 levels of sensitivity to smoke presence. |
| 2 | Z-Wave notifications status | This parameter allows to activate excess temperature ... |
| 2 | Z-Wave notifications status | This parameter allows to activate excess temperature ... |
| 3 | Visual indicator notifications status | This parameter allows to activate visual indications |
| 4 | Sound notifications status | This parameter allows to activate sound signals... |
| 10 | Config of control frames in BASIC command class | This parameter defines which frames will be sent ... |
@ -221,17 +220,6 @@ The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 2: Z-Wave notifications status
This parameter allows to activate excess temperature ...
...  and/or enclosure opening notifications sent to the main controller
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Visual indicator notifications status
This parameter allows to activate visual indications

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

@ -152,14 +152,13 @@ This channel provides the battery level as a percentage and also reflects the lo
## Device Configuration
The following table provides a summary of the 15 configuration parameters available in the FGSD002.
The following table provides a summary of the 14 configuration parameters available in the FGSD002.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Smoke Sensor sensitivity | There are 3 levels of sensitivity to smoke presence. |
| 2 | Z-Wave notifications status | This parameter allows to activate excess temperature ... |
| 2 | Z-Wave notifications status | This parameter allows to activate excess temperature ... |
| 3 | Visual indicator notifications status | This parameter allows to activate visual indications |
| 4 | Sound notifications status | This parameter allows to activate sound signals... |
| 10 | Config of control frames in BASIC command class | This parameter defines which frames will be sent ... |
@ -210,17 +209,6 @@ The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 2: Z-Wave notifications status
This parameter allows to activate excess temperature ...
...  and/or enclosure opening notifications sent to the main controller
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Visual indicator notifications status
This parameter allows to activate visual indications

6
_addons_bindings/zwave/doc/ge/zw4006_0_0.md
View File

@ -29,6 +29,10 @@ The switch enables wireless control of On/OFF functions of incandescent, LED, xe
1. Follow the instructions for your Z-Wave certified controller to exclude a device from the Z-Wave network.
2. Once the controller is ready to exclude your device, press and release the top or bottom button on the smart switch to exclude it from the network. 
### General Usage Information
## Channels
The following table summarises the channels available for the 26931/ZW4006 -:
@ -158,7 +162,7 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG
Change brightness of associated light bulb(s)
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 |
|--------|-------------|

10
_addons_bindings/zwave/doc/logic/zdb5100_0_0.md
View File

@ -922,7 +922,7 @@ Multi-Level Switch Set values for pushbutton 1
</td>
</tr>
</table>
Values in the range 0 to 33514240 may be set.
Values in the range 0 to 4294967295 may be set.
The manufacturer defined default value is ```33488896```.
@ -1176,9 +1176,9 @@ This parameter specifies the saturation levels for the red, green and blue LEDs,
</td>
</tr>
</table>
Values in the range 0 to 65535 may be set.
Values in the range 0 to 4294967295 may be set.
The manufacturer defined default value is ```0```.
The manufacturer defined default value is ```791621376```.
This parameter has the configuration ID ```config_23_4``` and is of type ```INTEGER```.
@ -1327,9 +1327,9 @@ Multi-Level Switch Set values for pushbutton 2.
</td>
</tr>
</table>
Values in the range 0 to 65535 may be set.
Values in the range 0 to 4294967295 may be set.
The manufacturer defined default value is ```0```.
The manufacturer defined default value is ```33488896```.
This parameter has the configuration ID ```config_26_4``` and is of type ```INTEGER```.

4
_addons_bindings/zwave/doc/nice/ibt4_0_0.md
View File

@ -123,8 +123,8 @@ Association group 1 supports 1 node.
### Documentation Links
* [Manual](https://opensmarthouse.org/zwavedatabase/1320/reference/IBT4ZWAVE-EN.pdf)
* [Tech Manual](https://opensmarthouse.org/zwavedatabase/1320/reference/IBT4ZWAVE-T-v0.7.pdf)
* [Manual](https://opensmarthouse.org/zwavedatabase/1320/reference/IBT4ZWAVE-EN_Manual.pdf)
* [Specs](https://opensmarthouse.org/zwavedatabase/1320/reference/IBT4ZWAVE-EN_SPECS.pdf)
---

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

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

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

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

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

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

301
_addons_bindings/zwave/doc/yale/yrl216_1_78.md Normal file
View File

@ -0,0 +1,301 @@
---
layout: documentation
title: YRL216 - ZWave
---
{% include base.html %}
# YRL216 Yale Smart Door Lock YRL216 with Z-Wave Module
This describes the Z-Wave device *YRL216*, manufactured by *ASSA ABLOY* with the thing type UID of ```yale_yrl216_01_078```.
This version of the device is limited to firmware versions above 1.78
The device is in the category of *Lock*, defining Devices whose primary pupose is locking something.
![YRL216 product image](https://opensmarthouse.org/zwavedatabase/1338/image/)
The YRL216 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.
## Overview
Adds Z-Wave functionality for Yale YRL216 and YRL236 locks.
### Inclusion Information
• Enter the 4-8 digit Master PIN code followed by the # key.
• Press the 7 key followed by the # key.
• Press the 1 key followed by the # key.
### Exclusion Information
• Enter the 4-8 digit Master PIN code followed by the # key.
• Press the 7 key followed by the # key.
• Press the 3 key followed by the # key.
### General Usage Information
## Channels
The following table summarises the channels available for the YRL216 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Door Lock | lock_door | lock_door | Door | Switch |
| Alarm (power) | alarm_power | alarm_power | Energy | Switch |
| Alarm (access) | alarm_access | alarm_access | Door | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Clock Time Offset | time_offset | time_offset | Time | Number |
### Door Lock
Lock and unlock the door.
The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category.
The following state translation is provided for this channel to the ```Switch``` item type -:
| Value | Label |
|-------|-----------|
| ON | Locked |
| OFF | Unlocked |
### Alarm (power)
Indicates if a power alarm is triggered.
The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
The following state translation is provided for this channel to the ```Switch``` item type -:
| Value | Label |
|-------|-----------|
| OFF | OK |
| ON | Alarm |
### Alarm (access)
Indicates if the access control alarm is triggered.
The ```alarm_access``` channel is of type ```alarm_access``` and supports the ```Switch``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device.
The following state translation is provided for this channel to the ```Switch``` item type -:
| Value | Label |
|-------|-----------|
| OFF | OK |
| ON | Alarm |
### 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%.
### Clock Time Offset
Provides the current time difference for the devices time.
The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Time``` category.
## Device Configuration
The following table provides a summary of the 9 configuration parameters available in the YRL216.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Silent Mode on/off | Changes speaker settings |
| 2 | Auto Relock on/off | Turn on/off auto re-lock function |
| 3 | Auto Relock Time | Set time after unlock to trigger auto relock function |
| 4 | Wrong Code Entry Limit | Set number of unsuccessful attempts before shutdown |
| 7 | Shut Down Time | Set time to shutdown unit after Wrong Code Entry Limit exceeded |
| 8 | Operating Mode | Set Normal or Vacation Mode |
| 11 | One Touch Locking | Turn on/off one touch locking feature |
| 13 | Lock Status LED | Turn on/off lock status LED |
| 15 | Reset to factory defaults | Reset to Factory Defaults |
| | Lock Timeout | Sets the time after which the door will auto lock |
### Parameter 1: Silent Mode on/off
Changes speaker settings
1. Sound Enable
3. Sound Disable
The following option values may be configured, in addition to values in the range 1 to 3 -:
| Value | Description |
|--------|-------------|
| 1 | Sound Enable |
| 3 | Sound Disable |
The manufacturer defined default value is ```1``` ( Sound Enable).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Auto Relock on/off
Turn on/off auto re-lock function
The following option values may be configured, in addition to values in the range 0 to 255 -:
| Value | Description |
|--------|-------------|
| 0 | Auto Relock Off |
| 255 | Auto Relock On |
The manufacturer defined default value is ```0``` (Auto Relock Off).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Auto Relock Time
Set time after unlock to trigger auto relock function
Values in the range 10 to 180 may be set.
The manufacturer defined default value is ```30```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Wrong Code Entry Limit
Set number of unsuccessful attempts before shutdown
After (**Wrong Code Entry Limit**) unsuccessful attempts at entering a valid PIN code, the unit will shut down and not allow operation for (**Shut Down Time**) seconds.
Values in the range 3 to 10 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 7: Shut Down Time
Set time to shutdown unit after Wrong Code Entry Limit exceeded
The unit will shutdown (flashing RED) for (**Shutdown Time**) seconds and not allow operation after the (**Wrong Code Entry L****imit**) has been met.
Values in the range 10 to 180 may be set.
The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Operating Mode
Set Normal or Vacation Mode
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Normal Mode (Default) |
| 1 | Vacation Mode (Keypad Locked Out) |
The manufacturer defined default value is ```0``` (Normal Mode (Default)).
This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```.
### Parameter 11: One Touch Locking
Turn on/off one touch locking feature
When the latch is retracted, activating the keypad will extend the latch (during Automatic Re-lock duration or when Automatic Re-lock is disabled). When One-Touch Re-lock is not in use (disabled), any valid PIN code will re-lock the lock.
The following option values may be configured, in addition to values in the range 0 to 255 -:
| Value | Description |
|--------|-------------|
| 0 | One Touch Locking Off |
| 255 | One Touch Locking On |
The manufacturer defined default value is ```255``` (One Touch Locking On).
This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```.
### Parameter 13: Lock Status LED
Turn on/off lock status LED
Located on the interior escutcheon. Shows active status (Locked) of lock and can be enabled or disabled with this parameter.
The following option values may be configured, in addition to values in the range 0 to 255 -:
| Value | Description |
|--------|-------------|
| 0 | LED Off |
| 255 | LED On |
The manufacturer defined default value is ```0``` (LED Off).
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 15: Reset to factory defaults
Reset to Factory Defaults
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```.
### Lock Timeout
Sets the time after which the door will auto lock.
This parameter has the configuration ID ```doorlock_timeout``` 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 YRL216 supports 1 association group.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Association group 1 supports 1 node.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_DOOR_LOCK_LOGGING_V1| |
| COMMAND_CLASS_SCHEDULE_ENTRY_LOCK_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_DOOR_LOCK_V1| |
| COMMAND_CLASS_USER_CODE_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V4| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_TIME_V1| |
| COMMAND_CLASS_TIME_PARAMETERS_V1| |
| COMMAND_CLASS_SECURITY_V1| |
### Documentation Links
* [YRL216_236 Manual](https://opensmarthouse.org/zwavedatabase/1338/reference/Assure_Lever_Manual_ZWave_Cert.pdf)
* [YRL216_226_236_256 Manual](https://opensmarthouse.org/zwavedatabase/1338/reference/YRL216_226_236_256_YaleRealLivingAssureLever_Z-WavePlus_SystemIntegrator..__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/1338).

8
_addons_bindings/zwave/doc/zooz/zen25_2_0.md
View File

@ -247,12 +247,8 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG
### Parameter 2: Wattage Threshold
Power Wattage Report Value Threshold
Choose how you want your Double Plug to report power consumption to your hub. The number entered as value corresponds to the number of Watts the appliance needs to go over for the change to be reported. So if 5 Watts are entered by default, the Double Plug will report any change in power usage over 5 Watts for each outlet (whether it’s at least 5 Watts more or 5 Watts less compared to previous report).
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
Choose how you want your Double Plug to report power consumption to your hub. The number entered as value corresponds to the number of Watts the appliance needs to go over for the change to be reported. So if 5 Watts are entered by default, the Double Plug will report any change in power usage over 5 Watts for each outlet (whether it’s at least 5 Watts more or 5 Watts less compared to previous report). 0 = Disable.
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is ```10```.

63
installation/openhabian.md
View File

@ -9,7 +9,7 @@ source: https://github.com/openhab/openhabian/blob/master/docs/openhabian.md
<!-- 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).
Jump to [install instructions](#raspberry-pi-prepackaged-sd-card-image). But read the full docs before you ask for help !
:::
# openHABian - Hassle-free openHAB Setup
@ -19,14 +19,13 @@ However, setting up a fully working Linux system with all recommended packages a
<p style="text-align: center; font-size: 1.2em; font-style: italic;"><q>A home automation enthusiast doesn't have to be a Linux enthusiast!</q></p>
openHABian aims to provide a **self-configuring** Linux system setup specific to the needs of every openHAB user.
To that end, the project provides two things:
It provides:
* Complete **SD-card images pre-configured with openHAB** and many other openHAB- and Hardware-specific preparations for the Raspberry Pi
* The openHABian Configuration Tool to set up and configure openHAB and many related things on any Debian based system
* complete **SD-card images pre-configured with openHAB** for the Raspberry Pi line of SBCs
* The openHABian configuration tool to set up and configure openHAB and many related things on any Debian based system
#### Table of Contents
{::options toc_levels="2..3"/}
- TOC
{:toc}
@ -69,11 +68,12 @@ Let's put this first: our current recommendation is to get a RPi 4 with 2 or 4 G
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).
***
ATTENTION:<br>
::: warning ATTENTION
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,
@ -97,7 +97,7 @@ 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
not, 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.
@ -176,10 +176,11 @@ You will see the following welcome screen:
<a id="manual-setup"></a>
### Other Linux Systems (add openHABian just like any other software)
Going beyond what the RPi image provides, we support running openHABian on x86 hardware on top of any existing
Debian installation.
Going beyond what the RPi image provides, you can also openHABian on x86 hardware on top of any existing Debian installation.
Please note that the unattended install is tailored to work for Raspberries. We cannot test HW/OS combos beyond RPis upfront so there is no promise for this work.
See the [Hardware and OS section](#hardware-and-os-support) for details on supported hardware and OSs before you proceed.
Note that although the core parts of openHABian were reported to work on there, Ubuntu is not supported and untested.
See the [README](https://github.com/openhab/openhabian#hardware-and-os-support) for details on supported hardware and OSs before you proceed.
If you try and fail, please help and drop us a note on Github with debug log enabled, see [DEBUG guide](openhabian-DEBUG.md).
***
Start with a fresh installation of your operating system, login and run
@ -201,31 +202,25 @@ git clone -b openHAB3 https://github.com/openhab/openhabian.git /opt/openhabian
ln -s /opt/openhabian/openhabian-setup.sh /usr/local/bin/openhabian-config
cp /opt/openhabian/openhabian.conf.dist /etc/openhabian.conf
```
#### Interactive Install on generic Linux
Start `openhabian-config` to get into the openHABian configuration tool.
➜ Continue at the ["openHABian Configuration Tool"](#openhabian-configuration-tool) chapter below!
#### Unattended Install on generic Linux
BEWARE:<br>
This install method is only for experts that already know to handle and debug openHABian.
As a beginner, use the interactive `openhabian-config` tool !
That being said, you actually _can_ install openHABian in an unattended mode.
To do so, edit `/etc/openhabian.conf` to match your needs, then use
Edit `/etc/openhabian.conf` to match your needs, then finally use
```shell
openhabian-config unattended
```
to install.
to get the automated openHABian installation going.
#### Interactive install on generic x86 Linux
We strongly recommend you to use the automated install but you actually *can* walk through the interactive tool.
Start `openhabian-config`.
Get the bare minimum you will *need* installed by selecting menu option 03.
To install the recommended components that automated install will get in one go select menu options 33, 32, 31, 11, 12, 15, Zulu 11 OpenJDK 64-bit (in menu 4X), 13, 16, 14, 21, 38, 53, 52.
We try to make install options independent of each other but there may be dependencies we are not aware of left so any other order may or may not work.
Please note that we cannot test HW/OS combos beyond RPis upfront so there is no support / no promise for this work as explained in the [README](https://github.com/openhab/openhabian#hardware-and-os-support).
➜ Continue at the ["openHABian Configuration Tool"](#openhabian-configuration-tool) chapter below
## openHABian Configuration Tool
The following instructions are targeted at a Raspberry Pi but should be applicable to all openHABian environments.
Once connected to the command line console of your system, please execute the openHABian configuration tool by typing the following command.
The following instructions are developed for a Raspberry Pi but should be applicable to all hardware / all openHABian environments.
Once connected to the command line console of your system, please execute the openHABian configuration tool by typing the following command:
(Hint: sudo executes a command with elevated rights and will hence ask for your password: `openhabian`).
@ -236,15 +231,13 @@ sudo openhabian-config
![openHABian-config menu](images/openHABian-config.png)
The configuration tool is the heart of openHABian.
It is not only a menu with a set of options, it's also used in a special unattended mode to automate the setup run,
as either part of the RPi image as well as in a manual install.
It is not only a menu with a set of options, it's also used in a special unattended mode to automate the setup run, either as part of the RPi image or in a manual install run.
⌨ - A quick note on menu navigation.
Use the cursor keys to navigate, <kbd>Enter</kbd> to execute, <kbd>Space</kbd> to select and <kbd>Tab</kbd> to jump to the actions on the bottom of the screen. Press <kbd>Esc</kbd> twice to exit the configuration tool.
### Linux Hints
If you are unfamiliar with Linux, SSH and the Linux console or if you want to improve your skills, read up on these important topics.
A lot of helpful articles can be found on the internet, for example:
Many helpful articles can be found on the internet, for example:
- "Learn the ways of Linux-fu, for free" interactively with exercises at [linuxjourney.com](https://linuxjourney.com).
- The official Raspberry Pi help articles over at [raspberrypi.org](https://www.raspberrypi.org/help)
@ -349,7 +342,7 @@ So in addition to the setup instructions given above, uncomment and complete the
Whenever the WiFi interface wlan0 exists but does not have connectivity, openHABian will launch a **Hotspot**.
When you use your mobile phone to scan for WiFi networks, you should be seeing a new network called `openHABian-<n>`.
Connecting will work without a password. Once connected, open your browser and point it at `http://raspberrypi.local` or `http://comitup-<n>`.
This may or may not work for your mobile browser as it requires Bonjour/ZeroConf abilities. If you cannot connect to this address, go to `http://10.42.0.1`.
This may or may not work for your mobile browser as it requires Bonjour/ZeroConf abilities. If you cannot connect to this address, go to `http://10.41.0.1`.
On that page you can select the SSID of the network you want to connect your system to. Provide the password and press the button.
Note that as soon as you do, the wlan0 IP address changes so your mobile browser will not be able to provide you any feedback if that worked out.
Try to ping the new system's hostname (default is `openHABianDevice`) or check DHCP on your router if your openHABian system appeared there.
@ -413,7 +406,7 @@ Follow the instructions in the previous section and insert a line into `openhabi
#### Fake hardware mode
If to install openHABian fails because you have a non-supported hardware or run an unsupported OS release, you can "fake" your hardware and OS to make openHABian behave as if you did own that HW/OS.
In `openhabian.conf`, uncomment and complete the lines reading `hw=`, `hwarch=` and/or `release=` with the hw and os versions you want to attempt installation with.
In `openhabian.conf`, uncomment and complete the lines reading `hw=`, `hwarch=` and/or `osrelease=` with the hw and os versions you want to attempt installation with.
## Optional Components
openHABian comes with a number of additional routines to quickly install and set up home automation related software.