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-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add KNX integration removal instructions (#36800)

Browse Source 
* Add KNX integration removal instructions

* Use more terms

* add missing logger information

* tiny tweaks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Matthias Alphart 2025-01-08 13:50:30 +01:00 committed by GitHub
parent 79aa1dad55
commit 5c052e633d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/_integrations/knx.markdown
View File

@ -416,7 +416,7 @@ automation:
### Register event ### Register event
The `knx.event_register` action can be used to register (or unregister) group addresses to fire `knx_event` Events. Events for group addresses configured in the `event` key in `configuration.yaml` cannot be unregistered. See [knx_event](#events) The `knx.event_register` action can be used to register (or unregister) group addresses to fire `knx_event` Events. Events for group addresses configured in the `event` key in {% term "`configuration.yaml`" %} cannot be unregistered. See [knx_event](#events)
{% configuration %} {% configuration %}
address: address:
@ -436,7 +436,7 @@ type:
### Register exposure ### Register exposure
The `knx.exposure_register` action can be used to register (or unregister) exposures to the KNX bus. Exposures defined in `configuration.yaml` can not be unregistered. Per address only one exposure can be registered. See [expose](#exposing-entity-states-entity-attributes-or-time-to-knx-bus) The `knx.exposure_register` action can be used to register (or unregister) exposures to the KNX bus. Exposures defined in {% term "`configuration.yaml`" %} can not be unregistered. Per address only one exposure can be registered. See [expose](#exposing-entity-states-entity-attributes-or-time-to-knx-bus)
{% configuration %} {% configuration %}
remove: remove:
@ -740,7 +740,7 @@ entity_category:
The KNX climate platform is used as an interface to KNX thermostats and room controllers. 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 top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: To use your KNX thermostats in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in {% term "`configuration.yaml`" %}:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -1017,7 +1017,7 @@ Unlike most KNX devices, Home Assistant defines 0% as closed and 100% as fully o
Home Assistant will, by default, `close` a cover by moving it in the `DOWN` direction in the KNX nomenclature, and `open` a cover by moving it in the `UP` direction. Home Assistant will, by default, `close` a cover by moving it in the `DOWN` direction in the KNX nomenclature, and `open` a cover by moving it in the `UP` direction.
{% endnote %} {% endnote %}
To use your KNX covers in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: To use your KNX covers in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in your {% term "`configuration.yaml`" %}:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -1243,7 +1243,7 @@ The KNX fan integration is used to control KNX fans. Following control types are
- Percentage controlled: Fans that set the percentage directly from 0-100%. - Percentage controlled: Fans that set the percentage directly from 0-100%.
- Step controlled: Fans which have a fixed amount of steps to set. The integration will convert percentage to step automatically. The `max_step` attribute is set to the number of steps of the fan, not counting the `off`-step. Example: A fan supports the steps 0 to 3. To use this fan the `max_step` attribute has to be set to `3`. The integration will convert the percentage `66 %` to the step `2` when sending data to KNX. - Step controlled: Fans which have a fixed amount of steps to set. The integration will convert percentage to step automatically. The `max_step` attribute is set to the number of steps of the fan, not counting the `off`-step. Example: A fan supports the steps 0 to 3. To use this fan the `max_step` attribute has to be set to `3`. The integration will convert the percentage `66 %` to the step `2` when sending data to KNX.
To use your KNX fan in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: To use your KNX fan in your installation, add the following lines to your top-level [KNX Integration](/integrations/knx) configuration key in your {% term "`configuration.yaml`" %}:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -1788,7 +1788,7 @@ knx:
type: percent type: percent
``` ```
In order to actively read the sensor data from the bus every 30 minutes you can add the following lines to your `configuration.yaml`: In order to actively read the sensor data from the bus every 30 minutes you can add the following lines to your {% term "`configuration.yaml`" %}:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -2225,7 +2225,7 @@ entity_category:
The KNX weather platform is used as an interface to KNX weather stations. The KNX weather platform is used as an interface to KNX weather stations.
To use your KNX weather station in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: To use your KNX weather station in your installation, add the following lines to your top-level [KNX Integration](/integrations/knx) configuration key in your {% term "`configuration.yaml`" %}:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -2334,8 +2334,8 @@ entity_category:
### Logs for the KNX integration ### Logs for the KNX integration
`xknx`, the library used for KNX communication, provides various logging handlers for monitoring and debug purposes. The [`xknx` library](https://github.com/XKNX/xknx) is used for KNX communication. It provides various logging handlers for monitoring and debug purposes.
Add the following lines to your Home Assistant `configuration.yaml` to activate them: Add the following lines to your Home Assistant {% term "`configuration.yaml`" %} to activate them:
```yaml ```yaml
logger: logger:
@ -2352,6 +2352,7 @@ logger:
xknx.knx: debug # logs incoming and outgoing KNX/IP frames xknx.knx: debug # logs incoming and outgoing KNX/IP frames
xknx.raw_socket: warning # logs incoming UDP/TCP frames in raw hex format at socket level xknx.raw_socket: warning # logs incoming UDP/TCP frames in raw hex format at socket level
# Loggers for xknx internals # Loggers for xknx internals
xknx.ga_dpt: warning # logs when payloads can't be decoded with given project file information
xknx.state_updater: warning # provides information about the state updater xknx.state_updater: warning # provides information about the state updater
``` ```
@ -2403,3 +2404,17 @@ The `unique_id` for KNX entities is generated based on required configuration va
- weather: `address_temperature` - weather: `address_temperature`
There can not be multiple entities on the same platform sharing these exact group addresses, even if they differ in other configuration. There can not be multiple entities on the same platform sharing these exact group addresses, even if they differ in other configuration.
## Remove integration
This integration can be removed by following these steps:
{% include integrations/remove_device_service.md %}
In addition, remove `knx:` from your {% term "`configuration.yaml`" %}.
{% warning %}
Removing the integration will delete an uploaded keyring file, ETS project information, telegram history, and all entity configuration done via the UI panel.
{% endwarning %}