netbox-map 0.1.0__tar.gz

netbox_map-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Christian Rose
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_map-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include netbox_map/templates *
+recursive-include netbox_map/static *

netbox_map-0.1.0/PKG-INFO

@@ -0,0 +1,418 @@
+Metadata-Version: 2.4
+Name: netbox-map
+Version: 0.1.0
+Summary: Interactive floor plan visualization for NetBox sites
+Author: Christian Rose
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/DenDanskeMine/netbox-map
+Project-URL: Repository, https://github.com/DenDanskeMine/netbox-map
+Project-URL: Issues, https://github.com/DenDanskeMine/netbox-map/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# NetBox Map
+
+![Python](https://img.shields.io/badge/python-3.12%2B-blue.svg)
+![NetBox](https://img.shields.io/badge/netbox-4.5%2B-blue.svg)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/netbox-map.svg)](https://pypi.org/project/netbox-map/)
+
+A comprehensive mapping and floor plan visualization plugin for NetBox. Build interactive data center floor plans, place assets on a global geographic map, visualize rack utilization, explore devices nested inside racks, and configure everything from a web-based settings page — no restart required.
+
+---
+
+## Feature Highlights
+
+| Feature | Description |
+|---------|-------------|
+| **Interactive Floor Plans** | Canvas-based editor with drag-and-drop tile placement, pan/zoom, and configurable grids |
+| **Global Site Map** | Leaflet.js geographic map showing sites, locations, tiles, and standalone markers |
+| **Rack Utilization Heatmap** | Color-coded gradient (green → red) showing rack fill percentage directly on tiles |
+| **Nested Rack Devices** | Expand any rack in the sidebar to see all devices inside it, sorted by U-position |
+| **Searchable Sidebar** | Real-time search across tile labels, device names, and IP addresses — finds devices inside racks |
+| **Rack Elevation View** | Select a rack tile to see its full front/rear elevation SVG in the sidebar |
+| **Camera FOV Visualization** | Configure and display camera field-of-view cones with live preview |
+| **GPS Sync** | Automatically updates device latitude/longitude when placed on a map |
+| **Web-Based Settings** | Toggle features and configure detail panel fields from the UI — no file editing or restarts |
+| **PDF Export** | One-click export of floor plans to PDF |
+| **REST API** | Full CRUD API for all models with filtering and search |
+| **Dark Mode** | Full support for NetBox light and dark themes |
+
+---
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Floor Plan Visualization](#floor-plan-visualization)
+  - [Canvas Editor](#canvas-editor)
+  - [Tile Types](#tile-types)
+  - [Object Linking](#object-linking)
+  - [Rack Utilization](#rack-utilization)
+  - [Nested Rack Devices](#nested-rack-devices)
+  - [Rack Elevation](#rack-elevation)
+  - [Camera FOV](#camera-fov)
+  - [Sidebar Search & Filtering](#sidebar-search--filtering)
+  - [PDF Export](#pdf-export)
+- [Global Site Map](#global-site-map)
+  - [Map Markers](#map-markers)
+  - [Edit Mode](#site-map-edit-mode)
+- [Settings](#settings)
+  - [Detail Panel Configuration](#detail-panel-configuration)
+  - [GPS Sync Toggle](#gps-sync-toggle)
+- [NetBox Integration](#netbox-integration)
+- [REST API](#rest-api)
+- [Controls Reference](#controls-reference)
+- [Development](#development)
+- [License](#license)
+
+---
+
+## Requirements
+
+- NetBox **4.5.0** or later
+- Python **3.12** or later
+
+## Installation
+
+### From PyPI
+
+```bash
+source /opt/netbox/venv/bin/activate
+pip install netbox-map
+```
+
+### From source
+
+```bash
+source /opt/netbox/venv/bin/activate
+pip install git+https://github.com/DenDanskeMine/netbox-map.git
+```
+
+### Enable the plugin
+
+Add `netbox_map` to your NetBox `configuration.py`:
+
+```python
+PLUGINS = [
+    'netbox_map',
+]
+```
+
+### Optional configuration
+
+```python
+PLUGINS_CONFIG = {
+    'netbox_map': {
+        'default_grid_width': 20,    # Default grid width in tiles
+        'default_grid_height': 20,   # Default grid height in tiles
+        'default_tile_size': 60,     # Default tile size in pixels
+    }
+}
+```
+
+> All other settings (detail panel fields, MAC display, GPS sync) are managed from the web-based [Settings](#settings) page.
+
+### Apply migrations
+
+```bash
+cd /opt/netbox/netbox
+python3 manage.py migrate
+```
+
+### Collect static files
+
+```bash
+cd /opt/netbox/netbox
+python3 manage.py collectstatic --no-input
+```
+
+### Restart services
+
+```bash
+sudo systemctl restart netbox
+```
+
+---
+
+## Floor Plan Visualization
+
+### Canvas Editor
+
+The floor plan editor is a full-featured canvas application with:
+
+- **Configurable grid** — set width, height (up to 1000 cells), and tile size (5–200px)
+- **Pan and zoom** — mouse wheel zoom, middle-click or left-click drag to pan
+- **Fit to view** — one click to auto-fit all tiles in the viewport
+- **Background images** — upload blueprints or photos as placement guides
+- **Floor plan selector** — switch between floor plans at the same site without leaving the page
+
+**To create a floor plan:**
+
+1. Navigate to **Floor Plans > Floor Plans > Add**
+2. Select a site, name the floor plan, and configure grid dimensions
+3. Optionally upload a background image
+4. Open the **Visualization** tab to start editing
+
+**Edit mode controls:**
+
+- **Double-click** on the grid to place a new tile
+- **Drag** a tile to move it (auto-saves position)
+- **Click** a tile to select it and view details in the sidebar
+- Use the toolbar to set tile type, label, and dimensions before placing
+- **Delete** selected tiles with the delete button
+
+### Tile Types
+
+12 tile types are available, each with a distinct color:
+
+| Type | Color | Use Case |
+|------|-------|----------|
+| Rack | Utilization gradient | Server racks with fill percentage |
+| Aisle | Dark grey | Walkways between rack rows |
+| Wall | Medium grey | Room boundaries |
+| Column | Light grey | Structural columns |
+| Door | Teal | Entry/exit points |
+| Cooling | Cyan | CRAC/CRAH units, in-row cooling |
+| Power | Gold | PDUs, UPS, electrical panels |
+| Empty | Dark | Placeholder / available space |
+| Reserved | Orange | Reserved for future use |
+| Access Point | Purple | Wireless access points |
+| Camera | Red | Security cameras (with FOV) |
+| Printer | Orange | Network printers |
+
+Each tile supports:
+- **Custom labels** (editable inline)
+- **Size** from 1x1 to 10x10 grid cells
+- **Status** — Active, Planned, or Decommissioned
+- **Orientation** — 0, 90, 180, 270 degrees
+
+### Object Linking
+
+Tiles can be linked to NetBox objects:
+
+- **Racks** — shows utilization, elevation, and nested devices
+- **Devices** — shows primary IP, MAC address, and detail fields
+- **Power Panels** — shows site and location info
+- **Power Feeds** — shows status, voltage, amperage
+
+**To link an object:**
+
+1. Enter edit mode and select a tile
+2. In the **Link Object** panel, choose an object type
+3. Select the specific object from the dropdown (filtered by site)
+4. Click **Link**
+
+### Rack Utilization
+
+Rack tiles display a color-coded utilization heatmap:
+
+- **Green** (0%) → **Yellow** (50%) → **Red** (90%+)
+- Empty/unlinked racks show as neutral grey
+- Utilization percentage is displayed on the tile when there's enough space
+- The gradient legend appears in the header bar
+
+### Nested Rack Devices
+
+Every rack tile in the sidebar shows an **expand arrow** (▸) when it contains devices:
+
+- Click the arrow to expand and see all devices in that rack
+- Devices are sorted by **U-position** (highest first)
+- Each device shows its **name** (linked to NetBox), **IP address**, and **U-position**
+- A device count badge (e.g., "12d") appears on each rack item
+- **Searching works across devices** — type a device name or IP in the search box and the parent rack auto-expands to reveal matching devices
+- Device data is fetched once via a single API call and cached for the session
+
+### Rack Elevation
+
+When a rack tile is selected, the sidebar shows the rack's **elevation SVG**:
+
+- Toggle between **Front** and **Rear** views
+- Shows device positions, model names, and empty slots
+- Click devices in the elevation to navigate to their detail pages
+- Loaded via AJAX from NetBox's rack elevation API
+
+### Camera FOV
+
+Camera-type tiles display a field-of-view cone on the canvas:
+
+- **Direction** (0–360 degrees) — where the camera points (0 = north)
+- **Angle** (10–360 degrees) — how wide the FOV is
+- **Distance** (1–50 grid cells) — how far the camera sees
+- FOV cones render as semi-transparent red wedges
+- **Live preview** — adjust values and see the cone update in real-time
+- Toggle all FOV cones on/off with the **FOV** button in the sidebar
+
+### Sidebar Search & Filtering
+
+The sidebar provides powerful search and filtering:
+
+- **Real-time text search** — filters tiles by label, type, device name, and IP address
+- **Type toggles** — show/hide any of the 12 tile types independently
+- **Tile count** — shows visible / total tile count
+- **Click to zoom** — clicking a sidebar item zooms the canvas to center that tile
+- **Active highlighting** — selected tile is highlighted in both the sidebar and canvas
+
+### PDF Export
+
+Click the **PDF** button in the zoom controls to export the current floor plan:
+
+- Includes all visible tiles with correct colors and labels
+- Respects type toggle visibility (hidden types are excluded)
+- Adds a title header and tile count legend
+- Camera FOV cones are included if the FOV toggle is on
+
+---
+
+## Global Site Map
+
+The site map provides a geographic overview of your entire infrastructure using **Leaflet.js** with OpenStreetMap tiles.
+
+Navigate to **Floor Plans > Maps > Site Map**.
+
+### What's on the map
+
+- **Sites** — with floor plan links in popups
+- **Locations** — via the LocationCoordinates model (extends NetBox locations with lat/lng)
+- **Floor plan tiles** — tiles with geographic coordinates appear on the global map
+- **Standalone map markers** — custom markers not tied to floor plans
+
+### Map Markers
+
+Standalone map markers can be placed anywhere on the globe:
+
+- All 12 marker types supported (same as tile types)
+- Can be linked to devices, racks, power panels, or power feeds
+- Optional site association
+- Description field
+- Camera markers include full FOV visualization on the map
+
+### Site Map Edit Mode
+
+Users with `change_site` permission can enter edit mode:
+
+- **Place sites** — select an unplaced site and click the map to set its coordinates
+- **Place locations** — add geographic coordinates to NetBox locations
+- **Place tiles** — give floor plan tiles a geographic position
+- **Add markers** — create new standalone map markers by clicking the map
+- **Drag to reposition** — all markers are draggable in edit mode (auto-saves)
+- **Remove/delete** — remove tiles from the map or delete standalone markers
+
+---
+
+## Settings
+
+Navigate to **Floor Plans > Configuration > Settings** to manage plugin settings from the web UI.
+
+### Detail Panel Configuration
+
+Control which fields appear in the detail panel when you click a tile or marker:
+
+**General toggles:**
+- **Show MAC Address** — display MAC address for devices (from primary IP interface)
+- **Show Custom Fields** — display custom fields in the detail panel
+
+**Per-object-type field selection:**
+
+Select which standard fields to show for each object type using checkboxes:
+
+| Object Type | Available Fields |
+|-------------|-----------------|
+| **Device** | status, role, device_type, platform, serial, asset_tag, tenant, site, location, rack, position, face, airflow, primary_ip4, primary_ip6, oob_ip, cluster, virtual_chassis, vc_position, description |
+| **Rack** | status, role, facility_id, serial, asset_tag, u_height, width, type, weight, max_weight, tenant, site, location, description |
+| **Power Panel** | site, location, description |
+| **Power Feed** | status, type, supply, voltage, amperage, max_utilization, power_panel, rack, description |
+
+### GPS Sync Toggle
+
+- **Sync Device GPS** — when enabled, placing a device on a map (via tile or marker with coordinates) automatically writes the latitude/longitude to the device record in NetBox
+- When a tile/marker is deleted or the device is unlinked, the GPS is cleared if no other map references remain
+
+All settings are stored in the database and take effect immediately — no restart needed.
+
+---
+
+## NetBox Integration
+
+The plugin integrates with existing NetBox pages:
+
+| Integration | Description |
+|-------------|-------------|
+| **Site detail page** | Panel showing floor plans for the site with links to visualizations |
+| **Device detail page** | "Map Locations" tab listing all floor plan tiles and map markers where the device appears |
+| **Global search** | Floor plans, tiles, and map markers are indexed for NetBox search |
+| **Change logging** | All models support NetBox's change log |
+
+---
+
+## REST API
+
+Full CRUD REST API endpoints:
+
+| Endpoint | Description |
+|----------|-------------|
+| `/api/plugins/netbox-map/floorplans/` | Floor plan CRUD with site/location filtering |
+| `/api/plugins/netbox-map/floorplan-tiles/` | Tile CRUD with floor plan, type, status filtering |
+| `/api/plugins/netbox-map/location-coordinates/` | Geographic coordinates for locations |
+| `/api/plugins/netbox-map/map-markers/` | Standalone map marker CRUD |
+
+All endpoints support filtering, pagination, and brief mode.
+
+---
+
+## Controls Reference
+
+### Floor Plan Canvas
+
+| Action | Control |
+|--------|---------|
+| Pan | Left-click drag (empty space) or middle-click drag |
+| Zoom | Mouse wheel or +/- buttons |
+| Fit to view | Fit button in zoom controls |
+| Select tile | Click |
+| Place tile (edit mode) | Double-click |
+| Move tile (edit mode) | Drag tile |
+
+### Site Map
+
+| Action | Control |
+|--------|---------|
+| Pan | Left-click drag |
+| Zoom | Mouse wheel or +/- buttons |
+| Select marker | Click |
+| Move marker (edit mode) | Drag |
+| Place item (edit mode) | Select item, click map |
+
+### Sidebar
+
+| Action | Control |
+|--------|---------|
+| Search | Type in the search box |
+| Filter by type | Click type toggle buttons |
+| Zoom to tile | Click sidebar item |
+| Expand rack devices | Click the arrow (▸) on a rack item |
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/DenDanskeMine/netbox-map.git
+cd netbox-map
+pip install -e .
+```
+
+## License
+
+This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- [Open an issue](https://github.com/DenDanskeMine/netbox-map/issues) on GitHub
+- Check existing issues for answers