jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Fix samples, add title and other changes (#3828)

Browse source
This commit is contained in:
Fabian Affolter 2017-10-30 07:54:34 +01:00 • committed by GitHub
parent 9faef559b6
commit f91615cbb6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 106 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

39
source/_components/knx.markdown
View file

@ -13,8 +13,6 @@ ha_release: 0.24
ha_iot_class: "Local Polling"
---
Overview
--------
The [KNX](http://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices.
@ -30,8 +28,7 @@ There is currently support for the following device types within Home Assistant:
- [Thermostat](/components/climate.knx)
- [Notify](/components/notify.knx)
Configuration
--------------
### {% linkable_title Configuration %}
To use your KNX in your installation, add the following lines to your `configuration.yaml` file:
@ -39,13 +36,14 @@ To use your KNX in your installation, add the following lines to your `configura
knx:
```
Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside HASS:
Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside of Home Assistant:
```yaml
knx:
config_file: '/path/to/xknx.yaml'
```
* **config_file**: (*Optional*) path for xknx configuration file.
- **config_file** (*Optional*): The path for XKNX configuration file.
If the auto detection of the KNX/IP device does not work you can specify ip/port of the tunneling device:
@ -56,9 +54,10 @@ knx:
port: 3671
local_ip: '192.168.2.109'
```
* **host**: Host of the KNX/IP tunneling device
* **port**: Port of the KNX/IP tunneling device
* **local_ip**: IP of the local interface
- **host**: Host of the KNX/IP tunneling device.
- **port**: Port of the KNX/IP tunneling device.
- **local_ip**: IP of the local interface.
Explicit connection to a KNX/IP routing device:
@ -68,7 +67,8 @@ knx:
routing:
local_ip: '192.168.2.109'
```
* **local_ip**: local ip of interface (which should be used for multicasting)
- **local_ip**: The local IP address of interface (which should be used for multicasting).
```yaml
knx:
@ -76,13 +76,11 @@ knx:
fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
```
* **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus
* **fire_event_filter** (*Optional*): If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HASS event bus.
- **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus
- **fire_event_filter** (*Optional*): If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.
- **state_updater** (*Optional*): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.
* **state_updater** (*Optional*): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.
Service
-------
### {% linkable_title Services %}
In order to directly interact with the KNX bus, you can now use the following service:
@ -96,12 +94,7 @@ Service Data: {"address": "1/0/15", "payload": 0}
* **payload**: Payload, either an integer or an array of integers
### {% linkable_title Known issues %}
Known issues:
-------------
Due to lame multicast support the routing abstraction and the gateway scanner
only work with python >=3.5.
Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5.