48 Commits

Author SHA1 Message Date
n07070
09e588c3ff Change Error to warning when not on a Raspberry 2026-06-12 17:20:53 +02:00
n07070
0699775d35 Add welcome message 2026-06-12 17:20:44 +02:00
n07070
7d19098b61 Change management of state : we assume the printer is online. Otherwise,
because this is a real-time command, we might not get the good answer
and fail to print fast enough. See https://download4.epson.biz/sec_pubs/pos/reference_en/escpos/realtime_commands.html
2026-06-12 17:19:53 +02:00
n07070
65e4a2ad9c Manage error when no Printers are found 2026-06-12 16:35:38 +02:00
n07070
af15ed8754 Manage file too big exceptions 2026-06-04 19:45:37 +02:00
n07070
53010987f4 Update Error raising in uploads and image processing 2026-06-04 19:26:21 +02:00
n07070
175dd3385a Add content in print queue method 2026-06-04 02:32:47 +02:00
n07070
3a1d9b20fb Add skip line and catch printing errors 2026-06-04 02:32:23 +02:00
n07070
c57e2f91a2 Update getting debug env 2026-06-04 02:32:08 +02:00
n07070
9ccd2b8bdf Use textarea instead of input, easier for ASCII art 2026-06-04 02:31:53 +02:00
n07070
54678175ba Remove socketio from Worker for the moment 2026-06-04 01:27:23 +02:00
n07070
2262840f75 Apply linting to worker 2026-06-04 01:26:47 +02:00
n07070
ad3cb6231a Apply linting to web 2026-06-04 01:11:37 +02:00
n07070
adcc744e7a Apply linting to the Raspberry Pi 2026-06-04 01:04:46 +02:00
n07070
6d9db2d2aa Apply linting to printers 2026-06-04 00:39:37 +02:00
n07070
651235a610 Lint printer file 2026-06-04 00:34:49 +02:00
n07070
3c490e10b4 Apply black formatter 2026-06-04 00:31:04 +02:00
n07070
a2d1779e2b Update worker to get differents printer types 2026-06-03 23:55:04 +02:00
n07070
f841cd5628 Add queue completion method, add Printer discovery and types 2026-06-03 23:54:15 +02:00
n07070
db7e030a1f Remove printer import, remove vendor&device configuration, update
print_queue
2026-06-03 23:53:02 +02:00
n07070
1218d3fbee Remove unused import, add get_queue_completed method 2026-06-03 23:52:23 +02:00
n07070
ef613b3c10 Remove print, add task Typing 2026-06-03 23:51:38 +02:00
n07070
e549cdc64b Remove vendor and device ID from configuration because it's not needed
anymore
2026-06-03 23:51:13 +02:00
n07070
9e4ec6c1a5 Add support for QR code task 2026-06-01 21:40:28 +02:00
n07070
9e77e0980b Change the Printer class to implement multiple printer types 2026-06-01 21:40:13 +02:00
0e3cc46a41 Merge pull request 'Restructure the code and implement a printing queue' (#29) from restructure-printing-queue into master
Reviewed-on: #29
2026-05-27 00:00:56 +02:00
n07070
bbfe1936da Remove unused import 2026-05-26 23:58:47 +02:00
n07070
8134c5e892 Improve linting of printer class 2026-05-26 23:56:55 +02:00
n07070
934f766cf3 Update waiting time, update Exceptions 2026-05-26 23:53:26 +02:00
n07070
eb9e1ec200 Remove code meant for another branch ( brother-ql code ) 2026-05-26 23:50:00 +02:00
n07070
bc035508cd Update line lenght of docstring 2026-05-22 11:01:06 +02:00
n07070
cba34744f6 Update raspberry pi class to print via the print queue 2026-05-22 11:01:06 +02:00
n07070
0c8c40098c Add docstring & comments, remove dead code 2026-05-22 11:01:06 +02:00
n07070
3b640dc549 Add comments about the code structure 2026-05-22 11:01:06 +02:00
n07070
2daafe28f2 Apply linting 2026-05-22 11:01:06 +02:00
n07070
c50922790d Restructure main class to activate worker and use tasks, print queue,
update Printer
2026-05-22 11:01:06 +02:00
n07070
e8ec9b74c0 Restructure web class to use print queue and tasks 2026-05-22 11:01:06 +02:00
n07070
9dee67c333 Add worker class 2026-05-22 11:01:06 +02:00
n07070
42bf6d6496 Add printing queue objects 2026-05-22 11:01:06 +02:00
n07070
a38088bd05 Add task objects 2026-05-22 11:01:06 +02:00
n07070
cb3e0d900f Update numpy 2026-05-22 11:01:06 +02:00
n07070
c5a8019fbe Add an alert if the webcam print fails 2026-05-22 11:01:06 +02:00
n07070
e926ee9163 Update printing routes for the form 2026-05-22 11:01:06 +02:00
n07070
3f915a1b25 Fix error flashing and transmission 2026-05-22 11:01:06 +02:00
n07070
a06086521a Add new web route, restructure API route 2026-05-22 11:01:06 +02:00
n07070
ee27c62d0f Add new functions for discovery and parsing of printers, WIP 2026-05-22 11:01:06 +02:00
n07070
2a11239c1e Add new dependencies for brother ql printers 2026-05-22 11:00:43 +02:00
n07070
bd9888caf7 Downgrade python supported version for 3.13 2026-05-20 12:01:51 +02:00
15 changed files with 1513 additions and 411 deletions

View File

@@ -79,6 +79,16 @@ 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.
### 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
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

@@ -5,8 +5,6 @@ signature = "Anonymous"
# Printer settings
[printer]
vendor_id = 0x04b8
device_id = 0x0e28
upload_folder = "src/static/uploads"
# Raspberry Pi Configuration

178
poetry.lock generated
View File

@@ -75,6 +75,25 @@ files = [
{file = "blinker-1.9.0.tar.gz", hash = "sha256:b4ce2265a7abece45e7cc896e98dbebe6cead56bcf805a3d23136d145f5445bf"},
]
[[package]]
name = "brother-ql-inventree"
version = "1.3"
description = "Python package to talk to Brother QL label printers"
optional = false
python-versions = "*"
groups = ["main"]
files = [
{file = "brother_ql_inventree-1.3-py3-none-any.whl", hash = "sha256:0f7e0d78bae04f44bcfe1010ed0d99f98d5b4db1d6179da242d5bd52bb0c9ea4"},
{file = "brother_ql_inventree-1.3.tar.gz", hash = "sha256:24335ca5f4b3444c692698b599459a7e6c4bd036dd580074c63d39382914fca3"},
]
[package.dependencies]
attrs = "*"
click = "*"
packbits = "*"
pillow = ">=10.0.0"
pyusb = "*"
[[package]]
name = "certifi"
version = "2026.4.22"
@@ -867,84 +886,84 @@ files = [
[[package]]
name = "numpy"
version = "2.4.5"
version = "2.4.6"
description = "Fundamental package for array computing in Python"
optional = false
python-versions = ">=3.11"
groups = ["main"]
files = [
{file = "numpy-2.4.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:3176dc8ff71dbb593606f91a69ad0c3cd3303c7eb546af477370ab9edf760288"},
{file = "numpy-2.4.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:1811150e5148f5a01a7cc282cb2f489b4a3050a773e173adb480e507bad3a3d7"},
{file = "numpy-2.4.5-cp311-cp311-macosx_14_0_arm64.whl", hash = "sha256:0d63a780070871210853ba01e90b88f9b85cf2abf63a7f143d5127189265ddf6"},
{file = "numpy-2.4.5-cp311-cp311-macosx_14_0_x86_64.whl", hash = "sha256:0c6919cefafb3b76cd46a89dbb203bf1dd95529d2a6d09fef2d325d95d6a79d8"},
{file = "numpy-2.4.5-cp311-cp311-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:d51efede1e58e8b11877536a5518f60e318d8ff69b89ad7b38ee5e431b24d772"},
{file = "numpy-2.4.5-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:07ce7e74da92d7c71b5df157b9758bcdd53d7fea10602154de3afd2b3ddc34dd"},
{file = "numpy-2.4.5-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d7828234a13185effb34979e146f9921f2a65dfbbe215e6dbb57d6478fc8e059"},
{file = "numpy-2.4.5-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:f96083adc3dfc1bbf778f2c79654d88115fa07074c97cb724fe9508f12d91c55"},
{file = "numpy-2.4.5-cp311-cp311-win32.whl", hash = "sha256:4ed78c904a638b6e5d7cd4db90c06fca5fc6ec2f28d258305368f454a50e79cf"},
{file = "numpy-2.4.5-cp311-cp311-win_amd64.whl", hash = "sha256:079b0fad6f2899b23c5da89792b5409d2d83fc83e8bd5c2299cc9c397a264864"},
{file = "numpy-2.4.5-cp311-cp311-win_arm64.whl", hash = "sha256:d6c78e260b53affe9b395a9d54fc61f101f9521c4d9452c7e9e3718b19e2215b"},
{file = "numpy-2.4.5-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:654fb8674b61b1c4bd568f944d13a908566fdcb0d797303521d4149d16da05ef"},
{file = "numpy-2.4.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:4cd9f6fa7ce10dc4627f2bb81dd9075dab67e94632e04c2b638e12575ddaa862"},
{file = "numpy-2.4.5-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:4f5bc96d35d94e4ceab8b38a92241b4611e95dc44e63b9f1fa2a331858ee3507"},
{file = "numpy-2.4.5-cp312-cp312-macosx_14_0_x86_64.whl", hash = "sha256:4bb33e900ee81730ad77a258965134aa8ceac805124f7e5229347beda4b8d0aa"},
{file = "numpy-2.4.5-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:32f8f852273ef32b291201ac2a2c97629c4a1ee8632bb670e3443eaa09fc2e72"},
{file = "numpy-2.4.5-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:685681e956fc8dcb75adc6ff26694e1dfd738b24bd8d4696c51ca0110157f912"},
{file = "numpy-2.4.5-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:6f64dd84b277a737eb59513f6b9bb6195bf41ab11941ef15b2562dbab43fa8ef"},
{file = "numpy-2.4.5-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b42d9496f79e3a728192f05a42d86e36163217b7cdecb3813d0028a0aa6b72d7"},
{file = "numpy-2.4.5-cp312-cp312-win32.whl", hash = "sha256:86d980970f5110595ca14855768073b08585fc1acc36895de303e039e7dee4a5"},
{file = "numpy-2.4.5-cp312-cp312-win_amd64.whl", hash = "sha256:3333dba6a4e611d666f69e177ba8fe4140366ff681a5feb2374d3fd4fff3acb6"},
{file = "numpy-2.4.5-cp312-cp312-win_arm64.whl", hash = "sha256:4593d197270b894efeb538dcbe227e4bcf1c77f88c4c6bf933ead812cfaa4453"},
{file = "numpy-2.4.5-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:1ef248460b645c102026b82337cc4e88231909c66dd77b59ec6d6cac7e44f277"},
{file = "numpy-2.4.5-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:4603622bdcdbf8dccb1d9d5b21d16a7aa4e473ae6c8e14048d846fd4ca2907a0"},
{file = "numpy-2.4.5-cp313-cp313-macosx_14_0_arm64.whl", hash = "sha256:6c18d49c67689c562854b53fdc433b93e47c12952aa6fa6d59f185e1a5992419"},
{file = "numpy-2.4.5-cp313-cp313-macosx_14_0_x86_64.whl", hash = "sha256:b1c663ddc641f4192e90511bec61a09bc231e3bbdb996cdc6edbcaa0e528d685"},
{file = "numpy-2.4.5-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:93793222b524f692f12b2f8752ce8b1d9d9125b2bfd5dbf0fb69c92c5e1ce86c"},
{file = "numpy-2.4.5-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1616bde34b2bcba2fa9bde06217ce00da4f3d1bdfb264d54525a99e8fe170d83"},
{file = "numpy-2.4.5-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:09d7d97da1c2c62f4818b3e150a57572ff8dcf1cf5ac501aac832ffd4ebd9566"},
{file = "numpy-2.4.5-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:2d68d0b355ab2e39fe0de59001d7151dfdbbb880ef67baeed806661e03df5097"},
{file = "numpy-2.4.5-cp313-cp313-win32.whl", hash = "sha256:fe28b64777ddfa0eca9b5f51474034ebe3dcb8324f48f27b28f479085673ae33"},
{file = "numpy-2.4.5-cp313-cp313-win_amd64.whl", hash = "sha256:fb4a6c9c537d6ccec9cc4aeae4261bd3cc79b070c67ddc0646f5b1c07fddde42"},
{file = "numpy-2.4.5-cp313-cp313-win_arm64.whl", hash = "sha256:6d7df2da2e7ea0624a43aa368104b3a3ce14aae98ad4bb2c9a93fecef76f1c97"},
{file = "numpy-2.4.5-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:2a235607a18df941760a695927051af4b1cd5d3ee85840d0e2af816785771feb"},
{file = "numpy-2.4.5-cp313-cp313t-macosx_14_0_arm64.whl", hash = "sha256:58dcf64969d870f36bc7fbd557d2617e997db7dc06261b6e3327148ea460d0a4"},
{file = "numpy-2.4.5-cp313-cp313t-macosx_14_0_x86_64.whl", hash = "sha256:235f54b0156274d8fa3155db3ed6d2f401c7e8f3367c90db0a12f02a58fde6ed"},
{file = "numpy-2.4.5-cp313-cp313t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ef3b5bb65437a3555c648e706475db01c645559ca80dc8b03e4f202ea757e0d6"},
{file = "numpy-2.4.5-cp313-cp313t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7f09a7e5f017d7098c66522097c96257411c9620c0926212200d66bc8cee3976"},
{file = "numpy-2.4.5-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:993a88d8fdd8554466a8765cd8bacd97ba56b70ca6b0a04bcdca77f5afed4222"},
{file = "numpy-2.4.5-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:84f58bed609b5669f5ad3d597901a4f1f86ee5b3c3708aaa55f05b4fe6e0f656"},
{file = "numpy-2.4.5-cp313-cp313t-win32.whl", hash = "sha256:7200c58f3f933ca61e66346667dcc8510bb111995e9ce15398a731e6a4afa4bb"},
{file = "numpy-2.4.5-cp313-cp313t-win_amd64.whl", hash = "sha256:c26c71080d35db5002102f5d9ff614d45de02aa1f7802943e691e063e5ee93bc"},
{file = "numpy-2.4.5-cp313-cp313t-win_arm64.whl", hash = "sha256:2caa576d1707b275cba1aeb60a5c50daa6fa2a3f28ecb08123bc05fd439005db"},
{file = "numpy-2.4.5-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:889ca2c072315de638a5194a772aa1fa2df92bdd6175f6a222d4784040424b61"},
{file = "numpy-2.4.5-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:89e89304fb1f8c3f0ecfa4a7d48f311dd79771336a940e920159d643d1307e77"},
{file = "numpy-2.4.5-cp314-cp314-macosx_14_0_arm64.whl", hash = "sha256:144fcc5a3a17679b2b82543b4a2d8dd29937230a7af13232b5f753872feb6361"},
{file = "numpy-2.4.5-cp314-cp314-macosx_14_0_x86_64.whl", hash = "sha256:398bb16772b265b9fa5c07b07072646ea97137c10ffb62a9a087b277fc825c29"},
{file = "numpy-2.4.5-cp314-cp314-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:fb352e7b8876da1249e72254736d6c58c505fa4e58a3d7e30efca241ca9ca9ce"},
{file = "numpy-2.4.5-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7341b08ff8124d7353939778e2707b8732d03c78c1c30e0815aba2dacbe1245a"},
{file = "numpy-2.4.5-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:deb01226f012539f3945261ffe1c10aec081a0fa0a5c925419933c70f3ae2d23"},
{file = "numpy-2.4.5-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:d888bdf7335f76878c3c7b264ac1ff089863e211ec81249f9fb5795c2183dc25"},
{file = "numpy-2.4.5-cp314-cp314-win32.whl", hash = "sha256:15f90d1256e9b2320aff24fde44815b787ab6d7c49a1a11bfd8138b321c5f080"},
{file = "numpy-2.4.5-cp314-cp314-win_amd64.whl", hash = "sha256:4bd2cd4ef9c0afa87de73723c0a33c0edff62143e1432917458e26d3d195d87f"},
{file = "numpy-2.4.5-cp314-cp314-win_arm64.whl", hash = "sha256:db304568c650e9d7039744d3575d0d287754debb2057d7c7b8cdfdc2c487a957"},
{file = "numpy-2.4.5-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:6de2883e0d2c63eae1bab1a84b390dca74aabb3d20ea1f5d58f360853c83abf3"},
{file = "numpy-2.4.5-cp314-cp314t-macosx_14_0_arm64.whl", hash = "sha256:06760fe73ae5005008748d182de612c733542af3cde063d532cd2127561b27be"},
{file = "numpy-2.4.5-cp314-cp314t-macosx_14_0_x86_64.whl", hash = "sha256:4b51a01745cb04cc19278482207444b4d30728ce91c28d27a3bfae5fc6ff24c7"},
{file = "numpy-2.4.5-cp314-cp314t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9a05636d7937d0936f271e5ba957fa8d746b5be3c2025caa1a2508f4fe521d40"},
{file = "numpy-2.4.5-cp314-cp314t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:14b86f56048ed09c3bbe48962a7dff077c2fd3274f8cf981800f3b38eac49cc3"},
{file = "numpy-2.4.5-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:130d58151c4db23e9fa860b84784e219a3aa3e030acc88a493ea37006c4dfd4c"},
{file = "numpy-2.4.5-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:d475afc8cbe935ff5944f753d863bba774d7f4e1feaaa4102901e3e053ca5963"},
{file = "numpy-2.4.5-cp314-cp314t-win32.whl", hash = "sha256:27f4a6dc26353a860b348961b9aa9e009835688b435cfa105e873b8dc2c726f5"},
{file = "numpy-2.4.5-cp314-cp314t-win_amd64.whl", hash = "sha256:76ac6e90f5e226011c88f9b7040a4bcae612518bc7e9adc127e697a13b28ad1a"},
{file = "numpy-2.4.5-cp314-cp314t-win_arm64.whl", hash = "sha256:7c392e2c1bf596701d3c6832be7567eab5d5b0a13865036c33365ee097d37f8b"},
{file = "numpy-2.4.5-pp311-pypy311_pp73-macosx_10_15_x86_64.whl", hash = "sha256:6bf0bfc1c2e1db972e30b6cd3d4861f477f3af908b27799b239dc3cbe3eb4b95"},
{file = "numpy-2.4.5-pp311-pypy311_pp73-macosx_11_0_arm64.whl", hash = "sha256:73d664413fb97229149c4711ef56531a6fe8c15c1c2626b0bbe497b84c287e70"},
{file = "numpy-2.4.5-pp311-pypy311_pp73-macosx_14_0_arm64.whl", hash = "sha256:b35bee5ef99e8d227a07829bee2e864fcb65f7c157646fcd8ec8b4b45dd8b88f"},
{file = "numpy-2.4.5-pp311-pypy311_pp73-macosx_14_0_x86_64.whl", hash = "sha256:02981d0fc9f9ce147643d552966d47f329a02f7ecb3b113e84207242f20dfa83"},
{file = "numpy-2.4.5-pp311-pypy311_pp73-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0e63caf31a1df06338ae63d999f7a33a675ced62eea9c9b02db4b1c1f45cff38"},
{file = "numpy-2.4.5-pp311-pypy311_pp73-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d8fc52b85a7b45e474be53eddf08e006d22e381a4e41bcde8e4aa08da0e7d198"},
{file = "numpy-2.4.5-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:40c71d50a4da1a7c317af419461052d3911a5770bfc5fd55baf52cc45e7a2c20"},
{file = "numpy-2.4.5.tar.gz", hash = "sha256:ca670567a5683b7c1670ec03e0ddd5862e10934e92a70751d68d7b7b74ca7f9f"},
{file = "numpy-2.4.6-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:0280e0356c0829a18d9de1cb7eee50ec22ca639878d7240307ca0943d73cd2c4"},
{file = "numpy-2.4.6-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:110f8b71aacb688ec69062bb7f6938a0f8acb01b7c1c4beb453c65b6d234584d"},
{file = "numpy-2.4.6-cp311-cp311-macosx_14_0_arm64.whl", hash = "sha256:4cfe66903cc32a9921a6733d96b19bb6abf310397581bbad89c228f5abaf0ee8"},
{file = "numpy-2.4.6-cp311-cp311-macosx_14_0_x86_64.whl", hash = "sha256:8155154c7c691289fe18f510b5d4657c68c67989f293f0535a91360392ff6538"},
{file = "numpy-2.4.6-cp311-cp311-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0ab0a9c4ffb1a6d95ef519fe4247dba8eb6b18ad93999f76b7f657039acabd47"},
{file = "numpy-2.4.6-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:89cd468399cfd2504718f0ba50e410dca55a170b61a02ad92bb18c8a65186e93"},
{file = "numpy-2.4.6-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:c2d37ab77531417474168eb79d6d80b14f821a966818505d03013d0833edb7a8"},
{file = "numpy-2.4.6-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:f407cb6b8e9d6d8c626bc73c945db1706035af8fd632295547bf1c9e46d092d6"},
{file = "numpy-2.4.6-cp311-cp311-win32.whl", hash = "sha256:ddea102b48f9e339f3948bf22040944184627a30fdf7f858667673b9c5f033c8"},
{file = "numpy-2.4.6-cp311-cp311-win_amd64.whl", hash = "sha256:1e254a00cdf42b1e4d5b3d68d33af63268d41340d8885df2ab6470f2e1500147"},
{file = "numpy-2.4.6-cp311-cp311-win_arm64.whl", hash = "sha256:ed9749eef4cbd126da3dc1d6bcb3a57f5eb7ac6a6484146bdbf743f552dfc577"},
{file = "numpy-2.4.6-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:001fbb8e08d942dd57599e781f2472269ee7f2755fae407b4f67b2f0b17da3f1"},
{file = "numpy-2.4.6-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ebfb099f8dcf083deef3ac1ca4c1503f387cf76296fcb3816b66f5ecb5f54fdb"},
{file = "numpy-2.4.6-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:3213d622a0283a39a93d188f3cf72b26862df52fbb4ca3697f51705016523d41"},
{file = "numpy-2.4.6-cp312-cp312-macosx_14_0_x86_64.whl", hash = "sha256:357cc07a6d7b0b182ff02249616a03742827ebb1277546b5c7cd7f7620a45698"},
{file = "numpy-2.4.6-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:5f9fb9157b4ce2971008323afe46053787b526ef624fea915b261468a8421a0f"},
{file = "numpy-2.4.6-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:90f9849678c75fe7afa2d348ac842c168b0a4d3d61919687216dfc547976d853"},
{file = "numpy-2.4.6-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:c1a2af6c6ef86344a6b0db6b97834208bf598db514f2b155042439b62605601a"},
{file = "numpy-2.4.6-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:e5805d5a22fd19c8ccff10a9561f9df94436b0545619ea579db2d3c35294bce2"},
{file = "numpy-2.4.6-cp312-cp312-win32.whl", hash = "sha256:e3eeb0aabd6bd5ce64faae67e9935203a6991b4bc2a485a767fbafb2c5125f45"},
{file = "numpy-2.4.6-cp312-cp312-win_amd64.whl", hash = "sha256:d8e8286dd7cea7895157318d1b91cdacac64c479f3cbc8dce548331728484751"},
{file = "numpy-2.4.6-cp312-cp312-win_arm64.whl", hash = "sha256:4081eb135ac24158bd51cdfbef16f1c64df7063b1143f24731387137c092bec8"},
{file = "numpy-2.4.6-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:511dbaf848decaaaf4b4ca48032619fb3138710c4bf7da7617765edad1ef96b0"},
{file = "numpy-2.4.6-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:bf162abab1c1a736333192707cef898e735a5ca00f38f27eeedf44b39d9e85eb"},
{file = "numpy-2.4.6-cp313-cp313-macosx_14_0_arm64.whl", hash = "sha256:043191bfa8eab18c776647b62723ac9dddece59743b13f49b2016094129c2b3f"},
{file = "numpy-2.4.6-cp313-cp313-macosx_14_0_x86_64.whl", hash = "sha256:6180d8b35af935aed8ece3a85e0a43f87393ae0ac87c8d2c8bd2c993f7270ef3"},
{file = "numpy-2.4.6-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:72fbe16c6fac95aedf5937fa873445cec2110be35d8a4e9433d7501fd98dae6b"},
{file = "numpy-2.4.6-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a7830bab239b79cda9c08c2da014761cafb48da6150e1da17ac06283f43b6089"},
{file = "numpy-2.4.6-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ef4aea96ce4d3b074422cb4f2f64e216bf9e213004bb58ecfdf50ea02ea8eb9a"},
{file = "numpy-2.4.6-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:dfa20cc6ca228e6b155b11da03825975ce66aea520985dbbddf0f2a5a495c605"},
{file = "numpy-2.4.6-cp313-cp313-win32.whl", hash = "sha256:56b39e5e0622a09a25bf5baf62f4bcf0cb8a41ae6e2819cf49bbc5a74c083f91"},
{file = "numpy-2.4.6-cp313-cp313-win_amd64.whl", hash = "sha256:c4fc99836233ea196540b17ab0983aff60ed07941751930f5f4d05bc3b3b7359"},
{file = "numpy-2.4.6-cp313-cp313-win_arm64.whl", hash = "sha256:a7c711e21628b52034bb5ab8d1bce291f752fcc5e92accc615778acee1ff4778"},
{file = "numpy-2.4.6-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:112b06a867b235ef466ed3508ddf0238050df9c727cafb5301ac385b899189a1"},
{file = "numpy-2.4.6-cp313-cp313t-macosx_14_0_arm64.whl", hash = "sha256:eaf7fa2de5c0be8ae6ff8e9bea2ccd725e980541244521d8d4b5f3354a27babe"},
{file = "numpy-2.4.6-cp313-cp313t-macosx_14_0_x86_64.whl", hash = "sha256:7265a2f3d436e54ef9f2b52b5c937e6be778781bd97a590319d7348f1c1ca997"},
{file = "numpy-2.4.6-cp313-cp313t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f74a575920ab21fe304421a3fc28793d82e299cae9eccb37084e9fc7f3617c20"},
{file = "numpy-2.4.6-cp313-cp313t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ede83e07a75dd06bc501566c1eca2afc0d61677c1472ac9ad93fdee6e638a48d"},
{file = "numpy-2.4.6-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:68bb27509ac1b9a3443094260f6326150663b06abe40b73a2f81160623da5b67"},
{file = "numpy-2.4.6-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:a0df0043bdb289bde1f62da130d20df23d58b45429f752bc7a8fc5325a225ecd"},
{file = "numpy-2.4.6-cp313-cp313t-win32.whl", hash = "sha256:29a287e0cf63ff528da061de6b9f64a4618da591ca1046aafc54062e40ca7eab"},
{file = "numpy-2.4.6-cp313-cp313t-win_amd64.whl", hash = "sha256:25c692919ac5a01f170a3bfcd62d745b24fd095c353d50812637d6fcab442e75"},
{file = "numpy-2.4.6-cp313-cp313t-win_arm64.whl", hash = "sha256:1e978ec1e8bd0e0e4de6bb75de9d30cbb74db6b6a2bb727618613703ca0167dd"},
{file = "numpy-2.4.6-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:06ca2f61ec4385a07a6977c55ba998a4466c123642b4a32694d3128fce18c079"},
{file = "numpy-2.4.6-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:38efbc8de75c7a0fc1ac190162d892787f3f47b57cc291231aafee36b80982b7"},
{file = "numpy-2.4.6-cp314-cp314-macosx_14_0_arm64.whl", hash = "sha256:d581b735e177fdcdce6fed8e7e8880a3fb6ee4e3653a3ac6af01c6f4c03effc5"},
{file = "numpy-2.4.6-cp314-cp314-macosx_14_0_x86_64.whl", hash = "sha256:0a041d3d761dc3c35cc56ce0351506a02bcbc25f7b169f652435141a17db9096"},
{file = "numpy-2.4.6-cp314-cp314-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:40fdc1ae7125e518ea98e53e69a4ebc27e1fd50510c47b7ea130cf21e5e1d42b"},
{file = "numpy-2.4.6-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a2c306dea656c12c68f51f4cea133cbe78ca7435eb28c735eac1d3ebe73be6e8"},
{file = "numpy-2.4.6-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:33111801a01c12a8a1e3721f0a9232f8cfc8ae2c6b7098167e6f623c6073f402"},
{file = "numpy-2.4.6-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:ae506e6902902557576a26ff33eda8695e7ecb3cb36c3b573a0765dee114ebdb"},
{file = "numpy-2.4.6-cp314-cp314-win32.whl", hash = "sha256:aaf159caa35993cb1f56fb9b8e4610d35758e7ca005412eb1daa856a78c9c4b1"},
{file = "numpy-2.4.6-cp314-cp314-win_amd64.whl", hash = "sha256:b507f5c4c1d508876d1819b6bf9a49d365b96320b5d4993426b33a23ca4b8261"},
{file = "numpy-2.4.6-cp314-cp314-win_arm64.whl", hash = "sha256:6f41ae150c4e32db4f3310cdaf64b1593a03dbabe29eec77fc9b50fe64061df6"},
{file = "numpy-2.4.6-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:ece3d2cfe132e7d51f44a832b303895e6f2d499c5e74dfbdb06ee246147a304a"},
{file = "numpy-2.4.6-cp314-cp314t-macosx_14_0_arm64.whl", hash = "sha256:e3e5193ef5a3dc73bceee50f7fdc2c90dbb76c42df8d8fae3d1067a583df579e"},
{file = "numpy-2.4.6-cp314-cp314t-macosx_14_0_x86_64.whl", hash = "sha256:17f9ade344e7d9b464a084d69bcf18fc691cb1db67c62ed80820bf4926d78f0e"},
{file = "numpy-2.4.6-cp314-cp314t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9cd5ffd25db4e7ba6a375693b3fc0fc1791ec636c17db3720da19bde7180ec43"},
{file = "numpy-2.4.6-cp314-cp314t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7d92c3819208a60205a12a245c91ad70cb0a85336659b19b834205573ac8456e"},
{file = "numpy-2.4.6-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:e85b752a1e912b70eaad4fafbd4d1238007ab221de2009b9a2f5ae7461239895"},
{file = "numpy-2.4.6-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:29cb7f67d10b479ff07c17d33e39f78c07f71c40ef30d63c153d340e96cd3fb4"},
{file = "numpy-2.4.6-cp314-cp314t-win32.whl", hash = "sha256:260a5d70215b61ab4fadf5c7baacd64821842975eea312125ed3c39a6391b063"},
{file = "numpy-2.4.6-cp314-cp314t-win_amd64.whl", hash = "sha256:81a1cca95ed5bb92aa8b10dd2cdc9a0d3853a50fad926c28b5d7e8ea54389627"},
{file = "numpy-2.4.6-cp314-cp314t-win_arm64.whl", hash = "sha256:0c9136e14ed34a9e343a31c533d78a9813a69a3148332bce5e9821cb2f996e66"},
{file = "numpy-2.4.6-pp311-pypy311_pp73-macosx_10_15_x86_64.whl", hash = "sha256:55cced7c52e981362f708ad635198e97a752dfba412cc03c23bbf3bd8d5cd662"},
{file = "numpy-2.4.6-pp311-pypy311_pp73-macosx_11_0_arm64.whl", hash = "sha256:d6da64deb6b8ed903e7560180a92f2d804ee1ba5eeb849ac2748b8c1aba1f6d7"},
{file = "numpy-2.4.6-pp311-pypy311_pp73-macosx_14_0_arm64.whl", hash = "sha256:68a5124b13fa6cc2086764a20005d30bc0548146f7f5322f02fce212ca14317f"},
{file = "numpy-2.4.6-pp311-pypy311_pp73-macosx_14_0_x86_64.whl", hash = "sha256:948424b06129ce883307e8cff868c31396d8dc7630a59c61d70d98dbe70f222c"},
{file = "numpy-2.4.6-pp311-pypy311_pp73-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:5dbbdb29840ca3d91ee0fece42fc29278886d908280bfec0a5846c6f901a3eb0"},
{file = "numpy-2.4.6-pp311-pypy311_pp73-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:8ad03c0965fb3c692200e74d458ca28c1dbb4ce96f9a479a8aa041ad5fabca02"},
{file = "numpy-2.4.6-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:2803abfebfc990042cd494d8ce2d5f82e9d847af6d35ec486923aa19dbad5e73"},
{file = "numpy-2.4.6.tar.gz", hash = "sha256:f3a3570c4a2a16746ac2c31a7c7c7b0c186b95ce902e33db6f28094ed7387dda"},
]
[[package]]
@@ -974,6 +993,17 @@ files = [
{file = "packaging-26.2.tar.gz", hash = "sha256:ff452ff5a3e828ce110190feff1178bb1f2ea2281fa2075aadb987c2fb221661"},
]
[[package]]
name = "packbits"
version = "0.6"
description = "PackBits encoder/decoder"
optional = false
python-versions = "*"
groups = ["main"]
files = [
{file = "packbits-0.6.tar.gz", hash = "sha256:bc6b370bb34e04ac8cfa835e06c0484380affc6d593adb8009dd6c0f7bfff034"},
]
[[package]]
name = "pep8"
version = "1.7.1"
@@ -1853,4 +1883,4 @@ h11 = ">=0.16.0,<1"
[metadata]
lock-version = "2.1"
python-versions = ">=3.14"
content-hash = "fd3fb42c796aaaee4193f31df09bb4c74277855c489bf34a27c4bc1616851dfb"
content-hash = "18e1a5c8b085aa639b665279856f9e3c51a734a6a8d1d4dd135ca7e4f67e86ae"

View File

@@ -7,7 +7,7 @@ authors = [
]
license = "AGPLv3"
readme = "README.md"
requires-python = ">=3.14"
requires-python = ">=3.13"
dependencies = [
"flask (>=3.1.3,<4.0.0)",
"numpy (>=2.3.4)",
@@ -42,6 +42,7 @@ dependencies = [
"python-escpos (>=3.1,<4.0)",
"pep8 (>=1.7.1,<2.0.0)",
"pylint (>=4.0.5,<5.0.0)",
"brother-ql-inventree (>=1.3,<2.0)",
]
[tool.poetry]

View File

@@ -36,14 +36,16 @@ import werkzeug.exceptions
from flask_socketio import SocketIO
from flask_limiter import Limiter
from flask_limiter.util import get_remote_address
from printer import Printer # The wrapper for the printer class
from raspberry import Raspberry # The Raspberry pi control Class
from web import Web # Wrapper for the web routes and API
from print_queue import PrintQueue
from worker import PrintWorker
# Variables
# We create the main Flask object
app = Flask(__name__)
socketio = SocketIO(app)
socketio = SocketIO(app, cors_allowed_origins="*")
# Global variables
ALLOWED_EXTENSIONS = {"png", "jpg", "jpeg", "gif", "webp"}
# Load the configuration file
@@ -70,11 +72,7 @@ except OSError as e:
app.logger.debug("Config file loaded !")
# Define the USB connections here.
vendor_id = configuration_file["printer"]["vendor_id"]
device_id = configuration_file["printer"]["device_id"]
UPLOAD_FOLDER = str(configuration_file["printer"]["upload_folder"])
try:
os.mkdir(UPLOAD_FOLDER)
app.logger.debug("Directory %s created successfully.", UPLOAD_FOLDER)
@@ -82,50 +80,52 @@ except FileExistsError:
app.logger.debug("Directory %s already exists.", UPLOAD_FOLDER)
except PermissionError:
app.logger.error("Permission denied: Unable to create %s", UPLOAD_FOLDER)
exit(77)
sys.exit(77)
# Output the config file
if os.getenv("LIPY_DEBUG") is True:
if not os.getenv("FLASK_DEBUG") is None and os.getenv("FLASK_DEBUG") is True:
pprint.pprint(configuration_file)
# We define the app module used by Flask
app.secret_key = configuration_file["secrets"]["flask_secret_key"]
app.config["UPLOAD_FOLDER"] = UPLOAD_FOLDER
app.config["ALLOWED_EXTENSIONS"] = ALLOWED_EXTENSIONS
app.config["MAX_CONTENT_LENGTH"] = 10 * 1000 * 1000 # Maximum 3Mb for a file upload
app.config["MAX_CONTENT_LENGTH"] = 10 * 1000 * 1000 # Maximum 10Mb for a file upload
app.config["TEMPLATES_AUTO_RELOAD"] = True
# Printer connection
# Uses the class defined in the printer.py file
printer = Printer(app, 0x04B8, 0x0E28)
printer.init_printer()
# Queue creation
print_queue = PrintQueue(app)
# Find out if we are running on a Raspberry Pi
rpi = Raspberry(
printer,
print_queue,
app,
socketio,
configuration_file["rpi"]["button_gpio_port_number"],
configuration_file["rpi"]["indicator_gpio_port_number"],
configuration_file["rpi"]["flash_gpio_port_number"],
configuration_file["rpi"]["flash"],
configuration_file
)
RASPBERRY_PI_CONNECTED = rpi.is_raspberry_pi()
# Web & API routes
# Web & API management
web = Web(app, print_queue)
web = Web(app, printer)
if __name__ == "__main__":
app.run(debug=True, use_reloader=False, host="0.0.0.0", ssl_context="adhoc")
# Start worker thread
# When created, the worker will try to find printers connected to the system
try:
worker = PrintWorker(app, print_queue)
worker.start()
except Exception as e:
app.logger.error("Could not start the worker because %s ", str(e))
sys.exit(-1)
# The rate limit
limiter = Limiter(
get_remote_address, app=app, default_limits=["1500 per day", "500 per hour"]
)
app.logger.info("🖶 Welcome to LittlePrynter !")
# General routes
@app.route("/")
@limiter.limit("1/second", override_defaults=False)
def index():
@@ -142,6 +142,86 @@ def webcam():
return render_template("webcam.html")
# Form treatement
@app.route("/web/print/sms", methods=["POST"])
@limiter.limit("6/minute", override_defaults=False)
def web_print_sms():
"""Prints a short message on a printer"""
app.logger.debug("Printing an sms via web method")
try:
txt = request.form["txt"]
except werkzeug.exceptions.BadRequestKeyError as 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")
return redirect(url_for("index"))
try:
# comment: We try to get a signature
sign = request.form["signature"]
except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.warning(
"No signature found for this print, using default signature : %s ", str(e)
)
sign = configuration_file["defaults"]["signature"]
try:
web.print_sms(txt, sign)
except RuntimeError as 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")
return redirect(url_for("index"))
# end try
flash("The SMS has been added to the print queue !", "info")
return redirect(url_for("index"))
@app.route("/web/print/img", methods=["POST"])
@limiter.limit("1/second", override_defaults=False)
def web_print_img():
"""Prints an image on a printer"""
app.logger.debug("Printing an image with web method")
try:
# comment: We try to get a signature
sign = request.form["signature"]
except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.warning(
"No signature found for this print, using default signature : %s", str(e)
)
sign = configuration_file["defaults"]["signature"]
except werkzeug.exceptions.RequestEntityTooLarge as e:
flash("Whoops, image is too big: " + str(e), "error")
return redirect(url_for("index"))
# check if the post request has the file part
if "img" not in request.files:
app.logger.error("Whoops, no images submitted : %s ", str(e))
app.logger.error("Error getting the files : %s", str(e))
flash("Whoops, no images submitted : " + str(e), "error")
return redirect(url_for("index"))
file = request.files["img"]
# If the user does not select a file, the browser submits an
# empty file without a filename.
if file.filename == "":
app.logger.error("Submitted file has no filename !")
flash("Submitted file has no filename !", "error")
return redirect(url_for("index"))
try:
app.logger.debug("Sending the image to the printer.")
web.print_image(file, sign)
except RuntimeError as 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")
return redirect(url_for("index"))
flash("Picture added to the print queue !", "info")
return redirect(url_for("index"))
# API routes
# The api has the following methods
# api/print/{sms,img,letter,qr,barcode}
@@ -163,93 +243,122 @@ def api_index():
@limiter.limit("6/minute", override_defaults=False)
def api_print_sms():
"""Prints a short message on a printer"""
app.logger.debug("Printing an sms")
app.logger.debug("Printing an sms via API")
try:
txt = request.form["txt"]
except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.error("Whoops, we are missing the txt input field. : %s ", str(e))
flash("Whoops, no forms submitted or missing signature : %s", str(e))
return redirect(url_for("index"))
return str(e), 400
try:
# comment: We try to get a signature
sign = request.form["signature"]
except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.warning(
"No signature found for this print, using default signature.", str(e)
"No signature found for this print, using default signature. : %s", str(e)
)
sign = configuration_file["defaults"]["signature"]
web.print_sms(txt, sign)
return redirect(url_for("index"))
try:
# comment: We try to print the SMS
web.print_sms(txt, sign)
except RuntimeError as e:
return str(e), 500
# end try
return "OK", 200
@app.route("/api/print/img", methods=["POST"])
@limiter.limit("6/minute", override_defaults=False)
def api_print_image():
"""Prints an image on a printer"""
app.logger.debug("Printing an image")
app.logger.debug("Printing an image via API")
try:
# comment: We try to get a signature
sign = request.form["signature"]
except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.warning(
"No signature found for this print, using default signature.", str(e)
"No signature found for this print, using default signature. %s", str(e)
)
sign = configuration_file["defaults"]["signature"]
if request.method == "POST":
# check if the post request has the file part
if "img" not in request.files:
app.logger.error("Whoops, no images submitted : %s ", str(e))
app.logger.error("Error getting the files : %s", str(e))
flash("Whoops, no images submitted : %s", str(e))
return redirect(url_for("index"))
# check if the post request has the file part
if "img" not in request.files:
app.logger.error("Whoops, no images submitted.")
return "No image submitted", 400
file = request.files["img"]
# If the user does not select a file, the browser submits an
# empty file without a filename.
if file.filename == "":
app.logger.error("Submitted file has no filename !")
flash("Submitted file has no filename !")
return redirect(url_for("index"))
file = request.files["img"]
# If the user submits an empty file without a filename.
if file.filename == "":
app.logger.error("Submitted file has no filename !")
return "Submitted file has no filename !", 400
try:
app.logger.debug("Sending the image to the printer.")
web.print_image(file, sign)
except Exception as e:
app.logger.error("The image could not be printed because : %s ", str(e))
flash("The image could not be printed because : %s ", str(e))
return redirect(url_for("index"))
try:
app.logger.debug("Sending the image to the printer.")
web.print_image(file, sign)
except RuntimeError as e:
return str(e), 500
else:
app.logger.error("Method not allowed")
flash("Method not allowed")
return redirect(url_for("index"))
flash("Picture printed ! ")
return redirect(url_for("index"))
return "OK", 200
@app.route("/api/camera/picture")
# TODO: This might not depend on the Raspberry Pi
@app.route("/api/camera/picture", methods=["GET"])
def camera_picture():
"""Returns a picture taken by the camera"""
"""Returns a picture taken by the camera on a raspberry pi"""
if RASPBERRY_PI_CONNECTED:
try:
return rpi.camera_picture()
except Exception as e:
except RuntimeError as e:
return jsonify({"message": "Error getting the stream : " + e}), 500
else:
return jsonify({"message": "No camera present"}), 500
@app.route("/api/queue", methods=["GET"])
def api_queue_status():
"""API endpoint for entire queue"""
return jsonify(web.get_queue_state())
@app.route("/api/queue/completed", methods=["GET"])
def api_queue_completed():
"""API endpoint that returns the finished tasks"""
return jsonify(web.get_queue_completed())
@app.route("/api/worker", methods=["GET"])
def api_worker_state():
"""API endpoint to get the worker state"""
return jsonify(worker.current_state())
@app.route("/api/worker/start")
def api_worker_start():
"""
Enable to worker. This starts to process the print queue.
"""
worker.start_worker()
return jsonify(worker.current_state())
@app.route("/api/worker/stop")
def api_worker_stop():
"""
Stops the print queue. This stops the processing of the print queue.
"""
worker.stop_worker()
return jsonify(worker.current_state())
## Authentification
@app.route("/login")
@limiter.limit("1/second", override_defaults=False)
def login_page():
"""Unsued, logins"""
# web.login(username,password)
return redirect(url_for("index"))
return redirect(url_for("index")), 501
@app.route("/logout")
@@ -257,7 +366,7 @@ def login_page():
def logout_page():
"""Unused, logout"""
# web.logout(username, password)
return redirect(url_for("index"))
return redirect(url_for("index")), 501
@app.errorhandler(429)
@@ -295,3 +404,7 @@ def camera_status():
socketio.emit("camera_status", True)
else:
socketio.emit("camera_status", False)
if __name__ == "__main__":
app.run(use_reloader=False, host="0.0.0.0", ssl_context="adhoc")

144
src/print_queue.py Normal file
View File

@@ -0,0 +1,144 @@
"""
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
the queue is
"""
from collections import deque
# Because actually printing and adding new print job requests happen at
# diffrent times, the print queue is managed by it's own thread.
import threading
from datetime import datetime
from task import TaskType
class PrintQueue:
"""
A Double-ended Queue to manage the printing Tasks
"""
def __init__(self, app):
self.app = app
self._queue = deque()
self._lock = threading.Lock()
self._completed_tasks = {} # Store completed task info
self._task_counter = 0
self.app.logger.debug("Created a new PrintQueue")
def __len__(self) -> int:
return len(self._queue)
def enqueue(self, task):
"""Add task to right of the queue and return position"""
with self._lock:
try:
self.app.logger.info("Add task %s to queue ", task.task_id)
self._queue.append(task)
position = self._queue.index(task)
# We return the current position of the task if it was added
self.app.logger.debug(
"Added a new task %s to the queue at position %s",
task.task_id,
position,
)
return position
except Exception as e:
self.app.logger.error("Could not add a task to the queue : %s ", e)
raise e
def dequeue(self):
"""Remove and return next task ( from the left of the queue ) (thread-safe)"""
with self._lock:
return self._queue.popleft() if len(self._queue) > 0 else None
def get_position(self, task):
"""Get current position of task in queue (1-indexed)"""
with self._lock:
if task.task_id in self._completed_tasks:
return None # Task already completed
try:
# Try to get the position of a Task
return self._queue.index(task)
except ValueError as e:
raise e
# end try
def is_empty(self):
"""Check if queue is empty"""
with self._lock:
self.app.logger.debug("Checking if queue is empty")
return len(self._queue) == 0
def get_queue_state(self):
"""Return current queue state"""
with self._lock:
self.app.logger.debug("Return current queue state")
return [
{"task_id": t.task_id, "status": t.status, "type": str(t.task_type), "content": str(t.get_print_data())}
for t in self._queue
]
def get_queue_completed(self):
"""Return completed queue elements"""
with self._lock:
self.app.logger.debug("Return completed queue elements")
return self._completed_tasks
def get_status(self, task_id):
"""Get full status info for a task"""
with self._lock:
if task_id in self._completed_tasks:
return self._completed_tasks[task_id]
# Check in queue if it exists
for index, task in enumerate(self._queue):
if task.task_id == task_id:
# Depending on it's type, we return more info
if task.task_type == TaskType.IMAGE:
return {
"task_id": task_id,
"status": task.status,
"type": task.task_type,
"position": index,
"in_queue": True,
"content": task.content,
"signature": task.signature,
}
if task.task_type == TaskType.TEXT:
return {
"task_id": task_id,
"status": task.status,
"type": task.task_type,
"position": index,
"in_queue": True,
"image_path": str(task.image_path),
"signature": task.signature,
"process": str(task.process),
}
if task.task_type == TaskType.CUT:
return {
"task_id": task_id,
"status": task.status,
"type": task.task_type,
"position": index,
"in_queue": True,
}
return None
def mark_completed(self, task_id, task_status):
"""Mark task as completed and remove from queue"""
with self._lock:
self._completed_tasks[task_id] = {
"task_id": task_id,
"status": task_status,
"position": None,
"in_queue": False,
"completed_at": datetime.now().isoformat(),
}

View File

@@ -1,93 +1,129 @@
# Importing the module to manage the connection to the printer.
import escpos.printer as escp
from time import sleep, gmtime, strftime
"""
This class manages connexion to a Printer
"""
import os.path
from PIL import Image, ImageEnhance, ImageOps
import os
from abc import ABC, abstractmethod
from dataclasses import dataclass
import time
from enum import Enum
import uuid
import threading
import usb.core
from PIL import Image, ImageEnhance
import numpy as np
# Importing the modules needed for each supported printer Type
import escpos.printer
from brother_ql.models import ModelsManager
from brother_ql.backends import backend_factory
from brother_ql.raster import BrotherQLRaster
from brother_ql.conversion import convert
from brother_ql.backends.helpers import send
class Printer(object):
class PrinterType(Enum):
"""
# The connection is based on the ESC/POS library
## Connection to the USB printer
## Making sure the printer is alive
## Making sure it has paper
## Define default print settings
## Print starting message, log time of first print, cut.
## Annonce readyness : return a positive pong message.
What are the capacities of a Printer ?
"""
# Is the printer ready to accept a new print ?
ready = False
EPSON = "epson"
BROTHER = "brother"
def __init__(self, app, device_id, vendor_id):
super(Printer, self).__init__()
# For Brother-QL Printers
@dataclass
class PrinterInfo:
"""
Brother-QL printer information
"""
identifier: str
backend: str
protocol: str
vendor_id: str
product_id: str
serial_number: str
name: str = "Brother QL Printer"
model: str = "QL-570"
status: str = "unknown"
label_type: str = "unknown"
label_size: str = "unknown"
label_width: int = 0
label_height: int = 0
def __getitem__(self, item):
return getattr(self, item)
def __setitem__(self, key, value):
setattr(self, key, value)
class Printer(ABC):
"""
If it outputs printed paper and speaks like a printer, then it must be a printer.
"""
def __init__(self, app, vendor_id, device_id, printer_type: PrinterType):
"""
We initialize a Printer via it's USB connexion, and generate a unique ID
"""
self.id = uuid.uuid4()
self.app = app
self.ready = False
self.printer = None
self.device_id = device_id
self.vendor_id = vendor_id
self.device_id = device_id
self.ready = False
self.printer_type = printer_type
self._lock = threading.Lock()
@abstractmethod
def _has_paper(self) -> bool:
"""Check if the printer has papier"""
@abstractmethod
def _state(self) -> bool:
"""Reports the state of the Printer"""
@abstractmethod
def print_task(self, task_type, data) -> None:
"""Takes a PrintTask and executes it"""
class EscPosPrinter(Printer):
"""
Create a new ESC/POS based printer.
"""
def __init__(self, app, vendor_id, device_id):
"""
Create a connexion to a ESC/POS Printer via USB,
Making sure the printer is alive,
Making sure it has paper,
Define default print settings
"""
super().__init__(app, vendor_id, device_id, printer_type=PrinterType.EPSON)
self.printer = None
self.usb_args = {}
self.usb_args["idVendor"] = self.device_id
self.usb_args["idProduct"] = self.vendor_id
self.usb_args["idVendor"] = self.vendor_id
self.usb_args["idProduct"] = self.device_id
def check_paper(self) -> bool:
# Let's check paper status
self.app.logger.debug("Checking paper status...")
self.printer.open(self.usb_args)
status = self.printer.paper_status()
match status:
case 0:
self.app.logger.error("Printer has no more paper, aborting...")
self.printer.close()
raise Exception("No more paper in the printer")
case 1:
self.app.logger.warning(
"Printer needs paper to be changed very soon ! "
)
self.printer.close()
case 2:
self.app.logger.debug("Printer has paper, good to go")
self.printer.close()
try:
# This also calls open(), which we need to close()
# or else the device will appear as busy.
p = escpos.printer.Usb(self.vendor_id, self.device_id, 0, profile="TM-P80")
except escpos.exceptions.DeviceNotFoundError as e:
self.app.logger.error(
"The USB device is not plugged in : %s",
str(e),
)
except Exception as e:
self.app.logger.error("Printer could not be connected : %s ", str(e))
def init_printer(self):
# Is the printer online ? Is the communication with the printer successfull ?
waiting_elapsed = 30
self.app.logger.debug("Waiting for printer to get online...")
while not self.ready:
try:
# This also calls open(), which we need to close()
# or else the device will appear as busy.
p = escp.Usb(self.device_id, self.vendor_id, 0, profile="TM-P80")
except Exception as e:
self.app.logger.error(
"The USB device is not plugged in, trying again : " + str(e)
)
pass
try:
if p.is_online():
self.ready = True
self.app.logger.debug("Printer online !")
except Exception as e:
pass
sleep(1)
waiting_elapsed -= 1
if waiting_elapsed < 1:
self.app.logger.error(
"Printer took more than 30 seconds to get online, aborting..."
)
waiting_elapsed = 1 # Reset the waiting time for the next print.
return False
try:
if p.is_online():
self.app.logger.debug("Printer online !")
except Exception as e:
raise e
# Setting up the printing options.
p.set(
@@ -108,22 +144,54 @@ class Printer(object):
# Beware : if we print every time the printer becomes ready, it means
# we are printing before and after every print !
self.printer = p
self.printer.close() # We close the connexion to the Printer
try:
self._has_paper()
except Exception as e:
raise e
self.ready = True
self.printer.close()
self.check_paper()
def _has_paper(self):
"""Check if the printer has paper left"""
self.app.logger.debug("Checking paper status...")
self.printer.open(self.usb_args)
status = self.printer.paper_status()
match status:
case 0:
self.app.logger.error("Printer has no more paper, aborting...")
self.printer.close()
raise RuntimeError("No more paper in the printer")
case 1:
self.app.logger.warning(
"Printer needs paper to be changed very soon ! "
)
self.printer.close()
return True
case 2:
self.app.logger.debug("Printer has paper, good to go")
self.printer.close()
return True
return True
def _print_txt(self, msg, signature="", bold=False):
self.ready = False
if not isinstance(msg, str):
self.app.logger.error(
"It is not possible to print a " + str(type(msg)) + ", only strings."
)
raise ValueError
def print_sms(self, msg, signature="", bold=False):
# We make sure that the signature is not something too goofy
clean_msg = str(msg) + "\n"
clean_signature = str(signature)
# Make checks on the size of the message being printed
if len(clean_msg) > 4096:
self.app.logger.warning(
"Could not print message of this length: " + str(len(clean_msg))
)
raise Exception(
raise RuntimeError(
"Could not print message of this length :"
+ str(len(clean_msg))
+ ", needs to be below 4096 caracters long."
@@ -133,33 +201,40 @@ class Printer(object):
self.app.logger.warning(
"Could not print signature of this length: " + str(len(clean_signature))
)
raise Exception(
raise RuntimeError(
"Could not print signature of this length :"
+ str(len(clean_signature))
+ ", needs to be below 256 caracters long."
)
# Do the actual printing
# We would pop the next element in the queue here, if it's a sms type
try:
self.printer.open(self.usb_args)
self.printer.set(align="center", font="a", bold=bold)
self.printer.textln(clean_msg)
if clean_signature:
self.printer.textln(clean_signature)
self.printer.textln()
self.printer.close()
except Exception as e:
self.app.logger.error("Unable to print because : " + str(e))
raise RuntimeError(
"Unable to print a SMS, the printer couldn't do it."
) from e
self.app.logger.info("Printed text")
return True
self.ready = True
def print_img(self, path, sign="", center=True, process=False):
clean_signature = str(sign)
def _print_img(self, path, signature="", center=True, process=False):
self.ready = False
clean_signature = str(signature)
if len(sign) > 256:
if len(signature) > 256:
self.app.logger.warning(
"Could not print signature of this length: " + str(len(clean_signature))
)
raise Exception(
raise ValueError(
"Could not print signature of this length :"
+ str(len(clean_signature))
+ ", needs to be below 256 caracters long."
@@ -167,53 +242,74 @@ class Printer(object):
if not os.path.isfile(str(path)):
self.app.logger.warning("File does not exist : " + str(path))
raise Exception(
raise OSError(
"The file path for this image :"
+ str(path)
+ " 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:
try:
self.app.logger.debug("Proccessing the image")
path = process_image(self, path)
except Exception as e:
self.app.logger.error(str(e))
return False
processed_path = _process_image(self, path)
except RuntimeError as e:
self.app.logger.error(
"Error while processing the image, aborting print : %s", str(e)
)
raise e
else:
processed_path = path
self.app.logger.warning("Not proccessing the image")
try:
self.printer.open(self.usb_args)
self.printer.image(path, center=center)
self.printer.image(processed_path, center=center)
self.printer.textln(signature)
self.printer.close()
self.app.logger.debug("Printed an image : " + str(path))
os.remove(path)
self.app.logger.debug("Removed image : " + str(path))
self.app.logger.debug("Printed an image : " + str(processed_path))
except Exception as e:
self.printer.close()
self.app.logger.error(str(e))
return False
raise RuntimeError("Could not print the picture") from e
finally:
try:
os.remove(path)
os.remove(processed_path)
except OSError as e:
raise e
self.app.logger.debug("Removed image : " + str(processed_path))
self.app.logger.debug("Removed image : " + str(path))
try:
self.printer.close()
except Exception as e:
self.app.logger.error(
"Could not close the printer connexion %s", str(e)
)
raise RuntimeError("Could not close the printer connexion. ") from e
self.app.logger.info("Printed a picture")
return True
self.ready = True
def qr(self, content):
def _qr(self, content):
self.ready = False
try:
self.printer.open(self.usb_args)
self.printer.qr(content, center=True)
self.printer.textln(content)
self.printer.close()
except Exception as e:
except RuntimeError as e:
self.printer.close()
self.app.logger.error(str(e))
return False
raise e
self.app.logger.info("Printed a QR")
return True
self.ready = True
def cut(self):
def _cut(self):
self.ready = False
try:
self.printer.open(self.usb_args)
self.printer.cut()
@@ -224,28 +320,245 @@ class Printer(object):
raise e
self.app.logger.info("Did a cut")
return True
self.ready = True
def _state(self) -> bool:
has_paper = self._has_paper()
is_ready = self.ready
self.app.logger.debug("Has paper : %s " , has_paper )
self.app.logger.debug("Ready : %s " , is_ready )
return is_ready and has_paper # and is_online
def print_task(self, task_type, data):
"""Execute actual print based on task type"""
def process_image(self, path):
with self._lock:
self.app.logger.debug("Acquired lock to start print")
i_m_ready = self._state()
while not i_m_ready:
self.app.logger.debug("Waiting for the printer to become ready, current state %s ", str(i_m_ready))
i_m_ready = self._state()
time.sleep(0.3)
self.app.logger.debug("Checked state to start printing : %s", self._state())
self.ready = False
try:
self.app.logger.debug("Checking task type")
match (task_type.value):
case "text":
self._print_txt(data["txt"], signature=data["sign"])
self.ready = True
case "image":
self._print_img(
data["img"], signature=data["sign"], process=data["process"]
)
self.ready = True
case "cut":
self._cut()
self.ready = True
case "qr":
self._qr(data["txt"])
self.ready = True
case _:
raise RuntimeError("This task type is not supported")
except Exception as e:
self.app.logger.debug("Exception occured while printing %s", str(e))
self.ready = True
raise RuntimeError from e
class BrotherPrinter(Printer):
"""
Manages connexion and capabilities of a BrotherQL Printer
"""
def __init__(self, app, vendor_id, device_id):
super().__init__(
app, vendor_id="", device_id="", printer_type=PrinterType.BROTHER
)
self.printer = None
self.usb_args = {}
self.usb_args["idVendor"] = self.device_id
self.usb_args["idProduct"] = self.vendor_id
self.model_manager = ModelsManager()
# Code taken from https://github.com/5shekel/printit/blob/master/printer_utils.py
backend = backend_factory("pyusb")
available_devices = backend["list_available_devices"]()
for printer in available_devices:
self.app.logger.debug(f"Found device: {printer}")
identifier = printer["identifier"]
parts = identifier.split("/")
if len(parts) < 4:
self.app.logger.warning(
f"Skipping device with invalid identifier format: {identifier}"
)
continue
protocol = parts[0]
# device_info = parts[2]
serial_number = parts[3]
try:
product_id_int = int(self.device_id, 16)
for m in self.model_manager.iter_elements():
if m.product_id == product_id_int:
model = m.identifier
break
self.app.logger.debug(f"Matched printer model: {model}")
except ValueError:
self.app.logger.warning(f"Invalid product ID format: {m.product_id}")
self.printer_info = PrinterInfo(
identifier=identifier,
backend="pyusb",
model=model,
protocol=protocol,
vendor_id=vendor_id,
product_id=self.device_id,
serial_number=serial_number,
)
self.ready = True
def _has_paper(self):
raise NotImplementedError("This printer model does not support this.")
def _state(self):
return self.ready
def _print_img(self, data):
"""
Print a raster image via a Brother QL printer
"""
self.ready = False
label_type = "102"
rotate = 0
dither = False
try:
# Prepare the image for printing
qlr = BrotherQLRaster(self.printer_info["model"])
instructions = convert(
qlr=qlr,
images=[data["img"]],
label=label_type,
rotate=rotate,
threshold=70,
dither=dither,
compress=True,
red=False,
dpi_600=False,
hq=False,
cut=True,
)
# Debug logging
if os.getenv("FLASK_DEBUG"):
self.app.logger.debug(f"""
Print parameters:
- Label type: {label_type}
- Rotate: {rotate}
- Dither: {dither}
- Model: {self.printer_info['model']}
- Backend: {self.printer_info['backend']}
- Identifier: {self.printer_info['identifier']}
""")
# Try to print using Python API
# send() = status = {
# 'instructions_sent': True, # The instructions were sent to the printer.
# 'outcome': 'unknown', # String description of the outcome of the sending operation like: 'unknown', 'sent', 'printed', 'error'
# 'printer_state': None, # If the selected backend supports reading back the printer state, this key will contain it.
# 'did_print': False, # If True, a print was produced. It defaults to False if the outcome is uncertain (due to a backend without read-back capability).
# 'ready_for_next_job': False, # If True, the printer is ready to receive the next instructions. It defaults to False if the state is unknown.
# }
status = send(
instructions=instructions,
printer_identifier=self.printer_info["identifier"],
backend_identifier="pyusb",
)
if (
not status["did_print"]
or status["outcome"] == "error"
or status["outcome"] == "unknown"
):
raise RuntimeError("Failed to print using Python API")
if status["printer_state"]:
self.ready = bool(status["printer_state"])
else:
self.ready = True
except usb.core.USBError as e:
# Treat timeout errors as successful since they often occur after print completion
if e.errno == 110: # Operation timed out
self.app.logger.debug(
"USB timeout occurred - this is normal and the print likely completed"
)
self.app.logger.debug("Print completed (timeout is normal)")
self.ready = True
error_msg = f"USBError encountered: {e}"
self.app.logger.debug(error_msg)
raise RuntimeError from e
except Exception as e:
error_msg = f"Unexpected error during printing: {str(e)}"
self.app.logger.debug(error_msg)
raise RuntimeError from e
def print_task(self, task_type, data):
"""Execute actual print based on task type"""
with self._lock:
if self._state:
self._state = False
match (task_type.value):
case "image":
self._print_img(data["img"])
self._state = True
case "cut":
# The cut happens by default on Brother QL printers.
self._state = True
case _:
raise RuntimeError("This task type is not supported")
else:
raise RuntimeError("The printer is not ready to print yet !")
# These values are by default for now
# raise NotImplementedError("This printer type is not implemented yet")
def _process_image(self, path):
brightness_factor = 1.5 # Used only if image is too dark
brightness_threshold = 100 # Brightness threshold (0255)
contrast_factor = 0.6 # Less than 1.0 = lower contrast
contrast_factor = 2 # Less than 1.0 = lower contrast
max_width = 575
max_height = 1000
with Image.open(path) as original_img:
# Convert to RGB if needed (JPEG doesn't support alpha)
if original_img.mode in ("RGBA", "P"):
self.app.logger.debug("Converting the image to RGB from RGBA")
self.app.logger.debug("Converting the image from RGBA to RGBA")
original_img = original_img.convert("RGB")
# Resize while maintaining aspect ratio
original_img.thumbnail((max_width, max_height), Image.LANCZOS)
original_img.thumbnail((max_width, max_height), Image.Resampling.LANCZOS)
self.app.logger.debug("Resized the image")
# # Convert to grayscale for dithering
# dithered_img = original_img.convert("L").convert("1") # Dithering using default method (FloydSteinberg)
# dithered_img = original_img.convert("L").convert("1")
# Dithering using default method (FloydSteinberg)
# self.app.logger.debug("Dithered the image")
# Compute brightness of original image (grayscale average)
@@ -266,23 +579,19 @@ def process_image(self, path):
self.app.logger.debug(
f"Image too dark, increasing brightness by a factor of {brightness_factor:.2f}"
)
enhancer = ImageEnhance.Brightness(original_img)
original_img = enhancer.enhance(brightness_factor)
enhancer = ImageEnhance.Brightness(grayscale)
grayscale = enhancer.enhance(brightness_factor)
# # Reduce contrast
# contrast_enhancer = ImageEnhance.Contrast(original_img)
# original_img = contrast_enhancer.enhance(contrast_factor)
# Final resize check
if original_img.height > max_height:
raise ValueError("Image is too long, sorry! Keep it below 575×1000 pixels.")
self.app.logger.error(
"Image is too long, sorry! Keep it below 575×1000 pixels."
)
return False
# Computer current contrast of grayscale image
contrast = np.clip(np.std(np.array(grayscale)), 0, 255)
self.app.logger.debug("Standard deviation of the contrast : %s", contrast)
# # Enhance contrast
contrast_enhancer = ImageEnhance.Contrast(grayscale)
original_img = contrast_enhancer.enhance(contrast_factor)
# Convert to JPEG and save
jpeg_path = os.path.splitext(path)[0] + "_processed.jpg"
original_img.save(jpeg_path, format="JPEG", quality=95, optimize=True)
grayscale.save(jpeg_path, format="JPEG", quality=95, optimize=True)
self.app.logger.debug("Processed and saved image.")
return jpeg_path

160
src/printers.py Normal file
View File

@@ -0,0 +1,160 @@
"""
A collection of Printers.
It has methods to discover printers, and provides an interface for
the methods expected from printers.
"""
from collections.abc import Set
import usb.core
import usb.util
from printer import Printer, EscPosPrinter, BrotherPrinter
class Printers:
"""
Finds and creates a set of Printer that can be used by the Workers to print.
"""
def __init__(self, app):
"""
Discover printers connected to the computer and return a Collection of Printer()
"""
self.app = app
self.printers = self._discover_printers()
def _discover_printers(self) -> Set[Printer]:
"""
Gets connected USB printer devices using the pyusb library.
We analyse the USB devices, get the ones that match
the printer class ( 7 ) and for Brother and EPSON printers,
try to create a Printer object that can be used by the Worker class
to execute prints.
Returns a set of Printer
"""
self.app.logger.debug("Discovering USB Devices connected to this system")
printers = set()
# Find all connected USB devices
devices = usb.core.find(find_all=True, custom_match=_FindClass(7))
if not devices:
self.app.logger.warning(
"No USB devices of class 7 ( printers ) found or pyusb could not access the bus."
)
raise RuntimeError(
"No USB devices of class 7 ( printers ) found or pyusb could not access the bus."
)
for dev in devices:
# Attempt to get the manufacturer and product strings
try:
manufacturer = usb.util.get_string(dev, dev.iManufacturer)
except Exception:
manufacturer = "Unknown"
try:
product = usb.util.get_string(dev, dev.iProduct)
except Exception:
product = "Unknown"
self.app.logger.debug(
"Looking at %s %s (%s:%s)",
manufacturer,
product,
hex(dev.idVendor),
hex(dev.idProduct),
)
if manufacturer == "EPSON":
try:
# We create a new EscPosPrinter()
self.app.logger.debug("Trying to creat a new EPSON printer")
prid = dev.idProduct
vendir = dev.idVendor
escpos_printer = EscPosPrinter(
self.app, vendor_id=vendir, device_id=prid
)
except Exception as e:
raise e
# If the object creation is successfull, we add it to the list of Printers
printers.add(escpos_printer)
self.app.logger.debug("Found a %s printer", manufacturer)
# We already found the type of printer,
# we don't need an extra comparaison.
continue
# or a Brother Printer
if manufacturer == "Brother":
try:
# We create a new BrotherPrinter()
self.app.logger.debug("Trying to creat a new BROTHER printer")
prid = dev.idProduct
vendir = dev.idVendor
brother_printer = BrotherPrinter(
self.app, vendor_id=vendir, device_id=prid
)
except Exception as e:
self.app.logger.error(
"Could not create a %s printer class with %s:%s" , product,
dev.idVendor,
dev.idProduct,
)
raise e
# If the object creation is successfull, we add it to the list of Printers
printers.add(brother_printer)
self.app.logger.debug("Found a %s printer" , manufacturer)
self.app.logger.debug("Found %s printers" , len(printers))
if len(printers) < 1:
self.app.logger.warning("Not printers found ! Please plug in a Printer and restart the program.")
raise RuntimeError("No printers found")
return printers
def any(self) -> Printer:
"""
Return a dict key: UUID, value: Printer, with any connected printer.
"""
if len(self.printers) > 0:
for i in self.printers:
return i
else:
raise RuntimeError("No printers available")
# def get_printer(self, printer_type):
# """
# Return a specific printer
# printer_type -- a printer type
# """
# return NotImplementedError()
class _FindClass:
"""
Use by usb.core to modify the way USB devices are found
Taken from pyUSB documentation on Github
"""
def __init__(self, class_):
self._class = class_
def __call__(self, device):
# first, let's check the device
if device.bDeviceClass == self._class:
return True
# ok, transverse all devices to find an
# interface that matches our class
for cfg in device:
# find_descriptor: what's it?
intf = usb.util.find_descriptor(cfg, bInterfaceClass=self._class)
if intf is not None:
return True
return False

View File

@@ -1,13 +1,21 @@
from flask_socketio import SocketIO
from gpiozero import Button, LED, DigitalOutputDevice
from time import sleep, gmtime, strftime
from PIL import Image
"""
This class executes when we are on a raspberry Pi.
It handles the press of a button via GPIO,
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 subprocess
import os
from time import sleep, gmtime, strftime
from gpiozero import Button, LED, DigitalOutputDevice
from PIL import Image
from task import TextTask, ImageTask, CutTask
class Raspberry(object):
class Raspberry:
"""
This class will manage three things :
- Connecting to a USB webcam
@@ -15,32 +23,29 @@ class Raspberry(object):
- Activating a flash ( or light )
- Flash an indicator light
# pylint: disable=too-many-instance-attributes
# dede
"""
def __init__(
self,
printer,
print_queue,
app,
socketio,
button_gpio_port_number,
indicator_gpio_port_number,
flash_gpio_port_number,
is_flash_present,
configuration_file
):
self.printer = printer
self.socketio = socketio
self.print_queue = print_queue
self.app = app
self.flash_gpio = flash_gpio_port_number
self.is_flash_present = is_flash_present
self.button_gpio = button_gpio_port_number
self.led_gpio = indicator_gpio_port_number
self.configuration_file = configuration_file
self.image_path = self.app.config["UPLOAD_FOLDER"] + "/image.jpg"
def is_raspberry_pi(self, raise_on_errors=False):
def is_raspberry_pi(self):
"""
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
try:
with io.open("/proc/cpuinfo", "r") as cpuinfo:
with io.open("/proc/cpuinfo", "r", encoding="utf-8") as cpuinfo:
found = False
for line in cpuinfo:
if line.startswith("Hardware"):
@@ -60,9 +65,10 @@ class Raspberry(object):
return False
if not found:
self.app.logger.error(
"Couldn't get sufficient hardware information from /proc/cpuinfo, Unable to determine if we are on a Raspberry Pi."
self.app.logger.warning(
"Couldn't get sufficient hardware information from /proc/cpuinfo"
)
self.app.logger.warning("Unable to determine if we are on a Raspberry Pi.")
return False
except IOError:
self.app.logger.error("Unable to open `/proc/cpuinfo`.")
@@ -71,28 +77,38 @@ class Raspberry(object):
self.app.logger.debug("It seems we are on a Raspberry Pi")
try:
self.initialise_gpio()
self._initialise_gpio()
except Exception as e:
self.app.logger.debug("Could not init GPIO : " + str(e))
raise e
return True
def initialise_gpio(self):
def _initialise_gpio(self):
"""
Set GPIO ports from configuration and activate them
to show the user it's working.
"""
self.app.logger.debug("Initializing GPIO")
self.led = LED(self.led_gpio)
self.led = LED(self.configuration_file["rpi"]["indicator_gpio_port_number"])
self.app.logger.debug("Activated indicator LED")
self.indicator_countdown(iters=3)
self.button = Button(self.button_gpio, pull_up=True, bounce_time=0.1)
self.button = Button(
self.configuration_file["rpi"]["button_gpio_port_number"],
pull_up=True, bounce_time=0.1
)
self.button.when_pressed = self.on_button_pressed
self.app.logger.debug("Activated button")
# The "flash" is a relay-controlled device ( light bulb for example )
self.flash = DigitalOutputDevice(self.flash_gpio)
self.flash = DigitalOutputDevice(self.configuration_file["rpi"]["flash_gpio_port_number"])
self.flash_toggle()
self.app.logger.debug("Activated flash")
def indicator_countdown(self, iters=10, multi=10):
"""
Activates the LED faster and faster to show a countdown
"""
for i in range(iters, 0, -1):
self.led.on()
sleep(i / multi)
@@ -100,7 +116,10 @@ class Raspberry(object):
sleep(i / multi)
def indicator_led(self, timing=0.2, l=5):
for i in range(l):
"""
Turns on the indicator LED for a certain period of time
"""
for _ in range(l):
self.app.logger.debug("LED turned on")
self.led.on()
sleep(timing)
@@ -109,6 +128,9 @@ class Raspberry(object):
sleep(timing)
def flash_toggle(self):
"""
Flashes the flash
"""
self.app.logger.debug("Flash turned on")
self.flash.on()
sleep(0.3)
@@ -116,6 +138,9 @@ class Raspberry(object):
self.app.logger.debug("Flash turned off")
def take_picture(self):
"""
Takes a picture via the USB webcam
"""
# Validate if the image path is valid
if not os.path.isdir(os.path.dirname(self.image_path)):
self.app.logger.error(
@@ -141,7 +166,7 @@ class Raspberry(object):
f"Unable to take a picture. Error: {e.stderr.decode()}"
)
return False
except Exception as e:
except RuntimeError as e:
# Catch any unexpected errors
self.app.logger.error(f"Unexpected error while taking picture: {str(e)}")
return False
@@ -161,6 +186,9 @@ class Raspberry(object):
position="bottom_right",
margin=10,
):
"""
Takes an image and overlays it with a another picture.
"""
try:
image = Image.open(image_path).convert("RGBA")
logo = Image.open(logo_path).convert("RGBA")
@@ -187,7 +215,9 @@ class Raspberry(object):
y = image.height - logo.height - margin
else:
raise ValueError(
"Invalid position. Choose from 'bottom_right', 'top_left', 'top_right', or 'bottom_left'."
"Invalid position." +
"Choose from 'bottom_right', 'top_left', " +
" 'top_right', or 'bottom_left'."
)
# Composite the logo onto the image
@@ -198,13 +228,16 @@ class Raspberry(object):
output_path = image_path # Overwrite the original image if no output path is given
image.save(output_path)
except Exception as e:
except RuntimeError as e:
self.app.logger.error(f"Error overlaying logo: {e}")
return False
return True
def crop_to_square(self, image_path, output_path=None):
"""
Crop an image so that it becomes a square
"""
try:
image = Image.open(image_path)
width, height = image.size
@@ -225,13 +258,17 @@ class Raspberry(object):
image.save(output_path)
except Exception as e:
except RuntimeError as e:
self.app.logger.error(f"Error cropping image to square: {e}")
return False
return True
def on_button_pressed(self):
"""
When a button press is detected, a picture is taken from the webcam
and added to the print queue.
"""
self.app.logger.debug("Button has been pressed")
self.led.on()
self.app.logger.debug("Counting down")
@@ -242,7 +279,7 @@ class Raspberry(object):
try:
self.flash.on()
self.take_picture()
except Exception as e:
except RuntimeError as e:
self.app.logger.error(
"Could not take a picture after the button press : " + str(e)
)
@@ -251,15 +288,13 @@ class Raspberry(object):
self.app.logger.debug("Printing picture")
self.led.on()
self.crop_to_square(self.image_path)
self.printer.print_img("src/static/images/extase-club.png", process=True)
self.printer.print_img(self.image_path, process=True)
self.printer.print_sms("")
self.printer.print_sms("With Love From Société.Vide", signature="", bold=True)
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.print_queue.enqueue(ImageTask(self.image_path, signature="", process=True))
self.print_queue.enqueue(
TextTask(content="Imprimé par LittlePrynter", signature="")
)
time = strftime("%Y-%m-%d %H:%M", gmtime())
self.print_queue.enqueue(TextTask(content=time, signature=""))
self.print_queue.enqueue(CutTask())
self.led.off()
self.app.logger.debug("Done printing picture")
self.app.logger.debug("Added a photomaton picture to the print queue")
return True

View File

@@ -255,7 +255,12 @@ function print_picture(data){
// headers:{
// 'Content-Type': 'multipart/form-data'
// }
}).then(function(response) { console.log('Success:', response); } , true)
}).then(function(response) {
console.log('Reponse:', response);
if(response.status != 200 ){
alert("The picture could not be printed be : " + response.statusText)
}
} , true)
.catch(error => console.error('Error:', error), false);
}

110
src/task.py Normal file
View File

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

View File

@@ -5,8 +5,9 @@
<div class="card">
<h3 class="card-header">Print a short message</h3>
<div class="card-body">
<form class="form-group" action="/api/print/sms" method="post">
<input class="form-control" type="text" name="txt" placeholder="200 chars or less " maxlength="200" required><br>
<form class="form-group" action="/web/print/sms" method="post">
<textarea class="form-control" type="text" name="txt" placeholder="4096 chars or less " maxlength="4096"></textarea>
<br>
<input class="form-control" type="text" name="signature" placeholder="Signature or pseudo" maxlength="200"><br>
<input class="btn btn-primary float-right" type="submit" value="Imprimer" name="imprimer">
</form>
@@ -18,7 +19,7 @@
<div class="card">
<h3 class="card-header">Print an image</h3>
<div class="card-body">
<form enctype="multipart/form-data" class="form-group" action="/api/print/img" method="post">
<form enctype="multipart/form-data" class="form-group" action="/web/print/img" method="post">
<input class="form-control" type="file" name="img" required><br>
<input class="form-control" type="text" name="signature" placeholder="Signature or pseudo" maxlength="200"><br>
<input class="btn btn-primary float-right" type="submit" value="Imprimer" name="imprimer">

View File

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

View File

@@ -1,59 +1,86 @@
from flask import Flask, request, flash
from werkzeug.utils import secure_filename
from printer import Printer
import time
"""
Manage all of the inputs from a web source
"""
import os
from werkzeug.utils import secure_filename
from task import TextTask, ImageTask, CutTask
class Web(object):
"""docstring for web."""
class Web:
"""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"""
def __init__(self, app, printer):
def __init__(self, app, print_queue):
super(Web).__init__()
self.printer = printer
self.print_queue = print_queue
self.app = app
def print_sms(self, texte, sign: str):
# TODO: verify the texte before printing it here ?
def print_sms(self, texte, sign: str) -> bool:
"""
Get text and a signature, prints the text and cuts after that.
"""
self.app.logger.debug("Printing : " + str(texte) + " from " + str(sign))
try:
self.printer.print_sms(texte, sign)
self.printer.cut()
# We create two new tasks and add them directly to the queue
# TODO: this might need to be improved because
# !! there is no garantee !! that both the SMS task and the Cut task
# are added back to back, another task could be
# inserted between the two.
sms = self.print_queue.enqueue(TextTask(content=texte, signature=sign))
cut = self.print_queue.enqueue(CutTask())
except Exception as e:
self.app.logger.error(e)
flash("Error while printing the SMS : " + str(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)
return True
flash("You message " + str(texte) + " has been printed :)")
def print_image(self, image, sign):
self.app.logger.debug("Uploading file")
def print_image(self, image, sign: str) -> bool:
"""
Get an image and a signature, prints the image and cuts after that.
"""
try:
self.app.logger.debug("Uploading file from " + str(sign))
if self.upload_file(image):
self.app.logger.debug("File has been uploaded, printing...")
self.printer.print_img(
os.path.join(
self.app.config["UPLOAD_FOLDER"],
secure_filename(image.filename),
),
sign=sign,
process=True,
file_uploaded = self.upload_file(image)
except Exception as e:
self.app.logger.error(e)
raise RuntimeError("Could not upload file : " + str(e)) from e
if file_uploaded:
self.app.logger.debug("File has been uploaded, printing...")
try:
img = self.print_queue.enqueue(
ImageTask(
os.path.join(
self.app.config["UPLOAD_FOLDER"],
secure_filename(image.filename),
),
signature=sign,
process=True,
)
)
self.printer.cut()
except Exception as e:
self.app.logger.error(e)
flash("Could not upload file." + str(e))
flash("Your image has been printed :)")
cut = self.print_queue.enqueue(CutTask())
except Exception as e:
raise RuntimeError("Could not add IMG to queue" + str(e)) from e
def login(username: str, password: str) -> bool:
pass
self.app.logger.info("Added two new tasks at position %s and %s", img, cut)
def logout(username: str, password: str) -> bool:
pass
return True
# def login(self, username: str, password: str) -> bool:
# """Not implemented"""
# return
# def logout(self, username: str, password: str) -> bool:
# """Not implemented"""
# return
def allowed_file(self, filename) -> bool:
self.app.logger.debug("Is the filename allowed ?")
"""
Check if the file extension is allowed
"""
self.app.logger.debug("Checking if the file extension is allowed")
return (
"." in filename
and filename.rsplit(".", 1)[1].lower()
@@ -61,23 +88,35 @@ class Web(object):
)
def upload_file(self, image) -> bool:
"""
Save the file after executing checks on it
"""
self.app.logger.debug("Validating file")
if image and self.allowed_file(image.filename):
filename = secure_filename(image.filename)
self.app.logger.debug("File valid")
try:
image.save(os.path.join(self.app.config["UPLOAD_FOLDER"], filename))
self.app.logger.debug("File saved")
except Exception as e:
self.app.logger.error("Could not save file")
flash(str(e), "error")
return False
if not image is None or not image == "":
if self.allowed_file(image.filename):
filename = secure_filename(image.filename)
self.app.logger.debug("File valid")
try:
image.save(os.path.join(self.app.config["UPLOAD_FOLDER"], filename))
except OSError as e:
self.app.logger.error("Could not save file %s", e)
raise RuntimeError("An OS error occured while uploading this file : " + str(e)) from e
self.app.logger.debug(
"File saved to "
+ str(os.path.join(self.app.config["UPLOAD_FOLDER"], filename))
)
return True
else:
self.app.logger.error("Could not save file " + str(filename))
return False
self.app.logger.debug(
"File saved to "
+ str(os.path.join(self.app.config["UPLOAD_FOLDER"], filename))
)
return True
self.app.logger.error(
"Could not save file because the filename is forbidden"
)
raise RuntimeError("This file type is forbidden.")
def get_queue_state(self):
"""Return current queue state"""
return self.print_queue.get_queue_state()
def get_queue_completed(self):
"""Return completed queue elements"""
return self.print_queue.get_queue_completed()

147
src/worker.py Normal file
View File

@@ -0,0 +1,147 @@
"""
This is the main printing thread. A worker thread consums Tasks from
a PrintQueue, while trying to find available printers.
"""
import threading
import time
from printers import Printers
class PrintWorker(threading.Thread):
"""
A thread used to consume Tasks added to a Print Queue.
On initialisation, the worker will try to find Printers,
and on each print, choose an available Printer from a list of Printers.
If a print fails, it's not retried, but will be added to a list of completed
tasks.
"""
def __init__(self, app, print_queue):
super().__init__(daemon=True)
self.app = app
self.print_queue = print_queue
self.printer = None
self._lock = threading.Lock()
self.running = True
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...")
try:
self.printers = Printers(self.app)
self.printers_obj = self.printers.printers
self.printers = iter(self.printers.printers)
except RuntimeError as e:
self.app.logger.warning("Could not get any Printers")
raise e
def run(self):
"""Background thread that processes queue items"""
self.app.logger.debug("Worker %s started working.", threading.get_ident())
self.app.logger.debug("Current threads : %s" , threading.active_count())
self.app.logger.debug("Threads actives : %s " , threading.enumerate())
while True:
# If the printer is dead or asleep, it can't work.
if not self.running:
time.sleep(0.2)
continue
# If we have no available printer, we look at the list printers
# we know about, and try to find one that is available.
# When we find a printer, we acquire it
# When we are finished with a printer, we release it to the world.
while not self.printer or not self.printer.ready:
time.sleep(1)
try:
self.app.logger.debug("Changing printers")
self.printer = next(self.printers)
self.app.logger.debug(
"The worker got a %s printer and it's %s",
self.printer.printer_type,
"Ready" if self.printer.ready else "Not ready",
)
except Exception as e:
self.app.logger.error("No printer detected" + str(e))
self.printer = None
if self.state != "idle":
self.app.logger("We are not idle, waiting...")
time.sleep(1)
continue
self.state = "printing"
with self._lock:
try:
task = self.print_queue.dequeue()
except Exception as e:
self.app.logger.error("Could not get a new task ! %s ", str(e))
self.state = "idle"
raise RuntimeError(
"We could not get a new task because " + str(e)
) from e
if task:
try:
self.app.logger.info("Got a new task")
self.app.logger.debug("Got task %s", task.task_id)
task.status = "processing"
print_data = task.get_print_data()
try:
self.printer.print_task(task.task_type, print_data)
except RuntimeError as e:
self.state = "idle"
self.app.logger.error("Could not print : %s", str(e))
raise e
task.status = "completed"
self.print_queue.mark_completed(task.task_id, "completed")
self.app.logger.debug(
"Finished printing task %s " , task.task_id
)
self.state = "idle"
except RuntimeError as e:
task.status = "failed"
self.state = "idle"
self.print_queue.mark_completed(task.task_id, "failed")
self.app.logger.error(
"Could not print task %s because %s " , task.task_id, str(e)
)
else:
# When they are no new tasks to handle, we put the thread to sleep.
self.state = "idle"
time.sleep(0.1)
def stop_worker(self):
"""
Give the worker a break
"""
self.app.logger.debug("Giving the worker a break")
self.state = "drinking-a-beer"
self.running = False
def start_worker(self):
"""
Get the worker back to it
"""
self.app.logger.debug("Time to work !")
self.state = "idle"
self.running = True
def current_state(self):
"""
Return the worker state
"""
return {
"is_running": self.running,
"queue_size": len(self.print_queue),
"state": self.state,
"printers": len(self.printers_obj),
}