[feature] Add API endpoint for indoor map coordinates #828 by dee077 · Pull Request #976 · openwisp/openwisp-controller

dee077 · 2025-02-02T13:46:33Z

Implemented API to return device coordinates for a given location ID.

Fixes #828

Checklist

I have read the OpenWISP Contributing Guidelines.
I have manually tested the changes proposed in this pull request.
I have written new test cases for new code and/or updated existing tests for changes to existing code.
I have updated the documentation.

Reference to Existing Issue

Closes #828

Description of Changes

Added endpoint floorplan_coordinates_list to list coordinates
Created a new serializer to add this below fields

fields = [
    "name", 
    "mac_address",
     "is_deactivated",
     "model",
     "os",
     "floor_name",
     "floor",
     "image",
     "location",
]

Added filter by floor
Added pagination class
Added test

coveralls · 2025-02-02T17:50:38Z

coverage: 98.888% (-0.01%) from 98.899%
when pulling 1754156 on dee077:feature/828-api-indoor-map-coordinates
into 129a42f on openwisp:master.

nemesifier · 2025-02-06T22:04:09Z

@dee077 Isn't this part of the GSoC project idea for the indoor map?

dee077 · 2025-02-07T07:04:14Z

Yes, this aligns with the GSoC project idea for the indoor map. However, at the time, it didn’t have the gsoc-idea label, so I wasn’t aware that it would be proposed as a GSoC idea for 2025.

nemesifier

The output looks very similar to GeoJSON, but it's not.
Good progress @dee077 👏

Look at where we use GeoJSON (rest_framework_gis): https://github.com/search?q=repo%3Aopenwisp%2Fopenwisp-controller%20rest_framework_gis&type=code.

Let's paginate the results and ensure the frontend can load paginated results gradually without crashing if there's many floorplan points scattered on many floors.

openwisp_controller/geo/api/serializers.py

openwisp_controller/geo/api/views.py

dee077 · 2025-07-16T21:30:25Z

Updates

Updated filter class as suggested.
Updated docs
Updated tests to use more descriptive variable names

pandafy

@dee077 I found some minor issues on this PR which I missed in my previous review.

Since, all of these changes are minor, I will take care of them now so you can focus working on other tasks.

However, I ask you to review all the comments so we can avoid them in the future.

pandafy · 2025-07-28T10:25:36Z

docs/user/rest-api.rst

+
+.. note::
+
+    this endpoint returns device coordinates from the first floor above


Suggested change

this endpoint returns device coordinates from the first floor above

This endpoint returns device coordinates from the first floor above

pandafy · 2025-07-28T10:32:05Z

openwisp_controller/geo/api/serializers.py

+    def get_floor_name(self, obj):
+        loc_name = obj.floorplan.location.name
+        floor_no = obj.floorplan.floor
+        return f"{loc_name} {ordinal(floor_no)} Floor"


I thought, I already respond to this question, my bad.

The django-loci model has the correct string representation for the object. Can you we that?

https://github.com/openwisp/django-loci/blob/4e45c8d986697cf851bc2b04bbb01b989c63720f/django_loci/base/models.py#L101-L106

pandafy · 2025-07-28T11:23:27Z

openwisp_controller/geo/api/views.py

+    def get_parent_queryset(self):
+        return DeviceLocation.objects.filter(location__pk=self.kwargs.get("pk"))


The get_parent_queryset() method is used to get the list of parent elements which has the organization field.

https://github.com/openwisp/openwisp-users/blob/17aeffb5be731c5c969475bad5690bb94711c0fd/openwisp_users/api/mixins.py#L108-L115

I believe returning the queryset of the Location object will be more appropriate here.

Right now, both parent and child models are same.

pandafy · 2025-07-28T11:23:59Z

openwisp_controller/geo/api/views.py

+    filter_backends = [filters.DjangoFilterBackend]
+    filterset_class = IndoorCoordinatesFilter
+    pagination_class = IndoorCoodinatesViewPagination
+    organization_field = "content_object__organization"


While this works without any issues, for logical reasons I think `floorplan__organization" will be more appropriate here.

pandafy · 2025-07-28T12:34:00Z

openwisp_controller/geo/tests/test_api.py

            self.assertEqual(r.status_code, 401)

+    @capture_any_output()
+    def test_indoor_coodinate_list(self):


There's a lack of check which verifies the complete response.

Ideally, we want the tests to fail when we make changes to the code. Right now, the tests are not exhaustive. E.g., if I remove the admin url from the response, then none of the tests would fail.

pandafy · 2025-07-28T12:37:04Z

openwisp_controller/geo/tests/test_api.py

            r = self.client.get(reverse(url))
            self.assertEqual(r.status_code, 401)

+    @capture_any_output()


@dee077 why did you use capture_any_output for this test?

We generally use this to suppress noisy logging while running the test suite. In my testing this test did not generate any noise.

pandafy · 2025-07-28T12:55:57Z

openwisp_controller/geo/api/serializers.py

+
+class IndoorCoordinatesSerializer(serializers.ModelSerializer):
+    admin_edit_url = SerializerMethodField("get_admin_edit_url")
+    content_object_id = serializers.UUIDField(


I think, device_id would be more descriptive here instead of content_object_id.

nemesifier · 2025-07-29T16:38:45Z

docs/user/rest-api.rst

+    This endpoint returns device coordinates from the first floor above
+    ground (lowest non-negative floors) by default. If a location only has
+    negative floors (e.g. underground parking lot), then it will return
+    the closest floor to the ground (maximum negative floor).


Suggested change

the closest floor to the ground (maximum negative floor).

the closest floor to the ground (greatest negative floor).

nemesifier · 2025-07-29T16:53:00Z

openwisp_controller/geo/utils.py

            name="detail_location",
        ),
+        path(
+            "api/v1/controller/location/<str:pk>/indoor-coordinates/",


Suggested change

"api/v1/controller/location/<str:pk>/indoor-coordinates/",

"api/v1/controller/location/<uuid:pk>/indoor-coordinates/",

Please verify that trying to open an URL with an invalid UUID returns 404 (should be automatically handled by Django), if that's not the case please write a test for this and fix the bug (hopefully not necessary).

PS: you have copied the URL definition structure from the URLs above, which also suffer from the same issue, I am fixing that in #1101.

Updated to uuid and it is showing 404 not found on invalid id

Implemented API to return device coordinates for a given location ID. Fixes openwisp#828

dee077 force-pushed the feature/828-api-indoor-map-coordinates branch 3 times, most recently from 103a39c to 611f852 Compare February 2, 2025 17:22

dee077 closed this Feb 2, 2025

dee077 reopened this Feb 2, 2025

dee077 changed the title ~~[feature] Add API endpoint for indoor map coordinates #828~~ [feature] Add API endpoint for indoor map coordinates Feb 2, 2025

dee077 changed the title ~~[feature] Add API endpoint for indoor map coordinates~~ [feature] Add API endpoint for indoor map coordinates #828 Feb 2, 2025

pandafy self-requested a review February 3, 2025 08:59

dee077 added this to [GSoC25] General Map: Indoor, Mobile, Linkable URLs May 15, 2025

dee077 moved this to In progress in [GSoC25] General Map: Indoor, Mobile, Linkable URLs May 15, 2025

dee077 changed the base branch from master to gsoc25-map May 23, 2025 14:53

nemesifier added the gsoc Part of a Google Summer of Code project label May 23, 2025

nemesifier assigned dee077 May 23, 2025

dee077 force-pushed the feature/828-api-indoor-map-coordinates branch 4 times, most recently from d3ca54d to e1e9295 Compare June 11, 2025 13:40

nemesifier requested changes Jun 14, 2025

View reviewed changes

github-project-automation bot moved this from To do (general) to In progress in OpenWISP Contributor's Board Jun 14, 2025

dee077 force-pushed the feature/828-api-indoor-map-coordinates branch from c9ab3be to f6bf373 Compare June 16, 2025 18:15

dee077 marked this pull request as ready for review June 17, 2025 17:14

dee077 force-pushed the feature/828-api-indoor-map-coordinates branch from bafe7c1 to 0b15b71 Compare June 17, 2025 17:26

dee077 moved this from In progress to In review in [GSoC25] General Map: Indoor, Mobile, Linkable URLs Jun 18, 2025

dee077 force-pushed the feature/828-api-indoor-map-coordinates branch 2 times, most recently from d77d518 to 69976d0 Compare June 26, 2025 22:24

nemesifier requested changes Jun 30, 2025

View reviewed changes

openwisp_controller/geo/api/serializers.py Outdated Show resolved Hide resolved

pandafy reviewed Jul 4, 2025

View reviewed changes

openwisp_controller/geo/api/views.py Outdated Show resolved Hide resolved

dee077 force-pushed the feature/828-api-indoor-map-coordinates branch from 319676a to eec111f Compare July 16, 2025 23:12

pandafy reviewed Jul 28, 2025

View reviewed changes

pandafy approved these changes Jul 28, 2025

View reviewed changes

nemesifier requested changes Jul 29, 2025

View reviewed changes

nemesifier approved these changes Jul 29, 2025

View reviewed changes

dee077 and others added 20 commits July 30, 2025 04:04

[feature] Add API endpoint for indoor map coordinates openwisp#828

8fa196f

Implemented API to return device coordinates for a given location ID. Fixes openwisp#828

[feature] Redesign floorplan coordinates list endpoint

70759f5

[fix] Change floorplan coordinates to (y,x)

4312973

[fix] Added pagination_class in the view and added the test

fbc3ec1

[fix] Rename endpoint url

4f91aca

[fix] Fix url and update fields

0f01bd9

[fix] Fix pagination

a1ae166

[fix] Update indoor-coordinates endpoint

c2d5644

[fix] Floors getting filtered and then get_available_floors is called

50c70e2

[chores] Fix tests and remove unnecessary filter class

ff3c177

[fix] Add tests and create a filter class

c5fe5f9

[docs] Add docs for the api

0dfd0e4

[fix] Add a subtest and filter class in the view

56264fc

[fix] Add edge case tests for default floor

f2b67d7

[fix] Added test to proper test class

d402615

[fix] Update docs, filter class and tests

db30cb8

[fix] Fix IndoorCoordinatesList list method structure

ba2688a

[miscellaneous] Improved tests and API view

6e93759

[fix] Fixed lookup of IndoorCoordinatesList

5320029

[fix] Add uuid in url and small change in docs

8e81084

dee077 force-pushed the feature/828-api-indoor-map-coordinates branch from d39ba0e to 8e81084 Compare July 29, 2025 22:35

nemesifier merged commit daa9ed3 into openwisp:gsoc25-map Jul 29, 2025
12 checks passed

github-project-automation bot moved this from In review to Done in [GSoC25] General Map: Indoor, Mobile, Linkable URLs Jul 29, 2025

github-project-automation bot moved this from In progress to Done in OpenWISP Contributor's Board Jul 29, 2025


		.. note::

		this endpoint returns device coordinates from the first floor above

		def get_parent_queryset(self):
		return DeviceLocation.objects.filter(location__pk=self.kwargs.get("pk"))

	the closest floor to the ground (maximum negative floor).
	the closest floor to the ground (greatest negative floor).

	"api/v1/controller/location/<str:pk>/indoor-coordinates/",
	"api/v1/controller/location/<uuid:pk>/indoor-coordinates/",

Uh oh!

Conversation

dee077 commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Reference to Existing Issue

Description of Changes

Uh oh!

coveralls commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nemesifier commented Feb 6, 2025

Uh oh!

dee077 commented Feb 7, 2025

Uh oh!

nemesifier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dee077 commented Jul 16, 2025

Updates

Uh oh!

pandafy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nemesifier Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dee077 commented Feb 2, 2025 •

edited

Loading

coveralls commented Feb 2, 2025 •

edited

Loading

nemesifier Jul 29, 2025 •

edited

Loading