File: test_sensor.py

package info (click to toggle)
blebox-uniapi 2.5.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 520 kB
  • sloc: python: 4,994; makefile: 85; sh: 5
file content (401 lines) | stat: -rw-r--r-- 11,994 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
"""Blebox sensors tests."""

import json
import pytest

from blebox_uniapi.box_types import get_latest_api_level
from .conftest import CommonEntity, DefaultBoxTest, future_date, jmerge

TEMP_CELSIUS = "celsius"
DEVICE_CLASS_TEMPERATURE = "temperature class"


class BleBoxSensorEntity(CommonEntity):
    """Home Assistant representation style of a BleBox sensor feature."""

    @property
    def state(self):
        """Return the temperature."""
        return self._feature.current

    @property
    def unit_of_measurement(self):
        """Return the temperature unit."""
        return {"celsius": TEMP_CELSIUS}[self._feature.unit]

    @property
    def device_class(self):
        """Return the device class."""
        types = {"temperature": DEVICE_CLASS_TEMPERATURE}
        return types[self._feature.device_class]

    @property
    def native_value(self):
        """Return the state."""
        return self._feature.native_value


class TestTempSensor(DefaultBoxTest):
    """Tests for sensors representing BleBox tempSensor."""

    DEVCLASS = "sensors"
    ENTITY_CLASS = BleBoxSensorEntity

    DEV_INFO_PATH = "api/tempsensor/state"

    DEVICE_INFO = json.loads(
        """
    {
        "device": {
            "deviceName": "My tempSensor",
            "type": "tempSensor",
            "fv": "0.176",
            "hv": "0.6",
            "apiLevel": "20180604",
            "id": "1afe34db9437",
            "ip": "172.100.123.4"
        }
    }
    """
    )

    def patch_version(apiLevel):
        """Generate a patch for a JSON state fixture."""
        return f"""
        {{ "device": {{ "apiLevel": {apiLevel} }} }}
        """

    DEVICE_INFO_FUTURE = jmerge(DEVICE_INFO, patch_version(future_date()))
    DEVICE_INFO_LATEST = jmerge(
        DEVICE_INFO, patch_version(get_latest_api_level("tempSensor"))
    )
    DEVICE_INFO_UNSUPPORTED = jmerge(DEVICE_INFO, patch_version(20180603))

    DEVICE_INFO_UNSPECIFIED_API = json.loads(
        """
    {
        "device": {
            "deviceName": "My tempSensor",
            "type": "tempSensor",
            "fv": "0.176",
            "hv": "0.6",
            "id": "1afe34db9437",
            "ip": "172.100.123.4"
        }
    }
    """
    )

    STATE_DEFAULT = json.loads(
        """
    {
      "tempSensor": {
        "sensors": [
          {
            "type": "temperature",
            "id": 0,
            "value": 2518,
            "trend": 3,
            "state": 2,
            "elapsedTimeS": 0
          }
        ]
      }
    }
    """
    )

    DEVICE_EXTENDED_INFO_RAIN_AIR_TEMP = {}

    DEVICE_MULTISENSOR = json.loads(
        """
        {
            "multiSensor":
            {
                "sensors":
                [
                    {
                        "type": "temperature",
                        "id": 0,
                        "name": "Temperature outside",
                        "iconSet": 2,
                        "value": 3606,
                        "trend": 2,
                        "state": 2,
                        "elapsedTimeS": -1
                    },
                    {
                        "type": "temperature",
                        "id": 1,
                        "name": "Temperature inside fence",
                        "iconSet": 3,
                        "value": 4712,
                        "trend": 3,
                        "state": 2,
                        "elapsedTimeS": -1
                    },
                    {
                        "type": "temperature",
                        "id": 2,
                        "name": "Underground -10 cm",
                        "iconSet": 2,
                        "value": 2050,
                        "trend": 3,
                        "state": 2,
                        "elapsedTimeS": -1
                    }
                ]
            }
        }"""
    )

    DEVICE_MULTISENSOR_UPDATE = json.loads(
        """
        {
            "multiSensor":
            {
                "sensors":
                [
                    {
                        "type": "temperature",
                        "id": 0,
                        "name": "Temperature outside",
                        "iconSet": 2,
                        "value": 123,
                        "trend": 2,
                        "state": 2,
                        "elapsedTimeS": -1
                    },
                    {
                        "type": "temperature",
                        "id": 1,
                        "name": "Temperature inside fence",
                        "iconSet": 3,
                        "value": 213,
                        "trend": 3,
                        "state": 2,
                        "elapsedTimeS": -1
                    },
                    {
                        "type": "temperature",
                        "id": 2,
                        "name": "Underground -10 cm",
                        "iconSet": 2,
                        "value": 312,
                        "trend": 3,
                        "state": 2,
                        "elapsedTimeS": -1
                    }
                ]
            }
        }"""
    )
    DEVICE_EXTENDED_INFO = DEVICE_MULTISENSOR
    DEVICE_EXTENDED_INFO_PATH = "/state/extended"

    DEVICE_INFO_MULTISENSOR = json.loads(
        """
        {
          "device":
          {
            "deviceName": "Backyard - tempSensor PRO",
            "type": "multiSensor",
            "product": "tempSensorPro",
            "hv": "tSP-1.0",
            "fv": "0.1044",
            "universe": 0,
            "apiLevel": "20210413",
            "categories":
            [
              4,
              7
            ],
            "id": "42f5200ca102",
            "ip": "172.0.0.1",
            "availableFv": null
          }
        }
        """
    )

    async def test_init(self, aioclient_mock):
        """Test sensor default state."""

        await self.allow_get_info(aioclient_mock)
        entity = (await self.async_entities(aioclient_mock))[0]

        assert entity.device_class == DEVICE_CLASS_TEMPERATURE
        assert entity.unique_id == "BleBox-tempSensor-1afe34db9437-0.temperature"
        assert entity.unit_of_measurement == TEMP_CELSIUS
        assert entity.state is None
        # assert entity.outdated is False

    async def test_device_info(self, aioclient_mock):
        await self.allow_get_info(aioclient_mock, self.DEVICE_INFO)
        entity = (await self.async_entities(aioclient_mock))[0]
        assert entity.device_info["name"] == "My tempSensor"
        assert entity.device_info["mac"] == "1afe34db9437"
        assert entity.device_info["manufacturer"] == "BleBox"
        assert entity.device_info["model"] == "tempSensor"
        assert entity.device_info["sw_version"] == "0.176"

    async def test_update(self, aioclient_mock):
        """Test sensor update."""

        await self.allow_get_info(aioclient_mock)
        entity = (await self.async_entities(aioclient_mock))[0]

        self.allow_get_state(aioclient_mock, self.STATE_DEFAULT)
        await entity.async_update()

        # TODO: include product name?
        assert entity.name == "My tempSensor (tempSensor#0.temperature)"
        assert entity.state == 25.2

    async def test_sensor_factory(self, aioclient_mock):
        """Test sensor factory method class."""

        self.DEVICE_EXTENDED_INFO = self.DEVICE_MULTISENSOR
        self.STATE_DEFAULT = self.DEVICE_MULTISENSOR
        self.DEVICE_INFO = self.DEVICE_INFO_MULTISENSOR
        await self.allow_get_info(aioclient_mock)

        entity = await self.async_entities(aioclient_mock)

        assert len(entity) == 3

    async def test_multisensor_update(self, aioclient_mock):
        self.DEV_INFO_PATH = "state"
        self.DEVICE_EXTENDED_INFO = self.DEVICE_MULTISENSOR
        self.STATE_DEFAULT = self.DEVICE_MULTISENSOR
        self.DEVICE_INFO = self.DEVICE_INFO_MULTISENSOR
        # await self.allow_get_state(aioclient_mock)

        entity = await self.updated(aioclient_mock, self.DEVICE_MULTISENSOR_UPDATE)

        assert entity.native_value == 1.2


class TestAirSensor(DefaultBoxTest):
    """Tests for sensors representing BleBox airSensor."""

    DEV_INFO_PATH = "api/air/state"

    DEVCLASS = "sensors"
    ENTITY_CLASS = BleBoxSensorEntity

    DEVICE_INFO = json.loads(
        """
    {
        "deviceName": "My air 1",
        "type": "airSensor",
        "fv": "0.973",
        "hv": "0.6",
        "apiLevel": "20180403",
        "id": "1afe34db9437",
        "ip": "192.168.1.11"
    }
    """
    )

    def patch_version(apiLevel):
        """Generate a patch for a JSON state fixture."""
        return f"""
        {{ "apiLevel": {apiLevel} }}
        """

    DEVICE_INFO_FUTURE = jmerge(DEVICE_INFO, patch_version(future_date()))
    DEVICE_INFO_LATEST = jmerge(
        DEVICE_INFO, patch_version(get_latest_api_level("airSensor"))
    )
    DEVICE_INFO_UNSUPPORTED = jmerge(DEVICE_INFO, patch_version(20180402))

    DEVICE_INFO_UNSPECIFIED_API = json.loads(
        """
    {
        "deviceName": "My air 1",
        "type": "airSensor",
        "fv": "0.973",
        "hv": "0.6",
        "id": "1afe34db9437",
        "ip": "192.168.1.11"
    }
    """
    )

    STATE_DEFAULT = json.loads(
        """
        {
            "air": {
                "sensors": [
                    {
                        "type": "pm1",
                        "value": 49,
                        "trend": 3,
                        "state": 0,
                        "qualityLevel": 0,
                        "elaspedTimeS": -1
                    },
                    {
                        "type": "pm2.5",
                        "value": 222,
                        "trend": 1,
                        "state": 0,
                        "qualityLevel": 4,
                        "elaspedTimeS": -1
                    },
                    {
                        "type": "pm10",
                        "value": 333,
                        "trend": 0,
                        "state": 0,
                        "qualityLevel": 6,
                        "elaspedTimeS": -1
                    }
                ]
            }
        }
        """
    )

    # DEVICE_EXTENDED_INFO
    # DEVICE_EXTENDED_INFO_PATH

    async def test_init(self, aioclient_mock):
        """Test air quality sensor default state."""

        await self.allow_get_info(aioclient_mock)
        entity = (await self.async_entities(aioclient_mock))[0]

        assert entity.name == "My air 1 (airSensor#pm1)"
        assert entity.unique_id == "BleBox-airSensor-1afe34db9437-pm1"
        assert entity.native_value is None

    async def test_device_info(self, aioclient_mock):
        await self.allow_get_info(aioclient_mock, self.DEVICE_INFO)
        entity = (await self.async_entities(aioclient_mock))[0]
        assert entity.device_info["name"] == "My air 1"
        assert entity.device_info["mac"] == "1afe34db9437"
        assert entity.device_info["manufacturer"] == "BleBox"
        assert entity.device_info["model"] == "airSensor"
        assert entity.device_info["sw_version"] == "0.973"

    @pytest.mark.parametrize("io_param", [(0, 49), (1, 222), (2, 333)])
    async def test_update(self, aioclient_mock, io_param):
        """Test air quality sensor state after update."""

        await self.allow_get_info(aioclient_mock)
        entity = (await self.async_entities(aioclient_mock))[io_param[0]]

        self.allow_get_state(aioclient_mock, self.STATE_DEFAULT)
        await entity.async_update()

        assert entity.native_value == io_param[1]  # parametrised

    async def test_list_quantity(self, aioclient_mock):
        """Test air sensor init from config."""
        await self.allow_get_info(aioclient_mock)

        entity = await self.async_entities(aioclient_mock)

        assert len(entity) == 3