jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-29 04:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

KNX component updates for xknx 0.11 (#9682)

Browse Source 
* xknx 0.11

* update for xknx 0.11.1

- state_address instead of address
- sync_state option

* ✏️ Tweak

- Please check if this config variable `device_class` belongs here. For now it breaks netlify with building.

* copy and past error -.-

* even more typos

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweaks

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweaks

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak

* ✏️ Tweak
This commit is contained in:
Matthias Alphart 2019-08-06 12:33:24 +02:00 committed by Franck Nijhof
parent af7b284906
commit 3b597bb3bd
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
9 changed files with 172 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
source/_components/binary_sensor.knx.markdown
View File

@ -5,11 +5,19 @@ logo: knx.png
ha_category:
- Binary Sensor
ha_release: 0.24
ha_iot_class: Local Polling
ha_iot_class: Local Push
---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
</div>
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors.
Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/components/knx/#exposing-sensor-values-or-time-to-knx-bus).
## Configuration
The `knx` integration must be configured correctly, see [KNX Integration](/components/knx).
@ -18,11 +26,11 @@ The `knx` integration must be configured correctly, see [KNX Integration](/compo
# Example configuration.yaml entry
binary_sensor:
- platform: knx
address: '6/0/2'
state_address: '6/0/2'
```
{% configuration %}
address:
state_address:
description: KNX group address of the binary sensor.
required: true
type: string
@ -30,6 +38,11 @@ name:
description: A name for this device used within Home Assistant.
required: false
type: string
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus.
required: false
type: boolean
default: True
device_class:
description: Sets the [class of the device](/components/binary_sensor/), changing the device state and icon that is displayed on the frontend.
required: false
@ -54,7 +67,7 @@ You can also attach actions to binary sensors (e.g., to switch on a light when a
binary_sensor:
- platform: knx
name: Livingroom.3Switch3
address: '5/0/26'
state_address: '5/0/26'
automation:
- counter: 1
hook: 'on'

42
source/_components/climate.knx.markdown
View File

@ -5,12 +5,16 @@ logo: knx.png
ha_category:
- Climate
ha_release: 0.25
ha_iot_class: Local Polling
ha_iot_class: Local Push
---
The `knx` climate platform is used as in interface with KNX thermostats.
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
The `knx` integration must be configured correctly, see [KNX Integration](/components/knx).
</div>
The `knx` climate platform is used as an interface to KNX thermostats and room controllers.
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:
@ -24,6 +28,7 @@ climate:
setpoint_shift_state_address: '5/1/3'
target_temperature_state_address: '5/1/4'
operation_mode_address: '5/1/5'
operation_mode_state_address: '5/1/6'
```
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
@ -40,10 +45,11 @@ climate:
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
operation_mode_state_address: '5/1/8'
```
If your device doesn't support setpoint_shift calculations (i.e. if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp`
attributes of the climate device to avoid issues with increasing the temperature in the frontend. Please do also make sure to add the `target_temperature_address`
attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address`
to the config in this case.:
```yaml
@ -57,11 +63,13 @@ climate:
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
operation_mode_state_address: '5/1/8'
min_temp: 7.0
max_temp: 32.0
```
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` is specified.
If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading eg. when starting home-assistant.
The following values are valid for the `hvac_mode` attribute:
@ -86,27 +94,27 @@ name:
default: KNX Climate
type: string
temperature_address:
description: KNX group address for reading current room temperature from KNX bus.
description: KNX group address for reading current room temperature from KNX bus. *DPT 9.001*
required: true
type: string
target_temperature_address:
description: KNX group address for setting target temperature.
description: KNX group address for setting target temperature. *DPT 9.001*
required: false
type: string
target_temperature_state_address:
description: KNX group address for reading current target temperature from KNX bus.
description: KNX group address for reading current target temperature from KNX bus. *DPT 9.001*
required: true
type: string
setpoint_shift_address:
description: KNX address for setpoint_shift.
description: KNX address for setpoint_shift. *DPT 6.010*
required: false
type: string
setpoint_shift_state_address:
description: Explicit KNX address for reading setpoint_shift.
description: KNX address for reading setpoint_shift. *DPT 6.010*
required: false
type: string
setpoint_shift_step:
description: Defines for step size in Kelvin for each step of setpoint_shift.
description: Defines the step size in Kelvin for each step of setpoint_shift.
required: false
default: 0.5
type: float
@ -114,18 +122,18 @@ setpoint_shift_min:
description: Minimum value of setpoint shift.
required: false
default: -6
type: integer
type: float
setpoint_shift_max:
description: Maximum value of setpoint shift.
required: false
default: 6
type: integer
type: float
operation_mode_address:
description: KNX address for operation mode (Frost protection/night/comfort).
description: KNX address for setting operation mode (Frost protection/night/comfort). *DPT 20.102*
required: false
type: string
operation_mode_state_address:
description: Explicit KNX address for reading operation mode.
description: KNX address for reading operation mode. *DPT 20.102*
required: false
type: string
controller_status_address:
@ -133,15 +141,15 @@ controller_status_address:
required: false
type: string
controller_status_state_address:
description: Explicit KNX address for reading HVAC controller status.
description: KNX address for reading HVAC controller status.
required: false
type: string
controller_mode_address:
description: KNX address for handling controller modes.
description: KNX address for setting HVAC controller modes. *DPT 20.105*
required: false
type: string
controller_mode_state_address:
description: Explicit KNX address for reading HVAC Control Mode.
description: KNX address for reading HVAC Control Mode. *DPT 20.105*
required: false
type: string
operation_mode_frost_protection_address:

9
source/_components/cover.knx.markdown
View File

@ -5,13 +5,16 @@ logo: knx.png
ha_category:
- Cover
ha_release: 0.48
ha_iot_class: Local Polling
ha_iot_class: Local Push
---
<div class='note'>
The `knx` cover platform is used as in interface with KNX covers.
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
The `knx` integration must be configured correctly, see [KNX Integration](/components/knx).
</div>
The `knx` cover platform is used as an interface to KNX covers.
To use your KNX covers in your installation, add the following to your `configuration.yaml` file:

29
source/_components/knx.markdown
View File

@ -5,17 +5,15 @@ logo: knx.png
ha_category:
- Hub
ha_release: 0.24
ha_iot_class: Local Polling
ha_iot_class: Local Push
---
The [KNX](https://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices.
The integration requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.
<div class='note warning'>
Please note, the `knx` platform does not support Windows.
The integration requires a local KNX/IP interface or a KNX/IP router. Through this, it will send and receive commands to and from other devices to the KNX bus.
<div class='note'>
Please note, the `knx` platform does not support Windows.
</div>
There is currently support for the following device types within Home Assistant:
@ -69,19 +67,21 @@ knx:
host:
description: Host of the KNX/IP tunneling device.
type: string
required: true
port:
description: Port of the KNX/IP tunneling device.
type: integer
required: false
local_ip:
description: IP of the local interface.
type: string
required: false
{% endconfiguration %}
Explicit connection to a KNX/IP routing device:
```yaml
knx:
config_file: '/path/to/xknx.yaml'
routing:
local_ip: '192.168.2.109'
```
@ -90,6 +90,7 @@ knx:
local_ip:
description: The local IP address of interface (which should be used for multicasting).
type: string
required: true
{% endconfiguration %}
```yaml
@ -117,7 +118,7 @@ state_updater:
### Services
In order to directly interact with the KNX bus, you can now use the following service:
In order to directly interact with the KNX bus, you can use the following service:
```
Domain: knx
@ -145,6 +146,12 @@ knx:
- type: 'temperature'
entity_id: 'sensor.owm_temperature'
address: '0/0/2'
- type: 'string'
address: '0/6/4'
entity_id: "sensor.owm_weather"
- type: 'binary'
entity_id: 'binary_sensor.kitchen_window'
address: '0/6/5'
- type: 'time'
address: '0/0/1'
- type: 'datetime'
@ -153,12 +160,14 @@ knx:
{% configuration %}
type:
description: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity").
description: Type of the exposed value. Either 'binary', 'time', 'date', 'datetime' or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity").
type: string
required: true
entity_id:
description: Entity id of the HASS integration to be exposed. Not necessary for types time and datetime.
description: Entity id to be exposed. Not needed for types time, date and datetime.
type: string
address:
description: KNX group address.
type: string
required: true
{% endconfiguration %}

18
source/_components/light.knx.markdown
View File

@ -5,9 +5,15 @@ logo: knx.png
ha_category:
- Light
ha_release: 0.44
ha_iot_class: Local Polling
ha_iot_class: Local Push
---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
</div>
The `knx light` integration is used as an interface to control knx actuators for lighting applications such as:
- switching actuators
@ -15,8 +21,6 @@ The `knx light` integration is used as an interface to control knx actuators for
- LED controllers
- DALI gateways
The `knx` integration must be configured correctly to use this component, see [KNX Component](/components/knx).
## Configuration
To use your KNX light in your installation, add the following lines to your `configuration.yaml` file:
@ -57,6 +61,14 @@ color_state_address:
description: KNX group address for retrieving the RGB color of the light. *DPT 232.600*
required: false
type: string
rgbw_address:
description: KNX group address for setting the RGBW color of the light. *DPT 251.600*
required: false
type: string
rgbw_state_address:
description: KNX group address for retrieving the RGBW color of the light. *DPT 251.600*
required: false
type: string
color_temperature_address:
description: KNX group address for setting the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode*
required: false

8
source/_components/notify.knx.markdown
View File

@ -8,9 +8,13 @@ ha_release: 0.53
ha_iot_class: Local Push
---
The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices.
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
</div>
The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices.
## Configuration

12
source/_components/scene.knx.markdown
View File

@ -7,9 +7,13 @@ ha_category:
ha_release: 0.63
---
The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes.
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
</div>
The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes.
## Configuration
@ -26,11 +30,11 @@ scene:
{% configuration %}
address:
description: KNX group address of the binary sensor.
description: KNX group address for the scene.
required: true
type: string
scene_number:
description: Zero-indexed KNX scene number to be activated.
description: KNX scene number to be activated. ( 1 ... 64 )
required: true
type: integer
name:

106
source/_components/sensor.knx.markdown
View File

@ -1,6 +1,6 @@
---
title: "KNX Sensor"
description: "Instructions on how to use the KNX Sensor with Home Assistant."
description: "Instructions on how to use a KNX Sensor with Home Assistant."
logo: knx.png
ha_category:
- Sensor
@ -8,9 +8,16 @@ ha_release: 0.29
ha_iot_class: Local Push
---
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors.
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
</div>
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors.
Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/components/knx/#exposing-sensor-values-or-time-to-knx-bus).
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
## Configuration
@ -33,44 +40,68 @@ name:
description: A name for this device used within Home Assistant.
required: false
type: string
type:
description: A type from the following table can be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly.
sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus.
required: false
type: boolean
default: True
type:
description: A type from the following table must be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly.
required: true
type: string
{% endconfiguration %}
| type | unit | expected KNX DPT |
|--------------------|------|------------------|
| percent | % | 5.001 |
| pulse | | 5.010 |
| temperature | °C | 9.001 |
| humidity | % | 9.007 |
| illuminance | lx | 9.004 |
| brightness | lx | 7.013 |
| speed_ms | m/s | 9.005 |
| current | mA | 7.012 |
| voltage | mV | 9.020 |
| power | W | 14.056 |
| electric_current | A | 14.019 |
| electric_potential | V | 14.027 |
| energy | J | 14.031 |
| frequency | Hz | 14.033 |
| heatflowrate | W | 14.036 |
| phaseanglerad | rad | 14.054 |
| phaseangledeg | ° | 14.055 |
| powerfactor | | 14.057 |
| speed | m/s | 14.065 |
| enthalpy | H | 9.* |
| ppm | ppm | 9.008 |
| DPT-7 | | 7.* |
| 2byte_unsigned | | 7.* |
| DPT-9 | | 9.* |
| DPT-12 | | 12.* |
| 4byte_unsigned | | 12.* |
| DPT-13 | | 13.* |
| 4byte_signed | | 13.* |
| DPT-14 | | 14.* |
| 4byte_float | | 14.* |
| KNX DPT | type | size in byte | unit |
|--------:|--------------------|-------------:|----------------|
| 5.001 | percent | 1 | % |
| 5.003 | angle | 1 | ° |
| 5.004 | percentU8 | 1 | % |
| 5.010 | pulse | 1 | |
| 5.010 | DPT-5 | 1 | |
| 5.010 | 1byte_unsigned | 1 | |
| 6.001 | percentV8 | 1 | % |
| 6.010 | counter_pulses | 1 | counter pulses |
| 7.*** | DPT-7 | 2 | |
| 7.001 | 2byte_unsigned | 2 | pulses |
| 7.012 | current | 2 | mA |
| 7.013 | brightness | 2 | lx |
| 7.600 | color_temperature | 2 | K |
| 8.*** | DPT-8 | 2 | |
| 8.001 | 2byte_signed | 2 | pulses |
| 8.002 | delta_time_ms | 2 | ms |
| 8.005 | delta_time_sec | 2 | s |
| 8.006 | delta_time_min | 2 | min |
| 8.007 | delta_time_hrs | 2 | h |
| 8.010 | percentV16 | 2 | % |
| 8.011 | rotation_angle | 2 | ° |
| 9.* | enthalpy | 2 | H |
| 9.*** | DPT-9 | 2 | |
| 9.001 | temperature | 2 | °C |
| 9.004 | illuminance | 2 | lx |
| 9.005 | speed_ms | 2 | m/s |
| 9.007 | humidity | 2 | % |
| 9.008 | ppm | 2 | ppm |
| 9.020 | voltage | 2 | mV |
| 12.*** | DPT-12 | 4 | |
| 12.*** | 4byte_unsigned | 4 | |
| 13.*** | DPT-13 | 4 | |
| 13.*** | 4byte_signed | 4 | |
| 14.*** | DPT-14 | 4 | |
| 14.*** | 4byte_float | 4 | |
| 14.019 | electric_current | 4 | A |
| 14.027 | electric_potential | 4 | V |
| 14.031 | energy | 4 | J |
| 14.033 | frequency | 4 | Hz |
| 14.036 | heatflowrate | 4 | W |
| 14.042 | luminous_flux | 4 | lm |
| 14.054 | phaseanglerad | 4 | rad |
| 14.055 | phaseangledeg | 4 | ° |
| 14.056 | power | 4 | W |
| 14.057 | powerfactor | 4 | |
| 14.058 | pressure | 4 | Pa |
| 14.065 | speed | 4 | m/s |
| 16.000 | string | 14 | |
| 17.001 | scene_number | 1 | |
## Full example
@ -84,5 +115,6 @@ sensor:
- platform: knx
name: Kitchen.Temperature
state_address: '6/2/1'
sync_state: False
type: 'temperature'
```

10
source/_components/switch.knx.markdown
View File

@ -5,12 +5,16 @@ logo: knx.png
ha_category:
- Switch
ha_release: 0.24
ha_iot_class: Local Polling
ha_iot_class: Local Push
---
The `knx` switch integration is used as in interface to switching actuators.
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx).
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
</div>
The `knx` switch platform is used as an interface to switching actuators.
## Configuration