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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
"""Unit test for NumericValue objects."""
from unittest.mock import Mock
import pytest
from xknx import XKNX
from xknx.devices import NumericValue
from xknx.dpt import DPTArray
from xknx.telegram import GroupAddress, Telegram
from xknx.telegram.apci import GroupValueRead, GroupValueResponse, GroupValueWrite
class TestNumericValue:
"""Test class for NumericValue objects."""
@pytest.mark.parametrize(
"value_type,raw_payload,expected_state",
[
# DPT-14 values are according to ETS group monitor values
(
"absolute_temperature",
DPTArray((0x44, 0xD7, 0xD2, 0x8B)),
1726.579,
),
(
"angle",
DPTArray((0xE4,)),
322,
),
(
"brightness",
DPTArray((0xC3, 0x56)),
50006,
),
(
"color_temperature",
DPTArray((0x6C, 0x95)),
27797,
),
(
"counter_pulses",
DPTArray((0x9D,)),
-99,
),
(
"current",
DPTArray((0xCA, 0xCC)),
51916,
),
(
"percent",
DPTArray((0xE3,)),
89,
),
(
"percentU8",
DPTArray((0x6B,)),
107,
),
(
"percentV8",
DPTArray((0x20,)),
32,
),
(
"percentV16",
DPTArray((0x8A, 0x2F)),
-301.61,
),
(
"pulse",
DPTArray((0xFC,)),
252,
),
(
"scene_number",
DPTArray((0x1,)),
2,
),
],
)
async def test_sensor_value_types(
self,
value_type: str,
raw_payload: DPTArray,
expected_state: int,
) -> None:
"""Test sensor value types."""
xknx = XKNX()
sensor = NumericValue(
xknx,
"TestSensor",
group_address="1/2/3",
value_type=value_type,
)
sensor.process(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(value=raw_payload),
)
)
assert sensor.resolve_state() == expected_state
#
# TEST RESPOND
#
async def test_respond_to_read(self) -> None:
"""Test respond_to_read function."""
xknx = XKNX()
responding = NumericValue(
xknx,
"TestSensor1",
group_address="1/1/1",
respond_to_read=True,
value_type="volume_liquid_litre",
)
non_responding = NumericValue(
xknx,
"TestSensor2",
group_address="1/1/1",
respond_to_read=False,
value_type="volume_liquid_litre",
)
responding_multiple = NumericValue(
xknx,
"TestSensor3",
group_address=["1/1/1", "3/3/3"],
group_address_state="2/2/2",
respond_to_read=True,
value_type="volume_liquid_litre",
)
# set initial payload of NumericValue
responding.sensor_value.value = 256
non_responding.sensor_value.value = 256
responding_multiple.sensor_value.value = 256
read_telegram = Telegram(
destination_address=GroupAddress("1/1/1"), payload=GroupValueRead()
)
# verify no response when respond is False
non_responding.process(read_telegram)
assert xknx.telegrams.qsize() == 0
# verify response when respond is True
responding.process(read_telegram)
assert xknx.telegrams.qsize() == 1
response = xknx.telegrams.get_nowait()
assert response == Telegram(
destination_address=GroupAddress("1/1/1"),
payload=GroupValueResponse(DPTArray((0x00, 0x00, 0x01, 0x00))),
)
# verify no response when GroupValueRead request is not for group_address
responding_multiple.process(read_telegram)
assert xknx.telegrams.qsize() == 1
response = xknx.telegrams.get_nowait()
assert response == Telegram(
destination_address=GroupAddress("1/1/1"),
payload=GroupValueResponse(DPTArray((0x00, 0x00, 0x01, 0x00))),
)
responding_multiple.process(
Telegram(
destination_address=GroupAddress("2/2/2"), payload=GroupValueRead()
)
)
responding_multiple.process(
Telegram(
destination_address=GroupAddress("3/3/3"), payload=GroupValueRead()
)
)
assert xknx.telegrams.qsize() == 0
#
# TEST SET
#
async def test_set_percent(self) -> None:
"""Test set with percent numeric value."""
xknx = XKNX()
num_value = NumericValue(
xknx, "TestSensor", group_address="1/2/3", value_type="percent"
)
await num_value.set(75)
assert xknx.telegrams.qsize() == 1
telegram = xknx.telegrams.get_nowait()
assert telegram == Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0xBF,))),
)
async def test_set_temperature(self) -> None:
"""Test set with temperature numeric value."""
xknx = XKNX()
num_value = NumericValue(
xknx, "TestSensor", group_address="1/2/3", value_type="temperature"
)
await num_value.set(21.0)
assert xknx.telegrams.qsize() == 1
telegram = xknx.telegrams.get_nowait()
assert telegram == Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x0C, 0x1A))),
)
# test HomeAssistant device class
assert num_value.ha_device_class() == "temperature"
#
# SYNC
#
async def test_sync(self) -> None:
"""Test sync function / sending group reads to KNX bus."""
xknx = XKNX()
sensor = NumericValue(
xknx, "TestSensor", value_type="temperature", group_address_state="1/2/3"
)
await sensor.sync()
assert xknx.telegrams.qsize() == 1
telegram = xknx.telegrams.get_nowait()
assert telegram == Telegram(
destination_address=GroupAddress("1/2/3"), payload=GroupValueRead()
)
#
# TEST PROCESS
#
async def test_process(self) -> None:
"""Test process / reading telegrams from telegram queue."""
xknx = XKNX()
sensor = NumericValue(
xknx, "TestSensor", value_type="temperature", group_address="1/2/3"
)
telegram = Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x06, 0xA0))),
)
sensor.process(telegram)
assert sensor.sensor_value.value == 16.96
assert sensor.sensor_value.telegram.payload.value == DPTArray((0x06, 0xA0))
assert sensor.resolve_state() == 16.96
async def test_process_callback(self) -> None:
"""Test process / reading telegrams from telegram queue. Test if callback is called."""
xknx = XKNX()
sensor = NumericValue(
xknx, "TestSensor", group_address="1/2/3", value_type="temperature"
)
after_update_callback = Mock()
sensor.register_device_updated_cb(after_update_callback)
telegram = Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x01, 0x02))),
)
sensor.process(telegram)
after_update_callback.assert_called_with(sensor)
assert sensor.last_telegram == telegram
# consecutive telegrams with same payload shall only trigger one callback
after_update_callback.reset_mock()
sensor.process(telegram)
after_update_callback.assert_not_called()
async def test_process_callback_always(self) -> None:
"""Test process / reading telegrams from telegram queue. Test if callback is called."""
xknx = XKNX()
sensor = NumericValue(
xknx,
"TestSensor",
group_address="1/2/3",
value_type="temperature",
always_callback=True,
)
after_update_callback = Mock()
sensor.register_device_updated_cb(after_update_callback)
telegram = Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x01, 0x02))),
)
sensor.process(telegram)
after_update_callback.assert_called_with(sensor)
assert sensor.last_telegram == telegram
# every telegram shall trigger callback
after_update_callback.reset_mock()
sensor.process(telegram)
after_update_callback.assert_called_with(sensor)
async def test_process_callback_set(self) -> None:
"""Test setting value. Test if callback is called."""
xknx = XKNX()
after_update_callback = Mock()
num_value = NumericValue(
xknx, "TestSensor", group_address="1/2/3", value_type="temperature"
)
xknx.devices.async_add(num_value)
num_value.register_device_updated_cb(after_update_callback)
await num_value.set(21.0)
xknx.devices.process(xknx.telegrams.get_nowait())
after_update_callback.assert_called_with(num_value)
def test_string(self) -> None:
"""Test NumericValue string representation."""
xknx = XKNX()
value = NumericValue(
xknx, "Num", group_address="1/2/3", value_type="temperature"
)
value.sensor_value.value = 4.9
assert (
str(value)
== '<NumericValue name="Num" addresses=<1/2/3, None, [], 4.9 /> value=4.9 unit="°C"/>'
)
|
