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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
"""Unit test for Sensor objects."""
from unittest.mock import AsyncMock, Mock, call
from xknx import XKNX
from xknx.devices import ExposeSensor
from xknx.dpt import DPTArray, DPTBinary
from xknx.telegram import GroupAddress, Telegram
from xknx.telegram.apci import GroupValueRead, GroupValueResponse, GroupValueWrite
from ..conftest import EventLoopClockAdvancer
class TestExposeSensor:
"""Test class for Sensor objects."""
#
# STR FUNCTIONS
#
async def test_str_binary(self) -> None:
"""Test resolve state with binary sensor."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", group_address="1/2/3", value_type="binary"
)
expose_sensor.process(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(value=DPTBinary(1)),
)
)
assert expose_sensor.resolve_state() is True
assert expose_sensor.unit_of_measurement() is None
async def test_str_percent(self) -> None:
"""Test resolve state with percent sensor."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", group_address="1/2/3", value_type="percent"
)
expose_sensor.process(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x40,))),
)
)
assert expose_sensor.resolve_state() == 25
assert expose_sensor.unit_of_measurement() == "%"
async def test_str_temperature(self) -> None:
"""Test resolve state with temperature sensor."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", group_address="1/2/3", value_type="temperature"
)
expose_sensor.process(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x0C, 0x1A))),
)
)
assert expose_sensor.resolve_state() == 21.0
assert expose_sensor.unit_of_measurement() == "°C"
#
# TEST SET
#
async def test_set_binary(self) -> None:
"""Test set with binary sensor."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", group_address="1/2/3", value_type="binary"
)
await expose_sensor.set(False)
assert xknx.telegrams.qsize() == 1
telegram = xknx.telegrams.get_nowait()
assert telegram == Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTBinary(0)),
)
async def test_set_percent(self) -> None:
"""Test set with percent sensor."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", group_address="1/2/3", value_type="percent"
)
await expose_sensor.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 sensor."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", group_address="1/2/3", value_type="temperature"
)
await expose_sensor.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 PROCESS (GROUP READ)
#
async def test_process_binary(self) -> None:
"""Test reading binary expose sensor from bus."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", value_type="binary", group_address="1/2/3"
)
expose_sensor.sensor_value.value = True
telegram = Telegram(GroupAddress("1/2/3"), payload=GroupValueRead())
expose_sensor.process(telegram)
assert xknx.telegrams.qsize() == 1
telegram = xknx.telegrams.get_nowait()
assert telegram == Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueResponse(DPTBinary(True)),
)
async def test_process_percent(self) -> None:
"""Test reading percent expose sensor from bus."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", value_type="percent", group_address="1/2/3"
)
expose_sensor.process(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x40,))),
)
)
telegram = Telegram(GroupAddress("1/2/3"), payload=GroupValueRead())
expose_sensor.process(telegram)
assert xknx.telegrams.qsize() == 1
telegram = xknx.telegrams.get_nowait()
assert telegram == Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueResponse(DPTArray((0x40,))),
)
async def test_process_temperature(self) -> None:
"""Test reading temperature expose sensor from bus."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", value_type="temperature", group_address="1/2/3"
)
expose_sensor.sensor_value.value = 21.0
telegram = Telegram(GroupAddress("1/2/3"), payload=GroupValueRead())
expose_sensor.process(telegram)
assert xknx.telegrams.qsize() == 1
telegram = xknx.telegrams.get_nowait()
assert telegram == Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueResponse(DPTArray((0x0C, 0x1A))),
)
async def test_process_no_respond_to_read(self) -> None:
"""Test expose sensor with respond_to_read set to False."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx,
"TestSensor",
value_type="temperature",
group_address="1/2/3",
respond_to_read=False,
)
expose_sensor.sensor_value.value = 21.0
telegram = Telegram(GroupAddress("1/2/3"), payload=GroupValueRead())
expose_sensor.process(telegram)
assert xknx.telegrams.qsize() == 0
#
# HAS GROUP ADDRESS
#
def test_has_group_address(self) -> None:
"""Test expose sensor has group address."""
xknx = XKNX()
expose_sensor = ExposeSensor(
xknx, "TestSensor", value_type="temperature", group_address="1/2/3"
)
assert expose_sensor.has_group_address(GroupAddress("1/2/3"))
assert not expose_sensor.has_group_address(GroupAddress("1/2/4"))
#
# PROCESS CALLBACK
#
async def test_process_callback(self) -> None:
"""Test setting value. Test if callback is called."""
xknx = XKNX()
after_update_callback = Mock()
expose_sensor = ExposeSensor(
xknx, "TestSensor", group_address="1/2/3", value_type="temperature"
)
expose_sensor.register_device_updated_cb(after_update_callback)
xknx.devices.async_add(expose_sensor)
await expose_sensor.set(21.0)
xknx.devices.process(xknx.telegrams.get_nowait())
after_update_callback.assert_called_with(expose_sensor)
#
# TEST COOLDOWN
#
async def test_cooldown(self, time_travel: EventLoopClockAdvancer) -> None:
"""Test cooldown."""
xknx = XKNX()
xknx.cemi_handler = AsyncMock()
await xknx.telegram_queue.start()
expose_sensor_cd = ExposeSensor(
xknx,
"TestSensor",
group_address="1/2/3",
value_type="temperature",
cooldown=10,
)
xknx.devices.async_add(expose_sensor_cd)
expose_sensor_no_cd = ExposeSensor(
xknx,
"TestSensor",
group_address="1/2/4",
value_type="temperature",
)
xknx.devices.async_add(expose_sensor_no_cd)
await expose_sensor_cd.set(21.0)
await expose_sensor_no_cd.set(21.0)
await time_travel(0)
xknx.cemi_handler.send_telegram.assert_has_calls(
[
call(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x0C, 0x1A))),
)
),
call(
Telegram(
destination_address=GroupAddress("1/2/4"),
payload=GroupValueWrite(DPTArray((0x0C, 0x1A))),
)
),
]
)
xknx.cemi_handler.send_telegram.reset_mock()
# don't send telegram with same payload twice if cooldown is active
await expose_sensor_cd.set(21.0)
await expose_sensor_no_cd.set(21.0)
await time_travel(0)
xknx.cemi_handler.send_telegram.assert_has_calls(
[
call(
Telegram(
destination_address=GroupAddress("1/2/4"),
payload=GroupValueWrite(DPTArray((0x0C, 0x1A))),
)
),
]
)
xknx.cemi_handler.send_telegram.reset_mock()
await time_travel(10)
assert xknx.telegrams.qsize() == 0
xknx.cemi_handler.send_telegram.assert_not_called()
# different payload after cooldown
await expose_sensor_cd.set(10.0)
await expose_sensor_no_cd.set(10.0)
await time_travel(0)
xknx.cemi_handler.send_telegram.assert_has_calls(
[
call(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x03, 0xE8))),
)
),
call(
Telegram(
destination_address=GroupAddress("1/2/4"),
payload=GroupValueWrite(DPTArray((0x03, 0xE8))),
)
),
]
)
xknx.cemi_handler.send_telegram.reset_mock()
# different payload immediately (payload of 3.111 equals 3.11)
await expose_sensor_cd.set(3.111)
await expose_sensor_no_cd.set(3.111)
await time_travel(0)
xknx.cemi_handler.send_telegram.assert_has_calls(
[
call(
Telegram(
destination_address=GroupAddress("1/2/4"),
payload=GroupValueWrite(DPTArray((0x01, 0x37))),
)
),
]
)
xknx.cemi_handler.send_telegram.reset_mock()
assert expose_sensor_cd._cooldown_latest_value == 3.111
assert expose_sensor_cd.sensor_value.value == 10
await time_travel(10)
xknx.cemi_handler.send_telegram.assert_has_calls(
[
call(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x01, 0x37))),
)
),
]
)
xknx.cemi_handler.send_telegram.reset_mock()
assert expose_sensor_cd._cooldown_latest_value == 3.11
assert expose_sensor_cd.sensor_value.value == 3.11
await time_travel(10)
xknx.cemi_handler.send_telegram.assert_not_called()
# reading unsent value
await expose_sensor_cd.set(10)
# first send new value
await time_travel(0)
xknx.cemi_handler.send_telegram.assert_has_calls(
[
call(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueWrite(DPTArray((0x03, 0xE8))),
)
),
]
)
xknx.cemi_handler.send_telegram.reset_mock()
# in cooldown with a new value - receiving a read request
await expose_sensor_cd.set(21)
expose_sensor_cd.process(
Telegram(GroupAddress("1/2/3"), payload=GroupValueRead())
)
await time_travel(0)
xknx.cemi_handler.send_telegram.assert_has_calls(
[
call(
Telegram(
destination_address=GroupAddress("1/2/3"),
payload=GroupValueResponse(DPTArray((0x0C, 0x1A))),
)
),
]
)
xknx.cemi_handler.send_telegram.reset_mock()
# after cooldown - new value not sent again (already in GroupValueResponse)
await time_travel(10)
xknx.cemi_handler.send_telegram.assert_not_called()
await xknx.stop()
|
