1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
---
layout: default
title: Climate / HVAC
parent: Devices
nav_order: 2
---
# [](#header-1)HVAC/Climate controls
## [](#header-2)Overview
Climate are representations of KNX HVAC/Climate controls.
## [](#header-2)Interface
- `xknx` is the XKNX object.
- `name` is the name of the object.
- `group_address_temperature` KNX address of current room temperature. *DPT 9.001*
- `group_address_target_temperature` KNX address for setting the target temperature if setpoint shift is not supported. *DPT 9.001*
- `group_address_target_temperature_state` KNX address for reading the target temperature from the KNX bus. Used in for setpoint_shift calculations as base temperature. *DPT 9.001*
- `group_address_setpoint_shift` KNX address to set setpoint_shift (base temperature deviation). *DPT 6.010* or *DPT 9.002*
- `group_address_setpoint_shift_state` KNX address to read current setpoint_shift. *DPT 6.010* or *DPT 9.002*
- `group_address_fan_speed` KNX address for the fan speed. *DPT 5.001 / 5.010*
- `group_address_fan_speed_state` KNX address for reading fan speed. *DPT 5.001 / 5.010*
- `group_address_swing` KNX address for fan swing. If `group_address_horizontal_swing` is present this should refer to vertical swing *DPT 1*
- `group_address_swing_state` KNX address for reading fan swing. If `group_address_horizontal_swing` is present this should refer to vertical swing *DPT 1*
- `group_address_horizontal_swing` KNX address for horizontal fan swing. *DPT 1*
- `group_address_horizontal_swing_state` KNX address for reading horizontal fan swing. *DPT 1*
- `setpoint_shift_mode` SetpointShiftMode Enum for setpoint_shift payload encoding. When `None` it is inferred from first incoming payload. Default: `None`
- `setpoint_shift_max` Maximum value for setpoint_shift.
- `setpoint_shift_min` Minimum value for setpoint_shift.
- `temperature_step` Set the multiplier for setpoint_shift calculations when DPT 6.010 is used.
- `group_address_on_off` KNX address for turning climate device on or off. *DPT 1*
- `group_address_on_off_state` KNX address for reading the on/off state. *DPT 1*
- `on_off_invert` Invert on/off. Default: `False`
- `group_address_active_state` KNX address for reading if the climate device is currently active. *DPT 1*
- `group_address_command_value_state` KNX address for reading the current command value / valve position in %. *DPT 5.001*
- `group_address_humidity_state` KNX address of current room humidity. *DPT 9.007*
- `sync_state` defines if and how often the value should be actively read from the bus. If `False` no GroupValueRead telegrams will be sent to its group address. Defaults to `True`
- `max_temp` Maximum value for target temperature.
- `min_temp` Minimum value for target temperature.
- `fan_speed_mode` Defines the mode of fan speed control. Can be either `FanSpeedMode.STEP` for step-wise control or `FanSpeedMode.PERCENT` for percentage control. For `STEP` mode, the fan speed is controlled by sending integer values, and the group address uses *DPT 5.010*. For `PERCENT` mode, the fan speed is controlled by sending percentage values (0-100%), and the group address uses *DPT 5.001*. Default: `FanSpeedMode.PERCENT`.
- `mode` ClimateMode instance for this climate device
- `group_address_operation_mode` KNX address for operation mode. *DPT 20.102*
- `group_address_operation_mode_state` KNX address for operation mode status. *DPT 20.102*
- `group_address_operation_mode_protection` KNX address for switching on/off building protection mode. *DPT 1*
- `group_address_operation_mode_economy` KNX address for switching on/off economy mode. *DPT 1*
- `group_address_operation_mode_comfort` KNX address for switching on/off comfort mode. *DPT 1*
- `group_address_operation_mode_standby` KNX address for switching on/off standby mode. *DPT 1*
- `group_address_controller_status` KNX address for controller status.
- `group_address_controller_status_state` KNX address for controller status state.
- `group_address_controller_mode` KNX address for controller mode. *DPT 20.105*
- `group_address_controller_mode_state` KNX address for controller mode status. *DPT 20.105*
- `group_address_heat_cool` KNX address for switching heating / cooling mode. *DPT 1*
- `group_address_heat_cool_state` KNX address for reading heating / cooling mode. *DPT 1*
- `operation_modes` Overrides the supported operation modes.
- `controller_modes` Overrides the supported controller modes.
- `device_updated_cb` Callback for each update.
**Note:** `group_address_operation_mode_protection` / `group_address_operation_mode_economy` / `group_address_operation_mode_comfort` / `group_address_operation_mode_standby` are not necessary if `group_address_operation_mode` was specified. When one of these is set `True`, the others will be set `False`. When one of these is set `Standby`, `Comfort`, `Building Protection` and `Economy` will be set as supported. If `group_address_operation_mode_standby` is omitted, `Standby` is set when the other 3 are set to `False`.
If only a subset of operation modes shall be used a list of supported modes may be passed to `operation_modes`.
```python
climate_mode = ClimateMode(
xknx,
'TestClimateMode',
group_address_operation_mode='',
group_address_operation_mode_state='',
group_address_operation_mode_protection=None,
group_address_operation_mode_economy=None,
group_address_operation_mode_comfort=None,
group_address_controller_status=None,
group_address_controller_status_state=None,
group_address_controller_mode=None,
group_address_controller_mode_state=None,
operation_modes=None,
controller_modes=None,
device_updated_cb=None,
)
climate = Climate(
xknx,
'TestClimate',
group_address_temperature='',
group_address_target_temperature='',
group_address_target_temperature_state='',
group_address_setpoint_shift='',
group_address_setpoint_shift_state='',
group_address_fan_speed=None,
group_address_fan_speed_state=None,
group_address_swing=None,
group_address_swing_sate=None,
group_address_horizontal_swing=None,
group_address_horizontal_swing_state=None,
temperature_step=0.1,
setpoint_shift_max=6,
setpoint_shift_min=-6,
group_address_on_off='',
group_address_on_off_state='',
on_off_invert=False,
min_temp=18,
max_temp=26,
mode=climate_mode,
device_updated_cb=None,
fan_speed_mode=FanSpeedMode.STEP,
group_address_humidity_state='',
)
xknx.devices.async_add(climate)
xknx.devices.async_add(climate_mode)
# Set target temperature to 23 degrees. Works with setpoint_shift too.
await climate.set_target_temperature(23)
# Set new setpoint shift value.
await climate.set_setpoint_shift(1)
# Reading climate device
await climate.sync(wait_for_result=True)
print("Current temperature: ", climate.temperature)
# Shutdown the Climate and the underlying ClimateMode!
climate.shutdown()
```
## [](#header-2)Example
```python
climate_setpoint_shift = Climate(
xknx,
'TestClimateSPS',
group_address_temperature='1/2/2',
group_address_target_temperature_state='1/2/5',
group_address_setpoint_shift='1/2/3',
group_address_setpoint_shift_state='1/2/4'
)
climate_target_temp = Climate(
xknx,
'TestClimateTT',
group_address_temperature='2/2/2',
group_address_target_temperature='2/2/3',
group_address_target_temperature_state='2/2/4'
)
```
|
