Add documentation for KNX IP secure (#22203)

This commit is contained in:
Marvin Wichmann 2022-03-31 00:59:19 +02:00 committed by GitHub
parent 7457e7e822
commit f67c9456c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 25 additions and 6 deletions

View File

@ -46,12 +46,6 @@ The [KNX](https://www.knx.org) integration for Home Assistant allows you to conn
The integration requires a local KNX/IP interface or router. Through this, it will establish a connection between Home Assistant and your KNX bus.
<div class='note warning'>
Please note, the KNX platform does not support KNX Secure.
</div>
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
@ -121,6 +115,31 @@ Connection parameters are set up when adding the integration and can be changed
Use `route back` if your tunneling server is located on a different network.
### KNX Secure
The KNX integration currently supports IP secure tunneling.
IP secure via routing and data secure are currently not supported.
In order to use IP Secure you will have to chose "Tunneling" -> "TCP with IP Secure" in the config flow.
You can configure the IP Secure credentials either manually or by providing a `.knxkeys` file, which you can obtain by exporting the keyring in ETS as seen in the screenshot below.
![Export Keyring in ETS5](/images/integrations/knx/export_keyring_ets.png)
The `.knxkeys` file has to be placed in `config/.storage/knx/yourfile.knxkeys`.
If you decide to configure IP Secure manually you will need the user ID, the user password and the device authentication password.
The user id 0 is reserved and the user id 1 is used for management tasks, thus you will need to specify a user id that is 2 or higher according to the tunneling channel you would like to use.
The following screenshot will show how you can get the device authentication password in ETS.
![Obtain device authentication password in ETS](/images/integrations/knx/device_authentication_password.png)
The user password can be obtained almost the same way as seen in the below screenshot.
![Obtain the user password in ETS](/images/integrations/knx/user_password.png)
## Events
```yaml

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB