Added aggregated stats to device api endpoint

Author: qoda

iotserver/apps/device/api/serializers.py

@@ -49,6 +49,7 @@ class DeviceListDetailSerializer(serializers.ModelSerializer):
     location = LocationSerializer(many=False, read_only=True)
     pins = DevicePinSerializer(many=True, read_only=True)
     last_status = serializers.SerializerMethodField()
+    aggregated_status = serializers.SerializerMethodField()
     health = serializers.SerializerMethodField()
 
     class Meta:
@@ -58,7 +59,11 @@ class Meta:
 
     def get_last_status(self, instance):
         if instance.last_status:
-            return DeviceStatusSerializer(instance.last_status).data
+            return DeviceStatusSerializer(instance.last_status['status']).data
+
+    def get_aggregated_status(self, instance):
+        if instance.last_status:
+            return instance.last_status['aggregates']
 
     def get_health(self, instance):
         try:

iotserver/apps/device/models.py

@@ -11,7 +11,7 @@
 from django.utils.functional import cached_property
 
 from iotserver.apps.device import constants
-from iotserver.apps.device.utils import mqtt, webrepl
+from iotserver.apps.device.utils import mqtt, stats, webrepl
 
 
 class Location(models.Model):
@@ -89,7 +89,10 @@ def full_config(self):
 
     @cached_property
     def last_status(self):
-        return self.statuses.first()
+        return {
+            'status': self.statuses.first(),
+            'aggregates': stats.aggregate_statuses(self.statuses),
+        }
 
     def mqtt_toggle(self, state: str):
         mqtt.toggle(self.id, str(constants.DEVICE_TOGGLE_STATE[state]))

iotserver/apps/device/tests/test_models.py

@@ -38,7 +38,39 @@ class TestDeviceModel(object):
     def setup_method(self, test_method):
         self.device = device_factories.DeviceFactory()
         self.device_pin = device_factories.DevicePinFactory(devices=[self.device])
-        self.device_status = device_factories.DeviceStatusFactory(device=self.device)
+        self.device_statuses = [
+            device_factories.DeviceStatusFactory(
+                device=self.device,
+                status={
+                    'dht-sensor': {
+                        'humidity': 10,
+                        'temperature': 10
+                    },
+                    'light-sensor': 10
+                },
+            ),
+            device_factories.DeviceStatusFactory(
+                device=self.device,
+                status={
+                    'dht-sensor': {
+                        'humidity': 20,
+                        'temperature': 20
+                    },
+                    'light-sensor': 20
+                },
+            ),
+            device_factories.DeviceStatusFactory(
+                device=self.device,
+                status={
+                    'dht-sensor': {
+                        'humidity': 12,
+                        'temperature': 12
+                    },
+                    'light-sensor': 12
+                },
+            )
+        ]
+        self.device_status = self.device_statuses[2]
 
     def test_str(self):
         assert str(self.device) == self.device.name
@@ -53,7 +85,14 @@ def test_full_config(self):
         }
 
     def test_last_status(self):
-        assert self.device.last_status.pk == self.device_status.pk
+        assert self.device.last_status['status'].pk == self.device_status.pk
+        assert self.device.last_status['aggregates'] == {
+            'dht-sensor': {
+                'humidity': {'minimum': 10, 'maximum': 20, 'average': 15},
+                'temperature': {'minimum': 10, 'maximum': 20, 'average': 15}
+            },
+            'light-sensor': {'minimum': 10, 'maximum': 20, 'average': 15}
+        }
 
     def test_mqtt_toggle(self, mocker):
         mock_mqtt_toggle = mocker.patch('iotserver.apps.device.models.mqtt.toggle')

iotserver/apps/device/utils/stats.py

@@ -0,0 +1,43 @@
+from django.utils import timezone
+
+
+def aggregate_statuses(statuses):
+    """
+    Returns device stats by minimum, maximum and average values for today.
+    """
+    today = timezone.now().date()
+    statuses = statuses.filter(created_at__date=today)
+
+    aggregates = {}
+    for status in statuses:
+        for key, value in status.status.items():
+            if isinstance(value, dict):
+                if key not in aggregates:
+                    aggregates[key] = {}
+                for subkey, subvalue in value.items():
+                    if subkey not in aggregates[key]:
+                        aggregates[key][subkey] = {
+                            'minimum': subvalue,
+                            'maximum': subvalue
+                        }
+                    else:
+                        aggregates[key][subkey]['minimum'] = min(
+                            aggregates[key][subkey]['minimum'], subvalue
+                        )
+                        aggregates[key][subkey]['maximum'] = max(
+                            aggregates[key][subkey]['maximum'], subvalue
+                        )
+                    aggregates[key][subkey]['average'] = (
+                        aggregates[key][subkey]['minimum'] +
+                        aggregates[key][subkey]['maximum']
+                    ) / 2
+            else:
+                if key not in aggregates:
+                    aggregates[key] = {'minimum': value, 'maximum': value}
+                else:
+                    aggregates[key]['minimum'] = min(aggregates[key]['minimum'], value)
+                    aggregates[key]['maximum'] = max(aggregates[key]['maximum'], value)
+                aggregates[key]['average'] = (
+                    aggregates[key]['minimum'] + aggregates[key]['maximum']
+                ) / 2
+    return aggregates

iotserver/tests/test_views.py

@@ -25,7 +25,10 @@ def test_detail__no_device(self, api_client):
 
     def test_detail__device_id(self, api_client):
         response = api_client.get(f'{self.root_url}{self.device_health.device_id}/')
+
         return_data = response.json()
 
         assert response.status_code == 200
         assert return_data['status'] == 'ok'
+
+        assert self.device_health.updated_at != self.device_health.created_at

iotserver/urls.py

@@ -29,6 +29,7 @@
 
 # Health endpoint
 urlpatterns = [
+    path('health/<str:device_pk>/', health),
     path('health/', health),
 ]
 
@@ -51,14 +52,5 @@
     path('api/schema/docs/', SpectacularRedocView.as_view(url_name='schema'), name='docs'),
 ]
 
-# from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
-# urlpatterns = [
-#     # YOUR PATTERNS
-#     path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
-#     # Optional UI:
-#     path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
-#     path('api/schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
-# ]
-
 # Static files
 urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

iotserver/views.py

@@ -5,9 +5,16 @@
 )
 from rest_framework.response import Response
 
+from iotserver.apps.device.models import DeviceHealth
+
 
 @api_view(['GET'])
 @authentication_classes([])
 @permission_classes([])
 def health(request, device_pk=None):
+    if device_pk is not None:
+        device_health, created = DeviceHealth.objects.get_or_create(device_id=device_pk)
+        if not created:
+            device_health.save()
+
     return Response({'status': 'ok'})