Skip to content

KNX: Update docs - added rate_limit and target_temperature_state_address #8785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions source/_components/climate.knx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ climate:
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_address: '5/1/4'
target_temperature_state_address: '5/1/4'
operation_mode_address: '5/1/5'
```

Expand All @@ -41,17 +41,33 @@ climate:
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_state_address: '5/1/4'
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
```

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`
to the config in this case.:

```yaml
# Example configuration.yaml entry
climate:
- platform: knx
name: HASS-Kitchen.Temperature
temperature_address: '5/1/2'
target_temperature_address: '5/1/4'
target_temperature_state_address: '5/1/1'
operation_mode_frost_protection_address: '5/1/5'
operation_mode_night_address: '5/1/6'
operation_mode_comfort_address: '5/1/7'
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 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.

The following values are valid for the `operation_modes` attribute:

- Comfort (maps internally to STATE_HEAT within Home Assistant)
Expand All @@ -72,6 +88,10 @@ temperature_address:
required: true
type: string
target_temperature_address:
description: KNX group address for setting target temperature.
required: false
type: string
target_temperature_state_address:
description: KNX group address for reading current target temperature from KNX bus.
required: true
type: string
Expand Down
5 changes: 5 additions & 0 deletions source/_components/knx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ config_file:
description: The path for XKNX configuration file.
required: false
type: string
rate_limit:
description: Defines the maximum number of telegrams to be sent to the bus per second (range 1-100).
required: false
default: 20
type: integer
{% endconfiguration %}

If the auto detection of the KNX/IP device does not work you can specify ip/port of the tunneling device:
Expand Down