Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/netbox-community/netbox-qrcode
NetBox Plugin for generate QR Codes
https://github.com/netbox-community/netbox-qrcode
netbox netbox-plugin
Last synced: about 1 month ago
JSON representation
NetBox Plugin for generate QR Codes
- Host: GitHub
- URL: https://github.com/netbox-community/netbox-qrcode
- Owner: netbox-community
- License: apache-2.0
- Created: 2020-07-15T10:56:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T15:14:10.000Z (7 months ago)
- Last Synced: 2024-05-23T05:17:29.023Z (7 months ago)
- Topics: netbox, netbox-plugin
- Language: Python
- Homepage:
- Size: 2.16 MB
- Stars: 187
- Watchers: 16
- Forks: 29
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-netbox - k01ek/netbox-qrcode - Plugin for generate QR codes for objects: Rack, Device, Cable (Plugins)
README
# Netbox QR Code Plugin
[Netbox](https://github.com/netbox-community/netbox) plugin for generate QR codes for objects: Rack, Device, Cable.
This plugin depends on [qrcode](https://github.com/lincolnloop/python-qrcode) and [Pillow](https://github.com/python-pillow/Pillow) python library
[](https://pepy.tech/project/netbox-qrcode)
[](https://pepy.tech/project/netbox-qrcode)
[](https://pepy.tech/project/netbox-qrcode)
## Compatibility
| Plugin Version | NetBox Version | Tested on |
| ------------- |:-------------| :-----:|
| 0.0.11 | >= 3.7.0 | 3.7.x |
| 0.0.13 | >= 4.0.2 < v4.1.0 | v4.0.2 |
## Installation
If Netbox was installed according to the standard installation instructions. It may be necessary to activate the virtual environment.
```
source /opt/netbox/venv/bin/activate
```
The plugin is available as a Python package in pypi and can be installed with pip
```
pip install netbox-qrcode
```
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
```
PLUGINS = ['netbox_qrcode']
```
Restart NetBox and add `netbox-qrcode` to your local_requirements.txt
## Configuration
The following options are available:
* `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`.
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:
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.
* `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).
### Per object options
Per object options override default options. Per object options dictionary can contains any of default options inside.
* `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.
## Screenshots
Device QR code with text label
Rack QR code
Cable QR code
Device QR code via Jinja2 "text_template" Parameter (Multiline and labeled)
