Configuration

The plugin is configured in the Netbox configuration file: configuration.py If you have followed the standard installation of Netbox, the configuration file is located under: /opt/netbox/netbox/netbox/configuration.py

The following options are available. If the same variable name is specified several times in several lines, these are different examples. Entries with ‘# DEFAULT’ are system defaults.

General Plugin

title:

A title is displayed in the label window. This can be expanded with information. Useful if you want to provide several label variants for devices, for example.
```
'title': '', # DEFAULT
'title': 'My text extension in the plugin heading.',
```

Text content

with_text:

Text label will be added to QR code image if enabled.
```
'with_text': True, # DEFAULT
'with_text': False,
```

text_location:

Where to render the text, relative to the QR code.

'text_location': 'right', # DEFAULT
'text_location': 'left',
'text_location': 'up',
'text_location': 'down',

text_align_horizontal:

Defines where the text is to be displayed horizontally in the text area.

'text_align_horizontal': 'left', # DEFAULT
'text_align_horizontal': 'center',
'text_align_horizontal': 'right',

text_align_vertical:

Defines where the text is to be displayed vertically in the text area.

'text_align_horizontal': 'middle', # DEFAULT
'text_align_horizontal': 'top',
'text_align_horizontal': 'bottom',

Text source (Option A)

text_fields:

Text fields of an object that will be added as text label to QR image. It's possible to use custom field values.

'text_fields': ['name', 'serial'], # DEFAULT
'text_fields': ['name'],
'text_fields': ['site',
                'name',
                'id']

custom_text: Additional text label to QR code image (will be added after text_fields).
```
'custom_text': None, # DEFAULT
'custom_text': 'My Text',
```
Text source (Option B)
text_template:

Jinja2 template with {{ obj }} as context for device, rack, etc., using it ignores text_fields and custom_text.

{{ obj.xyz }} :

Value of the object/module (e.g. device, rack, etc.). Which values can be read depends on the Netbox module. Many names can be found during mass import, e.g. https://server/dcim/devices/import/, i.e. the “Field Options” names such as “status”, i.e. “obj.status”. Writing HTML text is permitted.
```
# Example to output name and site in two lines with caption (See also screenshots below):

'text_template': 'Name: {{ obj.name }}\nSite: {{ obj.site }}',
```
{{ logo }} :

The value stored in the logo parameter.
```
<div style="display: inline-block; height: 5mm; width: 15mm"><img src="{{logo}}" height="100%" width="100%"/></div>```
```
{{ qrCode }} :

The QR code is provided as a Base64 string.
```
<div style="display: inline-block; height: 10mm; width: 10mm"><img src="data:image/png;base64,{{qrCode}}" height="100%" width="100%"/></div>
```

Font

font:

Font name for text label (All fonts supported by the browser are supported. Web-Safe-Fonts are recommended as these are supported on all common systems without the need for subsequent installation.

'font': 'TahomaBold' # DEFAULT
'font': 'Arial',
'font': 'Verdana',
'font': 'Arial, Verdana', # If Arial is not available then Verdana.
'font': '\'Trebuchet MS\'', # If blank character in font name.

font_size:

Defines the height of the font.

'font_size': '3.00mm', # DEFAULT
'font_size': '0.11in', # For inches

font_weight:

Determines how dense the font is.

'font_weight': 'normal', # DEFAULT
'font_weight': 'bold',
'font_weight': 'lighter', 
'font_weight': 'bolder',

font_color:

Determines how dense the font is. (More Color Infos https://www.w3schools.com/html/html_colors.asp)

'font_color': 'black', # DEFAULT
'font_color': 'red',
'font_color': 'rgb(255, 0, 0)',  # blue
'font_color': '#6a5acd', # violett

QR-Code

with_qr:

QR-Code label will be added to label if enabled.
```
'with_qr': True, # DEFAULT
'with_qr': False,
```
QR-Code alternative source

By default, the URL path to the object is used as the text for the QR code. Below is an alternative for defining your own QR code content.

url_template: Jinja2 template with {{ obj }} as context for device, rack, etc.

# Example to output the object name and the ID in the QR code.
(This means that information other than the Netbox URL can also be output in the QR code):

'url_template': None, # DEFAULT
'url_template': '{{ obj.name }} - Objekt ID: {{ obj.id }}',

QR-Code Image File

These parameters are used to create the QR code image file.

qr_version:

For the image file: Parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). More Information see: qrcode 3.0 Parameter "version"

Experience: The higher the number, the more often it appears as if the QR codes are repeated. The value 1 is recommended for beginners.
```
'qr_version': 1, # DEFAULT 
```

qr_error_correction:

For the image file: This value is used to create the QR code image file. Controls the error correction used for the QR Code. More Information see: qrcode 3.0 Parameter "error_correction"

Experience: You can scratch x% off the QR code before it is no longer readable.

'qr_error_correction': 0, # DEFAULT - About 15% or less errors can be corrected.
'qr_error_correction': 1, # About 7% or less errors can be corrected.
'qr_error_correction': 2, # About 30% or less errors can be corrected.
'qr_error_correction': 3, # About 25% or less errors can be corrected.

qr_box_size:

For the image file: This value is used to create the QR code image file. Controls how many pixels each "Black boxes within the QR code" of the QR code is. More Information see: qrcode 3.0 Parameter "box_size"

Experience: The larger the value, the larger the QR code image file will be. It also takes longer to create the image file. If a value that is too small is used, the QR code may become unscaled if label_qr_width and label_qr_height have values that are too large.
```
'qr_box_size': 4, # DEFAULT
```
qr_border:

For the image file: This value is used to create the QR code image file. Defines the border width when rendering the QR code image file. More Information see: qrcode 3.0 Parameter "qr_border"

Experience: Value 0, as the size of the QR code can be better influenced by 'label_qr_width', label_qr_height and the centered positioning creates a margin. The size of the QR code can therefore be better adjusted. However, there should be a border around the QR code on the label.
```
'qr_border': 0, # DEFAULT.
```

Summery qr_... :

This table should show a few combinations of qr_[parameter name] and their resulting QR code image file sizes. With the values in column 4 you can see that you already get a 4cm x 4cm QR code image file.

	Test	Test	Test	Test	Test	Test	Test	Test	Test	Test
qr_version	1	1	1	1	1	1	2	4	6	40
qr_box_size	1	2	3	4	5	6	6	6	6	1
qr_error_correction	0	0	0	0	0	0	0	0	0	0
qr_border	0	0	0	0	0	0	0	0	0	0
DPI	72	72	72	72	72	72	72	72	72	72
cm (H/W)	`1,02`	`2,05`	`3,07`	`4,09`	`5,12`	`6,14`	`6,14`	`6,99`	`8,68`	`6,24`
Pixel (H/W)	`29`	`58`	`87`	`116`	`145`	`174`	`174`	`198`	`246`	`177`

Label Layout

The parameters that can be used to design the label are listed below.

Label dimensions

label_width:

Indicates how wide the physical label is.

'label_width': '56mm', # DEFAULT
'label_width': '2.20in', # For inch

label_height: