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-20 15:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation of KNX sync_state and expected DPTs (#14482)

Browse Source
This commit is contained in:
Matthias Alphart 2020-09-19 09:32:20 +02:00 committed by GitHub
parent dfabd049eb
commit ade9374a22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 46 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,21 +8,13 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors. The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors.
Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus). Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus).
## Configuration ## Configuration
The `knx` integration must be configured correctly, see [KNX Integration](/integrations/knx). To use your binary sensors please add the relevant configuration to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
To use your binary sensors please add the relevant configuration to your top level KNX configuration key in `configuration.yaml`:
```yaml ```yaml
knx: knx:
@ -33,7 +25,7 @@ knx:
{% configuration %} {% configuration %}
state_address: state_address:
description: KNX group address of the binary sensor. description: KNX group address of the binary sensor. *DPT 1*
required: true required: true
type: string type: string
name: name:
@ -41,19 +33,14 @@ name:
required: false required: false
type: string type: string
sync_state: sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire <minutes>` to read the state from the KNX bus when no telegram was received for \<minutes\> or `every <minutes>` to update it regularly every \<minutes\>. Maximum value for \<minutes\> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60".
required: false required: false
type: boolean type: [boolean, string, integer]
default: True default: True
device_class: device_class:
description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend. description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend.
required: false required: false
type: string type: string
significant_bit:
description: Specify which significant bit of the KNX value should be used.
required: false
type: integer
default: 1
reset_after: reset_after:
description: Reset back to OFF state after specified milliseconds. description: Reset back to OFF state after specified milliseconds.
required: false required: false

20
source/_integrations/climate.knx.markdown
View File

@ -8,15 +8,9 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
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 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 `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -194,19 +188,19 @@ heat_cool_state_address:
required: false required: false
type: string type: string
operation_mode_frost_protection_address: operation_mode_frost_protection_address:
description: KNX address for switching on/off frost/heat protection mode. description: KNX address for switching on/off frost/heat protection mode. *DPT 1*
required: false required: false
type: string type: string
operation_mode_night_address: operation_mode_night_address:
description: KNX address for switching on/off night mode. description: KNX address for switching on/off night mode. *DPT 1*
required: false required: false
type: string type: string
operation_mode_comfort_address: operation_mode_comfort_address:
description: KNX address for switching on/off comfort mode. description: KNX address for switching on/off comfort mode. *DPT 1*
required: false required: false
type: string type: string
operation_mode_standby_address: operation_mode_standby_address:
description: KNX address for switching on/off standby mode. description: KNX address for switching on/off standby mode. *DPT 1*
required: false required: false
type: string type: string
operation_modes: operation_modes:
@ -214,7 +208,7 @@ operation_modes:
required: false required: false
type: list type: list
on_off_address: on_off_address:
description: KNX address for switching the climate device on/off. description: KNX address for switching the climate device on/off. *DPT 1*
required: false required: false
type: string type: string
on_off_invert: on_off_invert:
@ -223,7 +217,7 @@ on_off_invert:
default: false default: false
type: boolean type: boolean
on_off_state_address: on_off_state_address:
description: KNX address for gathering the current state (on/off) of the climate device. description: KNX address for gathering the current state (on/off) of the climate device. *DPT 1*
required: false required: false
type: string type: string
min_temp: min_temp:

22
source/_integrations/cover.knx.markdown
View File

@ -8,15 +8,9 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
The `knx` cover platform is used as an interface to KNX covers. 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: 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`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -39,31 +33,31 @@ name:
default: KNX Cover default: KNX Cover
type: string type: string
move_long_address: move_long_address:
description: KNX group address for moving the cover full up or down. description: KNX group address for moving the cover full up or down. *DPT 1*
required: false required: false
type: string type: string
move_short_address: move_short_address:
description: KNX group address for moving the cover short time up or down. description: KNX group address for moving the cover short time up or down. *DPT 1*
required: false required: false
type: string type: string
stop_address: stop_address:
description: KNX group address for stopping the current movement from the cover. description: KNX group address for stopping the current movement from the cover. *DPT 1*
required: false required: false
type: string type: string
position_address: position_address:
description: KNX group address for moving the cover to the dedicated position. description: KNX group address for moving the cover to the dedicated position. *DPT 5.001*
required: false required: false
type: string type: string
position_state_address: position_state_address:
description: Separate KNX group address for requesting the current position of the cover. description: Separate KNX group address for requesting the current position of the cover. *DPT 5.001*
required: false required: false
type: string type: string
angle_address: angle_address:
description: KNX group address for moving the cover to the dedicated angle. description: KNX group address for moving the cover to the dedicated angle. *DPT 5.001*
required: false required: false
type: string type: string
angle_state_address: angle_state_address:
description: Separate KNX group address for requesting the current angle of cover. description: Separate KNX group address for requesting the current angle of cover. *DPT 5.001*
required: false required: false
type: string type: string
travelling_time_down: travelling_time_down:

19
source/_integrations/knx.markdown
View File

@ -35,7 +35,7 @@ There is currently support for the following device types within Home Assistant:
- [Weather](/integrations/weather.knx) - [Weather](/integrations/weather.knx)
## Configuration ## Basic Configuration
To use your KNX bus in your installation, add the following lines to your `configuration.yaml` file: To use your KNX bus in your installation, add the following lines to your `configuration.yaml` file:
@ -90,7 +90,7 @@ knx:
{% configuration %} {% configuration %}
host: host:
description: Host of the KNX/IP tunneling device. description: IP address of the KNX/IP tunneling device.
type: string type: string
required: true required: true
port: port:
@ -98,7 +98,7 @@ port:
type: integer type: integer
required: false required: false
local_ip: local_ip:
description: IP of the local interface. description: IP address of the local interface.
type: string type: string
required: false required: false
{% endconfiguration %} {% endconfiguration %}
@ -113,7 +113,7 @@ knx:
{% configuration %} {% configuration %}
local_ip: local_ip:
description: The local IP address of interface (which should be used for multicasting). description: The local IP address of the interface that shall be used to send multicast packets.
type: string type: string
required: true required: true
{% endconfiguration %} {% endconfiguration %}
@ -141,7 +141,7 @@ state_updater:
type: boolean type: boolean
{% endconfiguration %} {% endconfiguration %}
### Services ## Services
In order to directly interact with the KNX bus, you can use the following service: In order to directly interact with the KNX bus, you can use the following service:
@ -156,17 +156,16 @@ address:
description: KNX group address description: KNX group address
type: string type: string
payload: payload:
description: Payload, either an integer or an array of integers description: Payload to send to the bus. When `type` is not set, raw bytes are sent. Integers are then treated as DPT 1/2/3 payloads. For DPTs > 6 bits send a list. Each value represents 1 octet (0-255). Pad with 0 to DPT byte length.
type: [integer, list] type: [integer, list]
type: type:
description: If set, the payload will not be sent as raw bytes, but encoded as given DPT. KNX sensor types are valid values. description: If set, the payload will not be sent as raw bytes, but encoded as given DPT. KNX sensor types are valid values - see table in [KNX Sensor](/integrations/sensor.knx).
required: false type: [string, integer, float]
type: string
{% endconfiguration %} {% endconfiguration %}
You can also use the `homeassistant.update_entity` service call to issue GroupValueRead requests for all `*state_address` of a device. You can also use the `homeassistant.update_entity` service call to issue GroupValueRead requests for all `*state_address` of a device.
### Exposing entity states, entity attributes or time to KNX bus ## Exposing entity states, entity attributes or time to KNX bus
KNX integration is able to expose entity states or attributes to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address. It is also possible to expose the current time. KNX integration is able to expose entity states or attributes to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address. It is also possible to expose the current time.

8
source/_integrations/light.knx.markdown
View File

@ -8,12 +8,6 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
The `knx light` integration is used as an interface to control KNX actuators for lighting applications such as: The `knx light` integration is used as an interface to control KNX actuators for lighting applications such as:
- switching actuators - switching actuators
@ -23,7 +17,7 @@ The `knx light` integration is used as an interface to control KNX actuators for
## Configuration ## Configuration
To use your KNX light in your installation, add the following lines to your `configuration.yaml` file: To use your KNX light in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

10
source/_integrations/notify.knx.markdown
View File

@ -8,17 +8,11 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
The `knx` notify platform allows you to send notifications to [KNX](https://www.knx.org/) devices. The `knx` notify platform allows you to send notifications to [KNX](https://www.knx.org/) devices.
## Configuration ## Configuration
To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file: To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml ```yaml
knx: knx:
@ -29,7 +23,7 @@ knx:
{% configuration %} {% configuration %}
address: address:
description: KNX group address of the notification. description: KNX group address of the notification. *DPT 16.000*
required: true required: true
type: string type: string
name: name:

10
source/_integrations/scene.knx.markdown
View File

@ -7,17 +7,11 @@ ha_release: 0.63
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
The `knx` scenes platform allows you to trigger [KNX](https://www.knx.org/) scenes. The `knx` scenes platform allows you to trigger [KNX](https://www.knx.org/) scenes.
## Configuration ## Configuration
To use your KNX scence in your installation, add the following to your `configuration.yaml` file: To use your KNX scence in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -30,7 +24,7 @@ knx:
{% configuration %} {% configuration %}
address: address:
description: KNX group address for the scene. description: KNX group address for the scene. *DPT 17.001*
required: true required: true
type: string type: string
scene_number: scene_number:

15
source/_integrations/sensor.knx.markdown
View File

@ -8,12 +8,6 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) sensors. The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) sensors.
Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus). Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus).
@ -21,7 +15,7 @@ Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integr
## Configuration ## Configuration
To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file: To use your KNX sensor in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -39,7 +33,7 @@ knx:
sensor: sensor:
- name: Heating.Valve1 - name: Heating.Valve1
state_address: '2/0/0' state_address: '2/0/0'
sync_state: 30 sync_state: expire 30
``` ```
{% configuration %} {% configuration %}
@ -52,7 +46,7 @@ name:
required: false required: false
type: string type: string
sync_state: sync_state:
description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. You can also define in seconds between 2 and 1440 how often the state update should take place. description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire <minutes>` to read the state from the KNX bus when no telegram was received for \<minutes\> or `every <minutes>` to update it regularly every \<minutes\>. Maximum value for \<minutes\> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60".
required: false required: false
type: [boolean, string, integer] type: [boolean, string, integer]
default: True default: True
@ -210,9 +204,10 @@ knx:
sensor: sensor:
- name: Heating.Valve1 - name: Heating.Valve1
state_address: '2/0/0' state_address: '2/0/0'
sync_state: init
type: 'percent' type: 'percent'
- name: Kitchen.Temperature - name: Kitchen.Temperature
state_address: '6/2/1' state_address: '6/2/1'
sync_state: False sync_state: every 60
type: 'temperature' type: 'temperature'
``` ```

12
source/_integrations/switch.knx.markdown
View File

@ -8,17 +8,11 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
The `knx` switch platform is used as an interface to switching actuators. The `knx` switch platform is used as an interface to switching actuators.
## Configuration ## Configuration
To use your KNX switch in your installation, add the following to your `configuration.yaml` file: To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
```yaml ```yaml
knx: knx:
@ -29,7 +23,7 @@ knx:
{% configuration %} {% configuration %}
address: address:
description: KNX group address for switching the switch on/off. description: KNX group address for switching the switch on/off. *DPT 1*
required: true required: true
type: string type: string
name: name:
@ -38,7 +32,7 @@ name:
default: KNX Switch default: KNX Switch
type: string type: string
state_address: state_address:
description: Separate KNX group address for retrieving the switch state. description: Separate KNX group address for retrieving the switch state. *DPT 1*
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}

8
source/_integrations/weather.knx.markdown
View File

@ -8,15 +8,9 @@ ha_iot_class: Local Push
ha_domain: knx ha_domain: knx
--- ---
<div class='note'>
The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/integrations/knx).
</div>
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 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 `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry