12 Commits

Author SHA1 Message Date
n07070
f52d7493c8 Restructure main class to activate worker and use tasks, print queue,
update Printer
2026-05-21 02:34:12 +02:00
n07070
b48e7072bf Restructure web class to use print queue and tasks 2026-05-21 02:33:51 +02:00
n07070
cbd5d59445 Add worker class 2026-05-21 02:33:40 +02:00
n07070
e7a7c84664 Add printing queue objects 2026-05-21 02:33:25 +02:00
n07070
60f4eff26c Add task objects 2026-05-21 02:33:12 +02:00
n07070
e78f811904 Update numpy 2026-05-20 16:34:57 +02:00
n07070
0f848ba790 Add an alert if the webcam print fails 2026-05-20 16:34:45 +02:00
n07070
24260834ff Update printing routes for the form 2026-05-20 16:34:33 +02:00
n07070
306cab6606 Fix error flashing and transmission 2026-05-20 16:34:01 +02:00
n07070
26c2de12b6 Add new web route, restructure API route 2026-05-20 13:29:23 +02:00
n07070
f2d3d99e8f Add new functions for discovery and parsing of printers, WIP 2026-05-19 10:52:36 +02:00
n07070
f9831f15c7 Add new dependencies for brother ql printers 2026-05-19 10:52:23 +02:00
10 changed files with 274 additions and 256 deletions

View File

@@ -79,16 +79,6 @@ Your contributions are very much welcome ! You can either request an account on
Please also say if you had a printer to test your code, and which printer you've been using. Please also say if you had a printer to test your code, and which printer you've been using.
### Code structure
The app is written about the Flask framework. You can start by looking at the code in the `src/` folder, in the `main.py` file. There, you will see that a few classes are initialized. In general, they are two parts to the program :
The Web pages and the API, which are the user-facing parts. This is with what the users will interact, and define how the program is going to be used. The web pages are renderer from the `include/` folder where Jinj2 templates are defined.
The Worker and Printer Queue are the internal parts. When a new thing needs to be printed, usually sent from the Web or API interfaces, a new Task in the type of the document is created, and added to a print queue. Then, a Worker thread looks up the state of the queue every so often and picks jobs to execute on the printers connected to the system.
The last part of the program is the Raspberry Pi class, that handles to Photomaton mode, which handles button presses, and LED indicator and a flash.
### Linting ### Linting
If you want to contribute code, please make sure to lint the project before commiting. This helps the code keep a general structure, and avoids some commons erros and mistakes. If you want to contribute code, please make sure to lint the project before commiting. This helps the code keep a general structure, and avoids some commons erros and mistakes.

View File

@@ -7,7 +7,7 @@ authors = [
] ]
license = "AGPLv3" license = "AGPLv3"
readme = "README.md" readme = "README.md"
requires-python = ">=3.13" requires-python = ">=3.14"
dependencies = [ dependencies = [
"flask (>=3.1.3,<4.0.0)", "flask (>=3.1.3,<4.0.0)",
"numpy (>=2.3.4)", "numpy (>=2.3.4)",

View File

@@ -23,6 +23,7 @@ import sys
import os # For VARS from the shell. import os # For VARS from the shell.
import pprint # To pretty print JSON import pprint # To pretty print JSON
import toml # Used for the config file parsing import toml # Used for the config file parsing
import threading
from flask import ( from flask import (
Flask, Flask,
request, request,
@@ -42,6 +43,7 @@ from web import Web # Wrapper for the web routes and API
from print_queue import PrintQueue from print_queue import PrintQueue
from worker import PrintWorker from worker import PrintWorker
# We create the main Flask object # We create the main Flask object
app = Flask(__name__) app = Flask(__name__)
socketio = SocketIO(app, cors_allowed_origins="*") socketio = SocketIO(app, cors_allowed_origins="*")
@@ -85,7 +87,7 @@ except FileExistsError:
app.logger.debug("Directory %s already exists.", UPLOAD_FOLDER) app.logger.debug("Directory %s already exists.", UPLOAD_FOLDER)
except PermissionError: except PermissionError:
app.logger.error("Permission denied: Unable to create %s", UPLOAD_FOLDER) app.logger.error("Permission denied: Unable to create %s", UPLOAD_FOLDER)
sys.exit(77) exit(77)
# Output the config file # Output the config file
if os.getenv("FLASK_DEBUG"): if os.getenv("FLASK_DEBUG"):
@@ -101,6 +103,9 @@ app.config["TEMPLATES_AUTO_RELOAD"] = True
# Printer connection # Printer connection
# Uses the class defined in the printer.py file # Uses the class defined in the printer.py file
printer = Printer(app, 0x04B8, 0x0E28) printer = Printer(app, 0x04B8, 0x0E28)
# printers = Printer(app)
# printers.discover_printers()
# printers.init()
printer.init_printer() printer.init_printer()
# Find out if we are running on a Raspberry Pi # Find out if we are running on a Raspberry Pi
@@ -119,19 +124,19 @@ RASPBERRY_PI_CONNECTED = rpi.is_raspberry_pi()
# Queue creation # Queue creation
print_queue = PrintQueue(app) print_queue = PrintQueue(app)
# Web & API management # Web & API routes
web = Web(app, print_queue) web = Web(app, print_queue)
# Start worker thread # Start worker thread
worker = PrintWorker(app, print_queue, printer, socketio) worker = PrintWorker(app, print_queue, printer, socketio)
worker.start() worker.start()
# The rate limit
limiter = Limiter( limiter = Limiter(
get_remote_address, app=app, default_limits=["1500 per day", "500 per hour"] get_remote_address, app=app, default_limits=["1500 per day", "500 per hour"]
) )
# General routes # General routes
@app.route("/") @app.route("/")
@limiter.limit("1/second", override_defaults=False) @limiter.limit("1/second", override_defaults=False)
def index(): def index():
@@ -147,8 +152,8 @@ def webcam():
app.logger.debug("Loading webcam interface") app.logger.debug("Loading webcam interface")
return render_template("webcam.html") return render_template("webcam.html")
# Form treatement # Form treatement
@app.route("/web/print/sms", methods=["POST"]) @app.route("/web/print/sms", methods=["POST"])
@limiter.limit("6/minute", override_defaults=False) @limiter.limit("6/minute", override_defaults=False)
def web_print_sms(): def web_print_sms():
@@ -159,7 +164,7 @@ def web_print_sms():
txt = request.form["txt"] txt = request.form["txt"]
except werkzeug.exceptions.BadRequestKeyError as e: except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.error("Whoops, we are missing the txt input field. : %s ", str(e)) app.logger.error("Whoops, we are missing the txt input field. : %s ", str(e))
flash("Whoops, no forms submitted or missing signature : " + str(e), "error") flash("Whoops, no forms submitted or missing signature : " + str(e), 'error')
return redirect(url_for("index")) return redirect(url_for("index"))
try: try:
@@ -167,23 +172,23 @@ def web_print_sms():
sign = request.form["signature"] sign = request.form["signature"]
except werkzeug.exceptions.BadRequestKeyError as e: except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.warning( app.logger.warning(
"No signature found for this print, using default signature : %s ", str(e) "No signature found for this print, using default signature.", str(e)
) )
sign = configuration_file["defaults"]["signature"] sign = configuration_file["defaults"]["signature"]
try: try:
web.print_sms(txt, sign) web.print_sms(txt, sign)
except RuntimeError as e: except Exception as e:
app.logger.error("Whoops, we could not print an SMS because : %s ", str(e)) app.logger.error("Whoops, we could not print an SMS because : %s ", str(e))
flash("Whoops, we could not print an SMS because :" + str(e), "error") flash("Whoops, we could not print an SMS because :" + str(e), 'error')
return redirect(url_for("index")) return redirect(url_for("index"))
# end try # end try
flash("The SMS has been added to the print queue !", "info") flash("The SMS has been printed !", 'info')
return redirect(url_for("index")) return redirect(url_for("index"))
@app.route("/web/print/img", methods=["POST"]) @app.route("/web/print/img", methods=["POST"])
@limiter.limit("1/second", override_defaults=False) @limiter.limit("1/second", override_defaults=False)
def web_print_img(): def web_print_img():
"""Prints an image on a printer""" """Prints an image on a printer"""
@@ -194,7 +199,7 @@ def web_print_img():
sign = request.form["signature"] sign = request.form["signature"]
except werkzeug.exceptions.BadRequestKeyError as e: except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.warning( app.logger.warning(
"No signature found for this print, using default signature : %s", str(e) "No signature found for this print, using default signature.", str(e)
) )
sign = configuration_file["defaults"]["signature"] sign = configuration_file["defaults"]["signature"]
@@ -202,7 +207,7 @@ def web_print_img():
if "img" not in request.files: if "img" not in request.files:
app.logger.error("Whoops, no images submitted : %s ", str(e)) app.logger.error("Whoops, no images submitted : %s ", str(e))
app.logger.error("Error getting the files : %s", str(e)) app.logger.error("Error getting the files : %s", str(e))
flash("Whoops, no images submitted : " + str(e), "error") flash("Whoops, no images submitted : " + str(e), 'error')
return redirect(url_for("index")) return redirect(url_for("index"))
file = request.files["img"] file = request.files["img"]
@@ -210,21 +215,20 @@ def web_print_img():
# empty file without a filename. # empty file without a filename.
if file.filename == "": if file.filename == "":
app.logger.error("Submitted file has no filename !") app.logger.error("Submitted file has no filename !")
flash("Submitted file has no filename !", "error") flash("Submitted file has no filename !", 'error')
return redirect(url_for("index")) return redirect(url_for("index"))
try: try:
app.logger.debug("Sending the image to the printer.") app.logger.debug("Sending the image to the printer.")
web.print_image(file, sign) web.print_image(file, sign)
except RuntimeError as e: except Exception as e:
app.logger.error("The image could not be printed because : %s ", str(e)) app.logger.error("The image could not be printed because : %s ", str(e))
flash("The image could not be printed because : " + str(e), "error") flash("The image could not be printed because : " + str(e), 'error')
return redirect(url_for("index")) return redirect(url_for("index"))
flash("Picture added to the print queue !", "info") flash("Picture printed !", 'info')
return redirect(url_for("index")) return redirect(url_for("index"))
# API routes # API routes
# The api has the following methods # The api has the following methods
# api/print/{sms,img,letter,qr,barcode} # api/print/{sms,img,letter,qr,barcode}
@@ -263,12 +267,11 @@ def api_print_sms():
try: try:
# comment: We try to print the SMS # comment: We try to print the SMS
web.print_sms(txt, sign) web.print_sms(txt, sign)
except RuntimeError as e: except Exception as e:
return str(e), 500 return str(e), 500
# end try # end try
return "OK", 200 return "OK", 200
@app.route("/api/print/img", methods=["POST"]) @app.route("/api/print/img", methods=["POST"])
@limiter.limit("6/minute", override_defaults=False) @limiter.limit("6/minute", override_defaults=False)
def api_print_image(): def api_print_image():
@@ -290,7 +293,8 @@ def api_print_image():
return "No image submitted", 400 return "No image submitted", 400
file = request.files["img"] file = request.files["img"]
# If the user submits an empty file without a filename. # If the user does not select a file, the browser submits an
# empty file without a filename.
if file.filename == "": if file.filename == "":
app.logger.error("Submitted file has no filename !") app.logger.error("Submitted file has no filename !")
return "Submitted file has no filename !", 400 return "Submitted file has no filename !", 400
@@ -298,57 +302,45 @@ def api_print_image():
try: try:
app.logger.debug("Sending the image to the printer.") app.logger.debug("Sending the image to the printer.")
web.print_image(file, sign) web.print_image(file, sign)
except RuntimeError as e: except Exception as e:
return str(e), 500 return str(e), 500
return "OK", 200 return "OK", 200
@app.route("/api/camera/picture", methods=["GET"]) @app.route("/api/camera/picture", methods=["GET"])
def camera_picture(): def camera_picture():
"""Returns a picture taken by the camera on a raspberry pi""" """Returns a picture taken by the camera on a raspberry pi"""
if RASPBERRY_PI_CONNECTED: if RASPBERRY_PI_CONNECTED:
try: try:
return rpi.camera_picture() return rpi.camera_picture()
except RuntimeError as e: except Exception as e:
return jsonify({"message": "Error getting the stream : " + e}), 500 return jsonify({"message": "Error getting the stream : " + e}), 500
else: else:
return jsonify({"message": "No camera present"}), 500 return jsonify({"message": "No camera present"}), 500
@app.route('/api/queue', methods=["GET"])
@app.route("/api/queue", methods=["GET"])
def api_queue_status(): def api_queue_status():
"""API endpoint for entire queue""" """API endpoint for entire queue"""
return jsonify(web.get_queue_state()) return jsonify(web.get_queue_state())
@app.route('/api/worker', methods=["GET"])
@app.route("/api/worker", methods=["GET"])
def api_worker_state(): def api_worker_state():
"""API endpoint to get the worker state""" """API endpoint to get the worker state"""
return jsonify(worker.current_state()) return jsonify(worker.current_state())
@app.route('/api/worker/start')
@app.route("/api/worker/start")
def api_worker_start(): def api_worker_start():
"""
Enable to worker. This starts to process the print queue.
"""
worker.start_worker() worker.start_worker()
return jsonify(worker.current_state()) return jsonify(worker.current_state())
@app.route('/api/worker/stop')
@app.route("/api/worker/stop")
def api_worker_stop(): def api_worker_stop():
"""
Stops the print queue. This stops the processing of the print queue.
"""
worker.stop_worker() worker.stop_worker()
return jsonify(worker.current_state()) return jsonify(worker.current_state())
## Authentification ## Authentification
@app.route("/login") @app.route("/login")
@limiter.limit("1/second", override_defaults=False) @limiter.limit("1/second", override_defaults=False)
def login_page(): def login_page():
@@ -401,6 +393,5 @@ def camera_status():
else: else:
socketio.emit("camera_status", False) socketio.emit("camera_status", False)
if __name__ == "__main__": if __name__ == "__main__":
app.run(debug=True, use_reloader=False, host="0.0.0.0", ssl_context="adhoc") app.run(debug=True, use_reloader=False, host="0.0.0.0", ssl_context="adhoc")

View File

@@ -1,8 +1,6 @@
""" # This class has the method by which we manage the Tasks
This class has the method by which we manage the Tasks # It's a printing queue, so we need to add, remove and get information on where
It's a printing queue, so we need to add, remove and get information on where # the queue is
the queue is
"""
from collections import deque from collections import deque
@@ -11,14 +9,12 @@ from collections import deque
import threading import threading
from datetime import datetime from datetime import datetime
from task import TaskType from task import TaskType, CutTask
class PrintQueue: class PrintQueue:
""" """
A Double-ended Queue to manage the printing Tasks A Double-ended Queue to manage the printing Tasks
""" """
def __init__(self, app): def __init__(self, app):
self.app = app self.app = app
self._queue = deque() self._queue = deque()
@@ -38,11 +34,7 @@ class PrintQueue:
self._queue.append(task) self._queue.append(task)
position = self._queue.index(task) position = self._queue.index(task)
# We return the current position of the task if it was added # We return the current position of the task if it was added
self.app.logger.debug( self.app.logger.debug("Added a new task %s to the queue at position %s", task.task_id, position)
"Added a new task %s to the queue at position %s",
task.task_id,
position,
)
return position return position
except Exception as e: except Exception as e:
self.app.logger.error("Could not add a task to the queue : %s ", e) self.app.logger.error("Could not add a task to the queue : %s ", e)
@@ -93,32 +85,32 @@ class PrintQueue:
return { return {
"task_id": task_id, "task_id": task_id,
"status": task.status, "status": task.status,
"type": task.task_type, "type" : task.task_type,
"position": index, "position": index,
"in_queue": True, "in_queue": True,
"content": task.content, "content" : task.content,
"signature": task.signature, "signature": task.signature
} }
if task.task_type == TaskType.TEXT: if task.task_type == TaskType.TEXT:
return { return {
"task_id": task_id, "task_id": task_id,
"status": task.status, "status": task.status,
"type": task.task_type, "type" : task.task_type,
"position": index, "position": index,
"in_queue": True, "in_queue": True,
"image_path": str(task.image_path), "image_path" : str(task.image_path),
"signature": task.signature, "signature" : task.signature,
"process": str(task.process), "process" : str(task.process)
} }
if task.task_type == TaskType.CUT: if task.task_type == TaskType.CUT:
return { return {
"task_id": task_id, "task_id": task_id,
"status": task.status, "status": task.status,
"type": task.task_type, "type" : task.task_type,
"position": index, "position": index,
"in_queue": True, "in_queue": True
} }
return None return None
@@ -131,5 +123,5 @@ class PrintQueue:
"status": task_status, "status": task_status,
"position": None, "position": None,
"in_queue": False, "in_queue": False,
"completed_at": datetime.now().isoformat(), "completed_at": datetime.now().isoformat()
} }

View File

@@ -1,18 +1,12 @@
"""
This class manages connexion to a Printer
"""
# import brother_ql
from time import sleep
import os.path
from PIL import Image, ImageEnhance
import numpy as np
# Importing the module to manage the connection to the printer. # Importing the module to manage the connection to the printer.
import escpos.printer import escpos.printer
# import brother_ql
from time import sleep, gmtime, strftime
import os.path
from PIL import Image, ImageEnhance, ImageOps
import numpy as np
class Printer(object):
class Printer():
""" """
# The connection is based on the ESC/POS library # The connection is based on the ESC/POS library
@@ -33,7 +27,7 @@ class Printer():
ready = False ready = False
def __init__(self, app, device_id, vendor_id): def __init__(self, app, device_id, vendor_id):
super().__init__() super(Printer, self).__init__()
self.app = app self.app = app
self.ready = False self.ready = False
self.printer = None self.printer = None
@@ -71,7 +65,7 @@ class Printer():
# TODO: This could happen directly when creating a new Printer class # TODO: This could happen directly when creating a new Printer class
if os.getenv("FLASK_DEBUG"): if os.getenv("FLASK_DEBUG"):
waiting_elapsed = 3 waiting_elapsed = 15
else: else:
waiting_elapsed = 10 waiting_elapsed = 10
@@ -81,26 +75,21 @@ class Printer():
try: try:
# This also calls open(), which we need to close() # This also calls open(), which we need to close()
# or else the device will appear as busy. # or else the device will appear as busy.
p = escpos.printer.Usb( p = escpos.printer.Usb(self.device_id, self.vendor_id, 0, profile="TM-P80")
self.device_id, self.vendor_id, 0, profile="TM-P80" except Exception as e:
)
except RuntimeError as e:
self.app.logger.error( self.app.logger.error(
"The USB device is not plugged in, trying again %s : %s", "The USB device is not plugged in, trying again %s : %s",waiting_elapsed, str(e)
waiting_elapsed,
str(e),
) )
pass
try: try:
if p.is_online(): if p.is_online():
self.ready = True self.ready = True
self.app.logger.debug("Printer online !") self.app.logger.debug("Printer online !")
except RuntimeError as e: except Exception as e:
self.app.logger.error( self.app.logger.error("Error while getting the printer online %s : %s",waiting_elapsed, str(e)
"Error while getting the printer online %s : %s",
waiting_elapsed,
str(e),
) )
pass
sleep(1) sleep(1)
waiting_elapsed -= 1 waiting_elapsed -= 1
@@ -139,10 +128,8 @@ class Printer():
def _print_sms(self, msg, signature="", bold=False): def _print_sms(self, msg, signature="", bold=False):
if not isinstance(msg, str): if not isinstance(msg,str):
self.app.logger.error( self.app.logger.error("It is not possible to print a " + str(type(msg)) + ", only strings.")
"It is not possible to print a " + str(type(msg)) + ", only strings."
)
raise ValueError raise ValueError
# We make sure that the signature is not something too goofy # We make sure that the signature is not something too goofy
@@ -154,7 +141,7 @@ class Printer():
self.app.logger.warning( self.app.logger.warning(
"Could not print message of this length: " + str(len(clean_msg)) "Could not print message of this length: " + str(len(clean_msg))
) )
raise RuntimeError( raise Exception(
"Could not print message of this length :" "Could not print message of this length :"
+ str(len(clean_msg)) + str(len(clean_msg))
+ ", needs to be below 4096 caracters long." + ", needs to be below 4096 caracters long."
@@ -164,7 +151,7 @@ class Printer():
self.app.logger.warning( self.app.logger.warning(
"Could not print signature of this length: " + str(len(clean_signature)) "Could not print signature of this length: " + str(len(clean_signature))
) )
raise RuntimeError( raise Exception(
"Could not print signature of this length :" "Could not print signature of this length :"
+ str(len(clean_signature)) + str(len(clean_signature))
+ ", needs to be below 256 caracters long." + ", needs to be below 256 caracters long."
@@ -181,9 +168,7 @@ class Printer():
self.printer.close() self.printer.close()
except Exception as e: except Exception as e:
self.app.logger.error("Unable to print because : " + str(e)) self.app.logger.error("Unable to print because : " + str(e))
raise RuntimeError( raise RuntimeError("Unable to print a SMS, the printer couldn't do it.") from e
"Unable to print a SMS, the printer couldn't do it."
) from e
self.app.logger.info("Printed text") self.app.logger.info("Printed text")
return True return True
@@ -208,17 +193,15 @@ class Printer():
+ str(path) + str(path)
+ " wasn't found. Please try again." + " wasn't found. Please try again."
) )
else:
self.app.logger.debug("Printing file from " + str(path)) self.app.logger.debug("Printing file from " + str(path))
if process: if process:
try: try:
self.app.logger.debug("Proccessing the image") self.app.logger.debug("Proccessing the image")
path = _process_image(self, path) path = _process_image(self, path)
except RuntimeError as e: except RuntimeError as e:
self.app.logger.error( self.app.logger.error("Error while processing the image, aborting print : %s",str(e))
"Error while processing the image, aborting print : %s", str(e)
)
raise e raise e
else: else:
self.app.logger.warning("Not proccessing the image") self.app.logger.warning("Not proccessing the image")
@@ -243,9 +226,7 @@ class Printer():
try: try:
self.printer.close() self.printer.close()
except Exception as e: except Exception as e:
self.app.logger.error( self.app.logger.error("Could not close the printer connexion %s", str(e))
"Could not close the printer connexion %s", str(e)
)
raise RuntimeError("Could not close the printer connexion. ") from e raise RuntimeError("Could not close the printer connexion. ") from e
self.app.logger.info("Printed a picture") self.app.logger.info("Printed a picture")
@@ -256,7 +237,7 @@ class Printer():
self.printer.open(self.usb_args) self.printer.open(self.usb_args)
self.printer.qr(content, center=True) self.printer.qr(content, center=True)
self.printer.close() self.printer.close()
except RuntimeError as e: except Exception as e:
self.printer.close() self.printer.close()
self.app.logger.error(str(e)) self.app.logger.error(str(e))
return False return False
@@ -280,13 +261,11 @@ class Printer():
def print_task(self, task_type, data): def print_task(self, task_type, data):
"""Execute actual print based on task type""" """Execute actual print based on task type"""
match (task_type.value): match (task_type.value):
case "text": case ("text"):
self._print_sms(data["txt"], signature=data["sign"]) self._print_sms(data["txt"],signature=data["sign"])
case "image": case ("image"):
self._print_img( self._print_img(data["img"], signature=data["sign"],process=data["process"])
data["img"], signature=data["sign"], process=data["process"] case ("cut"):
)
case "cut":
self._cut() self._cut()
case _: case _:
raise RuntimeError("This task type is not supported") raise RuntimeError("This task type is not supported")
@@ -310,8 +289,7 @@ def _process_image(self, path):
self.app.logger.debug("Resized the image") self.app.logger.debug("Resized the image")
# # Convert to grayscale for dithering # # Convert to grayscale for dithering
# dithered_img = original_img.convert("L").convert("1") # dithered_img = original_img.convert("L").convert("1") # Dithering using default method (FloydSteinberg)
# Dithering using default method (FloydSteinberg)
# self.app.logger.debug("Dithered the image") # self.app.logger.debug("Dithered the image")
# Compute brightness of original image (grayscale average) # Compute brightness of original image (grayscale average)
@@ -345,3 +323,92 @@ def _process_image(self, path):
self.app.logger.debug("Processed and saved image.") self.app.logger.debug("Processed and saved image.")
return jpeg_path return jpeg_path
def discover_printers():
"""
We try to find all the connected printers ( 0 or n ) to this system.
For every type of supported printer, we try to autodiscover them.
http://www.linux-usb.org/usb.ids A list of USB vendor IDs
04b8 Seiko Epson Corp.
04f9 Brother Industries, Ltd
"""
def find_and_parse_borther_ql_printer():
## We might be able to no use this because there is a `discover` command in https://github.com/pklaus/brother_ql#usage
## Code stolen from https://framagit.org/stickoeur/diagnostickoeur/-/blob/no-masters/printit.py?ref_type=heads
"""Find and parse Brother QL printer information."""
model_manager = ModelsManager()
# Debug print to show we're searching
# print("Searching for Brother QL printer...")
for backend_name in ["pyusb", "linux_kernel"]:
try:
#print(f"Trying backend: {backend_name}")
backend = backend_factory(backend_name)
available_devices = backend["list_available_devices"]()
#print(f"Found {len(available_devices)} devices with {backend_name} backend")
for printer in available_devices:
#print(f"Found device: {printer}")
identifier = printer["identifier"]
parts = identifier.split("/")
if len(parts) < 4:
#print(f"Skipping device with invalid identifier format: {identifier}")
continue
protocol = parts[0]
device_info = parts[2]
serial_number = parts[3]
try:
vendor_id, product_id = device_info.split(":")
except ValueError:
#print(f"Invalid device info format: {device_info}")
continue
# Default model
model = "QL-570"
# Try to match product ID to determine actual model
try:
product_id_int = int(product_id, 16)
for m in model_manager.iter_elements():
if m.product_id == product_id_int:
model = m.identifier
break
#print(f"Matched printer model: {model}")
except ValueError:
#print(f"Invalid product ID format: {product_id}")
continue
printer_info = {
"identifier": identifier,
"backend": backend_name,
"model": model,
"protocol": protocol,
"vendor_id": vendor_id,
"product_id": product_id,
"serial_number": serial_number,
}
#print(f"Found printer: {printer_info}")
return printer_info
except Exception as e:
#print(f"Error with backend {backend_name}: {str(e)}")
continue
print("No Brother QL printer found")
return None
def fint_and_parse_epson_printer():
pass

View File

@@ -1,21 +1,13 @@
""" from flask_socketio import SocketIO
This class executes when we are on a raspberry Pi. from gpiozero import Button, LED, DigitalOutputDevice
from time import sleep, gmtime, strftime
It handles the press of a button via GPIO, from PIL import Image
activates a flash and prints out the picture
that was taken via a USB Webcam.
"""
import io # To check if we are on a Raspberry Pi import io # To check if we are on a Raspberry Pi
import subprocess import subprocess
import os import os
from time import sleep, gmtime, strftime
from flask_socketio import SocketIO
from gpiozero import Button, LED, DigitalOutputDevice
from PIL import Image
from task import TextTask, ImageTask, CutTask
class Raspberry():
class Raspberry(object):
""" """
This class will manage three things : This class will manage three things :
- Connecting to a USB webcam - Connecting to a USB webcam
@@ -27,7 +19,7 @@ class Raspberry():
def __init__( def __init__(
self, self,
print_queue, printer,
app, app,
socketio, socketio,
button_gpio_port_number, button_gpio_port_number,
@@ -35,7 +27,7 @@ class Raspberry():
flash_gpio_port_number, flash_gpio_port_number,
is_flash_present, is_flash_present,
): ):
self.print_queue = print_queue self.printer = printer
self.socketio = socketio self.socketio = socketio
self.app = app self.app = app
@@ -46,13 +38,9 @@ class Raspberry():
self.image_path = self.app.config["UPLOAD_FOLDER"] + "/image.jpg" self.image_path = self.app.config["UPLOAD_FOLDER"] + "/image.jpg"
def is_raspberry_pi(self, raise_on_errors=False): def is_raspberry_pi(self, raise_on_errors=False):
"""
Checking if we are on a Raspberry Pi by checking
information on the /proc/cpuinfo file
"""
# Check if we are running on a raspberry pi # Check if we are running on a raspberry pi
try: try:
with io.open("/proc/cpuinfo", "r", encoding="utf-8") as cpuinfo: with io.open("/proc/cpuinfo", "r") as cpuinfo:
found = False found = False
for line in cpuinfo: for line in cpuinfo:
if line.startswith("Hardware"): if line.startswith("Hardware"):
@@ -153,7 +141,7 @@ class Raspberry():
f"Unable to take a picture. Error: {e.stderr.decode()}" f"Unable to take a picture. Error: {e.stderr.decode()}"
) )
return False return False
except RuntimeError as e: except Exception as e:
# Catch any unexpected errors # Catch any unexpected errors
self.app.logger.error(f"Unexpected error while taking picture: {str(e)}") self.app.logger.error(f"Unexpected error while taking picture: {str(e)}")
return False return False
@@ -210,7 +198,7 @@ class Raspberry():
output_path = image_path # Overwrite the original image if no output path is given output_path = image_path # Overwrite the original image if no output path is given
image.save(output_path) image.save(output_path)
except RuntimeError as e: except Exception as e:
self.app.logger.error(f"Error overlaying logo: {e}") self.app.logger.error(f"Error overlaying logo: {e}")
return False return False
@@ -237,7 +225,7 @@ class Raspberry():
image.save(output_path) image.save(output_path)
except RuntimeError as e: except Exception as e:
self.app.logger.error(f"Error cropping image to square: {e}") self.app.logger.error(f"Error cropping image to square: {e}")
return False return False
@@ -254,7 +242,7 @@ class Raspberry():
try: try:
self.flash.on() self.flash.on()
self.take_picture() self.take_picture()
except RuntimeError as e: except Exception as e:
self.app.logger.error( self.app.logger.error(
"Could not take a picture after the button press : " + str(e) "Could not take a picture after the button press : " + str(e)
) )
@@ -263,11 +251,15 @@ class Raspberry():
self.app.logger.debug("Printing picture") self.app.logger.debug("Printing picture")
self.led.on() self.led.on()
self.crop_to_square(self.image_path) self.crop_to_square(self.image_path)
self.print_queue.enqueue(ImageTask(self.image_path,signature="",process=True)) self.printer.print_img("src/static/images/extase-club.png", process=True)
self.print_queue.enqueue(TextTask(content="Imprimé par LittlePrynter", signature="")) self.printer.print_img(self.image_path, process=True)
time = strftime("%Y-%m-%d %H:%M", gmtime()) self.printer.print_sms("")
self.print_queue.enqueue(TextTask(content=time, signature="")) self.printer.print_sms("With Love From Société.Vide", signature="", bold=True)
self.print_queue.enqueue(CutTask()) self.printer.print_sms("Printed by LittlePrynter", signature="")
self.printer.print_sms("n07070.xyz", signature="")
self.printer.print_sms(strftime("%Y-%m-%d %H:%M", gmtime()), signature="")
self.printer.qr("https://n07070.xyz/articles/littleprynter")
self.printer.cut()
self.led.off() self.led.off()
self.app.logger.debug("Added a photomaton picture to the print queue") self.app.logger.debug("Done printing picture")
return True return True

View File

@@ -1,32 +1,27 @@
""" # Here we define the types of tasks
Here we define the types of tasks # We are using Abstract Base Classes,
We are using Abstract Base Classes, # like this we can define types of tasks ( text, images, ... )
like this we can define types of tasks ( text, images, ... ) # that all work with the same basic options
that all work with the same basic options
The tasks are going to be injected into a Queue. # The tasks are going to be injected into a Queue.
It's a usefull way of storing information in our # It's a usefull way of storing information in our
program, while making sure that things are indeed printed. # program, while making sure that things are indeed printed.
It's also a way to prevent two concurrent connexions creating # It's also a way to prevent two concurrent connexions creating
a access conflict on a single printer, like two people wanting # a access conflict on a single printer, like two people wanting
to print at the same time. # to print at the same time.
# We can also delay and store printing tasks until a printer becomes
# available if none is online.
We can also delay and store printing tasks until a printer becomes
available if none is online.
"""
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
## See https://docs.python.org/3/library/abc.html to learn more about this ## See https://docs.python.org/3/library/abc.html to learn more about this
# from dataclasses import dataclass
from enum import Enum from enum import Enum
import uuid import uuid
## You can expand this if you want to take other types of tasks into account ## You can expand this if you want to take other types of tasks into account
class TaskType(Enum): class TaskType(Enum):
"""
The different tasks supported by the printers
"""
TEXT = "text" TEXT = "text"
IMAGE = "image" IMAGE = "image"
CUT = "cut" CUT = "cut"
@@ -36,7 +31,6 @@ class PrintTask(ABC):
""" """
A print task holds information about what we are looking to print. A print task holds information about what we are looking to print.
""" """
def __init__(self, task_type): def __init__(self, task_type):
self.task_id = self._generate_id() self.task_id = self._generate_id()
self.task_type = task_type self.task_type = task_type
@@ -47,10 +41,10 @@ class PrintTask(ABC):
@abstractmethod @abstractmethod
def get_print_data(self): def get_print_data(self):
"""Return data formatted for printer""" """Return data formatted for printer"""
pass
def _generate_id(self): def _generate_id(self):
# Generate unique task ID # Generate unique task ID
return str(uuid.uuid4()) return str(uuid.uuid4())
@@ -58,21 +52,18 @@ class TextTask(PrintTask):
""" """
This tasks represents a texte content, and it's signature. This tasks represents a texte content, and it's signature.
""" """
def __init__(self, content, signature): def __init__(self, content, signature):
super().__init__(TaskType.TEXT) super().__init__(TaskType.TEXT)
self.content = content self.content = content
self.signature = signature self.signature = signature
def get_print_data(self): def get_print_data(self):
return {"txt": self.content, "sign": self.signature} return { "txt": self.content, "sign": self.signature }
class ImageTask(PrintTask): class ImageTask(PrintTask):
""" """
This tasks represents a image content ( in the form of it's path ), and it's signature. This tasks represents a image content ( in the form of it's path ), and it's signature.
""" """
def __init__(self, image_path, signature, process): def __init__(self, image_path, signature, process):
super().__init__(TaskType.IMAGE) super().__init__(TaskType.IMAGE)
self.image_path = image_path self.image_path = image_path
@@ -81,8 +72,7 @@ class ImageTask(PrintTask):
def get_print_data(self): def get_print_data(self):
# Return image data in printer-compatible format # Return image data in printer-compatible format
return {"img": self.image_path, "sign": self.signature, "process": self.process} return { "img": self.image_path, "sign": self.signature, "process" : self.process }
class CutTask(PrintTask): class CutTask(PrintTask):
""" """
@@ -95,4 +85,4 @@ class CutTask(PrintTask):
# There is no print data, # There is no print data,
# the task existence in itself is indication of what to do # the task existence in itself is indication of what to do
def get_print_data(self): def get_print_data(self):
return None return None

View File

@@ -1,41 +1,41 @@
# class User(object): class User(object):
# """docstring for User.""" """docstring for User."""
# def __init__(self, arg): def __init__(self, arg):
# super(User, self).__init__() super(User, self).__init__()
# self.arg = arg self.arg = arg
# # @app.route('/login', methods=['POST','GET']) # @app.route('/login', methods=['POST','GET'])
# # @limiter.limit("100 per minute", error_message=error_handler_limiter) # @limiter.limit("100 per minute", error_message=error_handler_limiter)
# def login(): def login():
# if request.method == "POST": if request.method == "POST":
# if not session.get("logged_in"): if not session.get("logged_in"):
# if request.form["username"] and request.form["password"]: if request.form["username"] and request.form["password"]:
# # Get the json # Get the json
# with open("users.json") as f: with open("users.json") as f:
# users_file = json.load(f) users_file = json.load(f)
# for user in users_file["users"]: for user in users_file["users"]:
# if users_file["users"][user] == request.form["password"]: if users_file["users"][user] == request.form["password"]:
# session["logged_in"] = True session["logged_in"] = True
# session["user"] = request.form["username"] session["user"] = request.form["username"]
# if not session.get("logged_in"): if not session.get("logged_in"):
# flash("Mot de passe ou pseudo invalide.", "danger") flash("Mot de passe ou pseudo invalide.", "danger")
# return redirect(url_for("login")) return redirect(url_for("login"))
# else: else:
# return redirect(url_for("display_index_page")) return redirect(url_for("display_index_page"))
# else: else:
# flash("Incorrect logins") flash("Incorrect logins")
# return render_template("password.html") return render_template("password.html")
# else: else:
# return render_template("password.html") return render_template("password.html")
# else: else:
# return render_template("password.html") return render_template("password.html")
# @app.route("/logout") @app.route("/logout")
# def logout(): def logout():
# session["logged_in"] = False session["logged_in"] = False
# flash("Tu est déconnecté", "info") flash("Tu est déconnecté", "info")
# return redirect(url_for("login")) return redirect(url_for("login"))

View File

@@ -6,8 +6,7 @@ from task import TextTask, ImageTask, CutTask
class Web(object): class Web(object):
"""Web is the class that gets all of the information from web calls """Web is the class that gets all of the information from web calls ( API and Web page ) and provides checks before sending stuff to printing"""
( API and Web page ) and provides checks before sending stuff to printing"""
def __init__(self, app, print_queue): def __init__(self, app, print_queue):
super(Web).__init__() super(Web).__init__()
@@ -31,7 +30,7 @@ class Web(object):
except Exception as e: except Exception as e:
self.app.logger.error(e) self.app.logger.error(e)
raise RuntimeError("Could not add SMS to queue, " + str(e)) from e raise RuntimeError("Could not add SMS to queue, " + str(e)) from e
self.app.logger.info("Added two new tasks at position %s and %s", sms, cut) self.app.logger.info("Added two new tasks at position %s and %s", sms, cut )
return True return True
def print_image(self, image, sign: str) -> bool: def print_image(self, image, sign: str) -> bool:
@@ -47,22 +46,19 @@ class Web(object):
if file_uploaded: if file_uploaded:
self.app.logger.debug("File has been uploaded, printing...") self.app.logger.debug("File has been uploaded, printing...")
try: try:
img = self.print_queue.enqueue( img = self.print_queue.enqueue(ImageTask(os.path.join(
ImageTask( self.app.config["UPLOAD_FOLDER"],
os.path.join( secure_filename(image.filename),
self.app.config["UPLOAD_FOLDER"], ),
secure_filename(image.filename), signature=sign,
), process=True))
signature=sign,
process=True,
)
)
cut = self.print_queue.enqueue(CutTask()) cut = self.print_queue.enqueue(CutTask())
except Exception as e: except Exception as e:
raise RuntimeError("Could not add IMG to queue" + str(e)) from e raise RuntimeError("Could not add IMG to queue" + str(e)) from e
self.app.logger.info("Added two new tasks at position %s and %s", img, cut) self.app.logger.info("Added two new tasks at position %s and %s", img, cut )
return True return True
@@ -100,14 +96,10 @@ class Web(object):
) )
return True return True
else: else:
self.app.logger.error( self.app.logger.error("Could not save file because the filename is forbidden")
"Could not save file because the filename is forbidden"
)
return False return False
else: else:
self.app.logger.error( self.app.logger.error("Could not save file, it seems to be null ? : " + str(filename))
"Could not save file, it seems to be null ? : " + str(filename)
)
return False return False
def get_queue_state(self): def get_queue_state(self):

View File

@@ -4,7 +4,7 @@
import threading import threading
import time import time
from task import TaskType
class PrintWorker(threading.Thread): class PrintWorker(threading.Thread):
def __init__(self, app, print_queue, printer, socketio=None): def __init__(self, app, print_queue, printer, socketio=None):
@@ -14,7 +14,7 @@ class PrintWorker(threading.Thread):
self.printer = printer self.printer = printer
self.socketio = socketio # Optional self.socketio = socketio # Optional
self.running = True self.running = True
self.state = "idle" # idle, printing, dead, drinking-a-beer self.state = "idle" # idle, printing, dead, drinking-a-beer
self.app.logger.debug("Ho great, I'm alive... I'm ready to work another day...") self.app.logger.debug("Ho great, I'm alive... I'm ready to work another day...")
@@ -22,17 +22,23 @@ class PrintWorker(threading.Thread):
"""Background thread that processes queue items""" """Background thread that processes queue items"""
self.app.logger.info("Worker started working.") self.app.logger.info("Worker started working.")
while True: while True:
if not self.running or not self.printer.ready: if not self.running:
time.sleep(0.2) time.sleep(0.2)
continue continue
# TODO: This could be improved to simply no start
# the while loop as long as the printer is not ready.
# and maybe get out of it when the printer is not ready anymore ?
if not self.printer.ready:
self.app.logger.debug("Waiting for the printer to be ready...")
time.sleep(1)
continue
try: try:
task = self.print_queue.dequeue() task = self.print_queue.dequeue()
except Exception as e: except Exception as e:
self.app.logger.error("Could not get a new task ! %s ", str(e)) self.app.logger.error("Could not get a new task ! %s ", str(e))
raise RuntimeError( raise RuntimeError("We could not get a new task because " + str(e)) from e
"We could not get a new task because " + str(e)
) from e
if task: if task:
try: try:
@@ -45,7 +51,7 @@ class PrintWorker(threading.Thread):
print_data = task.get_print_data() print_data = task.get_print_data()
try: try:
self.printer.print_task(task.task_type, print_data) self.printer.print_task(task.task_type, print_data)
except RuntimeError as e: except Exception as e:
self.app.logger.error("Could not print : %s", str(e)) self.app.logger.error("Could not print : %s", str(e))
raise e raise e
@@ -53,7 +59,7 @@ class PrintWorker(threading.Thread):
self.print_queue.mark_completed(task.task_id, "completed") self.print_queue.mark_completed(task.task_id, "completed")
self._emit_status(task.task_id, "completed") self._emit_status(task.task_id, "completed")
except RuntimeError as e: except Exception as e:
task.status = "failed" task.status = "failed"
self.print_queue.mark_completed(task.task_id, "failed") self.print_queue.mark_completed(task.task_id, "failed")
self._emit_status(task.task_id, "failed", error=str(e)) self._emit_status(task.task_id, "failed", error=str(e))
@@ -72,19 +78,18 @@ class PrintWorker(threading.Thread):
data = { data = {
"task_id": task_id, "task_id": task_id,
"status": status, "status": status,
"position": None, # Task no longer in queue "position": None # Task no longer in queue
} }
if error: if error:
data["error"] = error data["error"] = error
self.socketio.emit("task_status", data, room=room) self.socketio.emit('task_status', data, room=room)
def stop_worker(self): def stop_worker(self):
""" """
Give the worker a break Give the worker a break
""" """
self.app.logger.debug("Giving the worker a break")
self.state = "drinking-a-beer" self.state = "drinking-a-beer"
self.running = False self.running = False
@@ -92,7 +97,6 @@ class PrintWorker(threading.Thread):
""" """
Get the worker back to it Get the worker back to it
""" """
self.app.logger.debug("Time to work !")
self.state = "idle" self.state = "idle"
self.running = True self.running = True
@@ -103,5 +107,5 @@ class PrintWorker(threading.Thread):
return { return {
"is_running": self.running, "is_running": self.running,
"queue_size": len(self.print_queue), "queue_size": len(self.print_queue),
"state": self.state, "state" : self.state
} }