|
1 | | -Geographic and Indoor Maps |
2 | | -========================== |
| 1 | +Geographic & Indoor Maps |
| 2 | +======================== |
3 | 3 |
|
4 | 4 | .. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/intro.gif |
| 5 | + :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/intro.gif |
5 | 6 | :alt: Intro |
6 | 7 |
|
7 | 8 | OpenWISP provides a unified web interface to monitor network status across |
8 | 9 | all scales: start with a global geographic overview, drill down into |
9 | 10 | specific buildings via indoor maps, and switch between floors to track |
10 | 11 | devices in real time. |
11 | 12 |
|
12 | | -- **Indoor Map View with Floor Navigation:** The dashboard map includes an |
13 | | - indoor view with floor switching and fullscreen mode. |
| 13 | +.. contents:: **Table of contents**: |
| 14 | + :depth: 1 |
| 15 | + :local: |
14 | 16 |
|
15 | | - .. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/indoor-map-view.gif |
16 | | - :alt: Indoor map view |
| 17 | +Indoor Map View with Floor Navigation |
| 18 | +------------------------------------- |
17 | 19 |
|
18 | | -- **Location View on Dedicated Map Page from Device Details Page:** The |
19 | | - device detail page provides navigation to a full-page geographic map for |
20 | | - the associated location. |
| 20 | +.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/indoor-map-view.gif |
| 21 | + :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/indoor-map-view.gif |
| 22 | + :alt: Indoor map view |
21 | 23 |
|
22 | | - .. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/view-on-general-map-button.gif |
23 | | - :alt: Location View from Device Details Page |
| 24 | +The dashboard map includes an indoor view with floor switching and |
| 25 | +full-screen mode. |
24 | 26 |
|
25 | | -- **Indoor Device View on Dedicated Map Page from Device Details Page:** |
26 | | - The device detail page provides navigation to a full-page indoor map |
27 | | - showing the device position. |
| 27 | +Shareable Geographic Map URLs |
| 28 | +----------------------------- |
28 | 29 |
|
29 | | - .. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/view-on-indoor-map-button.gif |
30 | | - :alt: Indoor Device View from Device Details Page |
| 30 | +.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/bookmark-url-map.gif |
| 31 | + :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/bookmark-url-map.gif |
| 32 | + :alt: Shareable Geographic Map URLs |
31 | 33 |
|
32 | | -- **Shareable Geographic Map URLs:** Interactions with location or device |
33 | | - nodes on the geographic map update the URL. |
| 34 | +Interactions with location or device nodes on the geographic map update |
| 35 | +the URL, which can be bookmarked or shared. |
34 | 36 |
|
35 | | - .. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/bookmark-url-map.gif |
36 | | - :alt: Shareable Geographic Map URLs |
| 37 | +Shareable Indoor Map URLs |
| 38 | +------------------------- |
37 | 39 |
|
38 | | -- **Shareable Indoor Map URLs:** Interactions with indoor device nodes |
39 | | - update the URL. |
| 40 | +.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/bookmark-url-indoor-map.gif |
| 41 | + :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/bookmark-url-indoor-map.gif |
| 42 | + :alt: Shareable Indoor Map URLs |
40 | 43 |
|
41 | | - .. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/bookmark-url-indoor-map.gif |
42 | | - :alt: Shareable Indoor Map URLs |
| 44 | +Interactions with indoor device nodes update the URL, which can be |
| 45 | +bookmarked or shared. |
43 | 46 |
|
44 | | -- **Real-Time Device Position Updates:** Device positions on the map are |
45 | | - updated when new location data is received. |
| 47 | +Jump from Device Detail to General Map |
| 48 | +-------------------------------------- |
46 | 49 |
|
47 | | - .. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/moving-devices.gif |
48 | | - :alt: Real-Time Device Position Updates |
| 50 | +.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/view-on-general-map-button.gif |
| 51 | + :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/view-on-general-map-button.gif |
| 52 | + :alt: Location View from Device Details Page |
49 | 53 |
|
50 | | -- **WebSocket-Based Real-Time Location Updates:** Real-time map updates |
51 | | - are delivered using WebSocket connections, allowing the frontend to |
52 | | - receive live location data without polling. The common location |
53 | | - broadcast channel is available at ``/ws/loci/location/`` and is used to |
54 | | - push device location updates to geographic map views as soon as new data |
55 | | - is received. |
| 54 | +Easily jump from the device detail page to the full geographic map, where |
| 55 | +the current device is already in focus and nearby devices are visible. |
56 | 56 |
|
57 | | - The location broadcast channel requires authentication. Access is |
58 | | - controlled based on organization membership: |
| 57 | +Jump from Device Detail to Full Indoor View |
| 58 | +------------------------------------------- |
59 | 59 |
|
60 | | - - **Superusers:** Can receive location updates for all organizations. |
61 | | - - **Regular Users:** Can only receive location updates for organizations |
62 | | - they manage. |
| 60 | +.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/view-on-indoor-map-button.gif |
| 61 | + :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/view-on-indoor-map-button.gif |
| 62 | + :alt: Indoor Device View from Device Details Page |
63 | 63 |
|
64 | | - This ensures that location data is properly scoped and users can only |
65 | | - receive real-time updates for locations within their managed |
66 | | - organizations. |
| 64 | +Easily jump from the device detail page to the full indoor map, where the |
| 65 | +current device is already in focus and nearby devices are visible. |
| 66 | + |
| 67 | +Real-Time Device Position Updates |
| 68 | +--------------------------------- |
| 69 | + |
| 70 | +.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/moving-devices.gif |
| 71 | + :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.3/moving-devices.gif |
| 72 | + :alt: Real-Time Device Position Updates |
| 73 | + |
| 74 | +Device positions on the map are updated when new location data is |
| 75 | +received. |
| 76 | + |
| 77 | +Real-time map updates are delivered using WebSocket connections, allowing |
| 78 | +the frontend to receive live location data without polling. The common |
| 79 | +location broadcast channel is available at ``/ws/loci/location/`` and is |
| 80 | +used to push device location updates to geographic map views as soon as |
| 81 | +new data is received. |
| 82 | + |
| 83 | +The location broadcast channel requires authentication. Access is |
| 84 | +controlled based on organization membership: |
| 85 | + |
| 86 | +- **Superusers:** Can receive location updates for all organizations. |
| 87 | +- **Regular Users:** Can only receive location updates for organizations |
| 88 | + they manage. |
| 89 | + |
| 90 | +This ensures that location data is properly scoped and users can only |
| 91 | +receive real-time updates for locations within their managed |
| 92 | +organizations. |
0 commit comments