mirror of
https://github.com/rickbarrette/redmine_qbo_label_agent.git
synced 2026-11-17 18:10:36 -05:00
Print agent for redmine_qbo_labels
Runs on the label printer's network, asks Redmine for labels every couple of seconds (Bearer token from Administration » Label printers), draws them like the print dialog's preview, and prints them on a Brother QL printer over TCP 9100. Finds the printer on the network over Bonjour/mDNS (or PRINTER), checks its status before each label and every minute, and reports back printed or failed with the printer's error. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
commit
e5ca5b6980
20 files changed
+1054
No files matched your search
@@ -0,0 +1,68 @@
|
||||
# Redmine QBO Label Agent
|
||||
|
||||
The print agent for [redmine_qbo_labels](https://github.com/rickbarrette/redmine_qbo_labels): runs on a computer on the label printer's network, asks Redmine for labels every couple of seconds, and prints them on a Brother QL printer (made for the QL-820NWB with a 62mm continuous roll).
|
||||
|
||||
Redmine never needs to reach the printer, or the shop's network: the agent only makes outgoing HTTPS requests, so there's nothing to open on the router, and labels print from anywhere Redmine can be reached.
|
||||
|
||||
* **Finds the printer by itself** on the network (Bonjour/mDNS, which Brother printers announce), and again if its address changes. Or give it the address with `PRINTER`.
|
||||
* **Checks the printer** before each label and every minute (cover open, no labels, wrong roll), and tells Redmine, which shows it on the Label printers page and in the print dialog.
|
||||
* **Draws the label** the same way as the print dialog's preview: the lines stacked in the biggest bold letters that fit, on a label only as long as the text needs.
|
||||
* Keeps one connection to Redmine open, so Redmine's name is looked up once instead of on every poll.
|
||||
|
||||
## Running it
|
||||
|
||||
In Redmine, **Administration » Label printers » New label printer** shows the agent's token and a Compose file with it filled in. On the computer on the printer's network:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
label-agent:
|
||||
build: https://github.com/rickbarrette/redmine_qbo_label_agent.git
|
||||
restart: always
|
||||
# Host networking lets the agent find the printer on the local network (Bonjour/mDNS)
|
||||
network_mode: host
|
||||
environment:
|
||||
REDMINE_URL: https://redmine.example.com
|
||||
AGENT_TOKEN: qbl_paste-the-token-here
|
||||
PRINTER_MODEL: QL-820NWB
|
||||
# Optional: skip the network search and use this printer
|
||||
# PRINTER: tcp://192.168.0.100
|
||||
LOG_LEVEL: INFO
|
||||
```
|
||||
|
||||
```
|
||||
docker compose up -d
|
||||
docker compose logs -f
|
||||
```
|
||||
|
||||
The log says which printer it found (`Found QL-820NWB at 192.168.0.100:9100`) and each label it prints.
|
||||
|
||||
Host networking is what lets it hear the printer's announcements. Without it (e.g. Docker Desktop on Windows or Mac), set `PRINTER` to the printer's address, preferably one reserved for it on the router.
|
||||
|
||||
It replaces brother_ql_web: both send to the printer's port 9100, and only one can print at a time, so they can run side by side, but there's no need to.
|
||||
|
||||
## Settings
|
||||
|
||||
Variable|Default|
|
||||
---|---|---
|
||||
`REDMINE_URL`||Redmine's address (required)
|
||||
`AGENT_TOKEN`||The printer's token from **Administration » Label printers** (required)
|
||||
`PRINTER`|found on the network|The printer, e.g. `tcp://192.168.0.100` or `192.168.0.100:9100`
|
||||
`PRINTER_MODEL`|`QL-820NWB`|The model, as [brother_ql](https://github.com/inventree/brother_ql) names it; also picks this model when the network has several printers
|
||||
`LABEL`|`62`|The roll, as brother_ql names it (`62`: 62mm continuous)
|
||||
`LOG_LEVEL`|`INFO`|`DEBUG` logs every poll and the printer's status messages; `WARNING` only problems
|
||||
`VERIFY_SSL`|`1`|`0` to skip checking Redmine's certificate
|
||||
|
||||
How often it asks for labels, and how long labels are, are set in Redmine (the plugin's settings) and picked up within a poll.
|
||||
|
||||
## Development
|
||||
|
||||
```
|
||||
pip install -r requirements-dev.txt
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
The tests draw labels and print them on a fake printer, through a fake Redmine.
|
||||
|
||||
## License
|
||||
|
||||
MIT, see LICENSE. The label font is DejaVu Sans Bold, cut down to Latin letters (see `fonts/LICENSE`).
|
||||
Reference in new issue
Block a user