File: test_packet_decoder.py

package info (click to toggle)
python-airtouch5py 0.2.10-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,052 kB
  • sloc: python: 1,748; makefile: 5
file content (537 lines) | stat: -rw-r--r-- 17,431 bytes parent folder | download
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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
from airtouch5py.packet_decoder import PacketDecoder
from airtouch5py.packets.ac_ability import AcAbilityData, AcAbilityRequestData
from airtouch5py.packets.ac_control import (
    AcControlData,
    SetAcFanSpeed,
    SetAcMode,
    SetpointControl,
    SetPowerSetting,
)
from airtouch5py.packets.ac_error_information import (
    AcErrorInformationData,
    AcErrorInformationRequestData,
)
from airtouch5py.packets.ac_status import AcFanSpeed, AcMode, AcPowerState, AcStatusData
from airtouch5py.packets.console_version import (
    ConsoleVersionData,
    ConsoleVersionRequestData,
)
from airtouch5py.packets.datapacket import DataPacket
from airtouch5py.packets.zone_control import (
    ZoneControlData,
    ZoneSettingPower,
    ZoneSettingValue,
)
from airtouch5py.packets.zone_name import ZoneNameData, ZoneNameRequestData
from airtouch5py.packets.zone_status import (
    ControlMethod,
    ZonePowerState,
    ZoneStatusData,
)

"""
Tests for PacketDecoder, using examples from the protocol documentation
"""


def test_decode_zone_control_example():
    """
    Decode the zone control message as given in the protocol documentation.
    Turn off the second zone
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x80\xB0\x0F\xC0\x00\x0C\x20\x00\x00\x00\x00\x04\x00\x01\x01\x02\xFF\x00\xF0\xA1"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x80B0
    assert packet.message_id == 0x0F
    assert type(packet.data) is ZoneControlData

    # Zone control
    d: ZoneControlData = packet.data
    assert len(d.zones) == 1

    # Zone
    z = d.zones[0]
    assert z.zone_number == 1
    assert z.zone_setting_value == ZoneSettingValue.KEEP_SETTING_VALUE
    assert z.power == ZoneSettingPower.SET_TO_OFF
    assert z.value_to_set == 0xFF


def test_decode_zone_status_request_example():
    """
    Decode the zone status (request) message as given in the protocol documentation.
    """

    decoder = PacketDecoder()
    # TODO: Add CRC bytes
    data = b"\x55\x55\x55\xAA\x80\xB0\x01\xC0\x00\x08\x21\x00\x00\x00\x00\x00\x00\x00\xA4\x31"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x80B0
    assert packet.message_id == 0x01
    assert type(packet.data) is ZoneStatusData

    # Zone status
    assert len(packet.data.zones) == 0


def test_decode_zone_status_response_example():
    """
    Decode the zone status (response) message as given in the protocol documentation.

    Data has been altered to be valid (Example has 2 zones worth of data but says it just has 1)
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\xB0\x80\x01\xC0\x00\x18\x21\x00\x00\x00\x00\x08\x00\x02\x40\x80\x96\x80\x02\xE7\x00\x00\x01\x64\xFF\x00\x07\xFF\x00\x00\xB9\xEF"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0xB080
    assert packet.message_id == 0x01
    assert type(packet.data) is ZoneStatusData

    # Zone status
    assert len(packet.data.zones) == 2

    # Zone 0
    zone = packet.data.zones[0]
    assert zone.zone_power_state == ZonePowerState.ON
    assert zone.zone_number == 0
    assert zone.control_method == ControlMethod.TEMPERATURE_CONTROL
    assert zone.open_percentage == 0.0
    assert zone.set_point == 25
    assert zone.has_sensor == True
    assert zone.temperature == 24.3
    assert zone.spill_active == False
    assert zone.is_low_battery == False

    # Zone 1
    zone = packet.data.zones[1]
    assert zone.zone_power_state == ZonePowerState.OFF
    assert zone.zone_number == 1
    assert zone.control_method == ControlMethod.PERCENTAGE_CONTROL
    assert zone.open_percentage == 1.0
    assert zone.set_point == None  # Invalid
    assert zone.has_sensor == False
    assert zone.temperature == None  # Invalid
    assert zone.spill_active == False
    assert zone.is_low_battery == False


def test_decode_ac_control_turn_off_second_ac_example():
    """
    Decode the AC control message as given in the protocol documentation.

    Turn off the second AC
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x80\xb0\x01\xC0\x00\x0C\x22\x00\x00\x00\x00\x04\x00\x01\x21\xFF\x00\xFF\xD3\x47"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x80B0
    assert packet.message_id == 0x01
    assert type(packet.data) is AcControlData

    # AC control
    assert len(packet.data.ac_control) == 1

    # AC
    c = packet.data.ac_control[0]
    assert c.power_setting == SetPowerSetting.SET_TO_OFF
    assert c.ac_number == 1
    assert c.ac_mode == SetAcMode.KEEP_AC_MODE
    assert c.ac_fan_speed == SetAcFanSpeed.KEEP_AC_FAN_SPEED
    assert c.setpoint_control == SetpointControl.KEEP_SETPOINT_VALUE
    # Value of setpoint isn't used in this case (It is 0xFF), but checking we still decode it fine
    assert c.setpoint == 35.5


def test_decode_ac_control_first_ac_cool_second_ac_26_degrees_example():
    """
    Decode the AC control message as given in the protocol documentation.

    Set the first AC to cool and the second AC to 26 degrees
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x80\xb0\x01\xC0\x00\x10\x22\x00\x00\x00\x00\x04\x00\x02\x00\x4F\x00\xFF\x01\xFF\x40\xA0\x10\x4B"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x80B0
    assert packet.message_id == 0x01
    assert type(packet.data) is AcControlData

    # AC control
    assert len(packet.data.ac_control) == 2

    # AC 0
    c = packet.data.ac_control[0]
    assert c.power_setting == SetPowerSetting.KEEP_POWER_SETTING
    assert c.ac_number == 0
    assert c.ac_mode == SetAcMode.SET_TO_COOL
    assert c.ac_fan_speed == SetAcFanSpeed.KEEP_AC_FAN_SPEED
    assert c.setpoint_control == SetpointControl.KEEP_SETPOINT_VALUE
    assert c.setpoint == 35.5  # Unused in this case

    # AC 1
    c = packet.data.ac_control[1]
    assert c.power_setting == SetPowerSetting.KEEP_POWER_SETTING
    assert c.ac_number == 1
    assert c.ac_mode == SetAcMode.KEEP_AC_MODE
    assert c.ac_fan_speed == SetAcFanSpeed.KEEP_AC_FAN_SPEED
    assert c.setpoint_control == SetpointControl.CHANGE_SETPOINT
    assert c.setpoint == 26.0


def test_decode_ac_status_request_example():
    """
    Decode the AC status (request) message as given in the protocol documentation.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x80\xB0\x01\xC0\x00\x08\x23\x00\x00\x00\x00\x00\x00\x00\x7D\xB0"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x80B0
    assert packet.message_id == 0x01
    assert type(packet.data) is AcStatusData

    # AC status
    assert len(packet.data.ac_status) == 0


def test_decode_ac_status_response_2_acs_example():
    """
    Decode the AC status (response) message as given in the protocol documentation.

    AirTouch 5 response with data for 2 ACs
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\xB0\x80\x01\xC0\x00\x1C\x23\x00\x00\x00\x00\x0A\x00\x02\x10\x12\x78\xC0\x02\xDA\x00\x00\x80\x00\x01\x42\x64\xC0\x02\xE4\x00\x00\x80\x00\x3D\x79"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0xB080
    assert packet.message_id == 0x01
    assert type(packet.data) is AcStatusData

    # AC status
    assert len(packet.data.ac_status) == 2

    # AC 0
    ac = packet.data.ac_status[0]
    assert ac.ac_power_state == AcPowerState.ON
    assert ac.ac_number == 0
    assert ac.ac_mode == AcMode.HEAT
    assert ac.ac_fan_speed == AcFanSpeed.LOW
    assert ac.ac_setpoint == 22.0
    assert ac.turbo_active == False
    assert ac.bypass_active == False
    assert ac.spill_active == False
    assert ac.timer_set == False
    assert ac.temperature == 23.0
    assert ac.error_code == 0  # No error

    # AC 1
    ac = packet.data.ac_status[1]
    assert ac.ac_power_state == AcPowerState.OFF
    assert ac.ac_number == 1
    assert ac.ac_mode == AcMode.COOL
    assert ac.ac_fan_speed == AcFanSpeed.LOW
    assert ac.ac_setpoint == 20.0
    assert ac.turbo_active == False
    assert ac.bypass_active == False
    assert ac.spill_active == False
    assert ac.timer_set == False
    assert ac.temperature == 24.0
    assert ac.error_code == 0  # No error

def test_decode_ac_status_response_console_120():
    """
    Decode the AC status (response) message as received with console version 1.2.0 (2024-06-27 release).

    The repeated section is 14 bytes instead of 10 as it used to be
    """
    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xaa\xb0\x80\x07\xc0\x00\x16\x23\x00\x00\x00\x00\x0e\x00\x01\x10\x12\x82\xc5\x0a\xbf\x00\x00\xe5\x00\xe2\xe4\x00\x00\xa7\xd5"
    packet: DataPacket = decoder.decode(data)

    # Packet

    assert packet.address == 0xB080
    assert packet.message_id == 0x07
    assert type(packet.data) is AcStatusData

    # AC status

    assert len(packet.data.ac_status) == 1

    # AC 0

    ac = packet.data.ac_status[0]
    assert ac.ac_power_state == AcPowerState.ON
    assert ac.ac_number == 0
    assert ac.ac_mode == AcMode.HEAT
    assert ac.ac_fan_speed == AcFanSpeed.LOW
    assert ac.ac_setpoint == 23.0
    assert ac.turbo_active == False
    assert ac.bypass_active == True
    assert ac.spill_active == False
    assert ac.timer_set == True
    assert ac.temperature == 20.3
    assert ac.error_code == 0  # No error


def test_decode_extended_ac_ability_request_example():
    """
    Decode the extended AC ability (request) message as given in the protocol documentation.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x90\xB0\x01\x1F\x00\x03\xFF\x11\x00\x09\x83"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x90B0
    assert packet.message_id == 0x01
    assert type(packet.data) is AcAbilityRequestData

    # AC ability request (AC 0)
    assert packet.data.ac_number == 0x00


def test_decode_extended_ac_ability_response_example():
    """
    Decode the extended AC ability (response) message as given in the protocol documentation.

    Had to increase length to 1C from 1A
    Sample says the AC supports fan, but it doesn't
    Sample says the AC doesn't support dry, but it does
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\xB0\x90\x01\x1F\x00\x1C\xFF\x11\x00\x18\x55\x4E\x49\x54\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x17\x1D\x10\x1f\x12\x1f\xa2\x26"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0xB090
    assert packet.message_id == 0x01
    assert type(packet.data) is AcAbilityData
    assert len(packet.data.ac_ability) == 1

    # AC ability response (AC 0)
    ac = packet.data.ac_ability[0]
    assert ac.ac_number == 0x00
    assert ac.ac_name == "UNIT"
    assert ac.start_zone_number == 0x00
    assert ac.zone_count == 0x04
    assert ac.supports_mode_cool == True
    assert ac.supports_mode_fan == False
    assert ac.supports_mode_dry == True
    assert ac.supports_mode_heat == True
    assert ac.supports_mode_auto == True

    assert ac.supports_fan_speed_intelligent_auto == False
    assert ac.supports_fan_speed_turbo == False
    assert ac.supports_fan_speed_powerful == False
    assert ac.supports_fan_speed_high == True
    assert ac.supports_fan_speed_medium == True
    assert ac.supports_fan_speed_low == True
    assert ac.supports_fan_speed_quiet == False
    assert ac.supports_fan_speed_auto == True

    assert ac.min_cool_set_point == 16.0
    assert ac.max_cool_set_point == 31.0
    assert ac.min_heat_set_point == 18.0
    assert ac.max_heat_set_point == 31.0


def test_decode_ac_error_information_request_example():
    """
    Decode the AC error information (request) message as given in the protocol documentation.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x90\xB0\x01\x1F\x00\x03\xFF\x10\x00\x99\x82"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x90B0
    assert packet.message_id == 0x01
    assert type(packet.data) is AcErrorInformationRequestData

    # AC error information request (AC 0)
    assert packet.data.ac_number == 0x00


def test_decode_ac_error_information_response_example():
    """
    Decode the AC error information (response) message as given in the protocol documentation.

    Example has length as 0x1A, but it should be 0x0C
    """

    decoder = PacketDecoder()
    # TODO: Add CRC bytes
    data = b"\x55\x55\x55\xAA\xB0\x90\x01\x1F\x00\x0C\xFF\x10\x00\x08\x45\x52\x3A\x20\x46\x46\x46\x45"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0xB090
    assert packet.message_id == 0x01
    assert type(packet.data) is AcErrorInformationData

    # AC error information response (AC 0)
    assert packet.data.ac_number == 0x00
    assert packet.data.error_info == "ER: FFFE"


def test_decode_zone_names_request_all_example():
    """
    Decode the zone names (request) message as given in the protocol documentation.

    TODO: The docs also say this is 0xFF 0x12?? In the samples they use both.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x90\xB0\x01\x1F\x00\x02\xFF\x13\x42\xCD"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x90B0
    assert packet.message_id == 0x01
    assert type(packet.data) is ZoneNameRequestData

    # All Zones
    assert packet.data.zone_number == None


def test_decode_zone_names_request_single_example():
    """
    Decode the zone names (request) message as given in the protocol documentation.

    TODO: The docs also say this is 0xFF 0x12?? In the samples they use both.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x90\xB0\x01\x1F\x00\x03\xFF\x13\x00\x69\x82"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x90B0
    assert packet.message_id == 0x01
    assert type(packet.data) is ZoneNameRequestData

    # Zone 0
    assert packet.data.zone_number == 0x00


def test_decode_zone_names_response_single_example():
    """
    Decode the zone names (response) message as given in the protocol documentation.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\xB0\x90\x01\x1F\x00\x0A\xFF\x13\x00\x06\x4C\x69\x76\x69\x6E\x67\xB6\x2F"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0xB090
    assert packet.message_id == 0x01
    assert type(packet.data) is ZoneNameData
    assert len(packet.data.zone_names) == 1

    # Zone 0
    z = packet.data.zone_names[0]
    assert z.zone_number == 0x00
    assert z.zone_name == "Living"


def test_decode_zone_names_response_multiple_example():
    """
    Decode the zone names (response) message as given in the protocol documentation.

    Sample has length as 0x1D but it should be 0x1C
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\xb0\x90\x01\x1F\x00\x1C\xFF\x13\x00\x06\x4C\x69\x76\x69\x6E\x67\x01\x07\x4B\x69\x74\x63\x68\x65\x6E\x02\x07\x42\x65\x64\x72\x6F\x6F\x6D\xAE\x8B"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0xB090
    assert packet.message_id == 0x01
    assert type(packet.data) is ZoneNameData
    assert len(packet.data.zone_names) == 3

    # Zone 0
    z = packet.data.zone_names[0]
    assert z.zone_number == 0x00
    assert z.zone_name == "Living"

    # Zone 1
    z = packet.data.zone_names[1]
    assert z.zone_number == 0x01
    assert z.zone_name == "Kitchen"

    # Zone 2
    z = packet.data.zone_names[2]
    assert z.zone_number == 0x02
    assert z.zone_name == "Bedroom"


def test_decode_zone_names_response_zone_name_is_utf8():
    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xaa\xb0\x90\x03\x1f\x00\x3c\xff\x13\x00\x06\x4d\x61\x73\x74\x65\x72\x01\x0a\x43\x61\x6d\xe2\x80\x99\x73\x20\x72\x6f\x02\x06\x52\x75\x6d\x70\x75\x73\x03\x0c\x44\x72\x61\x67\x6f\x6e\x73\x20\x6c\x61\x69\x72\x04\x06\x44\x69\x6e\x69\x6e\x67\x05\x06\x4c\x6f\x75\x6e\x67\x65\xc9\x19"
    packet: DataPacket = decoder.decode(data)

    assert type(packet.data) is ZoneNameData

    assert len(packet.data.zone_names) == 6
    # The single quote here is a special character that doesn't encode to a single byte
    assert packet.data.zone_names[1].zone_name == "Cam’s ro"


def test_decode_console_version_request_example():
    """
    Decode the console version (request) message as given in the protocol documentation.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\x90\xB0\x01\x1F\x00\x02\xFF\x30\x9B\x8C"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0x90B0
    assert packet.message_id == 0x01
    assert type(packet.data) is ConsoleVersionRequestData


def test_console_version_response_example():
    """
    Decode the console version (request) message as given in the protocol documentation.
    """

    decoder = PacketDecoder()
    data = b"\x55\x55\x55\xAA\xB0\x90\x01\x1F\x00\x0F\xFF\x30\x00\x0B\x31\x2E\x30\x2E\x33\x2C\x31\x2E\x30\x2E\x33\x13\x28"
    packet: DataPacket = decoder.decode(data)

    # Packet
    assert packet.address == 0xB090
    assert packet.message_id == 0x01
    assert type(packet.data) is ConsoleVersionData

    # Console version
    assert packet.data.has_update == False
    assert packet.data.version == "1.0.3,1.0.3"