Repository files navigation

This project is intended to be a webhook target forGrocy to print labels to a brother QL label printer.

Datamatrix or QR codes can be used with Datamatrix being the default. Datamatrix will fit better in smaller labels but I've found aren't as easily read by the Grocybarcode reader or by theAndroid App.

Only die-cut labels are supported as I don't have any endless rolls to test with.

Once you have this running somewhere update your config atapp/data/config.php to match the following. Presuming that you have this running on localhost at port 8000.

    // Label printer settings    Setting('LABEL_PRINTER_WEBHOOK', 'http://127.0.0.1:8000/print');    Setting('LABEL_PRINTER_RUN_SERVER', true);    Setting('LABEL_PRINTER_PARAMS', []);    Setting('LABEL_PRINTER_HOOK_JSON', false);    Setting('FEATURE_FLAG_LABEL_PRINTER', true);

The label size and printer are configured via environmental variables. You can also create a.env file instead.

Included fonts areNotoSans-Regular.ttf andNotoSerif-Regular.ttf

These are supported, for example the62 label size. The length of the label will be big enough to accommodate the max number of lines including a margin.You may want to experiment with font sizes and line count to get the most out of it.

Two endpoints are available/print and/image both accept the same parameters./image will return the rendered image as a PNG instead of sending to the printer.

POST or GET accepted.

The name will use whichever parameter is given.

Note: Theres no security on this web service, so don't make it publicly available.

This has been tested with python 3.10, newer may work fine.

You will need to install thelibdmtx library for the barcodes to generate, seepylibdmtx documentation on pypi.

Its advisable to run and install in avenv. For example:

    # Create and enter the venv    python -m venv .venv    source ./.venv/bin/activate    # Install packages    python -m pip install -U -r requirements.txt    # exit with ./.venv/bin/deactivate

For development you can useflask run --debug to run the service on port 5000. Alternatively usegunicorn -c gunicorn_conf.py app:app to run the service on port 8000.

• Some more formatting options

A Dockerfile is included based on a python 3.10 alpine image. The default port is 8000.

Published to Dockerhub assam159/brotherql_grocylabels for architectures amd64, arm64, and armv7.

As an example, you can launch this withdocker run -d -p 8000:8000 -e PRINTER_MODEL=QL-500 -e PRINTER_PATH=file:///dev/usb/lp1 sam159/brotherql_grocylabels:latest.

An exampledocker-compose.yml file can be foundhere.

I'll try to keep on top of bugs but feature requests may go unfulfilled. Please use the issue tracking in Github.

PRs are welcome!