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

Updated external content (Jenkins build 431)

pull/1265/head
openHAB Build Server 2020-01-13 07:24:36 +00:00
parent a2547cf6c8
commit b583f9acf3
38 changed files with 1493 additions and 436 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_addons_bindings/amazonechocontrol/readme.md
View File

@ -147,8 +147,8 @@ It will be configured at runtime by using the save channel to store the current
| musicProviderId | String | R/W | echo, echoshow, echospot | Current Music provider
| playMusicVoiceCommand | String | W | echo, echoshow, echospot | Write Only! Voice command as text. E.g. 'Yesterday from the Beatles'
| startCommand | String | W | echo, echoshow, echospot | Write Only! Used to start anything. Available options: Weather, Traffic, GoodMorning, SingASong, TellStory, FlashBriefing and FlashBriefing.<FlahshbriefingDeviceID> (Note: The options are case sensitive)
| announcement | String | W | echo, echoshow, echospot | Write Only! Display the announcement message on the display. See in the tutorial section to learn how it’s possible to set the title and turn off the sound.
| textToSpeech | String | W | echo, echoshow, echospot | Write Only! Write some text to this channel and Alexa will speak it. It is possible to use plain text or SSML: e.g. `<speak>I want to tell you a secret.<amazon:effect name="whispered">I am not a real human.</amazon:effect></speak>`
| announcement | String | W | echo, echoshow, echospot | Write Only! Display the announcement message on the display. Please note: the announcement feature must be activated in the alexa app at the echo device. See in the tutorial section to learn how it’s possible to set the title and turn off the sound.
| textToSpeech | String | W | echo, echoshow, echospot | Write Only! Write some text to this channel and Alexa will speak it. It is possible to use plain text or SSML: e.g. `<speak>I want to tell you a secret.<amazon:effect name="whispered">I am not a real human. Please note: the announcement feature must be activated in the alexa app at the echo device to use SSML. </amazon:effect></speak>`
| textToSpeechVolume | Dimmer | R/W | echo, echoshow, echospot | Volume of the textToSpeech channel, if 0 the current volume will be used
| lastVoiceCommand | String | R/W | echo, echoshow, echospot | Last voice command spoken to the device. Writing to the channel starts voice output.
| mediaProgress | Dimmer | R/W | echo, echoshow, echospot | Media progress in percent

32
_addons_bindings/bluetooth.bluez/readme.md
View File

@ -16,9 +16,39 @@ install: manual
This extension supports Bluetooth access via BlueZ on Linux (ARMv6hf).
# Setup
Please note that at least BlueZ 5.43 is required, while 5.48 or above are [not (yet) supported](https://github.com/intel-iot-devkit/tinyb/issues/131) either.
Also note that the OS user needs to be a member of the "bluetooth" group of Linux in order to have the rights to access the BlueZ stack.
Some settings are required to ensure that openHAB has access to Bluez.
To allow openHAB to access Bluez via dbus you need to add the following entry within your dbus configuration in `/etc/dbus-1/system.d/bluetooth.conf`
```xml
<busconfig>
<policy user="root">
...
</policy>
<policy group="bluetooth">
<allow send_destination="org.bluez"/>
</policy>
...
</busconfig>
```
and add openHAB to the "bluetooth" group.
```shell
sudo adduser openhab bluetooth
```
Also, in case you don't want to manually enable your bluetooth adapters with `bluetoothctl`, ensure that it's automatically enabled by setting the option `AutoEnable` in your `/etc/bluetooth/main.conf` to `true`.
Restart running services for changes to take effect.
```
systemctl restart dbus
systemctl restart bluetooth
systemctl restart openhab2
```
## Supported Things

6
_addons_bindings/darksky/readme.md
View File

@ -214,7 +214,7 @@ Number:Speed localCurrentSnowIntensity "Current snow intensity [%.2f mm/h]" <sno
Number:Speed localCurrentPrecipitationIntensity "Current precipitation intensity [%.2f mm/h]" <rain> { channel="darksky:weather-and-forecast:api:local:current#precip-intensity" }
Number:Dimensionless localCurrentPrecipitationProbability "Current precipitation probability [%d %unit%]" <rain> { channel="darksky:weather-and-forecast:api:local:current#precip-probability" }
String localCurrentPrecipitationType "Current precipitation type [%s]" <rain> { channel="darksky:weather-and-forecast:api:local:current#precip-type" }
Number localCurrentUVIndex "Current precipitation probability [%d]" <none> { channel="darksky:weather-and-forecast:api:local:current#uvindex" }
Number localCurrentUVIndex "Current UV index [%d]" <none> { channel="darksky:weather-and-forecast:api:local:current#uvindex" }
Number:ArealDensity localCurrentOzone "Current ozone [%.1f %unit%]" <none> { channel="darksky:weather-and-forecast:api:local:current#ozone" }
DateTime localSunrise "Sunrise [%1$tY-%1$tm-%1$tdT%1$tH:%1$tM:%1$tS]" <sun> { channel="darksky:weather-and-forecast:api:local:current#sunrise" }
DateTime localSunset "Sunset [%1$tY-%1$tm-%1$tdT%1$tH:%1$tM:%1$tS]" <sun> { channel="darksky:weather-and-forecast:api:local:current#sunset" }
@ -308,8 +308,8 @@ sitemap demo label="Dark Sky" {
Image item=localDailyForecastTodayConditionIcon
Text item=localDailyForecastTodayMinTemperature
Text item=localDailyForecastTodayMaxTemperature
Text item=localDailyForecastTodayMinApprentTemperature
Text item=localDailyForecastTodayMaxApprentTemperature
Text item=localDailyForecastTodayMinApparentTemperature
Text item=localDailyForecastTodayMaxApparentTemperature
Text item=localDailyForecastTodayPressure
Text item=localDailyForecastTodayHumidity
Text item=localDailyForecastTodayWindSpeed

281
_addons_bindings/dsmr/readme.md
View File

@ -3,7 +3,7 @@ id: dsmr
label: DSMR
title: DSMR - Bindings
type: binding
description: "The DSMR-binding is targeted towards Dutch and Luxembourger users having a smart meter (Dutch: 'Slimme meter')."
description: "The DSMR-binding is targeted towards Dutch, Belgium and Luxembourger users having a smart meter (Dutch: 'Slimme meter')."
since: 2x
install: auto
---
@ -14,15 +14,19 @@ install: auto
# DSMR Binding
The DSMR-binding is targeted towards Dutch and Luxembourger users having a smart meter (Dutch: 'Slimme meter').
Data of Dutch/Luxembourg smart meters can be obtained via the P1-port.
The DSMR-binding is targeted towards Dutch, Belgium and Luxembourger users having a smart meter (Dutch: 'Slimme meter').
Data of Dutch/Belgium/Luxembourg smart meters can be obtained via the P1-port.
When connecting this port from a serial port the data can be read out.
This binding reads the P1-port of the Dutch Smart Meters that comply to NTA8130, DSMR v2.1, DSMR v2.2, DSMR v3.0, DSMR v4.0, DSMR v4.04, and DSMR 5.0.
This binding reads the P1-port of the Luxembourg’s electricity meter "Smarty" that comply to V1.0.
This binding reads the P1-port of:
* Dutch Smart Meters that comply to NTA8130, DSMR v2.1, DSMR v2.2, DSMR v3.0, DSMR v4.0, DSMR v4.04, and DSMR 5.0.
* Belgium Smart Meters that comply to e-MUCS v1.0.
* Luxembourg’s electricity meter "Smarty" that comply to V1.0.
Although DSMR v4.2 is not an official specification, the binding has support for this version.
If you are not living in the Netherlands/Luxembourg but do want to read a meter please have look at the [SmartMeter Binding](/addons/bindings/smartmeter/).
If you are not living in the Netherlands/Belgium/Luxembourg but do want to read a meter please have look at the [SmartMeter Binding](/addons/bindings/smartmeter/).
Because the Dutch Meter standard is based on the IEC-62056-21 standard it might be desirable to build support for other country metering systems based on that standard in this binding.
## Serial Port Configuration
@ -31,19 +35,23 @@ The P1-port is a serial port. To configure the serial port within openHAB see th
## Supported Things
### dsmrBridge (The Netherlands)
### dsmrBridge (The Netherlands/Belgium)
`dsmrBridge`: This is the device that communicated between the binding (serial) and its internal meters.
You always have to have a 'Dutch Smart Meter'-bridge. The bridge contains the serial port configuration.
You always have to have a 'Dutch/Belgium Smart Meter'-bridge. The bridge contains the serial port configuration.
Specific meters are bound via the bridge to the smart meter. A smart meter consists typically out of minimal 2 meters.
A generic meter and the electricity meter. Each meter is bound to the DSMR protocol the physical meter supports.
For each meter it is possible to set a refresh rate at which the status is updated.
The physical meter might update with a high frequency per second, while it is desired to have only values per minute.
The Belgium e-MUCS protocol is an extension to the DSMR standard.
Belgium meters have `emucs` in the thing name.
Due to it similarities the bridge for Belgium meters is also a dsmrBridge.
### smartyBridge (Luxembourg)
`smartyBridge`: This is the device that communicated between the binding (serial) and its internal meters.
You always have to have a 'Dutch Smart Meter'-bridge. The bridge contains the serial port configuration.
You always have to have a 'Smarty Smart Meter'-bridge. The bridge contains the serial port configuration.
## Discovery
@ -97,6 +105,7 @@ Supported meters:
| DSMR V2 / V3 Device | `device_v2_v3` | -1 | 10 seconds |
| DSMR V4 Device | `device_v4` | -1 | 10 seconds |
| DSMR V5 Device | `device_v5` | -1 | 10 seconds |
| e-MUCS V1.0 Device | `device_emucs_v1_0` | -1 | ? |
| ACE4000 GTMM Mk3 Electricity meter | `electricity_ace4000` | 0 | 10 seconds |
| DSMR V2.1 Electricity meter | `electricity_v2_1` | 0 | 10 seconds |
| DSMR V2.2 Electricity meter | `electricity_v2_2` | 0 | 10 seconds |
@ -105,11 +114,13 @@ Supported meters:
| DSMR V4.0.4 Electricity meter | `electricity_v4_0_4` | 0 | 10 seconds |
| DSMR V4.2 Electricity meter | `electricity_v4_2` | 0 | 10 seconds |
| DSMR V5 Electricity meter | `electricity_v5_0` | 0 | 10 seconds |
| e-MUCS V1.0 Electricity meter | `electricity_emucs_v1_0` | 0 | ? |
| Smarty V1.0 Electricity Meter | `electricity_smarty_v1_0` | 0 | 10 seconds |
| ACE4000 GTMM Mk3 Gas meter | `gas_ace4000` | 3 | 1 hour |
| DSMR V2.1 Gas meter | `gas_v2_1` | 0 | 24 hours |
| DSMR V2.2 Gas meter | `gas_v2_2` | 0 | 24 hours |
| DSMR V3.0 Gas meter | `gas_v3_0` | *note 1* | 1 hour |
| e-MUCS V1.0 Gas meter | `gas_emucs_v1_0` | *note 1* | ? |
| ACE4000 GTMM Mk3 Cooling meter | `cooling_ace4000` | 6 | 1 hour |
| DSMR V2.2 Cooling meter | `cooling_v2_2` | 0 | 1 hour |
| ACE4000 GTMM Mk3 Heating meter | `heating_ace4000` | 4 | 1 hour |
@ -165,131 +176,133 @@ The following channels are supported:
- O channel is supported only if the device has this functionality
| Channel Type ID | Item Type | Description | Ace4000 | DSMR V2.1 | DSMR V2.2 | DSMR V3.0 | DSMR V4.0 | DSMR V4.0.4 | DSMR V4.2 | DSMR V5 | SMARTY V1.0 |
|--------------------------------------------------|--------------------------|------------------------------------------------------------------------|---------|-----------|-----------|-----------|-----------|-------------|-----------|---------|-------------|
| | | **Channels for the generic device** | | | | | | | | | |
| `p1_text_code` | String | Text code from the device | - | Y | Y | Y | Y | Y | Y | - | - |
| `p1_text_string` | String | Text string from the device | - | Y | Y | Y | Y | Y | Y | Y | Y |
| `p1_version_output` | String | Version information (most times this refers to the DSMR specification) | - | - | - | - | Y | Y | Y | Y | Y |
| `p1_timestamp` | DateTime | Timestamp of the last device reading | - | - | - | - | Y | Y | Y | Y | Y |
| | | **Channels for the cooling meter** | | | | | | | | | |
| `cmeter_value_v2` | Number:Energy | The total amount of cooling used in the past period (GJ) | Y | - | Y | - | - | - | - | - | - |
| `cmeter_value_v2_timestamp` | DateTime | Timestamp of the last meter reading | Y | - | Y | - | - | - | - | - | - |
| `cmeter_equipment_identifier_v2_2` | String | Equipment identifier | - | - | Y | - | - | - | - | - | - |
| | | **Channels for the main electricity meter** | | | | | | | | | |
| `emeter_equipment_identifier_v2_x` | String | Electricity Equipment identifier | - | Y | Y | - | - | - | - | - | Y |
| `emeter_equipment_identifier` | String | Electricity Equipment identifier | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_delivery_tariff0` | Number:Energy | Total amount of electricity used for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | Y |
| `emeter_delivery_tariff1` | Number:Energy | Total amount of electricity used for tariff 1 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - |
| `emeter_delivery_tariff2` | Number:Energy | Total amount of electricity used for tariff 2 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - |
| `emeter_production_tariff0` | Number:Energy | Total amount of electricity produced for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | Y |
| `emeter_production_tariff1` | Number:Energy | Total amount of electricity produced for tariff 1 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - |
| `emeter_production_tariff2` | Number:Energy | Total amount of electricity produced for tariff 2 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - |
| `emeter_delivery_tariff0_antifraud` | Number:Energy | Total amount of electricity used for tariff 2 [antifraud] (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff1_antifraud` | Number:Energy | Total amount of electricity used for tariff 1 [antifraud] (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff2_antifraud` | Number:Energy | Total amount of electricity used for tariff 2 [antifraud] (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_total_imported_energy_register_q` | Number:Energy | Total Imported Energy (Q+) (kvarh) | - | - | - | - | - | - | - | - | Y |
| `emeter_total_exported_energy_register_q` | Number:Energy | Total Exported Energy (Q-) (kvarh) | - | - | - | - | - | - | - | - | Y |
| `emeter_tariff_indicator` | String | Current tariff indicator | Y | Y | Y | Y | Y | Y | Y | Y | - |
| `emeter_treshold_a_v2_1` | Number:ElectricCurrent | Actual treshold (A) | - | Y | - | - | - | - | - | - | - |
| `emeter_treshold_a` | Number:ElectricCurrent | Actual treshold (A) | Y | - | Y | Y | - | - | - | - | - |
| `emeter_treshold_kwh` | Number:Power | Actual treshold (kW) | - | - | - | - | Y | Y | - | - | - |
| `emeter_switch_position_v2_1` | Number | Switch position | - | Y | - | - | - | - | - | - | - |
| `emeter_switch_position` | Number | Switch position | Y | - | Y | Y | Y | Y | - | - | Y |
| `emeter_active_import_power` | Number:Power | Aggregate active import power (W) | Y | - | - | - | - | - | - | - | - |
| `emeter_actual_delivery` | Number:Power | Current power delivery (kW) | - | Y | Y | Y | Y | Y | Y | Y | Y |
| `emeter_actual_production` | Number:Power | Current power production (kW) | - | - | - | Y | Y | Y | Y | Y | Y |
| `emeter_actual_reactive_delivery` | Number | Actual Reactive Power Delivery (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_actual_reactive_production` | Number | Actual Reactive Power Production (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_active_threshold_smax` | Number | Active threshold (SMAX) (kVA) | - | - | - | - | - | - | - | - | Y |
| `emeter_power_failures` | Number | Number of power failures | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_long_power_failures` | Number | Number of long power failures | - | - | - | - | Y | Y | Y | Y | - |
| `emeter_power_failure_log_entries` | Number | Number of entries in the power failure log | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_power_failure_log_timestamp[x]` *note 2* | DateTime | Timestamp for entry [x] in the power failure log | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_power_failure_log_duration[x]` *note 2* | Number:Time | Duration for entry [x] the power failure log | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_voltage_sags_l1` | Number | Number of voltage sags L1 | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_voltage_sags_l2` | Number | Number of voltage sags L2 | - | - | - | - | O | O | O | O | O |
| `emeter_voltage_sags_l3` | Number | Number of voltage sags L3 | - | - | - | - | O | O | O | O | O |
| `emeter_voltage_swells_l1` | Number | Number of voltage swells L1 | - | - | - | - | Y | Y | Y | Y | - |
| `emeter_voltage_swells_l2` | Number | Number of voltage swells L2 | - | - | - | - | O | O | O | O | - |
| `emeter_voltage_swells_l3` | Number | Number of voltage swells L3 | - | - | - | - | O | O | O | O | - |
| `emeter_instant_current_l1` | Number:ElectricCurrent | Instant Current L1 (A) | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_instant_current_l2` | Number:ElectricCurrent | Instant Current L2 (A) | - | - | - | - | O | O | O | O | O |
| `emeter_instant_current_l3` | Number:ElectricCurrent | Instant Current L3 (A) | - | - | - | - | O | O | O | O | O |
| `emeter_instant_power_delivery_l1` | Number:Power | Instant Power Delivery L1 (kW) | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_instant_power_delivery_l2` | Number:Power | Instant Power Delivery L2 (kW) | - | - | - | - | O | O | O | O | O |
| `emeter_instant_power_delivery_l3` | Number:Power | Instant Power Delivery L3 (kW) | - | - | - | - | O | O | O | O | O |
| `emeter_instant_power_production_l1` | Number:Power | Instant Power Production L1 (kW) | - | - | - | - | Y | Y | Y | Y | Y |
| `emeter_instant_power_production_l2` | Number:Power | Instant Power Production L2 (kW) | - | - | - | - | O | O | O | O | O |
| `emeter_instant_power_production_l3` | Number:Power | Instant Power Production L3 (kW) | - | - | - | - | O | O | O | O | O |
| `emeter_instant_reactive_power_delivery_l1` | Number:Power | Instant Reactive Power Delivery L1 (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_instant_reactive_power_delivery_l2` | Number:Power | Instant Reactive Power Delivery L2 (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_instant_reactive_power_delivery_l3` | Number:Power | Instant Reactive Power Delivery L3 (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_instant_reactive_power_production_l1` | Number:Power | Instant Reactive Power Prodcution L1 (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_instant_reactive_power_production_l2` | Number:Power | Instant Reactive Power Prodcution L2 (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_instant_reactive_power_production_l3` | Number:Power | Instant Reactive Power Prodcution L3 (kvar) | - | - | - | - | - | - | - | - | Y |
| `emeter_instant_voltage_l1` | Number:ElectricPotential | Instant Voltage L1 (V) | - | - | - | - | - | - | - | Y | - |
| `emeter_instant_voltage_l2` | Number:ElectricPotential | Instant Voltage L2 (V) | - | - | - | - | - | - | - | O | - |
| `emeter_instant_voltage_l3` | Number:ElectricPotential | Instant Voltage L3 (V) | - | - | - | - | - | - | - | O | - |
| | | **Channels for the slave electricity meter** | | | | | | | | | |
| `meter_device_type` | String | Slave Electricity Meter Device Type | - | - | - | - | Y | Y | Y | Y | - |
| `meter_equipment_identifier` | String | Slave Electricity Meter ID | - | - | - | - | Y | Y | Y | Y | - |
| `emeter_delivery_tariff0` | Number:Energy | Total amount of slave electricity used for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff1` | Number:Energy | Total amount of slave electricity used for tariff 1 (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff2` | Number:Energy | Total amount of slave electricity used for tariff 2 (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_production_tariff0` | Number:Energy | Total amount of slave electricity produced for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_production_tariff1` | Number:Energy | Total amount of slave electricity produced for tariff 1 (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_production_tariff2` | Number:Energy | Total amount of slave electricity produced for tariff 2 (kWh) | Y | - | - | - | - | - | - | - | - |
| `emeter_tariff_indicator` | String | Current slave tariff indicator | Y | - | - | - | - | - | - | - | - |
| `emeter_treshold_a` | Number:ElectricCurrent | Actual slave treshold (A) | Y | - | - | - | - | - | - | - | - |
| `meter_switch_position` | Number | Slave electricity switch position | Y | - | - | Y | Y | Y | - | - | - |
| `emeter_active_import_power` | Number:Power | Slave aggregate active import power (W) | Y | - | - | - | - | - | - | - | - |
| `emeter_value` | Number:Energy | Slave electricity usage (kWh) in the past period | - | - | - | - | Y | Y | Y | Y | - |
| `emeter_value_timestamp` | DateTime | Timestamp of the last reading | - | - | - | - | Y | Y | Y | Y | - |
| `meter_device_type` | String | Gas Meter Device Type | - | - | - | Y | - | - | - | - | - |
| `meter_equipment_identifier` | String | Gas Meter ID | Y | - | - | Y | - | - | - | - | - |
| | | **Channels for the gas meter** | | | | | | | | | |
| `gmeter_equipment_identifier_v2` | String | Gas Meter ID | - | Y | Y | - | - | - | - | - | - |
| `gmeter_24h_delivery_v2` | Number:Volume | Gas Delivery past 24 hours | Y | Y | Y | - | - | - | - | - | - |
| `gmeter_24h_delivery_v2_timestamp` | DateTime | Timestamp of the last reading | Y | Y | Y | - | - | - | - | - | - |
| `gmeter_24h_delivery_compensated_v2` | Number:Volume | Gas Delivery past 24 hours (compensated) | - | Y | Y | - | - | - | - | - | - |
| `gmeter_24h_delivery_compensated_v2_timestamp` | DateTime | Timestamp of the last reading | - | Y | Y | - | - | - | - | - | - |
| `gmeter_value_v3` | Number:Volume | Gas Delivery past period | - | - | - | Y | - | - | - | - | - |
| `gmeter_value_v3_timestamp` | DateTime | Timestamp of the last reading | - | - | - | Y | - | - | - | - | - |
| `gmeter_valve_position_v2_1` | Number | Gas Valve position | - | Y | - | - | - | - | - | - | - |
| `gmeter_valve_position_v2_2` | Number | Gas Valve position | Y | - | Y | - | - | - | - | - | - |
| | | **Channels for the generic meter** | | | | | | | | | |
| `meter_valve_switch_position` | Number | Gas Valve position | - | - | - | Y | - | - | - | - | - |
| `meter_device_type` | String | Generic Meter Device Type | - | - | - | Y | - | - | - | - | - |
| `gmeter_equipment_identifier` | String | Generic Meter ID | - | - | - | Y | - | - | - | - | - |
| `genmeter_value_v3` | Number | Delivery past period | - | - | - | Y | - | - | - | - | - |
| `meter_valve_switch_position` | Number | Generic Meter Valve/Switch position | - | - | - | Y | - | - | - | - | - |
| | | **Channels for the GJ meter (Heating or Cooling)** | | | | | | | | | |
| `meter_device_type` | String | GJ Meter Device Type | - | - | - | Y | Y | Y | Y | Y | - |
| `meter_equipment_identifier` | Number | GJ Meter ID | - | - | - | Y | Y | Y | Y | Y | - |
| `gjmeter_value_v3` | Number:Energy | GJ Delivery past period | - | - | - | Y | - | - | - | - | - |
| `gjmeter_value_v3_timestamp` | DateTime | Timestamp of the last reading | - | - | - | Y | - | - | - | - | - |
| `gjmeter_value_v4` | Number:Energy | GJ Delivery past period | - | - | - | - | Y | Y | Y | Y | - |
| `gjmeter_value_v4_timestamp` | DateTime | Timestamp of the last reading | - | - | - | - | Y | Y | Y | Y | - |
| | | **Channels for the heating meter** | | | | | | | | | |
| `meter_valve_switch_position` | Number | GJ Meter Valve position | - | - | - | Y | Y | Y | Y | - | - |
| `meter_equipment_identifier` | String | Heating Meter ID | Y | - | - | - | - | - | - | - | - |
| `hmeter_equipment_identifier_v2_2` | String | Heating Meter ID | - | - | Y | - | - | - | - | - | - |
| `hmeter_value_v2` | Number:Energy | Heating Delivery past period | Y | - | Y | - | - | - | - | - | - |
| `hmeter_value_v2_timestamp` | DateTime | Timestamp of the last reading | Y | - | Y | - | - | - | - | - | - |
| | | **Channels for the m3 meter (Gas or Water)** | | | | | | | | | |
| `meter_device_type` | String | m3 Meter Device Type | - | - | - | - | Y | Y | Y | Y | - |
| `meter_equipment_identifier` | String | m3 Meter ID | - | - | - | - | Y | Y | Y | Y | - |
| `m3meter_value` | Number:Volume | m3 Delivery past period | - | - | - | - | Y | Y | Y | Y | - |
| `meter_valve_switch_position` | Number | m3 Meter Valve position | - | - | - | - | Y | Y | Y | - | - |
| | | **Channels for the water meter** | | | | | | | | | |
| `meter_device_type` | String | Water Meter Device Type | - | - | - | Y | - | - | - | - | - |
| `meter_equipment_identifier` | String | Water Meter ID | Y | - | - | Y | - | - | - | - | - |
| `wmeter_equipment_identifier_v2_2` | String | Water Meter ID | - | - | Y | - | - | - | - | - | - |
| `wmeter_value_v2` | Number:Volume | Water Delivery past period | Y | - | Y | - | - | - | - | - | - |
| `wmeter_value_v2_timestamp` | DateTime | Timestamp of the last reading | Y | - | Y | - | - | - | - | - | - |
| `wmeter_value_v3` | Number:Volume | Water Delivery past period | - | - | - | Y | - | - | - | - | - |
| `meter_valve_switch_position` | Number | Water Meter Valve position | - | - | - | Y | - | - | - | - | - |
| Channel Type ID | Item Type | Description | Ace4000 | DSMR V2.1 | DSMR V2.2 | DSMR V3.0 | DSMR V4.0 | DSMR V4.0.4 | DSMR V4.2 | DSMR V5 |SMARTY V1.0 | e-MUCS V1.0 |
|--------------------------------------------------|--------------------------|------------------------------------------------------------------------|---------|-----------|-----------|-----------|-----------|-------------|-----------|---------|-------------|-------------|
| | | **Channels for the generic device** | | | | | | | | | | |
| `p1_text_code` | String | Text code from the device | - | Y | Y | Y | Y | Y | Y | - | - | - |
| `p1_text_string` | String | Text string from the device | - | Y | Y | Y | Y | Y | Y | Y | Y | Y |
| `p1_version_output` | String | Version information (most times this refers to the DSMR specification) | - | - | - | - | Y | Y | Y | Y | Y | - |
| `p1_emucs_version_output` | String | e-MUCS version information | - | - | - | - | - | - | - | - | Y | y |
| `p1_timestamp` | DateTime | Timestamp of the last device reading | - | - | - | - | Y | Y | Y | Y | Y | Y |
| | | **Channels for the cooling meter** | | | | | | | | | | |
| `cmeter_value_v2` | Number:Energy | The total amount of cooling used in the past period (GJ) | Y | - | Y | - | - | - | - | - | - | - |
| `cmeter_value_v2_timestamp` | DateTime | Timestamp of the last meter reading | Y | - | Y | - | - | - | - | - | - | - |
| `cmeter_equipment_identifier_v2_2` | String | Equipment identifier | - | - | Y | - | - | - | - | - | - | - |
| | | **Channels for the main electricity meter** | | | | | | | | | | |
| `emeter_equipment_identifier_v2_x` | String | Electricity Equipment identifier | - | Y | Y | - | - | - | - | - | Y | - |
| `emeter_equipment_identifier` | String | Electricity Equipment identifier | - | - | - | Y | Y | Y | Y | Y | - | Y |
| `emeter_delivery_tariff0` | Number:Energy | Total amount of electricity used for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | Y | - |
| `emeter_delivery_tariff1` | Number:Energy | Total amount of electricity used for tariff 1 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - | Y |
| `emeter_delivery_tariff2` | Number:Energy | Total amount of electricity used for tariff 2 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - | Y |
| `emeter_production_tariff0` | Number:Energy | Total amount of electricity produced for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | Y | - |
| `emeter_production_tariff1` | Number:Energy | Total amount of electricity produced for tariff 1 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - | Y |
| `emeter_production_tariff2` | Number:Energy | Total amount of electricity produced for tariff 2 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y | - | Y |
| `emeter_delivery_tariff0_antifraud` | Number:Energy | Total amount of electricity used for tariff 2 [antifraud] (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff1_antifraud` | Number:Energy | Total amount of electricity used for tariff 1 [antifraud] (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff2_antifraud` | Number:Energy | Total amount of electricity used for tariff 2 [antifraud] (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_total_imported_energy_register_q` | Number:Energy | Total Imported Energy (Q+) (kvarh) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_total_exported_energy_register_q` | Number:Energy | Total Exported Energy (Q-) (kvarh) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_tariff_indicator` | String | Current tariff indicator | Y | Y | Y | Y | Y | Y | Y | Y | - | Y |
| `emeter_treshold_a_v2_1` | Number:ElectricCurrent | Actual treshold (A) | - | Y | - | - | - | - | - | - | - | - |
| `emeter_treshold_a` | Number:ElectricCurrent | Actual treshold (A) | Y | - | Y | Y | - | - | - | - | - | - |
| `emeter_treshold_kwh` | Number:Power | Actual treshold (kW) | - | - | - | - | Y | Y | - | - | - | Y |
| `emeter_switch_position_v2_1` | Number | Switch position | - | Y | - | - | - | - | - | - | - | - |
| `emeter_switch_position` | Number | Switch position | Y | - | Y | Y | Y | Y | - | - | Y | Y |
| `emeter_active_import_power` | Number:Power | Aggregate active import power (W) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_actual_delivery` | Number:Power | Current power delivery (kW) | - | Y | Y | Y | Y | Y | Y | Y | Y | Y |
| `emeter_actual_production` | Number:Power | Current power production (kW) | - | - | - | Y | Y | Y | Y | Y | Y | Y |
| `emeter_actual_reactive_delivery` | Number | Actual Reactive Power Delivery (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_actual_reactive_production` | Number | Actual Reactive Power Production (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_active_threshold_smax` | Number | Active threshold (SMAX) (kVA) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_power_failures` | Number | Number of power failures | - | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_long_power_failures` | Number | Number of long power failures | - | - | - | - | Y | Y | Y | Y | - | - |
| `emeter_power_failure_log_entries` | Number | Number of entries in the power failure log | - | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_power_failure_log_timestamp[x]` *note 2* | DateTime | Timestamp for entry [x] in the power failure log | - | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_power_failure_log_duration[x]` *note 2* | Number:Time | Duration for entry [x] the power failure log | - | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_voltage_sags_l1` | Number | Number of voltage sags L1 | - | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_voltage_sags_l2` | Number | Number of voltage sags L2 | - | - | - | - | O | O | O | O | O | - |
| `emeter_voltage_sags_l3` | Number | Number of voltage sags L3 | - | - | - | - | O | O | O | O | O | - |
| `emeter_voltage_swells_l1` | Number | Number of voltage swells L1 | - | - | - | - | Y | Y | Y | Y | - | - |
| `emeter_voltage_swells_l2` | Number | Number of voltage swells L2 | - | - | - | - | O | O | O | O | - | - |
| `emeter_voltage_swells_l3` | Number | Number of voltage swells L3 | - | - | - | - | O | O | O | O | - | - |
| `emeter_instant_current_l1` | Number:ElectricCurrent | Instant Current L1 (A) | - | - | - | - | Y | Y | Y | Y | Y | Y |
| `emeter_instant_current_l2` | Number:ElectricCurrent | Instant Current L2 (A) | - | - | - | - | O | O | O | O | O | Y |
| `emeter_instant_current_l3` | Number:ElectricCurrent | Instant Current L3 (A) | - | - | - | - | O | O | O | O | O | Y |
| `emeter_instant_power_delivery_l1` | Number:Power | Instant Power Delivery L1 (kW) | - | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_instant_power_delivery_l2` | Number:Power | Instant Power Delivery L2 (kW) | - | - | - | - | O | O | O | O | O | - |
| `emeter_instant_power_delivery_l3` | Number:Power | Instant Power Delivery L3 (kW) | - | - | - | - | O | O | O | O | O | - |
| `emeter_instant_power_production_l1` | Number:Power | Instant Power Production L1 (kW) | - | - | - | - | Y | Y | Y | Y | Y | - |
| `emeter_instant_power_production_l2` | Number:Power | Instant Power Production L2 (kW) | - | - | - | - | O | O | O | O | O | - |
| `emeter_instant_power_production_l3` | Number:Power | Instant Power Production L3 (kW) | - | - | - | - | O | O | O | O | O | - |
| `emeter_instant_reactive_power_delivery_l1` | Number:Power | Instant Reactive Power Delivery L1 (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_instant_reactive_power_delivery_l2` | Number:Power | Instant Reactive Power Delivery L2 (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_instant_reactive_power_delivery_l3` | Number:Power | Instant Reactive Power Delivery L3 (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_instant_reactive_power_production_l1` | Number:Power | Instant Reactive Power Prodcution L1 (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_instant_reactive_power_production_l2` | Number:Power | Instant Reactive Power Prodcution L2 (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_instant_reactive_power_production_l3` | Number:Power | Instant Reactive Power Prodcution L3 (kvar) | - | - | - | - | - | - | - | - | Y | - |
| `emeter_instant_voltage_l1` | Number:ElectricPotential | Instant Voltage L1 (V) | - | - | - | - | - | - | - | Y | - | Y |
| `emeter_instant_voltage_l2` | Number:ElectricPotential | Instant Voltage L2 (V) | - | - | - | - | - | - | - | O | - | Y |
| `emeter_instant_voltage_l3` | Number:ElectricPotential | Instant Voltage L3 (V) | - | - | - | - | - | - | - | O | - | Y |
| | | **Channels for the slave electricity meter** | | | | | | | | | | |
| `meter_device_type` | String | Slave Electricity Meter Device Type | - | - | - | - | Y | Y | Y | Y | - | - |
| `meter_equipment_identifier` | String | Slave Electricity Meter ID | - | - | - | - | Y | Y | Y | Y | - | - |
| `emeter_delivery_tariff0` | Number:Energy | Total amount of slave electricity used for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff1` | Number:Energy | Total amount of slave electricity used for tariff 1 (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_delivery_tariff2` | Number:Energy | Total amount of slave electricity used for tariff 2 (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_production_tariff0` | Number:Energy | Total amount of slave electricity produced for tariff 0 (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_production_tariff1` | Number:Energy | Total amount of slave electricity produced for tariff 1 (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_production_tariff2` | Number:Energy | Total amount of slave electricity produced for tariff 2 (kWh) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_tariff_indicator` | String | Current slave tariff indicator | Y | - | - | - | - | - | - | - | - | - |
| `emeter_treshold_a` | Number:ElectricCurrent | Actual slave treshold (A) | Y | - | - | - | - | - | - | - | - | - |
| `meter_switch_position` | Number | Slave electricity switch position | Y | - | - | Y | Y | Y | - | - | - | - |
| `emeter_active_import_power` | Number:Power | Slave aggregate active import power (W) | Y | - | - | - | - | - | - | - | - | - |
| `emeter_value` | Number:Energy | Slave electricity usage (kWh) in the past period | - | - | - | - | Y | Y | Y | Y | - | - |
| `emeter_value_timestamp` | DateTime | Timestamp of the last reading | - | - | - | - | Y | Y | Y | Y | - | - |
| | | **Channels for the gas meter** | | | | | | | | | | |
| `meter_device_type` | String | Gas Meter Device Type | - | - | - | Y | - | - | - | - | - | Y |
| `meter_equipment_identifier` | String | Gas Meter ID | Y | - | - | Y | - | - | - | - | - | Y |
| `gmeter_equipment_identifier_v2` | String | Gas Meter ID | - | Y | Y | - | - | - | - | - | - | - |
| `gmeter_24h_delivery_v2` | Number:Volume | Gas Delivery past 24 hours | Y | Y | Y | - | - | - | - | - | - | - |
| `gmeter_24h_delivery_v2_timestamp` | DateTime | Timestamp of the last reading | Y | Y | Y | - | - | - | - | - | - | - |
| `gmeter_24h_delivery_compensated_v2` | Number:Volume | Gas Delivery past 24 hours (compensated) | - | Y | Y | - | - | - | - | - | - | - |
| `gmeter_24h_delivery_compensated_v2_timestamp` | DateTime | Timestamp of the last reading | - | Y | Y | - | - | - | - | - | - | - |
| `gmeter_value_v3` | Number:Volume | Gas Delivery past period | - | - | - | Y | - | - | - | - | - | - |
| `gmeter_value_v3_timestamp` | DateTime | Timestamp of the last reading | - | - | - | Y | - | - | - | - | - | - |
| `gmeter_last_value` | Number:Volume | Gas Delivery last reading value | - | - | - | - | - | - | - | - | - | Y |
| `gmeter_last_value_timestamp` | DateTime | Timesamp of last Gas Delivery reading | - | - | - | - | - | - | - | - | - | Y |
| `gmeter_valve_position_v2_1` | Number | Gas Valve position | - | Y | - | - | - | - | - | - | - | - |
| `gmeter_valve_position_v2_2` | Number | Gas Valve position | Y | - | Y | - | - | - | - | - | - | - |
| `meter_valve_switch_position` | Number | Gas Valve position | - | - | - | Y | - | - | - | - | - | Y |
| | | **Channels for the generic meter** | | | | | | | | | | |
| `meter_device_type` | String | Generic Meter Device Type | - | - | - | Y | - | - | - | - | - | - |
| `gmeter_equipment_identifier` | String | Generic Meter ID | - | - | - | Y | - | - | - | - | - | - |
| `genmeter_value_v3` | Number | Delivery past period | - | - | - | Y | - | - | - | - | - | - |
| `meter_valve_switch_position` | Number | Generic Meter Valve/Switch position | - | - | - | Y | - | - | - | - | - | - |
| | | **Channels for the GJ meter (Heating or Cooling)** | | | | | | | | | | - |
| `meter_device_type` | String | GJ Meter Device Type | - | - | - | Y | Y | Y | Y | Y | - | |
| `meter_equipment_identifier` | Number | GJ Meter ID | - | - | - | Y | Y | Y | Y | Y | - | - |
| `gjmeter_value_v3` | Number:Energy | GJ Delivery past period | - | - | - | Y | - | - | - | - | - | - |
| `gjmeter_value_v3_timestamp` | DateTime | Timestamp of the last reading | - | - | - | Y | - | - | - | - | - | - |
| `gjmeter_value_v4` | Number:Energy | GJ Delivery past period | - | - | - | - | Y | Y | Y | Y | - | - |
| `gjmeter_value_v4_timestamp` | DateTime | Timestamp of the last reading | - | - | - | - | Y | Y | Y | Y | - | - |
| | | **Channels for the heating meter** | | | | | | | | | | |
| `meter_valve_switch_position` | Number | GJ Meter Valve position | - | - | - | Y | Y | Y | Y | - | - | - |
| `meter_equipment_identifier` | String | Heating Meter ID | Y | - | - | - | - | - | - | - | - | - |
| `hmeter_equipment_identifier_v2_2` | String | Heating Meter ID | - | - | Y | - | - | - | - | - | - | - |
| `hmeter_value_v2` | Number:Energy | Heating Delivery past period | Y | - | Y | - | - | - | - | - | - | - |
| `hmeter_value_v2_timestamp` | DateTime | Timestamp of the last reading | Y | - | Y | - | - | - | - | - | - | - |
| | | m3 Meter Device Type | - | - | - | - | Y | Y | Y | Y | - | - |
| `meter_equipment_identifier` | String | m3 Meter ID | - | - | - | - | Y | Y | Y | Y | - | - |
| `m3meter_value` | Number:Volume | m3 Delivery past period | - | - | - | - | Y | Y | Y | Y | - | - |
| `meter_valve_switch_position` | Number | m3 Meter Valve position | - | - | - | - | Y | Y | Y | - | - | - |
| | | **Channels for the water meter** | | | | | | | | | | |
| `meter_device_type` | String | Water Meter Device Type | - | - | - | Y | - | - | - | - | - | - |
| `meter_equipment_identifier` | String | Water Meter ID | Y | - | - | Y | - | - | - | - | - | - |
| `wmeter_equipment_identifier_v2_2` | String | Water Meter ID | - | - | Y | - | - | - | - | - | - | - |
| `wmeter_value_v2` | Number:Volume | Water Delivery past period | Y | - | Y | - | - | - | - | - | - | - |
| `wmeter_value_v2_timestamp` | DateTime | Timestamp of the last reading | Y | - | Y | - | - | - | - | - | - | - |
| `wmeter_value_v3` | Number:Volume | Water Delivery past period | - | - | - | Y | - | - | - | - | - | - |
| `meter_valve_switch_position` | Number | Water Meter Valve position | - | - | - | Y | - | - | - | - | - | - |
*note 2*. The power failure log has a dynamic number of entries starting at `0`.
So `emeter_power_failure_log_timestamp0`, `emeter_power_failure_log_duration0` refers to the first entry,

2
_addons_bindings/fsinternetradio/readme.md
View File

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

23
_addons_bindings/ftpupload/readme.md
View File

@ -16,11 +16,11 @@ install: auto
This binding can be used to receive image files from FTP clients.
The binding acts as a FTP server.
Images stored on the FTP server are not saved to the file system, therefore the binding shouldn't cause any problems on flash based openHAB installations.
Images stored on the FTP server are not saved to the file system, therefore the binding shouldn't cause any problems on flash based openHAB installations if files are uploaded to FTP server continuously (e.g. network camera images).
## Supported Things
This binding supports Things of type ```ftpupload```.
This binding supports Things of type `ftpupload`.
Every Thing is identified by FTP user name.
Therefore, every thing should use unique user name to login FTP server.
@ -37,14 +37,25 @@ The binding has the following configuration options:
| port | TCP Port | TCP port of the FTP server | no | 2121 |
| idleTimeout | Idle timeout | The number of seconds before an inactive client is disconnected. If this value is set to 0, the idle time is disabled. | no | 60 |
## Thing Configuration
The `ftpupload` Thing has the following configuration parameters:
| Parameter | Description | Required | Default value |
|-----------------------------|---------------------------------------------------------------------------------------------------------------------|----------|---------------|
| userName | User name to login to the FTP server. User name is used to identify the Thing, so it should be unique per Thing. | yes | |
| password | Password to login to the FTP server. | yes | |
## Channels
This binding currently supports the following channels:
| Channel Type ID | Item Type | Description |
|-----------------|--------------|----------------------------------------------------------------------------------------|
| image | Image | Image file received via FTP. |
| Channel | Channel Type Id | Item Type | Description |
|-----------------|-----------------|--------------|----------------------------------------------------------------------------------------|
| image | image-channel | Image | Image file received via FTP. |
Additionally user can introduce custom image-channel's to Thing (see examples).
When an image file is uploaded to FTP server, the binding tries to find the channel whose filename matches the uploaded image filename.
If no match is found, no channel is updated.
The filename parameter supports regular expression patterns.
@ -170,7 +181,7 @@ Frame label="Garage network camera" icon="camera" {
## Logging and Problem Solving
For problem solving, if binding logging is not enough, Apache FTP server logging can also be enabled by the following command in the karaf console:
For problem solving, if binding logging is not enough, Apache FTP server logging can also be enabled by the following command in the Karaf console:
```
log:set DEBUG org.apache.ftpserver

1
_addons_bindings/logreader/readme.md
View File

@ -21,6 +21,7 @@ When certain log events are recognized, openHAB rules can be used to send notifi
This binding supports one ThingType: `reader`.
A reader supports 3 separate channels
* One for errors
* one for warnings
* one custom channel for other purposes.

2
_addons_bindings/miele/readme.md
View File

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

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

@ -108,6 +108,7 @@ You can connect this channel to a String item.
* __min__: An optional minimum value.
* __max__: An optional maximum value.
* __step__: For decrease, increase commands the step needs to be known
* __unit__: Unit of measurement (optional). For supported units see [OpenHAB: List of Units](https://www.openhab.org/docs/concepts/units-of-measurement.html#list-of-units). Examples: "°C", "°F"
A decimal value (like 0.2) is send to the MQTT topic if the number has a fractional part.
If you always require an integer, please use the formatter.

12
_addons_bindings/nanoleaf/readme.md
View File

@ -37,7 +37,7 @@ You can set the color for each panel or turn it on (white) or off (black).
## Discovery
A controller (bridge) device is discovered automatically through mDNS in the local network.
Alternatively, you can also provide a things file (see below for more details).
Alternatively, you can also provide the usual files to configure the binding (see [Full Example](#full-example) below for more details).
After the device is discovered and added as a thing, it needs a valid authentication token that must be obtained by pairing it with your openHAB instance.
Without the token the light panels remain in status OFFLINE.
@ -111,6 +111,14 @@ Bridge nanoleaf:controller:MyLightPanels [ address="192.168.1.100", port=16021,
}
```
Note: To generate the `authToken`:
* On the Nanoleaf controller, hold the on-off button for 5-7 seconds until the LED starts flashing.
* Send a POST request to the authorization endpoint within 30 seconds of activating pairing, like this:
`http://<address>:16021/api/v1/new`
e.g. via command line `curl --location --request POST 'http://<address>:16021/api/v1/new'`
### nanoleaf.items
```
@ -127,7 +135,6 @@ Switch NanoleafRhythmState "Rhythm connected [MAP(nanoleaf.map):%s]" { channel="
Switch NanoleafRhythmActive "Rhythm active [MAP(nanoleaf.map):%s]" { channel="nanoleaf:controller:MyLightPanels:rhythmActive" }
Number NanoleafRhythmSource "Rhythm source [%s]" { channel="nanoleaf:controller:MyLightPanels:rhythmMode" }
Color Panel1Color "Panel 1" { channel="nanoleaf:lightpanel:MyLightPanels:135:panelColor" }
Dimmer Panel1Brightness "Panel 1" { channel="nanoleaf:lightpanel:MyLightPanels:135:panelColor" }
Color Panel2Color "Panel 2" { channel="nanoleaf:lightpanel:MyLightPanels:158:panelColor" }
Switch NanoleafRainbowScene "Show Rainbow Scene"
```
@ -154,7 +161,6 @@ sitemap nanoleaf label="Nanoleaf"
Frame label="Panels" {
Colorpicker item=Panel1Color
Slider item=Panel1Brightness
Colorpicker item=Panel2Color
}

13
_addons_bindings/network/readme.md
View File

@ -27,6 +27,7 @@ The binding has the following configuration options:
- **allowDHCPlisten:** If devices leave and reenter a network, they usually request their last IPv4 address by using DHCP requests. By listening for those messages, the status update can be more "real-time" without having to wait for the next refresh cycle. Default is true.
- **arpPingToolPath:** If the arp ping tool is not called `arping` and cannot be found in the PATH environment variable, the absolute path can be configured here. Default is `arping`.
- **cacheDeviceStateTimeInMS:** The result of a device presence detection is cached for a small amount of time. Set this time here in milliseconds. Be aware that no new pings will be issued within this time frame, even if explicitly requested. Default is 2000.
- **preferResponseTimeAsLatency:** If enabled, an attempt will be made to extract the latency from the output of the ping command. If no such latency value is found in the ping command output, the time to execute the ping command is used as fallback latency. If disabled, the time to execute the ping command is always used as latency value. This is disabled by default to be backwards-compatible and to not break statistics and monitoring which existed before this feature.
Create a `<openHAB-conf>/services/network.cfg` file and use the above options like this:
@ -170,6 +171,18 @@ iptables -A PREROUTING -t mangle -p udp ! -s 127.0.0.1 --dport 67 -j TEE --gatew
iptables -A OUTPUT -t nat -p udp -s 127.0.0.1/32 --dport 67 -j DNAT --to 127.0.0.1:6767
```
Above iptables solutions to check *dhcp_state* are not working when OpenHAB is started in Docker. Use another workaround
```shell
iptables -I PREROUTING -t nat -p udp --src 0.0.0.0 --dport 67 -j DNAT --to 0.0.0.0:6767
```
To verify PREROUTING list use below command
```shell
iptables -L -n -t nat
```
## Channels
Things support the following channels:

4
_addons_bindings/nibeheatpump/readme.md
View File

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

5
_addons_bindings/opensprinkler/readme.md
View File

@ -67,7 +67,10 @@ The following channel is supported by the `station` thing.
| | | | used as the time the station will be kept open when |
| | | | switched on. It is advised to add persistence for items |
| | | | linked to this channel, the binding does not persist |
| | | | values of it.
| | | | values of it. |
| queued | Switch | RW | Indicates that the station is queued to be turned on. |
| | | | The channel cannot be turned on, only turning it off is |
| | | | supported (which removes the station from the queue). |
When using the `nextDuration` channel, it is advised to setup persistence (e.g. MapDB) in order to persist the value through restarts.

8
_addons_bindings/rfxcom/readme.md
View File

@ -780,10 +780,10 @@ end
| Brand | What | Action | Command ID | Supported | Source |
|-------|---------------|-------------|------------|-----------|--------|
| Kerui | Motion Sensor | Motion | 10 | as ON | [#3103](https://github.com/openhab/openhab2-addons/issues/3103) |
| Kerui | Door Contact | door open | 14 | as OFF | [#3103](https://github.com/openhab/openhab2-addons/issues/3103) |
| Kerui | Door Contact | door closed | 7 | as ON | [#3103](https://github.com/openhab/openhab2-addons/issues/3103) |
| Kerui | Door Contact | tamper | 7 | as ON | [#3103](https://github.com/openhab/openhab2-addons/issues/3103) |
| Kerui | Motion Sensor | Motion | 10 | as ON | [#3103](https://github.com/openhab/openhab-addons/issues/3103) |
| Kerui | Door Contact | door open | 14 | as OFF | [#3103](https://github.com/openhab/openhab-addons/issues/3103) |
| Kerui | Door Contact | door closed | 7 | as ON | [#3103](https://github.com/openhab/openhab-addons/issues/3103) |
| Kerui | Door Contact | tamper | 7 | as ON | [#3103](https://github.com/openhab/openhab-addons/issues/3103) |
### lighting5 - RFXCOM Lighting5 Actuator

18
_addons_bindings/samsungtv/readme.md
View File

@ -28,6 +28,7 @@ Tested TV models:
| Model | State | Notes |
|-------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| UE48J5670SU | PARTIAL | Supported channels: `volume`, `sourceName` |
| UE40J6300AU | PARTIAL | Supported channels: `volume`, `mute`, `sourceName`, `power` |
| UE46E5505 | OK | Initial contribution is done by this model |
| UE46D5700 | PARTIAL | Supports at my home only commands via the fake remote, no discovery |
| UE40F6500 | OK | All channels except `colorTemperature`, `programTitle` and `channelName` are working |
@ -55,8 +56,10 @@ Additionally, a refresh interval can be configured in milliseconds to specify ho
E.g.
```
Thing samsungtv:tv:livingroom [ hostName="192.168.1.10", port=55000, refreshInterval=1000 ]
Thing samsungtv:tv:livingroom [ hostName="192.168.1.10", port=55000, macAddress="78:bd:bc:9f:12:34", refreshInterval=1000 ]
```
Different ports are used in different models. It may be 55000, 8001 or 8002.
Try to scan for new Things in Paper UI to find TV easily.
## Channels
@ -85,7 +88,14 @@ TVs support the following channels:
E.g.
```
Dimmer TV_Volume { channel="samsungtv:tv:livingroom:volume" }
Switch TV_Mute { channel="samsungtv:tv:livingroom:mute" }
String TV_KeyCode { channel="samsungtv:tv:livingroom:keyCode" }
Group gLivingRoomTV "Living room TV" <screen>
Dimmer TV_Volume "Volume" <soundvolume> (gLivingRoomTV) { channel="samsungtv:tv:livingroom:volume" }
Switch TV_Mute "Mute" <soundvolume_mute> (gLivingRoomTV) { channel="samsungtv:tv:livingroom:mute" }
String TV_SourceName "Source Name" (gLivingRoomTV) { channel="samsungtv:tv:livingroom:sourceName" }
String TV_SourceApp "Source App" (gLivingRoomTV) { channel="samsungtv:tv:livingroom:sourceApp" }
String TV_ProgramTitle "Program Title" (gLivingRoomTV) { channel="samsungtv:tv:livingroom:programTitle" }
String TV_ChannelName "Channel Name" (gLivingRoomTV) { channel="samsungtv:tv:livingroom:channelName" }
String TV_KeyCode "Key Code" (gLivingRoomTV) { channel="samsungtv:tv:livingroom:keyCode" }
Switch TV_Power "Power" (gLivingRoomTV) { channel="samsungtv:tv:livingroom:power" }
Switch TV_ArtMode "Art Mode" (gLivingRoomTV) { channel="samsungtv:tv:livingroom:artMode" }
```

7
_addons_bindings/telegram/readme.md
View File

@ -110,7 +110,7 @@ These actions will send a message to all chat ids configured for this bot.
| sendTelegram(String format, Object... args) | Sends a formatted message (See https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html for more information).
| sendTelegramQuery(String message, String replyId, String... buttons) | Sends a question to the user that can be answered via the defined buttons. The replyId can be freely choosen and is sent back with the answer. Then, the id is required to identify what question has been answered (e.g. in case of multiple open questions). The final result looks like this: ![Telegram Inline Keyboard](doc/queryExample.png). |
| sendTelegramAnswer(String replyId, String message) | Sends a message after the user has answered a question. You should *always* call this method after you received an answer. It will remove buttons from the specific question and will also stop the progress bar displayed at the client side. If no message is necessary, just pass `null` here. |
| sendTelegramPhoto(String photoURL, String caption) | Sends a picture. The URL can be specified using the http, https, and file protocols or a base64 encoded image. |
| sendTelegramPhoto(String photoURL, String caption) | Sends a picture. The URL can be specified using the http, https, and file protocols or a base64 encoded image (simple base64 data or data URI scheme). |
| sendTelegramPhoto(String photoURL, String caption, String username, String password) | Sends a picture which is downloaded from a username/password protected http/https address. |
### Actions to send messages to a particular chat
@ -203,8 +203,13 @@ when
Item Light_GF_Living_Table changed
then
val telegramAction = getActions("telegram","telegram:telegramBot:2b155b22")
// image as base64 string
var String base64Image = "iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAS1BMVEUAAABAQEA9QUc7P0Y0OD88QEY+QUhmaW7c3N3w8PBlaG0+QUjb29w5PUU3O0G+vsigoas6P0WfoKo4O0I9QUdkZ2w9Qkg+QkkkSUnT3FKbAAAAGXRSTlMACJbx//CV9v//9pT/7Ur//+z/SfD2kpMHrnfDaAAAAGhJREFUeAHt1bUBAzAMRFGZmcL7LxpOalN5r/evLIlgGwBgXMhxSjP64sa6cdYH+hLWzYiKvqSbI4kQeEt5PlBealsMFIkAAgi8HNriOLcjduLTafWwBB9n3p8v/+Ma1Mxxvd4IAGCzB4xDPuBRkEZiAAAAAElFTkSuQmCC"
telegramAction.sendTelegramPhoto(base64Image, "battery of motion sensor is empty")
// image as base64 string in data URI scheme
var String base64ImageDataURI = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAS1BMVEUAAABAQEA9QUc7P0Y0OD88QEY+QUhmaW7c3N3w8PBlaG0+QUjb29w5PUU3O0G+vsigoas6P0WfoKo4O0I9QUdkZ2w9Qkg+QkkkSUnT3FKbAAAAGXRSTlMACJbx//CV9v//9pT/7Ur//+z/SfD2kpMHrnfDaAAAAGhJREFUeAHt1bUBAzAMRFGZmcL7LxpOalN5r/evLIlgGwBgXMhxSjP64sa6cdYH+hLWzYiKvqSbI4kQeEt5PlBealsMFIkAAgi8HNriOLcjduLTafWwBB9n3p8v/+Ma1Mxxvd4IAGCzB4xDPuBRkEZiAAAAAElFTkSuQmCC"
telegramAction.sendTelegramPhoto(base64ImageDataURI, "battery of motion sensor is empty")
end
```

46
_addons_bindings/tesla/readme.md
View File

@ -207,29 +207,29 @@ Bridge tesla:account:myaccount "My Tesla Account" [ refreshToken="xxxx" ] {
demo.items:
```
Switch TeslaCharge {channel="tesla:model3:myaccount:mycar::charge"}
Location TeslaLocation {channel="tesla:model3:myaccount:mycar::location"}
Dimmer TeslaChargeLimit {channel="tesla:model3:myaccount:mycar::chargelimit"}
String TeslaChargeRate {channel="tesla:model3:myaccount:mycar::chargerate"}
String TeslaChargingState {channel="tesla:model3:myaccount:mycar::chargingstate"}
Number TeslaTimeToFullCharge {channel="tesla:model3:myaccount:mycar::timetofullcharge"}
Number TeslaChargerPower {channel="tesla:model3:myaccount:mycar::chargerpower"}
DateTime TeslaScheduledChargingStart {channel="tesla:model3:myaccount:mycar::scheduledchargingstart"}
Dimmer TeslaSoC {channel="tesla:model3:myaccount:mycar::soc"}
Number:Speed TeslaSpeed {channel="tesla:model3:myaccount:mycar::speed"}
String TeslaState {channel="tesla:model3:myaccount:mycar::state"}
Number TeslaPower {channel="tesla:model3:myaccount:mycar::power"}
Number:Temperature TeslaInsideTemperature {channel="tesla:model3:myaccount:mycar::insidetemp"}
Number:Temperature TeslaOutsideTemperature {channel="tesla:model3:myaccount:mycar::outsidetemp"}
Switch TeslaAutoconditioning {channel="tesla:model3:myaccount:mycar::autoconditioning"}
Number:Temperature TeslaTemperature {channel="tesla:model3:myaccount:mycar::temperature"}
String TeslaShiftState {channel="tesla:model3:myaccount:mycar::shiftstate"}
Number TeslaBatteryCurrent {channel="tesla:model3:myaccount:mycar::batterycurrent"}
Number TeslaBatteryLevel {channel="tesla:model3:myaccount:mycar::batterylevel"}
DateTime TeslaEventstamp {channel="tesla:model3:myaccount:mycar::eventstamp"}
Number:Length TeslaOdometer {channel="tesla:model3:myaccount:mycar::odometer"}
Number TeslaHeading {channel="tesla:model3:myaccount:mycar::heading"}
DateTime TeslaGPSStamp {channel="tesla:model3:myaccount:mycar::gpstimestamp"}
Switch TeslaCharge {channel="tesla:model3:myaccount:mycar:charge"}
Location TeslaLocation {channel="tesla:model3:myaccount:mycar:location"}
Dimmer TeslaChargeLimit {channel="tesla:model3:myaccount:mycar:chargelimit"}
String TeslaChargeRate {channel="tesla:model3:myaccount:mycar:chargerate"}
String TeslaChargingState {channel="tesla:model3:myaccount:mycar:chargingstate"}
Number TeslaTimeToFullCharge {channel="tesla:model3:myaccount:mycar:timetofullcharge"}
Number TeslaChargerPower {channel="tesla:model3:myaccount:mycar:chargerpower"}
DateTime TeslaScheduledChargingStart {channel="tesla:model3:myaccount:mycar:scheduledchargingstart"}
Dimmer TeslaSoC {channel="tesla:model3:myaccount:mycar:soc"}
Number:Speed TeslaSpeed {channel="tesla:model3:myaccount:mycar:speed"}
String TeslaState {channel="tesla:model3:myaccount:mycar:state"}
Number TeslaPower {channel="tesla:model3:myaccount:mycar:power"}
Number:Temperature TeslaInsideTemperature {channel="tesla:model3:myaccount:mycar:insidetemp"}
Number:Temperature TeslaOutsideTemperature {channel="tesla:model3:myaccount:mycar:outsidetemp"}
Switch TeslaAutoconditioning {channel="tesla:model3:myaccount:mycar:autoconditioning"}
Number:Temperature TeslaTemperature {channel="tesla:model3:myaccount:mycar:temperature"}
String TeslaShiftState {channel="tesla:model3:myaccount:mycar:shiftstate"}
Number TeslaBatteryCurrent {channel="tesla:model3:myaccount:mycar:batterycurrent"}
Number TeslaBatteryLevel {channel="tesla:model3:myaccount:mycar:batterylevel"}
DateTime TeslaEventstamp {channel="tesla:model3:myaccount:mycar:eventstamp"}
Number:Length TeslaOdometer {channel="tesla:model3:myaccount:mycar:odometer"}
Number TeslaHeading {channel="tesla:model3:myaccount:mycar:heading"}
DateTime TeslaGPSStamp {channel="tesla:model3:myaccount:mycar:gpstimestamp"}
```
demo.sitemap:

95
_addons_bindings/toon/readme.md
View File

@ -1,95 +0,0 @@
---
id: toon
label: Toon
title: Toon - Bindings
type: binding
description: "The Toon bindings shows among others current room temperature, setpoint, energy and gas usage information."
since: 2x
install: auto
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Toon Binding
The Toon bindings shows among others current room temperature, setpoint, energy and gas usage information.
It can control the setpoint and current program.
Connected smart plugs can also be controlled.
## Supported Things
### Toon Webaccount
Before the binding can be used, a Toon Webaccount must be added.
This needs to be done manually. Select `Toon Webaccount`, and enter your username and password.
Afterwards start discovery so your display and connected plugs are discovered.
### Toon display unit
The display unit holds all channels that represent current room temperature, setpoint, setpoint mode, gas and energy meter readings.
### Toon plug
A Toon plug represents a connected wall plug that can be controlled via Toon.
## Discovery
Once the binding is authorized, and the `Toon Webaccount` is added, you can start the discovery.
This will find your Toon Display and put it in the Inbox.
Currently only the display and plugs are discovered. So no Alarms or Hue lights will be discovered.
## Binding Configuration
## Thing Configuration
demo.things
```
toon:toonapi:toontest [ username="xxxx", password="yyyy" ]
```
## Items
demo.items:
```
Group Toon
// Display items
Number ToonTemp (Toon) {channel="toon:main:toontest:zzzz:Temperature"}
Number ToonSetpoint (Toon) {channel="toon:main:toontest:zzzz:Setpoint"}
Number ToonSetpointMode (Toon) {channel="toon:main:toontest:zzzz:SetpointMode"}
Number Gas (Toon) {channel="toon:main:toontest:zzzz:GasMeterReading"}
Number Power (Toon) {channel="toon:main:toontest:zzzz:PowerMeterReading"}
Number PowerLow (Toon) {channel="toon:main:toontest:zzzz:PowerMeterReadingLow"}
Number PowerConsumption (Toon) {channel="toon:main:toontest:zzzz:PowerConsumption"}
Number Modulation (Toon) {channel="toon:main:toontest:zzzz:ModulationLevel"}
Switch Heater (Toon) {channel="toon:main:toontest:zzzz:Heating"}
Switch Tapwater (Toon) {channel="toon:main:toontest:zzzz:Tapwater"}
Switch PreHeat (Toon) {channel="toon:main:toontest:zzzz:Preheat"}
// Plug items
Switch Plug (Toon) {channel="toon:plug:toontest:pppp:switch_binary"}
Number PlugConsumption (Toon) {channel="toon:plug:toontest:pppp:PowerConsumption"}
```
Replace zzzz and pppp with the discovered values.
## Sitemaps
demo.sitemaps
```
Frame {
Group item=Toon
Setpoint item=ToonSetpoint minValue=16 maxValue=28 step=0.5
Selection item=ToonSetpointMode label="Toon Program Selection" mappings=[0=Comfort, 1=Active, 2=Sleep, 3=Away]
}
```

33
_addons_bindings/tplinksmarthome/readme.md
View File

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

8
_addons_bindings/zwave/doc/abus/shbw10000_0_0.md
View File

@ -89,7 +89,7 @@ The following table summarises the channels available for the SHBW10000 -:
| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number |
| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number |
| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature |
| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch |
| Motion Alarm | alarm_motion | alarm_motion | Motion | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### Binary Sensor
@ -119,10 +119,10 @@ 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.
### Alarm (burglar)
Indicates if the burglar alarm is triggered.
### Motion Alarm
Indicates if a motion alarm is triggered.
The ```alarm_burglar``` channel is of type ```alarm_burglar``` and supports the ```Switch``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device.
The ```alarm_motion``` channel is of type ```alarm_motion``` and supports the ```Switch``` item and is in the ```Motion``` 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 -:

6
_addons_bindings/zwave/doc/abus/shhm10000_0_0.md
View File

@ -207,11 +207,7 @@ The value 0 deactivates the power report threshold.
* Adjustable from 0 – 65535 in Watt
(Hexadecimal: 0x00 – 0xFFFF)
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Watt |
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is ```50```.

1
_addons_bindings/zwave/doc/aeon/zw111_2_3.md
View File

@ -1007,6 +1007,7 @@ Association group 4 supports 5 nodes.
* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1096/Nano-Dimmer-Manual.pdf)
* [Engineering Spec](https://www.cd-jackson.com/zwave_device_uploads/1096/22-Nano-Dimmer-Engineering--20170601-.pdf)
* [Firmware Update](https://www.cd-jackson.com/zwave_device_uploads/1096/How-to-update-Nano-Dimmer-Z-Wave-firmware----Aeotec-Group.pdf)
* [Engineering Spec 2.03](https://www.cd-jackson.com/zwave_device_uploads/1096/ES---Nano-Dimmer-V2-03.pdf)
---

4
_addons_bindings/zwave/doc/aeotec/zw164_0_0.md
View File

@ -52,6 +52,7 @@ The following table summarises the channels available for the ZW164 -:
| Alarm 1 | alarm_general1 | alarm_general | Alarm | Switch |
| Alarm 2 | alarm_general2 | alarm_general | Alarm | Switch |
| Alarm (power) 3 | alarm_power3 | alarm_power | Energy | Switch |
| Siren Notification | notification_siren3 | notification_siren | | |
| Alarm (power) 4 | alarm_power4 | alarm_power | Energy | Switch |
| Alarm (power) 5 | alarm_power5 | alarm_power | Energy | Switch |
| Alarm 6 | alarm_general6 | alarm_general | Alarm | Switch |
@ -118,6 +119,9 @@ The following state translation is provided for this channel to the ```Switch```
| OFF | OK |
| ON | Alarm |
### Siren Notification
Channel type information on this channel is not found.
### Alarm (power) 4
Indicates if a power alarm is triggered.

288
_addons_bindings/zwave/doc/benext/heatingcontrol_0_0.md Normal file
View File

@ -0,0 +1,288 @@
---
layout: documentation
title: Heating Control - ZWave
---
{% include base.html %}
# Heating Control Thermostat for controlling the opentherm protocol
This describes the Z-Wave device *Heating Control*, manufactured by *[BeNext](http://www.benext.eu/)* with the thing type UID of ```benext_heatingcontrol_00_000```.
The device is in the category of *HVAC*, defining Air condition devices, Fans.
![Heating Control product image](https://www.cd-jackson.com/zwave_device_uploads/473/473_default.png)
The Heating Control 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 Heating Control is the central point of your climate environment. You can overwrite the temperature setpoint of your thermostat, and this product also reports information about your thermostat or boiler. For example the room temperature, boiler pressure, modulation level or water temperature.
This product can be simply placed between your thermostat and boiler. The current setup is not changed and therefore you can still use the device as you normally would do. You don’t have to replace your current thermostat.
Note: This product only works if the current communication between your thermostat and boiler uses the standardized modulating protocol Open Therm. If you are not sure whether your thermostat/boiler uses Open Therm, you may find that in the manual of your thermostat/boiler. You can also find it on the internet. You can search for example on ‘Honeywell round clock open therm’.
### Inclusion Information
Press and hold the push button for 2 seconds and release to start the inclusion or exclude process.
### Exclusion Information
Press and hold the push button for 2 seconds and release to start the inclusion or exclude process.
## Channels
The following table summarises the channels available for the Heating Control -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Room temperature | room_temperature | sensor_temperature | Temperature | Number:Temperature |
| Outside temperature | outside_temperature | sensor_temperature | Temperature | Number:Temperature |
| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number |
| Heating setpoint | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature |
| Energy save setpoint | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature |
### Room temperature
Room temperature of the room thermostat
Indicates the current temperature.
The ```room_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category.
### Outside temperature
The temperature outside, if reported by the boiler
Indicates the current temperature.
The ```outside_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category.
### Thermostat mode
Determines the mode of the thermostat, either ON ("Heat", 1), or OFF ("Off", 0). The heating setpoint will be applied if the mode Heat is applied and the Energy saving setpoint if the mode Off is applied
Sets the thermostat.
The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category.
The following state translation is provided for this channel to the ```Number``` item type -:
| Value | Label |
|-------|-----------|
| 0 | Off |
| 1 | Heat |
| 2 | Cool |
| 3 | Auto |
| 4 | Aux Heat |
| 5 | Resume |
| 6 | Fan Only |
| 7 | Furnace |
| 8 | Dry Air |
| 9 | Moist Air |
| 10 | Auto Changeover |
| 11 | Heat Economy |
| 12 | Cool Economy |
| 13 | Away |
### Heating setpoint
The setpoint used for the heating schedule
Sets the thermostat setpoint.
The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category.
### Energy save setpoint
The setpoint used for the energy save heating program
Sets the thermostat setpoint.
The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category.
## Device Configuration
The following table provides a summary of the 9 configuration parameters available in the Heating Control.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Set to default | Set all configuration values to default values (factory settings) |
| 2 | Data request interval | Interval of updating data from thermostat and boiler |
| 3 | T room update difference | Difference of temperature before new update |
| 4 | T setpoint update difference | Difference in setpoint before new update |
| 5 | Unsolicited CRC | CRC-16 encapulation |
| 6 | Type of 'special' thermostat | Type of 'special' thermostat if applicable |
| 7 | Status auto report | Status auto report boiler/thermostat report. |
| 9 | Enable/Disable thermostat schedule | Enable/Disable thermostat schedule inside the controller |
| 11 | Readout manual setpoint thermostat | Readout manual setpoint thermostat |
### Parameter 1: Set to default
Set all configuration values to default values (factory settings)
If 0xFF (255) then set to default
The following option values may be configured, in addition to values in the range 0 to 255 -:
| Value | Description |
|--------|-------------|
| 255 | Reset |
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Data request interval
Interval of updating data from thermostat and boiler
The interval in seconds that data is requested (and therefore updated) from the thermostat and boiler. 
Values in the range 1 to 255 may be set.
The manufacturer defined default value is ```14```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: T room update difference
Difference of temperature before new update
The value that the room temperature must differ (compared to his previous send value) before an unsolicited room temperature report is send to the associated node. 
Values in the range 1 to 255 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: T setpoint update difference
Difference in setpoint before new update
The value that the temperature setpoint must differ (compared to his previous send value) before an unsolicited temperature setpoint report is send to the associated node. 
Values in the range 1 to 255 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 5: Unsolicited CRC
CRC-16 encapulation
Configure if the unsolicited reports are send with the CRC-16 encapsulation. Not that the receiving node should support this encapsulation to parse the Z-Wave frame! This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Off |
| 255 | On |
The manufacturer defined default value is ```0``` (Off).
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Type of 'special' thermostat
Type of 'special' thermostat if applicable
Type of 'special' thermostat. NOTE: when remeha Celcia 20 support is set than any other thermostat cannot be set (!) NOTE2: when Remeha Celcia 20 gives 'Fout 203' send cfg value again 
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | No special |
| 1 | Remeha Celcia 20 |
| 2 | Honeywell (rounded temperatures) |
The manufacturer defined default value is ```0``` (No special).
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Parameter 7: Status auto report
Status auto report boiler/thermostat report.
Status auto report boiler/thermostat report.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable messages auto report |
| 255 | Enable status messages auto report |
The manufacturer defined default value is ```0``` (Disable messages auto report).
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 9: Enable/Disable thermostat schedule
Enable/Disable thermostat schedule inside the controller
Enable/Disable thermostat schedule inside the heatingcontroller
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable thermostat schedule |
| 255 | Enable thermostat schedule |
The manufacturer defined default value is ```0``` (Disable thermostat schedule).
This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```.
### Parameter 11: Readout manual setpoint thermostat
Readout manual setpoint thermostat
This parameter is used to set the possible manual readout of the setpoint on the thermostat. If the thermostat is manually set to a different mode it is then possible to readout this value if enabled.
(NB. This setting is not in the manual but verified through contacting the service department of BeNext).
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Readout OFF |
| 255 | Readout ON |
The manufacturer defined default value is ```0``` (Readout OFF).
This parameter has the configuration ID ```config_11_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 Heating Control supports 1 association group.
### Group 1: Group 1
Unsolicited reports
Every unsolicited report will be sent to the nodes in this group. 
Association group 1 supports 1 node.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V6| |
| COMMAND_CLASS_THERMOSTAT_MODE_V1| Linked to BASIC|
| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| |
| COMMAND_CLASS_CRC_16_ENCAP_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V3| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V1| |
### Documentation Links
* [Heating Control Manual EN](https://www.cd-jackson.com/zwave_device_uploads/473/heatingcontrol.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/473).

143
_addons_bindings/zwave/doc/danfoss/rxz2c_0_0.md Normal file
View File

@ -0,0 +1,143 @@
---
layout: documentation
title: RXZ-2C - ZWave
---
{% include base.html %}
# RXZ-2C Thermostat
This describes the Z-Wave device *RXZ-2C*, manufactured by *Danfoss* with the thing type UID of ```danfoss_rxz2c_00_000```.
The device is in the category of *HVAC*, defining Air condition devices, Fans.
![RXZ-2C product image](https://www.cd-jackson.com/zwave_device_uploads/1189/1189_default.png)
The RXZ-2C 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
230VAC powered static controller with binary switch capability containing 2 power relays
### Inclusion Information
After the device is Factory Reset it automatically enters Inclusion Mode.
1. Press PROG to place in Program mode (Red LED on stead)
2. Press and hold CH1 button for at least 15 seconds (PROG LED rapidly flashed red and green)
3. Press and hold down the PROG button for at least 15 seconds
Channel LEDs will show red and PROG LED will slowly flash green
### Exclusion Information
Factory Reset the device th exclude it.
1. Press PROG to place in Program mode (Red LED on stead)
2. Press and hold CH1 button for at least 15 seconds (PROG LED rapidly flashed red and green)
3. Press and hold down the PROG button for at least 15 seconds
Channel LEDs will show red and PROG LED will slowly flash green
## Channels
The following table summarises the channels available for the RXZ-2C -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature |
| Switch 1 | switch_binary1 | switch_binary | Switch | Switch |
| Setpoint (heating) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature |
| Switch 2 | switch_binary2 | switch_binary | Switch | Switch |
| Setpoint (heating) 2 | thermostat_setpoint2 | thermostat_setpoint | Heating | Number:Temperature |
### 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.
### Setpoint (heating)
Sets the thermostat setpoint.
The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category.
### 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.
### Setpoint (heating) 1
Sets the thermostat setpoint.
The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` 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.
### Setpoint (heating) 2
Sets the thermostat setpoint.
The ```thermostat_setpoint2``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category.
## Device Configuration
The device has no configuration parameters defined.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The RXZ-2C supports 1 association group.
### Group 1: Group 1
Association group 1 supports 1 node.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V1| |
| COMMAND_CLASS_VERSION_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CMD_V1| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| |
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| |
### Documentation Links
* [Scanned Manual](https://www.cd-jackson.com/zwave_device_uploads/1189/RXZ-2C-Manual.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1189).

113
_addons_bindings/zwave/doc/ge/46203_0_0.md
View File

@ -39,6 +39,16 @@ Once the controller is ready to add your device, press and release the top or bo
Once the controller is ready to add your device, press and release the top or bottom of the smart fan control switch (rocker) to add it in the network.
**NOTE: See Parameter 19 to set alternate exclusion mode.**
### General Usage Information
# Factory Reset
Quickly press ON (top) button three times, then immediately press the OFF (Bottom) button three times. The LED will flash ON/OFF five times when completed successfully.
**Note:** This should only be used if your network’s primary controller is missing or otherwise inoperable.
## Channels
The following table summarises the channels available for the 46203 -:
@ -74,21 +84,34 @@ This channel provides the scene, and the event as a decimal value in the form ``
## Device Configuration
The following table provides a summary of the 2 configuration parameters available in the 46203.
The following table provides a summary of the 8 configuration parameters available in the 46203.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 3 | LED Status | LED Status |
| 4 | Invert | |
| 6 | Dim up/down rate | Dim up/down rate |
| 16 | Switch Mode | Switch Mode |
| 19 | Alternate Exclusion | Alternate Exclusion |
| 30 | Minimum Dim Threshold | Minimum Dim Threshold |
| 31 | Maximum Brightness Threshold | Maximum Brightness Threshold |
| 32 | Default Brightness Level | Default Brightness Level |
### Parameter 3: LED Status
LED Status
Values in the range 0 to 2 may be set.
The following option values may be configured -:
The manufacturer defined default value is ```0```.
| Value | Description |
|--------|-------------|
| 0 | Device is ON, LED is OFF; device is OFF, LED is ON |
| 1 | Device is ON, LED is ON; device is OFF, LED is OFF |
| 2 | LED always OFF |
| 3 | LED always ON |
The manufacturer defined default value is ```0``` (Device is ON, LED is OFF; device is OFF, LED is ON).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
@ -104,6 +127,90 @@ The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 6: Dim up/down rate
Dim up/down rate
Adjust the speed at which the ramps to a specific value other than 0 and FF
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Quickly |
| 1 | Slowly |
The manufacturer defined default value is ```0``` (Quickly).
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Parameter 16: Switch Mode
Switch Mode
Turn your dimmer into an On/Off switch with switch mode
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Dimmer Mode |
| 1 | Switch Mode |
The manufacturer defined default value is ```0``` (Dimmer Mode).
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 19: Alternate Exclusion
Alternate Exclusion
Never accidentally remove a device with alternate exclusion.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Normal, Press Any Button on the device |
| 1 | Alternate |
The manufacturer defined default value is ```0``` (Normal, Press Any Button on the device).
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Parameter 30: Minimum Dim Threshold
Minimum Dim Threshold
Set the minimum dimmer threshold when manually or remotely controlled
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_30_1``` and is of type ```INTEGER```.
### Parameter 31: Maximum Brightness Threshold
Maximum Brightness Threshold
Set the maximum brightness threshold when manually or remotely controlled
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_31_1``` and is of type ```INTEGER```.
### Parameter 32: Default Brightness Level
Default Brightness Level
Set the default brightness level that the dimmer will turn on when being controlled manually
* 0 = Default
* 1 - 99 = percentage
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_32_1``` and is of type ```INTEGER```.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.

93
_addons_bindings/zwave/doc/merten/5046xx_0_0.md Normal file
View File

@ -0,0 +1,93 @@
---
layout: documentation
title: 5046xx - ZWave
---
{% include base.html %}
# 5046xx Dimmer Insert Button
This describes the Z-Wave device *5046xx*, manufactured by *Merten* with the thing type UID of ```merten_5046xx_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.
![5046xx product image](https://www.cd-jackson.com/zwave_device_uploads/1192/1192_default.jpg)
The 5046xx 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
A CONNECT radio sensor cover for dimmer inserts.
### Inclusion Information
Press the button three times
### Exclusion Information
Press the button three times
## Channels
The following table summarises the channels available for the 5046xx -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
## Device Configuration
The device has no configuration parameters defined.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The 5046xx supports 2 association groups.
### Group 1: Other device so be switched
Association group 1 supports 5 nodes.
### Group 2: Group 2
Association group 2 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| Linked to BASIC|
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_SWITCH_TOGGLE_MULTILEVEL_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_PROTECTION_V2| |
| COMMAND_CLASS_ASSOCIATION_V1| |
| COMMAND_CLASS_VERSION_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
### Documentation Links
* [Merten 5046xx](https://www.cd-jackson.com/zwave_device_uploads/1192/untitled.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1192).

104
_addons_bindings/zwave/doc/nietech/smartplugswitch_0_0.md Normal file
View File

@ -0,0 +1,104 @@
---
layout: documentation
title: ZW36 - ZWave
---
{% include base.html %}
# ZW36 1-channel smart plug, ZWave Plus
This describes the Z-Wave device *ZW36*, manufactured by *NIE Technology* with the thing type UID of ```nietech_smartplugswitch_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.
![ZW36 product image](https://www.cd-jackson.com/zwave_device_uploads/1193/1193_default.jpg)
The ZW36 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 EVA LOGIK ZW36 is a Z-Wave enabled 15A receptacle designed for most residential lighting and motor applications. It's compatible with LED, halogen, incandescent, xenon, fluorescent and compact fluorescent bulbs.The ZW36 fully works with the Fibaro, Smartthings, Wink hub as well as all other certified Z-Wave controllers.
### Inclusion Information
Put the Z-wave interface controller into “Add” mode, triple press the Program button (A).
It will be included to network.
(Once your controller confirmed, refresh the Z-Wave network to optimize performance. )
### Exclusion Information
Put the Z-Wave interface controller into "Remove" mode, triple press the Program button (A). It will be excluded to network.
## Channels
The following table summarises the channels available for the ZW36 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Scene Number | scene_number | scene_number | | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -:
| Event ID | Event Description |
|----------|--------------------|
| 0 | Single key press |
| 1 | Key released |
| 2 | Key held down |
| 3 | Double keypress |
| 4 | Tripple keypress |
| 5 | 4 x keypress |
| 6 | 5 x keypress |
## Device Configuration
The device has no configuration parameters defined.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The device does not support associations.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
### Documentation Links
* [EVA LOGIK ZW36 Manual](https://www.cd-jackson.com/zwave_device_uploads/1193/ZW36manual170412.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1193).

38
_addons_bindings/zwave/doc/qubino/minidimmer_0_0.md
View File

@ -76,6 +76,44 @@ Press and hold the S (Service) button between 2 and 6 seconds if connected to 24
**NOTE: Please wait at least 30 seconds between each inclusion and exclusion.**
### General Usage Information
**FACTORY RESET**
1. Connect the device to the power supply.
2. Within the first minute (60seconds) the device is connected to the power supply, toggle the switch connected to the I1 terminal 5 times within 3 seconds.
OR
Press and hold the S (Service) button for at least 6 seconds if connected to 24-30VDC.
**NOTE:** By resetting the device, all custom parameters previously set on the device will return to their default values, and the node ID will be deleted. Use this reset procedure only when the main gateway (hub) is missing or otherwise inoperable.
**NOTE:** the reset with switch connected to I1 is possible only in the first minute after the device is connected to the power.
**NOTE:** after the reset is successfully done the autocalibration will trigger and the green LED will start blinking.
**LED SIGNALIZATION FOR INCLUSION/EXCLUSION**
LED (green)
* LED is blinking (1 sec ON, 1 sec OFF) = module is excluded
* LED is ON = module is included
LED (red)
* LED is OFF = normal operation
* LED is ON = overload
* LED is blinking (1 sec ON, 1 sec OFF) = over temperature
LED (blue)
* LED is OFF = normal operation
* LED is blinking (1 sec ON, 1 sec OFF) = calibration in progress
* LED is ON = calibration failed
**NOTE:** After each power cycle all 3 LEDs will blink once before resuming normal operation.
## Channels
The following table summarises the channels available for the ZMNHHD -:

137
_addons_bindings/zwave/doc/qubino/zmnhhd_0_0.md Normal file
View File

@ -0,0 +1,137 @@
---
layout: documentation
title: ZMNHHD - ZWave
---
{% include base.html %}
# ZMNHHD Qubino Mini Dimmer
This describes the Z-Wave device *ZMNHHD*, manufactured by *[Goap](http://www.qubino.com/)* with the thing type UID of ```qubino_zmnhhd_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.
![ZMNHHD product image](https://www.cd-jackson.com/zwave_device_uploads/1188/1188_default.png)
The ZMNHHD 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
Mini Dimmer is a MOSFET-switching light device that also supports control of low-voltage halogen lamps with electronic transformers, dimmable compact fluorescent lights, and dimmable LED bulbs. It measures power consumption of the connected device. It supports push-button/momentary switches (default) and toggle switches. It can work with or without the neutral line. Qubino Mini Dimmer allows the easiest and quickest installation.
### Inclusion Information
**AUTOMATICALLY ADDING THE DEVICE TO A Z-WAVE NETWORK (AUTO INCLUSION)**
1. Enable add/remove mode on your Z-Wave gateway (hub).
2. Automatic selection of secure/unsecure inclusion.
3. The device can be automatically added to a Z-Wave network during the first 2 minutes.
4. Connect the device to the power supply.
5. Auto-inclusion will be initiated within 5 seconds of connection to the power supply and the device will automatically enrol in your network. (when the device is excluded and connected to the power supply it automatically enters the LEARN MODE state.)
NOTE: the device can be automatically added to a Z-Wave network during the first 2 minutes after connected to the power supply.
ⓘ NOTE: LEARN MODE state allows the device to receive network infromation from the controller
ⓘ NOTE: For S2 inclusion please check chapter – »17. Z-Wave Security« in the manual.
**MANUALLY ADDING THE DEVICE TO A Z-WAVE NETWORK (MANUAL INCLUSION) **
1. Connect the device to the power supply
2. Enable add/remove mode on your Z-Wave gateway (hub)
3. Toggle the switch connected to the I1 terminal 3 times within 3 seconds (this procedure put the device in LEARN MODE). The device has to get On/Off signal 3 times, meaning 3 times push of the button or with the normal button 3 times On/Off.
**OR**
Press and hold the S (Service) button between 2 and 6 seconds if connected to 24-30VDC (this procedure put the device in LEARN MODE).
1. A new device will appear on your dashboard
2. Inclusion with the switch connected to I1 terminal is not limited by time
ⓘ NOTE: LEARN MODE state allows the device to receive network information from the controller.
### Exclusion Information
**REMOVAL FROM A ZWAVE NETWORK (Z-WAVE EXCLUSION)**
1. Connect the device to the power supply.
2. Make sure the device is within direct range of your Z-Wave gateway (hub) or use a hand-held Z-Wave remote to perform exclusion.
3. Enable add/remove mode on your Z-Wave gateway (hub).
4. Toggle the switch connected to the I1 terminal 3 times within 3 seconds (this procedure put the device in LEARN MODE). The device has to get On/Off signal 3 times, meaning 3 times push of the button or with the normal button 3 times On/Off.
**OR**
Press and hold the S (Service) button between 2 and 6 seconds if connected to 24-30VDC (this procedure put the device in LEARN MODE)
1. Exclusion with the switch connected to I1 terminal is not limited by time.
2. The device will be removed from your network, but any custom configuration parameters will not be erased.
ⓘ NOTE: LEARN MODE state allows the device to receive network information from the controller.
**FACTORY RESET**
1. Connect the device to the power supply.
2. Within the first minute (60seconds) the device is connected to the power supply, toggle the switch connected to the I1 terminal 5 times within 3 seconds.
**OR**
Press and hold the S (Service) button for at least 6 seconds if connected to 24-30VDC.
ⓘ NOTE: By resetting the device, all custom parameters previously set on the device will return to their default values, and the node ID will be deleted. Use this reset procedure only when the main gateway (hub) is missing or otherwise inoperable.
ⓘ NOTE: the reset with switch connected to I1 is possible only in the first minute after the device is connected to the power.
ⓘ NOTE: after the reset is successfully done the autocalibration will trigger and the green LED will start blinking.
**LED SIGNALIZATION FOR INCLUSION/EXCLUSION**
LED (green)
* LED is blinking (1 sec ON, 1 sec OFF) = module is excluded
* LED is ON = module is included
LED (red)
* LED is OFF = normal operation
* LED is ON = overload
* LED is blinking (1 sec ON, 1 sec OFF) = over temperature
LED (blue)
* LED is OFF = normal operation
* LED is blinking (1 sec ON, 1 sec OFF) = calibration in progress
* LED is ON = calibration failed
ⓘ NOTE: after each power cycle all 3 LEDs will blink once before resuming normal operation.
## Channels
The following table summarises the channels available for the ZMNHHD -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
## Device Configuration
The device has no configuration parameters defined.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The device does not support associations.
## Technical Information
### Endpoints
### Documentation Links
* [Qubino Mini Dimmer v4.5.pdf](https://www.cd-jackson.com/zwave_device_uploads/1188/Qubino-Mini-Dimmer-V-4-5.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1188).

2
_addons_bindings/zwave/doc/simontech/1000204113x_0_0.md
View File

@ -114,6 +114,8 @@ The following option values may be configured, in addition to values in the rang
| Value | Description |
|--------|-------------|
| 0 | Disables the beacon function |
| 49 | Beacon LED at 50% |
| 99 | Beacon LED at 100% |
The manufacturer defined default value is ```0``` (Disables the beacon function).

186
_addons_bindings/zwave/doc/sunricher/zv9001k4dim_0_0.md Normal file
View File

@ -0,0 +1,186 @@
---
layout: documentation
title: ZV9001K4-DIM - ZWave
---
{% include base.html %}
# ZV9001K4-DIM 2-Group Single Color Wallmounted Remote
This describes the Z-Wave device *ZV9001K4-DIM*, manufactured by *[Sunricher](www.sunricher.com)* with the thing type UID of ```sunricher_zv9001k4dim_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.
![ZV9001K4-DIM product image](https://www.cd-jackson.com/zwave_device_uploads/1191/1191_default.png)
The ZV9001K4-DIM 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 ZV9001K4-DIM 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
The SR-ZV9001K4-DIM is a new single color wall mounted push button z-wave secondary controller light switch which adopts latest z-wave RF Plus and Mesh network technology to switch and dim single color LED lighting. It is a universal z-wave slave and can be added to z-wave network or removed from z-wave network by z-wave primary (master) or gateway.
The wall controller is powered by a cell lithium battery. The wireless dimmer is compatible with single color z wave device SR-ZV9101FA-DIM and different frequencies are available for different countries or areas. The signal transmit distance can be up to 30m.
It supports 3 groups for associations, a lifeline group association to primary (master) controller and 2 groups association to devices, the groups association to devices support maximum 20 Z-wave devices per group. Compatible with existing frames from Berker, Gira, Jung and Merten, the z-wave secondary controller is easy to be mounted on the wall.
**Key Features**
* Z-wave secondary controller light switch
* Source-routed Mesh Network Architecture
* Each device works as a node
* All Nodes Are Transceivers
* Each Z-wave Network Allows Up to 243 Devices
* Actively route around and circumvent obstacles or radio dead spots
* Wireless Synchronization to Drastically Increase Control Distance
* Devices can communicate to one another by using intermediate nodes
* Added to z-wave network by z-wave masters or gateway
* Removed from z-wave network by z-wave masters or gateway
* Compatible with universal z-wave masters/gateway
* Supports 1 lifeline group association to master controller
* Supports 2 groups association to z-wave devices, maximum 20 devices per group
### Inclusion Information
Please make sure the battery of the wall mounted controller has enough power (press any key and if the blue LED indicator turns on, which means the remote works well) -> set the master controller or gateway into network inclusion or add device mode (please refer to the user manual to learn how) -> press and hold down both keys I and O at the top row (group 2) simultaneously on the wall controller until LED indicator turns on and flashes 6 times quickly to indicate successful adding -> there shall be an indication on the master controller or gateway.
### Exclusion Information
When the wall mounted controller has already been added to z-wave network, set z-wave master (primary) controller or z-wave gateway into network inclusion or remove device mode (please refer to the user manual to learn how) -> press and hold down both keys I and O at the top row (group 2) simultaneously on the wall controller until LED indicator turns on and shows 3 short blinks and 1 long blink to indicate successful removing -> there shall be an indication on the master controller or gateway.
### Wakeup Information
The ZV9001K4-DIM 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.
Press any button.
## Channels
The following table summarises the channels available for the ZV9001K4-DIM -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| switch_binary [Deprecated]| switch_binary | switch_binary | Switch | Switch |
| switch_dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### switch_binary [Deprecated]
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.
**Note:** This channel is marked as deprecated so should not be used.
### 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.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -:
| Event ID | Event Description |
|----------|--------------------|
| 0 | Single key press |
| 1 | Key released |
| 2 | Key held down |
| 3 | Double keypress |
| 4 | Tripple keypress |
| 5 | 4 x keypress |
| 6 | 5 x keypress |
### Battery Level
Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.
The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category.
This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.
## Device Configuration
The device has no configuration parameters defined.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The ZV9001K4-DIM 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.
Send Mode: Single Cast
Send Commands:
* DEVICE\_RESET\_LOCALLY_NOTIFICATION
* BATTERY_REPORT
Association group 1 supports 5 nodes.
### Group 2: Launch 1
Send Mode: Multicast
Send Commands:
* The Basic Set
* Switch Multilevel Start Level Change
* Switch Multilevel Stop Level Change
Association group 2 supports 5 nodes.
### Group 3: Launch 2
Send Mode: Multicast
Send Commands:
* The Basic Set
* Switch Multilevel Start Level Change
* Switch Multilevel Stop Level Change
Association group 3 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC|
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
### Documentation Links
* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1191/ZV9001K4.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1191).

41
_addons_bindings/zwave/doc/sunricher/zv9001k8dim_0_0.md
View File

@ -19,7 +19,11 @@ The ZV9001K8-DIM does not permanently listen for messages sent from the controll
## Overview
The SR-ZV9001K8-DIM is a new single color wall mounted push button z-wave secondary controller light switch which adopts latest z-wave RF Plus and Mesh network technology to switch and dim single color LED lighting. It is a universal z-wave slave and can be added to z-wave network or removed from z-wave network by z-wave primary (master) or gateway. The wall controller is powered by a cell lithium battery. The wireless dimmer is compatible with single color z wave device SR-ZV9101FA-DIM and different frequencies are available for different countries or areas. The signal transmit distance can be up to 30m. It supports 5 groups for associations, a lifeline group association to primary (master) controller and 4 groups association to devices, the groups association to devices support maximum 20 Z-wave devices per group. Compatible with existing frames from Berker, Gira, Jung and Merten, the z-wave secondary controller is easy to be mounted on the wall.
The SR-ZV9001K8-DIM is a new single color wall mounted push button z-wave secondary controller light switch which adopts latest z-wave RF Plus and Mesh network technology to switch and dim single color LED lighting. It is a universal z-wave slave and can be added to z-wave network or removed from z-wave network by z-wave primary (master) or gateway.
The wall controller is powered by a cell lithium battery. The wireless dimmer is compatible with single color z wave device SR-ZV9101FA-DIM and different frequencies are available for different countries or areas. The signal transmit distance can be up to 30m.
It supports 5 groups for associations, a lifeline group association to primary (master) controller and 4 groups association to devices, the groups association to devices support maximum 20 Z-wave devices per group. Compatible with existing frames from Berker, Gira, Jung and Merten, the z-wave secondary controller is easy to be mounted on the wall.
**Key Features**
@ -39,19 +43,11 @@ The SR-ZV9001K8-DIM is a new single color wall mounted push button z-wave second
### Inclusion Information
Please make sure the battery of the wall mounted controller has enough power (press any key and if the blue LED
indicator turns on, which means the remote works well) -> set the master controller or gateway into network inclusion or
add device mode (please refer to the user manual to learn how) -> press and hold down both keys I and O at the top row
(group 2) simultaneously on the wall controller until LED indicator turns on and flashes 6 times quickly to indicate
successful adding -> there shall be an indication on the master controller or gateway.
Please make sure the battery of the wall mounted controller has enough power (press any key and if the blue LED indicator turns on, which means the remote works well) -> set the master controller or gateway into network inclusion or add device mode (please refer to the user manual to learn how) -> press and hold down both keys I and O at the top row (group 2) simultaneously on the wall controller until LED indicator turns on and flashes 6 times quickly to indicate successful adding -> there shall be an indication on the master controller or gateway.
### Exclusion Information
When the wall mounted controller has already been added to z-wave network, set z-wave master (primary) controller or
z-wave gateway into network inclusion or remove device mode (please refer to the user manual to learn how) -> press
and hold down both keys I and O at the top row (group 2) simultaneously on the wall controller until LED indicator turns
on and shows 3 short blinks and 1 long blink to indicate successful removing -> there shall be an indication on the
master controller or gateway.
When the wall mounted controller has already been added to z-wave network, set z-wave master (primary) controller or z-wave gateway into network inclusion or remove device mode (please refer to the user manual to learn how) -> press and hold down both keys I and O at the top row (group 2) simultaneously on the wall controller until LED indicator turns on and shows 3 short blinks and 1 long blink to indicate successful removing -> there shall be an indication on the master controller or gateway.
### Wakeup Information
@ -65,14 +61,15 @@ The following table summarises the channels available for the ZV9001K8-DIM -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| switch_binary2 | switch_binary | switch_binary | Switch | Switch |
| switch_binary | switch_binary | switch_binary | Switch | Switch |
| switch_dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| switch_binary | switch_binary2 | switch_binary | Switch | Switch |
| switch_binary | switch_binary3 | 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_binary2
### switch_binary
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.
@ -104,12 +101,17 @@ Represents the battery level as a percentage (0-100%). Bindings for things suppo
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_binary
### 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_binary
### 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.
@ -213,10 +215,6 @@ Association group 5 supports 20 nodes.
| COMMAND_CLASS_SECURITY_V1| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| Linked to BASIC|
@ -224,6 +222,7 @@ Association group 5 supports 20 nodes.
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| Linked to BASIC|
#### Endpoint 3
| Command Class | Comment |

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

@ -5,7 +5,7 @@ title: ZEN30 - ZWave
{% include base.html %}
# ZEN30 Double Switch
# ZEN30 Dimmer & dry contact relay
This describes the Z-Wave device *ZEN30*, manufactured by *[Zooz](http://www.getzooz.com/)* with the thing type UID of ```zooz_zen30_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.

2
_addons_bindings/zway/doc/GETTING_STARTED.md
View File

@ -13,7 +13,7 @@
```shell
cd /opt/openhab2/addons
sudo wget https://github.com/openhab/openhab2-addons/files/636686/org.openhab.binding.zway-2.0.0-SNAPSHOT.zip
sudo wget https://github.com/openhab/openhab-addons/files/636686/org.openhab.binding.zway-2.0.0-SNAPSHOT.zip
sudo unzip org.openhab.binding.zway-2.0.0-SNAPSHOT.zip
sudo rm org.openhab.binding.zway-2.0.0-SNAPSHOT.zip
```

45
_addons_ios/azureiothub/readme.md
View File

@ -1,45 +0,0 @@
---
id: azureiothub
label: Azure IoT Hub Connector
title: Azure IoT Hub Connector - System Integrations
type: io
description: "The Azure IoT Hub connector replicates your local things to a [Microsoft Azure IoT Hub](https://azure.microsoft.com/en-us/services/iot-hub/)."
since: 2x
logo: images/addons/azureiothub.png
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Azure IoT Hub Connector
The Azure IoT Hub connector replicates your local things to a [Microsoft Azure IoT Hub](https://azure.microsoft.com/en-us/services/iot-hub/).
This IoT building block resides in the Azure cloud and allows 2 way communication with your devices and your IoT infrastructure in the cloud.
The IoT hub can be connected to other Azure services like a [database](https://azure.microsoft.com/en-us/services/hdinsight/), [stream analytics](https://azure.microsoft.com/en-us/services/stream-analytics/), [machine learning](https://azure.microsoft.com/en-us/services/machine-learning/) and [time series insights](https://azure.microsoft.com/en-us/services/time-series-insights/).
## Pricing
You may send up to 8000 messages a day for free.
That is 5.5 status updates every minute.
Anything more than this in the free price tier is simply neglected by the IoT Hub.
If you want to log more than this, you can switch to a paying price tier, see [pricing details](https://azure.microsoft.com/en-us/pricing/details/iot-hub/).
[Create an Azure account here](https://azure.microsoft.com/en-us/free/)
## Configuration
### Connection string
From the [Azure portal](https://portal.azure.com/), you need to create an IoT Hub.
Click on the '+' sign on the upper left, search for 'IoT Hub', click create and follow the wizard.
Once the hub is available, go to settings - Shared access policies, click `iothubowner` and copy the connection string - primary key.
When configuring your connector in openHAB, you need to provide this string as the parameter `connectionstring`.
### Mode
The openHAB Azure IoT Hub Connector can operate in 2 modes:
Publish (only) or publish and command.
In publish mode, openHAB will sync all its devices and its status changes to Azure.
In publish & command mode, you can also send cloud to device commands.

121
_addons_ios/google-assistant/readme.md
View File

@ -22,74 +22,73 @@ With the Action you can voice control your openHAB items and it supports lights,
* Google Home or Google Home mini.
## Item configuration
In openHAB 2 Items are exposed via [tags](https://www.openhab.org/docs/configuration/items.html#item-definition-and-syntax). Currently the following Tags are supported (also depending on Googles API capabilities):
In openHAB 2 items are exposed via [metadata](https://www.openhab.org/docs/configuration/items.html#item-definition-and-syntax).
* Switch / Dimmer / Color ["Lighting"]
* Switch ["Switchable"]
* Switch ["Outlet"]
* Switch ["Fan"]
* Switch ["CoffeeMaker"]
* Switch ["WaterHeater"]
* Switch ["Fireplace"]
* Switch ["Valve"]
* Switch ["Sprinkler"]
* Switch ["Vacuum"]
* Switch ["Scene"]
* Switch ["Lock"]
* Rollershutter ["Awning"]
* Rollershutter ["Blinds"]
* Rollershutter ["Curtain"]
* Rollershutter ["Door"]
* Rollershutter ["Garage"]
* Rollershutter ["Gate"]
* Rollershutter ["Pergola"]
* Rollershutter ["Shutter"]
* Rollershutter ["Window"]
* Group ["Thermostat"]
* Number ["CurrentTemperature"] as part of Thermostat.
* Number ["CurrentHumidity"] as part of Thermostat.
* Number ["homekit:TargetTemperature"] as part of Thermostat.
* Number / String ["homekit:TargetHeatingCoolingMode"] as part of Thermostat.
Currently the following metadata values are supported (also depending on Googles API capabilities):
* Switch / Dimmer / Color { ga="Light" }
* Switch { ga="Switch" }
* Switch { ga="Outlet" }
* Switch { ga="CoffeeMaker" }
* Switch { ga="WaterHeater" }
* Switch { ga="Fireplace" }
* Switch { ga="Valve" }
* Switch { ga="Sprinkler" }
* Switch { ga="Vacuum" }
* Switch { ga="Scene" }
* Switch { ga="Lock" [ tfaAck=true ] }
* Switch { ga="SecuritySystem" [ tfaPin="1234" ] }
* Dimmer { ga="Speaker" }
* Switch / Dimmer { ga="Fan" [ speeds="0=away:zero,50=default:standard:one,100=high:two", lang="en", ordered=true ] } (for Dimmer the options have to be set)
* Rollershutter { ga="Awning" [ inverted=true ] } (all Rollershutter items can use the inverted option)
* Rollershutter { ga="Blinds" }
* Rollershutter { ga="Curtain" }
* Rollershutter { ga="Door" }
* Rollershutter { ga="Garage" }
* Rollershutter { ga="Gate" }
* Rollershutter { ga="Pergola" }
* Rollershutter { ga="Shutter" }
* Rollershutter { ga="Window" }
* Group { ga="Thermostat" }
* Number { ga="thermostatTemperatureAmbient" } as part of Thermostat.
* Number { ga="thermostatHumidityAmbient" } as part of Thermostat.
* Number { ga="thermostatTemperatureSetpoint" } as part of Thermostat.
* Number / String { ga="thermostatMode" } as part of Thermostat.
```
Switch KitchenLights "Kitchen Lights" <light> (gKitchen) [ "Switchable" ]
Dimmer BedroomLights "Bedroom Lights" <light> (gBedroom) [ "Lighting" ]
Color LivingroomLights "Livingroom Lights" <light> (gLivingroom) [ "Lighting" ]
Switch SceneMovie "Scene Movie" (gLivingroom) [ "Scene" ]
Switch CristmasTree "Cristmas Tree" (gLivingroom) [ "Outlet" ]
Switch DoorLock "Door Lock" [ "Lock" ]
Switch KitchenLights "Kitchen Lights" <light> (gKitchen) { ga="Switch" }
Dimmer BedroomLights "Bedroom Lights" <light> (gBedroom) { ga="Light" }
Color LivingroomLights "Livingroom Lights" <light> (gLivingroom) { ga="Light" }
Switch SceneMovie "Livingroom Scene Movie" (gLivingroom) { synonyms="Movie Scene", ga="Scene" }
Switch CristmasTree "Cristmas Tree" (gLivingroom) { ga="Outlet" }
Switch DoorLock "Door Lock" { ga="Lock" }
//Thermostat Setup (Google requires a mode, even if you manually set it up in openHAB)
Group g_HK_Basement_TSTAT "Basement Thermostat" [ "Thermostat", "Fahrenheit" ]
Number HK_Basement_Mode "Basement Heating/Cooling Mode" (g_HK_Basement_TSTAT) [ "homekit:TargetHeatingCoolingMode" ]
Number HK_Basement_Temp "Basement Temperature" (g_HK_Basement_TSTAT) [ "CurrentTemperature" ]
Number HK_Basement_Humid "Basement Humidity" (g_HK_Basement_TSTAT) [ "CurrentHumidity" ]
Number HK_Basement_Setpoint "Basement Setpoint" (g_HK_Basement_TSTAT) [ "homekit:TargetTemperature" ]
Group g_HK_Basement_TSTAT "Basement Thermostat" { ga="Thermostat" [ useFahrenheit=true ] }
Number HK_Basement_Mode "Basement Heating/Cooling Mode" (g_HK_Basement_TSTAT) { ga="thermostatMode" }
Number HK_Basement_Setpoint "Basement Setpoint" (g_HK_Basement_TSTAT) { ga="thermostatTemperatureSetpoint" }
Number HK_Basement_Temp "Basement Temperature" (g_HK_Basement_TSTAT) { ga="thermostatTemperatureAmbient" }
Number HK_Basement_Humid "Basement Humidity" (g_HK_Basement_TSTAT) { ga="thermostatHumidityAmbient" }
```
Item labels are not mandatory in openHAB, but for the Google Assistant Action they are absolutely necessary!
It is the "label text" (e.g. "Kitchen Lights" for example above) and not the item's name that will be available to you via vocal commands or in the Google Home app, so make it unique and easy to say!
NOTA : tags are not (yet?) available via paperUI. Either you create your items via ".items" files, or you can:
- assign tags via REST api :
NOTA : metadata is not (yet?) available via paperUI. Either you create your items via ".items" files, or you can:
- add metadata via console :
```
curl -X PUT --header “Content-Type: application/json” --header “Accept: application/json” “http://localhost:8080/rest/items/[itemname]/tags/Lighting
```
- assign tags via console :
```
smarthome:items addTag MickTest Lighting
smarthome:metadata add BedroomLights ga Light
```
Notes Regarding Thermostat Items:
- Thermostat requires a group to be properly setup with Google Assistant, default format is Celsius.
- There must be at least 3 elements:
* (Mandatory) Mode: Number (Zwave THERMOSTAT_MODE Format) or String (off, heat, cool, on).
* (Mandatory) Current Temperature: Number.
* (Mandatory) Target Temperature: Number.
* (Optional) Current Humidity: Number.
* (Mandatory) Temperature Ambient: Number.
* (Mandatory) Temperature Setpoint: Number.
* (Optional) Humidity Ambient: Number.
- If your thermostat does not have a mode, you should create one and manually assign a value (e.g. heat, cool, on, etc.) to have proper functionality.
- See also HomeKit Addon for further formatting details.
## Setup & Usage on Google Assistant App
* Make sure Google Play Services is up to date.
@ -122,7 +121,7 @@ Notes Regarding Thermostat Items:
![openHAB Google App](images/Screenshot_6.png)
![openHAB Google App](images/Screenshot_7.png)
* You will now be able to see your previously tagged items and devices. Assign them to a room. Press Done.
* You will now be able to see your previously configured items and devices. Assign them to a room. Press Done.
![openHAB Google App](images/Screenshot_8.png)
![openHAB Google App](images/Screenshot_9.png)
@ -156,24 +155,24 @@ Here are some example voice commands:
I'm not able to connect openHAB to Google Home.
* Check, recheck and after that check again your items!
* The items that you want to expose to Google Assistant should have the right tags.
* The items that you want to expose to Google Assistant should have the right metadata assigned.
* The items that you want to expose to Google Assistant must have a item label! [Item Definition and Syntax](https://www.openhab.org/docs/configuration/items.html#item-definition-and-syntax)
* If you expose thermostats make sure than you have:
* A group item with the tag [ "Thermostat" ]
* A number or string item with the tag [ "homekit:TargetHeatingCoolingMode" ]
* A number item with the tag [ "CurrentTemperature" ]
* A number item with the tag [ "homekit:TargetTemperature" ]
* A group item with the metadata value { ga="Thermostat" }
* A number or string item with the metadata value { ga="thermostatMode" } as part of the thermostat group
* A number item with the metadata value { ga="thermostatTemperatureAmbient" } as part of the thermostat group
* A number item with the metadata value { ga="thermostatTemperatureSetpoint" } as part of the thermostat group
```
Group g_HK_Basement_TSTAT "Basement Thermostat" [ "Thermostat", "Fahrenheit" ]
Number HK_Basement_Mode "Basement Heating/Cooling Mode" (g_HK_Basement_TSTAT) [ "homekit:TargetHeatingCoolingMode" ]
Number HK_Basement_Temp "Basement Temperature" (g_HK_Basement_TSTAT) [ "CurrentTemperature" ]
Number HK_Basement_Setpoint "Basement Setpoint" (g_HK_Basement_TSTAT) [ "homekit:TargetTemperature" ]
Group g_HK_Basement_TSTAT "Basement Thermostat" { ga="Thermostat" [ useFahrenheit=true ] }
Number HK_Basement_Mode "Basement Heating/Cooling Mode" (g_HK_Basement_TSTAT) { ga="thermostatMode" }
Number HK_Basement_Setpoint "Basement Setpoint" (g_HK_Basement_TSTAT) { ga="thermostatTemperatureSetpoint" }
Number HK_Basement_Temp "Basement Temperature" (g_HK_Basement_TSTAT) { ga="thermostatTemperatureAmbient" }
```
* If none of the above solutions works for you:
* Remove all the tags.
* Remove all the metadata.
* Make a new .item file with 1 item to expose.
```
Switch TestLight "Test Light" [ "Switchable" ]
Switch TestLight "Test Light" { ga="Switch" }
```
* Relink your account.

2
_addons_transformations/scale/readme.md
View File

@ -74,7 +74,7 @@ Referenced scale file `uvindex.scale` in the `transform` folder:
]3..6]=2
]6..8]=3
]8..10]=4
[10..100]=5
]10..100]=5
```
Each value the item receives, will be categorized to one of the five given ranges.