Add method to associate sensor metadata with measurements (#5)

hf-kklein · web-flow · commit ef1fc3642de9 · 2023-12-19T12:00:15.000+01:00
and fix wrong datetime format string
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ async def get_recent_measurements(sensebox_id: str):
     client = OpenSenseMapClient()
     box = await client.get_sensebox(sensebox_id)
     sensor_tasks: list[Awaitable[list[Measurement]]] = [
-        client.get_measurements(box.id, sensor.id) for sensor in box.sensors
+        client.get_sensor_measurements(box.id, sensor.id) for sensor in box.sensors
     ]
     measurement_series = await asyncio.gather(*sensor_tasks)
     await client.close_session()
diff --git a/src/osemclient/client.py b/src/osemclient/client.py
@@ -1,14 +1,15 @@
 """
 This a docstring for the module.
 """
+import asyncio
 import logging
 from datetime import datetime, timezone
-from typing import Optional
+from typing import Awaitable, Optional
 
 from aiohttp import ClientSession, TCPConnector
 from yarl import URL
 
-from osemclient.models import Box, Measurement, _Measurements
+from osemclient.models import Box, Measurement, MeasurementWithSensorMetadata, _Measurements
 
 _logger = logging.getLogger(__name__)
 
@@ -17,7 +18,7 @@
 
 def _to_osem_dateformat(dt: datetime) -> str:
     # OSeM needs the post-decimal places in the ISO/RFC3339 format
-    return dt.astimezone(timezone.utc).strftime("%Y-%m-%dT%H-%M-%S.%fZ")
+    return dt.astimezone(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
 
 
 class OpenSenseMapClient:
@@ -43,7 +44,7 @@ async def get_sensebox(self, sensebox_id: str) -> Box:
             _logger.debug("Retrieved sensebox %s", sensebox_id)
             return result
 
-    async def get_measurements(
+    async def get_sensor_measurements(
         self, sensebox_id: str, sensor_id: str, from_date: Optional[datetime] = None, to_date: Optional[datetime] = None
     ) -> list[Measurement]:
         """
@@ -67,6 +68,31 @@ async def get_measurements(
             )
             return results.root
 
+    async def get_measurements_with_sensor_metadata(
+        self, sensebox_id: str, from_date: Optional[datetime] = None, to_date: Optional[datetime] = None
+    ) -> list[MeasurementWithSensorMetadata]:
+        """
+        Returns all the box measurements in the given time range (or the APIs default if not specified).
+        Other than the get_sensor_measurements method, to use this method you don't have to specify the sensor id.
+        Also, the return values are annotated with the phenomenon measured.
+        The result is not sorted in a specific way.
+        """
+        box = await self.get_sensebox(sensebox_id=sensebox_id)
+        sensor_tasks: list[Awaitable[list[Measurement]]] = [
+            self.get_sensor_measurements(box.id, sensor.id, from_date=from_date, to_date=to_date)
+            for sensor in box.sensors
+        ]
+        sensor_measurements = await asyncio.gather(*sensor_tasks)
+        _logger.debug("Retrieved %i measurement series for sensors of box %s", len(sensor_measurements), sensebox_id)
+        results = [
+            MeasurementWithSensorMetadata.model_validate(
+                {**sensor.dict(by_alias=True), **measurement.dict(by_alias=True)}
+            )
+            for sensor, sensor_measurement_list in zip(box.sensors, sensor_measurements)
+            for measurement in sensor_measurement_list
+        ]
+        return results
+
     async def close_session(self):
         """
         closes the client session
diff --git a/src/osemclient/models.py b/src/osemclient/models.py
@@ -49,3 +49,9 @@ class _Measurements(RootModel[list[Measurement]]):  # pylint:disable=too-few-pub
     The array that is returned by
     https://api.opensensemap.org/boxes/:senseBoxId/data/:sensorId?from-date=fromDate&to-date=toDate
     """
+
+
+class MeasurementWithSensorMetadata(Measurement, SensorMetadata):
+    """
+    A measurement with the associated sensor metadata.
+    """
diff --git a/unittests/test_client.py b/unittests/test_client.py
@@ -142,11 +142,11 @@ async def test_get_sensebox(self):
             assert sensebox.id == "621f53cdb527de001b06ad5e"
             assert len(sensebox.sensors) == 11
 
-    async def test_get_data_from_sensor(self):
+    async def test_get_sensor_measurements(self):
         with aioresponses() as mocked_api:
             mocked_api.get(
                 # pylint:disable=line-too-long
-                "https://api.opensensemap.org/boxes/621f53cdb527de001b06ad5e/data/621f53cdb527de001b06ad69?format=json&from-date=2023-12-15T08-00-00.000000Z&to-date=2023-12-15T08-05-00.000000Z",
+                "https://api.opensensemap.org/boxes/621f53cdb527de001b06ad5e/data/621f53cdb527de001b06ad69?format=json&from-date=2023-12-15T08:00:00.000000Z&to-date=2023-12-15T08:05:00.000000Z",
                 status=200,
                 payload=[
                     {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:04:42.215Z", "value": "2.63"},
@@ -156,12 +156,98 @@ async def test_get_data_from_sensor(self):
                     {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:00:36.615Z", "value": "2.68"},
                 ],
             )
-
             client = OpenSenseMapClient()
-            measurements = await client.get_measurements(
+            measurements = await client.get_sensor_measurements(
                 "621f53cdb527de001b06ad5e",
                 "621f53cdb527de001b06ad69",
                 from_date=_berlin.localize(datetime(2023, 12, 15, 9, 0, 0, 0)),
                 to_date=_berlin.localize(datetime(2023, 12, 15, 9, 5, 0, 0)),
             )
             assert len(measurements) == 5
+
+    async def test_get_measurements_with_sensor_metadata(self):
+        with aioresponses() as mocked_api:
+            mocked_api.get(
+                "https://api.opensensemap.org/boxes/621f53cdb527de001b06ad5e",
+                status=200,
+                payload={
+                    "_id": "621f53cdb527de001b06ad5e",
+                    "createdAt": "2022-03-02T11:23:57.505Z",
+                    "updatedAt": "2023-12-18T13:06:48.041Z",
+                    "name": "CampusJahnallee",
+                    "currentLocation": {
+                        "timestamp": "2022-03-02T11:23:57.500Z",
+                        "coordinates": [12.353332, 51.340222],
+                        "type": "Point",
+                    },
+                    "exposure": "outdoor",
+                    "sensors": [
+                        {
+                            "title": "Temperatur",
+                            "unit": "°C",
+                            "sensorType": "HDC1080",
+                            "icon": "osem-thermometer",
+                            "_id": "621f53cdb527de001b06ad69",
+                            "lastMeasurement": {"createdAt": "2023-12-18T13:06:48.018Z", "value": "9.65"},
+                        },
+                        {
+                            "title": "rel. Luftfeuchte",
+                            "unit": "%",
+                            "sensorType": "HDC1080",
+                            "icon": "osem-humidity",
+                            "_id": "621f53cdb527de001b06ad68",
+                            "lastMeasurement": {"createdAt": "2023-12-18T13:06:48.018Z", "value": "74.66"},
+                        },
+                        # other sensors omitted for brevity
+                    ],
+                    "model": "homeV2EthernetFeinstaub",
+                    "lastMeasurementAt": "2023-12-18T13:06:48.018Z",
+                    "description": "SenseBox der GSD Sachunterricht unter besonderer Berücksichtigung von ...",
+                    "image": "621f53cdb527de001b06ad5e_rrlwm9.jpg",
+                    "weblink": "https://www.erzwiss.uni-leipzig.de/institut-fuer-paedagogik-und-didaktik-im-...",
+                    "loc": [
+                        {
+                            "geometry": {
+                                "timestamp": "2022-03-02T11:23:57.500Z",
+                                "coordinates": [12.353332, 51.340222],
+                                "type": "Point",
+                            },
+                            "type": "Feature",
+                        }
+                    ],
+                },
+            )
+            mocked_api.get(
+                # pylint:disable=line-too-long
+                "https://api.opensensemap.org/boxes/621f53cdb527de001b06ad5e/data/621f53cdb527de001b06ad69?format=json&from-date=2023-12-15T08:00:00.000000Z&to-date=2023-12-15T08:05:00.000000Z",
+                status=200,
+                payload=[
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:04:42.215Z", "value": "2.63"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:03:40.855Z", "value": "2.61"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:02:39.403Z", "value": "2.61"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:01:37.957Z", "value": "2.63"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:00:36.615Z", "value": "2.68"},
+                ],
+            )
+            mocked_api.get(
+                # pylint:disable=line-too-long
+                "https://api.opensensemap.org/boxes/621f53cdb527de001b06ad5e/data/621f53cdb527de001b06ad68?format=json&from-date=2023-12-15T08:00:00.000000Z&to-date=2023-12-15T08:05:00.000000Z",
+                status=200,
+                payload=[
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:04:42.215Z", "value": "99.51"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:03:40.855Z", "value": "99.61"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:02:39.403Z", "value": "99.65"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:01:37.957Z", "value": "99.71"},
+                    {"location": [12.353332, 51.340222], "createdAt": "2023-12-15T08:00:36.615Z", "value": "99.92"},
+                ],
+            )
+            client = OpenSenseMapClient()
+            results = await client.get_measurements_with_sensor_metadata(
+                "621f53cdb527de001b06ad5e",
+                from_date=_berlin.localize(datetime(2023, 12, 15, 9, 0, 0, 0)),
+                to_date=_berlin.localize(datetime(2023, 12, 15, 9, 5, 0, 0)),
+            )
+            assert len(results) == 10
+            # assert the correct sensors are associated with their respective data
+            assert all(3 > float(x.value) > 2 for x in results if x.unit == "°C")
+            assert all(100 > float(x.value) > 99 for x in results if x.unit == "%")

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ async def get_recent_measurements(sensebox_id: str):`
`24`	`24`	`client = OpenSenseMapClient()`
`25`	`25`	`box = await client.get_sensebox(sensebox_id)`
`26`	`26`	`sensor_tasks: list[Awaitable[list[Measurement]]] = [`
`27`		`- client.get_measurements(box.id, sensor.id) for sensor in box.sensors`
	`27`	`+ client.get_sensor_measurements(box.id, sensor.id) for sensor in box.sensors`
`28`	`28`	`]`
`29`	`29`	`measurement_series = await asyncio.gather(*sensor_tasks)`
`30`	`30`	`await client.close_session()`