File: test_evaporative_humidifier.py

package info (click to toggle)
pyswitchbot 0.72.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 876 kB
  • sloc: python: 12,717; makefile: 2
file content (358 lines) | stat: -rw-r--r-- 11,148 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
import datetime
from unittest.mock import AsyncMock, MagicMock, patch

import pytest
from bleak.backends.device import BLEDevice

from switchbot import (
    HumidifierAction,
    HumidifierMode,
    HumidifierWaterLevel,
    SwitchBotAdvertisement,
    SwitchbotModel,
)
from switchbot.devices import evaporative_humidifier
from switchbot.devices.device import SwitchbotEncryptedDevice, SwitchbotOperationError

from .test_adv_parser import generate_ble_device


def create_device_for_command_testing(init_data: dict | None = None):
    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "any")
    evaporative_humidifier_device = (
        evaporative_humidifier.SwitchbotEvaporativeHumidifier(
            ble_device, "ff", "ffffffffffffffffffffffffffffffff"
        )
    )
    evaporative_humidifier_device.update_from_advertisement(
        make_advertisement_data(ble_device, init_data)
    )
    evaporative_humidifier_device._send_command = AsyncMock()
    evaporative_humidifier_device._check_command_result = MagicMock()
    evaporative_humidifier_device.update = AsyncMock()
    return evaporative_humidifier_device


def make_advertisement_data(ble_device: BLEDevice, init_data: dict | None = None):
    if init_data is None:
        init_data = {}
    """Set advertisement data with defaults."""
    return SwitchBotAdvertisement(
        address="aa:bb:cc:dd:ee:ff",
        data={
            "rawAdvData": b"#\x00\x00\x15\x1c\x00",
            "data": {
                "isOn": False,
                "mode": None,
                "target_humidity": 52,
                "child_lock": False,
                "over_humidify_protection": True,
                "tank_removed": False,
                "tilted_alert": False,
                "filter_missing": False,
                "is_meter_binded": True,
                "humidity": 51,
                "temperature": 16.8,
                "temp": {"c": 16.8, "f": 62.24},
                "filter_run_time": datetime.timedelta(days=3, seconds=57600),
                "filter_alert": False,
                "water_level": "medium",
            }
            | init_data,
            "isEncrypted": False,
            "model": "#",
            "modelFriendlyName": "Evaporative Humidifier",
            "modelName": SwitchbotModel.EVAPORATIVE_HUMIDIFIER,
        },
        device=ble_device,
        rssi=-80,
        active=True,
    )


@pytest.mark.asyncio
async def test_turn_on():
    """Test the turn_on method."""
    device = create_device_for_command_testing({"isOn": True})
    await device.turn_on()
    assert device.is_on() is True


@pytest.mark.asyncio
async def test_turn_off():
    """Test the turn_off method."""
    device = create_device_for_command_testing({"isOn": False})
    await device.turn_off()
    assert device.is_on() is False


@pytest.mark.asyncio
async def test_get_basic_is_none():
    """Test the get_basic_info when it returns None."""
    device = create_device_for_command_testing()
    device._get_basic_info = AsyncMock(return_value=None)
    assert await device.get_basic_info() is None


@pytest.mark.asyncio
@pytest.mark.parametrize(
    ("basic_info", "result"),
    [
        (
            bytearray(b"\x01\x86\x88\xb1\x98\x82\x00\x1e\x00\x88-\xc4\xff\xff \n\x07"),
            [
                True,
                HumidifierMode(6),
                True,
                False,
                False,
                False,
                False,
                True,
                49,
                24.8,
                24.8,
                76.64,
                "medium",
                30,
                45,
            ],
        ),
        (
            bytearray(b"\x01\x08 \xb1\x98r\x00\x1e\x00\x89-\xc4\xff\xff\x00\x00\x00"),
            [
                False,
                HumidifierMode(8),
                False,
                True,
                False,
                False,
                False,
                True,
                49,
                24.7,
                24.7,
                76.46,
                "medium",
                30,
                45,
            ],
        ),
    ],
)
async def test_get_basic_info(basic_info, result):
    """Test the get_basic_info method."""
    device = create_device_for_command_testing()
    device._get_basic_info = AsyncMock(return_value=basic_info)

    info = await device.get_basic_info()
    assert info["isOn"] is result[0]
    assert info["mode"] == result[1]
    assert info["over_humidify_protection"] is result[2]
    assert info["child_lock"] is result[3]
    assert info["tank_removed"] is result[4]
    assert info["tilted_alert"] is result[5]
    assert info["filter_missing"] is result[6]
    assert info["is_meter_binded"] is result[7]
    assert info["humidity"] == result[8]
    assert info["temperature"] == result[9]
    assert info["temp"]["c"] == result[10]
    assert info["temp"]["f"] == result[11]
    assert info["water_level"] == result[12]
    assert info["filter_run_time"] == result[13]
    assert info["target_humidity"] == result[14]


@pytest.mark.asyncio
@pytest.mark.parametrize(
    ("err_msg", "mode", "water_level"),
    [
        (
            "Target humidity can only be set in target humidity mode or sleep mode",
            HumidifierMode.AUTO,
            "low",
        ),
        (
            "Cannot perform operation when water tank is empty",
            HumidifierMode.TARGET_HUMIDITY,
            "empty",
        ),
    ],
)
async def test_set_target_humidity_with_invalid_conditions(err_msg, mode, water_level):
    """Test setting target humidity with invalid mode."""
    device = create_device_for_command_testing()
    device.get_mode = MagicMock(return_value=mode)
    device.get_water_level = MagicMock(return_value=water_level)
    with pytest.raises(SwitchbotOperationError, match=err_msg):
        await device.set_target_humidity(45)


@pytest.mark.asyncio
@pytest.mark.parametrize(
    ("err_msg", "mode", "water_level", "is_meter_binded", "target_humidity"),
    [
        (
            "Cannot perform operation when water tank is empty",
            HumidifierMode.TARGET_HUMIDITY,
            "empty",
            True,
            45,
        ),
        (
            "Cannot set target humidity or auto mode when meter is not binded",
            HumidifierMode.TARGET_HUMIDITY,
            "medium",
            False,
            45,
        ),
        (
            "Target humidity must be set before switching to target humidity mode or sleep mode",
            HumidifierMode.TARGET_HUMIDITY,
            "medium",
            True,
            None,
        ),
    ],
)
async def test_set_mode_with_invalid_conditions(
    err_msg, mode, water_level, is_meter_binded, target_humidity
):
    """Test setting target humidity with invalid mode."""
    device = create_device_for_command_testing()
    device.get_water_level = MagicMock(return_value=water_level)
    device.is_meter_binded = MagicMock(return_value=is_meter_binded)
    device.get_target_humidity = MagicMock(return_value=target_humidity)
    with pytest.raises(SwitchbotOperationError, match=err_msg):
        await device.set_mode(mode)


@pytest.mark.asyncio
async def test_set_target_humidity():
    """Test setting target humidity."""
    device = create_device_for_command_testing()
    device.get_mode = MagicMock(return_value=HumidifierMode.TARGET_HUMIDITY)

    await device.set_target_humidity(45)
    device._send_command.assert_awaited_once_with("570f430202002d")


@pytest.mark.asyncio
@pytest.mark.parametrize(
    ("mode", "command"),
    [
        (HumidifierMode.TARGET_HUMIDITY, "570f430202002d"),
        (HumidifierMode.AUTO, "570f4302040000"),
        (HumidifierMode.SLEEP, "570f430203002d"),
        (HumidifierMode.DRYING_FILTER, "570f43010108"),
    ],
)
async def test_set_mode(mode, command):
    """Test setting mode."""
    device = create_device_for_command_testing()
    device._validate_water_level(mode)
    device.get_target_humidity = MagicMock(return_value=45)

    await device.set_mode(mode)
    device._send_command.assert_awaited_once_with(command)


@pytest.mark.asyncio
@pytest.mark.parametrize(
    ("init_data", "result"),
    [
        (
            {"isOn": False, "mode": HumidifierMode.AUTO},
            [False, HumidifierMode.AUTO, HumidifierAction.OFF],
        ),
        (
            {"isOn": True, "mode": HumidifierMode.TARGET_HUMIDITY},
            [True, HumidifierMode.TARGET_HUMIDITY, HumidifierAction.HUMIDIFYING],
        ),
        (
            {"isOn": True, "mode": HumidifierMode.DRYING_FILTER},
            [True, HumidifierMode.DRYING_FILTER, HumidifierAction.DRYING],
        ),
    ],
)
async def test_status_from_process_adv(init_data, result):
    """Test status from process advertisement."""
    device = create_device_for_command_testing(init_data)

    assert device.is_on() is result[0]
    assert device.get_mode() is result[1]
    assert device.is_child_lock_enabled() is False
    assert device.is_over_humidify_protection_enabled() is True
    assert device.is_tank_removed() is False
    assert device.is_filter_missing() is False
    assert device.is_filter_alert_on() is False
    assert device.is_tilted_alert_on() is False
    assert device.get_water_level() == "medium"
    assert device.get_filter_run_time() == datetime.timedelta(days=3, seconds=57600)
    assert device.get_target_humidity() == 52
    assert device.get_humidity() == 51
    assert device.get_temperature() == 16.8
    assert device.get_action() == result[2]
    assert device.is_meter_binded() is True


@pytest.mark.asyncio
@pytest.mark.parametrize(
    ("enabled", "command"),
    [
        (True, "570f430501"),
        (False, "570f430500"),
    ],
)
async def test_set_child_lock(enabled, command):
    """Test setting child lock."""
    device = create_device_for_command_testing()
    await device.set_child_lock(enabled)
    device._send_command.assert_awaited_once_with(command)


@pytest.mark.asyncio
@patch.object(SwitchbotEncryptedDevice, "verify_encryption_key", new_callable=AsyncMock)
async def test_verify_encryption_key(mock_parent_verify):
    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "any")
    key_id = "ff"
    encryption_key = "ffffffffffffffffffffffffffffffff"

    mock_parent_verify.return_value = True

    result = await evaporative_humidifier.SwitchbotEvaporativeHumidifier.verify_encryption_key(
        device=ble_device,
        key_id=key_id,
        encryption_key=encryption_key,
    )

    mock_parent_verify.assert_awaited_once_with(
        ble_device,
        key_id,
        encryption_key,
        SwitchbotModel.EVAPORATIVE_HUMIDIFIER,
    )

    assert result is True


def test_evaporative_humidifier_modes():
    assert HumidifierMode.get_modes() == [
        "high",
        "medium",
        "low",
        "quiet",
        "target_humidity",
        "sleep",
        "auto",
        "drying_filter",
    ]


def test_evaporative_humidifier_water_levels():
    assert HumidifierWaterLevel.get_levels() == [
        "empty",
        "low",
        "medium",
        "high",
    ]