[feature] Added indoor maps #564 #662

- Allow to drill down to indoor map from geographic map
- Added REST API endpoints for getting device details and indoor coordinates
  for specific locations
- Allow searching and filtering by status in geographic map locations

Closes #564
Closes #662

---------

Co-authored-by: Gagan Deep <[email protected]>
Co-authored-by: Federico Capoano <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -83,6 +83,8 @@ jobs:
           pip install -r requirements-test.txt
           pip install -U -I -e .
           pip uninstall -y Django
+          # TODO: Remove before merging - install branch build of openwisp-utils for CI testing
+          pip install -U -I "openwisp-utils @ https://github.com/openwisp/openwisp-utils/tarball/gsoc25-map-adjustments"
           pip install -U ${{ matrix.django-version }}
           sudo npm install -g prettier
 

docs/user/rest-api.rst

@@ -226,6 +226,52 @@ Here's a few examples:
     GET /api/v1/monitoring/device/{pk}/nearby-devices/?model={model1,model2}
     GET /api/v1/monitoring/device/{pk}/nearby-devices/?distance__lte={distance}
 
+List Devices in a Location
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: text
+
+    GET /api/v1/monitoring/location/{pk}/device/
+
+Returns a list of network devices deployed in the specified location.
+
+**Available filters**
+
+- ``search`` (search by device name)
+- ``status`` (monitoring status of the device; multiple statuses can be
+  provided and will be treated as OR filters)
+
+Here's a few examples:
+
+.. code-block:: text
+
+    # search by device name
+    GET /api/v1/monitoring/location/{pk}/device/?search=hall
+    # status
+    GET /api/v1/monitoring/location/{pk}/device/?status=ok
+    # multiple statuses
+    GET /api/v1/monitoring/location/{pk}/device/?status=ok&status=problem
+
+List Device Indoor Coordinates in a Location
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Returns a list of indoor coordinates of network devices deployed in the
+specified location, along with device details and available floors.
+
+.. code-block:: text
+
+    GET /api/v1/monitoring/location/{pk}/indoor-coordinates/
+
+**Available filters**
+
+- ``floor`` (floor number of the floorplan)
+
+Here's a few examples:
+
+.. code-block:: text
+
+    GET /api/v1/monitoring/location/5/indoor-coordinates/?floor=2
+
 List WiFi Session
 ~~~~~~~~~~~~~~~~~
 

openwisp_monitoring/device/api/filters.py

@@ -1,3 +1,4 @@
+from django.db.models import Q
 from django.utils.translation import gettext_lazy as _
 from django_filters import rest_framework as filters
 from swapper import load_model
@@ -9,6 +10,7 @@
 
 Device = load_model("config", "Device")
 WifiSession = load_model("device_monitoring", "WifiSession")
+DeviceMonitoring = load_model("device_monitoring", "DeviceMonitoring")
 
 
 class WifiSessionFilter(FilterDjangoByOrgManaged):
@@ -23,6 +25,24 @@ class Meta:
         }
 
 
+class MonitoringLocationDeviceFilter(filters.FilterSet):
+    search = filters.CharFilter(method="filter_search")
+    status = filters.MultipleChoiceFilter(
+        field_name="monitoring__status",
+        choices=DeviceMonitoring.STATUS,
+    )
+
+    def filter_search(self, queryset, name, value):
+        value = value.strip()
+        return queryset.filter(
+            Q(name__icontains=value) | Q(mac_address__icontains=value)
+        )
+
+    class Meta:
+        model = Device
+        fields = ["search", "status"]
+
+
 class MonitoringDeviceFilter(OrganizationManagedFilter):
     class Meta(OrganizationManagedFilter.Meta):
         model = Device

openwisp_monitoring/device/api/serializers.py

@@ -4,6 +4,7 @@
 from openwisp_controller.config.api.serializers import DeviceListSerializer
 from openwisp_controller.geo.api.serializers import (
     GeoJsonLocationSerializer,
+    IndoorCoordinatesSerializer,
     LocationDeviceSerializer,
 )
 from openwisp_users.api.mixins import FilterSerializerByOrgManaged
@@ -12,6 +13,7 @@
 DeviceMonitoring = load_model("device_monitoring", "DeviceMonitoring")
 DeviceData = load_model("device_monitoring", "DeviceData")
 Device = load_model("config", "Device")
+DeviceLocation = load_model("geo", "DeviceLocation")
 WifiSession = load_model("device_monitoring", "WifiSession")
 WifiClient = load_model("device_monitoring", "WifiClient")
 
@@ -46,6 +48,15 @@ class MonitoringLocationDeviceSerializer(LocationDeviceSerializer):
     monitoring = DeviceMonitoringLocationSerializer()
 
 
+class MonitoringIndoorCoordinatesSerializer(IndoorCoordinatesSerializer):
+    monitoring = DeviceMonitoringLocationSerializer(
+        source="content_object.monitoring", read_only=True
+    )
+
+    class Meta(IndoorCoordinatesSerializer.Meta):
+        fields = IndoorCoordinatesSerializer.Meta.fields + ["monitoring"]
+
+
 class MonitoringNearbyDeviceSerializer(
     FilterSerializerByOrgManaged, serializers.ModelSerializer
 ):

openwisp_monitoring/device/api/urls.py

@@ -40,4 +40,9 @@
         views.wifi_session_detail,
         name="api_wifi_session_detail",
     ),
+    path(
+        "api/v1/monitoring/location/<str:pk>/indoor-coordinates/",
+        views.monitoring_indoor_coordinates_list,
+        name="api_indoor_coordinates_list",
+    ),
 ]

openwisp_monitoring/device/api/views.py

@@ -28,6 +28,7 @@
 from openwisp_controller.geo.api.views import (
     DevicePermission,
     GeoJsonLocationList,
+    IndoorCoordinatesList,
     LocationDeviceList,
     ProtectedAPIMixin,
 )
@@ -40,13 +41,15 @@
 from ..tasks import write_device_metrics
 from .filters import (
     MonitoringDeviceFilter,
+    MonitoringLocationDeviceFilter,
     MonitoringNearbyDeviceFilter,
     WifiSessionFilter,
 )
 from .serializers import (
     MonitoringDeviceDetailSerializer,
     MonitoringDeviceListSerializer,
     MonitoringGeoJsonLocationSerializer,
+    MonitoringIndoorCoordinatesSerializer,
     MonitoringLocationDeviceSerializer,
     MonitoringNearbyDeviceSerializer,
     WifiSessionSerializer,
@@ -59,6 +62,7 @@
 Device = load_model("config", "Device")
 DeviceMonitoring = load_model("device_monitoring", "DeviceMonitoring")
 DeviceData = load_model("device_monitoring", "DeviceData")
+DeviceLocation = load_model("geo", "DeviceLocation")
 Location = load_model("geo", "Location")
 WifiSession = load_model("device_monitoring", "WifiSession")
 
@@ -246,6 +250,8 @@ class MonitoringGeoJsonLocationList(GeoJsonLocationList):
 
 class MonitoringLocationDeviceList(LocationDeviceList):
     serializer_class = MonitoringLocationDeviceSerializer
+    filter_backends = [DjangoFilterBackend]
+    filterset_class = MonitoringLocationDeviceFilter
 
     def get_queryset(self):
         return super().get_queryset().select_related("monitoring").order_by("name")
@@ -254,6 +260,27 @@ def get_queryset(self):
 monitoring_location_device_list = MonitoringLocationDeviceList.as_view()
 
 
+class MonitoringIndoorCoordinatesList(IndoorCoordinatesList):
+    queryset = (
+        DeviceLocation.objects.filter(
+            location__type="indoor",
+            floorplan__isnull=False,
+        )
+        .select_related(
+            "content_object",
+            "content_object__monitoring",
+            "content_object__organization",
+            "location",
+            "floorplan",
+        )
+        .order_by("floorplan__floor")
+    )
+    serializer_class = MonitoringIndoorCoordinatesSerializer
+
+
+monitoring_indoor_coordinates_list = MonitoringIndoorCoordinatesList.as_view()
+
+
 class MonitoringNearbyDeviceList(
     DeviceKeyAuthenticationMixin, FilterByOrganizationManaged, ListAPIView
 ):

openwisp_monitoring/device/apps.py

@@ -375,9 +375,17 @@ def register_dashboard_items(self):
                 urlconf=MONITORING_API_URLCONF,
                 args=["000"],
             )
+            indoor_coordinates_list_url = reverse_lazy(
+                "monitoring:api_indoor_coordinates_list",
+                urlconf=MONITORING_API_URLCONF,
+                args=["000"],
+            )
             if MONITORING_API_BASEURL:
                 device_list_url = urljoin(MONITORING_API_BASEURL, str(device_list_url))
                 loc_geojson_url = urljoin(MONITORING_API_BASEURL, str(loc_geojson_url))
+                indoor_coordinates_list_url = urljoin(
+                    MONITORING_API_BASEURL, str(indoor_coordinates_list_url)
+                )
 
             register_dashboard_template(
                 position=0,
@@ -393,11 +401,14 @@ def register_dashboard_items(self):
                         "monitoring/js/lib/netjsongraph.min.js",
                         "monitoring/js/lib/leaflet.fullscreen.min.js",
                         "monitoring/js/device-map.js",
+                        "monitoring/js/floorplan.js",
                     ),
                 },
                 extra_config={
                     "monitoring_device_list_url": device_list_url,
                     "monitoring_location_geojson_url": loc_geojson_url,
+                    "monitoring_indoor_coordinates_list": indoor_coordinates_list_url,
+                    "monitoring_labels": app_settings.HEALTH_STATUS_LABELS,
                 },
             )
 

openwisp_monitoring/device/settings.py

@@ -37,10 +37,10 @@ def get_critical_device_metrics():
 
 def get_health_status_labels():
     default_labels = {
-        "unknown": "unknown",
         "ok": "ok",
         "problem": "problem",
         "critical": "critical",
+        "unknown": "unknown",
         "deactivated": "deactivated",
     }
     labels = default_labels.copy()