Merge pull request #109 from netbox-community/LHBL-merge

Merge LHBL Updates for new release

Author: cruse1977

CODEOWNERS

@@ -1 +1 @@
-*    @k01ek @cruse1977 @natm
+*    @k01ek @cruse1977 @cvitan

Makefile

@@ -1,5 +1,5 @@
 PYTHON_VER?=3.12
-NETBOX_VER?=v4.2.1
+NETBOX_VER?=v4.3.0
 
 NAME=netbox-qrcode
 

README.md

@@ -1,6 +1,6 @@
 # Netbox QR Code Plugin
 
-[Netbox](https://github.com/netbox-community/netbox) plugin for generate QR codes for objects: Rack, Device, Cable.
+[Netbox](https://github.com/netbox-community/netbox) plugin for generate QR codes for objects: Device, Module, Cable, Powerfeed, Powerpanel, Location 
 
 This plugin depends on [qrcode](https://github.com/lincolnloop/python-qrcode) and [Pillow](https://github.com/python-pillow/Pillow) python library
 
@@ -39,77 +39,63 @@ Restart NetBox and add `netbox-qrcode` to your local_requirements.txt
 
 ## Configuration
 
-The following options are available:
+### Label Design
 
-* `with_text`: Boolean (default True). Text label will be added to QR code image if enabled.
-* `text_template`: [Jinja2](https://jinja.palletsprojects.com/) template with {{ obj }} as context for device, rack, etc., using it ignores `text_fields` and `custom_text`.
+Extensive label customisation is possible, it's also possible to include different labels for each object type, for example 2 labels for the Device view.
 
-  Example to output name and site in two lines with caption (See also screenshots below):
-  ```
-  'text_template': 'Name: {{ obj.name }}\nSite: {{ obj.site }}',
-  ```
-* `text_fields`: List of String (default ['name']). Text fields of an object that will be added as text label to QR image. It's possible to use custom field values.
-* `font`: String (default TahomaBold) Font name for text label ( Some font include in package, see fonts dir).
-* `text_location`: Where to render the text, relative to the QR code.  Valid values are `"right"` (default), `"left"`", `"up"`, and `"down"`.
-* `custom_text`: String or None (default None) additional text label to QR code image (will be added after text_fields).
-* `qr_version`: Integer (default 1) parameter is an integer from 1 to 40 that controls the size of
-the QR Code (the smallest, version 1, is a 21x21 matrix).
-* `qr_error_correction`: Integer (default 0),  controls the error correction used for the
-QR Code. The following values are available:
+For advice on configuration please see the two links below:
 
-   1 - About 7% or less errors can be corrected.
-   0 - About 15% or less errors can be corrected.
-   2 - About 30% or less errors can be corrected.
-   3 - About 25% or less errors can be corrected.
+- [General Configuration >>](docs/README_Subpages/README_Configuration.md)
+- [Configuration Examples  >>](docs/README_Subpages/README_Configuration_ExampleLabelConf.md)
 
-* `qr_box_size`: Integer (default 6),  controls how many pixels each "box" of the QR code
-is.
-* `qr_border`: Integer (default 4),  controls how many boxes thick the border should be
-(the default is 4, which is the minimum according to the specs).
+![Cable QR Code](/docs/img/Configuration_Label_Example_10.png)
 
-### Per object options
 
-Per object options override default options. Per object options dictionary can contains any of default options inside.
+### Printing
+
+#### Setting the label printer 
+
+If the print does not look like the preview in the Netbox, first try to get a perfect print using Word. As many printer settings also have an influence on the print result. Borderless printing is possible if the printer (e.g. thermal transfer printer) supports this.
+
+![ShowImage](/docs/img/Configuration_Printer_WordPreview.png)
+
+
+Here is an example of what needs to be considered to print borderless from a Word document. [Go to: Example Zebra ZM400 300dpi label printer and a label 56x32mm. >>](/docs/img/Configuration_Printer_ZM400.png)
+
+
+#### Setting Browser Print Settings
+
+When you press the “Print” button, there are some print properties that are added by the browser. However, these interfere with the print result. They should therefore be deactivated.
+
+##### Firefox:
+
+| Parameter                                      | Value                        |
+| ---------------------------------------------  | ---------------------------  |
+| Orientation                                    | Portrait                     |  
+| Paper size                                     | User defined                 |
+| Margins                                        | none                         |
+| Scale                                          | Fit to page width or 100%    |
+| Options --> Print headers and footers          | disable                      |
+| Options --> Print backgrounds                  | disable                      |
+
+##### Chrome:
+Chrome can alter settings between printing and the print preview, therefore the below settings are recomended
+
+| Parameter                                      | Value                        |
+| ---------------------------------------------  | ---------------------------  |
+| Layout                                         | Portrait                     |  
+| Paper size                                     | empty !!!                    |
+| Pages per sheet                                | 1                            |
+| Margins                                        | none                         |
+| Scale                                          | Default or 100%              |
+| Options --> PBackground grafics                | disable                      |
+
+![Image](/docs/img/Configuration_Browser_Print_Settings.png)
+
 
-* `device`: Dict or None (default {'text_fields': ['name', 'serial']}), set None to disble QR code
-* `rack`: Dict or None (default {'text_fields': ['name']}) , set None to disble QR code
-* `cable`: Dict or None ( defaul {'text_fields': ['_termination_a_device', 'termination_a', '_termination_b_device', 'termination_b',]}), set None to disble QR code
 
-Configuration example:
-```
-PLUGINS_CONFIG = {
-    'netbox_qrcode': {
-        'with_text': True,
-        'text_fields': ['name', 'serial'],
-        'font': 'ArialMT',
-        'font_size': 12, # If the value is 0 or the line does not exist, then the text is automatically adjusted
-        'custom_text': 'Property of SomeCompany\ntel.8.800333554-CALL',
-        'text_location': 'up',
-        'qr_version': 1,
-        'qr_error_correction': 0,
-        'qr_box_size': 4,
-        'qr_border': 4,
-        # per object options
-        'cable': None,  # disable QR code for Cable object
-        'rack': {
-            'text_fields': [
-                'site',
-                'name',
-                'facility_id',
-                'tenant',
-                'cf.cf_name'
-            ]
-        },
-        'device': {
-            'qr_box_size': 6,
-            'custom_text': None,
-        }
-    }
-}
-```
 
 ## Contributing
-Developing tools for this project based on [ntc-netbox-plugin-onboarding](https://github.com/networktocode/ntc-netbox-plugin-onboarding) repo.
 
 Issues and pull requests are welcomed.
 
@@ -123,6 +109,3 @@ Rack QR code
 
 Cable QR code
 ![Cable QR Code](docs/img/qrcode_cable.png)
-
-Device QR code via Jinja2 "text_template" Parameter (Multiline and labeled)
-![Cable QR Code](docs/img/qrcode_text_template.png)

develop/Dockerfile

@@ -1,12 +1,14 @@
 ARG python_ver=3.12
 FROM python:${python_ver}
 
-ARG netbox_ver=v4.2.1
+ARG netbox_ver=main
 ENV PYTHONUNBUFFERED 1
 
 RUN mkdir -p /opt
 
 RUN pip install --upgrade pip
+RUN pip install setuptools
+
 
 # -------------------------------------------------------------------------------------
 # Install NetBox

develop/Netbox_Icon.png

@@ -157,7 +157,225 @@
 
 # Plugins configuration settings. These settings are used by various plugins that the user may have installed.
 # Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
-# PLUGINS_CONFIG = {}
+PLUGINS_CONFIG = {
+
+    'netbox_qrcode': {
+
+        ## Example Template for Devices
+
+        'device_2': {
+            'title': 'Example 2 (Template for Device)',
+            'text_template': '<div style="display: inline-block; height: 5mm; width: 15mm"><img src="{{ logo }}" style="width:100%; height:100%; object-fit:fill;""></div><br>{{ obj.name }}<br>Device: {{ obj.id|stringformat:"07d" }}',
+            'font_size': '4mm',
+            'label_qr_width': '20mm',
+            'label_qr_height': '30mm',
+            'label_qr_text_distance': '2mm',
+            'label_width': '56mm',
+            'label_height': '32mm',
+            'label_edge_top': '0mm',
+            'label_edge_left': '2mm',
+            'label_edge_right': '2mm',
+            'logo': '/media/image-attachments/Netbox_Icon_Example.png',
+        },
+
+        'device_3': {
+            'title': 'Example 3 (Template for Device)',
+            'font_size': '4mm',
+            'label_qr_width': '15mm',
+            'label_qr_height': '15mm',
+            'label_qr_text_distance': '2mm',
+            'label_width': '56mm',
+            'label_height': '32mm',
+            'label_edge_top': '0mm',
+            'label_edge_left': '2mm',
+            'label_edge_right': '2mm',
+             'text_location': 'left',
+        },
+
+        'device_4': {
+            'title': 'Example 4 (Template for Device)',
+            'font_size': '4mm',
+            'text_align_horizontal': 'center',
+            'text_align_vertical': 'middle',
+            'label_qr_width': '20mm',
+            'label_qr_height': '20mm',
+            'label_qr_text_distance': '0mm',
+            'label_width': '56mm',
+            'label_height': '32mm',
+            'label_edge_top': '0mm',
+            'label_edge_left': '0mm',
+            'label_edge_right': '0mm',
+            'with_text': True,
+            'with_qr': False,
+        },
+
+        'device_5': {
+            'title': 'Example 5 (Template for Device)',
+            'font_size': '4mm',
+            'text_align_horizontal': 'left',
+            'text_align_vertical': 'middle',
+            'label_qr_width': '20mm',
+            'label_qr_height': '20mm',
+            'label_qr_text_distance': '0mm',
+            'label_width': '56mm',
+            'label_height': '32mm',
+            'label_edge_top': '0mm',
+            'label_edge_left': '2mm',
+            'label_edge_right': '0mm',
+            'with_text': True,
+            'with_qr': False,
+        },
+
+        'device_6': {
+            'title': 'Example 6 (Template for Device)',
+            'font_size': '4mm',
+            'label_qr_width': '20mm',
+            'label_qr_height': '20mm',
+            'label_qr_text_distance': '0mm',
+            'label_width': '56mm',
+            'label_height': '32mm',
+            'label_edge_top': '0mm',
+            'label_edge_left': '0mm',
+            'label_edge_right': '0mm',
+            'with_text': False,
+            'with_qr': True,
+        },
+
+        'device_7': {
+            'title': 'Example 7 (Template for Device)',
+            'font_size': '4mm',
+            'label_qr_width': '20mm',
+            'label_qr_height': '20mm',
+            'label_qr_text_distance': '0mm',
+            'label_width': '32mm',
+            'label_height': '56mm',
+            'label_edge_top': '2mm',
+            'label_edge_left': '0mm',
+            'label_edge_right': '0mm',
+            'text_location': 'up',
+            'text_align_horizontal': 'center',
+            'text_align_vertical': 'top',
+            'label_edge_bottom': '2mm',
+        },
+
+        'device_8': {
+            'title': 'Example 8 (Template for Device)',
+            'font_size': '4mm',
+            'label_qr_width': '20mm',
+            'label_qr_height': '20mm',
+            'label_qr_text_distance': '2mm',
+            'label_width': '32mm',
+            'label_height': '56mm',
+            'label_edge_top': '2mm',
+            'label_edge_left': '0mm',
+            'label_edge_right': '0mm',
+            'text_location': 'down',
+            'text_align_horizontal': 'center',
+            'text_align_vertical': 'top',
+        },
+
+        'device_9': {
+            'title': 'Example 9 (Template for Device)',
+            'font_size': '1mm',
+            'label_qr_width': '9mm',
+            'label_qr_height': '9mm',
+            'label_qr_text_distance': '1mm',
+            'label_width': '25mm',
+            'label_height': '10mm',
+            'label_edge_top': '0.2mm',
+            'label_edge_left': '0.2mm',
+            'label_edge_right': '0mm',
+        },
+
+        'device_10': {
+            'title': 'Example 10 (Template for Device)',
+            'with_qr': False,
+            'text_align_horizontal': 'center',
+            'text_align_vertical': 'middle',
+            'text_template': '<div style="display: inline-block; height: 8.65mm; width: 30mm"><img src="/media/image-attachments/Netbox_Icon_Example.png" style="width:100%; height:100%; object-fit:fill;"></div><br>'
+                             '{{ obj.name }} <br>'
+                             '<div style="display: inline-block; height: 10mm; width: 10mm"><img src="data:image/png;base64,{{qrCode}}" style="width:100%; height:100%; object-fit:fill;"/></div><br>' 
+                             'Device: {{ obj.id|stringformat:"07d" }}'
+                             '<p>&#128541; <font color="red"><b> My label design </b> </font> &#128541;</p>',
+                             
+            'label_width': '56mm',
+            'label_height': '32mm',
+            'label_edge_top': '0mm',
+            'label_edge_left': '0mm',
+            'label_edge_right': '0mm',
+        },
+
+
+        ## Example Template for Cables
+
+        'cable': {
+            'title': 'Example 1 (Template for Cable)',
+            'with_qr': False,
+            'label_edge_left': '0.00mm',
+            'label_edge_right': '0.00mm',
+            'label_edge_top': '0.00mm',
+            'text_align_vertical': 'middle',
+            'text_align_horizontal': 'center',
+	        'text_template': '<span style="writing-mode: vertical-lr; transform: scale(-1);">'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+                             '{{ obj.label }}</br>'
+	                     '</span>'
+        },
+
+        'cable_2': {
+            'title': 'Example 2 (Template for Cable)',
+            'with_qr': False,
+            'label_edge_left': '0.00mm',
+            'label_edge_right': '0.00mm',
+            'label_edge_top': '0.00mm',
+            'text_align_vertical': 'middle',
+            'text_align_horizontal': 'center',
+            
+            # QR-Code Image File
+            'qr_version': 1,
+            'qr_error_correction': 1,
+            'qr_box_size': 2,
+            'qr_border': 0,
+            
+	    'text_template': '<svg id="barcode"></svg>'
+	                     '<svg id="barcode"></svg>'
+	                     '<svg id="barcode"></svg>'
+	                     '<svg id="barcode"></svg>'
+	                     ''
+	                     '<style>'
+                             '   #barcode {'
+                             '   max-width: 48mm;'
+                             '   width: 100%;'
+                             '   max-height: 6mm;'
+                             '   height: 100%;'
+                             '   }'
+                             '</style>'
+                             ''
+                             '<script src="https://cdn.jsdelivr.net/npm/jsbarcode@3.11.0/dist/JsBarcode.all.min.js"></script>'
+                             ''
+                             '<script>'
+                             '   JsBarcode("#barcode", "{{ obj.label }}", {'
+                             '   background: "transparent",'
+                             '   format: "CODE128",'
+                             '   displayValue: true,'
+                             '   margin: 0,'
+                             '   height: 15'
+                             '   });'
+                             '</script>'
+        }
+    }
+}
 
 # When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to
 # prefer IPv4 instead.